Class: GPU_group
A group of compatible GPUs across the resource pool
| Published in: | XenServer 6.0 (boston) | |
Enums
allocation_algorithm
| Values: | breadth_first | vGPUs of a given type are allocated evenly across supporting pGPUs. |
| depth_first | vGPUs of a given type are allocated on supporting pGPUs until they are full. |
Fields
enum allocation_algorithm
allocation_algorithm
[RW]
Current allocation of vGPUs to pGPUs for this group
| Default value: | depth_first |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
VGPU_type ref set
enabled_VGPU_types
[RO/runtime]
vGPU types supported on at least one of the pGPUs in this group
| Published in: | XenServer 6.2 SP1 (vgpu-productisation) | |
string set
GPU_types
[RO/runtime]
List of GPU types (vendor+device ID) that can be in this group
| Default value: | {} |
| Published in: | XenServer 6.0 (boston) | |
string
name_description
[RW]
a notes field containing human-readable description
| Default value: | "" |
| Published in: | XenServer 6.0 (boston) | |
string
name_label
[RW]
a human-readable name
| Default value: | "" |
| Published in: | XenServer 6.0 (boston) | |
(string → string) map
other_config
[RW]
Additional configuration
| Default value: | {} |
| Published in: | XenServer 6.0 (boston) | |
PGPU ref set
PGPUs
[RO/runtime]
List of pGPUs in the group
| Published in: | XenServer 6.0 (boston) | |
VGPU_type ref set
supported_VGPU_types
[RO/runtime]
vGPU types supported on at least one of the pGPUs in this group
| Published in: | XenServer 6.2 SP1 (vgpu-productisation) | |
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: | XenServer 6.0 (boston) | |
VGPU ref set
VGPUs
[RO/runtime]
List of vGPUs using the group
| Published in: | XenServer 6.0 (boston) | |
Messages
void
add_to_other_config
(session ref, GPU_group ref, string, string)
Add the given key-value pair to the other_config field of the given GPU_group.
| Parameters: | session ref session_id | Reference to a valid session |
| GPU_group 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) | |
GPU_group ref
create
(session ref, string, string, (string → string) map)
| Parameters: | session ref session_id | Reference to a valid session |
| string name_label | |
| string name_description | |
| (string → string) map other_config | |
| Minimum role: | pool-operator |
| Result: | The reference of the created GPU_group |
| Published in: | XenServer 6.0 (boston) | |
void
destroy
(session ref, GPU_group ref)
| Parameters: | session ref session_id | Reference to a valid session |
| GPU_group ref self | The GPU group to destroy |
| Minimum role: | pool-operator |
| Published in: | XenServer 6.0 (boston) | |
GPU_group ref set
get_all
(session ref)
Return a list of all the GPU_groups 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) | |
(GPU_group ref → GPU_group record) map
get_all_records
(session ref)
Return a map of GPU_group references to GPU_group records for all GPU_groups 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) | |
enum allocation_algorithm
get_allocation_algorithm
(session ref, GPU_group ref)
Get the allocation_algorithm field of the given GPU_group.
| Parameters: | session ref session_id | Reference to a valid session |
| GPU_group 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 set
get_by_name_label
(session ref, string)
Get all the GPU_group instances with the given label.
| Parameters: | session ref session_id | Reference to a valid session |
| string label | label of object to return |
| Minimum role: | read-only |
| Result: | references to objects with matching names |
| Published in: | XenServer 6.0 (boston) | |
GPU_group ref
get_by_uuid
(session ref, string)
Get a reference to the GPU_group 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) | |
VGPU_type ref set
get_enabled_VGPU_types
(session ref, GPU_group ref)
Get the enabled_VGPU_types field of the given GPU_group.
| Parameters: | session ref session_id | Reference to a valid session |
| GPU_group ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.2 SP1 (vgpu-productisation) | |
string set
get_GPU_types
(session ref, GPU_group ref)
Get the GPU_types field of the given GPU_group.
| Parameters: | session ref session_id | Reference to a valid session |
| GPU_group ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.0 (boston) | |
string
get_name_description
(session ref, GPU_group ref)
Get the name/description field of the given GPU_group.
| Parameters: | session ref session_id | Reference to a valid session |
| GPU_group ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.0 (boston) | |
string
get_name_label
(session ref, GPU_group ref)
Get the name/label field of the given GPU_group.
| Parameters: | session ref session_id | Reference to a valid session |
| GPU_group 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, GPU_group ref)
Get the other_config field of the given GPU_group.
| Parameters: | session ref session_id | Reference to a valid session |
| GPU_group ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.0 (boston) | |
PGPU ref set
get_PGPUs
(session ref, GPU_group ref)
Get the PGPUs field of the given GPU_group.
| Parameters: | session ref session_id | Reference to a valid session |
| GPU_group ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.0 (boston) | |
GPU_group record
get_record
(session ref, GPU_group ref)
Get a record containing the current state of the given GPU_group.
| Parameters: | session ref session_id | Reference to a valid session |
| GPU_group 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, GPU_group ref, VGPU_type ref)
| Parameters: | session ref session_id | Reference to a valid session |
| GPU_group ref self | The GPU group to query |
| VGPU_type ref vgpu_type | The VGPU_type for which the remaining capacity will be calculated |
| Minimum role: | read-only |
| Result: | The number of VGPUs of the given type which can still be started on the PGPUs in the group |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
VGPU_type ref set
get_supported_VGPU_types
(session ref, GPU_group ref)
Get the supported_VGPU_types field of the given GPU_group.
| Parameters: | session ref session_id | Reference to a valid session |
| GPU_group 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_uuid
(session ref, GPU_group ref)
Get the uuid field of the given GPU_group.
| Parameters: | session ref session_id | Reference to a valid session |
| GPU_group ref self | reference to the object |
| Minimum role: | read-only |
| Result: | value of the field |
| Published in: | XenServer 6.0 (boston) | |
VGPU ref set
get_VGPUs
(session ref, GPU_group ref)
Get the VGPUs field of the given GPU_group.
| Parameters: | session ref session_id | Reference to a valid session |
| GPU_group 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, GPU_group ref, string)
Remove the given key and its corresponding value from the other_config field of the given GPU_group. If the key is not in that Map, then do nothing.
| Parameters: | session ref session_id | Reference to a valid session |
| GPU_group ref self | reference to the object |
| string key | Key to remove |
| Minimum role: | pool-operator |
| Published in: | XenServer 6.0 (boston) | |
void
set_allocation_algorithm
(session ref, GPU_group ref, enum allocation_algorithm)
Set the allocation_algorithm field of the given GPU_group.
| Parameters: | session ref session_id | Reference to a valid session |
| GPU_group ref self | reference to the object |
| enum allocation_algorithm value | New value to set |
| Minimum role: | pool-operator |
| Published in: | XenServer 6.2 SP1 Tech-Preview (vgpu-tech-preview) | |
void
set_name_description
(session ref, GPU_group ref, string)
Set the name/description field of the given GPU_group.
| Parameters: | session ref session_id | Reference to a valid session |
| GPU_group ref self | reference to the object |
| string value | New value to set |
| Minimum role: | pool-operator |
| Published in: | XenServer 6.0 (boston) | |
void
set_name_label
(session ref, GPU_group ref, string)
Set the name/label field of the given GPU_group.
| Parameters: | session ref session_id | Reference to a valid session |
| GPU_group ref self | reference to the object |
| string value | New value to set |
| Minimum role: | pool-operator |
| Published in: | XenServer 6.0 (boston) | |
void
set_other_config
(session ref, GPU_group ref, (string → string) map)
Set the other_config field of the given GPU_group.
| Parameters: | session ref session_id | Reference to a valid session |
| GPU_group ref self | reference to the object |
| (string → string) map value | New value to set |
| Minimum role: | pool-operator |
| Published in: | XenServer 6.0 (boston) | |