Class: Hostdriver

Last published : Oct 01, 2026
UNSUPPORTED. A multiversion driver on a host
Related information
XenServer 8.4 Management API

Fields for class: Hostdriver

Field Type Qualifier Description
active_variant Driver_variant ref RO/runtime Currently active variant of this driver, if any, or Null.
description string RO/runtime Description of the driver
friendly_name string RO/runtime Descriptive name, not used for identification
host host ref RO/constructor Host where this driver is installed
info string RO/runtime Information about the driver
name string RO/runtime Name identifying the driver uniquely
selected_variant Driver_variant ref RO/runtime Variant (if any) selected to become active after reboot. Or Null
type string RO/runtime Device type this driver supports, like network or storage
uuid string RO/runtime Unique identifier/object reference
variants Driver_variant ref set RO/runtime Variants of this driver available for selection

RPCs associated with class: Hostdriver

RPC name: deselect

Overview:
UNSUPPORTED. Deselect the currently active variant of this driver after reboot. No action will be taken if no variant is currently active.
Signature:
void deselect (session ref session_ref, Host_driver ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Host_driver ref self Driver to become inactive (after reboot).
Minimum Role: pool-admin
Return Type: void

RPC name: getactivevariant

Overview:
Get the activevariant field of the given Hostdriver.
Signature:
Driver_variant ref get_active_variant (session ref session_ref, Host_driver ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Host_driver ref self reference to the object
Minimum Role: read-only
Return Type: Driver_variant ref
value of the field

RPC name: getall

Overview:
Return a list of all the Hostdrivers known to the system.
Signature:
Host_driver 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: Host_driver ref set
references to all objects

RPC name: getallrecords

Overview:
Return a map of Hostdriver references to Hostdriver records for all Hostdrivers known to the system.
Signature:
(Host_driver ref -> Host_driver 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: (Host_driver ref -> Host_driver record) map
records of all objects

RPC name: getbyuuid

Overview:
Get a reference to the Hostdriver instance with the specified UUID.
Signature:
Host_driver 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: Host_driver ref
reference to the object

RPC name: getdescription

Overview:
Get the description field of the given Hostdriver.
Signature:
string get_description (session ref session_ref, Host_driver ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Host_driver ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getfriendlyname

Overview:
Get the friendlyname field of the given Hostdriver.
Signature:
string get_friendly_name (session ref session_ref, Host_driver ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Host_driver ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: gethost

Overview:
Get the host field of the given Hostdriver.
Signature:
host ref get_host (session ref session_ref, Host_driver ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Host_driver ref self reference to the object
Minimum Role: read-only
Return Type: host ref
value of the field

RPC name: getinfo

Overview:
Get the info field of the given Hostdriver.
Signature:
string get_info (session ref session_ref, Host_driver ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Host_driver ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getname

Overview:
Get the name field of the given Hostdriver.
Signature:
string get_name (session ref session_ref, Host_driver ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Host_driver ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getrecord

Overview:
Get a record containing the current state of the given Hostdriver.
Signature:
Host_driver record get_record (session ref session_ref, Host_driver ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Host_driver ref self reference to the object
Minimum Role: read-only
Return Type: Host_driver record
all fields from the object

RPC name: getselectedvariant

Overview:
Get the selectedvariant field of the given Hostdriver.
Signature:
Driver_variant ref get_selected_variant (session ref session_ref, Host_driver ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Host_driver ref self reference to the object
Minimum Role: read-only
Return Type: Driver_variant ref
value of the field

RPC name: gettype

Overview:
Get the type field of the given Hostdriver.
Signature:
string get_type (session ref session_ref, Host_driver ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Host_driver 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 Hostdriver.
Signature:
string get_uuid (session ref session_ref, Host_driver ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Host_driver ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getvariants

Overview:
Get the variants field of the given Hostdriver.
Signature:
Driver_variant ref set get_variants (session ref session_ref, Host_driver ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Host_driver ref self reference to the object
Minimum Role: read-only
Return Type: Driver_variant ref set
value of the field

RPC name: rescan

Overview:
UNSUPPORTED. Rescan a host's drivers and update information about them. This is mostly for trouble shooting.
Signature:
void rescan (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host Update driver information of this host.
Minimum Role: pool-admin
Return Type: void

RPC name: select

Overview:
UNSUPPORTED. Select a variant of the driver to become active after reboot or immediately if currently no version is active
Signature:
void select (session ref session_ref, Host_driver ref self, Driver_variant ref variant)
Arguments:
Type Name Description
session ref session_ref 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
Return Type: void