cisco.dnac.sda_virtual_network – Manage SdaVirtualNetwork objects of Sda

Note

This plugin is part of the cisco.dnac collection (version 2.0.7).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.sda_virtual_network.

New in version 1.0.0: of cisco.dnac

Synopsis

• Get virtual network (VN) from SDA Fabric.

• Delete virtual network (VN) from SDA Fabric.

• Add virtual network (VN) in SDA Fabric.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• dnacentersdk

Parameters

Parameter		Choices/Defaults	Comments
payload list / elements=dictionary			An object to send in the Request body. Required for state create.
	siteNameHierarchy string		It is the sda virtual network's siteNameHierarchy.
	virtualNetworkName string		It is the sda virtual network's virtualNetworkName.
site_name_hierarchy string / required			SiteNameHierarchy query parameter.
virtual_network_name string / required			VirtualNetworkName query parameter.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.sda_virtual_network

The official documentation on the cisco.dnac.plugins.module_utils.definitions.sda_virtual_network module.

SdaVirtualNetwork reference

Complete reference of the SdaVirtualNetwork object model.

SdaVirtualNetwork reference

SDK reference.

Examples

- name: get_vn
  cisco.dnac.sda_virtual_network:
    state: query  # required
    site_name_hierarchy: SomeValue  # string, required
    virtual_network_name: SomeValue  # string, required
  register: nm_get_vn

- name: delete_vn
  cisco.dnac.sda_virtual_network:
    state: delete  # required
    site_name_hierarchy: SomeValue  # string, required
    virtual_network_name: SomeValue  # string, required

- name: add_vn
  cisco.dnac.sda_virtual_network:
    state: create  # required
    payload:  # required
    - virtualNetworkName: SomeValue  # string
      siteNameHierarchy: SomeValue  # string

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
dnac_response dictionary	always	A dictionary with the response returned by the DNA Center Python SDK Sample: {'response': 29, 'version': '1.0'}
missing_params list / elements=string	when the function request schema is not satisfied	Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function string	always	The DNA Center SDK function used to execute the task Sample: sda.add_vn

Authors

• Rafael Campos (@racampos)