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

Note

This module is part of the cisco.dnac collection (version 6.2.1).

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.

• Add IP Pool in SDA Virtual Network.

• Delete IP Pool from SDA Virtual Network.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.4.8

• python >= 3.5

Parameters

Parameter	Comments
authenticationPolicyName string added in 4.0.0 of cisco.dnac	Deprecated, same as vlanName, please use vlanName.
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: no ← (default) yes
dnac_host string / required	The Cisco DNA Center hostname.
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port integer	The Cisco DNA Center port. Default: 443
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: “admin”
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: no yes ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: “2.2.3.3”
ipPoolName string added in 4.0.0 of cisco.dnac	IpPoolName query parameter.
isL2FloodingEnabled boolean added in 4.0.0 of cisco.dnac	Layer2 flooding enablement flag. Choices: no yes
isThisCriticalPool boolean added in 4.0.0 of cisco.dnac	Critical pool enablement flag where depending on the pool type (data or voice), a corresponding Critical Vlan gets assigned to the Critical Pool. Choices: no yes
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	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: no yes ← (default)
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

• SDK Method used are sda.Sda.add_ip_pool_in_sda_virtual_network, sda.Sda.delete_ip_pool_from_sda_virtual_network,

• Paths used are post /dna/intent/api/v1/business/sda/virtualnetwork/ippool, delete /dna/intent/api/v1/business/sda/virtualnetwork/ippool,

• 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

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
    siteNameHierarchy: 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	Description
dnac_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: “{\n \”status\”: \”string\”,\n \”description\”: \”string\”,\n \”taskId\”: \”string\”,\n \”taskStatusUrl\”: \”string\”,\n \”executionStatusUrl\”: \”string\”,\n \”executionId\”: \”string\”\n}\n”

Authors

• Rafael Campos (@racampos)