cisco.dnac.sda_layer3_virtual_networks_v1 module -- Resource module for Sda Layer3 Virtual Networks V1

Note

This module is part of the cisco.dnac collection (version 6.28.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_v1.

New in cisco.dnac 6.15.0

Synopsis

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

• Adds layer 3 virtual networks based on user input.

• Deletes layer 3 virtual networks based on user input.

• Updates layer 3 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.

• dnacentersdk >= 2.4.9

• python >= 3.5

Parameters

Parameter	Comments
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"2.3.7.6"`
payload list / elements=dictionary	Sda Layer3 Virtual Networks's payload.
anchoredSiteId string	Fabric ID of the fabric site this layer 3 virtual network is to be anchored at.
fabricIds list / elements=string	IDs of the fabrics this layer 3 virtual network is to be assigned to.
virtualNetworkName string	Name of the layer 3 virtual network.
validate_response_schema boolean	Flag for Cisco DNA 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)
virtualNetworkName string	VirtualNetworkName query parameter. Name of the layer 3 virtual network.

Notes

Note

• SDK Method used are sda.Sda.add_layer3_virtual_networks_v1, sda.Sda.delete_layer3_virtual_networks_v1, sda.Sda.update_layer3_virtual_networks_v1,

• Paths used are post /dna/intent/api/v1/sda/layer3VirtualNetworks, delete /dna/intent/api/v1/sda/layer3VirtualNetworks, put /dna/intent/api/v1/sda/layer3VirtualNetworks,

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

Complete reference of the AddLayer3VirtualNetworksV1 API.

Cisco DNA Center documentation for SDA DeleteLayer3VirtualNetworksV1

Complete reference of the DeleteLayer3VirtualNetworksV1 API.

Cisco DNA Center documentation for SDA UpdateLayer3VirtualNetworksV1

Complete reference of the UpdateLayer3VirtualNetworksV1 API.

Examples

- name: Create
  cisco.dnac.sda_layer3_virtual_networks_v1:
    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}}"
    state: present
    payload:
    - anchoredSiteId: string
      fabricIds:
      - string
      virtualNetworkName: string

- name: Delete all
  cisco.dnac.sda_layer3_virtual_networks_v1:
    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}}"
    state: absent
    virtualNetworkName: string

- name: Update all
  cisco.dnac.sda_layer3_virtual_networks_v1:
    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}}"
    state: present
    payload:
    - anchoredSiteId: string
      fabricIds:
      - string
      id: string
      virtualNetworkName: string

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": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)