Develop for XenServer

Class: Host_driver

January 31, 2025

Contributed by:

UNSUPPORTED. A multi-version driver on a host

Fields for class: Host_driver

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

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)
<!--NeedCopy-->

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

Overview:

Get the active_variant field of the given Host_driver.

Signature:

Driver_variant ref get_active_variant (session ref session_ref, Host_driver ref self)
<!--NeedCopy-->

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

Overview:

Return a list of all the Host_drivers known to the system.

Signature:

Host_driver 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: Host_driver ref set

references to all objects

RPC name: get_all_records

Overview:

Return a map of Host_driver references to Host_driver records for all Host_drivers known to the system.

Signature:

(Host_driver ref -> Host_driver 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: (Host_driver ref -> Host_driver record) map

records of all objects

RPC name: get_by_uuid

Overview:

Get a reference to the Host_driver instance with the specified UUID.

Signature:

Host_driver 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: Host_driver ref

reference to the object

RPC name: get_description

Overview:

Get the description field of the given Host_driver.

Signature:

string get_description (session ref session_ref, Host_driver ref self)
<!--NeedCopy-->

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

Overview:

Get the friendly_name field of the given Host_driver.

Signature:

string get_friendly_name (session ref session_ref, Host_driver ref self)
<!--NeedCopy-->

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

Overview:

Get the host field of the given Host_driver.

Signature:

host ref get_host (session ref session_ref, Host_driver ref self)
<!--NeedCopy-->

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

Overview:

Get the info field of the given Host_driver.

Signature:

string get_info (session ref session_ref, Host_driver ref self)
<!--NeedCopy-->

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

Overview:

Get the name field of the given Host_driver.

Signature:

string get_name (session ref session_ref, Host_driver ref self)
<!--NeedCopy-->

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

Overview:

Get a record containing the current state of the given Host_driver.

Signature:

Host_driver record get_record (session ref session_ref, Host_driver ref self)
<!--NeedCopy-->

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

Overview:

Get the selected_variant field of the given Host_driver.

Signature:

Driver_variant ref get_selected_variant (session ref session_ref, Host_driver ref self)
<!--NeedCopy-->

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

Overview:

Get the type field of the given Host_driver.

Signature:

string get_type (session ref session_ref, Host_driver ref self)
<!--NeedCopy-->

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

Overview:

Get the uuid field of the given Host_driver.

Signature:

string get_uuid (session ref session_ref, Host_driver ref self)
<!--NeedCopy-->

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

Overview:

Get the variants field of the given Host_driver.

Signature:

Driver_variant ref set get_variants (session ref session_ref, Host_driver ref self)
<!--NeedCopy-->

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. Re-scan 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)
<!--NeedCopy-->

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)
<!--NeedCopy-->

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

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Class: Host_driver

January 31, 2025

Contributed by:

January 31, 2025

Contributed by:

Class: Host_driver

Fields for class: Host_driver

RPCs associated with class: Host_driver

RPC name: deselect

RPC name: get_active_variant

RPC name: get_all

RPC name: get_all_records

RPC name: get_by_uuid

RPC name: get_description

RPC name: get_friendly_name

RPC name: get_host

RPC name: get_info

RPC name: get_name

RPC name: get_record

RPC name: get_selected_variant

RPC name: get_type

RPC name: get_uuid

RPC name: get_variants

RPC name: rescan

RPC name: select

In this article