Esx.Settings.Clusters.Vms.LifecycleHookInfo

Esx.Settings.Clusters.Vms.LifecycleHookInfo
Esx.Settings.Clusters.Vms.LifecycleHookInfo

The Esx.Settings.Clusters.Vms.LifecycleHookInfo schema contains properties that describe a VM lifecycle hook that is activated for a given VM.

This schema was added in vSphere API 9.0.0.0.

JSON Example
{
    "vm": "string",
    "lifecycle_state": "string",
    "configuration": {
        "timeout": 0
    },
    "hook_activated": "string",
    "dynamic_update_processed": false
}
string
vm
Required

Identifier of the VM for which the hook is activated.

This property was added in vSphere API 9.0.0.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: VirtualMachine. When operations return a value of this schema as a response, the property will be an identifier for the resource type: VirtualMachine.

string
lifecycle_state
Required

VM lifecycle state of the VM specified by vm

Possible values:

  • POST_PROVISIONING: Post VM provisioning, reached once immediately after a VM is created.
  • POST_POWER_ON: Post VM power-on, reached immediately after every VM power-on.

For more information see: Esx.Settings.Clusters.Vms.LifecycleState.

This property was added in vSphere API 9.0.0.0.

configuration
Required

Configuration of the hook.

This property was added in vSphere API 9.0.0.0.

string As date-time As date-time
hook_activated
Required

The vLCM system time when the hook is activated.

This property was added in vSphere API 9.0.0.0.

boolean
dynamic_update_processed
Optional

This property represents if the DynamicUpdateSpec given with POST /esx/settings/clusters/{cluster}/vms/lifecycle-hooks?action=process-dynamic-update is applied successfully for the {#member lifecycleState} of the given {#member vm}.

Defaults to False.

See POST /esx/settings/clusters/{cluster}/vms/lifecycle-hooks?action=process-dynamic-update about how to process the dynamic update for a given Esx.Settings.Clusters.Vms.LifecycleState.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

This property is optional because it was added in a newer version than its parent node.

Property Of