mirror of
https://git.proxmox.com/git/systemd
synced 2025-06-11 05:45:05 +00:00
190 lines
6.3 KiB
Groff
190 lines
6.3 KiB
Groff
'\" t
|
|
.TH "MACHINECTL" "1" "" "systemd 218" "machinectl"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * Define some portability stuff
|
|
.\" -----------------------------------------------------------------
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.\" http://bugs.debian.org/507673
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
machinectl \- Control the systemd machine manager
|
|
.SH "SYNOPSIS"
|
|
.HP \w'\fBmachinectl\fR\ 'u
|
|
\fBmachinectl\fR [OPTIONS...] {COMMAND} [NAME...]
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
\fBmachinectl\fR
|
|
may be used to introspect and control the state of the
|
|
\fBsystemd\fR(1)
|
|
virtual machine and container registration manager
|
|
\fBsystemd-machined.service\fR(8)\&.
|
|
.SH "OPTIONS"
|
|
.PP
|
|
The following options are understood:
|
|
.PP
|
|
\fB\-p\fR, \fB\-\-property=\fR
|
|
.RS 4
|
|
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\&.
|
|
.RE
|
|
.PP
|
|
\fB\-a\fR, \fB\-\-all\fR
|
|
.RS 4
|
|
When showing machine properties, show all properties regardless of whether they are set or not\&.
|
|
.RE
|
|
.PP
|
|
\fB\-l\fR, \fB\-\-full\fR
|
|
.RS 4
|
|
Do not ellipsize process tree entries\&.
|
|
.RE
|
|
.PP
|
|
\fB\-\-kill\-who=\fR
|
|
.RS 4
|
|
When used with
|
|
\fBkill\fR, choose which processes to kill\&. Must be one of
|
|
\fBleader\fR, or
|
|
\fBall\fR
|
|
to select whether to kill only the leader process of the machine or all processes of the machine\&. If omitted, defaults to
|
|
\fBall\fR\&.
|
|
.RE
|
|
.PP
|
|
\fB\-s\fR, \fB\-\-signal=\fR
|
|
.RS 4
|
|
When used with
|
|
\fBkill\fR, choose which signal to send to selected processes\&. Must be one of the well\-known signal specifiers, such as
|
|
\fBSIGTERM\fR,
|
|
\fBSIGINT\fR
|
|
or
|
|
\fBSIGSTOP\fR\&. If omitted, defaults to
|
|
\fBSIGTERM\fR\&.
|
|
.RE
|
|
.PP
|
|
\fB\-\-no\-legend\fR
|
|
.RS 4
|
|
Do not print the legend, i\&.e\&. the column headers and the footer\&.
|
|
.RE
|
|
.PP
|
|
\fB\-H\fR, \fB\-\-host=\fR
|
|
.RS 4
|
|
Execute the operation remotely\&. Specify a hostname, or a username and hostname separated by
|
|
"@", to connect to\&. The hostname may optionally be suffixed by a container name, separated by
|
|
":", which connects directly to a specific container on the specified host\&. This will use SSH to talk to the remote machine manager instance\&. Container names may be enumerated with
|
|
\fBmachinectl \-H \fR\fB\fIHOST\fR\fR\&.
|
|
.RE
|
|
.PP
|
|
\fB\-M\fR, \fB\-\-machine=\fR
|
|
.RS 4
|
|
Execute operation on a local container\&. Specify a container name to connect to\&.
|
|
.RE
|
|
.PP
|
|
\fB\-h\fR, \fB\-\-help\fR
|
|
.RS 4
|
|
Print a short help text and exit\&.
|
|
.RE
|
|
.PP
|
|
\fB\-\-version\fR
|
|
.RS 4
|
|
Print a short version string and exit\&.
|
|
.RE
|
|
.PP
|
|
\fB\-\-no\-pager\fR
|
|
.RS 4
|
|
Do not pipe output into a pager\&.
|
|
.RE
|
|
.PP
|
|
The following commands are understood:
|
|
.PP
|
|
\fBlist\fR
|
|
.RS 4
|
|
List currently running virtual machines and containers\&.
|
|
.RE
|
|
.PP
|
|
\fBstatus\fR \fIID\fR\&.\&.\&.
|
|
.RS 4
|
|
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
|
|
\fBshow\fR
|
|
instead\&.
|
|
.RE
|
|
.PP
|
|
\fBshow\fR \fIID\fR\&.\&.\&.
|
|
.RS 4
|
|
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
|
|
\fB\-\-all\fR
|
|
to show those too\&. To select specific properties to show, use
|
|
\fB\-\-property=\fR\&. This command is intended to be used whenever computer\-parsable output is required\&. Use
|
|
\fBstatus\fR
|
|
if you are looking for formatted human\-readable output\&.
|
|
.RE
|
|
.PP
|
|
\fBlogin\fR \fIID\fR
|
|
.RS 4
|
|
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
|
|
\fBsystemd\fR(1)
|
|
as init system\&.
|
|
.RE
|
|
.PP
|
|
\fBreboot\fR \fIID\fR\&.\&.\&.
|
|
.RS 4
|
|
Reboot one or more containers\&. This will trigger a reboot by sending SIGINT to the container\*(Aqs init process, which is roughly equivalent to pressing Ctrl+Alt+Del on a non\-containerized system, and is compatible with containers running any init system\&.
|
|
.RE
|
|
.PP
|
|
\fBpoweroff\fR \fIID\fR\&.\&.\&.
|
|
.RS 4
|
|
Power off one or more containers\&. This will trigger a reboot by sending SIGRTMIN+4 to the container\*(Aqs init process, which causes systemd\-compatible init systems to shut down cleanly\&. This operation does not work on containers that do not run a
|
|
\fBsystemd\fR(1)\-compatible init system, such as sysvinit\&.
|
|
.RE
|
|
.PP
|
|
\fBkill\fR \fIID\fR\&.\&.\&.
|
|
.RS 4
|
|
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
|
|
\fB\-\-kill\-who=\fR
|
|
to select which process to kill\&. Use
|
|
\fB\-\-signal=\fR
|
|
to select the signal to send\&.
|
|
.RE
|
|
.PP
|
|
\fBterminate\fR \fIID\fR\&.\&.\&.
|
|
.RS 4
|
|
Terminates a virtual machine or container\&. This kills all processes of the virtual machine or container and deallocates all resources attached to that instance\&.
|
|
.RE
|
|
.SH "EXIT STATUS"
|
|
.PP
|
|
On success, 0 is returned, a non\-zero failure code otherwise\&.
|
|
.SH "ENVIRONMENT"
|
|
.PP
|
|
\fI$SYSTEMD_PAGER\fR
|
|
.RS 4
|
|
Pager to use when
|
|
\fB\-\-no\-pager\fR
|
|
is not given; overrides
|
|
\fI$PAGER\fR\&. Setting this to an empty string or the value
|
|
"cat"
|
|
is equivalent to passing
|
|
\fB\-\-no\-pager\fR\&.
|
|
.RE
|
|
.PP
|
|
\fI$SYSTEMD_LESS\fR
|
|
.RS 4
|
|
Override the default options passed to
|
|
\fBless\fR
|
|
("FRSXMK")\&.
|
|
.RE
|
|
.SH "SEE ALSO"
|
|
.PP
|
|
\fBsystemd-machined.service\fR(8),
|
|
\fBsystemd-nspawn\fR(1),
|
|
\fBsystemd.special\fR(7)
|