cisco.dnac.global_pool_info – Information module for Global Pool

Note

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

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

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

New in version 1.0.0: of cisco.dnac

Synopsis

  • Get all Global Pool.

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
limit
string
Limit query parameter. No of Global Pools to be retrieved.
offset
string
Offset query parameter. Offset/starting row.

See Also

See also

Global Pool reference

Complete reference of the Global Pool object model.

Examples

- name: Get all Global Pool
  cisco.dnac.global_pool_info:
    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}}"
    offset: string
    limit: string
  register: result

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:
{ "response": [ { "ipPoolName": "string", "dhcpServerIps": [ "string" ], "gateways": [ "string" ], "createTime": "string", "lastUpdateTime": "string", "totalIpAddressCount": "string", "usedIpAddressCount": "string", "parentUuid": "string", "owner": "string", "shared": "string", "overlapping": "string", "configureExternalDhcp": "string", "usedPercentage": "string", "clientOptions": {}, "dnsServerIps": [ "string" ], "context": [ { "owner": "string", "contextKey": "string", "contextValue": "string" } ], "ipv6": "string", "id": "string", "ipPoolCidr": "string" } ], "version": "string" }


Authors

  • Rafael Campos (@racampos)