OS Manuals

/usr/bin/firecracker

secure and fast microVMs for serverless computing

From firecracker 1.18.0-r0 (enterprise-packages), captured 2026-11-08 by running firecracker --help (exit 0). permalink

Firecracker v1.18.0

optional arguments:
  --api-sock <api-sock>                                     Path to unix domain socket used by the API. [default: "/run/firecracker.socket"]
  --boot-timer                                              Whether or not to load boot timer device for logging elapsed time since InstanceStart command.
  --config-file <config-file>                               Path to a file that contains the microVM configuration in JSON format.
  --describe-snapshot <describe-snapshot>                   Print the data format version of the provided snapshot state file.
  --enable-pci                                              Enables PCIe support.
  --help                                                    Show the help message.
  --http-api-max-payload-size <http-api-max-payload-size>   Http API request payload max size, in bytes. [default: "51200"]
  --id <id>                                                 MicroVM unique identifier. [default: "anonymous-instance"]
  --level <level>                                           Set the logger level.
  --log-path <log-path>                                     Path to a fifo or a file used for configuring the logger on startup.
  --metadata <metadata>                                     Path to a file that contains metadata in JSON format to add to the mmds.
  --metrics-path <metrics-path>                             Path to a fifo or a file used for configuring the metrics on startup.
  --mmds-size-limit <mmds-size-limit>                       Mmds data store limit, in bytes.
  --module <module>                                         Set the logger module filter.
  --no-api                                                  Optional parameter which allows starting and using a microVM without an active API socket.
  --no-seccomp                                              Optional parameter which allows starting and using a microVM without seccomp filtering. Not recommended.
  --parent-cpu-time-us <parent-cpu-time-us>                 Parent process CPU time (wall clock, microseconds). This parameter is optional.
  --seccomp-filter <seccomp-filter>                         Optional parameter which allows specifying the path to a custom seccomp filter. For advanced users.
  --show-level                                              Whether or not to output the level in the logs.
  --show-log-origin                                         Whether or not to include the file path and line number of the log's origin.
  --snapshot-version                                        Print the supported data format version.
  --start-time-cpu-us <start-time-cpu-us>                   Process start CPU time (wall clock, microseconds). This parameter is optional.
  --start-time-us <start-time-us>                           Process start time (wall clock, microseconds). This parameter is optional.
  --version                                                 Print the binary version number.
2026-11-08T04:12:24.000820655 [anonymous-instance:main] Firecracker exiting successfully. exit_code=0
Options (24)
OptionDescriptionSource
--api-sock api-sockPath to unix domain socket used by the API.help
--boot-timerWhether or not to load boot timer device for logging elapsed time since InstanceStart command.help
--config-file config-filePath to a file that contains the microVM configuration in JSON format.help
--describe-snapshot describe-snapshotPrint the data format version of the provided snapshot state file.help
--enable-pciEnables PCIe support.help
--helpShow the help message.help
--http-api-max-payload-size http-api-max-payload-sizeHttp API request payload max size, in bytes.help
--id idMicroVM unique identifier.help
--level levelSet the logger level.help
--log-path log-pathPath to a fifo or a file used for configuring the logger on startup.help
--metadata metadataPath to a file that contains metadata in JSON format to add to the mmds.help
--metrics-path metrics-pathPath to a fifo or a file used for configuring the metrics on startup.help
--mmds-size-limit mmds-size-limitMmds data store limit, in bytes.help
--module moduleSet the logger module filter.help
--no-apiOptional parameter which allows starting and using a microVM without an active API socket.help
--no-seccompOptional parameter which allows starting and using a microVM without seccomp filtering.help
--parent-cpu-time-us parent-cpu-time-usParent process CPU time (wall clock, microseconds).help
--seccomp-filter seccomp-filterOptional parameter which allows specifying the path to a custom seccomp filter.help
--show-levelWhether or not to output the level in the logs.help
--show-log-originWhether or not to include the file path and line number of the log's origin.help
--snapshot-versionPrint the supported data format version.help
--start-time-cpu-us start-time-cpu-usProcess start CPU time (wall clock, microseconds).help
--start-time-us start-time-usProcess start time (wall clock, microseconds).help
--versionPrint the binary version number.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.