cisco.dnac.provision_workflow_manager module – Resource module for provision related functions
Note
This module is part of the cisco.dnac collection (version 6.42.0).
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.provision_workflow_manager.
New in cisco.dnac 6.6.0
Synopsis
Manage operations related to wired and wireless provisioning
API to re-provision provisioned devices
API to un-provision provisioned devices
Un-provisioning refers to removing a device from the inventory list
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk == 2.4.5
python >= 3.9
Parameters
Parameter |
Comments |
|---|---|
List of details of device being managed. |
|
- The name of the Access Point (AP) authorization list to be used during WLC provisioning. - This authorization list defines the security policies and access control rules that govern which APs can join the wireless network. - The authorization list must exist in Cisco Catalyst Center before provisioning and should contain the MAC addresses or certificate-based authentication rules for APs. - Used in conjunction with ‘authorize_mesh_and_non_mesh_aps’ for comprehensive AP management during wireless controller provisioning. - If not specified, the default authorization behavior of the WLC will be applied. |
|
- A list of settings for enabling or disabling application telemetry on a group of network devices. - Supported in Cisco Catalyst version 2.3.7.9 and later. |
|
A list of IP addresses representing the network devices on which application telemetry should be enabled or disabled. |
|
A flag that indicates whether to include guest SSID information when enabling telemetry for wireless devices. Choices:
|
|
- Specifies whether to enable or disable application telemetry on the devices. Choices:
|
|
- Defines the WLAN mode for the device. - Applicable when enabling telemetry on wireless devices Choices:
|
|
- A flag that indicates whether to authorize both mesh and non-mesh Access Points (APs) during the WLC provisioning process. - When set to true, all AP types (mesh and non-mesh) will be automatically authorized to join the wireless network. - When set to false, only specifically configured APs matching the authorization criteria will be authorized. - Mesh APs create wireless backhaul connections to extend network coverage, while non-mesh APs connect directly to the wired infrastructure. - This setting works in conjunction with ‘ap_authorization_list_name’ for complete AP authorization workflow. - Supported from Cisco Catalyst Center release version 2.3.7.6 onwards. type: bool |
|
- A list of dynamic interfaces on the wireless controller. - Each entry represents an interface with associated configuration details. |
|
The gateway IP address for the interface. |
|
The IP address assigned to the interface. |
|
The name of the interface. |
|
The netmask of the interface in CIDR format (e.g., 24 for 255.255.255.0). |
|
The port number or LAG (Link Aggregation Group) identifier. |
|
The VLAN ID associated with the interface. |
|
- A dictionary containing feature template configuration for advanced wireless device provisioning. - Feature templates provide standardized, reusable configuration patterns that ensure consistent deployment across multiple wireless controllers. - Templates enable centralized configuration management, reduce manual errors, and enforce organizational policies. - The specified template must exist in Cisco Catalyst Center before it can be applied during provisioning. - Feature templates can include WLAN configurations, security policies, QoS settings, and other wireless controller parameters. - Supported from Cisco Catalyst Center release version 3.1.3.0 onwards for wireless controller provisioning. |
|
- A list of additional context-specific identifiers that provide customization parameters for the feature template. - These identifiers enable site-specific and WLAN-specific customization of the template during deployment. - Each identifier contains key-value pairs that help adapt the template for specific deployment scenarios and locations. - Multiple identifiers can be specified to support complex deployment requirements with different WLAN profiles and site contexts. |
|
- The site name hierarchy where the feature template should be applied during wireless controller provisioning. - Defines the specific site context for template deployment within the organizational hierarchy. - Must follow the format ‘Global/Area/Building/Floor’ as configured in Cisco Catalyst Center site topology. - The site hierarchy must exist in Cisco Catalyst Center before template application. - Used to apply site-specific configurations and policies defined in the feature template. |
|
- The WLAN profile name to be associated with the feature template during wireless controller provisioning. - This profile defines wireless network parameters including SSID, security settings, VLAN assignments, and QoS policies. - The WLAN profile must exist in Cisco Catalyst Center and be properly configured before template application. - Multiple WLAN profiles can be referenced by specifying multiple additional identifier entries. |
|
- The name of the feature template design to be applied during wireless controller provisioning. - This template name must match exactly with the template name defined in Cisco Catalyst Center. - The template defines standardized configuration parameters, policies, and settings to be applied to the wireless controller. - Template names are case-sensitive and should follow organizational naming conventions. |
|
- A list of specific template attributes to be excluded from the feature template application during wireless controller provisioning. - Use this to selectively apply only certain parts of a template while excluding others that may not be applicable to the specific deployment. - Attribute names must match the exact attribute names defined in the feature template configuration. - This provides fine-grained control over which template configurations are applied, allowing for customized deployments. - Useful for scenarios where most of the template is applicable but specific settings need to be omitted or handled separately. Choices:
|
|
- Determines whether to force reprovisioning of a device. - A device cannot be re-provisioned to a different site. - The ‘provisioning’ option should not be set to ‘false’ for ‘force_provisioning’ to take effect. - Set to ‘true’ to enforce reprovisioning, even if the device is already provisioned. - Set to ‘false’ to skip provisioning for devices that are already provisioned. Choices:
|
|
- Specifies the site locations allocated for Access Points (APs). - Renamed to ‘primary_managed_ap_locations’ starting from Cisco Catalyst version 2.3.7.6 to differentiate between primary and secondary managed AP locations. - Backward compatibility is maintained; either ‘managed_ap_locations’ or ‘primary_managed_ap_locations’ can be specified, with no changes required after upgrades. - Either ‘managed_ap_locations’ or ‘primary_managed_ap_locations’ can be used interchangeably, but only one of them is mandatory and must be provided. |
|
Management Ip Address of the device. |
|
- Specifies the site locations assigned to primary managed Access Points (APs). - Introduced as the updated name for ‘managed_ap_locations’ starting from Cisco Catalyst version 2.3.7.6. - Backward compatible with ‘managed_ap_locations’; either parameter can be specified without requiring changes after upgrades. - Mandatory for provisioning wireless devices if ‘managed_ap_locations’ is not used. - Supported in Cisco Catalyst version 2.3.7.6 and later. |
|
- Specifies whether the user intends to perform site assignment only or full provisioning for a wired device. - Set to ‘false’ to carry out site assignment only. - Set to ‘true’ to proceed with provisioning to a site. - only applicable for wired devices. Choices:
|
|
- Configuration options for performing a rolling upgrade of Access Points (APs) in phases. - Allows control over the gradual rebooting of APs during the upgrade process. - Supported in Cisco Catalyst version 2.3.7.6 and later. |
|
- The percentage of APs to reboot simultaneously during an upgrade. - Supported in Cisco Catalyst version 2.3.7.6 and later. - Must be either 5, 15 or 25 representing the proportion of APs to reboot at once. |
|
- Enable or disable the rolling AP upgrade feature. - If set to ‘true’, APs will be upgraded in batches based on the specified reboot percentage. - Supported in Cisco Catalyst version 2.3.7.6 and later. Choices:
|
|
- Specifies the site locations assigned to secondary managed Access Points (APs). - Introduced in Cisco Catalyst version 2.3.7.6 to allow differentiation between primary and secondary managed AP locations. - Mandatory for provisioning wireless devices in scenarios where secondary AP locations are required. |
|
Name of the site where the device will be added. This parameter is required for provisioning the device and assigning it to a site. |
|
- If set to ‘true’, Access Point (AP) provisioning will be skipped during the workflow. - Use this option when AP provisioning is not required as part of the current operation. - Supported in Cisco Catalyst version 2.3.7.6 and later. Choices:
|
|
Set to true to verify the Cisco Catalyst Center config after applying the playbook config. Choices:
|
|
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. Default: |
|
Indicates whether debugging is enabled in the Cisco Catalyst Center SDK. Choices:
|
|
The hostname of the Cisco Catalyst Center. |
|
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. Choices:
|
|
Determines the mode of the file. Set to True for ‘append’ mode. Set to False for ‘write’ mode. Choices:
|
|
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. Default: |
|
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. Default: |
|
The password for authentication at the Cisco Catalyst Center. |
|
Specifies the port number associated with the Cisco Catalyst Center. Default: |
|
Specifies the interval in seconds between successive calls to the API to retrieve task details. Default: |
|
The username for authentication at the Cisco Catalyst Center. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Specifies the version of the Cisco Catalyst Center that the SDK should use. Default: |
|
The state of Cisco Catalyst Center after module completion. Choices:
|
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Methods used are sites.Sites.get_site, devices.Devices.get_network_device_by_ip, task.Task.get_task_by_id, sda.Sda.get_provisioned_wired_device, sda.Sda.re_provision_wired_device, sda.Sda.provision_wired_device, wireless.Wireless.provision devices.Device.delete_network_device_with_configuration_cleanup, devices.Device.delete_a_network_device_without_configuration_cleanup, application_policy.ApplicationPolicy.enable_application_telemetry_feature_on_multiple_network_devices_v1, application_policy.ApplicationPolicy.disable_application_telemetry_feature_on_multiple_network_devices_v1
Paths used are get /dna/intent/api/v1/site get /dna/intent/api/v1/network-device/ip-address/{ipAddress} get /dna/intent/api/v1/task/{taskId} get /dna/intent/api/v1/business/sda/provision-device put /dna/intent/api/v1/business/sda/provision-device post /dna/intent/api/v1/business/sda/provision-device post /dna/intent/api/v1/wireless/provision delete /dna/intent/api/v1/networkDevices/deleteWithCleanup delete /dna/intent/api/v1/networkDevices/deleteWithoutCleanup post /dna/intent/api/v1/applicationVisibility/networkDevices/enableAppTelemetry post /dna/intent/api/v1/applicationVisibility/networkDevices/disableAppTelemetry
Added ‘provisioning’ option in v6.16.0
Added provisioning and reprovisioning of wireless devices in v6.16.0
Does not support
check_modeThe plugin runs on the control node and does not use any ansible connection plugins instead embedded connection manager from Cisco Catalyst Center SDK
The parameters starting with dnac_ are used by the Cisco Catalyst Center Python SDK to establish the connection
Examples
---
- name: Provision a wireless device to a site
cisco.dnac.provision_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: true
state: merged
config:
- site_name_hierarchy: Global/USA/San Francisco/BGL_18
management_ip_address: 204.192.3.40
managed_ap_locations:
- Global/USA/San Francisco/BGL_18/Test_Floor2
dynamic_interfaces:
- vlan_id: 1866
interface_name: Vlan1866
interface_ip_address: 204.192.6.200
interface_gateway: 204.192.6.1
- name: Provision a wireless device to a site for version
- 2.3.7.6
cisco.dnac.provision_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: true
state: merged
config:
- site_name_hierarchy: Global/USA/San Francisco/BGL_18
management_ip_address: 204.192.3.40
primary_managed_ap_locations:
- Global/USA/San Francisco/BGL_18/Test_Floor2
secondary_managed_ap_locations:
- Global/USA/San Francisco/BGL_18/Test_Floor1
dynamic_interfaces:
- interface_name: Vlan1866
vlan_id: 1866
interface_ip_address: 204.192.6.200
interface_gateway: 204.192.6.1
skip_ap_provision: false
rolling_ap_upgrade:
enable_rolling_ap_upgrade: false
ap_reboot_percentage: 5
ap_authorization_list_name: "AP-Auth-List"
authorize_mesh_and_non_mesh_aps: true
- name: Provision a wired device to a site
cisco.dnac.provision_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: true
state: merged
config:
- site_name_hierarchy: Global/USA/San Francisco/BGL_18
management_ip_address: 204.192.3.40
- name: Re-Provision a wired device to a site forcefully
cisco.dnac.provision_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: true
state: merged
config:
- site_name_hierarchy: Global/USA/San Francisco/BGL_18
management_ip_address: 204.192.3.40
force_provisioning: true
- name: Assign a wired device to a site
cisco.dnac.provision_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: true
state: merged
config:
- site_name_hierarchy: Global/USA/San Francisco/BGL_18
management_ip_address: 204.192.3.40
provisioning: false
- name: Provision a wireless device to a site
cisco.dnac.provision_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: true
state: merged
config_verify: true
config:
- site_name_hierarchy: Global/USA/RTP/BLD11
management_ip_address: 204.192.12.201
managed_ap_locations:
- Global/USA/RTP/BLD11/BLD11_FLOOR1
- name: Unprovision a device from a site
cisco.dnac.provision_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: true
state: deleted
config_verify: true
config:
- management_ip_address: 204.1.2.2
- name: Unprovision a device from a site
cisco.dnac.provision_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: true
state: deleted
config_verify: true
config:
- management_ip_address: 204.1.2.2
clean_config: true
- name: Configure application telemetry for network
devices on Cisco Catalyst Center
hosts: localhost
connection: local
gather_facts: false
vars_files:
- "credentials.yml"
tasks:
- name: Enable application telemetry on specified
network devices
cisco.dnac.provision_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: true
dnac_log_level: DEBUG
config_verify: false
dnac_api_task_timeout: 1000
dnac_task_poll_interval: 1
state: merged
config:
- application_telemetry:
- device_ips: ["204.1.1.2", "204.192.6.200"]
telemetry: enable
wlan_mode: LOCAL
include_guest_ssid: true
- name: Configure application telemetry for network
devices on Cisco Catalyst Center
hosts: localhost
connection: local
gather_facts: false
vars_files:
- "credentials.yml"
tasks:
- name: Disable application telemetry on specified
network devices
cisco.dnac.provision_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: true
dnac_log_level: DEBUG
config_verify: false
dnac_api_task_timeout: 1000
dnac_task_poll_interval: 1
state: merged
config:
- application_telemetry:
- device_ips: ["204.1.1.2", "204.192.6.200"]
telemetry: disable
- name: Provision a wireless device to a site with feature template
cisco.dnac.provision_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: true
dnac_log_level: DEBUG
config_verify: false
dnac_api_task_timeout: 1000
dnac_task_poll_interval: 1
state: merged
config:
- site_name_hierarchy: Global/USA/SAN JOSE/BLD23
management_ip_address: 204.192.4.2
primary_managed_ap_locations:
- Global/USA/SAN JOSE/BLD23/FLOOR1_LEVEL2
feature_template:
- design_name: newtest
additional_identifiers:
wlan_profile_name: ARUBA_SSID_profile
site_name_hierarchy: Global/USA/SAN JOSE/BLD23
excluded_attributes: ["guest_ssid_settings", "bandwidth_limits"]
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary with details of provision is returned Returned: always Sample: |
|
A list with the response returned by the Cisco Catalyst Center Python SDK Returned: always Sample: |
|
A dictionary with the exisiting details as returned by the Cisco Cisco Catalyst Center Python SDK Returned: always Sample: |
Authors
Abinash Mishra (@abimishr) Madhan Sankaranarayanan (@madhansansel) Syed Khadeer Ahmed(@syed-khadeerahmed) Ajith Andrew J (@ajithandrewj)