1 <?xml version='
1.0'
?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6 This file is part of systemd.
8 Copyright 2010 Lennart Poettering
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
24 <refentry id=
"systemctl"
25 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
28 <title>systemctl
</title>
29 <productname>systemd
</productname>
33 <contrib>Developer
</contrib>
34 <firstname>Lennart
</firstname>
35 <surname>Poettering
</surname>
36 <email>lennart@poettering.net
</email>
42 <refentrytitle>systemctl
</refentrytitle>
43 <manvolnum>1</manvolnum>
47 <refname>systemctl
</refname>
48 <refpurpose>Control the systemd system and service manager
</refpurpose>
53 <command>systemctl
</command>
54 <arg choice=
"opt" rep=
"repeat">OPTIONS
</arg>
55 <arg choice=
"plain">COMMAND
</arg>
56 <arg choice=
"opt" rep=
"repeat">NAME
</arg>
61 <title>Description
</title>
63 <para><command>systemctl
</command> may be used to
64 introspect and control the state of the
65 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>
66 system and service manager.
</para>
70 <title>Options
</title>
72 <para>The following options are understood:
</para>
76 <term><option>-h
</option></term>
77 <term><option>--help
</option></term>
79 <listitem><para>Prints a short help
80 text and exits.
</para></listitem>
84 <term><option>--version
</option></term>
87 <para>Prints a short version string and exits.
</para>
92 <term><option>-t
</option></term>
93 <term><option>--type=
</option></term>
96 <para>The argument should be a comma-separated list of unit
97 types such as
<option>service
</option> and
98 <option>socket
</option>.
101 <para>If one of the arguments is a unit type, when listing
102 units, limit display to certain unit types. Otherwise, units
103 of all types will be shown.
</para>
105 <para>As a special case, if one of the arguments is
106 <option>help
</option>, a list of allowed values will be
107 printed and the program will exit.
</para>
112 <term><option>--state=
</option></term>
115 <para>The argument should be a comma-separated list of unit LOAD,
116 SUB, or ACTIVE states. When listing units, show only those
117 in specified states.
</para>
122 <term><option>-p
</option></term>
123 <term><option>--property=
</option></term>
126 <para>When showing unit/job/manager properties with the
127 <command>show
</command> command, limit display to certain
128 properties as specified as argument. If not specified, all
129 set properties are shown. The argument should be a
130 comma-separated list of property names, such as
131 <literal>MainPID
</literal>. If specified more than once, all
132 properties with the specified names are shown.
</para>
137 <term><option>-a
</option></term>
138 <term><option>--all
</option></term>
141 <para>When listing units, show all loaded units, regardless
142 of their state, including inactive units. When showing
143 unit/job/manager properties, show all properties regardless
144 whether they are set or not.
</para>
145 <para>To list all units installed on the system, use the
146 <command>list-unit-files
</command> command instead.
</para>
151 <term><option>--reverse
</option></term>
154 <para>Show reverse dependencies between units with
155 <command>list-dependencies
</command>, i.e. units with
156 dependencies of type
<varname>Wants=
</varname> or
157 <varname>Requires=
</varname> on the given unit.
163 <term><option>--after
</option></term>
164 <term><option>--before
</option></term>
167 <para>Show which units are started after or before
168 with
<command>list-dependencies
</command>, respectively.
174 <term><option>-l
</option></term>
175 <term><option>--full
</option></term>
178 <para>Do not ellipsize unit names, process tree entries,
179 journal output, or truncate unit descriptions in the output
180 of
<command>status
</command>,
<command>list-units
</command>,
181 <command>list-jobs
</command>, and
182 <command>list-timers
</command>.
</para>
187 <term><option>--show-types
</option></term>
190 <para>When showing sockets, show the type of the socket.
</para>
195 <term><option>--job-mode=
</option></term>
198 <para>When queuing a new job, this option controls how to deal with
199 already queued jobs. It takes one of
<literal>fail
</literal>,
200 <literal>replace
</literal>,
201 <literal>replace-irreversibly
</literal>,
202 <literal>isolate
</literal>,
203 <literal>ignore-dependencies
</literal>,
204 <literal>ignore-requirements
</literal> or
205 <literal>flush
</literal>. Defaults to
206 <literal>replace
</literal>, except when the
207 <command>isolate
</command> command is used which implies the
208 <literal>isolate
</literal> job mode.
</para>
210 <para>If
<literal>fail
</literal> is specified and a requested
211 operation conflicts with a pending job (more specifically:
212 causes an already pending start job to be reversed into a stop
213 job or vice versa), cause the operation to fail.
</para>
215 <para>If
<literal>replace
</literal> (the default) is
216 specified, any conflicting pending job will be replaced, as
219 <para>If
<literal>replace-irreversibly
</literal> is specified,
220 operate like
<literal>replace
</literal>, but also mark the new
221 jobs as irreversible. This prevents future conflicting
222 transactions from replacing these jobs. The jobs can still be
223 cancelled using the
<command>cancel
</command> command.
</para>
225 <para><literal>isolate
</literal> is only valid for start
226 operations and causes all other units to be stopped when the
227 specified unit is started. This mode is always used when the
228 <command>isolate
</command> command is used.
</para>
230 <para><literal>flush
</literal> will cause all queued jobs to
231 be canceled when the new job is enqueued.
</para>
233 <para>If
<literal>ignore-dependencies
</literal> is specified,
234 then all unit dependencies are ignored for this new job and
235 the operation is executed immediately. If passed, no required
236 units of the unit passed will be pulled in, and no ordering
237 dependencies will be honored. This is mostly a debugging and
238 rescue tool for the administrator and should not be used by
241 <para><literal>ignore-requirements
</literal> is similar to
242 <literal>ignore-dependencies
</literal>, but only causes the
243 requirement dependencies to be ignored, the ordering
244 dependencies will still be honoured.
</para>
250 <term><option>-i
</option></term>
251 <term><option>--ignore-inhibitors
</option></term>
254 <para>When system shutdown or a sleep state is requested,
255 ignore inhibitor locks. Applications can establish inhibitor
256 locks to avoid that certain important operations (such as CD
257 burning or suchlike) are interrupted by system shutdown or a
258 sleep state. Any user may take these locks and privileged
259 users may override these locks. If any locks are taken,
260 shutdown and sleep state requests will normally fail
261 (regardless of whether privileged or not) and a list of active locks
262 is printed. However, if
<option>--ignore-inhibitors
</option>
263 is specified, the locks are ignored and not printed, and the
264 operation attempted anyway, possibly requiring additional
270 <term><option>-q
</option></term>
271 <term><option>--quiet
</option></term>
274 <para>Suppress output to standard output in
275 <command>snapshot
</command>,
276 <command>is-active
</command>,
277 <command>is-failed
</command>,
278 <command>enable
</command> and
279 <command>disable
</command>.
</para>
284 <term><option>--no-block
</option></term>
287 <para>Do not synchronously wait for the requested operation
288 to finish. If this is not specified, the job will be
289 verified, enqueued and
<command>systemctl
</command> will
290 wait until it is completed. By passing this argument, it is
291 only verified and enqueued.
</para>
296 <term><option>--no-legend
</option></term>
299 <para>Do not print the legend, i.e. the column headers and
300 the footer with hints.
</para>
305 <term><option>--no-pager
</option></term>
308 <para>Do not pipe output into a pager.
</para>
313 <term><option>--system
</option></term>
316 <para>Talk to the systemd system manager. (Default)
</para>
321 <term><option>--user
</option></term>
324 <para>Talk to the systemd manager of the calling
330 <term><option>--no-wall
</option></term>
333 <para>Do not send wall message before halt, power-off,
339 <term><option>--global
</option></term>
342 <para>When used with
<command>enable
</command> and
343 <command>disable
</command>, operate on the global user
344 configuration directory, thus enabling or disabling a unit
345 file globally for all future logins of all users.
</para>
350 <term><option>--no-reload
</option></term>
353 <para>When used with
<command>enable
</command> and
354 <command>disable
</command>, do not implicitly reload daemon
355 configuration after executing the changes.
</para>
360 <term><option>--no-ask-password
</option></term>
363 <para>When used with
<command>start
</command> and related
364 commands, disables asking for passwords. Background services
365 may require input of a password or passphrase string, for
366 example to unlock system hard disks or cryptographic
367 certificates. Unless this option is specified and the
368 command is invoked from a terminal,
369 <command>systemctl
</command> will query the user on the
370 terminal for the necessary secrets. Use this option to
371 switch this behavior off. In this case, the password must be
372 supplied by some other means (for example graphical password
373 agents) or the service might fail. This also disables
374 querying the user for authentication for privileged
381 <term><option>--kill-who=
</option></term>
384 <para>When used with
<command>kill
</command>, choose which
385 processes to kill. Must be one of
<option>main
</option>,
386 <option>control
</option> or
<option>all
</option> to select
387 whether to kill only the main process of the unit, the
388 control process or all processes of the unit. If omitted,
389 defaults to
<option>all
</option>.
</para>
395 <term><option>-s
</option></term>
396 <term><option>--signal=
</option></term>
399 <para>When used with
<command>kill
</command>, choose which
400 signal to send to selected processes. Must be one of the
401 well known signal specifiers such as
<constant>SIGTERM
</constant>,
<constant>SIGINT
</constant> or
402 <constant>SIGSTOP
</constant>. If omitted, defaults to
403 <option>SIGTERM
</option>.
</para>
408 <term><option>-f
</option></term>
409 <term><option>--force
</option></term>
412 <para>When used with
<command>enable
</command>, overwrite
413 any existing conflicting symlinks.
</para>
415 <para>When used with
<command>halt
</command>,
416 <command>poweroff
</command>,
<command>reboot
</command> or
417 <command>kexec
</command>, execute the selected operation
418 without shutting down all units. However, all processes will
419 be killed forcibly and all file systems are unmounted or
420 remounted read-only. This is hence a drastic but relatively
421 safe option to request an immediate reboot. If
422 <option>--force
</option> is specified twice for these
423 operations, they will be executed immediately without
424 terminating any processes or umounting any file
425 systems. Warning: specifying
<option>--force
</option> twice
426 with any of these operations might result in data
432 <term><option>--root=
</option></term>
436 <command>enable
</command>/
<command>disable
</command>/
<command>is-enabled
</command>
437 (and related commands), use alternative root path when
438 looking for unit files.
</para>
444 <term><option>--runtime
</option></term>
447 <para>When used with
<command>enable
</command>,
448 <command>disable
</command>,
449 (and related commands), make changes only temporarily, so
450 that they are lost on the next reboot. This will have the
451 effect that changes are not made in subdirectories of
452 <filename>/etc
</filename> but in
<filename>/run
</filename>,
453 with identical immediate effects, however, since the latter
454 is lost on reboot, the changes are lost too.
</para>
456 <para>Similarly, when used with
457 <command>set-property
</command>, make changes only
458 temporarily, so that they are lost on the next
464 <term><option>-H
</option></term>
465 <term><option>--host
</option></term>
468 <para>Execute the operation remotely. Specify a hostname, or
469 username and hostname separated by
<literal>@
</literal>, to
470 connect to. This will use SSH to talk to the remote systemd
476 <term><option>-M
</option></term>
477 <term><option>--machine=
</option></term>
479 <listitem><para>Execute the operation on a local
480 container. Specify a container name to connect
481 to.
</para></listitem>
485 <term><option>-n
</option></term>
486 <term><option>--lines=
</option></term>
489 <para>When used with
<command>status
</command>, controls the
490 number of journal lines to show, counting from the most
491 recent ones. Takes a positive integer argument. Defaults to
497 <term><option>-o
</option></term>
498 <term><option>--output=
</option></term>
501 <para>When used with
<command>status
</command>, controls the
502 formatting of the journal entries that are shown. For the
503 available choices, see
504 <citerefentry><refentrytitle>journalctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
505 Defaults to
<literal>short
</literal>.
</para>
510 <term><option>--plain
</option></term>
513 <para>When used with
<command>list-dependencies
</command>,
514 the output is printed as a list instead of a tree.
</para>
522 <title>Commands
</title>
524 <para>The following commands are understood:
</para>
527 <title>Unit Commands
</title>
531 <term><command>list-units
<optional><replaceable>PATTERN
</replaceable>...
</optional></command></term>
534 <para>List known units (subject to limitations specified
535 with
<option>-t
</option>). If one or more
536 <replaceable>PATTERN
</replaceable>s are specified, only
537 units matching one of them are shown.
</para>
539 <para>This is the default command.
</para>
544 <term><command>list-sockets
<optional><replaceable>PATTERN
</replaceable>...
</optional></command></term>
547 <para>List socket units ordered by listening address.
548 If one or more
<replaceable>PATTERN
</replaceable>s are
549 specified, only socket units matching one of them are
550 shown. Produces output similar to
552 LISTEN UNIT ACTIVATES
553 /dev/initctl systemd-initctl.socket systemd-initctl.service
555 [::]:
22 sshd.socket sshd.service
556 kobject-uevent
1 systemd-udevd-kernel.socket systemd-udevd.service
558 5 sockets listed.
</programlisting>
559 Note: because the addresses might contains spaces, this output
560 is not suitable for programmatic consumption.
563 <para>See also the options
<option>--show-types
</option>,
564 <option>--all
</option>, and
<option>--failed
</option>.
</para>
569 <term><command>list-timers
<optional><replaceable>PATTERN
</replaceable>...
</optional></command></term>
572 <para>List timer units ordered by the time they elapse
573 next. If one or more
<replaceable>PATTERN
</replaceable>s
574 are specified, only units matching one of them are shown.
577 <para>See also the options
<option>--all
</option> and
578 <option>--failed
</option>.
</para>
583 <term><command>start
<replaceable>PATTERN
</replaceable>...
</command></term>
586 <para>Start (activate) one or more units specified on the
589 <para>Note that glob patterns operate on a list of currently
590 loaded units. Units which are not active and are not in a
591 failed state usually are not loaded, and would not be
592 matched by any pattern. In addition, in case of
593 instantiated units, systemd is often unaware of the
594 instance name until the instance has been started. Therefore,
595 using glob patterns with
<command>start
</command>
596 has limited usefulness.
</para>
600 <term><command>stop
<replaceable>PATTERN
</replaceable>...
</command></term>
603 <para>Stop (deactivate) one or more units specified on the
608 <term><command>reload
<replaceable>PATTERN
</replaceable>...
</command></term>
611 <para>Asks all units listed on the command line to reload
612 their configuration. Note that this will reload the
613 service-specific configuration, not the unit configuration
614 file of systemd. If you want systemd to reload the
615 configuration file of a unit, use the
616 <command>daemon-reload
</command> command. In other words:
617 for the example case of Apache, this will reload Apache's
618 <filename>httpd.conf
</filename> in the web server, not the
619 <filename>apache.service
</filename> systemd unit
622 <para>This command should not be confused with the
623 <command>daemon-reload
</command> or
<command>load
</command>
629 <term><command>restart
<replaceable>PATTERN
</replaceable>...
</command></term>
632 <para>Restart one or more units specified on the command
633 line. If the units are not running yet, they will be
638 <term><command>try-restart
<replaceable>PATTERN
</replaceable>...
</command></term>
641 <para>Restart one or more units specified on the command
642 line if the units are running. This does nothing if units are not
643 running. Note that, for compatibility with Red Hat init
644 scripts,
<command>condrestart
</command> is equivalent to this
649 <term><command>reload-or-restart
<replaceable>PATTERN
</replaceable>...
</command></term>
652 <para>Reload one or more units if they support it. If not,
653 restart them instead. If the units are not running yet, they
654 will be started.
</para>
658 <term><command>reload-or-try-restart
<replaceable>PATTERN
</replaceable>...
</command></term>
661 <para>Reload one or more units if they support it. If not,
662 restart them instead. This does nothing if the units are not
663 running. Note that, for compatibility with SysV init scripts,
664 <command>force-reload
</command> is equivalent to this
669 <term><command>isolate
<replaceable>NAME
</replaceable></command></term>
672 <para>Start the unit specified on the command line and its
673 dependencies and stop all others.
</para>
675 <para>This is similar to changing the runlevel in a
676 traditional init system. The
<command>isolate
</command>
677 command will immediately stop processes that are not enabled
678 in the new unit, possibly including the graphical
679 environment or terminal you are currently using.
</para>
681 <para>Note that this is allowed only on units where
682 <option>AllowIsolate=
</option> is enabled. See
683 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
688 <term><command>kill
<replaceable>PATTERN
</replaceable>...
</command></term>
691 <para>Send a signal to one or more processes of the
692 unit. Use
<option>--kill-who=
</option> to select which
693 process to kill. Use
<option>--kill-mode=
</option> to select
694 the kill mode and
<option>--signal=
</option> to select the
695 signal to send.
</para>
699 <term><command>is-active
<replaceable>PATTERN
</replaceable>...
</command></term>
702 <para>Check whether any of the specified units are active
703 (i.e. running). Returns an exit code
704 <constant>0</constant> if at least one is active, or
705 non-zero otherwise. Unless
<option>--quiet
</option> is
706 specified, this will also print the current unit state to
707 standard output.
</para>
711 <term><command>is-failed
<replaceable>PATTERN
</replaceable>...
</command></term>
714 <para>Check whether any of the specified units are in a
715 "failed" state. Returns an exit code
716 <constant>0</constant> if at least one has failed,
717 non-zero otherwise. Unless
<option>--quiet
</option> is
718 specified, this will also print the current unit state to
719 standard output.
</para>
723 <term><command>status
</command> <optional><replaceable>PATTERN
</replaceable>...|
<replaceable>PID
</replaceable>...]
</optional></term>
726 <para>Show terse runtime status information about one or
727 more units, followed by most recent log data from the
728 journal. If no units are specified, show all units (subject
729 to limitations specified with
<option>-t
</option>). If a PID
730 is passed, show information about the unit the process
733 <para>This function is intended to generate human-readable
734 output. If you are looking for computer-parsable output,
735 use
<command>show
</command> instead. By default this
736 function only shows
10 lines of output and ellipsizes
737 lines to fit in the terminal window. This can be changes
738 with
<option>--lines
</option> and
<option>--full
</option>,
739 see above. In addition,
<command>journalctl
740 --unit=
<replaceable>NAME
</replaceable></command> or
742 --user-unit=
<replaceable>NAME
</replaceable></command> use
743 a similar filter for messages and might be more
749 <term><command>show
</command> <optional><replaceable>PATTERN
</replaceable>...|
<replaceable>JOB
</replaceable>...
</optional></term>
752 <para>Show properties of one or more units, jobs, or the
753 manager itself. If no argument is specified, properties of
754 the manager will be shown. If a unit name is specified,
755 properties of the unit is shown, and if a job id is
756 specified, properties of the job is shown. By default, empty
757 properties are suppressed. Use
<option>--all
</option> to
758 show those too. To select specific properties to show, use
759 <option>--property=
</option>. This command is intended to be
760 used whenever computer-parsable output is required. Use
761 <command>status
</command> if you are looking for formatted
762 human-readable output.
</para>
766 <term><command>cat
<replaceable>PATTERN
</replaceable>...
</command></term>
769 <para>Show backing files of one or more units. Prints the
770 "fragment" and
"drop-ins" (source files) of units. Each
771 file is preceded by a comment which includes the file
776 <term><command>set-property
<replaceable>NAME
</replaceable> <replaceable>ASSIGNMENT
</replaceable>...
</command></term>
779 <para>Set the specified unit properties at runtime where
780 this is supported. This allows changing configuration
781 parameter properties such as resource control settings at
782 runtime. Not all properties may be changed at runtime, but
783 many resource control settings (primarily those in
784 <citerefentry><refentrytitle>systemd.resource-control
</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
785 may. The changes are applied instantly, and stored on disk
786 for future boots, unless
<option>--runtime
</option> is
787 passed, in which case the settings only apply until the
788 next reboot. The syntax of the property assignment follows
789 closely the syntax of assignments in unit files.
</para>
791 <para>Example:
<command>systemctl set-property foobar.service CPUShares=
777</command></para>
793 <para>Note that this command allows changing multiple
794 properties at the same time, which is preferable over
795 setting them individually. Like unit file configuration
796 settings, assigning the empty list to list parameters will
797 reset the list.
</para>
802 <term><command>help
<replaceable>PATTERN
</replaceable>...|
<replaceable>PID
</replaceable>...
</command></term>
805 <para>Show manual pages for one or more units, if
806 available. If a PID is given, the manual pages for the unit
807 the process belongs to are shown.
</para>
812 <term><command>reset-failed [
<replaceable>PATTERN
</replaceable>...]
</command></term>
815 <para>Reset the
<literal>failed
</literal> state of the
816 specified units, or if no unit name is passed, reset the state of all
817 units. When a unit fails in some way (i.e. process exiting
818 with non-zero error code, terminating abnormally or timing
819 out), it will automatically enter the
820 <literal>failed
</literal> state and its exit code and status
821 is recorded for introspection by the administrator until the
822 service is restarted or reset with this command.
</para>
827 <term><command>list-dependencies
<replaceable>NAME
</replaceable></command></term>
830 <para>Shows required and wanted units of the specified
831 unit. If no unit is specified,
832 <filename>default.target
</filename> is implied. Target units
833 are recursively expanded. When
<option>--all
</option> is
834 passed, all other units are recursively expanded as
842 <title>Unit File Commands
</title>
846 <term><command>list-unit-files
<optional><replaceable>PATTERN...
</replaceable></optional></command></term>
849 <para>List installed unit files. If one or more
850 <replaceable>PATTERN
</replaceable>s are specified, only
851 units whose filename (just the last component of the path)
852 matches one of them are shown.
</para>
857 <term><command>enable
<replaceable>NAME
</replaceable>...
</command></term>
860 <para>Enable one or more unit files or unit file instances,
861 as specified on the command line. This will create a number
862 of symlinks as encoded in the
<literal>[Install]
</literal>
863 sections of the unit files. After the symlinks have been
864 created, the systemd configuration is reloaded (in a way that
865 is equivalent to
<command>daemon-reload
</command>) to ensure
866 the changes are taken into account immediately. Note that
867 this does
<emphasis>not
</emphasis> have the effect of also
868 starting any of the units being enabled. If this
869 is desired, a separate
<command>start
</command> command must
870 be invoked for the unit. Also note that in case of instance
871 enablement, symlinks named the same as instances are created in
872 the install location, however they all point to the same
873 template unit file.
</para>
875 <para>This command will print the actions executed. This
876 output may be suppressed by passing
<option>--quiet
</option>.
879 <para>Note that this operation creates only the suggested
880 symlinks for the units. While this command is the
881 recommended way to manipulate the unit configuration
882 directory, the administrator is free to make additional
883 changes manually by placing or removing symlinks in the
884 directory. This is particularly useful to create
885 configurations that deviate from the suggested default
886 installation. In this case, the administrator must make sure
887 to invoke
<command>daemon-reload
</command> manually as
888 necessary to ensure the changes are taken into account.
891 <para>Enabling units should not be confused with starting
892 (activating) units, as done by the
<command>start
</command>
893 command. Enabling and starting units is orthogonal: units
894 may be enabled without being started and started without
895 being enabled. Enabling simply hooks the unit into various
896 suggested places (for example, so that the unit is
897 automatically started on boot or when a particular kind of
898 hardware is plugged in). Starting actually spawns the daemon
899 process (in case of service units), or binds the socket (in
900 case of socket units), and so on.
</para>
902 <para>Depending on whether
<option>--system
</option>,
903 <option>--user
</option>,
<option>--runtime
</option>,
904 or
<option>--global
</option> is specified, this enables the unit
905 for the system, for the calling user only, for only this boot of
906 the system, or for all future logins of all users, or only this
907 boot. Note that in the last case, no systemd daemon
908 configuration is reloaded.
</para>
913 <term><command>disable
<replaceable>NAME
</replaceable>...
</command></term>
916 <para>Disables one or more units. This removes all symlinks
917 to the specified unit files from the unit configuration
918 directory, and hence undoes the changes made by
919 <command>enable
</command>. Note however that this removes
920 all symlinks to the unit files (i.e. including manual
921 additions), not just those actually created by
922 <command>enable
</command>. This call implicitly reloads the
923 systemd daemon configuration after completing the disabling
924 of the units. Note that this command does not implicitly
925 stop the units that are being disabled. If this is desired,
926 an additional
<command>stop
</command> command should be
927 executed afterwards.
</para>
929 <para>This command will print the actions executed. This
930 output may be suppressed by passing
<option>--quiet
</option>.
933 <para>This command honors
<option>--system
</option>,
934 <option>--user
</option>,
<option>--runtime
</option> and
935 <option>--global
</option> in a similar way as
936 <command>enable
</command>.
</para>
941 <term><command>is-enabled
<replaceable>NAME
</replaceable>...
</command></term>
944 <para>Checks whether any of the specified unit files are
945 enabled (as with
<command>enable
</command>). Returns an
946 exit code of
0 if at least one is enabled, non-zero
947 otherwise. Prints the current enable status (see table).
948 To suppress this output, use
<option>--quiet
</option>.
953 <command>is-enabled
</command> output
959 <entry>Printed string
</entry>
960 <entry>Meaning
</entry>
961 <entry>Return value
</entry>
966 <entry><literal>enabled
</literal></entry>
967 <entry morerows='
1'
>Enabled through a symlink in
<filename>.wants
</filename> directory (permanently or just in
<filename>/run
</filename>)
</entry>
968 <entry morerows='
1'
>0</entry>
971 <entry><literal>enabled-runtime
</literal></entry>
974 <entry><literal>linked
</literal></entry>
975 <entry morerows='
1'
>Made available through a symlink to the unit file (permanently or just in
<filename>/run
</filename>)
</entry>
976 <entry morerows='
1'
>1</entry>
979 <entry><literal>linked-runtime
</literal></entry>
982 <entry><literal>masked
</literal></entry>
983 <entry morerows='
1'
>Disabled entirely (permanently or just in
<filename>/run
</filename>)
</entry>
984 <entry morerows='
1'
>1</entry>
987 <entry><literal>masked-runtime
</literal></entry>
990 <entry><literal>static
</literal></entry>
991 <entry>Unit is not enabled, but has no provisions for enabling in [Install] section
</entry>
995 <entry><literal>disabled
</literal></entry>
996 <entry>Unit is not enabled
</entry>
1007 <term><command>reenable
<replaceable>NAME
</replaceable>...
</command></term>
1010 <para>Reenable one or more unit files, as specified on the
1011 command line. This is a combination of
1012 <command>disable
</command> and
<command>enable
</command> and
1013 is useful to reset the symlinks a unit is enabled with to
1014 the defaults configured in the
<literal>[Install]
</literal>
1015 section of the unit file.
</para>
1020 <term><command>preset
<replaceable>NAME
</replaceable>...
</command></term>
1023 <para>Reset one or more unit files, as specified on the
1024 command line, to the defaults configured in the preset
1025 policy files. This has the same effect as
1026 <command>disable
</command> or
<command>enable
</command>,
1027 depending how the unit is listed in the preset files. For
1028 more information on the preset policy format, see
1029 <citerefentry><refentrytitle>systemd.preset
</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1030 For more information on the concept of presets, please
1032 <ulink url=
"http://freedesktop.org/wiki/Software/systemd/Preset">Preset
</ulink>
1038 <term><command>mask
<replaceable>NAME
</replaceable>...
</command></term>
1041 <para>Mask one or more unit files, as specified on the
1042 command line. This will link these units to
1043 <filename>/dev/null
</filename>, making it impossible to
1044 start them. This is a stronger version of
1045 <command>disable
</command>, since it prohibits all kinds of
1046 activation of the unit, including manual activation. Use
1047 this option with care. This honors the
1048 <option>--runtime
</option> option to only mask temporarily
1049 until the next reoobt of the system.
</para>
1054 <term><command>unmask
<replaceable>NAME
</replaceable>...
</command></term>
1057 <para>Unmask one or more unit files, as specified on the
1058 command line. This will undo the effect of
1059 <command>mask
</command>.
</para>
1064 <term><command>link
<replaceable>FILENAME
</replaceable>...
</command></term>
1067 <para>Link a unit file that is not in the unit file search
1068 paths into the unit file search path. This requires an
1069 absolute path to a unit file. The effect of this can be
1070 undone with
<command>disable
</command>. The effect of this
1071 command is that a unit file is available for
1072 <command>start
</command> and other commands although it
1073 is not installed directly in the unit search path.
</para>
1078 <term><command>get-default
</command></term>
1081 <para>Get the default target specified
1082 via
<filename>default.target
</filename> link.
</para>
1087 <term><command>set-default
<replaceable>NAME
</replaceable></command></term>
1090 <para>Set the default target to boot into. Command links
1091 <filename>default.target
</filename> to the given unit.
</para>
1098 <title>Job Commands
</title>
1102 <term><command>list-jobs
<optional><replaceable>PATTERN...
</replaceable></optional></command></term>
1105 <para>List jobs that are in progress. If one or more
1106 <replaceable>PATTERN
</replaceable>s are specified, only
1107 jobs for units matching one of them are shown.
</para>
1111 <term><command>cancel
<replaceable>JOB
</replaceable>...
</command></term>
1114 <para>Cancel one or more jobs specified on the command line
1115 by their numeric job IDs. If no job ID is specified, cancel
1116 all pending jobs.
</para>
1123 <title>Snapshot Commands
</title>
1127 <term><command>snapshot
<optional><replaceable>NAME
</replaceable></optional></command></term>
1130 <para>Create a snapshot. If a snapshot name is specified,
1131 the new snapshot will be named after it. If none is
1132 specified, an automatic snapshot name is generated. In
1133 either case, the snapshot name used is printed to standard
1134 output, unless
<option>--quiet
</option> is specified.
1137 <para>A snapshot refers to a saved state of the systemd
1138 manager. It is implemented itself as a unit that is
1139 generated dynamically with this command and has dependencies
1140 on all units active at the time. At a later time, the user
1141 may return to this state by using the
1142 <command>isolate
</command> command on the snapshot unit.
1145 <para>Snapshots are only useful for saving and restoring
1146 which units are running or are stopped, they do not
1147 save/restore any other state. Snapshots are dynamic and lost
1152 <term><command>delete
<replaceable>PATTERN
</replaceable>...
</command></term>
1155 <para>Remove a snapshot previously created with
1156 <command>snapshot
</command>.
</para>
1163 <title>Environment Commands
</title>
1167 <term><command>show-environment
</command></term>
1170 <para>Dump the systemd manager environment block. The
1171 environment block will be dumped in straight-forward form
1172 suitable for sourcing into a shell script. This environment
1173 block will be passed to all processes the manager
1178 <term><command>set-environment
<replaceable>VARIABLE=VALUE
</replaceable>...
</command></term>
1181 <para>Set one or more systemd manager environment variables,
1182 as specified on the command line.
</para>
1186 <term><command>unset-environment
<replaceable>VARIABLE
</replaceable>...
</command></term>
1189 <para>Unset one or more systemd manager environment
1190 variables. If only a variable name is specified, it will be
1191 removed regardless of its value. If a variable and a value
1192 are specified, the variable is only removed if it has the
1193 specified value.
</para>
1197 <term><command>import-environment
<replaceable>VARIABLE
</replaceable>...
</command></term>
1200 <para>Import all, one or more environment variables set on
1201 the client into the systemd manager environment block. If
1202 no arguments are passed, the entire environment block is
1203 imported. Otherwise, a list of one or more environment
1204 variable names should be passed, whose client-side values
1205 are then imported into the manager's environment
1213 <title>Manager Lifecycle Commands
</title>
1217 <term><command>daemon-reload
</command></term>
1220 <para>Reload systemd manager configuration. This will reload
1221 all unit files and recreate the entire dependency
1222 tree. While the daemon is being reloaded, all sockets systemd
1223 listens on on behalf of user configuration will stay
1224 accessible.
</para> <para>This command should not be confused
1225 with the
<command>load
</command> or
1226 <command>reload
</command> commands.
</para>
1230 <term><command>daemon-reexec
</command></term>
1233 <para>Reexecute the systemd manager. This will serialize the
1234 manager state, reexecute the process and deserialize the
1235 state again. This command is of little use except for
1236 debugging and package upgrades. Sometimes, it might be
1237 helpful as a heavy-weight
<command>daemon-reload
</command>.
1238 While the daemon is being reexecuted, all sockets systemd listening
1239 on behalf of user configuration will stay accessible.
1247 <title>System Commands
</title>
1251 <term><command>default
</command></term>
1254 <para>Enter default mode. This is mostly equivalent to
1255 <command>isolate default.target
</command>.
</para>
1259 <term><command>rescue
</command></term>
1262 <para>Enter rescue mode. This is mostly equivalent to
1263 <command>isolate rescue.target
</command>, but also prints a
1264 wall message to all users.
</para>
1268 <term><command>emergency
</command></term>
1271 <para>Enter emergency mode. This is mostly equivalent to
1272 <command>isolate emergency.target
</command>, but also prints
1273 a wall message to all users.
</para>
1277 <term><command>halt
</command></term>
1280 <para>Shut down and halt the system. This is mostly equivalent to
1281 <command>start halt.target --irreversible
</command>, but also
1282 prints a wall message to all users. If combined with
1283 <option>--force
</option>, shutdown of all running services is
1284 skipped, however all processes are killed and all file
1285 systems are unmounted or mounted read-only, immediately
1286 followed by the system halt. If
<option>--force
</option> is
1287 specified twice, the operation is immediately executed
1288 without terminating any processes or unmounting any file
1289 systems. This may result in data loss.
</para>
1293 <term><command>poweroff
</command></term>
1296 <para>Shut down and power-off the system. This is mostly
1297 equivalent to
<command>start poweroff.target --irreversible
</command>,
1298 but also prints a wall message to all users. If combined with
1299 <option>--force
</option>, shutdown of all running services is
1300 skipped, however all processes are killed and all file
1301 systems are unmounted or mounted read-only, immediately
1302 followed by the powering off. If
<option>--force
</option> is
1303 specified twice, the operation is immediately executed
1304 without terminating any processes or unmounting any file
1305 systems. This may result in data loss.
</para>
1309 <term><command>reboot
<optional><replaceable>arg
</replaceable></optional></command></term>
1312 <para>Shut down and reboot the system. This is mostly
1313 equivalent to
<command>start reboot.target --irreversible
</command>,
1314 but also prints a wall message to all users. If combined with
1315 <option>--force
</option>, shutdown of all running services is
1316 skipped, however all processes are killed and all file
1317 systems are unmounted or mounted read-only, immediately
1318 followed by the reboot. If
<option>--force
</option> is
1319 specified twice, the operation is immediately executed
1320 without terminating any processes or unmounting any file
1321 systems. This may result in data loss.
</para>
1323 <para>If the optional argument
1324 <replaceable>arg
</replaceable> is given, it will be passed
1325 as the optional argument to the
1326 <citerefentry><refentrytitle>reboot
</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1327 system call. The value is architecture and firmware
1328 specific. As an example,
<literal>recovery
</literal> might
1329 be used to trigger system recovery, and
1330 <literal>fota
</literal> might be used to trigger a
1331 <quote>firmware over the air
</quote> update.
</para>
1335 <term><command>kexec
</command></term>
1338 <para>Shut down and reboot the system via kexec. This is
1339 mostly equivalent to
<command>start kexec.target --irreversible
</command>,
1340 but also prints a wall message to all users. If combined
1341 with
<option>--force
</option>, shutdown of all running
1342 services is skipped, however all processes are killed and
1343 all file systems are unmounted or mounted read-only,
1344 immediately followed by the reboot.
</para>
1348 <term><command>exit
</command></term>
1351 <para>Ask the systemd manager to quit. This is only
1352 supported for user service managers (i.e. in conjunction
1353 with the
<option>--user
</option> option) and will fail
1359 <term><command>suspend
</command></term>
1362 <para>Suspend the system. This will trigger activation of
1363 the special
<filename>suspend.target
</filename> target.
1368 <term><command>hibernate
</command></term>
1371 <para>Hibernate the system. This will trigger activation of
1372 the special
<filename>hibernate.target
</filename> target.
1377 <term><command>hybrid-sleep
</command></term>
1380 <para>Hibernate and suspend the system. This will trigger
1381 activation of the special
1382 <filename>hybrid-sleep.target
</filename> target.
</para>
1386 <term><command>switch-root
<replaceable>ROOT
</replaceable> <optional><replaceable>INIT
</replaceable></optional></command></term>
1389 <para>Switches to a different root directory and executes a
1390 new system manager process below it. This is intended for
1391 usage in initial RAM disks (
"initrd"), and will transition
1392 from the initrd's system manager process (a.k.a
"init"
1393 process) to the main system manager process. This call takes two
1394 arguments: the directory that is to become the new root directory, and
1395 the path to the new system manager binary below it to
1396 execute as PID
1. If the latter is omitted or the empty
1397 string, a systemd binary will automatically be searched for
1398 and used as init. If the system manager path is omitted or
1399 equal to the empty string, the state of the initrd's system
1400 manager process is passed to the main system manager, which
1401 allows later introspection of the state of the services
1402 involved in the initrd boot.
</para>
1409 <title>Parameter Syntax
</title>
1411 <para>Unit ommands listed above take either a single unit name
1412 (designated as
<replaceable>NAME
</replaceable>), or multiple
1413 unit specifications (designated as
1414 <replaceable>PATTERN
</replaceable>...). In the first case, the
1415 unit name with or without a suffix must be given. If the suffix
1416 is not specified, systemctl will append a suitable suffix,
1417 <literal>.service
</literal> by default, and a type-specific
1418 suffix in case of commands which operate only on specific unit
1420 <programlisting># systemctl start sshd
</programlisting> and
1421 <programlisting># systemctl start sshd.service
</programlisting>
1422 are equivalent, as are
1423 <programlisting># systemctl isolate snapshot-
11</programlisting>
1425 <programlisting># systemctl isolate snapshot-
11.snapshot
</programlisting>
1426 Note that (absolute) paths to device nodes are automatically
1427 converted to device unit names, and other (absolute) paths to
1429 <programlisting># systemctl status /dev/sda
1430 # systemctl status /home
</programlisting>
1432 <programlisting># systemctl status dev-sda.device
1433 # systemctl status home.mount
</programlisting>
1434 In the second case, shell-style globs will be matched against
1435 currently loaded units; literal unit names, with or without
1436 a suffix, will be treated as in the first case. This means that
1437 literal unit names always refer to exactly one unit, but globs
1438 may match zero units and this is not considered an error.
</para>
1440 <para>Glob patterns use
1441 <citerefentry><refentrytitle>fnmatch
</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
1442 so normal shell-style globbing rules are used, and
1443 <literal>*
</literal>,
<literal>?
</literal>,
1444 <literal>[]
</literal> may be used. See
1445 <citerefentry><refentrytitle>glob
</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1446 for more details. The patterns are matched against the names of
1447 currently loaded units, and patterns which do not match anything
1448 are silently skipped. For example:
1449 <programlisting># systemctl stop sshd@*.service
</programlisting>
1450 will stop all
<filename>sshd@.service
</filename> instances.
1453 <para>For unit file commands, the specified
1454 <replaceable>NAME
</replaceable> should be the full name of the
1455 unit file, or the absolute path to the unit file:
1456 <programlisting># systemctl enable foo.service
</programlisting>
1458 <programlisting># systemctl link /path/to/foo.service
</programlisting>
1465 <title>Exit status
</title>
1467 <para>On success,
0 is returned, a non-zero failure
1468 code otherwise.
</para>
1471 <xi:include href=
"less-variables.xml" />
1474 <title>See Also
</title>
1476 <citerefentry><refentrytitle>systemd
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1477 <citerefentry><refentrytitle>systemadm
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1478 <citerefentry><refentrytitle>journalctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1479 <citerefentry><refentrytitle>loginctl
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1480 <citerefentry><refentrytitle>systemd.unit
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1481 <citerefentry><refentrytitle>systemd.resource-management
</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1482 <citerefentry><refentrytitle>systemd.special
</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1483 <citerefentry><refentrytitle>wall
</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1484 <citerefentry><refentrytitle>systemd.preset
</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1485 <citerefentry><refentrytitle>glob
</refentrytitle><manvolnum>7</manvolnum></citerefentry>