cisco.dnac.sda_fabric_devices_layer2_handoffs_ip_transits module – Resource module for Sda Fabricdevices Layer2handoffs Iptransits
Note
This module is part of the cisco.dnac collection (version 6.18.0).
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_ip_transits
.
New in cisco.dnac 6.14.0
Synopsis
Manage operations create, update and delete of the resource Sda Fabricdevices Layer2handoffs Iptransits.
Adds layer 3 handoffs with ip transit in fabric devices based on user input.
Deletes a layer 3 handoff with ip transit of a fabric device by id.
Deletes layer 3 handoffs with ip transit of a fabric device based on user input.
Updates layer 3 handoffs with ip 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.7.2
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
FabricId query parameter. ID of the fabric this device belongs to. |
|
Id path parameter. ID of the layer 3 handoff with ip transit of a fabric device to be deleted. |
|
NetworkDeviceId query parameter. Network device ID of the fabric device. |
|
Sda Fabric Devices Layer2 Handoffs Ip Transits’s payload. |
|
External connectivity ip pool will be used by Catalyst Center to allocate IP address for the connection between the border node and peer. |
|
ID of the fabric this device belongs to. |
|
Interface name of the layer 3 handoff ip transit. |
|
Local ipv4 address for the selected virtual network. Enter the IP addresses and subnet mask in the CIDR notation (IP address/prefix-length). Not applicable if you have already provided an external connectivity ip pool name. |
|
Local ipv6 address for the selected virtual network. Enter the IP addresses and subnet mask in the CIDR notation (IP address/prefix-length). Not applicable if you have already provided an external connectivity ip pool name. |
|
Network device ID of the fabric device. |
|
Remote ipv4 address for the selected virtual network. Enter the IP addresses and subnet mask in the CIDR notation (IP address/prefix-length). Not applicable if you have already provided an external connectivity ip pool name. |
|
Remote ipv6 address for the selected virtual network. Enter the IP addresses and subnet mask in the CIDR notation (IP address/prefix-length). Not applicable if you have already provided an external connectivity ip pool name. |
|
TCP maximum segment size (mss) value for the layer 3 handoff. Allowed range is 500-1440. TCP MSS Adjustment value is applicable for the TCP sessions over both IPv4 and IPv6. |
|
ID of the transit network of the layer 3 handoff ip transit. |
|
Name of the virtual network associated with this fabric site. |
|
VLAN number for the Switch Virtual Interface (SVI) used to establish BGP peering with the external domain for the virtual network. Allowed VLAN range is 2-4094 except for reserved vlans (1, 1002-1005, 2046, 4094). |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are sda.Sda.add_fabric_devices_layer3_handoffs_with_ip_transit, sda.Sda.delete_fabric_device_layer3_handoff_with_ip_transit_by_id, sda.Sda.update_fabric_devices_layer3_handoffs_with_ip_transit,
Paths used are post /dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/ipTransits, delete /dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/ipTransits, delete /dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/ipTransits/{id}, put /dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/ipTransits,
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 AddFabricDevicesLayer3HandoffsWithIpTransit
Complete reference of the AddFabricDevicesLayer3HandoffsWithIpTransit API.
- Cisco DNA Center documentation for SDA DeleteFabricDeviceLayer3HandoffWithIpTransitById
Complete reference of the DeleteFabricDeviceLayer3HandoffWithIpTransitById API.
- Cisco DNA Center documentation for SDA DeleteFabricDeviceLayer3HandoffsWithIpTransit
Complete reference of the DeleteFabricDeviceLayer3HandoffsWithIpTransit API.
- Cisco DNA Center documentation for SDA UpdateFabricDevicesLayer3HandoffsWithIpTransit
Complete reference of the UpdateFabricDevicesLayer3HandoffsWithIpTransit API.
Examples
- name: Create
cisco.dnac.sda_fabric_devices_layer2_handoffs_ip_transits:
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:
- externalConnectivityIpPoolName: string
fabricId: string
interfaceName: string
localIpAddress: string
localIpv6Address: string
networkDeviceId: string
remoteIpAddress: string
remoteIpv6Address: string
tcpMssAdjustment: 0
transitNetworkId: string
virtualNetworkName: string
vlanId: 0
- name: Update all
cisco.dnac.sda_fabric_devices_layer2_handoffs_ip_transits:
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:
- externalConnectivityIpPoolName: string
fabricId: string
id: string
interfaceName: string
localIpAddress: string
localIpv6Address: string
networkDeviceId: string
remoteIpAddress: string
remoteIpv6Address: string
tcpMssAdjustment: 0
transitNetworkId: string
virtualNetworkName: string
vlanId: 0
- name: Delete all
cisco.dnac.sda_fabric_devices_layer2_handoffs_ip_transits:
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: Delete by id
cisco.dnac.sda_fabric_devices_layer2_handoffs_ip_transits:
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
id: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |