cisco.dnac.sda_extranet_policies_playbook_config_generator module -- Generate YAML playbooks for SDA extranet policies from existing configurations.

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

New in cisco.dnac 6.45.0

Synopsis

• Generates YAML playbooks compatible with the sda_extranet_policies_workflow_manager module by extracting existing SDA extranet policy configurations from Cisco Catalyst Center.

• Reduces manual effort by programmatically retrieving extranet policy details including provider virtual networks, subscriber virtual networks, and fabric site assignments.

• Supports selective filtering by extranet policy name to generate targeted playbooks.

• Enables complete infrastructure discovery with auto-generation mode when generate_all_configurations is enabled.

• Resolves fabric site UUIDs to human-readable site hierarchy paths for generated playbooks.

• Requires Cisco Catalyst Center version 2.3.7.9 or higher for SDA extranet policy API support.

Requirements

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

• dnacentersdk >= 2.10.10

• python >= 3.9

• Cisco Catalyst Center >= 2.3.7.9

• Requires minimum Cisco Catalyst Center version 2.3.7.9 for SDA extranet policies API support.

• Module will fail with an error if connected to an unsupported version.

• Generated playbooks are compatible with the sda_extranet_policies_workflow_manager module for extranet policy management operations.

• Fabric site UUIDs are automatically resolved to human-readable site hierarchy paths in the generated playbook.

• The module operates in check mode but does not make any changes to Cisco Catalyst Center.

• Use dnac_log and dnac_log_level parameters for detailed operation logging and troubleshooting.

Parameters

Parameter	Comments
config dictionary	A dictionary of filters for generating YAML playbook compatible with the sda_extranet_policies_workflow_manager module. Filters specify which components to include in the YAML configuration file. If "components_list" is specified, only those components are included, regardless of the filters. If config is not provided or is empty, all configurations for all extranet policies will be generated. This is useful for complete brownfield infrastructure discovery and documentation.
component_specific_filters dictionary / required	Filters to specify which components to include in the YAML configuration file. This parameter is mandatory when config is provided. Omitting it or providing an empty value will result in a validation error. If components_list is specified, only those components are included, regardless of other filters. If filters for specific components (e.g., extranet_policies) are provided without explicitly including them in components_list, those components will be automatically added to components_list.
components_list list / elements=string	List of component types to include in the generated YAML playbook. Currently supports only extranet_policies for SDA extranet policy configurations. If omitted, all supported components are included by default. Choices: :ansible-option-choices-entry:`"extranet\_policies"`
extranet_policies list / elements=dictionary	Filters for retrieving specific extranet policy configurations from Cisco Catalyst Center. Multiple filter entries can be specified to target different policies. If no filters are provided, all extranet policies are retrieved.
extranet_policy_name string	Name of the extranet policy to filter. Must match the exact policy name as configured in Cisco Catalyst Center. Example: Test_1
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 config is written to the YAML file. overwrite replaces existing file content. append appends generated YAML content to the existing file. This parameter is only relevant when file_path is specified. Defaults to overwrite. Choices: :ansible-option-choices-entry-default:`"overwrite"` ← (default) :ansible-option-choices-entry:`"append"`
file_path string	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 sda_extranet_policies_playbook_config_<YYYY-MM-DD_HH-MM-SS>.yml. For example, sda_extranet_policies_playbook_config_2026-01-30_19-16-01.yml.
state string	The desired state for the module operation. Only gathered state is supported to generate YAML playbooks from existing configurations. 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 - sites.Sites.get_site - sda.Sda.get_extranet_policies - sda.Sda.get_fabric_sites - sda.Sda.get_fabric_zones - sda.Sda.get_fabric_sites_by_id - sda.Sda.get_fabric_zones_by_id

• Paths used are - GET /dna/intent/api/v1/sites - GET /dna/intent/api/v1/sda/extranet-policies - GET /dna/intent/api/v1/sda/fabric-sites - GET /dna/intent/api/v1/sda/fabric-zones - GET /dna/intent/api/v1/sda/fabric-sites/{id} - GET /dna/intent/api/v1/sda/fabric-zones/{id}

• 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

See Also

See also

cisco.dnac.sda_extranet_policies_workflow_manager

Manage SDA extranet policies in Cisco Catalyst Center

Examples

# Example 1: Generate all configurations (default behavior when config is omitted)
- name: Generate YAML playbook for all SDA extranet policies
  cisco.dnac.sda_extranet_policies_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: DEBUG
    state: gathered
    # No config provided - generates all configurations

# Example 2: Generate all configurations with custom file path
- name: Generate complete SDA extranet policies configuration with custom filename
  cisco.dnac.sda_extranet_policies_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: DEBUG
    state: gathered
    file_path: "/tmp/complete_sda_extranet_policies_config.yaml"
    file_mode: "overwrite"
    # No config provided - generates all configurations

# Example 3: Generate extranet policies configurations for a specific policy
- name: Generate YAML playbook for specific extranet policy by name
  cisco.dnac.sda_extranet_policies_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: DEBUG
    state: gathered
    file_path: "/tmp/policy_specific.yaml"
    file_mode: "overwrite"
    config:
      component_specific_filters:
        components_list:
          - extranet_policies
        extranet_policies:
          - extranet_policy_name: "Test_1"

# Example 4: Generate configuration for multiple specific extranet policies
- name: Generate YAML playbook for multiple specific extranet policies
  cisco.dnac.sda_extranet_policies_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: DEBUG
    state: gathered
    file_path: "/tmp/selected_extranet_policies.yaml"
    file_mode: "overwrite"
    config:
      component_specific_filters:
        components_list:
          - extranet_policies
        extranet_policies:
          - extranet_policy_name: "Test_1"
          - extranet_policy_name: "Test_2"
          - extranet_policy_name: "Test_3"

# Example 5: Auto-populate components_list from component filters
- name: Generate configuration with auto-populated components_list
  cisco.dnac.sda_extranet_policies_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: DEBUG
    state: gathered
    file_path: "/tmp/test_policy.yaml"
    file_mode: "overwrite"
    config:
      component_specific_filters:
        # No components_list specified, but extranet_policies filters are provided
        # The 'extranet_policies' component will be automatically added to components_list
        extranet_policies:
          - extranet_policy_name: "Test_1"

# Example 6: Generate configuration with append mode
- name: Generate and append SDA extranet policies configuration
  cisco.dnac.sda_extranet_policies_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: DEBUG
    state: gathered
    file_path: "/tmp/all_extranet_policies.yaml"
    file_mode: "append"
    config:
      component_specific_filters:
        components_list:
          - extranet_policies
        extranet_policies:
          - extranet_policy_name: "Test_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 the response returned by the Cisco Catalyst Center Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"msg": {"YAML config generation Task succeeded for module 'sda\_extranet\_policies\_workflow\_manager'": {"file\_path": "sda\_extranet\_policies\_playbook\_config\_2026-02-03\_15-22-02.yml"}}, "response": {"YAML config generation Task succeeded for module 'sda\_extranet\_policies\_workflow\_manager'": {"file\_path": "sda\_extranet\_policies\_playbook\_config\_2026-02-03\_15-22-02.yml"}}}`
response_2 dictionary	A string with the response returned by the Cisco Catalyst Center Python SDK Returned: on failure Sample: :ansible-rv-sample-value:`{"msg": "YAML config generation Task failed for module 'sda\_extranet\_policies\_workflow\_manager': Invalid file path", "response": []}`

Authors

• Apoorv Bansal (@Apoorv74-dot)

• Madhan Sankaranarayanan (@madhansansel)

Collection links

Issue Tracker Repository (Sources)