com.vmware.vcenter.vm.hardware.boot

Interface Device

All Superinterfaces:

DeviceTypes, Service

All Known Implementing Classes:

DeviceStub

public interface Device
extends Service, DeviceTypes

The Device interface provides methods for configuring the device order used when booting a virtual machine.

The boot order may be specified using a mixture of device classes and device instances, chosen from among the following:

• DeviceTypes.Type.CDROM: Boot from a virtual CD-ROM drive; the device instance(s) will be chosen by the BIOS subsystem.
• DeviceTypes.Type.FLOPPY: Boot from a virtual floppy drive; the device instance(s) will be chosen by the BIOS subsystem.
• DeviceTypes.Type.DISK: Boot from a virtual disk device; the device instance is specified explicitly in DeviceTypes.Entry.getDisks() list, and multiple instances may be specified in the list.
• DeviceTypes.Type.ETHERNET: Boot from a virtual Ethernet adapter; the device instance is specified explicitly as DeviceTypes.Entry.getNic(), and multiple adapters may be specified in the boot order list.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.vm.hardware.boot.DeviceTypes

DeviceTypes.Entry, DeviceTypes.EntryCreateSpec, DeviceTypes.Type

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<DeviceTypes.Entry>	get(java.lang.String vm) Returns an ordered list of boot devices for the virtual machine.
void	get(java.lang.String vm, AsyncCallback<java.util.List<DeviceTypes.Entry>> asyncCallback) Returns an ordered list of boot devices for the virtual machine.
void	get(java.lang.String vm, AsyncCallback<java.util.List<DeviceTypes.Entry>> asyncCallback, InvocationConfig invocationConfig) Returns an ordered list of boot devices for the virtual machine.
java.util.List<DeviceTypes.Entry>	get(java.lang.String vm, InvocationConfig invocationConfig) Returns an ordered list of boot devices for the virtual machine.
void	set(java.lang.String vm, java.util.List<DeviceTypes.Entry> devices) Sets the virtual devices that will be used to boot the virtual machine.
void	set(java.lang.String vm, java.util.List<DeviceTypes.Entry> devices, AsyncCallback<java.lang.Void> asyncCallback) Sets the virtual devices that will be used to boot the virtual machine.
void	set(java.lang.String vm, java.util.List<DeviceTypes.Entry> devices, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Sets the virtual devices that will be used to boot the virtual machine.
void	set(java.lang.String vm, java.util.List<DeviceTypes.Entry> devices, InvocationConfig invocationConfig) Sets the virtual devices that will be used to boot the virtual machine.

Method Detail

get

java.util.List<DeviceTypes.Entry> get(java.lang.String vm)

Returns an ordered list of boot devices for the virtual machine. If the List is empty, the virtual machine uses a default boot sequence.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

Returns:

Ordered list of configured boot devices.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the virtual machine is not found.

ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

get

java.util.List<DeviceTypes.Entry> get(java.lang.String vm,
                                    InvocationConfig invocationConfig)

Returns an ordered list of boot devices for the virtual machine. If the List is empty, the virtual machine uses a default boot sequence.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

invocationConfig - Configuration for the method invocation.

Returns:

Ordered list of configured boot devices.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the virtual machine is not found.

ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

get

void get(java.lang.String vm,
       AsyncCallback<java.util.List<DeviceTypes.Entry>> asyncCallback)

Returns an ordered list of boot devices for the virtual machine. If the List is empty, the virtual machine uses a default boot sequence.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Result:
Ordered list of configured boot devices.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(java.lang.String vm,
       AsyncCallback<java.util.List<DeviceTypes.Entry>> asyncCallback,
       InvocationConfig invocationConfig)

Returns an ordered list of boot devices for the virtual machine. If the List is empty, the virtual machine uses a default boot sequence.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
Ordered list of configured boot devices.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

set

void set(java.lang.String vm,
       java.util.List<DeviceTypes.Entry> devices)

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 DeviceTypes.Entry for a given device type except DeviceTypes.Type.ETHERNET in the List.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

devices - Ordered list of boot devices.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the virtual machine is not found, or if any of the specified virtual devices is not found.

InvalidArgument - if a any of the CDROM, DISK, ETHERNET, FLOPPY values appears in more than one Entry with the exception of DeviceTypes.Type.ETHERNET, which may appear multiple times if the virtual machine has been configured with multiple Ethernet adapters.

ResourceBusy - if the virtual machine is busy performing another operation.

ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

set

void set(java.lang.String vm,
       java.util.List<DeviceTypes.Entry> devices,
       InvocationConfig invocationConfig)

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 DeviceTypes.Entry for a given device type except DeviceTypes.Type.ETHERNET in the List.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

devices - Ordered list of boot devices.

invocationConfig - Configuration for the method invocation.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the virtual machine is not found, or if any of the specified virtual devices is not found.

InvalidArgument - if a any of the CDROM, DISK, ETHERNET, FLOPPY values appears in more than one Entry with the exception of DeviceTypes.Type.ETHERNET, which may appear multiple times if the virtual machine has been configured with multiple Ethernet adapters.

ResourceBusy - if the virtual machine is busy performing another operation.

ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

set

void set(java.lang.String vm,
       java.util.List<DeviceTypes.Entry> devices,
       AsyncCallback<java.lang.Void> asyncCallback)

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 DeviceTypes.Entry for a given device type except DeviceTypes.Type.ETHERNET in the List.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found, or if any of the specified virtual devices is not found.
InvalidArgument - if a any of the CDROM, DISK, ETHERNET, FLOPPY values appears in more than one Entry with the exception of DeviceTypes.Type.ETHERNET, which may appear multiple times if the virtual machine has been configured with multiple Ethernet adapters.
ResourceBusy - if the virtual machine is busy performing another operation.
ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

devices - Ordered list of boot devices.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

set

void set(java.lang.String vm,
       java.util.List<DeviceTypes.Entry> devices,
       AsyncCallback<java.lang.Void> asyncCallback,
       InvocationConfig invocationConfig)

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 DeviceTypes.Entry for a given device type except DeviceTypes.Type.ETHERNET in the List.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found, or if any of the specified virtual devices is not found.
InvalidArgument - if a any of the CDROM, DISK, ETHERNET, FLOPPY values appears in more than one Entry with the exception of DeviceTypes.Type.ETHERNET, which may appear multiple times if the virtual machine has been configured with multiple Ethernet adapters.
ResourceBusy - if the virtual machine is busy performing another operation.
ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

devices - Ordered list of boot devices.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.