cisco.catalystcenter.sda_layer2_virtual_networks_info module -- Information module for Sda Layer2 Virtual Networks Info

Note

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

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

  • This module represents an alias of the module sda_layer2_virtual_networks_v1_info

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 2.3.7.9

  • python >= 3.5

Parameters

Parameter

Comments

_api_port

integer

The Cisco CATALYST Center port.

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

_debug

boolean

Flag for Cisco CATALYST Center SDK to enable debugging.

Choices:

_host

string / required

The Cisco CATALYST Center hostname.

_password

string

The Cisco CATALYST Center password to authenticate.

_username

aliases: user

string

The Cisco CATALYST Center username to authenticate.

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

_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

_version

string

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

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

associatedLayer3VirtualNetworkName

string

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

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_v1,

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

  • It should be noted that this module is an alias of sda_layer2_virtual_networks_v1_info

  • 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 CATALYST SDK

  • The parameters starting with catalystCenter_ are used by the Cisco CATALYST 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 Info
  cisco.catalystcenter.sda_layer2_virtual_networks_info:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _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

catalystcenter_response

dictionary

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

Returned: always

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

Authors

  • Rafael Campos (@racampos)