Prototype
Class: Driver_variant
UNSUPPORTED. Variant of a host driver
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Fields
Prototype
Host_driver ref
driver
[RO/runtime]
Driver this variant is a part of
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
bool
hardware_present
[RO/runtime]
True if the hardware for this variant is present on the host
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
string
name
[RO/runtime]
Name identifying the driver variant within the driver
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
float
priority
[RO/runtime]
Priority; this needs an explanation how this is ordered
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Prototype
string
status
[RO/runtime]
Development and release status of this variant, like 'alpha'
| 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
string
version
[RO/runtime]
Unique version of this driver variant
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
Messages
Prototype
Driver_variant ref set
get_all
(session ref)
Return a list of all the Driver_variants 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
(Driver_variant ref → Driver_variant record) map
get_all_records
(session ref)
Return a map of Driver_variant references to Driver_variant records for all Driver_variants 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
Driver_variant ref
get_by_uuid
(session ref, string)
Get a reference to the Driver_variant 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
Host_driver ref
get_driver
(session ref, Driver_variant ref)
Get the driver field of the given Driver_variant.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
Driver_variant 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
bool
get_hardware_present
(session ref, Driver_variant ref)
Get the hardware_present field of the given Driver_variant.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
Driver_variant 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, Driver_variant ref)
Get the name field of the given Driver_variant.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
Driver_variant 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
float
get_priority
(session ref, Driver_variant ref)
Get the priority field of the given Driver_variant.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
Driver_variant 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 record
get_record
(session ref, Driver_variant ref)
Get a record containing the current state of the given Driver_variant.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
Driver_variant 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
string
get_status
(session ref, Driver_variant ref)
Get the status field of the given Driver_variant.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
Driver_variant 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, Driver_variant ref)
Get the uuid field of the given Driver_variant.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
Driver_variant 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_version
(session ref, Driver_variant ref)
Get the version field of the given Driver_variant.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
Driver_variant 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
select
(session ref, Driver_variant ref)
UNSUPPORTED Select this variant of a driver to become active after reboot or immediately if currently no version is active
| Parameters: |
session ref session_id |
Reference to a valid session |
|
Driver_variant ref self |
Driver variant to become active (after reboot). |
| Minimum role: |
pool-admin |
| Prototyped in: |
XAPI 25.2.0 (25.2.0) |
|
