cisco.dnac.topology_layer_2_info – Information module for Topology Layer 2

Note

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

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

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

New in version 1.0.0: of cisco.dnac

Synopsis

  • Get Topology Layer 2 by id.

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
headers
dictionary
Additional headers.
vlanID
string
VlanID path parameter. Vlan Name for e.g Vlan1, Vlan23 etc.

See Also

See also

Topology Layer 2 reference

Complete reference of the Topology Layer 2 object model.

Examples

- name: Get Topology Layer 2 by id
  cisco.dnac.topology_layer_2_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
    vlanID: 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:
{ "response": { "id": "string", "links": [ { "additionalInfo": {}, "endPortID": "string", "endPortIpv4Address": "string", "endPortIpv4Mask": "string", "endPortName": "string", "endPortSpeed": "string", "greyOut": true, "id": "string", "linkStatus": "string", "source": "string", "startPortID": "string", "startPortIpv4Address": "string", "startPortIpv4Mask": "string", "startPortName": "string", "startPortSpeed": "string", "tag": "string", "target": "string" } ], "nodes": [ { "aclApplied": true, "additionalInfo": {}, "customParam": { "id": "string", "label": "string", "parentNodeId": "string", "x": 0, "y": 0 }, "dataPathId": "string", "deviceType": "string", "family": "string", "fixed": true, "greyOut": true, "id": "string", "ip": "string", "label": "string", "networkType": "string", "nodeType": "string", "order": 0, "osType": "string", "platformId": "string", "role": "string", "roleSource": "string", "softwareVersion": "string", "tags": [ "string" ], "upperNode": "string", "userId": "string", "vlanId": "string", "x": 0, "y": 0 } ] }, "version": "string" }


Authors

  • Rafael Campos (@racampos)