cisco.dnac.global_credential_v2 (6.13.3) — module

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

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.

Requirements

• dnacentersdk >= 2.6.0
• python >= 3.9

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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:
      id: string
      name: string
      password: string
      port: 0
      username: string
    httpsWrite:
      id: string
      name: 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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:
    - name: string
      password: string
      port: 0
      username: string
    httpsWrite:
    - name: 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
id:
    description: Id path parameter. Global Credential id.
    type: str

snmpV3:
    description: Global Credential V2's snmpV3.
    suboptions:
      authPassword:
        description: Auth Password.
        type: str
      authType:
        description: Auth Type.
        type: str
      description:
        description: Description.
        type: str
      id:
        description: Id.
        type: str
      privacyPassword:
        description: Privacy Password.
        type: str
      privacyType:
        description: Privacy Type.
        type: str
      snmpMode:
        description: Snmp Mode.
        type: str
      username:
        description: Username.
        type: str
    type: dict

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

httpsRead:
    description: Global Credential V2's httpsRead.
    suboptions:
      id:
        description: Id.
        type: str
      name:
        description: Name.
        type: str
      password:
        description: Password.
        type: str
      port:
        description: Port.
        type: int
      username:
        description: Username.
        type: str
    type: dict

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

httpsWrite:
    description: Global Credential V2's httpsWrite.
    suboptions:
      id:
        description: Id.
        type: str
      name:
        description: Name.
        type: str
      password:
        description: Password.
        type: str
      port:
        description: Port.
        type: int
      username:
        description: Username.
        type: str
    type: dict

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

snmpV2cRead:
    description: Global Credential V2's snmpV2cRead.
    suboptions:
      description:
        description: Description.
        type: str
      id:
        description: Id.
        type: str
      readCommunity:
        description: Read Community.
        type: str
    type: dict

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

snmpV2cWrite:
    description: Global Credential V2's snmpV2cWrite.
    suboptions:
      description:
        description: Description.
        type: str
      id:
        description: Id.
        type: str
      writeCommunity:
        description: Write Community.
        type: str
    type: dict

cliCredential:
    description: Global Credential V2's cliCredential.
    suboptions:
      description:
        description: Description.
        type: str
      enablePassword:
        description: Enable Password.
        type: str
      id:
        description: Id.
        type: str
      password:
        description: Password.
        type: str
      username:
        description: Username.
        type: str
    type: dict

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"response\": {\n    \"taskId\": \"string\",\n    \"url\": \"string\"\
    \n  },\n  \"version\": \"string\"\n}\n"
  type: dict

See also

• Cisco DNA Center documentation for Discovery CreateGlobalCredentialsV2: Complete reference of the CreateGlobalCredentialsV2 API. link
• Cisco DNA Center documentation for Discovery DeleteGlobalCredentialV2: Complete reference of the DeleteGlobalCredentialV2 API. link
• Cisco DNA Center documentation for Discovery UpdateGlobalCredentialsV2: Complete reference of the UpdateGlobalCredentialsV2 API. link