cisco.dnac.sda_border_device – Manage SdaBorderDevice objects of Sda

Note

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

To install it use: ansible-galaxy collection install cisco.dnac.

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

New in version 1.0.0: of cisco.dnac

Synopsis

• Gets border device detail from SDA Fabric.

• Deletes border device from SDA Fabric.

• Adds border device in SDA Fabric.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk

Parameters

Parameter					Choices/Defaults	Comments
device_ipaddress string / required						Device IP Address.
payload list / elements=dictionary						An object to send in the Request body. Required for state create.
	borderSessionType string					It is the sda border device's borderSessionType.
	connectedToInternet boolean				Choices: no yes	It is the sda border device's connectedToInternet.
	deviceManagementIpAddress string					It is the sda border device's deviceManagementIpAddress.
	externalConnectivityIpPoolName string					It is the sda border device's externalConnectivityIpPoolName.
	externalConnectivitySettings list / elements=dictionary					It is the sda border device's externalConnectivitySettings.
		externalAutonomouSystemNumber string				It is the sda border device's externalAutonomouSystemNumber.
		interfaceName string				It is the sda border device's interfaceName.
		l3Handoff list / elements=dictionary				It is the sda border device's l3Handoff.
			virtualNetwork dictionary			It is the sda border device's virtualNetwork.
				virtualNetworkName string		It is the sda border device's virtualNetworkName.
	externalDomainRoutingProtocolName string					It is the sda border device's externalDomainRoutingProtocolName.
	internalAutonomouSystemNumber string					It is the sda border device's internalAutonomouSystemNumber.
	siteNameHierarchy string					It is the sda border device's siteNameHierarchy.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.sda_border_device

The official documentation on the cisco.dnac.plugins.module_utils.definitions.sda_border_device module.

SdaBorderDevice reference

Complete reference of the SdaBorderDevice object model.

SdaBorderDevice reference

SDK reference.

Examples

- name: gets_border_device_detail
  cisco.dnac.sda_border_device:
    state: query  # required
    device_ipaddress: SomeValue  # string, required
  register: nm_gets_border_device_detail

- name: deletes_border_device
  cisco.dnac.sda_border_device:
    state: delete  # required
    device_ipaddress: SomeValue  # string, required

- name: adds_border_device
  cisco.dnac.sda_border_device:
    state: create  # required
    payload:  # required
    - deviceManagementIpAddress: SomeValue  # string
      siteNameHierarchy: SomeValue  # string
      externalDomainRoutingProtocolName: SomeValue  # string
      externalConnectivityIpPoolName: SomeValue  # string
      internalAutonomouSystemNumber: SomeValue  # string
      borderSessionType: SomeValue  # string
      connectedToInternet: True  # boolean
      externalConnectivitySettings:
      - interfaceName: SomeValue  # string
        externalAutonomouSystemNumber: SomeValue  # string
        l3Handoff:
        - virtualNetwork:
            virtualNetworkName: SomeValue  # 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 with the response returned by the DNA Center Python SDK Sample: {'response': 29, 'version': '1.0'}
missing_params list / elements=string	when the function request schema is not satisfied	Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function string	always	The DNA Center SDK function used to execute the task Sample: sda.adds_border_device

Authors

• Rafael Campos (@racampos)