Prototype
Class: VM_group
A VM group
| Prototyped in: |
XAPI 24.19.1 (24.19.1) |
|
Enums
placement_policy
| Values: |
anti_affinity |
Anti-affinity placement policy |
|
normal |
Default placement policy |
Fields
Prototype
VM ref set
VMs
[RO/runtime]
The list of VMs associated with the group
| Prototyped in: |
XAPI 24.19.1 (24.19.1) |
|
string
name_description
[RW]
a notes field containing human-readable description
| Default value: |
"" |
| Published in: |
XenServer 4.0 (rio) |
a notes field containing human-readable description |
string
name_label
[RW]
a human-readable name
| Default value: |
"" |
| Published in: |
XenServer 4.0 (rio) |
a human-readable name |
Prototype
enum placement_policy
placement
[RO/constructor]
The placement policy of the VM group
| Default value: |
normal |
| Prototyped in: |
XAPI 24.19.1 (24.19.1) |
|
string
uuid
[RO/runtime]
Unique identifier/object reference
| Published in: |
XenServer 4.0 (rio) |
Unique identifier/object reference |
Messages
Prototype
VM_group ref
create
(session ref, VM_group record)
Create a new VM_group instance, and return its handle.
The constructor args are: name_label, name_description, placement (* = non-optional).
| Parameters: |
session ref session_id |
Reference to a valid session |
|
VM_group record args |
All constructor arguments |
| Minimum role: |
vm-admin |
| Result: |
reference to the newly created object |
| Prototyped in: |
XAPI 24.19.1 (24.19.1) |
|
Prototype
void
destroy
(session ref, VM_group ref)
Destroy the specified VM_group instance.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
VM_group ref self |
reference to the object |
| Minimum role: |
vm-admin |
| Prototyped in: |
XAPI 24.19.1 (24.19.1) |
|
Prototype
VM ref set
get_VMs
(session ref, VM_group ref)
Get the VMs field of the given VM_group.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
VM_group ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Prototyped in: |
XAPI 24.19.1 (24.19.1) |
|
Prototype
VM_group ref set
get_all
(session ref)
Return a list of all the VM_groups known to the system.
| Parameters: |
session ref session_id |
Reference to a valid session |
| Minimum role: |
read-only |
| Result: |
references to all objects |
| Prototyped in: |
XAPI 24.19.1 (24.19.1) |
|
Prototype
(VM_group ref → VM_group record) map
get_all_records
(session ref)
Return a map of VM_group references to VM_group records for all VM_groups known to the system.
| Parameters: |
session ref session_id |
Reference to a valid session |
| Minimum role: |
read-only |
| Result: |
records of all objects |
| Prototyped in: |
XAPI 24.19.1 (24.19.1) |
|
Prototype
VM_group ref set
get_by_name_label
(session ref, string)
Get all the VM_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 |
| Prototyped in: |
XAPI 24.19.1 (24.19.1) |
|
Prototype
VM_group ref
get_by_uuid
(session ref, string)
Get a reference to the VM_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 |
| Prototyped in: |
XAPI 24.19.1 (24.19.1) |
|
string
get_name_description
(session ref, VM_group ref)
Get the name/description field of the given VM_group.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
VM_group ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Published in: |
XenServer 4.0 (rio) |
a notes field containing human-readable description |
string
get_name_label
(session ref, VM_group ref)
Get the name/label field of the given VM_group.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
VM_group ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Published in: |
XenServer 4.0 (rio) |
a human-readable name |
Prototype
enum placement_policy
get_placement
(session ref, VM_group ref)
Get the placement field of the given VM_group.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
VM_group ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Prototyped in: |
XAPI 24.19.1 (24.19.1) |
|
Prototype
VM_group record
get_record
(session ref, VM_group ref)
Get a record containing the current state of the given VM_group.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
VM_group ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
all fields from the object |
| Prototyped in: |
XAPI 24.19.1 (24.19.1) |
|
string
get_uuid
(session ref, VM_group ref)
Get the uuid field of the given VM_group.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
VM_group ref self |
reference to the object |
| Minimum role: |
read-only |
| Result: |
value of the field |
| Published in: |
XenServer 4.0 (rio) |
Unique identifier/object reference |
void
set_name_description
(session ref, VM_group ref, string)
Set the name/description field of the given VM_group.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
VM_group ref self |
reference to the object |
|
string value |
New value to set |
| Minimum role: |
vm-admin |
| Published in: |
XenServer 4.0 (rio) |
a notes field containing human-readable description |
void
set_name_label
(session ref, VM_group ref, string)
Set the name/label field of the given VM_group.
| Parameters: |
session ref session_id |
Reference to a valid session |
|
VM_group ref self |
reference to the object |
|
string value |
New value to set |
| Minimum role: |
vm-admin |
| Published in: |
XenServer 4.0 (rio) |
a human-readable name |
