Developer Documentation

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

Required Property Name Type Description
optional ip_allocation_policy IpAllocationParamsIpAllocationPolicy Enum

Specifies how IP allocation is done through an IP Pool. This is typically specified by the deployer. This field is optional in the input parameters when deploying an OVF package. If unset there is no IP allocation policy. This field will always be present in the result when retrieving information about an OVF package.

optional ip_protocol IpAllocationParamsIpProtocol Enum

Specifies the chosen IP protocol for this deployment. This must be one of the IP protocols supported by the guest software. See IpAllocationParams.supported-ip-protocol. This field is optional in the input parameters when deploying an OVF package. If unset there is no IP protocol chosen. This field will always be present in the result when retrieving information about an OVF package.

optional supported_allocation_scheme array of IpAllocationParamsIpAllocationScheme Enum

Specifies the IP allocation schemes supported by the guest software. This field defines the valid values for the IP allocation policy. This setting is often configured by the virtual appliance template author or OVF package author to reflect what the guest software supports, and the IP allocation policy is configured at deployment time. See IpAllocationParams.ip-allocation-policy. This field is not used 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.

optional supported_ip_allocation_policy array of IpAllocationParamsIpAllocationPolicy Enum

Specifies the IP allocation policies supported. The set of valid options for the policy is based on the capabilities of the virtual appliance software, as specified by the IpAllocationParams.supported-allocation-scheme field. This field is not used 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.

optional supported_ip_protocol array of IpAllocationParamsIpProtocol Enum

Specifies the IP protocols supported by the guest. This field is not used 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.

optional type string

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.

Feedback

Was this page helpful?