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>
216 <term><option>--before
</option></term>
219 <para>With
<command>list-dependencies
</command>, show the
220 units that are ordered after the specified unit. In other
221 words, recursively list units following the
222 <varname>Before=
</varname> dependency.
</para>
227 <term><option>-l
</option></term>
228 <term><option>--full
</option></term>
231 <para>Do not ellipsize unit names, process tree entries,
232 journal output, or truncate unit descriptions in the output
233 of
<command>status
</command>,
<command>list-units
</command>,
234 <command>list-jobs
</command>, and
235 <command>list-timers
</command>.
</para>
240 <term><option>--value
</option></term>
243 <para>When printing properties with
<command>show
</command>,
244 only print the value, and skip the property name and
245 <literal>=
</literal>.
</para>
250 <term><option>--show-types
</option></term>
253 <para>When showing sockets, show the type of the socket.
</para>
258 <term><option>--job-mode=
</option></term>
261 <para>When queuing a new job, this option controls how to deal with
262 already queued jobs. It takes one of
<literal>fail
</literal>,
263 <literal>replace
</literal>,
264 <literal>replace-irreversibly
</literal>,
265 <literal>isolate
</literal>,
266 <literal>ignore-dependencies
</literal>,
267 <literal>ignore-requirements
</literal> or
268 <literal>flush
</literal>. Defaults to
269 <literal>replace
</literal>, except when the
270 <command>isolate
</command> command is used which implies the
271 <literal>isolate
</literal> job mode.
</para>
273 <para>If
<literal>fail
</literal> is specified and a requested
274 operation conflicts with a pending job (more specifically:
275 causes an already pending start job to be reversed into a stop
276 job or vice versa), cause the operation to fail.
</para>
278 <para>If
<literal>replace
</literal> (the default) is
279 specified, any conflicting pending job will be replaced, as
282 <para>If
<literal>replace-irreversibly
</literal> is specified,
283 operate like
<literal>replace
</literal>, but also mark the new
284 jobs as irreversible. This prevents future conflicting
285 transactions from replacing these jobs (or even being enqueued
286 while the irreversible jobs are still pending). Irreversible
287 jobs can still be cancelled using the
<command>cancel
</command>
290 <para><literal>isolate
</literal> is only valid for start
291 operations and causes all other units to be stopped when the
292 specified unit is started. This mode is always used when the
293 <command>isolate
</command> command is used.
</para>
295 <para><literal>flush
</literal> will cause all queued jobs to
296 be canceled when the new job is enqueued.
</para>
298 <para>If
<literal>ignore-dependencies
</literal> is specified,
299 then all unit dependencies are ignored for this new job and
300 the operation is executed immediately. If passed, no required
301 units of the unit passed will be pulled in, and no ordering
302 dependencies will be honored. This is mostly a debugging and
303 rescue tool for the administrator and should not be used by
306 <para><literal>ignore-requirements
</literal> is similar to
307 <literal>ignore-dependencies
</literal>, but only causes the
308 requirement dependencies to be ignored, the ordering
309 dependencies will still be honoured.
</para>
315 <term><option>--fail
</option></term>
318 <para>Shorthand for
<option>--job-mode=
</option>fail.
</para>
319 <para>When used with the
<command>kill
</command> command,
320 if no units were killed, the operation results in an error.
326 <term><option>-i
</option></term>
327 <term><option>--ignore-inhibitors
</option></term>
330 <para>When system shutdown or a sleep state is requested,
331 ignore inhibitor locks. Applications can establish inhibitor
332 locks to avoid that certain important operations (such as CD
333 burning or suchlike) are interrupted by system shutdown or a
334 sleep state. Any user may take these locks and privileged
335 users may override these locks. If any locks are taken,
336 shutdown and sleep state requests will normally fail
337 (regardless of whether privileged or not) and a list of active locks
338 is printed. However, if
<option>--ignore-inhibitors
</option>
339 is specified, the locks are ignored and not printed, and the
340 operation attempted anyway, possibly requiring additional
346 <term><option>-q
</option></term>
347 <term><option>--quiet
</option></term>
350 <para>Suppress printing of the results of various commands
351 and also the hints about truncated log lines. This does not
352 suppress output of commands for which the printed output is
353 the only result (like
<command>show
</command>). Errors are
354 always printed.
</para>
359 <term><option>--no-block
</option></term>
362 <para>Do not synchronously wait for the requested operation
363 to finish. If this is not specified, the job will be
364 verified, enqueued and
<command>systemctl
</command> will
365 wait until the unit's start-up is completed. By passing this
366 argument, it is only verified and enqueued.
</para>
370 <xi:include href=
"user-system-options.xml" xpointer=
"user" />
371 <xi:include href=
"user-system-options.xml" xpointer=
"system" />
373 <!-- we do not document -failed here, as it has been made
374 redundant by -state=failed, which it predates. To keep
375 things simple, we only document the new switch, while
376 keeping the old one around for compatibility only. -->
379 <term><option>--no-wall
</option></term>
382 <para>Do not send wall message before halt, power-off,
388 <term><option>--global
</option></term>
391 <para>When used with
<command>enable
</command> and
392 <command>disable
</command>, operate on the global user
393 configuration directory, thus enabling or disabling a unit
394 file globally for all future logins of all users.
</para>
399 <term><option>--no-reload
</option></term>
402 <para>When used with
<command>enable
</command> and
403 <command>disable
</command>, do not implicitly reload daemon
404 configuration after executing the changes.
</para>
409 <term><option>--no-ask-password
</option></term>
412 <para>When used with
<command>start
</command> and related
413 commands, disables asking for passwords. Background services
414 may require input of a password or passphrase string, for
415 example to unlock system hard disks or cryptographic
416 certificates. Unless this option is specified and the
417 command is invoked from a terminal,
418 <command>systemctl
</command> will query the user on the
419 terminal for the necessary secrets. Use this option to
420 switch this behavior off. In this case, the password must be
421 supplied by some other means (for example graphical password
422 agents) or the service might fail. This also disables
423 querying the user for authentication for privileged
429 <term><option>--kill-who=
</option></term>
432 <para>When used with
<command>kill
</command>, choose which
433 processes to send a signal to. Must be one of
434 <option>main
</option>,
<option>control
</option> or
435 <option>all
</option> to select whether to kill only the main
436 process, the control process or all processes of the
437 unit. The main process of the unit is the one that defines
438 the life-time of it. A control process of a unit is one that
439 is invoked by the manager to induce state changes of it. For
440 example, all processes started due to the
441 <varname>ExecStartPre=
</varname>,
442 <varname>ExecStop=
</varname> or
443 <varname>ExecReload=
</varname> settings of service units are
444 control processes. Note that there is only one control
445 process per unit at a time, as only one state change is
446 executed at a time. For services of type
447 <varname>Type=forking
</varname>, the initial process started
448 by the manager for
<varname>ExecStart=
</varname> is a
449 control process, while the process ultimately forked off by
450 that one is then considered the main process of the unit (if
451 it can be determined). This is different for service units
452 of other types, where the process forked off by the manager
453 for
<varname>ExecStart=
</varname> is always the main process
454 itself. A service unit consists of zero or one main process,
455 zero or one control process plus any number of additional
456 processes. Not all unit types manage processes of these
457 types however. For example, for mount units, control processes
458 are defined (which are the invocations of
459 <filename>&MOUNT_PATH;</filename> and
460 <filename>&UMOUNT_PATH;</filename>), but no main process
461 is defined. If omitted, defaults to
462 <option>all
</option>.
</para>
468 <term><option>-s
</option></term>
469 <term><option>--signal=
</option></term>
472 <para>When used with
<command>kill
</command>, choose which
473 signal to send to selected processes. Must be one of the
474 well-known signal specifiers such as
<constant>SIGTERM
</constant>,
<constant>SIGINT
</constant> or
475 <constant>SIGSTOP
</constant>. If omitted, defaults to
476 <option>SIGTERM
</option>.
</para>
481 <term><option>-f
</option></term>
482 <term><option>--force
</option></term>
485 <para>When used with
<command>enable
</command>, overwrite
486 any existing conflicting symlinks.
</para>
488 <para>When used with
<command>edit
</command>, create all of the
489 specified units which do not already exist.
</para>
491 <para>When used with
<command>halt
</command>,
<command>poweroff
</command>,
<command>reboot
</command> or
492 <command>kexec
</command>, execute the selected operation without shutting down all units. However, all
493 processes will be killed forcibly and all file systems are unmounted or remounted read-only. This is hence a
494 drastic but relatively safe option to request an immediate reboot. If
<option>--force
</option> is specified
495 twice for these operations (with the exception of
<command>kexec
</command>), they will be executed
496 immediately, without terminating any processes or unmounting any file systems. Warning: specifying
497 <option>--force
</option> twice with any of these operations might result in data loss. Note that when
498 <option>--force
</option> is specified twice the selected operation is executed by
499 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
500 succeed even when the system manager hangs or crashed.
</para>
505 <term><option>--message=
</option></term>
508 <para>When used with
<command>halt
</command>,
509 <command>poweroff
</command>,
<command>reboot
</command> or
510 <command>kexec
</command>, set a short message explaining the reason
511 for the operation. The message will be logged together with the
512 default shutdown message.
</para>
517 <term><option>--now
</option></term>
520 <para>When used with
<command>enable
</command>, the units
521 will also be started. When used with
<command>disable
</command> or
522 <command>mask
</command>, the units will also be stopped. The start
523 or stop operation is only carried out when the respective enable or
524 disable operation has been successful.
</para>
529 <term><option>--root=
</option></term>
533 <command>enable
</command>/
<command>disable
</command>/
<command>is-enabled
</command>
534 (and related commands), use an alternate root path when
535 looking for unit files.
</para>
541 <term><option>--runtime
</option></term>
544 <para>When used with
<command>enable
</command>,
545 <command>disable
</command>,
<command>edit
</command>,
546 (and related commands), make changes only temporarily, so
547 that they are lost on the next reboot. This will have the
548 effect that changes are not made in subdirectories of
549 <filename>/etc
</filename> but in
<filename>/run
</filename>,
550 with identical immediate effects, however, since the latter
551 is lost on reboot, the changes are lost too.
</para>
553 <para>Similarly, when used with
554 <command>set-property
</command>, make changes only
555 temporarily, so that they are lost on the next
561 <term><option>--preset-mode=
</option></term>
564 <para>Takes one of
<literal>full
</literal> (the default),
565 <literal>enable-only
</literal>,
566 <literal>disable-only
</literal>. When used with the
567 <command>preset
</command> or
<command>preset-all
</command>
568 commands, controls whether units shall be disabled and
569 enabled according to the preset rules, or only enabled, or
570 only disabled.
</para>
575 <term><option>-n
</option></term>
576 <term><option>--lines=
</option></term>
579 <para>When used with
<command>status
</command>, controls the
580 number of journal lines to show, counting from the most
581 recent ones. Takes a positive integer argument. Defaults to
587 <term><option>-o
</option></term>
588 <term><option>--output=
</option></term>
591 <para>When used with
<command>status
</command>, controls the
592 formatting of the journal entries that are shown. For the
593 available choices, see
594 <citerefentry><refentrytitle>journalctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
595 Defaults to
<literal>short
</literal>.
</para>
600 <term><option>--firmware-setup
</option></term>
603 <para>When used with the
<command>reboot
</command> command,
604 indicate to the system's firmware to boot into setup
605 mode. Note that this is currently only supported on some EFI
606 systems and only if the system was booted in EFI
612 <term><option>--plain
</option></term>
615 <para>When used with
<command>list-dependencies
</command>,
616 <command>list-units
</command> or
<command>list-machines
</command>, the
617 the output is printed as a list instead of a tree, and the bullet
618 circles are omitted.
</para>
622 <xi:include href=
"user-system-options.xml" xpointer=
"host" />
623 <xi:include href=
"user-system-options.xml" xpointer=
"machine" />
625 <xi:include href=
"standard-options.xml" xpointer=
"no-pager" />
626 <xi:include href=
"standard-options.xml" xpointer=
"no-legend" />
627 <xi:include href=
"standard-options.xml" xpointer=
"help" />
628 <xi:include href=
"standard-options.xml" xpointer=
"version" />
633 <title>Commands
</title>
635 <para>The following commands are understood:
</para>
638 <title>Unit Commands
</title>
642 <term><command>list-units
<optional><replaceable>PATTERN
</replaceable>...
</optional></command></term>
645 <para>List units that
<command>systemd
</command> has loaded. This includes units that
646 are either referenced directly or through a dependency, or units that were active in the
647 past and have failed. By default only units which are active, have pending jobs, or have
648 failed are shown; this can be changed with option
<option>--all
</option>. If one or more
649 <replaceable>PATTERN
</replaceable>s are specified, only units matching one of them are
650 shown. The units that are shown are additionally filtered by
<option>--type=
</option>
651 and
<option>--state=
</option> if those options are specified.
</para>
653 <para>This is the default command.
</para>
658 <term><command>list-sockets
<optional><replaceable>PATTERN
</replaceable>...
</optional></command></term>
661 <para>List socket units ordered by listening address.
662 If one or more
<replaceable>PATTERN
</replaceable>s are
663 specified, only socket units matching one of them are
664 shown. Produces output similar to
666 LISTEN UNIT ACTIVATES
667 /dev/initctl systemd-initctl.socket systemd-initctl.service
669 [::]:
22 sshd.socket sshd.service
670 kobject-uevent
1 systemd-udevd-kernel.socket systemd-udevd.service
672 5 sockets listed.
</programlisting>
673 Note: because the addresses might contains spaces, this output
674 is not suitable for programmatic consumption.
677 <para>See also the options
<option>--show-types
</option>,
678 <option>--all
</option>, and
<option>--state=
</option>.
</para>
683 <term><command>list-timers
<optional><replaceable>PATTERN
</replaceable>...
</optional></command></term>
686 <para>List timer units ordered by the time they elapse
687 next. If one or more
<replaceable>PATTERN
</replaceable>s
688 are specified, only units matching one of them are shown.
691 <para>See also the options
<option>--all
</option> and
692 <option>--state=
</option>.
</para>
697 <term><command>start
<replaceable>PATTERN
</replaceable>...
</command></term>
700 <para>Start (activate) one or more units specified on the
703 <para>Note that glob patterns operate on the set of primary names of currently loaded units. Units which
704 are not active and are not in a failed state usually are not loaded, and will not be matched by any
705 pattern. In addition, in case of instantiated units, systemd is often unaware of the instance name until
706 the instance has been started. Therefore, using glob patterns with
<command>start
</command> has limited
707 usefulness. Also, secondary alias names of units are not considered.
</para>
711 <term><command>stop
<replaceable>PATTERN
</replaceable>...
</command></term>
714 <para>Stop (deactivate) one or more units specified on the
719 <term><command>reload
<replaceable>PATTERN
</replaceable>...
</command></term>
722 <para>Asks all units listed on the command line to reload
723 their configuration. Note that this will reload the
724 service-specific configuration, not the unit configuration
725 file of systemd. If you want systemd to reload the
726 configuration file of a unit, use the
727 <command>daemon-reload
</command> command. In other words:
728 for the example case of Apache, this will reload Apache's
729 <filename>httpd.conf
</filename> in the web server, not the
730 <filename>apache.service
</filename> systemd unit
733 <para>This command should not be confused with the
734 <command>daemon-reload
</command> command.
</para>
739 <term><command>restart
<replaceable>PATTERN
</replaceable>...
</command></term>
742 <para>Restart one or more units specified on the command
743 line. If the units are not running yet, they will be
748 <term><command>try-restart
<replaceable>PATTERN
</replaceable>...
</command></term>
751 <para>Restart one or more units specified on the command
752 line if the units are running. This does nothing if units are not
754 <!-- Note that we don't document condrestart here, as that is just compatibility support, and we generally
755 don't document that. -->
759 <term><command>reload-or-restart
<replaceable>PATTERN
</replaceable>...
</command></term>
762 <para>Reload one or more units if they support it. If not,
763 restart them instead. If the units are not running yet, they
764 will be started.
</para>
768 <term><command>try-reload-or-restart
<replaceable>PATTERN
</replaceable>...
</command></term>
771 <para>Reload one or more units if they support it. If not,
772 restart them instead. This does nothing if the units are not
774 <!-- Note that we don't document force-reload here, as that is just compatibility support, and we generally
775 don't document that. -->
779 <term><command>isolate
<replaceable>NAME
</replaceable></command></term>
782 <para>Start the unit specified on the command line and its
783 dependencies and stop all others. If a unit name with no
784 extension is given, an extension of
785 <literal>.target
</literal> will be assumed.
</para>
787 <para>This is similar to changing the runlevel in a
788 traditional init system. The
<command>isolate
</command>
789 command will immediately stop processes that are not enabled
790 in the new unit, possibly including the graphical
791 environment or terminal you are currently using.
</para>
793 <para>Note that this is allowed only on units where
794 <option>AllowIsolate=
</option> is enabled. See
795 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
800 <term><command>kill
<replaceable>PATTERN
</replaceable>...
</command></term>
803 <para>Send a signal to one or more processes of the
804 unit. Use
<option>--kill-who=
</option> to select which
805 process to kill. Use
<option>--signal=
</option> to select
806 the signal to send.
</para>
810 <term><command>is-active
<replaceable>PATTERN
</replaceable>...
</command></term>
813 <para>Check whether any of the specified units are active
814 (i.e. running). Returns an exit code
815 <constant>0</constant> if at least one is active, or
816 non-zero otherwise. Unless
<option>--quiet
</option> is
817 specified, this will also print the current unit state to
818 standard output.
</para>
822 <term><command>is-failed
<replaceable>PATTERN
</replaceable>...
</command></term>
825 <para>Check whether any of the specified units are in a
826 "failed" state. Returns an exit code
827 <constant>0</constant> if at least one has failed,
828 non-zero otherwise. Unless
<option>--quiet
</option> is
829 specified, this will also print the current unit state to
830 standard output.
</para>
834 <term><command>status
</command> <optional><replaceable>PATTERN
</replaceable>...|
<replaceable>PID
</replaceable>...]
</optional></term>
837 <para>Show terse runtime status information about one or
838 more units, followed by most recent log data from the
839 journal. If no units are specified, show system status. If
840 combined with
<option>--all
</option>, also show the status of
841 all units (subject to limitations specified with
842 <option>-t
</option>). If a PID is passed, show information
843 about the unit the process belongs to.
</para>
845 <para>This function is intended to generate human-readable
846 output. If you are looking for computer-parsable output,
847 use
<command>show
</command> instead. By default, this
848 function only shows
10 lines of output and ellipsizes
849 lines to fit in the terminal window. This can be changed
850 with
<option>--lines
</option> and
<option>--full
</option>,
851 see above. In addition,
<command>journalctl
852 --unit=
<replaceable>NAME
</replaceable></command> or
854 --user-unit=
<replaceable>NAME
</replaceable></command> use
855 a similar filter for messages and might be more
861 <term><command>show
</command> <optional><replaceable>PATTERN
</replaceable>...|
<replaceable>JOB
</replaceable>...
</optional></term>
864 <para>Show properties of one or more units, jobs, or the
865 manager itself. If no argument is specified, properties of
866 the manager will be shown. If a unit name is specified,
867 properties of the unit is shown, and if a job ID is
868 specified, properties of the job is shown. By default, empty
869 properties are suppressed. Use
<option>--all
</option> to
870 show those too. To select specific properties to show, use
871 <option>--property=
</option>. This command is intended to be
872 used whenever computer-parsable output is required. Use
873 <command>status
</command> if you are looking for formatted
874 human-readable output.
</para>
878 <term><command>cat
<replaceable>PATTERN
</replaceable>...
</command></term>
881 <para>Show backing files of one or more units. Prints the
882 "fragment" and
"drop-ins" (source files) of units. Each
883 file is preceded by a comment which includes the file
888 <term><command>set-property
<replaceable>NAME
</replaceable> <replaceable>ASSIGNMENT
</replaceable>...
</command></term>
891 <para>Set the specified unit properties at runtime where
892 this is supported. This allows changing configuration
893 parameter properties such as resource control settings at
894 runtime. Not all properties may be changed at runtime, but
895 many resource control settings (primarily those in
896 <citerefentry><refentrytitle>systemd.resource-control
</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
897 may. The changes are applied instantly, and stored on disk
898 for future boots, unless
<option>--runtime
</option> is
899 passed, in which case the settings only apply until the
900 next reboot. The syntax of the property assignment follows
901 closely the syntax of assignments in unit files.
</para>
903 <para>Example:
<command>systemctl set-property foobar.service CPUShares=
777</command></para>
905 <para>If the specified unit appears to be inactive, the
906 changes will be only stored on disk as described
907 previously hence they will be effective when the unit will
910 <para>Note that this command allows changing multiple
911 properties at the same time, which is preferable over
912 setting them individually. Like unit file configuration
913 settings, assigning the empty list to list parameters will
914 reset the list.
</para>
919 <term><command>help
<replaceable>PATTERN
</replaceable>...|
<replaceable>PID
</replaceable>...
</command></term>
922 <para>Show manual pages for one or more units, if
923 available. If a PID is given, the manual pages for the unit
924 the process belongs to are shown.
</para>
929 <term><command>reset-failed [
<replaceable>PATTERN
</replaceable>...]
</command></term>
932 <para>Reset the
<literal>failed
</literal> state of the
933 specified units, or if no unit name is passed, reset the state of all
934 units. When a unit fails in some way (i.e. process exiting
935 with non-zero error code, terminating abnormally or timing
936 out), it will automatically enter the
937 <literal>failed
</literal> state and its exit code and status
938 is recorded for introspection by the administrator until the
939 service is restarted or reset with this command.
</para>
945 <command>list-dependencies
</command>
946 <optional><replaceable>NAME
</replaceable></optional>
950 <para>Shows units required and wanted by the specified
951 unit. This recursively lists units following the
952 <varname>Requires=
</varname>,
953 <varname>Requisite=
</varname>,
954 <varname>ConsistsOf=
</varname>,
955 <varname>Wants=
</varname>,
<varname>BindsTo=
</varname>
956 dependencies. If no unit is specified,
957 <filename>default.target
</filename> is implied.
</para>
959 <para>By default, only target units are recursively
960 expanded. When
<option>--all
</option> is passed, all other
961 units are recursively expanded as well.
</para>
963 <para>Options
<option>--reverse
</option>,
964 <option>--after
</option>,
<option>--before
</option>
965 may be used to change what types of dependencies
973 <title>Unit File Commands
</title>
977 <term><command>list-unit-files
<optional><replaceable>PATTERN...
</replaceable></optional></command></term>
980 <para>List unit files installed on the system, in combination with their enablement state (as reported by
981 <command>is-enabled
</command>). If one or more
<replaceable>PATTERN
</replaceable>s are specified, only unit
982 files whose name matches one of them are shown (patterns matching unit file system paths are not
988 <term><command>enable
<replaceable>NAME
</replaceable>...
</command></term>
989 <term><command>enable
<replaceable>PATH
</replaceable>...
</command></term>
992 <para>Enable one or more units or unit instances. This will create a set of symlinks, as encoded in the
993 <literal>[Install]
</literal> sections of the indicated unit files. After the symlinks have been created,
994 the system manager configuration is reloaded (in a way equivalent to
<command>daemon-reload
</command>), in
995 order to ensure the changes are taken into account immediately. Note that this does
996 <emphasis>not
</emphasis> have the effect of also starting any of the units being enabled. If this is
997 desired, combine this command with the
<option>--now
</option> switch, or invoke
<command>start
</command>
998 with appropriate arguments later. Note that in case of unit instance enablement (i.e. enablement of units of
999 the form
<filename>foo@bar.service
</filename>), symlinks named the same as instances are created in the
1000 unit configuration diectory, however they point to the single template unit file they are instantiated
1003 <para>This command expects either valid unit names (in which case various unit file directories are
1004 automatically searched for unit files with appropriate names), or absolute paths to unit files (in which
1005 case these files are read directly). If a specified unit file is located outside of the usual unit file
1006 directories, an additional symlink is created, linking it into the unit configuration path, thus ensuring
1007 it is found when requested by commands such as
<command>start
</command>.
</para>
1009 <para>This command will print the file system operations executed. This output may be suppressed by passing
1010 <option>--quiet
</option>.
1013 <para>Note that this operation creates only the symlinks suggested in the
<literal>[Install]
</literal>
1014 section of the unit files. While this command is the recommended way to manipulate the unit configuration
1015 directory, the administrator is free to make additional changes manually by placing or removing symlinks
1016 below this directory. This is particularly useful to create configurations that deviate from the suggested
1017 default installation. In this case, the administrator must make sure to invoke
1018 <command>daemon-reload
</command> manually as necessary, in order to ensure the changes are taken into
1022 <para>Enabling units should not be confused with starting (activating) units, as done by the
1023 <command>start
</command> command. Enabling and starting units is orthogonal: units may be enabled without
1024 being started and started without being enabled. Enabling simply hooks the unit into various suggested
1025 places (for example, so that the unit is automatically started on boot or when a particular kind of
1026 hardware is plugged in). Starting actually spawns the daemon process (in case of service units), or binds
1027 the socket (in case of socket units), and so on.
</para>
1029 <para>Depending on whether
<option>--system
</option>,
<option>--user
</option>,
<option>--runtime
</option>,
1030 or
<option>--global
</option> is specified, this enables the unit for the system, for the calling user only,
1031 for only this boot of the system, or for all future logins of all users, or only this boot. Note that in
1032 the last case, no systemd daemon configuration is reloaded.
</para>
1034 <para>Using
<command>enable
</command> on masked units is not supported and results in an error.
</para>
1039 <term><command>disable
<replaceable>NAME
</replaceable>...
</command></term>
1042 <para>Disables one or more units. This removes all symlinks to the unit files backing the specified units
1043 from the unit configuration directory, and hence undoes any changes made by
<command>enable
</command> or
1044 <command>link
</command>. Note that this removes
<emphasis>all
</emphasis> symlinks to matching unit files,
1045 including manually created symlinks, and not just those actually created by
<command>enable
</command> or
1046 <command>link
</command>. Note that while
<command>disable
</command> undoes the effect of
1047 <command>enable
</command>, the two commands are otherwise not symmetric, as
<command>disable
</command> may
1048 remove more symlinks than a prior
<command>enable
</command> invocation of the same unit created.
</para>
1050 <para>This command expects valid unit names only, it does not accept paths to unit files.
</para>
1052 <para>In addition to the units specified as arguments, all units are disabled that are listed in the
1053 <varname>Also=
</varname> setting contained in the
<literal>[Install]
</literal> section of any of the unit
1054 files being operated on.
</para>
1056 <para>This command implicitly reloads the system manager configuration after completing the operation. Note
1057 that this command does not implicitly stop the units that are being disabled. If this is desired, either
1058 combine this command with the
<option>--now
</option> switch, or invoke the
<command>stop
</command> command
1059 with appropriate arguments later.
</para>
1061 <para>This command will print information about the file system operations (symlink removals)
1062 executed. This output may be suppressed by passing
<option>--quiet
</option>.
1065 <para>This command honors
<option>--system
</option>,
<option>--user
</option>,
<option>--runtime
</option>
1066 and
<option>--global
</option> in a similar way as
<command>enable
</command>.
</para>
1071 <term><command>reenable
<replaceable>NAME
</replaceable>...
</command></term>
1074 <para>Reenable one or more units, as specified on the command line. This is a combination of
1075 <command>disable
</command> and
<command>enable
</command> and is useful to reset the symlinks a unit file is
1076 enabled with to the defaults configured in its
<literal>[Install]
</literal> section. This commands expects
1077 a unit uname only, it does not accept paths to unit files.
</para>
1082 <term><command>preset
<replaceable>NAME
</replaceable>...
</command></term>
1085 <para>Reset the enable/disable status one or more unit files, as specified on
1086 the command line, to the defaults configured in the preset policy files. This
1087 has the same effect as
<command>disable
</command> or
1088 <command>enable
</command>, depending how the unit is listed in the preset
1091 <para>Use
<option>--preset-mode=
</option> to control whether units shall be
1092 enabled and disabled, or only enabled, or only disabled.
</para>
1094 <para>If the unit carries no install information, it will be silently ignored
1095 by this command.
</para>
1097 <para>For more information on the preset policy format, see
1098 <citerefentry><refentrytitle>systemd.preset
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1099 For more information on the concept of presets, please consult the
1100 <ulink url=
"http://freedesktop.org/wiki/Software/systemd/Preset">Preset
</ulink>
1106 <term><command>preset-all
</command></term>
1109 <para>Resets all installed unit files to the defaults
1110 configured in the preset policy file (see above).
</para>
1112 <para>Use
<option>--preset-mode=
</option> to control
1113 whether units shall be enabled and disabled, or only
1114 enabled, or only disabled.
</para>
1119 <term><command>is-enabled
<replaceable>NAME
</replaceable>...
</command></term>
1122 <para>Checks whether any of the specified unit files are
1123 enabled (as with
<command>enable
</command>). Returns an
1124 exit code of
0 if at least one is enabled, non-zero
1125 otherwise. Prints the current enable status (see table).
1126 To suppress this output, use
<option>--quiet
</option>.
1131 <command>is-enabled
</command> output
1138 <entry>Description
</entry>
1139 <entry>Exit Code
</entry>
1144 <entry><literal>enabled
</literal></entry>
1145 <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>
1146 <entry morerows='
1'
>0</entry>
1149 <entry><literal>enabled-runtime
</literal></entry>
1152 <entry><literal>linked
</literal></entry>
1153 <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>
1154 <entry morerows='
1'
>> 0</entry>
1157 <entry><literal>linked-runtime
</literal></entry>
1160 <entry><literal>masked
</literal></entry>
1161 <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>
1162 <entry morerows='
1'
>> 0</entry>
1165 <entry><literal>masked-runtime
</literal></entry>
1168 <entry><literal>static
</literal></entry>
1169 <entry>The unit file is not enabled, and has no provisions for enabling in the
<literal>[Install]
</literal> unit file section.
</entry>
1173 <entry><literal>indirect
</literal></entry>
1174 <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>
1178 <entry><literal>disabled
</literal></entry>
1179 <entry>The unit file is not enabled, but contains an
<literal>[Install]
</literal> section with installation instructions.
</entry>
1180 <entry>> 0</entry>
1183 <entry><literal>generated
</literal></entry>
1184 <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>
1188 <entry><literal>transient
</literal></entry>
1189 <entry>The unit file has been created dynamically with the runtime API. Transient units may not be enabled.
</entry>
1193 <entry><literal>bad
</literal></entry>
1194 <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>
1195 <entry>> 0</entry>
1205 <term><command>mask
<replaceable>NAME
</replaceable>...
</command></term>
1208 <para>Mask one or more units, as specified on the command line. This will link these unit files to
1209 <filename>/dev/null
</filename>, making it impossible to start them. This is a stronger version of
1210 <command>disable
</command>, since it prohibits all kinds of activation of the unit, including enablement
1211 and manual activation. Use this option with care. This honors the
<option>--runtime
</option> option to only
1212 mask temporarily until the next reboot of the system. The
<option>--now
</option> option may be used to
1213 ensure that the units are also stopped. This command expects valid unit names only, it does not accept unit
1219 <term><command>unmask
<replaceable>NAME
</replaceable>...
</command></term>
1222 <para>Unmask one or more unit files, as specified on the command line. This will undo the effect of
1223 <command>mask
</command>. This command expects valid unit names only, it does not accept unit file
1229 <term><command>link
<replaceable>PATH
</replaceable>...
</command></term>
1232 <para>Link a unit file that is not in the unit file search paths into the unit file search path. This
1233 command expects an absolute path to a unit file. The effect of this may be undone with
1234 <command>disable
</command>. The effect of this command is that a unit file is made available for commands
1235 such as
<command>start
</command>, even though it is not installed directly in the unit search path.
</para>
1240 <term><command>revert
<replaceable>NAME
</replaceable>...
</command></term>
1243 <para>Revert one or more unit files to their vendor versions. This command removes drop-in configuration
1244 files that modify the specified units, as well as any user-configured unit file that overrides a matching
1245 vendor supplied unit file. Specifically, for a unit
<literal>foo.service
</literal> the matching directories
1246 <literal>foo.service.d/
</literal> with all their contained files are removed, both below the persistent and
1247 runtime configuration directories (i.e. below
<filename>/etc/systemd/system
</filename> and
1248 <filename>/run/systemd/system
</filename>); if the unit file has a vendor-supplied version (i.e. a unit file
1249 located below
<filename>/usr
</filename>) any matching peristent or runtime unit file that overrides it is
1250 removed, too. Note that if a unit file has no vendor-supplied version (i.e. is only defined below
1251 <filename>/etc/systemd/system
</filename> or
<filename>/run/systemd/system
</filename>, but not in a unit
1252 file stored below
<filename>/usr
</filename>), then it is not removed. Also, if a unit is masked, it is
1255 <para>Effectively, this command may be used to undo all changes made with
<command>systemctl
1256 edit
</command>,
<command>systemctl set-property
</command> and
<command>systemctl mask
</command> and puts
1257 the original unit file with its settings back in effect.
</para>
1262 <term><command>add-wants
<replaceable>TARGET
</replaceable>
1263 <replaceable>NAME
</replaceable>...
</command></term>
1264 <term><command>add-requires
<replaceable>TARGET
</replaceable>
1265 <replaceable>NAME
</replaceable>...
</command></term>
1268 <para>Adds
<literal>Wants=
</literal> or
<literal>Requires=
</literal>
1269 dependencies, respectively, to the specified
1270 <replaceable>TARGET
</replaceable> for one or more units.
</para>
1272 <para>This command honors
<option>--system
</option>,
1273 <option>--user
</option>,
<option>--runtime
</option> and
1274 <option>--global
</option> in a way similar to
1275 <command>enable
</command>.
</para>
1281 <term><command>edit
<replaceable>NAME
</replaceable>...
</command></term>
1284 <para>Edit a drop-in snippet or a whole replacement file if
1285 <option>--full
</option> is specified, to extend or override the
1286 specified unit.
</para>
1288 <para>Depending on whether
<option>--system
</option> (the default),
1289 <option>--user
</option>, or
<option>--global
</option> is specified,
1290 this command creates a drop-in file for each unit either for the system,
1291 for the calling user, or for all futures logins of all users. Then,
1292 the editor (see the
"Environment" section below) is invoked on
1293 temporary files which will be written to the real location if the
1294 editor exits successfully.
</para>
1296 <para>If
<option>--full
</option> is specified, this will copy the
1297 original units instead of creating drop-in files.
</para>
1299 <para>If
<option>--force
</option> is specified and any units do
1300 not already exist, new unit files will be opened for editing.
</para>
1302 <para>If
<option>--runtime
</option> is specified, the changes will
1303 be made temporarily in
<filename>/run
</filename> and they will be
1304 lost on the next reboot.
</para>
1306 <para>If the temporary file is empty upon exit, the modification of
1307 the related unit is canceled.
</para>
1309 <para>After the units have been edited, systemd configuration is
1310 reloaded (in a way that is equivalent to
<command>daemon-reload
</command>).
1313 <para>Note that this command cannot be used to remotely edit units
1314 and that you cannot temporarily edit units which are in
1315 <filename>/etc
</filename>, since they take precedence over
1316 <filename>/run
</filename>.
</para>
1321 <term><command>get-default
</command></term>
1324 <para>Return the default target to boot into. This returns
1325 the target unit name
<filename>default.target
</filename>
1326 is aliased (symlinked) to.
</para>
1331 <term><command>set-default
<replaceable>NAME
</replaceable></command></term>
1334 <para>Set the default target to boot into. This sets
1335 (symlinks) the
<filename>default.target
</filename> alias
1336 to the given target unit.
</para>
1344 <title>Machine Commands
</title>
1348 <term><command>list-machines
<optional><replaceable>PATTERN
</replaceable>...
</optional></command></term>
1351 <para>List the host and all running local containers with
1352 their state. If one or more
1353 <replaceable>PATTERN
</replaceable>s are specified, only
1354 containers matching one of them are shown.
1362 <title>Job Commands
</title>
1366 <term><command>list-jobs
<optional><replaceable>PATTERN...
</replaceable></optional></command></term>
1369 <para>List jobs that are in progress. If one or more
1370 <replaceable>PATTERN
</replaceable>s are specified, only
1371 jobs for units matching one of them are shown.
</para>
1375 <term><command>cancel
<replaceable>JOB
</replaceable>...
</command></term>
1378 <para>Cancel one or more jobs specified on the command line
1379 by their numeric job IDs. If no job ID is specified, cancel
1380 all pending jobs.
</para>
1387 <title>Environment Commands
</title>
1391 <term><command>show-environment
</command></term>
1394 <para>Dump the systemd manager environment block. The
1395 environment block will be dumped in straight-forward form
1396 suitable for sourcing into a shell script. This environment
1397 block will be passed to all processes the manager
1402 <term><command>set-environment
<replaceable>VARIABLE=VALUE
</replaceable>...
</command></term>
1405 <para>Set one or more systemd manager environment variables,
1406 as specified on the command line.
</para>
1410 <term><command>unset-environment
<replaceable>VARIABLE
</replaceable>...
</command></term>
1413 <para>Unset one or more systemd manager environment
1414 variables. If only a variable name is specified, it will be
1415 removed regardless of its value. If a variable and a value
1416 are specified, the variable is only removed if it has the
1417 specified value.
</para>
1422 <command>import-environment
</command>
1423 <optional><replaceable>VARIABLE...
</replaceable></optional>
1427 <para>Import all, one or more environment variables set on
1428 the client into the systemd manager environment block. If
1429 no arguments are passed, the entire environment block is
1430 imported. Otherwise, a list of one or more environment
1431 variable names should be passed, whose client-side values
1432 are then imported into the manager's environment
1440 <title>Manager Lifecycle Commands
</title>
1444 <term><command>daemon-reload
</command></term>
1447 <para>Reload the systemd manager configuration. This will
1448 rerun all generators (see
1449 <citerefentry><refentrytitle>systemd.generator
</refentrytitle><manvolnum>7</manvolnum></citerefentry>),
1450 reload all unit files, and recreate the entire dependency
1451 tree. While the daemon is being reloaded, all sockets
1452 systemd listens on behalf of user configuration will stay
1455 <para>This command should not be confused with the
1456 <command>reload
</command> command.
</para>
1460 <term><command>daemon-reexec
</command></term>
1463 <para>Reexecute the systemd manager. This will serialize the
1464 manager state, reexecute the process and deserialize the
1465 state again. This command is of little use except for
1466 debugging and package upgrades. Sometimes, it might be
1467 helpful as a heavy-weight
<command>daemon-reload
</command>.
1468 While the daemon is being reexecuted, all sockets systemd listening
1469 on behalf of user configuration will stay accessible.
1477 <title>System Commands
</title>
1481 <term><command>is-system-running
</command></term>
1484 <para>Checks whether the system is operational. This
1485 returns success (exit code
0) when the system is fully up
1486 and running, specifically not in startup, shutdown or
1487 maintenance mode, and with no failed services. Failure is
1488 returned otherwise (exit code non-zero). In addition, the
1489 current state is printed in a short string to standard
1490 output, see the table below. Use
<option>--quiet
</option> to
1491 suppress this output.
</para>
1494 <title><command>is-system-running
</command> output
</title>
1496 <colspec colname='name'
/>
1497 <colspec colname='description'
/>
1498 <colspec colname='exit-code'
/>
1502 <entry>Description
</entry>
1503 <entry>Exit Code
</entry>
1508 <entry><varname>initializing
</varname></entry>
1509 <entry><para>Early bootup, before
1510 <filename>basic.target
</filename> is reached
1511 or the
<varname>maintenance
</varname> state entered.
1513 <entry>> 0</entry>
1516 <entry><varname>starting
</varname></entry>
1517 <entry><para>Late bootup, before the job queue
1518 becomes idle for the first time, or one of the
1519 rescue targets are reached.
</para></entry>
1520 <entry>> 0</entry>
1523 <entry><varname>running
</varname></entry>
1524 <entry><para>The system is fully
1525 operational.
</para></entry>
1529 <entry><varname>degraded
</varname></entry>
1530 <entry><para>The system is operational but one or more
1531 units failed.
</para></entry>
1532 <entry>> 0</entry>
1535 <entry><varname>maintenance
</varname></entry>
1536 <entry><para>The rescue or emergency target is
1537 active.
</para></entry>
1538 <entry>> 0</entry>
1541 <entry><varname>stopping
</varname></entry>
1542 <entry><para>The manager is shutting
1543 down.
</para></entry>
1544 <entry>> 0</entry>
1547 <entry><varname>offline
</varname></entry>
1548 <entry><para>The manager is not
1549 running. Specifically, this is the operational
1550 state if an incompatible program is running as
1551 system manager (PID
1).
</para></entry>
1552 <entry>> 0</entry>
1555 <entry><varname>unknown
</varname></entry>
1556 <entry><para>The operational state could not be
1557 determined, due to lack of resources or another
1558 error cause.
</para></entry>
1559 <entry>> 0</entry>
1568 <term><command>default
</command></term>
1571 <para>Enter default mode. This is mostly equivalent to
1572 <command>isolate default.target
</command>.
</para>
1577 <term><command>rescue
</command></term>
1580 <para>Enter rescue mode. This is mostly equivalent to
1581 <command>isolate rescue.target
</command>, but also prints a
1582 wall message to all users.
</para>
1586 <term><command>emergency
</command></term>
1589 <para>Enter emergency mode. This is mostly equivalent to
1590 <command>isolate emergency.target
</command>, but also prints
1591 a wall message to all users.
</para>
1595 <term><command>halt
</command></term>
1598 <para>Shut down and halt the system. This is mostly equivalent to
<command>start halt.target
1599 --job-mode=replace-irreversibly
</command>, but also prints a wall message to all users. If combined with
1600 <option>--force
</option>, shutdown of all running services is skipped, however all processes are killed and
1601 all file systems are unmounted or mounted read-only, immediately followed by the system halt. If
1602 <option>--force
</option> is specified twice, the operation is immediately executed without terminating any
1603 processes or unmounting any file systems. This may result in data loss. Note that when
1604 <option>--force
</option> is specified twice the halt operation is executed by
1605 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
1606 succeed even when the system manager hangs or crashed.
</para>
1610 <term><command>poweroff
</command></term>
1613 <para>Shut down and power-off the system. This is mostly equivalent to
<command>start poweroff.target
1614 --job-mode=replace-irreversibly
</command>, but also prints a wall message to all users. If combined with
1615 <option>--force
</option>, shutdown of all running services is skipped, however all processes are killed and
1616 all file systems are unmounted or mounted read-only, immediately followed by the powering off. If
1617 <option>--force
</option> is specified twice, the operation is immediately executed without terminating any
1618 processes or unmounting any file systems. This may result in data loss. Note that when
1619 <option>--force
</option> is specified twice the power-off operation is executed by
1620 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
1621 succeed even when the system manager hangs or crashed.
</para>
1625 <term><command>reboot
<optional><replaceable>arg
</replaceable></optional></command></term>
1628 <para>Shut down and reboot the system. This is mostly equivalent to
<command>start reboot.target
1629 --job-mode=replace-irreversibly
</command>, but also prints a wall message to all users. If combined with
1630 <option>--force
</option>, shutdown of all running services is skipped, however all processes are killed and
1631 all file systems are unmounted or mounted read-only, immediately followed by the reboot. If
1632 <option>--force
</option> is specified twice, the operation is immediately executed without terminating any
1633 processes or unmounting any file systems. This may result in data loss. Note that when
1634 <option>--force
</option> is specified twice the reboot operation is executed by
1635 <command>systemctl
</command> itself, and the system manager is not contacted. This means the command should
1636 succeed even when the system manager hangs or crashed.
</para>
1638 <para>If the optional argument
1639 <replaceable>arg
</replaceable> is given, it will be passed
1640 as the optional argument to the
1641 <citerefentry><refentrytitle>reboot
</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1642 system call. The value is architecture and firmware
1643 specific. As an example,
<literal>recovery
</literal> might
1644 be used to trigger system recovery, and
1645 <literal>fota
</literal> might be used to trigger a
1646 <quote>firmware over the air
</quote> update.
</para>
1651 <term><command>kexec
</command></term>
1654 <para>Shut down and reboot the system via kexec. This is
1655 mostly equivalent to
<command>start kexec.target --job-mode=replace-irreversibly
</command>,
1656 but also prints a wall message to all users. If combined
1657 with
<option>--force
</option>, shutdown of all running
1658 services is skipped, however all processes are killed and
1659 all file systems are unmounted or mounted read-only,
1660 immediately followed by the reboot.
</para>
1665 <term><command>exit
<optional><replaceable>EXIT_CODE
</replaceable></optional></command></term>
1668 <para>Ask the systemd manager to quit. This is only
1669 supported for user service managers (i.e. in conjunction
1670 with the
<option>--user
</option> option) or in containers
1671 and is equivalent to
<command>poweroff
</command> otherwise.
</para>
1673 <para>The systemd manager can exit with a non-zero exit
1674 code if the optional argument
1675 <replaceable>EXIT_CODE
</replaceable> is given.
</para>
1680 <term><command>switch-root
<replaceable>ROOT
</replaceable> <optional><replaceable>INIT
</replaceable></optional></command></term>
1683 <para>Switches to a different root directory and executes a
1684 new system manager process below it. This is intended for
1685 usage in initial RAM disks (
"initrd"), and will transition
1686 from the initrd's system manager process (a.k.a.
"init"
1687 process) to the main system manager process. This call takes two
1688 arguments: the directory that is to become the new root directory, and
1689 the path to the new system manager binary below it to
1690 execute as PID
1. If the latter is omitted or the empty
1691 string, a systemd binary will automatically be searched for
1692 and used as init. If the system manager path is omitted or
1693 equal to the empty string, the state of the initrd's system
1694 manager process is passed to the main system manager, which
1695 allows later introspection of the state of the services
1696 involved in the initrd boot.
</para>
1701 <term><command>suspend
</command></term>
1704 <para>Suspend the system. This will trigger activation of
1705 the special
<filename>suspend.target
</filename> target.
1711 <term><command>hibernate
</command></term>
1714 <para>Hibernate the system. This will trigger activation of
1715 the special
<filename>hibernate.target
</filename> target.
1721 <term><command>hybrid-sleep
</command></term>
1724 <para>Hibernate and suspend the system. This will trigger
1725 activation of the special
1726 <filename>hybrid-sleep.target
</filename> target.
</para>
1733 <title>Parameter Syntax
</title>
1735 <para>Unit commands listed above take either a single unit name (designated as
<replaceable>NAME
</replaceable>),
1736 or multiple unit specifications (designated as
<replaceable>PATTERN
</replaceable>...). In the first case, the
1737 unit name with or without a suffix must be given. If the suffix is not specified (unit name is
"abbreviated"),
1738 systemctl will append a suitable suffix,
<literal>.service
</literal> by default, and a type-specific suffix in
1739 case of commands which operate only on specific unit types. For example,
1740 <programlisting># systemctl start sshd
</programlisting> and
1741 <programlisting># systemctl start sshd.service
</programlisting>
1742 are equivalent, as are
1743 <programlisting># systemctl isolate default
</programlisting>
1745 <programlisting># systemctl isolate default.target
</programlisting>
1746 Note that (absolute) paths to device nodes are automatically converted to device unit names, and other (absolute)
1747 paths to mount unit names.
1748 <programlisting># systemctl status /dev/sda
1749 # systemctl status /home
</programlisting>
1751 <programlisting># systemctl status dev-sda.device
1752 # systemctl status home.mount
</programlisting>
1753 In the second case, shell-style globs will be matched against the primary names of all currently loaded units;
1754 literal unit names, with or without a suffix, will be treated as in the first case. This means that literal unit
1755 names always refer to exactly one unit, but globs may match zero units and this is not considered an
1758 <para>Glob patterns use
1759 <citerefentry project='man-pages'
><refentrytitle>fnmatch
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
1760 so normal shell-style globbing rules are used, and
1761 <literal>*
</literal>,
<literal>?
</literal>,
1762 <literal>[]
</literal> may be used. See
1763 <citerefentry project='man-pages'
><refentrytitle>glob
</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1764 for more details. The patterns are matched against the primary names of
1765 currently loaded units, and patterns which do not match anything
1766 are silently skipped. For example:
1767 <programlisting># systemctl stop sshd@*.service
</programlisting>
1768 will stop all
<filename>sshd@.service
</filename> instances. Note that alias names of units, and units that aren't
1769 loaded are not considered for glob expansion.
1772 <para>For unit file commands, the specified
<replaceable>NAME
</replaceable> should be the name of the unit file
1773 (possibly abbreviated, see above), or the absolute path to the unit file:
1774 <programlisting># systemctl enable foo.service
</programlisting>
1776 <programlisting># systemctl link /path/to/foo.service
</programlisting>
1783 <title>Exit status
</title>
1785 <para>On success,
0 is returned, a non-zero failure
1786 code otherwise.
</para>
1790 <title>Environment
</title>
1792 <variablelist class='environment-variables'
>
1794 <term><varname>$SYSTEMD_EDITOR
</varname></term>
1796 <listitem><para>Editor to use when editing units; overrides
1797 <varname>$EDITOR
</varname> and
<varname>$VISUAL
</varname>. If neither
1798 <varname>$SYSTEMD_EDITOR
</varname> nor
<varname>$EDITOR
</varname> nor
1799 <varname>$VISUAL
</varname> are present or if it is set to an empty
1800 string or if their execution failed, systemctl will try to execute well
1801 known editors in this order:
1802 <citerefentry project='die-net'
><refentrytitle>editor
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1803 <citerefentry project='die-net'
><refentrytitle>nano
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1804 <citerefentry project='die-net'
><refentrytitle>vim
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1805 <citerefentry project='die-net'
><refentrytitle>vi
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
1809 <xi:include href=
"less-variables.xml" xpointer=
"pager"/>
1810 <xi:include href=
"less-variables.xml" xpointer=
"less"/>
1814 <title>See Also
</title>
1816 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1817 <citerefentry><refentrytitle>journalctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1818 <citerefentry><refentrytitle>loginctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1819 <citerefentry><refentrytitle>machinectl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1820 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1821 <citerefentry><refentrytitle>systemd.resource-control
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1822 <citerefentry><refentrytitle>systemd.special
</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1823 <citerefentry project='man-pages'
><refentrytitle>wall
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1824 <citerefentry><refentrytitle>systemd.preset
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1825 <citerefentry><refentrytitle>systemd.generator
</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1826 <citerefentry project='man-pages'
><refentrytitle>glob
</refentrytitle><manvolnum>7</manvolnum></citerefentry>
projects / thirdparty / systemd.git / blob