cisco.catalystcenter.ipam_site_ip_address_pools module -- Resource module for Ipam Site Ip Address Pools

Note

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

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.

New in cisco.catalystcenter 2.0.0

Synopsis

• Manage operations create, update and delete of the resource Ipam Site Ip Address Pools. - > Reserves creates an IP address subpool, which reserves address space from a global pool or global pools for a particular site and it's child sites. A subpool may be either IPv4 with an `ipV4AddressSpace` specified , IPv6 with an `ipV6AddressSpace` specified or Dual-stack with both an `ipV4AddressSpace` and `ipV6AddressSpace` specified .

• Releases an IP address subpool.

• Updates 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.2.3.0.0

• python >= 3.12

Parameters

Parameter	Comments
catalystcenter_debug aliases: dnac_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host aliases: dnac_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password aliases: dnac_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_port aliases: dnac_port, catalystcenter_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_username aliases: dnac_username, user string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify aliases: dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version aliases: dnac_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"`
id string	The UUID for this reserve IP pool (subpool).
ipV4AddressSpace dictionary	Ipam Site Ip Address Pools's ipV4AddressSpace.
ipV6AddressSpace dictionary	Ipam Site Ip Address Pools's ipV6AddressSpace.
name string	The name for this reserve IP pool. Only letters, numbers, '-' (hyphen), '_' (underscore), '.' (period), and '/' (forward slash) are allowed.
poolType string	Once created, a subpool type cannot be changed. - LAN - Assigns IP addresses to LAN interfaces of applicable VNFs and underlay LAN automation. - Management - Assigns IP addresses to management interfaces. A management network is a dedicated network connected to VNFs for VNF management. - Service - Assigns IP addresses to service interfaces. Service networks are used for communication within VNFs. - WAN - Assigns IP addresses to NFVIS for UCS-E provisioning. - Generic - used for all other network types.
siteId string	The `id` of the site that this subpool belongs to. This must be the `id` of a non-Global site.
siteName string	The name of the site that this subpool belongs to.
validate_response_schema boolean	Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are network_settings.NetworkSettings.release_an_ip_address_subpool, network_settings.NetworkSettings.reservecreate_ip_address_subpools, network_settings.NetworkSettings.updates_an_ip_address_subpool,

• Paths used are post /dna/intent/api/v1/ipam/siteIpAddressPools, delete /dna/intent/api/v1/ipam/siteIpAddressPools/{id}, put /dna/intent/api/v1/ipam/siteIpAddressPools/{id},

• Does not support 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

• Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for Network Settings ReservecreateIPAddressSubpools

Complete reference of the ReservecreateIPAddressSubpools API.

Cisco Catalyst Center documentation for Network Settings ReleaseAnIPAddressSubpool

Complete reference of the ReleaseAnIPAddressSubpool API.

Cisco Catalyst Center documentation for Network Settings UpdatesAnIPAddressSubpool

Complete reference of the UpdatesAnIPAddressSubpool API.

Examples

---
- name: Update by id
  cisco.catalystcenter.ipam_site_ip_address_pools:
    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}}"
    state: present
    id: string
    ipV4AddressSpace: {}
    ipV6AddressSpace: {}
    name: {}
    poolType: string
    siteId: string
    siteName: string
- name: Delete by id
  cisco.catalystcenter.ipam_site_ip_address_pools:
    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}}"
    state: absent
    id: string
- name: Create
  cisco.catalystcenter.ipam_site_ip_address_pools:
    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}}"
    state: present
    id: string
    ipV4AddressSpace: {}
    ipV6AddressSpace: {}
    name: {}
    poolType: string
    siteId: string
    siteName: string

Return Values

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

Key	Description
catalystcenter_response dictionary	A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Bryan Vargas (@bvargasre)

Collection links

Issue Tracker Repository (Sources)