]>
Commit | Line | Data |
---|---|---|
7874bcd6 LP |
1 | <?xml version='1.0'?> <!--*-nxml-*--> |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | |
4a6022f0 | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
7874bcd6 LP |
4 | |
5 | <!-- | |
4a6022f0 | 6 | This file is part of systemd. |
7874bcd6 | 7 | |
4a6022f0 | 8 | Copyright 2010 Lennart Poettering |
7874bcd6 | 9 | |
4a6022f0 ZJS |
10 | systemd is free software; you can redistribute it and/or modify it |
11 | under the terms of the GNU Lesser General Public License as published by | |
12 | the Free Software Foundation; either version 2.1 of the License, or | |
13 | (at your option) any later version. | |
7874bcd6 | 14 | |
4a6022f0 ZJS |
15 | systemd is distributed in the hope that it will be useful, but |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
18 | Lesser General Public License for more details. | |
7874bcd6 | 19 | |
4a6022f0 ZJS |
20 | You should have received a copy of the GNU Lesser General Public License |
21 | along with systemd; If not, see <http://www.gnu.org/licenses/>. | |
7874bcd6 LP |
22 | --> |
23 | ||
21ac6ff1 ZJS |
24 | <refentry id="systemctl" |
25 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
7874bcd6 | 26 | |
4a6022f0 ZJS |
27 | <refentryinfo> |
28 | <title>systemctl</title> | |
29 | <productname>systemd</productname> | |
30 | ||
31 | <authorgroup> | |
32 | <author> | |
33 | <contrib>Developer</contrib> | |
34 | <firstname>Lennart</firstname> | |
35 | <surname>Poettering</surname> | |
36 | <email>lennart@poettering.net</email> | |
37 | </author> | |
38 | </authorgroup> | |
39 | </refentryinfo> | |
40 | ||
41 | <refmeta> | |
42 | <refentrytitle>systemctl</refentrytitle> | |
43 | <manvolnum>1</manvolnum> | |
44 | </refmeta> | |
45 | ||
46 | <refnamediv> | |
47 | <refname>systemctl</refname> | |
48 | <refpurpose>Control the systemd system and service manager</refpurpose> | |
49 | </refnamediv> | |
50 | ||
51 | <refsynopsisdiv> | |
52 | <cmdsynopsis> | |
53 | <command>systemctl</command> | |
54 | <arg choice="opt" rep="repeat">OPTIONS</arg> | |
55 | <arg choice="plain">COMMAND</arg> | |
56 | <arg choice="opt" rep="repeat">NAME</arg> | |
57 | </cmdsynopsis> | |
58 | </refsynopsisdiv> | |
59 | ||
60 | <refsect1> | |
61 | <title>Description</title> | |
62 | ||
63 | <para><command>systemctl</command> may be used to | |
64 | introspect and control the state of the | |
65 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
66 | system and service manager.</para> | |
67 | </refsect1> | |
68 | ||
69 | <refsect1> | |
70 | <title>Options</title> | |
71 | ||
72 | <para>The following options are understood:</para> | |
73 | ||
74 | <variablelist> | |
4a6022f0 ZJS |
75 | <varlistentry> |
76 | <term><option>-t</option></term> | |
77 | <term><option>--type=</option></term> | |
78 | ||
79 | <listitem> | |
e9dd9f95 | 80 | <para>The argument should be a comma-separated list of unit |
20b3f379 | 81 | types such as <option>service</option> and |
9b9b3d36 MW |
82 | <option>socket</option>. |
83 | </para> | |
20b3f379 ZJS |
84 | |
85 | <para>If one of the arguments is a unit type, when listing | |
7b870f60 | 86 | units, limit display to certain unit types. Otherwise, units |
4a6022f0 ZJS |
87 | of all types will be shown.</para> |
88 | ||
20b3f379 | 89 | <para>As a special case, if one of the arguments is |
4a6022f0 ZJS |
90 | <option>help</option>, a list of allowed values will be |
91 | printed and the program will exit.</para> | |
92 | </listitem> | |
93 | </varlistentry> | |
94 | ||
9b9b3d36 MW |
95 | <varlistentry> |
96 | <term><option>--state=</option></term> | |
97 | ||
98 | <listitem> | |
0f85cbe1 ZJS |
99 | <para>The argument should be a comma-separated list of unit LOAD, |
100 | SUB, or ACTIVE states. When listing units, show only those | |
101 | in specified states.</para> | |
9b9b3d36 MW |
102 | </listitem> |
103 | </varlistentry> | |
104 | ||
4a6022f0 ZJS |
105 | <varlistentry> |
106 | <term><option>-p</option></term> | |
107 | <term><option>--property=</option></term> | |
108 | ||
109 | <listitem> | |
54c31a79 LP |
110 | <para>When showing unit/job/manager properties with the |
111 | <command>show</command> command, limit display to certain | |
7b870f60 | 112 | properties as specified as argument. If not specified, all |
54c31a79 | 113 | set properties are shown. The argument should be a |
d2bbca68 | 114 | comma-separated list of property names, such as |
7b870f60 | 115 | <literal>MainPID</literal>. If specified more than once, all |
033a842c | 116 | properties with the specified names are shown.</para> |
4a6022f0 ZJS |
117 | </listitem> |
118 | </varlistentry> | |
119 | ||
120 | <varlistentry> | |
121 | <term><option>-a</option></term> | |
122 | <term><option>--all</option></term> | |
123 | ||
124 | <listitem> | |
a5e4972c LP |
125 | <para>When listing units, show all loaded units, regardless |
126 | of their state, including inactive units. When showing | |
4a6022f0 ZJS |
127 | unit/job/manager properties, show all properties regardless |
128 | whether they are set or not.</para> | |
a5e4972c LP |
129 | <para>To list all units installed on the system, use the |
130 | <command>list-unit-files</command> command instead.</para> | |
4a6022f0 ZJS |
131 | </listitem> |
132 | </varlistentry> | |
133 | ||
afba4199 ZJS |
134 | <varlistentry> |
135 | <term><option>--reverse</option></term> | |
136 | ||
137 | <listitem> | |
138 | <para>Show reverse dependencies between units with | |
139 | <command>list-dependencies</command>, i.e. units with | |
140 | dependencies of type <varname>Wants=</varname> or | |
141 | <varname>Requires=</varname> on the given unit. | |
142 | </para> | |
143 | </listitem> | |
144 | </varlistentry> | |
145 | ||
146 | <varlistentry> | |
147 | <term><option>--after</option></term> | |
148 | <term><option>--before</option></term> | |
149 | ||
150 | <listitem> | |
4a77ca70 AB |
151 | <para>Show after (before) which units the specified unit is started |
152 | with <command>list-dependencies</command>. | |
afba4199 ZJS |
153 | </para> |
154 | </listitem> | |
155 | </varlistentry> | |
156 | ||
4a6022f0 | 157 | <varlistentry> |
98a6e132 | 158 | <term><option>-l</option></term> |
4a6022f0 ZJS |
159 | <term><option>--full</option></term> |
160 | ||
161 | <listitem> | |
69d918b0 ZJS |
162 | <para>Do not ellipsize unit names, process tree entries, |
163 | journal output, or truncate unit descriptions in the output | |
164 | of <command>status</command>, <command>list-units</command>, | |
165 | <command>list-jobs</command>, and | |
166 | <command>list-timers</command>.</para> | |
4a6022f0 ZJS |
167 | </listitem> |
168 | </varlistentry> | |
169 | ||
991f2a39 ZJS |
170 | <varlistentry> |
171 | <term><option>--show-types</option></term> | |
172 | ||
173 | <listitem> | |
174 | <para>When showing sockets, show the type of the socket.</para> | |
175 | </listitem> | |
176 | </varlistentry> | |
177 | ||
23ade460 | 178 | <varlistentry> |
4dc5b821 | 179 | <term><option>--job-mode=</option></term> |
23ade460 MS |
180 | |
181 | <listitem> | |
e0e009c0 JE |
182 | <para>When queuing a new job, this option controls how to deal with |
183 | already queued jobs. It takes one of <literal>fail</literal>, | |
4dc5b821 LP |
184 | <literal>replace</literal>, |
185 | <literal>replace-irreversibly</literal>, | |
186 | <literal>isolate</literal>, | |
187 | <literal>ignore-dependencies</literal>, | |
188 | <literal>ignore-requirements</literal> or | |
189 | <literal>flush</literal>. Defaults to | |
190 | <literal>replace</literal>, except when the | |
191 | <command>isolate</command> command is used which implies the | |
192 | <literal>isolate</literal> job mode.</para> | |
193 | ||
194 | <para>If <literal>fail</literal> is specified and a requested | |
195 | operation conflicts with a pending job (more specifically: | |
196 | causes an already pending start job to be reversed into a stop | |
197 | job or vice versa), cause the operation to fail.</para> | |
198 | ||
199 | <para>If <literal>replace</literal> (the default) is | |
200 | specified, any conflicting pending job will be replaced, as | |
201 | necessary.</para> | |
202 | ||
203 | <para>If <literal>replace-irreversibly</literal> is specified, | |
204 | operate like <literal>replace</literal>, but also mark the new | |
205 | jobs as irreversible. This prevents future conflicting | |
206 | transactions from replacing these jobs. The jobs can still be | |
207 | cancelled using the <command>cancel</command> command.</para> | |
208 | ||
209 | <para><literal>isolate</literal> is only valid for start | |
210 | operations and causes all other units to be stopped when the | |
211 | specified unit is started. This mode is always used when the | |
212 | <command>isolate</command> command is used.</para> | |
213 | ||
214 | <para><literal>flush</literal> will cause all queued jobs to | |
215 | be canceled when the new job is enqueued.</para> | |
216 | ||
217 | <para>If <literal>ignore-dependencies</literal> is specified, | |
218 | then all unit dependencies are ignored for this new job and | |
219 | the operation is executed immediately. If passed, no required | |
220 | units of the unit passed will be pulled in, and no ordering | |
221 | dependencies will be honored. This is mostly a debugging and | |
222 | rescue tool for the administrator and should not be used by | |
223 | applications.</para> | |
224 | ||
225 | <para><literal>ignore-requirements</literal> is similar to | |
b040723e | 226 | <literal>ignore-dependencies</literal>, but only causes the |
4dc5b821 LP |
227 | requirement dependencies to be ignored, the ordering |
228 | dependencies will still be honoured.</para> | |
23ade460 | 229 | </listitem> |
4a6022f0 | 230 | |
4a6022f0 ZJS |
231 | </varlistentry> |
232 | ||
233 | <varlistentry> | |
234 | <term><option>-i</option></term> | |
235 | <term><option>--ignore-inhibitors</option></term> | |
236 | ||
237 | <listitem> | |
238 | <para>When system shutdown or a sleep state is requested, | |
239 | ignore inhibitor locks. Applications can establish inhibitor | |
240 | locks to avoid that certain important operations (such as CD | |
241 | burning or suchlike) are interrupted by system shutdown or a | |
242 | sleep state. Any user may take these locks and privileged | |
243 | users may override these locks. If any locks are taken, | |
244 | shutdown and sleep state requests will normally fail | |
494a6682 | 245 | (regardless of whether privileged or not) and a list of active locks |
7b870f60 JE |
246 | is printed. However, if <option>--ignore-inhibitors</option> |
247 | is specified, the locks are ignored and not printed, and the | |
4a6022f0 ZJS |
248 | operation attempted anyway, possibly requiring additional |
249 | privileges.</para> | |
250 | </listitem> | |
251 | </varlistentry> | |
252 | ||
253 | <varlistentry> | |
254 | <term><option>-q</option></term> | |
255 | <term><option>--quiet</option></term> | |
256 | ||
257 | <listitem> | |
258 | <para>Suppress output to standard output in | |
259 | <command>snapshot</command>, | |
260 | <command>is-active</command>, | |
261 | <command>is-failed</command>, | |
262 | <command>enable</command> and | |
263 | <command>disable</command>.</para> | |
264 | </listitem> | |
265 | </varlistentry> | |
266 | ||
267 | <varlistentry> | |
268 | <term><option>--no-block</option></term> | |
269 | ||
270 | <listitem> | |
271 | <para>Do not synchronously wait for the requested operation | |
7b870f60 | 272 | to finish. If this is not specified, the job will be |
4a6022f0 | 273 | verified, enqueued and <command>systemctl</command> will |
7b870f60 | 274 | wait until it is completed. By passing this argument, it is |
4a6022f0 ZJS |
275 | only verified and enqueued.</para> |
276 | </listitem> | |
277 | </varlistentry> | |
278 | ||
279 | <varlistentry> | |
280 | <term><option>--no-legend</option></term> | |
281 | ||
282 | <listitem> | |
841aa8c0 | 283 | <para>Do not print the legend, i.e. the column headers and |
4a6022f0 ZJS |
284 | the footer with hints.</para> |
285 | </listitem> | |
286 | </varlistentry> | |
287 | ||
88ae7333 ZJS |
288 | <xi:include href="user-system-options.xml" xpointer="user" /> |
289 | <xi:include href="user-system-options.xml" xpointer="system" /> | |
4a6022f0 ZJS |
290 | |
291 | <varlistentry> | |
292 | <term><option>--no-wall</option></term> | |
293 | ||
294 | <listitem> | |
7b870f60 | 295 | <para>Do not send wall message before halt, power-off, |
4a6022f0 ZJS |
296 | reboot.</para> |
297 | </listitem> | |
298 | </varlistentry> | |
299 | ||
300 | <varlistentry> | |
301 | <term><option>--global</option></term> | |
302 | ||
303 | <listitem> | |
304 | <para>When used with <command>enable</command> and | |
305 | <command>disable</command>, operate on the global user | |
306 | configuration directory, thus enabling or disabling a unit | |
307 | file globally for all future logins of all users.</para> | |
308 | </listitem> | |
309 | </varlistentry> | |
310 | ||
311 | <varlistentry> | |
312 | <term><option>--no-reload</option></term> | |
313 | ||
314 | <listitem> | |
315 | <para>When used with <command>enable</command> and | |
316 | <command>disable</command>, do not implicitly reload daemon | |
317 | configuration after executing the changes.</para> | |
318 | </listitem> | |
319 | </varlistentry> | |
320 | ||
321 | <varlistentry> | |
322 | <term><option>--no-ask-password</option></term> | |
323 | ||
324 | <listitem> | |
325 | <para>When used with <command>start</command> and related | |
326 | commands, disables asking for passwords. Background services | |
327 | may require input of a password or passphrase string, for | |
328 | example to unlock system hard disks or cryptographic | |
329 | certificates. Unless this option is specified and the | |
7b870f60 | 330 | command is invoked from a terminal, |
4a6022f0 ZJS |
331 | <command>systemctl</command> will query the user on the |
332 | terminal for the necessary secrets. Use this option to | |
7b870f60 | 333 | switch this behavior off. In this case, the password must be |
4a6022f0 ZJS |
334 | supplied by some other means (for example graphical password |
335 | agents) or the service might fail. This also disables | |
336 | querying the user for authentication for privileged | |
337 | operations.</para> | |
338 | </listitem> | |
339 | ||
340 | </varlistentry> | |
341 | ||
342 | <varlistentry> | |
343 | <term><option>--kill-who=</option></term> | |
344 | ||
345 | <listitem> | |
346 | <para>When used with <command>kill</command>, choose which | |
347 | processes to kill. Must be one of <option>main</option>, | |
348 | <option>control</option> or <option>all</option> to select | |
349 | whether to kill only the main process of the unit, the | |
7b870f60 | 350 | control process or all processes of the unit. If omitted, |
4a6022f0 ZJS |
351 | defaults to <option>all</option>.</para> |
352 | </listitem> | |
353 | ||
354 | </varlistentry> | |
355 | ||
356 | <varlistentry> | |
357 | <term><option>-s</option></term> | |
358 | <term><option>--signal=</option></term> | |
359 | ||
360 | <listitem> | |
361 | <para>When used with <command>kill</command>, choose which | |
362 | signal to send to selected processes. Must be one of the | |
05cc7267 | 363 | well known signal specifiers such as <constant>SIGTERM</constant>, <constant>SIGINT</constant> or |
7b870f60 | 364 | <constant>SIGSTOP</constant>. If omitted, defaults to |
4a6022f0 ZJS |
365 | <option>SIGTERM</option>.</para> |
366 | </listitem> | |
367 | </varlistentry> | |
368 | ||
369 | <varlistentry> | |
370 | <term><option>-f</option></term> | |
371 | <term><option>--force</option></term> | |
372 | ||
373 | <listitem> | |
374 | <para>When used with <command>enable</command>, overwrite | |
375 | any existing conflicting symlinks.</para> | |
376 | ||
377 | <para>When used with <command>halt</command>, | |
378 | <command>poweroff</command>, <command>reboot</command> or | |
7b870f60 | 379 | <command>kexec</command>, execute the selected operation |
4a6022f0 ZJS |
380 | without shutting down all units. However, all processes will |
381 | be killed forcibly and all file systems are unmounted or | |
382 | remounted read-only. This is hence a drastic but relatively | |
383 | safe option to request an immediate reboot. If | |
384 | <option>--force</option> is specified twice for these | |
385 | operations, they will be executed immediately without | |
386 | terminating any processes or umounting any file | |
387 | systems. Warning: specifying <option>--force</option> twice | |
388 | with any of these operations might result in data | |
389 | loss.</para> | |
390 | </listitem> | |
391 | </varlistentry> | |
392 | ||
393 | <varlistentry> | |
394 | <term><option>--root=</option></term> | |
395 | ||
396 | <listitem> | |
397 | <para>When used with | |
398 | <command>enable</command>/<command>disable</command>/<command>is-enabled</command> | |
399 | (and related commands), use alternative root path when | |
400 | looking for unit files.</para> | |
401 | </listitem> | |
402 | ||
403 | </varlistentry> | |
404 | ||
405 | <varlistentry> | |
406 | <term><option>--runtime</option></term> | |
407 | ||
408 | <listitem> | |
a330b376 | 409 | <para>When used with <command>enable</command>, |
171754aa | 410 | <command>disable</command>, |
4a6022f0 | 411 | (and related commands), make changes only temporarily, so |
a330b376 | 412 | that they are lost on the next reboot. This will have the |
4a6022f0 ZJS |
413 | effect that changes are not made in subdirectories of |
414 | <filename>/etc</filename> but in <filename>/run</filename>, | |
415 | with identical immediate effects, however, since the latter | |
416 | is lost on reboot, the changes are lost too.</para> | |
a330b376 | 417 | |
494a6682 | 418 | <para>Similarly, when used with |
fbce1139 | 419 | <command>set-property</command>, make changes only |
a330b376 LP |
420 | temporarily, so that they are lost on the next |
421 | reboot.</para> | |
4a6022f0 ZJS |
422 | </listitem> |
423 | </varlistentry> | |
424 | ||
4a6022f0 ZJS |
425 | <varlistentry> |
426 | <term><option>-n</option></term> | |
427 | <term><option>--lines=</option></term> | |
428 | ||
429 | <listitem> | |
7b870f60 | 430 | <para>When used with <command>status</command>, controls the |
4a6022f0 ZJS |
431 | number of journal lines to show, counting from the most |
432 | recent ones. Takes a positive integer argument. Defaults to | |
433 | 10.</para> | |
434 | </listitem> | |
435 | </varlistentry> | |
436 | ||
437 | <varlistentry> | |
438 | <term><option>-o</option></term> | |
439 | <term><option>--output=</option></term> | |
440 | ||
441 | <listitem> | |
7b870f60 | 442 | <para>When used with <command>status</command>, controls the |
4a6022f0 | 443 | formatting of the journal entries that are shown. For the |
7b870f60 | 444 | available choices, see |
4a6022f0 ZJS |
445 | <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>. |
446 | Defaults to <literal>short</literal>.</para> | |
447 | </listitem> | |
448 | </varlistentry> | |
449 | ||
5d0c05e5 LN |
450 | <varlistentry> |
451 | <term><option>--plain</option></term> | |
452 | ||
453 | <listitem> | |
7b870f60 | 454 | <para>When used with <command>list-dependencies</command>, |
5d0c05e5 LN |
455 | the output is printed as a list instead of a tree.</para> |
456 | </listitem> | |
457 | </varlistentry> | |
458 | ||
4f50d2ef ZJS |
459 | <xi:include href="user-system-options.xml" xpointer="host" /> |
460 | <xi:include href="user-system-options.xml" xpointer="machine" /> | |
461 | ||
dfdebb1b ZJS |
462 | <xi:include href="standard-options.xml" xpointer="help" /> |
463 | <xi:include href="standard-options.xml" xpointer="version" /> | |
464 | <xi:include href="standard-options.xml" xpointer="no-pager" /> | |
4a6022f0 ZJS |
465 | </variablelist> |
466 | </refsect1> | |
467 | ||
468 | <refsect1> | |
469 | <title>Commands</title> | |
470 | ||
471 | <para>The following commands are understood:</para> | |
472 | ||
27722f96 LN |
473 | <refsect2> |
474 | <title>Unit Commands</title> | |
4a6022f0 | 475 | |
27722f96 LN |
476 | <variablelist> |
477 | <varlistentry> | |
4f8f66cb | 478 | <term><command>list-units <optional><replaceable>PATTERN</replaceable>...</optional></command></term> |
4a6022f0 | 479 | |
27722f96 LN |
480 | <listitem> |
481 | <para>List known units (subject to limitations specified | |
d8fba7c6 ZJS |
482 | with <option>-t</option>). If one or more |
483 | <replaceable>PATTERN</replaceable>s are specified, only | |
484 | units matching one of them are shown.</para> | |
991f2a39 | 485 | |
27722f96 LN |
486 | <para>This is the default command.</para> |
487 | </listitem> | |
488 | </varlistentry> | |
991f2a39 | 489 | |
27722f96 | 490 | <varlistentry> |
4f8f66cb | 491 | <term><command>list-sockets <optional><replaceable>PATTERN</replaceable>...</optional></command></term> |
27722f96 LN |
492 | |
493 | <listitem> | |
e0e009c0 | 494 | <para>List socket units ordered by listening address. |
d8fba7c6 ZJS |
495 | If one or more <replaceable>PATTERN</replaceable>s are |
496 | specified, only socket units matching one of them are | |
497 | shown. Produces output similar to | |
27722f96 | 498 | <programlisting> |
991f2a39 ZJS |
499 | LISTEN UNIT ACTIVATES |
500 | /dev/initctl systemd-initctl.socket systemd-initctl.service | |
501 | ... | |
502 | [::]:22 sshd.socket sshd.service | |
503 | kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service | |
504 | ||
9fccdb0f | 505 | 5 sockets listed.</programlisting> |
27722f96 LN |
506 | Note: because the addresses might contains spaces, this output |
507 | is not suitable for programmatic consumption. | |
508 | </para> | |
509 | ||
510 | <para>See also the options <option>--show-types</option>, | |
511 | <option>--all</option>, and <option>--failed</option>.</para> | |
512 | </listitem> | |
513 | </varlistentry> | |
514 | ||
cbb76c29 | 515 | <varlistentry> |
4f8f66cb | 516 | <term><command>list-timers <optional><replaceable>PATTERN</replaceable>...</optional></command></term> |
cbb76c29 LP |
517 | |
518 | <listitem> | |
d8fba7c6 ZJS |
519 | <para>List timer units ordered by the time they elapse |
520 | next. If one or more <replaceable>PATTERN</replaceable>s | |
521 | are specified, only units matching one of them are shown. | |
522 | </para> | |
cbb76c29 LP |
523 | |
524 | <para>See also the options <option>--all</option> and | |
525 | <option>--failed</option>.</para> | |
526 | </listitem> | |
527 | </varlistentry> | |
528 | ||
27722f96 | 529 | <varlistentry> |
e3e0314b | 530 | <term><command>start <replaceable>PATTERN</replaceable>...</command></term> |
27722f96 LN |
531 | |
532 | <listitem> | |
533 | <para>Start (activate) one or more units specified on the | |
534 | command line.</para> | |
e3e0314b ZJS |
535 | |
536 | <para>Note that glob patterns operate on a list of currently | |
537 | loaded units. Units which are not active and are not in a | |
538 | failed state usually are not loaded, and would not be | |
539 | matched by any pattern. In addition, in case of | |
540 | instantiated units, systemd is often unaware of the | |
73e231ab | 541 | instance name until the instance has been started. Therefore, |
e3e0314b ZJS |
542 | using glob patterns with <command>start</command> |
543 | has limited usefulness.</para> | |
27722f96 LN |
544 | </listitem> |
545 | </varlistentry> | |
546 | <varlistentry> | |
e3e0314b | 547 | <term><command>stop <replaceable>PATTERN</replaceable>...</command></term> |
27722f96 LN |
548 | |
549 | <listitem> | |
550 | <para>Stop (deactivate) one or more units specified on the | |
551 | command line.</para> | |
552 | </listitem> | |
553 | </varlistentry> | |
554 | <varlistentry> | |
e3e0314b | 555 | <term><command>reload <replaceable>PATTERN</replaceable>...</command></term> |
27722f96 LN |
556 | |
557 | <listitem> | |
558 | <para>Asks all units listed on the command line to reload | |
559 | their configuration. Note that this will reload the | |
560 | service-specific configuration, not the unit configuration | |
561 | file of systemd. If you want systemd to reload the | |
79640424 | 562 | configuration file of a unit, use the |
27722f96 LN |
563 | <command>daemon-reload</command> command. In other words: |
564 | for the example case of Apache, this will reload Apache's | |
565 | <filename>httpd.conf</filename> in the web server, not the | |
566 | <filename>apache.service</filename> systemd unit | |
567 | file.</para> | |
568 | ||
569 | <para>This command should not be confused with the | |
570 | <command>daemon-reload</command> or <command>load</command> | |
571 | commands.</para> | |
572 | </listitem> | |
573 | ||
574 | </varlistentry> | |
575 | <varlistentry> | |
e3e0314b | 576 | <term><command>restart <replaceable>PATTERN</replaceable>...</command></term> |
27722f96 LN |
577 | |
578 | <listitem> | |
579 | <para>Restart one or more units specified on the command | |
580 | line. If the units are not running yet, they will be | |
581 | started.</para> | |
582 | </listitem> | |
583 | </varlistentry> | |
584 | <varlistentry> | |
e3e0314b | 585 | <term><command>try-restart <replaceable>PATTERN</replaceable>...</command></term> |
27722f96 LN |
586 | |
587 | <listitem> | |
588 | <para>Restart one or more units specified on the command | |
589 | line if the units are running. This does nothing if units are not | |
590 | running. Note that, for compatibility with Red Hat init | |
591 | scripts, <command>condrestart</command> is equivalent to this | |
592 | command.</para> | |
593 | </listitem> | |
594 | </varlistentry> | |
595 | <varlistentry> | |
e3e0314b | 596 | <term><command>reload-or-restart <replaceable>PATTERN</replaceable>...</command></term> |
27722f96 LN |
597 | |
598 | <listitem> | |
599 | <para>Reload one or more units if they support it. If not, | |
600 | restart them instead. If the units are not running yet, they | |
601 | will be started.</para> | |
602 | </listitem> | |
603 | </varlistentry> | |
604 | <varlistentry> | |
e3e0314b | 605 | <term><command>reload-or-try-restart <replaceable>PATTERN</replaceable>...</command></term> |
27722f96 LN |
606 | |
607 | <listitem> | |
608 | <para>Reload one or more units if they support it. If not, | |
609 | restart them instead. This does nothing if the units are not | |
610 | running. Note that, for compatibility with SysV init scripts, | |
611 | <command>force-reload</command> is equivalent to this | |
612 | command.</para> | |
613 | </listitem> | |
614 | </varlistentry> | |
615 | <varlistentry> | |
616 | <term><command>isolate <replaceable>NAME</replaceable></command></term> | |
617 | ||
618 | <listitem> | |
619 | <para>Start the unit specified on the command line and its | |
620 | dependencies and stop all others.</para> | |
621 | ||
622 | <para>This is similar to changing the runlevel in a | |
623 | traditional init system. The <command>isolate</command> | |
624 | command will immediately stop processes that are not enabled | |
625 | in the new unit, possibly including the graphical | |
626 | environment or terminal you are currently using.</para> | |
627 | ||
628 | <para>Note that this is allowed only on units where | |
629 | <option>AllowIsolate=</option> is enabled. See | |
630 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
631 | for details.</para> | |
632 | </listitem> | |
633 | </varlistentry> | |
634 | <varlistentry> | |
e3e0314b | 635 | <term><command>kill <replaceable>PATTERN</replaceable>...</command></term> |
27722f96 LN |
636 | |
637 | <listitem> | |
638 | <para>Send a signal to one or more processes of the | |
639 | unit. Use <option>--kill-who=</option> to select which | |
640 | process to kill. Use <option>--kill-mode=</option> to select | |
641 | the kill mode and <option>--signal=</option> to select the | |
642 | signal to send.</para> | |
643 | </listitem> | |
644 | </varlistentry> | |
645 | <varlistentry> | |
e3e0314b | 646 | <term><command>is-active <replaceable>PATTERN</replaceable>...</command></term> |
27722f96 LN |
647 | |
648 | <listitem> | |
649 | <para>Check whether any of the specified units are active | |
6db27428 ZJS |
650 | (i.e. running). Returns an exit code |
651 | <constant>0</constant> if at least one is active, or | |
652 | non-zero otherwise. Unless <option>--quiet</option> is | |
653 | specified, this will also print the current unit state to | |
654 | standard output.</para> | |
27722f96 LN |
655 | </listitem> |
656 | </varlistentry> | |
657 | <varlistentry> | |
e3e0314b | 658 | <term><command>is-failed <replaceable>PATTERN</replaceable>...</command></term> |
27722f96 LN |
659 | |
660 | <listitem> | |
6db27428 ZJS |
661 | <para>Check whether any of the specified units are in a |
662 | "failed" state. Returns an exit code | |
663 | <constant>0</constant> if at least one has failed, | |
664 | non-zero otherwise. Unless <option>--quiet</option> is | |
665 | specified, this will also print the current unit state to | |
666 | standard output.</para> | |
27722f96 LN |
667 | </listitem> |
668 | </varlistentry> | |
669 | <varlistentry> | |
e3e0314b | 670 | <term><command>status</command> <optional><replaceable>PATTERN</replaceable>...|<replaceable>PID</replaceable>...]</optional></term> |
27722f96 LN |
671 | |
672 | <listitem> | |
673 | <para>Show terse runtime status information about one or | |
674 | more units, followed by most recent log data from the | |
8fcf784d LP |
675 | journal. If no units are specified, show system status. If |
676 | combined with <option>--all</option> also shows status of | |
677 | all units (subject to limitations specified with | |
678 | <option>-t</option>). If a PID is passed, show information | |
679 | about the unit the process belongs to.</para> | |
27722f96 LN |
680 | |
681 | <para>This function is intended to generate human-readable | |
e213d1a3 ZJS |
682 | output. If you are looking for computer-parsable output, |
683 | use <command>show</command> instead. By default this | |
684 | function only shows 10 lines of output and ellipsizes | |
685 | lines to fit in the terminal window. This can be changes | |
686 | with <option>--lines</option> and <option>--full</option>, | |
687 | see above. In addition, <command>journalctl | |
688 | --unit=<replaceable>NAME</replaceable></command> or | |
689 | <command>journalctl | |
690 | --user-unit=<replaceable>NAME</replaceable></command> use | |
691 | a similar filter for messages and might be more | |
692 | convenient. | |
693 | </para> | |
27722f96 LN |
694 | </listitem> |
695 | </varlistentry> | |
696 | <varlistentry> | |
e3e0314b | 697 | <term><command>show</command> <optional><replaceable>PATTERN</replaceable>...|<replaceable>JOB</replaceable>...</optional></term> |
27722f96 LN |
698 | |
699 | <listitem> | |
700 | <para>Show properties of one or more units, jobs, or the | |
79640424 JE |
701 | manager itself. If no argument is specified, properties of |
702 | the manager will be shown. If a unit name is specified, | |
27722f96 | 703 | properties of the unit is shown, and if a job id is |
79640424 | 704 | specified, properties of the job is shown. By default, empty |
27722f96 | 705 | properties are suppressed. Use <option>--all</option> to |
79640424 | 706 | show those too. To select specific properties to show, use |
27722f96 LN |
707 | <option>--property=</option>. This command is intended to be |
708 | used whenever computer-parsable output is required. Use | |
709 | <command>status</command> if you are looking for formatted | |
710 | human-readable output.</para> | |
711 | </listitem> | |
712 | </varlistentry> | |
e93c33d4 | 713 | <varlistentry> |
e3e0314b | 714 | <term><command>cat <replaceable>PATTERN</replaceable>...</command></term> |
27722f96 | 715 | |
e93c33d4 | 716 | <listitem> |
e4c0fbe5 ZJS |
717 | <para>Show backing files of one or more units. Prints the |
718 | "fragment" and "drop-ins" (source files) of units. Each | |
719 | file is preceded by a comment which includes the file | |
720 | name.</para> | |
e93c33d4 SL |
721 | </listitem> |
722 | </varlistentry> | |
27722f96 LN |
723 | <varlistentry> |
724 | <term><command>set-property <replaceable>NAME</replaceable> <replaceable>ASSIGNMENT</replaceable>...</command></term> | |
725 | ||
726 | <listitem> | |
727 | <para>Set the specified unit properties at runtime where | |
728 | this is supported. This allows changing configuration | |
3fde5f30 | 729 | parameter properties such as resource control settings at |
27722f96 | 730 | runtime. Not all properties may be changed at runtime, but |
3fde5f30 LP |
731 | many resource control settings (primarily those in |
732 | <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>) | |
27722f96 LN |
733 | may. The changes are applied instantly, and stored on disk |
734 | for future boots, unless <option>--runtime</option> is | |
3fde5f30 LP |
735 | passed, in which case the settings only apply until the |
736 | next reboot. The syntax of the property assignment follows | |
27722f96 LN |
737 | closely the syntax of assignments in unit files.</para> |
738 | ||
739 | <para>Example: <command>systemctl set-property foobar.service CPUShares=777</command></para> | |
740 | ||
741 | <para>Note that this command allows changing multiple | |
742 | properties at the same time, which is preferable over | |
743 | setting them individually. Like unit file configuration | |
744 | settings, assigning the empty list to list parameters will | |
745 | reset the list.</para> | |
746 | </listitem> | |
747 | </varlistentry> | |
748 | ||
749 | <varlistentry> | |
e3e0314b | 750 | <term><command>help <replaceable>PATTERN</replaceable>...|<replaceable>PID</replaceable>...</command></term> |
27722f96 LN |
751 | |
752 | <listitem> | |
753 | <para>Show manual pages for one or more units, if | |
754 | available. If a PID is given, the manual pages for the unit | |
755 | the process belongs to are shown.</para> | |
756 | </listitem> | |
757 | </varlistentry> | |
758 | ||
759 | <varlistentry> | |
e3e0314b | 760 | <term><command>reset-failed [<replaceable>PATTERN</replaceable>...]</command></term> |
27722f96 LN |
761 | |
762 | <listitem> | |
763 | <para>Reset the <literal>failed</literal> state of the | |
764 | specified units, or if no unit name is passed, reset the state of all | |
765 | units. When a unit fails in some way (i.e. process exiting | |
766 | with non-zero error code, terminating abnormally or timing | |
767 | out), it will automatically enter the | |
768 | <literal>failed</literal> state and its exit code and status | |
769 | is recorded for introspection by the administrator until the | |
770 | service is restarted or reset with this command.</para> | |
771 | </listitem> | |
772 | </varlistentry> | |
773 | ||
774 | <varlistentry> | |
775 | <term><command>list-dependencies <replaceable>NAME</replaceable></command></term> | |
776 | ||
777 | <listitem> | |
778 | <para>Shows required and wanted units of the specified | |
779 | unit. If no unit is specified, | |
780 | <filename>default.target</filename> is implied. Target units | |
781 | are recursively expanded. When <option>--all</option> is | |
782 | passed, all other units are recursively expanded as | |
783 | well.</para> | |
784 | </listitem> | |
785 | </varlistentry> | |
786 | </variablelist> | |
787 | </refsect2> | |
788 | ||
789 | <refsect2> | |
790 | <title>Unit File Commands</title> | |
791 | ||
792 | <variablelist> | |
793 | <varlistentry> | |
d8fba7c6 | 794 | <term><command>list-unit-files <optional><replaceable>PATTERN...</replaceable></optional></command></term> |
27722f96 LN |
795 | |
796 | <listitem> | |
d8fba7c6 ZJS |
797 | <para>List installed unit files. If one or more |
798 | <replaceable>PATTERN</replaceable>s are specified, only | |
799 | units whose filename (just the last component of the path) | |
800 | matches one of them are shown.</para> | |
27722f96 LN |
801 | </listitem> |
802 | </varlistentry> | |
803 | ||
804 | <varlistentry> | |
805 | <term><command>enable <replaceable>NAME</replaceable>...</command></term> | |
806 | ||
807 | <listitem> | |
808 | <para>Enable one or more unit files or unit file instances, | |
809 | as specified on the command line. This will create a number | |
810 | of symlinks as encoded in the <literal>[Install]</literal> | |
811 | sections of the unit files. After the symlinks have been | |
812 | created, the systemd configuration is reloaded (in a way that | |
813 | is equivalent to <command>daemon-reload</command>) to ensure | |
814 | the changes are taken into account immediately. Note that | |
815 | this does <emphasis>not</emphasis> have the effect of also | |
816 | starting any of the units being enabled. If this | |
817 | is desired, a separate <command>start</command> command must | |
818 | be invoked for the unit. Also note that in case of instance | |
819 | enablement, symlinks named the same as instances are created in | |
820 | the install location, however they all point to the same | |
821 | template unit file.</para> | |
822 | ||
823 | <para>This command will print the actions executed. This | |
824 | output may be suppressed by passing <option>--quiet</option>. | |
825 | </para> | |
826 | ||
827 | <para>Note that this operation creates only the suggested | |
828 | symlinks for the units. While this command is the | |
829 | recommended way to manipulate the unit configuration | |
830 | directory, the administrator is free to make additional | |
831 | changes manually by placing or removing symlinks in the | |
832 | directory. This is particularly useful to create | |
833 | configurations that deviate from the suggested default | |
834 | installation. In this case, the administrator must make sure | |
835 | to invoke <command>daemon-reload</command> manually as | |
836 | necessary to ensure the changes are taken into account. | |
837 | </para> | |
838 | ||
839 | <para>Enabling units should not be confused with starting | |
840 | (activating) units, as done by the <command>start</command> | |
841 | command. Enabling and starting units is orthogonal: units | |
842 | may be enabled without being started and started without | |
843 | being enabled. Enabling simply hooks the unit into various | |
844 | suggested places (for example, so that the unit is | |
845 | automatically started on boot or when a particular kind of | |
846 | hardware is plugged in). Starting actually spawns the daemon | |
847 | process (in case of service units), or binds the socket (in | |
848 | case of socket units), and so on.</para> | |
849 | ||
850 | <para>Depending on whether <option>--system</option>, | |
1bee43de | 851 | <option>--user</option>, <option>--runtime</option>, |
72f4d966 | 852 | or <option>--global</option> is specified, this enables the unit |
1bee43de ZJS |
853 | for the system, for the calling user only, for only this boot of |
854 | the system, or for all future logins of all users, or only this | |
855 | boot. Note that in the last case, no systemd daemon | |
27722f96 LN |
856 | configuration is reloaded.</para> |
857 | </listitem> | |
858 | </varlistentry> | |
859 | ||
860 | <varlistentry> | |
861 | <term><command>disable <replaceable>NAME</replaceable>...</command></term> | |
862 | ||
863 | <listitem> | |
864 | <para>Disables one or more units. This removes all symlinks | |
865 | to the specified unit files from the unit configuration | |
866 | directory, and hence undoes the changes made by | |
867 | <command>enable</command>. Note however that this removes | |
868 | all symlinks to the unit files (i.e. including manual | |
869 | additions), not just those actually created by | |
870 | <command>enable</command>. This call implicitly reloads the | |
871 | systemd daemon configuration after completing the disabling | |
872 | of the units. Note that this command does not implicitly | |
873 | stop the units that are being disabled. If this is desired, | |
874 | an additional <command>stop</command> command should be | |
875 | executed afterwards.</para> | |
876 | ||
877 | <para>This command will print the actions executed. This | |
878 | output may be suppressed by passing <option>--quiet</option>. | |
879 | </para> | |
880 | ||
881 | <para>This command honors <option>--system</option>, | |
72f4d966 | 882 | <option>--user</option>, <option>--runtime</option> and |
1bee43de ZJS |
883 | <option>--global</option> in a similar way as |
884 | <command>enable</command>.</para> | |
27722f96 LN |
885 | </listitem> |
886 | </varlistentry> | |
887 | ||
888 | <varlistentry> | |
889 | <term><command>is-enabled <replaceable>NAME</replaceable>...</command></term> | |
890 | ||
891 | <listitem> | |
892 | <para>Checks whether any of the specified unit files are | |
171754aa ZJS |
893 | enabled (as with <command>enable</command>). Returns an |
894 | exit code of 0 if at least one is enabled, non-zero | |
895 | otherwise. Prints the current enable status (see table). | |
896 | To suppress this output, use <option>--quiet</option>. | |
897 | </para> | |
898 | ||
899 | <table> | |
900 | <title> | |
901 | <command>is-enabled</command> output | |
902 | </title> | |
903 | ||
904 | <tgroup cols='3'> | |
905 | <thead> | |
906 | <row> | |
907 | <entry>Printed string</entry> | |
908 | <entry>Meaning</entry> | |
909 | <entry>Return value</entry> | |
910 | </row> | |
911 | </thead> | |
912 | <tbody> | |
913 | <row> | |
914 | <entry><literal>enabled</literal></entry> | |
915 | <entry morerows='1'>Enabled through a symlink in <filename>.wants</filename> directory (permanently or just in <filename>/run</filename>)</entry> | |
916 | <entry morerows='1'>0</entry> | |
917 | </row> | |
918 | <row> | |
919 | <entry><literal>enabled-runtime</literal></entry> | |
920 | </row> | |
921 | <row> | |
922 | <entry><literal>linked</literal></entry> | |
923 | <entry morerows='1'>Made available through a symlink to the unit file (permanently or just in <filename>/run</filename>)</entry> | |
924 | <entry morerows='1'>1</entry> | |
925 | </row> | |
926 | <row> | |
927 | <entry><literal>linked-runtime</literal></entry> | |
928 | </row> | |
929 | <row> | |
930 | <entry><literal>masked</literal></entry> | |
931 | <entry morerows='1'>Disabled entirely (permanently or just in <filename>/run</filename>)</entry> | |
932 | <entry morerows='1'>1</entry> | |
933 | </row> | |
934 | <row> | |
935 | <entry><literal>masked-runtime</literal></entry> | |
936 | </row> | |
937 | <row> | |
938 | <entry><literal>static</literal></entry> | |
939 | <entry>Unit is not enabled, but has no provisions for enabling in [Install] section</entry> | |
91f0ac7d | 940 | <entry>0</entry> |
171754aa ZJS |
941 | </row> |
942 | <row> | |
943 | <entry><literal>disabled</literal></entry> | |
944 | <entry>Unit is not enabled</entry> | |
945 | <entry>1</entry> | |
946 | </row> | |
947 | </tbody> | |
948 | </tgroup> | |
949 | </table> | |
950 | ||
27722f96 LN |
951 | </listitem> |
952 | </varlistentry> | |
953 | ||
954 | <varlistentry> | |
955 | <term><command>reenable <replaceable>NAME</replaceable>...</command></term> | |
956 | ||
957 | <listitem> | |
958 | <para>Reenable one or more unit files, as specified on the | |
959 | command line. This is a combination of | |
960 | <command>disable</command> and <command>enable</command> and | |
961 | is useful to reset the symlinks a unit is enabled with to | |
962 | the defaults configured in the <literal>[Install]</literal> | |
963 | section of the unit file.</para> | |
964 | </listitem> | |
965 | </varlistentry> | |
966 | ||
967 | <varlistentry> | |
968 | <term><command>preset <replaceable>NAME</replaceable>...</command></term> | |
969 | ||
970 | <listitem> | |
971 | <para>Reset one or more unit files, as specified on the | |
972 | command line, to the defaults configured in the preset | |
973 | policy files. This has the same effect as | |
974 | <command>disable</command> or <command>enable</command>, | |
975 | depending how the unit is listed in the preset files. For | |
976 | more information on the preset policy format, see | |
977 | <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
978 | For more information on the concept of presets, please | |
979 | consult the | |
980 | <ulink url="http://freedesktop.org/wiki/Software/systemd/Preset">Preset</ulink> | |
981 | document.</para> | |
982 | </listitem> | |
983 | </varlistentry> | |
984 | ||
985 | <varlistentry> | |
986 | <term><command>mask <replaceable>NAME</replaceable>...</command></term> | |
987 | ||
988 | <listitem> | |
989 | <para>Mask one or more unit files, as specified on the | |
990 | command line. This will link these units to | |
991 | <filename>/dev/null</filename>, making it impossible to | |
992 | start them. This is a stronger version of | |
993 | <command>disable</command>, since it prohibits all kinds of | |
994 | activation of the unit, including manual activation. Use | |
1bee43de | 995 | this option with care. This honors the |
72f4d966 | 996 | <option>--runtime</option> option to only mask temporarily |
1bee43de | 997 | until the next reoobt of the system.</para> |
27722f96 LN |
998 | </listitem> |
999 | </varlistentry> | |
1000 | ||
1001 | <varlistentry> | |
1002 | <term><command>unmask <replaceable>NAME</replaceable>...</command></term> | |
1003 | ||
1004 | <listitem> | |
1005 | <para>Unmask one or more unit files, as specified on the | |
1006 | command line. This will undo the effect of | |
1007 | <command>mask</command>.</para> | |
1008 | </listitem> | |
1009 | </varlistentry> | |
1010 | ||
1011 | <varlistentry> | |
1012 | <term><command>link <replaceable>FILENAME</replaceable>...</command></term> | |
1013 | ||
1014 | <listitem> | |
1015 | <para>Link a unit file that is not in the unit file search | |
1016 | paths into the unit file search path. This requires an | |
1017 | absolute path to a unit file. The effect of this can be | |
1018 | undone with <command>disable</command>. The effect of this | |
1019 | command is that a unit file is available for | |
1020 | <command>start</command> and other commands although it | |
1021 | is not installed directly in the unit search path.</para> | |
1022 | </listitem> | |
1023 | </varlistentry> | |
1024 | ||
1025 | <varlistentry> | |
1026 | <term><command>get-default</command></term> | |
1027 | ||
1028 | <listitem> | |
1029 | <para>Get the default target specified | |
1030 | via <filename>default.target</filename> link.</para> | |
1031 | </listitem> | |
1032 | </varlistentry> | |
1033 | ||
1034 | <varlistentry> | |
1035 | <term><command>set-default <replaceable>NAME</replaceable></command></term> | |
1036 | ||
1037 | <listitem> | |
1038 | <para>Set the default target to boot into. Command links | |
1039 | <filename>default.target</filename> to the given unit.</para> | |
1040 | </listitem> | |
1041 | </varlistentry> | |
1042 | </variablelist> | |
1043 | </refsect2> | |
1044 | ||
0d292f5e LP |
1045 | <refsect2> |
1046 | <title>Machine Commands</title> | |
1047 | ||
1048 | <variablelist> | |
1049 | <varlistentry> | |
1050 | <term><command>list-machines <optional><replaceable>PATTERN</replaceable>...</optional></command></term> | |
1051 | ||
1052 | <listitem> | |
1053 | <para>List the host and all running local containers with | |
1054 | their state. If one or more | |
1055 | <replaceable>PATTERN</replaceable>s are specified, only | |
1056 | containers matching one of them are shown. | |
1057 | </para> | |
1058 | </listitem> | |
1059 | </varlistentry> | |
1060 | </variablelist> | |
1061 | </refsect2> | |
1062 | ||
27722f96 LN |
1063 | <refsect2> |
1064 | <title>Job Commands</title> | |
1065 | ||
1066 | <variablelist> | |
1067 | <varlistentry> | |
d8fba7c6 | 1068 | <term><command>list-jobs <optional><replaceable>PATTERN...</replaceable></optional></command></term> |
27722f96 LN |
1069 | |
1070 | <listitem> | |
d8fba7c6 ZJS |
1071 | <para>List jobs that are in progress. If one or more |
1072 | <replaceable>PATTERN</replaceable>s are specified, only | |
1073 | jobs for units matching one of them are shown.</para> | |
27722f96 LN |
1074 | </listitem> |
1075 | </varlistentry> | |
1076 | <varlistentry> | |
1077 | <term><command>cancel <replaceable>JOB</replaceable>...</command></term> | |
1078 | ||
1079 | <listitem> | |
1080 | <para>Cancel one or more jobs specified on the command line | |
1081 | by their numeric job IDs. If no job ID is specified, cancel | |
1082 | all pending jobs.</para> | |
1083 | </listitem> | |
1084 | </varlistentry> | |
1085 | </variablelist> | |
1086 | </refsect2> | |
1087 | ||
1088 | <refsect2> | |
1089 | <title>Snapshot Commands</title> | |
1090 | ||
1091 | <variablelist> | |
1092 | <varlistentry> | |
d8fba7c6 | 1093 | <term><command>snapshot <optional><replaceable>NAME</replaceable></optional></command></term> |
27722f96 LN |
1094 | |
1095 | <listitem> | |
1096 | <para>Create a snapshot. If a snapshot name is specified, | |
1097 | the new snapshot will be named after it. If none is | |
6db27428 ZJS |
1098 | specified, an automatic snapshot name is generated. In |
1099 | either case, the snapshot name used is printed to standard | |
1100 | output, unless <option>--quiet</option> is specified. | |
1101 | </para> | |
27722f96 LN |
1102 | |
1103 | <para>A snapshot refers to a saved state of the systemd | |
1104 | manager. It is implemented itself as a unit that is | |
1105 | generated dynamically with this command and has dependencies | |
1106 | on all units active at the time. At a later time, the user | |
1107 | may return to this state by using the | |
1108 | <command>isolate</command> command on the snapshot unit. | |
1109 | </para> | |
1110 | ||
1111 | <para>Snapshots are only useful for saving and restoring | |
1112 | which units are running or are stopped, they do not | |
1113 | save/restore any other state. Snapshots are dynamic and lost | |
1114 | on reboot.</para> | |
1115 | </listitem> | |
1116 | </varlistentry> | |
1117 | <varlistentry> | |
e3e0314b | 1118 | <term><command>delete <replaceable>PATTERN</replaceable>...</command></term> |
27722f96 LN |
1119 | |
1120 | <listitem> | |
1121 | <para>Remove a snapshot previously created with | |
1122 | <command>snapshot</command>.</para> | |
1123 | </listitem> | |
1124 | </varlistentry> | |
1125 | </variablelist> | |
1126 | </refsect2> | |
1127 | ||
1128 | <refsect2> | |
1129 | <title>Environment Commands</title> | |
1130 | ||
1131 | <variablelist> | |
1132 | <varlistentry> | |
1133 | <term><command>show-environment</command></term> | |
1134 | ||
1135 | <listitem> | |
1136 | <para>Dump the systemd manager environment block. The | |
1137 | environment block will be dumped in straight-forward form | |
1138 | suitable for sourcing into a shell script. This environment | |
1139 | block will be passed to all processes the manager | |
1140 | spawns.</para> | |
1141 | </listitem> | |
1142 | </varlistentry> | |
1143 | <varlistentry> | |
1144 | <term><command>set-environment <replaceable>VARIABLE=VALUE</replaceable>...</command></term> | |
1145 | ||
1146 | <listitem> | |
1147 | <para>Set one or more systemd manager environment variables, | |
1148 | as specified on the command line.</para> | |
1149 | </listitem> | |
1150 | </varlistentry> | |
1151 | <varlistentry> | |
1152 | <term><command>unset-environment <replaceable>VARIABLE</replaceable>...</command></term> | |
1153 | ||
1154 | <listitem> | |
1155 | <para>Unset one or more systemd manager environment | |
1156 | variables. If only a variable name is specified, it will be | |
1157 | removed regardless of its value. If a variable and a value | |
1158 | are specified, the variable is only removed if it has the | |
1159 | specified value.</para> | |
1160 | </listitem> | |
ac3efa8a LP |
1161 | </varlistentry> |
1162 | <varlistentry> | |
1163 | <term><command>import-environment <replaceable>VARIABLE</replaceable>...</command></term> | |
1164 | ||
1165 | <listitem> | |
1166 | <para>Import all, one or more environment variables set on | |
1167 | the client into the systemd manager environment block. If | |
73e231ab JE |
1168 | no arguments are passed, the entire environment block is |
1169 | imported. Otherwise, a list of one or more environment | |
1170 | variable names should be passed, whose client-side values | |
ac3efa8a LP |
1171 | are then imported into the manager's environment |
1172 | block.</para> | |
1173 | </listitem> | |
27722f96 LN |
1174 | </varlistentry> |
1175 | </variablelist> | |
1176 | </refsect2> | |
1177 | ||
1178 | <refsect2> | |
1179 | <title>Manager Lifecycle Commands</title> | |
1180 | ||
1181 | <variablelist> | |
1182 | <varlistentry> | |
1183 | <term><command>daemon-reload</command></term> | |
1184 | ||
1185 | <listitem> | |
1186 | <para>Reload systemd manager configuration. This will reload | |
1187 | all unit files and recreate the entire dependency | |
79640424 | 1188 | tree. While the daemon is being reloaded, all sockets systemd |
27722f96 LN |
1189 | listens on on behalf of user configuration will stay |
1190 | accessible.</para> <para>This command should not be confused | |
1191 | with the <command>load</command> or | |
1192 | <command>reload</command> commands.</para> | |
1193 | </listitem> | |
1194 | </varlistentry> | |
1195 | <varlistentry> | |
1196 | <term><command>daemon-reexec</command></term> | |
1197 | ||
1198 | <listitem> | |
1199 | <para>Reexecute the systemd manager. This will serialize the | |
1200 | manager state, reexecute the process and deserialize the | |
1201 | state again. This command is of little use except for | |
79640424 | 1202 | debugging and package upgrades. Sometimes, it might be |
27722f96 | 1203 | helpful as a heavy-weight <command>daemon-reload</command>. |
79640424 | 1204 | While the daemon is being reexecuted, all sockets systemd listening |
27722f96 LN |
1205 | on behalf of user configuration will stay accessible. |
1206 | </para> | |
1207 | </listitem> | |
1208 | </varlistentry> | |
1209 | </variablelist> | |
1210 | </refsect2> | |
1211 | ||
1212 | <refsect2> | |
1213 | <title>System Commands</title> | |
1214 | ||
1215 | <variablelist> | |
1216 | <varlistentry> | |
1217 | <term><command>default</command></term> | |
1218 | ||
1219 | <listitem> | |
1220 | <para>Enter default mode. This is mostly equivalent to | |
1221 | <command>isolate default.target</command>.</para> | |
1222 | </listitem> | |
1223 | </varlistentry> | |
1224 | <varlistentry> | |
1225 | <term><command>rescue</command></term> | |
1226 | ||
1227 | <listitem> | |
1228 | <para>Enter rescue mode. This is mostly equivalent to | |
1229 | <command>isolate rescue.target</command>, but also prints a | |
1230 | wall message to all users.</para> | |
1231 | </listitem> | |
1232 | </varlistentry> | |
1233 | <varlistentry> | |
1234 | <term><command>emergency</command></term> | |
1235 | ||
1236 | <listitem> | |
1237 | <para>Enter emergency mode. This is mostly equivalent to | |
1238 | <command>isolate emergency.target</command>, but also prints | |
1239 | a wall message to all users.</para> | |
1240 | </listitem> | |
1241 | </varlistentry> | |
1242 | <varlistentry> | |
1243 | <term><command>halt</command></term> | |
1244 | ||
1245 | <listitem> | |
1246 | <para>Shut down and halt the system. This is mostly equivalent to | |
1247 | <command>start halt.target --irreversible</command>, but also | |
1248 | prints a wall message to all users. If combined with | |
1249 | <option>--force</option>, shutdown of all running services is | |
1250 | skipped, however all processes are killed and all file | |
1251 | systems are unmounted or mounted read-only, immediately | |
1252 | followed by the system halt. If <option>--force</option> is | |
1253 | specified twice, the operation is immediately executed | |
1254 | without terminating any processes or unmounting any file | |
1255 | systems. This may result in data loss.</para> | |
1256 | </listitem> | |
1257 | </varlistentry> | |
1258 | <varlistentry> | |
1259 | <term><command>poweroff</command></term> | |
1260 | ||
1261 | <listitem> | |
1262 | <para>Shut down and power-off the system. This is mostly | |
1263 | equivalent to <command>start poweroff.target --irreversible</command>, | |
1264 | but also prints a wall message to all users. If combined with | |
1265 | <option>--force</option>, shutdown of all running services is | |
1266 | skipped, however all processes are killed and all file | |
1267 | systems are unmounted or mounted read-only, immediately | |
1268 | followed by the powering off. If <option>--force</option> is | |
1269 | specified twice, the operation is immediately executed | |
1270 | without terminating any processes or unmounting any file | |
1271 | systems. This may result in data loss.</para> | |
1272 | </listitem> | |
1273 | </varlistentry> | |
1274 | <varlistentry> | |
37185ec8 | 1275 | <term><command>reboot <optional><replaceable>arg</replaceable></optional></command></term> |
27722f96 LN |
1276 | |
1277 | <listitem> | |
1278 | <para>Shut down and reboot the system. This is mostly | |
1279 | equivalent to <command>start reboot.target --irreversible</command>, | |
1280 | but also prints a wall message to all users. If combined with | |
1281 | <option>--force</option>, shutdown of all running services is | |
1282 | skipped, however all processes are killed and all file | |
1283 | systems are unmounted or mounted read-only, immediately | |
1284 | followed by the reboot. If <option>--force</option> is | |
1285 | specified twice, the operation is immediately executed | |
1286 | without terminating any processes or unmounting any file | |
1287 | systems. This may result in data loss.</para> | |
37185ec8 WC |
1288 | |
1289 | <para>If the optional argument | |
1290 | <replaceable>arg</replaceable> is given, it will be passed | |
1291 | as the optional argument to the | |
1292 | <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry> | |
1293 | system call. The value is architecture and firmware | |
1294 | specific. As an example, <literal>recovery</literal> might | |
1295 | be used to trigger system recovery, and | |
1296 | <literal>fota</literal> might be used to trigger a | |
1297 | <quote>firmware over the air</quote> update.</para> | |
27722f96 LN |
1298 | </listitem> |
1299 | </varlistentry> | |
1300 | <varlistentry> | |
1301 | <term><command>kexec</command></term> | |
1302 | ||
1303 | <listitem> | |
1304 | <para>Shut down and reboot the system via kexec. This is | |
1305 | mostly equivalent to <command>start kexec.target --irreversible</command>, | |
1306 | but also prints a wall message to all users. If combined | |
1307 | with <option>--force</option>, shutdown of all running | |
1308 | services is skipped, however all processes are killed and | |
1309 | all file systems are unmounted or mounted read-only, | |
1310 | immediately followed by the reboot.</para> | |
1311 | </listitem> | |
1312 | </varlistentry> | |
1313 | <varlistentry> | |
1314 | <term><command>exit</command></term> | |
1315 | ||
1316 | <listitem> | |
1317 | <para>Ask the systemd manager to quit. This is only | |
1318 | supported for user service managers (i.e. in conjunction | |
1319 | with the <option>--user</option> option) and will fail | |
1320 | otherwise.</para> | |
1321 | </listitem> | |
1322 | ||
1323 | </varlistentry> | |
1324 | <varlistentry> | |
1325 | <term><command>suspend</command></term> | |
1326 | ||
1327 | <listitem> | |
1328 | <para>Suspend the system. This will trigger activation of | |
1329 | the special <filename>suspend.target</filename> target. | |
1330 | </para> | |
1331 | </listitem> | |
1332 | </varlistentry> | |
1333 | <varlistentry> | |
1334 | <term><command>hibernate</command></term> | |
1335 | ||
1336 | <listitem> | |
1337 | <para>Hibernate the system. This will trigger activation of | |
1338 | the special <filename>hibernate.target</filename> target. | |
1339 | </para> | |
1340 | </listitem> | |
1341 | </varlistentry> | |
1342 | <varlistentry> | |
1343 | <term><command>hybrid-sleep</command></term> | |
1344 | ||
1345 | <listitem> | |
1346 | <para>Hibernate and suspend the system. This will trigger | |
1347 | activation of the special | |
1348 | <filename>hybrid-sleep.target</filename> target.</para> | |
1349 | </listitem> | |
1350 | </varlistentry> | |
1351 | <varlistentry> | |
d8fba7c6 | 1352 | <term><command>switch-root <replaceable>ROOT</replaceable> <optional><replaceable>INIT</replaceable></optional></command></term> |
27722f96 LN |
1353 | |
1354 | <listitem> | |
1355 | <para>Switches to a different root directory and executes a | |
1356 | new system manager process below it. This is intended for | |
1357 | usage in initial RAM disks ("initrd"), and will transition | |
1358 | from the initrd's system manager process (a.k.a "init" | |
1359 | process) to the main system manager process. This call takes two | |
1360 | arguments: the directory that is to become the new root directory, and | |
1361 | the path to the new system manager binary below it to | |
1362 | execute as PID 1. If the latter is omitted or the empty | |
1363 | string, a systemd binary will automatically be searched for | |
1364 | and used as init. If the system manager path is omitted or | |
1365 | equal to the empty string, the state of the initrd's system | |
1366 | manager process is passed to the main system manager, which | |
1367 | allows later introspection of the state of the services | |
1368 | involved in the initrd boot.</para> | |
1369 | </listitem> | |
1370 | </varlistentry> | |
1371 | </variablelist> | |
1372 | </refsect2> | |
4a6022f0 | 1373 | |
a7c0e5d7 LP |
1374 | <refsect2> |
1375 | <title>Parameter Syntax</title> | |
1376 | ||
e3e0314b ZJS |
1377 | <para>Unit ommands listed above take either a single unit name |
1378 | (designated as <replaceable>NAME</replaceable>), or multiple | |
1379 | unit specifications (designated as | |
1380 | <replaceable>PATTERN</replaceable>...). In the first case, the | |
1381 | unit name with or without a suffix must be given. If the suffix | |
1382 | is not specified, systemctl will append a suitable suffix, | |
1383 | <literal>.service</literal> by default, and a type-specific | |
1384 | suffix in case of commands which operate only on specific unit | |
1385 | types. For example, | |
1386 | <programlisting># systemctl start sshd</programlisting> and | |
1387 | <programlisting># systemctl start sshd.service</programlisting> | |
1388 | are equivalent, as are | |
1389 | <programlisting># systemctl isolate snapshot-11</programlisting> | |
1390 | and | |
1391 | <programlisting># systemctl isolate snapshot-11.snapshot</programlisting> | |
1392 | Note that (absolute) paths to device nodes are automatically | |
1393 | converted to device unit names, and other (absolute) paths to | |
1394 | mount unit names. | |
1395 | <programlisting># systemctl status /dev/sda | |
1396 | # systemctl status /home</programlisting> | |
1397 | are equivalent to: | |
1398 | <programlisting># systemctl status dev-sda.device | |
1399 | # systemctl status home.mount</programlisting> | |
1400 | In the second case, shell-style globs will be matched against | |
73e231ab | 1401 | currently loaded units; literal unit names, with or without |
e3e0314b ZJS |
1402 | a suffix, will be treated as in the first case. This means that |
1403 | literal unit names always refer to exactly one unit, but globs | |
1404 | may match zero units and this is not considered an error.</para> | |
1405 | ||
1406 | <para>Glob patterns use | |
1407 | <citerefentry><refentrytitle>fnmatch</refentrytitle><manvolnum>3</manvolnum></citerefentry>, | |
1408 | so normal shell-style globbing rules are used, and | |
1409 | <literal>*</literal>, <literal>?</literal>, | |
1410 | <literal>[]</literal> may be used. See | |
1411 | <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry> | |
1412 | for more details. The patterns are matched against the names of | |
66f756d4 | 1413 | currently loaded units, and patterns which do not match anything |
e3e0314b ZJS |
1414 | are silently skipped. For example: |
1415 | <programlisting># systemctl stop sshd@*.service</programlisting> | |
1416 | will stop all <filename>sshd@.service</filename> instances. | |
1417 | </para> | |
1418 | ||
1419 | <para>For unit file commands, the specified | |
1420 | <replaceable>NAME</replaceable> should be the full name of the | |
1421 | unit file, or the absolute path to the unit file: | |
1422 | <programlisting># systemctl enable foo.service</programlisting> | |
1423 | or | |
1424 | <programlisting># systemctl link /path/to/foo.service</programlisting> | |
1425 | </para> | |
a7c0e5d7 LP |
1426 | </refsect2> |
1427 | ||
4a6022f0 ZJS |
1428 | </refsect1> |
1429 | ||
1430 | <refsect1> | |
1431 | <title>Exit status</title> | |
1432 | ||
7b870f60 | 1433 | <para>On success, 0 is returned, a non-zero failure |
4a6022f0 ZJS |
1434 | code otherwise.</para> |
1435 | </refsect1> | |
1436 | ||
21ac6ff1 | 1437 | <xi:include href="less-variables.xml" /> |
4a6022f0 ZJS |
1438 | |
1439 | <refsect1> | |
1440 | <title>See Also</title> | |
1441 | <para> | |
1442 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
1443 | <citerefentry><refentrytitle>systemadm</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
1444 | <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
1445 | <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
1446 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
3fde5f30 | 1447 | <citerefentry><refentrytitle>systemd.resource-management</refentrytitle><manvolnum>5</manvolnum></citerefentry>, |
4a6022f0 ZJS |
1448 | <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>, |
1449 | <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
1450 | <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
e3e0314b | 1451 | <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry> |
4a6022f0 ZJS |
1452 | </para> |
1453 | </refsect1> | |
7874bcd6 LP |
1454 | |
1455 | </refentry> |