Esx. Settings. Clusters. Software. Removed Components Get

Esx. Settings. Clusters. Software. Removed Components Get

Returns the component info for the given removed component in the desired software specification.

This operation was added in vSphere API 8.0.3.0.

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

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

Identifier of the cluster.

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

string
component
Required

Identifier of the component.

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

Authentication
This operation uses the following authentication methods.
Responses
200

Details about the component.

Returns Esx.Settings.ComponentInfo of type(s) application/json 
"Esx.Settings.ComponentInfo Object"

400

If the cluster is not vLCM managed.

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 caller does not 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 or no component associated with component in the system.

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

500

If there is 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/removed-components/{component}
On This Page
Esx.settings.clusters.software.removed Components Operations
GET
Esx. Settings. Clusters. Software. Removed Components Get
GET
Esx. Settings. Clusters. Software. Removed Components List