IpSpaceIpAllocationRequest

IpSpaceIpAllocationRequest
IpSpaceIpAllocationRequest

An IP Space IP Allocation request object. An IP Space IP allocation request can either request a specific IP address/IP prefix or request a specific number of any free IP Addresses/IP Prefixes within an IP Space. To allocate a specific IP Address or IP Prefix, the value field should be used and the IP Address or Prefix should be specified. To allocate up to 5 of any free IP Addresses or Prefixes within the IP Space, use the quantity field to specify the amount. The value and quantity fields should not be set simultaneously.

JSON Example
{
    "type": "string",
    "quantity": 0,
    "prefixLength": 0,
    "value": "string",
    "purpose": "<clusterName>-<serviceName>"
}
string
type
Required

The type of the IP allocation requested. Possible values are:

  • FLOATING_IP - For allocation of floating IP addresses from defined IP Space ranges.
  • IP_PREFIX - For allocation of IP prefix sequences from defined IP Space prefixes.
integer
quantity
Optional

The number of IP addresses or IP Prefix blocks to allocate. Specifying quantity will allocate the given number of any free IP addresses or IP Prefixes within the IP Space. To use a specific IP address or IP Prefix, please use the value field to request a specific value.

integer
prefixLength
Optional

The prefix length of an IP Prefix to allocate. This is required if type is IP_PREFIX. This field is only required if the request is for a specific quantity of IP Prefixes and not needed if request value is specified.

string
value
Optional

The specific IP addresses or IP Prefix to allocate. If this property is set, the quantity value should not be set. For IP_PREFIX type, only a single IP PREFIX CIDR is supported. For FLOATING_IP type, this value can be single IP such as "192.168.1.1", an IP Range such as "192.168.1.1-192.168.1.2", or a CIDR block such as "192.168.1.32/28". For IP Range and CIDR block, the maximum supported number of IPs is 16 (i.e. prefix length of 28 for CIDR block for IPv4).

string
purpose
Optional

This field allows users to specify the intended use or reason for requesting this IP allocation.

Availability
Added in 37.1
Parameter To