com.vmware.vcenter.vm

Interface Tools

All Superinterfaces:

Service, ToolsTypes

All Known Implementing Classes:

ToolsStub

public interface Tools
extends Service, ToolsTypes

The Tools interface provides methods for managing VMware Tools in the guest operating system. This interface was added in vSphere API 7.0.0.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.vm.ToolsTypes

ToolsTypes.Info, ToolsTypes.RunState, ToolsTypes.ToolsInstallType, ToolsTypes.UpdateSpec, ToolsTypes.UpgradePolicy, ToolsTypes.VersionStatus

Field Summary

Fields inherited from interface com.vmware.vcenter.vm.ToolsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
ToolsTypes.Info	get(java.lang.String vm) Get the properties of VMware Tools.
void	get(java.lang.String vm, AsyncCallback<ToolsTypes.Info> asyncCallback) Get the properties of VMware Tools.
void	get(java.lang.String vm, AsyncCallback<ToolsTypes.Info> asyncCallback, InvocationConfig invocationConfig) Get the properties of VMware Tools.
ToolsTypes.Info	get(java.lang.String vm, InvocationConfig invocationConfig) Get the properties of VMware Tools.
void	update(java.lang.String vm, ToolsTypes.UpdateSpec spec) Update the properties of VMware Tools.
void	update(java.lang.String vm, ToolsTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Update the properties of VMware Tools.
void	update(java.lang.String vm, ToolsTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Update the properties of VMware Tools.
void	update(java.lang.String vm, ToolsTypes.UpdateSpec spec, InvocationConfig invocationConfig) Update the properties of VMware Tools.
void	upgrade(java.lang.String vm, java.lang.String commandLineOptions) Begins the Tools upgrade process.
void	upgrade(java.lang.String vm, java.lang.String commandLineOptions, AsyncCallback<java.lang.Void> asyncCallback) Begins the Tools upgrade process.
void	upgrade(java.lang.String vm, java.lang.String commandLineOptions, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Begins the Tools upgrade process.
void	upgrade(java.lang.String vm, java.lang.String commandLineOptions, InvocationConfig invocationConfig) Begins the Tools upgrade process.

Method Detail

get

ToolsTypes.Info get(java.lang.String vm)

Get the properties of VMware Tools. This method was added in vSphere API 7.0.0.0.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

Returns:

VMware Tools properties.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the virtual machine is not found.

get

ToolsTypes.Info get(java.lang.String vm,
                    InvocationConfig invocationConfig)

Get the properties of VMware Tools. This method was added in vSphere API 7.0.0.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:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

invocationConfig - Configuration for the method invocation.

Returns:

VMware Tools properties.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the virtual machine is not found.

get

void get(java.lang.String vm,
         AsyncCallback<ToolsTypes.Info> asyncCallback)

Get the properties of VMware Tools. This method was added in vSphere API 7.0.0.0.

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

Invocation Result:
VMware Tools properties.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

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

get

void get(java.lang.String vm,
         AsyncCallback<ToolsTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Get the properties of VMware Tools. This method was added in vSphere API 7.0.0.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:
VMware Tools properties.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

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

invocationConfig - Configuration for the method invocation.

update

void update(java.lang.String vm,
            ToolsTypes.UpdateSpec spec)

Update the properties of VMware Tools. This method was added in vSphere API 7.0.0.0.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

spec - The new values.

Throws:

Error - if the system reports an error while responding to the request.

InvalidArgument - if the ToolsTypes.UpdateSpec.getUpgradePolicy() property contains a value that is not supported by the server.

NotFound - if the virtual machine is not found.

update

void update(java.lang.String vm,
            ToolsTypes.UpdateSpec spec,
            InvocationConfig invocationConfig)

Update the properties of VMware Tools. This method was added in vSphere API 7.0.0.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:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

spec - The new values.

invocationConfig - Configuration for the method invocation.

Throws:

Error - if the system reports an error while responding to the request.

InvalidArgument - if the ToolsTypes.UpdateSpec.getUpgradePolicy() property contains a value that is not supported by the server.

NotFound - if the virtual machine is not found.

update

void update(java.lang.String vm,
            ToolsTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback)

Update the properties of VMware Tools. This method was added in vSphere API 7.0.0.0.

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

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if the ToolsTypes.UpdateSpec.getUpgradePolicy() property contains a value that is not supported by the server.
NotFound - if the virtual machine is not found.

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

spec - The new values.

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

update

void update(java.lang.String vm,
            ToolsTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Update the properties of VMware Tools. This method was added in vSphere API 7.0.0.0.

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 the system reports an error while responding to the request.
InvalidArgument - if the ToolsTypes.UpdateSpec.getUpgradePolicy() property contains a value that is not supported by the server.
NotFound - if the virtual machine is not found.

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

spec - The new values.

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

invocationConfig - Configuration for the method invocation.

upgrade

void upgrade(java.lang.String vm,
             java.lang.String commandLineOptions)

Begins the Tools upgrade process. To monitor the status of the Tools upgrade, clients should check the Tools status by calling get(java.lang.String) and examining getVersionStatus() and getRunState(). This method was added in vSphere API 7.0.0.0.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

commandLineOptions - Command line options passed to the installer to modify the installation procedure for Tools. Set if any additional options are desired.

Throws:

NotFound - if the virtual machine is not found.

ServiceUnavailable - if the VMware Tools are not running.

NotAllowedInCurrentState - if the virtual machine is not powered on.

AlreadyInDesiredState - is an upgrade is already in progress.

Error - if the upgrade process fails inside the guest operating system.

upgrade

void upgrade(java.lang.String vm,
             java.lang.String commandLineOptions,
             InvocationConfig invocationConfig)

Begins the Tools upgrade process. To monitor the status of the Tools upgrade, clients should check the Tools status by calling get(java.lang.String) and examining getVersionStatus() and getRunState(). This method was added in vSphere API 7.0.0.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:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

commandLineOptions - Command line options passed to the installer to modify the installation procedure for Tools. Set if any additional options are desired.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the virtual machine is not found.

ServiceUnavailable - if the VMware Tools are not running.

NotAllowedInCurrentState - if the virtual machine is not powered on.

AlreadyInDesiredState - is an upgrade is already in progress.

Error - if the upgrade process fails inside the guest operating system.

upgrade

void upgrade(java.lang.String vm,
             java.lang.String commandLineOptions,
             AsyncCallback<java.lang.Void> asyncCallback)

Begins the Tools upgrade process. To monitor the status of the Tools upgrade, clients should check the Tools status by calling get(java.lang.String) and examining getVersionStatus() and getRunState(). This method was added in vSphere API 7.0.0.0.

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

Operation Errors:
NotFound - if the virtual machine is not found.
ServiceUnavailable - if the VMware Tools are not running.
NotAllowedInCurrentState - if the virtual machine is not powered on.
AlreadyInDesiredState - is an upgrade is already in progress.
Error - if the upgrade process fails inside the guest operating system.

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

commandLineOptions - Command line options passed to the installer to modify the installation procedure for Tools. Set if any additional options are desired.

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

upgrade

void upgrade(java.lang.String vm,
             java.lang.String commandLineOptions,
             AsyncCallback<java.lang.Void> asyncCallback,
             InvocationConfig invocationConfig)

Begins the Tools upgrade process. To monitor the status of the Tools upgrade, clients should check the Tools status by calling get(java.lang.String) and examining getVersionStatus() and getRunState(). This method was added in vSphere API 7.0.0.0.

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:
NotFound - if the virtual machine is not found.
ServiceUnavailable - if the VMware Tools are not running.
NotAllowedInCurrentState - if the virtual machine is not powered on.
AlreadyInDesiredState - is an upgrade is already in progress.
Error - if the upgrade process fails inside the guest operating system.

Parameters:

vm - Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

commandLineOptions - Command line options passed to the installer to modify the installation procedure for Tools. Set if any additional options are desired.

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

invocationConfig - Configuration for the method invocation.