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