Struct xo_api_client::api::vm::VmProcedures

pub struct VmProcedures { /* fields omitted */ }

Implementations

impl VmProcedures

pub async fn restart_nonblocking(&self, vm_id: VmId) -> Result<(), RestartError>

This function will try to initiate a soft restart of the VM The there is no guarantee that the VM has started once the returned future resolves

xo-cli: vm.restart id= [force=]

pub async fn snapshot(
    &self,
    vm_id: VmId,
    name: String,
    description: String,
    save_memory: bool
) -> Result<SnapshotId, RpcError>

Create snapshot of the specified VM

save_memory: Should the RAM memory of the VM be saved? Setting this to true does make the snapshot take a lot more time, may even freeze the VM for some time. If you are unsure, set this to false

xo-cli: vm.snapshot [description=] id= [name=] [saveMemory=]

pub async fn revert(
    &self,
    snapshot_id: SnapshotId
) -> Result<(), RevertSnapshotError>

Roll back Vm to an earlier snapshot

xo-cli: vm.revert snapshot=

pub async fn delete(
    &self,
    vm_or_snapshot_id: impl Into<VmOrSnapshotId>
) -> Result<(), RpcError>

This may be used for deleting snapshots as well as entire VMs, so be careful!

xo-cli: vm.delete id=