cisco.catalystcenter.sda_virtual_network_v2 module -- Resource module for Sda Virtual Network V2

Note

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

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

New in cisco.catalystcenter 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.

• catalystcentersdk >= 3.1.3.0.0

• python >= 3.5

Parameters

Parameter	Comments
catc_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catc_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catc_host string / required	The Cisco Catalyst Center hostname.
catc_password string	The Cisco Catalyst Center password to authenticate.
catc_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catc_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catc_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"2.3.7.6"`
isGuestVirtualNetwork boolean	Guest Virtual Network enablement flag, default value is False. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
scalableGroupNames list / elements=string	Scalable Group to be associated to 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)
virtualNetworkName string	Virtual Network Name to be assigned at global level.
vManageVpnId string	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 uses the embedded connection manager from Cisco CATALYST SDK

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.catalystcenter.sda_virtual_network:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    state: present
    isGuestVirtualNetwork: true
    scalableGroupNames:
      - string
    vManageVpnId: string
    virtualNetworkName: string
- name: Delete all
  cisco.catalystcenter.sda_virtual_network:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    state: absent
    virtualNetworkName: string
- name: Update all
  cisco.catalystcenter.sda_virtual_network:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_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
dnac_response dictionary	A dictionary or list with the response returned by the Cisco CATALYST Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"description": "string", "executionId": "string", "executionStatusUrl": "string", "status": "string", "taskId": "string", "taskStatusUrl": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)