cisco.dnac.sda_layer2_virtual_networks_v1_info module – Information module for Sda Layer2 Virtual Networks V1

Note

This module is part of the cisco.dnac collection (version 6.25.0).

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. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.dnac 6.15.0

Synopsis

  • Get all Sda Layer2 Virtual Networks V1.

  • Returns a list of layer 2 virtual networks that match the provided query parameters.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

Parameters

Parameter

Comments

associatedLayer3VirtualNetworkName

string

AssociatedLayer3VirtualNetworkName query parameter. Name of the associated layer 3 virtual network.

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • true

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false

  • true ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: "2.3.7.6"

fabricId

string

FabricId query parameter. ID of the fabric the layer 2 virtual network is assigned to.

headers

dictionary

Additional headers.

id

string

Id query parameter. ID of the layer 2 virtual network.

limit

float

Limit query parameter. Maximum number of records to return.

offset

float

Offset query parameter. Starting record for pagination.

trafficType

string

TrafficType query parameter. The traffic type of the layer 2 virtual network.

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • false

  • true ← (default)

vlanId

float

VlanId query parameter. The vlan ID of the layer 2 virtual network.

vlanName

string

VlanName query parameter. The vlan name of the layer 2 virtual network.

Notes

Note

  • SDK Method used are sda.Sda.get_layer2_virtual_networks_v1,

  • Paths used are get /dna/intent/api/v1/sda/layer2VirtualNetworks,

  • Supports 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

Cisco DNA Center documentation for SDA GetLayer2VirtualNetworksV1

Complete reference of the GetLayer2VirtualNetworksV1 API.

Examples

- name: Get all Sda Layer2 Virtual Networks V1
  cisco.dnac.sda_layer2_virtual_networks_v1_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: "{{my_headers | from_json}}"
    id: string
    fabricId: string
    vlanName: string
    vlanId: 0
    trafficType: string
    associatedLayer3VirtualNetworkName: string
    offset: 0
    limit: 0
  register: result

Return Values

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

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: {"response": [{"associatedLayer3VirtualNetworkName": "string", "fabricId": "string", "id": "string", "isFabricEnabledWireless": true, "trafficType": "string", "vlanId": 0, "vlanName": "string"}], "version": "string"}

Authors

  • Rafael Campos (@racampos)