Esx. Settings. Clusters. Vms. Lifecycle Hooks List

Esx. Settings. Clusters. Vms. Lifecycle Hooks List

All activated hooks that the system is waiting to be processed for a given solution.

This operation was added in vSphere API 9.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

  • Operation execution requires VcIntegrity.systemVM.Read.
Request
URI
GET
https://{api_host}/esx/settings/clusters/{cluster}/vms/lifecycle-hooks/{solution}
COPY
Path Parameters
string
cluster
Required

Identifier of the cluster.

The parameter must be an identifier for the resource type: ClusterComputeResource.

string
solution
Required

Identifier of the solution.

The parameter must be an identifier for the resource type: com.vmware.esx.settings.vms.SystemVmSolution.


Authentication
This operation uses the following authentication methods.
Responses
200

Esx.Settings.Clusters.Vms.LifecycleHooks.ListResult that describes the hooks that the system is waiting to be processed by a given solution.

Returns Esx.Settings.Clusters.Vms.LifecycleHooks.ListResult of type(s) application/json
"Esx.Settings.Clusters.Vms.LifecycleHooks.ListResult Object"

400

If the cluster associated with cluster is not managed by vLCM.

Returns Vapi.Std.Errors.Unsupported of type(s) application/json
"Vapi.Std.Errors.Unsupported Object"

401

If the caller is not authenticated.

Returns Vapi.Std.Errors.Unauthenticated of type(s) application/json
"Vapi.Std.Errors.Unauthenticated Object"

403

If the user doesn't have the required privileges.

Returns Vapi.Std.Errors.Unauthorized of type(s) application/json
"Vapi.Std.Errors.Unauthorized Object"

404

If there is no cluster associated with cluster in the system or no solution associated with solution in the cluster.

Returns Vapi.Std.Errors.NotFound of type(s) application/json
"Vapi.Std.Errors.NotFound Object"

500

If there is an unknown internal error. The accompanying error message will give more details about the failure.

Returns Vapi.Std.Errors.Error of type(s) application/json
"Vapi.Std.Errors.Error Object"

503

If the service is not available.

Returns Vapi.Std.Errors.ServiceUnavailable of type(s) application/json
"Vapi.Std.Errors.ServiceUnavailable Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/esx/settings/clusters/{cluster}/vms/lifecycle-hooks/{solution}