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 introspect and
64 control the state of the <literal>systemd</literal> system and
65 service manager. Please refer to
66 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
67 for an introduction into the basic concepts and functionality this
72 <title>Options</title>
74 <para>The following options are understood:</para>
78 <term><option>-t</option></term>
79 <term><option>--type=</option></term>
82 <para>The argument should be a comma-separated list of unit
83 types such as <option>service</option> and
84 <option>socket</option>.
87 <para>If one of the arguments is a unit type, when listing
88 units, limit display to certain unit types. Otherwise, units
89 of all types will be shown.</para>
91 <para>As a special case, if one of the arguments is
92 <option>help</option>, a list of allowed values will be
93 printed and the program will exit.</para>
98 <term><option>--state=</option></term>
101 <para>The argument should be a comma-separated list of unit LOAD,
102 SUB, or ACTIVE states. When listing units, show only those
103 in specified states.</para>
108 <term><option>-p</option></term>
109 <term><option>--property=</option></term>
112 <para>When showing unit/job/manager properties with the
113 <command>show</command> command, limit display to certain
114 properties as specified as argument. If not specified, all
115 set properties are shown. The argument should be a
116 comma-separated list of property names, such as
117 <literal>MainPID</literal>. If specified more than once, all
118 properties with the specified names are shown.</para>
123 <term><option>-a</option></term>
124 <term><option>--all</option></term>
127 <para>When listing units, show all loaded units, regardless
128 of their state, including inactive units. When showing
129 unit/job/manager properties, show all properties regardless
130 whether they are set or not.</para>
131 <para>To list all units installed on the system, use the
132 <command>list-unit-files</command> command instead.</para>
137 <term><option>-r</option></term>
138 <term><option>--recursive</option></term>
141 <para>When listing units, also show units of local
142 containers. Units of local containers will be prefixed with
143 the container name, separated by a single colon character
144 (<literal>:</literal>).</para>
149 <term><option>--reverse</option></term>
152 <para>Show reverse dependencies between units with
153 <command>list-dependencies</command>, i.e. units with
154 dependencies of type <varname>Wants=</varname> or
155 <varname>Requires=</varname> on the given unit.
161 <term><option>--after</option></term>
164 <para>With <command>list-dependencies</command>, show the
165 units that are ordered before the specified unit. In other
166 words, list the units that are in the <varname>After=</varname>
167 directive of the specified unit, have the specified unit in
168 their <varname>Before=</varname> directive, or are otherwise
169 implicit dependencies of the specified unit.</para>
174 <term><option>--before</option></term>
177 <para>With <command>list-dependencies</command>, show the
178 units that are ordered after the specified unit. In other
179 words, list the units that are in the <varname>Before=</varname>
180 directive of the specified unit, have the specified unit in
181 their <varname>After=</varname> directive, or otherwise depend
182 on the specified unit.</para>
187 <term><option>-l</option></term>
188 <term><option>--full</option></term>
191 <para>Do not ellipsize unit names, process tree entries,
192 journal output, or truncate unit descriptions in the output
193 of <command>status</command>, <command>list-units</command>,
194 <command>list-jobs</command>, and
195 <command>list-timers</command>.</para>
200 <term><option>--show-types</option></term>
203 <para>When showing sockets, show the type of the socket.</para>
208 <term><option>--job-mode=</option></term>
211 <para>When queuing a new job, this option controls how to deal with
212 already queued jobs. It takes one of <literal>fail</literal>,
213 <literal>replace</literal>,
214 <literal>replace-irreversibly</literal>,
215 <literal>isolate</literal>,
216 <literal>ignore-dependencies</literal>,
217 <literal>ignore-requirements</literal> or
218 <literal>flush</literal>. Defaults to
219 <literal>replace</literal>, except when the
220 <command>isolate</command> command is used which implies the
221 <literal>isolate</literal> job mode.</para>
223 <para>If <literal>fail</literal> is specified and a requested
224 operation conflicts with a pending job (more specifically:
225 causes an already pending start job to be reversed into a stop
226 job or vice versa), cause the operation to fail.</para>
228 <para>If <literal>replace</literal> (the default) is
229 specified, any conflicting pending job will be replaced, as
232 <para>If <literal>replace-irreversibly</literal> is specified,
233 operate like <literal>replace</literal>, but also mark the new
234 jobs as irreversible. This prevents future conflicting
235 transactions from replacing these jobs (or even being enqueued
236 while the irreversible jobs are still pending). Irreversible
237 jobs can still be cancelled using the <command>cancel</command>
240 <para><literal>isolate</literal> is only valid for start
241 operations and causes all other units to be stopped when the
242 specified unit is started. This mode is always used when the
243 <command>isolate</command> command is used.</para>
245 <para><literal>flush</literal> will cause all queued jobs to
246 be canceled when the new job is enqueued.</para>
248 <para>If <literal>ignore-dependencies</literal> is specified,
249 then all unit dependencies are ignored for this new job and
250 the operation is executed immediately. If passed, no required
251 units of the unit passed will be pulled in, and no ordering
252 dependencies will be honored. This is mostly a debugging and
253 rescue tool for the administrator and should not be used by
256 <para><literal>ignore-requirements</literal> is similar to
257 <literal>ignore-dependencies</literal>, but only causes the
258 requirement dependencies to be ignored, the ordering
259 dependencies will still be honoured.</para>
265 <term><option>-i</option></term>
266 <term><option>--ignore-inhibitors</option></term>
269 <para>When system shutdown or a sleep state is requested,
270 ignore inhibitor locks. Applications can establish inhibitor
271 locks to avoid that certain important operations (such as CD
272 burning or suchlike) are interrupted by system shutdown or a
273 sleep state. Any user may take these locks and privileged
274 users may override these locks. If any locks are taken,
275 shutdown and sleep state requests will normally fail
276 (regardless of whether privileged or not) and a list of active locks
277 is printed. However, if <option>--ignore-inhibitors</option>
278 is specified, the locks are ignored and not printed, and the
279 operation attempted anyway, possibly requiring additional
285 <term><option>-q</option></term>
286 <term><option>--quiet</option></term>
289 <para>Suppress output to standard output in
290 <command>snapshot</command>,
291 <command>is-active</command>,
292 <command>is-failed</command>,
293 <command>is-enabled</command>,
294 <command>is-system-running</command>,
295 <command>enable</command> and
296 <command>disable</command>.</para>
301 <term><option>--no-block</option></term>
304 <para>Do not synchronously wait for the requested operation
305 to finish. If this is not specified, the job will be
306 verified, enqueued and <command>systemctl</command> will
307 wait until it is completed. By passing this argument, it is
308 only verified and enqueued.</para>
313 <term><option>--no-legend</option></term>
316 <para>Do not print the legend, i.e. the column headers and
317 the footer with hints.</para>
321 <xi:include href="user-system-options.xml" xpointer="user" />
322 <xi:include href="user-system-options.xml" xpointer="system" />
325 <term><option>--failed</option></term>
328 <para>List units in failed state. This is equivalent to
329 <option>--state=failed</option>.</para>
334 <term><option>--no-wall</option></term>
337 <para>Do not send wall message before halt, power-off,
343 <term><option>--global</option></term>
346 <para>When used with <command>enable</command> and
347 <command>disable</command>, operate on the global user
348 configuration directory, thus enabling or disabling a unit
349 file globally for all future logins of all users.</para>
354 <term><option>--no-reload</option></term>
357 <para>When used with <command>enable</command> and
358 <command>disable</command>, do not implicitly reload daemon
359 configuration after executing the changes.</para>
364 <term><option>--no-ask-password</option></term>
367 <para>When used with <command>start</command> and related
368 commands, disables asking for passwords. Background services
369 may require input of a password or passphrase string, for
370 example to unlock system hard disks or cryptographic
371 certificates. Unless this option is specified and the
372 command is invoked from a terminal,
373 <command>systemctl</command> will query the user on the
374 terminal for the necessary secrets. Use this option to
375 switch this behavior off. In this case, the password must be
376 supplied by some other means (for example graphical password
377 agents) or the service might fail. This also disables
378 querying the user for authentication for privileged
385 <term><option>--kill-who=</option></term>
388 <para>When used with <command>kill</command>, choose which
389 processes to send a signal to. Must be one of
390 <option>main</option>, <option>control</option> or
391 <option>all</option> to select whether to kill only the main
392 process, the control process or all processes of the
393 unit. The main process of the unit is the one that defines
394 the life-time of it. A control process of a unit is one that
395 is invoked by the manager to induce state changes of it. For
396 example, all processes started due to the
397 <varname>ExecStartPre=</varname>,
398 <varname>ExecStop=</varname> or
399 <varname>ExecReload=</varname> settings of service units are
400 control processes. Note that there is only one control
401 process per unit at a time, as only one state change is
402 executed at a time. For services of type
403 <varname>Type=forking</varname>, the initial process started
404 by the manager for <varname>ExecStart=</varname> is a
405 control process, while the process ultimately forked off by
406 that one is then considered the main process of the unit (if
407 it can be determined). This is different for service units
408 of other types, where the process forked off by the manager
409 for <varname>ExecStart=</varname> is always the main process
410 itself. A service unit consists of zero or one main process,
411 zero or one control process plus any number of additional
412 processes. Not all unit types manage processes of these
413 types however. For example, for mount units, control processes
414 are defined (which are the invocations of
415 <filename>/usr/bin/mount</filename> and
416 <filename>/usr/bin/umount</filename>), but no main process
417 is defined. If omitted, defaults to
418 <option>all</option>.</para>
424 <term><option>-s</option></term>
425 <term><option>--signal=</option></term>
428 <para>When used with <command>kill</command>, choose which
429 signal to send to selected processes. Must be one of the
430 well known signal specifiers such as <constant>SIGTERM</constant>, <constant>SIGINT</constant> or
431 <constant>SIGSTOP</constant>. If omitted, defaults to
432 <option>SIGTERM</option>.</para>
437 <term><option>-f</option></term>
438 <term><option>--force</option></term>
441 <para>When used with <command>enable</command>, overwrite
442 any existing conflicting symlinks.</para>
444 <para>When used with <command>halt</command>,
445 <command>poweroff</command>, <command>reboot</command> or
446 <command>kexec</command>, execute the selected operation
447 without shutting down all units. However, all processes will
448 be killed forcibly and all file systems are unmounted or
449 remounted read-only. This is hence a drastic but relatively
450 safe option to request an immediate reboot. If
451 <option>--force</option> is specified twice for these
452 operations, they will be executed immediately without
453 terminating any processes or unmounting any file
454 systems. Warning: specifying <option>--force</option> twice
455 with any of these operations might result in data
461 <term><option>--root=</option></term>
465 <command>enable</command>/<command>disable</command>/<command>is-enabled</command>
466 (and related commands), use alternative root path when
467 looking for unit files.</para>
473 <term><option>--runtime</option></term>
476 <para>When used with <command>enable</command>,
477 <command>disable</command>,
478 (and related commands), make changes only temporarily, so
479 that they are lost on the next reboot. This will have the
480 effect that changes are not made in subdirectories of
481 <filename>/etc</filename> but in <filename>/run</filename>,
482 with identical immediate effects, however, since the latter
483 is lost on reboot, the changes are lost too.</para>
485 <para>Similarly, when used with
486 <command>set-property</command>, make changes only
487 temporarily, so that they are lost on the next
493 <term><option>--preset-mode=</option></term>
496 <para>Takes one of <literal>full</literal> (the default),
497 <literal>enable-only</literal>,
498 <literal>disable-only</literal>. When used with the
499 <command>preset</command> or <command>preset-all</command>
500 commands, controls whether units shall be disabled and
501 enabled according to the preset rules, or only enabled, or
502 only disabled.</para>
507 <term><option>-n</option></term>
508 <term><option>--lines=</option></term>
511 <para>When used with <command>status</command>, controls the
512 number of journal lines to show, counting from the most
513 recent ones. Takes a positive integer argument. Defaults to
519 <term><option>-o</option></term>
520 <term><option>--output=</option></term>
523 <para>When used with <command>status</command>, controls the
524 formatting of the journal entries that are shown. For the
525 available choices, see
526 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
527 Defaults to <literal>short</literal>.</para>
532 <term><option>--plain</option></term>
535 <para>When used with <command>list-dependencies</command>,
536 the output is printed as a list instead of a tree.</para>
540 <xi:include href="user-system-options.xml" xpointer="host" />
541 <xi:include href="user-system-options.xml" xpointer="machine" />
543 <xi:include href="standard-options.xml" xpointer="help" />
544 <xi:include href="standard-options.xml" xpointer="version" />
545 <xi:include href="standard-options.xml" xpointer="no-pager" />
550 <title>Commands</title>
552 <para>The following commands are understood:</para>
555 <title>Unit Commands</title>
559 <term><command>list-units <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
562 <para>List known units (subject to limitations specified
563 with <option>-t</option>). If one or more
564 <replaceable>PATTERN</replaceable>s are specified, only
565 units matching one of them are shown.</para>
567 <para>This is the default command.</para>
572 <term><command>list-sockets <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
575 <para>List socket units ordered by listening address.
576 If one or more <replaceable>PATTERN</replaceable>s are
577 specified, only socket units matching one of them are
578 shown. Produces output similar to
580 LISTEN UNIT ACTIVATES
581 /dev/initctl systemd-initctl.socket systemd-initctl.service
583 [::]:22 sshd.socket sshd.service
584 kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
586 5 sockets listed.</programlisting>
587 Note: because the addresses might contains spaces, this output
588 is not suitable for programmatic consumption.
591 <para>See also the options <option>--show-types</option>,
592 <option>--all</option>, and <option>--failed</option>.</para>
597 <term><command>list-timers <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
600 <para>List timer units ordered by the time they elapse
601 next. If one or more <replaceable>PATTERN</replaceable>s
602 are specified, only units matching one of them are shown.
605 <para>See also the options <option>--all</option> and
606 <option>--failed</option>.</para>
611 <term><command>start <replaceable>PATTERN</replaceable>...</command></term>
614 <para>Start (activate) one or more units specified on the
617 <para>Note that glob patterns operate on a list of currently
618 loaded units. Units which are not active and are not in a
619 failed state usually are not loaded, and would not be
620 matched by any pattern. In addition, in case of
621 instantiated units, systemd is often unaware of the
622 instance name until the instance has been started. Therefore,
623 using glob patterns with <command>start</command>
624 has limited usefulness.</para>
628 <term><command>stop <replaceable>PATTERN</replaceable>...</command></term>
631 <para>Stop (deactivate) one or more units specified on the
636 <term><command>reload <replaceable>PATTERN</replaceable>...</command></term>
639 <para>Asks all units listed on the command line to reload
640 their configuration. Note that this will reload the
641 service-specific configuration, not the unit configuration
642 file of systemd. If you want systemd to reload the
643 configuration file of a unit, use the
644 <command>daemon-reload</command> command. In other words:
645 for the example case of Apache, this will reload Apache's
646 <filename>httpd.conf</filename> in the web server, not the
647 <filename>apache.service</filename> systemd unit
650 <para>This command should not be confused with the
651 <command>daemon-reload</command> command.</para>
656 <term><command>restart <replaceable>PATTERN</replaceable>...</command></term>
659 <para>Restart one or more units specified on the command
660 line. If the units are not running yet, they will be
665 <term><command>try-restart <replaceable>PATTERN</replaceable>...</command></term>
668 <para>Restart one or more units specified on the command
669 line if the units are running. This does nothing if units are not
670 running. Note that, for compatibility with Red Hat init
671 scripts, <command>condrestart</command> is equivalent to this
676 <term><command>reload-or-restart <replaceable>PATTERN</replaceable>...</command></term>
679 <para>Reload one or more units if they support it. If not,
680 restart them instead. If the units are not running yet, they
681 will be started.</para>
685 <term><command>reload-or-try-restart <replaceable>PATTERN</replaceable>...</command></term>
688 <para>Reload one or more units if they support it. If not,
689 restart them instead. This does nothing if the units are not
690 running. Note that, for compatibility with SysV init scripts,
691 <command>force-reload</command> is equivalent to this
696 <term><command>isolate <replaceable>NAME</replaceable></command></term>
699 <para>Start the unit specified on the command line and its
700 dependencies and stop all others.</para>
702 <para>This is similar to changing the runlevel in a
703 traditional init system. The <command>isolate</command>
704 command will immediately stop processes that are not enabled
705 in the new unit, possibly including the graphical
706 environment or terminal you are currently using.</para>
708 <para>Note that this is allowed only on units where
709 <option>AllowIsolate=</option> is enabled. See
710 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
715 <term><command>kill <replaceable>PATTERN</replaceable>...</command></term>
718 <para>Send a signal to one or more processes of the
719 unit. Use <option>--kill-who=</option> to select which
720 process to kill. Use <option>--signal=</option> to select
721 the signal to send.</para>
725 <term><command>is-active <replaceable>PATTERN</replaceable>...</command></term>
728 <para>Check whether any of the specified units are active
729 (i.e. running). Returns an exit code
730 <constant>0</constant> if at least one is active, or
731 non-zero otherwise. Unless <option>--quiet</option> is
732 specified, this will also print the current unit state to
733 standard output.</para>
737 <term><command>is-failed <replaceable>PATTERN</replaceable>...</command></term>
740 <para>Check whether any of the specified units are in a
741 "failed" state. Returns an exit code
742 <constant>0</constant> if at least one has failed,
743 non-zero otherwise. Unless <option>--quiet</option> is
744 specified, this will also print the current unit state to
745 standard output.</para>
749 <term><command>status</command> <optional><replaceable>PATTERN</replaceable>...|<replaceable>PID</replaceable>...]</optional></term>
752 <para>Show terse runtime status information about one or
753 more units, followed by most recent log data from the
754 journal. If no units are specified, show system status. If
755 combined with <option>--all</option>, also show the status of
756 all units (subject to limitations specified with
757 <option>-t</option>). If a PID is passed, show information
758 about the unit the process belongs to.</para>
760 <para>This function is intended to generate human-readable
761 output. If you are looking for computer-parsable output,
762 use <command>show</command> instead. By default this
763 function only shows 10 lines of output and ellipsizes
764 lines to fit in the terminal window. This can be changes
765 with <option>--lines</option> and <option>--full</option>,
766 see above. In addition, <command>journalctl
767 --unit=<replaceable>NAME</replaceable></command> or
769 --user-unit=<replaceable>NAME</replaceable></command> use
770 a similar filter for messages and might be more
776 <term><command>show</command> <optional><replaceable>PATTERN</replaceable>...|<replaceable>JOB</replaceable>...</optional></term>
779 <para>Show properties of one or more units, jobs, or the
780 manager itself. If no argument is specified, properties of
781 the manager will be shown. If a unit name is specified,
782 properties of the unit is shown, and if a job id is
783 specified, properties of the job is shown. By default, empty
784 properties are suppressed. Use <option>--all</option> to
785 show those too. To select specific properties to show, use
786 <option>--property=</option>. This command is intended to be
787 used whenever computer-parsable output is required. Use
788 <command>status</command> if you are looking for formatted
789 human-readable output.</para>
793 <term><command>cat <replaceable>PATTERN</replaceable>...</command></term>
796 <para>Show backing files of one or more units. Prints the
797 "fragment" and "drop-ins" (source files) of units. Each
798 file is preceded by a comment which includes the file
803 <term><command>set-property <replaceable>NAME</replaceable> <replaceable>ASSIGNMENT</replaceable>...</command></term>
806 <para>Set the specified unit properties at runtime where
807 this is supported. This allows changing configuration
808 parameter properties such as resource control settings at
809 runtime. Not all properties may be changed at runtime, but
810 many resource control settings (primarily those in
811 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
812 may. The changes are applied instantly, and stored on disk
813 for future boots, unless <option>--runtime</option> is
814 passed, in which case the settings only apply until the
815 next reboot. The syntax of the property assignment follows
816 closely the syntax of assignments in unit files.</para>
818 <para>Example: <command>systemctl set-property foobar.service CPUShares=777</command></para>
820 <para>Note that this command allows changing multiple
821 properties at the same time, which is preferable over
822 setting them individually. Like unit file configuration
823 settings, assigning the empty list to list parameters will
824 reset the list.</para>
829 <term><command>help <replaceable>PATTERN</replaceable>...|<replaceable>PID</replaceable>...</command></term>
832 <para>Show manual pages for one or more units, if
833 available. If a PID is given, the manual pages for the unit
834 the process belongs to are shown.</para>
839 <term><command>reset-failed [<replaceable>PATTERN</replaceable>...]</command></term>
842 <para>Reset the <literal>failed</literal> state of the
843 specified units, or if no unit name is passed, reset the state of all
844 units. When a unit fails in some way (i.e. process exiting
845 with non-zero error code, terminating abnormally or timing
846 out), it will automatically enter the
847 <literal>failed</literal> state and its exit code and status
848 is recorded for introspection by the administrator until the
849 service is restarted or reset with this command.</para>
854 <term><command>list-dependencies <replaceable>NAME</replaceable></command></term>
857 <para>Shows required and wanted units of the specified
858 unit. If no unit is specified,
859 <filename>default.target</filename> is implied. Target units
860 are recursively expanded. When <option>--all</option> is
861 passed, all other units are recursively expanded as
869 <title>Unit File Commands</title>
873 <term><command>list-unit-files <optional><replaceable>PATTERN...</replaceable></optional></command></term>
876 <para>List installed unit files. If one or more
877 <replaceable>PATTERN</replaceable>s are specified, only
878 units whose filename (just the last component of the path)
879 matches one of them are shown.</para>
884 <term><command>enable <replaceable>NAME</replaceable>...</command></term>
887 <para>Enable one or more unit files or unit file instances,
888 as specified on the command line. This will create a number
889 of symlinks as encoded in the <literal>[Install]</literal>
890 sections of the unit files. After the symlinks have been
891 created, the systemd configuration is reloaded (in a way that
892 is equivalent to <command>daemon-reload</command>) to ensure
893 the changes are taken into account immediately. Note that
894 this does <emphasis>not</emphasis> have the effect of also
895 starting any of the units being enabled. If this
896 is desired, a separate <command>start</command> command must
897 be invoked for the unit. Also note that in case of instance
898 enablement, symlinks named the same as instances are created in
899 the install location, however they all point to the same
900 template unit file.</para>
902 <para>This command will print the actions executed. This
903 output may be suppressed by passing <option>--quiet</option>.
906 <para>Note that this operation creates only the suggested
907 symlinks for the units. While this command is the
908 recommended way to manipulate the unit configuration
909 directory, the administrator is free to make additional
910 changes manually by placing or removing symlinks in the
911 directory. This is particularly useful to create
912 configurations that deviate from the suggested default
913 installation. In this case, the administrator must make sure
914 to invoke <command>daemon-reload</command> manually as
915 necessary to ensure the changes are taken into account.
918 <para>Enabling units should not be confused with starting
919 (activating) units, as done by the <command>start</command>
920 command. Enabling and starting units is orthogonal: units
921 may be enabled without being started and started without
922 being enabled. Enabling simply hooks the unit into various
923 suggested places (for example, so that the unit is
924 automatically started on boot or when a particular kind of
925 hardware is plugged in). Starting actually spawns the daemon
926 process (in case of service units), or binds the socket (in
927 case of socket units), and so on.</para>
929 <para>Depending on whether <option>--system</option>,
930 <option>--user</option>, <option>--runtime</option>,
931 or <option>--global</option> is specified, this enables the unit
932 for the system, for the calling user only, for only this boot of
933 the system, or for all future logins of all users, or only this
934 boot. Note that in the last case, no systemd daemon
935 configuration is reloaded.</para>
937 <para>Using <command>enable</command> on masked units
938 results in an error.</para>
943 <term><command>disable <replaceable>NAME</replaceable>...</command></term>
946 <para>Disables one or more units. This removes all symlinks
947 to the specified unit files from the unit configuration
948 directory, and hence undoes the changes made by
949 <command>enable</command>. Note however that this removes
950 all symlinks to the unit files (i.e. including manual
951 additions), not just those actually created by
952 <command>enable</command>. This call implicitly reloads the
953 systemd daemon configuration after completing the disabling
954 of the units. Note that this command does not implicitly
955 stop the units that are being disabled. If this is desired,
956 an additional <command>stop</command> command should be
957 executed afterwards.</para>
959 <para>This command will print the actions executed. This
960 output may be suppressed by passing <option>--quiet</option>.
963 <para>This command honors <option>--system</option>,
964 <option>--user</option>, <option>--runtime</option> and
965 <option>--global</option> in a similar way as
966 <command>enable</command>.</para>
971 <term><command>is-enabled <replaceable>NAME</replaceable>...</command></term>
974 <para>Checks whether any of the specified unit files are
975 enabled (as with <command>enable</command>). Returns an
976 exit code of 0 if at least one is enabled, non-zero
977 otherwise. Prints the current enable status (see table).
978 To suppress this output, use <option>--quiet</option>.
983 <command>is-enabled</command> output
989 <entry>Printed string</entry>
990 <entry>Meaning</entry>
991 <entry>Return value</entry>
996 <entry><literal>enabled</literal></entry>
997 <entry morerows='1'>Enabled through a symlink in <filename>.wants</filename> directory (permanently or just in <filename>/run</filename>)</entry>
998 <entry morerows='1'>0</entry>
1001 <entry><literal>enabled-runtime</literal></entry>
1004 <entry><literal>linked</literal></entry>
1005 <entry morerows='1'>Made available through a symlink to the unit file (permanently or just in <filename>/run</filename>)</entry>
1006 <entry morerows='1'>1</entry>
1009 <entry><literal>linked-runtime</literal></entry>
1012 <entry><literal>masked</literal></entry>
1013 <entry morerows='1'>Disabled entirely (permanently or just in <filename>/run</filename>)</entry>
1014 <entry morerows='1'>1</entry>
1017 <entry><literal>masked-runtime</literal></entry>
1020 <entry><literal>static</literal></entry>
1021 <entry>Unit is not enabled, but has no provisions for enabling in [Install] section</entry>
1025 <entry><literal>disabled</literal></entry>
1026 <entry>Unit is not enabled</entry>
1037 <term><command>reenable <replaceable>NAME</replaceable>...</command></term>
1040 <para>Reenable one or more unit files, as specified on the
1041 command line. This is a combination of
1042 <command>disable</command> and <command>enable</command> and
1043 is useful to reset the symlinks a unit is enabled with to
1044 the defaults configured in the <literal>[Install]</literal>
1045 section of the unit file.</para>
1050 <term><command>preset <replaceable>NAME</replaceable>...</command></term>
1053 <para>Reset one or more unit files, as specified on the
1054 command line, to the defaults configured in the preset
1055 policy files. This has the same effect as
1056 <command>disable</command> or <command>enable</command>,
1057 depending how the unit is listed in the preset files.</para>
1059 <para>Use <option>--preset-mode=</option> to control
1060 whether units shall be enabled and disabled, or only
1061 enabled, or only disabled.</para>
1063 <para>For more information on the preset policy format,
1065 <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1066 For more information on the concept of presets, please
1068 url="http://freedesktop.org/wiki/Software/systemd/Preset">Preset</ulink>
1074 <term><command>preset-all</command></term>
1077 <para>Resets all installed unit files to the defaults
1078 configured in the preset policy file (see above).</para>
1080 <para>Use <option>--preset-mode=</option> to control
1081 whether units shall be enabled and disabled, or only
1082 enabled, or only disabled.</para>
1087 <term><command>mask <replaceable>NAME</replaceable>...</command></term>
1090 <para>Mask one or more unit files, as specified on the
1091 command line. This will link these units to
1092 <filename>/dev/null</filename>, making it impossible to
1093 start them. This is a stronger version of
1094 <command>disable</command>, since it prohibits all kinds of
1095 activation of the unit, including enablement and manual
1096 activation. Use this option with care. This honors the
1097 <option>--runtime</option> option to only mask temporarily
1098 until the next reboot of the system.</para>
1103 <term><command>unmask <replaceable>NAME</replaceable>...</command></term>
1106 <para>Unmask one or more unit files, as specified on the
1107 command line. This will undo the effect of
1108 <command>mask</command>.</para>
1113 <term><command>add-wants <replaceable>TARGET</replaceable>
1114 <replaceable>NAME</replaceable>...</command></term>
1115 <term><command>add-requires <replaceable>TARGET</replaceable>
1116 <replaceable>NAME</replaceable>...</command></term>
1119 <para>Adds <literal>Wants=</literal> resp. <literal>Requires=</literal>
1120 dependency to the specified <replaceable>TARGET</replaceable> for
1121 one or more units. </para>
1123 <para>This command honors <option>--system</option>,
1124 <option>--user</option>, <option>--runtime</option> and
1125 <option>--global</option> in a similar way as
1126 <command>enable</command>.</para>
1132 <term><command>link <replaceable>FILENAME</replaceable>...</command></term>
1135 <para>Link a unit file that is not in the unit file search
1136 paths into the unit file search path. This requires an
1137 absolute path to a unit file. The effect of this can be
1138 undone with <command>disable</command>. The effect of this
1139 command is that a unit file is available for
1140 <command>start</command> and other commands although it
1141 is not installed directly in the unit search path.</para>
1146 <term><command>get-default</command></term>
1149 <para>Get the default target specified
1150 via <filename>default.target</filename> link.</para>
1155 <term><command>set-default <replaceable>NAME</replaceable></command></term>
1158 <para>Set the default target to boot into. Command links
1159 <filename>default.target</filename> to the given unit.</para>
1166 <title>Machine Commands</title>
1170 <term><command>list-machines <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
1173 <para>List the host and all running local containers with
1174 their state. If one or more
1175 <replaceable>PATTERN</replaceable>s are specified, only
1176 containers matching one of them are shown.
1184 <title>Job Commands</title>
1188 <term><command>list-jobs <optional><replaceable>PATTERN...</replaceable></optional></command></term>
1191 <para>List jobs that are in progress. If one or more
1192 <replaceable>PATTERN</replaceable>s are specified, only
1193 jobs for units matching one of them are shown.</para>
1197 <term><command>cancel <replaceable>JOB</replaceable>...</command></term>
1200 <para>Cancel one or more jobs specified on the command line
1201 by their numeric job IDs. If no job ID is specified, cancel
1202 all pending jobs.</para>
1209 <title>Snapshot Commands</title>
1213 <term><command>snapshot <optional><replaceable>NAME</replaceable></optional></command></term>
1216 <para>Create a snapshot. If a snapshot name is specified,
1217 the new snapshot will be named after it. If none is
1218 specified, an automatic snapshot name is generated. In
1219 either case, the snapshot name used is printed to standard
1220 output, unless <option>--quiet</option> is specified.
1223 <para>A snapshot refers to a saved state of the systemd
1224 manager. It is implemented itself as a unit that is
1225 generated dynamically with this command and has dependencies
1226 on all units active at the time. At a later time, the user
1227 may return to this state by using the
1228 <command>isolate</command> command on the snapshot unit.
1231 <para>Snapshots are only useful for saving and restoring
1232 which units are running or are stopped, they do not
1233 save/restore any other state. Snapshots are dynamic and lost
1238 <term><command>delete <replaceable>PATTERN</replaceable>...</command></term>
1241 <para>Remove a snapshot previously created with
1242 <command>snapshot</command>.</para>
1249 <title>Environment Commands</title>
1253 <term><command>show-environment</command></term>
1256 <para>Dump the systemd manager environment block. The
1257 environment block will be dumped in straight-forward form
1258 suitable for sourcing into a shell script. This environment
1259 block will be passed to all processes the manager
1264 <term><command>set-environment <replaceable>VARIABLE=VALUE</replaceable>...</command></term>
1267 <para>Set one or more systemd manager environment variables,
1268 as specified on the command line.</para>
1272 <term><command>unset-environment <replaceable>VARIABLE</replaceable>...</command></term>
1275 <para>Unset one or more systemd manager environment
1276 variables. If only a variable name is specified, it will be
1277 removed regardless of its value. If a variable and a value
1278 are specified, the variable is only removed if it has the
1279 specified value.</para>
1283 <term><command>import-environment <replaceable>VARIABLE</replaceable>...</command></term>
1286 <para>Import all, one or more environment variables set on
1287 the client into the systemd manager environment block. If
1288 no arguments are passed, the entire environment block is
1289 imported. Otherwise, a list of one or more environment
1290 variable names should be passed, whose client-side values
1291 are then imported into the manager's environment
1299 <title>Manager Lifecycle Commands</title>
1303 <term><command>daemon-reload</command></term>
1306 <para>Reload systemd manager configuration. This will reload
1307 all unit files and recreate the entire dependency
1308 tree. While the daemon is being reloaded, all sockets systemd
1309 listens on behalf of user configuration will stay
1310 accessible.</para> <para>This command should not be confused
1311 with the <command>reload</command> command.</para>
1315 <term><command>daemon-reexec</command></term>
1318 <para>Reexecute the systemd manager. This will serialize the
1319 manager state, reexecute the process and deserialize the
1320 state again. This command is of little use except for
1321 debugging and package upgrades. Sometimes, it might be
1322 helpful as a heavy-weight <command>daemon-reload</command>.
1323 While the daemon is being reexecuted, all sockets systemd listening
1324 on behalf of user configuration will stay accessible.
1332 <title>System Commands</title>
1336 <term><command>is-system-running</command></term>
1339 <para>Checks whether the system is operational. This
1340 returns success when the system is fully up and running,
1341 meaning not in startup, shutdown or maintenance
1342 mode. Failure is returned otherwise. In addition, the
1343 current state is printed in a short string to standard
1344 output, see table below. Use <option>--quiet</option> to
1345 suppress this output.</para>
1348 <title>Manager Operational States</title>
1350 <colspec colname='name' />
1351 <colspec colname='description' />
1355 <entry>Description</entry>
1360 <entry><varname>initializing</varname></entry>
1361 <entry><para>Early bootup, before
1362 <filename>basic.target</filename> is reached
1363 or the <varname>maintenance</varname> state entered.
1367 <entry><varname>starting</varname></entry>
1368 <entry><para>Late bootup, before the job queue
1369 becomes idle for the first time, or one of the
1370 rescue targets are reached.</para></entry>
1373 <entry><varname>running</varname></entry>
1374 <entry><para>The system is fully
1375 operational.</para></entry>
1378 <entry><varname>degraded</varname></entry>
1379 <entry><para>The system is operational but one or more
1380 units failed.</para></entry>
1383 <entry><varname>maintenance</varname></entry>
1384 <entry><para>The rescue or emergency target is
1385 active.</para></entry>
1388 <entry><varname>stopping</varname></entry>
1389 <entry><para>The manager is shutting
1390 down.</para></entry>
1399 <term><command>default</command></term>
1402 <para>Enter default mode. This is mostly equivalent to
1403 <command>isolate default.target</command>.</para>
1408 <term><command>rescue</command></term>
1411 <para>Enter rescue mode. This is mostly equivalent to
1412 <command>isolate rescue.target</command>, but also prints a
1413 wall message to all users.</para>
1417 <term><command>emergency</command></term>
1420 <para>Enter emergency mode. This is mostly equivalent to
1421 <command>isolate emergency.target</command>, but also prints
1422 a wall message to all users.</para>
1426 <term><command>halt</command></term>
1429 <para>Shut down and halt the system. This is mostly equivalent to
1430 <command>start halt.target --irreversible</command>, but also
1431 prints a wall message to all users. If combined with
1432 <option>--force</option>, shutdown of all running services is
1433 skipped, however all processes are killed and all file
1434 systems are unmounted or mounted read-only, immediately
1435 followed by the system halt. If <option>--force</option> is
1436 specified twice, the operation is immediately executed
1437 without terminating any processes or unmounting any file
1438 systems. This may result in data loss.</para>
1442 <term><command>poweroff</command></term>
1445 <para>Shut down and power-off the system. This is mostly
1446 equivalent to <command>start poweroff.target --irreversible</command>,
1447 but also prints a wall message to all users. If combined with
1448 <option>--force</option>, shutdown of all running services is
1449 skipped, however all processes are killed and all file
1450 systems are unmounted or mounted read-only, immediately
1451 followed by the powering off. If <option>--force</option> is
1452 specified twice, the operation is immediately executed
1453 without terminating any processes or unmounting any file
1454 systems. This may result in data loss.</para>
1458 <term><command>reboot <optional><replaceable>arg</replaceable></optional></command></term>
1461 <para>Shut down and reboot the system. This is mostly
1462 equivalent to <command>start reboot.target --irreversible</command>,
1463 but also prints a wall message to all users. If combined with
1464 <option>--force</option>, shutdown of all running services is
1465 skipped, however all processes are killed and all file
1466 systems are unmounted or mounted read-only, immediately
1467 followed by the reboot. If <option>--force</option> is
1468 specified twice, the operation is immediately executed
1469 without terminating any processes or unmounting any file
1470 systems. This may result in data loss.</para>
1472 <para>If the optional argument
1473 <replaceable>arg</replaceable> is given, it will be passed
1474 as the optional argument to the
1475 <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1476 system call. The value is architecture and firmware
1477 specific. As an example, <literal>recovery</literal> might
1478 be used to trigger system recovery, and
1479 <literal>fota</literal> might be used to trigger a
1480 <quote>firmware over the air</quote> update.</para>
1484 <term><command>kexec</command></term>
1487 <para>Shut down and reboot the system via kexec. This is
1488 mostly equivalent to <command>start kexec.target --irreversible</command>,
1489 but also prints a wall message to all users. If combined
1490 with <option>--force</option>, shutdown of all running
1491 services is skipped, however all processes are killed and
1492 all file systems are unmounted or mounted read-only,
1493 immediately followed by the reboot.</para>
1497 <term><command>exit</command></term>
1500 <para>Ask the systemd manager to quit. This is only
1501 supported for user service managers (i.e. in conjunction
1502 with the <option>--user</option> option) and will fail
1508 <term><command>suspend</command></term>
1511 <para>Suspend the system. This will trigger activation of
1512 the special <filename>suspend.target</filename> target.
1517 <term><command>hibernate</command></term>
1520 <para>Hibernate the system. This will trigger activation of
1521 the special <filename>hibernate.target</filename> target.
1526 <term><command>hybrid-sleep</command></term>
1529 <para>Hibernate and suspend the system. This will trigger
1530 activation of the special
1531 <filename>hybrid-sleep.target</filename> target.</para>
1535 <term><command>switch-root <replaceable>ROOT</replaceable> <optional><replaceable>INIT</replaceable></optional></command></term>
1538 <para>Switches to a different root directory and executes a
1539 new system manager process below it. This is intended for
1540 usage in initial RAM disks ("initrd"), and will transition
1541 from the initrd's system manager process (a.k.a "init"
1542 process) to the main system manager process. This call takes two
1543 arguments: the directory that is to become the new root directory, and
1544 the path to the new system manager binary below it to
1545 execute as PID 1. If the latter is omitted or the empty
1546 string, a systemd binary will automatically be searched for
1547 and used as init. If the system manager path is omitted or
1548 equal to the empty string, the state of the initrd's system
1549 manager process is passed to the main system manager, which
1550 allows later introspection of the state of the services
1551 involved in the initrd boot.</para>
1558 <title>Parameter Syntax</title>
1560 <para>Unit commands listed above take either a single unit name
1561 (designated as <replaceable>NAME</replaceable>), or multiple
1562 unit specifications (designated as
1563 <replaceable>PATTERN</replaceable>...). In the first case, the
1564 unit name with or without a suffix must be given. If the suffix
1565 is not specified, systemctl will append a suitable suffix,
1566 <literal>.service</literal> by default, and a type-specific
1567 suffix in case of commands which operate only on specific unit
1569 <programlisting># systemctl start sshd</programlisting> and
1570 <programlisting># systemctl start sshd.service</programlisting>
1571 are equivalent, as are
1572 <programlisting># systemctl isolate snapshot-11</programlisting>
1574 <programlisting># systemctl isolate snapshot-11.snapshot</programlisting>
1575 Note that (absolute) paths to device nodes are automatically
1576 converted to device unit names, and other (absolute) paths to
1578 <programlisting># systemctl status /dev/sda
1579 # systemctl status /home</programlisting>
1581 <programlisting># systemctl status dev-sda.device
1582 # systemctl status home.mount</programlisting>
1583 In the second case, shell-style globs will be matched against
1584 currently loaded units; literal unit names, with or without
1585 a suffix, will be treated as in the first case. This means that
1586 literal unit names always refer to exactly one unit, but globs
1587 may match zero units and this is not considered an error.</para>
1589 <para>Glob patterns use
1590 <citerefentry><refentrytitle>fnmatch</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
1591 so normal shell-style globbing rules are used, and
1592 <literal>*</literal>, <literal>?</literal>,
1593 <literal>[]</literal> may be used. See
1594 <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1595 for more details. The patterns are matched against the names of
1596 currently loaded units, and patterns which do not match anything
1597 are silently skipped. For example:
1598 <programlisting># systemctl stop sshd@*.service</programlisting>
1599 will stop all <filename>sshd@.service</filename> instances.
1602 <para>For unit file commands, the specified
1603 <replaceable>NAME</replaceable> should be the full name of the
1604 unit file, or the absolute path to the unit file:
1605 <programlisting># systemctl enable foo.service</programlisting>
1607 <programlisting># systemctl link /path/to/foo.service</programlisting>
1614 <title>Exit status</title>
1616 <para>On success, 0 is returned, a non-zero failure
1617 code otherwise.</para>
1620 <xi:include href="less-variables.xml" />
1623 <title>See Also</title>
1625 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1626 <citerefentry><refentrytitle>systemadm</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1627 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1628 <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1629 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1630 <citerefentry><refentrytitle>systemd.resource-management</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1631 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1632 <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1633 <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1634 <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>