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 3.2.0).

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

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
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.2.3"
Informs the SDK which version of Cisco DNA Center to use.
ipPoolName
string
IpPoolName query parameter.
payload
list / elements=string
Sda Virtual Network Ip Pool's payload.
authenticationPolicyName
string
Authentication Policy Name.
ipPoolName
string
Ip Pool Name.
isL2FloodingEnabled
boolean
    Choices:
  • no
  • yes
Is L2 Flooding Enabled.
isThisCriticalPool
boolean
    Choices:
  • no
  • yes
Is This Critical Pool.
poolType
string
Pool Type.
scalableGroupName
string
Scalable Group Name.
trafficType
string
Traffic Type.
virtualNetworkName
string
Virtual Network Name.
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.

Notes

Note

  • Does not support check_mode

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
    payload:
    - virtualNetworkName: string
      ipPoolName: string
      trafficType: string
      authenticationPolicyName: string
      scalableGroupName: string
      isL2FloodingEnabled: true
      isThisCriticalPool: true
      poolType: 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", "executionStatusUrl": "string" }


Authors

  • Rafael Campos (@racampos)