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+
12 <refentry id=
"systemctl"
13 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
16 <title>systemctl
</title>
17 <productname>systemd
</productname>
21 <refentrytitle>systemctl
</refentrytitle>
22 <manvolnum>1</manvolnum>
26 <refname>systemctl
</refname>
27 <refpurpose>Control the systemd system and service manager
</refpurpose>
32 <command>systemctl
</command>
33 <arg choice=
"opt" rep=
"repeat">OPTIONS
</arg>
34 <arg choice=
"plain">COMMAND
</arg>
35 <arg choice=
"opt" rep=
"repeat">UNIT
</arg>
40 <title>Description
</title>
42 <para><command>systemctl
</command> may be used to introspect and
43 control the state of the
<literal>systemd
</literal> system and
44 service manager. Please refer to
45 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
46 for an introduction into the basic concepts and functionality this
51 <title>Options
</title>
53 <para>The following options are understood:
</para>
57 <term><option>-t
</option></term>
58 <term><option>--type=
</option></term>
61 <para>The argument should be a comma-separated list of unit
62 types such as
<option>service
</option> and
63 <option>socket
</option>.
66 <para>If one of the arguments is a unit type, when listing
67 units, limit display to certain unit types. Otherwise, units
68 of all types will be shown.
</para>
70 <para>As a special case, if one of the arguments is
71 <option>help
</option>, a list of allowed values will be
72 printed and the program will exit.
</para>
77 <term><option>--state=
</option></term>
80 <para>The argument should be a comma-separated list of unit
81 LOAD, SUB, or ACTIVE states. When listing units, show only
82 those in the specified states. Use
<option>--state=failed
</option>
83 to show only failed units.
</para>
85 <para>As a special case, if one of the arguments is
86 <option>help
</option>, a list of allowed values will be
87 printed and the program will exit.
</para>
92 <term><option>-p
</option></term>
93 <term><option>--property=
</option></term>
96 <para>When showing unit/job/manager properties with the
97 <command>show
</command> command, limit display to properties
98 specified in the argument. The argument should be a
99 comma-separated list of property names, such as
100 <literal>MainPID
</literal>. Unless specified, all known
101 properties are shown. If specified more than once, all
102 properties with the specified names are shown. Shell
103 completion is implemented for property names.
</para>
105 <para>For the manager itself,
106 <command>systemctl show
</command> will show all available
107 properties. Those properties are documented in
108 <citerefentry><refentrytitle>systemd-system.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
111 <para>Properties for units vary by unit type, so showing any
112 unit (even a non-existent one) is a way to list properties
113 pertaining to this type. Similarly, showing any job will list
114 properties pertaining to all jobs. Properties for units are
116 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
117 and the pages for individual unit types
118 <citerefentry><refentrytitle>systemd.service
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
119 <citerefentry><refentrytitle>systemd.socket
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
125 <term><option>-a
</option></term>
126 <term><option>--all
</option></term>
129 <para>When listing units with
<command>list-units
</command>, also show inactive units and
130 units which are following other units. When showing unit/job/manager properties, show all
131 properties regardless whether they are set or not.
</para>
133 <para>To list all units installed in the file system, use the
134 <command>list-unit-files
</command> command instead.
</para>
136 <para>When listing units with
<command>list-dependencies
</command>, recursively show
137 dependencies of all dependent units (by default only dependencies of target units are
143 <term><option>-r
</option></term>
144 <term><option>--recursive
</option></term>
147 <para>When listing units, also show units of local
148 containers. Units of local containers will be prefixed with
149 the container name, separated by a single colon character
150 (
<literal>:
</literal>).
</para>
155 <term><option>--reverse
</option></term>
158 <para>Show reverse dependencies between units with
159 <command>list-dependencies
</command>, i.e. follow
160 dependencies of type
<varname>WantedBy=
</varname>,
161 <varname>RequiredBy=
</varname>,
162 <varname>PartOf=
</varname>,
<varname>BoundBy=
</varname>,
163 instead of
<varname>Wants=
</varname> and similar.
169 <term><option>--after
</option></term>
172 <para>With
<command>list-dependencies
</command>, show the
173 units that are ordered before the specified unit. In other
174 words, recursively list units following the
175 <varname>After=
</varname> dependency.
</para>
177 <para>Note that any
<varname>After=
</varname> dependency is
178 automatically mirrored to create a
179 <varname>Before=
</varname> dependency. Temporal dependencies
180 may be specified explicitly, but are also created implicitly
181 for units which are
<varname>WantedBy=
</varname> targets
183 <citerefentry><refentrytitle>systemd.target
</refentrytitle><manvolnum>5</manvolnum></citerefentry>),
184 and as a result of other directives (for example
185 <varname>RequiresMountsFor=
</varname>). Both explicitly
186 and implicitly introduced dependencies are shown with
187 <command>list-dependencies
</command>.
</para>
189 <para>When passed to the
<command>list-jobs
</command> command, for each printed job show which other jobs are
190 waiting for it. May be combined with
<option>--before
</option> to show both the jobs waiting for each job as
191 well as all jobs each job is waiting for.
</para>
196 <term><option>--before
</option></term>
199 <para>With
<command>list-dependencies
</command>, show the
200 units that are ordered after the specified unit. In other
201 words, recursively list units following the
202 <varname>Before=
</varname> dependency.
</para>
204 <para>When passed to the
<command>list-jobs
</command> command, for each printed job show which other jobs it
205 is waiting for. May be combined with
<option>--after
</option> to show both the jobs waiting for each job as
206 well as all jobs each job is waiting for.
</para>
211 <term><option>-l
</option></term>
212 <term><option>--full
</option></term>
215 <para>Do not ellipsize unit names, process tree entries,
216 journal output, or truncate unit descriptions in the output
217 of
<command>status
</command>,
<command>list-units
</command>,
218 <command>list-jobs
</command>, and
219 <command>list-timers
</command>.
</para>
220 <para>Also, show installation targets in the output of
221 <command>is-enabled
</command>.
</para>
226 <term><option>--value
</option></term>
229 <para>When printing properties with
<command>show
</command>,
230 only print the value, and skip the property name and
231 <literal>=
</literal>.
</para>
236 <term><option>--show-types
</option></term>
239 <para>When showing sockets, show the type of the socket.
</para>
244 <term><option>--job-mode=
</option></term>
247 <para>When queuing a new job, this option controls how to deal with
248 already queued jobs. It takes one of
<literal>fail
</literal>,
249 <literal>replace
</literal>,
250 <literal>replace-irreversibly
</literal>,
251 <literal>isolate
</literal>,
252 <literal>ignore-dependencies
</literal>,
253 <literal>ignore-requirements
</literal> or
254 <literal>flush
</literal>. Defaults to
255 <literal>replace
</literal>, except when the
256 <command>isolate
</command> command is used which implies the
257 <literal>isolate
</literal> job mode.
</para>
259 <para>If
<literal>fail
</literal> is specified and a requested
260 operation conflicts with a pending job (more specifically:
261 causes an already pending start job to be reversed into a stop
262 job or vice versa), cause the operation to fail.
</para>
264 <para>If
<literal>replace
</literal> (the default) is
265 specified, any conflicting pending job will be replaced, as
268 <para>If
<literal>replace-irreversibly
</literal> is specified,
269 operate like
<literal>replace
</literal>, but also mark the new
270 jobs as irreversible. This prevents future conflicting
271 transactions from replacing these jobs (or even being enqueued
272 while the irreversible jobs are still pending). Irreversible
273 jobs can still be cancelled using the
<command>cancel
</command>
274 command. This job mode should be used on any transaction which
275 pulls in
<filename>shutdown.target
</filename>.
</para>
277 <para><literal>isolate
</literal> is only valid for start
278 operations and causes all other units to be stopped when the
279 specified unit is started. This mode is always used when the
280 <command>isolate
</command> command is used.
</para>
282 <para><literal>flush
</literal> will cause all queued jobs to
283 be canceled when the new job is enqueued.
</para>
285 <para>If
<literal>ignore-dependencies
</literal> is specified,
286 then all unit dependencies are ignored for this new job and
287 the operation is executed immediately. If passed, no required
288 units of the unit passed will be pulled in, and no ordering
289 dependencies will be honored. This is mostly a debugging and
290 rescue tool for the administrator and should not be used by
293 <para><literal>ignore-requirements
</literal> is similar to
294 <literal>ignore-dependencies
</literal>, but only causes the
295 requirement dependencies to be ignored, the ordering
296 dependencies will still be honored.
</para>
302 <term><option>--fail
</option></term>
305 <para>Shorthand for
<option>--job-mode=
</option>fail.
</para>
306 <para>When used with the
<command>kill
</command> command,
307 if no units were killed, the operation results in an error.
313 <term><option>-i
</option></term>
314 <term><option>--ignore-inhibitors
</option></term>
317 <para>When system shutdown or a sleep state is requested,
318 ignore inhibitor locks. Applications can establish inhibitor
319 locks to avoid that certain important operations (such as CD
320 burning or suchlike) are interrupted by system shutdown or a
321 sleep state. Any user may take these locks and privileged
322 users may override these locks. If any locks are taken,
323 shutdown and sleep state requests will normally fail
324 (regardless of whether privileged or not) and a list of active locks
325 is printed. However, if
<option>--ignore-inhibitors
</option>
326 is specified, the locks are ignored and not printed, and the
327 operation attempted anyway, possibly requiring additional
333 <term><option>--dry-run
</option></term>
336 <para>Just print what would be done. Currently supported by verbs
337 <command>halt
</command>,
<command>poweroff
</command>,
<command>reboot
</command>,
338 <command>kexec
</command>,
<command>suspend
</command>,
339 <command>hibernate
</command>,
<command>hybrid-sleep
</command>,
340 <command>default
</command>,
<command>rescue
</command>,
341 <command>emergency
</command>, and
<command>exit
</command>.
</para>
346 <term><option>-q
</option></term>
347 <term><option>--quiet
</option></term>
350 <para>Suppress printing of the results of various commands
351 and also the hints about truncated log lines. This does not
352 suppress output of commands for which the printed output is
353 the only result (like
<command>show
</command>). Errors are
354 always printed.
</para>
359 <term><option>--no-block
</option></term>
362 <para>Do not synchronously wait for the requested operation
363 to finish. If this is not specified, the job will be
364 verified, enqueued and
<command>systemctl
</command> will
365 wait until the unit's start-up is completed. By passing this
366 argument, it is only verified and enqueued. This option may not be
367 combined with
<option>--wait
</option>.
</para>
372 <term><option>--wait
</option></term>
375 <para>Synchronously wait for started units to terminate again.
376 This option may not be combined with
<option>--no-block
</option>.
377 Note that this will wait forever if any given unit never terminates
378 (by itself or by getting stopped explicitly); particularly services
379 which use
<literal>RemainAfterExit=yes
</literal>.
</para>
383 <xi:include href=
"user-system-options.xml" xpointer=
"user" />
384 <xi:include href=
"user-system-options.xml" xpointer=
"system" />
387 <term><option>--failed
</option></term>
390 <para>List units in failed state. This is equivalent to
391 <option>--state=failed
</option>.
</para>
396 <term><option>--no-wall
</option></term>
399 <para>Do not send wall message before halt, power-off and reboot.
</para>
404 <term><option>--global
</option></term>
407 <para>When used with
<command>enable
</command> and
408 <command>disable
</command>, operate on the global user
409 configuration directory, thus enabling or disabling a unit
410 file globally for all future logins of all users.
</para>
415 <term><option>--no-reload
</option></term>
418 <para>When used with
<command>enable
</command> and
419 <command>disable
</command>, do not implicitly reload daemon
420 configuration after executing the changes.
</para>
425 <term><option>--no-ask-password
</option></term>
428 <para>When used with
<command>start
</command> and related
429 commands, disables asking for passwords. Background services
430 may require input of a password or passphrase string, for
431 example to unlock system hard disks or cryptographic
432 certificates. Unless this option is specified and the
433 command is invoked from a terminal,
434 <command>systemctl
</command> will query the user on the
435 terminal for the necessary secrets. Use this option to
436 switch this behavior off. In this case, the password must be
437 supplied by some other means (for example graphical password
438 agents) or the service might fail. This also disables
439 querying the user for authentication for privileged
445 <term><option>--kill-who=
</option></term>
448 <para>When used with
<command>kill
</command>, choose which
449 processes to send a signal to. Must be one of
450 <option>main
</option>,
<option>control
</option> or
451 <option>all
</option> to select whether to kill only the main
452 process, the control process or all processes of the
453 unit. The main process of the unit is the one that defines
454 the life-time of it. A control process of a unit is one that
455 is invoked by the manager to induce state changes of it. For
456 example, all processes started due to the
457 <varname>ExecStartPre=
</varname>,
458 <varname>ExecStop=
</varname> or
459 <varname>ExecReload=
</varname> settings of service units are
460 control processes. Note that there is only one control
461 process per unit at a time, as only one state change is
462 executed at a time. For services of type
463 <varname>Type=forking
</varname>, the initial process started
464 by the manager for
<varname>ExecStart=
</varname> is a
465 control process, while the process ultimately forked off by
466 that one is then considered the main process of the unit (if
467 it can be determined). This is different for service units
468 of other types, where the process forked off by the manager
469 for
<varname>ExecStart=
</varname> is always the main process
470 itself. A service unit consists of zero or one main process,
471 zero or one control process plus any number of additional
472 processes. Not all unit types manage processes of these
473 types however. For example, for mount units, control processes
474 are defined (which are the invocations of
475 <filename>&MOUNT_PATH;</filename> and
476 <filename>&UMOUNT_PATH;</filename>), but no main process
477 is defined. If omitted, defaults to
478 <option>all
</option>.
</para>
484 <term><option>-s
</option></term>
485 <term><option>--signal=
</option></term>
488 <para>When used with
<command>kill
</command>, choose which
489 signal to send to selected processes. Must be one of the
490 well-known signal specifiers such as
<constant>SIGTERM
</constant>,
<constant>SIGINT
</constant> or
491 <constant>SIGSTOP
</constant>. If omitted, defaults to
492 <option>SIGTERM
</option>.
</para>
497 <term><option>-f
</option></term>
498 <term><option>--force
</option></term>
501 <para>When used with
<command>enable
</command>, overwrite
502 any existing conflicting symlinks.
</para>
504 <para>When used with
<command>edit
</command>, create all of the
505 specified units which do not already exist.
</para>
507 <para>When used with
<command>halt
</command>,
<command>poweroff
</command>,
<command>reboot
</command> or
508 <command>kexec
</command>, execute the selected operation without shutting down all units. However, all
509 processes will be killed forcibly and all file systems are unmounted or remounted read-only. This is hence a
510 drastic but relatively safe option to request an immediate reboot. If
<option>--force
</option> is specified
511 twice for these operations (with the exception of
<command>kexec
</command>), they will be executed
512 immediately, without terminating any processes or unmounting any file systems. Warning: specifying
513 <option>--force
</option> twice with any of these operations might result in data loss. Note that when
514 <option>--force
</option> is specified twice the selected operation is executed by
515 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
516 succeed even when the system manager has crashed.
</para>
521 <term><option>--message=
</option></term>
524 <para>When used with
<command>halt
</command>,
<command>poweroff
</command> or
<command>reboot
</command>, set a
525 short message explaining the reason for the operation. The message will be logged together with the default
526 shutdown message.
</para>
531 <term><option>--now
</option></term>
534 <para>When used with
<command>enable
</command>, the units
535 will also be started. When used with
<command>disable
</command> or
536 <command>mask
</command>, the units will also be stopped. The start
537 or stop operation is only carried out when the respective enable or
538 disable operation has been successful.
</para>
543 <term><option>--root=
</option></term>
547 <command>enable
</command>/
<command>disable
</command>/
<command>is-enabled
</command>
548 (and related commands), use the specified root path when looking for unit
549 files. If this option is present,
<command>systemctl
</command> will operate on
550 the file system directly, instead of communicating with the
<command>systemd
</command>
551 daemon to carry out changes.
</para>
557 <term><option>--runtime
</option></term>
560 <para>When used with
<command>set-property
</command>, make changes only
561 temporarily, so that they are lost on the next reboot.
</para>
563 <para>Similarily, when used with
<command>enable
</command>,
<command>mask
</command>,
564 <command>edit
</command> and related commands, make temporary changes, which are lost on
565 the next reboot. Changes are not made in subdirectories of
<filename>/etc
</filename>, but
566 in
<filename>/run
</filename>. The immediate effect is identical, however since the latter
567 is lost on reboot, the changes are lost too.
</para>
569 <para>Note: this option cannot be used with
<command>disable
</command>,
570 <command>unmask
</command>,
<command>preset
</command>, or
<command>preset-all
</command>,
571 because those operations sometimes need to remove symlinks under
<filename>/etc
</filename>
572 to have the desired effect, which would cause a persistent change.
</para>
577 <term><option>--preset-mode=
</option></term>
580 <para>Takes one of
<literal>full
</literal> (the default),
581 <literal>enable-only
</literal>,
582 <literal>disable-only
</literal>. When used with the
583 <command>preset
</command> or
<command>preset-all
</command>
584 commands, controls whether units shall be disabled and
585 enabled according to the preset rules, or only enabled, or
586 only disabled.
</para>
591 <term><option>-n
</option></term>
592 <term><option>--lines=
</option></term>
595 <para>When used with
<command>status
</command>, controls the
596 number of journal lines to show, counting from the most
597 recent ones. Takes a positive integer argument. Defaults to
603 <term><option>-o
</option></term>
604 <term><option>--output=
</option></term>
607 <para>When used with
<command>status
</command>, controls the
608 formatting of the journal entries that are shown. For the
609 available choices, see
610 <citerefentry><refentrytitle>journalctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
611 Defaults to
<literal>short
</literal>.
</para>
616 <term><option>--firmware-setup
</option></term>
619 <para>When used with the
<command>reboot
</command> command,
620 indicate to the system's firmware to boot into setup
621 mode. Note that this is currently only supported on some EFI
622 systems and only if the system was booted in EFI
628 <term><option>--plain
</option></term>
631 <para>When used with
<command>list-dependencies
</command>,
632 <command>list-units
</command> or
<command>list-machines
</command>,
633 the output is printed as a list instead of a tree, and the bullet
634 circles are omitted.
</para>
638 <xi:include href=
"user-system-options.xml" xpointer=
"host" />
639 <xi:include href=
"user-system-options.xml" xpointer=
"machine" />
641 <xi:include href=
"standard-options.xml" xpointer=
"no-pager" />
642 <xi:include href=
"standard-options.xml" xpointer=
"no-legend" />
643 <xi:include href=
"standard-options.xml" xpointer=
"help" />
644 <xi:include href=
"standard-options.xml" xpointer=
"version" />
649 <title>Commands
</title>
651 <para>The following commands are understood:
</para>
654 <title>Unit Commands
</title>
658 <term><command>list-units
<optional><replaceable>PATTERN
</replaceable>…
</optional></command></term>
661 <para>List units that
<command>systemd
</command> currently has in memory. This includes units that are
662 either referenced directly or through a dependency, units that are pinned by applications programmatically,
663 or units that were active in the past and have failed. By default only units which are active, have pending
664 jobs, or have failed are shown; this can be changed with option
<option>--all
</option>. If one or more
665 <replaceable>PATTERN
</replaceable>s are specified, only units matching one of them are shown. The units
666 that are shown are additionally filtered by
<option>--type=
</option> and
<option>--state=
</option> if those
667 options are specified.
</para>
669 <para>Produces output similar to
670 <programlisting> UNIT LOAD ACTIVE SUB DESCRIPTION
671 sys-module-fuse.device loaded active plugged /sys/module/fuse
672 -.mount loaded active mounted Root Mount
673 boot-efi.mount loaded active mounted /boot/efi
674 systemd-journald.service loaded active running Journal Service
675 systemd-logind.service loaded active running Login Service
676 â—Ź user@
1000.service loaded active running User Manager for UID
1000
678 systemd-tmpfiles-clean.timer loaded active waiting Daily Cleanup of Temporary Directories
680 LOAD = Reflects whether the unit definition was properly loaded.
681 ACTIVE = The high-level unit activation state, i.e. generalization of SUB.
682 SUB = The low-level unit activation state, values depend on unit type.
684 123 loaded units listed. Pass --all to see loaded but inactive units, too.
685 To show all installed unit files use 'systemctl list-unit-files'.
687 The header and the last unit of a given type are underlined if the
688 terminal supports that. A colored dot is shown next to services which
689 were masked, not found, or otherwise failed.
</para>
691 <para>The LOAD column shows the load state, one of
<constant>loaded
</constant>,
692 <constant>not-found
</constant>,
<constant>bad-setting
</constant>,
<constant>error
</constant>,
693 <constant>masked
</constant>. The ACTIVE columns shows the general unit state, one of
694 <constant>active
</constant>,
<constant>reloading
</constant>,
<constant>inactive
</constant>,
695 <constant>failed
</constant>,
<constant>activating
</constant>,
<constant>deactivating
</constant>. The SUB
696 column shows the unit-type-specific detailed state of the unit, possible values vary by unit type. The list
697 of possible LOAD, ACTIVE, and SUB states is not constant and new systemd releases may both add and remove
698 values.
<programlisting>systemctl --state=help
</programlisting> command maybe be used to display the
699 current set of possible values.
</para>
701 <para>This is the default command.
</para>
706 <term><command>list-sockets
<optional><replaceable>PATTERN
</replaceable>…
</optional></command></term>
709 <para>List socket units currently in memory, ordered by listening address. If one or more
710 <replaceable>PATTERN
</replaceable>s are specified, only socket units matching one of them are
711 shown. Produces output similar to
713 LISTEN UNIT ACTIVATES
714 /dev/initctl systemd-initctl.socket systemd-initctl.service
716 [::]:
22 sshd.socket sshd.service
717 kobject-uevent
1 systemd-udevd-kernel.socket systemd-udevd.service
719 5 sockets listed.
</programlisting>
720 Note: because the addresses might contains spaces, this output
721 is not suitable for programmatic consumption.
724 <para>Also see
<option>--show-types
</option>,
<option>--all
</option>, and
<option>--state=
</option>.
</para>
729 <term><command>list-timers
<optional><replaceable>PATTERN
</replaceable>…
</optional></command></term>
732 <para>List timer units currently in memory, ordered by the time they elapse next. If one or more
733 <replaceable>PATTERN
</replaceable>s are specified, only units matching one of them are shown.
734 Produces output similar to
736 NEXT LEFT LAST PASSED UNIT ACTIVATES
737 n/a n/a Thu
2017-
02-
23 13:
40:
29 EST
3 days ago ureadahead-stop.timer ureadahead-stop.service
738 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
739 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
740 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
744 <para><emphasis>NEXT
</emphasis> shows the next time the timer will run.
</para>
745 <para><emphasis>LEFT
</emphasis> shows how long till the next time the timer runs.
</para>
746 <para><emphasis>LAST
</emphasis> shows the last time the timer ran.
</para>
747 <para><emphasis>PASSED
</emphasis> shows how long has passed since the timer last ran.
</para>
748 <para><emphasis>UNIT
</emphasis> shows the name of the timer
</para>
749 <para><emphasis>ACTIVATES
</emphasis> shows the name the service the timer activates when it runs.
</para>
751 <para>Also see
<option>--all
</option> and
<option>--state=
</option>.
</para>
756 <term><command>start
<replaceable>PATTERN
</replaceable>…
</command></term>
759 <para>Start (activate) one or more units specified on the
762 <para>Note that glob patterns operate on the set of primary names of units currently in memory. Units which
763 are not active and are not in a failed state usually are not in memory, and will not be matched by any
764 pattern. In addition, in case of instantiated units, systemd is often unaware of the instance name until
765 the instance has been started. Therefore, using glob patterns with
<command>start
</command> has limited
766 usefulness. Also, secondary alias names of units are not considered.
</para>
770 <term><command>stop
<replaceable>PATTERN
</replaceable>…
</command></term>
773 <para>Stop (deactivate) one or more units specified on the
778 <term><command>reload
<replaceable>PATTERN
</replaceable>…
</command></term>
781 <para>Asks all units listed on the command line to reload
782 their configuration. Note that this will reload the
783 service-specific configuration, not the unit configuration
784 file of systemd. If you want systemd to reload the
785 configuration file of a unit, use the
786 <command>daemon-reload
</command> command. In other words:
787 for the example case of Apache, this will reload Apache's
788 <filename>httpd.conf
</filename> in the web server, not the
789 <filename>apache.service
</filename> systemd unit
792 <para>This command should not be confused with the
793 <command>daemon-reload
</command> command.
</para>
798 <term><command>restart
<replaceable>PATTERN
</replaceable>…
</command></term>
801 <para>Stop and then start one or more units specified on the command line. If the units are not running
802 yet, they will be started.
</para>
804 <para>Note that restarting a unit with this command does not necessarily flush out all of the unit's
805 resources before it is started again. For example, the per-service file descriptor storage facility (see
806 <varname>FileDescriptoreStoreMax=
</varname> in
807 <citerefentry><refentrytitle>systemd.service
</refentrytitle><manvolnum>5</manvolnum></citerefentry>) will
808 remain intact as long as the unit has a job pending, and is only cleared when the unit is fully stopped and
809 no jobs are pending anymore. If it is intended that the file descriptor store is flushed out, too, during a
810 restart operation an explicit
<command>systemctl stop
</command> command followed by
<command>systemctl
811 start
</command> should be issued.
</para>
815 <term><command>try-restart
<replaceable>PATTERN
</replaceable>…
</command></term>
818 <para>Stop and then start one or more units specified on the
819 command line if the units are running. This does nothing
820 if units are not running.
</para>
821 <!-- Note that we don't document condrestart here, as that is just compatibility support, and we generally
822 don't document that. -->
826 <term><command>reload-or-restart
<replaceable>PATTERN
</replaceable>…
</command></term>
829 <para>Reload one or more units if they support it. If not, stop and then start them instead. If the units
830 are not running yet, they will be started.
</para>
834 <term><command>try-reload-or-restart
<replaceable>PATTERN
</replaceable>…
</command></term>
837 <para>Reload one or more units if they support it. If not, stop and then start them instead. This does
838 nothing if the units are not running.
</para>
839 <!-- Note that we don't document force-reload here, as that is just compatibility support, and we generally
840 don't document that. -->
844 <term><command>isolate
<replaceable>UNIT
</replaceable></command></term>
847 <para>Start the unit specified on the command line and its dependencies
848 and stop all others, unless they have
849 <option>IgnoreOnIsolate=yes
</option> (see
850 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
851 If a unit name with no extension is given, an extension of
852 <literal>.target
</literal> will be assumed.
</para>
854 <para>This is similar to changing the runlevel in a
855 traditional init system. The
<command>isolate
</command>
856 command will immediately stop processes that are not enabled
857 in the new unit, possibly including the graphical
858 environment or terminal you are currently using.
</para>
860 <para>Note that this is allowed only on units where
861 <option>AllowIsolate=
</option> is enabled. See
862 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
867 <term><command>kill
<replaceable>PATTERN
</replaceable>…
</command></term>
870 <para>Send a signal to one or more processes of the
871 unit. Use
<option>--kill-who=
</option> to select which
872 process to kill. Use
<option>--signal=
</option> to select
873 the signal to send.
</para>
877 <term><command>is-active
<replaceable>PATTERN
</replaceable>…
</command></term>
880 <para>Check whether any of the specified units are active
881 (i.e. running). Returns an exit code
882 <constant>0</constant> if at least one is active, or
883 non-zero otherwise. Unless
<option>--quiet
</option> is
884 specified, this will also print the current unit state to
885 standard output.
</para>
889 <term><command>is-failed
<replaceable>PATTERN
</replaceable>…
</command></term>
892 <para>Check whether any of the specified units are in a
893 "failed" state. Returns an exit code
894 <constant>0</constant> if at least one has failed,
895 non-zero otherwise. Unless
<option>--quiet
</option> is
896 specified, this will also print the current unit state to
897 standard output.
</para>
901 <term><command>status
</command> <optional><replaceable>PATTERN
</replaceable>…|
<replaceable>PID
</replaceable>…]
</optional></term>
904 <para>Show terse runtime status information about one or
905 more units, followed by most recent log data from the
906 journal. If no units are specified, show system status. If
907 combined with
<option>--all
</option>, also show the status of
908 all units (subject to limitations specified with
909 <option>-t
</option>). If a PID is passed, show information
910 about the unit the process belongs to.
</para>
912 <para>This function is intended to generate human-readable
913 output. If you are looking for computer-parsable output,
914 use
<command>show
</command> instead. By default, this
915 function only shows
10 lines of output and ellipsizes
916 lines to fit in the terminal window. This can be changed
917 with
<option>--lines
</option> and
<option>--full
</option>,
918 see above. In addition,
<command>journalctl
919 --unit=
<replaceable>NAME
</replaceable></command> or
921 --user-unit=
<replaceable>NAME
</replaceable></command> use
922 a similar filter for messages and might be more
926 <para>systemd implicitly loads units as necessary, so just running the
<command>status
</command> will
927 attempt to load a file. The command is thus not useful for determining if something was already loaded or
928 not. The units may possibly also be quickly unloaded after the operation is completed if there's no reason
929 to keep it in memory thereafter.
933 <title>Example output from systemctl status
</title>
935 <programlisting>$ systemctl status bluetooth
936 â—Ź bluetooth.service - Bluetooth service
937 Loaded: loaded (/usr/lib/systemd/system/bluetooth.service; enabled; vendor preset: enabled)
938 Active: active (running) since Wed
2017-
01-
04 13:
54:
04 EST;
1 weeks
0 days ago
939 Docs: man:bluetoothd(
8)
940 Main PID:
930 (bluetoothd)
945 CGroup: /system.slice/bluetooth.service
946 └─
930 /usr/lib/bluetooth/bluetoothd
948 Jan
12 10:
46:
45 example.com bluetoothd[
8900]: Not enough free handles to register service
949 Jan
12 10:
46:
45 example.com bluetoothd[
8900]: Current Time Service could not be registered
950 Jan
12 10:
46:
45 example.com bluetoothd[
8900]: gatt-time-server: Input/output error (
5)
953 <para>The dot (
"â—Ź") uses color on supported terminals to summarize the unit state at a glance. White
954 indicates an
<literal>inactive
</literal> or
<literal>deactivating
</literal> state. Red indicates a
955 <literal>failed
</literal> or
<literal>error
</literal> state and green indicates an
956 <literal>active
</literal>,
<literal>reloading
</literal> or
<literal>activating
</literal> state.
959 <para>The
"Loaded:" line in the output will show
<literal>loaded
</literal> if the unit has been loaded into
960 memory. Other possible values for
"Loaded:" include:
<literal>error
</literal> if there was a problem
961 loading it,
<literal>not-found
</literal> if not unit file was found for this unit,
962 <literal>bad-setting
</literal> if an essential unit file setting could not be parsed and
963 <literal>masked
</literal> if the unit file has been masked. Along with showing the path to the unit file,
964 this line will also show the enablement state. Enabled commands start at boot. See the full table of
965 possible enablement states — including the definition of
<literal>masked
</literal> — in the documentation
966 for the
<command>is-enabled
</command> command.
969 <para>The
"Active:" line shows active state. The value is usually
<literal>active
</literal> or
970 <literal>inactive
</literal>. Active could mean started, bound, plugged in, etc depending on the unit type.
971 The unit could also be in process of changing states, reporting a state of
<literal>activating
</literal> or
972 <literal>deactivating
</literal>. A special
<literal>failed
</literal> state is entered when the service
973 failed in some way, such as a crash, exiting with an error code or timing out. If the failed state is
974 entered the cause will be logged for later reference.
</para>
980 <term><command>show
</command> <optional><replaceable>PATTERN
</replaceable>…|
<replaceable>JOB
</replaceable>…
</optional></term>
983 <para>Show properties of one or more units, jobs, or the manager itself. If no argument is specified,
984 properties of the manager will be shown. If a unit name is specified, properties of the unit are shown, and
985 if a job ID is specified, properties of the job are shown. By default, empty properties are suppressed. Use
986 <option>--all
</option> to show those too. To select specific properties to show, use
987 <option>--property=
</option>. This command is intended to be used whenever computer-parsable output is
988 required. Use
<command>status
</command> if you are looking for formatted human-readable output.
</para>
990 <para>Many properties shown by
<command>systemctl show
</command> map directly to configuration settings of
991 the system and service manager and its unit files. Note that the properties shown by the command are
992 generally more low-level, normalized versions of the original configuration settings and expose runtime
993 state in addition to configuration. For example, properties shown for service units include the service's
994 current main process identifier as
<literal>MainPID
</literal> (which is runtime state), and time settings
995 are always exposed as properties ending in the
<literal>…USec
</literal> suffix even if a matching
996 configuration options end in
<literal>…Sec
</literal>, because microseconds is the normalized time unit used
997 by the system and service manager.
</para>
1001 <term><command>cat
<replaceable>PATTERN
</replaceable>…
</command></term>
1004 <para>Show backing files of one or more units. Prints the
1005 "fragment" and
"drop-ins" (source files) of units. Each
1006 file is preceded by a comment which includes the file
1007 name. Note that this shows the contents of the backing files
1008 on disk, which may not match the system manager's
1009 understanding of these units if any unit files were
1010 updated on disk and the
<command>daemon-reload
</command>
1011 command wasn't issued since.
</para>
1015 <term><command>set-property
<replaceable>UNIT
</replaceable> <replaceable>PROPERTY
</replaceable>=
<replaceable>VALUE
</replaceable>…
</command></term>
1018 <para>Set the specified unit properties at runtime where
1019 this is supported. This allows changing configuration
1020 parameter properties such as resource control settings at
1021 runtime. Not all properties may be changed at runtime, but
1022 many resource control settings (primarily those in
1023 <citerefentry><refentrytitle>systemd.resource-control
</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
1024 may. The changes are applied immediately, and stored on disk
1025 for future boots, unless
<option>--runtime
</option> is
1026 passed, in which case the settings only apply until the
1027 next reboot. The syntax of the property assignment follows
1028 closely the syntax of assignments in unit files.
</para>
1030 <para>Example:
<command>systemctl set-property foobar.service CPUShares=
777</command></para>
1032 <para>If the specified unit appears to be inactive, the
1033 changes will be only stored on disk as described
1034 previously hence they will be effective when the unit will
1037 <para>Note that this command allows changing multiple
1038 properties at the same time, which is preferable over
1039 setting them individually. Like with unit file configuration
1040 settings, assigning an empty list will reset the property.
1046 <term><command>help
<replaceable>PATTERN
</replaceable>…|
<replaceable>PID
</replaceable>…
</command></term>
1049 <para>Show manual pages for one or more units, if
1050 available. If a PID is given, the manual pages for the unit
1051 the process belongs to are shown.
</para>
1056 <term><command>reset-failed [
<replaceable>PATTERN
</replaceable>…]
</command></term>
1059 <para>Reset the
<literal>failed
</literal> state of the specified units, or if no unit name is passed, reset
1060 the state of all units. When a unit fails in some way (i.e. process exiting with non-zero error code,
1061 terminating abnormally or timing out), it will automatically enter the
<literal>failed
</literal> state and
1062 its exit code and status is recorded for introspection by the administrator until the service is
1063 stopped/re-started or reset with this command.
</para>
1069 <command>list-dependencies
</command>
1070 <optional><replaceable>UNIT
</replaceable></optional>
1074 <para>Shows units required and wanted by the specified
1075 unit. This recursively lists units following the
1076 <varname>Requires=
</varname>,
1077 <varname>Requisite=
</varname>,
1078 <varname>ConsistsOf=
</varname>,
1079 <varname>Wants=
</varname>,
<varname>BindsTo=
</varname>
1080 dependencies. If no unit is specified,
1081 <filename>default.target
</filename> is implied.
</para>
1083 <para>By default, only target units are recursively
1084 expanded. When
<option>--all
</option> is passed, all other
1085 units are recursively expanded as well.
</para>
1087 <para>Options
<option>--reverse
</option>,
1088 <option>--after
</option>,
<option>--before
</option>
1089 may be used to change what types of dependencies
1097 <title>Unit File Commands
</title>
1101 <term><command>list-unit-files
<optional><replaceable>PATTERN…
</replaceable></optional></command></term>
1104 <para>List unit files installed on the system, in combination with their enablement state (as reported by
1105 <command>is-enabled
</command>). If one or more
<replaceable>PATTERN
</replaceable>s are specified, only unit
1106 files whose name matches one of them are shown (patterns matching unit file system paths are not
1112 <term><command>enable
<replaceable>UNIT
</replaceable>…
</command></term>
1113 <term><command>enable
<replaceable>PATH
</replaceable>…
</command></term>
1116 <para>Enable one or more units or unit instances. This will create a set of symlinks, as encoded in the
1117 <literal>[Install]
</literal> sections of the indicated unit files. After the symlinks have been created,
1118 the system manager configuration is reloaded (in a way equivalent to
<command>daemon-reload
</command>), in
1119 order to ensure the changes are taken into account immediately. Note that this does
1120 <emphasis>not
</emphasis> have the effect of also starting any of the units being enabled. If this is
1121 desired, combine this command with the
<option>--now
</option> switch, or invoke
<command>start
</command>
1122 with appropriate arguments later. Note that in case of unit instance enablement (i.e. enablement of units of
1123 the form
<filename>foo@bar.service
</filename>), symlinks named the same as instances are created in the
1124 unit configuration directory, however they point to the single template unit file they are instantiated
1127 <para>This command expects either valid unit names (in which case various unit file directories are
1128 automatically searched for unit files with appropriate names), or absolute paths to unit files (in which
1129 case these files are read directly). If a specified unit file is located outside of the usual unit file
1130 directories, an additional symlink is created, linking it into the unit configuration path, thus ensuring
1131 it is found when requested by commands such as
<command>start
</command>. The file system where the linked
1132 unit files are located must be accessible when systemd is started (e.g. anything underneath
1133 <filename>/home
</filename> or
<filename>/var
</filename> is not allowed, unless those directories are
1134 located on the root file system).
</para>
1136 <para>This command will print the file system operations executed. This output may be suppressed by passing
1137 <option>--quiet
</option>.
1140 <para>Note that this operation creates only the symlinks suggested in the
<literal>[Install]
</literal>
1141 section of the unit files. While this command is the recommended way to manipulate the unit configuration
1142 directory, the administrator is free to make additional changes manually by placing or removing symlinks
1143 below this directory. This is particularly useful to create configurations that deviate from the suggested
1144 default installation. In this case, the administrator must make sure to invoke
1145 <command>daemon-reload
</command> manually as necessary, in order to ensure the changes are taken into
1149 <para>Enabling units should not be confused with starting (activating) units, as done by the
1150 <command>start
</command> command. Enabling and starting units is orthogonal: units may be enabled without
1151 being started and started without being enabled. Enabling simply hooks the unit into various suggested
1152 places (for example, so that the unit is automatically started on boot or when a particular kind of
1153 hardware is plugged in). Starting actually spawns the daemon process (in case of service units), or binds
1154 the socket (in case of socket units), and so on.
</para>
1156 <para>Depending on whether
<option>--system
</option>,
<option>--user
</option>,
<option>--runtime
</option>,
1157 or
<option>--global
</option> is specified, this enables the unit for the system, for the calling user only,
1158 for only this boot of the system, or for all future logins of all users. Note that in the last case, no
1159 systemd daemon configuration is reloaded.
</para>
1161 <para>Using
<command>enable
</command> on masked units is not supported and results in an error.
</para>
1166 <term><command>disable
<replaceable>UNIT
</replaceable>…
</command></term>
1169 <para>Disables one or more units. This removes all symlinks to the unit files backing the specified units
1170 from the unit configuration directory, and hence undoes any changes made by
<command>enable
</command> or
1171 <command>link
</command>. Note that this removes
<emphasis>all
</emphasis> symlinks to matching unit files,
1172 including manually created symlinks, and not just those actually created by
<command>enable
</command> or
1173 <command>link
</command>. Note that while
<command>disable
</command> undoes the effect of
1174 <command>enable
</command>, the two commands are otherwise not symmetric, as
<command>disable
</command> may
1175 remove more symlinks than a prior
<command>enable
</command> invocation of the same unit created.
</para>
1177 <para>This command expects valid unit names only, it does not accept paths to unit files.
</para>
1179 <para>In addition to the units specified as arguments, all units are disabled that are listed in the
1180 <varname>Also=
</varname> setting contained in the
<literal>[Install]
</literal> section of any of the unit
1181 files being operated on.
</para>
1183 <para>This command implicitly reloads the system manager configuration after completing the operation. Note
1184 that this command does not implicitly stop the units that are being disabled. If this is desired, either
1185 combine this command with the
<option>--now
</option> switch, or invoke the
<command>stop
</command> command
1186 with appropriate arguments later.
</para>
1188 <para>This command will print information about the file system operations (symlink removals)
1189 executed. This output may be suppressed by passing
<option>--quiet
</option>.
1192 <para>This command honors
<option>--system
</option>,
<option>--user
</option>,
<option>--runtime
</option>
1193 and
<option>--global
</option> in a similar way as
<command>enable
</command>.
</para>
1198 <term><command>reenable
<replaceable>UNIT
</replaceable>…
</command></term>
1201 <para>Reenable one or more units, as specified on the command line. This is a combination of
1202 <command>disable
</command> and
<command>enable
</command> and is useful to reset the symlinks a unit file is
1203 enabled with to the defaults configured in its
<literal>[Install]
</literal> section. This command expects
1204 a unit name only, it does not accept paths to unit files.
</para>
1209 <term><command>preset
<replaceable>UNIT
</replaceable>…
</command></term>
1212 <para>Reset the enable/disable status one or more unit files, as specified on
1213 the command line, to the defaults configured in the preset policy files. This
1214 has the same effect as
<command>disable
</command> or
1215 <command>enable
</command>, depending how the unit is listed in the preset
1218 <para>Use
<option>--preset-mode=
</option> to control whether units shall be
1219 enabled and disabled, or only enabled, or only disabled.
</para>
1221 <para>If the unit carries no install information, it will be silently ignored
1222 by this command.
<replaceable>UNIT
</replaceable> must be the real unit name,
1223 any alias names are ignored silently.
</para>
1225 <para>For more information on the preset policy format, see
1226 <citerefentry><refentrytitle>systemd.preset
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1227 For more information on the concept of presets, please consult the
1228 <ulink url=
"https://www.freedesktop.org/wiki/Software/systemd/Preset">Preset
</ulink>
1234 <term><command>preset-all
</command></term>
1237 <para>Resets all installed unit files to the defaults
1238 configured in the preset policy file (see above).
</para>
1240 <para>Use
<option>--preset-mode=
</option> to control
1241 whether units shall be enabled and disabled, or only
1242 enabled, or only disabled.
</para>
1247 <term><command>is-enabled
<replaceable>UNIT
</replaceable>…
</command></term>
1250 <para>Checks whether any of the specified unit files are
1251 enabled (as with
<command>enable
</command>). Returns an
1252 exit code of
0 if at least one is enabled, non-zero
1253 otherwise. Prints the current enable status (see table).
1254 To suppress this output, use
<option>--quiet
</option>.
1255 To show installation targets, use
<option>--full
</option>.
1260 <command>is-enabled
</command> output
1267 <entry>Description
</entry>
1268 <entry>Exit Code
</entry>
1273 <entry><literal>enabled
</literal></entry>
1274 <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>
1275 <entry morerows='
1'
>0</entry>
1278 <entry><literal>enabled-runtime
</literal></entry>
1281 <entry><literal>linked
</literal></entry>
1282 <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>
1283 <entry morerows='
1'
>> 0</entry>
1286 <entry><literal>linked-runtime
</literal></entry>
1289 <entry><literal>masked
</literal></entry>
1290 <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>
1291 <entry morerows='
1'
>> 0</entry>
1294 <entry><literal>masked-runtime
</literal></entry>
1297 <entry><literal>static
</literal></entry>
1298 <entry>The unit file is not enabled, and has no provisions for enabling in the
<literal>[Install]
</literal> unit file section.
</entry>
1302 <entry><literal>indirect
</literal></entry>
1303 <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>
1307 <entry><literal>disabled
</literal></entry>
1308 <entry>The unit file is not enabled, but contains an
<literal>[Install]
</literal> section with installation instructions.
</entry>
1309 <entry>> 0</entry>
1312 <entry><literal>generated
</literal></entry>
1313 <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>
1317 <entry><literal>transient
</literal></entry>
1318 <entry>The unit file has been created dynamically with the runtime API. Transient units may not be enabled.
</entry>
1322 <entry><literal>bad
</literal></entry>
1323 <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>
1324 <entry>> 0</entry>
1334 <term><command>mask
<replaceable>UNIT
</replaceable>…
</command></term>
1337 <para>Mask one or more units, as specified on the command line. This will link these unit files to
1338 <filename>/dev/null
</filename>, making it impossible to start them. This is a stronger version of
1339 <command>disable
</command>, since it prohibits all kinds of activation of the unit, including enablement
1340 and manual activation. Use this option with care. This honors the
<option>--runtime
</option> option to only
1341 mask temporarily until the next reboot of the system. The
<option>--now
</option> option may be used to
1342 ensure that the units are also stopped. This command expects valid unit names only, it does not accept unit
1348 <term><command>unmask
<replaceable>UNIT
</replaceable>…
</command></term>
1351 <para>Unmask one or more unit files, as specified on the command line. This will undo the effect of
1352 <command>mask
</command>. This command expects valid unit names only, it does not accept unit file
1358 <term><command>link
<replaceable>PATH
</replaceable>…
</command></term>
1361 <para>Link a unit file that is not in the unit file search paths into the unit file search path. This
1362 command expects an absolute path to a unit file. The effect of this may be undone with
1363 <command>disable
</command>. The effect of this command is that a unit file is made available for commands
1364 such as
<command>start
</command>, even though it is not installed directly in the unit search path. The
1365 file system where the linked unit files are located must be accessible when systemd is started
1366 (e.g. anything underneath
<filename>/home
</filename> or
<filename>/var
</filename> is not allowed, unless
1367 those directories are located on the root file system).
</para>
1372 <term><command>revert
<replaceable>UNIT
</replaceable>…
</command></term>
1375 <para>Revert one or more unit files to their vendor versions. This command removes drop-in configuration
1376 files that modify the specified units, as well as any user-configured unit file that overrides a matching
1377 vendor supplied unit file. Specifically, for a unit
<literal>foo.service
</literal> the matching directories
1378 <literal>foo.service.d/
</literal> with all their contained files are removed, both below the persistent and
1379 runtime configuration directories (i.e. below
<filename>/etc/systemd/system
</filename> and
1380 <filename>/run/systemd/system
</filename>); if the unit file has a vendor-supplied version (i.e. a unit file
1381 located below
<filename>/usr
</filename>) any matching persistent or runtime unit file that overrides it is
1382 removed, too. Note that if a unit file has no vendor-supplied version (i.e. is only defined below
1383 <filename>/etc/systemd/system
</filename> or
<filename>/run/systemd/system
</filename>, but not in a unit
1384 file stored below
<filename>/usr
</filename>), then it is not removed. Also, if a unit is masked, it is
1387 <para>Effectively, this command may be used to undo all changes made with
<command>systemctl
1388 edit
</command>,
<command>systemctl set-property
</command> and
<command>systemctl mask
</command> and puts
1389 the original unit file with its settings back in effect.
</para>
1394 <term><command>add-wants
<replaceable>TARGET
</replaceable>
1395 <replaceable>UNIT
</replaceable>…
</command></term>
1396 <term><command>add-requires
<replaceable>TARGET
</replaceable>
1397 <replaceable>UNIT
</replaceable>…
</command></term>
1400 <para>Adds
<literal>Wants=
</literal> or
<literal>Requires=
</literal>
1401 dependencies, respectively, to the specified
1402 <replaceable>TARGET
</replaceable> for one or more units.
</para>
1404 <para>This command honors
<option>--system
</option>,
1405 <option>--user
</option>,
<option>--runtime
</option> and
1406 <option>--global
</option> in a way similar to
1407 <command>enable
</command>.
</para>
1413 <term><command>edit
<replaceable>UNIT
</replaceable>…
</command></term>
1416 <para>Edit a drop-in snippet or a whole replacement file if
1417 <option>--full
</option> is specified, to extend or override the
1418 specified unit.
</para>
1420 <para>Depending on whether
<option>--system
</option> (the default),
1421 <option>--user
</option>, or
<option>--global
</option> is specified,
1422 this command creates a drop-in file for each unit either for the system,
1423 for the calling user, or for all futures logins of all users. Then,
1424 the editor (see the
"Environment" section below) is invoked on
1425 temporary files which will be written to the real location if the
1426 editor exits successfully.
</para>
1428 <para>If
<option>--full
</option> is specified, this will copy the
1429 original units instead of creating drop-in files.
</para>
1431 <para>If
<option>--force
</option> is specified and any units do
1432 not already exist, new unit files will be opened for editing.
</para>
1434 <para>If
<option>--runtime
</option> is specified, the changes will
1435 be made temporarily in
<filename>/run
</filename> and they will be
1436 lost on the next reboot.
</para>
1438 <para>If the temporary file is empty upon exit, the modification of
1439 the related unit is canceled.
</para>
1441 <para>After the units have been edited, systemd configuration is
1442 reloaded (in a way that is equivalent to
<command>daemon-reload
</command>).
1445 <para>Note that this command cannot be used to remotely edit units
1446 and that you cannot temporarily edit units which are in
1447 <filename>/etc
</filename>, since they take precedence over
1448 <filename>/run
</filename>.
</para>
1453 <term><command>get-default
</command></term>
1456 <para>Return the default target to boot into. This returns
1457 the target unit name
<filename>default.target
</filename>
1458 is aliased (symlinked) to.
</para>
1463 <term><command>set-default
<replaceable>TARGET
</replaceable></command></term>
1466 <para>Set the default target to boot into. This sets
1467 (symlinks) the
<filename>default.target
</filename> alias
1468 to the given target unit.
</para>
1476 <title>Machine Commands
</title>
1480 <term><command>list-machines
<optional><replaceable>PATTERN
</replaceable>…
</optional></command></term>
1483 <para>List the host and all running local containers with
1484 their state. If one or more
1485 <replaceable>PATTERN
</replaceable>s are specified, only
1486 containers matching one of them are shown.
1494 <title>Job Commands
</title>
1498 <term><command>list-jobs
<optional><replaceable>PATTERN…
</replaceable></optional></command></term>
1501 <para>List jobs that are in progress. If one or more
1502 <replaceable>PATTERN
</replaceable>s are specified, only
1503 jobs for units matching one of them are shown.
</para>
1505 <para>When combined with
<option>--after
</option> or
<option>--before
</option> the list is augmented with
1506 information on which other job each job is waiting for, and which other jobs are waiting for it, see
1511 <term><command>cancel
<replaceable>JOB
</replaceable>…
</command></term>
1514 <para>Cancel one or more jobs specified on the command line
1515 by their numeric job IDs. If no job ID is specified, cancel
1516 all pending jobs.
</para>
1523 <title>Environment Commands
</title>
1527 <term><command>show-environment
</command></term>
1530 <para>Dump the systemd manager environment block. This is the environment
1531 block that is passed to all processes the manager spawns. The environment
1532 block will be dumped in straight-forward form suitable for sourcing into
1533 most shells. If no special characters or whitespace is present in the variable
1534 values, no escaping is performed, and the assignments have the form
1535 <literal>VARIABLE=value
</literal>. If whitespace or characters which have
1536 special meaning to the shell are present, dollar-single-quote escaping is
1537 used, and assignments have the form
<literal>VARIABLE=$'value'
</literal>.
1538 This syntax is known to be supported by
1539 <citerefentry project='die-net'
><refentrytitle>bash
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1540 <citerefentry project='die-net'
><refentrytitle>zsh
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1541 <citerefentry project='die-net'
><refentrytitle>ksh
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1543 <citerefentry project='die-net'
><refentrytitle>busybox
</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
1544 <citerefentry project='die-net'
><refentrytitle>ash
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1546 <citerefentry project='die-net'
><refentrytitle>dash
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
1548 <citerefentry project='die-net'
><refentrytitle>fish
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
1553 <term><command>set-environment
<replaceable>VARIABLE=VALUE
</replaceable>…
</command></term>
1556 <para>Set one or more systemd manager environment variables,
1557 as specified on the command line.
</para>
1561 <term><command>unset-environment
<replaceable>VARIABLE
</replaceable>…
</command></term>
1564 <para>Unset one or more systemd manager environment
1565 variables. If only a variable name is specified, it will be
1566 removed regardless of its value. If a variable and a value
1567 are specified, the variable is only removed if it has the
1568 specified value.
</para>
1573 <command>import-environment
</command>
1574 <optional><replaceable>VARIABLE…
</replaceable></optional>
1578 <para>Import all, one or more environment variables set on
1579 the client into the systemd manager environment block. If
1580 no arguments are passed, the entire environment block is
1581 imported. Otherwise, a list of one or more environment
1582 variable names should be passed, whose client-side values
1583 are then imported into the manager's environment
1591 <title>Manager Lifecycle Commands
</title>
1595 <term><command>daemon-reload
</command></term>
1598 <para>Reload the systemd manager configuration. This will
1599 rerun all generators (see
1600 <citerefentry><refentrytitle>systemd.generator
</refentrytitle><manvolnum>7</manvolnum></citerefentry>),
1601 reload all unit files, and recreate the entire dependency
1602 tree. While the daemon is being reloaded, all sockets
1603 systemd listens on behalf of user configuration will stay
1606 <para>This command should not be confused with the
1607 <command>reload
</command> command.
</para>
1611 <term><command>daemon-reexec
</command></term>
1614 <para>Reexecute the systemd manager. This will serialize the
1615 manager state, reexecute the process and deserialize the
1616 state again. This command is of little use except for
1617 debugging and package upgrades. Sometimes, it might be
1618 helpful as a heavy-weight
<command>daemon-reload
</command>.
1619 While the daemon is being reexecuted, all sockets systemd listening
1620 on behalf of user configuration will stay accessible.
1628 <title>System Commands
</title>
1632 <term><command>is-system-running
</command></term>
1635 <para>Checks whether the system is operational. This
1636 returns success (exit code
0) when the system is fully up
1637 and running, specifically not in startup, shutdown or
1638 maintenance mode, and with no failed services. Failure is
1639 returned otherwise (exit code non-zero). In addition, the
1640 current state is printed in a short string to standard
1641 output, see the table below. Use
<option>--quiet
</option> to
1642 suppress this output.
</para>
1645 <title><command>is-system-running
</command> output
</title>
1647 <colspec colname='name'
/>
1648 <colspec colname='description'
/>
1649 <colspec colname='exit-code'
/>
1653 <entry>Description
</entry>
1654 <entry>Exit Code
</entry>
1659 <entry><varname>initializing
</varname></entry>
1660 <entry><para>Early bootup, before
1661 <filename>basic.target
</filename> is reached
1662 or the
<varname>maintenance
</varname> state entered.
1664 <entry>> 0</entry>
1667 <entry><varname>starting
</varname></entry>
1668 <entry><para>Late bootup, before the job queue
1669 becomes idle for the first time, or one of the
1670 rescue targets are reached.
</para></entry>
1671 <entry>> 0</entry>
1674 <entry><varname>running
</varname></entry>
1675 <entry><para>The system is fully
1676 operational.
</para></entry>
1680 <entry><varname>degraded
</varname></entry>
1681 <entry><para>The system is operational but one or more
1682 units failed.
</para></entry>
1683 <entry>> 0</entry>
1686 <entry><varname>maintenance
</varname></entry>
1687 <entry><para>The rescue or emergency target is
1688 active.
</para></entry>
1689 <entry>> 0</entry>
1692 <entry><varname>stopping
</varname></entry>
1693 <entry><para>The manager is shutting
1694 down.
</para></entry>
1695 <entry>> 0</entry>
1698 <entry><varname>offline
</varname></entry>
1699 <entry><para>The manager is not
1700 running. Specifically, this is the operational
1701 state if an incompatible program is running as
1702 system manager (PID
1).
</para></entry>
1703 <entry>> 0</entry>
1706 <entry><varname>unknown
</varname></entry>
1707 <entry><para>The operational state could not be
1708 determined, due to lack of resources or another
1709 error cause.
</para></entry>
1710 <entry>> 0</entry>
1719 <term><command>default
</command></term>
1722 <para>Enter default mode. This is equivalent to
<command>systemctl isolate default.target
</command>. This
1723 operation is blocking by default, use
<option>--no-block
</option> to request asynchronous behavior.
</para>
1728 <term><command>rescue
</command></term>
1731 <para>Enter rescue mode. This is equivalent to
<command>systemctl isolate rescue.target
</command>. This
1732 operation is blocking by default, use
<option>--no-block
</option> to request asynchronous behavior.
</para>
1736 <term><command>emergency
</command></term>
1739 <para>Enter emergency mode. This is equivalent to
<command>systemctl isolate
1740 emergency.target
</command>. This operation is blocking by default, use
<option>--no-block
</option> to
1741 request asynchronous behavior.
</para>
1745 <term><command>halt
</command></term>
1748 <para>Shut down and halt the system. This is mostly equivalent to
<command>systemctl start halt.target
1749 --job-mode=replace-irreversibly --no-block
</command>, but also prints a wall message to all users. This command is
1750 asynchronous; it will return after the halt operation is enqueued, without waiting for it to complete. Note
1751 that this operation will simply halt the OS kernel after shutting down, leaving the hardware powered
1752 on. Use
<command>systemctl poweroff
</command> for powering off the system (see below).
</para>
1754 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1755 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1756 system halt. If
<option>--force
</option> is specified twice, the operation is immediately executed without
1757 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1758 <option>--force
</option> is specified twice the halt operation is executed by
<command>systemctl
</command>
1759 itself, and the system manager is not contacted. This means the command should succeed even when the system
1760 manager has crashed.
</para>
1764 <term><command>poweroff
</command></term>
1767 <para>Shut down and power-off the system. This is mostly equivalent to
<command>systemctl start
1768 poweroff.target --job-mode=replace-irreversibly --no-block
</command>, but also prints a wall message to all
1769 users. This command is asynchronous; it will return after the power-off operation is enqueued, without
1770 waiting for it to complete.
</para>
1772 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1773 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1774 powering off. If
<option>--force
</option> is specified twice, the operation is immediately executed without
1775 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1776 <option>--force
</option> is specified twice the power-off operation is executed by
1777 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
1778 succeed even when the system manager has crashed.
</para>
1782 <term><command>reboot
<optional><replaceable>arg
</replaceable></optional></command></term>
1785 <para>Shut down and reboot the system. This is mostly equivalent to
<command>systemctl start reboot.target
1786 --job-mode=replace-irreversibly --no-block
</command>, but also prints a wall message to all users. This
1787 command is asynchronous; it will return after the reboot operation is enqueued, without waiting for it to
1790 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1791 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1792 reboot. If
<option>--force
</option> is specified twice, the operation is immediately executed without
1793 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1794 <option>--force
</option> is specified twice the reboot operation is executed by
1795 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
1796 succeed even when the system manager has crashed.
</para>
1798 <para>If the optional argument
<replaceable>arg
</replaceable> is given, it will be passed as the optional
1799 argument to the
<citerefentry><refentrytitle>reboot
</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1800 system call. The value is architecture and firmware specific. As an example,
<literal>recovery
</literal>
1801 might be used to trigger system recovery, and
<literal>fota
</literal> might be used to trigger a
1802 <quote>firmware over the air
</quote> update.
</para>
1807 <term><command>kexec
</command></term>
1810 <para>Shut down and reboot the system via
<command>kexec
</command>. This is equivalent to
1811 <command>systemctl start kexec.target --job-mode=replace-irreversibly --no-block
</command>. This command is
1812 asynchronous; it will return after the reboot operation is enqueued, without waiting for it to
1815 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1816 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1822 <term><command>exit
<optional><replaceable>EXIT_CODE
</replaceable></optional></command></term>
1825 <para>Ask the service manager to quit. This is only supported for user service managers (i.e. in
1826 conjunction with the
<option>--user
</option> option) or in containers and is equivalent to
1827 <command>poweroff
</command> otherwise. This command is asynchronous; it will return after the exit
1828 operation is enqueued, without waiting for it to complete.
</para>
1830 <para>The service manager will exit with the specified exit code, if
1831 <replaceable>EXIT_CODE
</replaceable> is passed.
</para>
1836 <term><command>switch-root
<replaceable>ROOT
</replaceable> <optional><replaceable>INIT
</replaceable></optional></command></term>
1839 <para>Switches to a different root directory and executes a new system manager process below it. This is
1840 intended for usage in initial RAM disks (
"initrd"), and will transition from the initrd's system manager
1841 process (a.k.a.
"init" process) to the main system manager process which is loaded from the actual host
1842 volume. This call takes two arguments: the directory that is to become the new root directory, and the path
1843 to the new system manager binary below it to execute as PID
1. If the latter is omitted or the empty
1844 string, a systemd binary will automatically be searched for and used as init. If the system manager path is
1845 omitted, equal to the empty string or identical to the path to the systemd binary, the state of the
1846 initrd's system manager process is passed to the main system manager, which allows later introspection of
1847 the state of the services involved in the initrd boot phase.
</para>
1852 <term><command>suspend
</command></term>
1855 <para>Suspend the system. This will trigger activation of the special target unit
1856 <filename>suspend.target
</filename>. This command is asynchronous, and will return after the suspend
1857 operation is successfully enqueued. It will not wait for the suspend/resume cycle to complete.
</para>
1862 <term><command>hibernate
</command></term>
1865 <para>Hibernate the system. This will trigger activation of the special target unit
1866 <filename>hibernate.target
</filename>. This command is asynchronous, and will return after the hibernation
1867 operation is successfully enqueued. It will not wait for the hibernate/thaw cycle to complete.
</para>
1872 <term><command>hybrid-sleep
</command></term>
1875 <para>Hibernate and suspend the system. This will trigger activation of the special target unit
1876 <filename>hybrid-sleep.target
</filename>. This command is asynchronous, and will return after the hybrid
1877 sleep operation is successfully enqueued. It will not wait for the sleep/wake-up cycle to complete.
</para>
1884 <title>Parameter Syntax
</title>
1886 <para>Unit commands listed above take either a single unit name (designated as
<replaceable>UNIT
</replaceable>),
1887 or multiple unit specifications (designated as
<replaceable>PATTERN
</replaceable>…). In the first case, the
1888 unit name with or without a suffix must be given. If the suffix is not specified (unit name is
"abbreviated"),
1889 systemctl will append a suitable suffix,
<literal>.service
</literal> by default, and a type-specific suffix in
1890 case of commands which operate only on specific unit types. For example,
1891 <programlisting># systemctl start sshd
</programlisting> and
1892 <programlisting># systemctl start sshd.service
</programlisting>
1893 are equivalent, as are
1894 <programlisting># systemctl isolate default
</programlisting>
1896 <programlisting># systemctl isolate default.target
</programlisting>
1897 Note that (absolute) paths to device nodes are automatically converted to device unit names, and other (absolute)
1898 paths to mount unit names.
1899 <programlisting># systemctl status /dev/sda
1900 # systemctl status /home
</programlisting>
1902 <programlisting># systemctl status dev-sda.device
1903 # systemctl status home.mount
</programlisting>
1904 In the second case, shell-style globs will be matched against the primary names of all units currently in memory;
1905 literal unit names, with or without a suffix, will be treated as in the first case. This means that literal unit
1906 names always refer to exactly one unit, but globs may match zero units and this is not considered an
1909 <para>Glob patterns use
1910 <citerefentry project='man-pages'
><refentrytitle>fnmatch
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
1911 so normal shell-style globbing rules are used, and
1912 <literal>*
</literal>,
<literal>?
</literal>,
1913 <literal>[]
</literal> may be used. See
1914 <citerefentry project='man-pages'
><refentrytitle>glob
</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1915 for more details. The patterns are matched against the primary names of
1916 units currently in memory, and patterns which do not match anything
1917 are silently skipped. For example:
1918 <programlisting># systemctl stop sshd@*.service
</programlisting>
1919 will stop all
<filename>sshd@.service
</filename> instances. Note that alias names of units, and units that aren't
1920 in memory are not considered for glob expansion.
1923 <para>For unit file commands, the specified
<replaceable>UNIT
</replaceable> should be the name of the unit file
1924 (possibly abbreviated, see above), or the absolute path to the unit file:
1925 <programlisting># systemctl enable foo.service
</programlisting>
1927 <programlisting># systemctl link /path/to/foo.service
</programlisting>
1934 <title>Exit status
</title>
1936 <para>On success,
0 is returned, a non-zero failure
1937 code otherwise.
</para>
1941 <title>Environment
</title>
1943 <variablelist class='environment-variables'
>
1945 <term><varname>$SYSTEMD_EDITOR
</varname></term>
1947 <listitem><para>Editor to use when editing units; overrides
1948 <varname>$EDITOR
</varname> and
<varname>$VISUAL
</varname>. If neither
1949 <varname>$SYSTEMD_EDITOR
</varname> nor
<varname>$EDITOR
</varname> nor
1950 <varname>$VISUAL
</varname> are present or if it is set to an empty
1951 string or if their execution failed, systemctl will try to execute well
1952 known editors in this order:
1953 <citerefentry project='die-net'
><refentrytitle>editor
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1954 <citerefentry project='die-net'
><refentrytitle>nano
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1955 <citerefentry project='die-net'
><refentrytitle>vim
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1956 <citerefentry project='die-net'
><refentrytitle>vi
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
1960 <xi:include href=
"less-variables.xml" xpointer=
"pager"/>
1961 <xi:include href=
"less-variables.xml" xpointer=
"less"/>
1962 <xi:include href=
"less-variables.xml" xpointer=
"lesscharset"/>
1966 <title>See Also
</title>
1968 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1969 <citerefentry><refentrytitle>journalctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1970 <citerefentry><refentrytitle>loginctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1971 <citerefentry><refentrytitle>machinectl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1972 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1973 <citerefentry><refentrytitle>systemd.resource-control
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1974 <citerefentry><refentrytitle>systemd.special
</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1975 <citerefentry project='man-pages'
><refentrytitle>wall
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1976 <citerefentry><refentrytitle>systemd.preset
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1977 <citerefentry><refentrytitle>systemd.generator
</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1978 <citerefentry project='man-pages'
><refentrytitle>glob
</refentrytitle><manvolnum>7</manvolnum></citerefentry>
projects / thirdparty / systemd.git / blob