The Tools interface provides methods for managing VMware Tools in the guest operating system. More...

Inherited by vmware::vcenter::vm::ToolsStub.

Public Member Functions
vmware.vcenter.vm.ToolsTypes.Info	Get (string vm)
	Get the properties of VMware Tools.
vmware.vcenter.vm.ToolsTypes.Info	Get (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Get the properties of VMware Tools.
global::System.Threading.Tasks.Task < vmware.vcenter.vm.ToolsTypes.Info >	GetAsync (string vm)
	Get the properties of VMware Tools.
global::System.Threading.Tasks.Task < vmware.vcenter.vm.ToolsTypes.Info >	GetAsync (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Get the properties of VMware Tools.
void	Update (string vm, vmware.vcenter.vm.ToolsTypes.UpdateSpec spec)
	Update the properties of VMware Tools.
void	Update (string vm, vmware.vcenter.vm.ToolsTypes.UpdateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Update the properties of VMware Tools.
global::System.Threading.Tasks.Task	UpdateAsync (string vm, vmware.vcenter.vm.ToolsTypes.UpdateSpec spec)
	Update the properties of VMware Tools.
global::System.Threading.Tasks.Task	UpdateAsync (string vm, vmware.vcenter.vm.ToolsTypes.UpdateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Update the properties of VMware Tools.
void	Upgrade (string vm, string commandLineOptions)
	Begins the Tools upgrade process.
void	Upgrade (string vm, string commandLineOptions, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Begins the Tools upgrade process.
global::System.Threading.Tasks.Task	UpgradeAsync (string vm, string commandLineOptions)
	Begins the Tools upgrade process.
global::System.Threading.Tasks.Task	UpgradeAsync (string vm, string commandLineOptions, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Begins the Tools upgrade process.

Detailed Description

The Tools interface provides methods for managing VMware Tools in the guest operating system.

This interface was added in vSphere API 7.0.0.

Member Function Documentation

vmware.vcenter.vm.ToolsTypes.Info vmware::vcenter::vm::Tools::Get ( string vm )

Get the properties of VMware Tools.

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:: VMware Tools properties.

Implemented in vmware::vcenter::vm::ToolsStub.

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

Get the properties of VMware Tools.

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:: VMware Tools properties.

Implemented in vmware::vcenter::vm::ToolsStub.

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

Get the properties of VMware Tools.

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:: VMware Tools properties.

Implemented in vmware::vcenter::vm::ToolsStub.

global::System.Threading.Tasks.Task<vmware.vcenter.vm.ToolsTypes.Info> vmware::vcenter::vm::Tools::GetAsync ( string vm )

Get the properties of VMware Tools.

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:: VMware Tools properties.

Implemented in vmware::vcenter::vm::ToolsStub.

void vmware::vcenter::vm::Tools::Update	(	string	vm,
		vmware.vcenter.vm.ToolsTypes.UpdateSpec	spec
	)

Update the properties of VMware Tools.

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.InvalidArgument	if the Tools.UpdateSpec.upgradePolicy field contains a value that is not supported by the server.
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` .
spec	The new values.

Implemented in vmware::vcenter::vm::ToolsStub.

void vmware::vcenter::vm::Tools::Update	(	string	vm,
		vmware.vcenter.vm.ToolsTypes.UpdateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Update the properties of VMware Tools.

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.InvalidArgument	if the Tools.UpdateSpec.upgradePolicy field contains a value that is not supported by the server.
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` .
spec	The new values.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::vm::ToolsStub.

global::System.Threading.Tasks.Task vmware::vcenter::vm::Tools::UpdateAsync	(	string	vm,
		vmware.vcenter.vm.ToolsTypes.UpdateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Update the properties of VMware Tools.

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.InvalidArgument	if the Tools.UpdateSpec.upgradePolicy field contains a value that is not supported by the server.
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` .
spec	The new values.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::vm::ToolsStub.

global::System.Threading.Tasks.Task vmware::vcenter::vm::Tools::UpdateAsync	(	string	vm,
		vmware.vcenter.vm.ToolsTypes.UpdateSpec	spec
	)

Update the properties of VMware Tools.

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.InvalidArgument	if the Tools.UpdateSpec.upgradePolicy field contains a value that is not supported by the server.
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` .
spec	The new values.

Implemented in vmware::vcenter::vm::ToolsStub.

void vmware::vcenter::vm::Tools::Upgrade	(	string	vm,
		string	commandLineOptions,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Begins the Tools upgrade process.

To monitor the status of the Tools upgrade, clients should check the Tools status by calling Tools.Get and examining versionStatus and runState . 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.ServiceUnavailable	if the VMware Tools are not running.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is not powered on.
vmware.vapi.std.errors.AlreadyInDesiredState	is an upgrade is already in progress.
vmware.vapi.std.errors.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.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::vm::ToolsStub.

void vmware::vcenter::vm::Tools::Upgrade	(	string	vm,
		string	commandLineOptions
	)

Begins the Tools upgrade process.

To monitor the status of the Tools upgrade, clients should check the Tools status by calling Tools.Get and examining versionStatus and runState . 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.ServiceUnavailable	if the VMware Tools are not running.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is not powered on.
vmware.vapi.std.errors.AlreadyInDesiredState	is an upgrade is already in progress.
vmware.vapi.std.errors.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.

Implemented in vmware::vcenter::vm::ToolsStub.

global::System.Threading.Tasks.Task vmware::vcenter::vm::Tools::UpgradeAsync	(	string	vm,
		string	commandLineOptions
	)

Begins the Tools upgrade process.

To monitor the status of the Tools upgrade, clients should check the Tools status by calling Tools.Get and examining versionStatus and runState . 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.ServiceUnavailable	if the VMware Tools are not running.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is not powered on.
vmware.vapi.std.errors.AlreadyInDesiredState	is an upgrade is already in progress.
vmware.vapi.std.errors.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.

Implemented in vmware::vcenter::vm::ToolsStub.

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

Begins the Tools upgrade process.

To monitor the status of the Tools upgrade, clients should check the Tools status by calling Tools.Get and examining versionStatus and runState . 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.ServiceUnavailable	if the VMware Tools are not running.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is not powered on.
vmware.vapi.std.errors.AlreadyInDesiredState	is an upgrade is already in progress.
vmware.vapi.std.errors.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.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::vm::ToolsStub.

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

Tools.cs

Public Member Functions

Detailed Description

Member Function Documentation