cisco.dnac.sda_fabric_transits_workflow_manager module -- Resource module for SDA fabric transits

Note

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

New in cisco.dnac 6.18.0

Synopsis 

Manage operations on SDA fabric transits.
API to create transit networks.
API to update transit networks.
API to delete transit networks.

Requirements 

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

dnacentersdk >= 2.9.2
python >= 3.9

Parameters 

Parameter	Comments
config list / elements=dictionary / required	A list of SDA fabric transit configurations. Each entry in the list represents a transit network configuration.
sda_fabric_transits list / elements=dictionary	SDA fabric transit configurations.
ip_transit_settings dictionary	The configuration settings for IP based transit. Required when the type is set to IP_BASED_TRANSIT. IP_BASED_TRANSIT cannot be updated.
autonomous_system_number string	Used by routing protocols like BGP to manage routing between different autonomous systems. Autonomous System Number (ANS) should be from 1 to 4294967295. The ASN should be unique for every IP-based transits. Required when the transit_type is set to IP_BASED_TRANSIT.
routing_protocol_name string	Defines the protocol for determining the best paths for data transmission between networks. Choices: :ansible-option-choices-entry-default:`"BGP"` ← (default)
name string	The name of the SDA fabric transit. It facilitates seamless communication between different network segments. Required for the operations in the SDA fabric transits.
sda_transit_settings dictionary	The configuration settings for SDA-based transit. Required when the transit_type is set to SDA_LISP_PUB_SUB_TRANSIT or SDA_LISP_BGP_TRANSIT.
control_plane_network_device_ips list / elements=string	Specifies the IP addresses of the network devices that form the control plane. Required when the transit_type is set to either SDA_LISP_BGP_TRANSIT or SDA_LISP_PUB_SUB_TRANSIT. Atleast one control plane network device is required. A maximum of 2 control plane network devices are allowed when the transit_type is SDA_LISP_BGP_TRANSIT. A maximum of 4 control plane network devices are allowed when the transit_type is SDA_LISP_PUB_SUB_TRANSIT. SDA_LISP_PUB_SUB_TRANSIT supports only devices with IOS XE 17.6 or later. The devices must be present in the Fabric site or zone.
is_multicast_over_transit_enabled boolean	Determines whether multicast traffic is permitted to traverse the transit network. Enabling this option allows the distribution of data to multiple recipients across different network segments. Available only when the transit type is set to SDA_LISP_PUB_SUB_TRANSIT. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
transit_type string	Type of the fabric tranist. IP_BASED_TRANSIT - Responsible for managing IP routing and ensures data flow between various segments of the network. SDA_LISP_PUB_SUB_TRANSIT - Facilitates the decoupling of location and identity information for devices, enabling dynamic routing. SDA_LISP_BGP_TRANSIT - Integrates LISP with BGP to manage and optimize routing decisions between different network segments. Choices: :ansible-option-choices-entry-default:`"IP\_BASED\_TRANSIT"` ← (default) :ansible-option-choices-entry:`"SDA\_LISP\_PUB\_SUB\_TRANSIT"` :ansible-option-choices-entry:`"SDA\_LISP\_BGP\_TRANSIT"`
config_verify boolean	Set to True to verify the Cisco Catalyst Center after applying the playbook config. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`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: :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"`
state string	The state of Cisco Catalyst Center after module completion. Choices: :ansible-option-choices-entry-default:`"merged"` ← (default) :ansible-option-choices-entry:`"deleted"`
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 Method used are devices.Devices.get_device_list, sda.Sda.get_transit_networks, sda.Sda.add_transit_networks, sda.Sda.update_transit_networks, sda.Sda.delete_transit_network_by_id, task.Task.get_tasks_by_id, task.Task.get_task_details_by_id,
Paths used are get /dna/intent/api/v1/network-device, get /dna/intent/api/v1/sda/transitNetworks, post /dna/intent/api/v1/sda/transitNetworks, put /dna/intent/api/v1/sda/transitNetworks, delete /dna/intent/api/v1/sda/transitNetworks/${id}, get /dna/intent/api/v1/tasks/${id} get /dna/intent/api/v1/tasks/${id}/detail
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: Create SDA fabric transit of transit_type IP_BASED_TRANSIT
  cisco.dnac.sda_fabric_transits_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
    dnac_log_level: "{{ dnac_log_level }}"
    state: merged
    config_verify: True
    config:
    - sda_fabric_transits:
      - name: sample_transit
      transit_type: IP_BASED_TRANSIT
      ip_transit_settings:
        routing_protocol_name: BGP
        autonomous_system_number: 1234

- name: Create SDA fabric transit of transit_type SDA_LISP_BGP_TRANSIT
  cisco.dnac.sda_fabric_transits_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
    dnac_log_level: "{{ dnac_log_level }}"
    state: merged
    config_verify: True
    config:
    - sda_fabric_transits:
      - name: sample_transit
      transit_type: SDA_LISP_BGP_TRANSIT
      sda_transit_settings:
        control_plane_network_device_ips:
        - string
        - string

- name: Create SDA fabric transit of transit_type SDA_LISP_PUB_SUB_TRANSIT
  cisco.dnac.sda_fabric_transits_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
    dnac_log_level: "{{ dnac_log_level }}"
    state: merged
    config_verify: True
    config:
    - sda_fabric_transits:
      - name: sample_transit
      transit_type: SDA_LISP_PUB_SUB_TRANSIT
      sda_transit_settings:
        is_multicast_over_transit_enabled: false
        control_plane_network_device_ips:
        - string
        - string
        - string
        - string

- name: Update SDA fabric transit of transit_type SDA_LISP_BGP_TRANSIT
  cisco.dnac.sda_fabric_transits_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
    dnac_log_level: "{{ dnac_log_level }}"
    state: merged
    config_verify: True
    config:
    - sda_fabric_transits:
      - name: sample_transit
      transit_type: SDA_LISP_BGP_TRANSIT
      sda_transit_settings:
        control_plane_network_device_ips:
        - string
        - string

- name: Update the multicast over transit
  cisco.dnac.sda_fabric_transits_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
    dnac_log_level: "{{ dnac_log_level }}"
    state: merged
    config_verify: True
    config:
    - sda_fabric_transits:
      - name: sample_transit
      transit_type: SDA_LISP_PUB_SUB_TRANSIT
      sda_transit_settings:
        is_multicast_over_transit_enabled: true

- name: Update the control plane network devices
  cisco.dnac.sda_fabric_transits_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
    dnac_log_level: "{{ dnac_log_level }}"
    state: merged
    config_verify: True
    config:
    - sda_fabric_transits:
      - name: sample_transit
      transit_type: SDA_LISP_PUB_SUB_TRANSIT
      sda_transit_settings:
        control_plane_network_device_ips:
        - string
        - string
        - string

- name: Delete SDA fabric transit
  cisco.dnac.sda_fabric_transits_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
    dnac_log_level: "{{ dnac_log_level }}"
    state: deleted
    config_verify: True
    config:
    - sda_fabric_transits:
      - name: sample_transit1
      - name: sample_transit2

Return Values 

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

Key	Description
response_1 dictionary	A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`
response_2 dictionary	A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`
response_3 dictionary	A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

Muthu Rakesh (@MUTHU-RAKESH-27) Madhan Sankaranarayanan (@madhansansel)

Collection links

Issue Tracker Repository (Sources)

cisco.dnac.sda_fabric_transits_workflow_manager module -- Resource module for SDA fabric transits

Synopsis

Requirements

Parameters

Notes

Examples

Return Values