OS Manuals

/usr/bin/machinectl

systemd container tools

From systemd-container 262.2-r1 (os), captured 2026-11-05 by running machinectl --help (exit 0). permalink

> machinectl [OPTION…] COMMAND …

Send control commands to or query the virtual machine and container registration
manager.

Machine Commands:
  [list]                                  List running VMs and containers
  status NAME…                            Show VM/container details
  show [NAME…]                            Show properties of one or more VMs/containers
  start NAME…                             Start container as a service
  login [NAME]                            Get a login prompt in a container or on the local host
  shell [[USER@]NAME [COMMAND…]]          Invoke a shell (or other command) in a container or on the
                                          local host
  enable NAME…                            Enable automatic container start at boot
  disable NAME…                           Disable automatic container start at boot
  poweroff NAME…                          Power off one or more machines
  reboot NAME…                            Reboot one or more machines
  pause NAME…                             Pause one or more machines
  resume NAME…                            Resume one or more paused machines
  terminate NAME…                         Terminate one or more machines
  kill NAME…                              Send signal to processes of a machine
  copy-to NAME PATH [PATH]                Copy files from the host to a container
  copy-from NAME PATH [PATH]              Copy files from a container to the host
  bind NAME PATH [PATH]                   Bind mount a path from the host into a container

Image Commands:
  list-images                             Show available container and VM images
  image-status [NAME…]                    Show image details
  show-image [NAME…]                      Show properties of image
  edit NAME|FILE…                         Edit settings of one or more VMs/containers
  cat NAME|FILE…                          Show settings of one or more VMs/containers
  clone NAME NAME                         Clone an image
  rename NAME NAME                        Rename an image
  read-only NAME [BOOL]                   Mark or unmark image read-only
  remove NAME…                            Remove an image
  set-limit [NAME] BYTES                  Set image or pool size limit (disk quota)
  clean                                   Remove hidden (or all) images
  bind-volume MACHINE PROVIDER:VOLUME[:…] Attach a volume to a running machine
  unbind-volume MACHINE PROVIDER:VOLUME   Detach a volume from a running machine

Options:
  -h --help                               Show this help
     --version                            Show package version
  -H --host=[USER@]HOST                   Operate on remote host
  -M --machine=CONTAINER                  Operate on local container
     --system                             Connect to system machine manager
     --user                               Connect to user machine manager
     --value                              When showing properties, only print the value
  -p --property=NAME                      Show only properties by this name
  -P NAME                                 Equivalent to --value --property=NAME
  -a --all                                Show all properties, including empty ones
  -l --full                               Do not ellipsize output
     --kill-whom=WHOM                     Whom to send signal to
  -s --signal=SIGNAL                      Which signal to send
     --uid=USER                           Specify user ID to invoke shell as
  -E --setenv=VAR[=VALUE]                 Add an environment variable for shell
     --read-only                          Create read-only bind mount or clone
     --mkdir                              Create directory before bind mounting, if missing
  -n --lines=INTEGER                      Number of journal entries to show
     --max-addresses=INTEGER              Number of internet addresses to show at most
  -o --output=STRING                      Change journal output mode (short, short-precise,
                                          short-iso, short-iso-precise, short-full, short-monotonic,
                                          short-unix, short-delta, json, json-pretty, json-sse,
                                          json-seq, cat, verbose, export, with-unit)
     --force                              Replace target file when copying, if necessary
     --now                                Start or power off container after enabling or disabling
                                          it
     --runner=RUNNER                      Select between nspawn and vmspawn as the runner
  -V                                      Short for --runner=vmspawn
     --no-pager                           Do not start a pager
     --no-legend                          Do not show headers and footers
     --no-ask-password                    Do not prompt for password
  -q --quiet                              Suppress output

See the machinectl(1) man page for details.
Options (28)
OptionDescriptionSource
-h --helpShow this helphelp
--versionShow package versionhelp
-H --host=[USER@]HOSTOperate on remote hosthelp
-M --machine=CONTAINEROperate on local containerhelp
--systemConnect to system machine managerhelp
--userConnect to user machine managerhelp
--valueWhen showing properties, only print the valuehelp
-p --property=NAMEShow only properties by this namehelp
-P NAMEEquivalent to --value --property=NAMEhelp
-a --allShow all properties, including empty oneshelp
-l --fullDo not ellipsize outputhelp
--kill-whom WHOMWhom to send signal tohelp
-s --signal=SIGNALWhich signal to sendhelp
--uid USERSpecify user ID to invoke shell ashelp
-E --setenv=VAR[=VALUEAdd an environment variable for shellhelp
--read-onlyCreate read-only bind mount or clonehelp
--mkdirCreate directory before bind mounting, if missinghelp
-n --lines=INTEGERNumber of journal entries to showhelp
--max-addresses INTEGERNumber of internet addresses to show at mosthelp
-o --output=STRINGChange journal output mode (short, short-precise, short-iso, short-iso-precise, short-full, short-monotonic, short-unix, short-delta, json, json-pretty, json-sse, json-seq, cat, verbose, export,…help
--forceReplace target file when copying, if necessaryhelp
--nowStart or power off container after enabling or disabling ithelp
--runner RUNNERSelect between nspawn and vmspawn as the runnerhelp
-VShort for --runner=vmspawnhelp
--no-pagerDo not start a pagerhelp
--no-legendDo not show headers and footershelp
--no-ask-passwordDo not prompt for passwordhelp
-q --quietSuppress outputhelp

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