VmmAction

vmm::rpc_interface

Enum VmmAction 

Source 
pub enum VmmAction {

Show 39 variants    ConfigureBootSource(BootSourceConfig),
    ConfigureLogger(LoggerConfig),
    ConfigureMetrics(MetricsConfig),
    ConfigureSerial(SerialConfig),
    CreateSnapshot(CreateSnapshotParams),
    GetBalloonConfig,
    GetBalloonStats,
    GetFullVmConfig,
    GetMMDS,
    GetVmMachineConfig,
    GetVmInstanceInfo,
    GetVmmVersion,
    FlushMetrics,
    InsertBlockDevice(BlockDeviceConfig),
    InsertPmemDevice(PmemConfig),
    InsertNetworkDevice(NetworkInterfaceConfig),
    LoadSnapshot(LoadSnapshotParams),
    PatchMMDS(Value),
    Pause,
    PutMMDS(Value),
    PutCpuConfiguration(CustomCpuTemplate),
    Resume,
    SetBalloonDevice(BalloonDeviceConfig),
    SetMmdsConfiguration(MmdsConfig),
    SetVsockDevice(VsockDeviceConfig),
    SetEntropyDevice(EntropyDeviceConfig),
    GetMemoryHotplugStatus,
    SetMemoryHotplugDevice(MemoryHotplugConfig),
    UpdateMemoryHotplugSize(MemoryHotplugSizeUpdate),
    StartMicroVm,
    SendCtrlAltDel,
    UpdateBalloon(BalloonUpdateConfig),
    UpdateBalloonStatistics(BalloonUpdateStatsConfig),
    StartFreePageHinting(StartHintingCmd),
    GetFreePageHintingStatus,
    StopFreePageHinting,
    UpdateBlockDevice(BlockDeviceUpdateConfig),
    UpdateNetworkInterface(NetworkInterfaceUpdateConfig),
    UpdateMachineConfiguration(MachineConfigUpdate),

}
Expand description

This enum represents the public interface of the VMM. Each action contains various bits of information (ids, paths, etc.).

Variants§

§

ConfigureBootSource(BootSourceConfig)

Configure the boot source of the microVM using as input the ConfigureBootSource. This action can only be called before the microVM has booted.

§

ConfigureLogger(LoggerConfig)

Configure the logger using as input the LoggerConfig. This action can only be called before the microVM has booted.

§

ConfigureMetrics(MetricsConfig)

Configure the metrics using as input the MetricsConfig. This action can only be called before the microVM has booted.

§

ConfigureSerial(SerialConfig)

Configure the serial device. This action can only be called before the microVM has booted.

§

CreateSnapshot(CreateSnapshotParams)

Create a snapshot using as input the CreateSnapshotParams. This action can only be called after the microVM has booted and only when the microVM is in Paused state.

§

GetBalloonConfig

Get the balloon device configuration.

§

GetBalloonStats

Get the ballon device latest statistics.

§

GetFullVmConfig

Get complete microVM configuration in JSON format.

§

GetMMDS

Get MMDS contents.

§

GetVmMachineConfig

Get the machine configuration of the microVM.

§

GetVmInstanceInfo

Get microVM instance information.

§

GetVmmVersion

Get microVM version.

§

FlushMetrics

Flush the metrics. This action can only be called after the logger has been configured.

§

InsertBlockDevice(BlockDeviceConfig)

Add a new block device or update one that already exists using the BlockDeviceConfig as input. This action can only be called before the microVM has booted.

§

InsertPmemDevice(PmemConfig)

Add a virtio-pmem device.

§

InsertNetworkDevice(NetworkInterfaceConfig)

Add a new network interface config or update one that already exists using the NetworkInterfaceConfig as input. This action can only be called before the microVM has booted.

§

LoadSnapshot(LoadSnapshotParams)

Load the microVM state using as input the LoadSnapshotParams. This action can only be called before the microVM has booted. If this action is successful, the loaded microVM will be in Paused state. Should change this state to Resumed for the microVM to run.

§

PatchMMDS(Value)

Partial update of the MMDS contents.

§

Pause

Pause the guest, by pausing the microVM VCPUs.

§

PutMMDS(Value)

Repopulate the MMDS contents.

§

PutCpuConfiguration(CustomCpuTemplate)

Configure the guest vCPU features.

§

Resume

Resume the guest, by resuming the microVM VCPUs.

§

SetBalloonDevice(BalloonDeviceConfig)

Set the balloon device or update the one that already exists using the BalloonDeviceConfig as input. This action can only be called before the microVM has booted.

§

SetMmdsConfiguration(MmdsConfig)

Set the MMDS configuration.

§

SetVsockDevice(VsockDeviceConfig)

Set the vsock device or update the one that already exists using the VsockDeviceConfig as input. This action can only be called before the microVM has booted.

§

SetEntropyDevice(EntropyDeviceConfig)

Set the entropy device using EntropyDeviceConfig as input. This action can only be called before the microVM has booted.

§

GetMemoryHotplugStatus

Get the memory hotplug device configuration and status.

§

SetMemoryHotplugDevice(MemoryHotplugConfig)

Set the memory hotplug device using MemoryHotplugConfig as input. This action can only be called before the microVM has booted.

§

UpdateMemoryHotplugSize(MemoryHotplugSizeUpdate)

Updates the memory hotplug device using MemoryHotplugConfigUpdate as input. This action can only be called after the microVM has booted.

§

StartMicroVm

Launch the microVM. This action can only be called before the microVM has booted.

§

SendCtrlAltDel

Send CTRL+ALT+DEL to the microVM, using the i8042 keyboard function. If an AT-keyboard driver is listening on the guest end, this can be used to shut down the microVM gracefully.

§

UpdateBalloon(BalloonUpdateConfig)

Update the balloon size, after microVM start.

§

UpdateBalloonStatistics(BalloonUpdateStatsConfig)

Update the balloon statistics polling interval, after microVM start.

§

StartFreePageHinting(StartHintingCmd)

Start a free page hinting run

§

GetFreePageHintingStatus

Retrieve the status of the hinting run

§

StopFreePageHinting

Stops a free page hinting run

§

UpdateBlockDevice(BlockDeviceUpdateConfig)

Update existing block device properties such as path_on_host or rate_limiter.

§

UpdateNetworkInterface(NetworkInterfaceUpdateConfig)

Update a network interface, after microVM start. Currently, the only updatable properties are the RX and TX rate limiters.

§

UpdateMachineConfiguration(MachineConfigUpdate)

Update the microVM configuration (memory & vcpu) using VmUpdateConfig as input. This action can only be called before the microVM has booted.

Trait Implementations§

Source§

impl Debug for VmmAction

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl PartialEq for VmmAction

Source§

fn eq(&self, other: &VmmAction) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for VmmAction

Source§

impl StructuralPartialEq for VmmAction

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AsAny for T
where T: Any,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Return the immutable any encapsulated object.
Source§

fn as_mut_any(&mut self) -> &mut (dyn Any + 'static)

Return the mutable encapsulated any object.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V