Class: Driver_variant
UNSUPPORTED. Variant of a host driver
Fields for class: Driver_variant
| Field | Type | Qualifier | Description |
|---|---|---|---|
driver |
Host_driver ref |
RO/runtime | Driver this variant is a part of |
hardware_present |
bool |
RO/runtime | True if the hardware for this variant is present on the host |
name |
string |
RO/runtime | Name identifying the driver variant within the driver |
priority |
float |
RO/runtime | Priority; this needs an explanation how this is ordered |
status |
string |
RO/runtime | Development and release status of this variant, like ‘alpha’ |
uuid |
string |
RO/runtime | Unique identifier/object reference |
version |
string |
RO/runtime | Unique version of this driver variant |
RPCs associated with class: Driver_variant
RPC name: get_all
Overview:
Return a list of all the Driver_variants known to the system.
Signature:
Driver_variant ref set get_all (session ref session_ref)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Minimum Role: read-only
Return Type: Driver_variant ref set
references to all objects
RPC name: get_all_records
Overview:
Return a map of Driver_variant references to Driver_variant records for all Driver_variants known to the system.
Signature:
(Driver_variant ref -> Driver_variant record) map get_all_records (session ref session_ref)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Minimum Role: read-only
Return Type: (Driver_variant ref -> Driver_variant record) map
records of all objects
RPC name: get_by_uuid
Overview:
Get a reference to the Driver_variant instance with the specified UUID.
Signature:
Driver_variant ref get_by_uuid (session ref session_ref, string uuid)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
string |
uuid |
UUID of object to return |
Minimum Role: read-only
Return Type: Driver_variant ref
reference to the object
RPC name: get_driver
Overview:
Get the driver field of the given Driver_variant.
Signature:
Host_driver ref get_driver (session ref session_ref, Driver_variant ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Driver_variant ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: Host_driver ref
value of the field
RPC name: get_hardware_present
Overview:
Get the hardware_present field of the given Driver_variant.
Signature:
bool get_hardware_present (session ref session_ref, Driver_variant ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Driver_variant ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: bool
value of the field
RPC name: get_name
Overview:
Get the name field of the given Driver_variant.
Signature:
string get_name (session ref session_ref, Driver_variant ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Driver_variant ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: string
value of the field
RPC name: get_priority
Overview:
Get the priority field of the given Driver_variant.
Signature:
float get_priority (session ref session_ref, Driver_variant ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Driver_variant ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: float
value of the field
RPC name: get_record
Overview:
Get a record containing the current state of the given Driver_variant.
Signature:
Driver_variant record get_record (session ref session_ref, Driver_variant ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Driver_variant ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: Driver_variant record
all fields from the object
RPC name: get_status
Overview:
Get the status field of the given Driver_variant.
Signature:
string get_status (session ref session_ref, Driver_variant ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Driver_variant ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: string
value of the field
RPC name: get_uuid
Overview:
Get the uuid field of the given Driver_variant.
Signature:
string get_uuid (session ref session_ref, Driver_variant ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Driver_variant ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: string
value of the field
RPC name: get_version
Overview:
Get the version field of the given Driver_variant.
Signature:
string get_version (session ref session_ref, Driver_variant ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Driver_variant ref |
self |
reference to the object |
Minimum Role: read-only
Return Type: string
value of the field
RPC name: select
Overview:
UNSUPPORTED Select this variant of a driver to become active after reboot or immediately if currently no version is active
Signature:
void select (session ref session_ref, Driver_variant ref self)
<!--NeedCopy-->
Arguments:
| Type | Name | Description |
|---|---|---|
session ref |
session_ref |
Reference to a valid session |
Driver_variant ref |
self |
Driver variant to become active (after reboot). |
Minimum Role: pool-admin
Return Type: void