IpSpaceIpAllocation
An IP Space IP Allocation object.
Properties
Date when the IP address or IP prefix is allocated. This property is read-only.
Description about usage of an IP if the usageState is USED_MANUAL.
The identifier of the IP Space IP allocation in URN format.
The type of the IP allocation. 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.
The list of service categories where the IP address is being used. Typically this can be one of: SNAT, DNAT, LOAD_BALANCER, IPSEC_VPN, SSL_VPN or L2_VPN. This property is read-only.
Specifies current usage state of an allocated IP. Possible values are:
- UNUSED - the allocated IP is current not being used in the system.
- USED - the allocated IP is currently in use in the system. An allocated IP address or IP Prefix is considered used if it is being used in network services such as NAT rule or in Org VDC network definition.
- USED_MANUAL - the allocated IP is marked for manual usage. Allocation description can be referenced to get information about the manual usage.
Reference to the entity using the IP, such as an Edge Gateway Reference if the Floating IP is used for NAT or Org VDC network reference if IP Prefix is used for network definition. This property is read-only.
An individual IP Address or an IP Prefix which is allocated.
JSON Example
{
"id": "urn:vcloud:ipSpaceIpAllocation:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
Vendor Extensions
x-vcloud-property-annotations:
allocationDate:
x-vcloud-constraints:
- constraint: ReadOnly
- constraint: NonSearchable
description:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
id:
x-vcloud-constraints:
- constraint: NonSortable
- args:
- arg: ipSpaceIpAllocation
constraint: Urn
orgRef:
x-vcloud-constraints:
- constraint: NonSortable
type:
x-vcloud-constraints:
- constraint: NonSortable
usageCategories:
x-vcloud-constraints:
- constraint: ReadOnly
- constraint: NonSortable
usageState:
x-vcloud-constraints:
- constraint: NonSortable
usedByRef:
x-vcloud-constraints:
- constraint: ReadOnly
- constraint: NonSortable
Availability
Property Of
InlineIpSpaceIpAllocations1
Parameter To
Update IP Space IP Allocation
Returned By
Get IP Space IP Allocation
