The Power interface provides methods for managing the guest operating system power state of a virtual machine. More...

Inherited by vmware::vcenter::vm::guest::PowerStub.

Public Member Functions
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

The Power interface provides methods for managing the guest operating system power state of a virtual machine.

This interface was added in vSphere API 6.7.

Member Function Documentation

vmware.vcenter.vm.guest.PowerTypes.Info vmware::vcenter::vm::guest::Power::Get ( string vm )

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.

Implemented in vmware::vcenter::vm::guest::PowerStub.

vmware.vcenter.vm.guest.PowerTypes.Info vmware::vcenter::vm::guest::Power::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.

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.

Implemented in vmware::vcenter::vm::guest::PowerStub.

global::System.Threading.Tasks.Task<vmware.vcenter.vm.guest.PowerTypes.Info> vmware::vcenter::vm::guest::Power::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.

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.

Implemented in vmware::vcenter::vm::guest::PowerStub.

global::System.Threading.Tasks.Task<vmware.vcenter.vm.guest.PowerTypes.Info> vmware::vcenter::vm::guest::Power::GetAsync ( string vm )

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.

Implemented in vmware::vcenter::vm::guest::PowerStub.

void vmware::vcenter::vm::guest::Power::Reboot ( string vm )

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

Implemented in vmware::vcenter::vm::guest::PowerStub.

void vmware::vcenter::vm::guest::Power::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.

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

Implemented in vmware::vcenter::vm::guest::PowerStub.

global::System.Threading.Tasks.Task vmware::vcenter::vm::guest::Power::RebootAsync ( string vm )

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

Implemented in vmware::vcenter::vm::guest::PowerStub.

global::System.Threading.Tasks.Task vmware::vcenter::vm::guest::Power::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.

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

Implemented in vmware::vcenter::vm::guest::PowerStub.

void vmware::vcenter::vm::guest::Power::Shutdown ( string vm )

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

Implemented in vmware::vcenter::vm::guest::PowerStub.

void vmware::vcenter::vm::guest::Power::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.

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

Implemented in vmware::vcenter::vm::guest::PowerStub.

global::System.Threading.Tasks.Task vmware::vcenter::vm::guest::Power::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.

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

Implemented in vmware::vcenter::vm::guest::PowerStub.

global::System.Threading.Tasks.Task vmware::vcenter::vm::guest::Power::ShutdownAsync ( string vm )

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

Implemented in vmware::vcenter::vm::guest::PowerStub.

void vmware::vcenter::vm::guest::Power::Standby ( string vm )

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

Implemented in vmware::vcenter::vm::guest::PowerStub.

void vmware::vcenter::vm::guest::Power::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.

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

Implemented in vmware::vcenter::vm::guest::PowerStub.

global::System.Threading.Tasks.Task vmware::vcenter::vm::guest::Power::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.

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

Implemented in vmware::vcenter::vm::guest::PowerStub.

global::System.Threading.Tasks.Task vmware::vcenter::vm::guest::Power::StandbyAsync ( string vm )

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

Implemented in vmware::vcenter::vm::guest::PowerStub.

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

guest/Power.cs

Public Member Functions

Detailed Description

Member Function Documentation