15f7be9a52
This external documentation for pyVmomi was generated using Googly Docs (aka Google Standard Documentation) which renders very cleanly in GitHub. Internal documentation for a class should be done in Sphinx format because tools like pyCharm and Eclipse can use that documentation as a hint for code completion. Note: External docs as Googly Docs, internal docs as Sphinx. Closes bug#15
3.8 KiB
vim.vApp.EntityConfigInfo
- 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.
- extends
- since
- Attributes:
-
key (vim.ManagedEntity, optional):
Entity to power on or power off. This can be a virtual machine or a vApp.
tag (str, optional):
Tag for entity.Reconfigure privilege: VApp.ApplicationConfig
startOrder (int, optional):
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
startDelay (int, optional):
Delay in seconds before continuing with the next entity in the order of entities to be started.Reconfigure privilege: VApp.ApplicationConfig
waitingForGuest (bool, optional):
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
startAction (str, optional):
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
stopDelay (int, optional):
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
stopAction (str, optional):
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
destroyWithParent (bool, optional):
Whether the entity should be removed, when this vApp is removed. This is only set for linked children.Reconfigure privilege: VApp.ApplicationConfig