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 (Introspection and Modification)
</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>is-active
<replaceable>PATTERN
</replaceable>…
</command></term>
158 <para>Check whether any of the specified units are active
159 (i.e. running). Returns an exit code
160 <constant>0</constant> if at least one is active, or
161 non-zero otherwise. Unless
<option>--quiet
</option> is
162 specified, this will also print the current unit state to
163 standard output.
</para>
168 <term><command>is-failed
<replaceable>PATTERN
</replaceable>…
</command></term>
171 <para>Check whether any of the specified units are in a
172 "failed" state. Returns an exit code
173 <constant>0</constant> if at least one has failed,
174 non-zero otherwise. Unless
<option>--quiet
</option> is
175 specified, this will also print the current unit state to
176 standard output.
</para>
181 <term><command>status
</command> <optional><replaceable>PATTERN
</replaceable>…|
<replaceable>PID
</replaceable>…]
</optional></term>
184 <para>Show terse runtime status information about one or
185 more units, followed by most recent log data from the
186 journal. If no units are specified, show system status. If
187 combined with
<option>--all
</option>, also show the status of
188 all units (subject to limitations specified with
189 <option>-t
</option>). If a PID is passed, show information
190 about the unit the process belongs to.
</para>
192 <para>This function is intended to generate human-readable
193 output. If you are looking for computer-parsable output,
194 use
<command>show
</command> instead. By default, this
195 function only shows
10 lines of output and ellipsizes
196 lines to fit in the terminal window. This can be changed
197 with
<option>--lines
</option> and
<option>--full
</option>,
198 see above. In addition,
<command>journalctl
199 --unit=
<replaceable>NAME
</replaceable></command> or
201 --user-unit=
<replaceable>NAME
</replaceable></command> use
202 a similar filter for messages and might be more
206 <para>systemd implicitly loads units as necessary, so just running the
<command>status
</command> will
207 attempt to load a file. The command is thus not useful for determining if something was already loaded or
208 not. The units may possibly also be quickly unloaded after the operation is completed if there's no reason
209 to keep it in memory thereafter.
213 <title>Example output from systemctl status
</title>
215 <programlisting>$ systemctl status bluetooth
216 ● bluetooth.service - Bluetooth service
217 Loaded: loaded (/usr/lib/systemd/system/bluetooth.service; enabled; vendor preset: enabled)
218 Active: active (running) since Wed
2017-
01-
04 13:
54:
04 EST;
1 weeks
0 days ago
219 Docs: man:bluetoothd(
8)
220 Main PID:
930 (bluetoothd)
225 CGroup: /system.slice/bluetooth.service
226 └─
930 /usr/lib/bluetooth/bluetoothd
228 Jan
12 10:
46:
45 example.com bluetoothd[
8900]: Not enough free handles to register service
229 Jan
12 10:
46:
45 example.com bluetoothd[
8900]: Current Time Service could not be registered
230 Jan
12 10:
46:
45 example.com bluetoothd[
8900]: gatt-time-server: Input/output error (
5)
233 <para>The dot (
"●") uses color on supported terminals to summarize the unit state at a glance. White
234 indicates an
<literal>inactive
</literal> or
<literal>deactivating
</literal> state. Red indicates a
235 <literal>failed
</literal> or
<literal>error
</literal> state and green indicates an
236 <literal>active
</literal>,
<literal>reloading
</literal> or
<literal>activating
</literal> state.
239 <para>The
"Loaded:" line in the output will show
<literal>loaded
</literal> if the unit has been loaded into
240 memory. Other possible values for
"Loaded:" include:
<literal>error
</literal> if there was a problem
241 loading it,
<literal>not-found
</literal> if no unit file was found for this unit,
242 <literal>bad-setting
</literal> if an essential unit file setting could not be parsed and
243 <literal>masked
</literal> if the unit file has been masked. Along with showing the path to the unit file,
244 this line will also show the enablement state. Enabled commands start at boot. See the full table of
245 possible enablement states — including the definition of
<literal>masked
</literal> — in the documentation
246 for the
<command>is-enabled
</command> command.
249 <para>The
"Active:" line shows active state. The value is usually
<literal>active
</literal> or
250 <literal>inactive
</literal>. Active could mean started, bound, plugged in, etc depending on the unit type.
251 The unit could also be in process of changing states, reporting a state of
<literal>activating
</literal> or
252 <literal>deactivating
</literal>. A special
<literal>failed
</literal> state is entered when the service
253 failed in some way, such as a crash, exiting with an error code or timing out. If the failed state is
254 entered the cause will be logged for later reference.
</para>
261 <term><command>show
</command> <optional><replaceable>PATTERN
</replaceable>…|
<replaceable>JOB
</replaceable>…
</optional></term>
264 <para>Show properties of one or more units, jobs, or the manager itself. If no argument is specified,
265 properties of the manager will be shown. If a unit name is specified, properties of the unit are shown, and
266 if a job ID is specified, properties of the job are shown. By default, empty properties are suppressed. Use
267 <option>--all
</option> to show those too. To select specific properties to show, use
268 <option>--property=
</option>. This command is intended to be used whenever computer-parsable output is
269 required. Use
<command>status
</command> if you are looking for formatted human-readable output.
</para>
271 <para>Many properties shown by
<command>systemctl show
</command> map directly to configuration settings of
272 the system and service manager and its unit files. Note that the properties shown by the command are
273 generally more low-level, normalized versions of the original configuration settings and expose runtime
274 state in addition to configuration. For example, properties shown for service units include the service's
275 current main process identifier as
<literal>MainPID
</literal> (which is runtime state), and time settings
276 are always exposed as properties ending in the
<literal>…USec
</literal> suffix even if a matching
277 configuration options end in
<literal>…Sec
</literal>, because microseconds is the normalized time unit used
278 internally by the system and service manager.
</para>
280 <para>For details about many of these properties, see the documentation of the D-Bus interface
281 backing these properties, see
282 <citerefentry><refentrytitle>org.freedesktop.systemd1
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
287 <term><command>cat
<replaceable>PATTERN
</replaceable>…
</command></term>
290 <para>Show backing files of one or more units. Prints the
291 "fragment" and
"drop-ins" (source files) of units. Each
292 file is preceded by a comment which includes the file
293 name. Note that this shows the contents of the backing files
294 on disk, which may not match the system manager's
295 understanding of these units if any unit files were
296 updated on disk and the
<command>daemon-reload
</command>
297 command wasn't issued since.
</para>
302 <term><command>help
<replaceable>PATTERN
</replaceable>…|
<replaceable>PID
</replaceable>…
</command></term>
305 <para>Show manual pages for one or more units, if
306 available. If a PID is given, the manual pages for the unit
307 the process belongs to are shown.
</para>
313 <command>list-dependencies
</command>
314 <optional><replaceable>UNIT
</replaceable>...
</optional>
318 <para>Shows units required and wanted by the specified
319 units. This recursively lists units following the
320 <varname>Requires=
</varname>,
321 <varname>Requisite=
</varname>,
322 <varname>ConsistsOf=
</varname>,
323 <varname>Wants=
</varname>,
<varname>BindsTo=
</varname>
324 dependencies. If no units are specified,
325 <filename>default.target
</filename> is implied.
</para>
327 <para>By default, only target units are recursively
328 expanded. When
<option>--all
</option> is passed, all other
329 units are recursively expanded as well.
</para>
331 <para>Options
<option>--reverse
</option>,
332 <option>--after
</option>,
<option>--before
</option>
333 may be used to change what types of dependencies
336 <para>Note that this command only lists units currently loaded into memory by the service manager. In
337 particular, this command is not suitable to get a comprehensive list at all reverse dependencies on a
338 specific unit, as it won't list the dependencies declared by units currently not loaded.
</para>
342 <!-- Commands that modify unit state start here -->
345 <term><command>start
<replaceable>PATTERN
</replaceable>…
</command></term>
348 <para>Start (activate) one or more units specified on the command line.
</para>
350 <para>Note that unit glob patterns expand to names of units currently in memory. Units which are
351 not active and are not in a failed state usually are not in memory, and will not be matched by
352 any pattern. In addition, in case of instantiated units, systemd is often unaware of the instance
353 name until the instance has been started. Therefore, using glob patterns with
354 <command>start
</command> has limited usefulness. Also, secondary alias names of units are not
357 <para>Option
<option>--all
</option> may be used to also operate on inactive units which are
358 referenced by other loaded units. Note that this is not the same as operating on
"all" possible
359 units, because as the previous paragraph describes, such a list is ill-defined. Nevertheless,
360 <command>systemctl start --all
<replaceable>GLOB
</replaceable></command> may be useful if all the
361 units that should match the pattern are pulled in by some target which is known to be loaded.
366 <term><command>stop
<replaceable>PATTERN
</replaceable>…
</command></term>
369 <para>Stop (deactivate) one or more units specified on the command line.
</para>
371 <para>This command will fail if the unit does not exist or if stopping of the unit is prohibited (see
372 <varname>RefuseManualStop=
</varname> in
373 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
374 It will
<emphasis>not
</emphasis> fail if any of the commands configured to stop the unit
375 (
<varname>ExecStop=
</varname>, etc.) fail, because the manager will still forcibly terminate the
380 <term><command>reload
<replaceable>PATTERN
</replaceable>…
</command></term>
383 <para>Asks all units listed on the command line to reload
384 their configuration. Note that this will reload the
385 service-specific configuration, not the unit configuration
386 file of systemd. If you want systemd to reload the
387 configuration file of a unit, use the
388 <command>daemon-reload
</command> command. In other words:
389 for the example case of Apache, this will reload Apache's
390 <filename>httpd.conf
</filename> in the web server, not the
391 <filename>apache.service
</filename> systemd unit
394 <para>This command should not be confused with the
395 <command>daemon-reload
</command> command.
</para>
400 <term><command>restart
<replaceable>PATTERN
</replaceable>…
</command></term>
403 <para>Stop and then start one or more units specified on the command line. If the units are not running
404 yet, they will be started.
</para>
406 <para>Note that restarting a unit with this command does not necessarily flush out all of the unit's
407 resources before it is started again. For example, the per-service file descriptor storage facility (see
408 <varname>FileDescriptorStoreMax=
</varname> in
409 <citerefentry><refentrytitle>systemd.service
</refentrytitle><manvolnum>5</manvolnum></citerefentry>) will
410 remain intact as long as the unit has a job pending, and is only cleared when the unit is fully stopped and
411 no jobs are pending anymore. If it is intended that the file descriptor store is flushed out, too, during a
412 restart operation an explicit
<command>systemctl stop
</command> command followed by
<command>systemctl
413 start
</command> should be issued.
</para>
417 <term><command>try-restart
<replaceable>PATTERN
</replaceable>…
</command></term>
420 <para>Stop and then start one or more units specified on the
421 command line if the units are running. This does nothing
422 if units are not running.
</para>
423 <!-- Note that we don't document condrestart here, as that is just compatibility support, and we generally
424 don't document that. -->
428 <term><command>reload-or-restart
<replaceable>PATTERN
</replaceable>…
</command></term>
431 <para>Reload one or more units if they support it. If not, stop and then start them instead. If the units
432 are not running yet, they will be started.
</para>
436 <term><command>try-reload-or-restart
<replaceable>PATTERN
</replaceable>…
</command></term>
439 <para>Reload one or more units if they support it. If not, stop and then start them instead. This does
440 nothing if the units are not running.
</para>
441 <!-- Note that we don't document force-reload here, as that is just compatibility support, and we generally
442 don't document that. -->
446 <term><command>isolate
<replaceable>UNIT
</replaceable></command></term>
449 <para>Start the unit specified on the command line and its dependencies
450 and stop all others, unless they have
451 <option>IgnoreOnIsolate=yes
</option> (see
452 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
453 If a unit name with no extension is given, an extension of
454 <literal>.target
</literal> will be assumed.
</para>
456 <para>This command is dangerous, since it will immediately stop processes that are not enabled in
457 the new target, possibly including the graphical environment or terminal you are currently using.
460 <para>Note that this is allowed only on units where
461 <option>AllowIsolate=
</option> is enabled. See
462 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
467 <term><command>kill
<replaceable>PATTERN
</replaceable>…
</command></term>
470 <para>Send a signal to one or more processes of the
471 unit. Use
<option>--kill-who=
</option> to select which
472 process to kill. Use
<option>--signal=
</option> to select
473 the signal to send.
</para>
477 <term><command>clean
<replaceable>PATTERN
</replaceable>…
</command></term>
480 <para>Remove the configuration, state, cache, logs or runtime data of the specified units. Use
481 <option>--what=
</option> to select which kind of resource to remove. For service units this may
482 be used to remove the directories configured with
<varname>ConfigurationDirectory=
</varname>,
483 <varname>StateDirectory=
</varname>,
<varname>CacheDirectory=
</varname>,
484 <varname>LogsDirectory=
</varname> and
<varname>RuntimeDirectory=
</varname>, see
485 <citerefentry><refentrytitle>systemd.exec
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
486 for details. For timer units this may be used to clear out the persistent timestamp data if
487 <varname>Persistent=
</varname> is used and
<option>--what=state
</option> is selected, see
488 <citerefentry><refentrytitle>systemd.timer
</refentrytitle><manvolnum>5</manvolnum></citerefentry>. This
489 command only applies to units that use either of these settings. If
<option>--what=
</option> is
490 not specified, both the cache and runtime data are removed (as these two types of data are
491 generally redundant and reproducible on the next invocation of the unit).
</para>
495 <term><command>freeze
<replaceable>PATTERN
</replaceable>…
</command></term>
498 <para>Freeze one or more units specified on the
499 command line using cgroup freezer
</para>
501 <para>Freezing the unit will cause all processes contained within the cgroup corresponding to the unit
502 to be suspended. Being suspended means that unit's processes won't be scheduled to run on CPU until thawed.
503 Note that this command is supported only on systems that use unified cgroup hierarchy. Unit is automatically
504 thawed just before we execute a job against the unit, e.g. before the unit is stopped.
</para>
508 <term><command>thaw
<replaceable>PATTERN
</replaceable>…
</command></term>
511 <para>Thaw (unfreeze) one or more units specified on the
514 <para>This is the inverse operation to the
<command>freeze
</command> command and resumes the execution of
515 processes in the unit's cgroup.
</para>
519 <term><command>set-property
<replaceable>UNIT
</replaceable> <replaceable>PROPERTY
</replaceable>=
<replaceable>VALUE
</replaceable>…
</command></term>
522 <para>Set the specified unit properties at runtime where
523 this is supported. This allows changing configuration
524 parameter properties such as resource control settings at
525 runtime. Not all properties may be changed at runtime, but
526 many resource control settings (primarily those in
527 <citerefentry><refentrytitle>systemd.resource-control
</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
528 may. The changes are applied immediately, and stored on disk
529 for future boots, unless
<option>--runtime
</option> is
530 passed, in which case the settings only apply until the
531 next reboot. The syntax of the property assignment follows
532 closely the syntax of assignments in unit files.
</para>
534 <para>Example:
<command>systemctl set-property foobar.service CPUWeight=
200</command></para>
536 <para>If the specified unit appears to be inactive, the
537 changes will be only stored on disk as described
538 previously hence they will be effective when the unit will
541 <para>Note that this command allows changing multiple properties at the same time, which is
542 preferable over setting them individually.
</para>
544 <para>Example:
<command>systemctl set-property foobar.service CPUWeight=
200 MemoryMax=
2G IPAccounting=yes
</command></para>
546 <para>Like with unit file configuration settings, assigning an empty setting usually resets a
547 property to its defaults.
</para>
549 <para>Example:
<command>systemctl set-property avahi-daemon.service IPAddressDeny=
</command></para>
554 <term><command>service-log-level
</command> <replaceable>SERVICE
</replaceable> [
<replaceable>LEVEL
</replaceable>]
</term>
556 <listitem><para>If the
<replaceable>LEVEL
</replaceable> argument is not given, print the current
557 log level as reported by service
<replaceable>SERVICE
</replaceable>.
</para>
559 <para>If the optional argument
<replaceable>LEVEL
</replaceable> is provided, then change the
560 current log level of the service to
<replaceable>LEVEL
</replaceable>. The log level should be a
561 typical syslog log level, i.e. a value in the range
0…
7 or one of the strings
562 <constant>emerg
</constant>,
<constant>alert
</constant>,
<constant>crit
</constant>,
563 <constant>err
</constant>,
<constant>warning
</constant>,
<constant>notice
</constant>,
564 <constant>info
</constant>,
<constant>debug
</constant>; see
<citerefentry
565 project='man-pages'
><refentrytitle>syslog
</refentrytitle><manvolnum>3</manvolnum></citerefentry>
568 <para>The service must have the appropriate
569 <varname>BusName=
<replaceable>destination
</replaceable></varname> property and also implement the
571 <citerefentry><refentrytitle>org.freedesktop.LogControl1
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
572 interface. (
<filename>systemctl
</filename> will use the generic D-Bus protocol to access the
573 <interfacename>org.freedesktop.LogControl1.LogLevel
</interfacename> interface for the D-Bus name
574 <replaceable>destination
</replaceable>.)
</para></listitem>
578 <term><command>service-log-target
</command> <replaceable>SERVICE
</replaceable> [
<replaceable>TARGET
</replaceable>]
</term>
580 <listitem><para>If the
<replaceable>TARGET
</replaceable> argument is not given, print the current
581 log target as reported by service
<replaceable>SERVICE
</replaceable>.
</para>
583 <para>If the optional argument
<replaceable>TARGET
</replaceable> is provided, then change the
584 current log target of the service to
<replaceable>TARGET
</replaceable>. The log target should be
585 one of the strings
<constant>console
</constant> (for log output to the service's standard error
586 stream),
<constant>kmsg
</constant> (for log output to the kernel log buffer),
587 <constant>journal
</constant> (for log output to
588 <citerefentry><refentrytitle>systemd-journald.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>
589 using the native journal protocol),
<constant>syslog
</constant> (for log output to the classic
590 syslog socket
<filename>/dev/log
</filename>),
<constant>null
</constant> (for no log output
591 whatsoever) or
<constant>auto
</constant> (for an automatically determined choice, typically
592 equivalent to
<constant>console
</constant> if the service is invoked interactively, and
593 <constant>journal
</constant> or
<constant>syslog
</constant> otherwise).
</para>
595 <para>For most services, only a small subset of log targets make sense. In particular, most
596 "normal" services should only implement
<constant>console
</constant>,
<constant>journal
</constant>,
597 and
<constant>null
</constant>. Anything else is only appropriate for low-level services that
598 are active in very early boot before proper logging is established.
</para>
600 <para>The service must have the appropriate
601 <varname>BusName=
<replaceable>destination
</replaceable></varname> property and also implement the
603 <citerefentry><refentrytitle>org.freedesktop.LogControl1
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
604 interface. (
<filename>systemctl
</filename> will use the generic D-Bus protocol to access the
605 <interfacename>org.freedesktop.LogControl1.LogLevel
</interfacename> interface for the D-Bus name
606 <replaceable>destination
</replaceable>.)
</para></listitem>
610 <term><command>reset-failed [
<replaceable>PATTERN
</replaceable>…]
</command></term>
613 <para>Reset the
<literal>failed
</literal> state of the specified units, or if no unit name is passed, reset
614 the state of all units. When a unit fails in some way (i.e. process exiting with non-zero error code,
615 terminating abnormally or timing out), it will automatically enter the
<literal>failed
</literal> state and
616 its exit code and status is recorded for introspection by the administrator until the service is
617 stopped/re-started or reset with this command.
</para>
619 <para>In addition to resetting the
<literal>failed
</literal> state of a unit it also resets various other
620 per-unit properties: the start rate limit counter of all unit types is reset to zero, as is the restart
621 counter of service units. Thus, if a unit's start limit (as configured with
622 <varname>StartLimitIntervalSec=
</varname>/
<varname>StartLimitBurst=
</varname>) is hit and the unit refuses
623 to be started again, use this command to make it startable again.
</para>
630 <title>Unit File Commands
</title>
634 <term><command>list-unit-files
</command> <optional><replaceable>PATTERN…
</replaceable></optional></term>
637 <para>List unit files installed on the system, in combination with their enablement state (as reported by
638 <command>is-enabled
</command>). If one or more
<replaceable>PATTERN
</replaceable>s are specified, only unit
639 files whose name matches one of them are shown (patterns matching unit file system paths are not
645 <term><command>enable
<replaceable>UNIT
</replaceable>…
</command></term>
646 <term><command>enable
<replaceable>PATH
</replaceable>…
</command></term>
649 <para>Enable one or more units or unit instances. This will create a set of symlinks, as encoded in the
650 [Install] sections of the indicated unit files. After the symlinks have been created,
651 the system manager configuration is reloaded (in a way equivalent to
<command>daemon-reload
</command>), in
652 order to ensure the changes are taken into account immediately. Note that this does
653 <emphasis>not
</emphasis> have the effect of also starting any of the units being enabled. If this is
654 desired, combine this command with the
<option>--now
</option> switch, or invoke
<command>start
</command>
655 with appropriate arguments later. Note that in case of unit instance enablement (i.e. enablement of units of
656 the form
<filename>foo@bar.service
</filename>), symlinks named the same as instances are created in the
657 unit configuration directory, however they point to the single template unit file they are instantiated
660 <para>This command expects either valid unit names (in which case various unit file directories are
661 automatically searched for unit files with appropriate names), or absolute paths to unit files (in which
662 case these files are read directly). If a specified unit file is located outside of the usual unit file
663 directories, an additional symlink is created, linking it into the unit configuration path, thus ensuring
664 it is found when requested by commands such as
<command>start
</command>. The file system where the linked
665 unit files are located must be accessible when systemd is started (e.g. anything underneath
666 <filename>/home/
</filename> or
<filename>/var/
</filename> is not allowed, unless those directories are
667 located on the root file system).
</para>
669 <para>This command will print the file system operations executed. This output may be suppressed by passing
670 <option>--quiet
</option>.
673 <para>Note that this operation creates only the symlinks suggested in the [Install]
674 section of the unit files. While this command is the recommended way to manipulate the unit configuration
675 directory, the administrator is free to make additional changes manually by placing or removing symlinks
676 below this directory. This is particularly useful to create configurations that deviate from the suggested
677 default installation. In this case, the administrator must make sure to invoke
678 <command>daemon-reload
</command> manually as necessary, in order to ensure the changes are taken into
682 <para>Enabling units should not be confused with starting (activating) units, as done by the
683 <command>start
</command> command. Enabling and starting units is orthogonal: units may be enabled without
684 being started and started without being enabled. Enabling simply hooks the unit into various suggested
685 places (for example, so that the unit is automatically started on boot or when a particular kind of
686 hardware is plugged in). Starting actually spawns the daemon process (in case of service units), or binds
687 the socket (in case of socket units), and so on.
</para>
689 <para>Depending on whether
<option>--system
</option>,
<option>--user
</option>,
<option>--runtime
</option>,
690 or
<option>--global
</option> is specified, this enables the unit for the system, for the calling user only,
691 for only this boot of the system, or for all future logins of all users. Note that in the last case, no
692 systemd daemon configuration is reloaded.
</para>
694 <para>Using
<command>enable
</command> on masked units is not supported and results in an error.
</para>
699 <term><command>disable
<replaceable>UNIT
</replaceable>…
</command></term>
702 <para>Disables one or more units. This removes all symlinks to the unit files backing the specified units
703 from the unit configuration directory, and hence undoes any changes made by
<command>enable
</command> or
704 <command>link
</command>. Note that this removes
<emphasis>all
</emphasis> symlinks to matching unit files,
705 including manually created symlinks, and not just those actually created by
<command>enable
</command> or
706 <command>link
</command>. Note that while
<command>disable
</command> undoes the effect of
707 <command>enable
</command>, the two commands are otherwise not symmetric, as
<command>disable
</command> may
708 remove more symlinks than a prior
<command>enable
</command> invocation of the same unit created.
</para>
710 <para>This command expects valid unit names only, it does not accept paths to unit files.
</para>
712 <para>In addition to the units specified as arguments, all units are disabled that are listed in the
713 <varname>Also=
</varname> setting contained in the [Install] section of any of the unit
714 files being operated on.
</para>
716 <para>This command implicitly reloads the system manager configuration after completing the operation. Note
717 that this command does not implicitly stop the units that are being disabled. If this is desired, either
718 combine this command with the
<option>--now
</option> switch, or invoke the
<command>stop
</command> command
719 with appropriate arguments later.
</para>
721 <para>This command will print information about the file system operations (symlink removals)
722 executed. This output may be suppressed by passing
<option>--quiet
</option>.
725 <para>This command honors
<option>--system
</option>,
<option>--user
</option>,
<option>--runtime
</option>
726 and
<option>--global
</option> in a similar way as
<command>enable
</command>.
</para>
731 <term><command>reenable
<replaceable>UNIT
</replaceable>…
</command></term>
734 <para>Reenable one or more units, as specified on the command line. This is a combination of
735 <command>disable
</command> and
<command>enable
</command> and is useful to reset the symlinks a unit file is
736 enabled with to the defaults configured in its [Install] section. This command expects
737 a unit name only, it does not accept paths to unit files.
</para>
742 <term><command>preset
<replaceable>UNIT
</replaceable>…
</command></term>
745 <para>Reset the enable/disable status one or more unit files, as specified on
746 the command line, to the defaults configured in the preset policy files. This
747 has the same effect as
<command>disable
</command> or
748 <command>enable
</command>, depending how the unit is listed in the preset
751 <para>Use
<option>--preset-mode=
</option> to control whether units shall be
752 enabled and disabled, or only enabled, or only disabled.
</para>
754 <para>If the unit carries no install information, it will be silently ignored
755 by this command.
<replaceable>UNIT
</replaceable> must be the real unit name,
756 any alias names are ignored silently.
</para>
758 <para>For more information on the preset policy format, see
759 <citerefentry><refentrytitle>systemd.preset
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
760 For more information on the concept of presets, please consult the
761 <ulink url=
"https://www.freedesktop.org/wiki/Software/systemd/Preset">Preset
</ulink>
767 <term><command>preset-all
</command></term>
770 <para>Resets all installed unit files to the defaults
771 configured in the preset policy file (see above).
</para>
773 <para>Use
<option>--preset-mode=
</option> to control
774 whether units shall be enabled and disabled, or only
775 enabled, or only disabled.
</para>
780 <term><command>is-enabled
<replaceable>UNIT
</replaceable>…
</command></term>
783 <para>Checks whether any of the specified unit files are
784 enabled (as with
<command>enable
</command>). Returns an
785 exit code of
0 if at least one is enabled, non-zero
786 otherwise. Prints the current enable status (see table).
787 To suppress this output, use
<option>--quiet
</option>.
788 To show installation targets, use
<option>--full
</option>.
793 <command>is-enabled
</command> output
800 <entry>Description
</entry>
801 <entry>Exit Code
</entry>
806 <entry><literal>enabled
</literal></entry>
807 <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>
808 <entry morerows='
1'
>0</entry>
811 <entry><literal>enabled-runtime
</literal></entry>
814 <entry><literal>linked
</literal></entry>
815 <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>
816 <entry morerows='
1'
>> 0</entry>
819 <entry><literal>linked-runtime
</literal></entry>
822 <entry><literal>alias
</literal></entry>
823 <entry>The name is an alias (symlink to another unit file).
</entry>
827 <entry><literal>masked
</literal></entry>
828 <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>
829 <entry morerows='
1'
>> 0</entry>
832 <entry><literal>masked-runtime
</literal></entry>
835 <entry><literal>static
</literal></entry>
836 <entry>The unit file is not enabled, and has no provisions for enabling in the [Install] unit file section.
</entry>
840 <entry><literal>indirect
</literal></entry>
841 <entry>The unit file itself is not enabled, but it has a non-empty
<varname>Also=
</varname> setting in the [Install] 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 files, an instance different than the one specified in
<varname>DefaultInstance=
</varname> is enabled.
</entry>
845 <entry><literal>disabled
</literal></entry>
846 <entry>The unit file is not enabled, but contains an [Install] section with installation instructions.
</entry>
847 <entry>> 0</entry>
850 <entry><literal>generated
</literal></entry>
851 <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>
855 <entry><literal>transient
</literal></entry>
856 <entry>The unit file has been created dynamically with the runtime API. Transient units may not be enabled.
</entry>
860 <entry><literal>bad
</literal></entry>
861 <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>
862 <entry>> 0</entry>
872 <term><command>mask
<replaceable>UNIT
</replaceable>…
</command></term>
875 <para>Mask one or more units, as specified on the command line. This will link these unit files to
876 <filename>/dev/null
</filename>, making it impossible to start them. This is a stronger version of
877 <command>disable
</command>, since it prohibits all kinds of activation of the unit, including enablement
878 and manual activation. Use this option with care. This honors the
<option>--runtime
</option> option to only
879 mask temporarily until the next reboot of the system. The
<option>--now
</option> option may be used to
880 ensure that the units are also stopped. This command expects valid unit names only, it does not accept unit
886 <term><command>unmask
<replaceable>UNIT
</replaceable>…
</command></term>
889 <para>Unmask one or more unit files, as specified on the command line. This will undo the effect of
890 <command>mask
</command>. This command expects valid unit names only, it does not accept unit file
896 <term><command>link
<replaceable>PATH
</replaceable>…
</command></term>
899 <para>Link a unit file that is not in the unit file search paths into the unit file search path. This
900 command expects an absolute path to a unit file. The effect of this may be undone with
901 <command>disable
</command>. The effect of this command is that a unit file is made available for commands
902 such as
<command>start
</command>, even though it is not installed directly in the unit search path. The
903 file system where the linked unit files are located must be accessible when systemd is started
904 (e.g. anything underneath
<filename>/home/
</filename> or
<filename>/var/
</filename> is not allowed, unless
905 those directories are located on the root file system).
</para>
910 <term><command>revert
<replaceable>UNIT
</replaceable>…
</command></term>
913 <para>Revert one or more unit files to their vendor versions. This command removes drop-in configuration
914 files that modify the specified units, as well as any user-configured unit file that overrides a matching
915 vendor supplied unit file. Specifically, for a unit
<literal>foo.service
</literal> the matching directories
916 <literal>foo.service.d/
</literal> with all their contained files are removed, both below the persistent and
917 runtime configuration directories (i.e. below
<filename>/etc/systemd/system
</filename> and
918 <filename>/run/systemd/system
</filename>); if the unit file has a vendor-supplied version (i.e. a unit file
919 located below
<filename>/usr/
</filename>) any matching persistent or runtime unit file that overrides it is
920 removed, too. Note that if a unit file has no vendor-supplied version (i.e. is only defined below
921 <filename>/etc/systemd/system
</filename> or
<filename>/run/systemd/system
</filename>, but not in a unit
922 file stored below
<filename>/usr/
</filename>), then it is not removed. Also, if a unit is masked, it is
925 <para>Effectively, this command may be used to undo all changes made with
<command>systemctl
926 edit
</command>,
<command>systemctl set-property
</command> and
<command>systemctl mask
</command> and puts
927 the original unit file with its settings back in effect.
</para>
932 <term><command>add-wants
<replaceable>TARGET
</replaceable>
933 <replaceable>UNIT
</replaceable>…
</command></term>
934 <term><command>add-requires
<replaceable>TARGET
</replaceable>
935 <replaceable>UNIT
</replaceable>…
</command></term>
938 <para>Adds
<literal>Wants=
</literal> or
<literal>Requires=
</literal>
939 dependencies, respectively, to the specified
940 <replaceable>TARGET
</replaceable> for one or more units.
</para>
942 <para>This command honors
<option>--system
</option>,
943 <option>--user
</option>,
<option>--runtime
</option> and
944 <option>--global
</option> in a way similar to
945 <command>enable
</command>.
</para>
951 <term><command>edit
<replaceable>UNIT
</replaceable>…
</command></term>
954 <para>Edit a drop-in snippet or a whole replacement file if
955 <option>--full
</option> is specified, to extend or override the
956 specified unit.
</para>
958 <para>Depending on whether
<option>--system
</option> (the default),
959 <option>--user
</option>, or
<option>--global
</option> is specified,
960 this command creates a drop-in file for each unit either for the system,
961 for the calling user, or for all futures logins of all users. Then,
962 the editor (see the
"Environment" section below) is invoked on
963 temporary files which will be written to the real location if the
964 editor exits successfully.
</para>
966 <para>If
<option>--full
</option> is specified, this will copy the
967 original units instead of creating drop-in files.
</para>
969 <para>If
<option>--force
</option> is specified and any units do
970 not already exist, new unit files will be opened for editing.
</para>
972 <para>If
<option>--runtime
</option> is specified, the changes will
973 be made temporarily in
<filename>/run/
</filename> and they will be
974 lost on the next reboot.
</para>
976 <para>If the temporary file is empty upon exit, the modification of
977 the related unit is canceled.
</para>
979 <para>After the units have been edited, systemd configuration is
980 reloaded (in a way that is equivalent to
<command>daemon-reload
</command>).
983 <para>Note that this command cannot be used to remotely edit units
984 and that you cannot temporarily edit units which are in
985 <filename>/etc/
</filename>, since they take precedence over
986 <filename>/run/
</filename>.
</para>
991 <term><command>get-default
</command></term>
994 <para>Return the default target to boot into. This returns
995 the target unit name
<filename>default.target
</filename>
996 is aliased (symlinked) to.
</para>
1001 <term><command>set-default
<replaceable>TARGET
</replaceable></command></term>
1004 <para>Set the default target to boot into. This sets
1005 (symlinks) the
<filename>default.target
</filename> alias
1006 to the given target unit.
</para>
1014 <title>Machine Commands
</title>
1018 <term><command>list-machines
</command> <optional><replaceable>PATTERN
</replaceable>…
</optional></term>
1021 <para>List the host and all running local containers with
1022 their state. If one or more
1023 <replaceable>PATTERN
</replaceable>s are specified, only
1024 containers matching one of them are shown.
1032 <title>Job Commands
</title>
1036 <term><command>list-jobs
<optional><replaceable>PATTERN…
</replaceable></optional></command></term>
1039 <para>List jobs that are in progress. If one or more
1040 <replaceable>PATTERN
</replaceable>s are specified, only
1041 jobs for units matching one of them are shown.
</para>
1043 <para>When combined with
<option>--after
</option> or
<option>--before
</option> the list is augmented with
1044 information on which other job each job is waiting for, and which other jobs are waiting for it, see
1049 <term><command>cancel
<replaceable>JOB
</replaceable>…
</command></term>
1052 <para>Cancel one or more jobs specified on the command line
1053 by their numeric job IDs. If no job ID is specified, cancel
1054 all pending jobs.
</para>
1061 <title>Environment Commands
</title>
1065 <term><command>show-environment
</command></term>
1068 <para>Dump the systemd manager environment block. This is the environment
1069 block that is passed to all processes the manager spawns. The environment
1070 block will be dumped in straight-forward form suitable for sourcing into
1071 most shells. If no special characters or whitespace is present in the variable
1072 values, no escaping is performed, and the assignments have the form
1073 <literal>VARIABLE=value
</literal>. If whitespace or characters which have
1074 special meaning to the shell are present, dollar-single-quote escaping is
1075 used, and assignments have the form
<literal>VARIABLE=$'value'
</literal>.
1076 This syntax is known to be supported by
1077 <citerefentry project='die-net'
><refentrytitle>bash
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1078 <citerefentry project='die-net'
><refentrytitle>zsh
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1079 <citerefentry project='die-net'
><refentrytitle>ksh
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1081 <citerefentry project='die-net'
><refentrytitle>busybox
</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
1082 <citerefentry project='die-net'
><refentrytitle>ash
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1084 <citerefentry project='die-net'
><refentrytitle>dash
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
1086 <citerefentry project='die-net'
><refentrytitle>fish
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
1091 <term><command>set-environment
<replaceable>VARIABLE=VALUE
</replaceable>…
</command></term>
1094 <para>Set one or more systemd manager environment variables,
1095 as specified on the command line.
</para>
1099 <term><command>unset-environment
<replaceable>VARIABLE
</replaceable>…
</command></term>
1102 <para>Unset one or more systemd manager environment
1103 variables. If only a variable name is specified, it will be
1104 removed regardless of its value. If a variable and a value
1105 are specified, the variable is only removed if it has the
1106 specified value.
</para>
1111 <command>import-environment
</command>
1112 <optional><replaceable>VARIABLE…
</replaceable></optional>
1116 <para>Import all, one or more environment variables set on
1117 the client into the systemd manager environment block. If
1118 no arguments are passed, the entire environment block is
1119 imported. Otherwise, a list of one or more environment
1120 variable names should be passed, whose client-side values
1121 are then imported into the manager's environment
1129 <title>Manager State Commands
</title>
1133 <term><command>daemon-reload
</command></term>
1136 <para>Reload the systemd manager configuration. This will
1137 rerun all generators (see
1138 <citerefentry><refentrytitle>systemd.generator
</refentrytitle><manvolnum>7</manvolnum></citerefentry>),
1139 reload all unit files, and recreate the entire dependency
1140 tree. While the daemon is being reloaded, all sockets
1141 systemd listens on behalf of user configuration will stay
1144 <para>This command should not be confused with the
1145 <command>reload
</command> command.
</para>
1150 <term><command>daemon-reexec
</command></term>
1153 <para>Reexecute the systemd manager. This will serialize the
1154 manager state, reexecute the process and deserialize the
1155 state again. This command is of little use except for
1156 debugging and package upgrades. Sometimes, it might be
1157 helpful as a heavy-weight
<command>daemon-reload
</command>.
1158 While the daemon is being reexecuted, all sockets systemd listening
1159 on behalf of user configuration will stay accessible.
1164 <varlistentry id='log-level'
>
1165 <term><command>log-level
</command> [
<replaceable>LEVEL
</replaceable>]
</term>
1167 <listitem><para>If no argument is given, print the current log level of the manager. If an
1168 optional argument
<replaceable>LEVEL
</replaceable> is provided, then the command changes the
1169 current log level of the manager to
<replaceable>LEVEL
</replaceable> (accepts the same values as
1170 <option>--log-level=
</option> described in
1171 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
1176 <term><command>log-target
</command> [
<replaceable>TARGET
</replaceable>]
</term>
1178 <listitem><para>If no argument is given, print the current log target of the manager. If an
1179 optional argument
<replaceable>TARGET
</replaceable> is provided, then the command changes the
1180 current log target of the manager to
<replaceable>TARGET
</replaceable> (accepts the same values as
1181 <option>--log-target=
</option>, described in
1182 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>).
1187 <term><command>service-watchdogs
</command> [yes|no]
</term>
1189 <listitem><para>If no argument is given, print the current state of service runtime watchdogs of
1190 the manager. If an optional boolean argument is provided, then globally enables or disables the
1191 service runtime watchdogs (
<option>WatchdogSec=
</option>) and emergency actions (e.g.
1192 <option>OnFailure=
</option> or
<option>StartLimitAction=
</option>); see
1193 <citerefentry><refentrytitle>systemd.service
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1194 The hardware watchdog is not affected by this setting.
</para></listitem>
1200 <title>System Commands
</title>
1204 <term><command>is-system-running
</command></term>
1207 <para>Checks whether the system is operational. This
1208 returns success (exit code
0) when the system is fully up
1209 and running, specifically not in startup, shutdown or
1210 maintenance mode, and with no failed services. Failure is
1211 returned otherwise (exit code non-zero). In addition, the
1212 current state is printed in a short string to standard
1213 output, see the table below. Use
<option>--quiet
</option> to
1214 suppress this output.
</para>
1216 <para>Use
<option>--wait
</option> to wait until the boot
1217 process is completed before printing the current state and
1218 returning the appropriate error status. If
<option>--wait
</option>
1219 is in use, states
<varname>initializing
</varname> or
1220 <varname>starting
</varname> will not be reported, instead
1221 the command will block until a later state (such as
1222 <varname>running
</varname> or
<varname>degraded
</varname>)
1226 <title><command>is-system-running
</command> output
</title>
1228 <colspec colname='name'
/>
1229 <colspec colname='description'
/>
1230 <colspec colname='exit-code'
/>
1234 <entry>Description
</entry>
1235 <entry>Exit Code
</entry>
1240 <entry><varname>initializing
</varname></entry>
1241 <entry><para>Early bootup, before
1242 <filename>basic.target
</filename> is reached
1243 or the
<varname>maintenance
</varname> state entered.
1245 <entry>> 0</entry>
1248 <entry><varname>starting
</varname></entry>
1249 <entry><para>Late bootup, before the job queue
1250 becomes idle for the first time, or one of the
1251 rescue targets are reached.
</para></entry>
1252 <entry>> 0</entry>
1255 <entry><varname>running
</varname></entry>
1256 <entry><para>The system is fully
1257 operational.
</para></entry>
1261 <entry><varname>degraded
</varname></entry>
1262 <entry><para>The system is operational but one or more
1263 units failed.
</para></entry>
1264 <entry>> 0</entry>
1267 <entry><varname>maintenance
</varname></entry>
1268 <entry><para>The rescue or emergency target is
1269 active.
</para></entry>
1270 <entry>> 0</entry>
1273 <entry><varname>stopping
</varname></entry>
1274 <entry><para>The manager is shutting
1275 down.
</para></entry>
1276 <entry>> 0</entry>
1279 <entry><varname>offline
</varname></entry>
1280 <entry><para>The manager is not
1281 running. Specifically, this is the operational
1282 state if an incompatible program is running as
1283 system manager (PID
1).
</para></entry>
1284 <entry>> 0</entry>
1287 <entry><varname>unknown
</varname></entry>
1288 <entry><para>The operational state could not be
1289 determined, due to lack of resources or another
1290 error cause.
</para></entry>
1291 <entry>> 0</entry>
1300 <term><command>default
</command></term>
1303 <para>Enter default mode. This is equivalent to
<command>systemctl isolate default.target
</command>. This
1304 operation is blocking by default, use
<option>--no-block
</option> to request asynchronous behavior.
</para>
1309 <term><command>rescue
</command></term>
1312 <para>Enter rescue mode. This is equivalent to
<command>systemctl isolate rescue.target
</command>. This
1313 operation is blocking by default, use
<option>--no-block
</option> to request asynchronous behavior.
</para>
1317 <term><command>emergency
</command></term>
1320 <para>Enter emergency mode. This is equivalent to
<command>systemctl isolate
1321 emergency.target
</command>. This operation is blocking by default, use
<option>--no-block
</option> to
1322 request asynchronous behavior.
</para>
1326 <term><command>halt
</command></term>
1329 <para>Shut down and halt the system. This is mostly equivalent to
<command>systemctl start halt.target
1330 --job-mode=replace-irreversibly --no-block
</command>, but also prints a wall message to all users. This command is
1331 asynchronous; it will return after the halt operation is enqueued, without waiting for it to complete. Note
1332 that this operation will simply halt the OS kernel after shutting down, leaving the hardware powered
1333 on. Use
<command>systemctl poweroff
</command> for powering off the system (see below).
</para>
1335 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1336 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1337 system halt. If
<option>--force
</option> is specified twice, the operation is immediately executed without
1338 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1339 <option>--force
</option> is specified twice the halt operation is executed by
<command>systemctl
</command>
1340 itself, and the system manager is not contacted. This means the command should succeed even when the system
1341 manager has crashed.
</para>
1345 <term><command>poweroff
</command></term>
1348 <para>Shut down and power-off the system. This is mostly equivalent to
<command>systemctl start
1349 poweroff.target --job-mode=replace-irreversibly --no-block
</command>, but also prints a wall message to all
1350 users. This command is asynchronous; it will return after the power-off operation is enqueued, without
1351 waiting for it to complete.
</para>
1353 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1354 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1355 powering off. If
<option>--force
</option> is specified twice, the operation is immediately executed without
1356 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1357 <option>--force
</option> is specified twice the power-off operation is executed by
1358 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
1359 succeed even when the system manager has crashed.
</para>
1363 <term><command>reboot
</command></term>
1366 <para>Shut down and reboot the system. This is mostly equivalent to
<command>systemctl start reboot.target
1367 --job-mode=replace-irreversibly --no-block
</command>, but also prints a wall message to all users. This
1368 command is asynchronous; it will return after the reboot operation is enqueued, without waiting for it to
1371 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1372 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1373 reboot. If
<option>--force
</option> is specified twice, the operation is immediately executed without
1374 terminating any processes or unmounting any file systems. This may result in data loss. Note that when
1375 <option>--force
</option> is specified twice the reboot operation is executed by
1376 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
1377 succeed even when the system manager has crashed.
</para>
1379 <para>If the switch
<option>--reboot-argument=
</option> is given, it will be passed as the optional
1380 argument to the
<citerefentry><refentrytitle>reboot
</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1386 <term><command>kexec
</command></term>
1389 <para>Shut down and reboot the system via
<command>kexec
</command>. This is equivalent to
1390 <command>systemctl start kexec.target --job-mode=replace-irreversibly --no-block
</command>. This command is
1391 asynchronous; it will return after the reboot operation is enqueued, without waiting for it to
1394 <para>If combined with
<option>--force
</option>, shutdown of all running services is skipped, however all
1395 processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the
1401 <term><command>exit
</command> <optional><replaceable>EXIT_CODE
</replaceable></optional></term>
1404 <para>Ask the service manager to quit. This is only supported for user service managers (i.e. in
1405 conjunction with the
<option>--user
</option> option) or in containers and is equivalent to
1406 <command>poweroff
</command> otherwise. This command is asynchronous; it will return after the exit
1407 operation is enqueued, without waiting for it to complete.
</para>
1409 <para>The service manager will exit with the specified exit code, if
1410 <replaceable>EXIT_CODE
</replaceable> is passed.
</para>
1415 <term><command>switch-root
</command> <replaceable>ROOT
</replaceable> <optional><replaceable>INIT
</replaceable></optional></term>
1418 <para>Switches to a different root directory and executes a new system manager process below it. This is
1419 intended for usage in initial RAM disks (
"initrd"), and will transition from the initrd's system manager
1420 process (a.k.a.
"init" process) to the main system manager process which is loaded from the actual host
1421 volume. This call takes two arguments: the directory that is to become the new root directory, and the path
1422 to the new system manager binary below it to execute as PID
1. If the latter is omitted or the empty
1423 string, a systemd binary will automatically be searched for and used as init. If the system manager path is
1424 omitted, equal to the empty string or identical to the path to the systemd binary, the state of the
1425 initrd's system manager process is passed to the main system manager, which allows later introspection of
1426 the state of the services involved in the initrd boot phase.
</para>
1431 <term><command>suspend
</command></term>
1434 <para>Suspend the system. This will trigger activation of the special target unit
1435 <filename>suspend.target
</filename>. This command is asynchronous, and will return after the suspend
1436 operation is successfully enqueued. It will not wait for the suspend/resume cycle to complete.
</para>
1441 <term><command>hibernate
</command></term>
1444 <para>Hibernate the system. This will trigger activation of the special target unit
1445 <filename>hibernate.target
</filename>. This command is asynchronous, and will return after the hibernation
1446 operation is successfully enqueued. It will not wait for the hibernate/thaw cycle to complete.
</para>
1451 <term><command>hybrid-sleep
</command></term>
1454 <para>Hibernate and suspend the system. This will trigger activation of the special target unit
1455 <filename>hybrid-sleep.target
</filename>. This command is asynchronous, and will return after the hybrid
1456 sleep operation is successfully enqueued. It will not wait for the sleep/wake-up cycle to complete.
</para>
1461 <term><command>suspend-then-hibernate
</command></term>
1464 <para>Suspend the system and hibernate it after the delay specified in
<filename>systemd-sleep.conf
</filename>.
1465 This will trigger activation of the special target unit
<filename>suspend-then-hibernate.target
</filename>.
1466 This command is asynchronous, and will return after the hybrid sleep operation is successfully enqueued.
1467 It will not wait for the sleep/wake-up or hibernate/thaw cycle to complete.
</para>
1474 <title>Parameter Syntax
</title>
1476 <para>Unit commands listed above take either a single unit name (designated as
<replaceable>UNIT
</replaceable>),
1477 or multiple unit specifications (designated as
<replaceable>PATTERN
</replaceable>…). In the first case, the
1478 unit name with or without a suffix must be given. If the suffix is not specified (unit name is
"abbreviated"),
1479 systemctl will append a suitable suffix,
<literal>.service
</literal> by default, and a type-specific suffix in
1480 case of commands which operate only on specific unit types. For example,
1481 <programlisting># systemctl start sshd
</programlisting> and
1482 <programlisting># systemctl start sshd.service
</programlisting>
1483 are equivalent, as are
1484 <programlisting># systemctl isolate default
</programlisting>
1486 <programlisting># systemctl isolate default.target
</programlisting>
1487 Note that (absolute) paths to device nodes are automatically converted to device unit names, and other (absolute)
1488 paths to mount unit names.
1489 <programlisting># systemctl status /dev/sda
1490 # systemctl status /home
</programlisting>
1492 <programlisting># systemctl status dev-sda.device
1493 # systemctl status home.mount
</programlisting>
1494 In the second case, shell-style globs will be matched against the primary names of all units currently in memory;
1495 literal unit names, with or without a suffix, will be treated as in the first case. This means that literal unit
1496 names always refer to exactly one unit, but globs may match zero units and this is not considered an
1499 <para>Glob patterns use
1500 <citerefentry project='man-pages'
><refentrytitle>fnmatch
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
1501 so normal shell-style globbing rules are used, and
1502 <literal>*
</literal>,
<literal>?
</literal>,
1503 <literal>[]
</literal> may be used. See
1504 <citerefentry project='man-pages'
><refentrytitle>glob
</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1505 for more details. The patterns are matched against the primary names of
1506 units currently in memory, and patterns which do not match anything
1507 are silently skipped. For example:
1508 <programlisting># systemctl stop sshd@*.service
</programlisting>
1509 will stop all
<filename>sshd@.service
</filename> instances. Note that alias names of units, and units that aren't
1510 in memory are not considered for glob expansion.
1513 <para>For unit file commands, the specified
<replaceable>UNIT
</replaceable> should be the name of the unit file
1514 (possibly abbreviated, see above), or the absolute path to the unit file:
1515 <programlisting># systemctl enable foo.service
</programlisting>
1517 <programlisting># systemctl link /path/to/foo.service
</programlisting>
1524 <title>Options
</title>
1526 <para>The following options are understood:
</para>
1530 <term><option>-t
</option></term>
1531 <term><option>--type=
</option></term>
1534 <para>The argument should be a comma-separated list of unit
1535 types such as
<option>service
</option> and
1536 <option>socket
</option>.
1539 <para>If one of the arguments is a unit type, when listing
1540 units, limit display to certain unit types. Otherwise, units
1541 of all types will be shown.
</para>
1543 <para>As a special case, if one of the arguments is
1544 <option>help
</option>, a list of allowed values will be
1545 printed and the program will exit.
</para>
1550 <term><option>--state=
</option></term>
1553 <para>The argument should be a comma-separated list of unit
1554 LOAD, SUB, or ACTIVE states. When listing units, show only
1555 those in the specified states. Use
<option>--state=failed
</option>
1556 to show only failed units.
</para>
1558 <para>As a special case, if one of the arguments is
1559 <option>help
</option>, a list of allowed values will be
1560 printed and the program will exit.
</para>
1565 <term><option>-p
</option></term>
1566 <term><option>--property=
</option></term>
1569 <para>When showing unit/job/manager properties with the
1570 <command>show
</command> command, limit display to properties
1571 specified in the argument. The argument should be a
1572 comma-separated list of property names, such as
1573 <literal>MainPID
</literal>. Unless specified, all known
1574 properties are shown. If specified more than once, all
1575 properties with the specified names are shown. Shell
1576 completion is implemented for property names.
</para>
1578 <para>For the manager itself,
1579 <command>systemctl show
</command> will show all available
1580 properties. Those properties are documented in
1581 <citerefentry><refentrytitle>systemd-system.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1584 <para>Properties for units vary by unit type, so showing any
1585 unit (even a non-existent one) is a way to list properties
1586 pertaining to this type. Similarly, showing any job will list
1587 properties pertaining to all jobs. Properties for units are
1589 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1590 and the pages for individual unit types
1591 <citerefentry><refentrytitle>systemd.service
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1592 <citerefentry><refentrytitle>systemd.socket
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1598 <term><option>-P
</option></term>
1601 <para>Equivalent to
<option>--value
</option> <option>--property=
</option>, i.e. shows the
1602 value of the property without the property name or
<literal>=
</literal>. Note that using
1603 <option>-P
</option> once will also affect all properties listed with
1604 <option>-p
</option>/
<option>--property=
</option>.
</para>
1609 <term><option>-a
</option></term>
1610 <term><option>--all
</option></term>
1613 <para>When listing units with
<command>list-units
</command>, also show inactive units and
1614 units which are following other units. When showing unit/job/manager properties, show all
1615 properties regardless whether they are set or not.
</para>
1617 <para>To list all units installed in the file system, use the
1618 <command>list-unit-files
</command> command instead.
</para>
1620 <para>When listing units with
<command>list-dependencies
</command>, recursively show
1621 dependencies of all dependent units (by default only dependencies of target units are
1624 <para>When used with
<command>status
</command>, show journal messages in full, even if they include
1625 unprintable characters or are very long. By default, fields with unprintable characters are
1626 abbreviated as
"blob data". (Note that the pager may escape unprintable characters again.)
</para>
1631 <term><option>-r
</option></term>
1632 <term><option>--recursive
</option></term>
1635 <para>When listing units, also show units of local
1636 containers. Units of local containers will be prefixed with
1637 the container name, separated by a single colon character
1638 (
<literal>:
</literal>).
</para>
1643 <term><option>--reverse
</option></term>
1646 <para>Show reverse dependencies between units with
1647 <command>list-dependencies
</command>, i.e. follow
1648 dependencies of type
<varname>WantedBy=
</varname>,
1649 <varname>RequiredBy=
</varname>,
1650 <varname>PartOf=
</varname>,
<varname>BoundBy=
</varname>,
1651 instead of
<varname>Wants=
</varname> and similar.
1657 <term><option>--after
</option></term>
1660 <para>With
<command>list-dependencies
</command>, show the
1661 units that are ordered before the specified unit. In other
1662 words, recursively list units following the
1663 <varname>After=
</varname> dependency.
</para>
1665 <para>Note that any
<varname>After=
</varname> dependency is
1666 automatically mirrored to create a
1667 <varname>Before=
</varname> dependency. Temporal dependencies
1668 may be specified explicitly, but are also created implicitly
1669 for units which are
<varname>WantedBy=
</varname> targets
1671 <citerefentry><refentrytitle>systemd.target
</refentrytitle><manvolnum>5</manvolnum></citerefentry>),
1672 and as a result of other directives (for example
1673 <varname>RequiresMountsFor=
</varname>). Both explicitly
1674 and implicitly introduced dependencies are shown with
1675 <command>list-dependencies
</command>.
</para>
1677 <para>When passed to the
<command>list-jobs
</command> command, for each printed job show which other jobs are
1678 waiting for it. May be combined with
<option>--before
</option> to show both the jobs waiting for each job as
1679 well as all jobs each job is waiting for.
</para>
1684 <term><option>--before
</option></term>
1687 <para>With
<command>list-dependencies
</command>, show the
1688 units that are ordered after the specified unit. In other
1689 words, recursively list units following the
1690 <varname>Before=
</varname> dependency.
</para>
1692 <para>When passed to the
<command>list-jobs
</command> command, for each printed job show which other jobs it
1693 is waiting for. May be combined with
<option>--after
</option> to show both the jobs waiting for each job as
1694 well as all jobs each job is waiting for.
</para>
1699 <term><option>--with-dependencies
</option></term>
1702 <para>When used with
<command>status
</command>,
1703 <command>cat
</command>,
<command>list-units
</command>, and
1704 <command>list-unit-files
</command>, those commands print all
1705 specified units and the dependencies of those units.
</para>
1707 <para>Options
<option>--reverse
</option>,
1708 <option>--after
</option>,
<option>--before
</option>
1709 may be used to change what types of dependencies
1715 <term><option>-l
</option></term>
1716 <term><option>--full
</option></term>
1719 <para>Do not ellipsize unit names, process tree entries,
1720 journal output, or truncate unit descriptions in the output
1721 of
<command>status
</command>,
<command>list-units
</command>,
1722 <command>list-jobs
</command>, and
1723 <command>list-timers
</command>.
</para>
1724 <para>Also, show installation targets in the output of
1725 <command>is-enabled
</command>.
</para>
1730 <term><option>--value
</option></term>
1733 <para>When printing properties with
<command>show
</command>, only print the value, and skip the
1734 property name and
<literal>=
</literal>. Also see option
<option>-P
</option> above.
</para>
1739 <term><option>--show-types
</option></term>
1742 <para>When showing sockets, show the type of the socket.
</para>
1747 <term><option>--job-mode=
</option></term>
1750 <para>When queuing a new job, this option controls how to deal with
1751 already queued jobs. It takes one of
<literal>fail
</literal>,
1752 <literal>replace
</literal>,
1753 <literal>replace-irreversibly
</literal>,
1754 <literal>isolate
</literal>,
1755 <literal>ignore-dependencies
</literal>,
1756 <literal>ignore-requirements
</literal>,
1757 <literal>flush
</literal>, or
1758 <literal>triggering
</literal>. Defaults to
1759 <literal>replace
</literal>, except when the
1760 <command>isolate
</command> command is used which implies the
1761 <literal>isolate
</literal> job mode.
</para>
1763 <para>If
<literal>fail
</literal> is specified and a requested
1764 operation conflicts with a pending job (more specifically:
1765 causes an already pending start job to be reversed into a stop
1766 job or vice versa), cause the operation to fail.
</para>
1768 <para>If
<literal>replace
</literal> (the default) is
1769 specified, any conflicting pending job will be replaced, as
1772 <para>If
<literal>replace-irreversibly
</literal> is specified,
1773 operate like
<literal>replace
</literal>, but also mark the new
1774 jobs as irreversible. This prevents future conflicting
1775 transactions from replacing these jobs (or even being enqueued
1776 while the irreversible jobs are still pending). Irreversible
1777 jobs can still be cancelled using the
<command>cancel
</command>
1778 command. This job mode should be used on any transaction which
1779 pulls in
<filename>shutdown.target
</filename>.
</para>
1781 <para><literal>isolate
</literal> is only valid for start
1782 operations and causes all other units to be stopped when the
1783 specified unit is started. This mode is always used when the
1784 <command>isolate
</command> command is used.
</para>
1786 <para><literal>flush
</literal> will cause all queued jobs to
1787 be canceled when the new job is enqueued.
</para>
1789 <para>If
<literal>ignore-dependencies
</literal> is specified,
1790 then all unit dependencies are ignored for this new job and
1791 the operation is executed immediately. If passed, no required
1792 units of the unit passed will be pulled in, and no ordering
1793 dependencies will be honored. This is mostly a debugging and
1794 rescue tool for the administrator and should not be used by
1795 applications.
</para>
1797 <para><literal>ignore-requirements
</literal> is similar to
1798 <literal>ignore-dependencies
</literal>, but only causes the
1799 requirement dependencies to be ignored, the ordering
1800 dependencies will still be honored.
</para>
1803 <para><literal>triggering
</literal> may only be used with
1804 <command>systemctl stop
</command>. In this mode, the specified
1805 unit and any active units that trigger it are stopped. See the
1807 <varname>Triggers=
</varname> in
<citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1808 for more information about triggering units.
</para>
1813 <term><option>-T
</option></term>
1814 <term><option>--show-transaction
</option></term>
1817 <para>When enqueuing a unit job (for example as effect of a
<command>systemctl start
</command>
1818 invocation or similar), show brief information about all jobs enqueued, covering both the requested
1819 job and any added because of unit dependencies. Note that the output will only include jobs
1820 immediately part of the transaction requested. It is possible that service start-up program code
1821 run as effect of the enqueued jobs might request further jobs to be pulled in. This means that
1822 completion of the listed jobs might ultimately entail more jobs than the listed ones.
</para>
1827 <term><option>--fail
</option></term>
1830 <para>Shorthand for
<option>--job-mode=
</option>fail.
</para>
1831 <para>When used with the
<command>kill
</command> command,
1832 if no units were killed, the operation results in an error.
1838 <term><option>-i
</option></term>
1839 <term><option>--ignore-inhibitors
</option></term>
1842 <para>When system shutdown or a sleep state is requested, ignore inhibitor locks. Applications can establish
1843 inhibitor locks to avoid that certain important operations (such as CD burning or suchlike) are interrupted
1844 by system shutdown or a sleep state. Any user may take these locks and privileged users may override these
1845 locks. If any locks are taken, shutdown and sleep state requests will normally fail (unless privileged) and a
1846 list of active locks is printed. However, if
<option>--ignore-inhibitors
</option> is specified, the
1847 established locks are ignored and not shown, and the operation attempted anyway, possibly requiring
1848 additional privileges.
</para>
1853 <term><option>--dry-run
</option></term>
1856 <para>Just print what would be done. Currently supported by verbs
1857 <command>halt
</command>,
<command>poweroff
</command>,
<command>reboot
</command>,
1858 <command>kexec
</command>,
<command>suspend
</command>,
<command>hibernate
</command>,
1859 <command>hybrid-sleep
</command>,
<command>suspend-then-hibernate
</command>,
1860 <command>default
</command>,
<command>rescue
</command>,
1861 <command>emergency
</command>, and
<command>exit
</command>.
</para>
1866 <term><option>-q
</option></term>
1867 <term><option>--quiet
</option></term>
1870 <para>Suppress printing of the results of various commands
1871 and also the hints about truncated log lines. This does not
1872 suppress output of commands for which the printed output is
1873 the only result (like
<command>show
</command>). Errors are
1874 always printed.
</para>
1879 <term><option>--no-block
</option></term>
1882 <para>Do not synchronously wait for the requested operation
1883 to finish. If this is not specified, the job will be
1884 verified, enqueued and
<command>systemctl
</command> will
1885 wait until the unit's start-up is completed. By passing this
1886 argument, it is only verified and enqueued. This option may not be
1887 combined with
<option>--wait
</option>.
</para>
1892 <term><option>--wait
</option></term>
1895 <para>Synchronously wait for started units to terminate again.
1896 This option may not be combined with
<option>--no-block
</option>.
1897 Note that this will wait forever if any given unit never terminates
1898 (by itself or by getting stopped explicitly); particularly services
1899 which use
<literal>RemainAfterExit=yes
</literal>.
</para>
1901 <para>When used with
<command>is-system-running
</command>, wait
1902 until the boot process is completed before returning.
</para>
1906 <xi:include href=
"user-system-options.xml" xpointer=
"user" />
1907 <xi:include href=
"user-system-options.xml" xpointer=
"system" />
1910 <term><option>--failed
</option></term>
1913 <para>List units in failed state. This is equivalent to
1914 <option>--state=failed
</option>.
</para>
1919 <term><option>--no-wall
</option></term>
1922 <para>Do not send wall message before halt, power-off and reboot.
</para>
1927 <term><option>--global
</option></term>
1930 <para>When used with
<command>enable
</command> and
1931 <command>disable
</command>, operate on the global user
1932 configuration directory, thus enabling or disabling a unit
1933 file globally for all future logins of all users.
</para>
1938 <term><option>--no-reload
</option></term>
1941 <para>When used with
<command>enable
</command> and
1942 <command>disable
</command>, do not implicitly reload daemon
1943 configuration after executing the changes.
</para>
1948 <term><option>--no-ask-password
</option></term>
1951 <para>When used with
<command>start
</command> and related
1952 commands, disables asking for passwords. Background services
1953 may require input of a password or passphrase string, for
1954 example to unlock system hard disks or cryptographic
1955 certificates. Unless this option is specified and the
1956 command is invoked from a terminal,
1957 <command>systemctl
</command> will query the user on the
1958 terminal for the necessary secrets. Use this option to
1959 switch this behavior off. In this case, the password must be
1960 supplied by some other means (for example graphical password
1961 agents) or the service might fail. This also disables
1962 querying the user for authentication for privileged
1968 <term><option>--kill-who=
</option></term>
1971 <para>When used with
<command>kill
</command>, choose which
1972 processes to send a signal to. Must be one of
1973 <option>main
</option>,
<option>control
</option> or
1974 <option>all
</option> to select whether to kill only the main
1975 process, the control process or all processes of the
1976 unit. The main process of the unit is the one that defines
1977 the life-time of it. A control process of a unit is one that
1978 is invoked by the manager to induce state changes of it. For
1979 example, all processes started due to the
1980 <varname>ExecStartPre=
</varname>,
1981 <varname>ExecStop=
</varname> or
1982 <varname>ExecReload=
</varname> settings of service units are
1983 control processes. Note that there is only one control
1984 process per unit at a time, as only one state change is
1985 executed at a time. For services of type
1986 <varname>Type=forking
</varname>, the initial process started
1987 by the manager for
<varname>ExecStart=
</varname> is a
1988 control process, while the process ultimately forked off by
1989 that one is then considered the main process of the unit (if
1990 it can be determined). This is different for service units
1991 of other types, where the process forked off by the manager
1992 for
<varname>ExecStart=
</varname> is always the main process
1993 itself. A service unit consists of zero or one main process,
1994 zero or one control process plus any number of additional
1995 processes. Not all unit types manage processes of these
1996 types however. For example, for mount units, control processes
1997 are defined (which are the invocations of
1998 <filename>&MOUNT_PATH;</filename> and
1999 <filename>&UMOUNT_PATH;</filename>), but no main process
2000 is defined. If omitted, defaults to
2001 <option>all
</option>.
</para>
2007 <term><option>-s
</option></term>
2008 <term><option>--signal=
</option></term>
2011 <para>When used with
<command>kill
</command>, choose which
2012 signal to send to selected processes. Must be one of the
2013 well-known signal specifiers such as
<constant>SIGTERM
</constant>,
<constant>SIGINT
</constant> or
2014 <constant>SIGSTOP
</constant>. If omitted, defaults to
2015 <option>SIGTERM
</option>.
</para>
2020 <term><option>--what=
</option></term>
2023 <para>Select what type of per-unit resources to remove when the
<command>clean
</command> command is
2024 invoked, see below. Takes one of
<constant>configuration
</constant>,
<constant>state
</constant>,
2025 <constant>cache
</constant>,
<constant>logs
</constant>,
<constant>runtime
</constant> to select the
2026 type of resource. This option may be specified more than once, in which case all specified resource
2027 types are removed. Also accepts the special value
<constant>all
</constant> as a shortcut for
2028 specifying all five resource types. If this option is not specified defaults to the combination of
2029 <constant>cache
</constant> and
<constant>runtime
</constant>, i.e. the two kinds of resources that
2030 are generally considered to be redundant and can be reconstructed on next invocation.
</para>
2035 <term><option>-f
</option></term>
2036 <term><option>--force
</option></term>
2039 <para>When used with
<command>enable
</command>, overwrite
2040 any existing conflicting symlinks.
</para>
2042 <para>When used with
<command>edit
</command>, create all of the
2043 specified units which do not already exist.
</para>
2045 <para>When used with
<command>halt
</command>,
<command>poweroff
</command>,
<command>reboot
</command> or
2046 <command>kexec
</command>, execute the selected operation without shutting down all units. However, all
2047 processes will be killed forcibly and all file systems are unmounted or remounted read-only. This is hence a
2048 drastic but relatively safe option to request an immediate reboot. If
<option>--force
</option> is specified
2049 twice for these operations (with the exception of
<command>kexec
</command>), they will be executed
2050 immediately, without terminating any processes or unmounting any file systems. Warning: specifying
2051 <option>--force
</option> twice with any of these operations might result in data loss. Note that when
2052 <option>--force
</option> is specified twice the selected operation is executed by
2053 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
2054 succeed even when the system manager has crashed.
</para>
2059 <term><option>--message=
</option></term>
2062 <para>When used with
<command>halt
</command>,
<command>poweroff
</command> or
<command>reboot
</command>, set a
2063 short message explaining the reason for the operation. The message will be logged together with the default
2064 shutdown message.
</para>
2069 <term><option>--now
</option></term>
2072 <para>When used with
<command>enable
</command>, the units
2073 will also be started. When used with
<command>disable
</command> or
2074 <command>mask
</command>, the units will also be stopped. The start
2075 or stop operation is only carried out when the respective enable or
2076 disable operation has been successful.
</para>
2081 <term><option>--root=
</option></term>
2084 <para>When used with
2085 <command>enable
</command>/
<command>disable
</command>/
<command>is-enabled
</command>
2086 (and related commands), use the specified root path when looking for unit
2087 files. If this option is present,
<command>systemctl
</command> will operate on
2088 the file system directly, instead of communicating with the
<command>systemd
</command>
2089 daemon to carry out changes.
</para>
2095 <term><option>--runtime
</option></term>
2098 <para>When used with
<command>enable
</command>,
2099 <command>disable
</command>,
<command>edit
</command>,
2100 (and related commands), make changes only temporarily, so
2101 that they are lost on the next reboot. This will have the
2102 effect that changes are not made in subdirectories of
2103 <filename>/etc/
</filename> but in
<filename>/run/
</filename>,
2104 with identical immediate effects, however, since the latter
2105 is lost on reboot, the changes are lost too.
</para>
2107 <para>Similarly, when used with
2108 <command>set-property
</command>, make changes only
2109 temporarily, so that they are lost on the next
2115 <term><option>--preset-mode=
</option></term>
2118 <para>Takes one of
<literal>full
</literal> (the default),
2119 <literal>enable-only
</literal>,
2120 <literal>disable-only
</literal>. When used with the
2121 <command>preset
</command> or
<command>preset-all
</command>
2122 commands, controls whether units shall be disabled and
2123 enabled according to the preset rules, or only enabled, or
2124 only disabled.
</para>
2129 <term><option>-n
</option></term>
2130 <term><option>--lines=
</option></term>
2133 <para>When used with
<command>status
</command>, controls the number of journal lines to show, counting from
2134 the most recent ones. Takes a positive integer argument, or
0 to disable journal output. Defaults to
2140 <term><option>-o
</option></term>
2141 <term><option>--output=
</option></term>
2144 <para>When used with
<command>status
</command>, controls the
2145 formatting of the journal entries that are shown. For the
2146 available choices, see
2147 <citerefentry><refentrytitle>journalctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
2148 Defaults to
<literal>short
</literal>.
</para>
2153 <term><option>--firmware-setup
</option></term>
2156 <para>When used with the
<command>reboot
</command> command, indicate to the system's firmware to reboot into
2157 the firmware setup interface. Note that this functionality is not available on all systems.
</para>
2162 <term><option>--boot-loader-menu=
</option></term>
2165 <para>When used with the
<command>reboot
</command> command, indicate to the system's boot loader to show the
2166 boot loader menu on the following boot. Takes a time value as parameter — indicating the menu timeout. Pass
2167 zero in order to disable the menu timeout. Note that not all boot loaders support this
2168 functionality.
</para>
2173 <term><option>--boot-loader-entry=
</option></term>
2176 <para>When used with the
<command>reboot
</command> command, indicate to the system's boot loader to boot into
2177 a specific boot loader entry on the following boot. Takes a boot loader entry identifier as argument, or
2178 <literal>help
</literal> in order to list available entries. Note that not all boot loaders support this
2179 functionality.
</para>
2184 <term><option>--reboot-argument=
</option></term>
2187 <para>This switch is used with
<command>reboot
</command>. The value is architecture and firmware specific. As an example,
<literal>recovery
</literal>
2188 might be used to trigger system recovery, and
<literal>fota
</literal> might be used to trigger a
2189 <quote>firmware over the air
</quote> update.
</para>
2194 <term><option>--plain
</option></term>
2197 <para>When used with
<command>list-dependencies
</command>,
2198 <command>list-units
</command> or
<command>list-machines
</command>,
2199 the output is printed as a list instead of a tree, and the bullet
2200 circles are omitted.
</para>
2205 <term><option>--timestamp=
</option></term>
2208 <para>Takes one of
<literal>pretty
</literal> (the default),
2209 <literal>us
</literal>,
<literal>µs
</literal>,
<literal>utc
</literal>.
2210 Changes the format of printed timestamps.
2211 <literal>pretty
</literal>:
<literal>Day YYYY-MM-DD HH:MM:SS TZ
</literal>
2212 <literal>us
</literal> or
<literal>µs
</literal>:
<literal>Day YYYY-MM-DD HH:MM:SS.UUUUUU TZ
</literal>
2213 <literal>utc
</literal>:
<literal>Day YYYY-MM-DD HH:MM:SS UTC
</literal></para>
2214 <literal>us+utc
</literal> or
<literal>µs+utc
</literal>:
<literal>Day YYYY-MM-DD HH:MM:SS.UUUUUU UTC
</literal>
2218 <xi:include href=
"user-system-options.xml" xpointer=
"host" />
2219 <xi:include href=
"user-system-options.xml" xpointer=
"machine" />
2221 <xi:include href=
"standard-options.xml" xpointer=
"no-pager" />
2222 <xi:include href=
"standard-options.xml" xpointer=
"no-legend" />
2223 <xi:include href=
"standard-options.xml" xpointer=
"help" />
2224 <xi:include href=
"standard-options.xml" xpointer=
"version" />
2229 <title>Exit status
</title>
2231 <para>On success,
0 is returned, a non-zero failure code otherwise.
</para>
2233 <para><command>systemctl
</command> uses the return codes defined by LSB, as defined in
2234 <ulink url=
"http://refspecs.linuxbase.org/LSB_3.0.0/LSB-PDA/LSB-PDA/iniscrptact.html">LSB
3.0.0</ulink>.
2238 <title>LSB return codes
</title>
2243 <entry>Value
</entry>
2244 <entry>Description in LSB
</entry>
2245 <entry>Use in systemd
</entry>
2250 <entry><constant>0</constant></entry>
2251 <entry>"program is running or service is OK"</entry>
2252 <entry>unit is active
</entry>
2255 <entry><constant>1</constant></entry>
2256 <entry>"program is dead and <filename>/var/run</filename> pid file exists"</entry>
2257 <entry>unit
<emphasis>not
</emphasis> failed (used by
<command>is-failed
</command>)
</entry>
2260 <entry><constant>2</constant></entry>
2261 <entry>"program is dead and <filename>/var/lock</filename> lock file exists"</entry>
2262 <entry>unused
</entry>
2265 <entry><constant>3</constant></entry>
2266 <entry>"program is not running"</entry>
2267 <entry>unit is not active
</entry>
2270 <entry><constant>4</constant></entry>
2271 <entry>"program or service status is unknown"</entry>
2272 <entry>no such unit
</entry>
2278 <para>The mapping of LSB service states to systemd unit states is imperfect, so it is better to
2279 not rely on those return values but to look for specific unit states and substates instead.
2284 <title>Environment
</title>
2286 <variablelist class='environment-variables'
>
2288 <term><varname>$SYSTEMD_EDITOR
</varname></term>
2290 <listitem><para>Editor to use when editing units; overrides
2291 <varname>$EDITOR
</varname> and
<varname>$VISUAL
</varname>. If neither
2292 <varname>$SYSTEMD_EDITOR
</varname> nor
<varname>$EDITOR
</varname> nor
2293 <varname>$VISUAL
</varname> are present or if it is set to an empty
2294 string or if their execution failed, systemctl will try to execute well
2295 known editors in this order:
2296 <citerefentry project='die-net'
><refentrytitle>editor
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2297 <citerefentry project='die-net'
><refentrytitle>nano
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2298 <citerefentry project='die-net'
><refentrytitle>vim
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2299 <citerefentry project='die-net'
><refentrytitle>vi
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
2303 <xi:include href=
"less-variables.xml" xpointer=
"pager"/>
2304 <xi:include href=
"less-variables.xml" xpointer=
"less"/>
2305 <xi:include href=
"less-variables.xml" xpointer=
"lesscharset"/>
2306 <xi:include href=
"less-variables.xml" xpointer=
"lesssecure"/>
2307 <xi:include href=
"less-variables.xml" xpointer=
"colors"/>
2308 <xi:include href=
"less-variables.xml" xpointer=
"urlify"/>
2312 <title>See Also
</title>
2314 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2315 <citerefentry><refentrytitle>journalctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2316 <citerefentry><refentrytitle>loginctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2317 <citerefentry><refentrytitle>machinectl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2318 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2319 <citerefentry><refentrytitle>systemd.resource-control
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2320 <citerefentry><refentrytitle>systemd.special
</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
2321 <citerefentry project='man-pages'
><refentrytitle>wall
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2322 <citerefentry><refentrytitle>systemd.preset
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2323 <citerefentry><refentrytitle>systemd.generator
</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
2324 <citerefentry project='man-pages'
><refentrytitle>glob
</refentrytitle><manvolnum>7</manvolnum></citerefentry>
projects / thirdparty / systemd.git / blob