cisco.dnac.ipam_global_ip_address_pools_id_v1 module – Resource module for Ipam Global Ip Address Pools Id V1
Note
This module is part of the cisco.dnac collection (version 6.27.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.dnac
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.ipam_global_ip_address_pools_id_v1
.
New in cisco.dnac 6.17.0
Synopsis
Manage operations update and delete of the resource Ipam Global Ip Address Pools Id V1.
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.
dnacentersdk >= 2.4.9
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
Ipam Global Ip Address Pools Id’s addressSpace. |
|
The DHCP server(s) for this subnet. |
|
The DNS server(s) for this subnet. |
|
The gateway IP address for this subnet. |
|
The network mask component, as a decimal, for the CIDR notation of this subnet. |
|
The IP address component of the CIDR notation for this subnet. |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Id path parameter. The `id` of the global IP address pool to update. |
|
The name for this reserve IP pool. Only letters, numbers, ‘-’ (hyphen), ‘_’ (underscore), ‘.’ (period), and ‘/’ (forward slash) are allowed. |
|
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. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are network_settings.NetworkSettings.delete_a_global_ip_address_pool_v1, network_settings.NetworkSettings.updates_a_global_ip_address_pool_v1,
Paths used are 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 the embedded connection manager from Cisco DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco DNA Center documentation for Network Settings DeleteAGlobalIPAddressPoolV1
Complete reference of the DeleteAGlobalIPAddressPoolV1 API.
- Cisco DNA Center documentation for Network Settings UpdatesAGlobalIPAddressPoolV1
Complete reference of the UpdatesAGlobalIPAddressPoolV1 API.
Examples
- name: Update by id
cisco.dnac.ipam_global_ip_address_pools_id_v1:
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}}"
state: present
addressSpace:
dhcpServers:
- string
dnsServers:
- string
gatewayIpAddress: string
prefixLength: 0
subnet: string
id: string
name: string
poolType: string
- name: Delete by id
cisco.dnac.ipam_global_ip_address_pools_id_v1:
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}}"
state: absent
id: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |