View Source XenAPI.VBD (XenAPI v0.1.2)
Link to this section Summary
Functions
Add the given key-value pair to the other_config field of the given VBD.
Add the given key-value pair to the other_config field of the given VBD. (Raise error on XMLRPC failure)
Add the given key-value pair to the qos/algorithm_params field of the given VBD.
Add the given key-value pair to the qos/algorithm_params field of the given VBD. (Raise error on XMLRPC failure)
Throws an error if this VBD could not be attached to this VM if the VM were running. Intended for debugging.
Throws an error if this VBD could not be attached to this VM if the VM were running. Intended for debugging. (Raise error on XMLRPC failure)
Create a new VBD instance, and return its handle. The constructor args are: VM, VDI, userdevice, bootable, mode, type, unpluggable, empty, other_config, qos_algorithm_type, qos_algorithm_params (* = non-optional).
Create a new VBD instance, and return its handle. The constructor args are: VM, VDI, userdevice, bootable, mode, type, unpluggable, empty, other_config, qos_algorithm_type, qos_algorithm_params (* = non-optional). (Raise error on XMLRPC failure)
Destroy the specified VBD instance.
Destroy the specified VBD instance. (Raise error on XMLRPC failure)
Remove the media from the device and leave it empty
Remove the media from the device and leave it empty (Raise error on XMLRPC failure)
Return a list of all the VBDs known to the system.
Return a list of all the VBDs known to the system. (Raise error on XMLRPC failure)
Return a map of VBD references to VBD records for all VBDs known to the system.
Return a map of VBD references to VBD records for all VBDs known to the system. (Raise error on XMLRPC failure)
Get the allowed_operations field of the given VBD.
Get the allowed_operations field of the given VBD. (Raise error on XMLRPC failure)
Get the bootable field of the given VBD.
Get the bootable field of the given VBD. (Raise error on XMLRPC failure)
Get a reference to the VBD instance with the specified UUID.
Get a reference to the VBD instance with the specified UUID. (Raise error on XMLRPC failure)
Get the current_operations field of the given VBD.
Get the current_operations field of the given VBD. (Raise error on XMLRPC failure)
Get the currently_attached field of the given VBD.
Get the currently_attached field of the given VBD. (Raise error on XMLRPC failure)
Get the device field of the given VBD.
Get the device field of the given VBD. (Raise error on XMLRPC failure)
Get the empty field of the given VBD.
Get the empty field of the given VBD. (Raise error on XMLRPC failure)
Get the metrics field of the given VBD.
Get the metrics field of the given VBD. (Raise error on XMLRPC failure)
Get the mode field of the given VBD.
Get the mode field of the given VBD. (Raise error on XMLRPC failure)
Get the other_config field of the given VBD.
Get the other_config field of the given VBD. (Raise error on XMLRPC failure)
Get the qos/algorithm_params field of the given VBD.
Get the qos/algorithm_params field of the given VBD. (Raise error on XMLRPC failure)
Get the qos/algorithm_type field of the given VBD.
Get the qos/algorithm_type field of the given VBD. (Raise error on XMLRPC failure)
Get the qos/supported_algorithms field of the given VBD.
Get the qos/supported_algorithms field of the given VBD. (Raise error on XMLRPC failure)
Get a record containing the current state of the given VBD.
Get a record containing the current state of the given VBD. (Raise error on XMLRPC failure)
Get the runtime_properties field of the given VBD.
Get the runtime_properties field of the given VBD. (Raise error on XMLRPC failure)
Get the status_code field of the given VBD.
Get the status_code field of the given VBD. (Raise error on XMLRPC failure)
Get the status_detail field of the given VBD.
Get the status_detail field of the given VBD. (Raise error on XMLRPC failure)
Get the storage_lock field of the given VBD.
Get the storage_lock field of the given VBD. (Raise error on XMLRPC failure)
Get the type field of the given VBD.
Get the type field of the given VBD. (Raise error on XMLRPC failure)
Get the unpluggable field of the given VBD.
Get the unpluggable field of the given VBD. (Raise error on XMLRPC failure)
Get the userdevice field of the given VBD.
Get the userdevice field of the given VBD. (Raise error on XMLRPC failure)
Get the uuid field of the given VBD.
Get the uuid field of the given VBD. (Raise error on XMLRPC failure)
Get the VDI field of the given VBD.
Get the VDI field of the given VBD. (Raise error on XMLRPC failure)
Get the VM field of the given VBD.
Get the VM field of the given VBD. (Raise error on XMLRPC failure)
Insert new media into the device
Insert new media into the device (Raise error on XMLRPC failure)
Hotplug the specified VBD, dynamically attaching it to the running VM
Hotplug the specified VBD, dynamically attaching it to the running VM (Raise error on XMLRPC failure)
Remove the given key and its corresponding value from the other_config field of the given VBD. If the key is not in that Map, then do nothing.
Remove the given key and its corresponding value from the other_config field of the given VBD. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)
Remove the given key and its corresponding value from the qos/algorithm_params field of the given VBD. If the key is not in that Map, then do nothing.
Remove the given key and its corresponding value from the qos/algorithm_params field of the given VBD. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)
Set the bootable field of the given VBD.
Set the bootable field of the given VBD. (Raise error on XMLRPC failure)
Sets the mode of the VBD. The power_state of the VM must be halted.
Sets the mode of the VBD. The power_state of the VM must be halted. (Raise error on XMLRPC failure)
Set the other_config field of the given VBD.
Set the other_config field of the given VBD. (Raise error on XMLRPC failure)
Set the qos/algorithm_params field of the given VBD.
Set the qos/algorithm_params field of the given VBD. (Raise error on XMLRPC failure)
Set the qos/algorithm_type field of the given VBD.
Set the qos/algorithm_type field of the given VBD. (Raise error on XMLRPC failure)
Set the type field of the given VBD.
Set the type field of the given VBD. (Raise error on XMLRPC failure)
Set the unpluggable field of the given VBD.
Set the unpluggable field of the given VBD. (Raise error on XMLRPC failure)
Set the userdevice field of the given VBD.
Set the userdevice field of the given VBD. (Raise error on XMLRPC failure)
Hot-unplug the specified VBD, dynamically unattaching it from the running VM
Hot-unplug the specified VBD, dynamically unattaching it from the running VM (Raise error on XMLRPC failure)
Forcibly unplug the specified VBD
Forcibly unplug the specified VBD (Raise error on XMLRPC failure)
Link to this section Functions
Add the given key-value pair to the other_config field of the given VBD.
Add the given key-value pair to the other_config field of the given VBD. (Raise error on XMLRPC failure)
Add the given key-value pair to the qos/algorithm_params field of the given VBD.
Add the given key-value pair to the qos/algorithm_params field of the given VBD. (Raise error on XMLRPC failure)
Throws an error if this VBD could not be attached to this VM if the VM were running. Intended for debugging.
Throws an error if this VBD could not be attached to this VM if the VM were running. Intended for debugging. (Raise error on XMLRPC failure)
Create a new VBD instance, and return its handle. The constructor args are: VM, VDI, userdevice, bootable, mode, type, unpluggable, empty, other_config, qos_algorithm_type, qos_algorithm_params (* = non-optional).
Create a new VBD instance, and return its handle. The constructor args are: VM, VDI, userdevice, bootable, mode, type, unpluggable, empty, other_config, qos_algorithm_type, qos_algorithm_params (* = non-optional). (Raise error on XMLRPC failure)
Destroy the specified VBD instance.
Destroy the specified VBD instance. (Raise error on XMLRPC failure)
Remove the media from the device and leave it empty
Remove the media from the device and leave it empty (Raise error on XMLRPC failure)
Return a list of all the VBDs known to the system.
Return a list of all the VBDs known to the system. (Raise error on XMLRPC failure)
Return a map of VBD references to VBD records for all VBDs known to the system.
Return a map of VBD references to VBD records for all VBDs known to the system. (Raise error on XMLRPC failure)
Get the allowed_operations field of the given VBD.
Get the allowed_operations field of the given VBD. (Raise error on XMLRPC failure)
Get the bootable field of the given VBD.
Get the bootable field of the given VBD. (Raise error on XMLRPC failure)
Get a reference to the VBD instance with the specified UUID.
Get a reference to the VBD instance with the specified UUID. (Raise error on XMLRPC failure)
Get the current_operations field of the given VBD.
Get the current_operations field of the given VBD. (Raise error on XMLRPC failure)
Get the currently_attached field of the given VBD.
Get the currently_attached field of the given VBD. (Raise error on XMLRPC failure)
Get the device field of the given VBD.
Get the device field of the given VBD. (Raise error on XMLRPC failure)
Get the empty field of the given VBD.
Get the empty field of the given VBD. (Raise error on XMLRPC failure)
Get the metrics field of the given VBD.
Get the metrics field of the given VBD. (Raise error on XMLRPC failure)
Get the mode field of the given VBD.
Get the mode field of the given VBD. (Raise error on XMLRPC failure)
Get the other_config field of the given VBD.
Get the other_config field of the given VBD. (Raise error on XMLRPC failure)
Get the qos/algorithm_params field of the given VBD.
Get the qos/algorithm_params field of the given VBD. (Raise error on XMLRPC failure)
Get the qos/algorithm_type field of the given VBD.
Get the qos/algorithm_type field of the given VBD. (Raise error on XMLRPC failure)
Get the qos/supported_algorithms field of the given VBD.
Get the qos/supported_algorithms field of the given VBD. (Raise error on XMLRPC failure)
Get a record containing the current state of the given VBD.
Get a record containing the current state of the given VBD. (Raise error on XMLRPC failure)
Get the runtime_properties field of the given VBD.
Get the runtime_properties field of the given VBD. (Raise error on XMLRPC failure)
Get the status_code field of the given VBD.
Get the status_code field of the given VBD. (Raise error on XMLRPC failure)
Get the status_detail field of the given VBD.
Get the status_detail field of the given VBD. (Raise error on XMLRPC failure)
Get the storage_lock field of the given VBD.
Get the storage_lock field of the given VBD. (Raise error on XMLRPC failure)
Get the type field of the given VBD.
Get the type field of the given VBD. (Raise error on XMLRPC failure)
Get the unpluggable field of the given VBD.
Get the unpluggable field of the given VBD. (Raise error on XMLRPC failure)
Get the userdevice field of the given VBD.
Get the userdevice field of the given VBD. (Raise error on XMLRPC failure)
Get the uuid field of the given VBD.
Get the uuid field of the given VBD. (Raise error on XMLRPC failure)
Get the VDI field of the given VBD.
Get the VDI field of the given VBD. (Raise error on XMLRPC failure)
Get the VM field of the given VBD.
Get the VM field of the given VBD. (Raise error on XMLRPC failure)
Insert new media into the device
Insert new media into the device (Raise error on XMLRPC failure)
Hotplug the specified VBD, dynamically attaching it to the running VM
Hotplug the specified VBD, dynamically attaching it to the running VM (Raise error on XMLRPC failure)
Remove the given key and its corresponding value from the other_config field of the given VBD. If the key is not in that Map, then do nothing.
Remove the given key and its corresponding value from the other_config field of the given VBD. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)
Remove the given key and its corresponding value from the qos/algorithm_params field of the given VBD. If the key is not in that Map, then do nothing.
Remove the given key and its corresponding value from the qos/algorithm_params field of the given VBD. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)
Set the bootable field of the given VBD.
Set the bootable field of the given VBD. (Raise error on XMLRPC failure)
Sets the mode of the VBD. The power_state of the VM must be halted.
Sets the mode of the VBD. The power_state of the VM must be halted. (Raise error on XMLRPC failure)
Set the other_config field of the given VBD.
Set the other_config field of the given VBD. (Raise error on XMLRPC failure)
Set the qos/algorithm_params field of the given VBD.
Set the qos/algorithm_params field of the given VBD. (Raise error on XMLRPC failure)
Set the qos/algorithm_type field of the given VBD.
Set the qos/algorithm_type field of the given VBD. (Raise error on XMLRPC failure)
Set the type field of the given VBD.
Set the type field of the given VBD. (Raise error on XMLRPC failure)
Set the unpluggable field of the given VBD.
Set the unpluggable field of the given VBD. (Raise error on XMLRPC failure)
Set the userdevice field of the given VBD.
Set the userdevice field of the given VBD. (Raise error on XMLRPC failure)
Hot-unplug the specified VBD, dynamically unattaching it from the running VM
Hot-unplug the specified VBD, dynamically unattaching it from the running VM (Raise error on XMLRPC failure)
Forcibly unplug the specified VBD
Forcibly unplug the specified VBD (Raise error on XMLRPC failure)