2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
4 <!ENTITY % entities SYSTEM
"custom-entities.ent" >
7 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
9 <refentry id=
"systemctl"
10 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
13 <title>systemctl
</title>
14 <productname>systemd
</productname>
18 <refentrytitle>systemctl
</refentrytitle>
19 <manvolnum>1</manvolnum>
23 <refname>systemctl
</refname>
24 <refpurpose>Control the systemd system and service manager
</refpurpose>
29 <command>systemctl
</command>
30 <arg choice=
"opt" rep=
"repeat">OPTIONS
</arg>
31 <arg choice=
"plain">COMMAND
</arg>
32 <arg choice=
"opt" rep=
"repeat">UNIT
</arg>
37 <title>Description
</title>
39 <para><command>systemctl
</command> may be used to introspect and
40 control the state of the
<literal>systemd
</literal> system and
41 service manager. Please refer to
42 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
43 for an introduction into the basic concepts and functionality this
48 <title>Options
</title>
50 <para>The following options are understood:
</para>
54 <term><option>-t
</option></term>
55 <term><option>--type=
</option></term>
58 <para>The argument should be a comma-separated list of unit
59 types such as
<option>service
</option> and
60 <option>socket
</option>.
63 <para>If one of the arguments is a unit type, when listing
64 units, limit display to certain unit types. Otherwise, units
65 of all types will be shown.
</para>
67 <para>As a special case, if one of the arguments is
68 <option>help
</option>, a list of allowed values will be
69 printed and the program will exit.
</para>
74 <term><option>--state=
</option></term>
77 <para>The argument should be a comma-separated list of unit
78 LOAD, SUB, or ACTIVE states. When listing units, show only
79 those in the specified states. Use
<option>--state=failed
</option>
80 to show only failed units.
</para>
82 <para>As a special case, if one of the arguments is
83 <option>help
</option>, a list of allowed values will be
84 printed and the program will exit.
</para>
89 <term><option>-p
</option></term>
90 <term><option>--property=
</option></term>
93 <para>When showing unit/job/manager properties with the
94 <command>show
</command> command, limit display to properties
95 specified in the argument. The argument should be a
96 comma-separated list of property names, such as
97 <literal>MainPID
</literal>. Unless specified, all known
98 properties are shown. If specified more than once, all
99 properties with the specified names are shown. Shell
100 completion is implemented for property names.
</para>
102 <para>For the manager itself,
103 <command>systemctl show
</command> will show all available
104 properties. Those properties are documented in
105 <citerefentry><refentrytitle>systemd-system.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
108 <para>Properties for units vary by unit type, so showing any
109 unit (even a non-existent one) is a way to list properties
110 pertaining to this type. Similarly, showing any job will list
111 properties pertaining to all jobs. Properties for units are
113 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
114 and the pages for individual unit types
115 <citerefentry><refentrytitle>systemd.service
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
116 <citerefentry><refentrytitle>systemd.socket
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
122 <term><option>-a
</option></term>
123 <term><option>--all
</option></term>
126 <para>When listing units with
<command>list-units
</command>, also show inactive units and
127 units which are following other units. When showing unit/job/manager properties, show all
128 properties regardless whether they are set or not.
</para>
130 <para>To list all units installed in the file system, use the
131 <command>list-unit-files
</command> command instead.
</para>
133 <para>When listing units with
<command>list-dependencies
</command>, recursively show
134 dependencies of all dependent units (by default only dependencies of target units are
137 <para>When used with
<command>status
</command>, show journal messages in full, even if they include
138 unprintable characters or are very long. By default, fields with unprintable characters are
139 abbreviated as
"blob data". (Note that the pager may escape unprintable characters again.)
</para>
144 <term><option>-r
</option></term>
145 <term><option>--recursive
</option></term>
148 <para>When listing units, also show units of local
149 containers. Units of local containers will be prefixed with
150 the container name, separated by a single colon character
151 (
<literal>:
</literal>).
</para>
156 <term><option>--reverse
</option></term>
159 <para>Show reverse dependencies between units with
160 <command>list-dependencies
</command>, i.e. follow
161 dependencies of type
<varname>WantedBy=
</varname>,
162 <varname>RequiredBy=
</varname>,
163 <varname>PartOf=
</varname>,
<varname>BoundBy=
</varname>,
164 instead of
<varname>Wants=
</varname> and similar.
170 <term><option>--after
</option></term>
173 <para>With
<command>list-dependencies
</command>, show the
174 units that are ordered before the specified unit. In other
175 words, recursively list units following the
176 <varname>After=
</varname> dependency.
</para>
178 <para>Note that any
<varname>After=
</varname> dependency is
179 automatically mirrored to create a
180 <varname>Before=
</varname> dependency. Temporal dependencies
181 may be specified explicitly, but are also created implicitly
182 for units which are
<varname>WantedBy=
</varname> targets
184 <citerefentry><refentrytitle>systemd.target
</refentrytitle><manvolnum>5</manvolnum></citerefentry>),
185 and as a result of other directives (for example
186 <varname>RequiresMountsFor=
</varname>). Both explicitly
187 and implicitly introduced dependencies are shown with
188 <command>list-dependencies
</command>.
</para>
190 <para>When passed to the
<command>list-jobs
</command> command, for each printed job show which other jobs are
191 waiting for it. May be combined with
<option>--before
</option> to show both the jobs waiting for each job as
192 well as all jobs each job is waiting for.
</para>
197 <term><option>--before
</option></term>
200 <para>With
<command>list-dependencies
</command>, show the
201 units that are ordered after the specified unit. In other
202 words, recursively list units following the
203 <varname>Before=
</varname> dependency.
</para>
205 <para>When passed to the
<command>list-jobs
</command> command, for each printed job show which other jobs it
206 is waiting for. May be combined with
<option>--after
</option> to show both the jobs waiting for each job as
207 well as all jobs each job is waiting for.
</para>
212 <term><option>-l
</option></term>
213 <term><option>--full
</option></term>
216 <para>Do not ellipsize unit names, process tree entries,
217 journal output, or truncate unit descriptions in the output
218 of
<command>status
</command>,
<command>list-units
</command>,
219 <command>list-jobs
</command>, and
220 <command>list-timers
</command>.
</para>
221 <para>Also, show installation targets in the output of
222 <command>is-enabled
</command>.
</para>
227 <term><option>--value
</option></term>
230 <para>When printing properties with
<command>show
</command>,
231 only print the value, and skip the property name and
232 <literal>=
</literal>.
</para>
237 <term><option>--show-types
</option></term>
240 <para>When showing sockets, show the type of the socket.
</para>
245 <term><option>--job-mode=
</option></term>
248 <para>When queuing a new job, this option controls how to deal with
249 already queued jobs. It takes one of
<literal>fail
</literal>,
250 <literal>replace
</literal>,
251 <literal>replace-irreversibly
</literal>,
252 <literal>isolate
</literal>,
253 <literal>ignore-dependencies
</literal>,
254 <literal>ignore-requirements
</literal> or
255 <literal>flush
</literal>. Defaults to
256 <literal>replace
</literal>, except when the
257 <command>isolate
</command> command is used which implies the
258 <literal>isolate
</literal> job mode.
</para>
260 <para>If
<literal>fail
</literal> is specified and a requested
261 operation conflicts with a pending job (more specifically:
262 causes an already pending start job to be reversed into a stop
263 job or vice versa), cause the operation to fail.
</para>
265 <para>If
<literal>replace
</literal> (the default) is
266 specified, any conflicting pending job will be replaced, as
269 <para>If
<literal>replace-irreversibly
</literal> is specified,
270 operate like
<literal>replace
</literal>, but also mark the new
271 jobs as irreversible. This prevents future conflicting
272 transactions from replacing these jobs (or even being enqueued
273 while the irreversible jobs are still pending). Irreversible
274 jobs can still be cancelled using the
<command>cancel
</command>
275 command. This job mode should be used on any transaction which
276 pulls in
<filename>shutdown.target
</filename>.
</para>
278 <para><literal>isolate
</literal> is only valid for start
279 operations and causes all other units to be stopped when the
280 specified unit is started. This mode is always used when the
281 <command>isolate
</command> command is used.
</para>
283 <para><literal>flush
</literal> will cause all queued jobs to
284 be canceled when the new job is enqueued.
</para>
286 <para>If
<literal>ignore-dependencies
</literal> is specified,
287 then all unit dependencies are ignored for this new job and
288 the operation is executed immediately. If passed, no required
289 units of the unit passed will be pulled in, and no ordering
290 dependencies will be honored. This is mostly a debugging and
291 rescue tool for the administrator and should not be used by
294 <para><literal>ignore-requirements
</literal> is similar to
295 <literal>ignore-dependencies
</literal>, but only causes the
296 requirement dependencies to be ignored, the ordering
297 dependencies will still be honored.
</para>
303 <term><option>-T
</option></term>
304 <term><option>--show-transaction
</option></term>
307 <para>When enqueuing a unit job (for example as effect of a
<command>systemctl start
</command>
308 invocation or similar), show brief information about all jobs enqueued, covering both the requested
309 job and any added because of unit dependencies. Note that the output will only include jobs
310 immediately part of the transaction requested. It is possible that service start-up program code
311 run as effect of the enqueued jobs might request further jobs to be pulled in. This means that
312 completion of the listed jobs might ultimately entail more jobs than the listed ones.
</para>
317 <term><option>--fail
</option></term>
320 <para>Shorthand for
<option>--job-mode=
</option>fail.
</para>
321 <para>When used with the
<command>kill
</command> command,
322 if no units were killed, the operation results in an error.
328 <term><option>-i
</option></term>
329 <term><option>--ignore-inhibitors
</option></term>
332 <para>When system shutdown or a sleep state is requested, ignore inhibitor locks. Applications can establish
333 inhibitor locks to avoid that certain important operations (such as CD burning or suchlike) are interrupted
334 by system shutdown or a sleep state. Any user may take these locks and privileged users may override these
335 locks. If any locks are taken, shutdown and sleep state requests will normally fail (unless privileged) and a
336 list of active locks is printed. However, if
<option>--ignore-inhibitors
</option> is specified, the
337 established locks are ignored and not shown, and the operation attempted anyway, possibly requiring
338 additional privileges.
</para>
343 <term><option>--dry-run
</option></term>
346 <para>Just print what would be done. Currently supported by verbs
347 <command>halt
</command>,
<command>poweroff
</command>,
<command>reboot
</command>,
348 <command>kexec
</command>,
<command>suspend
</command>,
<command>hibernate
</command>,
349 <command>hybrid-sleep
</command>,
<command>suspend-then-hibernate
</command>,
350 <command>default
</command>,
<command>rescue
</command>,
351 <command>emergency
</command>, and
<command>exit
</command>.
</para>
356 <term><option>-q
</option></term>
357 <term><option>--quiet
</option></term>
360 <para>Suppress printing of the results of various commands
361 and also the hints about truncated log lines. This does not
362 suppress output of commands for which the printed output is
363 the only result (like
<command>show
</command>). Errors are
364 always printed.
</para>
369 <term><option>--no-block
</option></term>
372 <para>Do not synchronously wait for the requested operation
373 to finish. If this is not specified, the job will be
374 verified, enqueued and
<command>systemctl
</command> will
375 wait until the unit's start-up is completed. By passing this
376 argument, it is only verified and enqueued. This option may not be
377 combined with
<option>--wait
</option>.
</para>
382 <term><option>--wait
</option></term>
385 <para>Synchronously wait for started units to terminate again.
386 This option may not be combined with
<option>--no-block
</option>.
387 Note that this will wait forever if any given unit never terminates
388 (by itself or by getting stopped explicitly); particularly services
389 which use
<literal>RemainAfterExit=yes
</literal>.
</para>
391 <para>When used with
<command>is-system-running
</command>, wait
392 until the boot process is completed before returning.
</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>--what=
</option></term>
513 <para>Select what type of per-unit resources to remove when the
<command>clean
</command> command is
514 invoked, see below. Takes one of
<constant>configuration
</constant>,
<constant>state
</constant>,
515 <constant>cache
</constant>,
<constant>logs
</constant>,
<constant>runtime
</constant> to select the
516 type of resource. This option may be specified more than once, in which case all specified resource
517 types are removed. Also accepts the special value
<constant>all
</constant> as a shortcut for
518 specifiying all five resource types. If this option is not specified defaults to the combination of
519 <constant>cache
</constant> and
<constant>runtime
</constant>, i.e. the two kinds of resources that
520 are generally considered to be redundant and can be reconstructed on next invocation.
</para>
525 <term><option>-f
</option></term>
526 <term><option>--force
</option></term>
529 <para>When used with
<command>enable
</command>, overwrite
530 any existing conflicting symlinks.
</para>
532 <para>When used with
<command>edit
</command>, create all of the
533 specified units which do not already exist.
</para>
535 <para>When used with
<command>halt
</command>,
<command>poweroff
</command>,
<command>reboot
</command> or
536 <command>kexec
</command>, execute the selected operation without shutting down all units. However, all
537 processes will be killed forcibly and all file systems are unmounted or remounted read-only. This is hence a
538 drastic but relatively safe option to request an immediate reboot. If
<option>--force
</option> is specified
539 twice for these operations (with the exception of
<command>kexec
</command>), they will be executed
540 immediately, without terminating any processes or unmounting any file systems. Warning: specifying
541 <option>--force
</option> twice with any of these operations might result in data loss. Note that when
542 <option>--force
</option> is specified twice the selected operation is executed by
543 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
544 succeed even when the system manager has crashed.
</para>
549 <term><option>--message=
</option></term>
552 <para>When used with
<command>halt
</command>,
<command>poweroff
</command> or
<command>reboot
</command>, set a
553 short message explaining the reason for the operation. The message will be logged together with the default
554 shutdown message.
</para>
559 <term><option>--now
</option></term>
562 <para>When used with
<command>enable
</command>, the units
563 will also be started. When used with
<command>disable
</command> or
564 <command>mask
</command>, the units will also be stopped. The start
565 or stop operation is only carried out when the respective enable or
566 disable operation has been successful.
</para>
571 <term><option>--root=
</option></term>
575 <command>enable
</command>/
<command>disable
</command>/
<command>is-enabled
</command>
576 (and related commands), use the specified root path when looking for unit
577 files. If this option is present,
<command>systemctl
</command> will operate on
578 the file system directly, instead of communicating with the
<command>systemd
</command>
579 daemon to carry out changes.
</para>
585 <term><option>--runtime
</option></term>
588 <para>When used with
<command>enable
</command>,
589 <command>disable
</command>,
<command>edit
</command>,
590 (and related commands), make changes only temporarily, so
591 that they are lost on the next reboot. This will have the
592 effect that changes are not made in subdirectories of
593 <filename>/etc
</filename> but in
<filename>/run
</filename>,
594 with identical immediate effects, however, since the latter
595 is lost on reboot, the changes are lost too.
</para>
597 <para>Similarly, when used with
598 <command>set-property
</command>, make changes only
599 temporarily, so that they are lost on the next
605 <term><option>--preset-mode=
</option></term>
608 <para>Takes one of
<literal>full
</literal> (the default),
609 <literal>enable-only
</literal>,
610 <literal>disable-only
</literal>. When used with the
611 <command>preset
</command> or
<command>preset-all
</command>
612 commands, controls whether units shall be disabled and
613 enabled according to the preset rules, or only enabled, or
614 only disabled.
</para>
619 <term><option>-n
</option></term>
620 <term><option>--lines=
</option></term>
623 <para>When used with
<command>status
</command>, controls the number of journal lines to show, counting from
624 the most recent ones. Takes a positive integer argument, or
0 to disable journal output. Defaults to
630 <term><option>-o
</option></term>
631 <term><option>--output=
</option></term>
634 <para>When used with
<command>status
</command>, controls the
635 formatting of the journal entries that are shown. For the
636 available choices, see
637 <citerefentry><refentrytitle>journalctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
638 Defaults to
<literal>short
</literal>.
</para>
643 <term><option>--firmware-setup
</option></term>
646 <para>When used with the
<command>reboot
</command> command, indicate to the system's firmware to reboot into
647 the firmware setup interface. Note that this functionality is not available on all systems.
</para>
652 <term><option>--boot-loader-menu=
</option></term>
655 <para>When used with the
<command>reboot
</command> command, indicate to the system's boot loader to show the
656 boot loader menu on the following boot. Takes a time value as parameter — indicating the menu time-out. Pass
657 zero in order to disable the menu time-out. Note that not all boot loaders support this
658 functionality.
</para>
663 <term><option>--boot-loader-entry=
</option></term>
666 <para>When used with the
<command>reboot
</command> command, indicate to the system's boot loader to boot into
667 a specific boot loader entry on the following boot. Takes a boot loader entry identifier as argument, or
668 <literal>help
</literal> in order to list available entries. Note that not all boot loaders support this
669 functionality.
</para>
674 <term><option>--plain
</option></term>
677 <para>When used with
<command>list-dependencies
</command>,
678 <command>list-units
</command> or
<command>list-machines
</command>,
679 the output is printed as a list instead of a tree, and the bullet
680 circles are omitted.
</para>
684 <xi:include href=
"user-system-options.xml" xpointer=
"host" />
685 <xi:include href=
"user-system-options.xml" xpointer=
"machine" />
687 <xi:include href=
"standard-options.xml" xpointer=
"no-pager" />
688 <xi:include href=
"standard-options.xml" xpointer=
"no-legend" />
689 <xi:include href=
"standard-options.xml" xpointer=
"help" />
690 <xi:include href=
"standard-options.xml" xpointer=
"version" />
695 <title>Commands
</title>
697 <para>The following commands are understood:
</para>
700 <title>Unit Commands
</title>
704 <term><command>list-units
</command> <optional><replaceable>PATTERN
</replaceable>…
</optional></term>
707 <para>List units that
<command>systemd
</command> currently has in memory. This includes units that are
708 either referenced directly or through a dependency, units that are pinned by applications programmatically,
709 or units that were active in the past and have failed. By default only units which are active, have pending
710 jobs, or have failed are shown; this can be changed with option
<option>--all
</option>. If one or more
711 <replaceable>PATTERN
</replaceable>s are specified, only units matching one of them are shown. The units
712 that are shown are additionally filtered by
<option>--type=
</option> and
<option>--state=
</option> if those
713 options are specified.
</para>
715 <para>Produces output similar to
716 <programlisting> UNIT LOAD ACTIVE SUB DESCRIPTION
717 sys-module-fuse.device loaded active plugged /sys/module/fuse
718 -.mount loaded active mounted Root Mount
719 boot-efi.mount loaded active mounted /boot/efi
720 systemd-journald.service loaded active running Journal Service
721 systemd-logind.service loaded active running Login Service
722 â—Ź user@
1000.service loaded failed failed User Manager for UID
1000
724 systemd-tmpfiles-clean.timer loaded active waiting Daily Cleanup of Temporary Directories
726 LOAD = Reflects whether the unit definition was properly loaded.
727 ACTIVE = The high-level unit activation state, i.e. generalization of SUB.
728 SUB = The low-level unit activation state, values depend on unit type.
730 123 loaded units listed. Pass --all to see loaded but inactive units, too.
731 To show all installed unit files use 'systemctl list-unit-files'.
733 The header and the last unit of a given type are underlined if the
734 terminal supports that. A colored dot is shown next to services which
735 were masked, not found, or otherwise failed.
</para>
737 <para>The LOAD column shows the load state, one of
<constant>loaded
</constant>,
738 <constant>not-found
</constant>,
<constant>bad-setting
</constant>,
<constant>error
</constant>,
739 <constant>masked
</constant>. The ACTIVE columns shows the general unit state, one of
740 <constant>active
</constant>,
<constant>reloading
</constant>,
<constant>inactive
</constant>,
741 <constant>failed
</constant>,
<constant>activating
</constant>,
<constant>deactivating
</constant>. The SUB
742 column shows the unit-type-specific detailed state of the unit, possible values vary by unit type. The list
743 of possible LOAD, ACTIVE, and SUB states is not constant and new systemd releases may both add and remove
744 values.
<programlisting>systemctl --state=help
</programlisting> command maybe be used to display the
745 current set of possible values.
</para>
747 <para>This is the default command.
</para>
752 <term><command>list-sockets
</command> <optional><replaceable>PATTERN
</replaceable>…
</optional></term>
755 <para>List socket units currently in memory, ordered by listening address. If one or more
756 <replaceable>PATTERN
</replaceable>s are specified, only socket units matching one of them are
757 shown. Produces output similar to
759 LISTEN UNIT ACTIVATES
760 /dev/initctl systemd-initctl.socket systemd-initctl.service
762 [::]:
22 sshd.socket sshd.service
763 kobject-uevent
1 systemd-udevd-kernel.socket systemd-udevd.service
765 5 sockets listed.
</programlisting>
766 Note: because the addresses might contains spaces, this output
767 is not suitable for programmatic consumption.
770 <para>Also see
<option>--show-types
</option>,
<option>--all
</option>, and
<option>--state=
</option>.
</para>
775 <term><command>list-timers
</command> <optional><replaceable>PATTERN
</replaceable>…
</optional></term>
778 <para>List timer units currently in memory, ordered by the time they elapse next. If one or more
779 <replaceable>PATTERN
</replaceable>s are specified, only units matching one of them are shown.
780 Produces output similar to
782 NEXT LEFT LAST PASSED UNIT ACTIVATES
783 n/a n/a Thu
2017-
02-
23 13:
40:
29 EST
3 days ago ureadahead-stop.timer ureadahead-stop.service
784 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
785 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
786 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
790 <para><emphasis>NEXT
</emphasis> shows the next time the timer will run.
</para>
791 <para><emphasis>LEFT
</emphasis> shows how long till the next time the timer runs.
</para>
792 <para><emphasis>LAST
</emphasis> shows the last time the timer ran.
</para>
793 <para><emphasis>PASSED
</emphasis> shows how long has passed since the timer last ran.
</para>
794 <para><emphasis>UNIT
</emphasis> shows the name of the timer
</para>
795 <para><emphasis>ACTIVATES
</emphasis> shows the name the service the timer activates when it runs.
</para>
797 <para>Also see
<option>--all
</option> and
<option>--state=
</option>.
</para>
802 <term><command>start
<replaceable>PATTERN
</replaceable>…
</command></term>
805 <para>Start (activate) one or more units specified on the
808 <para>Note that glob patterns operate on the set of primary names of units currently in memory. Units which
809 are not active and are not in a failed state usually are not in memory, and will not be matched by any
810 pattern. In addition, in case of instantiated units, systemd is often unaware of the instance name until
811 the instance has been started. Therefore, using glob patterns with
<command>start
</command> has limited
812 usefulness. Also, secondary alias names of units are not considered.
</para>
816 <term><command>stop
<replaceable>PATTERN
</replaceable>…
</command></term>
819 <para>Stop (deactivate) one or more units specified on the
824 <term><command>reload
<replaceable>PATTERN
</replaceable>…
</command></term>
827 <para>Asks all units listed on the command line to reload
828 their configuration. Note that this will reload the
829 service-specific configuration, not the unit configuration
830 file of systemd. If you want systemd to reload the
831 configuration file of a unit, use the
832 <command>daemon-reload
</command> command. In other words:
833 for the example case of Apache, this will reload Apache's
834 <filename>httpd.conf
</filename> in the web server, not the
835 <filename>apache.service
</filename> systemd unit
838 <para>This command should not be confused with the
839 <command>daemon-reload
</command> command.
</para>
844 <term><command>restart
<replaceable>PATTERN
</replaceable>…
</command></term>
847 <para>Stop and then start one or more units specified on the command line. If the units are not running
848 yet, they will be started.
</para>
850 <para>Note that restarting a unit with this command does not necessarily flush out all of the unit's
851 resources before it is started again. For example, the per-service file descriptor storage facility (see
852 <varname>FileDescriptorStoreMax=
</varname> in
853 <citerefentry><refentrytitle>systemd.service
</refentrytitle><manvolnum>5</manvolnum></citerefentry>) will
854 remain intact as long as the unit has a job pending, and is only cleared when the unit is fully stopped and
855 no jobs are pending anymore. If it is intended that the file descriptor store is flushed out, too, during a
856 restart operation an explicit
<command>systemctl stop
</command> command followed by
<command>systemctl
857 start
</command> should be issued.
</para>
861 <term><command>try-restart
<replaceable>PATTERN
</replaceable>…
</command></term>
864 <para>Stop and then start one or more units specified on the
865 command line if the units are running. This does nothing
866 if units are not running.
</para>
867 <!-- Note that we don't document condrestart here, as that is just compatibility support, and we generally
868 don't document that. -->
872 <term><command>reload-or-restart
<replaceable>PATTERN
</replaceable>…
</command></term>
875 <para>Reload one or more units if they support it. If not, stop and then start them instead. If the units
876 are not running yet, they will be started.
</para>
880 <term><command>try-reload-or-restart
<replaceable>PATTERN
</replaceable>…
</command></term>
883 <para>Reload one or more units if they support it. If not, stop and then start them instead. This does
884 nothing if the units are not running.
</para>
885 <!-- Note that we don't document force-reload here, as that is just compatibility support, and we generally
886 don't document that. -->
890 <term><command>isolate
<replaceable>UNIT
</replaceable></command></term>
893 <para>Start the unit specified on the command line and its dependencies
894 and stop all others, unless they have
895 <option>IgnoreOnIsolate=yes
</option> (see
896 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
897 If a unit name with no extension is given, an extension of
898 <literal>.target
</literal> will be assumed.
</para>
900 <para>This is similar to changing the runlevel in a
901 traditional init system. The
<command>isolate
</command>
902 command will immediately stop processes that are not enabled
903 in the new unit, possibly including the graphical
904 environment or terminal you are currently using.
</para>
906 <para>Note that this is allowed only on units where
907 <option>AllowIsolate=
</option> is enabled. See
908 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
913 <term><command>kill
<replaceable>PATTERN
</replaceable>…
</command></term>
916 <para>Send a signal to one or more processes of the
917 unit. Use
<option>--kill-who=
</option> to select which
918 process to kill. Use
<option>--signal=
</option> to select
919 the signal to send.
</para>
923 <term><command>clean
<replaceable>PATTERN
</replaceable>…
</command></term>
926 <para>Remove the configuration, state, cache, logs or runtime data of the specified units. Use
927 <option>--what=
</option> to select which kind of resource to remove. For service units this may
928 be used to remove the directories configured with
<varname>ConfigurationDirectory=
</varname>,
929 <varname>StateDirectory=
</varname>,
<varname>CacheDirectory=
</varname>,
930 <varname>LogsDirectory=
</varname> and
<varname>RuntimeDirectory=
</varname>, see
931 <citerefentry><refentrytitle>systemd.exec
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
932 for details. For timer units this may be used to clear out the persistent timestamp data if
933 <varname>Persistent=
</varname> is used and
<option>--what=state
</option> is selected, see
934 <citerefentry><refentrytitle>systemd.timer
</refentrytitle><manvolnum>5</manvolnum></citerefentry>. This
935 command only applies to units that use either of these settings. If
<option>--what=
</option> is
936 not specified, both the cache and runtime data are removed (as these two types of data are
937 generally redundant and reproducible on the next invocation of the unit).
</para>
941 <term><command>is-active
<replaceable>PATTERN
</replaceable>…
</command></term>
944 <para>Check whether any of the specified units are active
945 (i.e. running). Returns an exit code
946 <constant>0</constant> if at least one is active, or
947 non-zero otherwise. Unless
<option>--quiet
</option> is
948 specified, this will also print the current unit state to
949 standard output.
</para>
953 <term><command>is-failed
<replaceable>PATTERN
</replaceable>…
</command></term>
956 <para>Check whether any of the specified units are in a
957 "failed" state. Returns an exit code
958 <constant>0</constant> if at least one has failed,
959 non-zero otherwise. Unless
<option>--quiet
</option> is
960 specified, this will also print the current unit state to
961 standard output.
</para>
965 <term><command>status
</command> <optional><replaceable>PATTERN
</replaceable>…|
<replaceable>PID
</replaceable>…]
</optional></term>
968 <para>Show terse runtime status information about one or
969 more units, followed by most recent log data from the
970 journal. If no units are specified, show system status. If
971 combined with
<option>--all
</option>, also show the status of
972 all units (subject to limitations specified with
973 <option>-t
</option>). If a PID is passed, show information
974 about the unit the process belongs to.
</para>
976 <para>This function is intended to generate human-readable
977 output. If you are looking for computer-parsable output,
978 use
<command>show
</command> instead. By default, this
979 function only shows
10 lines of output and ellipsizes
980 lines to fit in the terminal window. This can be changed
981 with
<option>--lines
</option> and
<option>--full
</option>,
982 see above. In addition,
<command>journalctl
983 --unit=
<replaceable>NAME
</replaceable></command> or
985 --user-unit=
<replaceable>NAME
</replaceable></command> use
986 a similar filter for messages and might be more
990 <para>systemd implicitly loads units as necessary, so just running the
<command>status
</command> will
991 attempt to load a file. The command is thus not useful for determining if something was already loaded or
992 not. The units may possibly also be quickly unloaded after the operation is completed if there's no reason
993 to keep it in memory thereafter.
997 <title>Example output from systemctl status
</title>
999 <programlisting>$ systemctl status bluetooth
1000 â—Ź bluetooth.service - Bluetooth service
1001 Loaded: loaded (/usr/lib/systemd/system/bluetooth.service; enabled; vendor preset: enabled)
1002 Active: active (running) since Wed
2017-
01-
04 13:
54:
04 EST;
1 weeks
0 days ago
1003 Docs: man:bluetoothd(
8)
1004 Main PID:
930 (bluetoothd)
1009 CGroup: /system.slice/bluetooth.service
1010 └─
930 /usr/lib/bluetooth/bluetoothd
1012 Jan
12 10:
46:
45 example.com bluetoothd[
8900]: Not enough free handles to register service
1013 Jan
12 10:
46:
45 example.com bluetoothd[
8900]: Current Time Service could not be registered
1014 Jan
12 10:
46:
45 example.com bluetoothd[
8900]: gatt-time-server: Input/output error (
5)
1017 <para>The dot (
"â—Ź") uses color on supported terminals to summarize the unit state at a glance. White
1018 indicates an
<literal>inactive
</literal> or
<literal>deactivating
</literal> state. Red indicates a
1019 <literal>failed
</literal> or
<literal>error
</literal> state and green indicates an
1020 <literal>active
</literal>,
<literal>reloading
</literal> or
<literal>activating
</literal> state.
1023 <para>The
"Loaded:" line in the output will show
<literal>loaded
</literal> if the unit has been loaded into
1024 memory. Other possible values for
"Loaded:" include:
<literal>error
</literal> if there was a problem
1025 loading it,
<literal>not-found
</literal> if not unit file was found for this unit,
1026 <literal>bad-setting
</literal> if an essential unit file setting could not be parsed and
1027 <literal>masked
</literal> if the unit file has been masked. Along with showing the path to the unit file,
1028 this line will also show the enablement state. Enabled commands start at boot. See the full table of
1029 possible enablement states — including the definition of
<literal>masked
</literal> — in the documentation
1030 for the
<command>is-enabled
</command> command.
1033 <para>The
"Active:" line shows active state. The value is usually
<literal>active
</literal> or
1034 <literal>inactive
</literal>. Active could mean started, bound, plugged in, etc depending on the unit type.
1035 The unit could also be in process of changing states, reporting a state of
<literal>activating
</literal> or
1036 <literal>deactivating
</literal>. A special
<literal>failed
</literal> state is entered when the service
1037 failed in some way, such as a crash, exiting with an error code or timing out. If the failed state is
1038 entered the cause will be logged for later reference.
</para>
1044 <term><command>show
</command> <optional><replaceable>PATTERN
</replaceable>…|
<replaceable>JOB
</replaceable>…
</optional></term>
1047 <para>Show properties of one or more units, jobs, or the manager itself. If no argument is specified,
1048 properties of the manager will be shown. If a unit name is specified, properties of the unit are shown, and
1049 if a job ID is specified, properties of the job are shown. By default, empty properties are suppressed. Use
1050 <option>--all
</option> to show those too. To select specific properties to show, use
1051 <option>--property=
</option>. This command is intended to be used whenever computer-parsable output is
1052 required. Use
<command>status
</command> if you are looking for formatted human-readable output.
</para>
1054 <para>Many properties shown by
<command>systemctl show
</command> map directly to configuration settings of
1055 the system and service manager and its unit files. Note that the properties shown by the command are
1056 generally more low-level, normalized versions of the original configuration settings and expose runtime
1057 state in addition to configuration. For example, properties shown for service units include the service's
1058 current main process identifier as
<literal>MainPID
</literal> (which is runtime state), and time settings
1059 are always exposed as properties ending in the
<literal>…USec
</literal> suffix even if a matching
1060 configuration options end in
<literal>…Sec
</literal>, because microseconds is the normalized time unit used
1061 by the system and service manager.
</para>
1065 <term><command>cat
<replaceable>PATTERN
</replaceable>…
</command></term>
1068 <para>Show backing files of one or more units. Prints the
1069 "fragment" and
"drop-ins" (source files) of units. Each
1070 file is preceded by a comment which includes the file
1071 name. Note that this shows the contents of the backing files
1072 on disk, which may not match the system manager's
1073 understanding of these units if any unit files were
1074 updated on disk and the
<command>daemon-reload
</command>
1075 command wasn't issued since.
</para>
1079 <term><command>set-property
<replaceable>UNIT
</replaceable> <replaceable>PROPERTY
</replaceable>=
<replaceable>VALUE
</replaceable>…
</command></term>
1082 <para>Set the specified unit properties at runtime where
1083 this is supported. This allows changing configuration
1084 parameter properties such as resource control settings at
1085 runtime. Not all properties may be changed at runtime, but
1086 many resource control settings (primarily those in
1087 <citerefentry><refentrytitle>systemd.resource-control
</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
1088 may. The changes are applied immediately, and stored on disk
1089 for future boots, unless
<option>--runtime
</option> is
1090 passed, in which case the settings only apply until the
1091 next reboot. The syntax of the property assignment follows
1092 closely the syntax of assignments in unit files.
</para>
1094 <para>Example:
<command>systemctl set-property foobar.service CPUWeight=
200</command></para>
1096 <para>If the specified unit appears to be inactive, the
1097 changes will be only stored on disk as described
1098 previously hence they will be effective when the unit will
1101 <para>Note that this command allows changing multiple properties at the same time, which is
1102 preferable over setting them individually.
</para>
1104 <para>Example:
<command>systemctl set-property foobar.service CPUWeight=
200 MemoryMax=
2G IPAccounting=yes
</command></para>
1106 <para>Like with unit file configuration settings, assigning an empty setting usually resets a
1107 property to its defaults.
</para>
1109 <para>Example:
<command>systemctl set-property avahi-daemon.service IPAddressDeny=
</command></para>
1114 <term><command>help
<replaceable>PATTERN
</replaceable>…|
<replaceable>PID
</replaceable>…
</command></term>
1117 <para>Show manual pages for one or more units, if
1118 available. If a PID is given, the manual pages for the unit
1119 the process belongs to are shown.
</para>
1124 <term><command>reset-failed [
<replaceable>PATTERN
</replaceable>…]
</command></term>
1127 <para>Reset the
<literal>failed
</literal> state of the specified units, or if no unit name is passed, reset
1128 the state of all units. When a unit fails in some way (i.e. process exiting with non-zero error code,
1129 terminating abnormally or timing out), it will automatically enter the
<literal>failed
</literal> state and
1130 its exit code and status is recorded for introspection by the administrator until the service is
1131 stopped/re-started or reset with this command.
</para>
1133 <para>In addition to resetting the
<literal>failed
</literal> state of a unit it also resets various other
1134 per-unit properties: the start rate limit counter of all unit types is reset to zero, as is the restart
1135 counter of service units. Thus, if a unit's start limit (as configured with
1136 <varname>StartLimitIntervalSec=
</varname>/
<varname>StartLimitBurst=
</varname>) is hit and the unit refuses
1137 to be started again, use this command to make it startable again.
</para>
1143 <command>list-dependencies
</command>
1144 <optional><replaceable>UNIT
</replaceable></optional>
1148 <para>Shows units required and wanted by the specified
1149 unit. This recursively lists units following the
1150 <varname>Requires=
</varname>,
1151 <varname>Requisite=
</varname>,
1152 <varname>ConsistsOf=
</varname>,
1153 <varname>Wants=
</varname>,
<varname>BindsTo=
</varname>
1154 dependencies. If no unit is specified,
1155 <filename>default.target
</filename> is implied.
</para>
1157 <para>By default, only target units are recursively
1158 expanded. When
<option>--all
</option> is passed, all other
1159 units are recursively expanded as well.
</para>
1161 <para>Options
<option>--reverse
</option>,
1162 <option>--after
</option>,
<option>--before
</option>
1163 may be used to change what types of dependencies
1166 <para>Note that this command only lists units currently loaded into memory by the service manager. In
1167 particular, this command is not suitable to get a comprehensive list at all reverse dependencies on a
1168 specific unit, as it won't list the dependencies declared by units currently not loaded.
</para>
1175 <title>Unit File Commands
</title>
1179 <term><command>list-unit-files
</command> <optional><replaceable>PATTERN…
</replaceable></optional></term>
1182 <para>List unit files installed on the system, in combination with their enablement state (as reported by
1183 <command>is-enabled
</command>). If one or more
<replaceable>PATTERN
</replaceable>s are specified, only unit
1184 files whose name matches one of them are shown (patterns matching unit file system paths are not
1190 <term><command>enable
<replaceable>UNIT
</replaceable>…
</command></term>
1191 <term><command>enable
<replaceable>PATH
</replaceable>…
</command></term>
1194 <para>Enable one or more units or unit instances. This will create a set of symlinks, as encoded in the
1195 <literal>[Install]
</literal> sections of the indicated unit files. After the symlinks have been created,
1196 the system manager configuration is reloaded (in a way equivalent to
<command>daemon-reload
</command>), in
1197 order to ensure the changes are taken into account immediately. Note that this does
1198 <emphasis>not
</emphasis> have the effect of also starting any of the units being enabled. If this is
1199 desired, combine this command with the
<option>--now
</option> switch, or invoke
<command>start
</command>
1200 with appropriate arguments later. Note that in case of unit instance enablement (i.e. enablement of units of
1201 the form
<filename>foo@bar.service
</filename>), symlinks named the same as instances are created in the
1202 unit configuration directory, however they point to the single template unit file they are instantiated
1205 <para>This command expects either valid unit names (in which case various unit file directories are
1206 automatically searched for unit files with appropriate names), or absolute paths to unit files (in which
1207 case these files are read directly). If a specified unit file is located outside of the usual unit file
1208 directories, an additional symlink is created, linking it into the unit configuration path, thus ensuring
1209 it is found when requested by commands such as
<command>start
</command>. The file system where the linked
1210 unit files are located must be accessible when systemd is started (e.g. anything underneath
1211 <filename>/home
</filename> or
<filename>/var
</filename> is not allowed, unless those directories are
1212 located on the root file system).
</para>
1214 <para>This command will print the file system operations executed. This output may be suppressed by passing
1215 <option>--quiet
</option>.
1218 <para>Note that this operation creates only the symlinks suggested in the
<literal>[Install]
</literal>
1219 section of the unit files. While this command is the recommended way to manipulate the unit configuration
1220 directory, the administrator is free to make additional changes manually by placing or removing symlinks
1221 below this directory. This is particularly useful to create configurations that deviate from the suggested
1222 default installation. In this case, the administrator must make sure to invoke
1223 <command>daemon-reload
</command> manually as necessary, in order to ensure the changes are taken into
1227 <para>Enabling units should not be confused with starting (activating) units, as done by the
1228 <command>start
</command> command. Enabling and starting units is orthogonal: units may be enabled without
1229 being started and started without being enabled. Enabling simply hooks the unit into various suggested
1230 places (for example, so that the unit is automatically started on boot or when a particular kind of
1231 hardware is plugged in). Starting actually spawns the daemon process (in case of service units), or binds
1232 the socket (in case of socket units), and so on.
</para>
1234 <para>Depending on whether
<option>--system
</option>,
<option>--user
</option>,
<option>--runtime
</option>,
1235 or
<option>--global
</option> is specified, this enables the unit for the system, for the calling user only,
1236 for only this boot of the system, or for all future logins of all users. Note that in the last case, no
1237 systemd daemon configuration is reloaded.
</para>
1239 <para>Using
<command>enable
</command> on masked units is not supported and results in an error.
</para>
1244 <term><command>disable
<replaceable>UNIT
</replaceable>…
</command></term>
1247 <para>Disables one or more units. This removes all symlinks to the unit files backing the specified units
1248 from the unit configuration directory, and hence undoes any changes made by
<command>enable
</command> or
1249 <command>link
</command>. Note that this removes
<emphasis>all
</emphasis> symlinks to matching unit files,
1250 including manually created symlinks, and not just those actually created by
<command>enable
</command> or
1251 <command>link
</command>. Note that while
<command>disable
</command> undoes the effect of
1252 <command>enable
</command>, the two commands are otherwise not symmetric, as
<command>disable
</command> may
1253 remove more symlinks than a prior
<command>enable
</command> invocation of the same unit created.
</para>
1255 <para>This command expects valid unit names only, it does not accept paths to unit files.
</para>
1257 <para>In addition to the units specified as arguments, all units are disabled that are listed in the
1258 <varname>Also=
</varname> setting contained in the
<literal>[Install]
</literal> section of any of the unit
1259 files being operated on.
</para>
1261 <para>This command implicitly reloads the system manager configuration after completing the operation. Note
1262 that this command does not implicitly stop the units that are being disabled. If this is desired, either
1263 combine this command with the
<option>--now
</option> switch, or invoke the
<command>stop
</command> command
1264 with appropriate arguments later.
</para>
1266 <para>This command will print information about the file system operations (symlink removals)
1267 executed. This output may be suppressed by passing
<option>--quiet
</option>.
1270 <para>This command honors
<option>--system
</option>,
<option>--user
</option>,
<option>--runtime
</option>
1271 and
<option>--global
</option> in a similar way as
<command>enable
</command>.
</para>
1276 <term><command>reenable
<replaceable>UNIT
</replaceable>…
</command></term>
1279 <para>Reenable one or more units, as specified on the command line. This is a combination of
1280 <command>disable
</command> and
<command>enable
</command> and is useful to reset the symlinks a unit file is
1281 enabled with to the defaults configured in its
<literal>[Install]
</literal> section. This command expects
1282 a unit name only, it does not accept paths to unit files.
</para>
1287 <term><command>preset
<replaceable>UNIT
</replaceable>…
</command></term>
1290 <para>Reset the enable/disable status one or more unit files, as specified on
1291 the command line, to the defaults configured in the preset policy files. This
1292 has the same effect as
<command>disable
</command> or
1293 <command>enable
</command>, depending how the unit is listed in the preset
1296 <para>Use
<option>--preset-mode=
</option> to control whether units shall be
1297 enabled and disabled, or only enabled, or only disabled.
</para>
1299 <para>If the unit carries no install information, it will be silently ignored
1300 by this command.
<replaceable>UNIT
</replaceable> must be the real unit name,
1301 any alias names are ignored silently.
</para>
1303 <para>For more information on the preset policy format, see
1304 <citerefentry><refentrytitle>systemd.preset
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1305 For more information on the concept of presets, please consult the
1306 <ulink url=
"https://www.freedesktop.org/wiki/Software/systemd/Preset">Preset
</ulink>
1312 <term><command>preset-all
</command></term>
1315 <para>Resets all installed unit files to the defaults
1316 configured in the preset policy file (see above).
</para>
1318 <para>Use
<option>--preset-mode=
</option> to control
1319 whether units shall be enabled and disabled, or only
1320 enabled, or only disabled.
</para>
1325 <term><command>is-enabled
<replaceable>UNIT
</replaceable>…
</command></term>
1328 <para>Checks whether any of the specified unit files are
1329 enabled (as with
<command>enable
</command>). Returns an
1330 exit code of
0 if at least one is enabled, non-zero
1331 otherwise. Prints the current enable status (see table).
1332 To suppress this output, use
<option>--quiet
</option>.
1333 To show installation targets, use
<option>--full
</option>.
1338 <command>is-enabled
</command> output
1345 <entry>Description
</entry>
1346 <entry>Exit Code
</entry>
1351 <entry><literal>enabled
</literal></entry>
1352 <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>
1353 <entry morerows='
1'
>0</entry>
1356 <entry><literal>enabled-runtime
</literal></entry>
1359 <entry><literal>linked
</literal></entry>
1360 <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>
1361 <entry morerows='
1'
>> 0</entry>
1364 <entry><literal>linked-runtime
</literal></entry>
1367 <entry><literal>masked
</literal></entry>
1368 <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>
1369 <entry morerows='
1'
>> 0</entry>
1372 <entry><literal>masked-runtime
</literal></entry>
1375 <entry><literal>static
</literal></entry>
1376 <entry>The unit file is not enabled, and has no provisions for enabling in the
<literal>[Install]
</literal> unit file section.
</entry>
1380 <entry><literal>indirect
</literal></entry>
1381 <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
<varname>Also=
</varname>. For template unit file, an instance different than the one specified in
<varname>DefaultInstance=
</varname> is enabled.
</entry>
1385 <entry><literal>disabled
</literal></entry>
1386 <entry>The unit file is not enabled, but contains an
<literal>[Install]
</literal> section with installation instructions.
</entry>
1387 <entry>> 0</entry>
1390 <entry><literal>generated
</literal></entry>
1391 <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>
1395 <entry><literal>transient
</literal></entry>
1396 <entry>The unit file has been created dynamically with the runtime API. Transient units may not be enabled.
</entry>
1400 <entry><literal>bad
</literal></entry>
1401 <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>
1402 <entry>> 0</entry>
1412 <term><command>mask
<replaceable>UNIT
</replaceable>…
</command></term>
1415 <para>Mask one or more units, as specified on the command line. This will link these unit files to
1416 <filename>/dev/null
</filename>, making it impossible to start them. This is a stronger version of
1417 <command>disable
</command>, since it prohibits all kinds of activation of the unit, including enablement
1418 and manual activation. Use this option with care. This honors the
<option>--runtime
</option> option to only
1419 mask temporarily until the next reboot of the system. The
<option>--now
</option> option may be used to
1420 ensure that the units are also stopped. This command expects valid unit names only, it does not accept unit
1426 <term><command>unmask
<replaceable>UNIT
</replaceable>…
</command></term>
1429 <para>Unmask one or more unit files, as specified on the command line. This will undo the effect of
1430 <command>mask
</command>. This command expects valid unit names only, it does not accept unit file
1436 <term><command>link
<replaceable>PATH
</replaceable>…
</command></term>
1439 <para>Link a unit file that is not in the unit file search paths into the unit file search path. This
1440 command expects an absolute path to a unit file. The effect of this may be undone with
1441 <command>disable
</command>. The effect of this command is that a unit file is made available for commands
1442 such as
<command>start
</command>, even though it is not installed directly in the unit search path. The
1443 file system where the linked unit files are located must be accessible when systemd is started
1444 (e.g. anything underneath
<filename>/home
</filename> or
<filename>/var
</filename> is not allowed, unless
1445 those directories are located on the root file system).
</para>
1450 <term><command>revert
<replaceable>UNIT
</replaceable>…
</command></term>
1453 <para>Revert one or more unit files to their vendor versions. This command removes drop-in configuration
1454 files that modify the specified units, as well as any user-configured unit file that overrides a matching
1455 vendor supplied unit file. Specifically, for a unit
<literal>foo.service
</literal> the matching directories
1456 <literal>foo.service.d/
</literal> with all their contained files are removed, both below the persistent and
1457 runtime configuration directories (i.e. below
<filename>/etc/systemd/system
</filename> and
1458 <filename>/run/systemd/system
</filename>); if the unit file has a vendor-supplied version (i.e. a unit file
1459 located below
<filename>/usr
</filename>) any matching persistent or runtime unit file that overrides it is
1460 removed, too. Note that if a unit file has no vendor-supplied version (i.e. is only defined below
1461 <filename>/etc/systemd/system
</filename> or
<filename>/run/systemd/system
</filename>, but not in a unit
1462 file stored below
<filename>/usr
</filename>), then it is not removed. Also, if a unit is masked, it is
1465 <para>Effectively, this command may be used to undo all changes made with
<command>systemctl
1466 edit
</command>,
<command>systemctl set-property
</command> and
<command>systemctl mask
</command> and puts
1467 the original unit file with its settings back in effect.
</para>
1472 <term><command>add-wants
<replaceable>TARGET
</replaceable>
1473 <replaceable>UNIT
</replaceable>…
</command></term>
1474 <term><command>add-requires
<replaceable>TARGET
</replaceable>
1475 <replaceable>UNIT
</replaceable>…
</command></term>
1478 <para>Adds
<literal>Wants=
</literal> or
<literal>Requires=
</literal>
1479 dependencies, respectively, to the specified
1480 <replaceable>TARGET
</replaceable> for one or more units.
</para>
1482 <para>This command honors
<option>--system
</option>,
1483 <option>--user
</option>,
<option>--runtime
</option> and
1484 <option>--global
</option> in a way similar to
1485 <command>enable
</command>.
</para>
1491 <term><command>edit
<replaceable>UNIT
</replaceable>…
</command></term>
1494 <para>Edit a drop-in snippet or a whole replacement file if
1495 <option>--full
</option> is specified, to extend or override the
1496 specified unit.
</para>
1498 <para>Depending on whether
<option>--system
</option> (the default),
1499 <option>--user
</option>, or
<option>--global
</option> is specified,
1500 this command creates a drop-in file for each unit either for the system,
1501 for the calling user, or for all futures logins of all users. Then,
1502 the editor (see the
"Environment" section below) is invoked on
1503 temporary files which will be written to the real location if the
1504 editor exits successfully.
</para>
1506 <para>If
<option>--full
</option> is specified, this will copy the
1507 original units instead of creating drop-in files.
</para>
1509 <para>If
<option>--force
</option> is specified and any units do
1510 not already exist, new unit files will be opened for editing.
</para>
1512 <para>If
<option>--runtime
</option> is specified, the changes will
1513 be made temporarily in
<filename>/run
</filename> and they will be
1514 lost on the next reboot.
</para>
1516 <para>If the temporary file is empty upon exit, the modification of
1517 the related unit is canceled.
</para>
1519 <para>After the units have been edited, systemd configuration is
1520 reloaded (in a way that is equivalent to
<command>daemon-reload
</command>).
1523 <para>Note that this command cannot be used to remotely edit units
1524 and that you cannot temporarily edit units which are in
1525 <filename>/etc
</filename>, since they take precedence over
1526 <filename>/run
</filename>.
</para>
1531 <term><command>get-default
</command></term>
1534 <para>Return the default target to boot into. This returns
1535 the target unit name
<filename>default.target
</filename>
1536 is aliased (symlinked) to.
</para>
1541 <term><command>set-default
<replaceable>TARGET
</replaceable></command></term>
1544 <para>Set the default target to boot into. This sets
1545 (symlinks) the
<filename>default.target
</filename> alias
1546 to the given target unit.
</para>
1554 <title>Machine Commands
</title>
1558 <term><command>list-machines
</command> <optional><replaceable>PATTERN
</replaceable>…
</optional></term>
1561 <para>List the host and all running local containers with
1562 their state. If one or more
1563 <replaceable>PATTERN
</replaceable>s are specified, only
1564 containers matching one of them are shown.
1572 <title>Job Commands
</title>
1576 <term><command>list-jobs
<optional><replaceable>PATTERN…
</replaceable></optional></command></term>
1579 <para>List jobs that are in progress. If one or more
1580 <replaceable>PATTERN
</replaceable>s are specified, only
1581 jobs for units matching one of them are shown.
</para>
1583 <para>When combined with
<option>--after
</option> or
<option>--before
</option> the list is augmented with
1584 information on which other job each job is waiting for, and which other jobs are waiting for it, see
1589 <term><command>cancel
<replaceable>JOB
</replaceable>…
</command></term>
1592 <para>Cancel one or more jobs specified on the command line
1593 by their numeric job IDs. If no job ID is specified, cancel
1594 all pending jobs.
</para>
1601 <title>Environment Commands
</title>
1605 <term><command>show-environment
</command></term>
1608 <para>Dump the systemd manager environment block. This is the environment
1609 block that is passed to all processes the manager spawns. The environment
1610 block will be dumped in straight-forward form suitable for sourcing into
1611 most shells. If no special characters or whitespace is present in the variable
1612 values, no escaping is performed, and the assignments have the form
1613 <literal>VARIABLE=value
</literal>. If whitespace or characters which have
1614 special meaning to the shell are present, dollar-single-quote escaping is
1615 used, and assignments have the form
<literal>VARIABLE=$'value'
</literal>.
1616 This syntax is known to be supported by
1617 <citerefentry project='die-net'
><refentrytitle>bash
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1618 <citerefentry project='die-net'
><refentrytitle>zsh
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1619 <citerefentry project='die-net'
><refentrytitle>ksh
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1621 <citerefentry project='die-net'
><refentrytitle>busybox
</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
1622 <citerefentry project='die-net'
><refentrytitle>ash
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1624 <citerefentry project='die-net'
><refentrytitle>dash
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
1626 <citerefentry project='die-net'
><refentrytitle>fish
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
1631 <term><command>set-environment
<replaceable>VARIABLE=VALUE
</replaceable>…
</command></term>
1634 <para>Set one or more systemd manager environment variables,
1635 as specified on the command line.
</para>
1639 <term><command>unset-environment
<replaceable>VARIABLE
</replaceable>…
</command></term>
1642 <para>Unset one or more systemd manager environment
1643 variables. If only a variable name is specified, it will be
1644 removed regardless of its value. If a variable and a value
1645 are specified, the variable is only removed if it has the
1646 specified value.
</para>
1651 <command>import-environment
</command>
1652 <optional><replaceable>VARIABLE…
</replaceable></optional>
1656 <para>Import all, one or more environment variables set on
1657 the client into the systemd manager environment block. If
1658 no arguments are passed, the entire environment block is
1659 imported. Otherwise, a list of one or more environment
1660 variable names should be passed, whose client-side values
1661 are then imported into the manager's environment
1669 <title>Manager Lifecycle Commands
</title>
1673 <term><command>daemon-reload
</command></term>
1676 <para>Reload the systemd manager configuration. This will
1677 rerun all generators (see
1678 <citerefentry><refentrytitle>systemd.generator
</refentrytitle><manvolnum>7</manvolnum></citerefentry>),
1679 reload all unit files, and recreate the entire dependency
1680 tree. While the daemon is being reloaded, all sockets
1681 systemd listens on behalf of user configuration will stay
1684 <para>This command should not be confused with the
1685 <command>reload
</command> command.
</para>
1689 <term><command>daemon-reexec
</command></term>
1692 <para>Reexecute the systemd manager. This will serialize the
1693 manager state, reexecute the process and deserialize the
1694 state again. This command is of little use except for
1695 debugging and package upgrades. Sometimes, it might be
1696 helpful as a heavy-weight
<command>daemon-reload
</command>.
1697 While the daemon is being reexecuted, all sockets systemd listening
1698 on behalf of user configuration will stay accessible.
1706 <title>System Commands
</title>
1710 <term><command>is-system-running
</command></term>
1713 <para>Checks whether the system is operational. This
1714 returns success (exit code
0) when the system is fully up
1715 and running, specifically not in startup, shutdown or
1716 maintenance mode, and with no failed services. Failure is
1717 returned otherwise (exit code non-zero). In addition, the
1718 current state is printed in a short string to standard
1719 output, see the table below. Use
<option>--quiet
</option> to
1720 suppress this output.
</para>
1722 <para>Use
<option>--wait
</option> to wait until the boot
1723 process is completed before printing the current state and
1724 returning the appropriate error status. If
<option>--wait
</option>
1725 is in use, states
<varname>initializing
</varname> or
1726 <varname>starting
</varname> will not be reported, instead
1727 the command will block until a later state (such as
1728 <varname>running
</varname> or
<varname>degraded
</varname>)
1732 <title><command>is-system-running
</command> output
</title>
1734 <colspec colname='name'
/>
1735 <colspec colname='description'
/>
1736 <colspec colname='exit-code'
/>
1740 <entry>Description
</entry>
1741 <entry>Exit Code
</entry>
1746 <entry><varname>initializing
</varname></entry>
1747 <entry><para>Early bootup, before
1748 <filename>basic.target
</filename> is reached
1749 or the
<varname>maintenance
</varname> state entered.
1751 <entry>> 0</entry>
1754 <entry><varname>starting
</varname></entry>
1755 <entry><para>Late bootup, before the job queue
1756 becomes idle for the first time, or one of the
1757 rescue targets are reached.
</para></entry>
1758 <entry>> 0</entry>
1761 <entry><varname>running
</varname></entry>
1762 <entry><para>The system is fully
1763 operational.
</para></entry>
1767 <entry><varname>degraded
</varname></entry>
1768 <entry><para>The system is operational but one or more
1769 units failed.
</para></entry>
1770 <entry>> 0</entry>
1773 <entry><varname>maintenance
</varname></entry>
1774 <entry><para>The rescue or emergency target is
1775 active.
</para></entry>
1776 <entry>> 0</entry>
1779 <entry><varname>stopping
</varname></entry>
1780 <entry><para>The manager is shutting
1781 down.
</para></entry>
1782 <entry>> 0</entry>
1785 <entry><varname>offline
</varname></entry>
1786 <entry><para>The manager is not
1787 running. Specifically, this is the operational
1788 state if an incompatible program is running as
1789 system manager (PID
1).
</para></entry>
1790 <entry>> 0</entry>
1793 <entry><varname>unknown
</varname></entry>
1794 <entry><para>The operational state could not be
1795 determined, due to lack of resources or another
1796 error cause.
</para></entry>
1797 <entry>> 0</entry>
1806 <term><command>default
</command></term>
1809 <para>Enter default mode. This is equivalent to
<command>systemctl isolate default.target
</command>. This
1810 operation is blocking by default, use
<option>--no-block
</option> to request asynchronous behavior.
</para>
1815 <term><command>rescue
</command></term>
1818 <para>Enter rescue mode. This is equivalent to
<command>systemctl isolate rescue.target
</command>. This
1819 operation is blocking by default, use
<option>--no-block
</option> to request asynchronous behavior.
</para>
1823 <term><command>emergency
</command></term>
1826 <para>Enter emergency mode. This is equivalent to
<command>systemctl isolate
1827 emergency.target
</command>. This operation is blocking by default, use
<option>--no-block
</option> to
1828 request asynchronous behavior.
</para>
1832 <term><command>halt
</command></term>
1835 <para>Shut down and halt the system. This is mostly equivalent to
<command>systemctl start halt.target
1836 --job-mode=replace-irreversibly --no-block
</command>, but also prints a wall message to all users. This command is
1837 asynchronous; it will return after the halt operation is enqueued, without waiting for it to complete. Note
1838 that this operation will simply halt the OS kernel after shutting down, leaving the hardware powered
1839 on. Use
<command>systemctl poweroff
</command> for powering off the system (see below).
</para>
1841 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1842 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1843 system halt. If
<option>--force
</option> is specified twice, the operation is immediately executed without
1844 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1845 <option>--force
</option> is specified twice the halt operation is executed by
<command>systemctl
</command>
1846 itself, and the system manager is not contacted. This means the command should succeed even when the system
1847 manager has crashed.
</para>
1851 <term><command>poweroff
</command></term>
1854 <para>Shut down and power-off the system. This is mostly equivalent to
<command>systemctl start
1855 poweroff.target --job-mode=replace-irreversibly --no-block
</command>, but also prints a wall message to all
1856 users. This command is asynchronous; it will return after the power-off operation is enqueued, without
1857 waiting for it to complete.
</para>
1859 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1860 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1861 powering off. If
<option>--force
</option> is specified twice, the operation is immediately executed without
1862 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1863 <option>--force
</option> is specified twice the power-off operation is executed by
1864 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
1865 succeed even when the system manager has crashed.
</para>
1869 <term><command>reboot
</command> <optional><replaceable>arg
</replaceable></optional></term>
1872 <para>Shut down and reboot the system. This is mostly equivalent to
<command>systemctl start reboot.target
1873 --job-mode=replace-irreversibly --no-block
</command>, but also prints a wall message to all users. This
1874 command is asynchronous; it will return after the reboot operation is enqueued, without waiting for it to
1877 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1878 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1879 reboot. If
<option>--force
</option> is specified twice, the operation is immediately executed without
1880 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1881 <option>--force
</option> is specified twice the reboot operation is executed by
1882 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
1883 succeed even when the system manager has crashed.
</para>
1885 <para>If the optional argument
<replaceable>arg
</replaceable> is given, it will be passed as the optional
1886 argument to the
<citerefentry><refentrytitle>reboot
</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1887 system call. The value is architecture and firmware specific. As an example,
<literal>recovery
</literal>
1888 might be used to trigger system recovery, and
<literal>fota
</literal> might be used to trigger a
1889 <quote>firmware over the air
</quote> update.
</para>
1894 <term><command>kexec
</command></term>
1897 <para>Shut down and reboot the system via
<command>kexec
</command>. This is equivalent to
1898 <command>systemctl start kexec.target --job-mode=replace-irreversibly --no-block
</command>. This command is
1899 asynchronous; it will return after the reboot operation is enqueued, without waiting for it to
1902 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1903 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1909 <term><command>exit
</command> <optional><replaceable>EXIT_CODE
</replaceable></optional></term>
1912 <para>Ask the service manager to quit. This is only supported for user service managers (i.e. in
1913 conjunction with the
<option>--user
</option> option) or in containers and is equivalent to
1914 <command>poweroff
</command> otherwise. This command is asynchronous; it will return after the exit
1915 operation is enqueued, without waiting for it to complete.
</para>
1917 <para>The service manager will exit with the specified exit code, if
1918 <replaceable>EXIT_CODE
</replaceable> is passed.
</para>
1923 <term><command>switch-root
</command> <replaceable>ROOT
</replaceable> <optional><replaceable>INIT
</replaceable></optional></term>
1926 <para>Switches to a different root directory and executes a new system manager process below it. This is
1927 intended for usage in initial RAM disks (
"initrd"), and will transition from the initrd's system manager
1928 process (a.k.a.
"init" process) to the main system manager process which is loaded from the actual host
1929 volume. This call takes two arguments: the directory that is to become the new root directory, and the path
1930 to the new system manager binary below it to execute as PID
1. If the latter is omitted or the empty
1931 string, a systemd binary will automatically be searched for and used as init. If the system manager path is
1932 omitted, equal to the empty string or identical to the path to the systemd binary, the state of the
1933 initrd's system manager process is passed to the main system manager, which allows later introspection of
1934 the state of the services involved in the initrd boot phase.
</para>
1939 <term><command>suspend
</command></term>
1942 <para>Suspend the system. This will trigger activation of the special target unit
1943 <filename>suspend.target
</filename>. This command is asynchronous, and will return after the suspend
1944 operation is successfully enqueued. It will not wait for the suspend/resume cycle to complete.
</para>
1949 <term><command>hibernate
</command></term>
1952 <para>Hibernate the system. This will trigger activation of the special target unit
1953 <filename>hibernate.target
</filename>. This command is asynchronous, and will return after the hibernation
1954 operation is successfully enqueued. It will not wait for the hibernate/thaw cycle to complete.
</para>
1959 <term><command>hybrid-sleep
</command></term>
1962 <para>Hibernate and suspend the system. This will trigger activation of the special target unit
1963 <filename>hybrid-sleep.target
</filename>. This command is asynchronous, and will return after the hybrid
1964 sleep operation is successfully enqueued. It will not wait for the sleep/wake-up cycle to complete.
</para>
1969 <term><command>suspend-then-hibernate
</command></term>
1972 <para>Suspend the system and hibernate it after the delay specified in
<filename>systemd-sleep.conf
</filename>.
1973 This will trigger activation of the special target unit
<filename>suspend-then-hibernate.target
</filename>.
1974 This command is asynchronous, and will return after the hybrid sleep operation is successfully enqueued.
1975 It will not wait for the sleep/wake-up or hibernate/thaw cycle to complete.
</para>
1982 <title>Parameter Syntax
</title>
1984 <para>Unit commands listed above take either a single unit name (designated as
<replaceable>UNIT
</replaceable>),
1985 or multiple unit specifications (designated as
<replaceable>PATTERN
</replaceable>…). In the first case, the
1986 unit name with or without a suffix must be given. If the suffix is not specified (unit name is
"abbreviated"),
1987 systemctl will append a suitable suffix,
<literal>.service
</literal> by default, and a type-specific suffix in
1988 case of commands which operate only on specific unit types. For example,
1989 <programlisting># systemctl start sshd
</programlisting> and
1990 <programlisting># systemctl start sshd.service
</programlisting>
1991 are equivalent, as are
1992 <programlisting># systemctl isolate default
</programlisting>
1994 <programlisting># systemctl isolate default.target
</programlisting>
1995 Note that (absolute) paths to device nodes are automatically converted to device unit names, and other (absolute)
1996 paths to mount unit names.
1997 <programlisting># systemctl status /dev/sda
1998 # systemctl status /home
</programlisting>
2000 <programlisting># systemctl status dev-sda.device
2001 # systemctl status home.mount
</programlisting>
2002 In the second case, shell-style globs will be matched against the primary names of all units currently in memory;
2003 literal unit names, with or without a suffix, will be treated as in the first case. This means that literal unit
2004 names always refer to exactly one unit, but globs may match zero units and this is not considered an
2007 <para>Glob patterns use
2008 <citerefentry project='man-pages'
><refentrytitle>fnmatch
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
2009 so normal shell-style globbing rules are used, and
2010 <literal>*
</literal>,
<literal>?
</literal>,
2011 <literal>[]
</literal> may be used. See
2012 <citerefentry project='man-pages'
><refentrytitle>glob
</refentrytitle><manvolnum>7</manvolnum></citerefentry>
2013 for more details. The patterns are matched against the primary names of
2014 units currently in memory, and patterns which do not match anything
2015 are silently skipped. For example:
2016 <programlisting># systemctl stop sshd@*.service
</programlisting>
2017 will stop all
<filename>sshd@.service
</filename> instances. Note that alias names of units, and units that aren't
2018 in memory are not considered for glob expansion.
2021 <para>For unit file commands, the specified
<replaceable>UNIT
</replaceable> should be the name of the unit file
2022 (possibly abbreviated, see above), or the absolute path to the unit file:
2023 <programlisting># systemctl enable foo.service
</programlisting>
2025 <programlisting># systemctl link /path/to/foo.service
</programlisting>
2032 <title>Exit status
</title>
2034 <para>On success,
0 is returned, a non-zero failure code otherwise.
</para>
2036 <para><command>systemctl
</command> uses the return codes defined by LSB, as defined in
2037 <ulink url=
"http://refspecs.linuxbase.org/LSB_3.0.0/LSB-PDA/LSB-PDA/iniscrptact.html">LSB
3.0.0</ulink>.
2041 <title>LSB return codes
</title>
2046 <entry>Value
</entry>
2047 <entry>Description in LSB
</entry>
2048 <entry>Use in systemd
</entry>
2053 <entry><constant>0</constant></entry>
2054 <entry>"program is running or service is OK"</entry>
2055 <entry>unit is active
</entry>
2058 <entry><constant>1</constant></entry>
2059 <entry>"program is dead and <filename>/var/run</filename> pid file exists"</entry>
2060 <entry>unit
<emphasis>not
</emphasis> failed (used by
<command>is-failed
</command>)
</entry>
2063 <entry><constant>2</constant></entry>
2064 <entry>"program is dead and <filename>/var/lock</filename> lock file exists"</entry>
2065 <entry>unused
</entry>
2068 <entry><constant>3</constant></entry>
2069 <entry>"program is not running"</entry>
2070 <entry>unit is not active
</entry>
2073 <entry><constant>4</constant></entry>
2074 <entry>"program or service status is unknown"</entry>
2075 <entry>no such unit
</entry>
2081 <para>The mapping of LSB service states to systemd unit states is imperfect, so it is better to
2082 not rely on those return values but to look for specific unit states and substates instead.
2087 <title>Environment
</title>
2089 <variablelist class='environment-variables'
>
2091 <term><varname>$SYSTEMD_EDITOR
</varname></term>
2093 <listitem><para>Editor to use when editing units; overrides
2094 <varname>$EDITOR
</varname> and
<varname>$VISUAL
</varname>. If neither
2095 <varname>$SYSTEMD_EDITOR
</varname> nor
<varname>$EDITOR
</varname> nor
2096 <varname>$VISUAL
</varname> are present or if it is set to an empty
2097 string or if their execution failed, systemctl will try to execute well
2098 known editors in this order:
2099 <citerefentry project='die-net'
><refentrytitle>editor
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2100 <citerefentry project='die-net'
><refentrytitle>nano
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2101 <citerefentry project='die-net'
><refentrytitle>vim
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2102 <citerefentry project='die-net'
><refentrytitle>vi
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
2106 <xi:include href=
"less-variables.xml" xpointer=
"pager"/>
2107 <xi:include href=
"less-variables.xml" xpointer=
"less"/>
2108 <xi:include href=
"less-variables.xml" xpointer=
"lesscharset"/>
2112 <title>See Also
</title>
2114 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2115 <citerefentry><refentrytitle>journalctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2116 <citerefentry><refentrytitle>loginctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2117 <citerefentry><refentrytitle>machinectl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2118 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2119 <citerefentry><refentrytitle>systemd.resource-control
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2120 <citerefentry><refentrytitle>systemd.special
</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
2121 <citerefentry project='man-pages'
><refentrytitle>wall
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2122 <citerefentry><refentrytitle>systemd.preset
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2123 <citerefentry><refentrytitle>systemd.generator
</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
2124 <citerefentry project='man-pages'
><refentrytitle>glob
</refentrytitle><manvolnum>7</manvolnum></citerefentry>
projects / thirdparty / systemd.git / blob