machinectlsystemdDeveloperLennartPoetteringlennart@poettering.netmachinectl1machinectlControl the systemd machine managermachinectlOPTIONSCOMMANDNAMEDescriptionmachinectl may be used to
introspect and control the state of the
systemd1
virtual machine and container registration manager systemd-machined.service8.OptionsThe following options are understood:Prints a short help
text and exits.Prints a short version
string and exits.Do not pipe output into a
pager.Do not query the user
for authentication for privileged
operations.Execute the operation
remotely. Specify a hostname, or
username and hostname separated by @,
to connect to. This will use SSH to
talk to the remote machine manager
instance.Execute the operation on a
local container. Specify a container
name to connect to.When showing
machine properties, limit the
output to certain properties as
specified by the argument. If not
specified, all set properties are
shown. The argument should be a
property name, such as
Name. If
specified more than once, all
properties with the specified names
are shown.When showing
machine properties, show all
properties regardless of whether they are
set or not.Do not ellipsize
process tree entries.When used with
kill-machine,
choose which processes to kill. Must
be one of , or
to select whether
to kill only the leader process of the
machine or all processes of the
machine. If omitted, defaults to
.When used with
kill-machine, choose
which signal to send to selected
processes. Must be one of the
well-known signal specifiers, such as
SIGTERM,
SIGINT or
SIGSTOP. If
omitted, defaults to
SIGTERM.The following commands are understood:listList currently running
virtual machines and containers.
statusID...Show terse runtime
status information about one or more
virtual machines and containers. This
function is intended to generate
human-readable output. If you are
looking for computer-parsable output,
use show instead.
showID...Show properties of one
or more registered virtual machines or
containers or the manager itself. If
no argument is specified, properties
of the manager will be shown. If an
ID is specified, properties of this
virtual machine or container are
shown. By default, empty properties
are suppressed. Use
to show those
too. To select specific properties to
show, use
. This
command is intended to be used
whenever computer-parsable output is
required. Use
status if you are
looking for formatted human-readable
output.terminateID...Terminates a virtual
machine or container. This kills all
processes of the virtual machine or
container and deallocates all
resources attached to that
instance.killID...Send a signal to one
or more processes of the virtual
machine or container. This means
processes as seen by the host, not the
processes inside the virtual machine
or container.
Use to
select which process to kill. Use
to select
the signal to send.loginID...Open a terminal login
session to a container. This will
create a TTY connection to a specific
container and asks for the execution of a
getty on it. Note that this is only
supported for containers running
systemd1
as init system.Exit statusOn success, 0 is returned, a non-zero failure
code otherwise.Environment$SYSTEMD_PAGERPager to use when
is not given;
overrides $PAGER. Setting
this to an empty string or the value
cat is equivalent to passing
.See Alsosystemd-machined.service8,
systemd-nspawn1,
systemd.special7