cisco.dnac.ipam_site_ip_address_pools module – Resource module for Ipam Site Ip Address Pools

Note

This module is part of the cisco.dnac collection (version 6.31.3).

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_site_ip_address_pools.

New in cisco.dnac 6.17.0

Synopsis 

This module represents an alias of the module ipam_site_ip_address_pools_v1

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
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: `false` ← (default) `true`
dnac_host string / required	The Cisco DNA Center hostname.
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port integer	The Cisco DNA Center port. Default: `443`
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: `"admin"`
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: `false` `true` ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: `"2.3.7.6"`
ipV4AddressSpace dictionary	Ipam Site Ip Address Pools’s ipV4AddressSpace.
assignedAddresses string	The number of addresses assigned from the pool. This is a numeric string; since IPv6 address spaces are 128 bits in size, presume this string has a value up to 128 bits for IPv6 address spaces and 32 bits for IPv4 address spaces.
defaultAssignedAddresses string	The number of addresses that are assigned from the pool by default. This is a numeric string; since IPv6 address spaces are 128 bits in size, presume this string has a value up to 128 bits for IPv6 address spaces and 32 bits for IPv4 address spaces.
dhcpServers list / elements=string	The DHCP server(s) for this subnet.
dnsServers list / elements=string	The DNS server(s) for this subnet.
gatewayIpAddress string	The gateway IP address for this subnet.
globalPoolId string	The non-tunnel global pool for this reserve pool (which matches this IP address type). Once added this value cannot be changed.
prefixLength float	The network mask component, as a decimal, for the CIDR notation of this subnet.
slaacSupport boolean	If the prefixLength is 64, this option may be enabled. Stateless Address Auto-configuration (SLAAC) allows network devices to select their IP address without the use of DHCP servers. Choices: `false` `true`
subnet string	The IP address component of the CIDR notation for this subnet.
totalAddresses string	The total number of addresses in the pool. This is a numeric string; since IPv6 address spaces are 128 bits in size, presume this string has a value up to 128 bits for IPv6 address spaces and 32 bits for IPv4 address spaces.
unassignableAddresses string	The number of addresses in the pool that cannot be assigned. This is a numeric string; since IPv6 address spaces are 128 bits in size, presume this string has a value up to 128 bits for IPv6 address spaces and 32 bits for IPv4 address spaces.
ipV6AddressSpace dictionary	Ipam Site Ip Address Pools’s ipV6AddressSpace.
assignedAddresses string	The number of addresses assigned from the pool. This is a numeric string; since IPv6 address spaces are 128 bits in size, presume this string has a value up to 128 bits for IPv6 address spaces and 32 bits for IPv4 address spaces.
defaultAssignedAddresses string	The number of addresses that are assigned from the pool by default. This is a numeric string; since IPv6 address spaces are 128 bits in size, presume this string has a value up to 128 bits for IPv6 address spaces and 32 bits for IPv4 address spaces.
dhcpServers list / elements=string	The DHCP server(s) for this subnet.
dnsServers list / elements=string	The DNS server(s) for this subnet.
gatewayIpAddress string	The gateway IP address for this subnet.
globalPoolId string	The non-tunnel global pool for this reserve pool (which matches this IP address type). Once added this value cannot be changed.
prefixLength float	The network mask component, as a decimal, for the CIDR notation of this subnet.
slaacSupport boolean	If the prefixLength is 64, this option may be enabled. Stateless Address Auto-configuration (SLAAC) allows network devices to select their IP address without the use of DHCP servers. Choices: `false` `true`
subnet string	The IP address component of the CIDR notation for this subnet.
totalAddresses string	The total number of addresses in the pool. This is a numeric string; since IPv6 address spaces are 128 bits in size, presume this string has a value up to 128 bits for IPv6 address spaces and 32 bits for IPv4 address spaces.
unassignableAddresses string	The number of addresses in the pool that cannot be assigned. This is a numeric string; since IPv6 address spaces are 128 bits in size, presume this string has a value up to 128 bits for IPv6 address spaces and 32 bits for IPv4 address spaces.
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 DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: `false` `true` ← (default)

Notes 

Note

SDK Method used are network_settings.NetworkSettings.reservecreate_ip_address_subpools_v1,
Paths used are post /dna/intent/api/v1/ipam/siteIpAddressPools,
It should be noted that this module is an alias of ipam_site_ip_address_pools_v1
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

Examples 

- name: Create
  cisco.dnac.ipam_site_ip_address_pools:
    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
    ipV4AddressSpace:
      assignedAddresses: string
      defaultAssignedAddresses: string
      dhcpServers:
        - string
      dnsServers:
        - string
      gatewayIpAddress: string
      globalPoolId: string
      prefixLength: 0
      slaacSupport: true
      subnet: string
      totalAddresses: string
      unassignableAddresses: string
    ipV6AddressSpace:
      assignedAddresses: string
      defaultAssignedAddresses: string
      dhcpServers:
        - string
      dnsServers:
        - string
      gatewayIpAddress: string
      globalPoolId: string
      prefixLength: 0
      slaacSupport: true
      subnet: string
      totalAddresses: string
      unassignableAddresses: string
    name: string
    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
dnac_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: `{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

Rafael Campos (@racampos)

cisco.dnac.ipam_site_ip_address_pools module – Resource module for Ipam Site Ip Address Pools

Synopsis 

Requirements 

Parameters 

Notes 

See Also 

Examples 

Return Values 

Authors

Collection links

cisco.dnac.ipam_site_ip_address_pools module – Resource module for Ipam Site Ip Address Pools

Synopsis

Requirements

Parameters

Notes

See Also

Examples

Return Values

Authors

Collection links

Synopsis 

Requirements 

Parameters 

Notes 

See Also 

Examples 

Return Values 