cisco.catalystcenter.ipam_global_ip_address_pools module -- Resource module for Ipam Global 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_global_ip_address_pools.

New in cisco.catalystcenter 2.0.0

Synopsis

  • Manage operations create, update and delete of the resource Ipam Global Ip Address Pools. - > Creates a global IP address pool, which is not bound to a particular site. A global pool must be either an IPv4 or IPv6 pool. - > Deletes a global IP address pool. A global IP address pool can only be deleted if there are no subpools reserving address space from it.

  • Updates a global IP address pool.

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

addressSpace

dictionary

Ipam Global Ip Address Pools's addressSpace.

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

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:

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 global IP pool.

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 global pool type cannot be changed. - Tunnel - Assigns IP addresses to site-to-site VPN for IPSec tunneling. - Generic - used for all other network types.

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.create_a_global_ip_address_pool, network_settings.NetworkSettings.delete_a_global_ip_address_pool, network_settings.NetworkSettings.updates_a_global_ip_address_pool,

  • Paths used are post /dna/intent/api/v1/ipam/globalIpAddressPools, delete /dna/intent/api/v1/ipam/globalIpAddressPools/{id}, put /dna/intent/api/v1/ipam/globalIpAddressPools/{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 CreateAGlobalIPAddressPool

Complete reference of the CreateAGlobalIPAddressPool API.

Cisco Catalyst Center documentation for Network Settings DeleteAGlobalIPAddressPool

Complete reference of the DeleteAGlobalIPAddressPool API.

Cisco Catalyst Center documentation for Network Settings UpdatesAGlobalIPAddressPool

Complete reference of the UpdatesAGlobalIPAddressPool API.

Examples

---
- name: Create
  cisco.catalystcenter.ipam_global_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
    addressSpace: {}
    id: string
    name: {}
    poolType: string
- name: Update by id
  cisco.catalystcenter.ipam_global_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
    addressSpace: {}
    id: string
    name: {}
    poolType: string
- name: Delete by id
  cisco.catalystcenter.ipam_global_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

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)