Citrix Systems 6 Server User Manual


 
125
Parameter Name Description Type
vm-uuid The unique identifier/object
reference for the VM to which
the vGPU is assigned
Read only
vm-name-label The name of the VM to which
the vGPU is assigned
Read only
gpu-group-uuid The unique identifier/object
reference for the GPU group in
which the vGPU is contained
Read only
gpu-group-name-label The name of the GPU group in
which the vGPU is contained
Read only
currently-attached True if a VM with GPU Pass-
Through is running, false
otherwise
Read only
other-config A list of key/value pairs that
specify additional configuration
parameters for the vGPU
Read/write map parameter
vgpu-create
vgpu-create vm-uuid=<uuid_of_vm> gpu_group_uuid=<uuid_of_gpu_group>
Create a vGPU. This command attaches the VM to the specified GPU group.
vgpu-destroy
vgpu-destroy uuid=<uuid_of_vgpu>
Destroy a vGPU. This command detaches the VM from the associated GPU group.
Host Commands
Commands for interacting with XenServer host.
XenServer hosts are the physical servers running XenServer software. They have VMs running on them under the
control of a special privileged Virtual Machine, known as the control domain or domain 0.
The XenServer host objects can be listed with the standard object listing command (xe host-list, xe host-cpu-list,
and xe host-crashdump-list), and the parameters manipulated with the standard parameter commands. See the
section called “Low-level Parameter Commands” for details.
Host Selectors
Several of the commands listed here have a common mechanism for selecting one or more XenServer hosts on
which to perform the operation. The simplest is by supplying the argument host=<uuid_or_name_label>.
XenServer hosts can also be specified by filtering the full list of hosts on the values of fields. For example,
specifying enabled=true will select all XenServer hosts whose enabled field is equal to true. Where
multiple XenServer hosts are matching, and the operation can be performed on multiple XenServer hosts,
the option --multiple must be specified to perform the operation. The full list of parameters that can be
matched is described at the beginning of this section, and can be obtained by running the command xe host-
list params=all. If no parameters to select XenServer hosts are given, the operation will be performed on all
XenServer hosts.