cisco.dnac.reserve_ip_subpool_info – Information module for Reserve Ip Subpool

Note

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

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

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

New in version 1.0.0: of cisco.dnac

Synopsis

  • Get all Reserve Ip Subpool.

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.
siteId
string
SiteId query parameter. Site id to get the reserve ip associated with the site.

See Also

See also

Reserve Ip Subpool reference

Complete reference of the Reserve Ip Subpool object model.

Examples

- name: Get all Reserve Ip Subpool
  cisco.dnac.reserve_ip_subpool_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}}"
    siteId: string
    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": [ { "id": "string", "groupName": "string", "ipPools": [ { "ipPoolName": "string", "dhcpServerIps": [ {} ], "gateways": [ "string" ], "createTime": 0, "lastUpdateTime": 0, "totalIpAddressCount": 0, "usedIpAddressCount": 0, "parentUuid": "string", "owner": "string", "shared": true, "overlapping": true, "configureExternalDhcp": true, "usedPercentage": "string", "clientOptions": {}, "groupUuid": "string", "dnsServerIps": [ {} ], "context": [ { "owner": "string", "contextKey": "string", "contextValue": "string" } ], "ipv6": true, "id": "string", "ipPoolCidr": "string" } ], "siteId": "string", "siteHierarchy": "string", "type": "string", "groupOwner": "string" } ], "version": "string" }


Authors

  • Rafael Campos (@racampos)