cisco.dnac.sda_layer3_virtual_networks_info module -- Information module for Sda Layer3 Virtual Networks Info

Note

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

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

New in cisco.dnac 6.15.0

Synopsis

  • This module represents an alias of the module sda_layer3_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.

  • dnacentersdk >= 2.4.9

  • python >= 3.5

Parameters

Parameter

Comments

anchoredSiteId

string

AnchoredSiteId query parameter. Fabric ID of the fabric site the layer 3 virtual network is anchored at.

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

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: :ansible-option-default:`443`

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

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

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

dnac_version

string

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

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

fabricId

string

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

headers

dictionary

Additional headers.

limit

float

Limit query parameter. Maximum number of records to return.

offset

float

Offset query parameter. Starting record for pagination.

validate_response_schema

boolean

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

Choices:

virtualNetworkName

string

VirtualNetworkName query parameter. Name of the layer 3 virtual network.

Notes

Note

  • SDK Method used are sda.Sda.get_layer3_virtual_networks_v1,

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

  • It should be noted that this module is an alias of sda_layer3_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 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 GetLayer3VirtualNetworksV1

Complete reference of the GetLayer3VirtualNetworksV1 API.

Examples

- name: Get all Sda Layer3 Virtual Networks Info
  cisco.dnac.sda_layer3_virtual_networks_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}}"
    virtualNetworkName: string
    fabricId: string
    anchoredSiteId: 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: :ansible-rv-sample-value:`{"response": [{"anchoredSiteId": "string", "fabricIds": ["string"], "id": "string", "virtualNetworkName": "string"}], "version": "string"}`

Authors

  • Rafael Campos (@racampos)