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>Commands
</title>
50 <para>The following commands are understood:
</para>
53 <title>Unit Commands
</title>
57 <term><command>list-units
</command> <optional><replaceable>PATTERN
</replaceable>…
</optional></term>
60 <para>List units that
<command>systemd
</command> currently has in memory. This includes units that are
61 either referenced directly or through a dependency, units that are pinned by applications programmatically,
62 or units that were active in the past and have failed. By default only units which are active, have pending
63 jobs, or have failed are shown; this can be changed with option
<option>--all
</option>. If one or more
64 <replaceable>PATTERN
</replaceable>s are specified, only units matching one of them are shown. The units
65 that are shown are additionally filtered by
<option>--type=
</option> and
<option>--state=
</option> if those
66 options are specified.
</para>
68 <para>Produces output similar to
69 <programlisting> UNIT LOAD ACTIVE SUB DESCRIPTION
70 sys-module-fuse.device loaded active plugged /sys/module/fuse
71 -.mount loaded active mounted Root Mount
72 boot-efi.mount loaded active mounted /boot/efi
73 systemd-journald.service loaded active running Journal Service
74 systemd-logind.service loaded active running Login Service
75 ● user@
1000.service loaded failed failed User Manager for UID
1000
77 systemd-tmpfiles-clean.timer loaded active waiting Daily Cleanup of Temporary Directories
79 LOAD = Reflects whether the unit definition was properly loaded.
80 ACTIVE = The high-level unit activation state, i.e. generalization of SUB.
81 SUB = The low-level unit activation state, values depend on unit type.
83 123 loaded units listed. Pass --all to see loaded but inactive units, too.
84 To show all installed unit files use 'systemctl list-unit-files'.
86 The header and the last unit of a given type are underlined if the
87 terminal supports that. A colored dot is shown next to services which
88 were masked, not found, or otherwise failed.
</para>
90 <para>The LOAD column shows the load state, one of
<constant>loaded
</constant>,
91 <constant>not-found
</constant>,
<constant>bad-setting
</constant>,
<constant>error
</constant>,
92 <constant>masked
</constant>. The ACTIVE columns shows the general unit state, one of
93 <constant>active
</constant>,
<constant>reloading
</constant>,
<constant>inactive
</constant>,
94 <constant>failed
</constant>,
<constant>activating
</constant>,
<constant>deactivating
</constant>. The SUB
95 column shows the unit-type-specific detailed state of the unit, possible values vary by unit type. The list
96 of possible LOAD, ACTIVE, and SUB states is not constant and new systemd releases may both add and remove
97 values.
<programlisting>systemctl --state=help
</programlisting> command maybe be used to display the
98 current set of possible values.
</para>
100 <para>This is the default command.
</para>
105 <term><command>list-sockets
</command> <optional><replaceable>PATTERN
</replaceable>…
</optional></term>
108 <para>List socket units currently in memory, ordered by listening address. If one or more
109 <replaceable>PATTERN
</replaceable>s are specified, only socket units matching one of them are
110 shown. Produces output similar to
112 LISTEN UNIT ACTIVATES
113 /dev/initctl systemd-initctl.socket systemd-initctl.service
115 [::]:
22 sshd.socket sshd.service
116 kobject-uevent
1 systemd-udevd-kernel.socket systemd-udevd.service
118 5 sockets listed.
</programlisting>
119 Note: because the addresses might contains spaces, this output
120 is not suitable for programmatic consumption.
123 <para>Also see
<option>--show-types
</option>,
<option>--all
</option>, and
<option>--state=
</option>.
</para>
128 <term><command>list-timers
</command> <optional><replaceable>PATTERN
</replaceable>…
</optional></term>
131 <para>List timer units currently in memory, ordered by the time they elapse next. If one or more
132 <replaceable>PATTERN
</replaceable>s are specified, only units matching one of them are shown.
133 Produces output similar to
135 NEXT LEFT LAST PASSED UNIT ACTIVATES
136 n/a n/a Thu
2017-
02-
23 13:
40:
29 EST
3 days ago ureadahead-stop.timer ureadahead-stop.service
137 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
138 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
139 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
143 <para><emphasis>NEXT
</emphasis> shows the next time the timer will run.
</para>
144 <para><emphasis>LEFT
</emphasis> shows how long till the next time the timer runs.
</para>
145 <para><emphasis>LAST
</emphasis> shows the last time the timer ran.
</para>
146 <para><emphasis>PASSED
</emphasis> shows how long has passed since the timer last ran.
</para>
147 <para><emphasis>UNIT
</emphasis> shows the name of the timer
</para>
148 <para><emphasis>ACTIVATES
</emphasis> shows the name the service the timer activates when it runs.
</para>
150 <para>Also see
<option>--all
</option> and
<option>--state=
</option>.
</para>
155 <term><command>start
<replaceable>PATTERN
</replaceable>…
</command></term>
158 <para>Start (activate) one or more units specified on the command line.
</para>
160 <para>Note that unit glob patterns expand to names of units currently in memory. Units which are
161 not active and are not in a failed state usually are not in memory, and will not be matched by
162 any pattern. In addition, in case of instantiated units, systemd is often unaware of the instance
163 name until the instance has been started. Therefore, using glob patterns with
164 <command>start
</command> has limited usefulness. Also, secondary alias names of units are not
167 <para>Option
<option>--all
</option> may be used to also operate on inactive units which are
168 referenced by other loaded units. Note that this is not the same as operating on
"all" possible
169 units, because as the previous paragraph describes, such a list is ill-defined. Nevertheless,
170 <command>systemctl start --all
<replaceable>GLOB
</replaceable></command> may be useful if all the
171 units that should match the pattern are pulled in by some target which is known to be loaded.
176 <term><command>stop
<replaceable>PATTERN
</replaceable>…
</command></term>
179 <para>Stop (deactivate) one or more units specified on the command line.
</para>
181 <para>This command will fail if the unit does not exist or if stopping of the unit is prohibited (see
182 <varname>RefuseManualStop=
</varname> in
183 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
184 It will
<emphasis>not
</emphasis> fail if any of the commands configured to stop the unit
185 (
<varname>ExecStop=
</varname>, etc.) fail, because the manager will still forcibly terminate the
190 <term><command>reload
<replaceable>PATTERN
</replaceable>…
</command></term>
193 <para>Asks all units listed on the command line to reload
194 their configuration. Note that this will reload the
195 service-specific configuration, not the unit configuration
196 file of systemd. If you want systemd to reload the
197 configuration file of a unit, use the
198 <command>daemon-reload
</command> command. In other words:
199 for the example case of Apache, this will reload Apache's
200 <filename>httpd.conf
</filename> in the web server, not the
201 <filename>apache.service
</filename> systemd unit
204 <para>This command should not be confused with the
205 <command>daemon-reload
</command> command.
</para>
210 <term><command>restart
<replaceable>PATTERN
</replaceable>…
</command></term>
213 <para>Stop and then start one or more units specified on the command line. If the units are not running
214 yet, they will be started.
</para>
216 <para>Note that restarting a unit with this command does not necessarily flush out all of the unit's
217 resources before it is started again. For example, the per-service file descriptor storage facility (see
218 <varname>FileDescriptorStoreMax=
</varname> in
219 <citerefentry><refentrytitle>systemd.service
</refentrytitle><manvolnum>5</manvolnum></citerefentry>) will
220 remain intact as long as the unit has a job pending, and is only cleared when the unit is fully stopped and
221 no jobs are pending anymore. If it is intended that the file descriptor store is flushed out, too, during a
222 restart operation an explicit
<command>systemctl stop
</command> command followed by
<command>systemctl
223 start
</command> should be issued.
</para>
227 <term><command>try-restart
<replaceable>PATTERN
</replaceable>…
</command></term>
230 <para>Stop and then start one or more units specified on the
231 command line if the units are running. This does nothing
232 if units are not running.
</para>
233 <!-- Note that we don't document condrestart here, as that is just compatibility support, and we generally
234 don't document that. -->
238 <term><command>reload-or-restart
<replaceable>PATTERN
</replaceable>…
</command></term>
241 <para>Reload one or more units if they support it. If not, stop and then start them instead. If the units
242 are not running yet, they will be started.
</para>
246 <term><command>try-reload-or-restart
<replaceable>PATTERN
</replaceable>…
</command></term>
249 <para>Reload one or more units if they support it. If not, stop and then start them instead. This does
250 nothing if the units are not running.
</para>
251 <!-- Note that we don't document force-reload here, as that is just compatibility support, and we generally
252 don't document that. -->
256 <term><command>isolate
<replaceable>UNIT
</replaceable></command></term>
259 <para>Start the unit specified on the command line and its dependencies
260 and stop all others, unless they have
261 <option>IgnoreOnIsolate=yes
</option> (see
262 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
263 If a unit name with no extension is given, an extension of
264 <literal>.target
</literal> will be assumed.
</para>
266 <para>This is similar to changing the runlevel in a
267 traditional init system. The
<command>isolate
</command>
268 command will immediately stop processes that are not enabled
269 in the new unit, possibly including the graphical
270 environment or terminal you are currently using.
</para>
272 <para>Note that this is allowed only on units where
273 <option>AllowIsolate=
</option> is enabled. See
274 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
279 <term><command>kill
<replaceable>PATTERN
</replaceable>…
</command></term>
282 <para>Send a signal to one or more processes of the
283 unit. Use
<option>--kill-who=
</option> to select which
284 process to kill. Use
<option>--signal=
</option> to select
285 the signal to send.
</para>
289 <term><command>clean
<replaceable>PATTERN
</replaceable>…
</command></term>
292 <para>Remove the configuration, state, cache, logs or runtime data of the specified units. Use
293 <option>--what=
</option> to select which kind of resource to remove. For service units this may
294 be used to remove the directories configured with
<varname>ConfigurationDirectory=
</varname>,
295 <varname>StateDirectory=
</varname>,
<varname>CacheDirectory=
</varname>,
296 <varname>LogsDirectory=
</varname> and
<varname>RuntimeDirectory=
</varname>, see
297 <citerefentry><refentrytitle>systemd.exec
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
298 for details. For timer units this may be used to clear out the persistent timestamp data if
299 <varname>Persistent=
</varname> is used and
<option>--what=state
</option> is selected, see
300 <citerefentry><refentrytitle>systemd.timer
</refentrytitle><manvolnum>5</manvolnum></citerefentry>. This
301 command only applies to units that use either of these settings. If
<option>--what=
</option> is
302 not specified, both the cache and runtime data are removed (as these two types of data are
303 generally redundant and reproducible on the next invocation of the unit).
</para>
307 <term><command>is-active
<replaceable>PATTERN
</replaceable>…
</command></term>
310 <para>Check whether any of the specified units are active
311 (i.e. running). Returns an exit code
312 <constant>0</constant> if at least one is active, or
313 non-zero otherwise. Unless
<option>--quiet
</option> is
314 specified, this will also print the current unit state to
315 standard output.
</para>
319 <term><command>is-failed
<replaceable>PATTERN
</replaceable>…
</command></term>
322 <para>Check whether any of the specified units are in a
323 "failed" state. Returns an exit code
324 <constant>0</constant> if at least one has failed,
325 non-zero otherwise. Unless
<option>--quiet
</option> is
326 specified, this will also print the current unit state to
327 standard output.
</para>
331 <term><command>status
</command> <optional><replaceable>PATTERN
</replaceable>…|
<replaceable>PID
</replaceable>…]
</optional></term>
334 <para>Show terse runtime status information about one or
335 more units, followed by most recent log data from the
336 journal. If no units are specified, show system status. If
337 combined with
<option>--all
</option>, also show the status of
338 all units (subject to limitations specified with
339 <option>-t
</option>). If a PID is passed, show information
340 about the unit the process belongs to.
</para>
342 <para>This function is intended to generate human-readable
343 output. If you are looking for computer-parsable output,
344 use
<command>show
</command> instead. By default, this
345 function only shows
10 lines of output and ellipsizes
346 lines to fit in the terminal window. This can be changed
347 with
<option>--lines
</option> and
<option>--full
</option>,
348 see above. In addition,
<command>journalctl
349 --unit=
<replaceable>NAME
</replaceable></command> or
351 --user-unit=
<replaceable>NAME
</replaceable></command> use
352 a similar filter for messages and might be more
356 <para>systemd implicitly loads units as necessary, so just running the
<command>status
</command> will
357 attempt to load a file. The command is thus not useful for determining if something was already loaded or
358 not. The units may possibly also be quickly unloaded after the operation is completed if there's no reason
359 to keep it in memory thereafter.
363 <title>Example output from systemctl status
</title>
365 <programlisting>$ systemctl status bluetooth
366 ● bluetooth.service - Bluetooth service
367 Loaded: loaded (/usr/lib/systemd/system/bluetooth.service; enabled; vendor preset: enabled)
368 Active: active (running) since Wed
2017-
01-
04 13:
54:
04 EST;
1 weeks
0 days ago
369 Docs: man:bluetoothd(
8)
370 Main PID:
930 (bluetoothd)
375 CGroup: /system.slice/bluetooth.service
376 └─
930 /usr/lib/bluetooth/bluetoothd
378 Jan
12 10:
46:
45 example.com bluetoothd[
8900]: Not enough free handles to register service
379 Jan
12 10:
46:
45 example.com bluetoothd[
8900]: Current Time Service could not be registered
380 Jan
12 10:
46:
45 example.com bluetoothd[
8900]: gatt-time-server: Input/output error (
5)
383 <para>The dot (
"●") uses color on supported terminals to summarize the unit state at a glance. White
384 indicates an
<literal>inactive
</literal> or
<literal>deactivating
</literal> state. Red indicates a
385 <literal>failed
</literal> or
<literal>error
</literal> state and green indicates an
386 <literal>active
</literal>,
<literal>reloading
</literal> or
<literal>activating
</literal> state.
389 <para>The
"Loaded:" line in the output will show
<literal>loaded
</literal> if the unit has been loaded into
390 memory. Other possible values for
"Loaded:" include:
<literal>error
</literal> if there was a problem
391 loading it,
<literal>not-found
</literal> if not unit file was found for this unit,
392 <literal>bad-setting
</literal> if an essential unit file setting could not be parsed and
393 <literal>masked
</literal> if the unit file has been masked. Along with showing the path to the unit file,
394 this line will also show the enablement state. Enabled commands start at boot. See the full table of
395 possible enablement states — including the definition of
<literal>masked
</literal> — in the documentation
396 for the
<command>is-enabled
</command> command.
399 <para>The
"Active:" line shows active state. The value is usually
<literal>active
</literal> or
400 <literal>inactive
</literal>. Active could mean started, bound, plugged in, etc depending on the unit type.
401 The unit could also be in process of changing states, reporting a state of
<literal>activating
</literal> or
402 <literal>deactivating
</literal>. A special
<literal>failed
</literal> state is entered when the service
403 failed in some way, such as a crash, exiting with an error code or timing out. If the failed state is
404 entered the cause will be logged for later reference.
</para>
410 <term><command>show
</command> <optional><replaceable>PATTERN
</replaceable>…|
<replaceable>JOB
</replaceable>…
</optional></term>
413 <para>Show properties of one or more units, jobs, or the manager itself. If no argument is specified,
414 properties of the manager will be shown. If a unit name is specified, properties of the unit are shown, and
415 if a job ID is specified, properties of the job are shown. By default, empty properties are suppressed. Use
416 <option>--all
</option> to show those too. To select specific properties to show, use
417 <option>--property=
</option>. This command is intended to be used whenever computer-parsable output is
418 required. Use
<command>status
</command> if you are looking for formatted human-readable output.
</para>
420 <para>Many properties shown by
<command>systemctl show
</command> map directly to configuration settings of
421 the system and service manager and its unit files. Note that the properties shown by the command are
422 generally more low-level, normalized versions of the original configuration settings and expose runtime
423 state in addition to configuration. For example, properties shown for service units include the service's
424 current main process identifier as
<literal>MainPID
</literal> (which is runtime state), and time settings
425 are always exposed as properties ending in the
<literal>…USec
</literal> suffix even if a matching
426 configuration options end in
<literal>…Sec
</literal>, because microseconds is the normalized time unit used
427 by the system and service manager.
</para>
431 <term><command>cat
<replaceable>PATTERN
</replaceable>…
</command></term>
434 <para>Show backing files of one or more units. Prints the
435 "fragment" and
"drop-ins" (source files) of units. Each
436 file is preceded by a comment which includes the file
437 name. Note that this shows the contents of the backing files
438 on disk, which may not match the system manager's
439 understanding of these units if any unit files were
440 updated on disk and the
<command>daemon-reload
</command>
441 command wasn't issued since.
</para>
445 <term><command>set-property
<replaceable>UNIT
</replaceable> <replaceable>PROPERTY
</replaceable>=
<replaceable>VALUE
</replaceable>…
</command></term>
448 <para>Set the specified unit properties at runtime where
449 this is supported. This allows changing configuration
450 parameter properties such as resource control settings at
451 runtime. Not all properties may be changed at runtime, but
452 many resource control settings (primarily those in
453 <citerefentry><refentrytitle>systemd.resource-control
</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
454 may. The changes are applied immediately, and stored on disk
455 for future boots, unless
<option>--runtime
</option> is
456 passed, in which case the settings only apply until the
457 next reboot. The syntax of the property assignment follows
458 closely the syntax of assignments in unit files.
</para>
460 <para>Example:
<command>systemctl set-property foobar.service CPUWeight=
200</command></para>
462 <para>If the specified unit appears to be inactive, the
463 changes will be only stored on disk as described
464 previously hence they will be effective when the unit will
467 <para>Note that this command allows changing multiple properties at the same time, which is
468 preferable over setting them individually.
</para>
470 <para>Example:
<command>systemctl set-property foobar.service CPUWeight=
200 MemoryMax=
2G IPAccounting=yes
</command></para>
472 <para>Like with unit file configuration settings, assigning an empty setting usually resets a
473 property to its defaults.
</para>
475 <para>Example:
<command>systemctl set-property avahi-daemon.service IPAddressDeny=
</command></para>
480 <term><command>help
<replaceable>PATTERN
</replaceable>…|
<replaceable>PID
</replaceable>…
</command></term>
483 <para>Show manual pages for one or more units, if
484 available. If a PID is given, the manual pages for the unit
485 the process belongs to are shown.
</para>
490 <term><command>reset-failed [
<replaceable>PATTERN
</replaceable>…]
</command></term>
493 <para>Reset the
<literal>failed
</literal> state of the specified units, or if no unit name is passed, reset
494 the state of all units. When a unit fails in some way (i.e. process exiting with non-zero error code,
495 terminating abnormally or timing out), it will automatically enter the
<literal>failed
</literal> state and
496 its exit code and status is recorded for introspection by the administrator until the service is
497 stopped/re-started or reset with this command.
</para>
499 <para>In addition to resetting the
<literal>failed
</literal> state of a unit it also resets various other
500 per-unit properties: the start rate limit counter of all unit types is reset to zero, as is the restart
501 counter of service units. Thus, if a unit's start limit (as configured with
502 <varname>StartLimitIntervalSec=
</varname>/
<varname>StartLimitBurst=
</varname>) is hit and the unit refuses
503 to be started again, use this command to make it startable again.
</para>
509 <command>list-dependencies
</command>
510 <optional><replaceable>UNIT
</replaceable></optional>
514 <para>Shows units required and wanted by the specified
515 unit. This recursively lists units following the
516 <varname>Requires=
</varname>,
517 <varname>Requisite=
</varname>,
518 <varname>ConsistsOf=
</varname>,
519 <varname>Wants=
</varname>,
<varname>BindsTo=
</varname>
520 dependencies. If no unit is specified,
521 <filename>default.target
</filename> is implied.
</para>
523 <para>By default, only target units are recursively
524 expanded. When
<option>--all
</option> is passed, all other
525 units are recursively expanded as well.
</para>
527 <para>Options
<option>--reverse
</option>,
528 <option>--after
</option>,
<option>--before
</option>
529 may be used to change what types of dependencies
532 <para>Note that this command only lists units currently loaded into memory by the service manager. In
533 particular, this command is not suitable to get a comprehensive list at all reverse dependencies on a
534 specific unit, as it won't list the dependencies declared by units currently not loaded.
</para>
541 <title>Unit File Commands
</title>
545 <term><command>list-unit-files
</command> <optional><replaceable>PATTERN…
</replaceable></optional></term>
548 <para>List unit files installed on the system, in combination with their enablement state (as reported by
549 <command>is-enabled
</command>). If one or more
<replaceable>PATTERN
</replaceable>s are specified, only unit
550 files whose name matches one of them are shown (patterns matching unit file system paths are not
556 <term><command>enable
<replaceable>UNIT
</replaceable>…
</command></term>
557 <term><command>enable
<replaceable>PATH
</replaceable>…
</command></term>
560 <para>Enable one or more units or unit instances. This will create a set of symlinks, as encoded in the
561 <literal>[Install]
</literal> sections of the indicated unit files. After the symlinks have been created,
562 the system manager configuration is reloaded (in a way equivalent to
<command>daemon-reload
</command>), in
563 order to ensure the changes are taken into account immediately. Note that this does
564 <emphasis>not
</emphasis> have the effect of also starting any of the units being enabled. If this is
565 desired, combine this command with the
<option>--now
</option> switch, or invoke
<command>start
</command>
566 with appropriate arguments later. Note that in case of unit instance enablement (i.e. enablement of units of
567 the form
<filename>foo@bar.service
</filename>), symlinks named the same as instances are created in the
568 unit configuration directory, however they point to the single template unit file they are instantiated
571 <para>This command expects either valid unit names (in which case various unit file directories are
572 automatically searched for unit files with appropriate names), or absolute paths to unit files (in which
573 case these files are read directly). If a specified unit file is located outside of the usual unit file
574 directories, an additional symlink is created, linking it into the unit configuration path, thus ensuring
575 it is found when requested by commands such as
<command>start
</command>. The file system where the linked
576 unit files are located must be accessible when systemd is started (e.g. anything underneath
577 <filename>/home
</filename> or
<filename>/var
</filename> is not allowed, unless those directories are
578 located on the root file system).
</para>
580 <para>This command will print the file system operations executed. This output may be suppressed by passing
581 <option>--quiet
</option>.
584 <para>Note that this operation creates only the symlinks suggested in the
<literal>[Install]
</literal>
585 section of the unit files. While this command is the recommended way to manipulate the unit configuration
586 directory, the administrator is free to make additional changes manually by placing or removing symlinks
587 below this directory. This is particularly useful to create configurations that deviate from the suggested
588 default installation. In this case, the administrator must make sure to invoke
589 <command>daemon-reload
</command> manually as necessary, in order to ensure the changes are taken into
593 <para>Enabling units should not be confused with starting (activating) units, as done by the
594 <command>start
</command> command. Enabling and starting units is orthogonal: units may be enabled without
595 being started and started without being enabled. Enabling simply hooks the unit into various suggested
596 places (for example, so that the unit is automatically started on boot or when a particular kind of
597 hardware is plugged in). Starting actually spawns the daemon process (in case of service units), or binds
598 the socket (in case of socket units), and so on.
</para>
600 <para>Depending on whether
<option>--system
</option>,
<option>--user
</option>,
<option>--runtime
</option>,
601 or
<option>--global
</option> is specified, this enables the unit for the system, for the calling user only,
602 for only this boot of the system, or for all future logins of all users. Note that in the last case, no
603 systemd daemon configuration is reloaded.
</para>
605 <para>Using
<command>enable
</command> on masked units is not supported and results in an error.
</para>
610 <term><command>disable
<replaceable>UNIT
</replaceable>…
</command></term>
613 <para>Disables one or more units. This removes all symlinks to the unit files backing the specified units
614 from the unit configuration directory, and hence undoes any changes made by
<command>enable
</command> or
615 <command>link
</command>. Note that this removes
<emphasis>all
</emphasis> symlinks to matching unit files,
616 including manually created symlinks, and not just those actually created by
<command>enable
</command> or
617 <command>link
</command>. Note that while
<command>disable
</command> undoes the effect of
618 <command>enable
</command>, the two commands are otherwise not symmetric, as
<command>disable
</command> may
619 remove more symlinks than a prior
<command>enable
</command> invocation of the same unit created.
</para>
621 <para>This command expects valid unit names only, it does not accept paths to unit files.
</para>
623 <para>In addition to the units specified as arguments, all units are disabled that are listed in the
624 <varname>Also=
</varname> setting contained in the
<literal>[Install]
</literal> section of any of the unit
625 files being operated on.
</para>
627 <para>This command implicitly reloads the system manager configuration after completing the operation. Note
628 that this command does not implicitly stop the units that are being disabled. If this is desired, either
629 combine this command with the
<option>--now
</option> switch, or invoke the
<command>stop
</command> command
630 with appropriate arguments later.
</para>
632 <para>This command will print information about the file system operations (symlink removals)
633 executed. This output may be suppressed by passing
<option>--quiet
</option>.
636 <para>This command honors
<option>--system
</option>,
<option>--user
</option>,
<option>--runtime
</option>
637 and
<option>--global
</option> in a similar way as
<command>enable
</command>.
</para>
642 <term><command>reenable
<replaceable>UNIT
</replaceable>…
</command></term>
645 <para>Reenable one or more units, as specified on the command line. This is a combination of
646 <command>disable
</command> and
<command>enable
</command> and is useful to reset the symlinks a unit file is
647 enabled with to the defaults configured in its
<literal>[Install]
</literal> section. This command expects
648 a unit name only, it does not accept paths to unit files.
</para>
653 <term><command>preset
<replaceable>UNIT
</replaceable>…
</command></term>
656 <para>Reset the enable/disable status one or more unit files, as specified on
657 the command line, to the defaults configured in the preset policy files. This
658 has the same effect as
<command>disable
</command> or
659 <command>enable
</command>, depending how the unit is listed in the preset
662 <para>Use
<option>--preset-mode=
</option> to control whether units shall be
663 enabled and disabled, or only enabled, or only disabled.
</para>
665 <para>If the unit carries no install information, it will be silently ignored
666 by this command.
<replaceable>UNIT
</replaceable> must be the real unit name,
667 any alias names are ignored silently.
</para>
669 <para>For more information on the preset policy format, see
670 <citerefentry><refentrytitle>systemd.preset
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
671 For more information on the concept of presets, please consult the
672 <ulink url=
"https://www.freedesktop.org/wiki/Software/systemd/Preset">Preset
</ulink>
678 <term><command>preset-all
</command></term>
681 <para>Resets all installed unit files to the defaults
682 configured in the preset policy file (see above).
</para>
684 <para>Use
<option>--preset-mode=
</option> to control
685 whether units shall be enabled and disabled, or only
686 enabled, or only disabled.
</para>
691 <term><command>is-enabled
<replaceable>UNIT
</replaceable>…
</command></term>
694 <para>Checks whether any of the specified unit files are
695 enabled (as with
<command>enable
</command>). Returns an
696 exit code of
0 if at least one is enabled, non-zero
697 otherwise. Prints the current enable status (see table).
698 To suppress this output, use
<option>--quiet
</option>.
699 To show installation targets, use
<option>--full
</option>.
704 <command>is-enabled
</command> output
711 <entry>Description
</entry>
712 <entry>Exit Code
</entry>
717 <entry><literal>enabled
</literal></entry>
718 <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>
719 <entry morerows='
1'
>0</entry>
722 <entry><literal>enabled-runtime
</literal></entry>
725 <entry><literal>linked
</literal></entry>
726 <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>
727 <entry morerows='
1'
>> 0</entry>
730 <entry><literal>linked-runtime
</literal></entry>
733 <entry><literal>masked
</literal></entry>
734 <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>
735 <entry morerows='
1'
>> 0</entry>
738 <entry><literal>masked-runtime
</literal></entry>
741 <entry><literal>static
</literal></entry>
742 <entry>The unit file is not enabled, and has no provisions for enabling in the
<literal>[Install]
</literal> unit file section.
</entry>
746 <entry><literal>indirect
</literal></entry>
747 <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>
751 <entry><literal>disabled
</literal></entry>
752 <entry>The unit file is not enabled, but contains an
<literal>[Install]
</literal> section with installation instructions.
</entry>
753 <entry>> 0</entry>
756 <entry><literal>generated
</literal></entry>
757 <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>
761 <entry><literal>transient
</literal></entry>
762 <entry>The unit file has been created dynamically with the runtime API. Transient units may not be enabled.
</entry>
766 <entry><literal>bad
</literal></entry>
767 <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>
768 <entry>> 0</entry>
778 <term><command>mask
<replaceable>UNIT
</replaceable>…
</command></term>
781 <para>Mask one or more units, as specified on the command line. This will link these unit files to
782 <filename>/dev/null
</filename>, making it impossible to start them. This is a stronger version of
783 <command>disable
</command>, since it prohibits all kinds of activation of the unit, including enablement
784 and manual activation. Use this option with care. This honors the
<option>--runtime
</option> option to only
785 mask temporarily until the next reboot of the system. The
<option>--now
</option> option may be used to
786 ensure that the units are also stopped. This command expects valid unit names only, it does not accept unit
792 <term><command>unmask
<replaceable>UNIT
</replaceable>…
</command></term>
795 <para>Unmask one or more unit files, as specified on the command line. This will undo the effect of
796 <command>mask
</command>. This command expects valid unit names only, it does not accept unit file
802 <term><command>link
<replaceable>PATH
</replaceable>…
</command></term>
805 <para>Link a unit file that is not in the unit file search paths into the unit file search path. This
806 command expects an absolute path to a unit file. The effect of this may be undone with
807 <command>disable
</command>. The effect of this command is that a unit file is made available for commands
808 such as
<command>start
</command>, even though it is not installed directly in the unit search path. The
809 file system where the linked unit files are located must be accessible when systemd is started
810 (e.g. anything underneath
<filename>/home
</filename> or
<filename>/var
</filename> is not allowed, unless
811 those directories are located on the root file system).
</para>
816 <term><command>revert
<replaceable>UNIT
</replaceable>…
</command></term>
819 <para>Revert one or more unit files to their vendor versions. This command removes drop-in configuration
820 files that modify the specified units, as well as any user-configured unit file that overrides a matching
821 vendor supplied unit file. Specifically, for a unit
<literal>foo.service
</literal> the matching directories
822 <literal>foo.service.d/
</literal> with all their contained files are removed, both below the persistent and
823 runtime configuration directories (i.e. below
<filename>/etc/systemd/system
</filename> and
824 <filename>/run/systemd/system
</filename>); if the unit file has a vendor-supplied version (i.e. a unit file
825 located below
<filename>/usr
</filename>) any matching persistent or runtime unit file that overrides it is
826 removed, too. Note that if a unit file has no vendor-supplied version (i.e. is only defined below
827 <filename>/etc/systemd/system
</filename> or
<filename>/run/systemd/system
</filename>, but not in a unit
828 file stored below
<filename>/usr
</filename>), then it is not removed. Also, if a unit is masked, it is
831 <para>Effectively, this command may be used to undo all changes made with
<command>systemctl
832 edit
</command>,
<command>systemctl set-property
</command> and
<command>systemctl mask
</command> and puts
833 the original unit file with its settings back in effect.
</para>
838 <term><command>add-wants
<replaceable>TARGET
</replaceable>
839 <replaceable>UNIT
</replaceable>…
</command></term>
840 <term><command>add-requires
<replaceable>TARGET
</replaceable>
841 <replaceable>UNIT
</replaceable>…
</command></term>
844 <para>Adds
<literal>Wants=
</literal> or
<literal>Requires=
</literal>
845 dependencies, respectively, to the specified
846 <replaceable>TARGET
</replaceable> for one or more units.
</para>
848 <para>This command honors
<option>--system
</option>,
849 <option>--user
</option>,
<option>--runtime
</option> and
850 <option>--global
</option> in a way similar to
851 <command>enable
</command>.
</para>
857 <term><command>edit
<replaceable>UNIT
</replaceable>…
</command></term>
860 <para>Edit a drop-in snippet or a whole replacement file if
861 <option>--full
</option> is specified, to extend or override the
862 specified unit.
</para>
864 <para>Depending on whether
<option>--system
</option> (the default),
865 <option>--user
</option>, or
<option>--global
</option> is specified,
866 this command creates a drop-in file for each unit either for the system,
867 for the calling user, or for all futures logins of all users. Then,
868 the editor (see the
"Environment" section below) is invoked on
869 temporary files which will be written to the real location if the
870 editor exits successfully.
</para>
872 <para>If
<option>--full
</option> is specified, this will copy the
873 original units instead of creating drop-in files.
</para>
875 <para>If
<option>--force
</option> is specified and any units do
876 not already exist, new unit files will be opened for editing.
</para>
878 <para>If
<option>--runtime
</option> is specified, the changes will
879 be made temporarily in
<filename>/run
</filename> and they will be
880 lost on the next reboot.
</para>
882 <para>If the temporary file is empty upon exit, the modification of
883 the related unit is canceled.
</para>
885 <para>After the units have been edited, systemd configuration is
886 reloaded (in a way that is equivalent to
<command>daemon-reload
</command>).
889 <para>Note that this command cannot be used to remotely edit units
890 and that you cannot temporarily edit units which are in
891 <filename>/etc
</filename>, since they take precedence over
892 <filename>/run
</filename>.
</para>
897 <term><command>get-default
</command></term>
900 <para>Return the default target to boot into. This returns
901 the target unit name
<filename>default.target
</filename>
902 is aliased (symlinked) to.
</para>
907 <term><command>set-default
<replaceable>TARGET
</replaceable></command></term>
910 <para>Set the default target to boot into. This sets
911 (symlinks) the
<filename>default.target
</filename> alias
912 to the given target unit.
</para>
920 <title>Machine Commands
</title>
924 <term><command>list-machines
</command> <optional><replaceable>PATTERN
</replaceable>…
</optional></term>
927 <para>List the host and all running local containers with
928 their state. If one or more
929 <replaceable>PATTERN
</replaceable>s are specified, only
930 containers matching one of them are shown.
938 <title>Job Commands
</title>
942 <term><command>list-jobs
<optional><replaceable>PATTERN…
</replaceable></optional></command></term>
945 <para>List jobs that are in progress. If one or more
946 <replaceable>PATTERN
</replaceable>s are specified, only
947 jobs for units matching one of them are shown.
</para>
949 <para>When combined with
<option>--after
</option> or
<option>--before
</option> the list is augmented with
950 information on which other job each job is waiting for, and which other jobs are waiting for it, see
955 <term><command>cancel
<replaceable>JOB
</replaceable>…
</command></term>
958 <para>Cancel one or more jobs specified on the command line
959 by their numeric job IDs. If no job ID is specified, cancel
960 all pending jobs.
</para>
967 <title>Environment Commands
</title>
971 <term><command>show-environment
</command></term>
974 <para>Dump the systemd manager environment block. This is the environment
975 block that is passed to all processes the manager spawns. The environment
976 block will be dumped in straight-forward form suitable for sourcing into
977 most shells. If no special characters or whitespace is present in the variable
978 values, no escaping is performed, and the assignments have the form
979 <literal>VARIABLE=value
</literal>. If whitespace or characters which have
980 special meaning to the shell are present, dollar-single-quote escaping is
981 used, and assignments have the form
<literal>VARIABLE=$'value'
</literal>.
982 This syntax is known to be supported by
983 <citerefentry project='die-net'
><refentrytitle>bash
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
984 <citerefentry project='die-net'
><refentrytitle>zsh
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
985 <citerefentry project='die-net'
><refentrytitle>ksh
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
987 <citerefentry project='die-net'
><refentrytitle>busybox
</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
988 <citerefentry project='die-net'
><refentrytitle>ash
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
990 <citerefentry project='die-net'
><refentrytitle>dash
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
992 <citerefentry project='die-net'
><refentrytitle>fish
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
997 <term><command>set-environment
<replaceable>VARIABLE=VALUE
</replaceable>…
</command></term>
1000 <para>Set one or more systemd manager environment variables,
1001 as specified on the command line.
</para>
1005 <term><command>unset-environment
<replaceable>VARIABLE
</replaceable>…
</command></term>
1008 <para>Unset one or more systemd manager environment
1009 variables. If only a variable name is specified, it will be
1010 removed regardless of its value. If a variable and a value
1011 are specified, the variable is only removed if it has the
1012 specified value.
</para>
1017 <command>import-environment
</command>
1018 <optional><replaceable>VARIABLE…
</replaceable></optional>
1022 <para>Import all, one or more environment variables set on
1023 the client into the systemd manager environment block. If
1024 no arguments are passed, the entire environment block is
1025 imported. Otherwise, a list of one or more environment
1026 variable names should be passed, whose client-side values
1027 are then imported into the manager's environment
1035 <title>Manager State Commands
</title>
1039 <term><command>daemon-reload
</command></term>
1042 <para>Reload the systemd manager configuration. This will
1043 rerun all generators (see
1044 <citerefentry><refentrytitle>systemd.generator
</refentrytitle><manvolnum>7</manvolnum></citerefentry>),
1045 reload all unit files, and recreate the entire dependency
1046 tree. While the daemon is being reloaded, all sockets
1047 systemd listens on behalf of user configuration will stay
1050 <para>This command should not be confused with the
1051 <command>reload
</command> command.
</para>
1056 <term><command>daemon-reexec
</command></term>
1059 <para>Reexecute the systemd manager. This will serialize the
1060 manager state, reexecute the process and deserialize the
1061 state again. This command is of little use except for
1062 debugging and package upgrades. Sometimes, it might be
1063 helpful as a heavy-weight
<command>daemon-reload
</command>.
1064 While the daemon is being reexecuted, all sockets systemd listening
1065 on behalf of user configuration will stay accessible.
1071 <term><command>log-level
</command> [
<replaceable>LEVEL
</replaceable>]
</term>
1073 <listitem><para>If no argument is given, print the current log level of the manager. If an
1074 optional argument
<replaceable>LEVEL
</replaceable> is provided, then the command changes the
1075 current log level of the manager to
<replaceable>LEVEL
</replaceable> (accepts the same values as
1076 <option>--log-level=
</option> described in
1077 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
1082 <term><command>log-target
</command> [
<replaceable>TARGET
</replaceable>]
</term>
1084 <listitem><para>If no argument is given, print the current log target of the manager. If an
1085 optional argument
<replaceable>TARGET
</replaceable> is provided, then the command changes the
1086 current log target of the manager to
<replaceable>TARGET
</replaceable> (accepts the same values as
1087 <option>--log-target=
</option>, described in
1088 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
1093 <term><command>service-watchdogs
</command> [yes|no]
</term>
1095 <listitem><para>If no argument is given, print the current state of service runtime watchdogs of
1096 the manager. If an optional boolean argument is provided, then globally enables or disables the
1097 service runtime watchdogs (
<option>WatchdogSec=
</option>) and emergency actions (e.g.
1098 <option>OnFailure=
</option> or
<option>StartLimitAction=
</option>); see
1099 <citerefentry><refentrytitle>systemd.service
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1100 The hardware watchdog is not affected by this setting.
</para></listitem>
1106 <title>System Commands
</title>
1110 <term><command>is-system-running
</command></term>
1113 <para>Checks whether the system is operational. This
1114 returns success (exit code
0) when the system is fully up
1115 and running, specifically not in startup, shutdown or
1116 maintenance mode, and with no failed services. Failure is
1117 returned otherwise (exit code non-zero). In addition, the
1118 current state is printed in a short string to standard
1119 output, see the table below. Use
<option>--quiet
</option> to
1120 suppress this output.
</para>
1122 <para>Use
<option>--wait
</option> to wait until the boot
1123 process is completed before printing the current state and
1124 returning the appropriate error status. If
<option>--wait
</option>
1125 is in use, states
<varname>initializing
</varname> or
1126 <varname>starting
</varname> will not be reported, instead
1127 the command will block until a later state (such as
1128 <varname>running
</varname> or
<varname>degraded
</varname>)
1132 <title><command>is-system-running
</command> output
</title>
1134 <colspec colname='name'
/>
1135 <colspec colname='description'
/>
1136 <colspec colname='exit-code'
/>
1140 <entry>Description
</entry>
1141 <entry>Exit Code
</entry>
1146 <entry><varname>initializing
</varname></entry>
1147 <entry><para>Early bootup, before
1148 <filename>basic.target
</filename> is reached
1149 or the
<varname>maintenance
</varname> state entered.
1151 <entry>> 0</entry>
1154 <entry><varname>starting
</varname></entry>
1155 <entry><para>Late bootup, before the job queue
1156 becomes idle for the first time, or one of the
1157 rescue targets are reached.
</para></entry>
1158 <entry>> 0</entry>
1161 <entry><varname>running
</varname></entry>
1162 <entry><para>The system is fully
1163 operational.
</para></entry>
1167 <entry><varname>degraded
</varname></entry>
1168 <entry><para>The system is operational but one or more
1169 units failed.
</para></entry>
1170 <entry>> 0</entry>
1173 <entry><varname>maintenance
</varname></entry>
1174 <entry><para>The rescue or emergency target is
1175 active.
</para></entry>
1176 <entry>> 0</entry>
1179 <entry><varname>stopping
</varname></entry>
1180 <entry><para>The manager is shutting
1181 down.
</para></entry>
1182 <entry>> 0</entry>
1185 <entry><varname>offline
</varname></entry>
1186 <entry><para>The manager is not
1187 running. Specifically, this is the operational
1188 state if an incompatible program is running as
1189 system manager (PID
1).
</para></entry>
1190 <entry>> 0</entry>
1193 <entry><varname>unknown
</varname></entry>
1194 <entry><para>The operational state could not be
1195 determined, due to lack of resources or another
1196 error cause.
</para></entry>
1197 <entry>> 0</entry>
1206 <term><command>default
</command></term>
1209 <para>Enter default mode. This is equivalent to
<command>systemctl isolate default.target
</command>. This
1210 operation is blocking by default, use
<option>--no-block
</option> to request asynchronous behavior.
</para>
1215 <term><command>rescue
</command></term>
1218 <para>Enter rescue mode. This is equivalent to
<command>systemctl isolate rescue.target
</command>. This
1219 operation is blocking by default, use
<option>--no-block
</option> to request asynchronous behavior.
</para>
1223 <term><command>emergency
</command></term>
1226 <para>Enter emergency mode. This is equivalent to
<command>systemctl isolate
1227 emergency.target
</command>. This operation is blocking by default, use
<option>--no-block
</option> to
1228 request asynchronous behavior.
</para>
1232 <term><command>halt
</command></term>
1235 <para>Shut down and halt the system. This is mostly equivalent to
<command>systemctl start halt.target
1236 --job-mode=replace-irreversibly --no-block
</command>, but also prints a wall message to all users. This command is
1237 asynchronous; it will return after the halt operation is enqueued, without waiting for it to complete. Note
1238 that this operation will simply halt the OS kernel after shutting down, leaving the hardware powered
1239 on. Use
<command>systemctl poweroff
</command> for powering off the system (see below).
</para>
1241 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1242 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1243 system halt. If
<option>--force
</option> is specified twice, the operation is immediately executed without
1244 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1245 <option>--force
</option> is specified twice the halt operation is executed by
<command>systemctl
</command>
1246 itself, and the system manager is not contacted. This means the command should succeed even when the system
1247 manager has crashed.
</para>
1251 <term><command>poweroff
</command></term>
1254 <para>Shut down and power-off the system. This is mostly equivalent to
<command>systemctl start
1255 poweroff.target --job-mode=replace-irreversibly --no-block
</command>, but also prints a wall message to all
1256 users. This command is asynchronous; it will return after the power-off operation is enqueued, without
1257 waiting for it to complete.
</para>
1259 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1260 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1261 powering off. If
<option>--force
</option> is specified twice, the operation is immediately executed without
1262 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1263 <option>--force
</option> is specified twice the power-off operation is executed by
1264 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
1265 succeed even when the system manager has crashed.
</para>
1269 <term><command>reboot
</command> <optional><replaceable>arg
</replaceable></optional></term>
1272 <para>Shut down and reboot the system. This is mostly equivalent to
<command>systemctl start reboot.target
1273 --job-mode=replace-irreversibly --no-block
</command>, but also prints a wall message to all users. This
1274 command is asynchronous; it will return after the reboot operation is enqueued, without waiting for it to
1277 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1278 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1279 reboot. If
<option>--force
</option> is specified twice, the operation is immediately executed without
1280 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1281 <option>--force
</option> is specified twice the reboot operation is executed by
1282 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
1283 succeed even when the system manager has crashed.
</para>
1285 <para>If the optional argument
<replaceable>arg
</replaceable> is given, it will be passed as the optional
1286 argument to the
<citerefentry><refentrytitle>reboot
</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1287 system call. The value is architecture and firmware specific. As an example,
<literal>recovery
</literal>
1288 might be used to trigger system recovery, and
<literal>fota
</literal> might be used to trigger a
1289 <quote>firmware over the air
</quote> update.
</para>
1294 <term><command>kexec
</command></term>
1297 <para>Shut down and reboot the system via
<command>kexec
</command>. This is equivalent to
1298 <command>systemctl start kexec.target --job-mode=replace-irreversibly --no-block
</command>. This command is
1299 asynchronous; it will return after the reboot operation is enqueued, without waiting for it to
1302 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1303 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1309 <term><command>exit
</command> <optional><replaceable>EXIT_CODE
</replaceable></optional></term>
1312 <para>Ask the service manager to quit. This is only supported for user service managers (i.e. in
1313 conjunction with the
<option>--user
</option> option) or in containers and is equivalent to
1314 <command>poweroff
</command> otherwise. This command is asynchronous; it will return after the exit
1315 operation is enqueued, without waiting for it to complete.
</para>
1317 <para>The service manager will exit with the specified exit code, if
1318 <replaceable>EXIT_CODE
</replaceable> is passed.
</para>
1323 <term><command>switch-root
</command> <replaceable>ROOT
</replaceable> <optional><replaceable>INIT
</replaceable></optional></term>
1326 <para>Switches to a different root directory and executes a new system manager process below it. This is
1327 intended for usage in initial RAM disks (
"initrd"), and will transition from the initrd's system manager
1328 process (a.k.a.
"init" process) to the main system manager process which is loaded from the actual host
1329 volume. This call takes two arguments: the directory that is to become the new root directory, and the path
1330 to the new system manager binary below it to execute as PID
1. If the latter is omitted or the empty
1331 string, a systemd binary will automatically be searched for and used as init. If the system manager path is
1332 omitted, equal to the empty string or identical to the path to the systemd binary, the state of the
1333 initrd's system manager process is passed to the main system manager, which allows later introspection of
1334 the state of the services involved in the initrd boot phase.
</para>
1339 <term><command>suspend
</command></term>
1342 <para>Suspend the system. This will trigger activation of the special target unit
1343 <filename>suspend.target
</filename>. This command is asynchronous, and will return after the suspend
1344 operation is successfully enqueued. It will not wait for the suspend/resume cycle to complete.
</para>
1349 <term><command>hibernate
</command></term>
1352 <para>Hibernate the system. This will trigger activation of the special target unit
1353 <filename>hibernate.target
</filename>. This command is asynchronous, and will return after the hibernation
1354 operation is successfully enqueued. It will not wait for the hibernate/thaw cycle to complete.
</para>
1359 <term><command>hybrid-sleep
</command></term>
1362 <para>Hibernate and suspend the system. This will trigger activation of the special target unit
1363 <filename>hybrid-sleep.target
</filename>. This command is asynchronous, and will return after the hybrid
1364 sleep operation is successfully enqueued. It will not wait for the sleep/wake-up cycle to complete.
</para>
1369 <term><command>suspend-then-hibernate
</command></term>
1372 <para>Suspend the system and hibernate it after the delay specified in
<filename>systemd-sleep.conf
</filename>.
1373 This will trigger activation of the special target unit
<filename>suspend-then-hibernate.target
</filename>.
1374 This command is asynchronous, and will return after the hybrid sleep operation is successfully enqueued.
1375 It will not wait for the sleep/wake-up or hibernate/thaw cycle to complete.
</para>
1382 <title>Parameter Syntax
</title>
1384 <para>Unit commands listed above take either a single unit name (designated as
<replaceable>UNIT
</replaceable>),
1385 or multiple unit specifications (designated as
<replaceable>PATTERN
</replaceable>…). In the first case, the
1386 unit name with or without a suffix must be given. If the suffix is not specified (unit name is
"abbreviated"),
1387 systemctl will append a suitable suffix,
<literal>.service
</literal> by default, and a type-specific suffix in
1388 case of commands which operate only on specific unit types. For example,
1389 <programlisting># systemctl start sshd
</programlisting> and
1390 <programlisting># systemctl start sshd.service
</programlisting>
1391 are equivalent, as are
1392 <programlisting># systemctl isolate default
</programlisting>
1394 <programlisting># systemctl isolate default.target
</programlisting>
1395 Note that (absolute) paths to device nodes are automatically converted to device unit names, and other (absolute)
1396 paths to mount unit names.
1397 <programlisting># systemctl status /dev/sda
1398 # systemctl status /home
</programlisting>
1400 <programlisting># systemctl status dev-sda.device
1401 # systemctl status home.mount
</programlisting>
1402 In the second case, shell-style globs will be matched against the primary names of all units currently in memory;
1403 literal unit names, with or without a suffix, will be treated as in the first case. This means that literal unit
1404 names always refer to exactly one unit, but globs may match zero units and this is not considered an
1407 <para>Glob patterns use
1408 <citerefentry project='man-pages'
><refentrytitle>fnmatch
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
1409 so normal shell-style globbing rules are used, and
1410 <literal>*
</literal>,
<literal>?
</literal>,
1411 <literal>[]
</literal> may be used. See
1412 <citerefentry project='man-pages'
><refentrytitle>glob
</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1413 for more details. The patterns are matched against the primary names of
1414 units currently in memory, and patterns which do not match anything
1415 are silently skipped. For example:
1416 <programlisting># systemctl stop sshd@*.service
</programlisting>
1417 will stop all
<filename>sshd@.service
</filename> instances. Note that alias names of units, and units that aren't
1418 in memory are not considered for glob expansion.
1421 <para>For unit file commands, the specified
<replaceable>UNIT
</replaceable> should be the name of the unit file
1422 (possibly abbreviated, see above), or the absolute path to the unit file:
1423 <programlisting># systemctl enable foo.service
</programlisting>
1425 <programlisting># systemctl link /path/to/foo.service
</programlisting>
1432 <title>Options
</title>
1434 <para>The following options are understood:
</para>
1438 <term><option>-t
</option></term>
1439 <term><option>--type=
</option></term>
1442 <para>The argument should be a comma-separated list of unit
1443 types such as
<option>service
</option> and
1444 <option>socket
</option>.
1447 <para>If one of the arguments is a unit type, when listing
1448 units, limit display to certain unit types. Otherwise, units
1449 of all types will be shown.
</para>
1451 <para>As a special case, if one of the arguments is
1452 <option>help
</option>, a list of allowed values will be
1453 printed and the program will exit.
</para>
1458 <term><option>--state=
</option></term>
1461 <para>The argument should be a comma-separated list of unit
1462 LOAD, SUB, or ACTIVE states. When listing units, show only
1463 those in the specified states. Use
<option>--state=failed
</option>
1464 to show only failed units.
</para>
1466 <para>As a special case, if one of the arguments is
1467 <option>help
</option>, a list of allowed values will be
1468 printed and the program will exit.
</para>
1473 <term><option>-p
</option></term>
1474 <term><option>--property=
</option></term>
1477 <para>When showing unit/job/manager properties with the
1478 <command>show
</command> command, limit display to properties
1479 specified in the argument. The argument should be a
1480 comma-separated list of property names, such as
1481 <literal>MainPID
</literal>. Unless specified, all known
1482 properties are shown. If specified more than once, all
1483 properties with the specified names are shown. Shell
1484 completion is implemented for property names.
</para>
1486 <para>For the manager itself,
1487 <command>systemctl show
</command> will show all available
1488 properties. Those properties are documented in
1489 <citerefentry><refentrytitle>systemd-system.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1492 <para>Properties for units vary by unit type, so showing any
1493 unit (even a non-existent one) is a way to list properties
1494 pertaining to this type. Similarly, showing any job will list
1495 properties pertaining to all jobs. Properties for units are
1497 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1498 and the pages for individual unit types
1499 <citerefentry><refentrytitle>systemd.service
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1500 <citerefentry><refentrytitle>systemd.socket
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1506 <term><option>-a
</option></term>
1507 <term><option>--all
</option></term>
1510 <para>When listing units with
<command>list-units
</command>, also show inactive units and
1511 units which are following other units. When showing unit/job/manager properties, show all
1512 properties regardless whether they are set or not.
</para>
1514 <para>To list all units installed in the file system, use the
1515 <command>list-unit-files
</command> command instead.
</para>
1517 <para>When listing units with
<command>list-dependencies
</command>, recursively show
1518 dependencies of all dependent units (by default only dependencies of target units are
1521 <para>When used with
<command>status
</command>, show journal messages in full, even if they include
1522 unprintable characters or are very long. By default, fields with unprintable characters are
1523 abbreviated as
"blob data". (Note that the pager may escape unprintable characters again.)
</para>
1528 <term><option>-r
</option></term>
1529 <term><option>--recursive
</option></term>
1532 <para>When listing units, also show units of local
1533 containers. Units of local containers will be prefixed with
1534 the container name, separated by a single colon character
1535 (
<literal>:
</literal>).
</para>
1540 <term><option>--reverse
</option></term>
1543 <para>Show reverse dependencies between units with
1544 <command>list-dependencies
</command>, i.e. follow
1545 dependencies of type
<varname>WantedBy=
</varname>,
1546 <varname>RequiredBy=
</varname>,
1547 <varname>PartOf=
</varname>,
<varname>BoundBy=
</varname>,
1548 instead of
<varname>Wants=
</varname> and similar.
1554 <term><option>--after
</option></term>
1557 <para>With
<command>list-dependencies
</command>, show the
1558 units that are ordered before the specified unit. In other
1559 words, recursively list units following the
1560 <varname>After=
</varname> dependency.
</para>
1562 <para>Note that any
<varname>After=
</varname> dependency is
1563 automatically mirrored to create a
1564 <varname>Before=
</varname> dependency. Temporal dependencies
1565 may be specified explicitly, but are also created implicitly
1566 for units which are
<varname>WantedBy=
</varname> targets
1568 <citerefentry><refentrytitle>systemd.target
</refentrytitle><manvolnum>5</manvolnum></citerefentry>),
1569 and as a result of other directives (for example
1570 <varname>RequiresMountsFor=
</varname>). Both explicitly
1571 and implicitly introduced dependencies are shown with
1572 <command>list-dependencies
</command>.
</para>
1574 <para>When passed to the
<command>list-jobs
</command> command, for each printed job show which other jobs are
1575 waiting for it. May be combined with
<option>--before
</option> to show both the jobs waiting for each job as
1576 well as all jobs each job is waiting for.
</para>
1581 <term><option>--before
</option></term>
1584 <para>With
<command>list-dependencies
</command>, show the
1585 units that are ordered after the specified unit. In other
1586 words, recursively list units following the
1587 <varname>Before=
</varname> dependency.
</para>
1589 <para>When passed to the
<command>list-jobs
</command> command, for each printed job show which other jobs it
1590 is waiting for. May be combined with
<option>--after
</option> to show both the jobs waiting for each job as
1591 well as all jobs each job is waiting for.
</para>
1596 <term><option>-l
</option></term>
1597 <term><option>--full
</option></term>
1600 <para>Do not ellipsize unit names, process tree entries,
1601 journal output, or truncate unit descriptions in the output
1602 of
<command>status
</command>,
<command>list-units
</command>,
1603 <command>list-jobs
</command>, and
1604 <command>list-timers
</command>.
</para>
1605 <para>Also, show installation targets in the output of
1606 <command>is-enabled
</command>.
</para>
1611 <term><option>--value
</option></term>
1614 <para>When printing properties with
<command>show
</command>,
1615 only print the value, and skip the property name and
1616 <literal>=
</literal>.
</para>
1621 <term><option>--show-types
</option></term>
1624 <para>When showing sockets, show the type of the socket.
</para>
1629 <term><option>--job-mode=
</option></term>
1632 <para>When queuing a new job, this option controls how to deal with
1633 already queued jobs. It takes one of
<literal>fail
</literal>,
1634 <literal>replace
</literal>,
1635 <literal>replace-irreversibly
</literal>,
1636 <literal>isolate
</literal>,
1637 <literal>ignore-dependencies
</literal>,
1638 <literal>ignore-requirements
</literal>,
1639 <literal>flush
</literal>, or
1640 <literal>triggering
</literal>. Defaults to
1641 <literal>replace
</literal>, except when the
1642 <command>isolate
</command> command is used which implies the
1643 <literal>isolate
</literal> job mode.
</para>
1645 <para>If
<literal>fail
</literal> is specified and a requested
1646 operation conflicts with a pending job (more specifically:
1647 causes an already pending start job to be reversed into a stop
1648 job or vice versa), cause the operation to fail.
</para>
1650 <para>If
<literal>replace
</literal> (the default) is
1651 specified, any conflicting pending job will be replaced, as
1654 <para>If
<literal>replace-irreversibly
</literal> is specified,
1655 operate like
<literal>replace
</literal>, but also mark the new
1656 jobs as irreversible. This prevents future conflicting
1657 transactions from replacing these jobs (or even being enqueued
1658 while the irreversible jobs are still pending). Irreversible
1659 jobs can still be cancelled using the
<command>cancel
</command>
1660 command. This job mode should be used on any transaction which
1661 pulls in
<filename>shutdown.target
</filename>.
</para>
1663 <para><literal>isolate
</literal> is only valid for start
1664 operations and causes all other units to be stopped when the
1665 specified unit is started. This mode is always used when the
1666 <command>isolate
</command> command is used.
</para>
1668 <para><literal>flush
</literal> will cause all queued jobs to
1669 be canceled when the new job is enqueued.
</para>
1671 <para>If
<literal>ignore-dependencies
</literal> is specified,
1672 then all unit dependencies are ignored for this new job and
1673 the operation is executed immediately. If passed, no required
1674 units of the unit passed will be pulled in, and no ordering
1675 dependencies will be honored. This is mostly a debugging and
1676 rescue tool for the administrator and should not be used by
1677 applications.
</para>
1679 <para><literal>ignore-requirements
</literal> is similar to
1680 <literal>ignore-dependencies
</literal>, but only causes the
1681 requirement dependencies to be ignored, the ordering
1682 dependencies will still be honored.
</para>
1685 <para><literal>triggering
</literal> may only be used with
1686 <command>systemctl stop
</command>. In this mode, the specified
1687 unit and any active units that trigger it are stopped. See the
1689 <varname>Triggers=
</varname> in
<citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1690 for more information about triggering units.
</para>
1695 <term><option>-T
</option></term>
1696 <term><option>--show-transaction
</option></term>
1699 <para>When enqueuing a unit job (for example as effect of a
<command>systemctl start
</command>
1700 invocation or similar), show brief information about all jobs enqueued, covering both the requested
1701 job and any added because of unit dependencies. Note that the output will only include jobs
1702 immediately part of the transaction requested. It is possible that service start-up program code
1703 run as effect of the enqueued jobs might request further jobs to be pulled in. This means that
1704 completion of the listed jobs might ultimately entail more jobs than the listed ones.
</para>
1709 <term><option>--fail
</option></term>
1712 <para>Shorthand for
<option>--job-mode=
</option>fail.
</para>
1713 <para>When used with the
<command>kill
</command> command,
1714 if no units were killed, the operation results in an error.
1720 <term><option>-i
</option></term>
1721 <term><option>--ignore-inhibitors
</option></term>
1724 <para>When system shutdown or a sleep state is requested, ignore inhibitor locks. Applications can establish
1725 inhibitor locks to avoid that certain important operations (such as CD burning or suchlike) are interrupted
1726 by system shutdown or a sleep state. Any user may take these locks and privileged users may override these
1727 locks. If any locks are taken, shutdown and sleep state requests will normally fail (unless privileged) and a
1728 list of active locks is printed. However, if
<option>--ignore-inhibitors
</option> is specified, the
1729 established locks are ignored and not shown, and the operation attempted anyway, possibly requiring
1730 additional privileges.
</para>
1735 <term><option>--dry-run
</option></term>
1738 <para>Just print what would be done. Currently supported by verbs
1739 <command>halt
</command>,
<command>poweroff
</command>,
<command>reboot
</command>,
1740 <command>kexec
</command>,
<command>suspend
</command>,
<command>hibernate
</command>,
1741 <command>hybrid-sleep
</command>,
<command>suspend-then-hibernate
</command>,
1742 <command>default
</command>,
<command>rescue
</command>,
1743 <command>emergency
</command>, and
<command>exit
</command>.
</para>
1748 <term><option>-q
</option></term>
1749 <term><option>--quiet
</option></term>
1752 <para>Suppress printing of the results of various commands
1753 and also the hints about truncated log lines. This does not
1754 suppress output of commands for which the printed output is
1755 the only result (like
<command>show
</command>). Errors are
1756 always printed.
</para>
1761 <term><option>--no-block
</option></term>
1764 <para>Do not synchronously wait for the requested operation
1765 to finish. If this is not specified, the job will be
1766 verified, enqueued and
<command>systemctl
</command> will
1767 wait until the unit's start-up is completed. By passing this
1768 argument, it is only verified and enqueued. This option may not be
1769 combined with
<option>--wait
</option>.
</para>
1774 <term><option>--wait
</option></term>
1777 <para>Synchronously wait for started units to terminate again.
1778 This option may not be combined with
<option>--no-block
</option>.
1779 Note that this will wait forever if any given unit never terminates
1780 (by itself or by getting stopped explicitly); particularly services
1781 which use
<literal>RemainAfterExit=yes
</literal>.
</para>
1783 <para>When used with
<command>is-system-running
</command>, wait
1784 until the boot process is completed before returning.
</para>
1788 <xi:include href=
"user-system-options.xml" xpointer=
"user" />
1789 <xi:include href=
"user-system-options.xml" xpointer=
"system" />
1792 <term><option>--failed
</option></term>
1795 <para>List units in failed state. This is equivalent to
1796 <option>--state=failed
</option>.
</para>
1801 <term><option>--no-wall
</option></term>
1804 <para>Do not send wall message before halt, power-off and reboot.
</para>
1809 <term><option>--global
</option></term>
1812 <para>When used with
<command>enable
</command> and
1813 <command>disable
</command>, operate on the global user
1814 configuration directory, thus enabling or disabling a unit
1815 file globally for all future logins of all users.
</para>
1820 <term><option>--no-reload
</option></term>
1823 <para>When used with
<command>enable
</command> and
1824 <command>disable
</command>, do not implicitly reload daemon
1825 configuration after executing the changes.
</para>
1830 <term><option>--no-ask-password
</option></term>
1833 <para>When used with
<command>start
</command> and related
1834 commands, disables asking for passwords. Background services
1835 may require input of a password or passphrase string, for
1836 example to unlock system hard disks or cryptographic
1837 certificates. Unless this option is specified and the
1838 command is invoked from a terminal,
1839 <command>systemctl
</command> will query the user on the
1840 terminal for the necessary secrets. Use this option to
1841 switch this behavior off. In this case, the password must be
1842 supplied by some other means (for example graphical password
1843 agents) or the service might fail. This also disables
1844 querying the user for authentication for privileged
1850 <term><option>--kill-who=
</option></term>
1853 <para>When used with
<command>kill
</command>, choose which
1854 processes to send a signal to. Must be one of
1855 <option>main
</option>,
<option>control
</option> or
1856 <option>all
</option> to select whether to kill only the main
1857 process, the control process or all processes of the
1858 unit. The main process of the unit is the one that defines
1859 the life-time of it. A control process of a unit is one that
1860 is invoked by the manager to induce state changes of it. For
1861 example, all processes started due to the
1862 <varname>ExecStartPre=
</varname>,
1863 <varname>ExecStop=
</varname> or
1864 <varname>ExecReload=
</varname> settings of service units are
1865 control processes. Note that there is only one control
1866 process per unit at a time, as only one state change is
1867 executed at a time. For services of type
1868 <varname>Type=forking
</varname>, the initial process started
1869 by the manager for
<varname>ExecStart=
</varname> is a
1870 control process, while the process ultimately forked off by
1871 that one is then considered the main process of the unit (if
1872 it can be determined). This is different for service units
1873 of other types, where the process forked off by the manager
1874 for
<varname>ExecStart=
</varname> is always the main process
1875 itself. A service unit consists of zero or one main process,
1876 zero or one control process plus any number of additional
1877 processes. Not all unit types manage processes of these
1878 types however. For example, for mount units, control processes
1879 are defined (which are the invocations of
1880 <filename>&MOUNT_PATH;</filename> and
1881 <filename>&UMOUNT_PATH;</filename>), but no main process
1882 is defined. If omitted, defaults to
1883 <option>all
</option>.
</para>
1889 <term><option>-s
</option></term>
1890 <term><option>--signal=
</option></term>
1893 <para>When used with
<command>kill
</command>, choose which
1894 signal to send to selected processes. Must be one of the
1895 well-known signal specifiers such as
<constant>SIGTERM
</constant>,
<constant>SIGINT
</constant> or
1896 <constant>SIGSTOP
</constant>. If omitted, defaults to
1897 <option>SIGTERM
</option>.
</para>
1902 <term><option>--what=
</option></term>
1905 <para>Select what type of per-unit resources to remove when the
<command>clean
</command> command is
1906 invoked, see below. Takes one of
<constant>configuration
</constant>,
<constant>state
</constant>,
1907 <constant>cache
</constant>,
<constant>logs
</constant>,
<constant>runtime
</constant> to select the
1908 type of resource. This option may be specified more than once, in which case all specified resource
1909 types are removed. Also accepts the special value
<constant>all
</constant> as a shortcut for
1910 specifiying all five resource types. If this option is not specified defaults to the combination of
1911 <constant>cache
</constant> and
<constant>runtime
</constant>, i.e. the two kinds of resources that
1912 are generally considered to be redundant and can be reconstructed on next invocation.
</para>
1917 <term><option>-f
</option></term>
1918 <term><option>--force
</option></term>
1921 <para>When used with
<command>enable
</command>, overwrite
1922 any existing conflicting symlinks.
</para>
1924 <para>When used with
<command>edit
</command>, create all of the
1925 specified units which do not already exist.
</para>
1927 <para>When used with
<command>halt
</command>,
<command>poweroff
</command>,
<command>reboot
</command> or
1928 <command>kexec
</command>, execute the selected operation without shutting down all units. However, all
1929 processes will be killed forcibly and all file systems are unmounted or remounted read-only. This is hence a
1930 drastic but relatively safe option to request an immediate reboot. If
<option>--force
</option> is specified
1931 twice for these operations (with the exception of
<command>kexec
</command>), they will be executed
1932 immediately, without terminating any processes or unmounting any file systems. Warning: specifying
1933 <option>--force
</option> twice with any of these operations might result in data loss. Note that when
1934 <option>--force
</option> is specified twice the selected operation is executed by
1935 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
1936 succeed even when the system manager has crashed.
</para>
1941 <term><option>--message=
</option></term>
1944 <para>When used with
<command>halt
</command>,
<command>poweroff
</command> or
<command>reboot
</command>, set a
1945 short message explaining the reason for the operation. The message will be logged together with the default
1946 shutdown message.
</para>
1951 <term><option>--now
</option></term>
1954 <para>When used with
<command>enable
</command>, the units
1955 will also be started. When used with
<command>disable
</command> or
1956 <command>mask
</command>, the units will also be stopped. The start
1957 or stop operation is only carried out when the respective enable or
1958 disable operation has been successful.
</para>
1963 <term><option>--root=
</option></term>
1966 <para>When used with
1967 <command>enable
</command>/
<command>disable
</command>/
<command>is-enabled
</command>
1968 (and related commands), use the specified root path when looking for unit
1969 files. If this option is present,
<command>systemctl
</command> will operate on
1970 the file system directly, instead of communicating with the
<command>systemd
</command>
1971 daemon to carry out changes.
</para>
1977 <term><option>--runtime
</option></term>
1980 <para>When used with
<command>enable
</command>,
1981 <command>disable
</command>,
<command>edit
</command>,
1982 (and related commands), make changes only temporarily, so
1983 that they are lost on the next reboot. This will have the
1984 effect that changes are not made in subdirectories of
1985 <filename>/etc
</filename> but in
<filename>/run
</filename>,
1986 with identical immediate effects, however, since the latter
1987 is lost on reboot, the changes are lost too.
</para>
1989 <para>Similarly, when used with
1990 <command>set-property
</command>, make changes only
1991 temporarily, so that they are lost on the next
1997 <term><option>--preset-mode=
</option></term>
2000 <para>Takes one of
<literal>full
</literal> (the default),
2001 <literal>enable-only
</literal>,
2002 <literal>disable-only
</literal>. When used with the
2003 <command>preset
</command> or
<command>preset-all
</command>
2004 commands, controls whether units shall be disabled and
2005 enabled according to the preset rules, or only enabled, or
2006 only disabled.
</para>
2011 <term><option>-n
</option></term>
2012 <term><option>--lines=
</option></term>
2015 <para>When used with
<command>status
</command>, controls the number of journal lines to show, counting from
2016 the most recent ones. Takes a positive integer argument, or
0 to disable journal output. Defaults to
2022 <term><option>-o
</option></term>
2023 <term><option>--output=
</option></term>
2026 <para>When used with
<command>status
</command>, controls the
2027 formatting of the journal entries that are shown. For the
2028 available choices, see
2029 <citerefentry><refentrytitle>journalctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
2030 Defaults to
<literal>short
</literal>.
</para>
2035 <term><option>--firmware-setup
</option></term>
2038 <para>When used with the
<command>reboot
</command> command, indicate to the system's firmware to reboot into
2039 the firmware setup interface. Note that this functionality is not available on all systems.
</para>
2044 <term><option>--boot-loader-menu=
</option></term>
2047 <para>When used with the
<command>reboot
</command> command, indicate to the system's boot loader to show the
2048 boot loader menu on the following boot. Takes a time value as parameter — indicating the menu time-out. Pass
2049 zero in order to disable the menu time-out. Note that not all boot loaders support this
2050 functionality.
</para>
2055 <term><option>--boot-loader-entry=
</option></term>
2058 <para>When used with the
<command>reboot
</command> command, indicate to the system's boot loader to boot into
2059 a specific boot loader entry on the following boot. Takes a boot loader entry identifier as argument, or
2060 <literal>help
</literal> in order to list available entries. Note that not all boot loaders support this
2061 functionality.
</para>
2066 <term><option>--plain
</option></term>
2069 <para>When used with
<command>list-dependencies
</command>,
2070 <command>list-units
</command> or
<command>list-machines
</command>,
2071 the output is printed as a list instead of a tree, and the bullet
2072 circles are omitted.
</para>
2076 <xi:include href=
"user-system-options.xml" xpointer=
"host" />
2077 <xi:include href=
"user-system-options.xml" xpointer=
"machine" />
2079 <xi:include href=
"standard-options.xml" xpointer=
"no-pager" />
2080 <xi:include href=
"standard-options.xml" xpointer=
"no-legend" />
2081 <xi:include href=
"standard-options.xml" xpointer=
"help" />
2082 <xi:include href=
"standard-options.xml" xpointer=
"version" />
2087 <title>Exit status
</title>
2089 <para>On success,
0 is returned, a non-zero failure code otherwise.
</para>
2091 <para><command>systemctl
</command> uses the return codes defined by LSB, as defined in
2092 <ulink url=
"http://refspecs.linuxbase.org/LSB_3.0.0/LSB-PDA/LSB-PDA/iniscrptact.html">LSB
3.0.0</ulink>.
2096 <title>LSB return codes
</title>
2101 <entry>Value
</entry>
2102 <entry>Description in LSB
</entry>
2103 <entry>Use in systemd
</entry>
2108 <entry><constant>0</constant></entry>
2109 <entry>"program is running or service is OK"</entry>
2110 <entry>unit is active
</entry>
2113 <entry><constant>1</constant></entry>
2114 <entry>"program is dead and <filename>/var/run</filename> pid file exists"</entry>
2115 <entry>unit
<emphasis>not
</emphasis> failed (used by
<command>is-failed
</command>)
</entry>
2118 <entry><constant>2</constant></entry>
2119 <entry>"program is dead and <filename>/var/lock</filename> lock file exists"</entry>
2120 <entry>unused
</entry>
2123 <entry><constant>3</constant></entry>
2124 <entry>"program is not running"</entry>
2125 <entry>unit is not active
</entry>
2128 <entry><constant>4</constant></entry>
2129 <entry>"program or service status is unknown"</entry>
2130 <entry>no such unit
</entry>
2136 <para>The mapping of LSB service states to systemd unit states is imperfect, so it is better to
2137 not rely on those return values but to look for specific unit states and substates instead.
2142 <title>Environment
</title>
2144 <variablelist class='environment-variables'
>
2146 <term><varname>$SYSTEMD_EDITOR
</varname></term>
2148 <listitem><para>Editor to use when editing units; overrides
2149 <varname>$EDITOR
</varname> and
<varname>$VISUAL
</varname>. If neither
2150 <varname>$SYSTEMD_EDITOR
</varname> nor
<varname>$EDITOR
</varname> nor
2151 <varname>$VISUAL
</varname> are present or if it is set to an empty
2152 string or if their execution failed, systemctl will try to execute well
2153 known editors in this order:
2154 <citerefentry project='die-net'
><refentrytitle>editor
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2155 <citerefentry project='die-net'
><refentrytitle>nano
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2156 <citerefentry project='die-net'
><refentrytitle>vim
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2157 <citerefentry project='die-net'
><refentrytitle>vi
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
2161 <xi:include href=
"less-variables.xml" xpointer=
"pager"/>
2162 <xi:include href=
"less-variables.xml" xpointer=
"less"/>
2163 <xi:include href=
"less-variables.xml" xpointer=
"lesscharset"/>
2167 <title>See Also
</title>
2169 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2170 <citerefentry><refentrytitle>journalctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2171 <citerefentry><refentrytitle>loginctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2172 <citerefentry><refentrytitle>machinectl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2173 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2174 <citerefentry><refentrytitle>systemd.resource-control
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2175 <citerefentry><refentrytitle>systemd.special
</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
2176 <citerefentry project='man-pages'
><refentrytitle>wall
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2177 <citerefentry><refentrytitle>systemd.preset
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2178 <citerefentry><refentrytitle>systemd.generator
</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
2179 <citerefentry project='man-pages'
><refentrytitle>glob
</refentrytitle><manvolnum>7</manvolnum></citerefentry>