|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xensource.xenapi.XenAPIObject
com.xensource.xenapi.VMAppliance
public class VMAppliance
VM appliance
Nested Class Summary | |
---|---|
static class |
VMAppliance.Record
Represents all the fields in a VMAppliance |
Field Summary | |
---|---|
protected String |
ref
The XenAPI reference (OpaqueRef) to this object. |
Method Summary | |
---|---|
void |
assertCanBeRecovered(Connection c,
Session sessionTo)
Assert whether all SRs required to recover this VM appliance are available. |
Task |
assertCanBeRecoveredAsync(Connection c,
Session sessionTo)
Assert whether all SRs required to recover this VM appliance are available. |
void |
cleanShutdown(Connection c)
Perform a clean shutdown of all the VMs in the appliance |
Task |
cleanShutdownAsync(Connection c)
Perform a clean shutdown of all the VMs in the appliance |
static VMAppliance |
create(Connection c,
VMAppliance.Record record)
Create a new VM_appliance instance, and return its handle. |
static Task |
createAsync(Connection c,
VMAppliance.Record record)
Create a new VM_appliance instance, and return its handle. |
void |
destroy(Connection c)
Destroy the specified VM_appliance instance. |
Task |
destroyAsync(Connection c)
Destroy the specified VM_appliance instance. |
boolean |
equals(Object obj)
If obj is a VMAppliance, compares XenAPI references for equality. |
static Set<VMAppliance> |
getAll(Connection c)
Return a list of all the VM_appliances known to the system. |
Set<Types.VmApplianceOperation> |
getAllowedOperations(Connection c)
Get the allowed_operations field of the given VM_appliance. |
static Map<VMAppliance,VMAppliance.Record> |
getAllRecords(Connection c)
Return a map of VM_appliance references to VM_appliance records for all VM_appliances known to the system. |
static Set<VMAppliance> |
getByNameLabel(Connection c,
String label)
Get all the VM_appliance instances with the given label. |
static VMAppliance |
getByUuid(Connection c,
String uuid)
Get a reference to the VM_appliance instance with the specified UUID. |
Map<String,Types.VmApplianceOperation> |
getCurrentOperations(Connection c)
Get the current_operations field of the given VM_appliance. |
String |
getNameDescription(Connection c)
Get the name/description field of the given VM_appliance. |
String |
getNameLabel(Connection c)
Get the name/label field of the given VM_appliance. |
VMAppliance.Record |
getRecord(Connection c)
Get a record containing the current state of the given VM_appliance. |
String |
getUuid(Connection c)
Get the uuid field of the given VM_appliance. |
Set<VM> |
getVMs(Connection c)
Get the VMs field of the given VM_appliance. |
void |
hardShutdown(Connection c)
Perform a hard shutdown of all the VMs in the appliance |
Task |
hardShutdownAsync(Connection c)
Perform a hard shutdown of all the VMs in the appliance |
int |
hashCode()
|
void |
recover(Connection c,
Session sessionTo,
Boolean force)
Recover the VM appliance |
Task |
recoverAsync(Connection c,
Session sessionTo,
Boolean force)
Recover the VM appliance |
void |
setNameDescription(Connection c,
String description)
Set the name/description field of the given VM_appliance. |
void |
setNameLabel(Connection c,
String label)
Set the name/label field of the given VM_appliance. |
void |
shutdown(Connection c)
For each VM in the appliance, try to shut it down cleanly. |
Task |
shutdownAsync(Connection c)
For each VM in the appliance, try to shut it down cleanly. |
void |
start(Connection c,
Boolean paused)
Start all VMs in the appliance |
Task |
startAsync(Connection c,
Boolean paused)
Start all VMs in the appliance |
String |
toWireString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final String ref
Method Detail |
---|
public String toWireString()
toWireString
in class XenAPIObject
public boolean equals(Object obj)
equals
in class Object
public int hashCode()
hashCode
in class Object
public VMAppliance.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static VMAppliance getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
uuid
- UUID of object to return
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Task createAsync(Connection c, VMAppliance.Record record) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
record
- All constructor arguments
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static VMAppliance create(Connection c, VMAppliance.Record record) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
record
- All constructor arguments
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Task destroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Set<VMAppliance> getByNameLabel(Connection c, String label) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
label
- label of object to return
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public String getNameLabel(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public String getNameDescription(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Set<Types.VmApplianceOperation> getAllowedOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Map<String,Types.VmApplianceOperation> getCurrentOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Set<VM> getVMs(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setNameLabel(Connection c, String label) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
label
- New value to set
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setNameDescription(Connection c, String description) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
description
- New value to set
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Task startAsync(Connection c, Boolean paused) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.OperationPartiallyFailed
paused
- Instantiate all VMs belonging to this appliance in paused state if set to true.
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.OperationPartiallyFailed
public void start(Connection c, Boolean paused) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.OperationPartiallyFailed
paused
- Instantiate all VMs belonging to this appliance in paused state if set to true.
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.OperationPartiallyFailed
public Task cleanShutdownAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.OperationPartiallyFailed
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.OperationPartiallyFailed
public void cleanShutdown(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.OperationPartiallyFailed
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.OperationPartiallyFailed
public Task hardShutdownAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.OperationPartiallyFailed
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.OperationPartiallyFailed
public void hardShutdown(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.OperationPartiallyFailed
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.OperationPartiallyFailed
public Task shutdownAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.OperationPartiallyFailed
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.OperationPartiallyFailed
public void shutdown(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.OperationPartiallyFailed
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.OperationPartiallyFailed
public Task assertCanBeRecoveredAsync(Connection c, Session sessionTo) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.VmRequiresSr
sessionTo
- The session to which the VM appliance is to be recovered.
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.VmRequiresSr
public void assertCanBeRecovered(Connection c, Session sessionTo) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.VmRequiresSr
sessionTo
- The session to which the VM appliance is to be recovered.
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.VmRequiresSr
public Task recoverAsync(Connection c, Session sessionTo, Boolean force) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.VmRequiresSr
sessionTo
- The session to which the VM appliance is to be recovered.force
- Whether the VMs should replace newer versions of themselves.
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.VmRequiresSr
public void recover(Connection c, Session sessionTo, Boolean force) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.VmRequiresSr
sessionTo
- The session to which the VM appliance is to be recovered.force
- Whether the VMs should replace newer versions of themselves.
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.VmRequiresSr
public static Set<VMAppliance> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Map<VMAppliance,VMAppliance.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |