Struct VmStartConfig 

pub struct VmStartConfig {

    pub name: String,
    pub rootfs_path: String,
    pub kernel_path: Option<String>,
    pub initrd_path: Option<String>,
    pub revision_hash: String,
    pub flake_ref: String,
    pub profile: Option<String>,
    pub cpus: u32,
    pub memory_mib: u32,
    pub ports: Vec<VmPortMapping>,
    pub volumes: Vec<VmVolume>,
    pub config_files: Vec<VmFile>,
    pub secret_files: Vec<VmFile>,
    pub runner_dir: Option<String>,
}

Backend-agnostic configuration describing what to run.

Callers build a VmStartConfig from CLI arguments and build output. Each backend converts this into its own internal config type, filling in backend-specific details (Firecracker: kernel path, TAP slot; Apple Container: VZ block attachment; Docker: container image).

Examples

let config = VmStartConfig {
    name: "my-vm".into(),
    rootfs_path: "/nix/store/.../rootfs.ext4".into(),
    cpus: 2,
    memory_mib: 512,
    ..Default::default()
};
backend.start(&config)?;

Fields

name: String

VM name (user-provided or auto-generated).

rootfs_path: String

Absolute path to the root filesystem (ext4 image).

kernel_path: Option<String>

Absolute path to the kernel image (Firecracker needs this; others may ignore).

initrd_path: Option<String>

Absolute path to the initial ramdisk (NixOS stage-1), if present.

revision_hash: String

Nix store revision hash.

flake_ref: String

Original flake reference (for display / status).

profile: Option<String>

Flake profile name (e.g. “worker”, “gateway”).

cpus: u32

Number of vCPUs.

memory_mib: u32

Memory in MiB.

ports: Vec<VmPortMapping>

Declared port mappings (host:guest) for forwarding and guest config.

volumes: Vec<VmVolume>

Extra volumes to mount in the guest.

config_files: Vec<VmFile>

Extra config files to make available to the guest.

secret_files: Vec<VmFile>

Secret files (written with restricted permissions).

runner_dir: Option<String>

Directory containing microvm.nix runner scripts (microvm.nix backend only).

Trait Implementations

impl Clone for VmStartConfig

fn clone(&self) -> VmStartConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VmStartConfig

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

Formats the value using the given formatter.

impl Default for VmStartConfig

fn default() -> VmStartConfig

Returns the “default value” for a type.