vmware::vcenter::vm::guest::PowerStub Class Reference

Remote stub implementation of the Power API service. More...

Inherits vmware::vcenter::vm::guest::Power.

List of all members.

Public Member Functions
	PowerStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.TypeConverter typeConverter, vmware.vapi.bindings.IStubConfiguration config)
	PowerStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.IStubConfiguration config)
vmware.vcenter.vm.guest.PowerTypes.Info	Get (string vm)
	Returns information about the guest operating system power state.
vmware.vcenter.vm.guest.PowerTypes.Info	Get (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns information about the guest operating system power state.
global::System.Threading.Tasks.Task < vmware.vcenter.vm.guest.PowerTypes.Info >	GetAsync (string vm)
	Returns information about the guest operating system power state.
global::System.Threading.Tasks.Task < vmware.vcenter.vm.guest.PowerTypes.Info >	GetAsync (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns information about the guest operating system power state.
void	Shutdown (string vm)
	Issues a request to the guest operating system asking it to perform a clean shutdown of all services.
void	Shutdown (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Issues a request to the guest operating system asking it to perform a clean shutdown of all services.
global::System.Threading.Tasks.Task	ShutdownAsync (string vm)
	Issues a request to the guest operating system asking it to perform a clean shutdown of all services.
global::System.Threading.Tasks.Task	ShutdownAsync (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Issues a request to the guest operating system asking it to perform a clean shutdown of all services.
void	Reboot (string vm)
	Issues a request to the guest operating system asking it to perform a reboot.
void	Reboot (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Issues a request to the guest operating system asking it to perform a reboot.
global::System.Threading.Tasks.Task	RebootAsync (string vm)
	Issues a request to the guest operating system asking it to perform a reboot.
global::System.Threading.Tasks.Task	RebootAsync (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Issues a request to the guest operating system asking it to perform a reboot.
void	Standby (string vm)
	Issues a request to the guest operating system asking it to perform a suspend operation.
void	Standby (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Issues a request to the guest operating system asking it to perform a suspend operation.
global::System.Threading.Tasks.Task	StandbyAsync (string vm)
	Issues a request to the guest operating system asking it to perform a suspend operation.
global::System.Threading.Tasks.Task	StandbyAsync (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Issues a request to the guest operating system asking it to perform a suspend operation.

---

Detailed Description

Remote stub implementation of the Power API service.

---

Constructor & Destructor Documentation

vmware::vcenter::vm::guest::PowerStub::PowerStub	(	vmware.vapi.core.IApiProvider	iApiProvider,
		vmware.vapi.bindings.TypeConverter	typeConverter,
		vmware.vapi.bindings.IStubConfiguration	config
	)		[inline]

vmware::vcenter::vm::guest::PowerStub::PowerStub	(	vmware.vapi.core.IApiProvider	iApiProvider,
		vmware.vapi.bindings.IStubConfiguration	config
	)		[inline]

---

Member Function Documentation

vmware.vcenter.vm.guest.PowerTypes.Info vmware::vcenter::vm::guest::PowerStub::Get

(

string

vm

)

[inline]

Returns information about the guest operating system power state.

This method was added in vSphere API 6.7.

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:

Guest OS powerstate information.

Implements vmware::vcenter::vm::guest::Power.

vmware.vcenter.vm.guest.PowerTypes.Info vmware::vcenter::vm::guest::PowerStub::Get	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Returns information about the guest operating system power state.

This method was added in vSphere API 6.7.

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:

Guest OS powerstate information.

Implements vmware::vcenter::vm::guest::Power.

global::System.Threading.Tasks.Task<vmware.vcenter.vm.guest.PowerTypes.Info> vmware::vcenter::vm::guest::PowerStub::GetAsync	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Returns information about the guest operating system power state.

This method was added in vSphere API 6.7.

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:

Guest OS powerstate information.

Implements vmware::vcenter::vm::guest::Power.

global::System.Threading.Tasks.Task<vmware.vcenter.vm.guest.PowerTypes.Info> vmware::vcenter::vm::guest::PowerStub::GetAsync

(

string

vm

)

[inline]

Returns information about the guest operating system power state.

This method was added in vSphere API 6.7.

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:

Guest OS powerstate information.

Implements vmware::vcenter::vm::guest::Power.

void vmware::vcenter::vm::guest::PowerStub::Reboot

(

string

vm

)

[inline]

Issues a request to the guest operating system asking it to perform a reboot.

This request returns immediately and does not wait for the guest operating system to complete the operation. This method was added in vSphere API 6.7.

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.
vmware.vapi.std.errors.ServiceUnavailable	if VMware Tools is not running.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is performing another operation.
vmware.vapi.std.errors.Unsupported	if the virtual machine does not support being powered on (e.g. marked as a template, serving as a fault-tolerance secondary virtual machine).

Parameters:

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

Implements vmware::vcenter::vm::guest::Power.

void vmware::vcenter::vm::guest::PowerStub::Reboot	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Issues a request to the guest operating system asking it to perform a reboot.

This request returns immediately and does not wait for the guest operating system to complete the operation. This method was added in vSphere API 6.7.

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.
vmware.vapi.std.errors.ServiceUnavailable	if VMware Tools is not running.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is performing another operation.
vmware.vapi.std.errors.Unsupported	if the virtual machine does not support being powered on (e.g. marked as a template, serving as a fault-tolerance secondary virtual machine).

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

Implements vmware::vcenter::vm::guest::Power.

global::System.Threading.Tasks.Task vmware::vcenter::vm::guest::PowerStub::RebootAsync

(

string

vm

)

[inline]

Issues a request to the guest operating system asking it to perform a reboot.

This request returns immediately and does not wait for the guest operating system to complete the operation. This method was added in vSphere API 6.7.

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.
vmware.vapi.std.errors.ServiceUnavailable	if VMware Tools is not running.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is performing another operation.
vmware.vapi.std.errors.Unsupported	if the virtual machine does not support being powered on (e.g. marked as a template, serving as a fault-tolerance secondary virtual machine).

Parameters:

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

Implements vmware::vcenter::vm::guest::Power.

global::System.Threading.Tasks.Task vmware::vcenter::vm::guest::PowerStub::RebootAsync	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Issues a request to the guest operating system asking it to perform a reboot.

This request returns immediately and does not wait for the guest operating system to complete the operation. This method was added in vSphere API 6.7.

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.
vmware.vapi.std.errors.ServiceUnavailable	if VMware Tools is not running.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is performing another operation.
vmware.vapi.std.errors.Unsupported	if the virtual machine does not support being powered on (e.g. marked as a template, serving as a fault-tolerance secondary virtual machine).

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

Implements vmware::vcenter::vm::guest::Power.

void vmware::vcenter::vm::guest::PowerStub::Shutdown

(

string

vm

)

[inline]

Issues a request to the guest operating system asking it to perform a clean shutdown of all services.

This request returns immediately and does not wait for the guest operating system to complete the operation. This method was added in vSphere API 6.7.

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.AlreadyInDesiredState	if the virtual machine is not powered on.
vmware.vapi.std.errors.ServiceUnavailable	if VMware Tools is not running.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is suspended.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is performing another operation.
vmware.vapi.std.errors.Unsupported	if the virtual machine does not support being powered on (e.g. marked as a template, serving as a fault-tolerance secondary virtual machine).

Parameters:

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

Implements vmware::vcenter::vm::guest::Power.

void vmware::vcenter::vm::guest::PowerStub::Shutdown	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Issues a request to the guest operating system asking it to perform a clean shutdown of all services.

This request returns immediately and does not wait for the guest operating system to complete the operation. This method was added in vSphere API 6.7.

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.AlreadyInDesiredState	if the virtual machine is not powered on.
vmware.vapi.std.errors.ServiceUnavailable	if VMware Tools is not running.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is suspended.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is performing another operation.
vmware.vapi.std.errors.Unsupported	if the virtual machine does not support being powered on (e.g. marked as a template, serving as a fault-tolerance secondary virtual machine).

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

Implements vmware::vcenter::vm::guest::Power.

global::System.Threading.Tasks.Task vmware::vcenter::vm::guest::PowerStub::ShutdownAsync	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Issues a request to the guest operating system asking it to perform a clean shutdown of all services.

This request returns immediately and does not wait for the guest operating system to complete the operation. This method was added in vSphere API 6.7.

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.AlreadyInDesiredState	if the virtual machine is not powered on.
vmware.vapi.std.errors.ServiceUnavailable	if VMware Tools is not running.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is suspended.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is performing another operation.
vmware.vapi.std.errors.Unsupported	if the virtual machine does not support being powered on (e.g. marked as a template, serving as a fault-tolerance secondary virtual machine).

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

Implements vmware::vcenter::vm::guest::Power.

global::System.Threading.Tasks.Task vmware::vcenter::vm::guest::PowerStub::ShutdownAsync

(

string

vm

)

[inline]

Issues a request to the guest operating system asking it to perform a clean shutdown of all services.

This request returns immediately and does not wait for the guest operating system to complete the operation. This method was added in vSphere API 6.7.

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.AlreadyInDesiredState	if the virtual machine is not powered on.
vmware.vapi.std.errors.ServiceUnavailable	if VMware Tools is not running.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is suspended.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is performing another operation.
vmware.vapi.std.errors.Unsupported	if the virtual machine does not support being powered on (e.g. marked as a template, serving as a fault-tolerance secondary virtual machine).

Parameters:

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

Implements vmware::vcenter::vm::guest::Power.

void vmware::vcenter::vm::guest::PowerStub::Standby

(

string

vm

)

[inline]

Issues a request to the guest operating system asking it to perform a suspend operation.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.AlreadyInDesiredState	if the virtual machine is suspended.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.ServiceUnavailable	if VMware Tools is not running.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is not powered on.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is performing another operation.
vmware.vapi.std.errors.Unsupported	if the virtual machine does not support being powered on (e.g. marked as a template, serving as a fault-tolerance secondary virtual machine).

Parameters:

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

Implements vmware::vcenter::vm::guest::Power.

void vmware::vcenter::vm::guest::PowerStub::Standby	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Issues a request to the guest operating system asking it to perform a suspend operation.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.AlreadyInDesiredState	if the virtual machine is suspended.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.ServiceUnavailable	if VMware Tools is not running.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is not powered on.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is performing another operation.
vmware.vapi.std.errors.Unsupported	if the virtual machine does not support being powered on (e.g. marked as a template, serving as a fault-tolerance secondary virtual machine).

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

Implements vmware::vcenter::vm::guest::Power.

global::System.Threading.Tasks.Task vmware::vcenter::vm::guest::PowerStub::StandbyAsync	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Issues a request to the guest operating system asking it to perform a suspend operation.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.AlreadyInDesiredState	if the virtual machine is suspended.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.ServiceUnavailable	if VMware Tools is not running.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is not powered on.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is performing another operation.
vmware.vapi.std.errors.Unsupported	if the virtual machine does not support being powered on (e.g. marked as a template, serving as a fault-tolerance secondary virtual machine).

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

Implements vmware::vcenter::vm::guest::Power.

global::System.Threading.Tasks.Task vmware::vcenter::vm::guest::PowerStub::StandbyAsync

(

string

vm

)

[inline]

Issues a request to the guest operating system asking it to perform a suspend operation.

This method was added in vSphere API 6.7.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.AlreadyInDesiredState	if the virtual machine is suspended.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.ServiceUnavailable	if VMware Tools is not running.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is not powered on.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is performing another operation.
vmware.vapi.std.errors.Unsupported	if the virtual machine does not support being powered on (e.g. marked as a template, serving as a fault-tolerance secondary virtual machine).

Parameters:

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

Implements vmware::vcenter::vm::guest::Power.

---

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

• guest/PowerStub.cs