com.vmware.vcenter.vm.tools

Interface Installer

All Superinterfaces:

InstallerTypes, Service

All Known Implementing Classes:

InstallerStub

public interface Installer
extends Service, InstallerTypes

The Installer (@term service} provides methods to install VMware Tools in the guest operating system. This interface was added in vSphere API 7.0.0.

Nested Class Summary

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

InstallerTypes.Info

Field Summary

Fields inherited from interface com.vmware.vcenter.vm.tools.InstallerTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	connect(java.lang.String vm) Connects the VMware Tools CD installer as a CD-ROM for the guest operating system.
void	connect(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback) Connects the VMware Tools CD installer as a CD-ROM for the guest operating system.
void	connect(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Connects the VMware Tools CD installer as a CD-ROM for the guest operating system.
void	connect(java.lang.String vm, InvocationConfig invocationConfig) Connects the VMware Tools CD installer as a CD-ROM for the guest operating system.
void	disconnect(java.lang.String vm) Disconnect the VMware Tools installer CD image.
void	disconnect(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback) Disconnect the VMware Tools installer CD image.
void	disconnect(java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Disconnect the VMware Tools installer CD image.
void	disconnect(java.lang.String vm, InvocationConfig invocationConfig) Disconnect the VMware Tools installer CD image.
InstallerTypes.Info	get(java.lang.String vm) Get information about the VMware Tools installer.
void	get(java.lang.String vm, AsyncCallback<InstallerTypes.Info> asyncCallback) Get information about the VMware Tools installer.
void	get(java.lang.String vm, AsyncCallback<InstallerTypes.Info> asyncCallback, InvocationConfig invocationConfig) Get information about the VMware Tools installer.
InstallerTypes.Info	get(java.lang.String vm, InvocationConfig invocationConfig) Get information about the VMware Tools installer.

Method Detail

get

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

Get information about the VMware Tools installer. This method was added in vSphere API 7.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:

information about the VMware Tools installer.

Throws:

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

NotFound - if the virtual machine is not found.

get

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

Get information about the VMware Tools installer. This method was added in vSphere API 7.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:

information about the VMware Tools installer.

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<InstallerTypes.Info> asyncCallback)

Get information about the VMware Tools installer. This method was added in vSphere API 7.0.0.

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

Invocation Result:
information about the VMware Tools installer.

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<InstallerTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Get information about the VMware Tools installer. This method was added in vSphere API 7.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:
information about the VMware Tools installer.

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.

connect

void connect(java.lang.String vm)

Connects the VMware Tools CD installer as a CD-ROM for the guest operating system. On Windows guest operating systems with autorun, this should cause the installer to initiate the Tools installation which will need user input to complete. On other (non-Windows) guest operating systems this will make the Tools installation available, and a a user will need to do guest-specific actions. On Linux, this includes opening an archive and running the installer. To monitor the status of the Tools install, clients should check the getVersionStatus() and getRunState() from Tools.get(java.lang.String). This method was added in vSphere API 7.0.0.

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

Parameters:

vm - Virtual machine ID The parameter must be an identifier for the resource type: VirtualMachine.

Throws:

NotFound - if the virtual machine is not found.

NotAllowedInCurrentState - if the virtual machine is not powered on.

AlreadyInDesiredState - if the VMware Tools CD is already connected.

Error - if the Tools installation fails in the guest operating system.

connect

void connect(java.lang.String vm,
             InvocationConfig invocationConfig)

Connects the VMware Tools CD installer as a CD-ROM for the guest operating system. On Windows guest operating systems with autorun, this should cause the installer to initiate the Tools installation which will need user input to complete. On other (non-Windows) guest operating systems this will make the Tools installation available, and a a user will need to do guest-specific actions. On Linux, this includes opening an archive and running the installer. To monitor the status of the Tools install, clients should check the getVersionStatus() and getRunState() from Tools.get(java.lang.String). This method was added in vSphere API 7.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 - Virtual machine ID The parameter must be an identifier for the resource type: VirtualMachine.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the virtual machine is not found.

NotAllowedInCurrentState - if the virtual machine is not powered on.

AlreadyInDesiredState - if the VMware Tools CD is already connected.

Error - if the Tools installation fails in the guest operating system.

connect

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

Connects the VMware Tools CD installer as a CD-ROM for the guest operating system. On Windows guest operating systems with autorun, this should cause the installer to initiate the Tools installation which will need user input to complete. On other (non-Windows) guest operating systems this will make the Tools installation available, and a a user will need to do guest-specific actions. On Linux, this includes opening an archive and running the installer. To monitor the status of the Tools install, clients should check the getVersionStatus() and getRunState() from Tools.get(java.lang.String). This method was added in vSphere API 7.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.
NotAllowedInCurrentState - if the virtual machine is not powered on.
AlreadyInDesiredState - if the VMware Tools CD is already connected.
Error - if the Tools installation fails in the guest operating system.

Parameters:

vm - Virtual machine ID The parameter must be an identifier for the resource type: VirtualMachine.

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

connect

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

Connects the VMware Tools CD installer as a CD-ROM for the guest operating system. On Windows guest operating systems with autorun, this should cause the installer to initiate the Tools installation which will need user input to complete. On other (non-Windows) guest operating systems this will make the Tools installation available, and a a user will need to do guest-specific actions. On Linux, this includes opening an archive and running the installer. To monitor the status of the Tools install, clients should check the getVersionStatus() and getRunState() from Tools.get(java.lang.String). This method was added in vSphere API 7.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.
NotAllowedInCurrentState - if the virtual machine is not powered on.
AlreadyInDesiredState - if the VMware Tools CD is already connected.
Error - if the Tools installation fails in the guest operating system.

Parameters:

vm - Virtual machine ID 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.

disconnect

void disconnect(java.lang.String vm)

Disconnect the VMware Tools installer CD image. This method was added in vSphere API 7.0.0.

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

Parameters:

vm - Virtual machine ID The parameter must be an identifier for the resource type: VirtualMachine.

Throws:

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

NotFound - if the virtual machine is not found.

NotAllowedInCurrentState - if the virtual machine is not powered on.

disconnect

void disconnect(java.lang.String vm,
                InvocationConfig invocationConfig)

Disconnect the VMware Tools installer CD image. This method was added in vSphere API 7.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 - Virtual machine ID The parameter must be an identifier for the resource type: VirtualMachine.

invocationConfig - Configuration for the method invocation.

Throws:

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

NotFound - if the virtual machine is not found.

NotAllowedInCurrentState - if the virtual machine is not powered on.

disconnect

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

Disconnect the VMware Tools installer CD image. This method was added in vSphere API 7.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.
NotFound - if the virtual machine is not found.
NotAllowedInCurrentState - if the virtual machine is not powered on.

Parameters:

vm - Virtual machine ID The parameter must be an identifier for the resource type: VirtualMachine.

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

disconnect

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

Disconnect the VMware Tools installer CD image. This method was added in vSphere API 7.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.
NotFound - if the virtual machine is not found.
NotAllowedInCurrentState - if the virtual machine is not powered on.

Parameters:

vm - Virtual machine ID 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.