blob: e83b8ed3c831a3a7e207c12a48c9a44730d850dc (
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
#!/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: credential
short_description: Configures a credential on a SQL server
description:
- Creates, replaces, or removes a credential on a SQL server.
version_added: 1.3.0
options:
identity:
description:
- The Credential Identity.
type: str
required: true
name:
description:
- The Credential name.
type: str
required: false
password:
description:
- Password used to authenticate the Credential Identity.
type: str
required: false
mapped_class_type:
description:
- Sets the class associated with the credential.
type: str
required: false
choices: ['CryptographicProvider','None']
provider_name:
description:
- Specifies the cryptographic provider name for the Enterprise Key Management Provider.
type: str
required: false
force:
description:
- If this switch is enabled, the existing credential will be dropped and recreated.
type: bool
default: false
author:
- "Joe Krilov (@Joey40)"
- "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
- lowlydba.sqlserver.state
'''
EXAMPLES = r'''
- name: Create a credential with a password
lowlydba.sqlserver.credential:
sql_instance: sql-01.myco.io
identity: ad\\user
name: MyCredential
password : <Password>
- name: Replace an existing credential
lowlydba.sqlserver.credential:
sql_instance: sql-01.myco.io
identity: MyIdentity
force: true
- name: Create a credential using a SAS token for a backup URL
lowlydba.sqlserver.credential:
sql_instance: sql-01.myco.io
identity: SHARED ACCESS SIGNATURE
name: https://<azure storage account name>.blob.core.windows.net/<blob container>
password : <Shared Access Token>
- name: Remove a credential
lowlydba.sqlserver.credential:
sql_instance: sql-01.myco.io
identity: MyIdentity
state: absent
'''
RETURN = r'''
data:
description: Output from the C(New-DbaDbCredential), C(Get-DbaDbCredential), or C(Remove-DbaDbCredential) function.
returned: success, but not in check_mode.
type: dict
'''
|
