/ home / cisco / cisco.dnac / 6.13.3 / module / global_pool_info

cisco.dnac.global_pool_info (6.13.3) — module

Information module for Global Pool

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Global Pool.

API to get global pool.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- 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}}"
    headers: "{{my_headers | from_json}}"
    offset: 0
    limit: 0
  register: result

Inputs

    
limit:
    description:
    - Limit query parameter. No of Global Pools to be retrieved.
    type: int

offset:
    description:
    - Offset query parameter. Offset/starting row.
    type: int

headers:
    description: Additional headers.
    type: dict

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"response\": [\n    {\n      \"ipPoolName\": \"string\",\n      \"\
    dhcpServerIps\": [\n        \"string\"\n      ],\n      \"gateways\": [\n    \
    \    \"string\"\n      ],\n      \"createTime\": \"string\",\n      \"lastUpdateTime\"\
    : \"string\",\n      \"totalIpAddressCount\": \"string\",\n      \"usedIpAddressCount\"\
    : \"string\",\n      \"parentUuid\": \"string\",\n      \"owner\": \"string\"\
    ,\n      \"shared\": \"string\",\n      \"overlapping\": \"string\",\n      \"\
    configureExternalDhcp\": \"string\",\n      \"usedPercentage\": \"string\",\n\
    \      \"clientOptions\": {},\n      \"dnsServerIps\": [\n        \"string\"\n\
    \      ],\n      \"context\": [\n        {\n          \"owner\": \"string\",\n\
    \          \"contextKey\": \"string\",\n          \"contextValue\": \"string\"\
    \n        }\n      ],\n      \"ipv6\": \"string\",\n      \"id\": \"string\",\n\
    \      \"ipPoolCidr\": \"string\"\n    }\n  ],\n  \"version\": \"string\"\n}\n"
  type: dict