com.vmware.esx.settings.clusters

Class InstalledImagesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.esx.settings.clusters.InstalledImagesStub

All Implemented Interfaces:

InstalledImages, InstalledImagesTypes, com.vmware.vapi.bindings.Service

public class InstalledImagesStub
extends com.vmware.vapi.internal.bindings.Stub
implements InstalledImages

Remote stub implementation of the InstalledImages API service.

WARNING: Internal class, subject to change in future versions.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.esx.settings.clusters.InstalledImagesTypes

InstalledImagesTypes._VAPI_OPERATIONS, InstalledImagesTypes.ImageCategories, InstalledImagesTypes.InstalledImage, InstalledImagesTypes.InstalledImageInfo

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.esx.settings.clusters.InstalledImagesTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
InstalledImagesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
InstalledImagesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, com.vmware.vapi.bindings.StubConfigurationBase config)

Method Summary

Modifier and Type	Method and Description
java.lang.String	extract_Task(java.lang.String cluster) Extract installed images on all the hosts in the cluster.
void	extract_Task(java.lang.String cluster, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback) Extract installed images on all the hosts in the cluster.
void	extract_Task(java.lang.String cluster, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Extract installed images on all the hosts in the cluster.
java.lang.String	extract_Task(java.lang.String cluster, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Extract installed images on all the hosts in the cluster.
InstalledImagesTypes.InstalledImageInfo	get(java.lang.String cluster) Returns the last extracted installed Image info.
void	get(java.lang.String cluster, com.vmware.vapi.bindings.client.AsyncCallback<InstalledImagesTypes.InstalledImageInfo> asyncCallback) Returns the last extracted installed Image info.
void	get(java.lang.String cluster, com.vmware.vapi.bindings.client.AsyncCallback<InstalledImagesTypes.InstalledImageInfo> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the last extracted installed Image info.
InstalledImagesTypes.InstalledImageInfo	get(java.lang.String cluster, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the last extracted installed Image info.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InstalledImagesStub

public InstalledImagesStub(com.vmware.vapi.core.ApiProvider apiProvider,
                           com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                           com.vmware.vapi.bindings.StubConfigurationBase config)

InstalledImagesStub

public InstalledImagesStub(com.vmware.vapi.core.ApiProvider apiProvider,
                           com.vmware.vapi.bindings.StubConfigurationBase config)

Method Detail

extract_Task

public java.lang.String extract_Task(java.lang.String cluster)

Description copied from interface: InstalledImages

Extract installed images on all the hosts in the cluster. The API will work irrespective of whether a cluster is managed by single software image or not. If the cluster is not managed by single software image, it will first check the possibility to manage with single software image and if this check is successful then only it will extract the installed images on all the hosts. If the cluster is managed by single software image, it will skip eligibility check and directly extract the installed images on all the hosts. This method was added in vSphere API 8.0.3.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Specified by:

extract_Task in interface InstalledImages

Parameters:

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

Returns:

identifier for the task created by this API invocation

extract_Task

public java.lang.String extract_Task(java.lang.String cluster,
                                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: InstalledImages

Extract installed images on all the hosts in the cluster. The API will work irrespective of whether a cluster is managed by single software image or not. If the cluster is not managed by single software image, it will first check the possibility to manage with single software image and if this check is successful then only it will extract the installed images on all the hosts. If the cluster is managed by single software image, it will skip eligibility check and directly extract the installed images on all the hosts. This method was added in vSphere API 8.0.3.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

extract_Task in interface InstalledImages

Parameters:

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

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

extract_Task

public void extract_Task(java.lang.String cluster,
                         com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback)

Description copied from interface: InstalledImages

Extract installed images on all the hosts in the cluster. The API will work irrespective of whether a cluster is managed by single software image or not. If the cluster is not managed by single software image, it will first check the possibility to manage with single software image and if this check is successful then only it will extract the installed images on all the hosts. If the cluster is managed by single software image, it will skip eligibility check and directly extract the installed images on all the hosts. This method was added in vSphere API 8.0.3.0.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is some unknown 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 is not authorized.
Unsupported - if the host does not meet the vLCM transition eligibility criteria

Specified by:

extract_Task in interface InstalledImages

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.

extract_Task

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

Description copied from interface: InstalledImages

Extract installed images on all the hosts in the cluster. The API will work irrespective of whether a cluster is managed by single software image or not. If the cluster is not managed by single software image, it will first check the possibility to manage with single software image and if this check is successful then only it will extract the installed images on all the hosts. If the cluster is managed by single software image, it will skip eligibility check and directly extract the installed images on all the hosts. This method was added in vSphere API 8.0.3.0.

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

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is some unknown 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 is not authorized.
Unsupported - if the host does not meet the vLCM transition eligibility criteria

Specified by:

extract_Task in interface InstalledImages

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.

get

public InstalledImagesTypes.InstalledImageInfo get(java.lang.String cluster)

Description copied from interface: InstalledImages

Returns the last extracted installed Image info. 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.

Specified by:

get in interface InstalledImages

Parameters:

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

Returns:

last extracted installed images for the cluster

get

public InstalledImagesTypes.InstalledImageInfo get(java.lang.String cluster,
                                                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: InstalledImages

Returns the last extracted installed Image info. 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.

Specified by:

get in interface InstalledImages

Parameters:

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

invocationConfig - Configuration for the method invocation.

Returns:

last extracted installed images for the cluster

get

public void get(java.lang.String cluster,
                com.vmware.vapi.bindings.client.AsyncCallback<InstalledImagesTypes.InstalledImageInfo> asyncCallback)

Description copied from interface: InstalledImages

Returns the last extracted installed Image info. 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:
last extracted installed images for the cluster

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.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - If the caller is not authorized.
Unauthorized - if you do not have all of the privileges described as follows:

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

Specified by:

get in interface InstalledImages

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.

get

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

Description copied from interface: InstalledImages

Returns the last extracted installed Image info. 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:
last extracted installed images for the cluster

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.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - If the caller is not authorized.
Unauthorized - if you do not have all of the privileges described as follows:

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

Specified by:

get in interface InstalledImages

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.