[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Introduced1 Changed1

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.


Properties

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


integer
quantity Changed 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.


string
value Introduced Optional

The specific IP address or IP Prefix to allocate. If an IP address or IP Prefix is specified, the quantity value should not be set.

JSON Example

{
	"type": "string"
}

Vendor Extensions

This class contains the following vendor extensions defined in the spec:
x-vcloud-property-annotations:
    prefixLength:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    quantity:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    type:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    value:
        x-vcloud-added-in: "37.2"
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Availability
Added in 37.1
Parameter To

Allocate
What's changed in latest?

Added Properties
value
CHANGED (1)
Changed Properties
quantity

Feedback

Was this page helpful?