VirtualBox Main API
|
Virtual virtual machine (sic) in the cloud. More...
Public Member Functions | |
void | refresh ([retval] out IProgress progress) |
Refresh information by reading it from the cloud. | |
void | getDetailsForm ([retval] out IForm form) |
Obtain a form with the current settings for this cloud machine. | |
void | getSettingsForm (out IForm form, [retval] out IProgress progress) |
Obtain a form with settings for this cloud machine. | |
void | powerUp ([retval] out IProgress progress) |
Start cloud virtual machine execution. | |
void | reboot ([retval] out IProgress progress) |
Reboot cloud virtual machine. | |
void | reset ([retval] out IProgress progress) |
Forcing reset or hard reset of a cloud virtual machine. | |
void | shutdown ([retval] out IProgress progress) |
Shutdown cloud virtual machine. | |
void | powerDown ([retval] out IProgress progress) |
Initiates the power down procedure to stop the virtual machine execution. | |
void | terminate ([retval] out IProgress progress) |
Terminate cloud virtual machine. | |
void | unregister ([retval] out IProgress progress) |
Unregister this cloud machine, but leave the cloud artifacts intact. | |
void | remove ([retval] out IProgress progress) |
Unregister this cloud machine and delete all its cloud artifacts. | |
void | getConsoleHistory (out IDataStream stream, [retval] out IProgress progress) |
Get the backlog of the machine's console. | |
void | createConsoleConnection (in wstring sshPublicKey, [retval] out IProgress progress) |
void | deleteConsoleConnection ([retval] out IProgress progress) |
Public Attributes | |
readonly attribute wstringUUID | id |
UUID of the cloud machine. | |
readonly attribute boolean | accessible |
Whether this virtual machine is currently accessible or not. | |
readonly attribute IVirtualBoxErrorInfo | accessError |
Error information describing the reason of machine inaccessibility. | |
readonly attribute wstring | name |
Convenience shortcut to retrieve the name of the cloud machine. | |
readonly attribute wstring | OSTypeId |
Convenience shortcut to retrieve the OS Type id of the cloud machine. | |
readonly attribute CloudMachineState | state |
Machine state. | |
readonly attribute wstring | consoleConnectionFingerprint |
The fingerprint of the ssh key that is authorized to access the machine's console connection. | |
readonly attribute wstring | serialConsoleCommand |
The shell command to establish ssh connection to the cloud machine serial console. | |
readonly attribute wstring | serialConsoleCommandWindows |
The PowerShell command to establish ssh connection to the cloud machine serial console using PuTTY's plink. | |
readonly attribute wstring | VNCConsoleCommand |
The shell command to establish ssh port forwarding for the VNC connection to the cloud machine console. | |
readonly attribute wstring | VNCConsoleCommandWindows |
The PowerShell command to establish ssh port forwarding for the VNC connection to the cloud machine console using PuTTY's plink. | |
Virtual virtual machine (sic) in the cloud.
Reading object attributes returns cached values, use refresh to refresh them.
{147816C8-17E0-11EB-81FA-87CEA6263E1A}
void ICloudMachine::refresh | ( | [retval] out IProgress | progress | ) |
Refresh information by reading it from the cloud.
progress | Progress object to track the operation completion. |
void ICloudMachine::getDetailsForm | ( | [retval] out IForm | form | ) |
Obtain a form with the current settings for this cloud machine.
The form is not editable.
form | A form with the cloud machine settings. |
Obtain a form with settings for this cloud machine.
The form is editable.
form | A form with the cloud machine settings. |
progress | Progress object to track the operation completion. |
void ICloudMachine::powerUp | ( | [retval] out IProgress | progress | ) |
Start cloud virtual machine execution.
progress | Progress object to track the operation completion. |
void ICloudMachine::reboot | ( | [retval] out IProgress | progress | ) |
Reboot cloud virtual machine.
progress | Progress object to track the operation completion. |
void ICloudMachine::reset | ( | [retval] out IProgress | progress | ) |
Forcing reset or hard reset of a cloud virtual machine.
progress | Progress object to track the operation completion. |
void ICloudMachine::shutdown | ( | [retval] out IProgress | progress | ) |
Shutdown cloud virtual machine.
progress | Progress object to track the operation completion. |
void ICloudMachine::powerDown | ( | [retval] out IProgress | progress | ) |
Initiates the power down procedure to stop the virtual machine execution.
The completion of the power down procedure is tracked using the returned IProgress object. After the operation is complete, the machine will go to the PoweredOff state.
progress | Progress object to track the operation completion. |
VBOX_E_INVALID_VM_STATE | Virtual machine must be Running, to be powered down. |
void ICloudMachine::terminate | ( | [retval] out IProgress | progress | ) |
Terminate cloud virtual machine.
progress | Progress object to track the operation completion. |
void ICloudMachine::unregister | ( | [retval] out IProgress | progress | ) |
Unregister this cloud machine, but leave the cloud artifacts intact.
progress | Progress object to track the operation completion. |
void ICloudMachine::remove | ( | [retval] out IProgress | progress | ) |
Unregister this cloud machine and delete all its cloud artifacts.
progress | Progress object to track the operation completion. |
void ICloudMachine::getConsoleHistory | ( | out IDataStream | stream, |
[retval] out IProgress | progress | ||
) |
Get the backlog of the machine's console.
If you have ever seen console teletypes, this is like looking at the last few meters of the paper it spewed.
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. |
progress | Progress object to track the operation completion. |
void ICloudMachine::createConsoleConnection | ( | in wstring | sshPublicKey, |
[retval] out IProgress | progress | ||
) |
void ICloudMachine::deleteConsoleConnection | ( | [retval] out IProgress | progress | ) |
readonly attribute wstringUUID ICloudMachine::id |
UUID of the cloud machine.
readonly attribute boolean ICloudMachine::accessible |
Whether this virtual machine is currently accessible or not.
TBD...
readonly attribute IVirtualBoxErrorInfo ICloudMachine::accessError |
Error information describing the reason of machine inaccessibility.
Reading this property is only valid after the last call to accessible returned false
(i.e. the machine is currently inaccessible). Otherwise, a null
IVirtualBoxErrorInfo object will be returned.
readonly attribute wstring ICloudMachine::name |
Convenience shortcut to retrieve the name of the cloud machine.
The name is part of the machine settings that are hidden behind the settings form (see getSettingsForm).
readonly attribute wstring ICloudMachine::OSTypeId |
Convenience shortcut to retrieve the OS Type id of the cloud machine.
It is part of the machine settings that are hidden behind the settings form (see getSettingsForm).
readonly attribute CloudMachineState ICloudMachine::state |
Machine state.
readonly attribute wstring ICloudMachine::consoleConnectionFingerprint |
The fingerprint of the ssh key that is authorized to access the machine's console connection.
readonly attribute wstring ICloudMachine::serialConsoleCommand |
The shell command to establish ssh connection to the cloud machine serial console.
readonly attribute wstring ICloudMachine::serialConsoleCommandWindows |
The PowerShell command to establish ssh connection to the cloud machine serial console using PuTTY's plink.
readonly attribute wstring ICloudMachine::VNCConsoleCommand |
The shell command to establish ssh port forwarding for the VNC connection to the cloud machine console.
readonly attribute wstring ICloudMachine::VNCConsoleCommandWindows |
The PowerShell command to establish ssh port forwarding for the VNC connection to the cloud machine console using PuTTY's plink.