VBD

java.lang.Object
- com.xensource.xenapi.XenAPIObject
- - com.xensource.xenapi.VBD

```
public class VBD
extends XenAPIObject
```
A virtual block device First published in XenServer 4.0.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VBD.Record
Represents all the fields in a VBD

Nested Classes
Modifier and Type	Class and Description
`static class`	`VBD.Record` Represents all the fields in a VBD

Field Summary

Fields
Modifier and Type Field and Description

protected java.lang.String ref
The XenAPI reference (OpaqueRef) to this object.

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`ref` The XenAPI reference (OpaqueRef) to this object.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addToOtherConfig(Connection c, java.lang.String key, java.lang.String value)` Add the given key-value pair to the other_config field of the given VBD.
`void`	`addToQosAlgorithmParams(Connection c, java.lang.String key, java.lang.String value)` Add the given key-value pair to the qos/algorithm_params field of the given VBD.
`void`	`assertAttachable(Connection c)` Throws an error if this VBD could not be attached to this VM if the VM were running.
`Task`	`assertAttachableAsync(Connection c)` Throws an error if this VBD could not be attached to this VM if the VM were running.
`static VBD`	`create(Connection c, VBD.Record record)` Create a new VBD instance, and return its handle.
`static Task`	`createAsync(Connection c, VBD.Record record)` Create a new VBD instance, and return its handle.
`void`	`destroy(Connection c)` Destroy the specified VBD instance.
`Task`	`destroyAsync(Connection c)` Destroy the specified VBD instance.
`void`	`eject(Connection c)` Remove the media from the device and leave it empty First published in XenServer 4.0.
`Task`	`ejectAsync(Connection c)` Remove the media from the device and leave it empty First published in XenServer 4.0.
`boolean`	`equals(java.lang.Object obj)` If obj is a VBD, compares XenAPI references for equality.
`static java.util.Set<VBD>`	`getAll(Connection c)` Return a list of all the VBDs known to the system.
`java.util.Set<Types.VbdOperations>`	`getAllowedOperations(Connection c)` Get the allowed_operations field of the given VBD.
`static java.util.Map<VBD,VBD.Record>`	`getAllRecords(Connection c)` Return a map of VBD references to VBD records for all VBDs known to the system.
`java.lang.Boolean`	`getBootable(Connection c)` Get the bootable field of the given VBD.
`static VBD`	`getByUuid(Connection c, java.lang.String uuid)` Get a reference to the VBD instance with the specified UUID.
`java.lang.Boolean`	`getCurrentlyAttached(Connection c)` Get the currently_attached field of the given VBD.
`java.util.Map<java.lang.String,Types.VbdOperations>`	`getCurrentOperations(Connection c)` Get the current_operations field of the given VBD.
`java.lang.String`	`getDevice(Connection c)` Get the device field of the given VBD.
`java.lang.Boolean`	`getEmpty(Connection c)` Get the empty field of the given VBD.
`VBDMetrics`	`getMetrics(Connection c)` Get the metrics field of the given VBD.
`Types.VbdMode`	`getMode(Connection c)` Get the mode field of the given VBD.
`java.util.Map<java.lang.String,java.lang.String>`	`getOtherConfig(Connection c)` Get the other_config field of the given VBD.
`java.util.Map<java.lang.String,java.lang.String>`	`getQosAlgorithmParams(Connection c)` Get the qos/algorithm_params field of the given VBD.
`java.lang.String`	`getQosAlgorithmType(Connection c)` Get the qos/algorithm_type field of the given VBD.
`java.util.Set<java.lang.String>`	`getQosSupportedAlgorithms(Connection c)` Get the qos/supported_algorithms field of the given VBD.
`VBD.Record`	`getRecord(Connection c)` Get a record containing the current state of the given VBD.
`java.util.Map<java.lang.String,java.lang.String>`	`getRuntimeProperties(Connection c)` Get the runtime_properties field of the given VBD.
`java.lang.Long`	`getStatusCode(Connection c)` Get the status_code field of the given VBD.
`java.lang.String`	`getStatusDetail(Connection c)` Get the status_detail field of the given VBD.
`java.lang.Boolean`	`getStorageLock(Connection c)` Get the storage_lock field of the given VBD.
`Types.VbdType`	`getType(Connection c)` Get the type field of the given VBD.
`java.lang.Boolean`	`getUnpluggable(Connection c)` Get the unpluggable field of the given VBD.
`java.lang.String`	`getUserdevice(Connection c)` Get the userdevice field of the given VBD.
`java.lang.String`	`getUuid(Connection c)` Get the uuid field of the given VBD.
`VDI`	`getVDI(Connection c)` Get the VDI field of the given VBD.
`VM`	`getVM(Connection c)` Get the VM field of the given VBD.
`int`	`hashCode()`
`void`	`insert(Connection c, VDI vdi)` Insert new media into the device First published in XenServer 4.0.
`Task`	`insertAsync(Connection c, VDI vdi)` Insert new media into the device First published in XenServer 4.0.
`void`	`plug(Connection c)` Hotplug the specified VBD, dynamically attaching it to the running VM First published in XenServer 4.0.
`Task`	`plugAsync(Connection c)` Hotplug the specified VBD, dynamically attaching it to the running VM First published in XenServer 4.0.
`void`	`removeFromOtherConfig(Connection c, java.lang.String key)` Remove the given key and its corresponding value from the other_config field of the given VBD.
`void`	`removeFromQosAlgorithmParams(Connection c, java.lang.String key)` Remove the given key and its corresponding value from the qos/algorithm_params field of the given VBD.
`void`	`setBootable(Connection c, java.lang.Boolean bootable)` Set the bootable field of the given VBD.
`void`	`setMode(Connection c, Types.VbdMode value)` Sets the mode of the VBD.
`Task`	`setModeAsync(Connection c, Types.VbdMode value)` Sets the mode of the VBD.
`void`	`setOtherConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> otherConfig)` Set the other_config field of the given VBD.
`void`	`setQosAlgorithmParams(Connection c, java.util.Map<java.lang.String,java.lang.String> algorithmParams)` Set the qos/algorithm_params field of the given VBD.
`void`	`setQosAlgorithmType(Connection c, java.lang.String algorithmType)` Set the qos/algorithm_type field of the given VBD.
`void`	`setType(Connection c, Types.VbdType type)` Set the type field of the given VBD.
`void`	`setUnpluggable(Connection c, java.lang.Boolean unpluggable)` Set the unpluggable field of the given VBD.
`void`	`setUserdevice(Connection c, java.lang.String userdevice)` Set the userdevice field of the given VBD.
`java.lang.String`	`toWireString()`
`void`	`unplug(Connection c)` Hot-unplug the specified VBD, dynamically unattaching it from the running VM First published in XenServer 4.0.
`Task`	`unplugAsync(Connection c)` Hot-unplug the specified VBD, dynamically unattaching it from the running VM First published in XenServer 4.0.
`void`	`unplugForce(Connection c)` Forcibly unplug the specified VBD First published in XenServer 4.0.
`Task`	`unplugForceAsync(Connection c)` Forcibly unplug the specified VBD First published in XenServer 4.0.

Methods inherited from class com.xensource.xenapi.XenAPIObject
isNull

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail
- ref
```
protected final java.lang.String ref
```
  The XenAPI reference (OpaqueRef) to this object.

Method Detail

toWireString
```
public java.lang.String toWireString()
```
Specified by:

toWireString in class XenAPIObject

Returns:
The XenAPI reference (OpaqueRef) to this object.

equals
```
public boolean equals(java.lang.Object obj)
```
If obj is a VBD, compares XenAPI references for equality.

Overrides:

equals in class java.lang.Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

getRecord

public VBD.Record getRecord(Connection c)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException

Get a record containing the current state of the given VBD. First published in XenServer 4.0.

Returns:: all fields from the object
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getByUuid

public static VBD getByUuid(Connection c,
            java.lang.String uuid)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException

Get a reference to the VBD instance with the specified UUID. First published in XenServer 4.0.

Parameters:: uuid - UUID of object to return
Returns:: reference to the object
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

createAsync

public static Task createAsync(Connection c,
               VBD.Record record)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException

Create a new VBD instance, and return its handle. First published in XenServer 4.0.

Parameters:: record - All constructor arguments
Returns:: Task
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

create

public static VBD create(Connection c,
         VBD.Record record)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException

Create a new VBD instance, and return its handle. First published in XenServer 4.0.

Parameters:: record - All constructor arguments
Returns:: reference to the newly created object
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

destroyAsync

public Task destroyAsync(Connection c)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException

Destroy the specified VBD instance. First published in XenServer 4.0.

Returns:: Task
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

destroy

public void destroy(Connection c)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException

Destroy the specified VBD instance. First published in XenServer 4.0.

Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getUuid

public java.lang.String getUuid(Connection c)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException

Get the uuid field of the given VBD. First published in XenServer 4.0.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getAllowedOperations

public java.util.Set<Types.VbdOperations> getAllowedOperations(Connection c)
                                                        throws Types.BadServerResponse,
                                                               Types.XenAPIException,
                                                               org.apache.xmlrpc.XmlRpcException

Get the allowed_operations field of the given VBD. First published in XenServer 4.0.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getCurrentOperations

public java.util.Map<java.lang.String,Types.VbdOperations> getCurrentOperations(Connection c)
                                                                         throws Types.BadServerResponse,
                                                                                Types.XenAPIException,
                                                                                org.apache.xmlrpc.XmlRpcException

Get the current_operations field of the given VBD. First published in XenServer 4.0.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getVM

public VM getVM(Connection c)
         throws Types.BadServerResponse,
                Types.XenAPIException,
                org.apache.xmlrpc.XmlRpcException

Get the VM field of the given VBD. First published in XenServer 4.0.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getVDI

public VDI getVDI(Connection c)
           throws Types.BadServerResponse,
                  Types.XenAPIException,
                  org.apache.xmlrpc.XmlRpcException

Get the VDI field of the given VBD. First published in XenServer 4.0.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getDevice

public java.lang.String getDevice(Connection c)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException

Get the device field of the given VBD. First published in XenServer 4.0.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getUserdevice

public java.lang.String getUserdevice(Connection c)
                               throws Types.BadServerResponse,
                                      Types.XenAPIException,
                                      org.apache.xmlrpc.XmlRpcException

Get the userdevice field of the given VBD. First published in XenServer 4.0.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getBootable

public java.lang.Boolean getBootable(Connection c)
                              throws Types.BadServerResponse,
                                     Types.XenAPIException,
                                     org.apache.xmlrpc.XmlRpcException

Get the bootable field of the given VBD. First published in XenServer 4.0.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getMode

public Types.VbdMode getMode(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Get the mode field of the given VBD. First published in XenServer 4.0.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getType

public Types.VbdType getType(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Get the type field of the given VBD. First published in XenServer 4.0.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getUnpluggable

public java.lang.Boolean getUnpluggable(Connection c)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException

Get the unpluggable field of the given VBD. First published in XenServer 4.1.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getStorageLock

public java.lang.Boolean getStorageLock(Connection c)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException

Get the storage_lock field of the given VBD. First published in XenServer 4.0.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getEmpty

public java.lang.Boolean getEmpty(Connection c)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException

Get the empty field of the given VBD. First published in XenServer 4.0.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getOtherConfig

public java.util.Map<java.lang.String,java.lang.String> getOtherConfig(Connection c)
                                                                throws Types.BadServerResponse,
                                                                       Types.XenAPIException,
                                                                       org.apache.xmlrpc.XmlRpcException

Get the other_config field of the given VBD. First published in XenServer 4.0.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getCurrentlyAttached

public java.lang.Boolean getCurrentlyAttached(Connection c)
                                       throws Types.BadServerResponse,
                                              Types.XenAPIException,
                                              org.apache.xmlrpc.XmlRpcException

Get the currently_attached field of the given VBD. First published in XenServer 4.0.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getStatusCode

public java.lang.Long getStatusCode(Connection c)
                             throws Types.BadServerResponse,
                                    Types.XenAPIException,
                                    org.apache.xmlrpc.XmlRpcException

Get the status_code field of the given VBD. First published in XenServer 4.0.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getStatusDetail

public java.lang.String getStatusDetail(Connection c)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException

Get the status_detail field of the given VBD. First published in XenServer 4.0.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getRuntimeProperties

public java.util.Map<java.lang.String,java.lang.String> getRuntimeProperties(Connection c)
                                                                      throws Types.BadServerResponse,
                                                                             Types.XenAPIException,
                                                                             org.apache.xmlrpc.XmlRpcException

Get the runtime_properties field of the given VBD. First published in XenServer 4.0.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getQosAlgorithmType

public java.lang.String getQosAlgorithmType(Connection c)
                                     throws Types.BadServerResponse,
                                            Types.XenAPIException,
                                            org.apache.xmlrpc.XmlRpcException

Get the qos/algorithm_type field of the given VBD. First published in XenServer 4.0.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getQosAlgorithmParams

public java.util.Map<java.lang.String,java.lang.String> getQosAlgorithmParams(Connection c)
                                                                       throws Types.BadServerResponse,
                                                                              Types.XenAPIException,
                                                                              org.apache.xmlrpc.XmlRpcException

Get the qos/algorithm_params field of the given VBD. First published in XenServer 4.0.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getQosSupportedAlgorithms

public java.util.Set<java.lang.String> getQosSupportedAlgorithms(Connection c)
                                                          throws Types.BadServerResponse,
                                                                 Types.XenAPIException,
                                                                 org.apache.xmlrpc.XmlRpcException

Get the qos/supported_algorithms field of the given VBD. First published in XenServer 4.0.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getMetrics

public VBDMetrics getMetrics(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Get the metrics field of the given VBD. First published in XenServer 4.0.

Returns:: value of the field
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

setUserdevice

public void setUserdevice(Connection c,
                 java.lang.String userdevice)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException

Set the userdevice field of the given VBD. First published in XenServer 4.0.

Parameters:: userdevice - New value to set
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

setBootable

public void setBootable(Connection c,
               java.lang.Boolean bootable)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException

Set the bootable field of the given VBD. First published in XenServer 4.0.

Parameters:: bootable - New value to set
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

setType

public void setType(Connection c,
           Types.VbdType type)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException

Set the type field of the given VBD. First published in XenServer 4.0.

Parameters:: type - New value to set
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

setUnpluggable

public void setUnpluggable(Connection c,
                  java.lang.Boolean unpluggable)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException

Set the unpluggable field of the given VBD. First published in XenServer 4.1.

Parameters:: unpluggable - New value to set
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

setOtherConfig

public void setOtherConfig(Connection c,
                  java.util.Map<java.lang.String,java.lang.String> otherConfig)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException

Set the other_config field of the given VBD. First published in XenServer 4.0.

Parameters:: otherConfig - New value to set
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

addToOtherConfig

public void addToOtherConfig(Connection c,
                    java.lang.String key,
                    java.lang.String value)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Add the given key-value pair to the other_config field of the given VBD. First published in XenServer 4.0.

Parameters:: key - Key to add; value - Value to add
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

removeFromOtherConfig

public void removeFromOtherConfig(Connection c,
                         java.lang.String key)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException

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. First published in XenServer 4.0.

Parameters:: key - Key to remove
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

setQosAlgorithmType

public void setQosAlgorithmType(Connection c,
                       java.lang.String algorithmType)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException

Set the qos/algorithm_type field of the given VBD. First published in XenServer 4.0.

Parameters:: algorithmType - New value to set
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

setQosAlgorithmParams

public void setQosAlgorithmParams(Connection c,
                         java.util.Map<java.lang.String,java.lang.String> algorithmParams)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException

Set the qos/algorithm_params field of the given VBD. First published in XenServer 4.0.

Parameters:: algorithmParams - New value to set
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

addToQosAlgorithmParams

public void addToQosAlgorithmParams(Connection c,
                           java.lang.String key,
                           java.lang.String value)
                             throws Types.BadServerResponse,
                                    Types.XenAPIException,
                                    org.apache.xmlrpc.XmlRpcException

Add the given key-value pair to the qos/algorithm_params field of the given VBD. First published in XenServer 4.0.

Parameters:: key - Key to add; value - Value to add
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

removeFromQosAlgorithmParams

public void removeFromQosAlgorithmParams(Connection c,
                                java.lang.String key)
                                  throws Types.BadServerResponse,
                                         Types.XenAPIException,
                                         org.apache.xmlrpc.XmlRpcException

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. First published in XenServer 4.0.

Parameters:: key - Key to remove
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

ejectAsync

public Task ejectAsync(Connection c)
                throws Types.BadServerResponse,
                       Types.XenAPIException,
                       org.apache.xmlrpc.XmlRpcException,
                       Types.VbdNotRemovableMedia,
                       Types.VbdIsEmpty

Remove the media from the device and leave it empty First published in XenServer 4.0.

Returns:: Task
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException; Types.VbdNotRemovableMedia; Types.VbdIsEmpty

eject

public void eject(Connection c)
           throws Types.BadServerResponse,
                  Types.XenAPIException,
                  org.apache.xmlrpc.XmlRpcException,
                  Types.VbdNotRemovableMedia,
                  Types.VbdIsEmpty

Remove the media from the device and leave it empty First published in XenServer 4.0.

Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException; Types.VbdNotRemovableMedia; Types.VbdIsEmpty

insertAsync

public Task insertAsync(Connection c,
               VDI vdi)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException,
                        Types.VbdNotRemovableMedia,
                        Types.VbdNotEmpty

Insert new media into the device First published in XenServer 4.0.

Parameters:: vdi - The new VDI to 'insert'
Returns:: Task
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException; Types.VbdNotRemovableMedia; Types.VbdNotEmpty

insert

public void insert(Connection c,
          VDI vdi)
            throws Types.BadServerResponse,
                   Types.XenAPIException,
                   org.apache.xmlrpc.XmlRpcException,
                   Types.VbdNotRemovableMedia,
                   Types.VbdNotEmpty

Insert new media into the device First published in XenServer 4.0.

Parameters:: vdi - The new VDI to 'insert'
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException; Types.VbdNotRemovableMedia; Types.VbdNotEmpty

plugAsync

public Task plugAsync(Connection c)
               throws Types.BadServerResponse,
                      Types.XenAPIException,
                      org.apache.xmlrpc.XmlRpcException

Hotplug the specified VBD, dynamically attaching it to the running VM First published in XenServer 4.0.

Returns:: Task
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

plug
```
public void plug(Connection c)
          throws Types.BadServerResponse,
                 Types.XenAPIException,
                 org.apache.xmlrpc.XmlRpcException
