firecracker-node
    Preparing search index...

    Interface FirecrackerInitParams

    Parameters for initializing a Firecracker microVM process. These correspond to the command-line arguments supported by the Firecracker binary.

    https://github.com/firecracker-microvm/firecracker/blob/f0691f8253d4bde225b9f70ecabf39b7ad796935/src/firecracker/src/main.rs#L144

    interface FirecrackerInitParams {
        apiSock?: string;
        bootTimer?: boolean;
        configFile?: string;
        describeSnapshot?: string;
        enablePci?: boolean;
        httpApiMaxPayloadSize?: number;
        id?: string;
        level?: LogLevel;
        logPath?: string;
        metadataFile?: string;
        metricsPath?: string;
        mmdsSizeLimit?: number;
        module?: string;
        noApi?: boolean;
        noSeccomp?: boolean;
        parentCPUTimeUs?: number;
        seccompFilter?: string;
        showLevel?: boolean;
        showLogOrigin?: boolean;
        snapshotVersion?: boolean;
        startTimeCpuUs?: number;
        startTimeUs?: number;
        version?: boolean;
    }
    Index

    Properties

    apiSock? bootTimer? configFile? describeSnapshot? enablePci? httpApiMaxPayloadSize? id? level? logPath? metadataFile? metricsPath? mmdsSizeLimit? module? noApi? noSeccomp? parentCPUTimeUs? seccompFilter? showLevel? showLogOrigin? snapshotVersion? startTimeCpuUs? startTimeUs? version?

    Properties

    apiSock?: string

    Path to unix domain socket used by the API.

    "/run/firecracker.socket"
    bootTimer?: boolean

    Whether or not to load boot timer device for logging elapsed time since InstanceStart command.

    configFile?: string

    Path to a file that contains the microVM configuration in JSON format.

    describeSnapshot?: string

    Print the data format version of the provided snapshot state file.

    enablePci?: boolean

    Enables PCIe support.

    httpApiMaxPayloadSize?: number

    Http API request payload max size, in bytes.

    51200 (Reference: https://github.com/firecracker-microvm/firecracker/blob/f0691f8253d4bde225b9f70ecabf39b7ad796935/src/vmm/src/lib.rs#L198)
    id?: string

    MicroVM unique identifier.

    "anonymous-instance"
    level?: LogLevel

    Set the logger level.

    logPath?: string

    Path to a fifo or a file used for configuring the logger on startup.

    metadataFile?: string

    Path to a file that contains metadata in JSON format to add to the mmds.

    metricsPath?: string

    Path to a fifo or a file used for configuring the metrics on startup.

    mmdsSizeLimit?: number

    Mmds data store limit, in bytes.

    module?: string

    Set the logger module filter.

    noApi?: boolean

    Optional parameter which allows starting and using a microVM without an active API socket. Requires configFile to be specified.

    noSeccomp?: boolean

    Optional parameter which allows starting and using a microVM without seccomp filtering. Not recommended. Cannot be used with seccompFilter. For more details, see: https://github.com/firecracker-microvm/firecracker/blob/f0691f8253d4bde225b9f70ecabf39b7ad796935/src/firecracker/src/seccomp.rs#L38

    parentCPUTimeUs?: number

    Parent process CPU time (wall clock, microseconds). This parameter is optional.

    seccompFilter?: string

    Optional parameter which allows specifying the path to a custom seccomp filter. For advanced users. Cannot be used with noSeccomp. For more details, see: https://github.com/firecracker-microvm/firecracker/blob/f0691f8253d4bde225b9f70ecabf39b7ad796935/src/firecracker/src/seccomp.rs#L38

    showLevel?: boolean

    Whether or not to output the level in the logs.

    showLogOrigin?: boolean

    Whether or not to include the file path and line number of the log's origin.

    snapshotVersion?: boolean

    Print the supported data format version.

    startTimeCpuUs?: number

    Process start CPU time (wall clock, microseconds). This parameter is optional.

    startTimeUs?: number

    Process start time (wall clock, microseconds). This parameter is optional.

    version?: boolean

    Print the binary version number.

    Settings

    Member Visibility

    On This Page

    Properties