Esx Settings Clusters Vms Solutions apply$Task
Applies the current desired solution specification to a given cluster as specified by the Esx Settings Clusters Vms Solutions ApplySpec.
The runtime state of the applied desired solution specification can be observed using POST /esx/settings/clusters/{cluster}/vms/solutions?action=check-compliance operation.
If a solution that is specified within the spec is uninstalled/not present (not present in the cluster's desired state and runtime state) it is omitted from the result.
If a deployment unit that is specified within the spec is uninstalled/not present (not present for any of the solutions specified within the spec) it is omitted from the result.
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.Write.
Identifier of the cluster.
The parameter must be an identifier for the resource type: ClusterComputeResource.
Apply specification.
{
"host_solutions": {
"solutions": [
"string"
],
"hosts": [
"string"
]
},
"cluster_solutions": {
"solutions": [
"string"
],
"deployment_units": [
"string"
]
}
}Apply filter for solutions with deployment type Esx Settings Clusters Vms DeploymentType.EVERY_HOST_PINNED.
This property was added in vSphere API 9.0.0.0.
if missing or null or empty and {#member clusterSolutions} is missing or null or empty, all solutions are applied on the cluster.
Apply filter for solutions with deployment type Esx Settings Clusters Vms DeploymentType.CLUSTER_VM_SET.
This property was added in vSphere API 9.0.0.0.
if missing or null or empty and {#member hostSolutions} is missing or null or empty, all solutions are applied on the cluster.
The result of the apply operation.
Vapi Std Errors InvalidArgument If the spec specifies an invalid argument. For example thrown if a host that is specified within the spec is not present in the system.
Vapi Std Errors NotAllowedInCurrentState If 1) there is another operation in progress for any of the solutions specified within the spec or 2) System VMs are disabled on the cluster via internal ESX Agent Manager (EAM) API (eam.EsxtAgentManager#disable).
Vapi Std Errors Unsupported If the cluster associated with cluster is not managed by vLCM.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
If the caller is not authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
If the user doesn't have the required privileges.
"Vapi Std Errors Unauthorized Object"If there is no cluster associated with the cluster parameter.
"Vapi Std Errors NotFound Object"If there is an internal error. The accompanying error message will give more details about the failure.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
If the service is not available.
"Vapi Std Errors ServiceUnavailable Object" curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/esx/settings/clusters/{cluster}/vms/solutions?action=apply&vmw-task=true