firecracker-node
    Preparing search index...

    Interface Drive

    A drive descriptor for configuring block devices.

    https://github.com/firecracker-microvm/firecracker/blob/f0691f8253d4bde225b9f70ecabf39b7ad796935/src/firecracker/swagger/firecracker.yaml#L1183

    interface Drive {
        cache_type?: CacheType;
        drive_id: string;
        io_engine?: IOEngineType;
        is_read_only?: boolean;
        is_root_device: boolean;
        partuuid?: string;
        path_on_host?: string;
        rate_limiter?: RateLimiter;
        socket?: string;
    }
    Index

    Properties

    cache_type? drive_id io_engine? is_read_only? is_root_device partuuid? path_on_host? rate_limiter? socket?

    Properties

    cache_type?: CacheType

    Represents the caching strategy for the block device.

    drive_id: string

    Unique identifier for the drive

    io_engine?: IOEngineType

    Type of the IO engine used by the device. "Async" is supported on host kernels newer than 5.10.51. This field is optional for virtio-block config and should be omitted for vhost-user-block configuration.

    is_read_only?: boolean

    Is block read only. This field is required for virtio-block config and should be omitted for vhost-user-block configuration.

    is_root_device: boolean

    Whether this drive is the root device

    partuuid?: string

    Represents the unique id of the boot partition of this device. It is optional and it will be taken into account only if the is_root_device field is true.

    path_on_host?: string

    Host level path for the guest drive. This field is required for virtio-block config and should be omitted for vhost-user-block configuration.

    rate_limiter?: RateLimiter

    Rate limiter configuration

    socket?: string

    Path to the socket of vhost-user-block backend. This field is required for vhost-user-block config should be omitted for virtio-block configuration.

    Settings

    Member Visibility

    On This Page

    Properties