1 <?xml version='
1.0'
?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
4 <!ENTITY % entities SYSTEM
"custom-entities.ent" >
9 SPDX-License-Identifier: LGPL-2.1+
11 This file is part of systemd.
13 Copyright 2010 Lennart Poettering
15 systemd is free software; you can redistribute it and/or modify it
16 under the terms of the GNU Lesser General Public License as published by
17 the Free Software Foundation; either version 2.1 of the License, or
18 (at your option) any later version.
20 systemd is distributed in the hope that it will be useful, but
21 WITHOUT ANY WARRANTY; without even the implied warranty of
22 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23 Lesser General Public License for more details.
25 You should have received a copy of the GNU Lesser General Public License
26 along with systemd; If not, see <http://www.gnu.org/licenses/>.
29 <refentry id=
"systemctl"
30 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
33 <title>systemctl
</title>
34 <productname>systemd
</productname>
38 <contrib>Developer
</contrib>
39 <firstname>Lennart
</firstname>
40 <surname>Poettering
</surname>
41 <email>lennart@poettering.net
</email>
47 <refentrytitle>systemctl
</refentrytitle>
48 <manvolnum>1</manvolnum>
52 <refname>systemctl
</refname>
53 <refpurpose>Control the systemd system and service manager
</refpurpose>
58 <command>systemctl
</command>
59 <arg choice=
"opt" rep=
"repeat">OPTIONS
</arg>
60 <arg choice=
"plain">COMMAND
</arg>
61 <arg choice=
"opt" rep=
"repeat">NAME
</arg>
66 <title>Description
</title>
68 <para><command>systemctl
</command> may be used to introspect and
69 control the state of the
<literal>systemd
</literal> system and
70 service manager. Please refer to
71 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
72 for an introduction into the basic concepts and functionality this
77 <title>Options
</title>
79 <para>The following options are understood:
</para>
83 <term><option>-t
</option></term>
84 <term><option>--type=
</option></term>
87 <para>The argument should be a comma-separated list of unit
88 types such as
<option>service
</option> and
89 <option>socket
</option>.
92 <para>If one of the arguments is a unit type, when listing
93 units, limit display to certain unit types. Otherwise, units
94 of all types will be shown.
</para>
96 <para>As a special case, if one of the arguments is
97 <option>help
</option>, a list of allowed values will be
98 printed and the program will exit.
</para>
103 <term><option>--state=
</option></term>
106 <para>The argument should be a comma-separated list of unit
107 LOAD, SUB, or ACTIVE states. When listing units, show only
108 those in the specified states. Use
<option>--state=failed
</option>
109 to show only failed units.
</para>
111 <para>As a special case, if one of the arguments is
112 <option>help
</option>, a list of allowed values will be
113 printed and the program will exit.
</para>
118 <term><option>-p
</option></term>
119 <term><option>--property=
</option></term>
122 <para>When showing unit/job/manager properties with the
123 <command>show
</command> command, limit display to properties
124 specified in the argument. The argument should be a
125 comma-separated list of property names, such as
126 <literal>MainPID
</literal>. Unless specified, all known
127 properties are shown. If specified more than once, all
128 properties with the specified names are shown. Shell
129 completion is implemented for property names.
</para>
131 <para>For the manager itself,
132 <command>systemctl show
</command> will show all available
133 properties. Those properties are documented in
134 <citerefentry><refentrytitle>systemd-system.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
137 <para>Properties for units vary by unit type, so showing any
138 unit (even a non-existent one) is a way to list properties
139 pertaining to this type. Similarly, showing any job will list
140 properties pertaining to all jobs. Properties for units are
142 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
143 and the pages for individual unit types
144 <citerefentry><refentrytitle>systemd.service
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
145 <citerefentry><refentrytitle>systemd.socket
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
151 <term><option>-a
</option></term>
152 <term><option>--all
</option></term>
155 <para>When listing units with
<command>list-units
</command>, also show inactive units and
156 units which are following other units. When showing unit/job/manager properties, show all
157 properties regardless whether they are set or not.
</para>
159 <para>To list all units installed in the file system, use the
160 <command>list-unit-files
</command> command instead.
</para>
162 <para>When listing units with
<command>list-dependencies
</command>, recursively show
163 dependencies of all dependent units (by default only dependencies of target units are
169 <term><option>-r
</option></term>
170 <term><option>--recursive
</option></term>
173 <para>When listing units, also show units of local
174 containers. Units of local containers will be prefixed with
175 the container name, separated by a single colon character
176 (
<literal>:
</literal>).
</para>
181 <term><option>--reverse
</option></term>
184 <para>Show reverse dependencies between units with
185 <command>list-dependencies
</command>, i.e. follow
186 dependencies of type
<varname>WantedBy=
</varname>,
187 <varname>RequiredBy=
</varname>,
188 <varname>PartOf=
</varname>,
<varname>BoundBy=
</varname>,
189 instead of
<varname>Wants=
</varname> and similar.
195 <term><option>--after
</option></term>
198 <para>With
<command>list-dependencies
</command>, show the
199 units that are ordered before the specified unit. In other
200 words, recursively list units following the
201 <varname>After=
</varname> dependency.
</para>
203 <para>Note that any
<varname>After=
</varname> dependency is
204 automatically mirrored to create a
205 <varname>Before=
</varname> dependency. Temporal dependencies
206 may be specified explicitly, but are also created implicitly
207 for units which are
<varname>WantedBy=
</varname> targets
209 <citerefentry><refentrytitle>systemd.target
</refentrytitle><manvolnum>5</manvolnum></citerefentry>),
210 and as a result of other directives (for example
211 <varname>RequiresMountsFor=
</varname>). Both explicitly
212 and implicitly introduced dependencies are shown with
213 <command>list-dependencies
</command>.
</para>
215 <para>When passed to the
<command>list-jobs
</command> command, for each printed job show which other jobs are
216 waiting for it. May be combined with
<option>--before
</option> to show both the jobs waiting for each job as
217 well as all jobs each job is waiting for.
</para>
222 <term><option>--before
</option></term>
225 <para>With
<command>list-dependencies
</command>, show the
226 units that are ordered after the specified unit. In other
227 words, recursively list units following the
228 <varname>Before=
</varname> dependency.
</para>
230 <para>When passed to the
<command>list-jobs
</command> command, for each printed job show which other jobs it
231 is waiting for. May be combined with
<option>--after
</option> to show both the jobs waiting for each job as
232 well as all jobs each job is waiting for.
</para>
237 <term><option>-l
</option></term>
238 <term><option>--full
</option></term>
241 <para>Do not ellipsize unit names, process tree entries,
242 journal output, or truncate unit descriptions in the output
243 of
<command>status
</command>,
<command>list-units
</command>,
244 <command>list-jobs
</command>, and
245 <command>list-timers
</command>.
</para>
246 <para>Also, show installation targets in the output of
247 <command>is-enabled
</command>.
</para>
252 <term><option>--value
</option></term>
255 <para>When printing properties with
<command>show
</command>,
256 only print the value, and skip the property name and
257 <literal>=
</literal>.
</para>
262 <term><option>--show-types
</option></term>
265 <para>When showing sockets, show the type of the socket.
</para>
270 <term><option>--job-mode=
</option></term>
273 <para>When queuing a new job, this option controls how to deal with
274 already queued jobs. It takes one of
<literal>fail
</literal>,
275 <literal>replace
</literal>,
276 <literal>replace-irreversibly
</literal>,
277 <literal>isolate
</literal>,
278 <literal>ignore-dependencies
</literal>,
279 <literal>ignore-requirements
</literal> or
280 <literal>flush
</literal>. Defaults to
281 <literal>replace
</literal>, except when the
282 <command>isolate
</command> command is used which implies the
283 <literal>isolate
</literal> job mode.
</para>
285 <para>If
<literal>fail
</literal> is specified and a requested
286 operation conflicts with a pending job (more specifically:
287 causes an already pending start job to be reversed into a stop
288 job or vice versa), cause the operation to fail.
</para>
290 <para>If
<literal>replace
</literal> (the default) is
291 specified, any conflicting pending job will be replaced, as
294 <para>If
<literal>replace-irreversibly
</literal> is specified,
295 operate like
<literal>replace
</literal>, but also mark the new
296 jobs as irreversible. This prevents future conflicting
297 transactions from replacing these jobs (or even being enqueued
298 while the irreversible jobs are still pending). Irreversible
299 jobs can still be cancelled using the
<command>cancel
</command>
300 command. This job mode should be used on any transaction which
301 pulls in
<filename>shutdown.target
</filename>.
</para>
303 <para><literal>isolate
</literal> is only valid for start
304 operations and causes all other units to be stopped when the
305 specified unit is started. This mode is always used when the
306 <command>isolate
</command> command is used.
</para>
308 <para><literal>flush
</literal> will cause all queued jobs to
309 be canceled when the new job is enqueued.
</para>
311 <para>If
<literal>ignore-dependencies
</literal> is specified,
312 then all unit dependencies are ignored for this new job and
313 the operation is executed immediately. If passed, no required
314 units of the unit passed will be pulled in, and no ordering
315 dependencies will be honored. This is mostly a debugging and
316 rescue tool for the administrator and should not be used by
319 <para><literal>ignore-requirements
</literal> is similar to
320 <literal>ignore-dependencies
</literal>, but only causes the
321 requirement dependencies to be ignored, the ordering
322 dependencies will still be honored.
</para>
328 <term><option>--fail
</option></term>
331 <para>Shorthand for
<option>--job-mode=
</option>fail.
</para>
332 <para>When used with the
<command>kill
</command> command,
333 if no units were killed, the operation results in an error.
339 <term><option>-i
</option></term>
340 <term><option>--ignore-inhibitors
</option></term>
343 <para>When system shutdown or a sleep state is requested,
344 ignore inhibitor locks. Applications can establish inhibitor
345 locks to avoid that certain important operations (such as CD
346 burning or suchlike) are interrupted by system shutdown or a
347 sleep state. Any user may take these locks and privileged
348 users may override these locks. If any locks are taken,
349 shutdown and sleep state requests will normally fail
350 (regardless of whether privileged or not) and a list of active locks
351 is printed. However, if
<option>--ignore-inhibitors
</option>
352 is specified, the locks are ignored and not printed, and the
353 operation attempted anyway, possibly requiring additional
359 <term><option>--dry-run
</option></term>
362 <para>Just print what would be done. Currently supported by verbs
363 <command>halt
</command>,
<command>poweroff
</command>,
<command>reboot
</command>,
364 <command>kexec
</command>,
<command>suspend
</command>,
365 <command>hibernate
</command>,
<command>hybrid-sleep
</command>,
366 <command>default
</command>,
<command>rescue
</command>,
367 <command>emergency
</command>, and
<command>exit
</command>.
</para>
372 <term><option>-q
</option></term>
373 <term><option>--quiet
</option></term>
376 <para>Suppress printing of the results of various commands
377 and also the hints about truncated log lines. This does not
378 suppress output of commands for which the printed output is
379 the only result (like
<command>show
</command>). Errors are
380 always printed.
</para>
385 <term><option>--no-block
</option></term>
388 <para>Do not synchronously wait for the requested operation
389 to finish. If this is not specified, the job will be
390 verified, enqueued and
<command>systemctl
</command> will
391 wait until the unit's start-up is completed. By passing this
392 argument, it is only verified and enqueued. This option may not be
393 combined with
<option>--wait
</option>.
</para>
398 <term><option>--wait
</option></term>
401 <para>Synchronously wait for started units to terminate again.
402 This option may not be combined with
<option>--no-block
</option>.
403 Note that this will wait forever if any given unit never terminates
404 (by itself or by getting stopped explicitly); particularly services
405 which use
<literal>RemainAfterExit=yes
</literal>.
</para>
409 <xi:include href=
"user-system-options.xml" xpointer=
"user" />
410 <xi:include href=
"user-system-options.xml" xpointer=
"system" />
413 <term><option>--failed
</option></term>
416 <para>List units in failed state. This is equivalent to
417 <option>--state=failed
</option>.
</para>
422 <term><option>--no-wall
</option></term>
425 <para>Do not send wall message before halt, power-off and reboot.
</para>
430 <term><option>--global
</option></term>
433 <para>When used with
<command>enable
</command> and
434 <command>disable
</command>, operate on the global user
435 configuration directory, thus enabling or disabling a unit
436 file globally for all future logins of all users.
</para>
441 <term><option>--no-reload
</option></term>
444 <para>When used with
<command>enable
</command> and
445 <command>disable
</command>, do not implicitly reload daemon
446 configuration after executing the changes.
</para>
451 <term><option>--no-ask-password
</option></term>
454 <para>When used with
<command>start
</command> and related
455 commands, disables asking for passwords. Background services
456 may require input of a password or passphrase string, for
457 example to unlock system hard disks or cryptographic
458 certificates. Unless this option is specified and the
459 command is invoked from a terminal,
460 <command>systemctl
</command> will query the user on the
461 terminal for the necessary secrets. Use this option to
462 switch this behavior off. In this case, the password must be
463 supplied by some other means (for example graphical password
464 agents) or the service might fail. This also disables
465 querying the user for authentication for privileged
471 <term><option>--kill-who=
</option></term>
474 <para>When used with
<command>kill
</command>, choose which
475 processes to send a signal to. Must be one of
476 <option>main
</option>,
<option>control
</option> or
477 <option>all
</option> to select whether to kill only the main
478 process, the control process or all processes of the
479 unit. The main process of the unit is the one that defines
480 the life-time of it. A control process of a unit is one that
481 is invoked by the manager to induce state changes of it. For
482 example, all processes started due to the
483 <varname>ExecStartPre=
</varname>,
484 <varname>ExecStop=
</varname> or
485 <varname>ExecReload=
</varname> settings of service units are
486 control processes. Note that there is only one control
487 process per unit at a time, as only one state change is
488 executed at a time. For services of type
489 <varname>Type=forking
</varname>, the initial process started
490 by the manager for
<varname>ExecStart=
</varname> is a
491 control process, while the process ultimately forked off by
492 that one is then considered the main process of the unit (if
493 it can be determined). This is different for service units
494 of other types, where the process forked off by the manager
495 for
<varname>ExecStart=
</varname> is always the main process
496 itself. A service unit consists of zero or one main process,
497 zero or one control process plus any number of additional
498 processes. Not all unit types manage processes of these
499 types however. For example, for mount units, control processes
500 are defined (which are the invocations of
501 <filename>&MOUNT_PATH;</filename> and
502 <filename>&UMOUNT_PATH;</filename>), but no main process
503 is defined. If omitted, defaults to
504 <option>all
</option>.
</para>
510 <term><option>-s
</option></term>
511 <term><option>--signal=
</option></term>
514 <para>When used with
<command>kill
</command>, choose which
515 signal to send to selected processes. Must be one of the
516 well-known signal specifiers such as
<constant>SIGTERM
</constant>,
<constant>SIGINT
</constant> or
517 <constant>SIGSTOP
</constant>. If omitted, defaults to
518 <option>SIGTERM
</option>.
</para>
523 <term><option>-f
</option></term>
524 <term><option>--force
</option></term>
527 <para>When used with
<command>enable
</command>, overwrite
528 any existing conflicting symlinks.
</para>
530 <para>When used with
<command>edit
</command>, create all of the
531 specified units which do not already exist.
</para>
533 <para>When used with
<command>halt
</command>,
<command>poweroff
</command>,
<command>reboot
</command> or
534 <command>kexec
</command>, execute the selected operation without shutting down all units. However, all
535 processes will be killed forcibly and all file systems are unmounted or remounted read-only. This is hence a
536 drastic but relatively safe option to request an immediate reboot. If
<option>--force
</option> is specified
537 twice for these operations (with the exception of
<command>kexec
</command>), they will be executed
538 immediately, without terminating any processes or unmounting any file systems. Warning: specifying
539 <option>--force
</option> twice with any of these operations might result in data loss. Note that when
540 <option>--force
</option> is specified twice the selected operation is executed by
541 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
542 succeed even when the system manager has crashed.
</para>
547 <term><option>--message=
</option></term>
550 <para>When used with
<command>halt
</command>,
<command>poweroff
</command> or
<command>reboot
</command>, set a
551 short message explaining the reason for the operation. The message will be logged together with the default
552 shutdown message.
</para>
557 <term><option>--now
</option></term>
560 <para>When used with
<command>enable
</command>, the units
561 will also be started. When used with
<command>disable
</command> or
562 <command>mask
</command>, the units will also be stopped. The start
563 or stop operation is only carried out when the respective enable or
564 disable operation has been successful.
</para>
569 <term><option>--root=
</option></term>
573 <command>enable
</command>/
<command>disable
</command>/
<command>is-enabled
</command>
574 (and related commands), use the specified root path when looking for unit
575 files. If this option is present,
<command>systemctl
</command> will operate on
576 the file system directly, instead of communicating with the
<command>systemd
</command>
577 daemon to carry out changes.
</para>
583 <term><option>--runtime
</option></term>
586 <para>When used with
<command>enable
</command>,
587 <command>disable
</command>,
<command>edit
</command>,
588 (and related commands), make changes only temporarily, so
589 that they are lost on the next reboot. This will have the
590 effect that changes are not made in subdirectories of
591 <filename>/etc
</filename> but in
<filename>/run
</filename>,
592 with identical immediate effects, however, since the latter
593 is lost on reboot, the changes are lost too.
</para>
595 <para>Similarly, when used with
596 <command>set-property
</command>, make changes only
597 temporarily, so that they are lost on the next
603 <term><option>--preset-mode=
</option></term>
606 <para>Takes one of
<literal>full
</literal> (the default),
607 <literal>enable-only
</literal>,
608 <literal>disable-only
</literal>. When used with the
609 <command>preset
</command> or
<command>preset-all
</command>
610 commands, controls whether units shall be disabled and
611 enabled according to the preset rules, or only enabled, or
612 only disabled.
</para>
617 <term><option>-n
</option></term>
618 <term><option>--lines=
</option></term>
621 <para>When used with
<command>status
</command>, controls the
622 number of journal lines to show, counting from the most
623 recent ones. Takes a positive integer argument. Defaults to
629 <term><option>-o
</option></term>
630 <term><option>--output=
</option></term>
633 <para>When used with
<command>status
</command>, controls the
634 formatting of the journal entries that are shown. For the
635 available choices, see
636 <citerefentry><refentrytitle>journalctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
637 Defaults to
<literal>short
</literal>.
</para>
642 <term><option>--firmware-setup
</option></term>
645 <para>When used with the
<command>reboot
</command> command,
646 indicate to the system's firmware to boot into setup
647 mode. Note that this is currently only supported on some EFI
648 systems and only if the system was booted in EFI
654 <term><option>--plain
</option></term>
657 <para>When used with
<command>list-dependencies
</command>,
658 <command>list-units
</command> or
<command>list-machines
</command>,
659 the output is printed as a list instead of a tree, and the bullet
660 circles are omitted.
</para>
664 <xi:include href=
"user-system-options.xml" xpointer=
"host" />
665 <xi:include href=
"user-system-options.xml" xpointer=
"machine" />
667 <xi:include href=
"standard-options.xml" xpointer=
"no-pager" />
668 <xi:include href=
"standard-options.xml" xpointer=
"no-legend" />
669 <xi:include href=
"standard-options.xml" xpointer=
"help" />
670 <xi:include href=
"standard-options.xml" xpointer=
"version" />
675 <title>Commands
</title>
677 <para>The following commands are understood:
</para>
680 <title>Unit Commands
</title>
684 <term><command>list-units
<optional><replaceable>PATTERN
</replaceable>…
</optional></command></term>
687 <para>List units that
<command>systemd
</command> currently has in memory. This includes units that are
688 either referenced directly or through a dependency, units that are pinned by applications programmatically,
689 or units that were active in the past and have failed. By default only units which are active, have pending
690 jobs, or have failed are shown; this can be changed with option
<option>--all
</option>. If one or more
691 <replaceable>PATTERN
</replaceable>s are specified, only units matching one of them are shown. The units
692 that are shown are additionally filtered by
<option>--type=
</option> and
<option>--state=
</option> if those
693 options are specified.
</para>
695 <para>This is the default command.
</para>
700 <term><command>list-sockets
<optional><replaceable>PATTERN
</replaceable>…
</optional></command></term>
703 <para>List socket units currently in memory, ordered by listening address. If one or more
704 <replaceable>PATTERN
</replaceable>s are specified, only socket units matching one of them are
705 shown. Produces output similar to
707 LISTEN UNIT ACTIVATES
708 /dev/initctl systemd-initctl.socket systemd-initctl.service
710 [::]:
22 sshd.socket sshd.service
711 kobject-uevent
1 systemd-udevd-kernel.socket systemd-udevd.service
713 5 sockets listed.
</programlisting>
714 Note: because the addresses might contains spaces, this output
715 is not suitable for programmatic consumption.
718 <para>Also see
<option>--show-types
</option>,
<option>--all
</option>, and
<option>--state=
</option>.
</para>
723 <term><command>list-timers
<optional><replaceable>PATTERN
</replaceable>…
</optional></command></term>
726 <para>List timer units currently in memory, ordered by the time they elapse next. If one or more
727 <replaceable>PATTERN
</replaceable>s are specified, only units matching one of them are shown.
728 Produces output similar to
730 NEXT LEFT LAST PASSED UNIT ACTIVATES
731 n/a n/a Thu
2017-
02-
23 13:
40:
29 EST
3 days ago ureadahead-stop.timer ureadahead-stop.service
732 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
733 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
734 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
738 <para><emphasis>NEXT
</emphasis> shows the next time the timer will run.
</para>
739 <para><emphasis>LEFT
</emphasis> shows how long till the next time the timer runs.
</para>
740 <para><emphasis>LAST
</emphasis> shows the last time the timer ran.
</para>
741 <para><emphasis>PASSED
</emphasis> shows has long as passed since the timer laset ran.
</para>
742 <para><emphasis>UNIT
</emphasis> shows the name of the timer
</para>
743 <para><emphasis>ACTIVATES
</emphasis> shows the name the service the timer activates when it runs.
</para>
745 <para>Also see
<option>--all
</option> and
<option>--state=
</option>.
</para>
750 <term><command>start
<replaceable>PATTERN
</replaceable>…
</command></term>
753 <para>Start (activate) one or more units specified on the
756 <para>Note that glob patterns operate on the set of primary names of units currently in memory. Units which
757 are not active and are not in a failed state usually are not in memory, and will not be matched by any
758 pattern. In addition, in case of instantiated units, systemd is often unaware of the instance name until
759 the instance has been started. Therefore, using glob patterns with
<command>start
</command> has limited
760 usefulness. Also, secondary alias names of units are not considered.
</para>
764 <term><command>stop
<replaceable>PATTERN
</replaceable>…
</command></term>
767 <para>Stop (deactivate) one or more units specified on the
772 <term><command>reload
<replaceable>PATTERN
</replaceable>…
</command></term>
775 <para>Asks all units listed on the command line to reload
776 their configuration. Note that this will reload the
777 service-specific configuration, not the unit configuration
778 file of systemd. If you want systemd to reload the
779 configuration file of a unit, use the
780 <command>daemon-reload
</command> command. In other words:
781 for the example case of Apache, this will reload Apache's
782 <filename>httpd.conf
</filename> in the web server, not the
783 <filename>apache.service
</filename> systemd unit
786 <para>This command should not be confused with the
787 <command>daemon-reload
</command> command.
</para>
792 <term><command>restart
<replaceable>PATTERN
</replaceable>…
</command></term>
795 <para>Stop and then start one or more units specified on the command line. If the units are not running
796 yet, they will be started.
</para>
798 <para>Note that restarting a unit with this command does not necessarily flush out all of the unit's
799 resources before it is started again. For example, the per-service file descriptor storage facility (see
800 <varname>FileDescriptoreStoreMax=
</varname> in
801 <citerefentry><refentrytitle>systemd.service
</refentrytitle><manvolnum>5</manvolnum></citerefentry>) will
802 remain intact as long as the unit has a job pending, and is only cleared when the unit is fully stopped and
803 no jobs are pending anymore. If it is intended that the file descriptor store is flushed out, too, during a
804 restart operation an explicit
<command>systemctl stop
</command> command followed by
<command>systemctl
805 start
</command> should be issued.
</para>
809 <term><command>try-restart
<replaceable>PATTERN
</replaceable>…
</command></term>
812 <para>Stop and then start one or more units specified on the
813 command line if the units are running. This does nothing
814 if units are not running.
</para>
815 <!-- Note that we don't document condrestart here, as that is just compatibility support, and we generally
816 don't document that. -->
820 <term><command>reload-or-restart
<replaceable>PATTERN
</replaceable>…
</command></term>
823 <para>Reload one or more units if they support it. If not, stop and then start them instead. If the units
824 are not running yet, they will be started.
</para>
828 <term><command>try-reload-or-restart
<replaceable>PATTERN
</replaceable>…
</command></term>
831 <para>Reload one or more units if they support it. If not, stop and then start them instead. This does
832 nothing if the units are not running.
</para>
833 <!-- Note that we don't document force-reload here, as that is just compatibility support, and we generally
834 don't document that. -->
838 <term><command>isolate
<replaceable>NAME
</replaceable></command></term>
841 <para>Start the unit specified on the command line and its dependencies
842 and stop all others, unless they have
843 <option>IgnoreOnIsolate=yes
</option> (see
844 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
845 If a unit name with no extension is given, an extension of
846 <literal>.target
</literal> will be assumed.
</para>
848 <para>This is similar to changing the runlevel in a
849 traditional init system. The
<command>isolate
</command>
850 command will immediately stop processes that are not enabled
851 in the new unit, possibly including the graphical
852 environment or terminal you are currently using.
</para>
854 <para>Note that this is allowed only on units where
855 <option>AllowIsolate=
</option> is enabled. See
856 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
861 <term><command>kill
<replaceable>PATTERN
</replaceable>…
</command></term>
864 <para>Send a signal to one or more processes of the
865 unit. Use
<option>--kill-who=
</option> to select which
866 process to kill. Use
<option>--signal=
</option> to select
867 the signal to send.
</para>
871 <term><command>is-active
<replaceable>PATTERN
</replaceable>…
</command></term>
874 <para>Check whether any of the specified units are active
875 (i.e. running). Returns an exit code
876 <constant>0</constant> if at least one is active, or
877 non-zero otherwise. Unless
<option>--quiet
</option> is
878 specified, this will also print the current unit state to
879 standard output.
</para>
883 <term><command>is-failed
<replaceable>PATTERN
</replaceable>…
</command></term>
886 <para>Check whether any of the specified units are in a
887 "failed" state. Returns an exit code
888 <constant>0</constant> if at least one has failed,
889 non-zero otherwise. Unless
<option>--quiet
</option> is
890 specified, this will also print the current unit state to
891 standard output.
</para>
895 <term><command>status
</command> <optional><replaceable>PATTERN
</replaceable>…|
<replaceable>PID
</replaceable>…]
</optional></term>
898 <para>Show terse runtime status information about one or
899 more units, followed by most recent log data from the
900 journal. If no units are specified, show system status. If
901 combined with
<option>--all
</option>, also show the status of
902 all units (subject to limitations specified with
903 <option>-t
</option>). If a PID is passed, show information
904 about the unit the process belongs to.
</para>
906 <para>This function is intended to generate human-readable
907 output. If you are looking for computer-parsable output,
908 use
<command>show
</command> instead. By default, this
909 function only shows
10 lines of output and ellipsizes
910 lines to fit in the terminal window. This can be changed
911 with
<option>--lines
</option> and
<option>--full
</option>,
912 see above. In addition,
<command>journalctl
913 --unit=
<replaceable>NAME
</replaceable></command> or
915 --user-unit=
<replaceable>NAME
</replaceable></command> use
916 a similar filter for messages and might be more
920 <para>systemd implicitly loads units as necessary, so just running the
<command>status
</command> will
921 attempt to load a file. The command is thus not useful for determining if something was already loaded or
922 not. The units may possibly also be quickly unloaded after the operation is completed if there's no reason
923 to keep it in memory thereafter.
927 <title>Example output from systemctl status
</title>
929 <programlisting>$ systemctl status bluetooth
930 â—Ź bluetooth.service - Bluetooth service
931 Loaded: loaded (/usr/lib/systemd/system/bluetooth.service; enabled; vendor preset: enabled)
932 Active: active (running) since Wed
2017-
01-
04 13:
54:
04 EST;
1 weeks
0 days ago
933 Docs: man:bluetoothd(
8)
934 Main PID:
930 (bluetoothd)
939 CGroup: /system.slice/bluetooth.service
940 └─
930 /usr/lib/bluetooth/bluetoothd
942 Jan
12 10:
46:
45 example.com bluetoothd[
8900]: Not enough free handles to register service
943 Jan
12 10:
46:
45 example.com bluetoothd[
8900]: Current Time Service could not be registered
944 Jan
12 10:
46:
45 example.com bluetoothd[
8900]: gatt-time-server: Input/output error (
5)
947 <para>The dot (
"â—Ź") uses color on supported terminals to summarize the unit state at a glance. White
948 indicates an
<literal>inactive
</literal> or
<literal>deactivating
</literal> state. Red indicates a
949 <literal>failed
</literal> or
<literal>error
</literal> state and green indicates an
950 <literal>active
</literal>,
<literal>reloading
</literal> or
<literal>activating
</literal> state.
953 <para>The
"Loaded:" line in the output will show
<literal>loaded
</literal> if the unit has been loaded into
954 memory. Other possible values for
"Loaded:" include:
<literal>error
</literal> if there was a problem
955 loading it,
<literal>not-found
</literal>, and
<literal>masked
</literal>. Along with showing the path to
956 the unit file, this line will also show the enablement state. Enabled commands start at boot. See the
957 full table of possible enablement states — including the definition of
<literal>masked
</literal> — in the
958 documentation for the
<command>is-enabled
</command> command.
961 <para>The
"Active:" line shows active state. The value is usually
<literal>active
</literal> or
962 <literal>inactive
</literal>. Active could mean started, bound, plugged in, etc depending on the unit type.
963 The unit could also be in process of changing states, reporting a state of
<literal>activating
</literal> or
964 <literal>deactivating
</literal>. A special
<literal>failed
</literal> state is entered when the service
965 failed in some way, such as a crash, exiting with an error code or timing out. If the failed state is
966 entered the cause will be logged for later reference.
</para>
972 <term><command>show
</command> <optional><replaceable>PATTERN
</replaceable>…|
<replaceable>JOB
</replaceable>…
</optional></term>
975 <para>Show properties of one or more units, jobs, or the manager itself. If no argument is specified,
976 properties of the manager will be shown. If a unit name is specified, properties of the unit are shown, and
977 if a job ID is specified, properties of the job are shown. By default, empty properties are suppressed. Use
978 <option>--all
</option> to show those too. To select specific properties to show, use
979 <option>--property=
</option>. This command is intended to be used whenever computer-parsable output is
980 required. Use
<command>status
</command> if you are looking for formatted human-readable output.
</para>
982 <para>Many properties shown by
<command>systemctl show
</command> map directly to configuration settings of
983 the system and service manager and its unit files. Note that the properties shown by the command are
984 generally more low-level, normalized versions of the original configuration settings and expose runtime
985 state in addition to configuration. For example, properties shown for service units include the service's
986 current main process identifier as
<literal>MainPID
</literal> (which is runtime state), and time settings
987 are always exposed as properties ending in the
<literal>…USec
</literal> suffix even if a matching
988 configuration options end in
<literal>…Sec
</literal>, because microseconds is the normalized time unit used
989 by the system and service manager.
</para>
993 <term><command>cat
<replaceable>PATTERN
</replaceable>…
</command></term>
996 <para>Show backing files of one or more units. Prints the
997 "fragment" and
"drop-ins" (source files) of units. Each
998 file is preceded by a comment which includes the file
999 name. Note that this shows the contents of the backing files
1000 on disk, which may not match the system manager's
1001 understanding of these units if any unit files were
1002 updated on disk and the
<command>daemon-reload
</command>
1003 command wasn't issued since.
</para>
1007 <term><command>set-property
<replaceable>NAME
</replaceable> <replaceable>ASSIGNMENT
</replaceable>…
</command></term>
1010 <para>Set the specified unit properties at runtime where
1011 this is supported. This allows changing configuration
1012 parameter properties such as resource control settings at
1013 runtime. Not all properties may be changed at runtime, but
1014 many resource control settings (primarily those in
1015 <citerefentry><refentrytitle>systemd.resource-control
</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
1016 may. The changes are applied instantly, and stored on disk
1017 for future boots, unless
<option>--runtime
</option> is
1018 passed, in which case the settings only apply until the
1019 next reboot. The syntax of the property assignment follows
1020 closely the syntax of assignments in unit files.
</para>
1022 <para>Example:
<command>systemctl set-property foobar.service CPUShares=
777</command></para>
1024 <para>If the specified unit appears to be inactive, the
1025 changes will be only stored on disk as described
1026 previously hence they will be effective when the unit will
1029 <para>Note that this command allows changing multiple
1030 properties at the same time, which is preferable over
1031 setting them individually. Like unit file configuration
1032 settings, assigning the empty list to list parameters will
1033 reset the list.
</para>
1038 <term><command>help
<replaceable>PATTERN
</replaceable>…|
<replaceable>PID
</replaceable>…
</command></term>
1041 <para>Show manual pages for one or more units, if
1042 available. If a PID is given, the manual pages for the unit
1043 the process belongs to are shown.
</para>
1048 <term><command>reset-failed [
<replaceable>PATTERN
</replaceable>…]
</command></term>
1051 <para>Reset the
<literal>failed
</literal> state of the specified units, or if no unit name is passed, reset
1052 the state of all units. When a unit fails in some way (i.e. process exiting with non-zero error code,
1053 terminating abnormally or timing out), it will automatically enter the
<literal>failed
</literal> state and
1054 its exit code and status is recorded for introspection by the administrator until the service is
1055 stopped/re-started or reset with this command.
</para>
1061 <command>list-dependencies
</command>
1062 <optional><replaceable>NAME
</replaceable></optional>
1066 <para>Shows units required and wanted by the specified
1067 unit. This recursively lists units following the
1068 <varname>Requires=
</varname>,
1069 <varname>Requisite=
</varname>,
1070 <varname>ConsistsOf=
</varname>,
1071 <varname>Wants=
</varname>,
<varname>BindsTo=
</varname>
1072 dependencies. If no unit is specified,
1073 <filename>default.target
</filename> is implied.
</para>
1075 <para>By default, only target units are recursively
1076 expanded. When
<option>--all
</option> is passed, all other
1077 units are recursively expanded as well.
</para>
1079 <para>Options
<option>--reverse
</option>,
1080 <option>--after
</option>,
<option>--before
</option>
1081 may be used to change what types of dependencies
1089 <title>Unit File Commands
</title>
1093 <term><command>list-unit-files
<optional><replaceable>PATTERN…
</replaceable></optional></command></term>
1096 <para>List unit files installed on the system, in combination with their enablement state (as reported by
1097 <command>is-enabled
</command>). If one or more
<replaceable>PATTERN
</replaceable>s are specified, only unit
1098 files whose name matches one of them are shown (patterns matching unit file system paths are not
1104 <term><command>enable
<replaceable>NAME
</replaceable>…
</command></term>
1105 <term><command>enable
<replaceable>PATH
</replaceable>…
</command></term>
1108 <para>Enable one or more units or unit instances. This will create a set of symlinks, as encoded in the
1109 <literal>[Install]
</literal> sections of the indicated unit files. After the symlinks have been created,
1110 the system manager configuration is reloaded (in a way equivalent to
<command>daemon-reload
</command>), in
1111 order to ensure the changes are taken into account immediately. Note that this does
1112 <emphasis>not
</emphasis> have the effect of also starting any of the units being enabled. If this is
1113 desired, combine this command with the
<option>--now
</option> switch, or invoke
<command>start
</command>
1114 with appropriate arguments later. Note that in case of unit instance enablement (i.e. enablement of units of
1115 the form
<filename>foo@bar.service
</filename>), symlinks named the same as instances are created in the
1116 unit configuration directory, however they point to the single template unit file they are instantiated
1119 <para>This command expects either valid unit names (in which case various unit file directories are
1120 automatically searched for unit files with appropriate names), or absolute paths to unit files (in which
1121 case these files are read directly). If a specified unit file is located outside of the usual unit file
1122 directories, an additional symlink is created, linking it into the unit configuration path, thus ensuring
1123 it is found when requested by commands such as
<command>start
</command>.
</para>
1125 <para>This command will print the file system operations executed. This output may be suppressed by passing
1126 <option>--quiet
</option>.
1129 <para>Note that this operation creates only the symlinks suggested in the
<literal>[Install]
</literal>
1130 section of the unit files. While this command is the recommended way to manipulate the unit configuration
1131 directory, the administrator is free to make additional changes manually by placing or removing symlinks
1132 below this directory. This is particularly useful to create configurations that deviate from the suggested
1133 default installation. In this case, the administrator must make sure to invoke
1134 <command>daemon-reload
</command> manually as necessary, in order to ensure the changes are taken into
1138 <para>Enabling units should not be confused with starting (activating) units, as done by the
1139 <command>start
</command> command. Enabling and starting units is orthogonal: units may be enabled without
1140 being started and started without being enabled. Enabling simply hooks the unit into various suggested
1141 places (for example, so that the unit is automatically started on boot or when a particular kind of
1142 hardware is plugged in). Starting actually spawns the daemon process (in case of service units), or binds
1143 the socket (in case of socket units), and so on.
</para>
1145 <para>Depending on whether
<option>--system
</option>,
<option>--user
</option>,
<option>--runtime
</option>,
1146 or
<option>--global
</option> is specified, this enables the unit for the system, for the calling user only,
1147 for only this boot of the system, or for all future logins of all users. Note that in the last case, no
1148 systemd daemon configuration is reloaded.
</para>
1150 <para>Using
<command>enable
</command> on masked units is not supported and results in an error.
</para>
1155 <term><command>disable
<replaceable>NAME
</replaceable>…
</command></term>
1158 <para>Disables one or more units. This removes all symlinks to the unit files backing the specified units
1159 from the unit configuration directory, and hence undoes any changes made by
<command>enable
</command> or
1160 <command>link
</command>. Note that this removes
<emphasis>all
</emphasis> symlinks to matching unit files,
1161 including manually created symlinks, and not just those actually created by
<command>enable
</command> or
1162 <command>link
</command>. Note that while
<command>disable
</command> undoes the effect of
1163 <command>enable
</command>, the two commands are otherwise not symmetric, as
<command>disable
</command> may
1164 remove more symlinks than a prior
<command>enable
</command> invocation of the same unit created.
</para>
1166 <para>This command expects valid unit names only, it does not accept paths to unit files.
</para>
1168 <para>In addition to the units specified as arguments, all units are disabled that are listed in the
1169 <varname>Also=
</varname> setting contained in the
<literal>[Install]
</literal> section of any of the unit
1170 files being operated on.
</para>
1172 <para>This command implicitly reloads the system manager configuration after completing the operation. Note
1173 that this command does not implicitly stop the units that are being disabled. If this is desired, either
1174 combine this command with the
<option>--now
</option> switch, or invoke the
<command>stop
</command> command
1175 with appropriate arguments later.
</para>
1177 <para>This command will print information about the file system operations (symlink removals)
1178 executed. This output may be suppressed by passing
<option>--quiet
</option>.
1181 <para>This command honors
<option>--system
</option>,
<option>--user
</option>,
<option>--runtime
</option>
1182 and
<option>--global
</option> in a similar way as
<command>enable
</command>.
</para>
1187 <term><command>reenable
<replaceable>NAME
</replaceable>…
</command></term>
1190 <para>Reenable one or more units, as specified on the command line. This is a combination of
1191 <command>disable
</command> and
<command>enable
</command> and is useful to reset the symlinks a unit file is
1192 enabled with to the defaults configured in its
<literal>[Install]
</literal> section. This command expects
1193 a unit name only, it does not accept paths to unit files.
</para>
1198 <term><command>preset
<replaceable>NAME
</replaceable>…
</command></term>
1201 <para>Reset the enable/disable status one or more unit files, as specified on
1202 the command line, to the defaults configured in the preset policy files. This
1203 has the same effect as
<command>disable
</command> or
1204 <command>enable
</command>, depending how the unit is listed in the preset
1207 <para>Use
<option>--preset-mode=
</option> to control whether units shall be
1208 enabled and disabled, or only enabled, or only disabled.
</para>
1210 <para>If the unit carries no install information, it will be silently ignored
1211 by this command.
<replaceable>NAME
</replaceable> must be the real unit name,
1212 any alias names are ignored silently.
</para>
1214 <para>For more information on the preset policy format, see
1215 <citerefentry><refentrytitle>systemd.preset
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1216 For more information on the concept of presets, please consult the
1217 <ulink url=
"https://www.freedesktop.org/wiki/Software/systemd/Preset">Preset
</ulink>
1223 <term><command>preset-all
</command></term>
1226 <para>Resets all installed unit files to the defaults
1227 configured in the preset policy file (see above).
</para>
1229 <para>Use
<option>--preset-mode=
</option> to control
1230 whether units shall be enabled and disabled, or only
1231 enabled, or only disabled.
</para>
1236 <term><command>is-enabled
<replaceable>NAME
</replaceable>…
</command></term>
1239 <para>Checks whether any of the specified unit files are
1240 enabled (as with
<command>enable
</command>). Returns an
1241 exit code of
0 if at least one is enabled, non-zero
1242 otherwise. Prints the current enable status (see table).
1243 To suppress this output, use
<option>--quiet
</option>.
1244 To show installation targets, use
<option>--full
</option>.
1249 <command>is-enabled
</command> output
1256 <entry>Description
</entry>
1257 <entry>Exit Code
</entry>
1262 <entry><literal>enabled
</literal></entry>
1263 <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>
1264 <entry morerows='
1'
>0</entry>
1267 <entry><literal>enabled-runtime
</literal></entry>
1270 <entry><literal>linked
</literal></entry>
1271 <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>
1272 <entry morerows='
1'
>> 0</entry>
1275 <entry><literal>linked-runtime
</literal></entry>
1278 <entry><literal>masked
</literal></entry>
1279 <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>
1280 <entry morerows='
1'
>> 0</entry>
1283 <entry><literal>masked-runtime
</literal></entry>
1286 <entry><literal>static
</literal></entry>
1287 <entry>The unit file is not enabled, and has no provisions for enabling in the
<literal>[Install]
</literal> unit file section.
</entry>
1291 <entry><literal>indirect
</literal></entry>
1292 <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>
1296 <entry><literal>disabled
</literal></entry>
1297 <entry>The unit file is not enabled, but contains an
<literal>[Install]
</literal> section with installation instructions.
</entry>
1298 <entry>> 0</entry>
1301 <entry><literal>generated
</literal></entry>
1302 <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>
1306 <entry><literal>transient
</literal></entry>
1307 <entry>The unit file has been created dynamically with the runtime API. Transient units may not be enabled.
</entry>
1311 <entry><literal>bad
</literal></entry>
1312 <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>
1313 <entry>> 0</entry>
1323 <term><command>mask
<replaceable>NAME
</replaceable>…
</command></term>
1326 <para>Mask one or more units, as specified on the command line. This will link these unit files to
1327 <filename>/dev/null
</filename>, making it impossible to start them. This is a stronger version of
1328 <command>disable
</command>, since it prohibits all kinds of activation of the unit, including enablement
1329 and manual activation. Use this option with care. This honors the
<option>--runtime
</option> option to only
1330 mask temporarily until the next reboot of the system. The
<option>--now
</option> option may be used to
1331 ensure that the units are also stopped. This command expects valid unit names only, it does not accept unit
1337 <term><command>unmask
<replaceable>NAME
</replaceable>…
</command></term>
1340 <para>Unmask one or more unit files, as specified on the command line. This will undo the effect of
1341 <command>mask
</command>. This command expects valid unit names only, it does not accept unit file
1347 <term><command>link
<replaceable>PATH
</replaceable>…
</command></term>
1350 <para>Link a unit file that is not in the unit file search paths into the unit file search path. This
1351 command expects an absolute path to a unit file. The effect of this may be undone with
1352 <command>disable
</command>. The effect of this command is that a unit file is made available for commands
1353 such as
<command>start
</command>, even though it is not installed directly in the unit search path.
</para>
1358 <term><command>revert
<replaceable>NAME
</replaceable>…
</command></term>
1361 <para>Revert one or more unit files to their vendor versions. This command removes drop-in configuration
1362 files that modify the specified units, as well as any user-configured unit file that overrides a matching
1363 vendor supplied unit file. Specifically, for a unit
<literal>foo.service
</literal> the matching directories
1364 <literal>foo.service.d/
</literal> with all their contained files are removed, both below the persistent and
1365 runtime configuration directories (i.e. below
<filename>/etc/systemd/system
</filename> and
1366 <filename>/run/systemd/system
</filename>); if the unit file has a vendor-supplied version (i.e. a unit file
1367 located below
<filename>/usr
</filename>) any matching persistent or runtime unit file that overrides it is
1368 removed, too. Note that if a unit file has no vendor-supplied version (i.e. is only defined below
1369 <filename>/etc/systemd/system
</filename> or
<filename>/run/systemd/system
</filename>, but not in a unit
1370 file stored below
<filename>/usr
</filename>), then it is not removed. Also, if a unit is masked, it is
1373 <para>Effectively, this command may be used to undo all changes made with
<command>systemctl
1374 edit
</command>,
<command>systemctl set-property
</command> and
<command>systemctl mask
</command> and puts
1375 the original unit file with its settings back in effect.
</para>
1380 <term><command>add-wants
<replaceable>TARGET
</replaceable>
1381 <replaceable>NAME
</replaceable>…
</command></term>
1382 <term><command>add-requires
<replaceable>TARGET
</replaceable>
1383 <replaceable>NAME
</replaceable>…
</command></term>
1386 <para>Adds
<literal>Wants=
</literal> or
<literal>Requires=
</literal>
1387 dependencies, respectively, to the specified
1388 <replaceable>TARGET
</replaceable> for one or more units.
</para>
1390 <para>This command honors
<option>--system
</option>,
1391 <option>--user
</option>,
<option>--runtime
</option> and
1392 <option>--global
</option> in a way similar to
1393 <command>enable
</command>.
</para>
1399 <term><command>edit
<replaceable>NAME
</replaceable>…
</command></term>
1402 <para>Edit a drop-in snippet or a whole replacement file if
1403 <option>--full
</option> is specified, to extend or override the
1404 specified unit.
</para>
1406 <para>Depending on whether
<option>--system
</option> (the default),
1407 <option>--user
</option>, or
<option>--global
</option> is specified,
1408 this command creates a drop-in file for each unit either for the system,
1409 for the calling user, or for all futures logins of all users. Then,
1410 the editor (see the
"Environment" section below) is invoked on
1411 temporary files which will be written to the real location if the
1412 editor exits successfully.
</para>
1414 <para>If
<option>--full
</option> is specified, this will copy the
1415 original units instead of creating drop-in files.
</para>
1417 <para>If
<option>--force
</option> is specified and any units do
1418 not already exist, new unit files will be opened for editing.
</para>
1420 <para>If
<option>--runtime
</option> is specified, the changes will
1421 be made temporarily in
<filename>/run
</filename> and they will be
1422 lost on the next reboot.
</para>
1424 <para>If the temporary file is empty upon exit, the modification of
1425 the related unit is canceled.
</para>
1427 <para>After the units have been edited, systemd configuration is
1428 reloaded (in a way that is equivalent to
<command>daemon-reload
</command>).
1431 <para>Note that this command cannot be used to remotely edit units
1432 and that you cannot temporarily edit units which are in
1433 <filename>/etc
</filename>, since they take precedence over
1434 <filename>/run
</filename>.
</para>
1439 <term><command>get-default
</command></term>
1442 <para>Return the default target to boot into. This returns
1443 the target unit name
<filename>default.target
</filename>
1444 is aliased (symlinked) to.
</para>
1449 <term><command>set-default
<replaceable>NAME
</replaceable></command></term>
1452 <para>Set the default target to boot into. This sets
1453 (symlinks) the
<filename>default.target
</filename> alias
1454 to the given target unit.
</para>
1462 <title>Machine Commands
</title>
1466 <term><command>list-machines
<optional><replaceable>PATTERN
</replaceable>…
</optional></command></term>
1469 <para>List the host and all running local containers with
1470 their state. If one or more
1471 <replaceable>PATTERN
</replaceable>s are specified, only
1472 containers matching one of them are shown.
1480 <title>Job Commands
</title>
1484 <term><command>list-jobs
<optional><replaceable>PATTERN…
</replaceable></optional></command></term>
1487 <para>List jobs that are in progress. If one or more
1488 <replaceable>PATTERN
</replaceable>s are specified, only
1489 jobs for units matching one of them are shown.
</para>
1491 <para>When combined with
<option>--after
</option> or
<option>--before
</option> the list is augmented with
1492 information on which other job each job is waiting for, and which other jobs are waiting for it, see
1497 <term><command>cancel
<replaceable>JOB
</replaceable>…
</command></term>
1500 <para>Cancel one or more jobs specified on the command line
1501 by their numeric job IDs. If no job ID is specified, cancel
1502 all pending jobs.
</para>
1509 <title>Environment Commands
</title>
1513 <term><command>show-environment
</command></term>
1516 <para>Dump the systemd manager environment block. This is the environment
1517 block that is passed to all processes the manager spawns. The environment
1518 block will be dumped in straight-forward form suitable for sourcing into
1519 most shells. If no special characters or whitespace is present in the variable
1520 values, no escaping is performed, and the assignments have the form
1521 <literal>VARIABLE=value
</literal>. If whitespace or characters which have
1522 special meaning to the shell are present, dollar-single-quote escaping is
1523 used, and assignments have the form
<literal>VARIABLE=$'value'
</literal>.
1524 This syntax is known to be supported by
1525 <citerefentry project='die-net'
><refentrytitle>bash
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1526 <citerefentry project='die-net'
><refentrytitle>zsh
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1527 <citerefentry project='die-net'
><refentrytitle>ksh
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1529 <citerefentry project='die-net'
><refentrytitle>busybox
</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
1530 <citerefentry project='die-net'
><refentrytitle>ash
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1532 <citerefentry project='die-net'
><refentrytitle>dash
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
1534 <citerefentry project='die-net'
><refentrytitle>fish
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
1539 <term><command>set-environment
<replaceable>VARIABLE=VALUE
</replaceable>…
</command></term>
1542 <para>Set one or more systemd manager environment variables,
1543 as specified on the command line.
</para>
1547 <term><command>unset-environment
<replaceable>VARIABLE
</replaceable>…
</command></term>
1550 <para>Unset one or more systemd manager environment
1551 variables. If only a variable name is specified, it will be
1552 removed regardless of its value. If a variable and a value
1553 are specified, the variable is only removed if it has the
1554 specified value.
</para>
1559 <command>import-environment
</command>
1560 <optional><replaceable>VARIABLE…
</replaceable></optional>
1564 <para>Import all, one or more environment variables set on
1565 the client into the systemd manager environment block. If
1566 no arguments are passed, the entire environment block is
1567 imported. Otherwise, a list of one or more environment
1568 variable names should be passed, whose client-side values
1569 are then imported into the manager's environment
1577 <title>Manager Lifecycle Commands
</title>
1581 <term><command>daemon-reload
</command></term>
1584 <para>Reload the systemd manager configuration. This will
1585 rerun all generators (see
1586 <citerefentry><refentrytitle>systemd.generator
</refentrytitle><manvolnum>7</manvolnum></citerefentry>),
1587 reload all unit files, and recreate the entire dependency
1588 tree. While the daemon is being reloaded, all sockets
1589 systemd listens on behalf of user configuration will stay
1592 <para>This command should not be confused with the
1593 <command>reload
</command> command.
</para>
1597 <term><command>daemon-reexec
</command></term>
1600 <para>Reexecute the systemd manager. This will serialize the
1601 manager state, reexecute the process and deserialize the
1602 state again. This command is of little use except for
1603 debugging and package upgrades. Sometimes, it might be
1604 helpful as a heavy-weight
<command>daemon-reload
</command>.
1605 While the daemon is being reexecuted, all sockets systemd listening
1606 on behalf of user configuration will stay accessible.
1614 <title>System Commands
</title>
1618 <term><command>is-system-running
</command></term>
1621 <para>Checks whether the system is operational. This
1622 returns success (exit code
0) when the system is fully up
1623 and running, specifically not in startup, shutdown or
1624 maintenance mode, and with no failed services. Failure is
1625 returned otherwise (exit code non-zero). In addition, the
1626 current state is printed in a short string to standard
1627 output, see the table below. Use
<option>--quiet
</option> to
1628 suppress this output.
</para>
1631 <title><command>is-system-running
</command> output
</title>
1633 <colspec colname='name'
/>
1634 <colspec colname='description'
/>
1635 <colspec colname='exit-code'
/>
1639 <entry>Description
</entry>
1640 <entry>Exit Code
</entry>
1645 <entry><varname>initializing
</varname></entry>
1646 <entry><para>Early bootup, before
1647 <filename>basic.target
</filename> is reached
1648 or the
<varname>maintenance
</varname> state entered.
1650 <entry>> 0</entry>
1653 <entry><varname>starting
</varname></entry>
1654 <entry><para>Late bootup, before the job queue
1655 becomes idle for the first time, or one of the
1656 rescue targets are reached.
</para></entry>
1657 <entry>> 0</entry>
1660 <entry><varname>running
</varname></entry>
1661 <entry><para>The system is fully
1662 operational.
</para></entry>
1666 <entry><varname>degraded
</varname></entry>
1667 <entry><para>The system is operational but one or more
1668 units failed.
</para></entry>
1669 <entry>> 0</entry>
1672 <entry><varname>maintenance
</varname></entry>
1673 <entry><para>The rescue or emergency target is
1674 active.
</para></entry>
1675 <entry>> 0</entry>
1678 <entry><varname>stopping
</varname></entry>
1679 <entry><para>The manager is shutting
1680 down.
</para></entry>
1681 <entry>> 0</entry>
1684 <entry><varname>offline
</varname></entry>
1685 <entry><para>The manager is not
1686 running. Specifically, this is the operational
1687 state if an incompatible program is running as
1688 system manager (PID
1).
</para></entry>
1689 <entry>> 0</entry>
1692 <entry><varname>unknown
</varname></entry>
1693 <entry><para>The operational state could not be
1694 determined, due to lack of resources or another
1695 error cause.
</para></entry>
1696 <entry>> 0</entry>
1705 <term><command>default
</command></term>
1708 <para>Enter default mode. This is equivalent to
<command>systemctl isolate default.target
</command>. This
1709 operation is blocking by default, use
<option>--no-block
</option> to request asynchronous behavior.
</para>
1714 <term><command>rescue
</command></term>
1717 <para>Enter rescue mode. This is equivalent to
<command>systemctl isolate rescue.target
</command>. This
1718 operation is blocking by default, use
<option>--no-block
</option> to request asynchronous behavior.
</para>
1722 <term><command>emergency
</command></term>
1725 <para>Enter emergency mode. This is equivalent to
<command>systemctl isolate
1726 emergency.target
</command>. This operation is blocking by default, use
<option>--no-block
</option> to
1727 request asynchronous behavior.
</para>
1731 <term><command>halt
</command></term>
1734 <para>Shut down and halt the system. This is mostly equivalent to
<command>systemctl start halt.target
1735 --job-mode=replace-irreversibly --no-block
</command>, but also prints a wall message to all users. This command is
1736 asynchronous; it will return after the halt operation is enqueued, without waiting for it to complete. Note
1737 that this operation will simply halt the OS kernel after shutting down, leaving the hardware powered
1738 on. Use
<command>systemctl poweroff
</command> for powering off the system (see below).
</para>
1740 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1741 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1742 system halt. If
<option>--force
</option> is specified twice, the operation is immediately executed without
1743 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1744 <option>--force
</option> is specified twice the halt operation is executed by
<command>systemctl
</command>
1745 itself, and the system manager is not contacted. This means the command should succeed even when the system
1746 manager has crashed.
</para>
1750 <term><command>poweroff
</command></term>
1753 <para>Shut down and power-off the system. This is mostly equivalent to
<command>systemctl start
1754 poweroff.target --job-mode=replace-irreversibly --no-block
</command>, but also prints a wall message to all
1755 users. This command is asynchronous; it will return after the power-off operation is enqueued, without
1756 waiting for it to complete.
</para>
1758 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1759 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1760 powering off. If
<option>--force
</option> is specified twice, the operation is immediately executed without
1761 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1762 <option>--force
</option> is specified twice the power-off operation is executed by
1763 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
1764 succeed even when the system manager has crashed.
</para>
1768 <term><command>reboot
<optional><replaceable>arg
</replaceable></optional></command></term>
1771 <para>Shut down and reboot the system. This is mostly equivalent to
<command>systemctl start reboot.target
1772 --job-mode=replace-irreversibly --no-block
</command>, but also prints a wall message to all users. This
1773 command is asynchronous; it will return after the reboot operation is enqueued, without waiting for it to
1776 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1777 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1778 reboot. If
<option>--force
</option> is specified twice, the operation is immediately executed without
1779 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1780 <option>--force
</option> is specified twice the reboot operation is executed by
1781 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
1782 succeed even when the system manager has crashed.
</para>
1784 <para>If the optional argument
<replaceable>arg
</replaceable> is given, it will be passed as the optional
1785 argument to the
<citerefentry><refentrytitle>reboot
</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1786 system call. The value is architecture and firmware specific. As an example,
<literal>recovery
</literal>
1787 might be used to trigger system recovery, and
<literal>fota
</literal> might be used to trigger a
1788 <quote>firmware over the air
</quote> update.
</para>
1793 <term><command>kexec
</command></term>
1796 <para>Shut down and reboot the system via
<command>kexec
</command>. This is equivalent to
1797 <command>systemctl start kexec.target --job-mode=replace-irreversibly --no-block
</command>. This command is
1798 asynchronous; it will return after the reboot operation is enqueued, without waiting for it to
1801 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1802 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1808 <term><command>exit
<optional><replaceable>EXIT_CODE
</replaceable></optional></command></term>
1811 <para>Ask the service manager to quit. This is only supported for user service managers (i.e. in
1812 conjunction with the
<option>--user
</option> option) or in containers and is equivalent to
1813 <command>poweroff
</command> otherwise. This command is asynchronous; it will return after the exit
1814 operation is enqueued, without waiting for it to complete.
</para>
1816 <para>The service manager will exit with the specified exit code, if
1817 <replaceable>EXIT_CODE
</replaceable> is passed.
</para>
1822 <term><command>switch-root
<replaceable>ROOT
</replaceable> <optional><replaceable>INIT
</replaceable></optional></command></term>
1825 <para>Switches to a different root directory and executes a new system manager process below it. This is
1826 intended for usage in initial RAM disks (
"initrd"), and will transition from the initrd's system manager
1827 process (a.k.a.
"init" process) to the main system manager process which is loaded from the actual host
1828 volume. This call takes two arguments: the directory that is to become the new root directory, and the path
1829 to the new system manager binary below it to execute as PID
1. If the latter is omitted or the empty
1830 string, a systemd binary will automatically be searched for and used as init. If the system manager path is
1831 omitted, equal to the empty string or identical to the path to the systemd binary, the state of the
1832 initrd's system manager process is passed to the main system manager, which allows later introspection of
1833 the state of the services involved in the initrd boot phase.
</para>
1838 <term><command>suspend
</command></term>
1841 <para>Suspend the system. This will trigger activation of the special target unit
1842 <filename>suspend.target
</filename>. This command is asynchronous, and will return after the suspend
1843 operation is successfully enqueued. It will not wait for the suspend/resume cycle to complete.
</para>
1848 <term><command>hibernate
</command></term>
1851 <para>Hibernate the system. This will trigger activation of the special target unit
1852 <filename>hibernate.target
</filename>. This command is asynchronous, and will return after the hibernation
1853 operation is successfully enqueued. It will not wait for the hibernate/thaw cycle to complete.
</para>
1858 <term><command>hybrid-sleep
</command></term>
1861 <para>Hibernate and suspend the system. This will trigger activation of the special target unit
1862 <filename>hybrid-sleep.target
</filename>. This command is asynchronous, and will return after the hybrid
1863 sleep operation is successfully enqueued. It will not wait for the sleep/wake-up cycle to complete.
</para>
1870 <title>Parameter Syntax
</title>
1872 <para>Unit commands listed above take either a single unit name (designated as
<replaceable>NAME
</replaceable>),
1873 or multiple unit specifications (designated as
<replaceable>PATTERN
</replaceable>…). In the first case, the
1874 unit name with or without a suffix must be given. If the suffix is not specified (unit name is
"abbreviated"),
1875 systemctl will append a suitable suffix,
<literal>.service
</literal> by default, and a type-specific suffix in
1876 case of commands which operate only on specific unit types. For example,
1877 <programlisting># systemctl start sshd
</programlisting> and
1878 <programlisting># systemctl start sshd.service
</programlisting>
1879 are equivalent, as are
1880 <programlisting># systemctl isolate default
</programlisting>
1882 <programlisting># systemctl isolate default.target
</programlisting>
1883 Note that (absolute) paths to device nodes are automatically converted to device unit names, and other (absolute)
1884 paths to mount unit names.
1885 <programlisting># systemctl status /dev/sda
1886 # systemctl status /home
</programlisting>
1888 <programlisting># systemctl status dev-sda.device
1889 # systemctl status home.mount
</programlisting>
1890 In the second case, shell-style globs will be matched against the primary names of all units currently in memory;
1891 literal unit names, with or without a suffix, will be treated as in the first case. This means that literal unit
1892 names always refer to exactly one unit, but globs may match zero units and this is not considered an
1895 <para>Glob patterns use
1896 <citerefentry project='man-pages'
><refentrytitle>fnmatch
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
1897 so normal shell-style globbing rules are used, and
1898 <literal>*
</literal>,
<literal>?
</literal>,
1899 <literal>[]
</literal> may be used. See
1900 <citerefentry project='man-pages'
><refentrytitle>glob
</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1901 for more details. The patterns are matched against the primary names of
1902 units currently in memory, and patterns which do not match anything
1903 are silently skipped. For example:
1904 <programlisting># systemctl stop sshd@*.service
</programlisting>
1905 will stop all
<filename>sshd@.service
</filename> instances. Note that alias names of units, and units that aren't
1906 in memory are not considered for glob expansion.
1909 <para>For unit file commands, the specified
<replaceable>NAME
</replaceable> should be the name of the unit file
1910 (possibly abbreviated, see above), or the absolute path to the unit file:
1911 <programlisting># systemctl enable foo.service
</programlisting>
1913 <programlisting># systemctl link /path/to/foo.service
</programlisting>
1920 <title>Exit status
</title>
1922 <para>On success,
0 is returned, a non-zero failure
1923 code otherwise.
</para>
1927 <title>Environment
</title>
1929 <variablelist class='environment-variables'
>
1931 <term><varname>$SYSTEMD_EDITOR
</varname></term>
1933 <listitem><para>Editor to use when editing units; overrides
1934 <varname>$EDITOR
</varname> and
<varname>$VISUAL
</varname>. If neither
1935 <varname>$SYSTEMD_EDITOR
</varname> nor
<varname>$EDITOR
</varname> nor
1936 <varname>$VISUAL
</varname> are present or if it is set to an empty
1937 string or if their execution failed, systemctl will try to execute well
1938 known editors in this order:
1939 <citerefentry project='die-net'
><refentrytitle>editor
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1940 <citerefentry project='die-net'
><refentrytitle>nano
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1941 <citerefentry project='die-net'
><refentrytitle>vim
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1942 <citerefentry project='die-net'
><refentrytitle>vi
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
1946 <xi:include href=
"less-variables.xml" xpointer=
"pager"/>
1947 <xi:include href=
"less-variables.xml" xpointer=
"less"/>
1948 <xi:include href=
"less-variables.xml" xpointer=
"lesscharset"/>
1952 <title>See Also
</title>
1954 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1955 <citerefentry><refentrytitle>journalctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1956 <citerefentry><refentrytitle>loginctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1957 <citerefentry><refentrytitle>machinectl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1958 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1959 <citerefentry><refentrytitle>systemd.resource-control
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1960 <citerefentry><refentrytitle>systemd.special
</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1961 <citerefentry project='man-pages'
><refentrytitle>wall
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1962 <citerefentry><refentrytitle>systemd.preset
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1963 <citerefentry><refentrytitle>systemd.generator
</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1964 <citerefentry project='man-pages'
><refentrytitle>glob
</refentrytitle><manvolnum>7</manvolnum></citerefentry>
projects / thirdparty / systemd.git / blob