/Classes/VBD

Classes / VBD / index.html

A virtual block device

Fields

string uuid
Unique identifier/object reference
Set[enum vbd_operations] allowed_operations
list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.
Map[string,enum vbd_operations] current_operations
links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.
VM VM
the virtual machine
VDI VDI
the virtual disk
string device
device seen by the guest e.g. hda1
string userdevice
user-friendly device name e.g. 0,1,2,etc.
bool bootable
true if this VBD is bootable
enum vbd_mode mode
the mode the VBD should be mounted with
enum vbd_type type
how the VBD will appear to the guest (e.g. disk or CD)
bool unpluggable
true if this VBD will support hot-unplug
bool storage_lock
true if a storage level lock was acquired
bool empty
if true this represents an empty drive
bool reserved
true if the VBD is reserved pending a reboot/migrate
Map[string,string] other_config
additional configuration
bool currently_attached
is the device currently attached (erased on reboot)
int status_code
error/success code associated with last attach-operation (erased on reboot)
string status_detail
error/success information associated with last attach-operation status (erased on reboot)
Map[string,string] runtime_properties
Device runtime properties
string qos_algorithm_type
QoS algorithm to use
Map[string,string] qos_algorithm_params
parameters for chosen QoS algorithm
Set[string] qos_supported_algorithms
supported QoS algorithms for this VBD
VBD_metrics metrics
metrics associated with this VBD

Implicit messages

Record[VBD] get_record (session session_id, VBD self)
Get a record containing the current state of the given VBD.
VBD get_by_uuid (session session_id, string uuid)
Get a reference to the VBD instance with the specified UUID.
VBD create (session session_id, VM VM, VDI VDI, string userdevice, bool bootable, enum vbd_mode mode, enum vbd_type type, bool unpluggable, bool empty, Map[string,string] other_config, string qos_algorithm_type, Map[string,string] qos_algorithm_params)
Create a new VBD instance, and return its handle.
void destroy (session session_id, VBD self)
Destroy the specified VBD instance.
Set[VBD] get_all (session session_id)
Return a list of all the VBDs known to the system.
Map[VBD,Record[VBD]] get_all_records (session session_id)
Return a map of VBD references to VBD records for all VBDs known to the system.

Explicit messages

void eject (session session_id, VBD vbd)
Remove the media from the device and leave it empty
void insert (session session_id, VBD vbd, VDI vdi)
Insert new media into the device
void plug (session session_id, VBD self)
Hotplug the specified VBD, dynamically attaching it to the running VM
void unplug (session session_id, VBD self)
Hot-unplug the specified VBD, dynamically unattaching it from the running VM
void unplug_force (session session_id, VBD self)
Forcibly unplug the specified VBD
void assert_attachable (session session_id, VBD self)
Throws an error if this VBD could not be attached to this VM if the VM were running. Intended for debugging.