Esx.Settings.Clusters.Vms.LifecycleHooks.DynamicUpdateSpec

Esx.Settings.Clusters.Vms.LifecycleHooks.DynamicUpdateSpec
Esx.Settings.Clusters.Vms.LifecycleHooks.DynamicUpdateSpec

The Esx.Settings.Clusters.Vms.LifecycleHooks.DynamicUpdateSpec schema contains properties to describe a System VM desired state to be applied dynamically by vLCM.

Can be used only with Solutions that has Esx.Settings.Clusters.Vms.ClusterSolutionSpec.

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

JSON Example
{
    "vm": "string",
    "solution": "string",
    "lifecycle_state": "string",
    "alternative_vm_spec": {
        "selection_criteria": {
            "selection_type": "string",
            "extra_config_value": "string"
        },
        "devices": {}
    }
}
string
vm
Required

Identifier of the VM whose Esx.Settings.Clusters.Vms.LifecycleState hook needs a dynamic update to be processed.

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.

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
solution
Required

Identifier of the Solution whose Esx.Settings.Clusters.Vms.LifecycleState hook needs a dynamic update to be processed.

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.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.esx.settings.vms.SystemVmSolution. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.esx.settings.vms.SystemVmSolution.

string
lifecycle_state
Required

Expected lifecycle state of the VM specified by the {#member vm} whose hook needs a dynamic update to be processed.

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.

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.

alternative_vm_spec
Optional

Alternative VM spec to be applied to the given {#member vm} while in the given {member# lifecycleState}.

If the provided {member# alternativeVmSpec} is not present in the solution desired state specification (i.e. extraConfigValue is not present in @link ClusterSolutionSpec#alternativeVmSpecs}), vLCM will add the {member# alternativeVmSpec} to the Esx.Settings.Clusters.Vms.ClusterSolutionSpec.alternative_vm_specs.

If the provided {member# alternativeVmSpec} already exists in the solution desired state specification (i.e. extraConfigValue is present in @link ClusterSolutionSpec#alternativeVmSpecs}), the {#member alternativeVmSpec} is overridden in the Esx.Settings.Clusters.Vms.ClusterSolutionSpec.alternative_vm_specs.

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.

If missing or null no Esx.Settings.Clusters.Vms.AlternativeVmSpec will be applied for the {member# vm} and the Esx.Settings.Clusters.Vms.ClusterSolutionSpec.alternative_vm_specs will be unchanged.