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

Note

This plugin is part of the cisco.dnac collection (version 3.0.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 1.0.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

Parameters

Parameter Choices/Defaults Comments
id
string
Id query parameter. Id of subpool to be associated with the site.
ipv4DhcpServers
list / elements=string
Reserve Ip Subpool's ipv4DhcpServers.
ipv4DnsServers
list / elements=string
Reserve Ip Subpool's ipv4DnsServers.
ipv4GateWay
string
Reserve Ip Subpool's ipv4GateWay.
ipv4GlobalPool
string
Reserve Ip Subpool's ipv4GlobalPool.
ipv4Prefix
boolean
    Choices:
  • no
  • yes
Ipv4Prefix flag.
ipv4PrefixLength
integer
Reserve Ip Subpool's ipv4PrefixLength.
ipv4Subnet
string
Reserve Ip Subpool's ipv4Subnet.
ipv4TotalHost
integer
Reserve Ip Subpool's ipv4TotalHost.
ipv6AddressSpace
boolean
    Choices:
  • no
  • yes
Ipv6AddressSpace flag.
ipv6DhcpServers
list / elements=string
Reserve Ip Subpool's ipv6DhcpServers.
ipv6DnsServers
list / elements=string
Reserve Ip Subpool's ipv6DnsServers.
ipv6GateWay
string
Reserve Ip Subpool's ipv6GateWay.
ipv6GlobalPool
string
Reserve Ip Subpool's ipv6GlobalPool.
ipv6Prefix
boolean
    Choices:
  • no
  • yes
Ipv6Prefix flag.
ipv6PrefixLength
integer
Reserve Ip Subpool's ipv6PrefixLength.
ipv6Subnet
string
Reserve Ip Subpool's ipv6Subnet.
ipv6TotalHost
integer
Reserve Ip Subpool's ipv6TotalHost.
name
string
Reserve Ip Subpool's name.
siteId
string
SiteId path parameter. Site id of site to update sub pool.
slaacSupport
boolean
    Choices:
  • no
  • yes
SlaacSupport flag.
type
string
Reserve Ip Subpool's type.

See Also

See also

Reserve Ip Subpool reference

Complete reference of the Reserve Ip Subpool object model.

Examples

- 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

- 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: 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

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)