OS Manuals

/usr/bin/ch-remote

Remote API client for controlling a running cloud-hypervisor VMM

From ch-remote 54.0-r3 (enterprise-packages), captured 2026-11-08 by running ch-remote --help (exit 0). permalink

Remotely control a cloud-hypervisor VMM.

Usage: ch-remote [OPTIONS] <COMMAND>

Commands:
  add-device              Add VFIO device
  add-disk                Add block device
  add-fs                  Add virtio-fs backed fs device
  add-generic-vhost-user  Add generic vhost-user device
  add-net                 Add network device
  add-pmem                Add persistent memory device
  add-user-device         Add userspace device
  add-vdpa                Add vDPA device
  add-vsock               Add vsock device
  balloon-stats           Statistics from the virtio-balloon device
  boot                    Boot a created VM
  cancel-migration        Cancel any ongoing migration
  coredump                Create a coredump from VM
  counters                Counters from the VM
  create                  Create VM from a JSON configuration
  delete                  Delete a VM
  info                    Info on the VM
  nmi                     Trigger NMI
  pause                   Pause the VM
  ping                    Ping the VMM to check for API server availability
  power-button            Trigger a power button in the VM
  reboot                  Reboot the VM
  receive-migration       Receive a VM migration
  remove-device           Remove VFIO and PCI device
  resize                  Resize the VM
  resize-disk             Resize an attached disk
  resize-zone             Resize a memory zone
  restore                 Restore VM from a snapshot
  resume                  Resume the VM
  send-migration          Initiate a VM migration
  shutdown                Shutdown the VM
  shutdown-vmm            Shutdown the VMM
  snapshot                Create a snapshot from VM
  help                    Print this message or the help of the given subcommand(s)

Options:
      --api-socket <api-socket>  HTTP API socket path (UNIX domain socket).
  -h, --help                     Print help
  -V, --version                  Print version
Options (3)
OptionDescriptionSource
--api-socket api-socketHTTP API socket path (UNIX domain socket).help
-h, --helpPrint helphelp
-V, --versionPrint versionhelp

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