Data Object Description

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.

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.

Properties

Name	Type	Description
destroyWithParent*	xsd:boolean	Deprecated. As of vSphere API 5.1. Whether the entity should be removed, when this vApp is removed. This is only set for linked children. Reconfigure privilege: VApp.ApplicationConfig *Since* vSphere API 4.1
key*	ManagedObjectReference to a ManagedEntity	Entity to power on or power off. This can be a virtual machine or a vApp.
startAction*	xsd:string	How to start the entity. Valid settings are none or powerOn. If set to none, then the entity does not participate in auto-start. Reconfigure privilege: VApp.ApplicationConfig
startDelay*	xsd:int	Delay in seconds before continuing with the next entity in the order of entities to be started. Reconfigure privilege: VApp.ApplicationConfig
startOrder*	xsd:int	Specifies the start order for this entity. Entities are started from lower numbers to higher-numbers and reverse on shutdown. Multiple entities with the same start-order can be started in parallel and the order is unspecified. This value must be 0 or higher. Reconfigure privilege: VApp.ApplicationConfig
stopAction*	xsd:string	Defines the stop action for the entity. Can be set to none, powerOff, guestShutdown, or suspend. If set to none, then the entity does not participate in auto-stop. Reconfigure privilege: VApp.ApplicationConfig
stopDelay*	xsd:int	Delay in seconds before continuing with the next entity in the order sequence. This is only used if the stopAction is guestShutdown. Reconfigure privilege: VApp.ApplicationConfig
tag*	xsd:string	Tag for entity. Reconfigure privilege: VApp.ApplicationConfig
waitingForGuest*	xsd:boolean	Determines if the virtual machine should start after receiving a heartbeat, from the guest. When a virtual machine is next in the start order, the system either waits a specified period of time for a virtual machine to power on or it waits until it receives a successful heartbeat from a powered on virtual machine. By default, this is set to false. This property has no effect for vApps. Reconfigure privilege: VApp.ApplicationConfig
Properties inherited from DynamicData
dynamicProperty, dynamicType

Name

Type

Description

destroyWithParent*

xsd:boolean

Deprecated. As of vSphere API 5.1.

Whether the entity should be removed, when this vApp is removed. This is only set for linked children.

Reconfigure privilege: VApp.ApplicationConfig

Since vSphere API 4.1

key*

ManagedObjectReference
to a ManagedEntity

Entity to power on or power off. This can be a virtual machine or a vApp.

startAction*

xsd:string

How to start the entity. Valid settings are none or powerOn. If set to none, then the entity does not participate in auto-start.

Reconfigure privilege: VApp.ApplicationConfig

startDelay*

xsd:int

Delay in seconds before continuing with the next entity in the order of entities to be started.

Reconfigure privilege: VApp.ApplicationConfig

startOrder*

xsd:int

Specifies the start order for this entity. Entities are started from lower numbers to higher-numbers and reverse on shutdown. Multiple entities with the same start-order can be started in parallel and the order is unspecified. This value must be 0 or higher.

Reconfigure privilege: VApp.ApplicationConfig

stopAction*

xsd:string

Defines the stop action for the entity. Can be set to none, powerOff, guestShutdown, or suspend. If set to none, then the entity does not participate in auto-stop.

Reconfigure privilege: VApp.ApplicationConfig

stopDelay*

xsd:int

Delay in seconds before continuing with the next entity in the order sequence. This is only used if the stopAction is guestShutdown.

Reconfigure privilege: VApp.ApplicationConfig

tag*

xsd:string

Tag for entity.

Reconfigure privilege: VApp.ApplicationConfig

waitingForGuest*

xsd:boolean

Determines if the virtual machine should start after receiving a heartbeat, from the guest. When a virtual machine is next in the start order, the system either waits a specified period of time for a virtual machine to power on or it waits until it receives a successful heartbeat from a powered on virtual machine. By default, this is set to false.

This property has no effect for vApps.

Reconfigure privilege: VApp.ApplicationConfig

Properties inherited from DynamicData

dynamicProperty, dynamicType

Need not be set

Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="VAppEntityConfigInfo">
            <complexContent>
               <extension base="vim25:DynamicData">
                  <sequence>
                     <element name="key" type="vim25:ManagedObjectReference" minOccurs="0"/>
                     <element name="tag" type="xsd:string" minOccurs="0"/>
                     <element name="startOrder" type="xsd:int" minOccurs="0"/>
                     <element name="startDelay" type="xsd:int" minOccurs="0"/>
                     <element name="waitingForGuest" type="xsd:boolean" minOccurs="0"/>
                     <element name="startAction" type="xsd:string" minOccurs="0"/>
                     <element name="stopDelay" type="xsd:int" minOccurs="0"/>
                     <element name="stopAction" type="xsd:string" minOccurs="0"/>
                     <element name="destroyWithParent" type="xsd:boolean" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Data Object - VAppEntityConfigInfo

Data Object Description