Prototype
Class: Host_driver
UNSUPPORTED. A multi-version driver on a host
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Fields
Prototype
Driver_variant ref
active_variant
[RO/runtime]
Currently active variant of this driver, if any, or Null.
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
string
description
[RO/runtime]
Description of the driver
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
string
friendly_name
[RO/runtime]
Descriptive name, not used for identification
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
host ref
host
[RO/constructor]
Host where this driver is installed
| Default value: |
Null |
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
string
info
[RO/runtime]
Information about the driver
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
string
name
[RO/runtime]
Name identifying the driver uniquely
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
Driver_variant ref
selected_variant
[RO/runtime]
Variant (if any) selected to become active after reboot. Or Null
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
string
type
[RO/runtime]
Device type this driver supports, like network or storage
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
string
uuid
[RO/runtime]
Unique identifier/object reference
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
Driver_variant ref set
variants
[RO/runtime]
Variants of this driver available for selection
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Messages
Prototype
void
deselect
(session ref, Host_driver ref)
UNSUPPORTED. Deselect the currently active variant of this driver after reboot. No action will be taken if no variant is currently active.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
Host_driver ref self |
Driver to become inactive (after reboot). |
| Minimum role: |
pool-admin |
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
Driver_variant ref
get_active_variant
(session ref, Host_driver ref)
Get the active_variant field of the given Host_driver.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
Host_driver ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
Host_driver ref set
get_all
(session ref)
Return a list of all the Host_drivers known to the system.
| Parameters: |
session ref session_id |
Reference to a valid session |
| Minimum role: |
read-only |
| Result: |
references to all objects |
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
(Host_driver ref → Host_driver record) map
get_all_records
(session ref)
Return a map of Host_driver references to Host_driver records for all Host_drivers known to the system.
| Parameters: |
session ref session_id |
Reference to a valid session |
| Minimum role: |
read-only |
| Result: |
records of all objects |
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
Host_driver ref
get_by_uuid
(session ref, string)
Get a reference to the Host_driver instance with the specified UUID.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
string uuid |
UUID of object to return |
| Minimum role: |
read-only |
| Result: |
reference to the object |
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
string
get_description
(session ref, Host_driver ref)
Get the description field of the given Host_driver.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
Host_driver ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
string
get_friendly_name
(session ref, Host_driver ref)
Get the friendly_name field of the given Host_driver.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
Host_driver ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
host ref
get_host
(session ref, Host_driver ref)
Get the host field of the given Host_driver.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
Host_driver ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
string
get_info
(session ref, Host_driver ref)
Get the info field of the given Host_driver.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
Host_driver ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
string
get_name
(session ref, Host_driver ref)
Get the name field of the given Host_driver.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
Host_driver ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
Host_driver record
get_record
(session ref, Host_driver ref)
Get a record containing the current state of the given Host_driver.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
Host_driver ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
all fields from the object |
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
Driver_variant ref
get_selected_variant
(session ref, Host_driver ref)
Get the selected_variant field of the given Host_driver.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
Host_driver ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
string
get_type
(session ref, Host_driver ref)
Get the type field of the given Host_driver.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
Host_driver ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
string
get_uuid
(session ref, Host_driver ref)
Get the uuid field of the given Host_driver.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
Host_driver ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
Driver_variant ref set
get_variants
(session ref, Host_driver ref)
Get the variants field of the given Host_driver.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
Host_driver ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
void
rescan
(session ref, host ref)
UNSUPPORTED. Re-scan a host's drivers and update information about them. This is mostly for trouble shooting.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
host ref host |
Update driver information of this host. |
| Minimum role: |
pool-admin |
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
void
select
(session ref, Host_driver ref, Driver_variant ref)
UNSUPPORTED. Select a variant of the driver to become active after reboot or immediately if currently no version is active
| Parameters: |
session ref session_id |
Reference to a valid session |
|
Host_driver ref self |
Driver to become active (after reboot). |
|
Driver_variant ref variant |
Driver version to become active (after reboot). |
| Minimum role: |
pool-admin |
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
