cisco.dnac.sda_fabric_transits_playbook_config_generator module -- Generate YAML configurations playbook for sda_fabric_transits_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.sda_fabric_transits_playbook_config_generator.
New in cisco.dnac 6.44.0
Synopsis
Generates YAML configurations compatible with the
sda_fabric_transits_workflow_managermodule, reducing the effort required to manually create Ansible playbooks and enabling programmatic modifications.
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 `sda_fabric_transits_workflow_manager` module. Filters specify which components to include in the YAML configuration file. If config is not provided (omitted entirely), all configurations for sda fabric transits will be generated. This is useful for complete brownfield infrastructure discovery and documentation. Important - An empty dictionary {} is not valid. Either omit 'config' entirely to generate all configurations, or provide specific filters within 'config'. |
|
Filters to specify which components to include in the YAML configuration file. If filters for specific components (e.g., sda_fabric_transits) 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 values are - Fabric Transits For example, ["sda_fabric_transits"]. If not specified, all components are included. Choices: |
|
Fabric transits to filter by name or transit type. |
|
Transit name to filter fabric transits by name. |
|
Transit type to filter fabric transits by type. Valid values are IP_BASED_TRANSIT, SDA_LISP_PUB_SUB_TRANSIT, SDA_LISP_BGP_TRANSIT |
|
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 For example, |
|
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
Cisco Catalyst Center >= 2.3.7.9
SDK Methods used are sites.Sites.get_site sda.Sda.get_transit_networks network_device.NetworkDevice.get_device_list
SDK Paths used are GET /dna/intent/api/v1/sites GET /dna/intent/api/v1/network-device
Auto-population of components_list: If component-specific filters (such as 'sda_fabric_transits') 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 'sda_fabric_transits' without including 'sda_fabric_transits' in 'components_list', the module will automatically add 'sda_fabric_transits' 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., 'sda_fabric_transits') are provided. If neither condition is met, the module will fail with a validation error.
Module result behavior (changed/ok/failed): The module result reflects local file state only, not Catalyst Center state. In overwrite mode, the full file content is compared (excluding volatile fields like timestamps and playbook path). In append mode, only the last YAML document in the file is compared against the newly generated configuration. If a file contains multiple config entries from previous appends, only the most recent entry is used for the idempotency check. - changed=true (status: success): The generated YAML configuration differs
from the existing output file (or the file does not exist). The file was written and the configuration was updated.
changed=false (status: ok): The generated YAML configuration matches the existing output file content. The write was skipped as the file is already up-to-date.
failed=true (status: failed): The module encountered a validation error, API failure, or file write error. No file was written or modified.
Note: Re-running with identical inputs and unchanged Catalyst Center state will produce changed=false, ensuring idempotent playbook behavior.
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.sda_fabric_transits_workflow_manager
Module for managing fabric transits in Cisco Catalyst Center.
Examples
- name: Auto-generate YAML Configuration for all fabric transits
cisco.dnac.sda_fabric_transits_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
# No config provided - generates all configurations
- name: Generate YAML Configuration with File Path specified
cisco.dnac.sda_fabric_transits_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_config.yml"
file_mode: "overwrite"
# No config provided - generates all configurations
- name: Generate YAML Configuration with specific fabric transits components only
cisco.dnac.sda_fabric_transits_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_fabric_transits_config.yml"
file_mode: "append"
config:
component_specific_filters:
components_list: ["sda_fabric_transits"]
- name: Generate YAML Configuration for fabric transits with transit type filter
cisco.dnac.sda_fabric_transits_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_fabric_transits_config.yml"
config:
component_specific_filters:
components_list: ["sda_fabric_transits"] # Optional
sda_fabric_transits:
- transit_type: "IP_BASED_TRANSIT"
- transit_type: "SDA_LISP_BGP_TRANSIT"
- name: Generate YAML Configuration for fabric transits with name filter
cisco.dnac.sda_fabric_transits_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_fabric_transits_config.yml"
config:
component_specific_filters:
components_list: ["sda_fabric_transits"] # Optional
sda_fabric_transits:
- name: "Transit1"
- name: "Transit2"
- name: Generate YAML Configuration for fabric transits with name and type filter
cisco.dnac.sda_fabric_transits_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_fabric_transits_config.yml"
config:
component_specific_filters:
components_list: ["sda_fabric_transits"] # Optional
sda_fabric_transits:
- name: "Transit1"
transit_type: "IP_BASED_TRANSIT"
- name: "Transit2"
transit_type: "SDA_LISP_PUB_SUB_TRANSIT"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary with 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 |