Class: VMgroup

Last published : Oct 01, 2026
A VM group
Related information
XenServer 9 Management API

Fields for class: VMgroup

Field Type Qualifier Description
name_description string RW a notes field containing human-readable description
name_label string RW a human-readable name
placement placement_policy RO/constructor The placement policy of the VM group
uuid string RO/runtime Unique identifier/object reference
VMs VM ref set RO/runtime The list of VMs associated with the group

RPCs associated with class: VMgroup

RPC name: create

Overview:
Create a new VMgroup instance, and return its handle.
Signature:
VM_group ref create (session ref session_ref, VM_group record args)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_group record args All constructor arguments
Minimum Role: vm-admin
Return Type: VM_group ref
reference to the newly created object

RPC name: destroy

Overview:
Destroy the specified VMgroup instance.
Signature:
void destroy (session ref session_ref, VM_group ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_group ref self reference to the object
Minimum Role: vm-admin
Return Type: void

RPC name: getall

Overview:
Return a list of all the VMgroups known to the system.
Signature:
VM_group ref set get_all (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: VM_group ref set
references to all objects

RPC name: getallrecords

Overview:
Return a map of VMgroup references to VMgroup records for all VMgroups known to the system.
Signature:
(VM_group ref -> VM_group record) map get_all_records (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: (VM_group ref -> VM_group record) map
records of all objects

RPC name: getbynamelabel

Overview:
Get all the VMgroup instances with the given label.
Signature:
VM_group ref set get_by_name_label (session ref session_ref, string label)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
string label label of object to return
Minimum Role: read-only
Return Type: VM_group ref set
references to objects with matching names

RPC name: getbyuuid

Overview:
Get a reference to the VMgroup instance with the specified UUID.
Signature:
VM_group ref get_by_uuid (session ref session_ref, string uuid)
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: VM_group ref
reference to the object

RPC name: getnamedescription

Overview:
Get the name/description field of the given VMgroup.
Signature:
string get_name_description (session ref session_ref, VM_group ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_group ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getnamelabel

Overview:
Get the name/label field of the given VMgroup.
Signature:
string get_name_label (session ref session_ref, VM_group ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_group ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getplacement

Overview:
Get the placement field of the given VMgroup.
Signature:
placement_policy get_placement (session ref session_ref, VM_group ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_group ref self reference to the object
Minimum Role: read-only
Return Type: placement_policy
value of the field

RPC name: getrecord

Overview:
Get a record containing the current state of the given VMgroup.
Signature:
VM_group record get_record (session ref session_ref, VM_group ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_group ref self reference to the object
Minimum Role: read-only
Return Type: VM_group record
all fields from the object

RPC name: getuuid

Overview:
Get the uuid field of the given VMgroup.
Signature:
string get_uuid (session ref session_ref, VM_group ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_group ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getVMs

Overview:
Get the VMs field of the given VMgroup.
Signature:
VM ref set get_VMs (session ref session_ref, VM_group ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_group ref self reference to the object
Minimum Role: read-only
Return Type: VM ref set
value of the field

RPC name: setnamedescription

Overview:
Set the name/description field of the given VMgroup.
Signature:
void set_name_description (session ref session_ref, VM_group ref self, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_group ref self reference to the object
string value New value to set
Minimum Role: vm-admin
Return Type: void

RPC name: setnamelabel

Overview:
Set the name/label field of the given VMgroup.
Signature:
void set_name_label (session ref session_ref, VM_group ref self, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
VM_group ref self reference to the object
string value New value to set
Minimum Role: vm-admin
Return Type: void