Esx Settings Clusters Vms Lifecycle Hooks APIs

Esx Settings Clusters Vms Lifecycle Hooks APIs

The Esx Settings Clusters Vms LifecycleHooks resource provides operations to read and process VM lifecycle hooks in an ESXi cluster. See Esx Settings Clusters Vms LifecycleHookInfo and Esx Settings Clusters Vms LifecycleHookConfig.

VM lifecycle hook workflow:

  1. A System VM solution configures hooks for the different lifecycle states of its VMs as part of a desired specification.
  2. The system starts a deployment of a VM for that solution.
  3. The VM reaches a lifecycle state for which a hook is configured in the desired specification of the solution.
  4. The system activates a hook that matches the lifecycle state of the VM and starts waiting for the solution to process this hook. Until the hook is not processed the system does not work actively to reach the desired state of the VM.
  5. The solution makes the necessary configurations related to the VM.
  6. The solution marks the hook as proccessed.
  7. The system continues working actively to reach the desired specification of the deployment

This resource was added in vSphere API 9.0.0.0.

Operations
POST
Esx Settings Clusters Vms LifecycleHooks markAsProcessed
GET
Esx Settings Clusters Vms LifecycleHooks list