1 <?xml version='
1.0'
?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
4 <!ENTITY % entities SYSTEM
"custom-entities.ent" >
9 This file is part of systemd.
11 Copyright 2010 Lennart Poettering
13 systemd is free software; you can redistribute it and/or modify it
14 under the terms of the GNU Lesser General Public License as published by
15 the Free Software Foundation; either version 2.1 of the License, or
16 (at your option) any later version.
18 systemd is distributed in the hope that it will be useful, but
19 WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 Lesser General Public License for more details.
23 You should have received a copy of the GNU Lesser General Public License
24 along with systemd; If not, see <http://www.gnu.org/licenses/>.
27 <refentry id=
"systemctl"
28 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
31 <title>systemctl
</title>
32 <productname>systemd
</productname>
36 <contrib>Developer
</contrib>
37 <firstname>Lennart
</firstname>
38 <surname>Poettering
</surname>
39 <email>lennart@poettering.net
</email>
45 <refentrytitle>systemctl
</refentrytitle>
46 <manvolnum>1</manvolnum>
50 <refname>systemctl
</refname>
51 <refpurpose>Control the systemd system and service manager
</refpurpose>
56 <command>systemctl
</command>
57 <arg choice=
"opt" rep=
"repeat">OPTIONS
</arg>
58 <arg choice=
"plain">COMMAND
</arg>
59 <arg choice=
"opt" rep=
"repeat">NAME
</arg>
64 <title>Description
</title>
66 <para><command>systemctl
</command> may be used to introspect and
67 control the state of the
<literal>systemd
</literal> system and
68 service manager. Please refer to
69 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
70 for an introduction into the basic concepts and functionality this
75 <title>Options
</title>
77 <para>The following options are understood:
</para>
81 <term><option>-t
</option></term>
82 <term><option>--type=
</option></term>
85 <para>The argument should be a comma-separated list of unit
86 types such as
<option>service
</option> and
87 <option>socket
</option>.
90 <para>If one of the arguments is a unit type, when listing
91 units, limit display to certain unit types. Otherwise, units
92 of all types will be shown.
</para>
94 <para>As a special case, if one of the arguments is
95 <option>help
</option>, a list of allowed values will be
96 printed and the program will exit.
</para>
101 <term><option>--state=
</option></term>
104 <para>The argument should be a comma-separated list of unit
105 LOAD, SUB, or ACTIVE states. When listing units, show only
106 those in the specified states. Use
<option>--state=failed
</option>
107 to show only failed units.
</para>
109 <para>As a special case, if one of the arguments is
110 <option>help
</option>, a list of allowed values will be
111 printed and the program will exit.
</para>
116 <term><option>-p
</option></term>
117 <term><option>--property=
</option></term>
120 <para>When showing unit/job/manager properties with the
121 <command>show
</command> command, limit display to properties
122 specified in the argument. The argument should be a
123 comma-separated list of property names, such as
124 <literal>MainPID
</literal>. Unless specified, all known
125 properties are shown. If specified more than once, all
126 properties with the specified names are shown. Shell
127 completion is implemented for property names.
</para>
129 <para>For the manager itself,
130 <command>systemctl show
</command> will show all available
131 properties. Those properties are documented in
132 <citerefentry><refentrytitle>systemd-system.conf
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
135 <para>Properties for units vary by unit type, so showing any
136 unit (even a non-existent one) is a way to list properties
137 pertaining to this type. Similarly, showing any job will list
138 properties pertaining to all jobs. Properties for units are
140 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
141 and the pages for individual unit types
142 <citerefentry><refentrytitle>systemd.service
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
143 <citerefentry><refentrytitle>systemd.socket
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
149 <term><option>-a
</option></term>
150 <term><option>--all
</option></term>
153 <para>When listing units with
<command>list-units
</command>, also show inactive units and
154 units which are following other units. When showing unit/job/manager properties, show all
155 properties regardless whether they are set or not.
</para>
157 <para>To list all units installed in the file system, use the
158 <command>list-unit-files
</command> command instead.
</para>
160 <para>When listing units with
<command>list-dependencies
</command>, recursively show
161 dependencies of all dependent units (by default only dependencies of target units are
167 <term><option>-r
</option></term>
168 <term><option>--recursive
</option></term>
171 <para>When listing units, also show units of local
172 containers. Units of local containers will be prefixed with
173 the container name, separated by a single colon character
174 (
<literal>:
</literal>).
</para>
179 <term><option>--reverse
</option></term>
182 <para>Show reverse dependencies between units with
183 <command>list-dependencies
</command>, i.e. follow
184 dependencies of type
<varname>WantedBy=
</varname>,
185 <varname>RequiredBy=
</varname>,
186 <varname>PartOf=
</varname>,
<varname>BoundBy=
</varname>,
187 instead of
<varname>Wants=
</varname> and similar.
193 <term><option>--after
</option></term>
196 <para>With
<command>list-dependencies
</command>, show the
197 units that are ordered before the specified unit. In other
198 words, recursively list units following the
199 <varname>After=
</varname> dependency.
</para>
201 <para>Note that any
<varname>After=
</varname> dependency is
202 automatically mirrored to create a
203 <varname>Before=
</varname> dependency. Temporal dependencies
204 may be specified explicitly, but are also created implicitly
205 for units which are
<varname>WantedBy=
</varname> targets
207 <citerefentry><refentrytitle>systemd.target
</refentrytitle><manvolnum>5</manvolnum></citerefentry>),
208 and as a result of other directives (for example
209 <varname>RequiresMountsFor=
</varname>). Both explicitly
210 and implicitly introduced dependencies are shown with
211 <command>list-dependencies
</command>.
</para>
213 <para>When passed to the
<command>list-jobs
</command> command, for each printed job show which other jobs are
214 waiting for it. May be combined with
<option>--before
</option> to show both the jobs waiting for each job as
215 well as all jobs each job is waiting for.
</para>
220 <term><option>--before
</option></term>
223 <para>With
<command>list-dependencies
</command>, show the
224 units that are ordered after the specified unit. In other
225 words, recursively list units following the
226 <varname>Before=
</varname> dependency.
</para>
228 <para>When passed to the
<command>list-jobs
</command> command, for each printed job show which other jobs it
229 is waiting for. May be combined with
<option>--after
</option> to show both the jobs waiting for each job as
230 well as all jobs each job is waiting for.
</para>
235 <term><option>-l
</option></term>
236 <term><option>--full
</option></term>
239 <para>Do not ellipsize unit names, process tree entries,
240 journal output, or truncate unit descriptions in the output
241 of
<command>status
</command>,
<command>list-units
</command>,
242 <command>list-jobs
</command>, and
243 <command>list-timers
</command>.
</para>
244 <para>Also, show installation targets in the output of
245 <command>is-enabled
</command>.
</para>
250 <term><option>--value
</option></term>
253 <para>When printing properties with
<command>show
</command>,
254 only print the value, and skip the property name and
255 <literal>=
</literal>.
</para>
260 <term><option>--show-types
</option></term>
263 <para>When showing sockets, show the type of the socket.
</para>
268 <term><option>--job-mode=
</option></term>
271 <para>When queuing a new job, this option controls how to deal with
272 already queued jobs. It takes one of
<literal>fail
</literal>,
273 <literal>replace
</literal>,
274 <literal>replace-irreversibly
</literal>,
275 <literal>isolate
</literal>,
276 <literal>ignore-dependencies
</literal>,
277 <literal>ignore-requirements
</literal> or
278 <literal>flush
</literal>. Defaults to
279 <literal>replace
</literal>, except when the
280 <command>isolate
</command> command is used which implies the
281 <literal>isolate
</literal> job mode.
</para>
283 <para>If
<literal>fail
</literal> is specified and a requested
284 operation conflicts with a pending job (more specifically:
285 causes an already pending start job to be reversed into a stop
286 job or vice versa), cause the operation to fail.
</para>
288 <para>If
<literal>replace
</literal> (the default) is
289 specified, any conflicting pending job will be replaced, as
292 <para>If
<literal>replace-irreversibly
</literal> is specified,
293 operate like
<literal>replace
</literal>, but also mark the new
294 jobs as irreversible. This prevents future conflicting
295 transactions from replacing these jobs (or even being enqueued
296 while the irreversible jobs are still pending). Irreversible
297 jobs can still be cancelled using the
<command>cancel
</command>
300 <para><literal>isolate
</literal> is only valid for start
301 operations and causes all other units to be stopped when the
302 specified unit is started. This mode is always used when the
303 <command>isolate
</command> command is used.
</para>
305 <para><literal>flush
</literal> will cause all queued jobs to
306 be canceled when the new job is enqueued.
</para>
308 <para>If
<literal>ignore-dependencies
</literal> is specified,
309 then all unit dependencies are ignored for this new job and
310 the operation is executed immediately. If passed, no required
311 units of the unit passed will be pulled in, and no ordering
312 dependencies will be honored. This is mostly a debugging and
313 rescue tool for the administrator and should not be used by
316 <para><literal>ignore-requirements
</literal> is similar to
317 <literal>ignore-dependencies
</literal>, but only causes the
318 requirement dependencies to be ignored, the ordering
319 dependencies will still be honored.
</para>
325 <term><option>--fail
</option></term>
328 <para>Shorthand for
<option>--job-mode=
</option>fail.
</para>
329 <para>When used with the
<command>kill
</command> command,
330 if no units were killed, the operation results in an error.
336 <term><option>-i
</option></term>
337 <term><option>--ignore-inhibitors
</option></term>
340 <para>When system shutdown or a sleep state is requested,
341 ignore inhibitor locks. Applications can establish inhibitor
342 locks to avoid that certain important operations (such as CD
343 burning or suchlike) are interrupted by system shutdown or a
344 sleep state. Any user may take these locks and privileged
345 users may override these locks. If any locks are taken,
346 shutdown and sleep state requests will normally fail
347 (regardless of whether privileged or not) and a list of active locks
348 is printed. However, if
<option>--ignore-inhibitors
</option>
349 is specified, the locks are ignored and not printed, and the
350 operation attempted anyway, possibly requiring additional
356 <term><option>-q
</option></term>
357 <term><option>--quiet
</option></term>
360 <para>Suppress printing of the results of various commands
361 and also the hints about truncated log lines. This does not
362 suppress output of commands for which the printed output is
363 the only result (like
<command>show
</command>). Errors are
364 always printed.
</para>
369 <term><option>--no-block
</option></term>
372 <para>Do not synchronously wait for the requested operation
373 to finish. If this is not specified, the job will be
374 verified, enqueued and
<command>systemctl
</command> will
375 wait until the unit's start-up is completed. By passing this
376 argument, it is only verified and enqueued. This option may not be
377 combined with
<option>--wait
</option>.
</para>
382 <term><option>--wait
</option></term>
385 <para>Synchronously wait for started units to terminate again.
386 This option may not be combined with
<option>--no-block
</option>.
387 Note that this will wait forever if any given unit never terminates
388 (by itself or by getting stopped explicitly); particularly services
389 which use
<literal>RemainAfterExit=yes
</literal>.
</para>
393 <xi:include href=
"user-system-options.xml" xpointer=
"user" />
394 <xi:include href=
"user-system-options.xml" xpointer=
"system" />
396 <!-- we do not document -failed here, as it has been made
397 redundant by -state=failed, which it predates. To keep
398 things simple, we only document the new switch, while
399 keeping the old one around for compatibility only. -->
402 <term><option>--no-wall
</option></term>
405 <para>Do not send wall message before halt, power-off,
411 <term><option>--global
</option></term>
414 <para>When used with
<command>enable
</command> and
415 <command>disable
</command>, operate on the global user
416 configuration directory, thus enabling or disabling a unit
417 file globally for all future logins of all users.
</para>
422 <term><option>--no-reload
</option></term>
425 <para>When used with
<command>enable
</command> and
426 <command>disable
</command>, do not implicitly reload daemon
427 configuration after executing the changes.
</para>
432 <term><option>--no-ask-password
</option></term>
435 <para>When used with
<command>start
</command> and related
436 commands, disables asking for passwords. Background services
437 may require input of a password or passphrase string, for
438 example to unlock system hard disks or cryptographic
439 certificates. Unless this option is specified and the
440 command is invoked from a terminal,
441 <command>systemctl
</command> will query the user on the
442 terminal for the necessary secrets. Use this option to
443 switch this behavior off. In this case, the password must be
444 supplied by some other means (for example graphical password
445 agents) or the service might fail. This also disables
446 querying the user for authentication for privileged
452 <term><option>--kill-who=
</option></term>
455 <para>When used with
<command>kill
</command>, choose which
456 processes to send a signal to. Must be one of
457 <option>main
</option>,
<option>control
</option> or
458 <option>all
</option> to select whether to kill only the main
459 process, the control process or all processes of the
460 unit. The main process of the unit is the one that defines
461 the life-time of it. A control process of a unit is one that
462 is invoked by the manager to induce state changes of it. For
463 example, all processes started due to the
464 <varname>ExecStartPre=
</varname>,
465 <varname>ExecStop=
</varname> or
466 <varname>ExecReload=
</varname> settings of service units are
467 control processes. Note that there is only one control
468 process per unit at a time, as only one state change is
469 executed at a time. For services of type
470 <varname>Type=forking
</varname>, the initial process started
471 by the manager for
<varname>ExecStart=
</varname> is a
472 control process, while the process ultimately forked off by
473 that one is then considered the main process of the unit (if
474 it can be determined). This is different for service units
475 of other types, where the process forked off by the manager
476 for
<varname>ExecStart=
</varname> is always the main process
477 itself. A service unit consists of zero or one main process,
478 zero or one control process plus any number of additional
479 processes. Not all unit types manage processes of these
480 types however. For example, for mount units, control processes
481 are defined (which are the invocations of
482 <filename>&MOUNT_PATH;</filename> and
483 <filename>&UMOUNT_PATH;</filename>), but no main process
484 is defined. If omitted, defaults to
485 <option>all
</option>.
</para>
491 <term><option>-s
</option></term>
492 <term><option>--signal=
</option></term>
495 <para>When used with
<command>kill
</command>, choose which
496 signal to send to selected processes. Must be one of the
497 well-known signal specifiers such as
<constant>SIGTERM
</constant>,
<constant>SIGINT
</constant> or
498 <constant>SIGSTOP
</constant>. If omitted, defaults to
499 <option>SIGTERM
</option>.
</para>
504 <term><option>-f
</option></term>
505 <term><option>--force
</option></term>
508 <para>When used with
<command>enable
</command>, overwrite
509 any existing conflicting symlinks.
</para>
511 <para>When used with
<command>edit
</command>, create all of the
512 specified units which do not already exist.
</para>
514 <para>When used with
<command>halt
</command>,
<command>poweroff
</command>,
<command>reboot
</command> or
515 <command>kexec
</command>, execute the selected operation without shutting down all units. However, all
516 processes will be killed forcibly and all file systems are unmounted or remounted read-only. This is hence a
517 drastic but relatively safe option to request an immediate reboot. If
<option>--force
</option> is specified
518 twice for these operations (with the exception of
<command>kexec
</command>), they will be executed
519 immediately, without terminating any processes or unmounting any file systems. Warning: specifying
520 <option>--force
</option> twice with any of these operations might result in data loss. Note that when
521 <option>--force
</option> is specified twice the selected operation is executed by
522 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
523 succeed even when the system manager hangs or crashed.
</para>
528 <term><option>--message=
</option></term>
531 <para>When used with
<command>halt
</command>,
532 <command>poweroff
</command>,
<command>reboot
</command> or
533 <command>kexec
</command>, set a short message explaining the reason
534 for the operation. The message will be logged together with the
535 default shutdown message.
</para>
540 <term><option>--now
</option></term>
543 <para>When used with
<command>enable
</command>, the units
544 will also be started. When used with
<command>disable
</command> or
545 <command>mask
</command>, the units will also be stopped. The start
546 or stop operation is only carried out when the respective enable or
547 disable operation has been successful.
</para>
552 <term><option>--root=
</option></term>
556 <command>enable
</command>/
<command>disable
</command>/
<command>is-enabled
</command>
557 (and related commands), use the specified root path when looking for unit
558 files. If this option is present,
<command>systemctl
</command> will operate on
559 the file system directly, instead of communicating with the
<command>systemd
</command>
560 daemon to carry out changes.
</para>
566 <term><option>--runtime
</option></term>
569 <para>When used with
<command>enable
</command>,
570 <command>disable
</command>,
<command>edit
</command>,
571 (and related commands), make changes only temporarily, so
572 that they are lost on the next reboot. This will have the
573 effect that changes are not made in subdirectories of
574 <filename>/etc
</filename> but in
<filename>/run
</filename>,
575 with identical immediate effects, however, since the latter
576 is lost on reboot, the changes are lost too.
</para>
578 <para>Similarly, when used with
579 <command>set-property
</command>, make changes only
580 temporarily, so that they are lost on the next
586 <term><option>--preset-mode=
</option></term>
589 <para>Takes one of
<literal>full
</literal> (the default),
590 <literal>enable-only
</literal>,
591 <literal>disable-only
</literal>. When used with the
592 <command>preset
</command> or
<command>preset-all
</command>
593 commands, controls whether units shall be disabled and
594 enabled according to the preset rules, or only enabled, or
595 only disabled.
</para>
600 <term><option>-n
</option></term>
601 <term><option>--lines=
</option></term>
604 <para>When used with
<command>status
</command>, controls the
605 number of journal lines to show, counting from the most
606 recent ones. Takes a positive integer argument. Defaults to
612 <term><option>-o
</option></term>
613 <term><option>--output=
</option></term>
616 <para>When used with
<command>status
</command>, controls the
617 formatting of the journal entries that are shown. For the
618 available choices, see
619 <citerefentry><refentrytitle>journalctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
620 Defaults to
<literal>short
</literal>.
</para>
625 <term><option>--firmware-setup
</option></term>
628 <para>When used with the
<command>reboot
</command> command,
629 indicate to the system's firmware to boot into setup
630 mode. Note that this is currently only supported on some EFI
631 systems and only if the system was booted in EFI
637 <term><option>--plain
</option></term>
640 <para>When used with
<command>list-dependencies
</command>,
641 <command>list-units
</command> or
<command>list-machines
</command>,
642 the output is printed as a list instead of a tree, and the bullet
643 circles are omitted.
</para>
647 <xi:include href=
"user-system-options.xml" xpointer=
"host" />
648 <xi:include href=
"user-system-options.xml" xpointer=
"machine" />
650 <xi:include href=
"standard-options.xml" xpointer=
"no-pager" />
651 <xi:include href=
"standard-options.xml" xpointer=
"no-legend" />
652 <xi:include href=
"standard-options.xml" xpointer=
"help" />
653 <xi:include href=
"standard-options.xml" xpointer=
"version" />
658 <title>Commands
</title>
660 <para>The following commands are understood:
</para>
663 <title>Unit Commands
</title>
667 <term><command>list-units
<optional><replaceable>PATTERN
</replaceable>…
</optional></command></term>
670 <para>List units that
<command>systemd
</command> currently has in memory. This includes units that are
671 either referenced directly or through a dependency, units that are pinned by applications programmatically,
672 or units that were active in the past and have failed. By default only units which are active, have pending
673 jobs, or have failed are shown; this can be changed with option
<option>--all
</option>. If one or more
674 <replaceable>PATTERN
</replaceable>s are specified, only units matching one of them are shown. The units
675 that are shown are additionally filtered by
<option>--type=
</option> and
<option>--state=
</option> if those
676 options are specified.
</para>
678 <para>This is the default command.
</para>
683 <term><command>list-sockets
<optional><replaceable>PATTERN
</replaceable>…
</optional></command></term>
686 <para>List socket units currently in memory, ordered by listening address. If one or more
687 <replaceable>PATTERN
</replaceable>s are specified, only socket units matching one of them are
688 shown. Produces output similar to
690 LISTEN UNIT ACTIVATES
691 /dev/initctl systemd-initctl.socket systemd-initctl.service
693 [::]:
22 sshd.socket sshd.service
694 kobject-uevent
1 systemd-udevd-kernel.socket systemd-udevd.service
696 5 sockets listed.
</programlisting>
697 Note: because the addresses might contains spaces, this output
698 is not suitable for programmatic consumption.
701 <para>Also see
<option>--show-types
</option>,
<option>--all
</option>, and
<option>--state=
</option>.
</para>
706 <term><command>list-timers
<optional><replaceable>PATTERN
</replaceable>…
</optional></command></term>
709 <para>List timer units currently in memory, ordered by the time they elapse next. If one or more
710 <replaceable>PATTERN
</replaceable>s are specified, only units matching one of them are shown.
713 <para>Also see
<option>--all
</option> and
<option>--state=
</option>.
</para>
718 <term><command>start
<replaceable>PATTERN
</replaceable>…
</command></term>
721 <para>Start (activate) one or more units specified on the
724 <para>Note that glob patterns operate on the set of primary names of units currently in memory. Units which
725 are not active and are not in a failed state usually are not in memory, and will not be matched by any
726 pattern. In addition, in case of instantiated units, systemd is often unaware of the instance name until
727 the instance has been started. Therefore, using glob patterns with
<command>start
</command> has limited
728 usefulness. Also, secondary alias names of units are not considered.
</para>
732 <term><command>stop
<replaceable>PATTERN
</replaceable>…
</command></term>
735 <para>Stop (deactivate) one or more units specified on the
740 <term><command>reload
<replaceable>PATTERN
</replaceable>…
</command></term>
743 <para>Asks all units listed on the command line to reload
744 their configuration. Note that this will reload the
745 service-specific configuration, not the unit configuration
746 file of systemd. If you want systemd to reload the
747 configuration file of a unit, use the
748 <command>daemon-reload
</command> command. In other words:
749 for the example case of Apache, this will reload Apache's
750 <filename>httpd.conf
</filename> in the web server, not the
751 <filename>apache.service
</filename> systemd unit
754 <para>This command should not be confused with the
755 <command>daemon-reload
</command> command.
</para>
760 <term><command>restart
<replaceable>PATTERN
</replaceable>…
</command></term>
763 <para>Restart one or more units specified on the command
764 line. If the units are not running yet, they will be
769 <term><command>try-restart
<replaceable>PATTERN
</replaceable>…
</command></term>
772 <para>Restart one or more units specified on the command
773 line if the units are running. This does nothing if units are not
775 <!-- Note that we don't document condrestart here, as that is just compatibility support, and we generally
776 don't document that. -->
780 <term><command>reload-or-restart
<replaceable>PATTERN
</replaceable>…
</command></term>
783 <para>Reload one or more units if they support it. If not,
784 restart them instead. If the units are not running yet, they
785 will be started.
</para>
789 <term><command>try-reload-or-restart
<replaceable>PATTERN
</replaceable>…
</command></term>
792 <para>Reload one or more units if they support it. If not,
793 restart them instead. This does nothing if the units are not
795 <!-- Note that we don't document force-reload here, as that is just compatibility support, and we generally
796 don't document that. -->
800 <term><command>isolate
<replaceable>NAME
</replaceable></command></term>
803 <para>Start the unit specified on the command line and its
804 dependencies and stop all others. If a unit name with no
805 extension is given, an extension of
806 <literal>.target
</literal> will be assumed.
</para>
808 <para>This is similar to changing the runlevel in a
809 traditional init system. The
<command>isolate
</command>
810 command will immediately stop processes that are not enabled
811 in the new unit, possibly including the graphical
812 environment or terminal you are currently using.
</para>
814 <para>Note that this is allowed only on units where
815 <option>AllowIsolate=
</option> is enabled. See
816 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
821 <term><command>kill
<replaceable>PATTERN
</replaceable>…
</command></term>
824 <para>Send a signal to one or more processes of the
825 unit. Use
<option>--kill-who=
</option> to select which
826 process to kill. Use
<option>--signal=
</option> to select
827 the signal to send.
</para>
831 <term><command>is-active
<replaceable>PATTERN
</replaceable>…
</command></term>
834 <para>Check whether any of the specified units are active
835 (i.e. running). Returns an exit code
836 <constant>0</constant> if at least one is active, or
837 non-zero otherwise. Unless
<option>--quiet
</option> is
838 specified, this will also print the current unit state to
839 standard output.
</para>
843 <term><command>is-failed
<replaceable>PATTERN
</replaceable>…
</command></term>
846 <para>Check whether any of the specified units are in a
847 "failed" state. Returns an exit code
848 <constant>0</constant> if at least one has failed,
849 non-zero otherwise. Unless
<option>--quiet
</option> is
850 specified, this will also print the current unit state to
851 standard output.
</para>
855 <term><command>status
</command> <optional><replaceable>PATTERN
</replaceable>…|
<replaceable>PID
</replaceable>…]
</optional></term>
858 <para>Show terse runtime status information about one or
859 more units, followed by most recent log data from the
860 journal. If no units are specified, show system status. If
861 combined with
<option>--all
</option>, also show the status of
862 all units (subject to limitations specified with
863 <option>-t
</option>). If a PID is passed, show information
864 about the unit the process belongs to.
</para>
866 <para>This function is intended to generate human-readable
867 output. If you are looking for computer-parsable output,
868 use
<command>show
</command> instead. By default, this
869 function only shows
10 lines of output and ellipsizes
870 lines to fit in the terminal window. This can be changed
871 with
<option>--lines
</option> and
<option>--full
</option>,
872 see above. In addition,
<command>journalctl
873 --unit=
<replaceable>NAME
</replaceable></command> or
875 --user-unit=
<replaceable>NAME
</replaceable></command> use
876 a similar filter for messages and might be more
882 <term><command>show
</command> <optional><replaceable>PATTERN
</replaceable>…|
<replaceable>JOB
</replaceable>…
</optional></term>
885 <para>Show properties of one or more units, jobs, or the
886 manager itself. If no argument is specified, properties of
887 the manager will be shown. If a unit name is specified,
888 properties of the unit are shown, and if a job ID is
889 specified, properties of the job are shown. By default, empty
890 properties are suppressed. Use
<option>--all
</option> to
891 show those too. To select specific properties to show, use
892 <option>--property=
</option>. This command is intended to be
893 used whenever computer-parsable output is required. Use
894 <command>status
</command> if you are looking for formatted
895 human-readable output.
</para>
899 <term><command>cat
<replaceable>PATTERN
</replaceable>…
</command></term>
902 <para>Show backing files of one or more units. Prints the
903 "fragment" and
"drop-ins" (source files) of units. Each
904 file is preceded by a comment which includes the file
905 name. Note that this shows the contents of the backing files
906 on disk, which may not match the system manager's
907 understanding of these units if any unit files were
908 updated on disk and the
<command>daemon-reload
</command>
909 command wasn't issued since.
</para>
913 <term><command>set-property
<replaceable>NAME
</replaceable> <replaceable>ASSIGNMENT
</replaceable>…
</command></term>
916 <para>Set the specified unit properties at runtime where
917 this is supported. This allows changing configuration
918 parameter properties such as resource control settings at
919 runtime. Not all properties may be changed at runtime, but
920 many resource control settings (primarily those in
921 <citerefentry><refentrytitle>systemd.resource-control
</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
922 may. The changes are applied instantly, and stored on disk
923 for future boots, unless
<option>--runtime
</option> is
924 passed, in which case the settings only apply until the
925 next reboot. The syntax of the property assignment follows
926 closely the syntax of assignments in unit files.
</para>
928 <para>Example:
<command>systemctl set-property foobar.service CPUShares=
777</command></para>
930 <para>If the specified unit appears to be inactive, the
931 changes will be only stored on disk as described
932 previously hence they will be effective when the unit will
935 <para>Note that this command allows changing multiple
936 properties at the same time, which is preferable over
937 setting them individually. Like unit file configuration
938 settings, assigning the empty list to list parameters will
939 reset the list.
</para>
944 <term><command>help
<replaceable>PATTERN
</replaceable>…|
<replaceable>PID
</replaceable>…
</command></term>
947 <para>Show manual pages for one or more units, if
948 available. If a PID is given, the manual pages for the unit
949 the process belongs to are shown.
</para>
954 <term><command>reset-failed [
<replaceable>PATTERN
</replaceable>…]
</command></term>
957 <para>Reset the
<literal>failed
</literal> state of the
958 specified units, or if no unit name is passed, reset the state of all
959 units. When a unit fails in some way (i.e. process exiting
960 with non-zero error code, terminating abnormally or timing
961 out), it will automatically enter the
962 <literal>failed
</literal> state and its exit code and status
963 is recorded for introspection by the administrator until the
964 service is restarted or reset with this command.
</para>
970 <command>list-dependencies
</command>
971 <optional><replaceable>NAME
</replaceable></optional>
975 <para>Shows units required and wanted by the specified
976 unit. This recursively lists units following the
977 <varname>Requires=
</varname>,
978 <varname>Requisite=
</varname>,
979 <varname>ConsistsOf=
</varname>,
980 <varname>Wants=
</varname>,
<varname>BindsTo=
</varname>
981 dependencies. If no unit is specified,
982 <filename>default.target
</filename> is implied.
</para>
984 <para>By default, only target units are recursively
985 expanded. When
<option>--all
</option> is passed, all other
986 units are recursively expanded as well.
</para>
988 <para>Options
<option>--reverse
</option>,
989 <option>--after
</option>,
<option>--before
</option>
990 may be used to change what types of dependencies
998 <title>Unit File Commands
</title>
1002 <term><command>list-unit-files
<optional><replaceable>PATTERN…
</replaceable></optional></command></term>
1005 <para>List unit files installed on the system, in combination with their enablement state (as reported by
1006 <command>is-enabled
</command>). If one or more
<replaceable>PATTERN
</replaceable>s are specified, only unit
1007 files whose name matches one of them are shown (patterns matching unit file system paths are not
1013 <term><command>enable
<replaceable>NAME
</replaceable>…
</command></term>
1014 <term><command>enable
<replaceable>PATH
</replaceable>…
</command></term>
1017 <para>Enable one or more units or unit instances. This will create a set of symlinks, as encoded in the
1018 <literal>[Install]
</literal> sections of the indicated unit files. After the symlinks have been created,
1019 the system manager configuration is reloaded (in a way equivalent to
<command>daemon-reload
</command>), in
1020 order to ensure the changes are taken into account immediately. Note that this does
1021 <emphasis>not
</emphasis> have the effect of also starting any of the units being enabled. If this is
1022 desired, combine this command with the
<option>--now
</option> switch, or invoke
<command>start
</command>
1023 with appropriate arguments later. Note that in case of unit instance enablement (i.e. enablement of units of
1024 the form
<filename>foo@bar.service
</filename>), symlinks named the same as instances are created in the
1025 unit configuration directory, however they point to the single template unit file they are instantiated
1028 <para>This command expects either valid unit names (in which case various unit file directories are
1029 automatically searched for unit files with appropriate names), or absolute paths to unit files (in which
1030 case these files are read directly). If a specified unit file is located outside of the usual unit file
1031 directories, an additional symlink is created, linking it into the unit configuration path, thus ensuring
1032 it is found when requested by commands such as
<command>start
</command>.
</para>
1034 <para>This command will print the file system operations executed. This output may be suppressed by passing
1035 <option>--quiet
</option>.
1038 <para>Note that this operation creates only the symlinks suggested in the
<literal>[Install]
</literal>
1039 section of the unit files. While this command is the recommended way to manipulate the unit configuration
1040 directory, the administrator is free to make additional changes manually by placing or removing symlinks
1041 below this directory. This is particularly useful to create configurations that deviate from the suggested
1042 default installation. In this case, the administrator must make sure to invoke
1043 <command>daemon-reload
</command> manually as necessary, in order to ensure the changes are taken into
1047 <para>Enabling units should not be confused with starting (activating) units, as done by the
1048 <command>start
</command> command. Enabling and starting units is orthogonal: units may be enabled without
1049 being started and started without being enabled. Enabling simply hooks the unit into various suggested
1050 places (for example, so that the unit is automatically started on boot or when a particular kind of
1051 hardware is plugged in). Starting actually spawns the daemon process (in case of service units), or binds
1052 the socket (in case of socket units), and so on.
</para>
1054 <para>Depending on whether
<option>--system
</option>,
<option>--user
</option>,
<option>--runtime
</option>,
1055 or
<option>--global
</option> is specified, this enables the unit for the system, for the calling user only,
1056 for only this boot of the system, or for all future logins of all users, or only this boot. Note that in
1057 the last case, no systemd daemon configuration is reloaded.
</para>
1059 <para>Using
<command>enable
</command> on masked units is not supported and results in an error.
</para>
1064 <term><command>disable
<replaceable>NAME
</replaceable>…
</command></term>
1067 <para>Disables one or more units. This removes all symlinks to the unit files backing the specified units
1068 from the unit configuration directory, and hence undoes any changes made by
<command>enable
</command> or
1069 <command>link
</command>. Note that this removes
<emphasis>all
</emphasis> symlinks to matching unit files,
1070 including manually created symlinks, and not just those actually created by
<command>enable
</command> or
1071 <command>link
</command>. Note that while
<command>disable
</command> undoes the effect of
1072 <command>enable
</command>, the two commands are otherwise not symmetric, as
<command>disable
</command> may
1073 remove more symlinks than a prior
<command>enable
</command> invocation of the same unit created.
</para>
1075 <para>This command expects valid unit names only, it does not accept paths to unit files.
</para>
1077 <para>In addition to the units specified as arguments, all units are disabled that are listed in the
1078 <varname>Also=
</varname> setting contained in the
<literal>[Install]
</literal> section of any of the unit
1079 files being operated on.
</para>
1081 <para>This command implicitly reloads the system manager configuration after completing the operation. Note
1082 that this command does not implicitly stop the units that are being disabled. If this is desired, either
1083 combine this command with the
<option>--now
</option> switch, or invoke the
<command>stop
</command> command
1084 with appropriate arguments later.
</para>
1086 <para>This command will print information about the file system operations (symlink removals)
1087 executed. This output may be suppressed by passing
<option>--quiet
</option>.
1090 <para>This command honors
<option>--system
</option>,
<option>--user
</option>,
<option>--runtime
</option>
1091 and
<option>--global
</option> in a similar way as
<command>enable
</command>.
</para>
1096 <term><command>reenable
<replaceable>NAME
</replaceable>…
</command></term>
1099 <para>Reenable one or more units, as specified on the command line. This is a combination of
1100 <command>disable
</command> and
<command>enable
</command> and is useful to reset the symlinks a unit file is
1101 enabled with to the defaults configured in its
<literal>[Install]
</literal> section. This command expects
1102 a unit name only, it does not accept paths to unit files.
</para>
1107 <term><command>preset
<replaceable>NAME
</replaceable>…
</command></term>
1110 <para>Reset the enable/disable status one or more unit files, as specified on
1111 the command line, to the defaults configured in the preset policy files. This
1112 has the same effect as
<command>disable
</command> or
1113 <command>enable
</command>, depending how the unit is listed in the preset
1116 <para>Use
<option>--preset-mode=
</option> to control whether units shall be
1117 enabled and disabled, or only enabled, or only disabled.
</para>
1119 <para>If the unit carries no install information, it will be silently ignored
1120 by this command.
<replaceable>NAME
</replaceable> must be the real unit name,
1121 any alias names are ignored silently.
</para>
1123 <para>For more information on the preset policy format, see
1124 <citerefentry><refentrytitle>systemd.preset
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1125 For more information on the concept of presets, please consult the
1126 <ulink url=
"http://freedesktop.org/wiki/Software/systemd/Preset">Preset
</ulink>
1132 <term><command>preset-all
</command></term>
1135 <para>Resets all installed unit files to the defaults
1136 configured in the preset policy file (see above).
</para>
1138 <para>Use
<option>--preset-mode=
</option> to control
1139 whether units shall be enabled and disabled, or only
1140 enabled, or only disabled.
</para>
1145 <term><command>is-enabled
<replaceable>NAME
</replaceable>…
</command></term>
1148 <para>Checks whether any of the specified unit files are
1149 enabled (as with
<command>enable
</command>). Returns an
1150 exit code of
0 if at least one is enabled, non-zero
1151 otherwise. Prints the current enable status (see table).
1152 To suppress this output, use
<option>--quiet
</option>.
1153 To show installation targets, use
<option>--full
</option>.
1158 <command>is-enabled
</command> output
1165 <entry>Description
</entry>
1166 <entry>Exit Code
</entry>
1171 <entry><literal>enabled
</literal></entry>
1172 <entry morerows='
1'
>Enabled via
<filename>.wants/
</filename>,
<filename>.requires/
</filename> or alias symlinks (permanently in
<filename>/etc/systemd/system/
</filename>, or transiently in
<filename>/run/systemd/system/
</filename>).
</entry>
1173 <entry morerows='
1'
>0</entry>
1176 <entry><literal>enabled-runtime
</literal></entry>
1179 <entry><literal>linked
</literal></entry>
1180 <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>
1181 <entry morerows='
1'
>> 0</entry>
1184 <entry><literal>linked-runtime
</literal></entry>
1187 <entry><literal>masked
</literal></entry>
1188 <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>
1189 <entry morerows='
1'
>> 0</entry>
1192 <entry><literal>masked-runtime
</literal></entry>
1195 <entry><literal>static
</literal></entry>
1196 <entry>The unit file is not enabled, and has no provisions for enabling in the
<literal>[Install]
</literal> unit file section.
</entry>
1200 <entry><literal>indirect
</literal></entry>
1201 <entry>The unit file itself is not enabled, but it has a non-empty
<varname>Also=
</varname> setting in the
<literal>[Install]
</literal> unit file section, listing other unit files that might be enabled.
</entry>
1205 <entry><literal>disabled
</literal></entry>
1206 <entry>The unit file is not enabled, but contains an
<literal>[Install]
</literal> section with installation instructions.
</entry>
1207 <entry>> 0</entry>
1210 <entry><literal>generated
</literal></entry>
1211 <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>
1215 <entry><literal>transient
</literal></entry>
1216 <entry>The unit file has been created dynamically with the runtime API. Transient units may not be enabled.
</entry>
1220 <entry><literal>bad
</literal></entry>
1221 <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>
1222 <entry>> 0</entry>
1232 <term><command>mask
<replaceable>NAME
</replaceable>…
</command></term>
1235 <para>Mask one or more units, as specified on the command line. This will link these unit files to
1236 <filename>/dev/null
</filename>, making it impossible to start them. This is a stronger version of
1237 <command>disable
</command>, since it prohibits all kinds of activation of the unit, including enablement
1238 and manual activation. Use this option with care. This honors the
<option>--runtime
</option> option to only
1239 mask temporarily until the next reboot of the system. The
<option>--now
</option> option may be used to
1240 ensure that the units are also stopped. This command expects valid unit names only, it does not accept unit
1246 <term><command>unmask
<replaceable>NAME
</replaceable>…
</command></term>
1249 <para>Unmask one or more unit files, as specified on the command line. This will undo the effect of
1250 <command>mask
</command>. This command expects valid unit names only, it does not accept unit file
1256 <term><command>link
<replaceable>PATH
</replaceable>…
</command></term>
1259 <para>Link a unit file that is not in the unit file search paths into the unit file search path. This
1260 command expects an absolute path to a unit file. The effect of this may be undone with
1261 <command>disable
</command>. The effect of this command is that a unit file is made available for commands
1262 such as
<command>start
</command>, even though it is not installed directly in the unit search path.
</para>
1267 <term><command>revert
<replaceable>NAME
</replaceable>…
</command></term>
1270 <para>Revert one or more unit files to their vendor versions. This command removes drop-in configuration
1271 files that modify the specified units, as well as any user-configured unit file that overrides a matching
1272 vendor supplied unit file. Specifically, for a unit
<literal>foo.service
</literal> the matching directories
1273 <literal>foo.service.d/
</literal> with all their contained files are removed, both below the persistent and
1274 runtime configuration directories (i.e. below
<filename>/etc/systemd/system
</filename> and
1275 <filename>/run/systemd/system
</filename>); if the unit file has a vendor-supplied version (i.e. a unit file
1276 located below
<filename>/usr
</filename>) any matching persistent or runtime unit file that overrides it is
1277 removed, too. Note that if a unit file has no vendor-supplied version (i.e. is only defined below
1278 <filename>/etc/systemd/system
</filename> or
<filename>/run/systemd/system
</filename>, but not in a unit
1279 file stored below
<filename>/usr
</filename>), then it is not removed. Also, if a unit is masked, it is
1282 <para>Effectively, this command may be used to undo all changes made with
<command>systemctl
1283 edit
</command>,
<command>systemctl set-property
</command> and
<command>systemctl mask
</command> and puts
1284 the original unit file with its settings back in effect.
</para>
1289 <term><command>add-wants
<replaceable>TARGET
</replaceable>
1290 <replaceable>NAME
</replaceable>…
</command></term>
1291 <term><command>add-requires
<replaceable>TARGET
</replaceable>
1292 <replaceable>NAME
</replaceable>…
</command></term>
1295 <para>Adds
<literal>Wants=
</literal> or
<literal>Requires=
</literal>
1296 dependencies, respectively, to the specified
1297 <replaceable>TARGET
</replaceable> for one or more units.
</para>
1299 <para>This command honors
<option>--system
</option>,
1300 <option>--user
</option>,
<option>--runtime
</option> and
1301 <option>--global
</option> in a way similar to
1302 <command>enable
</command>.
</para>
1308 <term><command>edit
<replaceable>NAME
</replaceable>…
</command></term>
1311 <para>Edit a drop-in snippet or a whole replacement file if
1312 <option>--full
</option> is specified, to extend or override the
1313 specified unit.
</para>
1315 <para>Depending on whether
<option>--system
</option> (the default),
1316 <option>--user
</option>, or
<option>--global
</option> is specified,
1317 this command creates a drop-in file for each unit either for the system,
1318 for the calling user, or for all futures logins of all users. Then,
1319 the editor (see the
"Environment" section below) is invoked on
1320 temporary files which will be written to the real location if the
1321 editor exits successfully.
</para>
1323 <para>If
<option>--full
</option> is specified, this will copy the
1324 original units instead of creating drop-in files.
</para>
1326 <para>If
<option>--force
</option> is specified and any units do
1327 not already exist, new unit files will be opened for editing.
</para>
1329 <para>If
<option>--runtime
</option> is specified, the changes will
1330 be made temporarily in
<filename>/run
</filename> and they will be
1331 lost on the next reboot.
</para>
1333 <para>If the temporary file is empty upon exit, the modification of
1334 the related unit is canceled.
</para>
1336 <para>After the units have been edited, systemd configuration is
1337 reloaded (in a way that is equivalent to
<command>daemon-reload
</command>).
1340 <para>Note that this command cannot be used to remotely edit units
1341 and that you cannot temporarily edit units which are in
1342 <filename>/etc
</filename>, since they take precedence over
1343 <filename>/run
</filename>.
</para>
1348 <term><command>get-default
</command></term>
1351 <para>Return the default target to boot into. This returns
1352 the target unit name
<filename>default.target
</filename>
1353 is aliased (symlinked) to.
</para>
1358 <term><command>set-default
<replaceable>NAME
</replaceable></command></term>
1361 <para>Set the default target to boot into. This sets
1362 (symlinks) the
<filename>default.target
</filename> alias
1363 to the given target unit.
</para>
1371 <title>Machine Commands
</title>
1375 <term><command>list-machines
<optional><replaceable>PATTERN
</replaceable>…
</optional></command></term>
1378 <para>List the host and all running local containers with
1379 their state. If one or more
1380 <replaceable>PATTERN
</replaceable>s are specified, only
1381 containers matching one of them are shown.
1389 <title>Job Commands
</title>
1393 <term><command>list-jobs
<optional><replaceable>PATTERN…
</replaceable></optional></command></term>
1396 <para>List jobs that are in progress. If one or more
1397 <replaceable>PATTERN
</replaceable>s are specified, only
1398 jobs for units matching one of them are shown.
</para>
1400 <para>When combined with
<option>--after
</option> or
<option>--before
</option> the list is augmented with
1401 information on which other job each job is waiting for, and which other jobs are waiting for it, see
1406 <term><command>cancel
<replaceable>JOB
</replaceable>…
</command></term>
1409 <para>Cancel one or more jobs specified on the command line
1410 by their numeric job IDs. If no job ID is specified, cancel
1411 all pending jobs.
</para>
1418 <title>Environment Commands
</title>
1422 <term><command>show-environment
</command></term>
1425 <para>Dump the systemd manager environment block. The
1426 environment block will be dumped in straight-forward form
1427 suitable for sourcing into a shell script. This environment
1428 block will be passed to all processes the manager
1433 <term><command>set-environment
<replaceable>VARIABLE=VALUE
</replaceable>…
</command></term>
1436 <para>Set one or more systemd manager environment variables,
1437 as specified on the command line.
</para>
1441 <term><command>unset-environment
<replaceable>VARIABLE
</replaceable>…
</command></term>
1444 <para>Unset one or more systemd manager environment
1445 variables. If only a variable name is specified, it will be
1446 removed regardless of its value. If a variable and a value
1447 are specified, the variable is only removed if it has the
1448 specified value.
</para>
1453 <command>import-environment
</command>
1454 <optional><replaceable>VARIABLE…
</replaceable></optional>
1458 <para>Import all, one or more environment variables set on
1459 the client into the systemd manager environment block. If
1460 no arguments are passed, the entire environment block is
1461 imported. Otherwise, a list of one or more environment
1462 variable names should be passed, whose client-side values
1463 are then imported into the manager's environment
1471 <title>Manager Lifecycle Commands
</title>
1475 <term><command>daemon-reload
</command></term>
1478 <para>Reload the systemd manager configuration. This will
1479 rerun all generators (see
1480 <citerefentry><refentrytitle>systemd.generator
</refentrytitle><manvolnum>7</manvolnum></citerefentry>),
1481 reload all unit files, and recreate the entire dependency
1482 tree. While the daemon is being reloaded, all sockets
1483 systemd listens on behalf of user configuration will stay
1486 <para>This command should not be confused with the
1487 <command>reload
</command> command.
</para>
1491 <term><command>daemon-reexec
</command></term>
1494 <para>Reexecute the systemd manager. This will serialize the
1495 manager state, reexecute the process and deserialize the
1496 state again. This command is of little use except for
1497 debugging and package upgrades. Sometimes, it might be
1498 helpful as a heavy-weight
<command>daemon-reload
</command>.
1499 While the daemon is being reexecuted, all sockets systemd listening
1500 on behalf of user configuration will stay accessible.
1508 <title>System Commands
</title>
1512 <term><command>is-system-running
</command></term>
1515 <para>Checks whether the system is operational. This
1516 returns success (exit code
0) when the system is fully up
1517 and running, specifically not in startup, shutdown or
1518 maintenance mode, and with no failed services. Failure is
1519 returned otherwise (exit code non-zero). In addition, the
1520 current state is printed in a short string to standard
1521 output, see the table below. Use
<option>--quiet
</option> to
1522 suppress this output.
</para>
1525 <title><command>is-system-running
</command> output
</title>
1527 <colspec colname='name'
/>
1528 <colspec colname='description'
/>
1529 <colspec colname='exit-code'
/>
1533 <entry>Description
</entry>
1534 <entry>Exit Code
</entry>
1539 <entry><varname>initializing
</varname></entry>
1540 <entry><para>Early bootup, before
1541 <filename>basic.target
</filename> is reached
1542 or the
<varname>maintenance
</varname> state entered.
1544 <entry>> 0</entry>
1547 <entry><varname>starting
</varname></entry>
1548 <entry><para>Late bootup, before the job queue
1549 becomes idle for the first time, or one of the
1550 rescue targets are reached.
</para></entry>
1551 <entry>> 0</entry>
1554 <entry><varname>running
</varname></entry>
1555 <entry><para>The system is fully
1556 operational.
</para></entry>
1560 <entry><varname>degraded
</varname></entry>
1561 <entry><para>The system is operational but one or more
1562 units failed.
</para></entry>
1563 <entry>> 0</entry>
1566 <entry><varname>maintenance
</varname></entry>
1567 <entry><para>The rescue or emergency target is
1568 active.
</para></entry>
1569 <entry>> 0</entry>
1572 <entry><varname>stopping
</varname></entry>
1573 <entry><para>The manager is shutting
1574 down.
</para></entry>
1575 <entry>> 0</entry>
1578 <entry><varname>offline
</varname></entry>
1579 <entry><para>The manager is not
1580 running. Specifically, this is the operational
1581 state if an incompatible program is running as
1582 system manager (PID
1).
</para></entry>
1583 <entry>> 0</entry>
1586 <entry><varname>unknown
</varname></entry>
1587 <entry><para>The operational state could not be
1588 determined, due to lack of resources or another
1589 error cause.
</para></entry>
1590 <entry>> 0</entry>
1599 <term><command>default
</command></term>
1602 <para>Enter default mode. This is mostly equivalent to
1603 <command>isolate default.target
</command>.
</para>
1608 <term><command>rescue
</command></term>
1611 <para>Enter rescue mode. This is mostly equivalent to
1612 <command>isolate rescue.target
</command>, but also prints a
1613 wall message to all users.
</para>
1617 <term><command>emergency
</command></term>
1620 <para>Enter emergency mode. This is mostly equivalent to
1621 <command>isolate emergency.target
</command>, but also prints
1622 a wall message to all users.
</para>
1626 <term><command>halt
</command></term>
1629 <para>Shut down and halt the system. This is mostly equivalent to
<command>start halt.target
1630 --job-mode=replace-irreversibly
</command>, but also prints a wall message to all users. If combined with
1631 <option>--force
</option>, shutdown of all running services is skipped, however all processes are killed and
1632 all file systems are unmounted or mounted read-only, immediately followed by the system halt. If
1633 <option>--force
</option> is specified twice, the operation is immediately executed without terminating any
1634 processes or unmounting any file systems. This may result in data loss. Note that when
1635 <option>--force
</option> is specified twice the halt operation is executed by
1636 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
1637 succeed even when the system manager hangs or crashed.
</para>
1641 <term><command>poweroff
</command></term>
1644 <para>Shut down and power-off the system. This is mostly equivalent to
<command>start poweroff.target
1645 --job-mode=replace-irreversibly
</command>, but also prints a wall message to all users. If combined with
1646 <option>--force
</option>, shutdown of all running services is skipped, however all processes are killed and
1647 all file systems are unmounted or mounted read-only, immediately followed by the powering off. If
1648 <option>--force
</option> is specified twice, the operation is immediately executed without terminating any
1649 processes or unmounting any file systems. This may result in data loss. Note that when
1650 <option>--force
</option> is specified twice the power-off operation is executed by
1651 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
1652 succeed even when the system manager hangs or crashed.
</para>
1656 <term><command>reboot
<optional><replaceable>arg
</replaceable></optional></command></term>
1659 <para>Shut down and reboot the system. This is mostly equivalent to
<command>start reboot.target
1660 --job-mode=replace-irreversibly
</command>, but also prints a wall message to all users. If combined with
1661 <option>--force
</option>, shutdown of all running services is skipped, however all processes are killed and
1662 all file systems are unmounted or mounted read-only, immediately followed by the reboot. If
1663 <option>--force
</option> is specified twice, the operation is immediately executed without terminating any
1664 processes or unmounting any file systems. This may result in data loss. Note that when
1665 <option>--force
</option> is specified twice the reboot operation is executed by
1666 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
1667 succeed even when the system manager hangs or crashed.
</para>
1669 <para>If the optional argument
1670 <replaceable>arg
</replaceable> is given, it will be passed
1671 as the optional argument to the
1672 <citerefentry><refentrytitle>reboot
</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1673 system call. The value is architecture and firmware
1674 specific. As an example,
<literal>recovery
</literal> might
1675 be used to trigger system recovery, and
1676 <literal>fota
</literal> might be used to trigger a
1677 <quote>firmware over the air
</quote> update.
</para>
1682 <term><command>kexec
</command></term>
1685 <para>Shut down and reboot the system via kexec. This is
1686 mostly equivalent to
<command>start kexec.target --job-mode=replace-irreversibly
</command>,
1687 but also prints a wall message to all users. If combined
1688 with
<option>--force
</option>, shutdown of all running
1689 services is skipped, however all processes are killed and
1690 all file systems are unmounted or mounted read-only,
1691 immediately followed by the reboot.
</para>
1696 <term><command>exit
<optional><replaceable>EXIT_CODE
</replaceable></optional></command></term>
1699 <para>Ask the systemd manager to quit. This is only
1700 supported for user service managers (i.e. in conjunction
1701 with the
<option>--user
</option> option) or in containers
1702 and is equivalent to
<command>poweroff
</command> otherwise.
</para>
1704 <para>The systemd manager can exit with a non-zero exit
1705 code if the optional argument
1706 <replaceable>EXIT_CODE
</replaceable> is given.
</para>
1711 <term><command>switch-root
<replaceable>ROOT
</replaceable> <optional><replaceable>INIT
</replaceable></optional></command></term>
1714 <para>Switches to a different root directory and executes a new system manager process below it. This is
1715 intended for usage in initial RAM disks (
"initrd"), and will transition from the initrd's system manager
1716 process (a.k.a.
"init" process) to the main system manager process which is loaded from the actual host
1717 volume. This call takes two arguments: the directory that is to become the new root directory, and the path
1718 to the new system manager binary below it to execute as PID
1. If the latter is omitted or the empty
1719 string, a systemd binary will automatically be searched for and used as init. If the system manager path is
1720 omitted, equal to the empty string or identical to the path to the systemd binary, the state of the
1721 initrd's system manager process is passed to the main system manager, which allows later introspection of
1722 the state of the services involved in the initrd boot phase.
</para>
1727 <term><command>suspend
</command></term>
1730 <para>Suspend the system. This will trigger activation of
1731 the special
<filename>suspend.target
</filename> target.
1737 <term><command>hibernate
</command></term>
1740 <para>Hibernate the system. This will trigger activation of
1741 the special
<filename>hibernate.target
</filename> target.
1747 <term><command>hybrid-sleep
</command></term>
1750 <para>Hibernate and suspend the system. This will trigger
1751 activation of the special
1752 <filename>hybrid-sleep.target
</filename> target.
</para>
1759 <title>Parameter Syntax
</title>
1761 <para>Unit commands listed above take either a single unit name (designated as
<replaceable>NAME
</replaceable>),
1762 or multiple unit specifications (designated as
<replaceable>PATTERN
</replaceable>…). In the first case, the
1763 unit name with or without a suffix must be given. If the suffix is not specified (unit name is
"abbreviated"),
1764 systemctl will append a suitable suffix,
<literal>.service
</literal> by default, and a type-specific suffix in
1765 case of commands which operate only on specific unit types. For example,
1766 <programlisting># systemctl start sshd
</programlisting> and
1767 <programlisting># systemctl start sshd.service
</programlisting>
1768 are equivalent, as are
1769 <programlisting># systemctl isolate default
</programlisting>
1771 <programlisting># systemctl isolate default.target
</programlisting>
1772 Note that (absolute) paths to device nodes are automatically converted to device unit names, and other (absolute)
1773 paths to mount unit names.
1774 <programlisting># systemctl status /dev/sda
1775 # systemctl status /home
</programlisting>
1777 <programlisting># systemctl status dev-sda.device
1778 # systemctl status home.mount
</programlisting>
1779 In the second case, shell-style globs will be matched against the primary names of all units currently in memory;
1780 literal unit names, with or without a suffix, will be treated as in the first case. This means that literal unit
1781 names always refer to exactly one unit, but globs may match zero units and this is not considered an
1784 <para>Glob patterns use
1785 <citerefentry project='man-pages'
><refentrytitle>fnmatch
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
1786 so normal shell-style globbing rules are used, and
1787 <literal>*
</literal>,
<literal>?
</literal>,
1788 <literal>[]
</literal> may be used. See
1789 <citerefentry project='man-pages'
><refentrytitle>glob
</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1790 for more details. The patterns are matched against the primary names of
1791 units currently in memory, and patterns which do not match anything
1792 are silently skipped. For example:
1793 <programlisting># systemctl stop sshd@*.service
</programlisting>
1794 will stop all
<filename>sshd@.service
</filename> instances. Note that alias names of units, and units that aren't
1795 in memory are not considered for glob expansion.
1798 <para>For unit file commands, the specified
<replaceable>NAME
</replaceable> should be the name of the unit file
1799 (possibly abbreviated, see above), or the absolute path to the unit file:
1800 <programlisting># systemctl enable foo.service
</programlisting>
1802 <programlisting># systemctl link /path/to/foo.service
</programlisting>
1809 <title>Exit status
</title>
1811 <para>On success,
0 is returned, a non-zero failure
1812 code otherwise.
</para>
1816 <title>Environment
</title>
1818 <variablelist class='environment-variables'
>
1820 <term><varname>$SYSTEMD_EDITOR
</varname></term>
1822 <listitem><para>Editor to use when editing units; overrides
1823 <varname>$EDITOR
</varname> and
<varname>$VISUAL
</varname>. If neither
1824 <varname>$SYSTEMD_EDITOR
</varname> nor
<varname>$EDITOR
</varname> nor
1825 <varname>$VISUAL
</varname> are present or if it is set to an empty
1826 string or if their execution failed, systemctl will try to execute well
1827 known editors in this order:
1828 <citerefentry project='die-net'
><refentrytitle>editor
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1829 <citerefentry project='die-net'
><refentrytitle>nano
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1830 <citerefentry project='die-net'
><refentrytitle>vim
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1831 <citerefentry project='die-net'
><refentrytitle>vi
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
1835 <xi:include href=
"less-variables.xml" xpointer=
"pager"/>
1836 <xi:include href=
"less-variables.xml" xpointer=
"less"/>
1837 <xi:include href=
"less-variables.xml" xpointer=
"lesscharset"/>
1841 <title>See Also
</title>
1843 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1844 <citerefentry><refentrytitle>journalctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1845 <citerefentry><refentrytitle>loginctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1846 <citerefentry><refentrytitle>machinectl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1847 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1848 <citerefentry><refentrytitle>systemd.resource-control
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1849 <citerefentry><refentrytitle>systemd.special
</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1850 <citerefentry project='man-pages'
><refentrytitle>wall
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1851 <citerefentry><refentrytitle>systemd.preset
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1852 <citerefentry><refentrytitle>systemd.generator
</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1853 <citerefentry project='man-pages'
><refentrytitle>glob
</refentrytitle><manvolnum>7</manvolnum></citerefentry>
projects / thirdparty / systemd.git / blob