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
16 <refentry id=
"systemctl"
17 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
20 <title>systemctl
</title>
21 <productname>systemd
</productname>
25 <contrib>Developer
</contrib>
26 <firstname>Lennart
</firstname>
27 <surname>Poettering
</surname>
28 <email>lennart@poettering.net
</email>
34 <refentrytitle>systemctl
</refentrytitle>
35 <manvolnum>1</manvolnum>
39 <refname>systemctl
</refname>
40 <refpurpose>Control the systemd system and service manager
</refpurpose>
45 <command>systemctl
</command>
46 <arg choice=
"opt" rep=
"repeat">OPTIONS
</arg>
47 <arg choice=
"plain">COMMAND
</arg>
48 <arg choice=
"opt" rep=
"repeat">UNIT
</arg>
53 <title>Description
</title>
55 <para><command>systemctl
</command> may be used to introspect and
56 control the state of the
<literal>systemd
</literal> system and
57 service manager. Please refer to
58 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
59 for an introduction into the basic concepts and functionality this
64 <title>Options
</title>
66 <para>The following options are understood:
</para>
70 <term><option>-t
</option></term>
71 <term><option>--type=
</option></term>
74 <para>The argument should be a comma-separated list of unit
75 types such as
<option>service
</option> and
76 <option>socket
</option>.
79 <para>If one of the arguments is a unit type, when listing
80 units, limit display to certain unit types. Otherwise, units
81 of all types will be shown.
</para>
83 <para>As a special case, if one of the arguments is
84 <option>help
</option>, a list of allowed values will be
85 printed and the program will exit.
</para>
90 <term><option>--state=
</option></term>
93 <para>The argument should be a comma-separated list of unit
94 LOAD, SUB, or ACTIVE states. When listing units, show only
95 those in the specified states. Use
<option>--state=failed
</option>
96 to show only failed units.
</para>
98 <para>As a special case, if one of the arguments is
99 <option>help
</option>, a list of allowed values will be
100 printed and the program will exit.
</para>
105 <term><option>-p
</option></term>
106 <term><option>--property=
</option></term>
109 <para>When showing unit/job/manager properties with the
110 <command>show
</command> command, limit display to properties
111 specified in the argument. The argument should be a
112 comma-separated list of property names, such as
113 <literal>MainPID
</literal>. Unless specified, all known
114 properties are shown. If specified more than once, all
115 properties with the specified names are shown. Shell
116 completion is implemented for property names.
</para>
118 <para>For the manager itself,
119 <command>systemctl show
</command> will show all available
120 properties. Those properties are documented in
121 <citerefentry><refentrytitle>systemd-system.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
124 <para>Properties for units vary by unit type, so showing any
125 unit (even a non-existent one) is a way to list properties
126 pertaining to this type. Similarly, showing any job will list
127 properties pertaining to all jobs. Properties for units are
129 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
130 and the pages for individual unit types
131 <citerefentry><refentrytitle>systemd.service
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
132 <citerefentry><refentrytitle>systemd.socket
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
138 <term><option>-a
</option></term>
139 <term><option>--all
</option></term>
142 <para>When listing units with
<command>list-units
</command>, also show inactive units and
143 units which are following other units. When showing unit/job/manager properties, show all
144 properties regardless whether they are set or not.
</para>
146 <para>To list all units installed in the file system, use the
147 <command>list-unit-files
</command> command instead.
</para>
149 <para>When listing units with
<command>list-dependencies
</command>, recursively show
150 dependencies of all dependent units (by default only dependencies of target units are
156 <term><option>-r
</option></term>
157 <term><option>--recursive
</option></term>
160 <para>When listing units, also show units of local
161 containers. Units of local containers will be prefixed with
162 the container name, separated by a single colon character
163 (
<literal>:
</literal>).
</para>
168 <term><option>--reverse
</option></term>
171 <para>Show reverse dependencies between units with
172 <command>list-dependencies
</command>, i.e. follow
173 dependencies of type
<varname>WantedBy=
</varname>,
174 <varname>RequiredBy=
</varname>,
175 <varname>PartOf=
</varname>,
<varname>BoundBy=
</varname>,
176 instead of
<varname>Wants=
</varname> and similar.
182 <term><option>--after
</option></term>
185 <para>With
<command>list-dependencies
</command>, show the
186 units that are ordered before the specified unit. In other
187 words, recursively list units following the
188 <varname>After=
</varname> dependency.
</para>
190 <para>Note that any
<varname>After=
</varname> dependency is
191 automatically mirrored to create a
192 <varname>Before=
</varname> dependency. Temporal dependencies
193 may be specified explicitly, but are also created implicitly
194 for units which are
<varname>WantedBy=
</varname> targets
196 <citerefentry><refentrytitle>systemd.target
</refentrytitle><manvolnum>5</manvolnum></citerefentry>),
197 and as a result of other directives (for example
198 <varname>RequiresMountsFor=
</varname>). Both explicitly
199 and implicitly introduced dependencies are shown with
200 <command>list-dependencies
</command>.
</para>
202 <para>When passed to the
<command>list-jobs
</command> command, for each printed job show which other jobs are
203 waiting for it. May be combined with
<option>--before
</option> to show both the jobs waiting for each job as
204 well as all jobs each job is waiting for.
</para>
209 <term><option>--before
</option></term>
212 <para>With
<command>list-dependencies
</command>, show the
213 units that are ordered after the specified unit. In other
214 words, recursively list units following the
215 <varname>Before=
</varname> dependency.
</para>
217 <para>When passed to the
<command>list-jobs
</command> command, for each printed job show which other jobs it
218 is waiting for. May be combined with
<option>--after
</option> to show both the jobs waiting for each job as
219 well as all jobs each job is waiting for.
</para>
224 <term><option>-l
</option></term>
225 <term><option>--full
</option></term>
228 <para>Do not ellipsize unit names, process tree entries,
229 journal output, or truncate unit descriptions in the output
230 of
<command>status
</command>,
<command>list-units
</command>,
231 <command>list-jobs
</command>, and
232 <command>list-timers
</command>.
</para>
233 <para>Also, show installation targets in the output of
234 <command>is-enabled
</command>.
</para>
239 <term><option>--value
</option></term>
242 <para>When printing properties with
<command>show
</command>,
243 only print the value, and skip the property name and
244 <literal>=
</literal>.
</para>
249 <term><option>--show-types
</option></term>
252 <para>When showing sockets, show the type of the socket.
</para>
257 <term><option>--job-mode=
</option></term>
260 <para>When queuing a new job, this option controls how to deal with
261 already queued jobs. It takes one of
<literal>fail
</literal>,
262 <literal>replace
</literal>,
263 <literal>replace-irreversibly
</literal>,
264 <literal>isolate
</literal>,
265 <literal>ignore-dependencies
</literal>,
266 <literal>ignore-requirements
</literal> or
267 <literal>flush
</literal>. Defaults to
268 <literal>replace
</literal>, except when the
269 <command>isolate
</command> command is used which implies the
270 <literal>isolate
</literal> job mode.
</para>
272 <para>If
<literal>fail
</literal> is specified and a requested
273 operation conflicts with a pending job (more specifically:
274 causes an already pending start job to be reversed into a stop
275 job or vice versa), cause the operation to fail.
</para>
277 <para>If
<literal>replace
</literal> (the default) is
278 specified, any conflicting pending job will be replaced, as
281 <para>If
<literal>replace-irreversibly
</literal> is specified,
282 operate like
<literal>replace
</literal>, but also mark the new
283 jobs as irreversible. This prevents future conflicting
284 transactions from replacing these jobs (or even being enqueued
285 while the irreversible jobs are still pending). Irreversible
286 jobs can still be cancelled using the
<command>cancel
</command>
287 command. This job mode should be used on any transaction which
288 pulls in
<filename>shutdown.target
</filename>.
</para>
290 <para><literal>isolate
</literal> is only valid for start
291 operations and causes all other units to be stopped when the
292 specified unit is started. This mode is always used when the
293 <command>isolate
</command> command is used.
</para>
295 <para><literal>flush
</literal> will cause all queued jobs to
296 be canceled when the new job is enqueued.
</para>
298 <para>If
<literal>ignore-dependencies
</literal> is specified,
299 then all unit dependencies are ignored for this new job and
300 the operation is executed immediately. If passed, no required
301 units of the unit passed will be pulled in, and no ordering
302 dependencies will be honored. This is mostly a debugging and
303 rescue tool for the administrator and should not be used by
306 <para><literal>ignore-requirements
</literal> is similar to
307 <literal>ignore-dependencies
</literal>, but only causes the
308 requirement dependencies to be ignored, the ordering
309 dependencies will still be honored.
</para>
315 <term><option>--fail
</option></term>
318 <para>Shorthand for
<option>--job-mode=
</option>fail.
</para>
319 <para>When used with the
<command>kill
</command> command,
320 if no units were killed, the operation results in an error.
326 <term><option>-i
</option></term>
327 <term><option>--ignore-inhibitors
</option></term>
330 <para>When system shutdown or a sleep state is requested,
331 ignore inhibitor locks. Applications can establish inhibitor
332 locks to avoid that certain important operations (such as CD
333 burning or suchlike) are interrupted by system shutdown or a
334 sleep state. Any user may take these locks and privileged
335 users may override these locks. If any locks are taken,
336 shutdown and sleep state requests will normally fail
337 (regardless of whether privileged or not) and a list of active locks
338 is printed. However, if
<option>--ignore-inhibitors
</option>
339 is specified, the locks are ignored and not printed, and the
340 operation attempted anyway, possibly requiring additional
346 <term><option>--dry-run
</option></term>
349 <para>Just print what would be done. Currently supported by verbs
350 <command>halt
</command>,
<command>poweroff
</command>,
<command>reboot
</command>,
351 <command>kexec
</command>,
<command>suspend
</command>,
352 <command>hibernate
</command>,
<command>hybrid-sleep
</command>,
353 <command>default
</command>,
<command>rescue
</command>,
354 <command>emergency
</command>, and
<command>exit
</command>.
</para>
359 <term><option>-q
</option></term>
360 <term><option>--quiet
</option></term>
363 <para>Suppress printing of the results of various commands
364 and also the hints about truncated log lines. This does not
365 suppress output of commands for which the printed output is
366 the only result (like
<command>show
</command>). Errors are
367 always printed.
</para>
372 <term><option>--no-block
</option></term>
375 <para>Do not synchronously wait for the requested operation
376 to finish. If this is not specified, the job will be
377 verified, enqueued and
<command>systemctl
</command> will
378 wait until the unit's start-up is completed. By passing this
379 argument, it is only verified and enqueued. This option may not be
380 combined with
<option>--wait
</option>.
</para>
385 <term><option>--wait
</option></term>
388 <para>Synchronously wait for started units to terminate again.
389 This option may not be combined with
<option>--no-block
</option>.
390 Note that this will wait forever if any given unit never terminates
391 (by itself or by getting stopped explicitly); particularly services
392 which use
<literal>RemainAfterExit=yes
</literal>.
</para>
396 <xi:include href=
"user-system-options.xml" xpointer=
"user" />
397 <xi:include href=
"user-system-options.xml" xpointer=
"system" />
400 <term><option>--failed
</option></term>
403 <para>List units in failed state. This is equivalent to
404 <option>--state=failed
</option>.
</para>
409 <term><option>--no-wall
</option></term>
412 <para>Do not send wall message before halt, power-off and reboot.
</para>
417 <term><option>--global
</option></term>
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>
428 <term><option>--no-reload
</option></term>
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>
438 <term><option>--no-ask-password
</option></term>
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
458 <term><option>--kill-who=
</option></term>
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>
497 <term><option>-s
</option></term>
498 <term><option>--signal=
</option></term>
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>
510 <term><option>-f
</option></term>
511 <term><option>--force
</option></term>
514 <para>When used with
<command>enable
</command>, overwrite
515 any existing conflicting symlinks.
</para>
517 <para>When used with
<command>edit
</command>, create all of the
518 specified units which do not already exist.
</para>
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>
534 <term><option>--message=
</option></term>
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>
544 <term><option>--now
</option></term>
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>
556 <term><option>--root=
</option></term>
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>
570 <term><option>--runtime
</option></term>
573 <para>When used with
<command>set-property
</command>, make changes only
574 temporarily, so that they are lost on the next reboot.
</para>
576 <para>Similarily, when used with
<command>enable
</command>,
<command>mask
</command>,
577 <command>edit
</command> and related commands, make temporary changes, which are lost on
578 the next reboot. Changes are not made in subdirectories of
<filename>/etc
</filename>, but
579 in
<filename>/run
</filename>. The immediate effect is identical, however since the latter
580 is lost on reboot, the changes are lost too.
</para>
582 <para>Note: this option cannot be used with
<command>disable
</command>,
583 <command>unmask
</command>,
<command>preset
</command>, or
<command>preset-all
</command>,
584 because those operations sometimes need to remove symlinks under
<filename>/etc
</filename>
585 to have the desired effect, which would cause a persistent change.
</para>
590 <term><option>--preset-mode=
</option></term>
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>
604 <term><option>-n
</option></term>
605 <term><option>--lines=
</option></term>
608 <para>When used with
<command>status
</command>, controls the
609 number of journal lines to show, counting from the most
610 recent ones. Takes a positive integer argument. Defaults to
616 <term><option>-o
</option></term>
617 <term><option>--output=
</option></term>
620 <para>When used with
<command>status
</command>, controls the
621 formatting of the journal entries that are shown. For the
622 available choices, see
623 <citerefentry><refentrytitle>journalctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
624 Defaults to
<literal>short
</literal>.
</para>
629 <term><option>--firmware-setup
</option></term>
632 <para>When used with the
<command>reboot
</command> command,
633 indicate to the system's firmware to boot into setup
634 mode. Note that this is currently only supported on some EFI
635 systems and only if the system was booted in EFI
641 <term><option>--plain
</option></term>
644 <para>When used with
<command>list-dependencies
</command>,
645 <command>list-units
</command> or
<command>list-machines
</command>,
646 the output is printed as a list instead of a tree, and the bullet
647 circles are omitted.
</para>
651 <xi:include href=
"user-system-options.xml" xpointer=
"host" />
652 <xi:include href=
"user-system-options.xml" xpointer=
"machine" />
654 <xi:include href=
"standard-options.xml" xpointer=
"no-pager" />
655 <xi:include href=
"standard-options.xml" xpointer=
"no-legend" />
656 <xi:include href=
"standard-options.xml" xpointer=
"help" />
657 <xi:include href=
"standard-options.xml" xpointer=
"version" />
662 <title>Commands
</title>
664 <para>The following commands are understood:
</para>
667 <title>Unit Commands
</title>
671 <term><command>list-units
<optional><replaceable>PATTERN
</replaceable>…
</optional></command></term>
674 <para>List units that
<command>systemd
</command> currently has in memory. This includes units that are
675 either referenced directly or through a dependency, units that are pinned by applications programmatically,
676 or units that were active in the past and have failed. By default only units which are active, have pending
677 jobs, or have failed are shown; this can be changed with option
<option>--all
</option>. If one or more
678 <replaceable>PATTERN
</replaceable>s are specified, only units matching one of them are shown. The units
679 that are shown are additionally filtered by
<option>--type=
</option> and
<option>--state=
</option> if those
680 options are specified.
</para>
682 <para>Produces output similar to
683 <programlisting> UNIT LOAD ACTIVE SUB DESCRIPTION
684 sys-module-fuse.device loaded active plugged /sys/module/fuse
685 -.mount loaded active mounted Root Mount
686 boot-efi.mount loaded active mounted /boot/efi
687 systemd-journald.service loaded active running Journal Service
688 systemd-logind.service loaded active running Login Service
689 â—Ź user@
1000.service loaded active running User Manager for UID
1000
691 systemd-tmpfiles-clean.timer loaded active waiting Daily Cleanup of Temporary Directories
693 LOAD = Reflects whether the unit definition was properly loaded.
694 ACTIVE = The high-level unit activation state, i.e. generalization of SUB.
695 SUB = The low-level unit activation state, values depend on unit type.
697 123 loaded units listed. Pass --all to see loaded but inactive units, too.
698 To show all installed unit files use 'systemctl list-unit-files'.
700 The header and the last unit of a given type are underlined if the
701 terminal supports that. A colored dot is shown next to services which
702 were masked, not found, or otherwise failed.
</para>
704 <para>The LOAD column shows the load state, one of
<constant>loaded
</constant>,
705 <constant>not-found
</constant>,
<constant>bad-setting
</constant>,
<constant>error
</constant>,
706 <constant>masked
</constant>. The ACTIVE columns shows the general unit state, one of
707 <constant>active
</constant>,
<constant>reloading
</constant>,
<constant>inactive
</constant>,
708 <constant>failed
</constant>,
<constant>activating
</constant>,
<constant>deactivating
</constant>. The SUB
709 column shows the unit-type-specific detailed state of the unit, possible values vary by unit type. The list
710 of possible LOAD, ACTIVE, and SUB states is not constant and new systemd releases may both add and remove
711 values.
<programlisting>systemctl --state=help
</programlisting> command maybe be used to display the
712 current set of possible values.
</para>
714 <para>This is the default command.
</para>
719 <term><command>list-sockets
<optional><replaceable>PATTERN
</replaceable>…
</optional></command></term>
722 <para>List socket units currently in memory, ordered by listening address. If one or more
723 <replaceable>PATTERN
</replaceable>s are specified, only socket units matching one of them are
724 shown. Produces output similar to
726 LISTEN UNIT ACTIVATES
727 /dev/initctl systemd-initctl.socket systemd-initctl.service
729 [::]:
22 sshd.socket sshd.service
730 kobject-uevent
1 systemd-udevd-kernel.socket systemd-udevd.service
732 5 sockets listed.
</programlisting>
733 Note: because the addresses might contains spaces, this output
734 is not suitable for programmatic consumption.
737 <para>Also see
<option>--show-types
</option>,
<option>--all
</option>, and
<option>--state=
</option>.
</para>
742 <term><command>list-timers
<optional><replaceable>PATTERN
</replaceable>…
</optional></command></term>
745 <para>List timer units currently in memory, ordered by the time they elapse next. If one or more
746 <replaceable>PATTERN
</replaceable>s are specified, only units matching one of them are shown.
747 Produces output similar to
749 NEXT LEFT LAST PASSED UNIT ACTIVATES
750 n/a n/a Thu
2017-
02-
23 13:
40:
29 EST
3 days ago ureadahead-stop.timer ureadahead-stop.service
751 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
752 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
753 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
757 <para><emphasis>NEXT
</emphasis> shows the next time the timer will run.
</para>
758 <para><emphasis>LEFT
</emphasis> shows how long till the next time the timer runs.
</para>
759 <para><emphasis>LAST
</emphasis> shows the last time the timer ran.
</para>
760 <para><emphasis>PASSED
</emphasis> shows how long has passed since the timer last ran.
</para>
761 <para><emphasis>UNIT
</emphasis> shows the name of the timer
</para>
762 <para><emphasis>ACTIVATES
</emphasis> shows the name the service the timer activates when it runs.
</para>
764 <para>Also see
<option>--all
</option> and
<option>--state=
</option>.
</para>
769 <term><command>start
<replaceable>PATTERN
</replaceable>…
</command></term>
772 <para>Start (activate) one or more units specified on the
775 <para>Note that glob patterns operate on the set of primary names of units currently in memory. Units which
776 are not active and are not in a failed state usually are not in memory, and will not be matched by any
777 pattern. In addition, in case of instantiated units, systemd is often unaware of the instance name until
778 the instance has been started. Therefore, using glob patterns with
<command>start
</command> has limited
779 usefulness. Also, secondary alias names of units are not considered.
</para>
783 <term><command>stop
<replaceable>PATTERN
</replaceable>…
</command></term>
786 <para>Stop (deactivate) one or more units specified on the
791 <term><command>reload
<replaceable>PATTERN
</replaceable>…
</command></term>
794 <para>Asks all units listed on the command line to reload
795 their configuration. Note that this will reload the
796 service-specific configuration, not the unit configuration
797 file of systemd. If you want systemd to reload the
798 configuration file of a unit, use the
799 <command>daemon-reload
</command> command. In other words:
800 for the example case of Apache, this will reload Apache's
801 <filename>httpd.conf
</filename> in the web server, not the
802 <filename>apache.service
</filename> systemd unit
805 <para>This command should not be confused with the
806 <command>daemon-reload
</command> command.
</para>
811 <term><command>restart
<replaceable>PATTERN
</replaceable>…
</command></term>
814 <para>Stop and then start one or more units specified on the command line. If the units are not running
815 yet, they will be started.
</para>
817 <para>Note that restarting a unit with this command does not necessarily flush out all of the unit's
818 resources before it is started again. For example, the per-service file descriptor storage facility (see
819 <varname>FileDescriptoreStoreMax=
</varname> in
820 <citerefentry><refentrytitle>systemd.service
</refentrytitle><manvolnum>5</manvolnum></citerefentry>) will
821 remain intact as long as the unit has a job pending, and is only cleared when the unit is fully stopped and
822 no jobs are pending anymore. If it is intended that the file descriptor store is flushed out, too, during a
823 restart operation an explicit
<command>systemctl stop
</command> command followed by
<command>systemctl
824 start
</command> should be issued.
</para>
828 <term><command>try-restart
<replaceable>PATTERN
</replaceable>…
</command></term>
831 <para>Stop and then start one or more units specified on the
832 command line if the units are running. This does nothing
833 if units are not running.
</para>
834 <!-- Note that we don't document condrestart here, as that is just compatibility support, and we generally
835 don't document that. -->
839 <term><command>reload-or-restart
<replaceable>PATTERN
</replaceable>…
</command></term>
842 <para>Reload one or more units if they support it. If not, stop and then start them instead. If the units
843 are not running yet, they will be started.
</para>
847 <term><command>try-reload-or-restart
<replaceable>PATTERN
</replaceable>…
</command></term>
850 <para>Reload one or more units if they support it. If not, stop and then start them instead. This does
851 nothing if the units are not running.
</para>
852 <!-- Note that we don't document force-reload here, as that is just compatibility support, and we generally
853 don't document that. -->
857 <term><command>isolate
<replaceable>UNIT
</replaceable></command></term>
860 <para>Start the unit specified on the command line and its dependencies
861 and stop all others, unless they have
862 <option>IgnoreOnIsolate=yes
</option> (see
863 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
864 If a unit name with no extension is given, an extension of
865 <literal>.target
</literal> will be assumed.
</para>
867 <para>This is similar to changing the runlevel in a
868 traditional init system. The
<command>isolate
</command>
869 command will immediately stop processes that are not enabled
870 in the new unit, possibly including the graphical
871 environment or terminal you are currently using.
</para>
873 <para>Note that this is allowed only on units where
874 <option>AllowIsolate=
</option> is enabled. See
875 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
880 <term><command>kill
<replaceable>PATTERN
</replaceable>…
</command></term>
883 <para>Send a signal to one or more processes of the
884 unit. Use
<option>--kill-who=
</option> to select which
885 process to kill. Use
<option>--signal=
</option> to select
886 the signal to send.
</para>
890 <term><command>is-active
<replaceable>PATTERN
</replaceable>…
</command></term>
893 <para>Check whether any of the specified units are active
894 (i.e. running). Returns an exit code
895 <constant>0</constant> if at least one is active, or
896 non-zero otherwise. Unless
<option>--quiet
</option> is
897 specified, this will also print the current unit state to
898 standard output.
</para>
902 <term><command>is-failed
<replaceable>PATTERN
</replaceable>…
</command></term>
905 <para>Check whether any of the specified units are in a
906 "failed" state. Returns an exit code
907 <constant>0</constant> if at least one has failed,
908 non-zero otherwise. Unless
<option>--quiet
</option> is
909 specified, this will also print the current unit state to
910 standard output.
</para>
914 <term><command>status
</command> <optional><replaceable>PATTERN
</replaceable>…|
<replaceable>PID
</replaceable>…]
</optional></term>
917 <para>Show terse runtime status information about one or
918 more units, followed by most recent log data from the
919 journal. If no units are specified, show system status. If
920 combined with
<option>--all
</option>, also show the status of
921 all units (subject to limitations specified with
922 <option>-t
</option>). If a PID is passed, show information
923 about the unit the process belongs to.
</para>
925 <para>This function is intended to generate human-readable
926 output. If you are looking for computer-parsable output,
927 use
<command>show
</command> instead. By default, this
928 function only shows
10 lines of output and ellipsizes
929 lines to fit in the terminal window. This can be changed
930 with
<option>--lines
</option> and
<option>--full
</option>,
931 see above. In addition,
<command>journalctl
932 --unit=
<replaceable>NAME
</replaceable></command> or
934 --user-unit=
<replaceable>NAME
</replaceable></command> use
935 a similar filter for messages and might be more
939 <para>systemd implicitly loads units as necessary, so just running the
<command>status
</command> will
940 attempt to load a file. The command is thus not useful for determining if something was already loaded or
941 not. The units may possibly also be quickly unloaded after the operation is completed if there's no reason
942 to keep it in memory thereafter.
946 <title>Example output from systemctl status
</title>
948 <programlisting>$ systemctl status bluetooth
949 â—Ź bluetooth.service - Bluetooth service
950 Loaded: loaded (/usr/lib/systemd/system/bluetooth.service; enabled; vendor preset: enabled)
951 Active: active (running) since Wed
2017-
01-
04 13:
54:
04 EST;
1 weeks
0 days ago
952 Docs: man:bluetoothd(
8)
953 Main PID:
930 (bluetoothd)
958 CGroup: /system.slice/bluetooth.service
959 └─
930 /usr/lib/bluetooth/bluetoothd
961 Jan
12 10:
46:
45 example.com bluetoothd[
8900]: Not enough free handles to register service
962 Jan
12 10:
46:
45 example.com bluetoothd[
8900]: Current Time Service could not be registered
963 Jan
12 10:
46:
45 example.com bluetoothd[
8900]: gatt-time-server: Input/output error (
5)
966 <para>The dot (
"â—Ź") uses color on supported terminals to summarize the unit state at a glance. White
967 indicates an
<literal>inactive
</literal> or
<literal>deactivating
</literal> state. Red indicates a
968 <literal>failed
</literal> or
<literal>error
</literal> state and green indicates an
969 <literal>active
</literal>,
<literal>reloading
</literal> or
<literal>activating
</literal> state.
972 <para>The
"Loaded:" line in the output will show
<literal>loaded
</literal> if the unit has been loaded into
973 memory. Other possible values for
"Loaded:" include:
<literal>error
</literal> if there was a problem
974 loading it,
<literal>not-found
</literal> if not unit file was found for this unit,
975 <literal>bad-setting
</literal> if an essential unit file setting could not be parsed and
976 <literal>masked
</literal> if the unit file has been masked. Along with showing the path to the unit file,
977 this line will also show the enablement state. Enabled commands start at boot. See the full table of
978 possible enablement states — including the definition of
<literal>masked
</literal> — in the documentation
979 for the
<command>is-enabled
</command> command.
982 <para>The
"Active:" line shows active state. The value is usually
<literal>active
</literal> or
983 <literal>inactive
</literal>. Active could mean started, bound, plugged in, etc depending on the unit type.
984 The unit could also be in process of changing states, reporting a state of
<literal>activating
</literal> or
985 <literal>deactivating
</literal>. A special
<literal>failed
</literal> state is entered when the service
986 failed in some way, such as a crash, exiting with an error code or timing out. If the failed state is
987 entered the cause will be logged for later reference.
</para>
993 <term><command>show
</command> <optional><replaceable>PATTERN
</replaceable>…|
<replaceable>JOB
</replaceable>…
</optional></term>
996 <para>Show properties of one or more units, jobs, or the manager itself. If no argument is specified,
997 properties of the manager will be shown. If a unit name is specified, properties of the unit are shown, and
998 if a job ID is specified, properties of the job are shown. By default, empty properties are suppressed. Use
999 <option>--all
</option> to show those too. To select specific properties to show, use
1000 <option>--property=
</option>. This command is intended to be used whenever computer-parsable output is
1001 required. Use
<command>status
</command> if you are looking for formatted human-readable output.
</para>
1003 <para>Many properties shown by
<command>systemctl show
</command> map directly to configuration settings of
1004 the system and service manager and its unit files. Note that the properties shown by the command are
1005 generally more low-level, normalized versions of the original configuration settings and expose runtime
1006 state in addition to configuration. For example, properties shown for service units include the service's
1007 current main process identifier as
<literal>MainPID
</literal> (which is runtime state), and time settings
1008 are always exposed as properties ending in the
<literal>…USec
</literal> suffix even if a matching
1009 configuration options end in
<literal>…Sec
</literal>, because microseconds is the normalized time unit used
1010 by the system and service manager.
</para>
1014 <term><command>cat
<replaceable>PATTERN
</replaceable>…
</command></term>
1017 <para>Show backing files of one or more units. Prints the
1018 "fragment" and
"drop-ins" (source files) of units. Each
1019 file is preceded by a comment which includes the file
1020 name. Note that this shows the contents of the backing files
1021 on disk, which may not match the system manager's
1022 understanding of these units if any unit files were
1023 updated on disk and the
<command>daemon-reload
</command>
1024 command wasn't issued since.
</para>
1028 <term><command>set-property
<replaceable>UNIT
</replaceable> <replaceable>PROPERTY
</replaceable>=
<replaceable>VALUE
</replaceable>…
</command></term>
1031 <para>Set the specified unit properties at runtime where
1032 this is supported. This allows changing configuration
1033 parameter properties such as resource control settings at
1034 runtime. Not all properties may be changed at runtime, but
1035 many resource control settings (primarily those in
1036 <citerefentry><refentrytitle>systemd.resource-control
</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
1037 may. The changes are applied immediately, and stored on disk
1038 for future boots, unless
<option>--runtime
</option> is
1039 passed, in which case the settings only apply until the
1040 next reboot. The syntax of the property assignment follows
1041 closely the syntax of assignments in unit files.
</para>
1043 <para>Example:
<command>systemctl set-property foobar.service CPUShares=
777</command></para>
1045 <para>If the specified unit appears to be inactive, the
1046 changes will be only stored on disk as described
1047 previously hence they will be effective when the unit will
1050 <para>Note that this command allows changing multiple
1051 properties at the same time, which is preferable over
1052 setting them individually. Like with unit file configuration
1053 settings, assigning an empty list will reset the property.
1059 <term><command>help
<replaceable>PATTERN
</replaceable>…|
<replaceable>PID
</replaceable>…
</command></term>
1062 <para>Show manual pages for one or more units, if
1063 available. If a PID is given, the manual pages for the unit
1064 the process belongs to are shown.
</para>
1069 <term><command>reset-failed [
<replaceable>PATTERN
</replaceable>…]
</command></term>
1072 <para>Reset the
<literal>failed
</literal> state of the specified units, or if no unit name is passed, reset
1073 the state of all units. When a unit fails in some way (i.e. process exiting with non-zero error code,
1074 terminating abnormally or timing out), it will automatically enter the
<literal>failed
</literal> state and
1075 its exit code and status is recorded for introspection by the administrator until the service is
1076 stopped/re-started or reset with this command.
</para>
1082 <command>list-dependencies
</command>
1083 <optional><replaceable>UNIT
</replaceable></optional>
1087 <para>Shows units required and wanted by the specified
1088 unit. This recursively lists units following the
1089 <varname>Requires=
</varname>,
1090 <varname>Requisite=
</varname>,
1091 <varname>ConsistsOf=
</varname>,
1092 <varname>Wants=
</varname>,
<varname>BindsTo=
</varname>
1093 dependencies. If no unit is specified,
1094 <filename>default.target
</filename> is implied.
</para>
1096 <para>By default, only target units are recursively
1097 expanded. When
<option>--all
</option> is passed, all other
1098 units are recursively expanded as well.
</para>
1100 <para>Options
<option>--reverse
</option>,
1101 <option>--after
</option>,
<option>--before
</option>
1102 may be used to change what types of dependencies
1110 <title>Unit File Commands
</title>
1114 <term><command>list-unit-files
<optional><replaceable>PATTERN…
</replaceable></optional></command></term>
1117 <para>List unit files installed on the system, in combination with their enablement state (as reported by
1118 <command>is-enabled
</command>). If one or more
<replaceable>PATTERN
</replaceable>s are specified, only unit
1119 files whose name matches one of them are shown (patterns matching unit file system paths are not
1125 <term><command>enable
<replaceable>UNIT
</replaceable>…
</command></term>
1126 <term><command>enable
<replaceable>PATH
</replaceable>…
</command></term>
1129 <para>Enable one or more units or unit instances. This will create a set of symlinks, as encoded in the
1130 <literal>[Install]
</literal> sections of the indicated unit files. After the symlinks have been created,
1131 the system manager configuration is reloaded (in a way equivalent to
<command>daemon-reload
</command>), in
1132 order to ensure the changes are taken into account immediately. Note that this does
1133 <emphasis>not
</emphasis> have the effect of also starting any of the units being enabled. If this is
1134 desired, combine this command with the
<option>--now
</option> switch, or invoke
<command>start
</command>
1135 with appropriate arguments later. Note that in case of unit instance enablement (i.e. enablement of units of
1136 the form
<filename>foo@bar.service
</filename>), symlinks named the same as instances are created in the
1137 unit configuration directory, however they point to the single template unit file they are instantiated
1140 <para>This command expects either valid unit names (in which case various unit file directories are
1141 automatically searched for unit files with appropriate names), or absolute paths to unit files (in which
1142 case these files are read directly). If a specified unit file is located outside of the usual unit file
1143 directories, an additional symlink is created, linking it into the unit configuration path, thus ensuring
1144 it is found when requested by commands such as
<command>start
</command>. The file system where the linked
1145 unit files are located must be accessible when systemd is started (e.g. anything underneath
1146 <filename>/home
</filename> or
<filename>/var
</filename> is not allowed, unless those directories are
1147 located on the root file system).
</para>
1149 <para>This command will print the file system operations executed. This output may be suppressed by passing
1150 <option>--quiet
</option>.
1153 <para>Note that this operation creates only the symlinks suggested in the
<literal>[Install]
</literal>
1154 section of the unit files. While this command is the recommended way to manipulate the unit configuration
1155 directory, the administrator is free to make additional changes manually by placing or removing symlinks
1156 below this directory. This is particularly useful to create configurations that deviate from the suggested
1157 default installation. In this case, the administrator must make sure to invoke
1158 <command>daemon-reload
</command> manually as necessary, in order to ensure the changes are taken into
1162 <para>Enabling units should not be confused with starting (activating) units, as done by the
1163 <command>start
</command> command. Enabling and starting units is orthogonal: units may be enabled without
1164 being started and started without being enabled. Enabling simply hooks the unit into various suggested
1165 places (for example, so that the unit is automatically started on boot or when a particular kind of
1166 hardware is plugged in). Starting actually spawns the daemon process (in case of service units), or binds
1167 the socket (in case of socket units), and so on.
</para>
1169 <para>Depending on whether
<option>--system
</option>,
<option>--user
</option>,
<option>--runtime
</option>,
1170 or
<option>--global
</option> is specified, this enables the unit for the system, for the calling user only,
1171 for only this boot of the system, or for all future logins of all users. Note that in the last case, no
1172 systemd daemon configuration is reloaded.
</para>
1174 <para>Using
<command>enable
</command> on masked units is not supported and results in an error.
</para>
1179 <term><command>disable
<replaceable>UNIT
</replaceable>…
</command></term>
1182 <para>Disables one or more units. This removes all symlinks to the unit files backing the specified units
1183 from the unit configuration directory, and hence undoes any changes made by
<command>enable
</command> or
1184 <command>link
</command>. Note that this removes
<emphasis>all
</emphasis> symlinks to matching unit files,
1185 including manually created symlinks, and not just those actually created by
<command>enable
</command> or
1186 <command>link
</command>. Note that while
<command>disable
</command> undoes the effect of
1187 <command>enable
</command>, the two commands are otherwise not symmetric, as
<command>disable
</command> may
1188 remove more symlinks than a prior
<command>enable
</command> invocation of the same unit created.
</para>
1190 <para>This command expects valid unit names only, it does not accept paths to unit files.
</para>
1192 <para>In addition to the units specified as arguments, all units are disabled that are listed in the
1193 <varname>Also=
</varname> setting contained in the
<literal>[Install]
</literal> section of any of the unit
1194 files being operated on.
</para>
1196 <para>This command implicitly reloads the system manager configuration after completing the operation. Note
1197 that this command does not implicitly stop the units that are being disabled. If this is desired, either
1198 combine this command with the
<option>--now
</option> switch, or invoke the
<command>stop
</command> command
1199 with appropriate arguments later.
</para>
1201 <para>This command will print information about the file system operations (symlink removals)
1202 executed. This output may be suppressed by passing
<option>--quiet
</option>.
1205 <para>This command honors
<option>--system
</option>,
<option>--user
</option>,
<option>--runtime
</option>
1206 and
<option>--global
</option> in a similar way as
<command>enable
</command>.
</para>
1211 <term><command>reenable
<replaceable>UNIT
</replaceable>…
</command></term>
1214 <para>Reenable one or more units, as specified on the command line. This is a combination of
1215 <command>disable
</command> and
<command>enable
</command> and is useful to reset the symlinks a unit file is
1216 enabled with to the defaults configured in its
<literal>[Install]
</literal> section. This command expects
1217 a unit name only, it does not accept paths to unit files.
</para>
1222 <term><command>preset
<replaceable>UNIT
</replaceable>…
</command></term>
1225 <para>Reset the enable/disable status one or more unit files, as specified on
1226 the command line, to the defaults configured in the preset policy files. This
1227 has the same effect as
<command>disable
</command> or
1228 <command>enable
</command>, depending how the unit is listed in the preset
1231 <para>Use
<option>--preset-mode=
</option> to control whether units shall be
1232 enabled and disabled, or only enabled, or only disabled.
</para>
1234 <para>If the unit carries no install information, it will be silently ignored
1235 by this command.
<replaceable>UNIT
</replaceable> must be the real unit name,
1236 any alias names are ignored silently.
</para>
1238 <para>For more information on the preset policy format, see
1239 <citerefentry><refentrytitle>systemd.preset
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1240 For more information on the concept of presets, please consult the
1241 <ulink url=
"https://www.freedesktop.org/wiki/Software/systemd/Preset">Preset
</ulink>
1247 <term><command>preset-all
</command></term>
1250 <para>Resets all installed unit files to the defaults
1251 configured in the preset policy file (see above).
</para>
1253 <para>Use
<option>--preset-mode=
</option> to control
1254 whether units shall be enabled and disabled, or only
1255 enabled, or only disabled.
</para>
1260 <term><command>is-enabled
<replaceable>UNIT
</replaceable>…
</command></term>
1263 <para>Checks whether any of the specified unit files are
1264 enabled (as with
<command>enable
</command>). Returns an
1265 exit code of
0 if at least one is enabled, non-zero
1266 otherwise. Prints the current enable status (see table).
1267 To suppress this output, use
<option>--quiet
</option>.
1268 To show installation targets, use
<option>--full
</option>.
1273 <command>is-enabled
</command> output
1280 <entry>Description
</entry>
1281 <entry>Exit Code
</entry>
1286 <entry><literal>enabled
</literal></entry>
1287 <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>
1288 <entry morerows='
1'
>0</entry>
1291 <entry><literal>enabled-runtime
</literal></entry>
1294 <entry><literal>linked
</literal></entry>
1295 <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>
1296 <entry morerows='
1'
>> 0</entry>
1299 <entry><literal>linked-runtime
</literal></entry>
1302 <entry><literal>masked
</literal></entry>
1303 <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>
1304 <entry morerows='
1'
>> 0</entry>
1307 <entry><literal>masked-runtime
</literal></entry>
1310 <entry><literal>static
</literal></entry>
1311 <entry>The unit file is not enabled, and has no provisions for enabling in the
<literal>[Install]
</literal> unit file section.
</entry>
1315 <entry><literal>indirect
</literal></entry>
1316 <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>
1320 <entry><literal>disabled
</literal></entry>
1321 <entry>The unit file is not enabled, but contains an
<literal>[Install]
</literal> section with installation instructions.
</entry>
1322 <entry>> 0</entry>
1325 <entry><literal>generated
</literal></entry>
1326 <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>
1330 <entry><literal>transient
</literal></entry>
1331 <entry>The unit file has been created dynamically with the runtime API. Transient units may not be enabled.
</entry>
1335 <entry><literal>bad
</literal></entry>
1336 <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>
1337 <entry>> 0</entry>
1347 <term><command>mask
<replaceable>UNIT
</replaceable>…
</command></term>
1350 <para>Mask one or more units, as specified on the command line. This will link these unit files to
1351 <filename>/dev/null
</filename>, making it impossible to start them. This is a stronger version of
1352 <command>disable
</command>, since it prohibits all kinds of activation of the unit, including enablement
1353 and manual activation. Use this option with care. This honors the
<option>--runtime
</option> option to only
1354 mask temporarily until the next reboot of the system. The
<option>--now
</option> option may be used to
1355 ensure that the units are also stopped. This command expects valid unit names only, it does not accept unit
1361 <term><command>unmask
<replaceable>UNIT
</replaceable>…
</command></term>
1364 <para>Unmask one or more unit files, as specified on the command line. This will undo the effect of
1365 <command>mask
</command>. This command expects valid unit names only, it does not accept unit file
1371 <term><command>link
<replaceable>PATH
</replaceable>…
</command></term>
1374 <para>Link a unit file that is not in the unit file search paths into the unit file search path. This
1375 command expects an absolute path to a unit file. The effect of this may be undone with
1376 <command>disable
</command>. The effect of this command is that a unit file is made available for commands
1377 such as
<command>start
</command>, even though it is not installed directly in the unit search path. The
1378 file system where the linked unit files are located must be accessible when systemd is started
1379 (e.g. anything underneath
<filename>/home
</filename> or
<filename>/var
</filename> is not allowed, unless
1380 those directories are located on the root file system).
</para>
1385 <term><command>revert
<replaceable>UNIT
</replaceable>…
</command></term>
1388 <para>Revert one or more unit files to their vendor versions. This command removes drop-in configuration
1389 files that modify the specified units, as well as any user-configured unit file that overrides a matching
1390 vendor supplied unit file. Specifically, for a unit
<literal>foo.service
</literal> the matching directories
1391 <literal>foo.service.d/
</literal> with all their contained files are removed, both below the persistent and
1392 runtime configuration directories (i.e. below
<filename>/etc/systemd/system
</filename> and
1393 <filename>/run/systemd/system
</filename>); if the unit file has a vendor-supplied version (i.e. a unit file
1394 located below
<filename>/usr
</filename>) any matching persistent or runtime unit file that overrides it is
1395 removed, too. Note that if a unit file has no vendor-supplied version (i.e. is only defined below
1396 <filename>/etc/systemd/system
</filename> or
<filename>/run/systemd/system
</filename>, but not in a unit
1397 file stored below
<filename>/usr
</filename>), then it is not removed. Also, if a unit is masked, it is
1400 <para>Effectively, this command may be used to undo all changes made with
<command>systemctl
1401 edit
</command>,
<command>systemctl set-property
</command> and
<command>systemctl mask
</command> and puts
1402 the original unit file with its settings back in effect.
</para>
1407 <term><command>add-wants
<replaceable>TARGET
</replaceable>
1408 <replaceable>UNIT
</replaceable>…
</command></term>
1409 <term><command>add-requires
<replaceable>TARGET
</replaceable>
1410 <replaceable>UNIT
</replaceable>…
</command></term>
1413 <para>Adds
<literal>Wants=
</literal> or
<literal>Requires=
</literal>
1414 dependencies, respectively, to the specified
1415 <replaceable>TARGET
</replaceable> for one or more units.
</para>
1417 <para>This command honors
<option>--system
</option>,
1418 <option>--user
</option>,
<option>--runtime
</option> and
1419 <option>--global
</option> in a way similar to
1420 <command>enable
</command>.
</para>
1426 <term><command>edit
<replaceable>UNIT
</replaceable>…
</command></term>
1429 <para>Edit a drop-in snippet or a whole replacement file if
1430 <option>--full
</option> is specified, to extend or override the
1431 specified unit.
</para>
1433 <para>Depending on whether
<option>--system
</option> (the default),
1434 <option>--user
</option>, or
<option>--global
</option> is specified,
1435 this command creates a drop-in file for each unit either for the system,
1436 for the calling user, or for all futures logins of all users. Then,
1437 the editor (see the
"Environment" section below) is invoked on
1438 temporary files which will be written to the real location if the
1439 editor exits successfully.
</para>
1441 <para>If
<option>--full
</option> is specified, this will copy the
1442 original units instead of creating drop-in files.
</para>
1444 <para>If
<option>--force
</option> is specified and any units do
1445 not already exist, new unit files will be opened for editing.
</para>
1447 <para>If
<option>--runtime
</option> is specified, the changes will
1448 be made temporarily in
<filename>/run
</filename> and they will be
1449 lost on the next reboot.
</para>
1451 <para>If the temporary file is empty upon exit, the modification of
1452 the related unit is canceled.
</para>
1454 <para>After the units have been edited, systemd configuration is
1455 reloaded (in a way that is equivalent to
<command>daemon-reload
</command>).
1458 <para>Note that this command cannot be used to remotely edit units
1459 and that you cannot temporarily edit units which are in
1460 <filename>/etc
</filename>, since they take precedence over
1461 <filename>/run
</filename>.
</para>
1466 <term><command>get-default
</command></term>
1469 <para>Return the default target to boot into. This returns
1470 the target unit name
<filename>default.target
</filename>
1471 is aliased (symlinked) to.
</para>
1476 <term><command>set-default
<replaceable>TARGET
</replaceable></command></term>
1479 <para>Set the default target to boot into. This sets
1480 (symlinks) the
<filename>default.target
</filename> alias
1481 to the given target unit.
</para>
1489 <title>Machine Commands
</title>
1493 <term><command>list-machines
<optional><replaceable>PATTERN
</replaceable>…
</optional></command></term>
1496 <para>List the host and all running local containers with
1497 their state. If one or more
1498 <replaceable>PATTERN
</replaceable>s are specified, only
1499 containers matching one of them are shown.
1507 <title>Job Commands
</title>
1511 <term><command>list-jobs
<optional><replaceable>PATTERN…
</replaceable></optional></command></term>
1514 <para>List jobs that are in progress. If one or more
1515 <replaceable>PATTERN
</replaceable>s are specified, only
1516 jobs for units matching one of them are shown.
</para>
1518 <para>When combined with
<option>--after
</option> or
<option>--before
</option> the list is augmented with
1519 information on which other job each job is waiting for, and which other jobs are waiting for it, see
1524 <term><command>cancel
<replaceable>JOB
</replaceable>…
</command></term>
1527 <para>Cancel one or more jobs specified on the command line
1528 by their numeric job IDs. If no job ID is specified, cancel
1529 all pending jobs.
</para>
1536 <title>Environment Commands
</title>
1540 <term><command>show-environment
</command></term>
1543 <para>Dump the systemd manager environment block. This is the environment
1544 block that is passed to all processes the manager spawns. The environment
1545 block will be dumped in straight-forward form suitable for sourcing into
1546 most shells. If no special characters or whitespace is present in the variable
1547 values, no escaping is performed, and the assignments have the form
1548 <literal>VARIABLE=value
</literal>. If whitespace or characters which have
1549 special meaning to the shell are present, dollar-single-quote escaping is
1550 used, and assignments have the form
<literal>VARIABLE=$'value'
</literal>.
1551 This syntax is known to be supported by
1552 <citerefentry project='die-net'
><refentrytitle>bash
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1553 <citerefentry project='die-net'
><refentrytitle>zsh
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1554 <citerefentry project='die-net'
><refentrytitle>ksh
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1556 <citerefentry project='die-net'
><refentrytitle>busybox
</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
1557 <citerefentry project='die-net'
><refentrytitle>ash
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1559 <citerefentry project='die-net'
><refentrytitle>dash
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
1561 <citerefentry project='die-net'
><refentrytitle>fish
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
1566 <term><command>set-environment
<replaceable>VARIABLE=VALUE
</replaceable>…
</command></term>
1569 <para>Set one or more systemd manager environment variables,
1570 as specified on the command line.
</para>
1574 <term><command>unset-environment
<replaceable>VARIABLE
</replaceable>…
</command></term>
1577 <para>Unset one or more systemd manager environment
1578 variables. If only a variable name is specified, it will be
1579 removed regardless of its value. If a variable and a value
1580 are specified, the variable is only removed if it has the
1581 specified value.
</para>
1586 <command>import-environment
</command>
1587 <optional><replaceable>VARIABLE…
</replaceable></optional>
1591 <para>Import all, one or more environment variables set on
1592 the client into the systemd manager environment block. If
1593 no arguments are passed, the entire environment block is
1594 imported. Otherwise, a list of one or more environment
1595 variable names should be passed, whose client-side values
1596 are then imported into the manager's environment
1604 <title>Manager Lifecycle Commands
</title>
1608 <term><command>daemon-reload
</command></term>
1611 <para>Reload the systemd manager configuration. This will
1612 rerun all generators (see
1613 <citerefentry><refentrytitle>systemd.generator
</refentrytitle><manvolnum>7</manvolnum></citerefentry>),
1614 reload all unit files, and recreate the entire dependency
1615 tree. While the daemon is being reloaded, all sockets
1616 systemd listens on behalf of user configuration will stay
1619 <para>This command should not be confused with the
1620 <command>reload
</command> command.
</para>
1624 <term><command>daemon-reexec
</command></term>
1627 <para>Reexecute the systemd manager. This will serialize the
1628 manager state, reexecute the process and deserialize the
1629 state again. This command is of little use except for
1630 debugging and package upgrades. Sometimes, it might be
1631 helpful as a heavy-weight
<command>daemon-reload
</command>.
1632 While the daemon is being reexecuted, all sockets systemd listening
1633 on behalf of user configuration will stay accessible.
1641 <title>System Commands
</title>
1645 <term><command>is-system-running
</command></term>
1648 <para>Checks whether the system is operational. This
1649 returns success (exit code
0) when the system is fully up
1650 and running, specifically not in startup, shutdown or
1651 maintenance mode, and with no failed services. Failure is
1652 returned otherwise (exit code non-zero). In addition, the
1653 current state is printed in a short string to standard
1654 output, see the table below. Use
<option>--quiet
</option> to
1655 suppress this output.
</para>
1658 <title><command>is-system-running
</command> output
</title>
1660 <colspec colname='name'
/>
1661 <colspec colname='description'
/>
1662 <colspec colname='exit-code'
/>
1666 <entry>Description
</entry>
1667 <entry>Exit Code
</entry>
1672 <entry><varname>initializing
</varname></entry>
1673 <entry><para>Early bootup, before
1674 <filename>basic.target
</filename> is reached
1675 or the
<varname>maintenance
</varname> state entered.
1677 <entry>> 0</entry>
1680 <entry><varname>starting
</varname></entry>
1681 <entry><para>Late bootup, before the job queue
1682 becomes idle for the first time, or one of the
1683 rescue targets are reached.
</para></entry>
1684 <entry>> 0</entry>
1687 <entry><varname>running
</varname></entry>
1688 <entry><para>The system is fully
1689 operational.
</para></entry>
1693 <entry><varname>degraded
</varname></entry>
1694 <entry><para>The system is operational but one or more
1695 units failed.
</para></entry>
1696 <entry>> 0</entry>
1699 <entry><varname>maintenance
</varname></entry>
1700 <entry><para>The rescue or emergency target is
1701 active.
</para></entry>
1702 <entry>> 0</entry>
1705 <entry><varname>stopping
</varname></entry>
1706 <entry><para>The manager is shutting
1707 down.
</para></entry>
1708 <entry>> 0</entry>
1711 <entry><varname>offline
</varname></entry>
1712 <entry><para>The manager is not
1713 running. Specifically, this is the operational
1714 state if an incompatible program is running as
1715 system manager (PID
1).
</para></entry>
1716 <entry>> 0</entry>
1719 <entry><varname>unknown
</varname></entry>
1720 <entry><para>The operational state could not be
1721 determined, due to lack of resources or another
1722 error cause.
</para></entry>
1723 <entry>> 0</entry>
1732 <term><command>default
</command></term>
1735 <para>Enter default mode. This is equivalent to
<command>systemctl isolate default.target
</command>. This
1736 operation is blocking by default, use
<option>--no-block
</option> to request asynchronous behavior.
</para>
1741 <term><command>rescue
</command></term>
1744 <para>Enter rescue mode. This is equivalent to
<command>systemctl isolate rescue.target
</command>. This
1745 operation is blocking by default, use
<option>--no-block
</option> to request asynchronous behavior.
</para>
1749 <term><command>emergency
</command></term>
1752 <para>Enter emergency mode. This is equivalent to
<command>systemctl isolate
1753 emergency.target
</command>. This operation is blocking by default, use
<option>--no-block
</option> to
1754 request asynchronous behavior.
</para>
1758 <term><command>halt
</command></term>
1761 <para>Shut down and halt the system. This is mostly equivalent to
<command>systemctl start halt.target
1762 --job-mode=replace-irreversibly --no-block
</command>, but also prints a wall message to all users. This command is
1763 asynchronous; it will return after the halt operation is enqueued, without waiting for it to complete. Note
1764 that this operation will simply halt the OS kernel after shutting down, leaving the hardware powered
1765 on. Use
<command>systemctl poweroff
</command> for powering off the system (see below).
</para>
1767 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1768 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1769 system halt. If
<option>--force
</option> is specified twice, the operation is immediately executed without
1770 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1771 <option>--force
</option> is specified twice the halt operation is executed by
<command>systemctl
</command>
1772 itself, and the system manager is not contacted. This means the command should succeed even when the system
1773 manager has crashed.
</para>
1777 <term><command>poweroff
</command></term>
1780 <para>Shut down and power-off the system. This is mostly equivalent to
<command>systemctl start
1781 poweroff.target --job-mode=replace-irreversibly --no-block
</command>, but also prints a wall message to all
1782 users. This command is asynchronous; it will return after the power-off operation is enqueued, without
1783 waiting for it to complete.
</para>
1785 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1786 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1787 powering off. If
<option>--force
</option> is specified twice, the operation is immediately executed without
1788 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1789 <option>--force
</option> is specified twice the power-off operation is executed by
1790 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
1791 succeed even when the system manager has crashed.
</para>
1795 <term><command>reboot
<optional><replaceable>arg
</replaceable></optional></command></term>
1798 <para>Shut down and reboot the system. This is mostly equivalent to
<command>systemctl start reboot.target
1799 --job-mode=replace-irreversibly --no-block
</command>, but also prints a wall message to all users. This
1800 command is asynchronous; it will return after the reboot operation is enqueued, without waiting for it to
1803 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1804 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1805 reboot. If
<option>--force
</option> is specified twice, the operation is immediately executed without
1806 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1807 <option>--force
</option> is specified twice the reboot operation is executed by
1808 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
1809 succeed even when the system manager has crashed.
</para>
1811 <para>If the optional argument
<replaceable>arg
</replaceable> is given, it will be passed as the optional
1812 argument to the
<citerefentry><refentrytitle>reboot
</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1813 system call. The value is architecture and firmware specific. As an example,
<literal>recovery
</literal>
1814 might be used to trigger system recovery, and
<literal>fota
</literal> might be used to trigger a
1815 <quote>firmware over the air
</quote> update.
</para>
1820 <term><command>kexec
</command></term>
1823 <para>Shut down and reboot the system via
<command>kexec
</command>. This is equivalent to
1824 <command>systemctl start kexec.target --job-mode=replace-irreversibly --no-block
</command>. This command is
1825 asynchronous; it will return after the reboot operation is enqueued, without waiting for it to
1828 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1829 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1835 <term><command>exit
<optional><replaceable>EXIT_CODE
</replaceable></optional></command></term>
1838 <para>Ask the service manager to quit. This is only supported for user service managers (i.e. in
1839 conjunction with the
<option>--user
</option> option) or in containers and is equivalent to
1840 <command>poweroff
</command> otherwise. This command is asynchronous; it will return after the exit
1841 operation is enqueued, without waiting for it to complete.
</para>
1843 <para>The service manager will exit with the specified exit code, if
1844 <replaceable>EXIT_CODE
</replaceable> is passed.
</para>
1849 <term><command>switch-root
<replaceable>ROOT
</replaceable> <optional><replaceable>INIT
</replaceable></optional></command></term>
1852 <para>Switches to a different root directory and executes a new system manager process below it. This is
1853 intended for usage in initial RAM disks (
"initrd"), and will transition from the initrd's system manager
1854 process (a.k.a.
"init" process) to the main system manager process which is loaded from the actual host
1855 volume. This call takes two arguments: the directory that is to become the new root directory, and the path
1856 to the new system manager binary below it to execute as PID
1. If the latter is omitted or the empty
1857 string, a systemd binary will automatically be searched for and used as init. If the system manager path is
1858 omitted, equal to the empty string or identical to the path to the systemd binary, the state of the
1859 initrd's system manager process is passed to the main system manager, which allows later introspection of
1860 the state of the services involved in the initrd boot phase.
</para>
1865 <term><command>suspend
</command></term>
1868 <para>Suspend the system. This will trigger activation of the special target unit
1869 <filename>suspend.target
</filename>. This command is asynchronous, and will return after the suspend
1870 operation is successfully enqueued. It will not wait for the suspend/resume cycle to complete.
</para>
1875 <term><command>hibernate
</command></term>
1878 <para>Hibernate the system. This will trigger activation of the special target unit
1879 <filename>hibernate.target
</filename>. This command is asynchronous, and will return after the hibernation
1880 operation is successfully enqueued. It will not wait for the hibernate/thaw cycle to complete.
</para>
1885 <term><command>hybrid-sleep
</command></term>
1888 <para>Hibernate and suspend the system. This will trigger activation of the special target unit
1889 <filename>hybrid-sleep.target
</filename>. This command is asynchronous, and will return after the hybrid
1890 sleep operation is successfully enqueued. It will not wait for the sleep/wake-up cycle to complete.
</para>
1897 <title>Parameter Syntax
</title>
1899 <para>Unit commands listed above take either a single unit name (designated as
<replaceable>UNIT
</replaceable>),
1900 or multiple unit specifications (designated as
<replaceable>PATTERN
</replaceable>…). In the first case, the
1901 unit name with or without a suffix must be given. If the suffix is not specified (unit name is
"abbreviated"),
1902 systemctl will append a suitable suffix,
<literal>.service
</literal> by default, and a type-specific suffix in
1903 case of commands which operate only on specific unit types. For example,
1904 <programlisting># systemctl start sshd
</programlisting> and
1905 <programlisting># systemctl start sshd.service
</programlisting>
1906 are equivalent, as are
1907 <programlisting># systemctl isolate default
</programlisting>
1909 <programlisting># systemctl isolate default.target
</programlisting>
1910 Note that (absolute) paths to device nodes are automatically converted to device unit names, and other (absolute)
1911 paths to mount unit names.
1912 <programlisting># systemctl status /dev/sda
1913 # systemctl status /home
</programlisting>
1915 <programlisting># systemctl status dev-sda.device
1916 # systemctl status home.mount
</programlisting>
1917 In the second case, shell-style globs will be matched against the primary names of all units currently in memory;
1918 literal unit names, with or without a suffix, will be treated as in the first case. This means that literal unit
1919 names always refer to exactly one unit, but globs may match zero units and this is not considered an
1922 <para>Glob patterns use
1923 <citerefentry project='man-pages'
><refentrytitle>fnmatch
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
1924 so normal shell-style globbing rules are used, and
1925 <literal>*
</literal>,
<literal>?
</literal>,
1926 <literal>[]
</literal> may be used. See
1927 <citerefentry project='man-pages'
><refentrytitle>glob
</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1928 for more details. The patterns are matched against the primary names of
1929 units currently in memory, and patterns which do not match anything
1930 are silently skipped. For example:
1931 <programlisting># systemctl stop sshd@*.service
</programlisting>
1932 will stop all
<filename>sshd@.service
</filename> instances. Note that alias names of units, and units that aren't
1933 in memory are not considered for glob expansion.
1936 <para>For unit file commands, the specified
<replaceable>UNIT
</replaceable> should be the name of the unit file
1937 (possibly abbreviated, see above), or the absolute path to the unit file:
1938 <programlisting># systemctl enable foo.service
</programlisting>
1940 <programlisting># systemctl link /path/to/foo.service
</programlisting>
1947 <title>Exit status
</title>
1949 <para>On success,
0 is returned, a non-zero failure
1950 code otherwise.
</para>
1954 <title>Environment
</title>
1956 <variablelist class='environment-variables'
>
1958 <term><varname>$SYSTEMD_EDITOR
</varname></term>
1960 <listitem><para>Editor to use when editing units; overrides
1961 <varname>$EDITOR
</varname> and
<varname>$VISUAL
</varname>. If neither
1962 <varname>$SYSTEMD_EDITOR
</varname> nor
<varname>$EDITOR
</varname> nor
1963 <varname>$VISUAL
</varname> are present or if it is set to an empty
1964 string or if their execution failed, systemctl will try to execute well
1965 known editors in this order:
1966 <citerefentry project='die-net'
><refentrytitle>editor
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1967 <citerefentry project='die-net'
><refentrytitle>nano
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1968 <citerefentry project='die-net'
><refentrytitle>vim
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1969 <citerefentry project='die-net'
><refentrytitle>vi
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
1973 <xi:include href=
"less-variables.xml" xpointer=
"pager"/>
1974 <xi:include href=
"less-variables.xml" xpointer=
"less"/>
1975 <xi:include href=
"less-variables.xml" xpointer=
"lesscharset"/>
1979 <title>See Also
</title>
1981 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1982 <citerefentry><refentrytitle>journalctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1983 <citerefentry><refentrytitle>loginctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1984 <citerefentry><refentrytitle>machinectl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1985 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1986 <citerefentry><refentrytitle>systemd.resource-control
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1987 <citerefentry><refentrytitle>systemd.special
</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1988 <citerefentry project='man-pages'
><refentrytitle>wall
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1989 <citerefentry><refentrytitle>systemd.preset
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1990 <citerefentry><refentrytitle>systemd.generator
</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1991 <citerefentry project='man-pages'
><refentrytitle>glob
</refentrytitle><manvolnum>7</manvolnum></citerefentry>
projects / thirdparty / systemd.git / blob