cisco.dnac.sda_virtual_network_v2 module – Resource module for Sda Virtual Network V2
Note
This module is part of the cisco.dnac collection (version 6.22.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
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_virtual_network_v2
.
New in cisco.dnac 3.1.0
Synopsis
Manage operations create, update and delete of the resource Sda Virtual Network V2.
Add virtual network with scalable groups at global level.
Delete virtual network with scalable groups.
Update virtual network with scalable groups.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.7.2
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Guest Virtual Network enablement flag, default value is False. Choices:
|
|
Scalable Group to be associated to virtual network. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
|
Virtual Network Name to be assigned at global level. |
|
VManage vpn id for SD-WAN. |
Notes
Note
SDK Method used are sda.Sda.add_virtual_network_with_scalable_groups, sda.Sda.delete_virtual_network_with_scalable_groups, sda.Sda.update_virtual_network_with_scalable_groups,
Paths used are post /dna/intent/api/v1/virtual-network, delete /dna/intent/api/v1/virtual-network, put /dna/intent/api/v1/virtual-network,
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 AddVirtualNetworkWithScalableGroups
Complete reference of the AddVirtualNetworkWithScalableGroups API.
- Cisco DNA Center documentation for SDA DeleteVirtualNetworkWithScalableGroups
Complete reference of the DeleteVirtualNetworkWithScalableGroups API.
- Cisco DNA Center documentation for SDA UpdateVirtualNetworkWithScalableGroups
Complete reference of the UpdateVirtualNetworkWithScalableGroups API.
Examples
- name: Create
cisco.dnac.sda_virtual_network_v2:
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
isGuestVirtualNetwork: true
scalableGroupNames:
- string
vManageVpnId: string
virtualNetworkName: string
- name: Delete all
cisco.dnac.sda_virtual_network_v2:
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_virtual_network_v2:
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
isGuestVirtualNetwork: true
scalableGroupNames:
- string
vManageVpnId: string
virtualNetworkName: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |