cisco.dnac.global_pool – Resource module for Global 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.global_pool.

New in version 3.1.0: of cisco.dnac

Synopsis

• Manage operations create, update and delete of the resource Global 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.
id string				Id path parameter. Global pool id.
settings dictionary				Global Pool's settings.
	ippool list / elements=string			Global Pool's ippool.
		dhcpServerIps list / elements=string		Dhcp Server Ips.
		dnsServerIps list / elements=string		Dns Server Ips.
		gateway string		Gateway.
		id string		Id.
		ipPoolName string		Ip Pool 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.

Notes

Note

• Does not support check_mode

See Also

See also

Global Pool reference

Complete reference of the Global Pool object model.

Examples

- name: Update all
  cisco.dnac.global_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
    settings:
      ippool:
      - dhcpServerIps:
        - string
        dnsServerIps:
        - string
        gateway: string
        id: string
        ipPoolName: string

- name: Create
  cisco.dnac.global_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
    settings:
      ippool:
      - IpAddressSpace: string
        dhcpServerIps:
        - string
        dnsServerIps:
        - string
        gateway: string
        ipPoolCidr: string
        ipPoolName: string
        type: string

- name: Delete by id
  cisco.dnac.global_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
    id: 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: { "executionId": "string", "executionStatusUrl": "string", "message": "string" }

Authors

• Rafael Campos (@racampos)