Esx. Settings. Clusters. Software. Reports. Apply Impact Get

Esx. Settings. Clusters. Software. Reports. Apply Impact Get

Returns a summary of how hosts within the cluster will be impacted during an apply operation. The impact is generated from the compliance information obtained from GET /esx/settings/clusters/{cluster}/software/compliance

This operation was added in vSphere API 7.0.0.0.

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

  • Operation execution requires VcIntegrity.lifecycleSoftwareRemediation.Read.
  • The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareRemediation.Read.
Request
URI
GET
https://{api_host}/esx/settings/clusters/{cluster}/software/reports/apply-impact
COPY
Path Parameters
string
cluster
Required

The cluster identifier.

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

Query Parameters
string of array
hosts
Optional

The specific hosts for which an impact is to be generated.

This property was added in vSphere API 7.0.0.0.

if missing or null or empty impact is generated for all hosts within the cluster.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.


Authentication
This operation uses the following authentication methods.
Responses
200

Summary of how hosts will be impacted during an apply operation

Returns Esx.Settings.Clusters.Software.Reports.ApplyImpact.ClusterImpact of type(s) application/json
"Esx.Settings.Clusters.Software.Reports.ApplyImpact.ClusterImpact Object"

401

if the caller is not authenticated.

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

404

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

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}/software/reports/apply-impact