cisco.catalystcenter.network_device_config_info module -- Information module for Network Device Config
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_info.
New in cisco.catalystcenter 6.14.0
Synopsis
Get all Network Device Config . - > Returns the historical device configurations running configuration , startup configuration , vlan if applicable by specified criteria.
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 |
|---|---|
The Cisco Catalyst Center port. Default: :ansible-option-default:`443` |
|
Flag for Cisco Catalyst Center SDK to enable debugging. Choices: |
|
The Cisco Catalyst Center hostname. |
|
The Cisco Catalyst Center password to authenticate. |
|
The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"2.3.7.6"` |
|
CreatedBy query parameter. Comma separated values for createdBy - SCHEDULED, USER, CONFIG_CHANGE_EVENT, SCHEDULED_FIRST_TIME, DR_CALL_BACK, PRE_DEPLOY. |
|
CreatedTime query parameter. Supported with logical filters GT,GTE,LT,LTE & BT time in milliseconds (epoc format). |
|
DeviceId query parameter. Comma separated device id for example cf35b0a1-407f-412f-b2f4-f0c3156695f9,aaa38191-0c22-4158-befd-779a09d7cec1. If device id is not provided it will fetch for all devices. |
|
FileType query parameter. Config File Type can be RUNNINGCONFIG or STARTUPCONFIG. |
|
Additional headers. |
|
Limit query parameter. The number of records to be retrieved defaults to 500 if not specified, with a maximum allowed limit of 500. |
|
Offset query parameter. |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
Notes
Note
SDK Method used are configuration_archive.ConfigurationArchive.get_configuration_archive_details,
Paths used are get /dna/intent/api/v1/network-device-config,
Supports
check_modeThe 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 GetConfigurationArchiveDetails
Complete reference of the GetConfigurationArchiveDetails API.
Examples
---
- name: Get all Network Device Config
cisco.catalystcenter.network_device_config__info:
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}}"
headers: "{{my_headers | from_json}}"
deviceId: string
fileType: string
createdTime: string
createdBy: string
offset: 0
limit: 0
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco CATALYST Python SDK Returned: always |