VMware vSphere Automation SDK for .NET 7.0.0.1
vmware::vcenter::vm::PowerStub Class Reference

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

Inherits vmware::vcenter::vm::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.PowerTypes.Info Get (string vm)
 Returns the power state information of a virtual machine.
vmware.vcenter.vm.PowerTypes.Info Get (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns the power state information of a virtual machine.
global::System.Threading.Tasks.Task
< vmware.vcenter.vm.PowerTypes.Info
GetAsync (string vm)
 Returns the power state information of a virtual machine.
global::System.Threading.Tasks.Task
< vmware.vcenter.vm.PowerTypes.Info
GetAsync (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns the power state information of a virtual machine.
void Start (string vm)
 Powers on a powered-off or suspended virtual machine.
void Start (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Powers on a powered-off or suspended virtual machine.
global::System.Threading.Tasks.Task StartAsync (string vm)
 Powers on a powered-off or suspended virtual machine.
global::System.Threading.Tasks.Task StartAsync (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Powers on a powered-off or suspended virtual machine.
void Stop (string vm)
 Powers off a powered-on or suspended virtual machine.
void Stop (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Powers off a powered-on or suspended virtual machine.
global::System.Threading.Tasks.Task StopAsync (string vm)
 Powers off a powered-on or suspended virtual machine.
global::System.Threading.Tasks.Task StopAsync (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Powers off a powered-on or suspended virtual machine.
void Suspend (string vm)
 Suspends a powered-on virtual machine.
void Suspend (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Suspends a powered-on virtual machine.
global::System.Threading.Tasks.Task SuspendAsync (string vm)
 Suspends a powered-on virtual machine.
global::System.Threading.Tasks.Task SuspendAsync (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Suspends a powered-on virtual machine.
void Reset (string vm)
 Resets a powered-on virtual machine.
void Reset (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Resets a powered-on virtual machine.
global::System.Threading.Tasks.Task ResetAsync (string vm)
 Resets a powered-on virtual machine.
global::System.Threading.Tasks.Task ResetAsync (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Resets a powered-on virtual machine.

Detailed Description

Remote stub implementation of the Power API service.


Constructor & Destructor Documentation

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

Member Function Documentation

vmware.vcenter.vm.PowerTypes.Info vmware::vcenter::vm::PowerStub::Get ( string  vm) [inline]

Returns the power state information of a virtual machine.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the virtual machine is not found.
vmware.vapi.std.errors.ResourceInaccessibleif the virtual machine's configuration or execution state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource VirtualMachine referenced by the parameter vm requires System.Read .
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
Returns:
Power state information for the specified virtual machine.

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

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

Returns the power state information of a virtual machine.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the virtual machine is not found.
vmware.vapi.std.errors.ResourceInaccessibleif the virtual machine's configuration or execution state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource VirtualMachine referenced by the parameter vm requires System.Read .
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Power state information for the specified virtual machine.

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

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

Returns the power state information of a virtual machine.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the virtual machine is not found.
vmware.vapi.std.errors.ResourceInaccessibleif the virtual machine's configuration or execution state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource VirtualMachine referenced by the parameter vm requires System.Read .
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Power state information for the specified virtual machine.

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

global::System.Threading.Tasks.Task<vmware.vcenter.vm.PowerTypes.Info> vmware::vcenter::vm::PowerStub::GetAsync ( string  vm) [inline]

Returns the power state information of a virtual machine.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the virtual machine is not found.
vmware.vapi.std.errors.ResourceInaccessibleif the virtual machine's configuration or execution state cannot be accessed.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource VirtualMachine referenced by the parameter vm requires System.Read .
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
Returns:
Power state information for the specified virtual machine.

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

void vmware::vcenter::vm::PowerStub::Reset ( string  vm) [inline]

Resets a powered-on virtual machine.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the virtual machine is not found.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the virtual machine is powered off or suspended.
vmware.vapi.std.errors.ResourceBusyif the virtual machine is performing another operation
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.Reset .
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .

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

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

Resets a powered-on virtual machine.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the virtual machine is not found.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the virtual machine is powered off or suspended.
vmware.vapi.std.errors.ResourceBusyif the virtual machine is performing another operation
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.Reset .
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

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

global::System.Threading.Tasks.Task vmware::vcenter::vm::PowerStub::ResetAsync ( string  vm) [inline]

Resets a powered-on virtual machine.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the virtual machine is not found.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the virtual machine is powered off or suspended.
vmware.vapi.std.errors.ResourceBusyif the virtual machine is performing another operation
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.Reset .
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .

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

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

Resets a powered-on virtual machine.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the virtual machine is not found.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the virtual machine is powered off or suspended.
vmware.vapi.std.errors.ResourceBusyif the virtual machine is performing another operation
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.Reset .
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

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

void vmware::vcenter::vm::PowerStub::Start ( string  vm) [inline]

Powers on a powered-off or suspended virtual machine.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the virtual machine is not found.
vmware.vapi.std.errors.AlreadyInDesiredStateif the virtual machine is already powered on.
vmware.vapi.std.errors.Unsupportedif the virtual machine does not support being powered on (e.g. marked as a template, serving as a fault-tolerance secondary virtual machine).
vmware.vapi.std.errors.UnableToAllocateResourceif resources cannot be allocated for the virtual machine (e.g. physical resource allocation policy cannot be satisfied, insufficient licenses are available to run the virtual machine).
vmware.vapi.std.errors.ResourceInaccessibleif resources required by the virtual machine are not accessible (e.g. virtual machine configuration files or virtual disks are on inaccessible storage, no hosts are available to run the virtual machine).
vmware.vapi.std.errors.ResourceInUseif resources required by the virtual machine are in use (e.g. virtual machine configuration files or virtual disks are locked, host containing the virtual machine is an HA failover host).
vmware.vapi.std.errors.ResourceBusyif the virtual machine is performing another operation.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.PowerOn .
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .

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

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

Powers on a powered-off or suspended virtual machine.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the virtual machine is not found.
vmware.vapi.std.errors.AlreadyInDesiredStateif the virtual machine is already powered on.
vmware.vapi.std.errors.Unsupportedif the virtual machine does not support being powered on (e.g. marked as a template, serving as a fault-tolerance secondary virtual machine).
vmware.vapi.std.errors.UnableToAllocateResourceif resources cannot be allocated for the virtual machine (e.g. physical resource allocation policy cannot be satisfied, insufficient licenses are available to run the virtual machine).
vmware.vapi.std.errors.ResourceInaccessibleif resources required by the virtual machine are not accessible (e.g. virtual machine configuration files or virtual disks are on inaccessible storage, no hosts are available to run the virtual machine).
vmware.vapi.std.errors.ResourceInUseif resources required by the virtual machine are in use (e.g. virtual machine configuration files or virtual disks are locked, host containing the virtual machine is an HA failover host).
vmware.vapi.std.errors.ResourceBusyif the virtual machine is performing another operation.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.PowerOn .
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

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

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

Powers on a powered-off or suspended virtual machine.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the virtual machine is not found.
vmware.vapi.std.errors.AlreadyInDesiredStateif the virtual machine is already powered on.
vmware.vapi.std.errors.Unsupportedif the virtual machine does not support being powered on (e.g. marked as a template, serving as a fault-tolerance secondary virtual machine).
vmware.vapi.std.errors.UnableToAllocateResourceif resources cannot be allocated for the virtual machine (e.g. physical resource allocation policy cannot be satisfied, insufficient licenses are available to run the virtual machine).
vmware.vapi.std.errors.ResourceInaccessibleif resources required by the virtual machine are not accessible (e.g. virtual machine configuration files or virtual disks are on inaccessible storage, no hosts are available to run the virtual machine).
vmware.vapi.std.errors.ResourceInUseif resources required by the virtual machine are in use (e.g. virtual machine configuration files or virtual disks are locked, host containing the virtual machine is an HA failover host).
vmware.vapi.std.errors.ResourceBusyif the virtual machine is performing another operation.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.PowerOn .
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

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

global::System.Threading.Tasks.Task vmware::vcenter::vm::PowerStub::StartAsync ( string  vm) [inline]

Powers on a powered-off or suspended virtual machine.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the virtual machine is not found.
vmware.vapi.std.errors.AlreadyInDesiredStateif the virtual machine is already powered on.
vmware.vapi.std.errors.Unsupportedif the virtual machine does not support being powered on (e.g. marked as a template, serving as a fault-tolerance secondary virtual machine).
vmware.vapi.std.errors.UnableToAllocateResourceif resources cannot be allocated for the virtual machine (e.g. physical resource allocation policy cannot be satisfied, insufficient licenses are available to run the virtual machine).
vmware.vapi.std.errors.ResourceInaccessibleif resources required by the virtual machine are not accessible (e.g. virtual machine configuration files or virtual disks are on inaccessible storage, no hosts are available to run the virtual machine).
vmware.vapi.std.errors.ResourceInUseif resources required by the virtual machine are in use (e.g. virtual machine configuration files or virtual disks are locked, host containing the virtual machine is an HA failover host).
vmware.vapi.std.errors.ResourceBusyif the virtual machine is performing another operation.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.PowerOn .
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .

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

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

Powers off a powered-on or suspended virtual machine.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the virtual machine is not found.
vmware.vapi.std.errors.AlreadyInDesiredStateif the virtual machine is already powered off.
vmware.vapi.std.errors.ResourceBusyif the virtual machine is performing another operation.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.PowerOff .
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

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

void vmware::vcenter::vm::PowerStub::Stop ( string  vm) [inline]

Powers off a powered-on or suspended virtual machine.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the virtual machine is not found.
vmware.vapi.std.errors.AlreadyInDesiredStateif the virtual machine is already powered off.
vmware.vapi.std.errors.ResourceBusyif the virtual machine is performing another operation.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.PowerOff .
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .

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

global::System.Threading.Tasks.Task vmware::vcenter::vm::PowerStub::StopAsync ( string  vm) [inline]

Powers off a powered-on or suspended virtual machine.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the virtual machine is not found.
vmware.vapi.std.errors.AlreadyInDesiredStateif the virtual machine is already powered off.
vmware.vapi.std.errors.ResourceBusyif the virtual machine is performing another operation.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.PowerOff .
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .

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

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

Powers off a powered-on or suspended virtual machine.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the virtual machine is not found.
vmware.vapi.std.errors.AlreadyInDesiredStateif the virtual machine is already powered off.
vmware.vapi.std.errors.ResourceBusyif the virtual machine is performing another operation.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.PowerOff .
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

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

void vmware::vcenter::vm::PowerStub::Suspend ( string  vm) [inline]

Suspends a powered-on virtual machine.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the virtual machine is not found.
vmware.vapi.std.errors.AlreadyInDesiredStateif the virtual machine is already suspended.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the virtual machine is powered off.
vmware.vapi.std.errors.ResourceBusyif the virtual machine is performing another operation.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.Suspend .
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .

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

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

Suspends a powered-on virtual machine.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the virtual machine is not found.
vmware.vapi.std.errors.AlreadyInDesiredStateif the virtual machine is already suspended.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the virtual machine is powered off.
vmware.vapi.std.errors.ResourceBusyif the virtual machine is performing another operation.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.Suspend .
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

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

global::System.Threading.Tasks.Task vmware::vcenter::vm::PowerStub::SuspendAsync ( string  vm) [inline]

Suspends a powered-on virtual machine.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the virtual machine is not found.
vmware.vapi.std.errors.AlreadyInDesiredStateif the virtual machine is already suspended.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the virtual machine is powered off.
vmware.vapi.std.errors.ResourceBusyif the virtual machine is performing another operation.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.Suspend .
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .

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

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

Suspends a powered-on virtual machine.

Exceptions:
vmware.vapi.std.errors.Errorif the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFoundif the virtual machine is not found.
vmware.vapi.std.errors.AlreadyInDesiredStateif the virtual machine is already suspended.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the virtual machine is powered off.
vmware.vapi.std.errors.ResourceBusyif the virtual machine is performing another operation.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Interact.Suspend .
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

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


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