blob: 8aed1036a37891aadab78903b8bf68a535508190 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# (c) 2022, John McCall (@lowlydba)
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = r'''
---
module: sp_whoisactive
short_description: Install/update C(sp_whoisactive) by Adam Mechanic
description:
- A wrapper for C(Install-DbaWhoIsActive) to fetch the latest version of the script, or install from a local cached version.
version_added: 0.1.0
options:
local_file:
description:
- Specifies the path to a local file to install sp_WhoisActive from.
- This can be either the zip file as distributed by the website or the expanded SQL script.
- If this option is not specified, the latest version will be downloaded and installed from https://github.com/amachanic/sp_whoisactive/releases
type: str
required: false
database:
description:
- Name of the target database.
type: str
required: true
force:
description:
- If this switch is enabled, then C(sp_WhoisActive) will be downloaded from the internet even if previously cached.
type: bool
default: false
author: "John McCall (@lowlydba)"
requirements:
- L(dbatools,https://www.powershellgallery.com/packages/dbatools/) PowerShell module
extends_documentation_fragment:
- lowlydba.sqlserver.sql_credentials
- lowlydba.sqlserver.attributes.check_mode
- lowlydba.sqlserver.attributes.platform_all
'''
EXAMPLES = r'''
- name: Install/Update sp_whoisactive
lowlydba.sqlserver.sp_whoisactive:
sql_instance: sql-01.myco.io
database: lowlydb
'''
RETURN = r'''
data:
description: Output from the C(Install-DbaWhoIsActive) function.
returned: success, but not in check_mode.
type: dict
'''
|
