cisco.dnac.site_playbook_config_generator module -- Generate YAML playbook for 'site_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.site_playbook_config_generator.
New in cisco.dnac 6.45.0
Synopsis
Generates YAML configurations compatible with the `site_workflow_manager` module, reducing the effort required to manually create Ansible playbooks and enabling programmatic modifications.
The YAML configurations generated represent the site hierarchy (areas, buildings, floors) configured on the Cisco Catalyst Center.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.3.7.9
python >= 3.9
Parameters
Parameter |
Comments |
|---|---|
A dictionary of filters for generating YAML playbook compatible with the `site_workflow_manager` module. Filters specify which components to include in the YAML configuration file. If config is not provided or is empty, all configurations for all sites will be generated. This is useful for complete brownfield infrastructure discovery and documentation. If config is provided but is an empty dictionary, an error will be raised. |
|
Filters to specify which components to include in the YAML configuration file. If filters for specific components (e.g., site) are provided without explicitly including them in components_list, those components will be automatically added to components_list. At least one of components_list or component filters must be provided. |
|
List of components to include in the YAML configuration file. Valid value is If not specified but component filters (site) are provided, those components are automatically added to this list. If neither components_list nor any component filters are provided, an error will be raised. For example, ["site"]. Choices: |
|
Contains site filter expressions for site hierarchy extraction. Supported keys in each list item are Multiple list items are processed independently and merged as a union in the final output.
|
|
Parent site name hierarchy filter. Supports either a single hierarchy string or a list of hierarchy strings. |
|
Site name hierarchy filter. Supports either a single hierarchy string or a list of hierarchy strings. |
|
Site type filter. Valid values are "area", "building", and "floor". Can be a list to match multiple site types. When specified in one site filter item, the same values are applied to sibling hierarchy-only site filter items in the same request to keep union output type-consistent. |
|
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` |
|
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: :ansible-option-default:`"dnac.log"` |
|
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"` |
|
The password for authentication at the Cisco Catalyst Center. |
|
Specifies the port number associated with the Cisco Catalyst Center. Default: :ansible-option-default:`"443"` |
|
Specifies the interval in seconds between successive calls to the API to retrieve task details. Default: :ansible-option-default:`2` |
|
The username for authentication at the Cisco Catalyst Center. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Specifies the version of the Cisco Catalyst Center that the SDK should use. Default: :ansible-option-default:`"2.2.3.3"` |
|
Controls how config is written to the YAML file.
This parameter is only relevant when Choices: |
|
Path where the YAML configuration file will be saved. If not provided, the file will be saved in the current working directory with a default file name "site_playbook_config_<YYYY-MM-DD_HH-MM-SS>.yml". For example, "site_playbook_config_2026-02-24_12-33-20.yml". |
|
The desired state of Cisco Catalyst Center after module execution. 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_sites
Paths used are - GET /dna/intent/api/v1/sites
Auto-population of components_list: If component-specific filters (such as 'site') are provided without explicitly including them in 'components_list', those components will be automatically added to 'components_list'. This simplifies configuration by eliminating the need to redundantly specify components in both places.
Example of auto-population behavior: If you provide filters for 'site' without including 'site' in 'components_list', the module will automatically add 'site' to 'components_list' before processing. This allows you to write more concise playbooks.
Validation requirements: If 'component_specific_filters' is provided, at least one of the following must be true: (1) 'components_list' contains at least one component, OR (2) Component-specific filters (e.g., 'site') are provided. If neither condition is met, the module will fail with a validation error.
Empty config validation: If 'config' is provided but is an empty dictionary, the module will fail with an error. To generate all configurations, either omit 'config' entirely or provide specific filters.
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
See Also
See also
- cisco.dnac.site_workflow_manager
Module for managing site configurations.
- Site Management API
Specific documentation for site operations in Catalyst Center version.
Examples
# Example 1: Generate all configurations (brownfield discovery)
# When config is not provided, all site hierarchy entries are retrieved.
# Optionally specify file_path and file_mode to customize output location.
- name: Generate all site hierarchy configurations
cisco.dnac.site_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/all_sites.yaml" # Optional: specify custom output path
# file_mode: "overwrite" # Optional: "overwrite" or "append"
# Example 2: Filter by parent name hierarchy
# Retrieves a parent site and all its children. Useful for exporting a specific
# branch of your site hierarchy.
- name: Generate configurations for a parent site and its children
cisco.dnac.site_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/parent_hierarchy.yaml"
file_mode: "overwrite"
config:
component_specific_filters:
site:
- parent_name_hierarchy: "Global/USA"
# Example 3: Filter by parent name hierarchy and site type
# Retrieves specific site types (area, building, floor) under a parent hierarchy.
# This is the most practical pattern for targeted site exports.
- name: Generate configurations by parent hierarchy and site type
cisco.dnac.site_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/parent_with_types.yaml"
file_mode: "overwrite"
config:
component_specific_filters:
site:
- parent_name_hierarchy: "Global/USA"
site_type:
- "building"
- "floor"
# Example 4: Filter by specific site name hierarchy
# Retrieves specific sites by their exact hierarchy path without including children.
# Useful when you need just certain sites without their child elements.
- name: Generate configurations for specific sites
cisco.dnac.site_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/specific_sites.yaml"
file_mode: "overwrite"
config:
component_specific_filters:
site:
- site_name_hierarchy:
- "Global/USA/San Francisco"
- "Global/USA/New York"
# Example 5: Combined filters - multiple parents with site types
# Demonstrates combining multiple parent hierarchies with site type filters.
# Results include all specified parents and their children filtered by type.
- name: Generate configurations with multiple parents and site types
cisco.dnac.site_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/combined_filters.yaml"
file_mode: "overwrite"
config:
component_specific_filters:
site:
- parent_name_hierarchy:
- "Global/USA"
- "Global/India"
site_type:
- "building"
- "floor"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary with the response returned by the Cisco Catalyst Center Python SDK Returned: always |
|
A string with the response returned by the Cisco Catalyst Center Python SDK Returned: always |
|
A string with the response returned by the Cisco Catalyst Center Python SDK Returned: always |