VmConfigInfo

VmConfigInfo
VmConfigInfo

VM Configuration.

AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "product": [
        {
            "_typeName": "string",
            "key": 0,
            "classId": "string",
            "instanceId": "string",
            "name": "string",
            "vendor": "string",
            "version": "string",
            "fullVersion": "string",
            "vendorUrl": "string",
            "productUrl": "string",
            "appUrl": "string"
        }
    ],
    "property": [
        {
            "_typeName": "string",
            "key": 0,
            "classId": "string",
            "instanceId": "string",
            "id": "string",
            "category": "string",
            "label": "string",
            "type": "string",
            "typeReference": "string",
            "userConfigurable": false,
            "defaultValue": "string",
            "value": "string",
            "description": "string"
        }
    ],
    "ipAssignment": {
        "_typeName": "string",
        "supportedAllocationScheme": [
            "string"
        ],
        "ipAllocationPolicy": "string",
        "supportedIpProtocol": [
            "string"
        ],
        "ipProtocol": "string"
    },
    "eula": [
        "string"
    ],
    "ovfSection": [
        {
            "_typeName": "string",
            "key": 0,
            "namespace": "string",
            "type": "string",
            "atEnvelopeLevel": false,
            "contents": "string"
        }
    ],
    "ovfEnvironmentTransport": [
        "string"
    ],
    "installBootRequired": false,
    "installBootStopDelay": 0
}
array of VAppProductInfo
product
Optional

Information about the package content.

array of VAppPropertyInfo
property
Optional

List of properties

VAppIPAssignmentInfo
ipAssignment
Required

The IPAssignmentInfo class specifies how the guest software gets configured with IP addresses, including protocol type (IPv4 or IPv6) and the life-time of those IP addresses.

A vApp/virtual machine can either use DHCP to acquire an IP configuration, or it can acquire its IP configuration through the use of the vSphere platform using the OVF environment's properties. The latter is a known as OVF-environment-assigned IP configuration.

Guest software can be constructed to support DHCP , OVF assigned IP configuration, or both. The supportedAssignmentScheme property lists the supported schemes. This is typically specified by the author of a vApp.

The deployer / operator of a vApp, specifies what IP allocation policy should be used:

  • Using DHCP, if the vApp and deployed network supports it
  • Transient Assignment, if the vApp supports OVF-assigned IP configuration and the network has an IP range configured.
  • Fixed Assignment, if the vApp supports OVF-assigned IP configuration.
  • Fixed Allocated, if the vApp supports OVF-assigned IP configuration and the network has an IP range configured.

Transient and fixed assignment differs in the life time of the IP allocation. For transient, IP addresses are automatically assigned on power-on and released on power-off. For fixed, the IP addresses are explicitly specified by the deployer and does not change between a power-on/power-off. Fixed allocated is a hybrid of transient and fixed assignment. IP addresses are allocated at first power-on and remain allocated on power-off.

The IPAssignment settings are global to a deployment. Thus, if a vApp or virtual machine is part of another vApp, then the settings are ignored, and the ones for the top-most vApp container is used.

array of string
eula
Optional

End User Liceses Agreements.

array of VAppOvfSectionInfo
ovfSection
Optional

List of uninterpreted OVF meta-data sections.

array of string
ovfEnvironmentTransport
Optional

List the transports to use for properties.

Supported values are: iso and com.vmware.guestInfo.

boolean
installBootRequired
Required

Specifies whether the VM needs an initial boot before the deployment is complete.

Not relevant for vApps. This means that the value is always false when reading the configuration and is ignored when setting the configuration.

If a vApp requires an install boot (because one of its VMs does), this is visible on the installBootRequired field of the vApp.

integer As int32 As int32
installBootStopDelay
Required

Specifies the delay in seconds to wait for the VM to power off after the initial boot (used only if installBootRequired is true).

A value of 0 means wait forever.

Not relevant for vApps. This means that the value is always false when reading the configuration and is ignored when setting the configuration.

Property Of
Used By