Package com.xensource.xenapi
Class HostDriver
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.HostDriver
UNSUPPORTED. A multi-version driver on a host
First published in .
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Represents all the fields in a HostDriver -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
UNSUPPORTED.UNSUPPORTED.boolean
If obj is a HostDriver, compares XenAPI references for equality.Get the active_variant field of the given Host_driver.static Set<HostDriver>
getAll
(Connection c) Return a list of all the Host_drivers known to the system.static Map<HostDriver,
HostDriver.Record> Return a map of Host_driver references to Host_driver records for all Host_drivers known to the system.static HostDriver
getByUuid
(Connection c, String uuid) Get a reference to the Host_driver instance with the specified UUID.Get the description field of the given Host_driver.Get the friendly_name field of the given Host_driver.Get the host field of the given Host_driver.Get the info field of the given Host_driver.Get the name field of the given Host_driver.Get a record containing the current state of the given Host_driver.Get the selected_variant field of the given Host_driver.Get the type field of the given Host_driver.Get the uuid field of the given Host_driver.Get the variants field of the given Host_driver.int
hashCode()
static void
rescan
(Connection c, Host host) UNSUPPORTED.static Task
rescanAsync
(Connection c, Host host) UNSUPPORTED.void
select
(Connection c, DriverVariant variant) UNSUPPORTED.selectAsync
(Connection c, DriverVariant variant) UNSUPPORTED.Methods inherited from class com.xensource.xenapi.XenAPIObject
isNull
-
Field Details
-
ref
The XenAPI reference (OpaqueRef) to this object.
-
-
Method Details
-
toWireString
- Specified by:
toWireString
in classXenAPIObject
- Returns:
- The XenAPI reference (OpaqueRef) to this object.
-
equals
If obj is a HostDriver, compares XenAPI references for equality. -
hashCode
public int hashCode() -
getRecord
public HostDriver.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a record containing the current state of the given Host_driver. Minimum allowed role: read-only Experimental. First published in 25.2.0.- Parameters:
c
- The connection the call is made on- Returns:
- all fields from the object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getByUuid
public static HostDriver getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a reference to the Host_driver instance with the specified UUID. Minimum allowed role: read-only Experimental. First published in 25.2.0.- Parameters:
c
- The connection the call is made onuuid
- UUID of object to return- Returns:
- reference to the object
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getUuid
public String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the uuid field of the given Host_driver. Minimum allowed role: read-only Experimental. First published in 25.2.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getHost
public Host getHost(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the host field of the given Host_driver. Minimum allowed role: read-only Experimental. First published in 25.2.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getName
public String getName(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the name field of the given Host_driver. Minimum allowed role: read-only Experimental. First published in 25.2.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getFriendlyName
public String getFriendlyName(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the friendly_name field of the given Host_driver. Minimum allowed role: read-only Experimental. First published in 25.2.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getVariants
public Set<DriverVariant> getVariants(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the variants field of the given Host_driver. Minimum allowed role: read-only Experimental. First published in 25.2.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getActiveVariant
public DriverVariant getActiveVariant(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the active_variant field of the given Host_driver. Minimum allowed role: read-only Experimental. First published in 25.2.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getSelectedVariant
public DriverVariant getSelectedVariant(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the selected_variant field of the given Host_driver. Minimum allowed role: read-only Experimental. First published in 25.2.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getType
public String getType(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the type field of the given Host_driver. Minimum allowed role: read-only Experimental. First published in 25.2.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getDescription
public String getDescription(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the description field of the given Host_driver. Minimum allowed role: read-only Experimental. First published in 25.2.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getInfo
public String getInfo(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the info field of the given Host_driver. Minimum allowed role: read-only Experimental. First published in 25.2.0.- Parameters:
c
- The connection the call is made on- Returns:
- value of the field
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
select
public void select(Connection c, DriverVariant variant) throws Types.BadServerResponse, Types.XenAPIException, IOException UNSUPPORTED. Select a variant of the driver to become active after reboot or immediately if currently no version is active Minimum allowed role: pool-admin Experimental. First published in 25.2.0.- Parameters:
c
- The connection the call is made onvariant
- Driver version to become active (after reboot).- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
selectAsync
public Task selectAsync(Connection c, DriverVariant variant) throws Types.BadServerResponse, Types.XenAPIException, IOException UNSUPPORTED. Select a variant of the driver to become active after reboot or immediately if currently no version is active Minimum allowed role: pool-admin Experimental. First published in 25.2.0.- Parameters:
c
- The connection the call is made onvariant
- Driver version to become active (after reboot).- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
deselect
public void deselect(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException UNSUPPORTED. Deselect the currently active variant of this driver after reboot. No action will be taken if no variant is currently active. Minimum allowed role: pool-admin Experimental. First published in 25.2.0.- Parameters:
c
- The connection the call is made on- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
deselectAsync
public Task deselectAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException UNSUPPORTED. Deselect the currently active variant of this driver after reboot. No action will be taken if no variant is currently active. Minimum allowed role: pool-admin Experimental. First published in 25.2.0.- Parameters:
c
- The connection the call is made on- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
rescan
public static void rescan(Connection c, Host host) throws Types.BadServerResponse, Types.XenAPIException, IOException UNSUPPORTED. Re-scan a host's drivers and update information about them. This is mostly for trouble shooting. Minimum allowed role: pool-admin Experimental. First published in 25.2.0.- Parameters:
c
- The connection the call is made onhost
- Update driver information of this host.- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
rescanAsync
public static Task rescanAsync(Connection c, Host host) throws Types.BadServerResponse, Types.XenAPIException, IOException UNSUPPORTED. Re-scan a host's drivers and update information about them. This is mostly for trouble shooting. Minimum allowed role: pool-admin Experimental. First published in 25.2.0.- Parameters:
c
- The connection the call is made onhost
- Update driver information of this host.- Returns:
- Task
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAll
public static Set<HostDriver> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a list of all the Host_drivers known to the system. Minimum allowed role: read-only Experimental. First published in 25.2.0.- Parameters:
c
- The connection the call is made on- Returns:
- references to all objects
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-
getAllRecords
public static Map<HostDriver,HostDriver.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a map of Host_driver references to Host_driver records for all Host_drivers known to the system. Minimum allowed role: read-only Experimental. First published in 25.2.0.- Parameters:
c
- The connection the call is made on- Returns:
- records of all objects
- Throws:
Types.BadServerResponse
- Thrown if the response from the server contains an invalid status.Types.XenAPIException
- if the call failed.IOException
- if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.
-