cisco.catalystcenter.global_credential_v2 module -- Resource module for Global Credential V2

Note

This module is part of the cisco.catalystcenter collection (version 2.2.1).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.global_credential_v2.

New in cisco.catalystcenter 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.

  • catalystcentersdk >= 3.1.3.0.0

  • python >= 3.5

Parameters

Parameter

Comments

catc_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catc_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catc_host

string / required

The Cisco Catalyst Center hostname.

catc_password

string

The Cisco Catalyst Center password to authenticate.

catc_username

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catc_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catc_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

Default: :ansible-option-default:`"2.3.7.6"`

cliCredential

dictionary

Global Credential V2's cliCredential.

description

string

Description for CLI credential.

enablePassword

string

CLI Enable Password.

id

string

Id of the CLI Credential in UUID format.

password

string

CLI Password.

username

string

CLI Username.

httpsRead

dictionary

Global Credential V2's httpsRead.

description

string

Description for HTTP(S) Read Credentials.

id

string

Id of the HTTP(S) Read Credential in UUID format.

password

string

HTTP(S) Read Password.

port

integer

HTTP(S) Port.

username

string

HTTP(S) Read Username.

httpsWrite

dictionary

Global Credential V2's httpsWrite.

description

string

Description for HTTP(S) Write Credentials.

id

string

Id of the HTTP(S) Read Credential in UUID format.

password

string

HTTP(S) Write Password.

port

integer

HTTP(S) Port.

username

string

HTTP(S) Write Username.

id

string

Id path parameter. Global Credential id.

snmpV2cRead

dictionary

Global Credential V2's snmpV2cRead.

description

string

Description for Snmp RO community.

id

string

Id of the SNMP Read Credential in UUID format.

readCommunity

string

Snmp RO community.

snmpV2cWrite

dictionary

Global Credential V2's snmpV2cWrite.

description

string

Description for Snmp RW community.

id

string

Id of the SNMP Write Credential in UUID format.

writeCommunity

string

Snmp RW community.

snmpV3

dictionary

Global Credential V2's snmpV3.

authPassword

string

Auth Password for SNMP V3.

authType

string

SNMP auth protocol. SHA' or 'MD5'.

description

string

Description for Snmp V3 Credential.

id

string

Id of the SNMP V3 Credential in UUID format.

privacyPassword

string

Privacy Password for SNMP privacy.

privacyType

string

SNMP privacy protocol. 'AES128','AES192','AES256'.

snmpMode

string

Mode of SNMP. 'AUTHPRIV' or 'AUTHNOPRIV' or 'NOAUTHNOPRIV'.

username

string

SNMP V3 Username.

validate_response_schema

boolean

Flag for Cisco Catalyst 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 uses the embedded connection manager from Cisco CATALYST SDK

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.catalystcenter.global_credential:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_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.catalystcenter.global_credential:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_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.catalystcenter.global_credential:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    state: absent
    id: string

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco CATALYST Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)