cisco.catalystcenter.sda_layer2_virtual_networks_v1 module -- Resource module for Sda Layer2 Virtual Networks V1

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

New in cisco.catalystcenter 6.15.0

Synopsis

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

• 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 >= 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: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
_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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
_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.
id string	Id path parameter. ID of the layer 2 virtual network.
payload list / elements=dictionary	Sda Layer2 Virtual Networks's payload.
associatedLayer3VirtualNetworkName string	Name of the layer 3 virtual network associated with the layer 2 virtual network. This field is provided to support requests related to virtual network anchoring. The layer 3 virtual network must have already been added to the fabric before association. This field must either be present in all payload elements or none.
fabricId string	ID of the fabric this layer 2 virtual network is to be assigned to.
isFabricEnabledWireless boolean	Set to true to enable wireless. Default is false. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
isMultipleIpToMacAddresses boolean	Set to true to enable multiple IP-to-MAC addresses (Wireless Bridged-Network Virtual Machine). This field defaults to false when associated with a layer 3 virtual network and cannot be used when not associated with a layer 3 virtual network. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
trafficType string	The type of traffic that is served.
vlanId integer	ID of the VLAN of the layer 2 virtual network. Allowed VLAN range is 2-4093 except for reserved VLANs 1002-1005, and 2046. If deploying on a fabric zone, this vlanId must match the vlanId of the corresponding layer 2 virtual network on the fabric site.
vlanName string	Name of the VLAN of the layer 2 virtual network. Must contain only alphanumeric characters, underscores, and hyphens.
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_v1, sda.Sda.delete_layer2_virtual_network_by_id_v1, sda.Sda.update_layer2_virtual_networks_v1,

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

Complete reference of the AddLayer2VirtualNetworksV1 API.

Cisco DNA Center documentation for SDA DeleteLayer2VirtualNetworkByIdV1

Complete reference of the DeleteLayer2VirtualNetworkByIdV1 API.

Cisco DNA Center documentation for SDA DeleteLayer2VirtualNetworksV1

Complete reference of the DeleteLayer2VirtualNetworksV1 API.

Cisco DNA Center documentation for SDA UpdateLayer2VirtualNetworksV1

Complete reference of the UpdateLayer2VirtualNetworksV1 API.

Examples

- name: Create
  cisco.catalystcenter.sda_layer2_virtual_networks_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: present
    payload:
      - associatedLayer3VirtualNetworkName: string
        fabricId: string
        isFabricEnabledWireless: true
        isMultipleIpToMacAddresses: true
        trafficType: string
        vlanId: 0
        vlanName: string
- name: Delete all
  cisco.catalystcenter.sda_layer2_virtual_networks_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: absent
    associatedLayer3VirtualNetworkName: string
    fabricId: string
    trafficType: string
    vlanId: 0
    vlanName: string
- name: Update all
  cisco.catalystcenter.sda_layer2_virtual_networks_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: present
    payload:
      - associatedLayer3VirtualNetworkName: string
        fabricId: string
        id: string
        isFabricEnabledWireless: true
        isMultipleIpToMacAddresses: true
        trafficType: string
        vlanId: 0
        vlanName: string
- name: Delete by id
  cisco.catalystcenter.sda_layer2_virtual_networks_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _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 DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)