W3cubDocs

/Ansible

cisco.dnac.sda_fabric_devices_layer2_handoffs_sda_transits_v1 module – Resource module for Sda Fabric Devices Layer2 Handoffs Sda Transits V1

Note

This module is part of the cisco.dnac collection (version 6.31.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

New in cisco.dnac 6.14.0

Synopsis

  • Manage operations create, update and delete of the resource Sda Fabric Devices Layer2 Handoffs Sda Transits V1.
  • Adds layer 3 handoffs with sda transit in fabric devices based on user input.
  • Deletes layer 3 handoffs with sda transit of a fabric device based on user input.
  • Updates layer 3 handoffs with sda transit of fabric devices based on user input.

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:

  • false ← (default)
  • 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: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false
  • true ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: "2.3.7.6"

fabricId

string

FabricId query parameter. ID of the fabric this device belongs to.

networkDeviceId

string

NetworkDeviceId query parameter. Network device ID of the fabric device.

payload

list / elements=dictionary

Sda Fabric Devices Layer2 Handoffs Sda Transits’s payload.

affinityIdDecider

integer

Affinity id decider value of the border node. When the affinity id prime value is the same on multiple devices, the affinity id decider value is used as a tiebreaker. Allowed range is 0-2147483647. The lower the relative value of affinity id decider, the higher the preference for a destination border node.

affinityIdPrime

integer

Affinity id prime value of the border node. It supersedes the border priority to determine border node preference. Allowed range is 0-2147483647. The lower the relative value of affinity id prime, the higher the preference for a destination border node.

connectedToInternet

boolean

Set this true to allow associated site to provide internet access to other sites through sd-access.

Choices:

  • false
  • true

fabricId

string

ID of the fabric this device is assigned to. (updating this field is not allowed).

isMulticastOverTransitEnabled

boolean

Set this true to configure native multicast over multiple sites that are connected to an sd-access transit.

Choices:

  • false
  • true

networkDeviceId

string

Network device ID of the fabric device. (updating this field is not allowed).

transitNetworkId

string

ID of the transit network of the layer 3 handoff sda transit. (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:

  • false
  • true ← (default)

Notes

Note

  • SDK Method used are sda.Sda.add_fabric_devices_layer3_handoffs_with_sda_transit_v1, sda.Sda.delete_fabric_device_layer3_handoffs_with_sda_transit_v1, sda.Sda.update_fabric_devices_layer3_handoffs_with_sda_transit_v1,
  • Paths used are post /dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/sdaTransits, delete /dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/sdaTransits, put /dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/sdaTransits,
  • 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 AddFabricDevicesLayer3HandoffsWithSdaTransitV1

Complete reference of the AddFabricDevicesLayer3HandoffsWithSdaTransitV1 API.

Cisco DNA Center documentation for SDA DeleteFabricDeviceLayer3HandoffsWithSdaTransitV1

Complete reference of the DeleteFabricDeviceLayer3HandoffsWithSdaTransitV1 API.

Cisco DNA Center documentation for SDA UpdateFabricDevicesLayer3HandoffsWithSdaTransitV1

Complete reference of the UpdateFabricDevicesLayer3HandoffsWithSdaTransitV1 API.

Examples

- name: Update all
  cisco.dnac.sda_fabric_devices_layer2_handoffs_sda_transits_v1:
    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:
      - affinityIdDecider: 0
        affinityIdPrime: 0
        connectedToInternet: true
        fabricId: string
        isMulticastOverTransitEnabled: true
        networkDeviceId: string
        transitNetworkId: string
- name: Delete all
  cisco.dnac.sda_fabric_devices_layer2_handoffs_sda_transits_v1:
    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: absent
    fabricId: string
    networkDeviceId: string
- name: Create
  cisco.dnac.sda_fabric_devices_layer2_handoffs_sda_transits_v1:
    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:
      - affinityIdDecider: 0
        affinityIdPrime: 0
        connectedToInternet: true
        fabricId: string
        isMulticastOverTransitEnabled: true
        networkDeviceId: string
        transitNetworkId: 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: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Authors

  • Rafael Campos (@racampos)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/dnac/sda_fabric_devices_layer2_handoffs_sda_transits_v1_module.html