Develop for XenServer

Class: VGPU

June 19, 2024

Contributed by:

X X

A virtual GPU (vGPU)

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

Overview:

Add the given key-value pair to the other_config field of the given VGPU.

Signature:

void add_to_other_config (session ref session_ref, VGPU ref self, string key, string value)
<!--NeedCopy-->

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

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

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

Overview:

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

Signature:

VGPU 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 ref set

references to all objects

RPC name: get_all_records

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

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

Overview:

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

Signature:

VGPU 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 ref

reference to the object

RPC name: get_compatibility_metadata

Overview:

Get the compatibility_metadata field of the given VGPU.

Signature:

(string -> string) map get_compatibility_metadata (session ref session_ref, VGPU ref self)
<!--NeedCopy-->

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

Overview:

Get the currently_attached field of the given VGPU.

Signature:

bool get_currently_attached (session ref session_ref, VGPU ref self)
<!--NeedCopy-->

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

Overview:

Get the device field of the given VGPU.

Signature:

string get_device (session ref session_ref, VGPU ref self)
<!--NeedCopy-->

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

Overview:

Get the extra_args field of the given VGPU.

Signature:

string get_extra_args (session ref session_ref, VGPU ref self)
<!--NeedCopy-->

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

Overview:

Get the GPU_group field of the given VGPU.

Signature:

GPU_group ref get_GPU_group (session ref session_ref, VGPU ref self)
<!--NeedCopy-->

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

Overview:

Get the other_config field of the given VGPU.

Signature:

(string -> string) map get_other_config (session ref session_ref, VGPU ref self)
<!--NeedCopy-->

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

Overview:

Get the PCI field of the given VGPU.

Signature:

PCI ref get_PCI (session ref session_ref, VGPU ref self)
<!--NeedCopy-->

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

Overview:

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

Signature:

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

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

Overview:

Get the resident_on field of the given VGPU.

Signature:

PGPU ref get_resident_on (session ref session_ref, VGPU ref self)
<!--NeedCopy-->

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

Overview:

Get the scheduled_to_be_resident_on field of the given VGPU.

Signature:

PGPU ref get_scheduled_to_be_resident_on (session ref session_ref, VGPU ref self)
<!--NeedCopy-->

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

Overview:

Get the type field of the given VGPU.

Signature:

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

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

Overview:

Get the uuid field of the given VGPU.

Signature:

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

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

Overview:

Get the VM field of the given VGPU.

Signature:

VM ref get_VM (session ref session_ref, VGPU ref self)
<!--NeedCopy-->

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

Overview:

Remove the given key and its corresponding value from the other_config 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)
<!--NeedCopy-->

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

Overview:

Set the extra_args field of the given VGPU.

Signature:

void set_extra_args (session ref session_ref, VGPU ref self, string value)
<!--NeedCopy-->

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

Overview:

Set the other_config field of the given VGPU.

Signature:

void set_other_config (session ref session_ref, VGPU ref self, (string -> string) map value)
<!--NeedCopy-->

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

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

June 19, 2024

Contributed by:

X X

June 19, 2024

Contributed by:

X X

Class: VGPU

Fields for class: VGPU

RPCs associated with class: VGPU

RPC name: add_to_other_config

RPC name: create

RPC name: destroy

RPC name: get_all

RPC name: get_all_records

RPC name: get_by_uuid

RPC name: get_compatibility_metadata

RPC name: get_currently_attached

RPC name: get_device

RPC name: get_extra_args

RPC name: get_GPU_group

RPC name: get_other_config

RPC name: get_PCI

RPC name: get_record

RPC name: get_resident_on

RPC name: get_scheduled_to_be_resident_on

RPC name: get_type

RPC name: get_uuid

RPC name: get_VM

RPC name: remove_from_other_config

RPC name: set_extra_args

RPC name: set_other_config

In this article