]>
Commit | Line | Data |
---|---|---|
14228c0d | 1 | '\" t |
5eef597e | 2 | .TH "MACHINECTL" "1" "" "systemd 217" "machinectl" |
14228c0d MB |
3 | .\" ----------------------------------------------------------------- |
4 | .\" * Define some portability stuff | |
5 | .\" ----------------------------------------------------------------- | |
6 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
7 | .\" http://bugs.debian.org/507673 | |
8 | .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html | |
9 | .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
10 | .ie \n(.g .ds Aq \(aq | |
11 | .el .ds Aq ' | |
12 | .\" ----------------------------------------------------------------- | |
13 | .\" * set default formatting | |
14 | .\" ----------------------------------------------------------------- | |
15 | .\" disable hyphenation | |
16 | .nh | |
17 | .\" disable justification (adjust text to left margin only) | |
18 | .ad l | |
19 | .\" ----------------------------------------------------------------- | |
20 | .\" * MAIN CONTENT STARTS HERE * | |
21 | .\" ----------------------------------------------------------------- | |
22 | .SH "NAME" | |
23 | machinectl \- Control the systemd machine manager | |
24 | .SH "SYNOPSIS" | |
25 | .HP \w'\fBmachinectl\fR\ 'u | |
26 | \fBmachinectl\fR [OPTIONS...] {COMMAND} [NAME...] | |
27 | .SH "DESCRIPTION" | |
28 | .PP | |
29 | \fBmachinectl\fR | |
30 | may be used to introspect and control the state of the | |
31 | \fBsystemd\fR(1) | |
32 | virtual machine and container registration manager | |
33 | \fBsystemd-machined.service\fR(8)\&. | |
34 | .SH "OPTIONS" | |
35 | .PP | |
36 | The following options are understood: | |
37 | .PP | |
14228c0d MB |
38 | \fB\-p\fR, \fB\-\-property=\fR |
39 | .RS 4 | |
40 | 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 | |
41 | "Name"\&. If specified more than once, all properties with the specified names are shown\&. | |
42 | .RE | |
43 | .PP | |
44 | \fB\-a\fR, \fB\-\-all\fR | |
45 | .RS 4 | |
46 | When showing machine properties, show all properties regardless of whether they are set or not\&. | |
47 | .RE | |
48 | .PP | |
49 | \fB\-l\fR, \fB\-\-full\fR | |
50 | .RS 4 | |
51 | Do not ellipsize process tree entries\&. | |
52 | .RE | |
53 | .PP | |
14228c0d MB |
54 | \fB\-\-kill\-who=\fR |
55 | .RS 4 | |
56 | When used with | |
60f067b4 | 57 | \fBkill\fR, choose which processes to kill\&. Must be one of |
14228c0d MB |
58 | \fBleader\fR, or |
59 | \fBall\fR | |
60 | to select whether to kill only the leader process of the machine or all processes of the machine\&. If omitted, defaults to | |
61 | \fBall\fR\&. | |
62 | .RE | |
63 | .PP | |
64 | \fB\-s\fR, \fB\-\-signal=\fR | |
65 | .RS 4 | |
66 | When used with | |
60f067b4 | 67 | \fBkill\fR, choose which signal to send to selected processes\&. Must be one of the well\-known signal specifiers, such as |
14228c0d MB |
68 | \fBSIGTERM\fR, |
69 | \fBSIGINT\fR | |
70 | or | |
71 | \fBSIGSTOP\fR\&. If omitted, defaults to | |
72 | \fBSIGTERM\fR\&. | |
73 | .RE | |
74 | .PP | |
60f067b4 JS |
75 | \fB\-\-no\-legend\fR |
76 | .RS 4 | |
77 | Do not print the legend, i\&.e\&. the column headers and the footer\&. | |
78 | .RE | |
79 | .PP | |
80 | \fB\-H\fR, \fB\-\-host=\fR | |
14228c0d | 81 | .RS 4 |
e842803a MB |
82 | Execute the operation remotely\&. Specify a hostname, or a username and hostname separated by |
83 | "@", to connect to\&. The hostname may optionally be suffixed by a container name, separated by | |
84 | ":", 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 | |
85 | \fBmachinectl \-H \fR\fB\fIHOST\fR\fR\&. | |
14228c0d MB |
86 | .RE |
87 | .PP | |
60f067b4 JS |
88 | \fB\-M\fR, \fB\-\-machine=\fR |
89 | .RS 4 | |
90 | Execute operation on a local container\&. Specify a container name to connect to\&. | |
91 | .RE | |
92 | .PP | |
93 | \fB\-h\fR, \fB\-\-help\fR | |
14228c0d | 94 | .RS 4 |
60f067b4 JS |
95 | Print a short help text and exit\&. |
96 | .RE | |
97 | .PP | |
98 | \fB\-\-version\fR | |
99 | .RS 4 | |
100 | Print a short version string and exit\&. | |
101 | .RE | |
102 | .PP | |
103 | \fB\-\-no\-pager\fR | |
104 | .RS 4 | |
105 | Do not pipe output into a pager\&. | |
14228c0d MB |
106 | .RE |
107 | .PP | |
108 | The following commands are understood: | |
109 | .PP | |
110 | \fBlist\fR | |
111 | .RS 4 | |
112 | List currently running virtual machines and containers\&. | |
113 | .RE | |
114 | .PP | |
60f067b4 | 115 | \fBstatus\fR \fIID\fR\&.\&.\&. |
14228c0d MB |
116 | .RS 4 |
117 | 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 | |
118 | \fBshow\fR | |
119 | instead\&. | |
120 | .RE | |
121 | .PP | |
60f067b4 | 122 | \fBshow\fR \fIID\fR\&.\&.\&. |
14228c0d MB |
123 | .RS 4 |
124 | 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 | |
125 | \fB\-\-all\fR | |
126 | to show those too\&. To select specific properties to show, use | |
127 | \fB\-\-property=\fR\&. This command is intended to be used whenever computer\-parsable output is required\&. Use | |
128 | \fBstatus\fR | |
129 | if you are looking for formatted human\-readable output\&. | |
130 | .RE | |
131 | .PP | |
60f067b4 | 132 | \fBlogin\fR \fIID\fR |
14228c0d | 133 | .RS 4 |
60f067b4 JS |
134 | 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 |
135 | \fBsystemd\fR(1) | |
136 | as init system\&. | |
14228c0d MB |
137 | .RE |
138 | .PP | |
60f067b4 JS |
139 | \fBreboot\fR \fIID\fR\&.\&.\&. |
140 | .RS 4 | |
141 | 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\&. | |
142 | .RE | |
143 | .PP | |
144 | \fBpoweroff\fR \fIID\fR\&.\&.\&. | |
145 | .RS 4 | |
146 | 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 | |
147 | \fBsystemd\fR(1)\-compatible init system, such as sysvinit\&. | |
148 | .RE | |
149 | .PP | |
150 | \fBkill\fR \fIID\fR\&.\&.\&. | |
14228c0d MB |
151 | .RS 4 |
152 | 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 | |
153 | \fB\-\-kill\-who=\fR | |
154 | to select which process to kill\&. Use | |
155 | \fB\-\-signal=\fR | |
156 | to select the signal to send\&. | |
157 | .RE | |
60f067b4 JS |
158 | .PP |
159 | \fBterminate\fR \fIID\fR\&.\&.\&. | |
160 | .RS 4 | |
161 | Terminates a virtual machine or container\&. This kills all processes of the virtual machine or container and deallocates all resources attached to that instance\&. | |
162 | .RE | |
14228c0d MB |
163 | .SH "EXIT STATUS" |
164 | .PP | |
165 | On success, 0 is returned, a non\-zero failure code otherwise\&. | |
166 | .SH "ENVIRONMENT" | |
167 | .PP | |
168 | \fI$SYSTEMD_PAGER\fR | |
169 | .RS 4 | |
170 | Pager to use when | |
171 | \fB\-\-no\-pager\fR | |
172 | is not given; overrides | |
173 | \fI$PAGER\fR\&. Setting this to an empty string or the value | |
174 | "cat" | |
175 | is equivalent to passing | |
176 | \fB\-\-no\-pager\fR\&. | |
177 | .RE | |
60f067b4 JS |
178 | .PP |
179 | \fI$SYSTEMD_LESS\fR | |
180 | .RS 4 | |
181 | Override the default options passed to | |
182 | \fBless\fR | |
183 | ("FRSXMK")\&. | |
184 | .RE | |
14228c0d MB |
185 | .SH "SEE ALSO" |
186 | .PP | |
187 | \fBsystemd-machined.service\fR(8), | |
60f067b4 JS |
188 | \fBsystemd-nspawn\fR(1), |
189 | \fBsystemd.special\fR(7) |