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">
27 <title>systemctl</title>
28 <productname>systemd</productname>
32 <contrib>Developer</contrib>
33 <firstname>Lennart</firstname>
34 <surname>Poettering</surname>
35 <email>lennart@poettering.net</email>
41 <refentrytitle>systemctl</refentrytitle>
42 <manvolnum>1</manvolnum>
46 <refname>systemctl</refname>
47 <refpurpose>Control the systemd system and service manager</refpurpose>
52 <command>systemctl</command>
53 <arg choice="opt" rep="repeat">OPTIONS</arg>
54 <arg choice="plain">COMMAND</arg>
55 <arg choice="opt" rep="repeat">NAME</arg>
60 <title>Description</title>
62 <para><command>systemctl</command> may be used to
63 introspect and control the state of the
64 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
65 system and service manager.</para>
69 <title>Options</title>
71 <para>The following options are understood:</para>
75 <term><option>-h</option></term>
76 <term><option>--help</option></term>
78 <listitem><para>Prints a short help
79 text and exits.</para></listitem>
83 <term><option>--version</option></term>
86 <para>Prints a short version string and exits.</para>
91 <term><option>-t</option></term>
92 <term><option>--type=</option></term>
95 <para>The argument should be a comma-separated list of unit
96 types such as <option>service</option> and
97 <option>socket</option>.
100 <para>If one of the arguments is a unit type, when listing
101 units, limit display to certain unit types. Otherwise, units
102 of all types will be shown.</para>
104 <para>As a special case, if one of the arguments is
105 <option>help</option>, a list of allowed values will be
106 printed and the program will exit.</para>
111 <term><option>--state=</option></term>
114 <para>The argument should be a comma-separated list of unit LOAD,
115 SUB, or ACTIVE states. When listing units, show only those
116 in specified states.</para>
121 <term><option>-p</option></term>
122 <term><option>--property=</option></term>
125 <para>When showing unit/job/manager properties with the
126 <command>show</command> command, limit display to certain
127 properties as specified as argument. If not specified, all
128 set properties are shown. The argument should be a
129 comma-separated list of property names, such as
130 <literal>MainPID</literal>. If specified more than once, all
131 properties with the specified names are shown.</para>
136 <term><option>-a</option></term>
137 <term><option>--all</option></term>
140 <para>When listing units, show all loaded units, regardless
141 of their state, including inactive units. When showing
142 unit/job/manager properties, show all properties regardless
143 whether they are set or not.</para>
144 <para>To list all units installed on the system, use the
145 <command>list-unit-files</command> command instead.</para>
150 <term><option>--reverse</option></term>
153 <para>Show reverse dependencies between units with
154 <command>list-dependencies</command>, i.e. units with
155 dependencies of type <varname>Wants=</varname> or
156 <varname>Requires=</varname> on the given unit.
162 <term><option>--after</option></term>
163 <term><option>--before</option></term>
166 <para>Show which units are started after or before
167 with <command>list-dependencies</command>, respectively.
173 <term><option>-l</option></term>
174 <term><option>--full</option></term>
177 <para>Do not ellipsize unit names, process tree entries, and
178 truncate unit descriptions in the output of
179 <command>list-units</command> and
180 <command>list-jobs</command>.</para>
185 <term><option>--show-types</option></term>
188 <para>When showing sockets, show the type of the socket.</para>
193 <term><option>--job-mode=</option></term>
196 <para>When queuing a new job, control how to deal with already
197 queued jobs. Takes one of <literal>fail</literal>,
198 <literal>replace</literal>,
199 <literal>replace-irreversibly</literal>,
200 <literal>isolate</literal>,
201 <literal>ignore-dependencies</literal>,
202 <literal>ignore-requirements</literal> or
203 <literal>flush</literal>. Defaults to
204 <literal>replace</literal>, except when the
205 <command>isolate</command> command is used which implies the
206 <literal>isolate</literal> job mode.</para>
208 <para>If <literal>fail</literal> is specified and a requested
209 operation conflicts with a pending job (more specifically:
210 causes an already pending start job to be reversed into a stop
211 job or vice versa), cause the operation to fail.</para>
213 <para>If <literal>replace</literal> (the default) is
214 specified, any conflicting pending job will be replaced, as
217 <para>If <literal>replace-irreversibly</literal> is specified,
218 operate like <literal>replace</literal>, but also mark the new
219 jobs as irreversible. This prevents future conflicting
220 transactions from replacing these jobs. The jobs can still be
221 cancelled using the <command>cancel</command> command.</para>
223 <para><literal>isolate</literal> is only valid for start
224 operations and causes all other units to be stopped when the
225 specified unit is started. This mode is always used when the
226 <command>isolate</command> command is used.</para>
228 <para><literal>flush</literal> will cause all queued jobs to
229 be canceled when the new job is enqueued.</para>
231 <para>If <literal>ignore-dependencies</literal> is specified,
232 then all unit dependencies are ignored for this new job and
233 the operation is executed immediately. If passed, no required
234 units of the unit passed will be pulled in, and no ordering
235 dependencies will be honored. This is mostly a debugging and
236 rescue tool for the administrator and should not be used by
239 <para><literal>ignore-requirements</literal> is similar to
240 <literal>ignore-dependencies</literal> but only causes the
241 requirement dependencies to be ignored, the ordering
242 dependencies will still be honoured.</para>
248 <term><option>-i</option></term>
249 <term><option>--ignore-inhibitors</option></term>
252 <para>When system shutdown or a sleep state is requested,
253 ignore inhibitor locks. Applications can establish inhibitor
254 locks to avoid that certain important operations (such as CD
255 burning or suchlike) are interrupted by system shutdown or a
256 sleep state. Any user may take these locks and privileged
257 users may override these locks. If any locks are taken,
258 shutdown and sleep state requests will normally fail
259 (regardless if privileged or not) and a list of active locks
260 is printed. However, if <option>--ignore-inhibitors</option>
261 is specified, the locks are ignored and not printed, and the
262 operation attempted anyway, possibly requiring additional
268 <term><option>-q</option></term>
269 <term><option>--quiet</option></term>
272 <para>Suppress output to standard output in
273 <command>snapshot</command>,
274 <command>is-active</command>,
275 <command>is-failed</command>,
276 <command>enable</command> and
277 <command>disable</command>.</para>
282 <term><option>--no-block</option></term>
285 <para>Do not synchronously wait for the requested operation
286 to finish. If this is not specified, the job will be
287 verified, enqueued and <command>systemctl</command> will
288 wait until it is completed. By passing this argument, it is
289 only verified and enqueued.</para>
294 <term><option>--no-legend</option></term>
297 <para>Do not print a legend, i.e. the column headers and
298 the footer with hints.</para>
303 <term><option>--no-pager</option></term>
306 <para>Do not pipe output into a pager.</para>
311 <term><option>--system</option></term>
314 <para>Talk to the systemd system manager. (Default)</para>
319 <term><option>--user</option></term>
322 <para>Talk to the systemd manager of the calling
328 <term><option>--no-wall</option></term>
331 <para>Do not send wall message before halt, power-off,
337 <term><option>--global</option></term>
340 <para>When used with <command>enable</command> and
341 <command>disable</command>, operate on the global user
342 configuration directory, thus enabling or disabling a unit
343 file globally for all future logins of all users.</para>
348 <term><option>--no-reload</option></term>
351 <para>When used with <command>enable</command> and
352 <command>disable</command>, do not implicitly reload daemon
353 configuration after executing the changes.</para>
358 <term><option>--no-ask-password</option></term>
361 <para>When used with <command>start</command> and related
362 commands, disables asking for passwords. Background services
363 may require input of a password or passphrase string, for
364 example to unlock system hard disks or cryptographic
365 certificates. Unless this option is specified and the
366 command is invoked from a terminal,
367 <command>systemctl</command> will query the user on the
368 terminal for the necessary secrets. Use this option to
369 switch this behavior off. In this case, the password must be
370 supplied by some other means (for example graphical password
371 agents) or the service might fail. This also disables
372 querying the user for authentication for privileged
379 <term><option>--kill-who=</option></term>
382 <para>When used with <command>kill</command>, choose which
383 processes to kill. Must be one of <option>main</option>,
384 <option>control</option> or <option>all</option> to select
385 whether to kill only the main process of the unit, the
386 control process or all processes of the unit. If omitted,
387 defaults to <option>all</option>.</para>
393 <term><option>-s</option></term>
394 <term><option>--signal=</option></term>
397 <para>When used with <command>kill</command>, choose which
398 signal to send to selected processes. Must be one of the
399 well known signal specifiers such as <constant>SIGTERM</constant>, <constant>SIGINT</constant> or
400 <constant>SIGSTOP</constant>. If omitted, defaults to
401 <option>SIGTERM</option>.</para>
406 <term><option>-f</option></term>
407 <term><option>--force</option></term>
410 <para>When used with <command>enable</command>, overwrite
411 any existing conflicting symlinks.</para>
413 <para>When used with <command>halt</command>,
414 <command>poweroff</command>, <command>reboot</command> or
415 <command>kexec</command>, execute the selected operation
416 without shutting down all units. However, all processes will
417 be killed forcibly and all file systems are unmounted or
418 remounted read-only. This is hence a drastic but relatively
419 safe option to request an immediate reboot. If
420 <option>--force</option> is specified twice for these
421 operations, they will be executed immediately without
422 terminating any processes or umounting any file
423 systems. Warning: specifying <option>--force</option> twice
424 with any of these operations might result in data
430 <term><option>--root=</option></term>
434 <command>enable</command>/<command>disable</command>/<command>is-enabled</command>
435 (and related commands), use alternative root path when
436 looking for unit files.</para>
442 <term><option>--runtime</option></term>
445 <para>When used with <command>enable</command>,
446 <command>disable</command>,
447 (and related commands), make changes only temporarily, so
448 that they are lost on the next reboot. This will have the
449 effect that changes are not made in subdirectories of
450 <filename>/etc</filename> but in <filename>/run</filename>,
451 with identical immediate effects, however, since the latter
452 is lost on reboot, the changes are lost too.</para>
454 <para>Similar, when used with
455 <command>set-property</command>, make changes only
456 temporarily, so that they are lost on the next
462 <term><option>-H</option></term>
463 <term><option>--host</option></term>
466 <para>Execute the operation remotely. Specify a hostname, or
467 username and hostname separated by <literal>@</literal>, to
468 connect to. This will use SSH to talk to the remote systemd
474 <term><option>-M</option></term>
475 <term><option>--machine=</option></term>
477 <listitem><para>Execute the operation on a local
478 container. Specify a container name to connect
479 to.</para></listitem>
483 <term><option>-n</option></term>
484 <term><option>--lines=</option></term>
487 <para>When used with <command>status</command>, controls the
488 number of journal lines to show, counting from the most
489 recent ones. Takes a positive integer argument. Defaults to
495 <term><option>-o</option></term>
496 <term><option>--output=</option></term>
499 <para>When used with <command>status</command>, controls the
500 formatting of the journal entries that are shown. For the
501 available choices, see
502 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
503 Defaults to <literal>short</literal>.</para>
508 <term><option>--plain</option></term>
511 <para>When used with <command>list-dependencies</command>,
512 the output is printed as a list instead of a tree.</para>
520 <title>Commands</title>
522 <para>The following commands are understood:</para>
525 <title>Unit Commands</title>
529 <term><command>list-units <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
532 <para>List known units (subject to limitations specified
533 with <option>-t</option>). If one or more
534 <replaceable>PATTERN</replaceable>s are specified, only
535 units matching one of them are shown.</para>
537 <para>This is the default command.</para>
542 <term><command>list-sockets <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
545 <para>List socket units ordered by the listening address.
546 If one or more <replaceable>PATTERN</replaceable>s are
547 specified, only socket units matching one of them are
548 shown. Produces output similar to
550 LISTEN UNIT ACTIVATES
551 /dev/initctl systemd-initctl.socket systemd-initctl.service
553 [::]:22 sshd.socket sshd.service
554 kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
558 Note: because the addresses might contains spaces, this output
559 is not suitable for programmatic consumption.
562 <para>See also the options <option>--show-types</option>,
563 <option>--all</option>, and <option>--failed</option>.</para>
568 <term><command>list-timers <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
571 <para>List timer units ordered by the time they elapse
572 next. If one or more <replaceable>PATTERN</replaceable>s
573 are specified, only units matching one of them are shown.
576 <para>See also the options <option>--all</option> and
577 <option>--failed</option>.</para>
582 <term><command>start <replaceable>NAME</replaceable>...</command></term>
585 <para>Start (activate) one or more units specified on the
590 <term><command>stop <replaceable>NAME</replaceable>...</command></term>
593 <para>Stop (deactivate) one or more units specified on the
598 <term><command>reload <replaceable>NAME</replaceable>...</command></term>
601 <para>Asks all units listed on the command line to reload
602 their configuration. Note that this will reload the
603 service-specific configuration, not the unit configuration
604 file of systemd. If you want systemd to reload the
605 configuration file of a unit, use the
606 <command>daemon-reload</command> command. In other words:
607 for the example case of Apache, this will reload Apache's
608 <filename>httpd.conf</filename> in the web server, not the
609 <filename>apache.service</filename> systemd unit
612 <para>This command should not be confused with the
613 <command>daemon-reload</command> or <command>load</command>
619 <term><command>restart <replaceable>NAME</replaceable>...</command></term>
622 <para>Restart one or more units specified on the command
623 line. If the units are not running yet, they will be
628 <term><command>try-restart <replaceable>NAME</replaceable>...</command></term>
631 <para>Restart one or more units specified on the command
632 line if the units are running. This does nothing if units are not
633 running. Note that, for compatibility with Red Hat init
634 scripts, <command>condrestart</command> is equivalent to this
639 <term><command>reload-or-restart <replaceable>NAME</replaceable>...</command></term>
642 <para>Reload one or more units if they support it. If not,
643 restart them instead. If the units are not running yet, they
644 will be started.</para>
648 <term><command>reload-or-try-restart <replaceable>NAME</replaceable>...</command></term>
651 <para>Reload one or more units if they support it. If not,
652 restart them instead. This does nothing if the units are not
653 running. Note that, for compatibility with SysV init scripts,
654 <command>force-reload</command> is equivalent to this
659 <term><command>isolate <replaceable>NAME</replaceable></command></term>
662 <para>Start the unit specified on the command line and its
663 dependencies and stop all others.</para>
665 <para>This is similar to changing the runlevel in a
666 traditional init system. The <command>isolate</command>
667 command will immediately stop processes that are not enabled
668 in the new unit, possibly including the graphical
669 environment or terminal you are currently using.</para>
671 <para>Note that this is allowed only on units where
672 <option>AllowIsolate=</option> is enabled. See
673 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
678 <term><command>kill <replaceable>NAME</replaceable>...</command></term>
681 <para>Send a signal to one or more processes of the
682 unit. Use <option>--kill-who=</option> to select which
683 process to kill. Use <option>--kill-mode=</option> to select
684 the kill mode and <option>--signal=</option> to select the
685 signal to send.</para>
689 <term><command>is-active <replaceable>NAME</replaceable>...</command></term>
692 <para>Check whether any of the specified units are active
693 (i.e. running). Returns an exit code 0 if at least one is
694 active, non-zero otherwise. Unless <option>--quiet</option>
695 is specified, this will also print the current unit state to
700 <term><command>is-failed <replaceable>NAME</replaceable>...</command></term>
703 <para>Check whether any of the specified units are in a "failed" state.
704 Returns an exit code 0 if at least one has failed, non-zero
705 otherwise. Unless <option>--quiet</option> is specified, this
706 will also print the current unit state to
711 <term><command>status</command> <optional><replaceable>NAME</replaceable>...|<replaceable>PID</replaceable>...]</optional></term>
714 <para>Show terse runtime status information about one or
715 more units, followed by most recent log data from the
716 journal. If no units are specified, show all units (subject
717 to limitations specified with <option>-t</option>). If a PID
718 is passed, show information about the unit the process
721 <para>This function is intended to generate human-readable
722 output. If you are looking for computer-parsable output, use
723 <command>show</command> instead.</para>
727 <term><command>show</command> <optional><replaceable>NAME</replaceable>...|<replaceable>JOB</replaceable>...</optional></term>
730 <para>Show properties of one or more units, jobs, or the
731 manager itself. If no argument is specified, properties of
732 the manager will be shown. If a unit name is specified,
733 properties of the unit is shown, and if a job id is
734 specified, properties of the job is shown. By default, empty
735 properties are suppressed. Use <option>--all</option> to
736 show those too. To select specific properties to show, use
737 <option>--property=</option>. This command is intended to be
738 used whenever computer-parsable output is required. Use
739 <command>status</command> if you are looking for formatted
740 human-readable output.</para>
744 <term><command>cat <replaceable>NAME</replaceable>...</command></term>
747 <para>Show backing files of one or more units. Prints the
748 "fragment" and "drop-ins" (source files) of units. Each
749 file is preceded by a comment which includes the file
754 <term><command>set-property <replaceable>NAME</replaceable> <replaceable>ASSIGNMENT</replaceable>...</command></term>
757 <para>Set the specified unit properties at runtime where
758 this is supported. This allows changing configuration
759 parameter properties such as resource control settings at
760 runtime. Not all properties may be changed at runtime, but
761 many resource control settings (primarily those in
762 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
763 may. The changes are applied instantly, and stored on disk
764 for future boots, unless <option>--runtime</option> is
765 passed, in which case the settings only apply until the
766 next reboot. The syntax of the property assignment follows
767 closely the syntax of assignments in unit files.</para>
769 <para>Example: <command>systemctl set-property foobar.service CPUShares=777</command></para>
771 <para>Note that this command allows changing multiple
772 properties at the same time, which is preferable over
773 setting them individually. Like unit file configuration
774 settings, assigning the empty list to list parameters will
775 reset the list.</para>
780 <term><command>help <replaceable>NAME</replaceable>...|<replaceable>PID</replaceable>...</command></term>
783 <para>Show manual pages for one or more units, if
784 available. If a PID is given, the manual pages for the unit
785 the process belongs to are shown.</para>
790 <term><command>reset-failed [<replaceable>NAME</replaceable>...]</command></term>
793 <para>Reset the <literal>failed</literal> state of the
794 specified units, or if no unit name is passed, reset the state of all
795 units. When a unit fails in some way (i.e. process exiting
796 with non-zero error code, terminating abnormally or timing
797 out), it will automatically enter the
798 <literal>failed</literal> state and its exit code and status
799 is recorded for introspection by the administrator until the
800 service is restarted or reset with this command.</para>
805 <term><command>list-dependencies <replaceable>NAME</replaceable></command></term>
808 <para>Shows required and wanted units of the specified
809 unit. If no unit is specified,
810 <filename>default.target</filename> is implied. Target units
811 are recursively expanded. When <option>--all</option> is
812 passed, all other units are recursively expanded as
820 <title>Unit File Commands</title>
824 <term><command>list-unit-files <optional><replaceable>PATTERN...</replaceable></optional></command></term>
827 <para>List installed unit files. If one or more
828 <replaceable>PATTERN</replaceable>s are specified, only
829 units whose filename (just the last component of the path)
830 matches one of them are shown.</para>
835 <term><command>enable <replaceable>NAME</replaceable>...</command></term>
838 <para>Enable one or more unit files or unit file instances,
839 as specified on the command line. This will create a number
840 of symlinks as encoded in the <literal>[Install]</literal>
841 sections of the unit files. After the symlinks have been
842 created, the systemd configuration is reloaded (in a way that
843 is equivalent to <command>daemon-reload</command>) to ensure
844 the changes are taken into account immediately. Note that
845 this does <emphasis>not</emphasis> have the effect of also
846 starting any of the units being enabled. If this
847 is desired, a separate <command>start</command> command must
848 be invoked for the unit. Also note that in case of instance
849 enablement, symlinks named the same as instances are created in
850 the install location, however they all point to the same
851 template unit file.</para>
853 <para>This command will print the actions executed. This
854 output may be suppressed by passing <option>--quiet</option>.
857 <para>Note that this operation creates only the suggested
858 symlinks for the units. While this command is the
859 recommended way to manipulate the unit configuration
860 directory, the administrator is free to make additional
861 changes manually by placing or removing symlinks in the
862 directory. This is particularly useful to create
863 configurations that deviate from the suggested default
864 installation. In this case, the administrator must make sure
865 to invoke <command>daemon-reload</command> manually as
866 necessary to ensure the changes are taken into account.
869 <para>Enabling units should not be confused with starting
870 (activating) units, as done by the <command>start</command>
871 command. Enabling and starting units is orthogonal: units
872 may be enabled without being started and started without
873 being enabled. Enabling simply hooks the unit into various
874 suggested places (for example, so that the unit is
875 automatically started on boot or when a particular kind of
876 hardware is plugged in). Starting actually spawns the daemon
877 process (in case of service units), or binds the socket (in
878 case of socket units), and so on.</para>
880 <para>Depending on whether <option>--system</option>,
881 <option>--user</option>, <option>--runtime</option>,
882 or <option>--global</option> is specified, this enables the unit
883 for the system, for the calling user only, for only this boot of
884 the system, or for all future logins of all users, or only this
885 boot. Note that in the last case, no systemd daemon
886 configuration is reloaded.</para>
891 <term><command>disable <replaceable>NAME</replaceable>...</command></term>
894 <para>Disables one or more units. This removes all symlinks
895 to the specified unit files from the unit configuration
896 directory, and hence undoes the changes made by
897 <command>enable</command>. Note however that this removes
898 all symlinks to the unit files (i.e. including manual
899 additions), not just those actually created by
900 <command>enable</command>. This call implicitly reloads the
901 systemd daemon configuration after completing the disabling
902 of the units. Note that this command does not implicitly
903 stop the units that are being disabled. If this is desired,
904 an additional <command>stop</command> command should be
905 executed afterwards.</para>
907 <para>This command will print the actions executed. This
908 output may be suppressed by passing <option>--quiet</option>.
911 <para>This command honors <option>--system</option>,
912 <option>--user</option>, <option>--runtime</option> and
913 <option>--global</option> in a similar way as
914 <command>enable</command>.</para>
919 <term><command>is-enabled <replaceable>NAME</replaceable>...</command></term>
922 <para>Checks whether any of the specified unit files are
923 enabled (as with <command>enable</command>). Returns an
924 exit code of 0 if at least one is enabled, non-zero
925 otherwise. Prints the current enable status (see table).
926 To suppress this output, use <option>--quiet</option>.
931 <command>is-enabled</command> output
937 <entry>Printed string</entry>
938 <entry>Meaning</entry>
939 <entry>Return value</entry>
944 <entry><literal>enabled</literal></entry>
945 <entry morerows='1'>Enabled through a symlink in <filename>.wants</filename> directory (permanently or just in <filename>/run</filename>)</entry>
946 <entry morerows='1'>0</entry>
949 <entry><literal>enabled-runtime</literal></entry>
952 <entry><literal>linked</literal></entry>
953 <entry morerows='1'>Made available through a symlink to the unit file (permanently or just in <filename>/run</filename>)</entry>
954 <entry morerows='1'>1</entry>
957 <entry><literal>linked-runtime</literal></entry>
960 <entry><literal>masked</literal></entry>
961 <entry morerows='1'>Disabled entirely (permanently or just in <filename>/run</filename>)</entry>
962 <entry morerows='1'>1</entry>
965 <entry><literal>masked-runtime</literal></entry>
968 <entry><literal>static</literal></entry>
969 <entry>Unit is not enabled, but has no provisions for enabling in [Install] section</entry>
973 <entry><literal>disabled</literal></entry>
974 <entry>Unit is not enabled</entry>
985 <term><command>reenable <replaceable>NAME</replaceable>...</command></term>
988 <para>Reenable one or more unit files, as specified on the
989 command line. This is a combination of
990 <command>disable</command> and <command>enable</command> and
991 is useful to reset the symlinks a unit is enabled with to
992 the defaults configured in the <literal>[Install]</literal>
993 section of the unit file.</para>
998 <term><command>preset <replaceable>NAME</replaceable>...</command></term>
1001 <para>Reset one or more unit files, as specified on the
1002 command line, to the defaults configured in the preset
1003 policy files. This has the same effect as
1004 <command>disable</command> or <command>enable</command>,
1005 depending how the unit is listed in the preset files. For
1006 more information on the preset policy format, see
1007 <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1008 For more information on the concept of presets, please
1010 <ulink url="http://freedesktop.org/wiki/Software/systemd/Preset">Preset</ulink>
1016 <term><command>mask <replaceable>NAME</replaceable>...</command></term>
1019 <para>Mask one or more unit files, as specified on the
1020 command line. This will link these units to
1021 <filename>/dev/null</filename>, making it impossible to
1022 start them. This is a stronger version of
1023 <command>disable</command>, since it prohibits all kinds of
1024 activation of the unit, including manual activation. Use
1025 this option with care. This honors the
1026 <option>--runtime</option> option to only mask temporarily
1027 until the next reoobt of the system.</para>
1032 <term><command>unmask <replaceable>NAME</replaceable>...</command></term>
1035 <para>Unmask one or more unit files, as specified on the
1036 command line. This will undo the effect of
1037 <command>mask</command>.</para>
1042 <term><command>link <replaceable>FILENAME</replaceable>...</command></term>
1045 <para>Link a unit file that is not in the unit file search
1046 paths into the unit file search path. This requires an
1047 absolute path to a unit file. The effect of this can be
1048 undone with <command>disable</command>. The effect of this
1049 command is that a unit file is available for
1050 <command>start</command> and other commands although it
1051 is not installed directly in the unit search path.</para>
1056 <term><command>get-default</command></term>
1059 <para>Get the default target specified
1060 via <filename>default.target</filename> link.</para>
1065 <term><command>set-default <replaceable>NAME</replaceable></command></term>
1068 <para>Set the default target to boot into. Command links
1069 <filename>default.target</filename> to the given unit.</para>
1076 <title>Job Commands</title>
1080 <term><command>list-jobs <optional><replaceable>PATTERN...</replaceable></optional></command></term>
1083 <para>List jobs that are in progress. If one or more
1084 <replaceable>PATTERN</replaceable>s are specified, only
1085 jobs for units matching one of them are shown.</para>
1089 <term><command>cancel <replaceable>JOB</replaceable>...</command></term>
1092 <para>Cancel one or more jobs specified on the command line
1093 by their numeric job IDs. If no job ID is specified, cancel
1094 all pending jobs.</para>
1101 <title>Snapshot Commands</title>
1105 <term><command>snapshot <optional><replaceable>NAME</replaceable></optional></command></term>
1108 <para>Create a snapshot. If a snapshot name is specified,
1109 the new snapshot will be named after it. If none is
1110 specified, an automatic snapshot name is generated. In either
1111 case, the snapshot name used is printed to STDOUT, unless
1112 <option>--quiet</option> is specified.</para>
1114 <para>A snapshot refers to a saved state of the systemd
1115 manager. It is implemented itself as a unit that is
1116 generated dynamically with this command and has dependencies
1117 on all units active at the time. At a later time, the user
1118 may return to this state by using the
1119 <command>isolate</command> command on the snapshot unit.
1122 <para>Snapshots are only useful for saving and restoring
1123 which units are running or are stopped, they do not
1124 save/restore any other state. Snapshots are dynamic and lost
1129 <term><command>delete <replaceable>NAME</replaceable>...</command></term>
1132 <para>Remove a snapshot previously created with
1133 <command>snapshot</command>.</para>
1140 <title>Environment Commands</title>
1144 <term><command>show-environment</command></term>
1147 <para>Dump the systemd manager environment block. The
1148 environment block will be dumped in straight-forward form
1149 suitable for sourcing into a shell script. This environment
1150 block will be passed to all processes the manager
1155 <term><command>set-environment <replaceable>VARIABLE=VALUE</replaceable>...</command></term>
1158 <para>Set one or more systemd manager environment variables,
1159 as specified on the command line.</para>
1163 <term><command>unset-environment <replaceable>VARIABLE</replaceable>...</command></term>
1166 <para>Unset one or more systemd manager environment
1167 variables. If only a variable name is specified, it will be
1168 removed regardless of its value. If a variable and a value
1169 are specified, the variable is only removed if it has the
1170 specified value.</para>
1177 <title>Manager Lifecycle Commands</title>
1181 <term><command>daemon-reload</command></term>
1184 <para>Reload systemd manager configuration. This will reload
1185 all unit files and recreate the entire dependency
1186 tree. While the daemon is being reloaded, all sockets systemd
1187 listens on on behalf of user configuration will stay
1188 accessible.</para> <para>This command should not be confused
1189 with the <command>load</command> or
1190 <command>reload</command> commands.</para>
1194 <term><command>daemon-reexec</command></term>
1197 <para>Reexecute the systemd manager. This will serialize the
1198 manager state, reexecute the process and deserialize the
1199 state again. This command is of little use except for
1200 debugging and package upgrades. Sometimes, it might be
1201 helpful as a heavy-weight <command>daemon-reload</command>.
1202 While the daemon is being reexecuted, all sockets systemd listening
1203 on behalf of user configuration will stay accessible.
1211 <title>System Commands</title>
1215 <term><command>default</command></term>
1218 <para>Enter default mode. This is mostly equivalent to
1219 <command>isolate default.target</command>.</para>
1223 <term><command>rescue</command></term>
1226 <para>Enter rescue mode. This is mostly equivalent to
1227 <command>isolate rescue.target</command>, but also prints a
1228 wall message to all users.</para>
1232 <term><command>emergency</command></term>
1235 <para>Enter emergency mode. This is mostly equivalent to
1236 <command>isolate emergency.target</command>, but also prints
1237 a wall message to all users.</para>
1241 <term><command>halt</command></term>
1244 <para>Shut down and halt the system. This is mostly equivalent to
1245 <command>start halt.target --irreversible</command>, but also
1246 prints a wall message to all users. If combined with
1247 <option>--force</option>, shutdown of all running services is
1248 skipped, however all processes are killed and all file
1249 systems are unmounted or mounted read-only, immediately
1250 followed by the system halt. If <option>--force</option> is
1251 specified twice, the operation is immediately executed
1252 without terminating any processes or unmounting any file
1253 systems. This may result in data loss.</para>
1257 <term><command>poweroff</command></term>
1260 <para>Shut down and power-off the system. This is mostly
1261 equivalent to <command>start poweroff.target --irreversible</command>,
1262 but also prints a wall message to all users. If combined with
1263 <option>--force</option>, shutdown of all running services is
1264 skipped, however all processes are killed and all file
1265 systems are unmounted or mounted read-only, immediately
1266 followed by the powering off. If <option>--force</option> is
1267 specified twice, the operation is immediately executed
1268 without terminating any processes or unmounting any file
1269 systems. This may result in data loss.</para>
1273 <term><command>reboot <optional><replaceable>arg</replaceable></optional></command></term>
1276 <para>Shut down and reboot the system. This is mostly
1277 equivalent to <command>start reboot.target --irreversible</command>,
1278 but also prints a wall message to all users. If combined with
1279 <option>--force</option>, shutdown of all running services is
1280 skipped, however all processes are killed and all file
1281 systems are unmounted or mounted read-only, immediately
1282 followed by the reboot. If <option>--force</option> is
1283 specified twice, the operation is immediately executed
1284 without terminating any processes or unmounting any file
1285 systems. This may result in data loss.</para>
1287 <para>If the optional argument
1288 <replaceable>arg</replaceable> is given, it will be passed
1289 as the optional argument to the
1290 <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1291 system call. The value is architecture and firmware
1292 specific. As an example, <literal>recovery</literal> might
1293 be used to trigger system recovery, and
1294 <literal>fota</literal> might be used to trigger a
1295 <quote>firmware over the air</quote> update.</para>
1299 <term><command>kexec</command></term>
1302 <para>Shut down and reboot the system via kexec. This is
1303 mostly equivalent to <command>start kexec.target --irreversible</command>,
1304 but also prints a wall message to all users. If combined
1305 with <option>--force</option>, shutdown of all running
1306 services is skipped, however all processes are killed and
1307 all file systems are unmounted or mounted read-only,
1308 immediately followed by the reboot.</para>
1312 <term><command>exit</command></term>
1315 <para>Ask the systemd manager to quit. This is only
1316 supported for user service managers (i.e. in conjunction
1317 with the <option>--user</option> option) and will fail
1323 <term><command>suspend</command></term>
1326 <para>Suspend the system. This will trigger activation of
1327 the special <filename>suspend.target</filename> target.
1332 <term><command>hibernate</command></term>
1335 <para>Hibernate the system. This will trigger activation of
1336 the special <filename>hibernate.target</filename> target.
1341 <term><command>hybrid-sleep</command></term>
1344 <para>Hibernate and suspend the system. This will trigger
1345 activation of the special
1346 <filename>hybrid-sleep.target</filename> target.</para>
1350 <term><command>switch-root <replaceable>ROOT</replaceable> <optional><replaceable>INIT</replaceable></optional></command></term>
1353 <para>Switches to a different root directory and executes a
1354 new system manager process below it. This is intended for
1355 usage in initial RAM disks ("initrd"), and will transition
1356 from the initrd's system manager process (a.k.a "init"
1357 process) to the main system manager process. This call takes two
1358 arguments: the directory that is to become the new root directory, and
1359 the path to the new system manager binary below it to
1360 execute as PID 1. If the latter is omitted or the empty
1361 string, a systemd binary will automatically be searched for
1362 and used as init. If the system manager path is omitted or
1363 equal to the empty string, the state of the initrd's system
1364 manager process is passed to the main system manager, which
1365 allows later introspection of the state of the services
1366 involved in the initrd boot.</para>
1373 <title>Parameter Syntax</title>
1375 <para>For unit commands the specified
1376 <replaceable>NAME</replaceable> should be the full name of the
1377 unit, or an abbreviated name which is automatically extended with
1378 the <literal>.service</literal> suffix.
1379 <programlisting># systemctl start foo.service</programlisting> is equivalent to:
1380 <programlisting># systemctl start foo</programlisting>
1381 Note that (absolute) paths to device nodes are automatically converted to device unit names, and other (absolute) paths to mount unit names.
1382 <programlisting># systemctl status /dev/sda
1383 # systemctl status /home</programlisting> is equivalent to:
1384 <programlisting># systemctl status dev-sda.device
1385 # systemctl status home.mount</programlisting></para>
1387 <para>For unit file commands the
1388 specified <replaceable>NAME</replaceable> should be the full name
1389 of the unit file, or the absolute path to the unit file.
1390 <programlisting># systemctl link /path/to/foo.service</programlisting>
1397 <title>Exit status</title>
1399 <para>On success, 0 is returned, a non-zero failure
1400 code otherwise.</para>
1404 <title>Environment</title>
1406 <variablelist class='environment-variables'>
1408 <term><varname>$SYSTEMD_PAGER</varname></term>
1411 <para>Pager to use when <option>--no-pager</option> is not
1412 given; overrides <varname>$PAGER</varname>. Setting this to
1413 an empty string or the value <literal>cat</literal> is
1414 equivalent to passing
1415 <option>--no-pager</option>.</para>
1422 <title>See Also</title>
1424 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1425 <citerefentry><refentrytitle>systemadm</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1426 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1427 <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1428 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1429 <citerefentry><refentrytitle>systemd.resource-management</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1430 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1431 <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1432 <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>