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.6.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_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.4

  • python >= 3.5

Parameters

Parameter

Comments

deviceManagementIpAddress

string

added in cisco.dnac 4.0.0

DeviceManagementIpAddress query parameter.

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.3.0"

payload

list / elements=dictionary

Sda Fabric Border Device’s payload.

borderSessionType

string

added in cisco.dnac 4.0.0

Border Session Type.

borderWithExternalConnectivity

boolean

Border With External Connectivity (Note True for transit and False for non-transit border).

Choices:

  • false

  • true

connectedToInternet

boolean

added in cisco.dnac 4.0.0

Connected to Internet.

Choices:

  • false

  • true

deviceManagementIpAddress

string

added in cisco.dnac 4.0.0

Management Ip Address of the provisioned Device.

deviceRole

list / elements=string

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

externalConnectivityIpPoolName

string

added in cisco.dnac 4.0.0

External Connectivity IpPool Name.

externalConnectivitySettings

list / elements=dictionary

added in cisco.dnac 4.0.0

Sda Fabric Border Device’s externalConnectivitySettings.

externalAutonomouSystemNumber

string

added in cisco.dnac 4.0.0

External Autonomous System Number peer (e.g.,1-65535).

interfaceDescription

string

Interface Description.

interfaceName

string

added in cisco.dnac 4.0.0

Interface Name.

l2Handoff

list / elements=dictionary

Sda Fabric Border Device’s l2Handoff.

virtualNetworkName

string

added in cisco.dnac 4.0.0

Virtual Network Name, that is associated to Fabric Site.

vlanName

string

Vlan Name of L2 Handoff.

l3Handoff

list / elements=dictionary

added in cisco.dnac 4.0.0

Sda Fabric Border Device’s l3Handoff.

virtualNetwork

list / elements=dictionary

added in cisco.dnac 4.0.0

Sda Fabric Border Device’s virtualNetwork.

virtualNetworkName

string

added in cisco.dnac 4.0.0

Virtual Network Name, that is associated to Fabric Site.

vlanId

string

added in cisco.dnac 4.0.0

Vlan Id (e.g.,2-4096 except for reserved VLANs (1002-1005, 2046, 4095)).

externalDomainRoutingProtocolName

string

External Domain Routing Protocol Name.

internalAutonomouSystemNumber

string

Internal Autonomouns System Number (e.g.,1-65535).

sdaTransitNetworkName

string

SD-Access Transit Network Name.

siteNameHierarchy

string

Site Name Hierarchy of provisioned Device(site should be part of Fabric Site).

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

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

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: {"description": "string", "executionId": "string", "executionStatusUrl": "string", "status": "string", "taskId": "string", "taskStatusUrl": "string"}

Authors

  • Rafael Campos (@racampos)