cisco.dnac.sda_fabric_border_device – Resource module for Sda Fabric Border Device

Note

This plugin is part of the cisco.dnac collection (version 4.1.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.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.4.0

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
borderSessionType
string
added in 4.0.0 of cisco.dnac
Border Session Type.
connectedToInternet
boolean
added in 4.0.0 of cisco.dnac
    Choices:
  • no
  • yes
Connected to Internet.
deviceManagementIpAddress
string
added in 4.0.0 of cisco.dnac
Management Ip Address of the Device which is provisioned successfully.
dnac_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Cisco DNA Center SDK to enable debugging.
dnac_host
string / required
The Cisco DNA Center hostname.
dnac_password
string
The Cisco DNA Center password to authenticate.
dnac_port
string
Default:
443
The Cisco DNA Center port.
dnac_username
string
Default:
"admin"
The Cisco DNA Center username to authenticate.

aliases: user
dnac_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
dnac_version
string
Default:
"2.2.3.3"
Informs the SDK which version of Cisco DNA Center to use.
externalAutonomouSystemNumber
string
added in 4.0.0 of cisco.dnac
External Autonomous System Number will be used to automate IP routing between Border Node and remote peer (e.g.,1-65535).
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
dictionary
added in 4.0.0 of cisco.dnac
External Connectivity Settings information of L3 Handoff.
externalDomainRoutingProtocolName
string
added in 4.0.0 of cisco.dnac
External Domain Routing Protocol Name. (Example BGP).
interfaceName
string
added in 4.0.0 of cisco.dnac
Interface Name.
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).
l3Handoff
dictionary
added in 4.0.0 of cisco.dnac
L3 Handoff information.
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
    Choices:
  • no
  • yes ←
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.
virtualNetwork
dictionary
added in 4.0.0 of cisco.dnac
Virtual Network information of L3 Hand off.
virtualNetworkName
string
added in 4.0.0 of cisco.dnac
Virtual Network Name assigned to 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)).

Notes

Note

  • 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

Sda Fabric Border Device reference

Complete reference of the Sda Fabric Border Device object model.

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
    externalAutonomouSystemNumber: string
    externalConnectivityIpPoolName: string
    externalConnectivitySettings: {}
    externalDomainRoutingProtocolName: string
    interfaceName: string
    internalAutonomouSystemNumber: string
    l3Handoff: {}
    siteNameHierarchy: string
    virtualNetwork: {}
    virtualNetworkName: string
    vlanId: 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 Returned Description
dnac_response
dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

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


Authors

  • Rafael Campos (@racampos)