Class: VGPU_type
A type of virtual GPU
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
Enums
vgpu_type_implementation
| Values: | passthrough | Pass through an entire physical GPU to a guest |
| nvidia | vGPU using NVIDIA hardware |
| nvidia_sriov | vGPU using NVIDIA hardware with SR-IOV |
| gvt_g | vGPU using Intel GVT-g |
| mxgpu | vGPU using AMD MxGPU |
Fields
VGPU_type ref set
compatible_types_in_vm
[RO/runtime]
List of VGPU types which are compatible in one VM
| Default value: | {} |
| Published in: | Citrix Hypervisor 8.1 (quebec) | |
GPU_group ref set
enabled_on_GPU_groups
[RO/runtime]
List of GPU groups in which at least one have this VGPU type enabled
| Published in: | XenServer 6.2 SP1 (vgpu-productisation) | |
PGPU ref set
enabled_on_PGPUs
[RO/runtime]
List of PGPUs that have this VGPU type enabled
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
bool
experimental
[RO/constructor]
Indicates whether VGPUs of this type should be considered experimental
| Default value: | false |
| Published in: | XenServer 7.0 (dundee) | |
int
framebuffer_size
[RO/constructor]
Framebuffer size of the VGPU type, in bytes
| Default value: | 0 |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
string
identifier
[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
| Default value: | "" |
| Published in: | XenServer 7.0 (dundee) | |
enum vgpu_type_implementation
implementation
[RO/constructor]
The internal implementation of this VGPU type
| Default value: | passthrough |
| Published in: | XenServer 7.0 (dundee) | |
int
max_heads
[RO/constructor]
Maximum number of displays supported by the VGPU type
| Default value: | 0 |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
int
max_resolution_x
[RO/constructor]
Maximum resolution (width) supported by the VGPU type
| Default value: | 0 |
| Published in: | XenServer 6.2 SP1 (vgpu-productisation) | |
int
max_resolution_y
[RO/constructor]
Maximum resolution (height) supported by the VGPU type
| Default value: | 0 |
| Published in: | XenServer 6.2 SP1 (vgpu-productisation) | |
string
model_name
[RO/constructor]
Model name associated with the VGPU type
| Default value: | "" |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
GPU_group ref set
supported_on_GPU_groups
[RO/runtime]
List of GPU groups in which at least one PGPU supports this VGPU type
| Published in: | XenServer 6.2 SP1 (vgpu-productisation) | |
PGPU ref set
supported_on_PGPUs
[RO/runtime]
List of PGPUs that support this VGPU type
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
string
vendor_name
[RO/constructor]
Name of VGPU vendor
| Default value: | "" |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
VGPU ref set
VGPUs
[RO/runtime]
List of VGPUs of this type
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
Messages
VGPU_type ref set
get_all
(session ref)
Return a list of all the VGPU_types known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only |
| Result: | references to all objects |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
(VGPU_type ref → VGPU_type record) map
get_all_records
(session ref)
Return a map of VGPU_type references to VGPU_type records for all VGPU_types known to the system.
| Parameters: | session ref session_id | Reference to a valid session |
| Minimum role: | read-only |
| Result: | records of all objects |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
VGPU_type ref
get_by_uuid
(session ref, string)
Get a reference to the VGPU_type instance with the specified UUID.
| Parameters: | session ref session_id | Reference to a valid session |
| string uuid | UUID of object to return |
| Minimum role: | read-only |
| Result: | reference to the object |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
VGPU_type ref set
get_compatible_types_in_vm
(session ref, VGPU_type ref)
Get the compatible_types_in_vm field of the given VGPU_type.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU_type ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | Citrix Hypervisor 8.1 (quebec) | |
GPU_group ref set
get_enabled_on_GPU_groups
(session ref, VGPU_type ref)
Get the enabled_on_GPU_groups field of the given VGPU_type.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU_type ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.2 SP1 (vgpu-productisation) | |
PGPU ref set
get_enabled_on_PGPUs
(session ref, VGPU_type ref)
Get the enabled_on_PGPUs field of the given VGPU_type.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU_type ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
bool
get_experimental
(session ref, VGPU_type ref)
Get the experimental field of the given VGPU_type.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU_type ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.0 (dundee) | |
int
get_framebuffer_size
(session ref, VGPU_type ref)
Get the framebuffer_size field of the given VGPU_type.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU_type ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
string
get_identifier
(session ref, VGPU_type ref)
Get the identifier field of the given VGPU_type.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU_type ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.0 (dundee) | |
enum vgpu_type_implementation
get_implementation
(session ref, VGPU_type ref)
Get the implementation field of the given VGPU_type.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU_type ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.0 (dundee) | |
int
get_max_heads
(session ref, VGPU_type ref)
Get the max_heads field of the given VGPU_type.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU_type ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
int
get_max_resolution_x
(session ref, VGPU_type ref)
Get the max_resolution_x field of the given VGPU_type.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU_type ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.2 SP1 (vgpu-productisation) | |
int
get_max_resolution_y
(session ref, VGPU_type ref)
Get the max_resolution_y field of the given VGPU_type.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU_type ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.2 SP1 (vgpu-productisation) | |
string
get_model_name
(session ref, VGPU_type ref)
Get the model_name field of the given VGPU_type.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU_type ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
VGPU_type record
get_record
(session ref, VGPU_type ref)
Get a record containing the current state of the given VGPU_type.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU_type ref self | reference to the object |
| Minimum role: | read-only |
| Result: | all fields from the object |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
GPU_group ref set
get_supported_on_GPU_groups
(session ref, VGPU_type ref)
Get the supported_on_GPU_groups field of the given VGPU_type.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU_type ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.2 SP1 (vgpu-productisation) | |
PGPU ref set
get_supported_on_PGPUs
(session ref, VGPU_type ref)
Get the supported_on_PGPUs field of the given VGPU_type.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU_type ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
string
get_uuid
(session ref, VGPU_type ref)
Get the uuid field of the given VGPU_type.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU_type ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
string
get_vendor_name
(session ref, VGPU_type ref)
Get the vendor_name field of the given VGPU_type.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU_type ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
VGPU ref set
get_VGPUs
(session ref, VGPU_type ref)
Get the VGPUs field of the given VGPU_type.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU_type ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |