cisco.catalystcenter.sda_fabric_border_device module -- Resource module for Sda Fabric Border Device

Note

This module is part of the cisco.catalystcenter collection (version 2.1.4).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.catalystcenter 3.1.0

Synopsis

• This module represents an alias of the module sda_fabric_border_device_v1

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 2.3.7.9

• python >= 3.5

Parameters

Parameter	Comments
_api_port integer	The Cisco CATALYST Center port. Default: :ansible-option-default:`443`
_debug boolean	Flag for Cisco CATALYST Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
_host string / required	The Cisco CATALYST Center hostname.
_password string	The Cisco CATALYST Center password to authenticate.
_username aliases: user string	The Cisco CATALYST Center username to authenticate. Default: :ansible-option-default:`"admin"`
_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
_version string	Informs the SDK which version of Cisco CATALYST Center to use. Default: :ansible-option-default:`"2.3.7.6"`
deviceManagementIpAddress string added in cisco.catalystcenter 4.0.0	DeviceManagementIpAddress query parameter.
payload list / elements=dictionary	Sda Fabric Border Device's payload.
borderPriority string	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.
borderSessionType string added in cisco.catalystcenter 4.0.0	Border Session Type.
borderWithExternalConnectivity boolean	Border With External Connectivity (Note True for transit and False for non-transit border). Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
connectedToInternet boolean added in cisco.catalystcenter 4.0.0	Connected to Internet. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
deviceManagementIpAddress string added in cisco.catalystcenter 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.catalystcenter 4.0.0	External Connectivity IpPool Name.
externalConnectivitySettings list / elements=dictionary added in cisco.catalystcenter 4.0.0	Sda Fabric Border Device's externalConnectivitySettings.
externalAutonomouSystemNumber string added in cisco.catalystcenter 4.0.0	External Autonomous System Number peer (e.g.,1-65535).
interfaceDescription string	Interface Description.
interfaceName string added in cisco.catalystcenter 4.0.0	Interface Name.
l2Handoff list / elements=dictionary	Sda Fabric Border Device's l2Handoff.
virtualNetworkName string added in cisco.catalystcenter 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.catalystcenter 4.0.0	Sda Fabric Border Device's l3Handoff.
virtualNetwork dictionary added in cisco.catalystcenter 4.0.0	Sda Fabric Border Device's virtualNetwork.
virtualNetworkName string added in cisco.catalystcenter 4.0.0	Virtual Network Name, that is associated to Fabric Site.
vlanId string added in cisco.catalystcenter 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 Autonomous System Number.
routeDistributionProtocol string	Route Distribution Protocol for Control Plane Device. Allowed values are "LISP_BGP" or "LISP_PUB_SUB". Default value is "LISP_BGP".
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 CATALYST Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`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,

• It should be noted that this module is an alias of sda_fabric_border_device_v1

• 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 CATALYST SDK

• The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for SDA AddBorderDeviceInSDAFabricV1

Complete reference of the AddBorderDeviceInSDAFabricV1 API.

Cisco DNA Center documentation for SDA DeleteBorderDeviceFromSDAFabricV1

Complete reference of the DeleteBorderDeviceFromSDAFabricV1 API.

Examples

- name: Create
  cisco.catalystcenter.sda_fabric_border_device:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _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.catalystcenter.sda_fabric_border_device:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: absent
    deviceManagementIpAddress: string

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
catalystcenter_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"description": "string", "executionId": "string", "executionStatusUrl": "string", "status": "string", "taskId": "string", "taskStatusUrl": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)