cisco.catalystcenter.ipam_site_ip_address_pools_info module -- Information module for Ipam Site Ip Address Pools

Note

This module is part of the cisco.catalystcenter collection (version 2.3.1).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.ipam_site_ip_address_pools_info.

New in cisco.catalystcenter 6.17.0

Synopsis

  • Get all Ipam Site Ip Address Pools.

  • Get Ipam Site Ip Address Pools by id.

  • Retrieves IP address subpools, which reserve address space from a global pool or global pools . - > Retrieves an IP address subpool, which reserves address space from a global pool or global pools for a particular site.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • catalystcentersdk >= 3.1.6.0.0

  • python >= 3.12

Parameters

Parameter

Comments

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_username

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

Default: :ansible-option-default:`"3.1.6.0"`

headers

dictionary

Additional headers.

id

string

Id path parameter. The `id` of the IP address subpool to retrieve.

limit

integer

Limit query parameter. The number of records to show for this page; the minimum is 1, and the maximum is 500.

offset

integer

Offset query parameter. The first record to show for this page; the first record is numbered 1.

order

string

Order query parameter. Whether ascending or descending order should be used to sort the response.

siteId

string

SiteId query parameter. The `id` of the site for which to retrieve IP address subpools. Only subpools whose `siteId` exactly matches will be fetched, parent or child site matches will not be included.

sortBy

string

SortBy query parameter. A property within the response to sort by.

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • SDK Method used are network_settings.NetworkSettings.retrieves_an_ip_address_subpool, network_settings.NetworkSettings.retrieves_ip_address_subpools,

  • Paths used are get /dna/intent/api/v1/ipam/siteIpAddressPools, get /dna/intent/api/v1/ipam/siteIpAddressPools/{id},

  • Supports check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins,

  • but instead uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for Network Settings RetrievesAnIPAddressSubpool

Complete reference of the RetrievesAnIPAddressSubpool API.

Cisco DNA Center documentation for Network Settings RetrievesIPAddressSubpools

Complete reference of the RetrievesIPAddressSubpools API.

Examples

---
- name: Get all Ipam Site Ip Address Pools
  cisco.catalystcenter.ipam_site_ip_address_pools_info:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    headers: "{{my_headers | from_json}}"
    offset: 0
    limit: 0
    sortBy: string
    order: string
    siteId: string
  register: result
- name: Get Ipam Site Ip Address Pools by id
  cisco.catalystcenter.ipam_site_ip_address_pools_info:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    headers: "{{my_headers | from_json}}"
    id: string
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"id": "string", "ipV4AddressSpace": {"addressSpaceId": "string", "assignedAddresses": "string", "defaultAssignedAddresses": "string", "dhcpServers": ["string"], "dnsServers": ["string"], "gatewayIpAddress": "string", "globalPoolId": "string", "overlapping": true, "prefixLength": 0, "slaacSupport": true, "subnet": "string", "totalAddresses": "string", "unassignableAddresses": "string"}, "ipV6AddressSpace": {"addressSpaceId": "string", "assignedAddresses": "string", "defaultAssignedAddresses": "string", "dhcpServers": ["string"], "dnsServers": ["string"], "gatewayIpAddress": "string", "globalPoolId": "string", "overlapping": true, "prefixLength": 0, "slaacSupport": true, "subnet": "string", "totalAddresses": "string", "unassignableAddresses": "string"}, "name": "string", "poolType": "string", "siteId": "string", "siteName": "string"}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)