Develop for XenServer

Class: VGPU_type

June 19, 2024

Contributed by:

X X

A type of virtual GPU

Fields for class: VGPU_type

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

RPC name: get_all

Overview:

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

Signature:

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

references to all objects

RPC name: get_all_records

Overview:

Return a map of VGPU_type references to VGPU_type records for all VGPU_types known to the system.

Signature:

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

records of all objects

RPC name: get_by_uuid

Overview:

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

Signature:

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

reference to the object

RPC name: get_compatible_types_in_vm

Overview:

Get the compatible_types_in_vm field of the given VGPU_type.

Signature:

VGPU_type ref set get_compatible_types_in_vm (session ref session_ref, VGPU_type ref self)
<!--NeedCopy-->

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

Overview:

Get the enabled_on_GPU_groups field of the given VGPU_type.

Signature:

GPU_group ref set get_enabled_on_GPU_groups (session ref session_ref, VGPU_type ref self)
<!--NeedCopy-->

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

Overview:

Get the enabled_on_PGPUs field of the given VGPU_type.

Signature:

PGPU ref set get_enabled_on_PGPUs (session ref session_ref, VGPU_type ref self)
<!--NeedCopy-->

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

Overview:

Get the experimental field of the given VGPU_type.

Signature:

bool get_experimental (session ref session_ref, VGPU_type ref self)
<!--NeedCopy-->

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

Overview:

Get the framebuffer_size field of the given VGPU_type.

Signature:

int get_framebuffer_size (session ref session_ref, VGPU_type ref self)
<!--NeedCopy-->

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

Overview:

Get the identifier field of the given VGPU_type.

Signature:

string get_identifier (session ref session_ref, VGPU_type ref self)
<!--NeedCopy-->

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

Overview:

Get the implementation field of the given VGPU_type.

Signature:

vgpu_type_implementation get_implementation (session ref session_ref, VGPU_type ref self)
<!--NeedCopy-->

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

Overview:

Get the max_heads field of the given VGPU_type.

Signature:

int get_max_heads (session ref session_ref, VGPU_type ref self)
<!--NeedCopy-->

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

Overview:

Get the max_resolution_x field of the given VGPU_type.

Signature:

int get_max_resolution_x (session ref session_ref, VGPU_type ref self)
<!--NeedCopy-->

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

Overview:

Get the max_resolution_y field of the given VGPU_type.

Signature:

int get_max_resolution_y (session ref session_ref, VGPU_type ref self)
<!--NeedCopy-->

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

Overview:

Get the model_name field of the given VGPU_type.

Signature:

string get_model_name (session ref session_ref, VGPU_type ref self)
<!--NeedCopy-->

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

Overview:

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

Signature:

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

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

Overview:

Get the supported_on_GPU_groups field of the given VGPU_type.

Signature:

GPU_group ref set get_supported_on_GPU_groups (session ref session_ref, VGPU_type ref self)
<!--NeedCopy-->

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

Overview:

Get the supported_on_PGPUs field of the given VGPU_type.

Signature:

PGPU ref set get_supported_on_PGPUs (session ref session_ref, VGPU_type ref self)
<!--NeedCopy-->

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

Overview:

Get the uuid field of the given VGPU_type.

Signature:

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

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

Overview:

Get the vendor_name field of the given VGPU_type.

Signature:

string get_vendor_name (session ref session_ref, VGPU_type ref self)
<!--NeedCopy-->

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

Overview:

Get the VGPUs field of the given VGPU_type.

Signature:

VGPU ref set get_VGPUs (session ref session_ref, VGPU_type ref self)
<!--NeedCopy-->

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

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

June 19, 2024

Contributed by:

X X

June 19, 2024

Contributed by:

X X

Class: VGPU_type

Fields for class: VGPU_type

RPCs associated with class: VGPU_type

RPC name: get_all

RPC name: get_all_records

RPC name: get_by_uuid

RPC name: get_compatible_types_in_vm

RPC name: get_enabled_on_GPU_groups

RPC name: get_enabled_on_PGPUs

RPC name: get_experimental

RPC name: get_framebuffer_size

RPC name: get_identifier

RPC name: get_implementation

RPC name: get_max_heads

RPC name: get_max_resolution_x

RPC name: get_max_resolution_y

RPC name: get_model_name

RPC name: get_record

RPC name: get_supported_on_GPU_groups

RPC name: get_supported_on_PGPUs

RPC name: get_uuid

RPC name: get_vendor_name

RPC name: get_VGPUs

In this article