Class: VGPU
A virtual GPU (vGPU)
| Published in: | XenServer 6.0 (boston) | |
Fields
(string → string) map
compatibility_metadata
[RO/runtime]
bool
currently_attached
[RO/runtime]
Reflects whether the virtual device is currently connected to a physical device
| Default value: | false |
| Published in: | XenServer 6.0 (boston) | |
string
device
[RO/runtime]
Order in which the devices are plugged into the VM
| Default value: | "0" |
| Published in: | XenServer 6.0 (boston) | |
GPU_group ref
GPU_group
[RO/runtime]
GPU group used by the vGPU
| Published in: | XenServer 6.0 (boston) | |
(string → string) map
other_config
[RW]
Additional configuration
| Default value: | {} |
| Published in: | XenServer 6.0 (boston) | |
PCI ref
PCI
[RO/runtime]
Device passed trough to VM, either as full device or SR-IOV virtual function
| Default value: | OpaqueRef:NULL |
| Published in: | Citrix Hypervisor 8.1 (quebec) | |
PGPU ref
resident_on
[RO/runtime]
The PGPU on which this VGPU is running
| Default value: | OpaqueRef:NULL |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
PGPU ref
scheduled_to_be_resident_on
[RO/runtime]
The PGPU on which this VGPU is scheduled to run
| Default value: | OpaqueRef:NULL |
| Published in: | XenServer 7.0 (dundee) | |
VGPU_type ref
type
[RO/runtime]
Preset type for this VGPU
| Default value: | OpaqueRef:NULL |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 6.0 (boston) | |
VM ref
VM
[RO/runtime]
VM that owns the vGPU
| Published in: | XenServer 6.0 (boston) | |
Messages
void
add_to_other_config
(session ref, VGPU ref, string, string)
Add the given key-value pair to the other_config field of the given VGPU.
| Parameters: | session ref session_id | 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 |
| Published in: | XenServer 6.0 (boston) | |
VGPU ref
create
(session ref, VM ref, GPU_group ref, string, (string → string) map, VGPU_type ref)
| Parameters: | session ref session_id | 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 |
| Result: | The reference of the created VGPU object |
| Published in: | XenServer 6.0 (boston) | |
void
destroy
(session ref, VGPU ref)
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU ref self | The vGPU to destroy |
| Minimum role: | pool-operator |
| Published in: | XenServer 6.0 (boston) | |
VGPU ref set
get_all
(session ref)
Return a list of all the VGPUs 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.0 (boston) | |
(VGPU ref → VGPU record) map
get_all_records
(session ref)
Return a map of VGPU references to VGPU records for all VGPUs 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.0 (boston) | |
VGPU ref
get_by_uuid
(session ref, string)
Get a reference to the VGPU 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.0 (boston) | |
(string → string) map
get_compatibility_metadata
(session ref, VGPU ref)
bool
get_currently_attached
(session ref, VGPU ref)
Get the currently_attached field of the given VGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.0 (boston) | |
string
get_device
(session ref, VGPU ref)
Get the device field of the given VGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.0 (boston) | |
string
get_extra_args
(session ref, VGPU ref)
GPU_group ref
get_GPU_group
(session ref, VGPU ref)
Get the GPU_group field of the given VGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.0 (boston) | |
(string → string) map
get_other_config
(session ref, VGPU ref)
Get the other_config field of the given VGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.0 (boston) | |
PCI ref
get_PCI
(session ref, VGPU ref)
Get the PCI field of the given VGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | Citrix Hypervisor 8.1 (quebec) | |
VGPU record
get_record
(session ref, VGPU ref)
Get a record containing the current state of the given VGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU ref self | reference to the object |
| Minimum role: | read-only |
| Result: | all fields from the object |
| Published in: | XenServer 6.0 (boston) | |
PGPU ref
get_resident_on
(session ref, VGPU ref)
Get the resident_on field of the given VGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU 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) | |
PGPU ref
get_scheduled_to_be_resident_on
(session ref, VGPU ref)
Get the scheduled_to_be_resident_on field of the given VGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 7.0 (dundee) | |
VGPU_type ref
get_type
(session ref, VGPU ref)
Get the type field of the given VGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU 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 ref)
Get the uuid field of the given VGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.0 (boston) | |
VM ref
get_VM
(session ref, VGPU ref)
Get the VM field of the given VGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.0 (boston) | |
void
remove_from_other_config
(session ref, VGPU ref, string)
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.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU ref self | reference to the object |
| string key | Key to remove |
| Minimum role: | pool-operator |
| Published in: | XenServer 6.0 (boston) | |
void
set_extra_args
(session ref, VGPU ref, string)
void
set_other_config
(session ref, VGPU ref, (string → string) map)
Set the other_config field of the given VGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| VGPU ref self | reference to the object |
| (string → string) map value | New value to set |
| Minimum role: | pool-operator |
| Published in: | XenServer 6.0 (boston) | |