Class: PGPU
A physical GPU (pGPU)
| Published in: | XenServer 6.0 (boston) | |
Enums
pgpu_dom0_access
| Values: | enabled | dom0 can access this device as normal |
| disable_on_reboot | On host reboot dom0 will be blocked from accessing this device |
| disabled | dom0 cannot access this device |
| enable_on_reboot | On host reboot dom0 will be allowed to access this device |
Fields
(string → string) map
compatibility_metadata
[RO/runtime]
enum pgpu_dom0_access
dom0_access
[RO/runtime]
The accessibility of this device from dom0
| Default value: | enabled |
| Published in: | XenServer 6.5 SP1 (cream) | |
VGPU_type ref set
enabled_VGPU_types
[RO/runtime]
List of VGPU types which have been enabled for this PGPU
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
GPU_group ref
GPU_group
[RO/constructor]
GPU group the pGPU is contained in
| Default value: | OpaqueRef:NULL |
| Published in: | XenServer 6.0 (boston) | |
host ref
host
[RO/runtime]
Host that owns the GPU
| Default value: | OpaqueRef:NULL |
| Published in: | XenServer 6.0 (boston) | |
bool
is_system_display_device
[RO/runtime]
Is this device the system display device
| Default value: | false |
| Published in: | XenServer 6.5 SP1 (cream) | |
(string → string) map
other_config
[RW]
Additional configuration
| Default value: | {} |
| Published in: | XenServer 6.0 (boston) | |
PCI ref
PCI
[RO/constructor]
Link to underlying PCI device
| Default value: | OpaqueRef:NULL |
| Published in: | XenServer 6.0 (boston) | |
VGPU ref set
resident_VGPUs
[RO/runtime]
List of VGPUs running on this PGPU
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
(VGPU_type ref → int) map
supported_VGPU_max_capacities
[RO/runtime]
A map relating each VGPU type supported on this GPU to the maximum number of VGPUs of that type which can run simultaneously on this GPU
| Default value: | {} |
| Published in: | XenServer 6.2 SP1 (vgpu-productisation) | |
VGPU_type ref set
supported_VGPU_types
[RO/runtime]
List of VGPU types supported by the underlying hardware
| 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) | |
Messages
void
add_enabled_VGPU_types
(session ref, PGPU ref, VGPU_type ref)
| Parameters: | session ref session_id | Reference to a valid session |
| PGPU ref self | The PGPU to which we are adding an enabled VGPU type |
| VGPU_type ref value | The VGPU type to enable |
| Minimum role: | pool-operator |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
void
add_to_other_config
(session ref, PGPU ref, string, string)
Add the given key-value pair to the other_config field of the given PGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| PGPU 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) | |
enum pgpu_dom0_access
disable_dom0_access
(session ref, PGPU ref)
| Parameters: | session ref session_id | Reference to a valid session |
| PGPU ref self | The PGPU to which dom0 will be denied access |
| Minimum role: | pool-operator |
| Result: | The accessibility of this PGPU from dom0 |
| Published in: | XenServer 6.5 SP1 (cream) | |
enum pgpu_dom0_access
enable_dom0_access
(session ref, PGPU ref)
| Parameters: | session ref session_id | Reference to a valid session |
| PGPU ref self | The PGPU to which dom0 will be granted access |
| Minimum role: | pool-operator |
| Result: | The accessibility of this PGPU from dom0 |
| Published in: | XenServer 6.5 SP1 (cream) | |
PGPU ref set
get_all
(session ref)
Return a list of all the PGPUs 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) | |
(PGPU ref → PGPU record) map
get_all_records
(session ref)
Return a map of PGPU references to PGPU records for all PGPUs 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) | |
PGPU ref
get_by_uuid
(session ref, string)
Get a reference to the PGPU 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, PGPU ref)
enum pgpu_dom0_access
get_dom0_access
(session ref, PGPU ref)
Get the dom0_access field of the given PGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| PGPU ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.5 SP1 (cream) | |
VGPU_type ref set
get_enabled_VGPU_types
(session ref, PGPU ref)
Get the enabled_VGPU_types field of the given PGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| PGPU 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) | |
GPU_group ref
get_GPU_group
(session ref, PGPU ref)
Get the GPU_group field of the given PGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| PGPU ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.0 (boston) | |
host ref
get_host
(session ref, PGPU ref)
Get the host field of the given PGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| PGPU ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.0 (boston) | |
bool
get_is_system_display_device
(session ref, PGPU ref)
Get the is_system_display_device field of the given PGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| PGPU ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.5 SP1 (cream) | |
(string → string) map
get_other_config
(session ref, PGPU ref)
Get the other_config field of the given PGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| PGPU 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, PGPU ref)
Get the PCI field of the given PGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| PGPU ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.0 (boston) | |
PGPU record
get_record
(session ref, PGPU ref)
Get a record containing the current state of the given PGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| PGPU ref self | reference to the object |
| Minimum role: | read-only |
| Result: | all fields from the object |
| Published in: | XenServer 6.0 (boston) | |
int
get_remaining_capacity
(session ref, PGPU ref, VGPU_type ref)
| Parameters: | session ref session_id | Reference to a valid session |
| PGPU ref self | The PGPU to query |
| VGPU_type ref vgpu_type | The VGPU type for which we want to find the number of VGPUs which can still be started on this PGPU |
| Minimum role: | read-only |
| Result: | The number of VGPUs of the specified type which can still be started on this PGPU |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
VGPU ref set
get_resident_VGPUs
(session ref, PGPU ref)
Get the resident_VGPUs field of the given PGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| PGPU 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 ref → int) map
get_supported_VGPU_max_capacities
(session ref, PGPU ref)
Get the supported_VGPU_max_capacities field of the given PGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| PGPU ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.2 SP1 (vgpu-productisation) | |
VGPU_type ref set
get_supported_VGPU_types
(session ref, PGPU ref)
Get the supported_VGPU_types field of the given PGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| PGPU 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, PGPU ref)
Get the uuid field of the given PGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| PGPU ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.0 (boston) | |
void
remove_enabled_VGPU_types
(session ref, PGPU ref, VGPU_type ref)
| Parameters: | session ref session_id | Reference to a valid session |
| PGPU ref self | The PGPU from which we are removing an enabled VGPU type |
| VGPU_type ref value | The VGPU type to disable |
| Minimum role: | pool-operator |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
void
remove_from_other_config
(session ref, PGPU ref, string)
Remove the given key and its corresponding value from the other_config field of the given PGPU. If the key is not in that Map, then do nothing.
| Parameters: | session ref session_id | Reference to a valid session |
| PGPU ref self | reference to the object |
| string key | Key to remove |
| Minimum role: | pool-operator |
| Published in: | XenServer 6.0 (boston) | |
void
set_enabled_VGPU_types
(session ref, PGPU ref, VGPU_type ref set)
| Parameters: | session ref session_id | Reference to a valid session |
| PGPU ref self | The PGPU on which we are enabling a set of VGPU types |
| VGPU_type ref set value | The VGPU types to enable |
| Minimum role: | pool-operator |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
void
set_GPU_group
(session ref, PGPU ref, GPU_group ref)
| Parameters: | session ref session_id | Reference to a valid session |
| PGPU ref self | The PGPU to move to a new group |
| GPU_group ref value | The group to which the PGPU will be moved |
| Minimum role: | pool-operator |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
void
set_other_config
(session ref, PGPU ref, (string → string) map)
Set the other_config field of the given PGPU.
| Parameters: | session ref session_id | Reference to a valid session |
| PGPU ref self | reference to the object |
| (string → string) map value | New value to set |
| Minimum role: | pool-operator |
| Published in: | XenServer 6.0 (boston) | |