cisco.catalystcenter.sda_layer2_virtual_networks_info module -- Information module for Sda Layer2virtualnetworks

Note

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

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_layer2_virtual_networks_info.

New in cisco.catalystcenter 6.15.0

Synopsis

  • Get all Sda Layer2virtualnetworks.

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

  • catalystcentersdk >= 3.1.3.0.0

  • python >= 3.5

Parameters

Parameter

Comments

associatedLayer3VirtualNetworkName

string

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

catalystcenter_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_username

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

string

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

Default: :ansible-option-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. The maximum number of objects supported in a single request is 500.

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 Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

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,

  • 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 uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for SDA GetLayer2VirtualNetworks

Complete reference of the GetLayer2VirtualNetworks API.

Examples

---
- name: Get all Sda Layer2virtualnetworks
  cisco.catalystcenter.sda_layer2VirtualNetworks_info:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_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 CATALYST Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": [{"associatedLayer3VirtualNetworkName": "string", "fabricId": "string", "id": "string", "isFabricEnabledWireless": true, "isMultipleIpToMacAddresses": true, "isResourceGuardEnabled": true, "isWirelessFloodingEnabled": true, "layer2FloodingAddress": "string", "layer2FloodingAddressAssignment": "string", "trafficType": "string", "vlanId": 0, "vlanName": "string"}], "version": "string"}`

Authors

  • Rafael Campos (@racampos)