Class: Drivervariant

Last published : Oct 01, 2026
UNSUPPORTED. Variant of a host driver
Related information
XenServer 9 Management API

Fields for class: Drivervariant

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: Drivervariant

RPC name: getall

Overview:
Return a list of all the Drivervariants known to the system.
Signature:
Driver_variant ref set get_all (session ref session_ref)
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: getallrecords

Overview:
Return a map of Drivervariant references to Drivervariant records for all Drivervariants known to the system.
Signature:
(Driver_variant ref -> Driver_variant record) map get_all_records (session ref session_ref)
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: getbyuuid

Overview:
Get a reference to the Drivervariant instance with the specified UUID.
Signature:
Driver_variant ref get_by_uuid (session ref session_ref, string uuid)
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: getdriver

Overview:
Get the driver field of the given Drivervariant.
Signature:
Host_driver ref get_driver (session ref session_ref, Driver_variant ref self)
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: gethardwarepresent

Overview:
Get the hardwarepresent field of the given Drivervariant.
Signature:
bool get_hardware_present (session ref session_ref, Driver_variant ref self)
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: getname

Overview:
Get the name field of the given Drivervariant.
Signature:
string get_name (session ref session_ref, Driver_variant ref self)
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: getpriority

Overview:
Get the priority field of the given Drivervariant.
Signature:
float get_priority (session ref session_ref, Driver_variant ref self)
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: getrecord

Overview:
Get a record containing the current state of the given Drivervariant.
Signature:
Driver_variant record get_record (session ref session_ref, Driver_variant ref self)
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: getstatus

Overview:
Get the status field of the given Drivervariant.
Signature:
string get_status (session ref session_ref, Driver_variant ref self)
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: getuuid

Overview:
Get the uuid field of the given Drivervariant.
Signature:
string get_uuid (session ref session_ref, Driver_variant ref self)
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: getversion

Overview:
Get the version field of the given Drivervariant.
Signature:
string get_version (session ref session_ref, Driver_variant ref self)
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)
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