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,
178 journal output, or truncate unit descriptions in the output
179 of <command>status</command>, <command>list-units</command>,
180 <command>list-jobs</command>, and
181 <command>list-timers</command>.</para>
186 <term><option>--show-types</option></term>
189 <para>When showing sockets, show the type of the socket.</para>
194 <term><option>--job-mode=</option></term>
197 <para>When queuing a new job, control how to deal with already
198 queued jobs. Takes one of <literal>fail</literal>,
199 <literal>replace</literal>,
200 <literal>replace-irreversibly</literal>,
201 <literal>isolate</literal>,
202 <literal>ignore-dependencies</literal>,
203 <literal>ignore-requirements</literal> or
204 <literal>flush</literal>. Defaults to
205 <literal>replace</literal>, except when the
206 <command>isolate</command> command is used which implies the
207 <literal>isolate</literal> job mode.</para>
209 <para>If <literal>fail</literal> is specified and a requested
210 operation conflicts with a pending job (more specifically:
211 causes an already pending start job to be reversed into a stop
212 job or vice versa), cause the operation to fail.</para>
214 <para>If <literal>replace</literal> (the default) is
215 specified, any conflicting pending job will be replaced, as
218 <para>If <literal>replace-irreversibly</literal> is specified,
219 operate like <literal>replace</literal>, but also mark the new
220 jobs as irreversible. This prevents future conflicting
221 transactions from replacing these jobs. The jobs can still be
222 cancelled using the <command>cancel</command> command.</para>
224 <para><literal>isolate</literal> is only valid for start
225 operations and causes all other units to be stopped when the
226 specified unit is started. This mode is always used when the
227 <command>isolate</command> command is used.</para>
229 <para><literal>flush</literal> will cause all queued jobs to
230 be canceled when the new job is enqueued.</para>
232 <para>If <literal>ignore-dependencies</literal> is specified,
233 then all unit dependencies are ignored for this new job and
234 the operation is executed immediately. If passed, no required
235 units of the unit passed will be pulled in, and no ordering
236 dependencies will be honored. This is mostly a debugging and
237 rescue tool for the administrator and should not be used by
240 <para><literal>ignore-requirements</literal> is similar to
241 <literal>ignore-dependencies</literal> but only causes the
242 requirement dependencies to be ignored, the ordering
243 dependencies will still be honoured.</para>
249 <term><option>-i</option></term>
250 <term><option>--ignore-inhibitors</option></term>
253 <para>When system shutdown or a sleep state is requested,
254 ignore inhibitor locks. Applications can establish inhibitor
255 locks to avoid that certain important operations (such as CD
256 burning or suchlike) are interrupted by system shutdown or a
257 sleep state. Any user may take these locks and privileged
258 users may override these locks. If any locks are taken,
259 shutdown and sleep state requests will normally fail
260 (regardless if privileged or not) and a list of active locks
261 is printed. However, if <option>--ignore-inhibitors</option>
262 is specified, the locks are ignored and not printed, and the
263 operation attempted anyway, possibly requiring additional
269 <term><option>-q</option></term>
270 <term><option>--quiet</option></term>
273 <para>Suppress output to standard output in
274 <command>snapshot</command>,
275 <command>is-active</command>,
276 <command>is-failed</command>,
277 <command>enable</command> and
278 <command>disable</command>.</para>
283 <term><option>--no-block</option></term>
286 <para>Do not synchronously wait for the requested operation
287 to finish. If this is not specified, the job will be
288 verified, enqueued and <command>systemctl</command> will
289 wait until it is completed. By passing this argument, it is
290 only verified and enqueued.</para>
295 <term><option>--no-legend</option></term>
298 <para>Do not print the legend, i.e. the column headers and
299 the footer with hints.</para>
304 <term><option>--no-pager</option></term>
307 <para>Do not pipe output into a pager.</para>
312 <term><option>--system</option></term>
315 <para>Talk to the systemd system manager. (Default)</para>
320 <term><option>--user</option></term>
323 <para>Talk to the systemd manager of the calling
329 <term><option>--no-wall</option></term>
332 <para>Do not send wall message before halt, power-off,
338 <term><option>--global</option></term>
341 <para>When used with <command>enable</command> and
342 <command>disable</command>, operate on the global user
343 configuration directory, thus enabling or disabling a unit
344 file globally for all future logins of all users.</para>
349 <term><option>--no-reload</option></term>
352 <para>When used with <command>enable</command> and
353 <command>disable</command>, do not implicitly reload daemon
354 configuration after executing the changes.</para>
359 <term><option>--no-ask-password</option></term>
362 <para>When used with <command>start</command> and related
363 commands, disables asking for passwords. Background services
364 may require input of a password or passphrase string, for
365 example to unlock system hard disks or cryptographic
366 certificates. Unless this option is specified and the
367 command is invoked from a terminal,
368 <command>systemctl</command> will query the user on the
369 terminal for the necessary secrets. Use this option to
370 switch this behavior off. In this case, the password must be
371 supplied by some other means (for example graphical password
372 agents) or the service might fail. This also disables
373 querying the user for authentication for privileged
380 <term><option>--kill-who=</option></term>
383 <para>When used with <command>kill</command>, choose which
384 processes to kill. Must be one of <option>main</option>,
385 <option>control</option> or <option>all</option> to select
386 whether to kill only the main process of the unit, the
387 control process or all processes of the unit. If omitted,
388 defaults to <option>all</option>.</para>
394 <term><option>-s</option></term>
395 <term><option>--signal=</option></term>
398 <para>When used with <command>kill</command>, choose which
399 signal to send to selected processes. Must be one of the
400 well known signal specifiers such as <constant>SIGTERM</constant>, <constant>SIGINT</constant> or
401 <constant>SIGSTOP</constant>. If omitted, defaults to
402 <option>SIGTERM</option>.</para>
407 <term><option>-f</option></term>
408 <term><option>--force</option></term>
411 <para>When used with <command>enable</command>, overwrite
412 any existing conflicting symlinks.</para>
414 <para>When used with <command>halt</command>,
415 <command>poweroff</command>, <command>reboot</command> or
416 <command>kexec</command>, execute the selected operation
417 without shutting down all units. However, all processes will
418 be killed forcibly and all file systems are unmounted or
419 remounted read-only. This is hence a drastic but relatively
420 safe option to request an immediate reboot. If
421 <option>--force</option> is specified twice for these
422 operations, they will be executed immediately without
423 terminating any processes or umounting any file
424 systems. Warning: specifying <option>--force</option> twice
425 with any of these operations might result in data
431 <term><option>--root=</option></term>
435 <command>enable</command>/<command>disable</command>/<command>is-enabled</command>
436 (and related commands), use alternative root path when
437 looking for unit files.</para>
443 <term><option>--runtime</option></term>
446 <para>When used with <command>enable</command>,
447 <command>disable</command>,
448 (and related commands), make changes only temporarily, so
449 that they are lost on the next reboot. This will have the
450 effect that changes are not made in subdirectories of
451 <filename>/etc</filename> but in <filename>/run</filename>,
452 with identical immediate effects, however, since the latter
453 is lost on reboot, the changes are lost too.</para>
455 <para>Similar, when used with
456 <command>set-property</command>, make changes only
457 temporarily, so that they are lost on the next
463 <term><option>-H</option></term>
464 <term><option>--host</option></term>
467 <para>Execute the operation remotely. Specify a hostname, or
468 username and hostname separated by <literal>@</literal>, to
469 connect to. This will use SSH to talk to the remote systemd
475 <term><option>-M</option></term>
476 <term><option>--machine=</option></term>
478 <listitem><para>Execute the operation on a local
479 container. Specify a container name to connect
480 to.</para></listitem>
484 <term><option>-n</option></term>
485 <term><option>--lines=</option></term>
488 <para>When used with <command>status</command>, controls the
489 number of journal lines to show, counting from the most
490 recent ones. Takes a positive integer argument. Defaults to
496 <term><option>-o</option></term>
497 <term><option>--output=</option></term>
500 <para>When used with <command>status</command>, controls the
501 formatting of the journal entries that are shown. For the
502 available choices, see
503 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
504 Defaults to <literal>short</literal>.</para>
509 <term><option>--plain</option></term>
512 <para>When used with <command>list-dependencies</command>,
513 the output is printed as a list instead of a tree.</para>
521 <title>Commands</title>
523 <para>The following commands are understood:</para>
526 <title>Unit Commands</title>
530 <term><command>list-units <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
533 <para>List known units (subject to limitations specified
534 with <option>-t</option>). If one or more
535 <replaceable>PATTERN</replaceable>s are specified, only
536 units matching one of them are shown.</para>
538 <para>This is the default command.</para>
543 <term><command>list-sockets <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
546 <para>List socket units ordered by the listening address.
547 If one or more <replaceable>PATTERN</replaceable>s are
548 specified, only socket units matching one of them are
549 shown. Produces output similar to
551 LISTEN UNIT ACTIVATES
552 /dev/initctl systemd-initctl.socket systemd-initctl.service
554 [::]:22 sshd.socket sshd.service
555 kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
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>NAME</replaceable>...</command></term>
586 <para>Start (activate) one or more units specified on the
591 <term><command>stop <replaceable>NAME</replaceable>...</command></term>
594 <para>Stop (deactivate) one or more units specified on the
599 <term><command>reload <replaceable>NAME</replaceable>...</command></term>
602 <para>Asks all units listed on the command line to reload
603 their configuration. Note that this will reload the
604 service-specific configuration, not the unit configuration
605 file of systemd. If you want systemd to reload the
606 configuration file of a unit, use the
607 <command>daemon-reload</command> command. In other words:
608 for the example case of Apache, this will reload Apache's
609 <filename>httpd.conf</filename> in the web server, not the
610 <filename>apache.service</filename> systemd unit
613 <para>This command should not be confused with the
614 <command>daemon-reload</command> or <command>load</command>
620 <term><command>restart <replaceable>NAME</replaceable>...</command></term>
623 <para>Restart one or more units specified on the command
624 line. If the units are not running yet, they will be
629 <term><command>try-restart <replaceable>NAME</replaceable>...</command></term>
632 <para>Restart one or more units specified on the command
633 line if the units are running. This does nothing if units are not
634 running. Note that, for compatibility with Red Hat init
635 scripts, <command>condrestart</command> is equivalent to this
640 <term><command>reload-or-restart <replaceable>NAME</replaceable>...</command></term>
643 <para>Reload one or more units if they support it. If not,
644 restart them instead. If the units are not running yet, they
645 will be started.</para>
649 <term><command>reload-or-try-restart <replaceable>NAME</replaceable>...</command></term>
652 <para>Reload one or more units if they support it. If not,
653 restart them instead. This does nothing if the units are not
654 running. Note that, for compatibility with SysV init scripts,
655 <command>force-reload</command> is equivalent to this
660 <term><command>isolate <replaceable>NAME</replaceable></command></term>
663 <para>Start the unit specified on the command line and its
664 dependencies and stop all others.</para>
666 <para>This is similar to changing the runlevel in a
667 traditional init system. The <command>isolate</command>
668 command will immediately stop processes that are not enabled
669 in the new unit, possibly including the graphical
670 environment or terminal you are currently using.</para>
672 <para>Note that this is allowed only on units where
673 <option>AllowIsolate=</option> is enabled. See
674 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
679 <term><command>kill <replaceable>NAME</replaceable>...</command></term>
682 <para>Send a signal to one or more processes of the
683 unit. Use <option>--kill-who=</option> to select which
684 process to kill. Use <option>--kill-mode=</option> to select
685 the kill mode and <option>--signal=</option> to select the
686 signal to send.</para>
690 <term><command>is-active <replaceable>NAME</replaceable>...</command></term>
693 <para>Check whether any of the specified units are active
694 (i.e. running). Returns an exit code 0 if at least one is
695 active, non-zero otherwise. Unless <option>--quiet</option>
696 is specified, this will also print the current unit state to
701 <term><command>is-failed <replaceable>NAME</replaceable>...</command></term>
704 <para>Check whether any of the specified units are in a "failed" state.
705 Returns an exit code 0 if at least one has failed, non-zero
706 otherwise. Unless <option>--quiet</option> is specified, this
707 will also print the current unit state to
712 <term><command>status</command> <optional><replaceable>NAME</replaceable>...|<replaceable>PID</replaceable>...]</optional></term>
715 <para>Show terse runtime status information about one or
716 more units, followed by most recent log data from the
717 journal. If no units are specified, show all units (subject
718 to limitations specified with <option>-t</option>). If a PID
719 is passed, show information about the unit the process
722 <para>This function is intended to generate human-readable
723 output. If you are looking for computer-parsable output,
724 use <command>show</command> instead. By default this
725 function only shows 10 lines of output and ellipsizes
726 lines to fit in the terminal window. This can be changes
727 with <option>--lines</option> and <option>--full</option>,
728 see above. In addition, <command>journalctl
729 --unit=<replaceable>NAME</replaceable></command> or
731 --user-unit=<replaceable>NAME</replaceable></command> use
732 a similar filter for messages and might be more
738 <term><command>show</command> <optional><replaceable>NAME</replaceable>...|<replaceable>JOB</replaceable>...</optional></term>
741 <para>Show properties of one or more units, jobs, or the
742 manager itself. If no argument is specified, properties of
743 the manager will be shown. If a unit name is specified,
744 properties of the unit is shown, and if a job id is
745 specified, properties of the job is shown. By default, empty
746 properties are suppressed. Use <option>--all</option> to
747 show those too. To select specific properties to show, use
748 <option>--property=</option>. This command is intended to be
749 used whenever computer-parsable output is required. Use
750 <command>status</command> if you are looking for formatted
751 human-readable output.</para>
755 <term><command>cat <replaceable>NAME</replaceable>...</command></term>
758 <para>Show backing files of one or more units. Prints the
759 "fragment" and "drop-ins" (source files) of units. Each
760 file is preceded by a comment which includes the file
765 <term><command>set-property <replaceable>NAME</replaceable> <replaceable>ASSIGNMENT</replaceable>...</command></term>
768 <para>Set the specified unit properties at runtime where
769 this is supported. This allows changing configuration
770 parameter properties such as resource control settings at
771 runtime. Not all properties may be changed at runtime, but
772 many resource control settings (primarily those in
773 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
774 may. The changes are applied instantly, and stored on disk
775 for future boots, unless <option>--runtime</option> is
776 passed, in which case the settings only apply until the
777 next reboot. The syntax of the property assignment follows
778 closely the syntax of assignments in unit files.</para>
780 <para>Example: <command>systemctl set-property foobar.service CPUShares=777</command></para>
782 <para>Note that this command allows changing multiple
783 properties at the same time, which is preferable over
784 setting them individually. Like unit file configuration
785 settings, assigning the empty list to list parameters will
786 reset the list.</para>
791 <term><command>help <replaceable>NAME</replaceable>...|<replaceable>PID</replaceable>...</command></term>
794 <para>Show manual pages for one or more units, if
795 available. If a PID is given, the manual pages for the unit
796 the process belongs to are shown.</para>
801 <term><command>reset-failed [<replaceable>NAME</replaceable>...]</command></term>
804 <para>Reset the <literal>failed</literal> state of the
805 specified units, or if no unit name is passed, reset the state of all
806 units. When a unit fails in some way (i.e. process exiting
807 with non-zero error code, terminating abnormally or timing
808 out), it will automatically enter the
809 <literal>failed</literal> state and its exit code and status
810 is recorded for introspection by the administrator until the
811 service is restarted or reset with this command.</para>
816 <term><command>list-dependencies <replaceable>NAME</replaceable></command></term>
819 <para>Shows required and wanted units of the specified
820 unit. If no unit is specified,
821 <filename>default.target</filename> is implied. Target units
822 are recursively expanded. When <option>--all</option> is
823 passed, all other units are recursively expanded as
831 <title>Unit File Commands</title>
835 <term><command>list-unit-files <optional><replaceable>PATTERN...</replaceable></optional></command></term>
838 <para>List installed unit files. If one or more
839 <replaceable>PATTERN</replaceable>s are specified, only
840 units whose filename (just the last component of the path)
841 matches one of them are shown.</para>
846 <term><command>enable <replaceable>NAME</replaceable>...</command></term>
849 <para>Enable one or more unit files or unit file instances,
850 as specified on the command line. This will create a number
851 of symlinks as encoded in the <literal>[Install]</literal>
852 sections of the unit files. After the symlinks have been
853 created, the systemd configuration is reloaded (in a way that
854 is equivalent to <command>daemon-reload</command>) to ensure
855 the changes are taken into account immediately. Note that
856 this does <emphasis>not</emphasis> have the effect of also
857 starting any of the units being enabled. If this
858 is desired, a separate <command>start</command> command must
859 be invoked for the unit. Also note that in case of instance
860 enablement, symlinks named the same as instances are created in
861 the install location, however they all point to the same
862 template unit file.</para>
864 <para>This command will print the actions executed. This
865 output may be suppressed by passing <option>--quiet</option>.
868 <para>Note that this operation creates only the suggested
869 symlinks for the units. While this command is the
870 recommended way to manipulate the unit configuration
871 directory, the administrator is free to make additional
872 changes manually by placing or removing symlinks in the
873 directory. This is particularly useful to create
874 configurations that deviate from the suggested default
875 installation. In this case, the administrator must make sure
876 to invoke <command>daemon-reload</command> manually as
877 necessary to ensure the changes are taken into account.
880 <para>Enabling units should not be confused with starting
881 (activating) units, as done by the <command>start</command>
882 command. Enabling and starting units is orthogonal: units
883 may be enabled without being started and started without
884 being enabled. Enabling simply hooks the unit into various
885 suggested places (for example, so that the unit is
886 automatically started on boot or when a particular kind of
887 hardware is plugged in). Starting actually spawns the daemon
888 process (in case of service units), or binds the socket (in
889 case of socket units), and so on.</para>
891 <para>Depending on whether <option>--system</option>,
892 <option>--user</option>, <option>--runtime</option>,
893 or <option>--global</option> is specified, this enables the unit
894 for the system, for the calling user only, for only this boot of
895 the system, or for all future logins of all users, or only this
896 boot. Note that in the last case, no systemd daemon
897 configuration is reloaded.</para>
902 <term><command>disable <replaceable>NAME</replaceable>...</command></term>
905 <para>Disables one or more units. This removes all symlinks
906 to the specified unit files from the unit configuration
907 directory, and hence undoes the changes made by
908 <command>enable</command>. Note however that this removes
909 all symlinks to the unit files (i.e. including manual
910 additions), not just those actually created by
911 <command>enable</command>. This call implicitly reloads the
912 systemd daemon configuration after completing the disabling
913 of the units. Note that this command does not implicitly
914 stop the units that are being disabled. If this is desired,
915 an additional <command>stop</command> command should be
916 executed afterwards.</para>
918 <para>This command will print the actions executed. This
919 output may be suppressed by passing <option>--quiet</option>.
922 <para>This command honors <option>--system</option>,
923 <option>--user</option>, <option>--runtime</option> and
924 <option>--global</option> in a similar way as
925 <command>enable</command>.</para>
930 <term><command>is-enabled <replaceable>NAME</replaceable>...</command></term>
933 <para>Checks whether any of the specified unit files are
934 enabled (as with <command>enable</command>). Returns an
935 exit code of 0 if at least one is enabled, non-zero
936 otherwise. Prints the current enable status (see table).
937 To suppress this output, use <option>--quiet</option>.
942 <command>is-enabled</command> output
948 <entry>Printed string</entry>
949 <entry>Meaning</entry>
950 <entry>Return value</entry>
955 <entry><literal>enabled</literal></entry>
956 <entry morerows='1'>Enabled through a symlink in <filename>.wants</filename> directory (permanently or just in <filename>/run</filename>)</entry>
957 <entry morerows='1'>0</entry>
960 <entry><literal>enabled-runtime</literal></entry>
963 <entry><literal>linked</literal></entry>
964 <entry morerows='1'>Made available through a symlink to the unit file (permanently or just in <filename>/run</filename>)</entry>
965 <entry morerows='1'>1</entry>
968 <entry><literal>linked-runtime</literal></entry>
971 <entry><literal>masked</literal></entry>
972 <entry morerows='1'>Disabled entirely (permanently or just in <filename>/run</filename>)</entry>
973 <entry morerows='1'>1</entry>
976 <entry><literal>masked-runtime</literal></entry>
979 <entry><literal>static</literal></entry>
980 <entry>Unit is not enabled, but has no provisions for enabling in [Install] section</entry>
984 <entry><literal>disabled</literal></entry>
985 <entry>Unit is not enabled</entry>
996 <term><command>reenable <replaceable>NAME</replaceable>...</command></term>
999 <para>Reenable one or more unit files, as specified on the
1000 command line. This is a combination of
1001 <command>disable</command> and <command>enable</command> and
1002 is useful to reset the symlinks a unit is enabled with to
1003 the defaults configured in the <literal>[Install]</literal>
1004 section of the unit file.</para>
1009 <term><command>preset <replaceable>NAME</replaceable>...</command></term>
1012 <para>Reset one or more unit files, as specified on the
1013 command line, to the defaults configured in the preset
1014 policy files. This has the same effect as
1015 <command>disable</command> or <command>enable</command>,
1016 depending how the unit is listed in the preset files. For
1017 more information on the preset policy format, see
1018 <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1019 For more information on the concept of presets, please
1021 <ulink url="http://freedesktop.org/wiki/Software/systemd/Preset">Preset</ulink>
1027 <term><command>mask <replaceable>NAME</replaceable>...</command></term>
1030 <para>Mask one or more unit files, as specified on the
1031 command line. This will link these units to
1032 <filename>/dev/null</filename>, making it impossible to
1033 start them. This is a stronger version of
1034 <command>disable</command>, since it prohibits all kinds of
1035 activation of the unit, including manual activation. Use
1036 this option with care. This honors the
1037 <option>--runtime</option> option to only mask temporarily
1038 until the next reoobt of the system.</para>
1043 <term><command>unmask <replaceable>NAME</replaceable>...</command></term>
1046 <para>Unmask one or more unit files, as specified on the
1047 command line. This will undo the effect of
1048 <command>mask</command>.</para>
1053 <term><command>link <replaceable>FILENAME</replaceable>...</command></term>
1056 <para>Link a unit file that is not in the unit file search
1057 paths into the unit file search path. This requires an
1058 absolute path to a unit file. The effect of this can be
1059 undone with <command>disable</command>. The effect of this
1060 command is that a unit file is available for
1061 <command>start</command> and other commands although it
1062 is not installed directly in the unit search path.</para>
1067 <term><command>get-default</command></term>
1070 <para>Get the default target specified
1071 via <filename>default.target</filename> link.</para>
1076 <term><command>set-default <replaceable>NAME</replaceable></command></term>
1079 <para>Set the default target to boot into. Command links
1080 <filename>default.target</filename> to the given unit.</para>
1087 <title>Job Commands</title>
1091 <term><command>list-jobs <optional><replaceable>PATTERN...</replaceable></optional></command></term>
1094 <para>List jobs that are in progress. If one or more
1095 <replaceable>PATTERN</replaceable>s are specified, only
1096 jobs for units matching one of them are shown.</para>
1100 <term><command>cancel <replaceable>JOB</replaceable>...</command></term>
1103 <para>Cancel one or more jobs specified on the command line
1104 by their numeric job IDs. If no job ID is specified, cancel
1105 all pending jobs.</para>
1112 <title>Snapshot Commands</title>
1116 <term><command>snapshot <optional><replaceable>NAME</replaceable></optional></command></term>
1119 <para>Create a snapshot. If a snapshot name is specified,
1120 the new snapshot will be named after it. If none is
1121 specified, an automatic snapshot name is generated. In either
1122 case, the snapshot name used is printed to STDOUT, unless
1123 <option>--quiet</option> is specified.</para>
1125 <para>A snapshot refers to a saved state of the systemd
1126 manager. It is implemented itself as a unit that is
1127 generated dynamically with this command and has dependencies
1128 on all units active at the time. At a later time, the user
1129 may return to this state by using the
1130 <command>isolate</command> command on the snapshot unit.
1133 <para>Snapshots are only useful for saving and restoring
1134 which units are running or are stopped, they do not
1135 save/restore any other state. Snapshots are dynamic and lost
1140 <term><command>delete <replaceable>NAME</replaceable>...</command></term>
1143 <para>Remove a snapshot previously created with
1144 <command>snapshot</command>.</para>
1151 <title>Environment Commands</title>
1155 <term><command>show-environment</command></term>
1158 <para>Dump the systemd manager environment block. The
1159 environment block will be dumped in straight-forward form
1160 suitable for sourcing into a shell script. This environment
1161 block will be passed to all processes the manager
1166 <term><command>set-environment <replaceable>VARIABLE=VALUE</replaceable>...</command></term>
1169 <para>Set one or more systemd manager environment variables,
1170 as specified on the command line.</para>
1174 <term><command>unset-environment <replaceable>VARIABLE</replaceable>...</command></term>
1177 <para>Unset one or more systemd manager environment
1178 variables. If only a variable name is specified, it will be
1179 removed regardless of its value. If a variable and a value
1180 are specified, the variable is only removed if it has the
1181 specified value.</para>
1188 <title>Manager Lifecycle Commands</title>
1192 <term><command>daemon-reload</command></term>
1195 <para>Reload systemd manager configuration. This will reload
1196 all unit files and recreate the entire dependency
1197 tree. While the daemon is being reloaded, all sockets systemd
1198 listens on on behalf of user configuration will stay
1199 accessible.</para> <para>This command should not be confused
1200 with the <command>load</command> or
1201 <command>reload</command> commands.</para>
1205 <term><command>daemon-reexec</command></term>
1208 <para>Reexecute the systemd manager. This will serialize the
1209 manager state, reexecute the process and deserialize the
1210 state again. This command is of little use except for
1211 debugging and package upgrades. Sometimes, it might be
1212 helpful as a heavy-weight <command>daemon-reload</command>.
1213 While the daemon is being reexecuted, all sockets systemd listening
1214 on behalf of user configuration will stay accessible.
1222 <title>System Commands</title>
1226 <term><command>default</command></term>
1229 <para>Enter default mode. This is mostly equivalent to
1230 <command>isolate default.target</command>.</para>
1234 <term><command>rescue</command></term>
1237 <para>Enter rescue mode. This is mostly equivalent to
1238 <command>isolate rescue.target</command>, but also prints a
1239 wall message to all users.</para>
1243 <term><command>emergency</command></term>
1246 <para>Enter emergency mode. This is mostly equivalent to
1247 <command>isolate emergency.target</command>, but also prints
1248 a wall message to all users.</para>
1252 <term><command>halt</command></term>
1255 <para>Shut down and halt the system. This is mostly equivalent to
1256 <command>start halt.target --irreversible</command>, but also
1257 prints a wall message to all users. If combined with
1258 <option>--force</option>, shutdown of all running services is
1259 skipped, however all processes are killed and all file
1260 systems are unmounted or mounted read-only, immediately
1261 followed by the system halt. If <option>--force</option> is
1262 specified twice, the operation is immediately executed
1263 without terminating any processes or unmounting any file
1264 systems. This may result in data loss.</para>
1268 <term><command>poweroff</command></term>
1271 <para>Shut down and power-off the system. This is mostly
1272 equivalent to <command>start poweroff.target --irreversible</command>,
1273 but also prints a wall message to all users. If combined with
1274 <option>--force</option>, shutdown of all running services is
1275 skipped, however all processes are killed and all file
1276 systems are unmounted or mounted read-only, immediately
1277 followed by the powering off. If <option>--force</option> is
1278 specified twice, the operation is immediately executed
1279 without terminating any processes or unmounting any file
1280 systems. This may result in data loss.</para>
1284 <term><command>reboot <optional><replaceable>arg</replaceable></optional></command></term>
1287 <para>Shut down and reboot the system. This is mostly
1288 equivalent to <command>start reboot.target --irreversible</command>,
1289 but also prints a wall message to all users. If combined with
1290 <option>--force</option>, shutdown of all running services is
1291 skipped, however all processes are killed and all file
1292 systems are unmounted or mounted read-only, immediately
1293 followed by the reboot. If <option>--force</option> is
1294 specified twice, the operation is immediately executed
1295 without terminating any processes or unmounting any file
1296 systems. This may result in data loss.</para>
1298 <para>If the optional argument
1299 <replaceable>arg</replaceable> is given, it will be passed
1300 as the optional argument to the
1301 <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1302 system call. The value is architecture and firmware
1303 specific. As an example, <literal>recovery</literal> might
1304 be used to trigger system recovery, and
1305 <literal>fota</literal> might be used to trigger a
1306 <quote>firmware over the air</quote> update.</para>
1310 <term><command>kexec</command></term>
1313 <para>Shut down and reboot the system via kexec. This is
1314 mostly equivalent to <command>start kexec.target --irreversible</command>,
1315 but also prints a wall message to all users. If combined
1316 with <option>--force</option>, shutdown of all running
1317 services is skipped, however all processes are killed and
1318 all file systems are unmounted or mounted read-only,
1319 immediately followed by the reboot.</para>
1323 <term><command>exit</command></term>
1326 <para>Ask the systemd manager to quit. This is only
1327 supported for user service managers (i.e. in conjunction
1328 with the <option>--user</option> option) and will fail
1334 <term><command>suspend</command></term>
1337 <para>Suspend the system. This will trigger activation of
1338 the special <filename>suspend.target</filename> target.
1343 <term><command>hibernate</command></term>
1346 <para>Hibernate the system. This will trigger activation of
1347 the special <filename>hibernate.target</filename> target.
1352 <term><command>hybrid-sleep</command></term>
1355 <para>Hibernate and suspend the system. This will trigger
1356 activation of the special
1357 <filename>hybrid-sleep.target</filename> target.</para>
1361 <term><command>switch-root <replaceable>ROOT</replaceable> <optional><replaceable>INIT</replaceable></optional></command></term>
1364 <para>Switches to a different root directory and executes a
1365 new system manager process below it. This is intended for
1366 usage in initial RAM disks ("initrd"), and will transition
1367 from the initrd's system manager process (a.k.a "init"
1368 process) to the main system manager process. This call takes two
1369 arguments: the directory that is to become the new root directory, and
1370 the path to the new system manager binary below it to
1371 execute as PID 1. If the latter is omitted or the empty
1372 string, a systemd binary will automatically be searched for
1373 and used as init. If the system manager path is omitted or
1374 equal to the empty string, the state of the initrd's system
1375 manager process is passed to the main system manager, which
1376 allows later introspection of the state of the services
1377 involved in the initrd boot.</para>
1384 <title>Parameter Syntax</title>
1386 <para>For unit commands the specified
1387 <replaceable>NAME</replaceable> should be the full name of the
1388 unit, or an abbreviated name which is automatically extended with
1389 the <literal>.service</literal> suffix.
1390 <programlisting># systemctl start foo.service</programlisting> is equivalent to:
1391 <programlisting># systemctl start foo</programlisting>
1392 Note that (absolute) paths to device nodes are automatically converted to device unit names, and other (absolute) paths to mount unit names.
1393 <programlisting># systemctl status /dev/sda
1394 # systemctl status /home</programlisting> is equivalent to:
1395 <programlisting># systemctl status dev-sda.device
1396 # systemctl status home.mount</programlisting></para>
1398 <para>For unit file commands the
1399 specified <replaceable>NAME</replaceable> should be the full name
1400 of the unit file, or the absolute path to the unit file.
1401 <programlisting># systemctl link /path/to/foo.service</programlisting>
1408 <title>Exit status</title>
1410 <para>On success, 0 is returned, a non-zero failure
1411 code otherwise.</para>
1415 <title>Environment</title>
1417 <variablelist class='environment-variables'>
1419 <term><varname>$SYSTEMD_PAGER</varname></term>
1422 <para>Pager to use when <option>--no-pager</option> is not
1423 given; overrides <varname>$PAGER</varname>. Setting this to
1424 an empty string or the value <literal>cat</literal> is
1425 equivalent to passing
1426 <option>--no-pager</option>.</para>
1433 <title>See Also</title>
1435 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1436 <citerefentry><refentrytitle>systemadm</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1437 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1438 <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1439 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1440 <citerefentry><refentrytitle>systemd.resource-management</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1441 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1442 <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1443 <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>