REST API - ip_allocation

vcenter ovf: ip allocation params

The ip_allocation_params 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 ip_allocation_params 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 deploy and filter.

{
    "ip_allocation_policy": "DHCP",
    "ip_protocol": "IPV4",
    "supported_allocation_scheme": [
        "DHCP",
        "DHCP"
    ],
    "supported_ip_allocation_policy": [
        "DHCP",
        "DHCP"
    ],
    "supported_ip_protocol": [
        "IPV4",
        "IPV4"
    ],
    "type": "string"
}

<?xml version="1.0" ?>
<ns0:IpAllocationParams xmlns:ns0="http://vmware.com/vcenter/ovf" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <supported_ip_allocation_policy-array>
    <array-item>DHCP</array-item>
    <array-item>DHCP</array-item>
  </supported_ip_allocation_policy-array>
  <supported_ip_protocol-array>
    <array-item>IPV4</array-item>
    <array-item>IPV4</array-item>
  </supported_ip_protocol-array>
  <ip_allocation_policy>DHCP</ip_allocation_policy>
  <ip_protocol>IPV4</ip_protocol>
  <type>string</type>
  <supported_allocation_scheme-array>
    <array-item>DHCP</array-item>
    <array-item>DHCP</array-item>
  </supported_allocation_scheme-array>
</ns0:IpAllocationParams>

Attributes:

Name	Type	Description
Optional
supported_allocation_scheme	string[]	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 vcenter.ovf.ip_allocation_params.ip_allocation_policy. Optional. 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.
supported_ip_allocation_policy	string[]	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 vcenter.ovf.ip_allocation_params.supported_allocation_scheme field. Optional. 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.
ip_allocation_policy	string	Specifies how IP allocation is done through an IP Pool. This is typically specified by the deployer. Defines the possible IP allocation policy for a deployment. Value is one of: 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.Optional. 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.
supported_ip_protocol	string[]	Specifies the IP protocols supported by the guest. Optional. 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.
ip_protocol	string	Specifies the chosen IP protocol for this deployment. This must be one of the IP protocols supported by the guest software. See vcenter.ovf.ip_allocation_params.supported_ip_protocol. Defines the IP protocols supported by the guest software. Value is one of: IPV4: It supports the IPv4 protocol. IPV6: It supports the IPv6 protocol.Optional. 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.
type	string	Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters structure. Optional. 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.