]> git.ipfire.org Git - thirdparty/systemd.git/blob - man/systemctl.xml
hibernate-resume: add resumeflags= kernel option
[thirdparty/systemd.git] / man / systemctl.xml
1 <?xml version='1.0'?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
4 <!ENTITY % entities SYSTEM "custom-entities.ent" >
5 %entities;
6 ]>
7 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
8
9 <refentry id="systemctl"
10 xmlns:xi="http://www.w3.org/2001/XInclude">
11
12 <refentryinfo>
13 <title>systemctl</title>
14 <productname>systemd</productname>
15 </refentryinfo>
16
17 <refmeta>
18 <refentrytitle>systemctl</refentrytitle>
19 <manvolnum>1</manvolnum>
20 </refmeta>
21
22 <refnamediv>
23 <refname>systemctl</refname>
24 <refpurpose>Control the systemd system and service manager</refpurpose>
25 </refnamediv>
26
27 <refsynopsisdiv>
28 <cmdsynopsis>
29 <command>systemctl</command>
30 <arg choice="opt" rep="repeat">OPTIONS</arg>
31 <arg choice="plain">COMMAND</arg>
32 <arg choice="opt" rep="repeat">UNIT</arg>
33 </cmdsynopsis>
34 </refsynopsisdiv>
35
36 <refsect1>
37 <title>Description</title>
38
39 <para><command>systemctl</command> may be used to introspect and
40 control the state of the <literal>systemd</literal> system and
41 service manager. Please refer to
42 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
43 for an introduction into the basic concepts and functionality this
44 tool manages.</para>
45 </refsect1>
46
47 <refsect1>
48 <title>Options</title>
49
50 <para>The following options are understood:</para>
51
52 <variablelist>
53 <varlistentry>
54 <term><option>-t</option></term>
55 <term><option>--type=</option></term>
56
57 <listitem>
58 <para>The argument should be a comma-separated list of unit
59 types such as <option>service</option> and
60 <option>socket</option>.
61 </para>
62
63 <para>If one of the arguments is a unit type, when listing
64 units, limit display to certain unit types. Otherwise, units
65 of all types will be shown.</para>
66
67 <para>As a special case, if one of the arguments is
68 <option>help</option>, a list of allowed values will be
69 printed and the program will exit.</para>
70 </listitem>
71 </varlistentry>
72
73 <varlistentry>
74 <term><option>--state=</option></term>
75
76 <listitem>
77 <para>The argument should be a comma-separated list of unit
78 LOAD, SUB, or ACTIVE states. When listing units, show only
79 those in the specified states. Use <option>--state=failed</option>
80 to show only failed units.</para>
81
82 <para>As a special case, if one of the arguments is
83 <option>help</option>, a list of allowed values will be
84 printed and the program will exit.</para>
85 </listitem>
86 </varlistentry>
87
88 <varlistentry>
89 <term><option>-p</option></term>
90 <term><option>--property=</option></term>
91
92 <listitem>
93 <para>When showing unit/job/manager properties with the
94 <command>show</command> command, limit display to properties
95 specified in the argument. The argument should be a
96 comma-separated list of property names, such as
97 <literal>MainPID</literal>. Unless specified, all known
98 properties are shown. If specified more than once, all
99 properties with the specified names are shown. Shell
100 completion is implemented for property names.</para>
101
102 <para>For the manager itself,
103 <command>systemctl show</command> will show all available
104 properties. Those properties are documented in
105 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
106 </para>
107
108 <para>Properties for units vary by unit type, so showing any
109 unit (even a non-existent one) is a way to list properties
110 pertaining to this type. Similarly, showing any job will list
111 properties pertaining to all jobs. Properties for units are
112 documented in
113 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
114 and the pages for individual unit types
115 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
116 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
117 etc.</para>
118 </listitem>
119 </varlistentry>
120
121 <varlistentry>
122 <term><option>-a</option></term>
123 <term><option>--all</option></term>
124
125 <listitem>
126 <para>When listing units with <command>list-units</command>, also show inactive units and
127 units which are following other units. When showing unit/job/manager properties, show all
128 properties regardless whether they are set or not.</para>
129
130 <para>To list all units installed in the file system, use the
131 <command>list-unit-files</command> command instead.</para>
132
133 <para>When listing units with <command>list-dependencies</command>, recursively show
134 dependencies of all dependent units (by default only dependencies of target units are
135 shown).</para>
136
137 <para>When used with <command>status</command>, show journal messages in full, even if they include
138 unprintable characters or are very long. By default, fields with unprintable characters are
139 abbreviated as "blob data". (Note that the pager may escape unprintable characters again.)</para>
140 </listitem>
141 </varlistentry>
142
143 <varlistentry>
144 <term><option>-r</option></term>
145 <term><option>--recursive</option></term>
146
147 <listitem>
148 <para>When listing units, also show units of local
149 containers. Units of local containers will be prefixed with
150 the container name, separated by a single colon character
151 (<literal>:</literal>).</para>
152 </listitem>
153 </varlistentry>
154
155 <varlistentry>
156 <term><option>--reverse</option></term>
157
158 <listitem>
159 <para>Show reverse dependencies between units with
160 <command>list-dependencies</command>, i.e. follow
161 dependencies of type <varname>WantedBy=</varname>,
162 <varname>RequiredBy=</varname>,
163 <varname>PartOf=</varname>, <varname>BoundBy=</varname>,
164 instead of <varname>Wants=</varname> and similar.
165 </para>
166 </listitem>
167 </varlistentry>
168
169 <varlistentry>
170 <term><option>--after</option></term>
171
172 <listitem>
173 <para>With <command>list-dependencies</command>, show the
174 units that are ordered before the specified unit. In other
175 words, recursively list units following the
176 <varname>After=</varname> dependency.</para>
177
178 <para>Note that any <varname>After=</varname> dependency is
179 automatically mirrored to create a
180 <varname>Before=</varname> dependency. Temporal dependencies
181 may be specified explicitly, but are also created implicitly
182 for units which are <varname>WantedBy=</varname> targets
183 (see
184 <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>),
185 and as a result of other directives (for example
186 <varname>RequiresMountsFor=</varname>). Both explicitly
187 and implicitly introduced dependencies are shown with
188 <command>list-dependencies</command>.</para>
189
190 <para>When passed to the <command>list-jobs</command> command, for each printed job show which other jobs are
191 waiting for it. May be combined with <option>--before</option> to show both the jobs waiting for each job as
192 well as all jobs each job is waiting for.</para>
193 </listitem>
194 </varlistentry>
195
196 <varlistentry>
197 <term><option>--before</option></term>
198
199 <listitem>
200 <para>With <command>list-dependencies</command>, show the
201 units that are ordered after the specified unit. In other
202 words, recursively list units following the
203 <varname>Before=</varname> dependency.</para>
204
205 <para>When passed to the <command>list-jobs</command> command, for each printed job show which other jobs it
206 is waiting for. May be combined with <option>--after</option> to show both the jobs waiting for each job as
207 well as all jobs each job is waiting for.</para>
208 </listitem>
209 </varlistentry>
210
211 <varlistentry>
212 <term><option>-l</option></term>
213 <term><option>--full</option></term>
214
215 <listitem>
216 <para>Do not ellipsize unit names, process tree entries,
217 journal output, or truncate unit descriptions in the output
218 of <command>status</command>, <command>list-units</command>,
219 <command>list-jobs</command>, and
220 <command>list-timers</command>.</para>
221 <para>Also, show installation targets in the output of
222 <command>is-enabled</command>.</para>
223 </listitem>
224 </varlistentry>
225
226 <varlistentry>
227 <term><option>--value</option></term>
228
229 <listitem>
230 <para>When printing properties with <command>show</command>,
231 only print the value, and skip the property name and
232 <literal>=</literal>.</para>
233 </listitem>
234 </varlistentry>
235
236 <varlistentry>
237 <term><option>--show-types</option></term>
238
239 <listitem>
240 <para>When showing sockets, show the type of the socket.</para>
241 </listitem>
242 </varlistentry>
243
244 <varlistentry>
245 <term><option>--job-mode=</option></term>
246
247 <listitem>
248 <para>When queuing a new job, this option controls how to deal with
249 already queued jobs. It takes one of <literal>fail</literal>,
250 <literal>replace</literal>,
251 <literal>replace-irreversibly</literal>,
252 <literal>isolate</literal>,
253 <literal>ignore-dependencies</literal>,
254 <literal>ignore-requirements</literal> or
255 <literal>flush</literal>. Defaults to
256 <literal>replace</literal>, except when the
257 <command>isolate</command> command is used which implies the
258 <literal>isolate</literal> job mode.</para>
259
260 <para>If <literal>fail</literal> is specified and a requested
261 operation conflicts with a pending job (more specifically:
262 causes an already pending start job to be reversed into a stop
263 job or vice versa), cause the operation to fail.</para>
264
265 <para>If <literal>replace</literal> (the default) is
266 specified, any conflicting pending job will be replaced, as
267 necessary.</para>
268
269 <para>If <literal>replace-irreversibly</literal> is specified,
270 operate like <literal>replace</literal>, but also mark the new
271 jobs as irreversible. This prevents future conflicting
272 transactions from replacing these jobs (or even being enqueued
273 while the irreversible jobs are still pending). Irreversible
274 jobs can still be cancelled using the <command>cancel</command>
275 command. This job mode should be used on any transaction which
276 pulls in <filename>shutdown.target</filename>.</para>
277
278 <para><literal>isolate</literal> is only valid for start
279 operations and causes all other units to be stopped when the
280 specified unit is started. This mode is always used when the
281 <command>isolate</command> command is used.</para>
282
283 <para><literal>flush</literal> will cause all queued jobs to
284 be canceled when the new job is enqueued.</para>
285
286 <para>If <literal>ignore-dependencies</literal> is specified,
287 then all unit dependencies are ignored for this new job and
288 the operation is executed immediately. If passed, no required
289 units of the unit passed will be pulled in, and no ordering
290 dependencies will be honored. This is mostly a debugging and
291 rescue tool for the administrator and should not be used by
292 applications.</para>
293
294 <para><literal>ignore-requirements</literal> is similar to
295 <literal>ignore-dependencies</literal>, but only causes the
296 requirement dependencies to be ignored, the ordering
297 dependencies will still be honored.</para>
298 </listitem>
299
300 </varlistentry>
301
302 <varlistentry>
303 <term><option>-T</option></term>
304 <term><option>--show-transaction</option></term>
305
306 <listitem>
307 <para>When enqueuing a unit job (for example as effect of a <command>systemctl start</command>
308 invocation or similar), show brief information about all jobs enqueued, covering both the requested
309 job and any added because of unit dependencies. Note that the output will only include jobs
310 immediately part of the transaction requested. It is possible that service start-up program code
311 run as effect of the enqueued jobs might request further jobs to be pulled in. This means that
312 completion of the listed jobs might ultimately entail more jobs than the listed ones.</para>
313 </listitem>
314 </varlistentry>
315
316 <varlistentry>
317 <term><option>--fail</option></term>
318
319 <listitem>
320 <para>Shorthand for <option>--job-mode=</option>fail.</para>
321 <para>When used with the <command>kill</command> command,
322 if no units were killed, the operation results in an error.
323 </para>
324 </listitem>
325 </varlistentry>
326
327 <varlistentry>
328 <term><option>-i</option></term>
329 <term><option>--ignore-inhibitors</option></term>
330
331 <listitem>
332 <para>When system shutdown or a sleep state is requested, ignore inhibitor locks. Applications can establish
333 inhibitor locks to avoid that certain important operations (such as CD burning or suchlike) are interrupted
334 by system shutdown or a sleep state. Any user may take these locks and privileged users may override these
335 locks. If any locks are taken, shutdown and sleep state requests will normally fail (unless privileged) and a
336 list of active locks is printed. However, if <option>--ignore-inhibitors</option> is specified, the
337 established locks are ignored and not shown, and the operation attempted anyway, possibly requiring
338 additional privileges.</para>
339 </listitem>
340 </varlistentry>
341
342 <varlistentry>
343 <term><option>--dry-run</option></term>
344
345 <listitem>
346 <para>Just print what would be done. Currently supported by verbs
347 <command>halt</command>, <command>poweroff</command>, <command>reboot</command>,
348 <command>kexec</command>, <command>suspend</command>, <command>hibernate</command>,
349 <command>hybrid-sleep</command>, <command>suspend-then-hibernate</command>,
350 <command>default</command>, <command>rescue</command>,
351 <command>emergency</command>, and <command>exit</command>.</para>
352 </listitem>
353 </varlistentry>
354
355 <varlistentry>
356 <term><option>-q</option></term>
357 <term><option>--quiet</option></term>
358
359 <listitem>
360 <para>Suppress printing of the results of various commands
361 and also the hints about truncated log lines. This does not
362 suppress output of commands for which the printed output is
363 the only result (like <command>show</command>). Errors are
364 always printed.</para>
365 </listitem>
366 </varlistentry>
367
368 <varlistentry>
369 <term><option>--no-block</option></term>
370
371 <listitem>
372 <para>Do not synchronously wait for the requested operation
373 to finish. If this is not specified, the job will be
374 verified, enqueued and <command>systemctl</command> will
375 wait until the unit's start-up is completed. By passing this
376 argument, it is only verified and enqueued. This option may not be
377 combined with <option>--wait</option>.</para>
378 </listitem>
379 </varlistentry>
380
381 <varlistentry>
382 <term><option>--wait</option></term>
383
384 <listitem>
385 <para>Synchronously wait for started units to terminate again.
386 This option may not be combined with <option>--no-block</option>.
387 Note that this will wait forever if any given unit never terminates
388 (by itself or by getting stopped explicitly); particularly services
389 which use <literal>RemainAfterExit=yes</literal>.</para>
390
391 <para>When used with <command>is-system-running</command>, wait
392 until the boot process is completed before returning.</para>
393 </listitem>
394 </varlistentry>
395
396 <xi:include href="user-system-options.xml" xpointer="user" />
397 <xi:include href="user-system-options.xml" xpointer="system" />
398
399 <varlistentry>
400 <term><option>--failed</option></term>
401
402 <listitem>
403 <para>List units in failed state. This is equivalent to
404 <option>--state=failed</option>.</para>
405 </listitem>
406 </varlistentry>
407
408 <varlistentry>
409 <term><option>--no-wall</option></term>
410
411 <listitem>
412 <para>Do not send wall message before halt, power-off and reboot.</para>
413 </listitem>
414 </varlistentry>
415
416 <varlistentry>
417 <term><option>--global</option></term>
418
419 <listitem>
420 <para>When used with <command>enable</command> and
421 <command>disable</command>, operate on the global user
422 configuration directory, thus enabling or disabling a unit
423 file globally for all future logins of all users.</para>
424 </listitem>
425 </varlistentry>
426
427 <varlistentry>
428 <term><option>--no-reload</option></term>
429
430 <listitem>
431 <para>When used with <command>enable</command> and
432 <command>disable</command>, do not implicitly reload daemon
433 configuration after executing the changes.</para>
434 </listitem>
435 </varlistentry>
436
437 <varlistentry>
438 <term><option>--no-ask-password</option></term>
439
440 <listitem>
441 <para>When used with <command>start</command> and related
442 commands, disables asking for passwords. Background services
443 may require input of a password or passphrase string, for
444 example to unlock system hard disks or cryptographic
445 certificates. Unless this option is specified and the
446 command is invoked from a terminal,
447 <command>systemctl</command> will query the user on the
448 terminal for the necessary secrets. Use this option to
449 switch this behavior off. In this case, the password must be
450 supplied by some other means (for example graphical password
451 agents) or the service might fail. This also disables
452 querying the user for authentication for privileged
453 operations.</para>
454 </listitem>
455 </varlistentry>
456
457 <varlistentry>
458 <term><option>--kill-who=</option></term>
459
460 <listitem>
461 <para>When used with <command>kill</command>, choose which
462 processes to send a signal to. Must be one of
463 <option>main</option>, <option>control</option> or
464 <option>all</option> to select whether to kill only the main
465 process, the control process or all processes of the
466 unit. The main process of the unit is the one that defines
467 the life-time of it. A control process of a unit is one that
468 is invoked by the manager to induce state changes of it. For
469 example, all processes started due to the
470 <varname>ExecStartPre=</varname>,
471 <varname>ExecStop=</varname> or
472 <varname>ExecReload=</varname> settings of service units are
473 control processes. Note that there is only one control
474 process per unit at a time, as only one state change is
475 executed at a time. For services of type
476 <varname>Type=forking</varname>, the initial process started
477 by the manager for <varname>ExecStart=</varname> is a
478 control process, while the process ultimately forked off by
479 that one is then considered the main process of the unit (if
480 it can be determined). This is different for service units
481 of other types, where the process forked off by the manager
482 for <varname>ExecStart=</varname> is always the main process
483 itself. A service unit consists of zero or one main process,
484 zero or one control process plus any number of additional
485 processes. Not all unit types manage processes of these
486 types however. For example, for mount units, control processes
487 are defined (which are the invocations of
488 <filename>&MOUNT_PATH;</filename> and
489 <filename>&UMOUNT_PATH;</filename>), but no main process
490 is defined. If omitted, defaults to
491 <option>all</option>.</para>
492 </listitem>
493
494 </varlistentry>
495
496 <varlistentry>
497 <term><option>-s</option></term>
498 <term><option>--signal=</option></term>
499
500 <listitem>
501 <para>When used with <command>kill</command>, choose which
502 signal to send to selected processes. Must be one of the
503 well-known signal specifiers such as <constant>SIGTERM</constant>, <constant>SIGINT</constant> or
504 <constant>SIGSTOP</constant>. If omitted, defaults to
505 <option>SIGTERM</option>.</para>
506 </listitem>
507 </varlistentry>
508
509 <varlistentry>
510 <term><option>-f</option></term>
511 <term><option>--force</option></term>
512
513 <listitem>
514 <para>When used with <command>enable</command>, overwrite
515 any existing conflicting symlinks.</para>
516
517 <para>When used with <command>edit</command>, create all of the
518 specified units which do not already exist.</para>
519
520 <para>When used with <command>halt</command>, <command>poweroff</command>, <command>reboot</command> or
521 <command>kexec</command>, execute the selected operation without shutting down all units. However, all
522 processes will be killed forcibly and all file systems are unmounted or remounted read-only. This is hence a
523 drastic but relatively safe option to request an immediate reboot. If <option>--force</option> is specified
524 twice for these operations (with the exception of <command>kexec</command>), they will be executed
525 immediately, without terminating any processes or unmounting any file systems. Warning: specifying
526 <option>--force</option> twice with any of these operations might result in data loss. Note that when
527 <option>--force</option> is specified twice the selected operation is executed by
528 <command>systemctl</command> itself, and the system manager is not contacted. This means the command should
529 succeed even when the system manager has crashed.</para>
530 </listitem>
531 </varlistentry>
532
533 <varlistentry>
534 <term><option>--message=</option></term>
535
536 <listitem>
537 <para>When used with <command>halt</command>, <command>poweroff</command> or <command>reboot</command>, set a
538 short message explaining the reason for the operation. The message will be logged together with the default
539 shutdown message.</para>
540 </listitem>
541 </varlistentry>
542
543 <varlistentry>
544 <term><option>--now</option></term>
545
546 <listitem>
547 <para>When used with <command>enable</command>, the units
548 will also be started. When used with <command>disable</command> or
549 <command>mask</command>, the units will also be stopped. The start
550 or stop operation is only carried out when the respective enable or
551 disable operation has been successful.</para>
552 </listitem>
553 </varlistentry>
554
555 <varlistentry>
556 <term><option>--root=</option></term>
557
558 <listitem>
559 <para>When used with
560 <command>enable</command>/<command>disable</command>/<command>is-enabled</command>
561 (and related commands), use the specified root path when looking for unit
562 files. If this option is present, <command>systemctl</command> will operate on
563 the file system directly, instead of communicating with the <command>systemd</command>
564 daemon to carry out changes.</para>
565 </listitem>
566
567 </varlistentry>
568
569 <varlistentry>
570 <term><option>--runtime</option></term>
571
572 <listitem>
573 <para>When used with <command>enable</command>,
574 <command>disable</command>, <command>edit</command>,
575 (and related commands), make changes only temporarily, so
576 that they are lost on the next reboot. This will have the
577 effect that changes are not made in subdirectories of
578 <filename>/etc</filename> but in <filename>/run</filename>,
579 with identical immediate effects, however, since the latter
580 is lost on reboot, the changes are lost too.</para>
581
582 <para>Similarly, when used with
583 <command>set-property</command>, make changes only
584 temporarily, so that they are lost on the next
585 reboot.</para>
586 </listitem>
587 </varlistentry>
588
589 <varlistentry>
590 <term><option>--preset-mode=</option></term>
591
592 <listitem>
593 <para>Takes one of <literal>full</literal> (the default),
594 <literal>enable-only</literal>,
595 <literal>disable-only</literal>. When used with the
596 <command>preset</command> or <command>preset-all</command>
597 commands, controls whether units shall be disabled and
598 enabled according to the preset rules, or only enabled, or
599 only disabled.</para>
600 </listitem>
601 </varlistentry>
602
603 <varlistentry>
604 <term><option>-n</option></term>
605 <term><option>--lines=</option></term>
606
607 <listitem>
608 <para>When used with <command>status</command>, controls the number of journal lines to show, counting from
609 the most recent ones. Takes a positive integer argument, or 0 to disable journal output. Defaults to
610 10.</para>
611 </listitem>
612 </varlistentry>
613
614 <varlistentry>
615 <term><option>-o</option></term>
616 <term><option>--output=</option></term>
617
618 <listitem>
619 <para>When used with <command>status</command>, controls the
620 formatting of the journal entries that are shown. For the
621 available choices, see
622 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
623 Defaults to <literal>short</literal>.</para>
624 </listitem>
625 </varlistentry>
626
627 <varlistentry>
628 <term><option>--firmware-setup</option></term>
629
630 <listitem>
631 <para>When used with the <command>reboot</command> command, indicate to the system's firmware to reboot into
632 the firmware setup interface. Note that this functionality is not available on all systems.</para>
633 </listitem>
634 </varlistentry>
635
636 <varlistentry>
637 <term><option>--boot-loader-menu=</option></term>
638
639 <listitem>
640 <para>When used with the <command>reboot</command> command, indicate to the system's boot loader to show the
641 boot loader menu on the following boot. Takes a time value as parameter — indicating the menu time-out. Pass
642 zero in order to disable the menu time-out. Note that not all boot loaders support this
643 functionality.</para>
644 </listitem>
645 </varlistentry>
646
647 <varlistentry>
648 <term><option>--boot-loader-entry=</option></term>
649
650 <listitem>
651 <para>When used with the <command>reboot</command> command, indicate to the system's boot loader to boot into
652 a specific boot loader entry on the following boot. Takes a boot loader entry identifier as argument, or
653 <literal>help</literal> in order to list available entries. Note that not all boot loaders support this
654 functionality.</para>
655 </listitem>
656 </varlistentry>
657
658 <varlistentry>
659 <term><option>--plain</option></term>
660
661 <listitem>
662 <para>When used with <command>list-dependencies</command>,
663 <command>list-units</command> or <command>list-machines</command>,
664 the output is printed as a list instead of a tree, and the bullet
665 circles are omitted.</para>
666 </listitem>
667 </varlistentry>
668
669 <xi:include href="user-system-options.xml" xpointer="host" />
670 <xi:include href="user-system-options.xml" xpointer="machine" />
671
672 <xi:include href="standard-options.xml" xpointer="no-pager" />
673 <xi:include href="standard-options.xml" xpointer="no-legend" />
674 <xi:include href="standard-options.xml" xpointer="help" />
675 <xi:include href="standard-options.xml" xpointer="version" />
676 </variablelist>
677 </refsect1>
678
679 <refsect1>
680 <title>Commands</title>
681
682 <para>The following commands are understood:</para>
683
684 <refsect2>
685 <title>Unit Commands</title>
686
687 <variablelist>
688 <varlistentry>
689 <term><command>list-units</command> <optional><replaceable>PATTERN</replaceable>…</optional></term>
690
691 <listitem>
692 <para>List units that <command>systemd</command> currently has in memory. This includes units that are
693 either referenced directly or through a dependency, units that are pinned by applications programmatically,
694 or units that were active in the past and have failed. By default only units which are active, have pending
695 jobs, or have failed are shown; this can be changed with option <option>--all</option>. If one or more
696 <replaceable>PATTERN</replaceable>s are specified, only units matching one of them are shown. The units
697 that are shown are additionally filtered by <option>--type=</option> and <option>--state=</option> if those
698 options are specified.</para>
699
700 <para>Produces output similar to
701 <programlisting> UNIT LOAD ACTIVE SUB DESCRIPTION
702 sys-module-fuse.device loaded active plugged /sys/module/fuse
703 -.mount loaded active mounted Root Mount
704 boot-efi.mount loaded active mounted /boot/efi
705 systemd-journald.service loaded active running Journal Service
706 systemd-logind.service loaded active running Login Service
707 â—Ź user@1000.service loaded failed failed User Manager for UID 1000
708 …
709 systemd-tmpfiles-clean.timer loaded active waiting Daily Cleanup of Temporary Directories
710
711 LOAD = Reflects whether the unit definition was properly loaded.
712 ACTIVE = The high-level unit activation state, i.e. generalization of SUB.
713 SUB = The low-level unit activation state, values depend on unit type.
714
715 123 loaded units listed. Pass --all to see loaded but inactive units, too.
716 To show all installed unit files use 'systemctl list-unit-files'.
717 </programlisting>
718 The header and the last unit of a given type are underlined if the
719 terminal supports that. A colored dot is shown next to services which
720 were masked, not found, or otherwise failed.</para>
721
722 <para>The LOAD column shows the load state, one of <constant>loaded</constant>,
723 <constant>not-found</constant>, <constant>bad-setting</constant>, <constant>error</constant>,
724 <constant>masked</constant>. The ACTIVE columns shows the general unit state, one of
725 <constant>active</constant>, <constant>reloading</constant>, <constant>inactive</constant>,
726 <constant>failed</constant>, <constant>activating</constant>, <constant>deactivating</constant>. The SUB
727 column shows the unit-type-specific detailed state of the unit, possible values vary by unit type. The list
728 of possible LOAD, ACTIVE, and SUB states is not constant and new systemd releases may both add and remove
729 values. <programlisting>systemctl --state=help</programlisting> command maybe be used to display the
730 current set of possible values.</para>
731
732 <para>This is the default command.</para>
733 </listitem>
734 </varlistentry>
735
736 <varlistentry>
737 <term><command>list-sockets</command> <optional><replaceable>PATTERN</replaceable>…</optional></term>
738
739 <listitem>
740 <para>List socket units currently in memory, ordered by listening address. If one or more
741 <replaceable>PATTERN</replaceable>s are specified, only socket units matching one of them are
742 shown. Produces output similar to
743 <programlisting>
744 LISTEN UNIT ACTIVATES
745 /dev/initctl systemd-initctl.socket systemd-initctl.service
746 …
747 [::]:22 sshd.socket sshd.service
748 kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
749
750 5 sockets listed.</programlisting>
751 Note: because the addresses might contains spaces, this output
752 is not suitable for programmatic consumption.
753 </para>
754
755 <para>Also see <option>--show-types</option>, <option>--all</option>, and <option>--state=</option>.</para>
756 </listitem>
757 </varlistentry>
758
759 <varlistentry>
760 <term><command>list-timers</command> <optional><replaceable>PATTERN</replaceable>…</optional></term>
761
762 <listitem>
763 <para>List timer units currently in memory, ordered by the time they elapse next. If one or more
764 <replaceable>PATTERN</replaceable>s are specified, only units matching one of them are shown.
765 Produces output similar to
766 <programlisting>
767 NEXT LEFT LAST PASSED UNIT ACTIVATES
768 n/a n/a Thu 2017-02-23 13:40:29 EST 3 days ago ureadahead-stop.timer ureadahead-stop.service
769 Sun 2017-02-26 18:55:42 EST 1min 14s left Thu 2017-02-23 13:54:44 EST 3 days ago systemd-tmpfiles-clean.timer systemd-tmpfiles-clean.service
770 Sun 2017-02-26 20:37:16 EST 1h 42min left Sun 2017-02-26 11:56:36 EST 6h ago apt-daily.timer apt-daily.service
771 Sun 2017-02-26 20:57:49 EST 2h 3min left Sun 2017-02-26 11:56:36 EST 6h ago snapd.refresh.timer snapd.refresh.service
772 </programlisting>
773 </para>
774
775 <para><emphasis>NEXT</emphasis> shows the next time the timer will run.</para>
776 <para><emphasis>LEFT</emphasis> shows how long till the next time the timer runs.</para>
777 <para><emphasis>LAST</emphasis> shows the last time the timer ran.</para>
778 <para><emphasis>PASSED</emphasis> shows how long has passed since the timer last ran.</para>
779 <para><emphasis>UNIT</emphasis> shows the name of the timer</para>
780 <para><emphasis>ACTIVATES</emphasis> shows the name the service the timer activates when it runs.</para>
781
782 <para>Also see <option>--all</option> and <option>--state=</option>.</para>
783 </listitem>
784 </varlistentry>
785
786 <varlistentry>
787 <term><command>start <replaceable>PATTERN</replaceable>…</command></term>
788
789 <listitem>
790 <para>Start (activate) one or more units specified on the
791 command line.</para>
792
793 <para>Note that glob patterns operate on the set of primary names of units currently in memory. Units which
794 are not active and are not in a failed state usually are not in memory, and will not be matched by any
795 pattern. In addition, in case of instantiated units, systemd is often unaware of the instance name until
796 the instance has been started. Therefore, using glob patterns with <command>start</command> has limited
797 usefulness. Also, secondary alias names of units are not considered.</para>
798 </listitem>
799 </varlistentry>
800 <varlistentry>
801 <term><command>stop <replaceable>PATTERN</replaceable>…</command></term>
802
803 <listitem>
804 <para>Stop (deactivate) one or more units specified on the
805 command line.</para>
806 </listitem>
807 </varlistentry>
808 <varlistentry>
809 <term><command>reload <replaceable>PATTERN</replaceable>…</command></term>
810
811 <listitem>
812 <para>Asks all units listed on the command line to reload
813 their configuration. Note that this will reload the
814 service-specific configuration, not the unit configuration
815 file of systemd. If you want systemd to reload the
816 configuration file of a unit, use the
817 <command>daemon-reload</command> command. In other words:
818 for the example case of Apache, this will reload Apache's
819 <filename>httpd.conf</filename> in the web server, not the
820 <filename>apache.service</filename> systemd unit
821 file.</para>
822
823 <para>This command should not be confused with the
824 <command>daemon-reload</command> command.</para>
825 </listitem>
826
827 </varlistentry>
828 <varlistentry>
829 <term><command>restart <replaceable>PATTERN</replaceable>…</command></term>
830
831 <listitem>
832 <para>Stop and then start one or more units specified on the command line. If the units are not running
833 yet, they will be started.</para>
834
835 <para>Note that restarting a unit with this command does not necessarily flush out all of the unit's
836 resources before it is started again. For example, the per-service file descriptor storage facility (see
837 <varname>FileDescriptorStoreMax=</varname> in
838 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>) will
839 remain intact as long as the unit has a job pending, and is only cleared when the unit is fully stopped and
840 no jobs are pending anymore. If it is intended that the file descriptor store is flushed out, too, during a
841 restart operation an explicit <command>systemctl stop</command> command followed by <command>systemctl
842 start</command> should be issued.</para>
843 </listitem>
844 </varlistentry>
845 <varlistentry>
846 <term><command>try-restart <replaceable>PATTERN</replaceable>…</command></term>
847
848 <listitem>
849 <para>Stop and then start one or more units specified on the
850 command line if the units are running. This does nothing
851 if units are not running.</para>
852 <!-- Note that we don't document condrestart here, as that is just compatibility support, and we generally
853 don't document that. -->
854 </listitem>
855 </varlistentry>
856 <varlistentry>
857 <term><command>reload-or-restart <replaceable>PATTERN</replaceable>…</command></term>
858
859 <listitem>
860 <para>Reload one or more units if they support it. If not, stop and then start them instead. If the units
861 are not running yet, they will be started.</para>
862 </listitem>
863 </varlistentry>
864 <varlistentry>
865 <term><command>try-reload-or-restart <replaceable>PATTERN</replaceable>…</command></term>
866
867 <listitem>
868 <para>Reload one or more units if they support it. If not, stop and then start them instead. This does
869 nothing if the units are not running.</para>
870 <!-- Note that we don't document force-reload here, as that is just compatibility support, and we generally
871 don't document that. -->
872 </listitem>
873 </varlistentry>
874 <varlistentry>
875 <term><command>isolate <replaceable>UNIT</replaceable></command></term>
876
877 <listitem>
878 <para>Start the unit specified on the command line and its dependencies
879 and stop all others, unless they have
880 <option>IgnoreOnIsolate=yes</option> (see
881 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
882 If a unit name with no extension is given, an extension of
883 <literal>.target</literal> will be assumed.</para>
884
885 <para>This is similar to changing the runlevel in a
886 traditional init system. The <command>isolate</command>
887 command will immediately stop processes that are not enabled
888 in the new unit, possibly including the graphical
889 environment or terminal you are currently using.</para>
890
891 <para>Note that this is allowed only on units where
892 <option>AllowIsolate=</option> is enabled. See
893 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
894 for details.</para>
895 </listitem>
896 </varlistentry>
897 <varlistentry>
898 <term><command>kill <replaceable>PATTERN</replaceable>…</command></term>
899
900 <listitem>
901 <para>Send a signal to one or more processes of the
902 unit. Use <option>--kill-who=</option> to select which
903 process to kill. Use <option>--signal=</option> to select
904 the signal to send.</para>
905 </listitem>
906 </varlistentry>
907 <varlistentry>
908 <term><command>is-active <replaceable>PATTERN</replaceable>…</command></term>
909
910 <listitem>
911 <para>Check whether any of the specified units are active
912 (i.e. running). Returns an exit code
913 <constant>0</constant> if at least one is active, or
914 non-zero otherwise. Unless <option>--quiet</option> is
915 specified, this will also print the current unit state to
916 standard output.</para>
917 </listitem>
918 </varlistentry>
919 <varlistentry>
920 <term><command>is-failed <replaceable>PATTERN</replaceable>…</command></term>
921
922 <listitem>
923 <para>Check whether any of the specified units are in a
924 "failed" state. Returns an exit code
925 <constant>0</constant> if at least one has failed,
926 non-zero otherwise. Unless <option>--quiet</option> is
927 specified, this will also print the current unit state to
928 standard output.</para>
929 </listitem>
930 </varlistentry>
931 <varlistentry>
932 <term><command>status</command> <optional><replaceable>PATTERN</replaceable>…|<replaceable>PID</replaceable>…]</optional></term>
933
934 <listitem>
935 <para>Show terse runtime status information about one or
936 more units, followed by most recent log data from the
937 journal. If no units are specified, show system status. If
938 combined with <option>--all</option>, also show the status of
939 all units (subject to limitations specified with
940 <option>-t</option>). If a PID is passed, show information
941 about the unit the process belongs to.</para>
942
943 <para>This function is intended to generate human-readable
944 output. If you are looking for computer-parsable output,
945 use <command>show</command> instead. By default, this
946 function only shows 10 lines of output and ellipsizes
947 lines to fit in the terminal window. This can be changed
948 with <option>--lines</option> and <option>--full</option>,
949 see above. In addition, <command>journalctl
950 --unit=<replaceable>NAME</replaceable></command> or
951 <command>journalctl
952 --user-unit=<replaceable>NAME</replaceable></command> use
953 a similar filter for messages and might be more
954 convenient.
955 </para>
956
957 <para>systemd implicitly loads units as necessary, so just running the <command>status</command> will
958 attempt to load a file. The command is thus not useful for determining if something was already loaded or
959 not. The units may possibly also be quickly unloaded after the operation is completed if there's no reason
960 to keep it in memory thereafter.
961 </para>
962
963 <example>
964 <title>Example output from systemctl status </title>
965
966 <programlisting>$ systemctl status bluetooth
967 â—Ź bluetooth.service - Bluetooth service
968 Loaded: loaded (/usr/lib/systemd/system/bluetooth.service; enabled; vendor preset: enabled)
969 Active: active (running) since Wed 2017-01-04 13:54:04 EST; 1 weeks 0 days ago
970 Docs: man:bluetoothd(8)
971 Main PID: 930 (bluetoothd)
972 Status: "Running"
973 Tasks: 1
974 Memory: 648.0K
975 CPU: 435ms
976 CGroup: /system.slice/bluetooth.service
977 └─930 /usr/lib/bluetooth/bluetoothd
978
979 Jan 12 10:46:45 example.com bluetoothd[8900]: Not enough free handles to register service
980 Jan 12 10:46:45 example.com bluetoothd[8900]: Current Time Service could not be registered
981 Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output error (5)
982 </programlisting>
983
984 <para>The dot ("â—Ź") uses color on supported terminals to summarize the unit state at a glance. White
985 indicates an <literal>inactive</literal> or <literal>deactivating</literal> state. Red indicates a
986 <literal>failed</literal> or <literal>error</literal> state and green indicates an
987 <literal>active</literal>, <literal>reloading</literal> or <literal>activating</literal> state.
988 </para>
989
990 <para>The "Loaded:" line in the output will show <literal>loaded</literal> if the unit has been loaded into
991 memory. Other possible values for "Loaded:" include: <literal>error</literal> if there was a problem
992 loading it, <literal>not-found</literal> if not unit file was found for this unit,
993 <literal>bad-setting</literal> if an essential unit file setting could not be parsed and
994 <literal>masked</literal> if the unit file has been masked. Along with showing the path to the unit file,
995 this line will also show the enablement state. Enabled commands start at boot. See the full table of
996 possible enablement states — including the definition of <literal>masked</literal> — in the documentation
997 for the <command>is-enabled</command> command.
998 </para>
999
1000 <para>The "Active:" line shows active state. The value is usually <literal>active</literal> or
1001 <literal>inactive</literal>. Active could mean started, bound, plugged in, etc depending on the unit type.
1002 The unit could also be in process of changing states, reporting a state of <literal>activating</literal> or
1003 <literal>deactivating</literal>. A special <literal>failed</literal> state is entered when the service
1004 failed in some way, such as a crash, exiting with an error code or timing out. If the failed state is
1005 entered the cause will be logged for later reference.</para>
1006 </example>
1007
1008 </listitem>
1009 </varlistentry>
1010 <varlistentry>
1011 <term><command>show</command> <optional><replaceable>PATTERN</replaceable>…|<replaceable>JOB</replaceable>…</optional></term>
1012
1013 <listitem>
1014 <para>Show properties of one or more units, jobs, or the manager itself. If no argument is specified,
1015 properties of the manager will be shown. If a unit name is specified, properties of the unit are shown, and
1016 if a job ID is specified, properties of the job are shown. By default, empty properties are suppressed. Use
1017 <option>--all</option> to show those too. To select specific properties to show, use
1018 <option>--property=</option>. This command is intended to be used whenever computer-parsable output is
1019 required. Use <command>status</command> if you are looking for formatted human-readable output.</para>
1020
1021 <para>Many properties shown by <command>systemctl show</command> map directly to configuration settings of
1022 the system and service manager and its unit files. Note that the properties shown by the command are
1023 generally more low-level, normalized versions of the original configuration settings and expose runtime
1024 state in addition to configuration. For example, properties shown for service units include the service's
1025 current main process identifier as <literal>MainPID</literal> (which is runtime state), and time settings
1026 are always exposed as properties ending in the <literal>…USec</literal> suffix even if a matching
1027 configuration options end in <literal>…Sec</literal>, because microseconds is the normalized time unit used
1028 by the system and service manager.</para>
1029 </listitem>
1030 </varlistentry>
1031 <varlistentry>
1032 <term><command>cat <replaceable>PATTERN</replaceable>…</command></term>
1033
1034 <listitem>
1035 <para>Show backing files of one or more units. Prints the
1036 "fragment" and "drop-ins" (source files) of units. Each
1037 file is preceded by a comment which includes the file
1038 name. Note that this shows the contents of the backing files
1039 on disk, which may not match the system manager's
1040 understanding of these units if any unit files were
1041 updated on disk and the <command>daemon-reload</command>
1042 command wasn't issued since.</para>
1043 </listitem>
1044 </varlistentry>
1045 <varlistentry>
1046 <term><command>set-property <replaceable>UNIT</replaceable> <replaceable>PROPERTY</replaceable>=<replaceable>VALUE</replaceable>…</command></term>
1047
1048 <listitem>
1049 <para>Set the specified unit properties at runtime where
1050 this is supported. This allows changing configuration
1051 parameter properties such as resource control settings at
1052 runtime. Not all properties may be changed at runtime, but
1053 many resource control settings (primarily those in
1054 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
1055 may. The changes are applied immediately, and stored on disk
1056 for future boots, unless <option>--runtime</option> is
1057 passed, in which case the settings only apply until the
1058 next reboot. The syntax of the property assignment follows
1059 closely the syntax of assignments in unit files.</para>
1060
1061 <para>Example: <command>systemctl set-property foobar.service CPUShares=777</command></para>
1062
1063 <para>If the specified unit appears to be inactive, the
1064 changes will be only stored on disk as described
1065 previously hence they will be effective when the unit will
1066 be started.</para>
1067
1068 <para>Note that this command allows changing multiple
1069 properties at the same time, which is preferable over
1070 setting them individually. Like with unit file configuration
1071 settings, assigning an empty list will reset the property.
1072 </para>
1073 </listitem>
1074 </varlistentry>
1075
1076 <varlistentry>
1077 <term><command>help <replaceable>PATTERN</replaceable>…|<replaceable>PID</replaceable>…</command></term>
1078
1079 <listitem>
1080 <para>Show manual pages for one or more units, if
1081 available. If a PID is given, the manual pages for the unit
1082 the process belongs to are shown.</para>
1083 </listitem>
1084 </varlistentry>
1085
1086 <varlistentry>
1087 <term><command>reset-failed [<replaceable>PATTERN</replaceable>…]</command></term>
1088
1089 <listitem>
1090 <para>Reset the <literal>failed</literal> state of the specified units, or if no unit name is passed, reset
1091 the state of all units. When a unit fails in some way (i.e. process exiting with non-zero error code,
1092 terminating abnormally or timing out), it will automatically enter the <literal>failed</literal> state and
1093 its exit code and status is recorded for introspection by the administrator until the service is
1094 stopped/re-started or reset with this command.</para>
1095
1096 <para>In addition to resetting the <literal>failed</literal> state of a unit it also resets various other
1097 per-unit properties: the start rate limit counter of all unit types is reset to zero, as is the restart
1098 counter of service units. Thus, if a unit's start limit (as configured with
1099 <varname>StartLimitIntervalSec=</varname>/<varname>StartLimitBurst=</varname>) is hit and the unit refuses
1100 to be started again, use this command to make it startable again.</para>
1101 </listitem>
1102 </varlistentry>
1103
1104 <varlistentry>
1105 <term>
1106 <command>list-dependencies</command>
1107 <optional><replaceable>UNIT</replaceable></optional>
1108 </term>
1109
1110 <listitem>
1111 <para>Shows units required and wanted by the specified
1112 unit. This recursively lists units following the
1113 <varname>Requires=</varname>,
1114 <varname>Requisite=</varname>,
1115 <varname>ConsistsOf=</varname>,
1116 <varname>Wants=</varname>, <varname>BindsTo=</varname>
1117 dependencies. If no unit is specified,
1118 <filename>default.target</filename> is implied.</para>
1119
1120 <para>By default, only target units are recursively
1121 expanded. When <option>--all</option> is passed, all other
1122 units are recursively expanded as well.</para>
1123
1124 <para>Options <option>--reverse</option>,
1125 <option>--after</option>, <option>--before</option>
1126 may be used to change what types of dependencies
1127 are shown.</para>
1128
1129 <para>Note that this command only lists units currently loaded into memory by the service manager. In
1130 particular, this command is not suitable to get a comprehensive list at all reverse dependencies on a
1131 specific unit, as it won't list the dependencies declared by units currently not loaded.</para>
1132 </listitem>
1133 </varlistentry>
1134 </variablelist>
1135 </refsect2>
1136
1137 <refsect2>
1138 <title>Unit File Commands</title>
1139
1140 <variablelist>
1141 <varlistentry>
1142 <term><command>list-unit-files</command> <optional><replaceable>PATTERN…</replaceable></optional></term>
1143
1144 <listitem>
1145 <para>List unit files installed on the system, in combination with their enablement state (as reported by
1146 <command>is-enabled</command>). If one or more <replaceable>PATTERN</replaceable>s are specified, only unit
1147 files whose name matches one of them are shown (patterns matching unit file system paths are not
1148 supported).</para>
1149 </listitem>
1150 </varlistentry>
1151
1152 <varlistentry>
1153 <term><command>enable <replaceable>UNIT</replaceable>…</command></term>
1154 <term><command>enable <replaceable>PATH</replaceable>…</command></term>
1155
1156 <listitem>
1157 <para>Enable one or more units or unit instances. This will create a set of symlinks, as encoded in the
1158 <literal>[Install]</literal> sections of the indicated unit files. After the symlinks have been created,
1159 the system manager configuration is reloaded (in a way equivalent to <command>daemon-reload</command>), in
1160 order to ensure the changes are taken into account immediately. Note that this does
1161 <emphasis>not</emphasis> have the effect of also starting any of the units being enabled. If this is
1162 desired, combine this command with the <option>--now</option> switch, or invoke <command>start</command>
1163 with appropriate arguments later. Note that in case of unit instance enablement (i.e. enablement of units of
1164 the form <filename>foo@bar.service</filename>), symlinks named the same as instances are created in the
1165 unit configuration directory, however they point to the single template unit file they are instantiated
1166 from.</para>
1167
1168 <para>This command expects either valid unit names (in which case various unit file directories are
1169 automatically searched for unit files with appropriate names), or absolute paths to unit files (in which
1170 case these files are read directly). If a specified unit file is located outside of the usual unit file
1171 directories, an additional symlink is created, linking it into the unit configuration path, thus ensuring
1172 it is found when requested by commands such as <command>start</command>. The file system where the linked
1173 unit files are located must be accessible when systemd is started (e.g. anything underneath
1174 <filename>/home</filename> or <filename>/var</filename> is not allowed, unless those directories are
1175 located on the root file system).</para>
1176
1177 <para>This command will print the file system operations executed. This output may be suppressed by passing
1178 <option>--quiet</option>.
1179 </para>
1180
1181 <para>Note that this operation creates only the symlinks suggested in the <literal>[Install]</literal>
1182 section of the unit files. While this command is the recommended way to manipulate the unit configuration
1183 directory, the administrator is free to make additional changes manually by placing or removing symlinks
1184 below this directory. This is particularly useful to create configurations that deviate from the suggested
1185 default installation. In this case, the administrator must make sure to invoke
1186 <command>daemon-reload</command> manually as necessary, in order to ensure the changes are taken into
1187 account.
1188 </para>
1189
1190 <para>Enabling units should not be confused with starting (activating) units, as done by the
1191 <command>start</command> command. Enabling and starting units is orthogonal: units may be enabled without
1192 being started and started without being enabled. Enabling simply hooks the unit into various suggested
1193 places (for example, so that the unit is automatically started on boot or when a particular kind of
1194 hardware is plugged in). Starting actually spawns the daemon process (in case of service units), or binds
1195 the socket (in case of socket units), and so on.</para>
1196
1197 <para>Depending on whether <option>--system</option>, <option>--user</option>, <option>--runtime</option>,
1198 or <option>--global</option> is specified, this enables the unit for the system, for the calling user only,
1199 for only this boot of the system, or for all future logins of all users. Note that in the last case, no
1200 systemd daemon configuration is reloaded.</para>
1201
1202 <para>Using <command>enable</command> on masked units is not supported and results in an error.</para>
1203 </listitem>
1204 </varlistentry>
1205
1206 <varlistentry>
1207 <term><command>disable <replaceable>UNIT</replaceable>…</command></term>
1208
1209 <listitem>
1210 <para>Disables one or more units. This removes all symlinks to the unit files backing the specified units
1211 from the unit configuration directory, and hence undoes any changes made by <command>enable</command> or
1212 <command>link</command>. Note that this removes <emphasis>all</emphasis> symlinks to matching unit files,
1213 including manually created symlinks, and not just those actually created by <command>enable</command> or
1214 <command>link</command>. Note that while <command>disable</command> undoes the effect of
1215 <command>enable</command>, the two commands are otherwise not symmetric, as <command>disable</command> may
1216 remove more symlinks than a prior <command>enable</command> invocation of the same unit created.</para>
1217
1218 <para>This command expects valid unit names only, it does not accept paths to unit files.</para>
1219
1220 <para>In addition to the units specified as arguments, all units are disabled that are listed in the
1221 <varname>Also=</varname> setting contained in the <literal>[Install]</literal> section of any of the unit
1222 files being operated on.</para>
1223
1224 <para>This command implicitly reloads the system manager configuration after completing the operation. Note
1225 that this command does not implicitly stop the units that are being disabled. If this is desired, either
1226 combine this command with the <option>--now</option> switch, or invoke the <command>stop</command> command
1227 with appropriate arguments later.</para>
1228
1229 <para>This command will print information about the file system operations (symlink removals)
1230 executed. This output may be suppressed by passing <option>--quiet</option>.
1231 </para>
1232
1233 <para>This command honors <option>--system</option>, <option>--user</option>, <option>--runtime</option>
1234 and <option>--global</option> in a similar way as <command>enable</command>.</para>
1235 </listitem>
1236 </varlistentry>
1237
1238 <varlistentry>
1239 <term><command>reenable <replaceable>UNIT</replaceable>…</command></term>
1240
1241 <listitem>
1242 <para>Reenable one or more units, as specified on the command line. This is a combination of
1243 <command>disable</command> and <command>enable</command> and is useful to reset the symlinks a unit file is
1244 enabled with to the defaults configured in its <literal>[Install]</literal> section. This command expects
1245 a unit name only, it does not accept paths to unit files.</para>
1246 </listitem>
1247 </varlistentry>
1248
1249 <varlistentry>
1250 <term><command>preset <replaceable>UNIT</replaceable>…</command></term>
1251
1252 <listitem>
1253 <para>Reset the enable/disable status one or more unit files, as specified on
1254 the command line, to the defaults configured in the preset policy files. This
1255 has the same effect as <command>disable</command> or
1256 <command>enable</command>, depending how the unit is listed in the preset
1257 files.</para>
1258
1259 <para>Use <option>--preset-mode=</option> to control whether units shall be
1260 enabled and disabled, or only enabled, or only disabled.</para>
1261
1262 <para>If the unit carries no install information, it will be silently ignored
1263 by this command. <replaceable>UNIT</replaceable> must be the real unit name,
1264 any alias names are ignored silently.</para>
1265
1266 <para>For more information on the preset policy format, see
1267 <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1268 For more information on the concept of presets, please consult the
1269 <ulink url="https://www.freedesktop.org/wiki/Software/systemd/Preset">Preset</ulink>
1270 document.</para>
1271 </listitem>
1272 </varlistentry>
1273
1274 <varlistentry>
1275 <term><command>preset-all</command></term>
1276
1277 <listitem>
1278 <para>Resets all installed unit files to the defaults
1279 configured in the preset policy file (see above).</para>
1280
1281 <para>Use <option>--preset-mode=</option> to control
1282 whether units shall be enabled and disabled, or only
1283 enabled, or only disabled.</para>
1284 </listitem>
1285 </varlistentry>
1286
1287 <varlistentry>
1288 <term><command>is-enabled <replaceable>UNIT</replaceable>…</command></term>
1289
1290 <listitem>
1291 <para>Checks whether any of the specified unit files are
1292 enabled (as with <command>enable</command>). Returns an
1293 exit code of 0 if at least one is enabled, non-zero
1294 otherwise. Prints the current enable status (see table).
1295 To suppress this output, use <option>--quiet</option>.
1296 To show installation targets, use <option>--full</option>.
1297 </para>
1298
1299 <table>
1300 <title>
1301 <command>is-enabled</command> output
1302 </title>
1303
1304 <tgroup cols='3'>
1305 <thead>
1306 <row>
1307 <entry>Name</entry>
1308 <entry>Description</entry>
1309 <entry>Exit Code</entry>
1310 </row>
1311 </thead>
1312 <tbody>
1313 <row>
1314 <entry><literal>enabled</literal></entry>
1315 <entry morerows='1'>Enabled via <filename>.wants/</filename>, <filename>.requires/</filename> or <varname>Alias=</varname> symlinks (permanently in <filename>/etc/systemd/system/</filename>, or transiently in <filename>/run/systemd/system/</filename>).</entry>
1316 <entry morerows='1'>0</entry>
1317 </row>
1318 <row>
1319 <entry><literal>enabled-runtime</literal></entry>
1320 </row>
1321 <row>
1322 <entry><literal>linked</literal></entry>
1323 <entry morerows='1'>Made available through one or more symlinks to the unit file (permanently in <filename>/etc/systemd/system/</filename> or transiently in <filename>/run/systemd/system/</filename>), even though the unit file might reside outside of the unit file search path.</entry>
1324 <entry morerows='1'>&gt; 0</entry>
1325 </row>
1326 <row>
1327 <entry><literal>linked-runtime</literal></entry>
1328 </row>
1329 <row>
1330 <entry><literal>masked</literal></entry>
1331 <entry morerows='1'>Completely disabled, so that any start operation on it fails (permanently in <filename>/etc/systemd/system/</filename> or transiently in <filename>/run/systemd/systemd/</filename>).</entry>
1332 <entry morerows='1'>&gt; 0</entry>
1333 </row>
1334 <row>
1335 <entry><literal>masked-runtime</literal></entry>
1336 </row>
1337 <row>
1338 <entry><literal>static</literal></entry>
1339 <entry>The unit file is not enabled, and has no provisions for enabling in the <literal>[Install]</literal> unit file section.</entry>
1340 <entry>0</entry>
1341 </row>
1342 <row>
1343 <entry><literal>indirect</literal></entry>
1344 <entry>The unit file itself is not enabled, but it has a non-empty <varname>Also=</varname> setting in the <literal>[Install]</literal> unit file section, listing other unit files that might be enabled, or it has an alias under a different name through a symlink that is not specified in Also=. For template unit file, an instance different than the one specified in <varname>DefaultInstance=</varname> is enabled.</entry>
1345 <entry>0</entry>
1346 </row>
1347 <row>
1348 <entry><literal>disabled</literal></entry>
1349 <entry>The unit file is not enabled, but contains an <literal>[Install]</literal> section with installation instructions.</entry>
1350 <entry>&gt; 0</entry>
1351 </row>
1352 <row>
1353 <entry><literal>generated</literal></entry>
1354 <entry>The unit file was generated dynamically via a generator tool. See <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>. Generated unit files may not be enabled, they are enabled implicitly by their generator.</entry>
1355 <entry>0</entry>
1356 </row>
1357 <row>
1358 <entry><literal>transient</literal></entry>
1359 <entry>The unit file has been created dynamically with the runtime API. Transient units may not be enabled.</entry>
1360 <entry>0</entry>
1361 </row>
1362 <row>
1363 <entry><literal>bad</literal></entry>
1364 <entry>The unit file is invalid or another error occurred. Note that <command>is-enabled</command> will not actually return this state, but print an error message instead. However the unit file listing printed by <command>list-unit-files</command> might show it.</entry>
1365 <entry>&gt; 0</entry>
1366 </row>
1367 </tbody>
1368 </tgroup>
1369 </table>
1370
1371 </listitem>
1372 </varlistentry>
1373
1374 <varlistentry>
1375 <term><command>mask <replaceable>UNIT</replaceable>…</command></term>
1376
1377 <listitem>
1378 <para>Mask one or more units, as specified on the command line. This will link these unit files to
1379 <filename>/dev/null</filename>, making it impossible to start them. This is a stronger version of
1380 <command>disable</command>, since it prohibits all kinds of activation of the unit, including enablement
1381 and manual activation. Use this option with care. This honors the <option>--runtime</option> option to only
1382 mask temporarily until the next reboot of the system. The <option>--now</option> option may be used to
1383 ensure that the units are also stopped. This command expects valid unit names only, it does not accept unit
1384 file paths.</para>
1385 </listitem>
1386 </varlistentry>
1387
1388 <varlistentry>
1389 <term><command>unmask <replaceable>UNIT</replaceable>…</command></term>
1390
1391 <listitem>
1392 <para>Unmask one or more unit files, as specified on the command line. This will undo the effect of
1393 <command>mask</command>. This command expects valid unit names only, it does not accept unit file
1394 paths.</para>
1395 </listitem>
1396 </varlistentry>
1397
1398 <varlistentry>
1399 <term><command>link <replaceable>PATH</replaceable>…</command></term>
1400
1401 <listitem>
1402 <para>Link a unit file that is not in the unit file search paths into the unit file search path. This
1403 command expects an absolute path to a unit file. The effect of this may be undone with
1404 <command>disable</command>. The effect of this command is that a unit file is made available for commands
1405 such as <command>start</command>, even though it is not installed directly in the unit search path. The
1406 file system where the linked unit files are located must be accessible when systemd is started
1407 (e.g. anything underneath <filename>/home</filename> or <filename>/var</filename> is not allowed, unless
1408 those directories are located on the root file system).</para>
1409 </listitem>
1410 </varlistentry>
1411
1412 <varlistentry>
1413 <term><command>revert <replaceable>UNIT</replaceable>…</command></term>
1414
1415 <listitem>
1416 <para>Revert one or more unit files to their vendor versions. This command removes drop-in configuration
1417 files that modify the specified units, as well as any user-configured unit file that overrides a matching
1418 vendor supplied unit file. Specifically, for a unit <literal>foo.service</literal> the matching directories
1419 <literal>foo.service.d/</literal> with all their contained files are removed, both below the persistent and
1420 runtime configuration directories (i.e. below <filename>/etc/systemd/system</filename> and
1421 <filename>/run/systemd/system</filename>); if the unit file has a vendor-supplied version (i.e. a unit file
1422 located below <filename>/usr</filename>) any matching persistent or runtime unit file that overrides it is
1423 removed, too. Note that if a unit file has no vendor-supplied version (i.e. is only defined below
1424 <filename>/etc/systemd/system</filename> or <filename>/run/systemd/system</filename>, but not in a unit
1425 file stored below <filename>/usr</filename>), then it is not removed. Also, if a unit is masked, it is
1426 unmasked.</para>
1427
1428 <para>Effectively, this command may be used to undo all changes made with <command>systemctl
1429 edit</command>, <command>systemctl set-property</command> and <command>systemctl mask</command> and puts
1430 the original unit file with its settings back in effect.</para>
1431 </listitem>
1432 </varlistentry>
1433
1434 <varlistentry>
1435 <term><command>add-wants <replaceable>TARGET</replaceable>
1436 <replaceable>UNIT</replaceable>…</command></term>
1437 <term><command>add-requires <replaceable>TARGET</replaceable>
1438 <replaceable>UNIT</replaceable>…</command></term>
1439
1440 <listitem>
1441 <para>Adds <literal>Wants=</literal> or <literal>Requires=</literal>
1442 dependencies, respectively, to the specified
1443 <replaceable>TARGET</replaceable> for one or more units. </para>
1444
1445 <para>This command honors <option>--system</option>,
1446 <option>--user</option>, <option>--runtime</option> and
1447 <option>--global</option> in a way similar to
1448 <command>enable</command>.</para>
1449
1450 </listitem>
1451 </varlistentry>
1452
1453 <varlistentry>
1454 <term><command>edit <replaceable>UNIT</replaceable>…</command></term>
1455
1456 <listitem>
1457 <para>Edit a drop-in snippet or a whole replacement file if
1458 <option>--full</option> is specified, to extend or override the
1459 specified unit.</para>
1460
1461 <para>Depending on whether <option>--system</option> (the default),
1462 <option>--user</option>, or <option>--global</option> is specified,
1463 this command creates a drop-in file for each unit either for the system,
1464 for the calling user, or for all futures logins of all users. Then,
1465 the editor (see the "Environment" section below) is invoked on
1466 temporary files which will be written to the real location if the
1467 editor exits successfully.</para>
1468
1469 <para>If <option>--full</option> is specified, this will copy the
1470 original units instead of creating drop-in files.</para>
1471
1472 <para>If <option>--force</option> is specified and any units do
1473 not already exist, new unit files will be opened for editing.</para>
1474
1475 <para>If <option>--runtime</option> is specified, the changes will
1476 be made temporarily in <filename>/run</filename> and they will be
1477 lost on the next reboot.</para>
1478
1479 <para>If the temporary file is empty upon exit, the modification of
1480 the related unit is canceled.</para>
1481
1482 <para>After the units have been edited, systemd configuration is
1483 reloaded (in a way that is equivalent to <command>daemon-reload</command>).
1484 </para>
1485
1486 <para>Note that this command cannot be used to remotely edit units
1487 and that you cannot temporarily edit units which are in
1488 <filename>/etc</filename>, since they take precedence over
1489 <filename>/run</filename>.</para>
1490 </listitem>
1491 </varlistentry>
1492
1493 <varlistentry>
1494 <term><command>get-default</command></term>
1495
1496 <listitem>
1497 <para>Return the default target to boot into. This returns
1498 the target unit name <filename>default.target</filename>
1499 is aliased (symlinked) to.</para>
1500 </listitem>
1501 </varlistentry>
1502
1503 <varlistentry>
1504 <term><command>set-default <replaceable>TARGET</replaceable></command></term>
1505
1506 <listitem>
1507 <para>Set the default target to boot into. This sets
1508 (symlinks) the <filename>default.target</filename> alias
1509 to the given target unit.</para>
1510 </listitem>
1511 </varlistentry>
1512
1513 </variablelist>
1514 </refsect2>
1515
1516 <refsect2>
1517 <title>Machine Commands</title>
1518
1519 <variablelist>
1520 <varlistentry>
1521 <term><command>list-machines</command> <optional><replaceable>PATTERN</replaceable>…</optional></term>
1522
1523 <listitem>
1524 <para>List the host and all running local containers with
1525 their state. If one or more
1526 <replaceable>PATTERN</replaceable>s are specified, only
1527 containers matching one of them are shown.
1528 </para>
1529 </listitem>
1530 </varlistentry>
1531 </variablelist>
1532 </refsect2>
1533
1534 <refsect2>
1535 <title>Job Commands</title>
1536
1537 <variablelist>
1538 <varlistentry>
1539 <term><command>list-jobs <optional><replaceable>PATTERN…</replaceable></optional></command></term>
1540
1541 <listitem>
1542 <para>List jobs that are in progress. If one or more
1543 <replaceable>PATTERN</replaceable>s are specified, only
1544 jobs for units matching one of them are shown.</para>
1545
1546 <para>When combined with <option>--after</option> or <option>--before</option> the list is augmented with
1547 information on which other job each job is waiting for, and which other jobs are waiting for it, see
1548 above.</para>
1549 </listitem>
1550 </varlistentry>
1551 <varlistentry>
1552 <term><command>cancel <replaceable>JOB</replaceable>…</command></term>
1553
1554 <listitem>
1555 <para>Cancel one or more jobs specified on the command line
1556 by their numeric job IDs. If no job ID is specified, cancel
1557 all pending jobs.</para>
1558 </listitem>
1559 </varlistentry>
1560 </variablelist>
1561 </refsect2>
1562
1563 <refsect2>
1564 <title>Environment Commands</title>
1565
1566 <variablelist>
1567 <varlistentry>
1568 <term><command>show-environment</command></term>
1569
1570 <listitem>
1571 <para>Dump the systemd manager environment block. This is the environment
1572 block that is passed to all processes the manager spawns. The environment
1573 block will be dumped in straight-forward form suitable for sourcing into
1574 most shells. If no special characters or whitespace is present in the variable
1575 values, no escaping is performed, and the assignments have the form
1576 <literal>VARIABLE=value</literal>. If whitespace or characters which have
1577 special meaning to the shell are present, dollar-single-quote escaping is
1578 used, and assignments have the form <literal>VARIABLE=$'value'</literal>.
1579 This syntax is known to be supported by
1580 <citerefentry project='die-net'><refentrytitle>bash</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1581 <citerefentry project='die-net'><refentrytitle>zsh</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1582 <citerefentry project='die-net'><refentrytitle>ksh</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1583 and
1584 <citerefentry project='die-net'><refentrytitle>busybox</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
1585 <citerefentry project='die-net'><refentrytitle>ash</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1586 but not
1587 <citerefentry project='die-net'><refentrytitle>dash</refentrytitle><manvolnum>1</manvolnum></citerefentry>
1588 or
1589 <citerefentry project='die-net'><refentrytitle>fish</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
1590 </para>
1591 </listitem>
1592 </varlistentry>
1593 <varlistentry>
1594 <term><command>set-environment <replaceable>VARIABLE=VALUE</replaceable>…</command></term>
1595
1596 <listitem>
1597 <para>Set one or more systemd manager environment variables,
1598 as specified on the command line.</para>
1599 </listitem>
1600 </varlistentry>
1601 <varlistentry>
1602 <term><command>unset-environment <replaceable>VARIABLE</replaceable>…</command></term>
1603
1604 <listitem>
1605 <para>Unset one or more systemd manager environment
1606 variables. If only a variable name is specified, it will be
1607 removed regardless of its value. If a variable and a value
1608 are specified, the variable is only removed if it has the
1609 specified value.</para>
1610 </listitem>
1611 </varlistentry>
1612 <varlistentry>
1613 <term>
1614 <command>import-environment</command>
1615 <optional><replaceable>VARIABLE…</replaceable></optional>
1616 </term>
1617
1618 <listitem>
1619 <para>Import all, one or more environment variables set on
1620 the client into the systemd manager environment block. If
1621 no arguments are passed, the entire environment block is
1622 imported. Otherwise, a list of one or more environment
1623 variable names should be passed, whose client-side values
1624 are then imported into the manager's environment
1625 block.</para>
1626 </listitem>
1627 </varlistentry>
1628 </variablelist>
1629 </refsect2>
1630
1631 <refsect2>
1632 <title>Manager Lifecycle Commands</title>
1633
1634 <variablelist>
1635 <varlistentry>
1636 <term><command>daemon-reload</command></term>
1637
1638 <listitem>
1639 <para>Reload the systemd manager configuration. This will
1640 rerun all generators (see
1641 <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>),
1642 reload all unit files, and recreate the entire dependency
1643 tree. While the daemon is being reloaded, all sockets
1644 systemd listens on behalf of user configuration will stay
1645 accessible.</para>
1646
1647 <para>This command should not be confused with the
1648 <command>reload</command> command.</para>
1649 </listitem>
1650 </varlistentry>
1651 <varlistentry>
1652 <term><command>daemon-reexec</command></term>
1653
1654 <listitem>
1655 <para>Reexecute the systemd manager. This will serialize the
1656 manager state, reexecute the process and deserialize the
1657 state again. This command is of little use except for
1658 debugging and package upgrades. Sometimes, it might be
1659 helpful as a heavy-weight <command>daemon-reload</command>.
1660 While the daemon is being reexecuted, all sockets systemd listening
1661 on behalf of user configuration will stay accessible.
1662 </para>
1663 </listitem>
1664 </varlistentry>
1665 </variablelist>
1666 </refsect2>
1667
1668 <refsect2>
1669 <title>System Commands</title>
1670
1671 <variablelist>
1672 <varlistentry>
1673 <term><command>is-system-running</command></term>
1674
1675 <listitem>
1676 <para>Checks whether the system is operational. This
1677 returns success (exit code 0) when the system is fully up
1678 and running, specifically not in startup, shutdown or
1679 maintenance mode, and with no failed services. Failure is
1680 returned otherwise (exit code non-zero). In addition, the
1681 current state is printed in a short string to standard
1682 output, see the table below. Use <option>--quiet</option> to
1683 suppress this output.</para>
1684
1685 <para>Use <option>--wait</option> to wait until the boot
1686 process is completed before printing the current state and
1687 returning the appropriate error status. If <option>--wait</option>
1688 is in use, states <varname>initializing</varname> or
1689 <varname>starting</varname> will not be reported, instead
1690 the command will block until a later state (such as
1691 <varname>running</varname> or <varname>degraded</varname>)
1692 is reached.</para>
1693
1694 <table>
1695 <title><command>is-system-running</command> output</title>
1696 <tgroup cols='3'>
1697 <colspec colname='name'/>
1698 <colspec colname='description'/>
1699 <colspec colname='exit-code'/>
1700 <thead>
1701 <row>
1702 <entry>Name</entry>
1703 <entry>Description</entry>
1704 <entry>Exit Code</entry>
1705 </row>
1706 </thead>
1707 <tbody>
1708 <row>
1709 <entry><varname>initializing</varname></entry>
1710 <entry><para>Early bootup, before
1711 <filename>basic.target</filename> is reached
1712 or the <varname>maintenance</varname> state entered.
1713 </para></entry>
1714 <entry>&gt; 0</entry>
1715 </row>
1716 <row>
1717 <entry><varname>starting</varname></entry>
1718 <entry><para>Late bootup, before the job queue
1719 becomes idle for the first time, or one of the
1720 rescue targets are reached.</para></entry>
1721 <entry>&gt; 0</entry>
1722 </row>
1723 <row>
1724 <entry><varname>running</varname></entry>
1725 <entry><para>The system is fully
1726 operational.</para></entry>
1727 <entry>0</entry>
1728 </row>
1729 <row>
1730 <entry><varname>degraded</varname></entry>
1731 <entry><para>The system is operational but one or more
1732 units failed.</para></entry>
1733 <entry>&gt; 0</entry>
1734 </row>
1735 <row>
1736 <entry><varname>maintenance</varname></entry>
1737 <entry><para>The rescue or emergency target is
1738 active.</para></entry>
1739 <entry>&gt; 0</entry>
1740 </row>
1741 <row>
1742 <entry><varname>stopping</varname></entry>
1743 <entry><para>The manager is shutting
1744 down.</para></entry>
1745 <entry>&gt; 0</entry>
1746 </row>
1747 <row>
1748 <entry><varname>offline</varname></entry>
1749 <entry><para>The manager is not
1750 running. Specifically, this is the operational
1751 state if an incompatible program is running as
1752 system manager (PID 1).</para></entry>
1753 <entry>&gt; 0</entry>
1754 </row>
1755 <row>
1756 <entry><varname>unknown</varname></entry>
1757 <entry><para>The operational state could not be
1758 determined, due to lack of resources or another
1759 error cause.</para></entry>
1760 <entry>&gt; 0</entry>
1761 </row>
1762 </tbody>
1763 </tgroup>
1764 </table>
1765 </listitem>
1766 </varlistentry>
1767
1768 <varlistentry>
1769 <term><command>default</command></term>
1770
1771 <listitem>
1772 <para>Enter default mode. This is equivalent to <command>systemctl isolate default.target</command>. This
1773 operation is blocking by default, use <option>--no-block</option> to request asynchronous behavior.</para>
1774 </listitem>
1775 </varlistentry>
1776
1777 <varlistentry>
1778 <term><command>rescue</command></term>
1779
1780 <listitem>
1781 <para>Enter rescue mode. This is equivalent to <command>systemctl isolate rescue.target</command>. This
1782 operation is blocking by default, use <option>--no-block</option> to request asynchronous behavior.</para>
1783 </listitem>
1784 </varlistentry>
1785 <varlistentry>
1786 <term><command>emergency</command></term>
1787
1788 <listitem>
1789 <para>Enter emergency mode. This is equivalent to <command>systemctl isolate
1790 emergency.target</command>. This operation is blocking by default, use <option>--no-block</option> to
1791 request asynchronous behavior.</para>
1792 </listitem>
1793 </varlistentry>
1794 <varlistentry>
1795 <term><command>halt</command></term>
1796
1797 <listitem>
1798 <para>Shut down and halt the system. This is mostly equivalent to <command>systemctl start halt.target
1799 --job-mode=replace-irreversibly --no-block</command>, but also prints a wall message to all users. This command is
1800 asynchronous; it will return after the halt operation is enqueued, without waiting for it to complete. Note
1801 that this operation will simply halt the OS kernel after shutting down, leaving the hardware powered
1802 on. Use <command>systemctl poweroff</command> for powering off the system (see below).</para>
1803
1804 <para>If combined with <option>--force</option>, shutdown of all running services is skipped, however all
1805 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1806 system halt. If <option>--force</option> is specified twice, the operation is immediately executed without
1807 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1808 <option>--force</option> is specified twice the halt operation is executed by <command>systemctl</command>
1809 itself, and the system manager is not contacted. This means the command should succeed even when the system
1810 manager has crashed.</para>
1811 </listitem>
1812 </varlistentry>
1813 <varlistentry>
1814 <term><command>poweroff</command></term>
1815
1816 <listitem>
1817 <para>Shut down and power-off the system. This is mostly equivalent to <command>systemctl start
1818 poweroff.target --job-mode=replace-irreversibly --no-block</command>, but also prints a wall message to all
1819 users. This command is asynchronous; it will return after the power-off operation is enqueued, without
1820 waiting for it to complete.</para>
1821
1822 <para>If combined with <option>--force</option>, shutdown of all running services is skipped, however all
1823 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1824 powering off. If <option>--force</option> is specified twice, the operation is immediately executed without
1825 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1826 <option>--force</option> is specified twice the power-off operation is executed by
1827 <command>systemctl</command> itself, and the system manager is not contacted. This means the command should
1828 succeed even when the system manager has crashed.</para>
1829 </listitem>
1830 </varlistentry>
1831 <varlistentry>
1832 <term><command>reboot</command> <optional><replaceable>arg</replaceable></optional></term>
1833
1834 <listitem>
1835 <para>Shut down and reboot the system. This is mostly equivalent to <command>systemctl start reboot.target
1836 --job-mode=replace-irreversibly --no-block</command>, but also prints a wall message to all users. This
1837 command is asynchronous; it will return after the reboot operation is enqueued, without waiting for it to
1838 complete.</para>
1839
1840 <para>If combined with <option>--force</option>, shutdown of all running services is skipped, however all
1841 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1842 reboot. If <option>--force</option> is specified twice, the operation is immediately executed without
1843 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1844 <option>--force</option> is specified twice the reboot operation is executed by
1845 <command>systemctl</command> itself, and the system manager is not contacted. This means the command should
1846 succeed even when the system manager has crashed.</para>
1847
1848 <para>If the optional argument <replaceable>arg</replaceable> is given, it will be passed as the optional
1849 argument to the <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1850 system call. The value is architecture and firmware specific. As an example, <literal>recovery</literal>
1851 might be used to trigger system recovery, and <literal>fota</literal> might be used to trigger a
1852 <quote>firmware over the air</quote> update.</para>
1853 </listitem>
1854 </varlistentry>
1855
1856 <varlistentry>
1857 <term><command>kexec</command></term>
1858
1859 <listitem>
1860 <para>Shut down and reboot the system via <command>kexec</command>. This is equivalent to
1861 <command>systemctl start kexec.target --job-mode=replace-irreversibly --no-block</command>. This command is
1862 asynchronous; it will return after the reboot operation is enqueued, without waiting for it to
1863 complete.</para>
1864
1865 <para>If combined with <option>--force</option>, shutdown of all running services is skipped, however all
1866 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1867 reboot.</para>
1868 </listitem>
1869 </varlistentry>
1870
1871 <varlistentry>
1872 <term><command>exit</command> <optional><replaceable>EXIT_CODE</replaceable></optional></term>
1873
1874 <listitem>
1875 <para>Ask the service manager to quit. This is only supported for user service managers (i.e. in
1876 conjunction with the <option>--user</option> option) or in containers and is equivalent to
1877 <command>poweroff</command> otherwise. This command is asynchronous; it will return after the exit
1878 operation is enqueued, without waiting for it to complete.</para>
1879
1880 <para>The service manager will exit with the specified exit code, if
1881 <replaceable>EXIT_CODE</replaceable> is passed.</para>
1882 </listitem>
1883 </varlistentry>
1884
1885 <varlistentry>
1886 <term><command>switch-root</command> <replaceable>ROOT</replaceable> <optional><replaceable>INIT</replaceable></optional></term>
1887
1888 <listitem>
1889 <para>Switches to a different root directory and executes a new system manager process below it. This is
1890 intended for usage in initial RAM disks ("initrd"), and will transition from the initrd's system manager
1891 process (a.k.a. "init" process) to the main system manager process which is loaded from the actual host
1892 volume. This call takes two arguments: the directory that is to become the new root directory, and the path
1893 to the new system manager binary below it to execute as PID 1. If the latter is omitted or the empty
1894 string, a systemd binary will automatically be searched for and used as init. If the system manager path is
1895 omitted, equal to the empty string or identical to the path to the systemd binary, the state of the
1896 initrd's system manager process is passed to the main system manager, which allows later introspection of
1897 the state of the services involved in the initrd boot phase.</para>
1898 </listitem>
1899 </varlistentry>
1900
1901 <varlistentry>
1902 <term><command>suspend</command></term>
1903
1904 <listitem>
1905 <para>Suspend the system. This will trigger activation of the special target unit
1906 <filename>suspend.target</filename>. This command is asynchronous, and will return after the suspend
1907 operation is successfully enqueued. It will not wait for the suspend/resume cycle to complete.</para>
1908 </listitem>
1909 </varlistentry>
1910
1911 <varlistentry>
1912 <term><command>hibernate</command></term>
1913
1914 <listitem>
1915 <para>Hibernate the system. This will trigger activation of the special target unit
1916 <filename>hibernate.target</filename>. This command is asynchronous, and will return after the hibernation
1917 operation is successfully enqueued. It will not wait for the hibernate/thaw cycle to complete.</para>
1918 </listitem>
1919 </varlistentry>
1920
1921 <varlistentry>
1922 <term><command>hybrid-sleep</command></term>
1923
1924 <listitem>
1925 <para>Hibernate and suspend the system. This will trigger activation of the special target unit
1926 <filename>hybrid-sleep.target</filename>. This command is asynchronous, and will return after the hybrid
1927 sleep operation is successfully enqueued. It will not wait for the sleep/wake-up cycle to complete.</para>
1928 </listitem>
1929 </varlistentry>
1930
1931 <varlistentry>
1932 <term><command>suspend-then-hibernate</command></term>
1933
1934 <listitem>
1935 <para>Suspend the system and hibernate it after the delay specified in <filename>systemd-sleep.conf</filename>.
1936 This will trigger activation of the special target unit <filename>suspend-then-hibernate.target</filename>.
1937 This command is asynchronous, and will return after the hybrid sleep operation is successfully enqueued.
1938 It will not wait for the sleep/wake-up or hibernate/thaw cycle to complete.</para>
1939 </listitem>
1940 </varlistentry>
1941 </variablelist>
1942 </refsect2>
1943
1944 <refsect2>
1945 <title>Parameter Syntax</title>
1946
1947 <para>Unit commands listed above take either a single unit name (designated as <replaceable>UNIT</replaceable>),
1948 or multiple unit specifications (designated as <replaceable>PATTERN</replaceable>…). In the first case, the
1949 unit name with or without a suffix must be given. If the suffix is not specified (unit name is "abbreviated"),
1950 systemctl will append a suitable suffix, <literal>.service</literal> by default, and a type-specific suffix in
1951 case of commands which operate only on specific unit types. For example,
1952 <programlisting># systemctl start sshd</programlisting> and
1953 <programlisting># systemctl start sshd.service</programlisting>
1954 are equivalent, as are
1955 <programlisting># systemctl isolate default</programlisting>
1956 and
1957 <programlisting># systemctl isolate default.target</programlisting>
1958 Note that (absolute) paths to device nodes are automatically converted to device unit names, and other (absolute)
1959 paths to mount unit names.
1960 <programlisting># systemctl status /dev/sda
1961 # systemctl status /home</programlisting>
1962 are equivalent to:
1963 <programlisting># systemctl status dev-sda.device
1964 # systemctl status home.mount</programlisting>
1965 In the second case, shell-style globs will be matched against the primary names of all units currently in memory;
1966 literal unit names, with or without a suffix, will be treated as in the first case. This means that literal unit
1967 names always refer to exactly one unit, but globs may match zero units and this is not considered an
1968 error.</para>
1969
1970 <para>Glob patterns use
1971 <citerefentry project='man-pages'><refentrytitle>fnmatch</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
1972 so normal shell-style globbing rules are used, and
1973 <literal>*</literal>, <literal>?</literal>,
1974 <literal>[]</literal> may be used. See
1975 <citerefentry project='man-pages'><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1976 for more details. The patterns are matched against the primary names of
1977 units currently in memory, and patterns which do not match anything
1978 are silently skipped. For example:
1979 <programlisting># systemctl stop sshd@*.service</programlisting>
1980 will stop all <filename>sshd@.service</filename> instances. Note that alias names of units, and units that aren't
1981 in memory are not considered for glob expansion.
1982 </para>
1983
1984 <para>For unit file commands, the specified <replaceable>UNIT</replaceable> should be the name of the unit file
1985 (possibly abbreviated, see above), or the absolute path to the unit file:
1986 <programlisting># systemctl enable foo.service</programlisting>
1987 or
1988 <programlisting># systemctl link /path/to/foo.service</programlisting>
1989 </para>
1990 </refsect2>
1991
1992 </refsect1>
1993
1994 <refsect1>
1995 <title>Exit status</title>
1996
1997 <para>On success, 0 is returned, a non-zero failure code otherwise.</para>
1998
1999 <para><command>systemctl</command> uses the return codes defined by LSB, as defined in
2000 <ulink url="http://refspecs.linuxbase.org/LSB_3.0.0/LSB-PDA/LSB-PDA/iniscrptact.html">LSB 3.0.0</ulink>.
2001 </para>
2002
2003 <table>
2004 <title>LSB return codes</title>
2005
2006 <tgroup cols='3'>
2007 <thead>
2008 <row>
2009 <entry>Value</entry>
2010 <entry>Description in LSB</entry>
2011 <entry>Use in systemd</entry>
2012 </row>
2013 </thead>
2014 <tbody>
2015 <row>
2016 <entry><constant>0</constant></entry>
2017 <entry>"program is running or service is OK"</entry>
2018 <entry>unit is active</entry>
2019 </row>
2020 <row>
2021 <entry><constant>1</constant></entry>
2022 <entry>"program is dead and <filename>/var/run</filename> pid file exists"</entry>
2023 <entry>unit <emphasis>not</emphasis> failed (used by <command>is-failed</command>)</entry>
2024 </row>
2025 <row>
2026 <entry><constant>2</constant></entry>
2027 <entry>"program is dead and <filename>/var/lock</filename> lock file exists"</entry>
2028 <entry>unused</entry>
2029 </row>
2030 <row>
2031 <entry><constant>3</constant></entry>
2032 <entry>"program is not running"</entry>
2033 <entry>unit is not active</entry>
2034 </row>
2035 <row>
2036 <entry><constant>4</constant></entry>
2037 <entry>"program or service status is unknown"</entry>
2038 <entry>no such unit</entry>
2039 </row>
2040 </tbody>
2041 </tgroup>
2042 </table>
2043
2044 <para>The mapping of LSB service states to systemd unit states is imperfect, so it is better to
2045 not rely on those return values but to look for specific unit states and substates instead.
2046 </para>
2047 </refsect1>
2048
2049 <refsect1>
2050 <title>Environment</title>
2051
2052 <variablelist class='environment-variables'>
2053 <varlistentry>
2054 <term><varname>$SYSTEMD_EDITOR</varname></term>
2055
2056 <listitem><para>Editor to use when editing units; overrides
2057 <varname>$EDITOR</varname> and <varname>$VISUAL</varname>. If neither
2058 <varname>$SYSTEMD_EDITOR</varname> nor <varname>$EDITOR</varname> nor
2059 <varname>$VISUAL</varname> are present or if it is set to an empty
2060 string or if their execution failed, systemctl will try to execute well
2061 known editors in this order:
2062 <citerefentry project='die-net'><refentrytitle>editor</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2063 <citerefentry project='die-net'><refentrytitle>nano</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2064 <citerefentry project='die-net'><refentrytitle>vim</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2065 <citerefentry project='die-net'><refentrytitle>vi</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
2066 </para></listitem>
2067 </varlistentry>
2068 </variablelist>
2069 <xi:include href="less-variables.xml" xpointer="pager"/>
2070 <xi:include href="less-variables.xml" xpointer="less"/>
2071 <xi:include href="less-variables.xml" xpointer="lesscharset"/>
2072 </refsect1>
2073
2074 <refsect1>
2075 <title>See Also</title>
2076 <para>
2077 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2078 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2079 <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2080 <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2081 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2082 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2083 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
2084 <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2085 <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2086 <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
2087 <citerefentry project='man-pages'><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
2088 </para>
2089 </refsect1>
2090
2091 </refentry>