[{"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

IpSpacePrefix

An IP Prefix for an IP Space. Example: An IP Prefix with startingPrefixIpAddress 192.168.0.0 and prefixLength 30 and totalPrefixCount 3 will result in generation of 3 CIDR each with 4 IP addresses as: 192.168.0.0/30, 192.168.0.4/30 and 192.168.0.8/30 IP Prefix Sequences API /ipSpaces/ipPrefixSequences can be used to preview sequences.


Properties

integer
prefixLength Required

The prefix length.


string
startingPrefixIpAddress Required

Starting IP address for the IP prefix. Note that if the IP is a host IP and not the network definition IP for the specific prefix length, VCD will automatically modify starting IP to the network definition’s IP for the specified host IP. An example is that for prefix length 30, the starting IP of 192.169.0.2 will be automatically modified to 192.169.0.0. 192.169.0.6 will be modified to 192.169.0.4. 192.169.0.0/30 and 192.169.0.4/30 are network definition CIDRs for host IPs 192.169.0.2 and 192.169.0.6, respectively.


integer
totalPrefixCount Required

The number of prefix blocks defined by this IP prefix.


integer
allocatedPrefixCount Optional

The number of allocated IP prefix blocks.


number as float
allocatedPrefixPercentage Optional

Specifies the percentage of allocated IP prefix blocks out of total specified IP prefix blocks.


string
id Optional

Unique ID of the IP Space Prefix. For new IP Prefix, this is unset. Existing IP Prefix will have an ID which is used for update identification.

JSON Example

{
	"prefixLength": 0,
	"startingPrefixIpAddress": "string",
	"totalPrefixCount": 0
}

Vendor Extensions

This class contains the following vendor extensions defined in the spec:
x-vcloud-property-annotations:
    allocatedPrefixCount:
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSearchable
            - constraint: NonSortable
    allocatedPrefixPercentage:
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSearchable
            - constraint: NonSortable
    id:
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSearchable
            - constraint: NonSortable
            - constraint: UUID
    prefixLength:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
    startingPrefixIpAddress:
        x-vcloud-constraints:
            - constraint: NonSearchable
            - constraint: NonSortable
            - args:
                - arg: IPV4_IP
                - arg: IPV6_IP
              constraint: NetworkAddress
    totalPrefixCount:
        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
Property Of

IpSpacePrefixes

Feedback

Was this page helpful?