cisco.catalystcenter.sda_virtual_network module -- Resource module for Sda Virtual Network

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

New in cisco.catalystcenter 3.1.0

Synopsis

• This module represents an alias of the module sda_virtual_network_v2

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"`
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_v1, sda.Sda.delete_virtual_network_with_scalable_groups_v1, sda.Sda.update_virtual_network_with_scalable_groups_v1,

• Paths used are post /dna/intent/api/v1/virtual-network, delete /dna/intent/api/v1/virtual-network, put /dna/intent/api/v1/virtual-network,

• It should be noted that this module is an alias of sda_virtual_network_v2

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

Complete reference of the AddVirtualNetworkWithScalableGroupsV1 API.

Cisco DNA Center documentation for SDA DeleteVirtualNetworkWithScalableGroupsV1

Complete reference of the DeleteVirtualNetworkWithScalableGroupsV1 API.

Cisco DNA Center documentation for SDA UpdateVirtualNetworkWithScalableGroupsV1

Complete reference of the UpdateVirtualNetworkWithScalableGroupsV1 API.

Examples

- name: Create
  cisco.catalystcenter.sda_virtual_network:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: present
    isGuestVirtualNetwork: true
    scalableGroupNames:
      - string
    vManageVpnId: string
    virtualNetworkName: string
- name: Delete all
  cisco.catalystcenter.sda_virtual_network:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: absent
    virtualNetworkName: string
- name: Update all
  cisco.catalystcenter.sda_virtual_network:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _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
catalystcenter_response dictionary	A dictionary or list with the response returned by the Cisco DNAC 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)