cisco.dnac.network_devices_export_credentials_create module -- Resource module for Network Devices Export Credentials Create

Note

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

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

New in cisco.dnac 6.46.0

Synopsis

• Manage operation create of the resource Network Devices Export Credentials Create. - > Exports device credentials of all network devices in the inventory to an encrypted CSV file. To export credentials for selected devices only, provide the networkDeviceIds parameter in the request body. The exported file will be in zip format encrypted using the password provided in the request body. The ZIP file will contain a CSV file with the credentials of the selected network devices. If networkDeviceIds is not provided, then the credentials of all the network devices will be exported. Credentials for access points and Meraki devices cannot be exported. The response contains a task ID. Use the /dna/intent/api/v1/tasks/{taskId} API to check the status of the task. The task will be completed when the file is ready for download. The download URL will be available in the resultLocation attribute of the task API response.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.11.0

• python >= 3.12

Parameters

Parameter	Comments
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`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: :ansible-option-default:`443`
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: :ansible-option-default:`"admin"`
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"3.1.6.0"`
exportSshKey boolean	Flag to export the SSH key. If not provided, the SSH key will not be exported. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
networkDeviceIds list / elements=string	List of network device IDs to export the credentials for. If not provided, all devices will be exported.
password string	Password to encrypt the CSV file. A password must contain, at minimum 8 characters, one lowercase letter, one uppercase letter, one number, one special character (-=;,./~!@#$%^&*()_+{}| ?). The password cannot contain spaces or the characters < >.
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are devices.Devices.exports_the_credentials_of_network_devices,

• Paths used are post /dna/intent/api/v1/networkDevices/exportCredentials,

• 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 Devices ExportsTheCredentialsOfNetworkDevices

Complete reference of the ExportsTheCredentialsOfNetworkDevices API.

Examples

---
- name: Create
  cisco.dnac.network_devices_export_credentials_create:
    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}}"
    exportSshKey: true
    networkDeviceIds:
      - string
    password: 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: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)