cisco.catalystcenter.network_device_config_files_id_download_unmasked module -- Resource module for Network Device Config Files Id Download Unmasked

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

New in cisco.catalystcenter 6.17.0

Synopsis

• Manage operation create of the resource Network Device Config Files Id Download Unmasked.

• Download the unmasked raw device configuration by providing the file `id`.

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: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catc_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"2.3.7.6"`
id string	Id path parameter. The value of `id` can be obtained from the response of API `/dna/intent/api/v1/networkDeviceConfigFiles`.
password string	Password for the zip file to protect exported configurations. Must contain, at minimum 8 characters, one lowercase letter, one uppercase letter, one number, one special character(-=;,./~!@#$%^&*()_+{}| ?). It may not contain white space or the characters <>.
validate_response_schema boolean	Flag for Cisco Catalyst 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 configuration_archive.ConfigurationArchive.download_unmaskedraw_device_configuration_as_z_ip,

• Paths used are post /dna/intent/api/v1/networkDeviceConfigFiles/{id}/downloadUnmasked,

• 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 Configuration Archive DownloadUnmaskedrawDeviceConfigurationAsZIP

Complete reference of the DownloadUnmaskedrawDeviceConfigurationAsZIP API.

Examples

---
- name: Create
  cisco.catalystcenter.network_device_config_files_id_download_unmasked:
    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}}"
    id: 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 CATALYST Python SDK Returned: always Sample: :ansible-rv-sample-value:`{}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)