Class: VGPUtype

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

Fields for class: VGPUtype

Field Type Qualifier Description
compatible_types_in_vm VGPU_type ref set RO/runtime List of VGPU types which are compatible in one VM
enabled_on_GPU_groups GPU_group ref set RO/runtime List of GPU groups in which at least one have this VGPU type enabled
enabled_on_PGPUs PGPU ref set RO/runtime List of PGPUs that have this VGPU type enabled
experimental bool RO/constructor Indicates whether VGPUs of this type should be considered experimental
framebuffer_size int RO/constructor Framebuffer size of the VGPU type, in bytes
identifier string RO/constructor Key used to identify VGPU types and avoid creating duplicates - this field is used internally and not intended for interpretation by API clients
implementation vgpu_type_implementation RO/constructor The internal implementation of this VGPU type
max_heads int RO/constructor Maximum number of displays supported by the VGPU type
max_resolution_x int RO/constructor Maximum resolution (width) supported by the VGPU type
max_resolution_y int RO/constructor Maximum resolution (height) supported by the VGPU type
model_name string RO/constructor Model name associated with the VGPU type
supported_on_GPU_groups GPU_group ref set RO/runtime List of GPU groups in which at least one PGPU supports this VGPU type
supported_on_PGPUs PGPU ref set RO/runtime List of PGPUs that support this VGPU type
uuid string RO/runtime Unique identifier/object reference
vendor_name string RO/constructor Name of VGPU vendor
VGPUs VGPU ref set RO/runtime List of VGPUs of this type

RPCs associated with class: VGPUtype

RPC name: getall

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

RPC name: getallrecords

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

RPC name: getbyuuid

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

RPC name: getcompatibletypesinvm

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

RPC name: getenabledonGPUgroups

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

RPC name: getenabledonPGPUs

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

RPC name: getexperimental

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

RPC name: getframebuffersize

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

RPC name: getidentifier

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

RPC name: getimplementation

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

RPC name: getmaxheads

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

RPC name: getmaxresolutionx

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

RPC name: getmaxresolutiony

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

RPC name: getmodelname

Overview:
Get the modelname field of the given VGPUtype.
Signature:
string get_model_name (session ref session_ref, VGPU_type ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VGPU_type 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 VGPUtype.
Signature:
VGPU_type record get_record (session ref session_ref, VGPU_type ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VGPU_type ref self reference to the object
Minimum Role: read-only
Return Type: VGPU_type record
all fields from the object

RPC name: getsupportedonGPUgroups

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

RPC name: getsupportedonPGPUs

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

RPC name: getuuid

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

RPC name: getvendorname

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

RPC name: getVGPUs

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