]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/systemctl.xml
busctl: add --timeout= option to specify method call timeout
[thirdparty/systemd.git] / man / systemctl.xml
CommitLineData
7874bcd6
LP
1<?xml version='1.0'?> <!--*-nxml-*-->
2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
4a6022f0 3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
7874bcd6
LP
4
5<!--
4a6022f0 6This file is part of systemd.
7874bcd6 7
4a6022f0 8Copyright 2010 Lennart Poettering
7874bcd6 9
4a6022f0
ZJS
10systemd is free software; you can redistribute it and/or modify it
11under the terms of the GNU Lesser General Public License as published by
12the Free Software Foundation; either version 2.1 of the License, or
13(at your option) any later version.
7874bcd6 14
4a6022f0
ZJS
15systemd is distributed in the hope that it will be useful, but
16WITHOUT ANY WARRANTY; without even the implied warranty of
17MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18Lesser General Public License for more details.
7874bcd6 19
4a6022f0
ZJS
20You should have received a copy of the GNU Lesser General Public License
21along with systemd; If not, see <http://www.gnu.org/licenses/>.
7874bcd6
LP
22-->
23
21ac6ff1
ZJS
24<refentry id="systemctl"
25 xmlns:xi="http://www.w3.org/2001/XInclude">
7874bcd6 26
4a6022f0
ZJS
27 <refentryinfo>
28 <title>systemctl</title>
29 <productname>systemd</productname>
30
31 <authorgroup>
32 <author>
33 <contrib>Developer</contrib>
34 <firstname>Lennart</firstname>
35 <surname>Poettering</surname>
36 <email>lennart@poettering.net</email>
37 </author>
38 </authorgroup>
39 </refentryinfo>
40
41 <refmeta>
42 <refentrytitle>systemctl</refentrytitle>
43 <manvolnum>1</manvolnum>
44 </refmeta>
45
46 <refnamediv>
47 <refname>systemctl</refname>
48 <refpurpose>Control the systemd system and service manager</refpurpose>
49 </refnamediv>
50
51 <refsynopsisdiv>
52 <cmdsynopsis>
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>
57 </cmdsynopsis>
58 </refsynopsisdiv>
59
60 <refsect1>
61 <title>Description</title>
62
a4390b6b
LP
63 <para><command>systemctl</command> may be used to introspect and
64 control the state of the <literal>systemd</literal> system and
65 service manager. Please refer to
4a6022f0 66 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
a4390b6b
LP
67 for an introduction into the basic concepts and functionality this
68 tool manages.</para>
4a6022f0
ZJS
69 </refsect1>
70
71 <refsect1>
72 <title>Options</title>
73
74 <para>The following options are understood:</para>
75
76 <variablelist>
4a6022f0
ZJS
77 <varlistentry>
78 <term><option>-t</option></term>
79 <term><option>--type=</option></term>
80
81 <listitem>
e9dd9f95 82 <para>The argument should be a comma-separated list of unit
20b3f379 83 types such as <option>service</option> and
9b9b3d36
MW
84 <option>socket</option>.
85 </para>
20b3f379
ZJS
86
87 <para>If one of the arguments is a unit type, when listing
7b870f60 88 units, limit display to certain unit types. Otherwise, units
4a6022f0
ZJS
89 of all types will be shown.</para>
90
20b3f379 91 <para>As a special case, if one of the arguments is
4a6022f0
ZJS
92 <option>help</option>, a list of allowed values will be
93 printed and the program will exit.</para>
94 </listitem>
95 </varlistentry>
96
9b9b3d36
MW
97 <varlistentry>
98 <term><option>--state=</option></term>
99
100 <listitem>
036359ba
LP
101 <para>The argument should be a comma-separated list of unit
102 LOAD, SUB, or ACTIVE states. When listing units, show only
103 those in specified states. Use <option>--state=failed</option>
104 to show only failed units.</para>
9b9b3d36
MW
105 </listitem>
106 </varlistentry>
107
4a6022f0
ZJS
108 <varlistentry>
109 <term><option>-p</option></term>
110 <term><option>--property=</option></term>
111
112 <listitem>
54c31a79
LP
113 <para>When showing unit/job/manager properties with the
114 <command>show</command> command, limit display to certain
7b870f60 115 properties as specified as argument. If not specified, all
54c31a79 116 set properties are shown. The argument should be a
d2bbca68 117 comma-separated list of property names, such as
7b870f60 118 <literal>MainPID</literal>. If specified more than once, all
033a842c 119 properties with the specified names are shown.</para>
4a6022f0
ZJS
120 </listitem>
121 </varlistentry>
122
123 <varlistentry>
124 <term><option>-a</option></term>
125 <term><option>--all</option></term>
126
127 <listitem>
a5e4972c
LP
128 <para>When listing units, show all loaded units, regardless
129 of their state, including inactive units. When showing
4a6022f0
ZJS
130 unit/job/manager properties, show all properties regardless
131 whether they are set or not.</para>
a5e4972c
LP
132 <para>To list all units installed on the system, use the
133 <command>list-unit-files</command> command instead.</para>
4a6022f0
ZJS
134 </listitem>
135 </varlistentry>
136
1238ee09
LP
137 <varlistentry>
138 <term><option>-r</option></term>
139 <term><option>--recursive</option></term>
140
141 <listitem>
142 <para>When listing units, also show units of local
143 containers. Units of local containers will be prefixed with
144 the container name, separated by a single colon character
145 (<literal>:</literal>).</para>
146 </listitem>
147 </varlistentry>
148
afba4199
ZJS
149 <varlistentry>
150 <term><option>--reverse</option></term>
151
152 <listitem>
153 <para>Show reverse dependencies between units with
154 <command>list-dependencies</command>, i.e. units with
155 dependencies of type <varname>Wants=</varname> or
156 <varname>Requires=</varname> on the given unit.
157 </para>
158 </listitem>
159 </varlistentry>
160
161 <varlistentry>
162 <term><option>--after</option></term>
9029f642
JSJ
163
164 <listitem>
165 <para>With <command>list-dependencies</command>, show the
166 units that are ordered before the specified unit. In other
167 words, list the units that are in the <varname>After=</varname>
168 directive of the specified unit, have the specified unit in
169 their <varname>Before=</varname> directive, or are otherwise
170 implicit dependencies of the specified unit.</para>
171 </listitem>
172 </varlistentry>
173
174 <varlistentry>
afba4199
ZJS
175 <term><option>--before</option></term>
176
177 <listitem>
9029f642
JSJ
178 <para>With <command>list-dependencies</command>, show the
179 units that are ordered after the specified unit. In other
180 words, list the units that are in the <varname>Before=</varname>
181 directive of the specified unit, have the specified unit in
182 their <varname>After=</varname> directive, or otherwise depend
183 on the specified unit.</para>
afba4199
ZJS
184 </listitem>
185 </varlistentry>
186
4a6022f0 187 <varlistentry>
98a6e132 188 <term><option>-l</option></term>
4a6022f0
ZJS
189 <term><option>--full</option></term>
190
191 <listitem>
69d918b0
ZJS
192 <para>Do not ellipsize unit names, process tree entries,
193 journal output, or truncate unit descriptions in the output
194 of <command>status</command>, <command>list-units</command>,
195 <command>list-jobs</command>, and
196 <command>list-timers</command>.</para>
4a6022f0
ZJS
197 </listitem>
198 </varlistentry>
199
991f2a39
ZJS
200 <varlistentry>
201 <term><option>--show-types</option></term>
202
203 <listitem>
204 <para>When showing sockets, show the type of the socket.</para>
205 </listitem>
206 </varlistentry>
207
23ade460 208 <varlistentry>
4dc5b821 209 <term><option>--job-mode=</option></term>
23ade460
MS
210
211 <listitem>
e0e009c0
JE
212 <para>When queuing a new job, this option controls how to deal with
213 already queued jobs. It takes one of <literal>fail</literal>,
4dc5b821
LP
214 <literal>replace</literal>,
215 <literal>replace-irreversibly</literal>,
216 <literal>isolate</literal>,
217 <literal>ignore-dependencies</literal>,
218 <literal>ignore-requirements</literal> or
219 <literal>flush</literal>. Defaults to
220 <literal>replace</literal>, except when the
221 <command>isolate</command> command is used which implies the
222 <literal>isolate</literal> job mode.</para>
223
224 <para>If <literal>fail</literal> is specified and a requested
225 operation conflicts with a pending job (more specifically:
226 causes an already pending start job to be reversed into a stop
227 job or vice versa), cause the operation to fail.</para>
228
229 <para>If <literal>replace</literal> (the default) is
230 specified, any conflicting pending job will be replaced, as
231 necessary.</para>
232
233 <para>If <literal>replace-irreversibly</literal> is specified,
234 operate like <literal>replace</literal>, but also mark the new
235 jobs as irreversible. This prevents future conflicting
9a92e77e
DS
236 transactions from replacing these jobs (or even being enqueued
237 while the irreversible jobs are still pending). Irreversible
238 jobs can still be cancelled using the <command>cancel</command>
239 command.</para>
4dc5b821
LP
240
241 <para><literal>isolate</literal> is only valid for start
242 operations and causes all other units to be stopped when the
243 specified unit is started. This mode is always used when the
244 <command>isolate</command> command is used.</para>
245
246 <para><literal>flush</literal> will cause all queued jobs to
247 be canceled when the new job is enqueued.</para>
248
249 <para>If <literal>ignore-dependencies</literal> is specified,
250 then all unit dependencies are ignored for this new job and
251 the operation is executed immediately. If passed, no required
252 units of the unit passed will be pulled in, and no ordering
253 dependencies will be honored. This is mostly a debugging and
254 rescue tool for the administrator and should not be used by
255 applications.</para>
256
257 <para><literal>ignore-requirements</literal> is similar to
b040723e 258 <literal>ignore-dependencies</literal>, but only causes the
4dc5b821
LP
259 requirement dependencies to be ignored, the ordering
260 dependencies will still be honoured.</para>
23ade460 261 </listitem>
4a6022f0 262
4a6022f0
ZJS
263 </varlistentry>
264
265 <varlistentry>
266 <term><option>-i</option></term>
267 <term><option>--ignore-inhibitors</option></term>
268
269 <listitem>
270 <para>When system shutdown or a sleep state is requested,
271 ignore inhibitor locks. Applications can establish inhibitor
272 locks to avoid that certain important operations (such as CD
273 burning or suchlike) are interrupted by system shutdown or a
274 sleep state. Any user may take these locks and privileged
275 users may override these locks. If any locks are taken,
276 shutdown and sleep state requests will normally fail
494a6682 277 (regardless of whether privileged or not) and a list of active locks
7b870f60
JE
278 is printed. However, if <option>--ignore-inhibitors</option>
279 is specified, the locks are ignored and not printed, and the
4a6022f0
ZJS
280 operation attempted anyway, possibly requiring additional
281 privileges.</para>
282 </listitem>
283 </varlistentry>
284
285 <varlistentry>
286 <term><option>-q</option></term>
287 <term><option>--quiet</option></term>
288
289 <listitem>
290 <para>Suppress output to standard output in
291 <command>snapshot</command>,
292 <command>is-active</command>,
293 <command>is-failed</command>,
99813a19
LP
294 <command>is-enabled</command>,
295 <command>is-system-running</command>,
4a6022f0
ZJS
296 <command>enable</command> and
297 <command>disable</command>.</para>
298 </listitem>
299 </varlistentry>
300
301 <varlistentry>
302 <term><option>--no-block</option></term>
303
304 <listitem>
305 <para>Do not synchronously wait for the requested operation
7b870f60 306 to finish. If this is not specified, the job will be
4a6022f0 307 verified, enqueued and <command>systemctl</command> will
7b870f60 308 wait until it is completed. By passing this argument, it is
4a6022f0
ZJS
309 only verified and enqueued.</para>
310 </listitem>
311 </varlistentry>
312
313 <varlistentry>
314 <term><option>--no-legend</option></term>
315
316 <listitem>
841aa8c0 317 <para>Do not print the legend, i.e. the column headers and
4a6022f0
ZJS
318 the footer with hints.</para>
319 </listitem>
320 </varlistentry>
321
88ae7333
ZJS
322 <xi:include href="user-system-options.xml" xpointer="user" />
323 <xi:include href="user-system-options.xml" xpointer="system" />
4a6022f0 324
036359ba
LP
325 <!-- we do not document -failed here, as it has been made
326 redundant by -state=failed, which it predates. To keep
327 things simple we only document the new switch, while
328 keeping the old one around for compatibility only. -->
599b6322 329
4a6022f0
ZJS
330 <varlistentry>
331 <term><option>--no-wall</option></term>
332
333 <listitem>
7b870f60 334 <para>Do not send wall message before halt, power-off,
4a6022f0
ZJS
335 reboot.</para>
336 </listitem>
337 </varlistentry>
338
339 <varlistentry>
340 <term><option>--global</option></term>
341
342 <listitem>
343 <para>When used with <command>enable</command> and
344 <command>disable</command>, operate on the global user
345 configuration directory, thus enabling or disabling a unit
346 file globally for all future logins of all users.</para>
347 </listitem>
348 </varlistentry>
349
350 <varlistentry>
351 <term><option>--no-reload</option></term>
352
353 <listitem>
354 <para>When used with <command>enable</command> and
355 <command>disable</command>, do not implicitly reload daemon
356 configuration after executing the changes.</para>
357 </listitem>
358 </varlistentry>
359
360 <varlistentry>
361 <term><option>--no-ask-password</option></term>
362
363 <listitem>
364 <para>When used with <command>start</command> and related
365 commands, disables asking for passwords. Background services
366 may require input of a password or passphrase string, for
367 example to unlock system hard disks or cryptographic
368 certificates. Unless this option is specified and the
7b870f60 369 command is invoked from a terminal,
4a6022f0
ZJS
370 <command>systemctl</command> will query the user on the
371 terminal for the necessary secrets. Use this option to
7b870f60 372 switch this behavior off. In this case, the password must be
4a6022f0
ZJS
373 supplied by some other means (for example graphical password
374 agents) or the service might fail. This also disables
375 querying the user for authentication for privileged
376 operations.</para>
377 </listitem>
378
379 </varlistentry>
380
381 <varlistentry>
382 <term><option>--kill-who=</option></term>
383
384 <listitem>
385 <para>When used with <command>kill</command>, choose which
af7424af
LP
386 processes to send a signal to. Must be one of
387 <option>main</option>, <option>control</option> or
388 <option>all</option> to select whether to kill only the main
389 process, the control process or all processes of the
390 unit. The main process of the unit is the one that defines
391 the life-time of it. A control process of a unit is one that
392 is invoked by the manager to induce state changes of it. For
393 example, all processes started due to the
394 <varname>ExecStartPre=</varname>,
395 <varname>ExecStop=</varname> or
396 <varname>ExecReload=</varname> settings of service units are
397 control processes. Note that there is only one control
398 process per unit at a time, as only one state change is
399 executed at a time. For services of type
b8bde116 400 <varname>Type=forking</varname>, the initial process started
af7424af
LP
401 by the manager for <varname>ExecStart=</varname> is a
402 control process, while the process ultimately forked off by
403 that one is then considered the main process of the unit (if
404 it can be determined). This is different for service units
405 of other types, where the process forked off by the manager
406 for <varname>ExecStart=</varname> is always the main process
b8bde116
JE
407 itself. A service unit consists of zero or one main process,
408 zero or one control process plus any number of additional
af7424af 409 processes. Not all unit types manage processes of these
b8bde116 410 types however. For example, for mount units, control processes
af7424af
LP
411 are defined (which are the invocations of
412 <filename>/usr/bin/mount</filename> and
413 <filename>/usr/bin/umount</filename>), but no main process
414 is defined. If omitted, defaults to
415 <option>all</option>.</para>
4a6022f0
ZJS
416 </listitem>
417
418 </varlistentry>
419
420 <varlistentry>
421 <term><option>-s</option></term>
422 <term><option>--signal=</option></term>
423
424 <listitem>
425 <para>When used with <command>kill</command>, choose which
426 signal to send to selected processes. Must be one of the
05cc7267 427 well known signal specifiers such as <constant>SIGTERM</constant>, <constant>SIGINT</constant> or
7b870f60 428 <constant>SIGSTOP</constant>. If omitted, defaults to
4a6022f0
ZJS
429 <option>SIGTERM</option>.</para>
430 </listitem>
431 </varlistentry>
432
433 <varlistentry>
434 <term><option>-f</option></term>
435 <term><option>--force</option></term>
436
437 <listitem>
438 <para>When used with <command>enable</command>, overwrite
439 any existing conflicting symlinks.</para>
440
441 <para>When used with <command>halt</command>,
442 <command>poweroff</command>, <command>reboot</command> or
7b870f60 443 <command>kexec</command>, execute the selected operation
4a6022f0
ZJS
444 without shutting down all units. However, all processes will
445 be killed forcibly and all file systems are unmounted or
446 remounted read-only. This is hence a drastic but relatively
447 safe option to request an immediate reboot. If
448 <option>--force</option> is specified twice for these
449 operations, they will be executed immediately without
1e89266b 450 terminating any processes or unmounting any file
4a6022f0
ZJS
451 systems. Warning: specifying <option>--force</option> twice
452 with any of these operations might result in data
453 loss.</para>
454 </listitem>
455 </varlistentry>
456
457 <varlistentry>
458 <term><option>--root=</option></term>
459
460 <listitem>
461 <para>When used with
462 <command>enable</command>/<command>disable</command>/<command>is-enabled</command>
463 (and related commands), use alternative root path when
464 looking for unit files.</para>
465 </listitem>
466
467 </varlistentry>
468
469 <varlistentry>
470 <term><option>--runtime</option></term>
471
472 <listitem>
a330b376 473 <para>When used with <command>enable</command>,
171754aa 474 <command>disable</command>,
4a6022f0 475 (and related commands), make changes only temporarily, so
a330b376 476 that they are lost on the next reboot. This will have the
4a6022f0
ZJS
477 effect that changes are not made in subdirectories of
478 <filename>/etc</filename> but in <filename>/run</filename>,
479 with identical immediate effects, however, since the latter
480 is lost on reboot, the changes are lost too.</para>
a330b376 481
494a6682 482 <para>Similarly, when used with
fbce1139 483 <command>set-property</command>, make changes only
a330b376
LP
484 temporarily, so that they are lost on the next
485 reboot.</para>
4a6022f0
ZJS
486 </listitem>
487 </varlistentry>
488
d309c1c3
LP
489 <varlistentry>
490 <term><option>--preset-mode=</option></term>
491
492 <listitem>
493 <para>Takes one of <literal>full</literal> (the default),
494 <literal>enable-only</literal>,
8d0e0ddd 495 <literal>disable-only</literal>. When used with the
d309c1c3 496 <command>preset</command> or <command>preset-all</command>
8d0e0ddd 497 commands, controls whether units shall be disabled and
d309c1c3
LP
498 enabled according to the preset rules, or only enabled, or
499 only disabled.</para>
500 </listitem>
501 </varlistentry>
502
4a6022f0
ZJS
503 <varlistentry>
504 <term><option>-n</option></term>
505 <term><option>--lines=</option></term>
506
507 <listitem>
7b870f60 508 <para>When used with <command>status</command>, controls the
4a6022f0
ZJS
509 number of journal lines to show, counting from the most
510 recent ones. Takes a positive integer argument. Defaults to
511 10.</para>
512 </listitem>
513 </varlistentry>
514
515 <varlistentry>
516 <term><option>-o</option></term>
517 <term><option>--output=</option></term>
518
519 <listitem>
7b870f60 520 <para>When used with <command>status</command>, controls the
4a6022f0 521 formatting of the journal entries that are shown. For the
7b870f60 522 available choices, see
4a6022f0
ZJS
523 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
524 Defaults to <literal>short</literal>.</para>
525 </listitem>
526 </varlistentry>
527
5d0c05e5
LN
528 <varlistentry>
529 <term><option>--plain</option></term>
530
531 <listitem>
7b870f60 532 <para>When used with <command>list-dependencies</command>,
5d0c05e5
LN
533 the output is printed as a list instead of a tree.</para>
534 </listitem>
535 </varlistentry>
536
4f50d2ef
ZJS
537 <xi:include href="user-system-options.xml" xpointer="host" />
538 <xi:include href="user-system-options.xml" xpointer="machine" />
539
dfdebb1b
ZJS
540 <xi:include href="standard-options.xml" xpointer="help" />
541 <xi:include href="standard-options.xml" xpointer="version" />
542 <xi:include href="standard-options.xml" xpointer="no-pager" />
4a6022f0
ZJS
543 </variablelist>
544 </refsect1>
545
546 <refsect1>
547 <title>Commands</title>
548
549 <para>The following commands are understood:</para>
550
27722f96
LN
551 <refsect2>
552 <title>Unit Commands</title>
4a6022f0 553
27722f96
LN
554 <variablelist>
555 <varlistentry>
4f8f66cb 556 <term><command>list-units <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
4a6022f0 557
27722f96
LN
558 <listitem>
559 <para>List known units (subject to limitations specified
d8fba7c6
ZJS
560 with <option>-t</option>). If one or more
561 <replaceable>PATTERN</replaceable>s are specified, only
562 units matching one of them are shown.</para>
991f2a39 563
27722f96
LN
564 <para>This is the default command.</para>
565 </listitem>
566 </varlistentry>
991f2a39 567
27722f96 568 <varlistentry>
4f8f66cb 569 <term><command>list-sockets <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
27722f96
LN
570
571 <listitem>
e0e009c0 572 <para>List socket units ordered by listening address.
d8fba7c6
ZJS
573 If one or more <replaceable>PATTERN</replaceable>s are
574 specified, only socket units matching one of them are
575 shown. Produces output similar to
27722f96 576 <programlisting>
991f2a39
ZJS
577LISTEN UNIT ACTIVATES
578/dev/initctl systemd-initctl.socket systemd-initctl.service
579...
580[::]:22 sshd.socket sshd.service
581kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
582
9fccdb0f 5835 sockets listed.</programlisting>
27722f96
LN
584 Note: because the addresses might contains spaces, this output
585 is not suitable for programmatic consumption.
586 </para>
587
588 <para>See also the options <option>--show-types</option>,
ed80170d 589 <option>--all</option>, and <option>--state=</option>.</para>
27722f96
LN
590 </listitem>
591 </varlistentry>
592
cbb76c29 593 <varlistentry>
4f8f66cb 594 <term><command>list-timers <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
cbb76c29
LP
595
596 <listitem>
d8fba7c6
ZJS
597 <para>List timer units ordered by the time they elapse
598 next. If one or more <replaceable>PATTERN</replaceable>s
599 are specified, only units matching one of them are shown.
600 </para>
cbb76c29
LP
601
602 <para>See also the options <option>--all</option> and
ed80170d 603 <option>--state=</option>.</para>
cbb76c29
LP
604 </listitem>
605 </varlistentry>
606
27722f96 607 <varlistentry>
e3e0314b 608 <term><command>start <replaceable>PATTERN</replaceable>...</command></term>
27722f96
LN
609
610 <listitem>
611 <para>Start (activate) one or more units specified on the
612 command line.</para>
e3e0314b
ZJS
613
614 <para>Note that glob patterns operate on a list of currently
615 loaded units. Units which are not active and are not in a
616 failed state usually are not loaded, and would not be
617 matched by any pattern. In addition, in case of
618 instantiated units, systemd is often unaware of the
73e231ab 619 instance name until the instance has been started. Therefore,
e3e0314b
ZJS
620 using glob patterns with <command>start</command>
621 has limited usefulness.</para>
27722f96
LN
622 </listitem>
623 </varlistentry>
624 <varlistentry>
e3e0314b 625 <term><command>stop <replaceable>PATTERN</replaceable>...</command></term>
27722f96
LN
626
627 <listitem>
628 <para>Stop (deactivate) one or more units specified on the
629 command line.</para>
630 </listitem>
631 </varlistentry>
632 <varlistentry>
e3e0314b 633 <term><command>reload <replaceable>PATTERN</replaceable>...</command></term>
27722f96
LN
634
635 <listitem>
636 <para>Asks all units listed on the command line to reload
637 their configuration. Note that this will reload the
638 service-specific configuration, not the unit configuration
639 file of systemd. If you want systemd to reload the
79640424 640 configuration file of a unit, use the
27722f96
LN
641 <command>daemon-reload</command> command. In other words:
642 for the example case of Apache, this will reload Apache's
643 <filename>httpd.conf</filename> in the web server, not the
644 <filename>apache.service</filename> systemd unit
645 file.</para>
646
647 <para>This command should not be confused with the
d0a3fb75 648 <command>daemon-reload</command> command.</para>
27722f96
LN
649 </listitem>
650
651 </varlistentry>
652 <varlistentry>
e3e0314b 653 <term><command>restart <replaceable>PATTERN</replaceable>...</command></term>
27722f96
LN
654
655 <listitem>
656 <para>Restart one or more units specified on the command
657 line. If the units are not running yet, they will be
658 started.</para>
659 </listitem>
660 </varlistentry>
661 <varlistentry>
e3e0314b 662 <term><command>try-restart <replaceable>PATTERN</replaceable>...</command></term>
27722f96
LN
663
664 <listitem>
665 <para>Restart one or more units specified on the command
666 line if the units are running. This does nothing if units are not
667 running. Note that, for compatibility with Red Hat init
668 scripts, <command>condrestart</command> is equivalent to this
669 command.</para>
670 </listitem>
671 </varlistentry>
672 <varlistentry>
e3e0314b 673 <term><command>reload-or-restart <replaceable>PATTERN</replaceable>...</command></term>
27722f96
LN
674
675 <listitem>
676 <para>Reload one or more units if they support it. If not,
677 restart them instead. If the units are not running yet, they
678 will be started.</para>
679 </listitem>
680 </varlistentry>
681 <varlistentry>
e3e0314b 682 <term><command>reload-or-try-restart <replaceable>PATTERN</replaceable>...</command></term>
27722f96
LN
683
684 <listitem>
685 <para>Reload one or more units if they support it. If not,
686 restart them instead. This does nothing if the units are not
687 running. Note that, for compatibility with SysV init scripts,
688 <command>force-reload</command> is equivalent to this
689 command.</para>
690 </listitem>
691 </varlistentry>
692 <varlistentry>
693 <term><command>isolate <replaceable>NAME</replaceable></command></term>
694
695 <listitem>
696 <para>Start the unit specified on the command line and its
697 dependencies and stop all others.</para>
698
699 <para>This is similar to changing the runlevel in a
700 traditional init system. The <command>isolate</command>
701 command will immediately stop processes that are not enabled
702 in the new unit, possibly including the graphical
703 environment or terminal you are currently using.</para>
704
705 <para>Note that this is allowed only on units where
706 <option>AllowIsolate=</option> is enabled. See
707 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
708 for details.</para>
709 </listitem>
710 </varlistentry>
711 <varlistentry>
e3e0314b 712 <term><command>kill <replaceable>PATTERN</replaceable>...</command></term>
27722f96
LN
713
714 <listitem>
715 <para>Send a signal to one or more processes of the
716 unit. Use <option>--kill-who=</option> to select which
0088d631
LP
717 process to kill. Use <option>--signal=</option> to select
718 the signal to send.</para>
27722f96
LN
719 </listitem>
720 </varlistentry>
721 <varlistentry>
e3e0314b 722 <term><command>is-active <replaceable>PATTERN</replaceable>...</command></term>
27722f96
LN
723
724 <listitem>
725 <para>Check whether any of the specified units are active
6db27428
ZJS
726 (i.e. running). Returns an exit code
727 <constant>0</constant> if at least one is active, or
728 non-zero otherwise. Unless <option>--quiet</option> is
729 specified, this will also print the current unit state to
730 standard output.</para>
27722f96
LN
731 </listitem>
732 </varlistentry>
733 <varlistentry>
e3e0314b 734 <term><command>is-failed <replaceable>PATTERN</replaceable>...</command></term>
27722f96
LN
735
736 <listitem>
6db27428
ZJS
737 <para>Check whether any of the specified units are in a
738 "failed" state. Returns an exit code
739 <constant>0</constant> if at least one has failed,
740 non-zero otherwise. Unless <option>--quiet</option> is
741 specified, this will also print the current unit state to
742 standard output.</para>
27722f96
LN
743 </listitem>
744 </varlistentry>
745 <varlistentry>
e3e0314b 746 <term><command>status</command> <optional><replaceable>PATTERN</replaceable>...|<replaceable>PID</replaceable>...]</optional></term>
27722f96
LN
747
748 <listitem>
749 <para>Show terse runtime status information about one or
750 more units, followed by most recent log data from the
8fcf784d 751 journal. If no units are specified, show system status. If
b8bde116 752 combined with <option>--all</option>, also show the status of
8fcf784d
LP
753 all units (subject to limitations specified with
754 <option>-t</option>). If a PID is passed, show information
755 about the unit the process belongs to.</para>
27722f96
LN
756
757 <para>This function is intended to generate human-readable
e213d1a3
ZJS
758 output. If you are looking for computer-parsable output,
759 use <command>show</command> instead. By default this
760 function only shows 10 lines of output and ellipsizes
761 lines to fit in the terminal window. This can be changes
762 with <option>--lines</option> and <option>--full</option>,
763 see above. In addition, <command>journalctl
764 --unit=<replaceable>NAME</replaceable></command> or
765 <command>journalctl
766 --user-unit=<replaceable>NAME</replaceable></command> use
767 a similar filter for messages and might be more
768 convenient.
769 </para>
27722f96
LN
770 </listitem>
771 </varlistentry>
772 <varlistentry>
e3e0314b 773 <term><command>show</command> <optional><replaceable>PATTERN</replaceable>...|<replaceable>JOB</replaceable>...</optional></term>
27722f96
LN
774
775 <listitem>
776 <para>Show properties of one or more units, jobs, or the
79640424
JE
777 manager itself. If no argument is specified, properties of
778 the manager will be shown. If a unit name is specified,
27722f96 779 properties of the unit is shown, and if a job id is
79640424 780 specified, properties of the job is shown. By default, empty
27722f96 781 properties are suppressed. Use <option>--all</option> to
79640424 782 show those too. To select specific properties to show, use
27722f96
LN
783 <option>--property=</option>. This command is intended to be
784 used whenever computer-parsable output is required. Use
785 <command>status</command> if you are looking for formatted
786 human-readable output.</para>
787 </listitem>
788 </varlistentry>
e93c33d4 789 <varlistentry>
e3e0314b 790 <term><command>cat <replaceable>PATTERN</replaceable>...</command></term>
27722f96 791
e93c33d4 792 <listitem>
e4c0fbe5
ZJS
793 <para>Show backing files of one or more units. Prints the
794 "fragment" and "drop-ins" (source files) of units. Each
795 file is preceded by a comment which includes the file
796 name.</para>
e93c33d4
SL
797 </listitem>
798 </varlistentry>
27722f96
LN
799 <varlistentry>
800 <term><command>set-property <replaceable>NAME</replaceable> <replaceable>ASSIGNMENT</replaceable>...</command></term>
801
802 <listitem>
803 <para>Set the specified unit properties at runtime where
804 this is supported. This allows changing configuration
3fde5f30 805 parameter properties such as resource control settings at
27722f96 806 runtime. Not all properties may be changed at runtime, but
3fde5f30
LP
807 many resource control settings (primarily those in
808 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
27722f96
LN
809 may. The changes are applied instantly, and stored on disk
810 for future boots, unless <option>--runtime</option> is
3fde5f30
LP
811 passed, in which case the settings only apply until the
812 next reboot. The syntax of the property assignment follows
27722f96
LN
813 closely the syntax of assignments in unit files.</para>
814
815 <para>Example: <command>systemctl set-property foobar.service CPUShares=777</command></para>
816
817 <para>Note that this command allows changing multiple
818 properties at the same time, which is preferable over
819 setting them individually. Like unit file configuration
820 settings, assigning the empty list to list parameters will
821 reset the list.</para>
822 </listitem>
823 </varlistentry>
824
825 <varlistentry>
e3e0314b 826 <term><command>help <replaceable>PATTERN</replaceable>...|<replaceable>PID</replaceable>...</command></term>
27722f96
LN
827
828 <listitem>
829 <para>Show manual pages for one or more units, if
830 available. If a PID is given, the manual pages for the unit
831 the process belongs to are shown.</para>
832 </listitem>
833 </varlistentry>
834
835 <varlistentry>
e3e0314b 836 <term><command>reset-failed [<replaceable>PATTERN</replaceable>...]</command></term>
27722f96
LN
837
838 <listitem>
839 <para>Reset the <literal>failed</literal> state of the
840 specified units, or if no unit name is passed, reset the state of all
841 units. When a unit fails in some way (i.e. process exiting
842 with non-zero error code, terminating abnormally or timing
843 out), it will automatically enter the
844 <literal>failed</literal> state and its exit code and status
845 is recorded for introspection by the administrator until the
846 service is restarted or reset with this command.</para>
847 </listitem>
848 </varlistentry>
849
850 <varlistentry>
851 <term><command>list-dependencies <replaceable>NAME</replaceable></command></term>
852
853 <listitem>
854 <para>Shows required and wanted units of the specified
855 unit. If no unit is specified,
856 <filename>default.target</filename> is implied. Target units
857 are recursively expanded. When <option>--all</option> is
858 passed, all other units are recursively expanded as
859 well.</para>
860 </listitem>
861 </varlistentry>
862 </variablelist>
863 </refsect2>
864
865 <refsect2>
866 <title>Unit File Commands</title>
867
868 <variablelist>
869 <varlistentry>
d8fba7c6 870 <term><command>list-unit-files <optional><replaceable>PATTERN...</replaceable></optional></command></term>
27722f96
LN
871
872 <listitem>
d8fba7c6
ZJS
873 <para>List installed unit files. If one or more
874 <replaceable>PATTERN</replaceable>s are specified, only
875 units whose filename (just the last component of the path)
876 matches one of them are shown.</para>
27722f96
LN
877 </listitem>
878 </varlistentry>
879
880 <varlistentry>
881 <term><command>enable <replaceable>NAME</replaceable>...</command></term>
882
883 <listitem>
884 <para>Enable one or more unit files or unit file instances,
885 as specified on the command line. This will create a number
886 of symlinks as encoded in the <literal>[Install]</literal>
887 sections of the unit files. After the symlinks have been
888 created, the systemd configuration is reloaded (in a way that
889 is equivalent to <command>daemon-reload</command>) to ensure
890 the changes are taken into account immediately. Note that
891 this does <emphasis>not</emphasis> have the effect of also
892 starting any of the units being enabled. If this
893 is desired, a separate <command>start</command> command must
894 be invoked for the unit. Also note that in case of instance
895 enablement, symlinks named the same as instances are created in
896 the install location, however they all point to the same
897 template unit file.</para>
898
899 <para>This command will print the actions executed. This
900 output may be suppressed by passing <option>--quiet</option>.
901 </para>
902
903 <para>Note that this operation creates only the suggested
904 symlinks for the units. While this command is the
905 recommended way to manipulate the unit configuration
906 directory, the administrator is free to make additional
907 changes manually by placing or removing symlinks in the
908 directory. This is particularly useful to create
909 configurations that deviate from the suggested default
910 installation. In this case, the administrator must make sure
911 to invoke <command>daemon-reload</command> manually as
912 necessary to ensure the changes are taken into account.
913 </para>
914
915 <para>Enabling units should not be confused with starting
916 (activating) units, as done by the <command>start</command>
917 command. Enabling and starting units is orthogonal: units
918 may be enabled without being started and started without
919 being enabled. Enabling simply hooks the unit into various
920 suggested places (for example, so that the unit is
921 automatically started on boot or when a particular kind of
922 hardware is plugged in). Starting actually spawns the daemon
923 process (in case of service units), or binds the socket (in
924 case of socket units), and so on.</para>
925
926 <para>Depending on whether <option>--system</option>,
1bee43de 927 <option>--user</option>, <option>--runtime</option>,
72f4d966 928 or <option>--global</option> is specified, this enables the unit
1bee43de
ZJS
929 for the system, for the calling user only, for only this boot of
930 the system, or for all future logins of all users, or only this
931 boot. Note that in the last case, no systemd daemon
27722f96 932 configuration is reloaded.</para>
751ea8de
JS
933
934 <para>Using <command>enable</command> on masked units
935 results in an error.</para>
27722f96
LN
936 </listitem>
937 </varlistentry>
938
939 <varlistentry>
940 <term><command>disable <replaceable>NAME</replaceable>...</command></term>
941
942 <listitem>
943 <para>Disables one or more units. This removes all symlinks
944 to the specified unit files from the unit configuration
945 directory, and hence undoes the changes made by
946 <command>enable</command>. Note however that this removes
947 all symlinks to the unit files (i.e. including manual
948 additions), not just those actually created by
949 <command>enable</command>. This call implicitly reloads the
950 systemd daemon configuration after completing the disabling
951 of the units. Note that this command does not implicitly
952 stop the units that are being disabled. If this is desired,
953 an additional <command>stop</command> command should be
954 executed afterwards.</para>
955
956 <para>This command will print the actions executed. This
957 output may be suppressed by passing <option>--quiet</option>.
958 </para>
959
960 <para>This command honors <option>--system</option>,
72f4d966 961 <option>--user</option>, <option>--runtime</option> and
1bee43de
ZJS
962 <option>--global</option> in a similar way as
963 <command>enable</command>.</para>
27722f96
LN
964 </listitem>
965 </varlistentry>
966
967 <varlistentry>
968 <term><command>is-enabled <replaceable>NAME</replaceable>...</command></term>
969
970 <listitem>
971 <para>Checks whether any of the specified unit files are
171754aa
ZJS
972 enabled (as with <command>enable</command>). Returns an
973 exit code of 0 if at least one is enabled, non-zero
974 otherwise. Prints the current enable status (see table).
975 To suppress this output, use <option>--quiet</option>.
976 </para>
977
978 <table>
979 <title>
980 <command>is-enabled</command> output
981 </title>
982
983 <tgroup cols='3'>
984 <thead>
985 <row>
986 <entry>Printed string</entry>
987 <entry>Meaning</entry>
988 <entry>Return value</entry>
989 </row>
990 </thead>
991 <tbody>
992 <row>
993 <entry><literal>enabled</literal></entry>
39f76ad8 994 <entry morerows='1'>Enabled through a symlink in <filename>.wants</filename> directory (permanently or just in <filename>/run</filename>).</entry>
171754aa
ZJS
995 <entry morerows='1'>0</entry>
996 </row>
997 <row>
998 <entry><literal>enabled-runtime</literal></entry>
999 </row>
1000 <row>
1001 <entry><literal>linked</literal></entry>
39f76ad8 1002 <entry morerows='1'>Made available through a symlink to the unit file (permanently or just in <filename>/run</filename>).</entry>
171754aa
ZJS
1003 <entry morerows='1'>1</entry>
1004 </row>
1005 <row>
1006 <entry><literal>linked-runtime</literal></entry>
1007 </row>
1008 <row>
1009 <entry><literal>masked</literal></entry>
39f76ad8 1010 <entry morerows='1'>Disabled entirely (permanently or just in <filename>/run</filename>).</entry>
171754aa
ZJS
1011 <entry morerows='1'>1</entry>
1012 </row>
1013 <row>
1014 <entry><literal>masked-runtime</literal></entry>
1015 </row>
1016 <row>
1017 <entry><literal>static</literal></entry>
39f76ad8 1018 <entry>Unit file is not enabled, and has no provisions for enabling in the <literal>[Install]</literal> section.</entry>
91f0ac7d 1019 <entry>0</entry>
171754aa 1020 </row>
aedd4012
JS
1021 <row>
1022 <entry><literal>indirect</literal></entry>
39f76ad8 1023 <entry>Unit file itself is not enabled, but it has a non-empty <varname>Also=</varname> setting in the <literal>[Install]</literal> section, listing other unit files that might be enabled.</entry>
aedd4012
JS
1024 <entry>0</entry>
1025 </row>
171754aa
ZJS
1026 <row>
1027 <entry><literal>disabled</literal></entry>
39f76ad8 1028 <entry>Unit file is not enabled.</entry>
171754aa
ZJS
1029 <entry>1</entry>
1030 </row>
1031 </tbody>
1032 </tgroup>
1033 </table>
1034
27722f96
LN
1035 </listitem>
1036 </varlistentry>
1037
1038 <varlistentry>
1039 <term><command>reenable <replaceable>NAME</replaceable>...</command></term>
1040
1041 <listitem>
1042 <para>Reenable one or more unit files, as specified on the
1043 command line. This is a combination of
1044 <command>disable</command> and <command>enable</command> and
1045 is useful to reset the symlinks a unit is enabled with to
1046 the defaults configured in the <literal>[Install]</literal>
1047 section of the unit file.</para>
1048 </listitem>
1049 </varlistentry>
1050
1051 <varlistentry>
1052 <term><command>preset <replaceable>NAME</replaceable>...</command></term>
1053
1054 <listitem>
1055 <para>Reset one or more unit files, as specified on the
1056 command line, to the defaults configured in the preset
1057 policy files. This has the same effect as
1058 <command>disable</command> or <command>enable</command>,
d309c1c3
LP
1059 depending how the unit is listed in the preset files.</para>
1060
1061 <para>Use <option>--preset-mode=</option> to control
1062 whether units shall be enabled and disabled, or only
1063 enabled, or only disabled.</para>
1064
1065 <para>For more information on the preset policy format,
1066 see
27722f96
LN
1067 <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1068 For more information on the concept of presets, please
d309c1c3
LP
1069 consult the <ulink
1070 url="http://freedesktop.org/wiki/Software/systemd/Preset">Preset</ulink>
27722f96
LN
1071 document.</para>
1072 </listitem>
1073 </varlistentry>
1074
d309c1c3
LP
1075 <varlistentry>
1076 <term><command>preset-all</command></term>
1077
1078 <listitem>
1079 <para>Resets all installed unit files to the defaults
1080 configured in the preset policy file (see above).</para>
1081
1082 <para>Use <option>--preset-mode=</option> to control
1083 whether units shall be enabled and disabled, or only
1084 enabled, or only disabled.</para>
1085 </listitem>
1086 </varlistentry>
1087
27722f96
LN
1088 <varlistentry>
1089 <term><command>mask <replaceable>NAME</replaceable>...</command></term>
1090
1091 <listitem>
1092 <para>Mask one or more unit files, as specified on the
1093 command line. This will link these units to
1094 <filename>/dev/null</filename>, making it impossible to
1095 start them. This is a stronger version of
1096 <command>disable</command>, since it prohibits all kinds of
751ea8de
JS
1097 activation of the unit, including enablement and manual
1098 activation. Use this option with care. This honors the
72f4d966 1099 <option>--runtime</option> option to only mask temporarily
1e89266b 1100 until the next reboot of the system.</para>
27722f96
LN
1101 </listitem>
1102 </varlistentry>
1103
1104 <varlistentry>
1105 <term><command>unmask <replaceable>NAME</replaceable>...</command></term>
1106
1107 <listitem>
1108 <para>Unmask one or more unit files, as specified on the
1109 command line. This will undo the effect of
1110 <command>mask</command>.</para>
1111 </listitem>
1112 </varlistentry>
1113
e94937df
LN
1114 <varlistentry>
1115 <term><command>add-wants <replaceable>TARGET</replaceable>
1116 <replaceable>NAME</replaceable>...</command></term>
1117 <term><command>add-requires <replaceable>TARGET</replaceable>
1118 <replaceable>NAME</replaceable>...</command></term>
1119
1120 <listitem>
1121 <para>Adds <literal>Wants=</literal> resp. <literal>Requires=</literal>
1122 dependency to the specified <replaceable>TARGET</replaceable> for
1123 one or more units. </para>
1124
1125 <para>This command honors <option>--system</option>,
1126 <option>--user</option>, <option>--runtime</option> and
1127 <option>--global</option> in a similar way as
1128 <command>enable</command>.</para>
1129
1130 </listitem>
1131 </varlistentry>
1132
27722f96
LN
1133 <varlistentry>
1134 <term><command>link <replaceable>FILENAME</replaceable>...</command></term>
1135
1136 <listitem>
1137 <para>Link a unit file that is not in the unit file search
1138 paths into the unit file search path. This requires an
1139 absolute path to a unit file. The effect of this can be
1140 undone with <command>disable</command>. The effect of this
1141 command is that a unit file is available for
1142 <command>start</command> and other commands although it
1143 is not installed directly in the unit search path.</para>
1144 </listitem>
1145 </varlistentry>
1146
1147 <varlistentry>
1148 <term><command>get-default</command></term>
1149
1150 <listitem>
1151 <para>Get the default target specified
1152 via <filename>default.target</filename> link.</para>
1153 </listitem>
1154 </varlistentry>
1155
1156 <varlistentry>
1157 <term><command>set-default <replaceable>NAME</replaceable></command></term>
1158
1159 <listitem>
1160 <para>Set the default target to boot into. Command links
1161 <filename>default.target</filename> to the given unit.</para>
1162 </listitem>
1163 </varlistentry>
1164 </variablelist>
1165 </refsect2>
1166
0d292f5e
LP
1167 <refsect2>
1168 <title>Machine Commands</title>
1169
1170 <variablelist>
1171 <varlistentry>
1172 <term><command>list-machines <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
1173
1174 <listitem>
1175 <para>List the host and all running local containers with
1176 their state. If one or more
1177 <replaceable>PATTERN</replaceable>s are specified, only
1178 containers matching one of them are shown.
1179 </para>
1180 </listitem>
1181 </varlistentry>
1182 </variablelist>
1183 </refsect2>
1184
27722f96
LN
1185 <refsect2>
1186 <title>Job Commands</title>
1187
1188 <variablelist>
1189 <varlistentry>
d8fba7c6 1190 <term><command>list-jobs <optional><replaceable>PATTERN...</replaceable></optional></command></term>
27722f96
LN
1191
1192 <listitem>
d8fba7c6
ZJS
1193 <para>List jobs that are in progress. If one or more
1194 <replaceable>PATTERN</replaceable>s are specified, only
1195 jobs for units matching one of them are shown.</para>
27722f96
LN
1196 </listitem>
1197 </varlistentry>
1198 <varlistentry>
1199 <term><command>cancel <replaceable>JOB</replaceable>...</command></term>
1200
1201 <listitem>
1202 <para>Cancel one or more jobs specified on the command line
1203 by their numeric job IDs. If no job ID is specified, cancel
1204 all pending jobs.</para>
1205 </listitem>
1206 </varlistentry>
1207 </variablelist>
1208 </refsect2>
1209
1210 <refsect2>
1211 <title>Snapshot Commands</title>
1212
1213 <variablelist>
1214 <varlistentry>
d8fba7c6 1215 <term><command>snapshot <optional><replaceable>NAME</replaceable></optional></command></term>
27722f96
LN
1216
1217 <listitem>
1218 <para>Create a snapshot. If a snapshot name is specified,
1219 the new snapshot will be named after it. If none is
6db27428
ZJS
1220 specified, an automatic snapshot name is generated. In
1221 either case, the snapshot name used is printed to standard
1222 output, unless <option>--quiet</option> is specified.
1223 </para>
27722f96
LN
1224
1225 <para>A snapshot refers to a saved state of the systemd
1226 manager. It is implemented itself as a unit that is
1227 generated dynamically with this command and has dependencies
1228 on all units active at the time. At a later time, the user
1229 may return to this state by using the
1230 <command>isolate</command> command on the snapshot unit.
1231 </para>
1232
1233 <para>Snapshots are only useful for saving and restoring
1234 which units are running or are stopped, they do not
1235 save/restore any other state. Snapshots are dynamic and lost
1236 on reboot.</para>
1237 </listitem>
1238 </varlistentry>
1239 <varlistentry>
e3e0314b 1240 <term><command>delete <replaceable>PATTERN</replaceable>...</command></term>
27722f96
LN
1241
1242 <listitem>
1243 <para>Remove a snapshot previously created with
1244 <command>snapshot</command>.</para>
1245 </listitem>
1246 </varlistentry>
1247 </variablelist>
1248 </refsect2>
1249
1250 <refsect2>
1251 <title>Environment Commands</title>
1252
1253 <variablelist>
1254 <varlistentry>
1255 <term><command>show-environment</command></term>
1256
1257 <listitem>
1258 <para>Dump the systemd manager environment block. The
1259 environment block will be dumped in straight-forward form
1260 suitable for sourcing into a shell script. This environment
1261 block will be passed to all processes the manager
1262 spawns.</para>
1263 </listitem>
1264 </varlistentry>
1265 <varlistentry>
1266 <term><command>set-environment <replaceable>VARIABLE=VALUE</replaceable>...</command></term>
1267
1268 <listitem>
1269 <para>Set one or more systemd manager environment variables,
1270 as specified on the command line.</para>
1271 </listitem>
1272 </varlistentry>
1273 <varlistentry>
1274 <term><command>unset-environment <replaceable>VARIABLE</replaceable>...</command></term>
1275
1276 <listitem>
1277 <para>Unset one or more systemd manager environment
1278 variables. If only a variable name is specified, it will be
1279 removed regardless of its value. If a variable and a value
1280 are specified, the variable is only removed if it has the
1281 specified value.</para>
1282 </listitem>
ac3efa8a
LP
1283 </varlistentry>
1284 <varlistentry>
1285 <term><command>import-environment <replaceable>VARIABLE</replaceable>...</command></term>
1286
1287 <listitem>
1288 <para>Import all, one or more environment variables set on
1289 the client into the systemd manager environment block. If
73e231ab
JE
1290 no arguments are passed, the entire environment block is
1291 imported. Otherwise, a list of one or more environment
1292 variable names should be passed, whose client-side values
ac3efa8a
LP
1293 are then imported into the manager's environment
1294 block.</para>
1295 </listitem>
27722f96
LN
1296 </varlistentry>
1297 </variablelist>
1298 </refsect2>
1299
1300 <refsect2>
1301 <title>Manager Lifecycle Commands</title>
1302
1303 <variablelist>
1304 <varlistentry>
1305 <term><command>daemon-reload</command></term>
1306
1307 <listitem>
1308 <para>Reload systemd manager configuration. This will reload
1309 all unit files and recreate the entire dependency
79640424 1310 tree. While the daemon is being reloaded, all sockets systemd
cbfaff65 1311 listens on behalf of user configuration will stay
27722f96 1312 accessible.</para> <para>This command should not be confused
d0a3fb75 1313 with the <command>reload</command> command.</para>
27722f96
LN
1314 </listitem>
1315 </varlistentry>
1316 <varlistentry>
1317 <term><command>daemon-reexec</command></term>
1318
1319 <listitem>
1320 <para>Reexecute the systemd manager. This will serialize the
1321 manager state, reexecute the process and deserialize the
1322 state again. This command is of little use except for
79640424 1323 debugging and package upgrades. Sometimes, it might be
27722f96 1324 helpful as a heavy-weight <command>daemon-reload</command>.
79640424 1325 While the daemon is being reexecuted, all sockets systemd listening
27722f96
LN
1326 on behalf of user configuration will stay accessible.
1327 </para>
1328 </listitem>
1329 </varlistentry>
1330 </variablelist>
1331 </refsect2>
1332
1333 <refsect2>
1334 <title>System Commands</title>
1335
1336 <variablelist>
99813a19
LP
1337 <varlistentry>
1338 <term><command>is-system-running</command></term>
1339
1340 <listitem>
2de51fdc
ZJS
1341 <para>Checks whether the system is operational. This
1342 returns success when the system is fully up and running,
1343 meaning not in startup, shutdown or maintenance
1344 mode. Failure is returned otherwise. In addition, the
1345 current state is printed in a short string to standard
1346 output, see table below. Use <option>--quiet</option> to
1347 suppress this output.</para>
1348
1349 <table>
1350 <title>Manager Operational States</title>
1351 <tgroup cols='2'>
1352 <colspec colname='name' />
1353 <colspec colname='description' />
1354 <thead>
1355 <row>
1356 <entry>Name</entry>
1357 <entry>Description</entry>
1358 </row>
1359 </thead>
1360 <tbody>
1361 <row>
1362 <entry><varname>initializing</varname></entry>
1363 <entry><para>Early bootup, before
1fdfa094
LP
1364 <filename>basic.target</filename> is reached
1365 or the <varname>maintenance</varname> state entered.
2de51fdc
ZJS
1366 </para></entry>
1367 </row>
1368 <row>
1369 <entry><varname>starting</varname></entry>
1fdfa094
LP
1370 <entry><para>Late bootup, before the job queue
1371 becomes idle for the first time, or one of the
1372 rescue targets are reached.</para></entry>
2de51fdc
ZJS
1373 </row>
1374 <row>
1375 <entry><varname>running</varname></entry>
1376 <entry><para>The system is fully
1377 operational.</para></entry>
1378 </row>
1379 <row>
1380 <entry><varname>degraded</varname></entry>
1381 <entry><para>The system is operational but one or more
1382 units failed.</para></entry>
1383 </row>
1384 <row>
1385 <entry><varname>maintenance</varname></entry>
1fdfa094 1386 <entry><para>The rescue or emergency target is
2de51fdc
ZJS
1387 active.</para></entry>
1388 </row>
1389 <row>
1390 <entry><varname>stopping</varname></entry>
1391 <entry><para>The manager is shutting
1392 down.</para></entry>
1393 </row>
1394 </tbody>
1395 </tgroup>
1396 </table>
99813a19
LP
1397 </listitem>
1398 </varlistentry>
1399
27722f96
LN
1400 <varlistentry>
1401 <term><command>default</command></term>
1402
1403 <listitem>
1404 <para>Enter default mode. This is mostly equivalent to
1405 <command>isolate default.target</command>.</para>
1406 </listitem>
1407 </varlistentry>
99813a19 1408
27722f96
LN
1409 <varlistentry>
1410 <term><command>rescue</command></term>
1411
1412 <listitem>
1413 <para>Enter rescue mode. This is mostly equivalent to
1414 <command>isolate rescue.target</command>, but also prints a
1415 wall message to all users.</para>
1416 </listitem>
1417 </varlistentry>
1418 <varlistentry>
1419 <term><command>emergency</command></term>
1420
1421 <listitem>
1422 <para>Enter emergency mode. This is mostly equivalent to
1423 <command>isolate emergency.target</command>, but also prints
1424 a wall message to all users.</para>
1425 </listitem>
1426 </varlistentry>
1427 <varlistentry>
1428 <term><command>halt</command></term>
1429
1430 <listitem>
1431 <para>Shut down and halt the system. This is mostly equivalent to
1432 <command>start halt.target --irreversible</command>, but also
1433 prints a wall message to all users. If combined with
1434 <option>--force</option>, shutdown of all running services is
1435 skipped, however all processes are killed and all file
1436 systems are unmounted or mounted read-only, immediately
1437 followed by the system halt. If <option>--force</option> is
1438 specified twice, the operation is immediately executed
1439 without terminating any processes or unmounting any file
1440 systems. This may result in data loss.</para>
1441 </listitem>
1442 </varlistentry>
1443 <varlistentry>
1444 <term><command>poweroff</command></term>
1445
1446 <listitem>
1447 <para>Shut down and power-off the system. This is mostly
1448 equivalent to <command>start poweroff.target --irreversible</command>,
1449 but also prints a wall message to all users. If combined with
1450 <option>--force</option>, shutdown of all running services is
1451 skipped, however all processes are killed and all file
1452 systems are unmounted or mounted read-only, immediately
1453 followed by the powering off. If <option>--force</option> is
1454 specified twice, the operation is immediately executed
1455 without terminating any processes or unmounting any file
1456 systems. This may result in data loss.</para>
1457 </listitem>
1458 </varlistentry>
1459 <varlistentry>
37185ec8 1460 <term><command>reboot <optional><replaceable>arg</replaceable></optional></command></term>
27722f96
LN
1461
1462 <listitem>
1463 <para>Shut down and reboot the system. This is mostly
1464 equivalent to <command>start reboot.target --irreversible</command>,
1465 but also prints a wall message to all users. If combined with
1466 <option>--force</option>, shutdown of all running services is
1467 skipped, however all processes are killed and all file
1468 systems are unmounted or mounted read-only, immediately
1469 followed by the reboot. If <option>--force</option> is
1470 specified twice, the operation is immediately executed
1471 without terminating any processes or unmounting any file
1472 systems. This may result in data loss.</para>
37185ec8
WC
1473
1474 <para>If the optional argument
1475 <replaceable>arg</replaceable> is given, it will be passed
1476 as the optional argument to the
1477 <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1478 system call. The value is architecture and firmware
1479 specific. As an example, <literal>recovery</literal> might
1480 be used to trigger system recovery, and
1481 <literal>fota</literal> might be used to trigger a
1482 <quote>firmware over the air</quote> update.</para>
27722f96
LN
1483 </listitem>
1484 </varlistentry>
1485 <varlistentry>
1486 <term><command>kexec</command></term>
1487
1488 <listitem>
1489 <para>Shut down and reboot the system via kexec. This is
1490 mostly equivalent to <command>start kexec.target --irreversible</command>,
1491 but also prints a wall message to all users. If combined
1492 with <option>--force</option>, shutdown of all running
1493 services is skipped, however all processes are killed and
1494 all file systems are unmounted or mounted read-only,
1495 immediately followed by the reboot.</para>
1496 </listitem>
1497 </varlistentry>
1498 <varlistentry>
1499 <term><command>exit</command></term>
1500
1501 <listitem>
1502 <para>Ask the systemd manager to quit. This is only
1503 supported for user service managers (i.e. in conjunction
1504 with the <option>--user</option> option) and will fail
1505 otherwise.</para>
1506 </listitem>
1507
1508 </varlistentry>
1509 <varlistentry>
1510 <term><command>suspend</command></term>
1511
1512 <listitem>
1513 <para>Suspend the system. This will trigger activation of
1514 the special <filename>suspend.target</filename> target.
1515 </para>
1516 </listitem>
1517 </varlistentry>
1518 <varlistentry>
1519 <term><command>hibernate</command></term>
1520
1521 <listitem>
1522 <para>Hibernate the system. This will trigger activation of
1523 the special <filename>hibernate.target</filename> target.
1524 </para>
1525 </listitem>
1526 </varlistentry>
1527 <varlistentry>
1528 <term><command>hybrid-sleep</command></term>
1529
1530 <listitem>
1531 <para>Hibernate and suspend the system. This will trigger
1532 activation of the special
1533 <filename>hybrid-sleep.target</filename> target.</para>
1534 </listitem>
1535 </varlistentry>
1536 <varlistentry>
d8fba7c6 1537 <term><command>switch-root <replaceable>ROOT</replaceable> <optional><replaceable>INIT</replaceable></optional></command></term>
27722f96
LN
1538
1539 <listitem>
1540 <para>Switches to a different root directory and executes a
1541 new system manager process below it. This is intended for
1542 usage in initial RAM disks ("initrd"), and will transition
1543 from the initrd's system manager process (a.k.a "init"
1544 process) to the main system manager process. This call takes two
1545 arguments: the directory that is to become the new root directory, and
1546 the path to the new system manager binary below it to
1547 execute as PID 1. If the latter is omitted or the empty
1548 string, a systemd binary will automatically be searched for
1549 and used as init. If the system manager path is omitted or
1550 equal to the empty string, the state of the initrd's system
1551 manager process is passed to the main system manager, which
1552 allows later introspection of the state of the services
1553 involved in the initrd boot.</para>
1554 </listitem>
1555 </varlistentry>
1556 </variablelist>
1557 </refsect2>
4a6022f0 1558
a7c0e5d7
LP
1559 <refsect2>
1560 <title>Parameter Syntax</title>
1561
1e89266b 1562 <para>Unit commands listed above take either a single unit name
e3e0314b
ZJS
1563 (designated as <replaceable>NAME</replaceable>), or multiple
1564 unit specifications (designated as
1565 <replaceable>PATTERN</replaceable>...). In the first case, the
1566 unit name with or without a suffix must be given. If the suffix
1567 is not specified, systemctl will append a suitable suffix,
1568 <literal>.service</literal> by default, and a type-specific
1569 suffix in case of commands which operate only on specific unit
1570 types. For example,
1571 <programlisting># systemctl start sshd</programlisting> and
1572 <programlisting># systemctl start sshd.service</programlisting>
1573 are equivalent, as are
1574 <programlisting># systemctl isolate snapshot-11</programlisting>
1575 and
1576 <programlisting># systemctl isolate snapshot-11.snapshot</programlisting>
1577 Note that (absolute) paths to device nodes are automatically
1578 converted to device unit names, and other (absolute) paths to
1579 mount unit names.
1580 <programlisting># systemctl status /dev/sda
1581# systemctl status /home</programlisting>
1582 are equivalent to:
1583 <programlisting># systemctl status dev-sda.device
1584# systemctl status home.mount</programlisting>
1585 In the second case, shell-style globs will be matched against
73e231ab 1586 currently loaded units; literal unit names, with or without
e3e0314b
ZJS
1587 a suffix, will be treated as in the first case. This means that
1588 literal unit names always refer to exactly one unit, but globs
1589 may match zero units and this is not considered an error.</para>
1590
1591 <para>Glob patterns use
1592 <citerefentry><refentrytitle>fnmatch</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
1593 so normal shell-style globbing rules are used, and
1594 <literal>*</literal>, <literal>?</literal>,
1595 <literal>[]</literal> may be used. See
1596 <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1597 for more details. The patterns are matched against the names of
66f756d4 1598 currently loaded units, and patterns which do not match anything
e3e0314b
ZJS
1599 are silently skipped. For example:
1600 <programlisting># systemctl stop sshd@*.service</programlisting>
1601 will stop all <filename>sshd@.service</filename> instances.
1602 </para>
1603
1604 <para>For unit file commands, the specified
1605 <replaceable>NAME</replaceable> should be the full name of the
1606 unit file, or the absolute path to the unit file:
1607 <programlisting># systemctl enable foo.service</programlisting>
1608 or
1609 <programlisting># systemctl link /path/to/foo.service</programlisting>
1610 </para>
a7c0e5d7
LP
1611 </refsect2>
1612
4a6022f0
ZJS
1613 </refsect1>
1614
1615 <refsect1>
1616 <title>Exit status</title>
1617
7b870f60 1618 <para>On success, 0 is returned, a non-zero failure
4a6022f0
ZJS
1619 code otherwise.</para>
1620 </refsect1>
1621
21ac6ff1 1622 <xi:include href="less-variables.xml" />
4a6022f0
ZJS
1623
1624 <refsect1>
1625 <title>See Also</title>
1626 <para>
1627 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1628 <citerefentry><refentrytitle>systemadm</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1629 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1630 <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1631 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
3fde5f30 1632 <citerefentry><refentrytitle>systemd.resource-management</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
4a6022f0 1633 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
5aded369 1634 <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
4a6022f0 1635 <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>
e3e0314b 1636 <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
4a6022f0
ZJS
1637 </para>
1638 </refsect1>
7874bcd6
LP
1639
1640</refentry>