com.vmware.esx.settings.hosts.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 desired ESX base image. This interface was added in vSphere API 8.0.0.1.

Field Summary

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

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
BaseImageInfo	get(java.lang.String host) Returns the desired base-image specification set for given host.
void	get(java.lang.String host, AsyncCallback<BaseImageInfo> asyncCallback) Returns the desired base-image specification set for given host.
void	get(java.lang.String host, AsyncCallback<BaseImageInfo> asyncCallback, InvocationConfig invocationConfig) Returns the desired base-image specification set for given host.
BaseImageInfo	get(java.lang.String host, InvocationConfig invocationConfig) Returns the desired base-image specification set for given host.

Method Detail

get

BaseImageInfo get(java.lang.String host)

Returns the desired base-image specification set for given host. 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.

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

Returns the desired base-image specification set for given host. 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.

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

Returns the desired base-image specification set for given host. 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 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.

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

get

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

Returns the desired base-image specification set for given host. 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 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.

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

invocationConfig - Configuration for the method invocation.