cisco.dnac.sda_fabric_border_device_info – Information module for Sda Fabric Border Device

Note

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

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

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

New in version 3.1.0: of cisco.dnac

Synopsis

  • Get all 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.1

  • 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.
headers
dictionary
Additional headers.
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

  • Supports check_mode

See Also

See also

Sda Fabric Border Device reference

Complete reference of the Sda Fabric Border Device object model.

Examples

- name: Get all Sda Fabric Border Device
  cisco.dnac.sda_fabric_border_device_info:
    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}}"
    headers:
      custom: value
    deviceIPAddress: string
  register: result

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", "payload": { "id": "string", "instanceId": 0, "authEntityId": 0, "displayName": "string", "authEntityClass": 0, "instanceTenantId": "string", "deployPending": "string", "instanceVersion": 0, "createTime": 0, "deployed": true, "isSeeded": true, "isStale": true, "lastUpdateTime": 0, "name": "string", "namespace": "string", "provisioningState": "string", "resourceVersion": 0, "targetIdList": [], "type": "string", "cfsChangeInfo": [], "customProvisions": [], "configs": [], "managedSites": [], "networkDeviceId": "string", "roles": [ "string" ], "saveWanConnectivityDetailsOnly": true, "siteId": "string", "akcSettingsCfs": [], "deviceInterfaceInfo": [], "deviceSettings": { "id": "string", "instanceId": 0, "displayName": "string", "instanceTenantId": "string", "deployPending": "string", "instanceVersion": 0, "connectedTo": [], "cpu": 0, "dhcpEnabled": true, "externalConnectivityIpPool": "string", "externalDomainRoutingProtocol": "string", "internalDomainProtocolNumber": "string", "memory": 0, "nodeType": [ "string" ], "storage": 0, "extConnectivitySettings": [ { "id": "string", "instanceId": 0, "displayName": "string", "instanceTenantId": "string", "deployPending": "string", "instanceVersion": 0, "externalDomainProtocolNumber": "string", "interfaceUuid": "string", "policyPropagationEnabled": true, "policySgtTag": 0, "l2Handoff": [], "l3Handoff": [ { "id": "string", "instanceId": 0, "displayName": "string", "instanceTenantId": "string", "deployPending": "string", "instanceVersion": 0, "localIpAddress": "string", "remoteIpAddress": "string", "vlanId": 0, "virtualNetwork": { "idRef": "string" } } ] } ] }, "networkWideSettings": { "id": "string", "instanceId": 0, "displayName": "string", "instanceTenantId": "string", "deployPending": "string", "instanceVersion": 0, "aaa": [], "cmx": [], "dhcp": [ { "id": "string", "ipAddress": { "id": "string", "paddedAddress": "string", "addressType": "string", "address": "string" } } ], "dns": [ { "id": "string", "domainName": "string", "ip": { "id": "string", "paddedAddress": "string", "addressType": "string", "address": "string" } } ], "ldap": [], "nativeVlan": [], "netflow": [], "ntp": [], "snmp": [], "syslogs": [] }, "otherDevice": [], "transitNetworks": [ { "idRef": "string" } ], "virtualNetwork": [], "wlan": [] } }


Authors

  • Rafael Campos (@racampos)