cisco.dnac.global_credential_v2 module – Resource module for Global Credential V2
Note
This module is part of the cisco.dnac collection (version 6.20.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.dnac
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.global_credential_v2
.
New in cisco.dnac 3.1.0
Synopsis
Manage operations create, update and delete of the resource Global Credential V2.
API to create new global credentials. Multiple credentials of various types can be passed at once. Please refer sample Request Body for more information.
Delete a global credential. Only ‘id’ of the credential has to be passed.
API to update device credentials. Multiple credentials can be passed at once, but only a single credential of a given type can be passed at once. Please refer sample Request Body for more information.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.7.2
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
Global Credential V2’s cliCredential. |
|
Description for CLI credential. |
|
CLI Enable Password. |
|
Id of the CLI Credential in UUID format. |
|
CLI Password. |
|
CLI Username. |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Global Credential V2’s httpsRead. |
|
Description for HTTP(S) Read Credentials. |
|
Id of the HTTP(S) Read Credential in UUID format. |
|
HTTP(S) Read Password. |
|
HTTP(S) Port. |
|
HTTP(S) Read Username. |
|
Global Credential V2’s httpsWrite. |
|
Description for HTTP(S) Write Credentials. |
|
Id of the HTTP(S) Read Credential in UUID format. |
|
HTTP(S) Write Password. |
|
HTTP(S) Port. |
|
HTTP(S) Write Username. |
|
Id path parameter. Global Credential id. |
|
Global Credential V2’s snmpV2cRead. |
|
Description for Snmp RO community. |
|
Id of the SNMP Read Credential in UUID format. |
|
Snmp RO community. |
|
Global Credential V2’s snmpV2cWrite. |
|
Description for Snmp RW community. |
|
Id of the SNMP Write Credential in UUID format. |
|
Snmp RW community. |
|
Global Credential V2’s snmpV3. |
|
Auth Password for SNMP V3. |
|
SNMP auth protocol. SHA’ or ‘MD5’. |
|
Description for Snmp V3 Credential. |
|
Id of the SNMP V3 Credential in UUID format. |
|
Privacy Password for SNMP privacy. |
|
SNMP privacy protocol. ‘AES128’,’AES192’,’AES256’. |
|
Mode of SNMP. ‘AUTHPRIV’ or ‘AUTHNOPRIV’ or ‘NOAUTHNOPRIV’. |
|
SNMP V3 Username. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are discovery.Discovery.create_global_credentials_v2, discovery.Discovery.delete_global_credential_v2, discovery.Discovery.update_global_credentials_v2,
Paths used are post /dna/intent/api/v2/global-credential, delete /dna/intent/api/v2/global-credential/{id}, put /dna/intent/api/v2/global-credential,
Does not support
check_mode
The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco DNA Center documentation for Discovery CreateGlobalCredentialsV2
Complete reference of the CreateGlobalCredentialsV2 API.
- Cisco DNA Center documentation for Discovery DeleteGlobalCredentialV2
Complete reference of the DeleteGlobalCredentialV2 API.
- Cisco DNA Center documentation for Discovery UpdateGlobalCredentialsV2
Complete reference of the UpdateGlobalCredentialsV2 API.
Examples
- name: Update all
cisco.dnac.global_credential_v2:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
state: present
cliCredential:
description: string
enablePassword: string
id: string
password: string
username: string
httpsRead:
description: string
id: string
password: string
port: 0
username: string
httpsWrite:
description: string
id: string
password: string
port: 0
username: string
snmpV2cRead:
description: string
id: string
readCommunity: string
snmpV2cWrite:
description: string
id: string
writeCommunity: string
snmpV3:
authPassword: string
authType: string
description: string
id: string
privacyPassword: string
privacyType: string
snmpMode: string
username: string
- name: Create
cisco.dnac.global_credential_v2:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
state: present
cliCredential:
- description: string
enablePassword: string
password: string
username: string
httpsRead:
- description: string
password: string
port: 0
username: string
httpsWrite:
- description: string
password: string
port: 0
username: string
snmpV2cRead:
- description: string
readCommunity: string
snmpV2cWrite:
- description: string
writeCommunity: string
snmpV3:
- authPassword: string
authType: string
description: string
privacyPassword: string
privacyType: string
snmpMode: string
username: string
- name: Delete by id
cisco.dnac.global_credential_v2:
dnac_host: "{{dnac_host}}"
dnac_username: "{{dnac_username}}"
dnac_password: "{{dnac_password}}"
dnac_verify: "{{dnac_verify}}"
dnac_port: "{{dnac_port}}"
dnac_version: "{{dnac_version}}"
dnac_debug: "{{dnac_debug}}"
state: absent
id: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |