Package com.xensource.xenapi

Class VMGroup

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.VMGroup

public class VMGroup
extends XenAPIObject

A VM group First published in .

Author:

Cloud Software Group, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VMGroup.Record	Represents all the fields in a VMGroup

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	ref	The XenAPI reference (OpaqueRef) to this object.

Method Summary

Modifier and Type	Method	Description
static VMGroup	create(Connection c, VMGroup.Record record)	Create a new VM_group instance, and return its handle.
static Task	createAsync(Connection c, VMGroup.Record record)	Create a new VM_group instance, and return its handle.
void	destroy(Connection c)	Destroy the specified VM_group instance.
Task	destroyAsync(Connection c)	Destroy the specified VM_group instance.
boolean	equals(Object obj)	If obj is a VMGroup, compares XenAPI references for equality.
static Set<VMGroup>	getAll(Connection c)	Return a list of all the VM_groups known to the system.
static Map<VMGroup,VMGroup.Record>	getAllRecords(Connection c)	Return a map of VM_group references to VM_group records for all VM_groups known to the system.
static Set<VMGroup>	getByNameLabel(Connection c, String label)	Get all the VM_group instances with the given label.
static VMGroup	getByUuid(Connection c, String uuid)	Get a reference to the VM_group instance with the specified UUID.
String	getNameDescription(Connection c)	Get the name/description field of the given VM_group.
String	getNameLabel(Connection c)	Get the name/label field of the given VM_group.
Types.PlacementPolicy	getPlacement(Connection c)	Get the placement field of the given VM_group.
VMGroup.Record	getRecord(Connection c)	Get a record containing the current state of the given VM_group.
String	getUuid(Connection c)	Get the uuid field of the given VM_group.
Set<VM>	getVMs(Connection c)	Get the VMs field of the given VM_group.
int	hashCode()
void	setNameDescription(Connection c, String description)	Set the name/description field of the given VM_group.
void	setNameLabel(Connection c, String label)	Set the name/label field of the given VM_group.
String	toWireString()

Methods inherited from class com.xensource.xenapi.XenAPIObject

isNull

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

ref

protected final String ref

The XenAPI reference (OpaqueRef) to this object.

Method Details

toWireString

public String toWireString()

Specified by:

toWireString in class XenAPIObject

Returns:

The XenAPI reference (OpaqueRef) to this object.

equals

public boolean equals(Object obj)

If obj is a VMGroup, compares XenAPI references for equality.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getRecord

public VMGroup.Record getRecord(Connection c)
                         throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get a record containing the current state of the given VM_group. Minimum allowed role: read-only Experimental. First published in 24.19.1.

Parameters:

c - The connection the call is made on

Returns:

all fields from the object

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getByUuid

public static VMGroup getByUuid(Connection c,
 String uuid)
                         throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get a reference to the VM_group instance with the specified UUID. Minimum allowed role: read-only Experimental. First published in 24.19.1.

Parameters:

c - The connection the call is made on

uuid - UUID of object to return

Returns:

reference to the object

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

create

public static VMGroup create(Connection c,
 VMGroup.Record record)
                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Create a new VM_group instance, and return its handle. Minimum allowed role: vm-admin Experimental. First published in 24.19.1.

Parameters:

c - The connection the call is made on

record - All constructor arguments

Returns:

reference to the newly created object

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

createAsync

public static Task createAsync(Connection c,
 VMGroup.Record record)
                        throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Create a new VM_group instance, and return its handle. Minimum allowed role: vm-admin Experimental. First published in 24.19.1.

Parameters:

c - The connection the call is made on

record - All constructor arguments

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

destroy

public void destroy(Connection c)
             throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Destroy the specified VM_group instance. Minimum allowed role: vm-admin Experimental. First published in 24.19.1.

Parameters:

c - The connection the call is made on

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

destroyAsync

public Task destroyAsync(Connection c)
                  throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Destroy the specified VM_group instance. Minimum allowed role: vm-admin Experimental. First published in 24.19.1.

Parameters:

c - The connection the call is made on

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getByNameLabel

public static Set<VMGroup> getByNameLabel(Connection c,
 String label)
                                   throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get all the VM_group instances with the given label. Minimum allowed role: read-only Experimental. First published in 24.19.1.

Parameters:

c - The connection the call is made on

label - label of object to return

Returns:

references to objects with matching names

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getUuid

public String getUuid(Connection c)
               throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the uuid field of the given VM_group. Minimum allowed role: read-only First published in XenServer 4.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getNameLabel

public String getNameLabel(Connection c)
                    throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the name/label field of the given VM_group. Minimum allowed role: read-only First published in XenServer 4.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getNameDescription

public String getNameDescription(Connection c)
                          throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the name/description field of the given VM_group. Minimum allowed role: read-only First published in XenServer 4.0.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getPlacement

public Types.PlacementPolicy getPlacement(Connection c)
                                   throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the placement field of the given VM_group. Minimum allowed role: read-only Experimental. First published in 24.19.1.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getVMs

public Set<VM> getVMs(Connection c)
               throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the VMs field of the given VM_group. Minimum allowed role: read-only Experimental. First published in 24.19.1.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

setNameLabel

public void setNameLabel(Connection c,
 String label)
                  throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Set the name/label field of the given VM_group. Minimum allowed role: vm-admin First published in XenServer 4.0.

Parameters:

c - The connection the call is made on

label - New value to set

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

setNameDescription

public void setNameDescription(Connection c,
 String description)
                        throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Set the name/description field of the given VM_group. Minimum allowed role: vm-admin First published in XenServer 4.0.

Parameters:

c - The connection the call is made on

description - New value to set

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getAll

public static Set<VMGroup> getAll(Connection c)
                           throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Return a list of all the VM_groups known to the system. Minimum allowed role: read-only Experimental. First published in 24.19.1.

Parameters:

c - The connection the call is made on

Returns:

references to all objects

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getAllRecords

public static Map<VMGroup,VMGroup.Record> getAllRecords(Connection c)
                                                 throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Return a map of VM_group references to VM_group records for all VM_groups known to the system. Minimum allowed role: read-only Experimental. First published in 24.19.1.

Parameters:

c - The connection the call is made on

Returns:

records of all objects

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.