You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

cisco.dnac.device_credential_update module – Resource module for Device Credential Update

Note

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

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

New in cisco.dnac 3.1.0

Synopsis

• Manage operation update of the resource Device Credential Update.

• API to update device credentials.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.5.5

• 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.5.3"
settings dictionary	Device Credential Update’s settings.
cliCredential dictionary	Device Credential Update’s cliCredential.
description string	Description.
enablePassword string	Enable Password.
id string	Id.
password string	Password.
username string	Username.
httpsRead dictionary	Device Credential Update’s httpsRead.
id string	Id.
name string	Name.
password string	Password.
port string	Port.
username string	Username.
httpsWrite dictionary	Device Credential Update’s httpsWrite.
id string	Id.
name string	Name.
password string	Password.
port string	Port.
username string	Username.
snmpV2cRead dictionary	Device Credential Update’s snmpV2cRead.
description string	Description.
id string	Id.
readCommunity string	Read Community.
snmpV2cWrite dictionary	Device Credential Update’s snmpV2cWrite.
description string	Description.
id string	Id.
writeCommunity string	Write Community.
snmpV3 dictionary	Device Credential Update’s snmpV3.
authPassword string	Auth Password.
authType string	Auth Type.
description string	Description.
id string	Id.
privacyPassword string	Privacy Password.
privacyType string	Privacy Type.
snmpMode string	Snmp Mode.
username string	Username.
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.update_device_credentials,

• Paths used are put /dna/intent/api/v1/device-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 Network Settings UpdateDeviceCredentials

Complete reference of the UpdateDeviceCredentials API.

Examples

- name: Update all
  cisco.dnac.device_credential_update:
    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}}"
    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

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)

Collection links

Issue Tracker Repository (Sources)