com.vmware.esx.settings.clusters.software

Interface RemovedComponents

All Superinterfaces:

RemovedComponentsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

RemovedComponentsStub

public interface RemovedComponents
extends com.vmware.vapi.bindings.Service, RemovedComponentsTypes

The RemovedComponents interface provides methods to manage removal of components in a software specification. This interface was added in vSphere API 8.0.3.0.

Field Summary

Fields inherited from interface com.vmware.esx.settings.clusters.software.RemovedComponentsTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
ComponentInfo	get(java.lang.String cluster, java.lang.String component) Returns the component info for the given removed component in the desired software specification.
void	get(java.lang.String cluster, java.lang.String component, com.vmware.vapi.bindings.client.AsyncCallback<ComponentInfo> asyncCallback) Returns the component info for the given removed component in the desired software specification.
void	get(java.lang.String cluster, java.lang.String component, com.vmware.vapi.bindings.client.AsyncCallback<ComponentInfo> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the component info for the given removed component in the desired software specification.
ComponentInfo	get(java.lang.String cluster, java.lang.String component, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the component info for the given removed component in the desired software specification.
java.util.Map<java.lang.String,ComponentInfo>	list(java.lang.String cluster) Returns a map of removed components in the desired software specification.
void	list(java.lang.String cluster, com.vmware.vapi.bindings.client.AsyncCallback<java.util.Map<java.lang.String,ComponentInfo>> asyncCallback) Returns a map of removed components in the desired software specification.
void	list(java.lang.String cluster, com.vmware.vapi.bindings.client.AsyncCallback<java.util.Map<java.lang.String,ComponentInfo>> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns a map of removed components in the desired software specification.
java.util.Map<java.lang.String,ComponentInfo>	list(java.lang.String cluster, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns a map of removed components in the desired software specification.

Method Detail

get

ComponentInfo get(java.lang.String cluster,
                  java.lang.String component)

Returns the component info for the given removed component in the desired software specification. This method was added in vSphere API 8.0.3.0.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

Returns:

Details about the component.

Throws:

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

NotFound - If there is no cluster associated with cluster in the system or or no component associated with component in the system.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

Unauthorized - If the caller does not have the required privileges.

Unsupported - If the cluster is not vLCM managed.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

get

ComponentInfo get(java.lang.String cluster,
                  java.lang.String component,
                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the component info for the given removed component in the desired software specification. This method was added in vSphere API 8.0.3.0.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

invocationConfig - Configuration for the method invocation.

Returns:

Details about the component.

Throws:

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

NotFound - If there is no cluster associated with cluster in the system or or no component associated with component in the system.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

Unauthorized - If the caller does not have the required privileges.

Unsupported - If the cluster is not vLCM managed.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

get

void get(java.lang.String cluster,
         java.lang.String component,
         com.vmware.vapi.bindings.client.AsyncCallback<ComponentInfo> asyncCallback)

Returns the component info for the given removed component in the desired software specification. This method was added in vSphere API 8.0.3.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
Details about the component.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system or or no component associated with component in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - If the caller does not have the required privileges.
Unsupported - If the cluster is not vLCM managed.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(java.lang.String cluster,
         java.lang.String component,
         com.vmware.vapi.bindings.client.AsyncCallback<ComponentInfo> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the component info for the given removed component in the desired software specification. This method was added in vSphere API 8.0.3.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
Details about the component.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system or or no component associated with component in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - If the caller does not have the required privileges.
Unsupported - If the cluster is not vLCM managed.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

list

java.util.Map<java.lang.String,ComponentInfo> list(java.lang.String cluster)

Returns a map of removed components in the desired software specification. This method was added in vSphere API 8.0.3.0.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

Returns:

Map of ComponentInfo keyed by the component identifier. If no version is specified in desired software specification, then it will be empty. The key in the return value Map will be an identifier for the resource type: com.vmware.esx.settings.component.

Throws:

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

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

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

Unauthorized - If the caller does not have the required privileges.

Unsupported - If the cluster is not vLCM managed.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

list

java.util.Map<java.lang.String,ComponentInfo> list(java.lang.String cluster,
                                                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns a map of removed components in the desired software specification. This method was added in vSphere API 8.0.3.0.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

Map of ComponentInfo keyed by the component identifier. If no version is specified in desired software specification, then it will be empty. The key in the return value Map will be an identifier for the resource type: com.vmware.esx.settings.component.

Throws:

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

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

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

Unauthorized - If the caller does not have the required privileges.

Unsupported - If the cluster is not vLCM managed.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

list

void list(java.lang.String cluster,
          com.vmware.vapi.bindings.client.AsyncCallback<java.util.Map<java.lang.String,ComponentInfo>> asyncCallback)

Returns a map of removed components in the desired software specification. This method was added in vSphere API 8.0.3.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
Map of ComponentInfo keyed by the component identifier. If no version is specified in desired software specification, then it will be empty. The key in the return value Map will be an identifier for the resource type: com.vmware.esx.settings.component.

Operation Errors:
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - If the caller does not have the required privileges.
Unsupported - If the cluster is not vLCM managed.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

list

void list(java.lang.String cluster,
          com.vmware.vapi.bindings.client.AsyncCallback<java.util.Map<java.lang.String,ComponentInfo>> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns a map of removed components in the desired software specification. This method was added in vSphere API 8.0.3.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
Map of ComponentInfo keyed by the component identifier. If no version is specified in desired software specification, then it will be empty. The key in the return value Map will be an identifier for the resource type: com.vmware.esx.settings.component.

Operation Errors:
Error - If there is some unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - If the caller does not have the required privileges.
Unsupported - If the cluster is not vLCM managed.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.