cisco.dnac.reserve_ip_subpool_create module – Resource module for Reserve Ip Subpool Create
Note
This module is part of the cisco.dnac collection (version 6.25.1).
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.reserve_ip_subpool_create
.
New in cisco.dnac 4.0.0
Synopsis
This module represents an alias of the module reserve_ip_subpool_create_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 |
---|---|
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: |
|
IPv4 input for dhcp server ip example “1.1.1.1”. |
|
IPv4 input for dns server ip example “4.4.4.4”. |
|
Gateway ip address details, example 175.175.0.1. |
|
IP v4 Global pool address with cidr, example 175.175.0.0/16. |
|
IPv4 prefix value is true, the ip4 prefix length input field is enabled , if it is false ipv4 total Host input is enable. Choices:
|
|
The ipv4 prefix length is required when ipv4prefix value is true. |
|
IPv4 Subnet address, example 175.175.0.0. Either ipv4Subnet or ipv4TotalHost needs to be passed if creating IPv4 subpool. |
|
IPv4 total host is required when ipv4prefix value is false. |
|
If the value is omitted or false only ipv4 input are required, otherwise both ipv6 and ipv4 are required. Choices:
|
|
IPv6 format dhcp server as input example “2001 db8 1234”. |
|
IPv6 format dns server input example “2001 db8 1234”. |
|
Gateway ip address details, example 2001 db8 85a3 0 100 1. |
|
IPv6 Global pool address with cidr this is required when Ipv6AddressSpace value is true, example 2001 db8 85a3 /64. |
|
Ipv6 prefix value is true, the ip6 prefix length input field is enabled , if it is false ipv6 total Host input is enable. Choices:
|
|
IPv6 prefix length is required when the ipv6prefix value is true. |
|
IPv6 Subnet address, example 2001 db8 85a3 0 100. Either ipv6Subnet or ipv6TotalHost needs to be passed if creating IPv6 subpool. |
|
IPv6 total host is required when ipv6prefix value is false. |
|
Name of the reserve ip sub pool. |
|
SiteId path parameter. Site id to reserve the ip sub pool. |
|
Slaac Support. Choices:
|
|
Type of the reserve ip sub pool. |
|
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.reserve_ip_subpool_v1,
Paths used are post /dna/intent/api/v1/reserve-ip-subpool/{siteId},
It should be noted that this module is an alias of reserve_ip_subpool_create_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
See Also
See also
- Cisco DNA Center documentation for Network Settings ReserveIPSubpoolV1
Complete reference of the ReserveIPSubpoolV1 API.
Examples
- name: Create
cisco.dnac.reserve_ip_subpool_create:
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}}"
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
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: |