VMware vSphere Automation SDK for .NET 6.5.0
vmware::vcenter::vm::hardware::boot::DeviceStub Class Reference

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

Inherits vmware::vcenter::vm::hardware::boot::Device.

List of all members.

Public Member Functions

 DeviceStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.IStubConfiguration config)
global::System.Collections.Generic.List
< vmware.vcenter.vm.hardware.boot.DeviceTypes.Entry
Get (string vm)
 Returns an ordered list of boot devices for the virtual machine.
global::System.Collections.Generic.List
< vmware.vcenter.vm.hardware.boot.DeviceTypes.Entry
Get (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns an ordered list of boot devices for the virtual machine.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.vcenter.vm.hardware.boot.DeviceTypes.Entry > > 
GetAsync (string vm)
 Returns an ordered list of boot devices for the virtual machine.
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.vcenter.vm.hardware.boot.DeviceTypes.Entry > > 
GetAsync (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns an ordered list of boot devices for the virtual machine.
void Set (string vm, global::System.Collections.Generic.List< vmware.vcenter.vm.hardware.boot.DeviceTypes.Entry > devices)
 Sets the virtual devices that will be used to boot the virtual machine.
void Set (string vm, global::System.Collections.Generic.List< vmware.vcenter.vm.hardware.boot.DeviceTypes.Entry > devices, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Sets the virtual devices that will be used to boot the virtual machine.
global::System.Threading.Tasks.Task SetAsync (string vm, global::System.Collections.Generic.List< vmware.vcenter.vm.hardware.boot.DeviceTypes.Entry > devices)
 Sets the virtual devices that will be used to boot the virtual machine.
global::System.Threading.Tasks.Task SetAsync (string vm, global::System.Collections.Generic.List< vmware.vcenter.vm.hardware.boot.DeviceTypes.Entry > devices, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Sets the virtual devices that will be used to boot the virtual machine.

Detailed Description

Remote stub implementation of the Device API service.


Constructor & Destructor Documentation

vmware::vcenter::vm::hardware::boot::DeviceStub::DeviceStub ( vmware.vapi.core.IApiProvider  iApiProvider,
vmware.vapi.bindings.IStubConfiguration  config 
) [inline]

Member Function Documentation

global::System.Collections.Generic.List<vmware.vcenter.vm.hardware.boot.DeviceTypes.Entry> vmware::vcenter::vm::hardware::boot::DeviceStub::Get ( string  vm) [inline]

Returns an ordered list of boot devices for the virtual machine.

If the list is empty, the virtual machine uses a default boot sequence.

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 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.
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
Returns:
Ordered list of configured boot devices.

Implements vmware::vcenter::vm::hardware::boot::Device.

global::System.Collections.Generic.List<vmware.vcenter.vm.hardware.boot.DeviceTypes.Entry> vmware::vcenter::vm::hardware::boot::DeviceStub::Get ( string  vm,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Returns an ordered list of boot devices for the virtual machine.

If the list is empty, the virtual machine uses a default boot sequence.

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 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.
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:
Ordered list of configured boot devices.

Implements vmware::vcenter::vm::hardware::boot::Device.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vcenter.vm.hardware.boot.DeviceTypes.Entry> > vmware::vcenter::vm::hardware::boot::DeviceStub::GetAsync ( string  vm,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Returns an ordered list of boot devices for the virtual machine.

If the list is empty, the virtual machine uses a default boot sequence.

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 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.
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:
Ordered list of configured boot devices.

Implements vmware::vcenter::vm::hardware::boot::Device.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vcenter.vm.hardware.boot.DeviceTypes.Entry> > vmware::vcenter::vm::hardware::boot::DeviceStub::GetAsync ( string  vm) [inline]

Returns an ordered list of boot devices for the virtual machine.

If the list is empty, the virtual machine uses a default boot sequence.

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 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.
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
Returns:
Ordered list of configured boot devices.

Implements vmware::vcenter::vm::hardware::boot::Device.

void vmware::vcenter::vm::hardware::boot::DeviceStub::Set ( string  vm,
global::System.Collections.Generic.List< vmware.vcenter.vm.hardware.boot.DeviceTypes.Entry devices 
) [inline]

Sets the virtual devices that will be used to boot the virtual machine.

The virtual machine will check the devices in order, attempting to boot from each, until the virtual machine boots successfully. If the list is empty, the virtual machine will use a default boot sequence. There should be no more than one instance of Device.Entry for a given device type except Device.Type.ETHERNET in the list.

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, or if any of the specified virtual devices is not found.
vmware.vapi.std.errors.InvalidArgumentif a any of the CDROM, DISK, ETHERNET, FLOPPY values appears in more than one Device.Entry with the exception of Device.Type.ETHERNET , which may appear multiple times if the virtual machine has been configured with multiple Ethernet adapters.
vmware.vapi.std.errors.ResourceBusyif the virtual machine is busy performing another operation.
vmware.vapi.std.errors.ResourceInaccessibleif the virtual machine's configuration 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.
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
devicesOrdered list of boot devices.

Implements vmware::vcenter::vm::hardware::boot::Device.

void vmware::vcenter::vm::hardware::boot::DeviceStub::Set ( string  vm,
global::System.Collections.Generic.List< vmware.vcenter.vm.hardware.boot.DeviceTypes.Entry devices,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Sets the virtual devices that will be used to boot the virtual machine.

The virtual machine will check the devices in order, attempting to boot from each, until the virtual machine boots successfully. If the list is empty, the virtual machine will use a default boot sequence. There should be no more than one instance of Device.Entry for a given device type except Device.Type.ETHERNET in the list.

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, or if any of the specified virtual devices is not found.
vmware.vapi.std.errors.InvalidArgumentif a any of the CDROM, DISK, ETHERNET, FLOPPY values appears in more than one Device.Entry with the exception of Device.Type.ETHERNET , which may appear multiple times if the virtual machine has been configured with multiple Ethernet adapters.
vmware.vapi.std.errors.ResourceBusyif the virtual machine is busy performing another operation.
vmware.vapi.std.errors.ResourceInaccessibleif the virtual machine's configuration 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.
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
devicesOrdered list of boot devices.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implements vmware::vcenter::vm::hardware::boot::Device.

global::System.Threading.Tasks.Task vmware::vcenter::vm::hardware::boot::DeviceStub::SetAsync ( string  vm,
global::System.Collections.Generic.List< vmware.vcenter.vm.hardware.boot.DeviceTypes.Entry devices,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Sets the virtual devices that will be used to boot the virtual machine.

The virtual machine will check the devices in order, attempting to boot from each, until the virtual machine boots successfully. If the list is empty, the virtual machine will use a default boot sequence. There should be no more than one instance of Device.Entry for a given device type except Device.Type.ETHERNET in the list.

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, or if any of the specified virtual devices is not found.
vmware.vapi.std.errors.InvalidArgumentif a any of the CDROM, DISK, ETHERNET, FLOPPY values appears in more than one Device.Entry with the exception of Device.Type.ETHERNET , which may appear multiple times if the virtual machine has been configured with multiple Ethernet adapters.
vmware.vapi.std.errors.ResourceBusyif the virtual machine is busy performing another operation.
vmware.vapi.std.errors.ResourceInaccessibleif the virtual machine's configuration 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.
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
devicesOrdered list of boot devices.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implements vmware::vcenter::vm::hardware::boot::Device.

global::System.Threading.Tasks.Task vmware::vcenter::vm::hardware::boot::DeviceStub::SetAsync ( string  vm,
global::System.Collections.Generic.List< vmware.vcenter.vm.hardware.boot.DeviceTypes.Entry devices 
) [inline]

Sets the virtual devices that will be used to boot the virtual machine.

The virtual machine will check the devices in order, attempting to boot from each, until the virtual machine boots successfully. If the list is empty, the virtual machine will use a default boot sequence. There should be no more than one instance of Device.Entry for a given device type except Device.Type.ETHERNET in the list.

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, or if any of the specified virtual devices is not found.
vmware.vapi.std.errors.InvalidArgumentif a any of the CDROM, DISK, ETHERNET, FLOPPY values appears in more than one Device.Entry with the exception of Device.Type.ETHERNET , which may appear multiple times if the virtual machine has been configured with multiple Ethernet adapters.
vmware.vapi.std.errors.ResourceBusyif the virtual machine is busy performing another operation.
vmware.vapi.std.errors.ResourceInaccessibleif the virtual machine's configuration 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.
Parameters:
vmVirtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
devicesOrdered list of boot devices.

Implements vmware::vcenter::vm::hardware::boot::Device.


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