Try SpotterResource module for Network Device
| "added in version" 6.8.0 of cisco.dnac"
Authors: Abhishek Maheshwari (@abmahesh) Madhan Sankaranarayanan (@madhansansel)
Install with ansible-galaxy collection install cisco.dnac:==6.13.3
collections:
- name: cisco.dnac
version: 6.13.3Manage operations create, update and delete of the resource Network Device.
Adds the device with given credential.
Deletes the network device for the given Id.
Sync the devices provided as input.
- name: Add new device in Inventory with full credentials
cisco.dnac.inventory_workflow_manager:
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}}"
dnac_log_level: "{{dnac_log_level}}"
dnac_log: False
state: merged
config:
- cli_transport: ssh
compute_device: False
password: Test@123
enable_password: Test@1234
extended_discovery_info: test
http_username: "testuser"
http_password: "test"
http_port: "443"
http_secure: False
ip_address_list: ["1.1.1.1", "2.2.2.2"]
netconf_port: 830
snmp_auth_passphrase: "Lablab@12"
snmp_auth_protocol: SHA
snmp_mode: AUTHPRIV
snmp_priv_passphrase: "Lablab@123"
snmp_priv_protocol: AES256
snmp_retry: 3
snmp_timeout: 5
snmp_username: v3Public
snmp_version: v3
type: NETWORK_DEVICE
username: cisco
- name: Add new Compute device in Inventory with full credentials.Inputs needed for Compute Device
cisco.dnac.inventory_workflow_manager:
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}}"
dnac_log_level: "{{dnac_log_level}}"
dnac_log: False
state: merged
config:
- ip_address_list: ["1.1.1.1", "2.2.2.2"]
http_username: "testuser"
http_password: "test"
http_port: "443"
snmp_auth_passphrase: "Lablab@12"
snmp_auth_protocol: SHA
snmp_mode: AUTHPRIV
snmp_priv_passphrase: "Lablab@123"
snmp_priv_protocol: AES256
snmp_retry: 3
snmp_timeout: 5
snmp_username: v3Public
compute_device: True
username: cisco
type: "COMPUTE_DEVICE"
- name: Add new Meraki device in Inventory with full credentials.Inputs needed for Meraki Device.
cisco.dnac.inventory_workflow_manager:
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}}"
dnac_log_level: "{{dnac_log_level}}"
dnac_log: False
state: merged
config:
- http_password: "test"
type: "MERAKI_DASHBOARD"
- name: Add new Firepower Management device in Inventory with full credentials.Input needed to add Device.
cisco.dnac.inventory_workflow_manager:
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}}"
dnac_log_level: "{{dnac_log_level}}"
dnac_log: False
state: merged
config:
- ip_address_list: ["1.1.1.1", "2.2.2.2"]
http_username: "testuser"
http_password: "test"
http_port: "443"
type: "FIREPOWER_MANAGEMENT_SYSTEM"
- name: Add new Third Party device in Inventory with full credentials.Input needed to add Device.
cisco.dnac.inventory_workflow_manager:
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}}"
dnac_log_level: "{{dnac_log_level}}"
dnac_log: False
state: merged
config:
- ip_address_list: ["1.1.1.1", "2.2.2.2"]
snmp_auth_passphrase: "Lablab@12"
snmp_auth_protocol: SHA
snmp_mode: AUTHPRIV
snmp_priv_passphrase: "Lablab@123"
snmp_priv_protocol: AES256
snmp_retry: 3
snmp_timeout: 5
snmp_username: v3Public
type: "THIRD_PARTY_DEVICE"
- name: Update device details or credentails in Inventory
cisco.dnac.inventory_workflow_manager:
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}}"
dnac_log_level: "{{dnac_log_level}}"
dnac_log: False
state: merged
config:
- cli_transport: telnet
compute_device: False
password: newtest123
enable_password: newtest1233
ip_address_list: ["1.1.1.1", "2.2.2.2"]
type: NETWORK_DEVICE
credential_update: True
- name: Update new management IP address of device in inventory
cisco.dnac.inventory_workflow_manager:
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}}"
dnac_log_level: "{{dnac_log_level}}"
dnac_log: False
state: merged
config:
- ip_address_list: ["1.1.1.1"]
credential_update: True
update_mgmt_ipaddresslist:
- exist_mgmt_ipaddress: "1.1.1.1"
new_mgmt_ipaddress: "12.12.12.12"
- name: Associate Wired Devices to site and Provisioned it in Inventory
cisco.dnac.inventory_workflow_manager:
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}}"
dnac_log_level: "{{dnac_log_level}}"
dnac_log: False
state: merged
config:
- provision_wired_device:
- device_ip: "1.1.1.1"
site_name: "Global/USA/San Francisco/BGL_18/floor_pnp"
resync_retry_count: 200
resync_retry_interval: 2
- device_ip: "2.2.2.2"
site_name: "Global/USA/San Francisco/BGL_18/floor_test"
resync_retry_count: 200
resync_retry_interval: 2
- name: Update Device Role with IP Address
cisco.dnac.inventory_workflow_manager:
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}}"
dnac_log_level: "{{dnac_log_level}}"
dnac_log: False
state: merged
config:
- ip_address_list: ["1.1.1.1", "2.2.2.2"]
role: ACCESS
- name: Update Interface details with IP Address
cisco.dnac.inventory_workflow_manager:
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}}"
dnac_log_level: "{{dnac_log_level}}"
dnac_log: False
state: merged
config:
- ip_address_list: ["1.1.1.1", "2.2.2.2"]
update_interface_details:
description: "Testing for updating interface details"
admin_status: "UP"
vlan_id: 23
voice_vlan_id: 45
deployment_mode: "Deploy"
interface_name: ["GigabitEthernet1/0/11", FortyGigabitEthernet1/1/1]
clear_mac_address_table: True
- name: Export Device Details in a CSV file Interface details with IP Address
cisco.dnac.inventory_workflow_manager:
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}}"
dnac_log_level: "{{dnac_log_level}}"
dnac_log: False
state: merged
config:
- ip_address_list: ["1.1.1.1", "2.2.2.2"]
export_device_list:
password: "File_password"
operation_enum: "0"
parameters: ["componentName", "SerialNumber", "Last Sync Status"]
- name: Create Global User Defined with IP Address
cisco.dnac.inventory_workflow_manager:
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}}"
dnac_log_level: "{{dnac_log_level}}"
dnac_log: False
state: merged
config:
- ip_address_list: ["1.1.1.1", "2.2.2.2"]
add_user_defined_field:
- name: Test123
description: "Added first udf for testing"
value: "value123"
- name: Test321
description: "Added second udf for testing"
value: "value321"
- name: Resync Device with IP Addresses
cisco.dnac.inventory_workflow_manager:
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}}"
dnac_log_level: "{{dnac_log_level}}"
dnac_log: False
state: merged
config:
- ip_address_list: ["1.1.1.1", "2.2.2.2"]
device_resync: True
force_sync: False
- name: Reboot AP Devices with IP Addresses
cisco.dnac.inventory_workflow_manager:
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}}"
dnac_log_level: "{{dnac_log_level}}"
dnac_log: False
state: merged
config:
- ip_address_list: ["1.1.1.1", "2.2.2.2"]
reboot_device: True
- name: Delete Provision/Unprovision Devices by IP Address
cisco.dnac.inventory_workflow_manager:
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}}"
dnac_log: False
dnac_log_level: "{{dnac_log_level}}"
state: deleted
config:
- ip_address_list: ["1.1.1.1", "2.2.2.2"]
clean_config: False
- name: Delete Global User Defined Field with name
cisco.dnac.inventory_workflow_manager:
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}}"
dnac_log_level: "{{dnac_log_level}}"
dnac_log: False
state: deleted
config:
- ip_address_list: ["1.1.1.1", "2.2.2.2"]
add_user_defined_field:
name: "Test123"
state:
choices:
- merged
- deleted
default: merged
description: The state of Cisco Catalyst Center after module completion.
type: str
config:
description: List of devices with credentails to perform Add/Update/Delete/Resync
operation
elements: dict
required: true
suboptions:
add_user_defined_field:
description: This operation will take dictionary as a parameter and in this we
give details to create/update/delete/assign multiple UDF to a device.
suboptions:
description:
description: Info about the global user defined field. Also used while updating
interface details.
type: str
name:
description: Name of Global User Defined Field. Required for creating/deleting
UDF and then assigning it to device.
type: str
value:
description: Value to assign to tag with or without the same user defined
field name.
type: str
type: dict
clean_config:
default: false
description: Required if need to delete the Provisioned device by clearing current
configuration.
type: bool
cli_transport:
description: The essential prerequisite for adding Network devices is the specification
of the transport protocol (either SSH or Telnet) used by the device.
type: str
compute_device:
description: Indicates whether a device is a compute device.
type: bool
credential_update:
default: false
description: Make this as true needed for the updation of device credentials and
other device details.
type: bool
device_resync:
default: false
description: Make this as true needed for the resyncing of device.
type: bool
enable_password:
description: Password required for enabling configurations on the device.
type: str
export_device_list:
description: This operation take dictionary as parameter and export the device
details as well as device credentials details in a csv file.
suboptions:
operation_enum:
description: enum(CREDENTIALDETAILS, DEVICEDETAILS) 0 to export Device Credential
Details Or 1 to export Device Details. CREDENTIALDETAILS - Used for exporting
device credentials details like snpm credntials, device crdentails etc.
DEVICEDETAILS - Used for exporting device specific details like device hostname,
serial number, type, family etc.
type: str
parameters:
description: List of device parameters that needs to be exported to file.(For
example, ["componentName", "SerialNumber", "Last Sync Status"])
elements: str
type: list
password:
description: Specifies the password for the encryption of file while exporting
the device credentails into the file.
type: str
site_name:
description: Indicates the exact location where the wired device will be provisioned.
This is a string value that should represent the complete hierarchical path
of the site (For example, "Global/USA/San Francisco/BGL_18/floor_pnp").
type: str
type: dict
extended_discovery_info:
description: Additional discovery information for the device.
type: str
force_sync:
default: false
description: If forcesync is true then device sync would run in high priority
thread if available, else the sync will fail.
type: bool
hostname_list:
description: A list of hostnames representing devices. Operations such as updating,
deleting, resyncing, or rebooting can be performed as alternatives to using
IP addresses.
elements: str
type: list
http_password:
description: HTTP password required for adding compute, Meraki, and Firepower
Management Devices.
type: str
http_port:
description: HTTP port number required for adding compute and Firepower Management
Devices.
type: str
http_secure:
description: Flag indicating HTTP security.
type: bool
http_username:
description: HTTP username required for adding compute and Firepower Management
Devices.
type: str
ip_address_list:
description: A list of the IP addresses for the devices. It is required for tasks
such as adding, updating, deleting, or resyncing devices, with Meraki devices
being the exception.
elements: str
type: list
mac_address_list:
description: A list of MAC addresses representing devices. Operations such as
updating, deleting, resyncing, or rebooting can be performed as alternatives
to using IP addresses.
elements: str
type: list
netconf_port:
description: Specifies the port number for connecting to devices using the Netconf
protocol. Netconf (Network Configuration Protocol) is used for managing network
devices. Ensure that the provided port number corresponds to the Netconf service
port configured on your network devices. NETCONF with user privilege 15 is mandatory
for enabling Wireless Services on Wireless capable devices such as Catalyst
9000 series Switches and C9800 Series Wireless Controllers. The NETCONF credentials
are required to connect to C9800 Series Wireless Controllers as the majority
of data collection is done using NETCONF for these Devices.
type: str
password:
description: Password for accessing the device and for file encryption during
device export. Required for adding Network Device. Also needed for file encryption
while exporting device in a csv file.
type: str
provision_wired_device:
description: This parameter takes a list of dictionaries. Each dictionary provides
the IP address of a wired device and the name of the site where the device will
be provisioned.
elements: dict
suboptions:
device_ip:
description: Specifies the IP address of the wired device. This is a string
value that should be in the format of standard IPv4 or IPv6 addresses.
type: str
version_added: 6.12.0
version_added_collection: cisco.dnac
resync_retry_count:
default: 200
description: Determines the total number of retry attempts for checking if
the device has reached a managed state during the provisioning process.
If unspecified, the default value is set to 200 retries.
type: int
version_added: 6.12.0
version_added_collection: cisco.dnac
resync_retry_interval:
default: 2
description: Sets the interval, in seconds, at which the system will recheck
the device status throughout the provisioning process. If unspecified, the
system will check the device status every 2 seconds by default.
type: int
version_added: 6.12.0
version_added_collection: cisco.dnac
site_name:
description: Indicates the exact location where the wired device will be provisioned.
This is a string value that should represent the complete hierarchical path
of the site (For example, "Global/USA/San Francisco/BGL_18/floor_pnp").
type: str
type: list
reboot_device:
default: false
description: Make this as true needed for the Rebooting of Access Points.
type: bool
role:
description: Role of device which can be ACCESS, CORE, DISTRIBUTION, BORDER ROUTER,
UNKNOWN. ALL - This role typically represents all devices within the network,
regardless of their specific roles or functions. UNKNOWN - This role is assigned
to devices whose roles or functions have not been identified or classified within
Cisco Catalsyt Center. This could happen if the platform is unable to determine
the device's role based on available information. ACCESS - This role typically
represents switches or access points that serve as access points for end-user
devices to connect to the network. These devices are often located at the edge
of the network and provide connectivity to end-user devices. BORDER ROUTER -
These are devices that connect different network domains or segments together.
They often serve as gateways between different networks, such as connecting
an enterprise network to the internet or connecting multiple branch offices.
DISTRIBUTION - This role represents function as distribution switches or routers
in hierarchical network designs. They aggregate traffic from access switches
and route it toward the core of the network or toward other distribution switches.
CORE - This role typically represents high-capacity switches or routers that
form the backbone of the network. They handle large volumes of traffic and provide
connectivity between different parts of network, such as connecting distribution
switches or providing interconnection between different network segments.
type: str
serial_number_list:
description: A list of serial numbers representing devices. Operations such as
updating, deleting, resyncing, or rebooting can be performed as alternatives
to using IP addresses.
elements: str
type: list
snmp_auth_passphrase:
description: SNMP authentication passphrase required for adding network, compute,
and third-party devices.
type: str
snmp_auth_protocol:
default: SHA
description: SNMP authentication protocol. SHA (Secure Hash Algorithm) - cryptographic
hash function commonly used for data integrity verification and authentication
purposes.
type: str
snmp_mode:
description: Device's snmp Mode refer to different SNMP (Simple Network Management
Protocol) versions and their corresponding security levels. NOAUTHNOPRIV - This
mode provides no authentication or encryption for SNMP messages. It means that
devices communicating using SNMPv1 do not require any authentication (username/password)
or encryption (data confidentiality). This makes it the least secure option.
AUTHNOPRIV - This mode provides authentication but no encryption for SNMP messages.
Authentication involves validating the source of the SNMP messages using a community
string (similar to a password). However, the data transmitted between devices
is not encrypted, so it's susceptible to eavesdropping. AUTHPRIV - This mode
provides both authentication and encryption for SNMP messages. It offers the
highest level of security among the three options. Authentication ensures that
the source of the messages is genuine, and encryption ensures that the data
exchanged between devices is confidential and cannot be intercepted by unauthorized
parties.
type: str
snmp_priv_passphrase:
description: SNMP private passphrase required for adding network, compute, and
third-party devices.
type: str
snmp_priv_protocol:
description: SNMP private protocol required for adding network, compute, and third-party
devices.
type: str
snmp_retry:
default: 3
description: SNMP retry count.
type: int
snmp_ro_community:
description: SNMP Read-Only community required for adding V2C devices.
type: str
snmp_rw_community:
description: SNMP Read-Write community required for adding V2C devices.
type: str
snmp_timeout:
default: 5
description: SNMP timeout duration.
type: int
snmp_username:
description: SNMP username required for adding network, compute, and third-party
devices.
type: str
snmp_version:
description: It is a standard protocol used for managing and monitoring network
devices. v2 - In this communication between the SNMP manager (such as Cisco
Catalyst) and the managed devices (such as routers, switches, or access points)
is based on community strings.Community strings serve as form of authentication
and they are transmitted in clear text, providing no encryption. v3 - It is
the most secure version of SNMP, providing authentication, integrity, and encryption
features. It allows for the use of usernames, authentication passwords, and
encryption keys, providing stronger security compared to v2.
type: str
type:
default: NETWORK_DEVICE
description: Select Device's type from NETWORK_DEVICE, COMPUTE_DEVICE, MERAKI_DASHBOARD,
THIRD_PARTY_DEVICE, FIREPOWER_MANAGEMENT_SYSTEM. NETWORK_DEVICE - This refers
to traditional networking equipment such as routers, switches, access points,
and firewalls. These devices are responsible for routing, switching, and providing
connectivity within the network. COMPUTE_DEVICE - These are computing resources
such as servers, virtual machines, or containers that are part of the network
infrastructure. Cisco Catalyst Center can integrate with compute devices to
provide visibility and management capabilities, ensuring that the network and
compute resources work together seamlessly to support applications and services.
MERAKI_DASHBOARD - It is cloud-based platform used to manage Meraki networking
devices, including wireless access points, switches, security appliances, and
cameras. THIRD_PARTY_DEVICE - This category encompasses devices from vendors
other than Cisco or Meraki. Cisco Catalyst Center is designed to support integration
with third-party devices through open standards and APIs. This allows organizations
to manage heterogeneous network environments efficiently using Cisco Catalyst
Center's centralized management and automation capabilities. FIREPOWER_MANAGEMENT_SYSTEM
- It is a centralized management console used to manage Cisco's Firepower Next-Generation
Firewall (NGFW) devices. It provides features such as policy management, threat
detection, and advanced security analytics.
type: str
update_interface_details:
description: This operation will take dictionary as a parameter and in this we
give details to update interface details of device.
suboptions:
admin_status:
description: Status of Interface of a device, it can be (UP/DOWN).
type: str
clear_mac_address_table:
default: false
description: Set this to true if you need to clear the MAC address table for
a specific device's interface. It's a boolean type, with a default value
of False.
type: bool
deployment_mode:
default: Deploy
description: Preview/Deploy [Preview means the configuration is not pushed
to the device. Deploy makes the configuration pushed to the device]
type: str
description:
description: Specifies the description of the interface of the device.
type: str
interface_name:
description: Specify the list of interface names to update the details of
the device interface. (For example, GigabitEthernet1/0/11, FortyGigabitEthernet1/1/2)
elements: str
type: list
vlan_id:
description: Unique Id number assigned to a VLAN within a network used only
while updating interface details.
type: int
voice_vlan_id:
description: Identifier used to distinguish a specific VLAN that is dedicated
to voice traffic used only while updating interface details.
type: int
type: dict
update_mgmt_ipaddresslist:
description: List of updated management IP addresses for network devices.
elements: dict
suboptions:
exist_mgmt_ipaddress:
description: Device's existing Mgmt IpAddress.
type: str
new_mgmt_ipaddress:
description: Device's new Mgmt IpAddress.
type: str
type: list
username:
description: Username for accessing the device. Required for Adding Network Device.
type: str
type: list
dnac_log:
default: false
description:
- Flag to enable/disable playbook execution logging.
- When true and dnac_log_file_path is provided, - Create the log file at the execution
location with the specified name.
- When true and dnac_log_file_path is not provided, - Create the log file at the execution
location with the name 'dnac.log'.
- When false, - Logging is disabled.
- If the log file doesn't exist, - It is created in append or write mode based on
the "dnac_log_append" flag.
- If the log file exists, - It is overwritten or appended based on the "dnac_log_append"
flag.
type: bool
dnac_host:
description:
- The hostname of the Cisco Catalyst Center.
required: true
type: str
dnac_port:
default: '443'
description:
- Specifies the port number associated with the Cisco Catalyst Center.
type: str
dnac_debug:
default: false
description:
- Indicates whether debugging is enabled in the Cisco Catalyst Center SDK.
type: bool
dnac_verify:
default: true
description:
- Flag to enable or disable SSL certificate verification.
type: bool
dnac_version:
default: 2.2.3.3
description:
- Specifies the version of the Cisco Catalyst Center that the SDK should use.
type: str
config_verify:
default: false
description: Set to True to verify the Cisco Catalyst Center config after applying
the playbook config.
type: bool
dnac_password:
description:
- The password for authentication at the Cisco Catalyst Center.
type: str
dnac_username:
aliases:
- user
default: admin
description:
- The username for authentication at the Cisco Catalyst Center.
type: str
dnac_log_level:
default: WARNING
description:
- Sets the threshold for log level. Messages with a level equal to or higher than
this will be logged. Levels are listed in order of severity [CRITICAL, ERROR, WARNING,
INFO, DEBUG].
- CRITICAL indicates serious errors halting the program. Displays only CRITICAL messages.
- ERROR indicates problems preventing a function. Displays ERROR and CRITICAL messages.
- WARNING indicates potential future issues. Displays WARNING, ERROR, CRITICAL messages.
- INFO tracks normal operation. Displays INFO, WARNING, ERROR, CRITICAL messages.
- DEBUG provides detailed diagnostic info. Displays all log messages.
type: str
dnac_log_append:
default: true
description: Determines the mode of the file. Set to True for 'append' mode. Set to
False for 'write' mode.
type: bool
dnac_log_file_path:
default: dnac.log
description:
- Governs logging. Logs are recorded if dnac_log is True.
- If path is not specified, - When 'dnac_log_append' is True, 'dnac.log' is generated
in the current Ansible directory; logs are appended. - When 'dnac_log_append' is
False, 'dnac.log' is generated; logs are overwritten.
- If path is specified, - When 'dnac_log_append' is True, the file opens in append
mode. - When 'dnac_log_append' is False, the file opens in write (w) mode. - In
shared file scenarios, without append mode, content is overwritten after each module
execution. - For a shared log file, set append to False for the 1st module (to overwrite);
for subsequent modules, set append to True.
type: str
dnac_api_task_timeout:
default: 1200
description: Defines the timeout in seconds for API calls to retrieve task details.
If the task details are not received within this period, the process will end, and
a timeout notification will be logged.
type: int
dnac_task_poll_interval:
default: 2
description: Specifies the interval in seconds between successive calls to the API
to retrieve task details.
type: int
validate_response_schema:
default: true
description:
- Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against
a JSON schema.
type: bool
dnac_response:
description: A dictionary or list with the response returned by the Cisco Catalyst
Center Python SDK
returned: always
sample: "{\n \"response\": {\n \"taskId\": \"string\",\n \"url\": \"string\"\
\n },\n \"version\": \"string\"\n}\n"
type: dict