vmware::vcenter::vm::tools::Installer Interface Reference

The Installer ( service} provides methods to install VMware Tools in the guest operating system. More...

Inherited by vmware::vcenter::vm::tools::InstallerStub.

List of all members.

Public Member Functions
vmware.vcenter.vm.tools.InstallerTypes.Info	Get (string vm)
	Get information about the VMware Tools installer.
vmware.vcenter.vm.tools.InstallerTypes.Info	Get (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Get information about the VMware Tools installer.
global::System.Threading.Tasks.Task < vmware.vcenter.vm.tools.InstallerTypes.Info >	GetAsync (string vm)
	Get information about the VMware Tools installer.
global::System.Threading.Tasks.Task < vmware.vcenter.vm.tools.InstallerTypes.Info >	GetAsync (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Get information about the VMware Tools installer.
void	Connect (string vm)
	Connects the VMware Tools CD installer as a CD-ROM for the guest operating system.
void	Connect (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Connects the VMware Tools CD installer as a CD-ROM for the guest operating system.
global::System.Threading.Tasks.Task	ConnectAsync (string vm)
	Connects the VMware Tools CD installer as a CD-ROM for the guest operating system.
global::System.Threading.Tasks.Task	ConnectAsync (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Connects the VMware Tools CD installer as a CD-ROM for the guest operating system.
void	Disconnect (string vm)
	Disconnect the VMware Tools installer CD image.
void	Disconnect (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Disconnect the VMware Tools installer CD image.
global::System.Threading.Tasks.Task	DisconnectAsync (string vm)
	Disconnect the VMware Tools installer CD image.
global::System.Threading.Tasks.Task	DisconnectAsync (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Disconnect the VMware Tools installer CD image.

---

Detailed Description

The Installer ( service} provides methods to install VMware Tools in the guest operating system.

This interface was added in vSphere API 7.0.0.

---

Member Function Documentation

void vmware::vcenter::vm::tools::Installer::Connect

(

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 versionStatus and runState from vmware.vcenter.vm.Tools.Get . This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is not powered on.
vmware.vapi.std.errors.AlreadyInDesiredState	if the VMware Tools CD is already connected.
vmware.vapi.std.errors.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 .

Implemented in vmware::vcenter::vm::tools::InstallerStub.

void vmware::vcenter::vm::tools::Installer::Connect	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.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 versionStatus and runState from vmware.vcenter.vm.Tools.Get . This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is not powered on.
vmware.vapi.std.errors.AlreadyInDesiredState	if the VMware Tools CD is already connected.
vmware.vapi.std.errors.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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::vm::tools::InstallerStub.

global::System.Threading.Tasks.Task vmware::vcenter::vm::tools::Installer::ConnectAsync	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.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 versionStatus and runState from vmware.vcenter.vm.Tools.Get . This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is not powered on.
vmware.vapi.std.errors.AlreadyInDesiredState	if the VMware Tools CD is already connected.
vmware.vapi.std.errors.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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::vm::tools::InstallerStub.

global::System.Threading.Tasks.Task vmware::vcenter::vm::tools::Installer::ConnectAsync

(

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 versionStatus and runState from vmware.vcenter.vm.Tools.Get . This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is not powered on.
vmware.vapi.std.errors.AlreadyInDesiredState	if the VMware Tools CD is already connected.
vmware.vapi.std.errors.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 .

Implemented in vmware::vcenter::vm::tools::InstallerStub.

void vmware::vcenter::vm::tools::Installer::Disconnect

(

string

vm

)

Disconnect the VMware Tools installer CD image.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.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 .

Implemented in vmware::vcenter::vm::tools::InstallerStub.

void vmware::vcenter::vm::tools::Installer::Disconnect	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Disconnect the VMware Tools installer CD image.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::vm::tools::InstallerStub.

global::System.Threading.Tasks.Task vmware::vcenter::vm::tools::Installer::DisconnectAsync

(

string

vm

)

Disconnect the VMware Tools installer CD image.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.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 .

Implemented in vmware::vcenter::vm::tools::InstallerStub.

global::System.Threading.Tasks.Task vmware::vcenter::vm::tools::Installer::DisconnectAsync	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Disconnect the VMware Tools installer CD image.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::vm::tools::InstallerStub.

vmware.vcenter.vm.tools.InstallerTypes.Info vmware::vcenter::vm::tools::Installer::Get

(

string

vm

)

Get information about the VMware Tools installer.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.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 .

Returns:

information about the VMware Tools installer.

Implemented in vmware::vcenter::vm::tools::InstallerStub.

vmware.vcenter.vm.tools.InstallerTypes.Info vmware::vcenter::vm::tools::Installer::Get	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Get information about the VMware Tools installer.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

information about the VMware Tools installer.

Implemented in vmware::vcenter::vm::tools::InstallerStub.

global::System.Threading.Tasks.Task<vmware.vcenter.vm.tools.InstallerTypes.Info> vmware::vcenter::vm::tools::Installer::GetAsync	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Get information about the VMware Tools installer.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

information about the VMware Tools installer.

Implemented in vmware::vcenter::vm::tools::InstallerStub.

global::System.Threading.Tasks.Task<vmware.vcenter.vm.tools.InstallerTypes.Info> vmware::vcenter::vm::tools::Installer::GetAsync

(

string

vm

)

Get information about the VMware Tools installer.

This method was added in vSphere API 7.0.0.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.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 .

Returns:

information about the VMware Tools installer.

Implemented in vmware::vcenter::vm::tools::InstallerStub.

---

The documentation for this interface was generated from the following file:

• Installer.cs