cisco.dnac.sda_virtual_network_ip_pool – Resource module for Sda Virtual Network Ip Pool

Note

This plugin is part of the cisco.dnac collection (version 4.1.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.

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

New in version 3.1.0: of cisco.dnac

Synopsis

• Manage operations create and delete of the resource Sda Virtual Network Ip Pool.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.4.0

• python >= 3.5

Parameters

Parameter	Choices/Defaults	Comments
authenticationPolicyName string added in 4.0.0 of cisco.dnac		Deprecated, same as vlanName, please use vlanName.
dnac_debug boolean	Choices: no ← yes	Flag for Cisco DNA Center SDK to enable debugging.
dnac_host string / required		The Cisco DNA Center hostname.
dnac_password string		The Cisco DNA Center password to authenticate.
dnac_port string	Default: 443	The Cisco DNA Center port.
dnac_username string	Default: "admin"	The Cisco DNA Center username to authenticate. aliases: user
dnac_verify boolean	Choices: no yes ←	Flag to enable or disable SSL certificate verification.
dnac_version string	Default: "2.2.3.3"	Informs the SDK which version of Cisco DNA Center to use.
ipPoolName string added in 4.0.0 of cisco.dnac		IpPoolName query parameter.
isL2FloodingEnabled boolean added in 4.0.0 of cisco.dnac	Choices: no yes	Layer2 flooding enablement flag.
isThisCriticalPool boolean added in 4.0.0 of cisco.dnac	Choices: no yes	Critical pool enablement flag where depending on the pool type (data or voice), a corresponding Critical Vlan gets assigned to the Critical Pool.
isWirelessPool string added in 4.0.0 of cisco.dnac		Wireless Pool enablement flag.
poolType string added in 4.0.0 of cisco.dnac		Pool Type (needed when assigning segment to INFRA_VN) (Example AP.).
scalableGroupName string added in 4.0.0 of cisco.dnac		Scalable Group, that is associated to Virtual Network.
siteNameHierarchy string added in 4.0.0 of cisco.dnac		Full path of sda fabric siteNameHierarchy.
trafficType string added in 4.0.0 of cisco.dnac		Traffic type.
validate_response_schema boolean	Choices: no yes ←	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.
virtualNetworkName string		VirtualNetworkName query parameter.
vlanName string added in 4.0.0 of cisco.dnac		Vlan name for this segment, represent the segment name, if empty, vlanName would be auto generated by API.

Notes

Note

• 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

Sda Virtual Network Ip Pool reference

Complete reference of the Sda Virtual Network Ip Pool object model.

Examples

- name: Delete all
  cisco.dnac.sda_virtual_network_ip_pool:
    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
    ipPoolName: string
    virtualNetworkName: string

- name: Create
  cisco.dnac.sda_virtual_network_ip_pool:
    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
    authenticationPolicyName: string
    ipPoolName: string
    isL2FloodingEnabled: true
    isThisCriticalPool: true
    isWirelessPool: string
    poolType: string
    scalableGroupName: string
    siteNameHierarchy: string
    trafficType: string
    virtualNetworkName: string
    vlanName: 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 or list with the response returned by the Cisco DNAC Python SDK Sample: { "status": "string", "description": "string", "taskId": "string", "taskStatusUrl": "string", "executionStatusUrl": "string", "executionId": "string" }

Authors

• Rafael Campos (@racampos)