Package com.xensource.xenapi
Class VMGroup
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.VMGroup
A VM group
First published in .
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Represents all the fields in a VMGroup -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionstatic 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 the specified VM_group instance.Destroy the specified VM_group instance.boolean
If obj is a VMGroup, compares XenAPI references for equality.getAll
(Connection c) Return a list of all the VM_groups known to the system.static Map<VMGroup,
VMGroup.Record> Return a map of VM_group references to VM_group records for all VM_groups known to the system.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.Get the name/description field of the given VM_group.Get the name/label field of the given VM_group.Get the placement field of the given VM_group.Get a record containing the current state of the given VM_group.Get the uuid field of the given VM_group.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.Methods inherited from class com.xensource.xenapi.XenAPIObject
isNull
-
Field Details
-
ref
The XenAPI reference (OpaqueRef) to this object.
-
-
Method Details
-
toWireString
- Specified by:
toWireString
in classXenAPIObject
- Returns:
- The XenAPI reference (OpaqueRef) to this object.
-
equals
If obj is a VMGroup, compares XenAPI references for equality. -
hashCode
public int hashCode() -
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 onuuid
- 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 onrecord
- 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 onrecord
- 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 onlabel
- 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 onlabel
- 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 ondescription
- 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.
-