Volant
HomeDocsAPI Reference
HomeDocsAPI Reference
  1. References
  • Introduction
    • Why Volant
    • Introduction
  • Getting Started
    • Installation
    • Quick Start: Initramfs Strategy
    • Quick Start: Rootfs Strategy
  • Guides
    • Networking
    • Cloud-Init
    • Deployments
    • GPU Passthrough
    • Troubleshooting
  • Plugin Development
    • Overview
    • Initramfs Plugins
    • OCI/Rootfs Plugins
  • Architecture
    • Overview
    • Components
    • Data Flow
    • Networking
    • Boot and Runtime
    • Security and Limits
    • Extensibility
  • References
    • Plugin Manifest Schema
    • Fledge.toml Schema
    • VFIO API
    • volar(cli)
    • volantd (server)
    • kestrel(agent)
    • Glossary
  • Development
    • Contributing
    • Security
  1. References

volar(cli)

References: internal/cli/standard.

Global flag

  • --api, -a: base URL for volantd (default from VOLANT_API_BASE or http://127.0.0.1:7777)

Commands

  • version — print CLI version

  • vms — manage microVMs

    • list — list VMs
    • get — show details
    • create [flags] — create a VM
      • --plugin
      • --runtime
      • --cpu
      • --memory
      • --kernel-cmdline
      • --config
      • --api-host / --api-port
      • --device (repeatable)
      • --device-allowlist (repeatable)
    • delete
    • start
    • stop
    • restart
    • scale [--cpu N] [--memory MB] [--restart] | for deployments: --replicas N
    • config
      • get [--raw] [--output file]
      • set --file
      • history [--limit N]
    • console [--socket ] — attach to serial socket
    • operations — list operations from the VM’s plugin OpenAPI
    • call [--query k=v] [--body '{}'] [--body-file file] [--timeout 60s]
  • plugins — manage engine plugins

    • list
    • show
    • enable
    • disable
    • install [--manifest | --url <http(s)>] (positional arg allowed)
    • remove
  • deployments — manage VM groups

    • list
    • create --config [--replicas N]
    • get [--output file]
    • delete
    • scale
  • setup — configure host networking and service (Linux)

    • Flags: --bridge, --subnet, --host-ip, --dry-run, --runtime-dir, --log-dir,
      --service-file, --work-dir, --bzimage, --vmlinux
Modified at 2025-10-05 17:47:36
Previous
VFIO API
Next
volantd (server)
Built with