com.vmware.vcenter.vm.tools

Class InstallerStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.vm.tools.InstallerStub

All Implemented Interfaces:

Service, Installer, InstallerTypes

public class InstallerStub
extends com.vmware.vapi.internal.bindings.Stub
implements Installer

Remote stub implementation of the Installer API service.

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

Nested Class Summary

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

InstallerTypes.Info

Field Summary

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

apiProvider, converter, ifaceId, retryPolicy, securityContext

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

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

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.

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

InstallerStub

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

InstallerStub

public InstallerStub(ApiProvider apiProvider,
                     StubConfigurationBase config)

Method Detail

get

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

Description copied from interface: Installer

Get information about the VMware Tools installer. 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.

Specified by:

get in interface Installer

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.

get

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

Description copied from interface: Installer

Get information about the VMware Tools installer. 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.

Specified by:

get in interface Installer

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.

get

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

Description copied from interface: Installer

Get information about the VMware Tools installer. 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:
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.

Specified by:

get in interface Installer

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

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

Description copied from interface: Installer

Get information about the VMware Tools installer. 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:
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.

Specified by:

get in interface Installer

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

public void connect(java.lang.String vm)

Description copied from interface: Installer

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

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

Specified by:

connect in interface Installer

Parameters:

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

connect

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

Description copied from interface: Installer

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

connect in interface Installer

Parameters:

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

invocationConfig - Configuration for the method invocation.

connect

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

Description copied from interface: Installer

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

Specified by:

connect in interface Installer

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

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

Description copied from interface: Installer

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

Specified by:

connect in interface Installer

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

public void disconnect(java.lang.String vm)

Description copied from interface: Installer

Disconnect the VMware Tools installer CD image. 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.

Specified by:

disconnect in interface Installer

Parameters:

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

disconnect

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

Description copied from interface: Installer

Disconnect the VMware Tools installer CD image. 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.

Specified by:

disconnect in interface Installer

Parameters:

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

invocationConfig - Configuration for the method invocation.

disconnect

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

Description copied from interface: Installer

Disconnect the VMware Tools installer CD image. 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.
NotFound - if the virtual machine is not found.
NotAllowedInCurrentState - if the virtual machine is not powered on.

Specified by:

disconnect in interface Installer

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

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

Description copied from interface: Installer

Disconnect the VMware Tools installer CD image. 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.
NotFound - if the virtual machine is not found.
NotAllowedInCurrentState - if the virtual machine is not powered on.

Specified by:

disconnect in interface Installer

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.