1 <?xml version='1.0'?> <!--*-nxml-*-->
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
6 This file is part of systemd.
8 Copyright 2010 Lennart Poettering
10 systemd is free software; you can redistribute it and/or modify it
11 under the terms of the GNU Lesser General Public License as published by
12 the Free Software Foundation; either version 2.1 of the License, or
13 (at your option) any later version.
15 systemd is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 Lesser General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
24 <refentry id="systemctl"
25 xmlns:xi="http://www.w3.org/2001/XInclude">
28 <title>systemctl</title>
29 <productname>systemd</productname>
33 <contrib>Developer</contrib>
34 <firstname>Lennart</firstname>
35 <surname>Poettering</surname>
36 <email>lennart@poettering.net</email>
42 <refentrytitle>systemctl</refentrytitle>
43 <manvolnum>1</manvolnum>
47 <refname>systemctl</refname>
48 <refpurpose>Control the systemd system and service manager</refpurpose>
53 <command>systemctl</command>
54 <arg choice="opt" rep="repeat">OPTIONS</arg>
55 <arg choice="plain">COMMAND</arg>
56 <arg choice="opt" rep="repeat">NAME</arg>
61 <title>Description</title>
63 <para><command>systemctl</command> may be used to
64 introspect and control the state of the
65 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
66 system and service manager.</para>
70 <title>Options</title>
72 <para>The following options are understood:</para>
76 <term><option>-t</option></term>
77 <term><option>--type=</option></term>
80 <para>The argument should be a comma-separated list of unit
81 types such as <option>service</option> and
82 <option>socket</option>.
85 <para>If one of the arguments is a unit type, when listing
86 units, limit display to certain unit types. Otherwise, units
87 of all types will be shown.</para>
89 <para>As a special case, if one of the arguments is
90 <option>help</option>, a list of allowed values will be
91 printed and the program will exit.</para>
96 <term><option>--state=</option></term>
99 <para>The argument should be a comma-separated list of unit LOAD,
100 SUB, or ACTIVE states. When listing units, show only those
101 in specified states.</para>
106 <term><option>-p</option></term>
107 <term><option>--property=</option></term>
110 <para>When showing unit/job/manager properties with the
111 <command>show</command> command, limit display to certain
112 properties as specified as argument. If not specified, all
113 set properties are shown. The argument should be a
114 comma-separated list of property names, such as
115 <literal>MainPID</literal>. If specified more than once, all
116 properties with the specified names are shown.</para>
121 <term><option>-a</option></term>
122 <term><option>--all</option></term>
125 <para>When listing units, show all loaded units, regardless
126 of their state, including inactive units. When showing
127 unit/job/manager properties, show all properties regardless
128 whether they are set or not.</para>
129 <para>To list all units installed on the system, use the
130 <command>list-unit-files</command> command instead.</para>
135 <term><option>-r</option></term>
136 <term><option>--recursive</option></term>
139 <para>When listing units, also show units of local
140 containers. Units of local containers will be prefixed with
141 the container name, separated by a single colon character
142 (<literal>:</literal>).</para>
147 <term><option>--reverse</option></term>
150 <para>Show reverse dependencies between units with
151 <command>list-dependencies</command>, i.e. units with
152 dependencies of type <varname>Wants=</varname> or
153 <varname>Requires=</varname> on the given unit.
159 <term><option>--after</option></term>
162 <para>With <command>list-dependencies</command>, show the
163 units that are ordered before the specified unit. In other
164 words, list the units that are in the <varname>After=</varname>
165 directive of the specified unit, have the specified unit in
166 their <varname>Before=</varname> directive, or are otherwise
167 implicit dependencies of the specified unit.</para>
172 <term><option>--before</option></term>
175 <para>With <command>list-dependencies</command>, show the
176 units that are ordered after the specified unit. In other
177 words, list the units that are in the <varname>Before=</varname>
178 directive of the specified unit, have the specified unit in
179 their <varname>After=</varname> directive, or otherwise depend
180 on the specified unit.</para>
185 <term><option>-l</option></term>
186 <term><option>--full</option></term>
189 <para>Do not ellipsize unit names, process tree entries,
190 journal output, or truncate unit descriptions in the output
191 of <command>status</command>, <command>list-units</command>,
192 <command>list-jobs</command>, and
193 <command>list-timers</command>.</para>
198 <term><option>--show-types</option></term>
201 <para>When showing sockets, show the type of the socket.</para>
206 <term><option>--job-mode=</option></term>
209 <para>When queuing a new job, this option controls how to deal with
210 already queued jobs. It takes one of <literal>fail</literal>,
211 <literal>replace</literal>,
212 <literal>replace-irreversibly</literal>,
213 <literal>isolate</literal>,
214 <literal>ignore-dependencies</literal>,
215 <literal>ignore-requirements</literal> or
216 <literal>flush</literal>. Defaults to
217 <literal>replace</literal>, except when the
218 <command>isolate</command> command is used which implies the
219 <literal>isolate</literal> job mode.</para>
221 <para>If <literal>fail</literal> is specified and a requested
222 operation conflicts with a pending job (more specifically:
223 causes an already pending start job to be reversed into a stop
224 job or vice versa), cause the operation to fail.</para>
226 <para>If <literal>replace</literal> (the default) is
227 specified, any conflicting pending job will be replaced, as
230 <para>If <literal>replace-irreversibly</literal> is specified,
231 operate like <literal>replace</literal>, but also mark the new
232 jobs as irreversible. This prevents future conflicting
233 transactions from replacing these jobs (or even being enqueued
234 while the irreversible jobs are still pending). Irreversible
235 jobs can still be cancelled using the <command>cancel</command>
238 <para><literal>isolate</literal> is only valid for start
239 operations and causes all other units to be stopped when the
240 specified unit is started. This mode is always used when the
241 <command>isolate</command> command is used.</para>
243 <para><literal>flush</literal> will cause all queued jobs to
244 be canceled when the new job is enqueued.</para>
246 <para>If <literal>ignore-dependencies</literal> is specified,
247 then all unit dependencies are ignored for this new job and
248 the operation is executed immediately. If passed, no required
249 units of the unit passed will be pulled in, and no ordering
250 dependencies will be honored. This is mostly a debugging and
251 rescue tool for the administrator and should not be used by
254 <para><literal>ignore-requirements</literal> is similar to
255 <literal>ignore-dependencies</literal>, but only causes the
256 requirement dependencies to be ignored, the ordering
257 dependencies will still be honoured.</para>
263 <term><option>-i</option></term>
264 <term><option>--ignore-inhibitors</option></term>
267 <para>When system shutdown or a sleep state is requested,
268 ignore inhibitor locks. Applications can establish inhibitor
269 locks to avoid that certain important operations (such as CD
270 burning or suchlike) are interrupted by system shutdown or a
271 sleep state. Any user may take these locks and privileged
272 users may override these locks. If any locks are taken,
273 shutdown and sleep state requests will normally fail
274 (regardless of whether privileged or not) and a list of active locks
275 is printed. However, if <option>--ignore-inhibitors</option>
276 is specified, the locks are ignored and not printed, and the
277 operation attempted anyway, possibly requiring additional
283 <term><option>-q</option></term>
284 <term><option>--quiet</option></term>
287 <para>Suppress output to standard output in
288 <command>snapshot</command>,
289 <command>is-active</command>,
290 <command>is-failed</command>,
291 <command>is-enabled</command>,
292 <command>is-system-running</command>,
293 <command>enable</command> and
294 <command>disable</command>.</para>
299 <term><option>--no-block</option></term>
302 <para>Do not synchronously wait for the requested operation
303 to finish. If this is not specified, the job will be
304 verified, enqueued and <command>systemctl</command> will
305 wait until it is completed. By passing this argument, it is
306 only verified and enqueued.</para>
311 <term><option>--no-legend</option></term>
314 <para>Do not print the legend, i.e. the column headers and
315 the footer with hints.</para>
319 <xi:include href="user-system-options.xml" xpointer="user" />
320 <xi:include href="user-system-options.xml" xpointer="system" />
323 <term><option>--no-wall</option></term>
326 <para>Do not send wall message before halt, power-off,
332 <term><option>--global</option></term>
335 <para>When used with <command>enable</command> and
336 <command>disable</command>, operate on the global user
337 configuration directory, thus enabling or disabling a unit
338 file globally for all future logins of all users.</para>
343 <term><option>--no-reload</option></term>
346 <para>When used with <command>enable</command> and
347 <command>disable</command>, do not implicitly reload daemon
348 configuration after executing the changes.</para>
353 <term><option>--no-ask-password</option></term>
356 <para>When used with <command>start</command> and related
357 commands, disables asking for passwords. Background services
358 may require input of a password or passphrase string, for
359 example to unlock system hard disks or cryptographic
360 certificates. Unless this option is specified and the
361 command is invoked from a terminal,
362 <command>systemctl</command> will query the user on the
363 terminal for the necessary secrets. Use this option to
364 switch this behavior off. In this case, the password must be
365 supplied by some other means (for example graphical password
366 agents) or the service might fail. This also disables
367 querying the user for authentication for privileged
374 <term><option>--kill-who=</option></term>
377 <para>When used with <command>kill</command>, choose which
378 processes to send a signal to. Must be one of
379 <option>main</option>, <option>control</option> or
380 <option>all</option> to select whether to kill only the main
381 process, the control process or all processes of the
382 unit. The main process of the unit is the one that defines
383 the life-time of it. A control process of a unit is one that
384 is invoked by the manager to induce state changes of it. For
385 example, all processes started due to the
386 <varname>ExecStartPre=</varname>,
387 <varname>ExecStop=</varname> or
388 <varname>ExecReload=</varname> settings of service units are
389 control processes. Note that there is only one control
390 process per unit at a time, as only one state change is
391 executed at a time. For services of type
392 <varname>Type=forking</varname>, the initial process started
393 by the manager for <varname>ExecStart=</varname> is a
394 control process, while the process ultimately forked off by
395 that one is then considered the main process of the unit (if
396 it can be determined). This is different for service units
397 of other types, where the process forked off by the manager
398 for <varname>ExecStart=</varname> is always the main process
399 itself. A service unit consists of zero or one main process,
400 zero or one control process plus any number of additional
401 processes. Not all unit types manage processes of these
402 types however. For example, for mount units, control processes
403 are defined (which are the invocations of
404 <filename>/usr/bin/mount</filename> and
405 <filename>/usr/bin/umount</filename>), but no main process
406 is defined. If omitted, defaults to
407 <option>all</option>.</para>
413 <term><option>-s</option></term>
414 <term><option>--signal=</option></term>
417 <para>When used with <command>kill</command>, choose which
418 signal to send to selected processes. Must be one of the
419 well known signal specifiers such as <constant>SIGTERM</constant>, <constant>SIGINT</constant> or
420 <constant>SIGSTOP</constant>. If omitted, defaults to
421 <option>SIGTERM</option>.</para>
426 <term><option>-f</option></term>
427 <term><option>--force</option></term>
430 <para>When used with <command>enable</command>, overwrite
431 any existing conflicting symlinks.</para>
433 <para>When used with <command>halt</command>,
434 <command>poweroff</command>, <command>reboot</command> or
435 <command>kexec</command>, execute the selected operation
436 without shutting down all units. However, all processes will
437 be killed forcibly and all file systems are unmounted or
438 remounted read-only. This is hence a drastic but relatively
439 safe option to request an immediate reboot. If
440 <option>--force</option> is specified twice for these
441 operations, they will be executed immediately without
442 terminating any processes or unmounting any file
443 systems. Warning: specifying <option>--force</option> twice
444 with any of these operations might result in data
450 <term><option>--root=</option></term>
454 <command>enable</command>/<command>disable</command>/<command>is-enabled</command>
455 (and related commands), use alternative root path when
456 looking for unit files.</para>
462 <term><option>--runtime</option></term>
465 <para>When used with <command>enable</command>,
466 <command>disable</command>,
467 (and related commands), make changes only temporarily, so
468 that they are lost on the next reboot. This will have the
469 effect that changes are not made in subdirectories of
470 <filename>/etc</filename> but in <filename>/run</filename>,
471 with identical immediate effects, however, since the latter
472 is lost on reboot, the changes are lost too.</para>
474 <para>Similarly, when used with
475 <command>set-property</command>, make changes only
476 temporarily, so that they are lost on the next
482 <term><option>--preset-mode=</option></term>
485 <para>Takes one of <literal>full</literal> (the default),
486 <literal>enable-only</literal>,
487 <literal>disable-only</literal>. When used with the
488 <command>preset</command> or <command>preset-all</command>
489 commands, controls whether units shall be disabled and
490 enabled according to the preset rules, or only enabled, or
491 only disabled.</para>
496 <term><option>-n</option></term>
497 <term><option>--lines=</option></term>
500 <para>When used with <command>status</command>, controls the
501 number of journal lines to show, counting from the most
502 recent ones. Takes a positive integer argument. Defaults to
508 <term><option>-o</option></term>
509 <term><option>--output=</option></term>
512 <para>When used with <command>status</command>, controls the
513 formatting of the journal entries that are shown. For the
514 available choices, see
515 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
516 Defaults to <literal>short</literal>.</para>
521 <term><option>--plain</option></term>
524 <para>When used with <command>list-dependencies</command>,
525 the output is printed as a list instead of a tree.</para>
529 <xi:include href="user-system-options.xml" xpointer="host" />
530 <xi:include href="user-system-options.xml" xpointer="machine" />
532 <xi:include href="standard-options.xml" xpointer="help" />
533 <xi:include href="standard-options.xml" xpointer="version" />
534 <xi:include href="standard-options.xml" xpointer="no-pager" />
539 <title>Commands</title>
541 <para>The following commands are understood:</para>
544 <title>Unit Commands</title>
548 <term><command>list-units <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
551 <para>List known units (subject to limitations specified
552 with <option>-t</option>). If one or more
553 <replaceable>PATTERN</replaceable>s are specified, only
554 units matching one of them are shown.</para>
556 <para>This is the default command.</para>
561 <term><command>list-sockets <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
564 <para>List socket units ordered by listening address.
565 If one or more <replaceable>PATTERN</replaceable>s are
566 specified, only socket units matching one of them are
567 shown. Produces output similar to
569 LISTEN UNIT ACTIVATES
570 /dev/initctl systemd-initctl.socket systemd-initctl.service
572 [::]:22 sshd.socket sshd.service
573 kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
575 5 sockets listed.</programlisting>
576 Note: because the addresses might contains spaces, this output
577 is not suitable for programmatic consumption.
580 <para>See also the options <option>--show-types</option>,
581 <option>--all</option>, and <option>--failed</option>.</para>
586 <term><command>list-timers <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
589 <para>List timer units ordered by the time they elapse
590 next. If one or more <replaceable>PATTERN</replaceable>s
591 are specified, only units matching one of them are shown.
594 <para>See also the options <option>--all</option> and
595 <option>--failed</option>.</para>
600 <term><command>start <replaceable>PATTERN</replaceable>...</command></term>
603 <para>Start (activate) one or more units specified on the
606 <para>Note that glob patterns operate on a list of currently
607 loaded units. Units which are not active and are not in a
608 failed state usually are not loaded, and would not be
609 matched by any pattern. In addition, in case of
610 instantiated units, systemd is often unaware of the
611 instance name until the instance has been started. Therefore,
612 using glob patterns with <command>start</command>
613 has limited usefulness.</para>
617 <term><command>stop <replaceable>PATTERN</replaceable>...</command></term>
620 <para>Stop (deactivate) one or more units specified on the
625 <term><command>reload <replaceable>PATTERN</replaceable>...</command></term>
628 <para>Asks all units listed on the command line to reload
629 their configuration. Note that this will reload the
630 service-specific configuration, not the unit configuration
631 file of systemd. If you want systemd to reload the
632 configuration file of a unit, use the
633 <command>daemon-reload</command> command. In other words:
634 for the example case of Apache, this will reload Apache's
635 <filename>httpd.conf</filename> in the web server, not the
636 <filename>apache.service</filename> systemd unit
639 <para>This command should not be confused with the
640 <command>daemon-reload</command> or <command>load</command>
646 <term><command>restart <replaceable>PATTERN</replaceable>...</command></term>
649 <para>Restart one or more units specified on the command
650 line. If the units are not running yet, they will be
655 <term><command>try-restart <replaceable>PATTERN</replaceable>...</command></term>
658 <para>Restart one or more units specified on the command
659 line if the units are running. This does nothing if units are not
660 running. Note that, for compatibility with Red Hat init
661 scripts, <command>condrestart</command> is equivalent to this
666 <term><command>reload-or-restart <replaceable>PATTERN</replaceable>...</command></term>
669 <para>Reload one or more units if they support it. If not,
670 restart them instead. If the units are not running yet, they
671 will be started.</para>
675 <term><command>reload-or-try-restart <replaceable>PATTERN</replaceable>...</command></term>
678 <para>Reload one or more units if they support it. If not,
679 restart them instead. This does nothing if the units are not
680 running. Note that, for compatibility with SysV init scripts,
681 <command>force-reload</command> is equivalent to this
686 <term><command>isolate <replaceable>NAME</replaceable></command></term>
689 <para>Start the unit specified on the command line and its
690 dependencies and stop all others.</para>
692 <para>This is similar to changing the runlevel in a
693 traditional init system. The <command>isolate</command>
694 command will immediately stop processes that are not enabled
695 in the new unit, possibly including the graphical
696 environment or terminal you are currently using.</para>
698 <para>Note that this is allowed only on units where
699 <option>AllowIsolate=</option> is enabled. See
700 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
705 <term><command>kill <replaceable>PATTERN</replaceable>...</command></term>
708 <para>Send a signal to one or more processes of the
709 unit. Use <option>--kill-who=</option> to select which
710 process to kill. Use <option>--signal=</option> to select
711 the signal to send.</para>
715 <term><command>is-active <replaceable>PATTERN</replaceable>...</command></term>
718 <para>Check whether any of the specified units are active
719 (i.e. running). Returns an exit code
720 <constant>0</constant> if at least one is active, or
721 non-zero otherwise. Unless <option>--quiet</option> is
722 specified, this will also print the current unit state to
723 standard output.</para>
727 <term><command>is-failed <replaceable>PATTERN</replaceable>...</command></term>
730 <para>Check whether any of the specified units are in a
731 "failed" state. Returns an exit code
732 <constant>0</constant> if at least one has failed,
733 non-zero otherwise. Unless <option>--quiet</option> is
734 specified, this will also print the current unit state to
735 standard output.</para>
739 <term><command>status</command> <optional><replaceable>PATTERN</replaceable>...|<replaceable>PID</replaceable>...]</optional></term>
742 <para>Show terse runtime status information about one or
743 more units, followed by most recent log data from the
744 journal. If no units are specified, show system status. If
745 combined with <option>--all</option>, also show the status of
746 all units (subject to limitations specified with
747 <option>-t</option>). If a PID is passed, show information
748 about the unit the process belongs to.</para>
750 <para>This function is intended to generate human-readable
751 output. If you are looking for computer-parsable output,
752 use <command>show</command> instead. By default this
753 function only shows 10 lines of output and ellipsizes
754 lines to fit in the terminal window. This can be changes
755 with <option>--lines</option> and <option>--full</option>,
756 see above. In addition, <command>journalctl
757 --unit=<replaceable>NAME</replaceable></command> or
759 --user-unit=<replaceable>NAME</replaceable></command> use
760 a similar filter for messages and might be more
766 <term><command>show</command> <optional><replaceable>PATTERN</replaceable>...|<replaceable>JOB</replaceable>...</optional></term>
769 <para>Show properties of one or more units, jobs, or the
770 manager itself. If no argument is specified, properties of
771 the manager will be shown. If a unit name is specified,
772 properties of the unit is shown, and if a job id is
773 specified, properties of the job is shown. By default, empty
774 properties are suppressed. Use <option>--all</option> to
775 show those too. To select specific properties to show, use
776 <option>--property=</option>. This command is intended to be
777 used whenever computer-parsable output is required. Use
778 <command>status</command> if you are looking for formatted
779 human-readable output.</para>
783 <term><command>cat <replaceable>PATTERN</replaceable>...</command></term>
786 <para>Show backing files of one or more units. Prints the
787 "fragment" and "drop-ins" (source files) of units. Each
788 file is preceded by a comment which includes the file
793 <term><command>set-property <replaceable>NAME</replaceable> <replaceable>ASSIGNMENT</replaceable>...</command></term>
796 <para>Set the specified unit properties at runtime where
797 this is supported. This allows changing configuration
798 parameter properties such as resource control settings at
799 runtime. Not all properties may be changed at runtime, but
800 many resource control settings (primarily those in
801 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
802 may. The changes are applied instantly, and stored on disk
803 for future boots, unless <option>--runtime</option> is
804 passed, in which case the settings only apply until the
805 next reboot. The syntax of the property assignment follows
806 closely the syntax of assignments in unit files.</para>
808 <para>Example: <command>systemctl set-property foobar.service CPUShares=777</command></para>
810 <para>Note that this command allows changing multiple
811 properties at the same time, which is preferable over
812 setting them individually. Like unit file configuration
813 settings, assigning the empty list to list parameters will
814 reset the list.</para>
819 <term><command>help <replaceable>PATTERN</replaceable>...|<replaceable>PID</replaceable>...</command></term>
822 <para>Show manual pages for one or more units, if
823 available. If a PID is given, the manual pages for the unit
824 the process belongs to are shown.</para>
829 <term><command>reset-failed [<replaceable>PATTERN</replaceable>...]</command></term>
832 <para>Reset the <literal>failed</literal> state of the
833 specified units, or if no unit name is passed, reset the state of all
834 units. When a unit fails in some way (i.e. process exiting
835 with non-zero error code, terminating abnormally or timing
836 out), it will automatically enter the
837 <literal>failed</literal> state and its exit code and status
838 is recorded for introspection by the administrator until the
839 service is restarted or reset with this command.</para>
844 <term><command>list-dependencies <replaceable>NAME</replaceable></command></term>
847 <para>Shows required and wanted units of the specified
848 unit. If no unit is specified,
849 <filename>default.target</filename> is implied. Target units
850 are recursively expanded. When <option>--all</option> is
851 passed, all other units are recursively expanded as
859 <title>Unit File Commands</title>
863 <term><command>list-unit-files <optional><replaceable>PATTERN...</replaceable></optional></command></term>
866 <para>List installed unit files. If one or more
867 <replaceable>PATTERN</replaceable>s are specified, only
868 units whose filename (just the last component of the path)
869 matches one of them are shown.</para>
874 <term><command>enable <replaceable>NAME</replaceable>...</command></term>
877 <para>Enable one or more unit files or unit file instances,
878 as specified on the command line. This will create a number
879 of symlinks as encoded in the <literal>[Install]</literal>
880 sections of the unit files. After the symlinks have been
881 created, the systemd configuration is reloaded (in a way that
882 is equivalent to <command>daemon-reload</command>) to ensure
883 the changes are taken into account immediately. Note that
884 this does <emphasis>not</emphasis> have the effect of also
885 starting any of the units being enabled. If this
886 is desired, a separate <command>start</command> command must
887 be invoked for the unit. Also note that in case of instance
888 enablement, symlinks named the same as instances are created in
889 the install location, however they all point to the same
890 template unit file.</para>
892 <para>This command will print the actions executed. This
893 output may be suppressed by passing <option>--quiet</option>.
896 <para>Note that this operation creates only the suggested
897 symlinks for the units. While this command is the
898 recommended way to manipulate the unit configuration
899 directory, the administrator is free to make additional
900 changes manually by placing or removing symlinks in the
901 directory. This is particularly useful to create
902 configurations that deviate from the suggested default
903 installation. In this case, the administrator must make sure
904 to invoke <command>daemon-reload</command> manually as
905 necessary to ensure the changes are taken into account.
908 <para>Enabling units should not be confused with starting
909 (activating) units, as done by the <command>start</command>
910 command. Enabling and starting units is orthogonal: units
911 may be enabled without being started and started without
912 being enabled. Enabling simply hooks the unit into various
913 suggested places (for example, so that the unit is
914 automatically started on boot or when a particular kind of
915 hardware is plugged in). Starting actually spawns the daemon
916 process (in case of service units), or binds the socket (in
917 case of socket units), and so on.</para>
919 <para>Depending on whether <option>--system</option>,
920 <option>--user</option>, <option>--runtime</option>,
921 or <option>--global</option> is specified, this enables the unit
922 for the system, for the calling user only, for only this boot of
923 the system, or for all future logins of all users, or only this
924 boot. Note that in the last case, no systemd daemon
925 configuration is reloaded.</para>
930 <term><command>disable <replaceable>NAME</replaceable>...</command></term>
933 <para>Disables one or more units. This removes all symlinks
934 to the specified unit files from the unit configuration
935 directory, and hence undoes the changes made by
936 <command>enable</command>. Note however that this removes
937 all symlinks to the unit files (i.e. including manual
938 additions), not just those actually created by
939 <command>enable</command>. This call implicitly reloads the
940 systemd daemon configuration after completing the disabling
941 of the units. Note that this command does not implicitly
942 stop the units that are being disabled. If this is desired,
943 an additional <command>stop</command> command should be
944 executed afterwards.</para>
946 <para>This command will print the actions executed. This
947 output may be suppressed by passing <option>--quiet</option>.
950 <para>This command honors <option>--system</option>,
951 <option>--user</option>, <option>--runtime</option> and
952 <option>--global</option> in a similar way as
953 <command>enable</command>.</para>
958 <term><command>is-enabled <replaceable>NAME</replaceable>...</command></term>
961 <para>Checks whether any of the specified unit files are
962 enabled (as with <command>enable</command>). Returns an
963 exit code of 0 if at least one is enabled, non-zero
964 otherwise. Prints the current enable status (see table).
965 To suppress this output, use <option>--quiet</option>.
970 <command>is-enabled</command> output
976 <entry>Printed string</entry>
977 <entry>Meaning</entry>
978 <entry>Return value</entry>
983 <entry><literal>enabled</literal></entry>
984 <entry morerows='1'>Enabled through a symlink in <filename>.wants</filename> directory (permanently or just in <filename>/run</filename>)</entry>
985 <entry morerows='1'>0</entry>
988 <entry><literal>enabled-runtime</literal></entry>
991 <entry><literal>linked</literal></entry>
992 <entry morerows='1'>Made available through a symlink to the unit file (permanently or just in <filename>/run</filename>)</entry>
993 <entry morerows='1'>1</entry>
996 <entry><literal>linked-runtime</literal></entry>
999 <entry><literal>masked</literal></entry>
1000 <entry morerows='1'>Disabled entirely (permanently or just in <filename>/run</filename>)</entry>
1001 <entry morerows='1'>1</entry>
1004 <entry><literal>masked-runtime</literal></entry>
1007 <entry><literal>static</literal></entry>
1008 <entry>Unit is not enabled, but has no provisions for enabling in [Install] section</entry>
1012 <entry><literal>disabled</literal></entry>
1013 <entry>Unit is not enabled</entry>
1024 <term><command>reenable <replaceable>NAME</replaceable>...</command></term>
1027 <para>Reenable one or more unit files, as specified on the
1028 command line. This is a combination of
1029 <command>disable</command> and <command>enable</command> and
1030 is useful to reset the symlinks a unit is enabled with to
1031 the defaults configured in the <literal>[Install]</literal>
1032 section of the unit file.</para>
1037 <term><command>preset <replaceable>NAME</replaceable>...</command></term>
1040 <para>Reset one or more unit files, as specified on the
1041 command line, to the defaults configured in the preset
1042 policy files. This has the same effect as
1043 <command>disable</command> or <command>enable</command>,
1044 depending how the unit is listed in the preset files.</para>
1046 <para>Use <option>--preset-mode=</option> to control
1047 whether units shall be enabled and disabled, or only
1048 enabled, or only disabled.</para>
1050 <para>For more information on the preset policy format,
1052 <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1053 For more information on the concept of presets, please
1055 url="http://freedesktop.org/wiki/Software/systemd/Preset">Preset</ulink>
1061 <term><command>preset-all</command></term>
1064 <para>Resets all installed unit files to the defaults
1065 configured in the preset policy file (see above).</para>
1067 <para>Use <option>--preset-mode=</option> to control
1068 whether units shall be enabled and disabled, or only
1069 enabled, or only disabled.</para>
1074 <term><command>mask <replaceable>NAME</replaceable>...</command></term>
1077 <para>Mask one or more unit files, as specified on the
1078 command line. This will link these units to
1079 <filename>/dev/null</filename>, making it impossible to
1080 start them. This is a stronger version of
1081 <command>disable</command>, since it prohibits all kinds of
1082 activation of the unit, including manual activation. Use
1083 this option with care. This honors the
1084 <option>--runtime</option> option to only mask temporarily
1085 until the next reboot of the system.</para>
1090 <term><command>unmask <replaceable>NAME</replaceable>...</command></term>
1093 <para>Unmask one or more unit files, as specified on the
1094 command line. This will undo the effect of
1095 <command>mask</command>.</para>
1100 <term><command>link <replaceable>FILENAME</replaceable>...</command></term>
1103 <para>Link a unit file that is not in the unit file search
1104 paths into the unit file search path. This requires an
1105 absolute path to a unit file. The effect of this can be
1106 undone with <command>disable</command>. The effect of this
1107 command is that a unit file is available for
1108 <command>start</command> and other commands although it
1109 is not installed directly in the unit search path.</para>
1114 <term><command>get-default</command></term>
1117 <para>Get the default target specified
1118 via <filename>default.target</filename> link.</para>
1123 <term><command>set-default <replaceable>NAME</replaceable></command></term>
1126 <para>Set the default target to boot into. Command links
1127 <filename>default.target</filename> to the given unit.</para>
1134 <title>Machine Commands</title>
1138 <term><command>list-machines <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
1141 <para>List the host and all running local containers with
1142 their state. If one or more
1143 <replaceable>PATTERN</replaceable>s are specified, only
1144 containers matching one of them are shown.
1152 <title>Job Commands</title>
1156 <term><command>list-jobs <optional><replaceable>PATTERN...</replaceable></optional></command></term>
1159 <para>List jobs that are in progress. If one or more
1160 <replaceable>PATTERN</replaceable>s are specified, only
1161 jobs for units matching one of them are shown.</para>
1165 <term><command>cancel <replaceable>JOB</replaceable>...</command></term>
1168 <para>Cancel one or more jobs specified on the command line
1169 by their numeric job IDs. If no job ID is specified, cancel
1170 all pending jobs.</para>
1177 <title>Snapshot Commands</title>
1181 <term><command>snapshot <optional><replaceable>NAME</replaceable></optional></command></term>
1184 <para>Create a snapshot. If a snapshot name is specified,
1185 the new snapshot will be named after it. If none is
1186 specified, an automatic snapshot name is generated. In
1187 either case, the snapshot name used is printed to standard
1188 output, unless <option>--quiet</option> is specified.
1191 <para>A snapshot refers to a saved state of the systemd
1192 manager. It is implemented itself as a unit that is
1193 generated dynamically with this command and has dependencies
1194 on all units active at the time. At a later time, the user
1195 may return to this state by using the
1196 <command>isolate</command> command on the snapshot unit.
1199 <para>Snapshots are only useful for saving and restoring
1200 which units are running or are stopped, they do not
1201 save/restore any other state. Snapshots are dynamic and lost
1206 <term><command>delete <replaceable>PATTERN</replaceable>...</command></term>
1209 <para>Remove a snapshot previously created with
1210 <command>snapshot</command>.</para>
1217 <title>Environment Commands</title>
1221 <term><command>show-environment</command></term>
1224 <para>Dump the systemd manager environment block. The
1225 environment block will be dumped in straight-forward form
1226 suitable for sourcing into a shell script. This environment
1227 block will be passed to all processes the manager
1232 <term><command>set-environment <replaceable>VARIABLE=VALUE</replaceable>...</command></term>
1235 <para>Set one or more systemd manager environment variables,
1236 as specified on the command line.</para>
1240 <term><command>unset-environment <replaceable>VARIABLE</replaceable>...</command></term>
1243 <para>Unset one or more systemd manager environment
1244 variables. If only a variable name is specified, it will be
1245 removed regardless of its value. If a variable and a value
1246 are specified, the variable is only removed if it has the
1247 specified value.</para>
1251 <term><command>import-environment <replaceable>VARIABLE</replaceable>...</command></term>
1254 <para>Import all, one or more environment variables set on
1255 the client into the systemd manager environment block. If
1256 no arguments are passed, the entire environment block is
1257 imported. Otherwise, a list of one or more environment
1258 variable names should be passed, whose client-side values
1259 are then imported into the manager's environment
1267 <title>Manager Lifecycle Commands</title>
1271 <term><command>daemon-reload</command></term>
1274 <para>Reload systemd manager configuration. This will reload
1275 all unit files and recreate the entire dependency
1276 tree. While the daemon is being reloaded, all sockets systemd
1277 listens on on behalf of user configuration will stay
1278 accessible.</para> <para>This command should not be confused
1279 with the <command>load</command> or
1280 <command>reload</command> commands.</para>
1284 <term><command>daemon-reexec</command></term>
1287 <para>Reexecute the systemd manager. This will serialize the
1288 manager state, reexecute the process and deserialize the
1289 state again. This command is of little use except for
1290 debugging and package upgrades. Sometimes, it might be
1291 helpful as a heavy-weight <command>daemon-reload</command>.
1292 While the daemon is being reexecuted, all sockets systemd listening
1293 on behalf of user configuration will stay accessible.
1301 <title>System Commands</title>
1305 <term><command>is-system-running</command></term>
1308 <para>Checks whether the system is running. This returns
1309 success when the system is fully up and running, meaning
1310 not in startup, shutdown or maintainance mode. Failure is
1311 returned otherwise. In addition, the current state is
1312 printed in a short string to standard output. Use
1313 <option>--quiet</option> to suppress output of this state
1319 <term><command>default</command></term>
1322 <para>Enter default mode. This is mostly equivalent to
1323 <command>isolate default.target</command>.</para>
1328 <term><command>rescue</command></term>
1331 <para>Enter rescue mode. This is mostly equivalent to
1332 <command>isolate rescue.target</command>, but also prints a
1333 wall message to all users.</para>
1337 <term><command>emergency</command></term>
1340 <para>Enter emergency mode. This is mostly equivalent to
1341 <command>isolate emergency.target</command>, but also prints
1342 a wall message to all users.</para>
1346 <term><command>halt</command></term>
1349 <para>Shut down and halt the system. This is mostly equivalent to
1350 <command>start halt.target --irreversible</command>, but also
1351 prints a wall message to all users. If combined with
1352 <option>--force</option>, shutdown of all running services is
1353 skipped, however all processes are killed and all file
1354 systems are unmounted or mounted read-only, immediately
1355 followed by the system halt. If <option>--force</option> is
1356 specified twice, the operation is immediately executed
1357 without terminating any processes or unmounting any file
1358 systems. This may result in data loss.</para>
1362 <term><command>poweroff</command></term>
1365 <para>Shut down and power-off the system. This is mostly
1366 equivalent to <command>start poweroff.target --irreversible</command>,
1367 but also prints a wall message to all users. If combined with
1368 <option>--force</option>, shutdown of all running services is
1369 skipped, however all processes are killed and all file
1370 systems are unmounted or mounted read-only, immediately
1371 followed by the powering off. If <option>--force</option> is
1372 specified twice, the operation is immediately executed
1373 without terminating any processes or unmounting any file
1374 systems. This may result in data loss.</para>
1378 <term><command>reboot <optional><replaceable>arg</replaceable></optional></command></term>
1381 <para>Shut down and reboot the system. This is mostly
1382 equivalent to <command>start reboot.target --irreversible</command>,
1383 but also prints a wall message to all users. If combined with
1384 <option>--force</option>, shutdown of all running services is
1385 skipped, however all processes are killed and all file
1386 systems are unmounted or mounted read-only, immediately
1387 followed by the reboot. If <option>--force</option> is
1388 specified twice, the operation is immediately executed
1389 without terminating any processes or unmounting any file
1390 systems. This may result in data loss.</para>
1392 <para>If the optional argument
1393 <replaceable>arg</replaceable> is given, it will be passed
1394 as the optional argument to the
1395 <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1396 system call. The value is architecture and firmware
1397 specific. As an example, <literal>recovery</literal> might
1398 be used to trigger system recovery, and
1399 <literal>fota</literal> might be used to trigger a
1400 <quote>firmware over the air</quote> update.</para>
1404 <term><command>kexec</command></term>
1407 <para>Shut down and reboot the system via kexec. This is
1408 mostly equivalent to <command>start kexec.target --irreversible</command>,
1409 but also prints a wall message to all users. If combined
1410 with <option>--force</option>, shutdown of all running
1411 services is skipped, however all processes are killed and
1412 all file systems are unmounted or mounted read-only,
1413 immediately followed by the reboot.</para>
1417 <term><command>exit</command></term>
1420 <para>Ask the systemd manager to quit. This is only
1421 supported for user service managers (i.e. in conjunction
1422 with the <option>--user</option> option) and will fail
1428 <term><command>suspend</command></term>
1431 <para>Suspend the system. This will trigger activation of
1432 the special <filename>suspend.target</filename> target.
1437 <term><command>hibernate</command></term>
1440 <para>Hibernate the system. This will trigger activation of
1441 the special <filename>hibernate.target</filename> target.
1446 <term><command>hybrid-sleep</command></term>
1449 <para>Hibernate and suspend the system. This will trigger
1450 activation of the special
1451 <filename>hybrid-sleep.target</filename> target.</para>
1455 <term><command>switch-root <replaceable>ROOT</replaceable> <optional><replaceable>INIT</replaceable></optional></command></term>
1458 <para>Switches to a different root directory and executes a
1459 new system manager process below it. This is intended for
1460 usage in initial RAM disks ("initrd"), and will transition
1461 from the initrd's system manager process (a.k.a "init"
1462 process) to the main system manager process. This call takes two
1463 arguments: the directory that is to become the new root directory, and
1464 the path to the new system manager binary below it to
1465 execute as PID 1. If the latter is omitted or the empty
1466 string, a systemd binary will automatically be searched for
1467 and used as init. If the system manager path is omitted or
1468 equal to the empty string, the state of the initrd's system
1469 manager process is passed to the main system manager, which
1470 allows later introspection of the state of the services
1471 involved in the initrd boot.</para>
1478 <title>Parameter Syntax</title>
1480 <para>Unit commands listed above take either a single unit name
1481 (designated as <replaceable>NAME</replaceable>), or multiple
1482 unit specifications (designated as
1483 <replaceable>PATTERN</replaceable>...). In the first case, the
1484 unit name with or without a suffix must be given. If the suffix
1485 is not specified, systemctl will append a suitable suffix,
1486 <literal>.service</literal> by default, and a type-specific
1487 suffix in case of commands which operate only on specific unit
1489 <programlisting># systemctl start sshd</programlisting> and
1490 <programlisting># systemctl start sshd.service</programlisting>
1491 are equivalent, as are
1492 <programlisting># systemctl isolate snapshot-11</programlisting>
1494 <programlisting># systemctl isolate snapshot-11.snapshot</programlisting>
1495 Note that (absolute) paths to device nodes are automatically
1496 converted to device unit names, and other (absolute) paths to
1498 <programlisting># systemctl status /dev/sda
1499 # systemctl status /home</programlisting>
1501 <programlisting># systemctl status dev-sda.device
1502 # systemctl status home.mount</programlisting>
1503 In the second case, shell-style globs will be matched against
1504 currently loaded units; literal unit names, with or without
1505 a suffix, will be treated as in the first case. This means that
1506 literal unit names always refer to exactly one unit, but globs
1507 may match zero units and this is not considered an error.</para>
1509 <para>Glob patterns use
1510 <citerefentry><refentrytitle>fnmatch</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
1511 so normal shell-style globbing rules are used, and
1512 <literal>*</literal>, <literal>?</literal>,
1513 <literal>[]</literal> may be used. See
1514 <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1515 for more details. The patterns are matched against the names of
1516 currently loaded units, and patterns which do not match anything
1517 are silently skipped. For example:
1518 <programlisting># systemctl stop sshd@*.service</programlisting>
1519 will stop all <filename>sshd@.service</filename> instances.
1522 <para>For unit file commands, the specified
1523 <replaceable>NAME</replaceable> should be the full name of the
1524 unit file, or the absolute path to the unit file:
1525 <programlisting># systemctl enable foo.service</programlisting>
1527 <programlisting># systemctl link /path/to/foo.service</programlisting>
1534 <title>Exit status</title>
1536 <para>On success, 0 is returned, a non-zero failure
1537 code otherwise.</para>
1540 <xi:include href="less-variables.xml" />
1543 <title>See Also</title>
1545 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1546 <citerefentry><refentrytitle>systemadm</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1547 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1548 <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1549 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1550 <citerefentry><refentrytitle>systemd.resource-management</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1551 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1552 <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1553 <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1554 <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>