cisco.dnac.provision_playbook_config_generator module -- Generate YAML playbook for 'provision_workflow_manager' module.

Note

This module is part of the cisco.dnac collection (version 6.49.0).

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

New in cisco.dnac 6.44.0

Synopsis

• Generates YAML configurations compatible with the `provision_workflow_manager` module, reducing the effort required to manually create Ansible playbooks and enabling programmatic modifications.

• The YAML configurations generated represent the provisioned devices configured on the Cisco Catalyst Center.

Requirements

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

• dnacentersdk >= 2.7.2

• python >= 3.9

Parameters

Parameter	Comments
config dictionary	Configuration dictionary controlling component filters for provisioned device extraction. When provided, only component_specific_filters is supported. To generate all configurations, omit config.
component_specific_filters dictionary	Filters to specify which components to include in the YAML configuration file. Mandatory when config is provided. If "components_list" is specified, only those components are included, regardless of other filters.
components_list list / elements=string	List of components to include in the YAML configuration file. Valid values are - Wired Devices "wired" - Wireless Devices "wireless" Duplicate component names are not allowed. Required and non-empty when no component-specific filter block is provided. If wired/wireless filter blocks are provided, missing component names are auto-added. For example, ["wired", "wireless"]. Choices: :ansible-option-choices-entry:`"wired"` :ansible-option-choices-entry:`"wireless"`
wired list / elements=dictionary	Wired devices to filter devices by management IP, site name, or device family.
device_family list / elements=string	One or more device families to filter devices by type (e.g., 'Switches and Hubs', 'Routers'). A single string is normalized to a one-item list for backward compatibility.
management_ip_address list / elements=string	One or more management IP addresses to filter devices by IP address. A single string is normalized to a one-item list for backward compatibility.
site_name_hierarchy list / elements=string	Site name hierarchy to filter devices by site. Can specify single site or list of sites.
wireless list / elements=dictionary	Wireless devices to filter devices by management IP, site name, or device family.
device_family list / elements=string	One or more device families to filter devices by type (e.g., 'Wireless Controller'). A single string is normalized to a one-item list for backward compatibility.
management_ip_address list / elements=string	One or more management IP addresses to filter devices by IP address. A single string is normalized to a one-item list for backward compatibility.
site_name_hierarchy list / elements=string	Site name hierarchy to filter devices by site. Can specify single site or list of sites.
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: :ansible-option-default:`1200`
dnac_debug boolean	Indicates whether debugging is enabled in the Cisco Catalyst Center SDK. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`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: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
dnac_log_append boolean	Determines the mode of the file. Set to True for 'append' mode. Set to False for 'write' mode. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`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: :ansible-option-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: :ansible-option-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: :ansible-option-default:`"443"`
dnac_task_poll_interval integer	Specifies the interval in seconds between successive calls to the API to retrieve task details. Default: :ansible-option-default:`2`
dnac_username aliases: user string	The username for authentication at the Cisco Catalyst Center. Default: :ansible-option-default:`"admin"`
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
dnac_version string	Specifies the version of the Cisco Catalyst Center that the SDK should use. Default: :ansible-option-default:`"2.2.3.3"`
file_mode string	Controls how generated YAML is written when file_path is provided. overwrite creates or replaces the file. append appends to an existing file. Default: :ansible-option-default:`"overwrite"`
file_path string	Path where the YAML configuration file will be saved. If not provided, a default filename is generated in the current working directory.
state string	The desired state of Cisco Catalyst Center after module execution. Choices: :ansible-option-choices-entry-default:`"gathered"` ← (default)
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 Methods used are - sda.Sda.get_provisioned_devices - devices.Devices.get_network_device_by_ip - devices.Devices.get_device_detail - sites.Sites.get_site - wireless.Wireless.get_access_point_configuration - wireless.Wireless.get_primary_managed_ap_locations_for_specific_wireless_controller - wireless.Wireless.get_secondary_managed_ap_locations_for_specific_wireless_controller

• Paths used are - GET /dna/intent/api/v1/sda/provisioned-devices - GET /dna/intent/api/v1/network-device/ip-address/{ipAddress} - GET /dna/intent/api/v1/network-device/{id}/detail - GET /dna/intent/api/v1/site - GET /dna/intent/api/v1/wireless/accesspoint-configuration/summary - GET /dna/intent/api/v1/wireless/primary-managed-ap-locations/{networkDeviceId} - GET /dna/intent/api/v1/wireless/secondary-managed-ap-locations/{networkDeviceId}

• 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: Generate YAML for all provisioned devices (omit config)
  cisco.dnac.provision_playbook_config_generator:
    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: "{{dnac_log_level}}"
    state: gathered
    file_path: "/tmp/catc_all_provisioned_devices.yaml"

- name: Generate YAML with specific wired component
  cisco.dnac.provision_playbook_config_generator:
    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: "{{dnac_log_level}}"
    state: gathered
    file_path: "/tmp/catc_provision_config.yaml"
    config:
      component_specific_filters:
        components_list: ["wired"]

- name: Generate YAML for wireless devices with site filter
  cisco.dnac.provision_playbook_config_generator:
    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: "{{dnac_log_level}}"
    state: gathered
    file_path: "/tmp/catc_site_wireless_config.yaml"
    config:
      component_specific_filters:
        components_list: ["wireless"]
        wireless:
          - site_name_hierarchy:
              - "Global/USA/San Francisco/BGL_18"

- name: Generate YAML in append mode
  cisco.dnac.provision_playbook_config_generator:
    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: "{{dnac_log_level}}"
    state: gathered
    file_path: "/tmp/catc_provision_config.yaml"
    file_mode: append
    config:
      component_specific_filters:
        components_list: ["wired", "wireless"]
        wired:
          - management_ip_address:
              - "204.1.2.9"
            device_family:
              - "Switches and Hubs"

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 the response returned by the Cisco Catalyst Center Python SDK Returned: always Sample: :ansible-rv-sample-value:`"{\\n \\"response\\":\\n {\\n \\"response\\": String,\\n \\"version\\": String\\n },\\n \\"msg\\": String\\n}\\n"`
response_2 list / elements=string	A string with the response returned by the Cisco Catalyst Center Python SDK Returned: always Sample: :ansible-rv-sample-value:`["{\\n \\"response\\": []", "\\n \\"msg\\": String\\n}\\n"]`

Authors

• Syed Khadeer Ahmed (@syed-khadeerahmed)

• Madhan Sankaranarayanan (@madhansansel)

Collection links

Issue Tracker Repository (Sources)