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. The jobs can still be
234 cancelled using the <command>cancel</command> command.</para>
236 <para><literal>isolate</literal> is only valid for start
237 operations and causes all other units to be stopped when the
238 specified unit is started. This mode is always used when the
239 <command>isolate</command> command is used.</para>
241 <para><literal>flush</literal> will cause all queued jobs to
242 be canceled when the new job is enqueued.</para>
244 <para>If <literal>ignore-dependencies</literal> is specified,
245 then all unit dependencies are ignored for this new job and
246 the operation is executed immediately. If passed, no required
247 units of the unit passed will be pulled in, and no ordering
248 dependencies will be honored. This is mostly a debugging and
249 rescue tool for the administrator and should not be used by
252 <para><literal>ignore-requirements</literal> is similar to
253 <literal>ignore-dependencies</literal>, but only causes the
254 requirement dependencies to be ignored, the ordering
255 dependencies will still be honoured.</para>
261 <term><option>-i</option></term>
262 <term><option>--ignore-inhibitors</option></term>
265 <para>When system shutdown or a sleep state is requested,
266 ignore inhibitor locks. Applications can establish inhibitor
267 locks to avoid that certain important operations (such as CD
268 burning or suchlike) are interrupted by system shutdown or a
269 sleep state. Any user may take these locks and privileged
270 users may override these locks. If any locks are taken,
271 shutdown and sleep state requests will normally fail
272 (regardless of whether privileged or not) and a list of active locks
273 is printed. However, if <option>--ignore-inhibitors</option>
274 is specified, the locks are ignored and not printed, and the
275 operation attempted anyway, possibly requiring additional
281 <term><option>-q</option></term>
282 <term><option>--quiet</option></term>
285 <para>Suppress output to standard output in
286 <command>snapshot</command>,
287 <command>is-active</command>,
288 <command>is-failed</command>,
289 <command>enable</command> and
290 <command>disable</command>.</para>
295 <term><option>--no-block</option></term>
298 <para>Do not synchronously wait for the requested operation
299 to finish. If this is not specified, the job will be
300 verified, enqueued and <command>systemctl</command> will
301 wait until it is completed. By passing this argument, it is
302 only verified and enqueued.</para>
307 <term><option>--no-legend</option></term>
310 <para>Do not print the legend, i.e. the column headers and
311 the footer with hints.</para>
315 <xi:include href="user-system-options.xml" xpointer="user" />
316 <xi:include href="user-system-options.xml" xpointer="system" />
319 <term><option>--no-wall</option></term>
322 <para>Do not send wall message before halt, power-off,
328 <term><option>--global</option></term>
331 <para>When used with <command>enable</command> and
332 <command>disable</command>, operate on the global user
333 configuration directory, thus enabling or disabling a unit
334 file globally for all future logins of all users.</para>
339 <term><option>--no-reload</option></term>
342 <para>When used with <command>enable</command> and
343 <command>disable</command>, do not implicitly reload daemon
344 configuration after executing the changes.</para>
349 <term><option>--no-ask-password</option></term>
352 <para>When used with <command>start</command> and related
353 commands, disables asking for passwords. Background services
354 may require input of a password or passphrase string, for
355 example to unlock system hard disks or cryptographic
356 certificates. Unless this option is specified and the
357 command is invoked from a terminal,
358 <command>systemctl</command> will query the user on the
359 terminal for the necessary secrets. Use this option to
360 switch this behavior off. In this case, the password must be
361 supplied by some other means (for example graphical password
362 agents) or the service might fail. This also disables
363 querying the user for authentication for privileged
370 <term><option>--kill-who=</option></term>
373 <para>When used with <command>kill</command>, choose which
374 processes to kill. Must be one of <option>main</option>,
375 <option>control</option> or <option>all</option> to select
376 whether to kill only the main process of the unit, the
377 control process or all processes of the unit. If omitted,
378 defaults to <option>all</option>.</para>
384 <term><option>-s</option></term>
385 <term><option>--signal=</option></term>
388 <para>When used with <command>kill</command>, choose which
389 signal to send to selected processes. Must be one of the
390 well known signal specifiers such as <constant>SIGTERM</constant>, <constant>SIGINT</constant> or
391 <constant>SIGSTOP</constant>. If omitted, defaults to
392 <option>SIGTERM</option>.</para>
397 <term><option>-f</option></term>
398 <term><option>--force</option></term>
401 <para>When used with <command>enable</command>, overwrite
402 any existing conflicting symlinks.</para>
404 <para>When used with <command>halt</command>,
405 <command>poweroff</command>, <command>reboot</command> or
406 <command>kexec</command>, execute the selected operation
407 without shutting down all units. However, all processes will
408 be killed forcibly and all file systems are unmounted or
409 remounted read-only. This is hence a drastic but relatively
410 safe option to request an immediate reboot. If
411 <option>--force</option> is specified twice for these
412 operations, they will be executed immediately without
413 terminating any processes or umounting any file
414 systems. Warning: specifying <option>--force</option> twice
415 with any of these operations might result in data
421 <term><option>--root=</option></term>
425 <command>enable</command>/<command>disable</command>/<command>is-enabled</command>
426 (and related commands), use alternative root path when
427 looking for unit files.</para>
433 <term><option>--runtime</option></term>
436 <para>When used with <command>enable</command>,
437 <command>disable</command>,
438 (and related commands), make changes only temporarily, so
439 that they are lost on the next reboot. This will have the
440 effect that changes are not made in subdirectories of
441 <filename>/etc</filename> but in <filename>/run</filename>,
442 with identical immediate effects, however, since the latter
443 is lost on reboot, the changes are lost too.</para>
445 <para>Similarly, when used with
446 <command>set-property</command>, make changes only
447 temporarily, so that they are lost on the next
453 <term><option>-n</option></term>
454 <term><option>--lines=</option></term>
457 <para>When used with <command>status</command>, controls the
458 number of journal lines to show, counting from the most
459 recent ones. Takes a positive integer argument. Defaults to
465 <term><option>-o</option></term>
466 <term><option>--output=</option></term>
469 <para>When used with <command>status</command>, controls the
470 formatting of the journal entries that are shown. For the
471 available choices, see
472 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
473 Defaults to <literal>short</literal>.</para>
478 <term><option>--plain</option></term>
481 <para>When used with <command>list-dependencies</command>,
482 the output is printed as a list instead of a tree.</para>
486 <xi:include href="user-system-options.xml" xpointer="host" />
487 <xi:include href="user-system-options.xml" xpointer="machine" />
489 <xi:include href="standard-options.xml" xpointer="help" />
490 <xi:include href="standard-options.xml" xpointer="version" />
491 <xi:include href="standard-options.xml" xpointer="no-pager" />
496 <title>Commands</title>
498 <para>The following commands are understood:</para>
501 <title>Unit Commands</title>
505 <term><command>list-units <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
508 <para>List known units (subject to limitations specified
509 with <option>-t</option>). If one or more
510 <replaceable>PATTERN</replaceable>s are specified, only
511 units matching one of them are shown.</para>
513 <para>This is the default command.</para>
518 <term><command>list-sockets <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
521 <para>List socket units ordered by listening address.
522 If one or more <replaceable>PATTERN</replaceable>s are
523 specified, only socket units matching one of them are
524 shown. Produces output similar to
526 LISTEN UNIT ACTIVATES
527 /dev/initctl systemd-initctl.socket systemd-initctl.service
529 [::]:22 sshd.socket sshd.service
530 kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
532 5 sockets listed.</programlisting>
533 Note: because the addresses might contains spaces, this output
534 is not suitable for programmatic consumption.
537 <para>See also the options <option>--show-types</option>,
538 <option>--all</option>, and <option>--failed</option>.</para>
543 <term><command>list-timers <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
546 <para>List timer units ordered by the time they elapse
547 next. If one or more <replaceable>PATTERN</replaceable>s
548 are specified, only units matching one of them are shown.
551 <para>See also the options <option>--all</option> and
552 <option>--failed</option>.</para>
557 <term><command>start <replaceable>PATTERN</replaceable>...</command></term>
560 <para>Start (activate) one or more units specified on the
563 <para>Note that glob patterns operate on a list of currently
564 loaded units. Units which are not active and are not in a
565 failed state usually are not loaded, and would not be
566 matched by any pattern. In addition, in case of
567 instantiated units, systemd is often unaware of the
568 instance name until the instance has been started. Therefore,
569 using glob patterns with <command>start</command>
570 has limited usefulness.</para>
574 <term><command>stop <replaceable>PATTERN</replaceable>...</command></term>
577 <para>Stop (deactivate) one or more units specified on the
582 <term><command>reload <replaceable>PATTERN</replaceable>...</command></term>
585 <para>Asks all units listed on the command line to reload
586 their configuration. Note that this will reload the
587 service-specific configuration, not the unit configuration
588 file of systemd. If you want systemd to reload the
589 configuration file of a unit, use the
590 <command>daemon-reload</command> command. In other words:
591 for the example case of Apache, this will reload Apache's
592 <filename>httpd.conf</filename> in the web server, not the
593 <filename>apache.service</filename> systemd unit
596 <para>This command should not be confused with the
597 <command>daemon-reload</command> or <command>load</command>
603 <term><command>restart <replaceable>PATTERN</replaceable>...</command></term>
606 <para>Restart one or more units specified on the command
607 line. If the units are not running yet, they will be
612 <term><command>try-restart <replaceable>PATTERN</replaceable>...</command></term>
615 <para>Restart one or more units specified on the command
616 line if the units are running. This does nothing if units are not
617 running. Note that, for compatibility with Red Hat init
618 scripts, <command>condrestart</command> is equivalent to this
623 <term><command>reload-or-restart <replaceable>PATTERN</replaceable>...</command></term>
626 <para>Reload one or more units if they support it. If not,
627 restart them instead. If the units are not running yet, they
628 will be started.</para>
632 <term><command>reload-or-try-restart <replaceable>PATTERN</replaceable>...</command></term>
635 <para>Reload one or more units if they support it. If not,
636 restart them instead. This does nothing if the units are not
637 running. Note that, for compatibility with SysV init scripts,
638 <command>force-reload</command> is equivalent to this
643 <term><command>isolate <replaceable>NAME</replaceable></command></term>
646 <para>Start the unit specified on the command line and its
647 dependencies and stop all others.</para>
649 <para>This is similar to changing the runlevel in a
650 traditional init system. The <command>isolate</command>
651 command will immediately stop processes that are not enabled
652 in the new unit, possibly including the graphical
653 environment or terminal you are currently using.</para>
655 <para>Note that this is allowed only on units where
656 <option>AllowIsolate=</option> is enabled. See
657 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
662 <term><command>kill <replaceable>PATTERN</replaceable>...</command></term>
665 <para>Send a signal to one or more processes of the
666 unit. Use <option>--kill-who=</option> to select which
667 process to kill. Use <option>--kill-mode=</option> to select
668 the kill mode and <option>--signal=</option> to select the
669 signal to send.</para>
673 <term><command>is-active <replaceable>PATTERN</replaceable>...</command></term>
676 <para>Check whether any of the specified units are active
677 (i.e. running). Returns an exit code
678 <constant>0</constant> if at least one is active, or
679 non-zero otherwise. Unless <option>--quiet</option> is
680 specified, this will also print the current unit state to
681 standard output.</para>
685 <term><command>is-failed <replaceable>PATTERN</replaceable>...</command></term>
688 <para>Check whether any of the specified units are in a
689 "failed" state. Returns an exit code
690 <constant>0</constant> if at least one has failed,
691 non-zero otherwise. Unless <option>--quiet</option> is
692 specified, this will also print the current unit state to
693 standard output.</para>
697 <term><command>status</command> <optional><replaceable>PATTERN</replaceable>...|<replaceable>PID</replaceable>...]</optional></term>
700 <para>Show terse runtime status information about one or
701 more units, followed by most recent log data from the
702 journal. If no units are specified, show system status. If
703 combined with <option>--all</option> also shows status of
704 all units (subject to limitations specified with
705 <option>-t</option>). If a PID is passed, show information
706 about the unit the process belongs to.</para>
708 <para>This function is intended to generate human-readable
709 output. If you are looking for computer-parsable output,
710 use <command>show</command> instead. By default this
711 function only shows 10 lines of output and ellipsizes
712 lines to fit in the terminal window. This can be changes
713 with <option>--lines</option> and <option>--full</option>,
714 see above. In addition, <command>journalctl
715 --unit=<replaceable>NAME</replaceable></command> or
717 --user-unit=<replaceable>NAME</replaceable></command> use
718 a similar filter for messages and might be more
724 <term><command>show</command> <optional><replaceable>PATTERN</replaceable>...|<replaceable>JOB</replaceable>...</optional></term>
727 <para>Show properties of one or more units, jobs, or the
728 manager itself. If no argument is specified, properties of
729 the manager will be shown. If a unit name is specified,
730 properties of the unit is shown, and if a job id is
731 specified, properties of the job is shown. By default, empty
732 properties are suppressed. Use <option>--all</option> to
733 show those too. To select specific properties to show, use
734 <option>--property=</option>. This command is intended to be
735 used whenever computer-parsable output is required. Use
736 <command>status</command> if you are looking for formatted
737 human-readable output.</para>
741 <term><command>cat <replaceable>PATTERN</replaceable>...</command></term>
744 <para>Show backing files of one or more units. Prints the
745 "fragment" and "drop-ins" (source files) of units. Each
746 file is preceded by a comment which includes the file
751 <term><command>set-property <replaceable>NAME</replaceable> <replaceable>ASSIGNMENT</replaceable>...</command></term>
754 <para>Set the specified unit properties at runtime where
755 this is supported. This allows changing configuration
756 parameter properties such as resource control settings at
757 runtime. Not all properties may be changed at runtime, but
758 many resource control settings (primarily those in
759 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
760 may. The changes are applied instantly, and stored on disk
761 for future boots, unless <option>--runtime</option> is
762 passed, in which case the settings only apply until the
763 next reboot. The syntax of the property assignment follows
764 closely the syntax of assignments in unit files.</para>
766 <para>Example: <command>systemctl set-property foobar.service CPUShares=777</command></para>
768 <para>Note that this command allows changing multiple
769 properties at the same time, which is preferable over
770 setting them individually. Like unit file configuration
771 settings, assigning the empty list to list parameters will
772 reset the list.</para>
777 <term><command>help <replaceable>PATTERN</replaceable>...|<replaceable>PID</replaceable>...</command></term>
780 <para>Show manual pages for one or more units, if
781 available. If a PID is given, the manual pages for the unit
782 the process belongs to are shown.</para>
787 <term><command>reset-failed [<replaceable>PATTERN</replaceable>...]</command></term>
790 <para>Reset the <literal>failed</literal> state of the
791 specified units, or if no unit name is passed, reset the state of all
792 units. When a unit fails in some way (i.e. process exiting
793 with non-zero error code, terminating abnormally or timing
794 out), it will automatically enter the
795 <literal>failed</literal> state and its exit code and status
796 is recorded for introspection by the administrator until the
797 service is restarted or reset with this command.</para>
802 <term><command>list-dependencies <replaceable>NAME</replaceable></command></term>
805 <para>Shows required and wanted units of the specified
806 unit. If no unit is specified,
807 <filename>default.target</filename> is implied. Target units
808 are recursively expanded. When <option>--all</option> is
809 passed, all other units are recursively expanded as
817 <title>Unit File Commands</title>
821 <term><command>list-unit-files <optional><replaceable>PATTERN...</replaceable></optional></command></term>
824 <para>List installed unit files. If one or more
825 <replaceable>PATTERN</replaceable>s are specified, only
826 units whose filename (just the last component of the path)
827 matches one of them are shown.</para>
832 <term><command>enable <replaceable>NAME</replaceable>...</command></term>
835 <para>Enable one or more unit files or unit file instances,
836 as specified on the command line. This will create a number
837 of symlinks as encoded in the <literal>[Install]</literal>
838 sections of the unit files. After the symlinks have been
839 created, the systemd configuration is reloaded (in a way that
840 is equivalent to <command>daemon-reload</command>) to ensure
841 the changes are taken into account immediately. Note that
842 this does <emphasis>not</emphasis> have the effect of also
843 starting any of the units being enabled. If this
844 is desired, a separate <command>start</command> command must
845 be invoked for the unit. Also note that in case of instance
846 enablement, symlinks named the same as instances are created in
847 the install location, however they all point to the same
848 template unit file.</para>
850 <para>This command will print the actions executed. This
851 output may be suppressed by passing <option>--quiet</option>.
854 <para>Note that this operation creates only the suggested
855 symlinks for the units. While this command is the
856 recommended way to manipulate the unit configuration
857 directory, the administrator is free to make additional
858 changes manually by placing or removing symlinks in the
859 directory. This is particularly useful to create
860 configurations that deviate from the suggested default
861 installation. In this case, the administrator must make sure
862 to invoke <command>daemon-reload</command> manually as
863 necessary to ensure the changes are taken into account.
866 <para>Enabling units should not be confused with starting
867 (activating) units, as done by the <command>start</command>
868 command. Enabling and starting units is orthogonal: units
869 may be enabled without being started and started without
870 being enabled. Enabling simply hooks the unit into various
871 suggested places (for example, so that the unit is
872 automatically started on boot or when a particular kind of
873 hardware is plugged in). Starting actually spawns the daemon
874 process (in case of service units), or binds the socket (in
875 case of socket units), and so on.</para>
877 <para>Depending on whether <option>--system</option>,
878 <option>--user</option>, <option>--runtime</option>,
879 or <option>--global</option> is specified, this enables the unit
880 for the system, for the calling user only, for only this boot of
881 the system, or for all future logins of all users, or only this
882 boot. Note that in the last case, no systemd daemon
883 configuration is reloaded.</para>
888 <term><command>disable <replaceable>NAME</replaceable>...</command></term>
891 <para>Disables one or more units. This removes all symlinks
892 to the specified unit files from the unit configuration
893 directory, and hence undoes the changes made by
894 <command>enable</command>. Note however that this removes
895 all symlinks to the unit files (i.e. including manual
896 additions), not just those actually created by
897 <command>enable</command>. This call implicitly reloads the
898 systemd daemon configuration after completing the disabling
899 of the units. Note that this command does not implicitly
900 stop the units that are being disabled. If this is desired,
901 an additional <command>stop</command> command should be
902 executed afterwards.</para>
904 <para>This command will print the actions executed. This
905 output may be suppressed by passing <option>--quiet</option>.
908 <para>This command honors <option>--system</option>,
909 <option>--user</option>, <option>--runtime</option> and
910 <option>--global</option> in a similar way as
911 <command>enable</command>.</para>
916 <term><command>is-enabled <replaceable>NAME</replaceable>...</command></term>
919 <para>Checks whether any of the specified unit files are
920 enabled (as with <command>enable</command>). Returns an
921 exit code of 0 if at least one is enabled, non-zero
922 otherwise. Prints the current enable status (see table).
923 To suppress this output, use <option>--quiet</option>.
928 <command>is-enabled</command> output
934 <entry>Printed string</entry>
935 <entry>Meaning</entry>
936 <entry>Return value</entry>
941 <entry><literal>enabled</literal></entry>
942 <entry morerows='1'>Enabled through a symlink in <filename>.wants</filename> directory (permanently or just in <filename>/run</filename>)</entry>
943 <entry morerows='1'>0</entry>
946 <entry><literal>enabled-runtime</literal></entry>
949 <entry><literal>linked</literal></entry>
950 <entry morerows='1'>Made available through a symlink to the unit file (permanently or just in <filename>/run</filename>)</entry>
951 <entry morerows='1'>1</entry>
954 <entry><literal>linked-runtime</literal></entry>
957 <entry><literal>masked</literal></entry>
958 <entry morerows='1'>Disabled entirely (permanently or just in <filename>/run</filename>)</entry>
959 <entry morerows='1'>1</entry>
962 <entry><literal>masked-runtime</literal></entry>
965 <entry><literal>static</literal></entry>
966 <entry>Unit is not enabled, but has no provisions for enabling in [Install] section</entry>
970 <entry><literal>disabled</literal></entry>
971 <entry>Unit is not enabled</entry>
982 <term><command>reenable <replaceable>NAME</replaceable>...</command></term>
985 <para>Reenable one or more unit files, as specified on the
986 command line. This is a combination of
987 <command>disable</command> and <command>enable</command> and
988 is useful to reset the symlinks a unit is enabled with to
989 the defaults configured in the <literal>[Install]</literal>
990 section of the unit file.</para>
995 <term><command>preset <replaceable>NAME</replaceable>...</command></term>
998 <para>Reset one or more unit files, as specified on the
999 command line, to the defaults configured in the preset
1000 policy files. This has the same effect as
1001 <command>disable</command> or <command>enable</command>,
1002 depending how the unit is listed in the preset files. For
1003 more information on the preset policy format, see
1004 <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1005 For more information on the concept of presets, please
1007 <ulink url="http://freedesktop.org/wiki/Software/systemd/Preset">Preset</ulink>
1013 <term><command>mask <replaceable>NAME</replaceable>...</command></term>
1016 <para>Mask one or more unit files, as specified on the
1017 command line. This will link these units to
1018 <filename>/dev/null</filename>, making it impossible to
1019 start them. This is a stronger version of
1020 <command>disable</command>, since it prohibits all kinds of
1021 activation of the unit, including manual activation. Use
1022 this option with care. This honors the
1023 <option>--runtime</option> option to only mask temporarily
1024 until the next reoobt of the system.</para>
1029 <term><command>unmask <replaceable>NAME</replaceable>...</command></term>
1032 <para>Unmask one or more unit files, as specified on the
1033 command line. This will undo the effect of
1034 <command>mask</command>.</para>
1039 <term><command>link <replaceable>FILENAME</replaceable>...</command></term>
1042 <para>Link a unit file that is not in the unit file search
1043 paths into the unit file search path. This requires an
1044 absolute path to a unit file. The effect of this can be
1045 undone with <command>disable</command>. The effect of this
1046 command is that a unit file is available for
1047 <command>start</command> and other commands although it
1048 is not installed directly in the unit search path.</para>
1053 <term><command>get-default</command></term>
1056 <para>Get the default target specified
1057 via <filename>default.target</filename> link.</para>
1062 <term><command>set-default <replaceable>NAME</replaceable></command></term>
1065 <para>Set the default target to boot into. Command links
1066 <filename>default.target</filename> to the given unit.</para>
1073 <title>Machine Commands</title>
1077 <term><command>list-machines <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
1080 <para>List the host and all running local containers with
1081 their state. If one or more
1082 <replaceable>PATTERN</replaceable>s are specified, only
1083 containers matching one of them are shown.
1091 <title>Job Commands</title>
1095 <term><command>list-jobs <optional><replaceable>PATTERN...</replaceable></optional></command></term>
1098 <para>List jobs that are in progress. If one or more
1099 <replaceable>PATTERN</replaceable>s are specified, only
1100 jobs for units matching one of them are shown.</para>
1104 <term><command>cancel <replaceable>JOB</replaceable>...</command></term>
1107 <para>Cancel one or more jobs specified on the command line
1108 by their numeric job IDs. If no job ID is specified, cancel
1109 all pending jobs.</para>
1116 <title>Snapshot Commands</title>
1120 <term><command>snapshot <optional><replaceable>NAME</replaceable></optional></command></term>
1123 <para>Create a snapshot. If a snapshot name is specified,
1124 the new snapshot will be named after it. If none is
1125 specified, an automatic snapshot name is generated. In
1126 either case, the snapshot name used is printed to standard
1127 output, unless <option>--quiet</option> is specified.
1130 <para>A snapshot refers to a saved state of the systemd
1131 manager. It is implemented itself as a unit that is
1132 generated dynamically with this command and has dependencies
1133 on all units active at the time. At a later time, the user
1134 may return to this state by using the
1135 <command>isolate</command> command on the snapshot unit.
1138 <para>Snapshots are only useful for saving and restoring
1139 which units are running or are stopped, they do not
1140 save/restore any other state. Snapshots are dynamic and lost
1145 <term><command>delete <replaceable>PATTERN</replaceable>...</command></term>
1148 <para>Remove a snapshot previously created with
1149 <command>snapshot</command>.</para>
1156 <title>Environment Commands</title>
1160 <term><command>show-environment</command></term>
1163 <para>Dump the systemd manager environment block. The
1164 environment block will be dumped in straight-forward form
1165 suitable for sourcing into a shell script. This environment
1166 block will be passed to all processes the manager
1171 <term><command>set-environment <replaceable>VARIABLE=VALUE</replaceable>...</command></term>
1174 <para>Set one or more systemd manager environment variables,
1175 as specified on the command line.</para>
1179 <term><command>unset-environment <replaceable>VARIABLE</replaceable>...</command></term>
1182 <para>Unset one or more systemd manager environment
1183 variables. If only a variable name is specified, it will be
1184 removed regardless of its value. If a variable and a value
1185 are specified, the variable is only removed if it has the
1186 specified value.</para>
1190 <term><command>import-environment <replaceable>VARIABLE</replaceable>...</command></term>
1193 <para>Import all, one or more environment variables set on
1194 the client into the systemd manager environment block. If
1195 no arguments are passed, the entire environment block is
1196 imported. Otherwise, a list of one or more environment
1197 variable names should be passed, whose client-side values
1198 are then imported into the manager's environment
1206 <title>Manager Lifecycle Commands</title>
1210 <term><command>daemon-reload</command></term>
1213 <para>Reload systemd manager configuration. This will reload
1214 all unit files and recreate the entire dependency
1215 tree. While the daemon is being reloaded, all sockets systemd
1216 listens on on behalf of user configuration will stay
1217 accessible.</para> <para>This command should not be confused
1218 with the <command>load</command> or
1219 <command>reload</command> commands.</para>
1223 <term><command>daemon-reexec</command></term>
1226 <para>Reexecute the systemd manager. This will serialize the
1227 manager state, reexecute the process and deserialize the
1228 state again. This command is of little use except for
1229 debugging and package upgrades. Sometimes, it might be
1230 helpful as a heavy-weight <command>daemon-reload</command>.
1231 While the daemon is being reexecuted, all sockets systemd listening
1232 on behalf of user configuration will stay accessible.
1240 <title>System Commands</title>
1244 <term><command>default</command></term>
1247 <para>Enter default mode. This is mostly equivalent to
1248 <command>isolate default.target</command>.</para>
1252 <term><command>rescue</command></term>
1255 <para>Enter rescue mode. This is mostly equivalent to
1256 <command>isolate rescue.target</command>, but also prints a
1257 wall message to all users.</para>
1261 <term><command>emergency</command></term>
1264 <para>Enter emergency mode. This is mostly equivalent to
1265 <command>isolate emergency.target</command>, but also prints
1266 a wall message to all users.</para>
1270 <term><command>halt</command></term>
1273 <para>Shut down and halt the system. This is mostly equivalent to
1274 <command>start halt.target --irreversible</command>, but also
1275 prints a wall message to all users. If combined with
1276 <option>--force</option>, shutdown of all running services is
1277 skipped, however all processes are killed and all file
1278 systems are unmounted or mounted read-only, immediately
1279 followed by the system halt. If <option>--force</option> is
1280 specified twice, the operation is immediately executed
1281 without terminating any processes or unmounting any file
1282 systems. This may result in data loss.</para>
1286 <term><command>poweroff</command></term>
1289 <para>Shut down and power-off the system. This is mostly
1290 equivalent to <command>start poweroff.target --irreversible</command>,
1291 but also prints a wall message to all users. If combined with
1292 <option>--force</option>, shutdown of all running services is
1293 skipped, however all processes are killed and all file
1294 systems are unmounted or mounted read-only, immediately
1295 followed by the powering off. If <option>--force</option> is
1296 specified twice, the operation is immediately executed
1297 without terminating any processes or unmounting any file
1298 systems. This may result in data loss.</para>
1302 <term><command>reboot <optional><replaceable>arg</replaceable></optional></command></term>
1305 <para>Shut down and reboot the system. This is mostly
1306 equivalent to <command>start reboot.target --irreversible</command>,
1307 but also prints a wall message to all users. If combined with
1308 <option>--force</option>, shutdown of all running services is
1309 skipped, however all processes are killed and all file
1310 systems are unmounted or mounted read-only, immediately
1311 followed by the reboot. If <option>--force</option> is
1312 specified twice, the operation is immediately executed
1313 without terminating any processes or unmounting any file
1314 systems. This may result in data loss.</para>
1316 <para>If the optional argument
1317 <replaceable>arg</replaceable> is given, it will be passed
1318 as the optional argument to the
1319 <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1320 system call. The value is architecture and firmware
1321 specific. As an example, <literal>recovery</literal> might
1322 be used to trigger system recovery, and
1323 <literal>fota</literal> might be used to trigger a
1324 <quote>firmware over the air</quote> update.</para>
1328 <term><command>kexec</command></term>
1331 <para>Shut down and reboot the system via kexec. This is
1332 mostly equivalent to <command>start kexec.target --irreversible</command>,
1333 but also prints a wall message to all users. If combined
1334 with <option>--force</option>, shutdown of all running
1335 services is skipped, however all processes are killed and
1336 all file systems are unmounted or mounted read-only,
1337 immediately followed by the reboot.</para>
1341 <term><command>exit</command></term>
1344 <para>Ask the systemd manager to quit. This is only
1345 supported for user service managers (i.e. in conjunction
1346 with the <option>--user</option> option) and will fail
1352 <term><command>suspend</command></term>
1355 <para>Suspend the system. This will trigger activation of
1356 the special <filename>suspend.target</filename> target.
1361 <term><command>hibernate</command></term>
1364 <para>Hibernate the system. This will trigger activation of
1365 the special <filename>hibernate.target</filename> target.
1370 <term><command>hybrid-sleep</command></term>
1373 <para>Hibernate and suspend the system. This will trigger
1374 activation of the special
1375 <filename>hybrid-sleep.target</filename> target.</para>
1379 <term><command>switch-root <replaceable>ROOT</replaceable> <optional><replaceable>INIT</replaceable></optional></command></term>
1382 <para>Switches to a different root directory and executes a
1383 new system manager process below it. This is intended for
1384 usage in initial RAM disks ("initrd"), and will transition
1385 from the initrd's system manager process (a.k.a "init"
1386 process) to the main system manager process. This call takes two
1387 arguments: the directory that is to become the new root directory, and
1388 the path to the new system manager binary below it to
1389 execute as PID 1. If the latter is omitted or the empty
1390 string, a systemd binary will automatically be searched for
1391 and used as init. If the system manager path is omitted or
1392 equal to the empty string, the state of the initrd's system
1393 manager process is passed to the main system manager, which
1394 allows later introspection of the state of the services
1395 involved in the initrd boot.</para>
1402 <title>Parameter Syntax</title>
1404 <para>Unit ommands listed above take either a single unit name
1405 (designated as <replaceable>NAME</replaceable>), or multiple
1406 unit specifications (designated as
1407 <replaceable>PATTERN</replaceable>...). In the first case, the
1408 unit name with or without a suffix must be given. If the suffix
1409 is not specified, systemctl will append a suitable suffix,
1410 <literal>.service</literal> by default, and a type-specific
1411 suffix in case of commands which operate only on specific unit
1413 <programlisting># systemctl start sshd</programlisting> and
1414 <programlisting># systemctl start sshd.service</programlisting>
1415 are equivalent, as are
1416 <programlisting># systemctl isolate snapshot-11</programlisting>
1418 <programlisting># systemctl isolate snapshot-11.snapshot</programlisting>
1419 Note that (absolute) paths to device nodes are automatically
1420 converted to device unit names, and other (absolute) paths to
1422 <programlisting># systemctl status /dev/sda
1423 # systemctl status /home</programlisting>
1425 <programlisting># systemctl status dev-sda.device
1426 # systemctl status home.mount</programlisting>
1427 In the second case, shell-style globs will be matched against
1428 currently loaded units; literal unit names, with or without
1429 a suffix, will be treated as in the first case. This means that
1430 literal unit names always refer to exactly one unit, but globs
1431 may match zero units and this is not considered an error.</para>
1433 <para>Glob patterns use
1434 <citerefentry><refentrytitle>fnmatch</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
1435 so normal shell-style globbing rules are used, and
1436 <literal>*</literal>, <literal>?</literal>,
1437 <literal>[]</literal> may be used. See
1438 <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1439 for more details. The patterns are matched against the names of
1440 currently loaded units, and patterns which do not match anything
1441 are silently skipped. For example:
1442 <programlisting># systemctl stop sshd@*.service</programlisting>
1443 will stop all <filename>sshd@.service</filename> instances.
1446 <para>For unit file commands, the specified
1447 <replaceable>NAME</replaceable> should be the full name of the
1448 unit file, or the absolute path to the unit file:
1449 <programlisting># systemctl enable foo.service</programlisting>
1451 <programlisting># systemctl link /path/to/foo.service</programlisting>
1458 <title>Exit status</title>
1460 <para>On success, 0 is returned, a non-zero failure
1461 code otherwise.</para>
1464 <xi:include href="less-variables.xml" />
1467 <title>See Also</title>
1469 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1470 <citerefentry><refentrytitle>systemadm</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1471 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1472 <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1473 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1474 <citerefentry><refentrytitle>systemd.resource-management</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1475 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1476 <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1477 <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1478 <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>