cisco.catalystcenter.sda_layer2_virtual_networks module -- Resource module for Sda Layer2 Virtual Networks

Note

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

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.

New in cisco.catalystcenter 1.0.0

Synopsis

• Manage operations create, update and delete of the resource Sda Layer2 Virtual Networks.

• Adds layer 2 virtual networks based on user input.

• Deletes a layer 2 virtual network based on id.

• Deletes layer 2 virtual networks based on user input.

• Updates layer 2 virtual networks based on user input.

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 3.2.3.0.0

• python >= 3.12

Parameters

Parameter	Comments
associatedLayer3VirtualNetworkName string	AssociatedLayer3VirtualNetworkName query parameter. Name of the associated layer 3 virtual network.
catalystcenter_debug aliases: dnac_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host aliases: dnac_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password aliases: dnac_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_port aliases: dnac_port, catalystcenter_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_username aliases: dnac_username, user string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify aliases: dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version aliases: dnac_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"`
fabricId string	FabricId query parameter. ID of the fabric the layer 2 virtual network is assigned to.
id string	Id path parameter. ID of the layer 2 virtual network.
payload list / elements=dictionary	Layer 2 virtual network put request body.
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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`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.add_layer2_virtual_networks, sda.Sda.delete_layer2_virtual_network_by_id, sda.Sda.update_layer2_virtual_networks,

• Paths used are post /dna/intent/api/v1/sda/layer2VirtualNetworks, delete /dna/intent/api/v1/sda/layer2VirtualNetworks, delete /dna/intent/api/v1/sda/layer2VirtualNetworks/{id}, put /dna/intent/api/v1/sda/layer2VirtualNetworks,

• Does not support 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

• Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for SDA AddLayer2VirtualNetworks

Complete reference of the AddLayer2VirtualNetworks API.

Cisco Catalyst Center documentation for SDA DeleteLayer2VirtualNetworkById

Complete reference of the DeleteLayer2VirtualNetworkById API.

Cisco Catalyst Center documentation for SDA DeleteLayer2VirtualNetworks

Complete reference of the DeleteLayer2VirtualNetworks API.

Cisco Catalyst Center documentation for SDA UpdateLayer2VirtualNetworks

Complete reference of the UpdateLayer2VirtualNetworks API.

Examples

---
- name: Update all
  cisco.catalystcenter.sda_layer2_virtual_networks:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    payload:
      - {}
- name: Delete all
  cisco.catalystcenter.sda_layer2_virtual_networks:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: absent
    associatedLayer3VirtualNetworkName: string
    fabricId: string
    trafficType: string
    vlanId: 0
    vlanName: string
- name: Create
  cisco.catalystcenter.sda_layer2_virtual_networks:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    payload:
      - {}
- name: Delete by id
  cisco.catalystcenter.sda_layer2_virtual_networks:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: absent
    id: string

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 Catalyst Center Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Bryan Vargas (@bvargasre)

Collection links

Issue Tracker Repository (Sources)