cisco.catalystcenter.sda_fabric_devices_layer2_handoffs_sda_transits module -- Resource module for Sda Fabric Devices Layer2 Handoffs Sda Transits

Note

This module is part of the cisco.catalystcenter collection (version 2.11.0).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.sda_fabric_devices_layer2_handoffs_sda_transits.

New in cisco.catalystcenter 1.0.0

Synopsis

• Manage operations create, update and delete of the resource Sda Fabric Devices Layer2 Handoffs Sda Transits.

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

• Updates layer 3 handoffs with sda transit of fabric devices based on user.

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 3.2.3.0.0

• python >= 3.12

Parameters

Parameter	Comments
catalystcenter_debug aliases: dnac_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host aliases: dnac_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password aliases: dnac_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_port aliases: dnac_port, catalystcenter_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_username aliases: dnac_username, user string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify aliases: dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version aliases: dnac_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"`
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	Layer 3 handoff sda transit root element.
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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
fabricId string	ID of the fabric this device is assigned to.
isDualStack boolean	By default, a Border Node connected to SD-Access transit registers its Loopback 0 IPv4 address as the LISP RLOC with the Transit Control Plane Nodes. Set it to 'true' to enable this feature to register both Loopback 0 IPv4 and IPv6 addresses as LISP RLOCs. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
isMulticastOverTransitEnabled boolean	Set this true to configure native multicast over multiple sites that are connected to an sd-access transit. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
lispTransportType string	Specifies the IP protocol to be used for the LISP peering session between the Border Node and the Transit Control Plane Nodes. Allowed values are 'IPV4' or 'IPV6'. Default value will be the underlay type of the fabric site.
networkDeviceId string	Network device ID of the fabric device.
transitNetworkId string	ID of the transit network of the layer 3 handoff sda transit.
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 sda.Sda.add_fabric_devices_layer3_handoffs_with_sda_transit, sda.Sda.delete_fabric_device_layer3_handoffs_with_sda_transit, sda.Sda.update_fabric_devices_layer3_handoffs_with_sda_transit,

• 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 uses the embedded connection manager from Cisco CATALYST SDK

• Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for SDA AddFabricDevicesLayer3HandoffsWithSdaTransit

Complete reference of the AddFabricDevicesLayer3HandoffsWithSdaTransit API.

Cisco Catalyst Center documentation for SDA DeleteFabricDeviceLayer3HandoffsWithSdaTransit

Complete reference of the DeleteFabricDeviceLayer3HandoffsWithSdaTransit API.

Cisco Catalyst Center documentation for SDA UpdateFabricDevicesLayer3HandoffsWithSdaTransit

Complete reference of the UpdateFabricDevicesLayer3HandoffsWithSdaTransit API.

Examples

---
- name: Create
  cisco.catalystcenter.sda_fabric_devices_layer2_handoffs_sda_transits:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    payload:
      - affinityIdDecider: 0
        affinityIdPrime: 0
        connectedToInternet: true
        fabricId: string
        isDualStack: true
        isMulticastOverTransitEnabled: true
        lispTransportType: string
        networkDeviceId: string
        transitNetworkId: string
- name: Delete all
  cisco.catalystcenter.sda_fabric_devices_layer2_handoffs_sda_transits:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: absent
    fabricId: string
    networkDeviceId: string
- name: Update all
  cisco.catalystcenter.sda_fabric_devices_layer2_handoffs_sda_transits:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    payload:
      - affinityIdDecider: 0
        affinityIdPrime: 0
        connectedToInternet: true
        fabricId: string
        isDualStack: true
        isMulticastOverTransitEnabled: true
        lispTransportType: string
        networkDeviceId: string
        transitNetworkId: string

Return Values

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

Key	Description
catalystcenter_response 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

• Bryan Vargas (@bvargasre)

Collection links

Issue Tracker Repository (Sources)