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
560 Note: because the addresses might contains spaces, this output
561 is not suitable for programmatic consumption.
564 <para>See also the options <option>--show-types</option>,
565 <option>--all</option>, and <option>--failed</option>.</para>
570 <term><command>list-timers <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
573 <para>List timer units ordered by the time they elapse
574 next. If one or more <replaceable>PATTERN</replaceable>s
575 are specified, only units matching one of them are shown.
578 <para>See also the options <option>--all</option> and
579 <option>--failed</option>.</para>
584 <term><command>start <replaceable>PATTERN</replaceable>...</command></term>
587 <para>Start (activate) one or more units specified on the
590 <para>Note that glob patterns operate on a list of currently
591 loaded units. Units which are not active and are not in a
592 failed state usually are not loaded, and would not be
593 matched by any pattern. In addition, in case of
594 instantiated units, systemd is often unaware of the
595 instance name until the instance has been started. Therefore
596 using glob patterns with <command>start</command>
597 has limited usefulness.</para>
601 <term><command>stop <replaceable>PATTERN</replaceable>...</command></term>
604 <para>Stop (deactivate) one or more units specified on the
609 <term><command>reload <replaceable>PATTERN</replaceable>...</command></term>
612 <para>Asks all units listed on the command line to reload
613 their configuration. Note that this will reload the
614 service-specific configuration, not the unit configuration
615 file of systemd. If you want systemd to reload the
616 configuration file of a unit, use the
617 <command>daemon-reload</command> command. In other words:
618 for the example case of Apache, this will reload Apache's
619 <filename>httpd.conf</filename> in the web server, not the
620 <filename>apache.service</filename> systemd unit
623 <para>This command should not be confused with the
624 <command>daemon-reload</command> or <command>load</command>
630 <term><command>restart <replaceable>PATTERN</replaceable>...</command></term>
633 <para>Restart one or more units specified on the command
634 line. If the units are not running yet, they will be
639 <term><command>try-restart <replaceable>PATTERN</replaceable>...</command></term>
642 <para>Restart one or more units specified on the command
643 line if the units are running. This does nothing if units are not
644 running. Note that, for compatibility with Red Hat init
645 scripts, <command>condrestart</command> is equivalent to this
650 <term><command>reload-or-restart <replaceable>PATTERN</replaceable>...</command></term>
653 <para>Reload one or more units if they support it. If not,
654 restart them instead. If the units are not running yet, they
655 will be started.</para>
659 <term><command>reload-or-try-restart <replaceable>PATTERN</replaceable>...</command></term>
662 <para>Reload one or more units if they support it. If not,
663 restart them instead. This does nothing if the units are not
664 running. Note that, for compatibility with SysV init scripts,
665 <command>force-reload</command> is equivalent to this
670 <term><command>isolate <replaceable>NAME</replaceable></command></term>
673 <para>Start the unit specified on the command line and its
674 dependencies and stop all others.</para>
676 <para>This is similar to changing the runlevel in a
677 traditional init system. The <command>isolate</command>
678 command will immediately stop processes that are not enabled
679 in the new unit, possibly including the graphical
680 environment or terminal you are currently using.</para>
682 <para>Note that this is allowed only on units where
683 <option>AllowIsolate=</option> is enabled. See
684 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
689 <term><command>kill <replaceable>PATTERN</replaceable>...</command></term>
692 <para>Send a signal to one or more processes of the
693 unit. Use <option>--kill-who=</option> to select which
694 process to kill. Use <option>--kill-mode=</option> to select
695 the kill mode and <option>--signal=</option> to select the
696 signal to send.</para>
700 <term><command>is-active <replaceable>PATTERN</replaceable>...</command></term>
703 <para>Check whether any of the specified units are active
704 (i.e. running). Returns an exit code 0 if at least one is
705 active, or non-zero otherwise. Unless <option>--quiet</option>
706 is specified, this will also print the current unit state to
711 <term><command>is-failed <replaceable>PATTERN</replaceable>...</command></term>
714 <para>Check whether any of the specified units are in a "failed" state.
715 Returns an exit code 0 if at least one has failed, non-zero
716 otherwise. Unless <option>--quiet</option> is specified, this
717 will also print the current unit state to
722 <term><command>status</command> <optional><replaceable>PATTERN</replaceable>...|<replaceable>PID</replaceable>...]</optional></term>
725 <para>Show terse runtime status information about one or
726 more units, followed by most recent log data from the
727 journal. If no units are specified, show all units (subject
728 to limitations specified with <option>-t</option>). If a PID
729 is passed, show information about the unit the process
732 <para>This function is intended to generate human-readable
733 output. If you are looking for computer-parsable output,
734 use <command>show</command> instead. By default this
735 function only shows 10 lines of output and ellipsizes
736 lines to fit in the terminal window. This can be changes
737 with <option>--lines</option> and <option>--full</option>,
738 see above. In addition, <command>journalctl
739 --unit=<replaceable>NAME</replaceable></command> or
741 --user-unit=<replaceable>NAME</replaceable></command> use
742 a similar filter for messages and might be more
748 <term><command>show</command> <optional><replaceable>PATTERN</replaceable>...|<replaceable>JOB</replaceable>...</optional></term>
751 <para>Show properties of one or more units, jobs, or the
752 manager itself. If no argument is specified, properties of
753 the manager will be shown. If a unit name is specified,
754 properties of the unit is shown, and if a job id is
755 specified, properties of the job is shown. By default, empty
756 properties are suppressed. Use <option>--all</option> to
757 show those too. To select specific properties to show, use
758 <option>--property=</option>. This command is intended to be
759 used whenever computer-parsable output is required. Use
760 <command>status</command> if you are looking for formatted
761 human-readable output.</para>
765 <term><command>cat <replaceable>PATTERN</replaceable>...</command></term>
768 <para>Show backing files of one or more units. Prints the
769 "fragment" and "drop-ins" (source files) of units. Each
770 file is preceded by a comment which includes the file
775 <term><command>set-property <replaceable>NAME</replaceable> <replaceable>ASSIGNMENT</replaceable>...</command></term>
778 <para>Set the specified unit properties at runtime where
779 this is supported. This allows changing configuration
780 parameter properties such as resource control settings at
781 runtime. Not all properties may be changed at runtime, but
782 many resource control settings (primarily those in
783 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
784 may. The changes are applied instantly, and stored on disk
785 for future boots, unless <option>--runtime</option> is
786 passed, in which case the settings only apply until the
787 next reboot. The syntax of the property assignment follows
788 closely the syntax of assignments in unit files.</para>
790 <para>Example: <command>systemctl set-property foobar.service CPUShares=777</command></para>
792 <para>Note that this command allows changing multiple
793 properties at the same time, which is preferable over
794 setting them individually. Like unit file configuration
795 settings, assigning the empty list to list parameters will
796 reset the list.</para>
801 <term><command>help <replaceable>PATTERN</replaceable>...|<replaceable>PID</replaceable>...</command></term>
804 <para>Show manual pages for one or more units, if
805 available. If a PID is given, the manual pages for the unit
806 the process belongs to are shown.</para>
811 <term><command>reset-failed [<replaceable>PATTERN</replaceable>...]</command></term>
814 <para>Reset the <literal>failed</literal> state of the
815 specified units, or if no unit name is passed, reset the state of all
816 units. When a unit fails in some way (i.e. process exiting
817 with non-zero error code, terminating abnormally or timing
818 out), it will automatically enter the
819 <literal>failed</literal> state and its exit code and status
820 is recorded for introspection by the administrator until the
821 service is restarted or reset with this command.</para>
826 <term><command>list-dependencies <replaceable>NAME</replaceable></command></term>
829 <para>Shows required and wanted units of the specified
830 unit. If no unit is specified,
831 <filename>default.target</filename> is implied. Target units
832 are recursively expanded. When <option>--all</option> is
833 passed, all other units are recursively expanded as
841 <title>Unit File Commands</title>
845 <term><command>list-unit-files <optional><replaceable>PATTERN...</replaceable></optional></command></term>
848 <para>List installed unit files. If one or more
849 <replaceable>PATTERN</replaceable>s are specified, only
850 units whose filename (just the last component of the path)
851 matches one of them are shown.</para>
856 <term><command>enable <replaceable>NAME</replaceable>...</command></term>
859 <para>Enable one or more unit files or unit file instances,
860 as specified on the command line. This will create a number
861 of symlinks as encoded in the <literal>[Install]</literal>
862 sections of the unit files. After the symlinks have been
863 created, the systemd configuration is reloaded (in a way that
864 is equivalent to <command>daemon-reload</command>) to ensure
865 the changes are taken into account immediately. Note that
866 this does <emphasis>not</emphasis> have the effect of also
867 starting any of the units being enabled. If this
868 is desired, a separate <command>start</command> command must
869 be invoked for the unit. Also note that in case of instance
870 enablement, symlinks named the same as instances are created in
871 the install location, however they all point to the same
872 template unit file.</para>
874 <para>This command will print the actions executed. This
875 output may be suppressed by passing <option>--quiet</option>.
878 <para>Note that this operation creates only the suggested
879 symlinks for the units. While this command is the
880 recommended way to manipulate the unit configuration
881 directory, the administrator is free to make additional
882 changes manually by placing or removing symlinks in the
883 directory. This is particularly useful to create
884 configurations that deviate from the suggested default
885 installation. In this case, the administrator must make sure
886 to invoke <command>daemon-reload</command> manually as
887 necessary to ensure the changes are taken into account.
890 <para>Enabling units should not be confused with starting
891 (activating) units, as done by the <command>start</command>
892 command. Enabling and starting units is orthogonal: units
893 may be enabled without being started and started without
894 being enabled. Enabling simply hooks the unit into various
895 suggested places (for example, so that the unit is
896 automatically started on boot or when a particular kind of
897 hardware is plugged in). Starting actually spawns the daemon
898 process (in case of service units), or binds the socket (in
899 case of socket units), and so on.</para>
901 <para>Depending on whether <option>--system</option>,
902 <option>--user</option>, <option>--runtime</option>,
903 or <option>--global</option> is specified, this enables the unit
904 for the system, for the calling user only, for only this boot of
905 the system, or for all future logins of all users, or only this
906 boot. Note that in the last case, no systemd daemon
907 configuration is reloaded.</para>
912 <term><command>disable <replaceable>NAME</replaceable>...</command></term>
915 <para>Disables one or more units. This removes all symlinks
916 to the specified unit files from the unit configuration
917 directory, and hence undoes the changes made by
918 <command>enable</command>. Note however that this removes
919 all symlinks to the unit files (i.e. including manual
920 additions), not just those actually created by
921 <command>enable</command>. This call implicitly reloads the
922 systemd daemon configuration after completing the disabling
923 of the units. Note that this command does not implicitly
924 stop the units that are being disabled. If this is desired,
925 an additional <command>stop</command> command should be
926 executed afterwards.</para>
928 <para>This command will print the actions executed. This
929 output may be suppressed by passing <option>--quiet</option>.
932 <para>This command honors <option>--system</option>,
933 <option>--user</option>, <option>--runtime</option> and
934 <option>--global</option> in a similar way as
935 <command>enable</command>.</para>
940 <term><command>is-enabled <replaceable>NAME</replaceable>...</command></term>
943 <para>Checks whether any of the specified unit files are
944 enabled (as with <command>enable</command>). Returns an
945 exit code of 0 if at least one is enabled, non-zero
946 otherwise. Prints the current enable status (see table).
947 To suppress this output, use <option>--quiet</option>.
952 <command>is-enabled</command> output
958 <entry>Printed string</entry>
959 <entry>Meaning</entry>
960 <entry>Return value</entry>
965 <entry><literal>enabled</literal></entry>
966 <entry morerows='1'>Enabled through a symlink in <filename>.wants</filename> directory (permanently or just in <filename>/run</filename>)</entry>
967 <entry morerows='1'>0</entry>
970 <entry><literal>enabled-runtime</literal></entry>
973 <entry><literal>linked</literal></entry>
974 <entry morerows='1'>Made available through a symlink to the unit file (permanently or just in <filename>/run</filename>)</entry>
975 <entry morerows='1'>1</entry>
978 <entry><literal>linked-runtime</literal></entry>
981 <entry><literal>masked</literal></entry>
982 <entry morerows='1'>Disabled entirely (permanently or just in <filename>/run</filename>)</entry>
983 <entry morerows='1'>1</entry>
986 <entry><literal>masked-runtime</literal></entry>
989 <entry><literal>static</literal></entry>
990 <entry>Unit is not enabled, but has no provisions for enabling in [Install] section</entry>
994 <entry><literal>disabled</literal></entry>
995 <entry>Unit is not enabled</entry>
1006 <term><command>reenable <replaceable>NAME</replaceable>...</command></term>
1009 <para>Reenable one or more unit files, as specified on the
1010 command line. This is a combination of
1011 <command>disable</command> and <command>enable</command> and
1012 is useful to reset the symlinks a unit is enabled with to
1013 the defaults configured in the <literal>[Install]</literal>
1014 section of the unit file.</para>
1019 <term><command>preset <replaceable>NAME</replaceable>...</command></term>
1022 <para>Reset one or more unit files, as specified on the
1023 command line, to the defaults configured in the preset
1024 policy files. This has the same effect as
1025 <command>disable</command> or <command>enable</command>,
1026 depending how the unit is listed in the preset files. For
1027 more information on the preset policy format, see
1028 <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1029 For more information on the concept of presets, please
1031 <ulink url="http://freedesktop.org/wiki/Software/systemd/Preset">Preset</ulink>
1037 <term><command>mask <replaceable>NAME</replaceable>...</command></term>
1040 <para>Mask one or more unit files, as specified on the
1041 command line. This will link these units to
1042 <filename>/dev/null</filename>, making it impossible to
1043 start them. This is a stronger version of
1044 <command>disable</command>, since it prohibits all kinds of
1045 activation of the unit, including manual activation. Use
1046 this option with care. This honors the
1047 <option>--runtime</option> option to only mask temporarily
1048 until the next reoobt of the system.</para>
1053 <term><command>unmask <replaceable>NAME</replaceable>...</command></term>
1056 <para>Unmask one or more unit files, as specified on the
1057 command line. This will undo the effect of
1058 <command>mask</command>.</para>
1063 <term><command>link <replaceable>FILENAME</replaceable>...</command></term>
1066 <para>Link a unit file that is not in the unit file search
1067 paths into the unit file search path. This requires an
1068 absolute path to a unit file. The effect of this can be
1069 undone with <command>disable</command>. The effect of this
1070 command is that a unit file is available for
1071 <command>start</command> and other commands although it
1072 is not installed directly in the unit search path.</para>
1077 <term><command>get-default</command></term>
1080 <para>Get the default target specified
1081 via <filename>default.target</filename> link.</para>
1086 <term><command>set-default <replaceable>NAME</replaceable></command></term>
1089 <para>Set the default target to boot into. Command links
1090 <filename>default.target</filename> to the given unit.</para>
1097 <title>Job Commands</title>
1101 <term><command>list-jobs <optional><replaceable>PATTERN...</replaceable></optional></command></term>
1104 <para>List jobs that are in progress. If one or more
1105 <replaceable>PATTERN</replaceable>s are specified, only
1106 jobs for units matching one of them are shown.</para>
1110 <term><command>cancel <replaceable>JOB</replaceable>...</command></term>
1113 <para>Cancel one or more jobs specified on the command line
1114 by their numeric job IDs. If no job ID is specified, cancel
1115 all pending jobs.</para>
1122 <title>Snapshot Commands</title>
1126 <term><command>snapshot <optional><replaceable>NAME</replaceable></optional></command></term>
1129 <para>Create a snapshot. If a snapshot name is specified,
1130 the new snapshot will be named after it. If none is
1131 specified, an automatic snapshot name is generated. In either
1132 case, the snapshot name used is printed to STDOUT, unless
1133 <option>--quiet</option> is specified.</para>
1135 <para>A snapshot refers to a saved state of the systemd
1136 manager. It is implemented itself as a unit that is
1137 generated dynamically with this command and has dependencies
1138 on all units active at the time. At a later time, the user
1139 may return to this state by using the
1140 <command>isolate</command> command on the snapshot unit.
1143 <para>Snapshots are only useful for saving and restoring
1144 which units are running or are stopped, they do not
1145 save/restore any other state. Snapshots are dynamic and lost
1150 <term><command>delete <replaceable>PATTERN</replaceable>...</command></term>
1153 <para>Remove a snapshot previously created with
1154 <command>snapshot</command>.</para>
1161 <title>Environment Commands</title>
1165 <term><command>show-environment</command></term>
1168 <para>Dump the systemd manager environment block. The
1169 environment block will be dumped in straight-forward form
1170 suitable for sourcing into a shell script. This environment
1171 block will be passed to all processes the manager
1176 <term><command>set-environment <replaceable>VARIABLE=VALUE</replaceable>...</command></term>
1179 <para>Set one or more systemd manager environment variables,
1180 as specified on the command line.</para>
1184 <term><command>unset-environment <replaceable>VARIABLE</replaceable>...</command></term>
1187 <para>Unset one or more systemd manager environment
1188 variables. If only a variable name is specified, it will be
1189 removed regardless of its value. If a variable and a value
1190 are specified, the variable is only removed if it has the
1191 specified value.</para>
1195 <term><command>import-environment <replaceable>VARIABLE</replaceable>...</command></term>
1198 <para>Import all, one or more environment variables set on
1199 the client into the systemd manager environment block. If
1200 no arguments are passed the entire environment block is
1201 imported. Otherwise a list of one or more environment
1202 variable names should be passed, whose client side values
1203 are then imported into the manager's environment
1211 <title>Manager Lifecycle Commands</title>
1215 <term><command>daemon-reload</command></term>
1218 <para>Reload systemd manager configuration. This will reload
1219 all unit files and recreate the entire dependency
1220 tree. While the daemon is being reloaded, all sockets systemd
1221 listens on on behalf of user configuration will stay
1222 accessible.</para> <para>This command should not be confused
1223 with the <command>load</command> or
1224 <command>reload</command> commands.</para>
1228 <term><command>daemon-reexec</command></term>
1231 <para>Reexecute the systemd manager. This will serialize the
1232 manager state, reexecute the process and deserialize the
1233 state again. This command is of little use except for
1234 debugging and package upgrades. Sometimes, it might be
1235 helpful as a heavy-weight <command>daemon-reload</command>.
1236 While the daemon is being reexecuted, all sockets systemd listening
1237 on behalf of user configuration will stay accessible.
1245 <title>System Commands</title>
1249 <term><command>default</command></term>
1252 <para>Enter default mode. This is mostly equivalent to
1253 <command>isolate default.target</command>.</para>
1257 <term><command>rescue</command></term>
1260 <para>Enter rescue mode. This is mostly equivalent to
1261 <command>isolate rescue.target</command>, but also prints a
1262 wall message to all users.</para>
1266 <term><command>emergency</command></term>
1269 <para>Enter emergency mode. This is mostly equivalent to
1270 <command>isolate emergency.target</command>, but also prints
1271 a wall message to all users.</para>
1275 <term><command>halt</command></term>
1278 <para>Shut down and halt the system. This is mostly equivalent to
1279 <command>start halt.target --irreversible</command>, but also
1280 prints a wall message to all users. If combined with
1281 <option>--force</option>, shutdown of all running services is
1282 skipped, however all processes are killed and all file
1283 systems are unmounted or mounted read-only, immediately
1284 followed by the system halt. If <option>--force</option> is
1285 specified twice, the operation is immediately executed
1286 without terminating any processes or unmounting any file
1287 systems. This may result in data loss.</para>
1291 <term><command>poweroff</command></term>
1294 <para>Shut down and power-off the system. This is mostly
1295 equivalent to <command>start poweroff.target --irreversible</command>,
1296 but also prints a wall message to all users. If combined with
1297 <option>--force</option>, shutdown of all running services is
1298 skipped, however all processes are killed and all file
1299 systems are unmounted or mounted read-only, immediately
1300 followed by the powering off. If <option>--force</option> is
1301 specified twice, the operation is immediately executed
1302 without terminating any processes or unmounting any file
1303 systems. This may result in data loss.</para>
1307 <term><command>reboot <optional><replaceable>arg</replaceable></optional></command></term>
1310 <para>Shut down and reboot the system. This is mostly
1311 equivalent to <command>start reboot.target --irreversible</command>,
1312 but also prints a wall message to all users. If combined with
1313 <option>--force</option>, shutdown of all running services is
1314 skipped, however all processes are killed and all file
1315 systems are unmounted or mounted read-only, immediately
1316 followed by the reboot. If <option>--force</option> is
1317 specified twice, the operation is immediately executed
1318 without terminating any processes or unmounting any file
1319 systems. This may result in data loss.</para>
1321 <para>If the optional argument
1322 <replaceable>arg</replaceable> is given, it will be passed
1323 as the optional argument to the
1324 <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1325 system call. The value is architecture and firmware
1326 specific. As an example, <literal>recovery</literal> might
1327 be used to trigger system recovery, and
1328 <literal>fota</literal> might be used to trigger a
1329 <quote>firmware over the air</quote> update.</para>
1333 <term><command>kexec</command></term>
1336 <para>Shut down and reboot the system via kexec. This is
1337 mostly equivalent to <command>start kexec.target --irreversible</command>,
1338 but also prints a wall message to all users. If combined
1339 with <option>--force</option>, shutdown of all running
1340 services is skipped, however all processes are killed and
1341 all file systems are unmounted or mounted read-only,
1342 immediately followed by the reboot.</para>
1346 <term><command>exit</command></term>
1349 <para>Ask the systemd manager to quit. This is only
1350 supported for user service managers (i.e. in conjunction
1351 with the <option>--user</option> option) and will fail
1357 <term><command>suspend</command></term>
1360 <para>Suspend the system. This will trigger activation of
1361 the special <filename>suspend.target</filename> target.
1366 <term><command>hibernate</command></term>
1369 <para>Hibernate the system. This will trigger activation of
1370 the special <filename>hibernate.target</filename> target.
1375 <term><command>hybrid-sleep</command></term>
1378 <para>Hibernate and suspend the system. This will trigger
1379 activation of the special
1380 <filename>hybrid-sleep.target</filename> target.</para>
1384 <term><command>switch-root <replaceable>ROOT</replaceable> <optional><replaceable>INIT</replaceable></optional></command></term>
1387 <para>Switches to a different root directory and executes a
1388 new system manager process below it. This is intended for
1389 usage in initial RAM disks ("initrd"), and will transition
1390 from the initrd's system manager process (a.k.a "init"
1391 process) to the main system manager process. This call takes two
1392 arguments: the directory that is to become the new root directory, and
1393 the path to the new system manager binary below it to
1394 execute as PID 1. If the latter is omitted or the empty
1395 string, a systemd binary will automatically be searched for
1396 and used as init. If the system manager path is omitted or
1397 equal to the empty string, the state of the initrd's system
1398 manager process is passed to the main system manager, which
1399 allows later introspection of the state of the services
1400 involved in the initrd boot.</para>
1407 <title>Parameter Syntax</title>
1409 <para>Unit ommands listed above take either a single unit name
1410 (designated as <replaceable>NAME</replaceable>), or multiple
1411 unit specifications (designated as
1412 <replaceable>PATTERN</replaceable>...). In the first case, the
1413 unit name with or without a suffix must be given. If the suffix
1414 is not specified, systemctl will append a suitable suffix,
1415 <literal>.service</literal> by default, and a type-specific
1416 suffix in case of commands which operate only on specific unit
1418 <programlisting># systemctl start sshd</programlisting> and
1419 <programlisting># systemctl start sshd.service</programlisting>
1420 are equivalent, as are
1421 <programlisting># systemctl isolate snapshot-11</programlisting>
1423 <programlisting># systemctl isolate snapshot-11.snapshot</programlisting>
1424 Note that (absolute) paths to device nodes are automatically
1425 converted to device unit names, and other (absolute) paths to
1427 <programlisting># systemctl status /dev/sda
1428 # systemctl status /home</programlisting>
1430 <programlisting># systemctl status dev-sda.device
1431 # systemctl status home.mount</programlisting>
1432 In the second case, shell-style globs will be matched against
1433 currently loaded units, and literal unit names, with or without
1434 a suffix, will be treated as in the first case. This means that
1435 literal unit names always refer to exactly one unit, but globs
1436 may match zero units and this is not considered an error.</para>
1438 <para>Glob patterns use
1439 <citerefentry><refentrytitle>fnmatch</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
1440 so normal shell-style globbing rules are used, and
1441 <literal>*</literal>, <literal>?</literal>,
1442 <literal>[]</literal> may be used. See
1443 <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1444 for more details. The patterns are matched against the names of
1445 currently loaded units, and patterns which don't match anything
1446 are silently skipped. For example:
1447 <programlisting># systemctl stop sshd@*.service</programlisting>
1448 will stop all <filename>sshd@.service</filename> instances.
1451 <para>For unit file commands, the specified
1452 <replaceable>NAME</replaceable> should be the full name of the
1453 unit file, or the absolute path to the unit file:
1454 <programlisting># systemctl enable foo.service</programlisting>
1456 <programlisting># systemctl link /path/to/foo.service</programlisting>
1463 <title>Exit status</title>
1465 <para>On success, 0 is returned, a non-zero failure
1466 code otherwise.</para>
1469 <xi:include href="less-variables.xml" />
1472 <title>See Also</title>
1474 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1475 <citerefentry><refentrytitle>systemadm</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1476 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1477 <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1478 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1479 <citerefentry><refentrytitle>systemd.resource-management</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1480 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1481 <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1482 <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1483 <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>