@edgible-team/sdk
    Preparing search index...

    Interface VirtualMachineOptions

    Constructor options for VirtualMachine.

    interface VirtualMachineOptions {
        baseImagePath: string;
        cpus?: number;
        guestPaths?: Partial<GuestPaths>;
        keepOverlay?: boolean;
        loadvmTag?: string;
        logger?: Logger;
        memory?: number;
        network?: VmNetworkLike;
        qemuConfig?: QemuConfig;
        spawnFn?: SpawnFn;
        sshPassword?: string;
        sshPortRange?: [number, number];
        sshUser?: string;
    }
    Index

    Properties

    baseImagePath cpus? guestPaths? keepOverlay? loadvmTag? logger? memory? network? qemuConfig? spawnFn? sshPassword? sshPortRange? sshUser?

    Properties

    baseImagePath: string

    qcow2 image to boot. An overlay (or CoW copy for warm boots) is created beside it.

    cpus?: number

    vCPUs. Default 2.

    guestPaths?: Partial<GuestPaths>

    Override guest binary locations (defaults to /opt/edgible/...).

    keepOverlay?: boolean

    Keep the overlay/copy image on stop() instead of unlinking it.

    loadvmTag?: string

    QEMU savevm snapshot tag to resume from (passed as -loadvm <tag>). When set, kernel boot is skipped — the VM resumes RAM/CPU state, so the SSH wait is much shorter and the guest wall clock is re-synced on start.

    logger?: Logger
    memory?: number

    Memory in MB. Default 4096.

    network?: VmNetworkLike
    qemuConfig?: QemuConfig

    Per-platform QEMU configuration. Default: detected from the host.

    spawnFn?: SpawnFn

    Injectable process spawner (tests). Default: node:child_process spawn.

    sshPassword?: string

    Guest SSH password. Default 'testpass' (matches the image-build scripts).

    sshPortRange?: [number, number]

    Host port range for the SSH forward. Default [2222, 2299].

    sshUser?: string

    Guest SSH user. Default 'testuser' (matches the image-build scripts).

    Settings

    Member Visibility

    On This Page

    Properties