|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.virtualbox_7_1.IUnknown
org.virtualbox_7_1.ICloudMachine
public class ICloudMachine
Virtual virtual machine (sic) in the cloud.
Reading object attributes returns cached values, userefresh()
to refresh them.
Interface ID: {147816C8-17E0-11EB-81FA-87CEA6263E1A}
Field Summary |
---|
Fields inherited from class org.virtualbox_7_1.IUnknown |
---|
obj, objMgr, port |
Constructor Summary | |
---|---|
ICloudMachine(java.lang.String wrapped,
org.virtualbox_7_1.ObjectRefManager objMgr,
org.virtualbox_7_1.jaxws.VboxPortType port)
|
Method Summary | |
---|---|
IProgress |
createConsoleConnection(java.lang.String sshPublicKey)
|
IProgress |
deleteConsoleConnection()
|
IProgress |
enumerateMetricData(MetricType metricType,
java.lang.Long pointsNumber,
Holder<IStringArray> values,
Holder<IStringArray> timestamps,
Holder<IStringArray> unit)
Returns the interested metric history points. |
IVirtualBoxErrorInfo |
getAccessError()
Error information describing the reason of machine inaccessibility. |
java.lang.Boolean |
getAccessible()
Whether this virtual machine is currently accessible or not. |
java.lang.String |
getCloudId()
UUID of the cloud machine within Cloud |
java.lang.String |
getConsoleConnectionFingerprint()
The fingerprint of the ssh key that is authorized to access the machine's console connection. |
IProgress |
getConsoleHistory(Holder<IDataStream> stream)
Get the backlog of the machine's console. |
IForm |
getDetailsForm()
Obtain a form with the current settings for this cloud machine. |
java.lang.String |
getId()
UUID of the cloud machine within VirtualBox. |
java.lang.String |
getName()
Convenience shortcut to retrieve the name of the cloud machine. |
java.lang.String |
getOSTypeId()
Convenience shortcut to retrieve the OS Type id of the cloud machine. |
java.lang.String |
getSerialConsoleCommand()
The shell command to establish ssh connection to the cloud machine serial console. |
java.lang.String |
getSerialConsoleCommandWindows()
The PowerShell command to establish ssh connection to the cloud machine serial console using PuTTY's plink. |
IProgress |
getSettingsForm(Holder<IForm> form)
Obtain a form with settings for this cloud machine. |
CloudMachineState |
getState()
Machine state. |
java.lang.String |
getVNCConsoleCommand()
The shell command to establish ssh port forwarding for the VNC connection to the cloud machine console. |
java.lang.String |
getVNCConsoleCommandWindows()
The PowerShell command to establish ssh port forwarding for the VNC connection to the cloud machine console using PuTTY's plink. |
IProgress |
listMetricNames(Holder<IStringArray> metricNames)
Returns the metrics available for the instances in the Cloud. |
IProgress |
powerDown()
Initiates the power down procedure to stop the virtual machine execution. |
IProgress |
powerUp()
Start cloud virtual machine execution. |
static ICloudMachine |
queryInterface(IUnknown obj)
|
IProgress |
reboot()
Reboot cloud virtual machine. |
IProgress |
refresh()
Refresh information by reading it from the cloud. |
IProgress |
remove()
Unregister this cloud machine and delete all its cloud artifacts. |
IProgress |
reset()
Forcing reset or hard reset of a cloud virtual machine. |
IProgress |
shutdown()
Shutdown cloud virtual machine. |
IProgress |
terminate()
Terminate cloud virtual machine. |
IProgress |
unregister()
Unregister this cloud machine, but leave the cloud artifacts intact. |
Methods inherited from class org.virtualbox_7_1.IUnknown |
---|
getObjMgr, getRemoteWSPort, getWrapped, releaseRemote |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ICloudMachine(java.lang.String wrapped, org.virtualbox_7_1.ObjectRefManager objMgr, org.virtualbox_7_1.jaxws.VboxPortType port)
Method Detail |
---|
public java.lang.String getId()
public java.lang.String getCloudId()
public java.lang.Boolean getAccessible()
public IVirtualBoxErrorInfo getAccessError()
getAccessible()
returned false (i.e. the
machine is currently inaccessible). Otherwise, a null
IVirtualBoxErrorInfo object will be returned.
public java.lang.String getName()
getSettingsForm(Holder)
).
public java.lang.String getOSTypeId()
getSettingsForm(Holder)
).
public CloudMachineState getState()
public java.lang.String getConsoleConnectionFingerprint()
public java.lang.String getSerialConsoleCommand()
public java.lang.String getSerialConsoleCommandWindows()
public java.lang.String getVNCConsoleCommand()
public java.lang.String getVNCConsoleCommandWindows()
public static ICloudMachine queryInterface(IUnknown obj)
public IProgress refresh()
public IForm getDetailsForm()
public IProgress getSettingsForm(Holder<IForm> form)
form
- A form with the cloud machine settings.
public IProgress powerUp()
public IProgress reboot()
public IProgress reset()
public IProgress shutdown()
public IProgress powerDown()
VBOX_E_INVALID_VM_STATE
- Virtual machine must be Running, to be powered down.
public IProgress terminate()
public IProgress unregister()
public IProgress remove()
public IProgress getConsoleHistory(Holder<IDataStream> stream)
stream
- Data stream object for reading the console history. For now
we are abusing/repurposing this interface from the media
convertion API to avoid marshalling a huge string through
xpcom.
public IProgress createConsoleConnection(java.lang.String sshPublicKey)
public IProgress deleteConsoleConnection()
public IProgress listMetricNames(Holder<IStringArray> metricNames)
ICloudClient.getMetricTypeByName(String)
.
metricNames
- List of metrics names. May be empty if there are no metrics available on the instance or
if the corresponding service is not running on the instance.
public IProgress enumerateMetricData(MetricType metricType, java.lang.Long pointsNumber, Holder<IStringArray> values, Holder<IStringArray> timestamps, Holder<IStringArray> unit)
metricType
- The type of the requested metric.
Standard usage to get an appropriate MetricType:
- calllistMetricNames(Holder)
function; returns the types in string representation.
- callICloudClient.getMetricTypeByName(String)
function; converts the string representation into MetricType.pointsNumber
- History metric point numbers start at 1 and can go backwards as long as history exists.
Points are counted from the current time to the past. If user only wants the last actual value
he passes the value "1". If 2 values need to be returned (last and second to last),
the user passes "2", etc.
and etc.values
- The values of the metric returned.timestamps
- The timestamps of the metric returned. The array entries match
the corresponding entries in the array.
Time format is represented in Rfc2822.unit
- The measurement unit as "byte", "percentage" and etc...
The array entries match the corresponding entries in the array.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |