Class: VGPU

Last published : Oct 01, 2026
A virtual GPU vGPU
Related information
XenServer 9 Management API

Fields for class: VGPU

Field Type Qualifier Description
compatibility_metadata (string -> string) map RO/runtime VGPU metadata to determine whether a VGPU can migrate between two PGPUs
currently_attached bool RO/runtime Reflects whether the virtual device is currently connected to a physical device
device string RO/runtime Order in which the devices are plugged into the VM
extra_args string RW Extra arguments for vGPU and passed to demu
GPU_group GPU_group ref RO/runtime GPU group used by the vGPU
other_config (string -> string) map RW Additional configuration
PCI PCI ref RO/runtime Device passed trough to VM, either as full device or SR-IOV virtual function
resident_on PGPU ref RO/runtime The PGPU on which this VGPU is running
scheduled_to_be_resident_on PGPU ref RO/runtime The PGPU on which this VGPU is scheduled to run
type VGPU_type ref RO/runtime Preset type for this VGPU
uuid string RO/runtime Unique identifier/object reference
VM VM ref RO/runtime VM that owns the vGPU

RPCs associated with class: VGPU

RPC name: addtootherconfig

Overview:
Add the given keyvalue pair to the otherconfig field of the given VGPU.
Signature:
void add_to_other_config (session ref session_ref, VGPU ref self, string key, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VGPU ref self reference to the object
string key Key to add
string value Value to add
Minimum Role: pool-operator
Return Type: void

RPC name: create

Overview:
Signature:
VGPU ref create (session ref session_ref, VM ref VM, GPU_group ref GPU_group, string device, (string -> string) map other_config, VGPU_type ref type)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM ref VM
GPU_group ref GPU_group
string device
(string -> string) map other_config
VGPU_type ref type
Minimum Role: pool-operator
Return Type: VGPU ref
The reference of the created VGPU object

RPC name: destroy

Overview:
Signature:
void destroy (session ref session_ref, VGPU ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VGPU ref self The vGPU to destroy
Minimum Role: pool-operator
Return Type: void

RPC name: getall

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

RPC name: getallrecords

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

RPC name: getbyuuid

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

RPC name: getcompatibilitymetadata

Overview:
Get the compatibilitymetadata field of the given VGPU.
Signature:
(string -> string) map get_compatibility_metadata (session ref session_ref, VGPU ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VGPU ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: getcurrentlyattached

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

RPC name: getdevice

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

RPC name: getextraargs

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

RPC name: getGPUgroup

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

RPC name: getotherconfig

Overview:
Get the otherconfig field of the given VGPU.
Signature:
(string -> string) map get_other_config (session ref session_ref, VGPU ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VGPU ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: getPCI

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

RPC name: getrecord

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

RPC name: getresidenton

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

RPC name: getscheduledtoberesidenton

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

RPC name: gettype

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

RPC name: getuuid

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

RPC name: getVM

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

RPC name: removefromotherconfig

Overview:
Remove the given key and its corresponding value from the otherconfig field of the given VGPU. If the key is not in that Map, then do nothing.
Signature:
void remove_from_other_config (session ref session_ref, VGPU ref self, string key)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VGPU ref self reference to the object
string key Key to remove
Minimum Role: pool-operator
Return Type: void

RPC name: setextraargs

Overview:
Set the extraargs field of the given VGPU.
Signature:
void set_extra_args (session ref session_ref, VGPU ref self, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VGPU ref self reference to the object
string value New value to set
Minimum Role: pool-operator
Return Type: void

RPC name: setotherconfig

Overview:
Set the otherconfig field of the given VGPU.
Signature:
void set_other_config (session ref session_ref, VGPU ref self, (string -> string) map value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VGPU ref self reference to the object
(string -> string) map value New value to set
Minimum Role: pool-operator
Return Type: void