Develop for XenServer

Class: VM_group

October 11, 2024

Contributed by:

A VM group

Fields for class: VM_group

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: VM_group

RPC name: create

Overview:

Create a new VM_group instance, and return its handle.

Signature:

VM_group ref create (session ref session_ref, VM_group record args)
<!--NeedCopy-->

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 VM_group instance.

Signature:

void destroy (session ref session_ref, VM_group ref self)
<!--NeedCopy-->

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: get_all

Overview:

Return a list of all the VM_groups known to the system.

Signature:

VM_group ref set get_all (session ref session_ref)
<!--NeedCopy-->

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: get_all_records

Overview:

Return a map of VM_group references to VM_group records for all VM_groups known to the system.

Signature:

(VM_group ref -> VM_group record) map get_all_records (session ref session_ref)
<!--NeedCopy-->

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: get_by_name_label

Overview:

Get all the VM_group instances with the given label.

Signature:

VM_group ref set get_by_name_label (session ref session_ref, string label)
<!--NeedCopy-->

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: get_by_uuid

Overview:

Get a reference to the VM_group instance with the specified UUID.

Signature:

VM_group ref get_by_uuid (session ref session_ref, string uuid)
<!--NeedCopy-->

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: get_name_description

Overview:

Get the name/description field of the given VM_group.

Signature:

string get_name_description (session ref session_ref, VM_group ref self)
<!--NeedCopy-->

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: get_name_label

Overview:

Get the name/label field of the given VM_group.

Signature:

string get_name_label (session ref session_ref, VM_group ref self)
<!--NeedCopy-->

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: get_placement

Overview:

Get the placement field of the given VM_group.

Signature:

placement_policy get_placement (session ref session_ref, VM_group ref self)
<!--NeedCopy-->

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: get_record

Overview:

Get a record containing the current state of the given VM_group.

Signature:

VM_group record get_record (session ref session_ref, VM_group ref self)
<!--NeedCopy-->

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: get_uuid

Overview:

Get the uuid field of the given VM_group.

Signature:

string get_uuid (session ref session_ref, VM_group ref self)
<!--NeedCopy-->

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: get_VMs

Overview:

Get the VMs field of the given VM_group.

Signature:

VM ref set get_VMs (session ref session_ref, VM_group ref self)
<!--NeedCopy-->

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: set_name_description

Overview:

Set the name/description field of the given VM_group.

Signature:

void set_name_description (session ref session_ref, VM_group ref self, string value)
<!--NeedCopy-->

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: set_name_label

Overview:

Set the name/label field of the given VM_group.

Signature:

void set_name_label (session ref session_ref, VM_group ref self, string value)
<!--NeedCopy-->

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

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Class: VM_group

October 11, 2024

Contributed by:

October 11, 2024

Contributed by:

Class: VM_group

Fields for class: VM_group

RPCs associated with class: VM_group

RPC name: create

RPC name: destroy

RPC name: get_all

RPC name: get_all_records

RPC name: get_by_name_label

RPC name: get_by_uuid

RPC name: get_name_description

RPC name: get_name_label

RPC name: get_placement

RPC name: get_record

RPC name: get_uuid

RPC name: get_VMs

RPC name: set_name_description

RPC name: set_name_label

In this article