```
Hotplug the specified VBD, dynamically attaching it to the running VM First published in XenServer 4.0.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

unplugAsync

public Task unplugAsync(Connection c)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException,
                        Types.DeviceDetachRejected,
                        Types.DeviceAlreadyDetached

Hot-unplug the specified VBD, dynamically unattaching it from the running VM First published in XenServer 4.0.

Returns:: Task
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException; Types.DeviceDetachRejected; Types.DeviceAlreadyDetached

unplug

public void unplug(Connection c)
            throws Types.BadServerResponse,
                   Types.XenAPIException,
                   org.apache.xmlrpc.XmlRpcException,
                   Types.DeviceDetachRejected,
                   Types.DeviceAlreadyDetached

Hot-unplug the specified VBD, dynamically unattaching it from the running VM First published in XenServer 4.0.

Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException; Types.DeviceDetachRejected; Types.DeviceAlreadyDetached

unplugForceAsync

public Task unplugForceAsync(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Forcibly unplug the specified VBD First published in XenServer 4.0.

Returns:: Task
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

unplugForce

public void unplugForce(Connection c)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException

Forcibly unplug the specified VBD First published in XenServer 4.0.

Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

assertAttachableAsync

public Task assertAttachableAsync(Connection c)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException

Throws an error if this VBD could not be attached to this VM if the VM were running. Intended for debugging. First published in XenServer 4.0.

Returns:: Task
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

assertAttachable

public void assertAttachable(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Throws an error if this VBD could not be attached to this VM if the VM were running. Intended for debugging. First published in XenServer 4.0.

Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

setModeAsync

public Task setModeAsync(Connection c,
                Types.VbdMode value)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException

Sets the mode of the VBD. The power_state of the VM must be halted. First published in XenServer 4.0.

Parameters:: value - New value to set
Returns:: Task
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

setMode

public void setMode(Connection c,
           Types.VbdMode value)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException

Sets the mode of the VBD. The power_state of the VM must be halted. First published in XenServer 4.0.

Parameters:: value - New value to set
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getAll

public static java.util.Set<VBD> getAll(Connection c)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException

Return a list of all the VBDs known to the system. First published in XenServer 4.0.

Returns:: references to all objects
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

getAllRecords

public static java.util.Map<VBD,VBD.Record> getAllRecords(Connection c)
                                                   throws Types.BadServerResponse,
                                                          Types.XenAPIException,
                                                          org.apache.xmlrpc.XmlRpcException

Return a map of VBD references to VBD records for all VBDs known to the system. First published in XenServer 4.0.

Returns:: records of all objects
Throws:: Types.BadServerResponse; Types.XenAPIException; org.apache.xmlrpc.XmlRpcException

Class VBD

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class com.xensource.xenapi.XenAPIObject

Methods inherited from class java.lang.Object

Field Detail

ref

Method Detail

toWireString

equals

hashCode

getRecord

getByUuid

createAsync

create

destroyAsync

destroy

getUuid

getAllowedOperations

getCurrentOperations

getVM

getVDI

getDevice

getUserdevice

getBootable

getMode

getType

getUnpluggable

getStorageLock

getEmpty

getOtherConfig

getCurrentlyAttached

getStatusCode

getStatusDetail

getRuntimeProperties

getQosAlgorithmType

getQosAlgorithmParams

getQosSupportedAlgorithms

getMetrics

setUserdevice

setBootable

setType

setUnpluggable

setOtherConfig

addToOtherConfig

removeFromOtherConfig

setQosAlgorithmType

setQosAlgorithmParams

addToQosAlgorithmParams

removeFromQosAlgorithmParams

ejectAsync

eject

insertAsync

insert

plugAsync

plug

unplugAsync

unplug

unplugForceAsync

unplugForce

assertAttachableAsync

assertAttachable

setModeAsync

setMode

getAll

getAllRecords