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

Interface BaseImage

All Superinterfaces:

BaseImageTypes, Service

All Known Implementing Classes:

BaseImageStub

public interface BaseImage
extends Service, BaseImageTypes

The BaseImage interface provides methods to manage the base-image specification in a software draft. This interface was added in vSphere API 8.0.0.1.

Field Summary

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

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
BaseImageInfo	get(java.lang.String host, java.lang.String draft) Returns the base-image specification in a software draft.
void	get(java.lang.String host, java.lang.String draft, AsyncCallback<BaseImageInfo> asyncCallback) Returns the base-image specification in a software draft.
void	get(java.lang.String host, java.lang.String draft, AsyncCallback<BaseImageInfo> asyncCallback, InvocationConfig invocationConfig) Returns the base-image specification in a software draft.
BaseImageInfo	get(java.lang.String host, java.lang.String draft, InvocationConfig invocationConfig) Returns the base-image specification in a software draft.
void	set(java.lang.String host, java.lang.String draft, BaseImageSpec spec) Sets a new desired base-image specification in the software draft.
void	set(java.lang.String host, java.lang.String draft, BaseImageSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Sets a new desired base-image specification in the software draft.
void	set(java.lang.String host, java.lang.String draft, BaseImageSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Sets a new desired base-image specification in the software draft.
void	set(java.lang.String host, java.lang.String draft, BaseImageSpec spec, InvocationConfig invocationConfig) Sets a new desired base-image specification in the software draft.

Method Detail

get

BaseImageInfo get(java.lang.String host,
                  java.lang.String draft)

Returns the base-image specification in a 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:

Base-image specification.

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

BaseImageInfo get(java.lang.String host,
                  java.lang.String draft,
                  InvocationConfig invocationConfig)

Returns the base-image specification in a 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:

Base-image specification.

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 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,
         AsyncCallback<BaseImageInfo> asyncCallback)

Returns the base-image specification in a 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:
Base-image specification.

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 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.

get

void get(java.lang.String host,
         java.lang.String draft,
         AsyncCallback<BaseImageInfo> asyncCallback,
         InvocationConfig invocationConfig)

Returns the base-image specification in a 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:
Base-image specification.

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 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.

set

void set(java.lang.String host,
         java.lang.String draft,
         BaseImageSpec spec)

Sets a new desired base-image specification in the software draft. It will overwrite the existing desired base-image specification if one already exists. 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 - Base-image specification.

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,
         BaseImageSpec spec,
         InvocationConfig invocationConfig)

Sets a new desired base-image specification in the software draft. It will overwrite the existing desired base-image specification if one already exists. 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 - Base-image specification.

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,
         BaseImageSpec spec,
         AsyncCallback<java.lang.Void> asyncCallback)

Sets a new desired base-image specification in the software draft. It will overwrite the existing desired base-image specification if one already exists. 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 - Base-image specification.

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

set

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

Sets a new desired base-image specification in the software draft. It will overwrite the existing desired base-image specification if one already exists. 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 - Base-image specification.

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

invocationConfig - Configuration for the method invocation.