cisco.dnac.sda_fabric_border_device module – Resource module for Sda Fabric Border Device
Note
This module is part of the cisco.dnac collection (version 6.7.2).
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_border_device.
New in cisco.dnac 3.1.0
Synopsis
Manage operations create and delete of the resource Sda Fabric Border Device.
Add border device in SDA Fabric.
Delete border device from SDA Fabric.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.5.5
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
DeviceManagementIpAddress query parameter. |
|
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: |
|
Sda Fabric Border Device’s payload. |
|
Border priority associated with a given device. Allowed range for Border Priority is 1-9. A lower value indicates higher priority. E.g., a priority of 1 takes precedence over 5. Default priority would be set to 10. |
|
Border Session Type. |
|
Border With External Connectivity (Note True for transit and False for non-transit border). Choices:
|
|
Connected to Internet. Choices:
|
|
Management Ip Address of the provisioned Device. |
|
Supported Device Roles in SD-Access fabric. Allowed roles are “Border_Node”,”Control_Plane_Nod… E.g. “Border_Node” or “Border_Node”, “Control_Plane_Node” or “Border_Node”, “Control_Plane_Node”,”Edge_Node”. |
|
External Connectivity IpPool Name. |
|
Sda Fabric Border Device’s externalConnectivitySettings. |
|
External Autonomous System Number peer (e.g.,1-65535). |
|
Interface Description. |
|
Interface Name. |
|
Sda Fabric Border Device’s l2Handoff. |
|
Virtual Network Name, that is associated to Fabric Site. |
|
Vlan Name of L2 Handoff. |
|
Sda Fabric Border Device’s l3Handoff. |
|
Sda Fabric Border Device’s virtualNetwork. |
|
Virtual Network Name, that is associated to Fabric Site. |
|
Vlan Id (e.g.,2-4096 except for reserved VLANs (1002-1005, 2046, 4095)). |
|
External Domain Routing Protocol Name. |
|
Internal Autonomouns System Number (e.g.,1-65535). |
|
Route Distribution Protocol for Control Plane Device. Allowed values are “LISP_BGP” or “LISP_PUB_SUB”. Default value is “LISP_BGP”. |
|
SD-Access Transit Network Name. |
|
Site Name Hierarchy of provisioned Device(site should be part of Fabric Site). |
|
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.adds_border_device, sda.Sda.deletes_border_device,
Paths used are post /dna/intent/api/v1/business/sda/border-device, delete /dna/intent/api/v1/business/sda/border-device,
Does not support
check_modeThe 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 AddBorderDeviceInSDAFabric
Complete reference of the AddBorderDeviceInSDAFabric API.
- Cisco DNA Center documentation for SDA DeleteBorderDeviceFromSDAFabric
Complete reference of the DeleteBorderDeviceFromSDAFabric API.
Examples
- name: Create
cisco.dnac.sda_fabric_border_device:
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:
- borderPriority: string
borderSessionType: string
borderWithExternalConnectivity: true
connectedToInternet: true
deviceManagementIpAddress: string
deviceRole:
- string
externalConnectivityIpPoolName: string
externalConnectivitySettings:
- externalAutonomouSystemNumber: string
interfaceDescription: string
interfaceName: string
l2Handoff:
- virtualNetworkName: string
vlanName: string
l3Handoff:
- virtualNetwork:
virtualNetworkName: string
vlanId: string
externalDomainRoutingProtocolName: string
internalAutonomouSystemNumber: string
routeDistributionProtocol: string
sdaTransitNetworkName: string
siteNameHierarchy: string
- name: Delete all
cisco.dnac.sda_fabric_border_device:
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
deviceManagementIpAddress: 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: |