OvfIpAllocationParams
The IpAllocationParams structure specifies how IP addresses are allocated to OVF properties. In particular, it informs the deployment platform whether the guest supports IPv4, IPv6, or both. It also specifies whether the IP addresses can be obtained through DHCP or through the properties provided in the OVF environment. Ovf Property elements are exposed to the guest software through the OVF environment. Each Property element exposed in the OVF environment shall be constructed from the value of the ovf:key attribute. A Property element contains a key/value pair, it may optionally specify type qualifiers using the ovf:qualifiers attribute with multiple qualifiers separated by commas.
The settings in IpAllocationParams structure are global to a deployment. Thus, if a virtual machine is part of a virtual appliance, then its settings are ignored and the settings for the virtual appliance is used.
This information is based on the vmw:IpAssignmentSection in OVF package.
See LibraryItem.deploy and LibraryItem.filter.
Properties
The IpAllocationParams.IpAllocationPolicy enumerated type defines the possible IP allocation policy for a deployment.
DHCP : Specifies that DHCP will be used to allocate IP addresses.
TRANSIENT_IPPOOL : Specifies that IP addresses are allocated from an IP pool. The IP addresses are allocated when needed, typically at power-on, and deallocated during power-off. There is no guarantee that a property will receive same IP address when restarted.
STATIC_MANUAL : Specifies that IP addresses are configured manually upon deployment, and will be kept until reconfigured or the virtual appliance destroyed. This ensures that a property gets a consistent IP for its lifetime.
STATIC_IPPOOL : Specifies that IP addresses are allocated from the range managed by an IP pool. The IP addresses are allocated at first power-on, and remain allocated at power-off. This ensures that a virtual appliance gets a consistent IP for its life-time.
Possible values are: DHCP , TRANSIENT_IPPOOL , STATIC_MANUAL , STATIC_IPPOOL
The IpAllocationParams.IpProtocol enumerated type defines the IP protocols supported by the guest software.
IPV4 : It supports the IPv4 protocol.
IPV6 : It supports the IPv6 protocol.
Possible values are: IPV4 , IPV6
The IpAllocationParams.IpAllocationScheme enumerated type defines the possible IP allocation schemes that can be supported by the guest software.
DHCP : It supports DHCP to acquire IP configuration.
OVF_ENVIRONMENT : It supports setting the IP configuration through the properties provided in the OVF environment.
Possible values are: DHCP , OVF_ENVIRONMENT
The IpAllocationParams.IpAllocationPolicy enumerated type defines the possible IP allocation policy for a deployment.
DHCP : Specifies that DHCP will be used to allocate IP addresses.
TRANSIENT_IPPOOL : Specifies that IP addresses are allocated from an IP pool. The IP addresses are allocated when needed, typically at power-on, and deallocated during power-off. There is no guarantee that a property will receive same IP address when restarted.
STATIC_MANUAL : Specifies that IP addresses are configured manually upon deployment, and will be kept until reconfigured or the virtual appliance destroyed. This ensures that a property gets a consistent IP for its lifetime.
STATIC_IPPOOL : Specifies that IP addresses are allocated from the range managed by an IP pool. The IP addresses are allocated at first power-on, and remain allocated at power-off. This ensures that a virtual appliance gets a consistent IP for its life-time.
Possible values are: DHCP , TRANSIENT_IPPOOL , STATIC_MANUAL , STATIC_IPPOOL
The IpAllocationParams.IpProtocol enumerated type defines the IP protocols supported by the guest software.
IPV4 : It supports the IPv4 protocol.
IPV6 : It supports the IPv6 protocol.
Possible values are: IPV4 , IPV6
Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters structure. This field must be provided in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package.
JSON Example
{
"ip_allocation_policy": "DHCP",
"ip_protocol": "IPV4",
"supported_allocation_scheme": "DHCP",
"supported_ip_allocation_policy": "DHCP",
"supported_ip_protocol": "IPV4",
"type": "string"
}
