You are reading an older version of the Ansible documentation. Use the version selection to the left if you want the latest (stable) released version.

cisco.dnac.provision_workflow_manager module – Resource module for provision related functions

Note

This module is part of the cisco.dnac collection (version 6.25.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

Requirements 

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

dnacentersdk == 2.4.5
python >= 3.9

Parameters 

Parameter	Comments
config list / elements=dictionary / required	List of details of device being managed.
dynamic_interfaces list / elements=dictionary	A list of dynamic interfaces on the wireless controller. Each entry represents an interface with associated configuration details.
interface_gateway string	The gateway IP address for the interface.
interface_ip_address string	The IP address assigned to the interface.
interface_name string	The name of the interface.
interface_netmask_in_c_i_d_r string	The netmask of the interface in CIDR format (e.g., 24 for 255.255.255.0).
lag_or_port_number string	The port number or LAG (Link Aggregation Group) identifier.
vlan_id string	The VLAN ID associated with the interface.
force_provisioning boolean	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. Applicable only for wired devices. 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: `false` ← (default) `true`
managed_ap_locations list / elements=string	Location of the sites allocated for the APs. This is mandatory for provisioning of wireless devices.
management_ip_address string / required	Management Ip Address of the device.
primary_managed_ap_locations list / elements=string	List of site locations assigned to primary managed Access Points (APs). Required for provisioning wireless devices if the managed AP location is not set. Supported in Cisco Catalyst version 2.3.7.6 and later.
provisioning boolean	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. Choices: `false` `true` ← (default)
rolling_ap_upgrade dictionary	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.
ap_reboot_percentage integer	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_rolling_ap_upgrade boolean	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: `false` ← (default) `true`
secondary_managed_ap_locations list / elements=string	List of site locations assigned to secondary managed Access Points (APs). Required for provisioning wireless devices if the managed AP location is not set. Supported in Cisco Catalyst version 2.3.7.6 and later.
site_name_hierarchy string / 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.
skip_ap_provision boolean	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: `false` ← (default) `true`
config_verify boolean	Set to true to verify the Cisco Catalyst Center config after applying the playbook config. Choices: `false` ← (default) `true`
dnac_api_task_timeout integer	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: `1200`
dnac_debug boolean	Indicates whether debugging is enabled in the Cisco Catalyst Center SDK. Choices: `false` ← (default) `true`
dnac_host string / required	The hostname of the Cisco Catalyst Center.
dnac_log boolean	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: `false` ← (default) `true`
dnac_log_append boolean	Determines the mode of the file. Set to True for ‘append’ mode. Set to False for ‘write’ mode. Choices: `false` `true` ← (default)
dnac_log_file_path string	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: `"dnac.log"`
dnac_log_level string	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: `"WARNING"`
dnac_password string	The password for authentication at the Cisco Catalyst Center.
dnac_port string	Specifies the port number associated with the Cisco Catalyst Center. Default: `"443"`
dnac_task_poll_interval integer	Specifies the interval in seconds between successive calls to the API to retrieve task details. Default: `2`
dnac_username aliases: user string	The username for authentication at the Cisco Catalyst Center. Default: `"admin"`
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: `false` `true` ← (default)
dnac_version string	Specifies the version of the Cisco Catalyst Center that the SDK should use. Default: `"2.2.3.3"`
state string	The state of Cisco Catalyst Center after module completion. Choices: `"merged"` ← (default) `"deleted"`
validate_response_schema boolean	Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: `false` `true` ← (default)

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
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
Added ‘provisioning’ option in v6.16.0
Added provisioning and reprovisioning of wireless devices in v6.16.0
Does not support check_mode
The 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

- 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

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
response_1 dictionary	A dictionary with details of provision is returned Returned: always Sample: `"{\n \"response\":\n {\n \"response\": String,\n \"version\": String\n },\n \"msg\": String\n}\n"`
response_2 list / elements=string	A list with the response returned by the Cisco Catalyst Center Python SDK Returned: always Sample: `["{\n \"response\": []", "\n \"msg\": String\n}\n"]`
response_3 dictionary	A dictionary with the exisiting details as returned by the Cisco Cisco Catalyst Center Python SDK Returned: always Sample: `"{\n \"response\": String,\n \"msg\": String\n}\n"`

Authors

Abinash Mishra (@abimishr) Madhan Sankaranarayanan (@madhansansel) Syed Khadeer Ahmed(@syed-khadeerahmed) Ajith Andrew J (@ajithandrewj)

cisco.dnac.provision_workflow_manager module – Resource module for provision related functions

Synopsis

Requirements

Parameters

Notes

Examples

Return Values

Authors

Collection links

Synopsis 

Requirements 

Parameters 

Notes 

Examples 

Return Values 