cisco.dnac.sda_transit_networks module -- Resource module for Sda Transit Networks

Note

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

New in cisco.dnac 6.15.0

Synopsis

• This module represents an alias of the module sda_transit_networks_v1

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.4.9

• python >= 3.5

Parameters

Parameter	Comments
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
dnac_host string / required	The Cisco DNA Center hostname.
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port integer	The Cisco DNA Center port. Default: :ansible-option-default:`443`
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. 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	Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"2.3.7.6"`
payload list / elements=dictionary	Sda Transit Networks's payload.
id string	ID of the transit network (updating this field is not allowed).
ipTransitSettings dictionary	Sda Transit Networks's ipTransitSettings.
autonomousSystemNumber string	Autonomous System Number of the IP transit network. Allowed range is 1 to 4294967295 (updating this field is not allowed).
routingProtocolName string	Routing Protocol Name of the IP transit network (updating this field is not allowed).
name string	Name of the transit network (updating this field is not allowed).
sdaTransitSettings dictionary	Sda Transit Networks's sdaTransitSettings.
controlPlaneNetworkDeviceIds list / elements=string	List of network device IDs that will be used as control plane nodes. Maximum 2 network device IDs can be provided for transit of type SDA_LISP_BGP_TRANSIT and maximum 4 network device IDs can be provided for transit of type SDA_LISP_PUB_SUB_TRANSIT.
isMulticastOverTransitEnabled boolean	Set this to true to enable multicast over SD-Access transit. This supports Native Multicast over SD-Access Transit. This is only applicable for transit of type SDA_LISP_PUB_SUB_TRANSIT. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
type string	Type of the transit network (updating this field is not allowed).
validate_response_schema boolean	Flag for Cisco DNA 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 sda.Sda.add_transit_networks_v1, sda.Sda.update_transit_networks_v1,

• Paths used are post /dna/intent/api/v1/sda/transitNetworks, put /dna/intent/api/v1/sda/transitNetworks,

• It should be noted that this module is an alias of sda_transit_networks_v1

• Does not support check_mode

• The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK

• The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for SDA AddTransitNetworksV1

Complete reference of the AddTransitNetworksV1 API.

Cisco DNA Center documentation for SDA UpdateTransitNetworksV1

Complete reference of the UpdateTransitNetworksV1 API.

Examples

- name: Update all
  cisco.dnac.sda_transit_networks:
    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}}"
    state: present
    payload:
    - id: string
      ipTransitSettings:
        autonomousSystemNumber: string
        routingProtocolName: string
      name: string
      sdaTransitSettings:
        controlPlaneNetworkDeviceIds:
        - string
        isMulticastOverTransitEnabled: true
      type: string

- name: Create
  cisco.dnac.sda_transit_networks:
    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}}"
    state: present
    payload:
    - ipTransitSettings:
        autonomousSystemNumber: string
        routingProtocolName: string
      name: string
      sdaTransitSettings:
        controlPlaneNetworkDeviceIds:
        - string
        isMulticastOverTransitEnabled: true
      type: string

Return Values

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

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

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)