/ home / cisco / cisco.dnac / 6.13.3 / module / reserve_ip_subpool_info

cisco.dnac.reserve_ip_subpool_info (6.13.3) — module

Information module for Reserve Ip Subpool

| "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 Reserve Ip Subpool.

API to get the ip subpool info.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- 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}}"
    headers: "{{my_headers | from_json}}"
    siteId: string
    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

siteId:
    description:
    - SiteId query parameter. Site id to get the reserve ip associated with the site.
    type: str

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      \"id\": \"string\",\n      \"groupName\"\
    : \"string\",\n      \"ipPools\": [\n        {\n          \"ipPoolName\": \"string\"\
    ,\n          \"dhcpServerIps\": [\n            {}\n          ],\n          \"\
    gateways\": [\n            \"string\"\n          ],\n          \"createTime\"\
    : 0,\n          \"lastUpdateTime\": 0,\n          \"totalIpAddressCount\": 0,\n\
    \          \"usedIpAddressCount\": 0,\n          \"parentUuid\": \"string\",\n\
    \          \"owner\": \"string\",\n          \"shared\": true,\n          \"overlapping\"\
    : true,\n          \"configureExternalDhcp\": true,\n          \"usedPercentage\"\
    : \"string\",\n          \"clientOptions\": {},\n          \"groupUuid\": \"string\"\
    ,\n          \"dnsServerIps\": [\n            {}\n          ],\n          \"context\"\
    : [\n            {\n              \"owner\": \"string\",\n              \"contextKey\"\
    : \"string\",\n              \"contextValue\": \"string\"\n            }\n   \
    \       ],\n          \"ipv6\": true,\n          \"id\": \"string\",\n       \
    \   \"ipPoolCidr\": \"string\"\n        }\n      ],\n      \"siteId\": \"string\"\
    ,\n      \"siteHierarchy\": \"string\",\n      \"type\": \"string\",\n      \"\
    groupOwner\": \"string\"\n    }\n  ],\n  \"version\": \"string\"\n}\n"
  type: dict