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

To use it in a playbook, specify: cisco.dnac.sda_fabric_border_device.

New in version 3.1.0: of cisco.dnac

Synopsis

• Manage operations create and delete of the resource Sda Fabric Border Device.

• Adds border device in SDA Fabric.

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

• python >= 3.5

Parameters

Parameter	Comments
borderSessionType string added in 4.0.0 of cisco.dnac	Border Session Type.
connectedToInternet boolean added in 4.0.0 of cisco.dnac	Connected to Internet. Choices: no yes
deviceManagementIpAddress string added in 4.0.0 of cisco.dnac	Management Ip Address of the Device which is provisioned successfully.
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: no ← (default) yes
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: no yes ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: “2.2.3.3”
externalConnectivityIpPoolName string added in 4.0.0 of cisco.dnac	IP pool to use to automate IP routing between the border node and remote peer.
externalConnectivitySettings list / elements=dictionary added in 4.0.0 of cisco.dnac	Sda Fabric Border Device’s externalConnectivitySettings.
externalAutonomouSystemNumber string added in 4.0.0 of cisco.dnac	External Autonomous System Number peer (e.g.,1-65535).
interfaceName string added in 4.0.0 of cisco.dnac	Interface Name.
l3Handoff list / elements=dictionary added in 4.0.0 of cisco.dnac	Sda Fabric Border Device’s l3Handoff.
virtualNetwork dictionary added in 4.0.0 of cisco.dnac	Sda Fabric Border Device’s virtualNetwork.
virtualNetworkName string added in 4.0.0 of cisco.dnac	Virtual Network Name, that is associated to Fabric Site.
vlanId string added in 4.0.0 of cisco.dnac	Vlan Id (e.g.,2-4096 except for reserved VLANs (1002-1005, 2046, 4095)).
externalDomainRoutingProtocolName string added in 4.0.0 of cisco.dnac	External Domain Routing Protocol Name. (Example BGP).
internalAutonomouSystemNumber string added in 4.0.0 of cisco.dnac	Internal Autonomouns System Number used by border node to communicate with remote peer (e.g.,1-65535).
siteNameHierarchy string added in 4.0.0 of cisco.dnac	Site Name Hierarchy for device location(site should be fabric site).
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: no yes ← (default)

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_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

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
    borderSessionType: string
    connectedToInternet: true
    deviceManagementIpAddress: string
    externalConnectivityIpPoolName: string
    externalConnectivitySettings:
    - externalAutonomouSystemNumber: string
      interfaceName: string
      l3Handoff:
      - virtualNetwork:
          virtualNetworkName: string
          vlanId: string
    externalDomainRoutingProtocolName: string
    internalAutonomouSystemNumber: 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
dnac_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: “{\n \”status\”: \”string\”,\n \”description\”: \”string\”,\n \”taskId\”: \”string\”,\n \”taskStatusUrl\”: \”string\”,\n \”executionStatusUrl\”: \”string\”,\n \”executionId\”: \”string\”\n}\n”

Authors

• Rafael Campos (@racampos)