InlineNetworkManualIpReservation1
{
"id": "urn:vcloud:networkManualIpReservation:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "string",
"description": "string",
"networkRef": {
"name": "string",
"id": "string"
},
"ipAddresses": "string",
"ipQuantity": 0,
"subnet": "string",
"expirationType": "string",
"expirationDate": "string",
"expirationVAppRef": {
"name": "string",
"id": "string"
},
"expirationVAppVdcRef": {
"name": "string",
"id": "string"
},
"allowIpUsageByServiceOrVm": false,
"removeIpAfterUsage": false,
"createdBy": "string",
"updatedBy": "string",
"orgRef": {
"name": "string",
"id": "string"
},
"creationDate": "string"
}The identifier of the Manual IP Reservation in URN format.
Display name for the Manual IP Reservation.
Description for the Manual IP Reservation.
The list of specific IP addresses to reserve. This value can be a single IP such as "192.168.1.1", an IP Range such as "192.168.1.1-192.168.1.2", or a list of IPs such as "192.168.1.1,192.168.1.2,192.168.1.3". This property can be updatable: new IPs will be reserved and any IP no longer in the original list will be released. For the case where user needs to request a number of free/non-specific IP Addresses, user can use the property "ipQuantity"; the newly reserved IP Addresses will be appended to this list. The maximum supported number of IPs is 5: sum of this property's list size and the property "ipQuantity".
The number of free IP addresses to reserve. Specifying the quantity will reserve the given number of free IP addresses within the optionally-specified "subnet", and the list of newly reserved IP Addresses will be added to the property "ipAddresses". The maximum supported number of IPs is 5: sum of this property and the list size of property "ipAddresses". This property is only applicable on creating or updating of Manual IP Reservation.
When ipQuantity is set, for dual-stack networks, user can optionally choose the specific subnet CIDR in the network that specifies where to reserve the free IPs from. On dual-stack networks, if this property is not set, then the default subnet is the IPv4 subnet. For single-stack networks, this property is ignored. This property is only applicable on creating or updating of Manual IP Reservation.
The type that determines when this IP reservation and its reserved IPs expires and will be automatically removed/released.
- VAPP_BASED - Expiration is based on the lifecycle of a vApp. When vApp is removed from VCD, this Manual IP Reservation will also be automatically removed. The property "vAppRef" must be set.
- TIME_BASED - Expiration is based on the number of days. The property "expirationDate" must be set.
The ISO-8601 date that this Manual IP Reservation is valid for until it expires and will be eventually cancelled/removed automatically. Unsetting this value means that there is no expiration. This property must be set if expiration type is TIME_BASED; otherwise, it is ignored. This property is only applicable on creating or updating of Manual IP Reservation.
By default (this property set to false), IPs in the reservation are not allowed to be used as manual static IP on a VM or Edge's Load Balancer VIP. Setting this to true will override this behavior and allow the IPs to be used.
True means that when the IP is used as Edge's Load Balancer VIP or VM's static IP, the IP will be removed from the reservation. If there are no more IPs in the reservation, the reservation itself will also be deleted. True value allows the user to temporarily hold the IP so that it is not inadvertently used or reserved again before it is actually used. This property is ignored if "allowIpUsageByServiceOrVm" is set to false.
The name of the user that created the reservation. This property is read-only.
The name of the user that last updated the reservation. This property is read-only.
ISO-8601 date when the Manual IP Reservation is created. This property is read-only.