com.vmware.esx.settings.hosts.software.drafts.software

Interface Components

All Superinterfaces:

ComponentsTypes, Service

All Known Implementing Classes:

ComponentsStub

public interface Components
extends Service, ComponentsTypes

The Components interface provides methods to manage component specification in a software draft. This interface was added in vSphere API 8.0.0.1.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.esx.settings.hosts.software.drafts.software.ComponentsTypes

ComponentsTypes.UpdateSpec

Field Summary

Fields inherited from interface com.vmware.esx.settings.hosts.software.drafts.software.ComponentsTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String host, java.lang.String draft, java.lang.String component) Deletes the given component from the software draft.
void	delete(java.lang.String host, java.lang.String draft, java.lang.String component, AsyncCallback<java.lang.Void> asyncCallback) Deletes the given component from the software draft.
void	delete(java.lang.String host, java.lang.String draft, java.lang.String component, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Deletes the given component from the software draft.
void	delete(java.lang.String host, java.lang.String draft, java.lang.String component, InvocationConfig invocationConfig) Deletes the given component from the software draft.
ComponentInfo	get(java.lang.String host, java.lang.String draft, java.lang.String component) Returns the component version for the given component in the software draft.
void	get(java.lang.String host, java.lang.String draft, java.lang.String component, AsyncCallback<ComponentInfo> asyncCallback) Returns the component version for the given component in the software draft.
void	get(java.lang.String host, java.lang.String draft, java.lang.String component, AsyncCallback<ComponentInfo> asyncCallback, InvocationConfig invocationConfig) Returns the component version for the given component in the software draft.
ComponentInfo	get(java.lang.String host, java.lang.String draft, java.lang.String component, InvocationConfig invocationConfig) Returns the component version for the given component in the software draft.
java.util.Map<java.lang.String,ComponentInfo>	list(java.lang.String host, java.lang.String draft) Returns the components that comprise the software draft.
void	list(java.lang.String host, java.lang.String draft, AsyncCallback<java.util.Map<java.lang.String,ComponentInfo>> asyncCallback) Returns the components that comprise the software draft.
void	list(java.lang.String host, java.lang.String draft, AsyncCallback<java.util.Map<java.lang.String,ComponentInfo>> asyncCallback, InvocationConfig invocationConfig) Returns the components that comprise the software draft.
java.util.Map<java.lang.String,ComponentInfo>	list(java.lang.String host, java.lang.String draft, InvocationConfig invocationConfig) Returns the components that comprise the software draft.
void	set(java.lang.String host, java.lang.String draft, java.lang.String component, java.lang.String version) Set the component version for a given component in the software draft.
void	set(java.lang.String host, java.lang.String draft, java.lang.String component, java.lang.String version, AsyncCallback<java.lang.Void> asyncCallback) Set the component version for a given component in the software draft.
void	set(java.lang.String host, java.lang.String draft, java.lang.String component, java.lang.String version, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Set the component version for a given component in the software draft.
void	set(java.lang.String host, java.lang.String draft, java.lang.String component, java.lang.String version, InvocationConfig invocationConfig) Set the component version for a given component in the software draft.
void	update(java.lang.String host, java.lang.String draft, ComponentsTypes.UpdateSpec spec) Updates the list of components in a given draft.
void	update(java.lang.String host, java.lang.String draft, ComponentsTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Updates the list of components in a given draft.
void	update(java.lang.String host, java.lang.String draft, ComponentsTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Updates the list of components in a given draft.
void	update(java.lang.String host, java.lang.String draft, ComponentsTypes.UpdateSpec spec, InvocationConfig invocationConfig) Updates the list of components in a given draft.

Method Detail

get

ComponentInfo get(java.lang.String host,
                  java.lang.String draft,
                  java.lang.String component)

Returns the component version for the given component in the software draft. This method was added in vSphere API 8.0.0.1.

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.

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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

Returns:

Information about component version. If null then version will be chosen based on the constraints in the system.

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

ServiceUnavailable - If the service is not available.

Unauthenticated - if the caller is not authenticated.

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 draft,
                  java.lang.String component,
                  InvocationConfig invocationConfig)

Returns the component version for the given component in the software draft. This method was added in vSphere API 8.0.0.1.

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.

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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:

Information about component version. If null then version will be chosen based on the constraints in the system.

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

ServiceUnavailable - If the service is not available.

Unauthenticated - if the caller is not authenticated.

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 draft,
         java.lang.String component,
         AsyncCallback<ComponentInfo> asyncCallback)

Returns the component version for the given component in the software draft. This method was added in vSphere API 8.0.0.1.

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

Invocation Result:
Information about component version. If null then version will be chosen based on the constraints in the system.

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 or no draft associated with draft or no component associated with component in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - if the caller is not authenticated.
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.

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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 draft,
         java.lang.String component,
         AsyncCallback<ComponentInfo> asyncCallback,
         InvocationConfig invocationConfig)

Returns the component version for the given component in the software draft. This method was added in vSphere API 8.0.0.1.

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:
Information about component version. If null then version will be chosen based on the constraints in the system.

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 or no draft associated with draft or no component associated with component in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - if the caller is not authenticated.
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.

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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.

set

void set(java.lang.String host,
         java.lang.String draft,
         java.lang.String component,
         java.lang.String version)

Set the component version for a given component in the software draft. This will overwrite any existing version for the given component. This method was added in vSphere API 8.0.0.1.

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.

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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

version - Component version. This property is currently required. In the future,if this property is null then version is chosen based on the constraints in the system.

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 or no draft associated with draft in the system.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

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.Write.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.

set

void set(java.lang.String host,
         java.lang.String draft,
         java.lang.String component,
         java.lang.String version,
         InvocationConfig invocationConfig)

Set the component version for a given component in the software draft. This will overwrite any existing version for the given component. This method was added in vSphere API 8.0.0.1.

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.

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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

version - Component version. This property is currently required. In the future,if this property is null then version is chosen based on the constraints in the system.

invocationConfig - Configuration for the method invocation.

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 or no draft associated with draft in the system.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

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.Write.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.

set

void set(java.lang.String host,
         java.lang.String draft,
         java.lang.String component,
         java.lang.String version,
         AsyncCallback<java.lang.Void> asyncCallback)

Set the component version for a given component in the software draft. This will overwrite any existing version for the given component. This method was added in vSphere API 8.0.0.1.

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

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 or no draft associated with draft in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
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.Write.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Parameters:

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

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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

version - Component version. This property is currently required. In the future,if this property is null then version is chosen based on the constraints in the system.

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

set

void set(java.lang.String host,
         java.lang.String draft,
         java.lang.String component,
         java.lang.String version,
         AsyncCallback<java.lang.Void> asyncCallback,
         InvocationConfig invocationConfig)

Set the component version for a given component in the software draft. This will overwrite any existing version for the given component. This method was added in vSphere API 8.0.0.1.

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

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 or no draft associated with draft in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
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.Write.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Parameters:

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

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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

version - Component version. This property is currently required. In the future,if this property is null then version is chosen based on the constraints in the system.

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String host,
            java.lang.String draft,
            java.lang.String component)

