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

Note

This plugin is part of the cisco.dnac collection (version 3.2.3).

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

• python >= 3.5

Parameters

Parameter					Choices/Defaults	Comments
deviceIPAddress string						DeviceIPAddress query parameter. Device IP Address.
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.2.3"	Informs the SDK which version of Cisco DNA Center to use.
payload list / elements=string						Sda Fabric Border Device's payload.
	borderSessionType string					Border Session Type.
	connectedToInternet boolean				Choices: no yes	Connected To Internet.
	deviceManagementIpAddress string					Device Management Ip Address.
	externalConnectivityIpPoolName string					External Connectivity Ip Pool Name.
	externalConnectivitySettings list / elements=string					Sda Fabric Border Device's externalConnectivitySettings.
		externalAutonomouSystemNumber string				External Autonomou System Number.
		interfaceName string				Interface Name.
		l3Handoff list / elements=string				Sda Fabric Border Device's l3Handoff.
			virtualNetwork dictionary			Sda Fabric Border Device's virtualNetwork.
				virtualNetworkName string		Virtual Network Name.
	externalDomainRoutingProtocolName string					External Domain Routing Protocol Name.
	internalAutonomouSystemNumber string					Internal Autonomou System Number.
	siteNameHierarchy string					Site Name Hierarchy.
validate_response_schema boolean					Choices: no yes ←	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

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
    payload:
    - deviceManagementIpAddress: string
      siteNameHierarchy: string
      externalDomainRoutingProtocolName: string
      externalConnectivityIpPoolName: string
      internalAutonomouSystemNumber: string
      borderSessionType: string
      connectedToInternet: true
      externalConnectivitySettings:
      - interfaceName: string
        externalAutonomouSystemNumber: string
        l3Handoff:
        - virtualNetwork:
            virtualNetworkName: 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
    deviceIPAddress: 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", "executionStatusUrl": "string" }

Authors

• Rafael Campos (@racampos)