cisco.dnac.reserve_ip_subpool – Resource module for Reserve Ip Subpool

Note

This plugin is part of the cisco.dnac collection (version 3.2.0).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.reserve_ip_subpool.

New in version 3.1.0: of cisco.dnac

Synopsis

• Manage operations create, update and delete of the resource Reserve Ip Subpool.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.3.1

• python >= 3.5

Parameters

Parameter	Choices/Defaults	Comments
dnac_debug boolean	Choices: no ← yes	Flag for Cisco DNA Center SDK to enable debugging.
dnac_host string / required		The Cisco DNA Center hostname.
dnac_password string		The Cisco DNA Center password to authenticate.
dnac_port string	Default: 443	The Cisco DNA Center port.
dnac_username string	Default: "admin"	The Cisco DNA Center username to authenticate. aliases: user
dnac_verify boolean	Choices: no yes ←	Flag to enable or disable SSL certificate verification.
dnac_version string	Default: "2.2.2.3"	Informs the SDK which version of Cisco DNA Center to use.
id string		Id path parameter. Id of reserve ip subpool to be deleted.
ipv4DhcpServers list / elements=string		IPv4 input for dhcp server ip example 1.1.1.1.
ipv4DnsServers list / elements=string		IPv4 input for dns server ip example 4.4.4.4.
ipv4GateWay string		Gateway ip address details, example 175.175.0.1.
ipv4GlobalPool string		IP v4 Global pool address with cidr, example 175.175.0.0/16.
ipv4Prefix boolean	Choices: no yes	IPv4 prefix value is true, the ip4 prefix length input field is enabled , if it is false ipv4 total Host input is enable.
ipv4PrefixLength integer		The ipv4 prefix length is required when ipv4prefix value is true.
ipv4Subnet string		IPv4 Subnet address, example 175.175.0.0.
ipv4TotalHost integer		IPv4 total host is required when ipv4prefix value is false.
ipv6AddressSpace boolean	Choices: no yes	If the value is false only ipv4 input are required, otherwise both ipv6 and ipv4 are required.
ipv6DhcpServers list / elements=string		IPv6 format dhcp server as input example 2001 db8 1234.
ipv6DnsServers list / elements=string		IPv6 format dns server input example 2001 db8 1234.
ipv6GateWay string		Gateway ip address details, example 2001 db8 85a3 0 100 1.
ipv6GlobalPool string		IPv6 Global pool address with cidr this is required when Ipv6AddressSpace value is true, example 2001 db8 85a3 /64.
ipv6Prefix boolean	Choices: no yes	Ipv6 prefix value is true, the ip6 prefix length input field is enabled , if it is false ipv6 total Host input is enable.
ipv6PrefixLength integer		IPv6 prefix length is required when the ipv6prefix value is true.
ipv6Subnet string		IPv6 Subnet address, example 2001 db8 85a3 0 100.
ipv6TotalHost integer		IPv6 total host is required when ipv6prefix value is false.
name string		Name of the reserve ip sub pool.
siteId string		SiteId path parameter. Site id to reserve the ip sub pool.
slaacSupport boolean	Choices: no yes	Slaac Support.
type string		Type of the reserve ip sub pool.
validate_response_schema boolean	Choices: no yes ←	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Notes

Note

• Does not support check_mode

See Also

See also

Reserve Ip Subpool reference

Complete reference of the Reserve Ip Subpool object model.

Examples

- name: Delete by id
  cisco.dnac.reserve_ip_subpool:
    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

- name: Create
  cisco.dnac.reserve_ip_subpool:
    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
    ipv4DhcpServers:
    - string
    ipv4DnsServers:
    - string
    ipv4GateWay: string
    ipv4GlobalPool: string
    ipv4Prefix: true
    ipv4PrefixLength: 0
    ipv4Subnet: string
    ipv4TotalHost: 0
    ipv6AddressSpace: true
    ipv6DhcpServers:
    - string
    ipv6DnsServers:
    - string
    ipv6GateWay: string
    ipv6GlobalPool: string
    ipv6Prefix: true
    ipv6PrefixLength: 0
    ipv6Subnet: string
    ipv6TotalHost: 0
    name: string
    siteId: string
    slaacSupport: true
    type: string

- name: Update by id
  cisco.dnac.reserve_ip_subpool:
    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
    id: string
    ipv4DhcpServers:
    - string
    ipv4DnsServers:
    - string
    ipv6AddressSpace: true
    ipv6DhcpServers:
    - string
    ipv6DnsServers:
    - string
    ipv6GateWay: string
    ipv6GlobalPool: string
    ipv6Prefix: true
    ipv6PrefixLength: 0
    ipv6Subnet: string
    ipv6TotalHost: 0
    name: string
    siteId: string
    slaacSupport: true

Return Values

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

Key	Returned	Description
dnac_response dictionary	always	A dictionary or list with the response returned by the Cisco DNAC Python SDK Sample: { "executionId": "string", "executionStatusUrl": "string", "message": "string" }

Authors

• Rafael Campos (@racampos)