Deletes the given component from the software draft. This method was added in vSphere API 8.0.0.1.

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.

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

component - Identifier of the component. The parameter must 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 or no draft associated with draft or no component associated with component in the system.

ServiceUnavailable - If the service is not available.

Unauthenticated - if the caller is not authenticated.

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.Write.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.

delete

void delete(java.lang.String host,
            java.lang.String draft,
            java.lang.String component,
            InvocationConfig invocationConfig)

Deletes the given component from the software draft. This method was added in vSphere API 8.0.0.1.

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.

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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.

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

ServiceUnavailable - If the service is not available.

Unauthenticated - if the caller is not authenticated.

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.Write.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.

delete

void delete(java.lang.String host,
            java.lang.String draft,
            java.lang.String component,
            AsyncCallback<java.lang.Void> asyncCallback)

Deletes the given component from the software draft. This method was added in vSphere API 8.0.0.1.

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

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 or no draft associated with draft or no component associated with component in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - if the caller is not authenticated.
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.Write.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Parameters:

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

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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.

delete

void delete(java.lang.String host,
            java.lang.String draft,
            java.lang.String component,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Deletes the given component from the software draft. This method was added in vSphere API 8.0.0.1.

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

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 or no draft associated with draft or no component associated with component in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - if the caller is not authenticated.
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.Write.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Parameters:

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

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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.

update

void update(java.lang.String host,
            java.lang.String draft,
            ComponentsTypes.UpdateSpec spec)

Updates the list of components in a given draft. This allows set and/or delete of multiple components in a batch operation. This method was added in vSphere API 8.0.0.1.

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.

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

spec - Update specification containing list of components to add and/or delete.

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 or no draft associated with draft in the system.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

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.Write.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.

update

void update(java.lang.String host,
            java.lang.String draft,
            ComponentsTypes.UpdateSpec spec,
            InvocationConfig invocationConfig)

Updates the list of components in a given draft. This allows set and/or delete of multiple components in a batch operation. This method was added in vSphere API 8.0.0.1.

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.

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

spec - Update specification containing list of components to add and/or delete.

invocationConfig - Configuration for the method invocation.

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 or no draft associated with draft in the system.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

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.Write.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.

update

void update(java.lang.String host,
            java.lang.String draft,
            ComponentsTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback)

Updates the list of components in a given draft. This allows set and/or delete of multiple components in a batch operation. This method was added in vSphere API 8.0.0.1.

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

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 or no draft associated with draft in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
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.Write.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Parameters:

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

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

spec - Update specification containing list of components to add and/or delete.

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

update

void update(java.lang.String host,
            java.lang.String draft,
            ComponentsTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Updates the list of components in a given draft. This allows set and/or delete of multiple components in a batch operation. This method was added in vSphere API 8.0.0.1.

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

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 or no draft associated with draft in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
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.Write.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Parameters:

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

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

spec - Update specification containing list of components to add and/or delete.

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,
                                                   java.lang.String draft)

Returns the components that comprise the software draft. This method was added in vSphere API 8.0.0.1.

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.

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

Returns:

Map of component version information keyed by the component identifier. 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 or no draft associated with draft in the system.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

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.

list

java.util.Map<java.lang.String,ComponentInfo> list(java.lang.String host,
                                                   java.lang.String draft,
                                                   InvocationConfig invocationConfig)

Returns the components that comprise the software draft. This method was added in vSphere API 8.0.0.1.

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.

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

invocationConfig - Configuration for the method invocation.

Returns:

Map of component version information keyed by the component identifier. 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 or no draft associated with draft in the system.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

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.

list

void list(java.lang.String host,
          java.lang.String draft,
          AsyncCallback<java.util.Map<java.lang.String,ComponentInfo>> asyncCallback)

Returns the components that comprise the software draft. This method was added in vSphere API 8.0.0.1.

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

Invocation Result:
Map of component version information keyed by the component identifier. 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 or no draft associated with draft in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
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.

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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

list

void list(java.lang.String host,
          java.lang.String draft,
          AsyncCallback<java.util.Map<java.lang.String,ComponentInfo>> asyncCallback,
          InvocationConfig invocationConfig)

Returns the components that comprise the software draft. This method was added in vSphere API 8.0.0.1.

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 component version information keyed by the component identifier. 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 or no draft associated with draft in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
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.

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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

invocationConfig - Configuration for the method invocation.