.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.catalystcenter.sda_layer2_virtual_networks_v1 module -- Resource module for Sda Layer2 Virtual Networks V1 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.catalystcenter collection `_ (version 2.1.4). To install it, use: :code:`ansible-galaxy collection install cisco.catalystcenter`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.catalystcenter.sda_layer2_virtual_networks_v1`. .. version_added .. rst-class:: ansible-version-added New in cisco.catalystcenter 6.15.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - 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 :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - catalystcentersdk \>= 2.3.7.9 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__parameter-_api_port: .. rst-class:: ansible-option-title **_api_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco CATALYST Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__parameter-_debug: .. rst-class:: ansible-option-title **_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco CATALYST Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__parameter-_host: .. rst-class:: ansible-option-title **_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco CATALYST Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__parameter-_password: .. rst-class:: ansible-option-title **_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco CATALYST Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__parameter-_username: .. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__parameter-user: .. rst-class:: ansible-option-title **_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco CATALYST Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__parameter-_verify: .. rst-class:: ansible-option-title **_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__parameter-_version: .. rst-class:: ansible-option-title **_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco CATALYST Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.3.7.6"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__parameter-associatedlayer3virtualnetworkname: .. rst-class:: ansible-option-title **associatedLayer3VirtualNetworkName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
AssociatedLayer3VirtualNetworkName query parameter. Name of the associated layer 3 virtual network. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__parameter-fabricid: .. rst-class:: ansible-option-title **fabricId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
FabricId query parameter. ID of the fabric the layer 2 virtual network is assigned to. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id path parameter. ID of the layer 2 virtual network. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__parameter-payload: .. rst-class:: ansible-option-title **payload** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Sda Layer2 Virtual Networks's payload. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__parameter-payload/associatedlayer3virtualnetworkname: .. rst-class:: ansible-option-title **associatedLayer3VirtualNetworkName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__parameter-payload/fabricid: .. rst-class:: ansible-option-title **fabricId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ID of the fabric this layer 2 virtual network is to be assigned to. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__parameter-payload/isfabricenabledwireless: .. rst-class:: ansible-option-title **isFabricEnabledWireless** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Set to true to enable wireless. Default is false. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__parameter-payload/ismultipleiptomacaddresses: .. rst-class:: ansible-option-title **isMultipleIpToMacAddresses** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__parameter-payload/traffictype: .. rst-class:: ansible-option-title **trafficType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The type of traffic that is served. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__parameter-payload/vlanid: .. rst-class:: ansible-option-title **vlanId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__parameter-payload/vlanname: .. rst-class:: ansible-option-title **vlanName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the VLAN of the layer 2 virtual network. Must contain only alphanumeric characters, underscores, and hyphens. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__parameter-traffictype: .. rst-class:: ansible-option-title **trafficType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
TrafficType query parameter. The traffic type of the layer 2 virtual network. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco CATALYST Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__parameter-vlanid: .. rst-class:: ansible-option-title **vlanId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
VlanId query parameter. The vlan ID of the layer 2 virtual network. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__parameter-vlanname: .. rst-class:: ansible-option-title **vlanName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
VlanName query parameter. The vlan name of the layer 2 virtual network. .. raw:: html
.. Attributes .. Notes 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 \ :literal:`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 .. Seealso See Also -------- .. seealso:: `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 Examples -------- .. code-block:: yaml+jinja - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.sda_layer2_virtual_networks_v1_module__return-catalystcenter_response: .. rst-class:: ansible-option-title **catalystcenter_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco DNAC Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors