Class FirecrackerClient

Thin typed client for the Firecracker REST API, served by the VMM over a unix socket. See https://firecracker-microvm.github.io/ and the firecracker.yaml OpenAPI spec.

Index

Constructors

Properties

balloon bootSource logger machineConfig metrics mmds snapshot vm vmConfig vsock

Methods

action createSyncAction drive getInstanceInfo getVersion networkInterface

Constructors

constructor

new FirecrackerClient(options: FirecrackerClientOptions): FirecrackerClient
Parameters
- options: FirecrackerClientOptions
Returns FirecrackerClient
- Defined in src/client.ts:224

Properties

`Readonly`balloon

balloon: BalloonResource

`Readonly`bootSource

bootSource: BootSourceResource

`Readonly`logger

logger: LoggerResource

`Readonly`machineConfig

machineConfig: MachineConfigResource

`Readonly`metrics

metrics: MetricsResource

`Readonly`mmds

mmds: MmdsResource

`Readonly`snapshot

snapshot: SnapshotResource

`Readonly`vm

`Readonly`vmConfig

vmConfig: VmConfigResource

`Readonly`vsock

vsock: VsockResource

Methods

action

action(actionType: ActionType): Promise<void>
Shorthand for createSyncAction({ action_type }).
Parameters
- actionType: ActionType
Returns Promise<void>
- Defined in src/client.ts:267

createSyncAction

createSyncAction(action: InstanceActionInfo): Promise<void>
PUT /actions
Parameters
- action: InstanceActionInfo
Returns Promise<void>
- Defined in src/client.ts:262

drive

drive(driveId: string): DriveResource
Resource handle for /drives/{drive_id}.
Parameters
- driveId: string
Returns DriveResource
- Defined in src/client.ts:242

getInstanceInfo

getInstanceInfo(): Promise<InstanceInfo>
GET /

Returns Promise<InstanceInfo>
- Defined in src/client.ts:252

getVersion

getVersion(): Promise<FirecrackerVersion>
GET /version

Returns Promise<FirecrackerVersion>
- Defined in src/client.ts:257

networkInterface

networkInterface(ifaceId: string): NetworkInterfaceResource
Resource handle for /network-interfaces/{iface_id}.
Parameters
- ifaceId: string
Returns NetworkInterfaceResource
- Defined in src/client.ts:247