W3cubDocs

/Ansible

cisco.dnac.device_credential module – Resource module for Device Credential

Note

This module is part of the cisco.dnac collection (version 6.31.3).

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.device_credential.

New in cisco.dnac 3.1.0

Synopsis

  • This module represents an alias of the module device_credential_v1

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • dnacentersdk >= 2.4.9
  • python >= 3.5

Parameters

Parameter

Comments

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)
  • true

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false
  • true ← (default)

dnac_version

string

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

Default: "2.3.7.6"

id

string

Id path parameter. Global credential id.

settings

dictionary

Device Credential’s settings.

cliCredential

list / elements=dictionary

Device Credential’s cliCredential.

description

string

Name or description for CLI credential.

enablePassword

string

Enable password for CLI credential.

password

string

Password for CLI credential.

username

string

User name for CLI credential.

httpsRead

list / elements=dictionary

Device Credential’s httpsRead.

name

string

Name or description of http read credential.

password

string

Password for http read credential.

port

float

Port for http read credential.

username

string

User name of the http read credential.

httpsWrite

list / elements=dictionary

Device Credential’s httpsWrite.

name

string

Name or description of http write credential.

password

string

Password for http write credential.

port

float

Port for http write credential.

username

string

User name of the http write credential.

snmpV2cRead

list / elements=dictionary

Device Credential’s snmpV2cRead.

description

string

Description for snmp v2 read.

readCommunity

string

Ready community for snmp v2 read credential.

snmpV2cWrite

list / elements=dictionary

Device Credential’s snmpV2cWrite.

description

string

Description for snmp v2 write.

writeCommunity

string

Write community for snmp v2 write credential.

snmpV3

list / elements=dictionary

Device Credential’s snmpV3.

authPassword

string

Authentication password for snmpv3 credential.

authType

string

Authentication type for snmpv3 credential.

description

string

Name or description for SNMPV3 credential.

privacyPassword

string

Privacy password for snmpv3 credential.

privacyType

string

Privacy type for snmpv3 credential.

snmpMode

string

Mode for snmpv3 credential.

username

string

User name for SNMPv3 credential.

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • false
  • true ← (default)

Notes

Note

  • SDK Method used are network_settings.NetworkSettings.create_device_credentials_v1, network_settings.NetworkSettings.delete_device_credential_v1, network_settings.NetworkSettings.update_device_credentials_v1,
  • Paths used are post /dna/intent/api/v1/device-credential, delete /dna/intent/api/v1/device-credential/{id}, put /dna/intent/api/v1/device-credential,
  • It should be noted that this module is an alias of device_credential_v1
  • 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 Network Settings CreateDeviceCredentialsV1

Complete reference of the CreateDeviceCredentialsV1 API.

Cisco DNA Center documentation for Network Settings DeleteDeviceCredentialV1

Complete reference of the DeleteDeviceCredentialV1 API.

Cisco DNA Center documentation for Network Settings UpdateDeviceCredentialsV1

Complete reference of the UpdateDeviceCredentialsV1 API.

Examples

- name: Create
  cisco.dnac.device_credential:
    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
    settings:
      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
- name: Update all
  cisco.dnac.device_credential:
    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
    settings:
      cliCredential:
        description: string
        enablePassword: string
        id: string
        password: string
        username: string
      httpsRead:
        id: string
        name: string
        password: string
        port: string
        username: string
      httpsWrite:
        id: string
        name: string
        password: string
        port: string
        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: Delete by id
  cisco.dnac.device_credential:
    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

dnac_response

dictionary

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

Returned: always

Sample: {"executionId": "string", "executionStatusUrl": "string", "message": "string"}

Authors

  • Rafael Campos (@racampos)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/dnac/device_credential_module.html