com.vmware.esx.settings.hosts.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 draft. This interface was added in vSphere API 8.0.3.0.

Field Summary

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

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

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

Returns the component version 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:

host - Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

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 host associated with host 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 necessary privileges.

Unsupported - If the host is not a vLCM managed standlone host.

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

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.

get

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

Returns the component version 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:

host - Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

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 host associated with host 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 necessary privileges.

Unsupported - If the host is not a vLCM managed standlone host.

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

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.

get

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

Returns the component version 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 host associated with host 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 necessary privileges.
Unsupported - If the host is not a vLCM managed standlone host.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Parameters:

host - Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

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 host,
         java.lang.String component,
         com.vmware.vapi.bindings.client.AsyncCallback<ComponentInfo> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the component version 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 host associated with host 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 necessary privileges.
Unsupported - If the host is not a vLCM managed standlone host.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSoftwareSpecification.Read.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Parameters:

host - Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

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 host)

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:

host - Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

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 host associated with host 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 necessary privileges.

Unsupported - If the host is not a vLCM managed standlone host.

list

java.util.Map<java.lang.String,ComponentInfo> list(java.lang.String host,
                                                   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:

host - Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

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 host associated with host 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 necessary privileges.

Unsupported - If the host is not a vLCM managed standlone host.

list

void list(java.lang.String host,
          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 host associated with host 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 necessary privileges.
Unsupported - If the host is not a vLCM managed standlone host.

Parameters:

host - Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

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

list

void list(java.lang.String host,
          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 host associated with host 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 necessary privileges.
Unsupported - If the host is not a vLCM managed standlone host.

Parameters:

host - Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

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

invocationConfig - Configuration for the method invocation.