ImportSpec

ImportSpec
ImportSpec

An ImportSpec is used when importing VMs or vApps.

It can be built from scratch, or it can be generated from an OVF descriptor using the service interface OvfManager.

This class is the abstract base for VirtualMachineImportSpec and VirtualAppImportSpec. These three classes form a composite structure that allows us to contain arbitrarily complex entitites in a single ImportSpec.

AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "entityConfig": {
        "_typeName": "string",
        "key": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "tag": "string",
        "startOrder": 0,
        "startDelay": 0,
        "waitingForGuest": false,
        "startAction": "string",
        "stopDelay": 0,
        "stopAction": "string",
        "destroyWithParent": false
    },
    "instantiationOst": {
        "_typeName": "string",
        "id": "string",
        "type": "string",
        "section": [
            {
                "_typeName": "string",
                "lineNumber": 0,
                "xml": "string"
            }
        ],
        "child": [
            "OvfConsumerOstNode Object"
        ],
        "entity": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    }
}
VAppEntityConfigInfo
entityConfig
Optional

This object type describes the behavior of an entity (virtual machine or sub-vApp container) in a vApp container.

The auto-start/auto-stop configurations control the behavior of the start/stop vApp operations.

An virtual machine entity can be configured to wait for a period of time before starting or to wait to receive a successful heartbeat from a virtual machine before starting the next virtual machine in the sequence.

  • For a power-on operation, if waitForHeartbeat is true, then the power-on sequence continues after the the first heartbeat has been received. If waitingForGuest is false, the system waits for the specified delay and then continues the power-on sequence.
  • For a power-off operation, if delay is non-zero, the requested power-off action is invoked (powerOff, suspend, guestShutdown) on the virtual machine and the system waits until the number of seconds specified in the delay have passed.

If startAction and stopAction for an entity are both set to none, that entity does not participate in the sequence.

The start/stop delay and waitingForGuest is not used if the entity is a vApp container. For a vApp the only value values for startAction is none or powerOn, and the valid values for stopAction is none or powerOff.

OvfConsumerOstNode
instantiationOst
Optional

A node in the OVF section tree.

This class represents a node on which OVF sections can be defined. The possible node types are OstNodeType.envelope, OstNodeType.virtualSystem or OstNodeType.virtualSystemCollection, corresponding to the identically named OVF element types.

Since the node contains a list of children, it can also be regarded as a tree. This tree mirrors the structure of the OVF descriptor. It is provided to OVF consumers as a more convenient way to navigate and modify the OVF than by working directly on the XML.

Property Of
Used By