]>
Commit | Line | Data |
---|---|---|
514094f9 | 1 | <?xml version='1.0'?> |
7874bcd6 | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
681eb9cf FB |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ |
4 | <!ENTITY % entities SYSTEM "custom-entities.ent" > | |
5 | %entities; | |
6 | ]> | |
7874bcd6 LP |
7 | |
8 | <!-- | |
572eb058 | 9 | SPDX-License-Identifier: LGPL-2.1+ |
7874bcd6 LP |
10 | --> |
11 | ||
21ac6ff1 ZJS |
12 | <refentry id="systemctl" |
13 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
7874bcd6 | 14 | |
4a6022f0 ZJS |
15 | <refentryinfo> |
16 | <title>systemctl</title> | |
17 | <productname>systemd</productname> | |
4a6022f0 ZJS |
18 | </refentryinfo> |
19 | ||
20 | <refmeta> | |
21 | <refentrytitle>systemctl</refentrytitle> | |
22 | <manvolnum>1</manvolnum> | |
23 | </refmeta> | |
24 | ||
25 | <refnamediv> | |
26 | <refname>systemctl</refname> | |
27 | <refpurpose>Control the systemd system and service manager</refpurpose> | |
28 | </refnamediv> | |
29 | ||
30 | <refsynopsisdiv> | |
31 | <cmdsynopsis> | |
32 | <command>systemctl</command> | |
33 | <arg choice="opt" rep="repeat">OPTIONS</arg> | |
34 | <arg choice="plain">COMMAND</arg> | |
da5e955f | 35 | <arg choice="opt" rep="repeat">UNIT</arg> |
4a6022f0 ZJS |
36 | </cmdsynopsis> |
37 | </refsynopsisdiv> | |
38 | ||
39 | <refsect1> | |
40 | <title>Description</title> | |
41 | ||
a4390b6b LP |
42 | <para><command>systemctl</command> may be used to introspect and |
43 | control the state of the <literal>systemd</literal> system and | |
44 | service manager. Please refer to | |
4a6022f0 | 45 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> |
a4390b6b LP |
46 | for an introduction into the basic concepts and functionality this |
47 | tool manages.</para> | |
4a6022f0 ZJS |
48 | </refsect1> |
49 | ||
50 | <refsect1> | |
51 | <title>Options</title> | |
52 | ||
53 | <para>The following options are understood:</para> | |
54 | ||
55 | <variablelist> | |
4a6022f0 ZJS |
56 | <varlistentry> |
57 | <term><option>-t</option></term> | |
58 | <term><option>--type=</option></term> | |
59 | ||
60 | <listitem> | |
e9dd9f95 | 61 | <para>The argument should be a comma-separated list of unit |
20b3f379 | 62 | types such as <option>service</option> and |
9b9b3d36 MW |
63 | <option>socket</option>. |
64 | </para> | |
20b3f379 ZJS |
65 | |
66 | <para>If one of the arguments is a unit type, when listing | |
7b870f60 | 67 | units, limit display to certain unit types. Otherwise, units |
4a6022f0 ZJS |
68 | of all types will be shown.</para> |
69 | ||
20b3f379 | 70 | <para>As a special case, if one of the arguments is |
4a6022f0 ZJS |
71 | <option>help</option>, a list of allowed values will be |
72 | printed and the program will exit.</para> | |
73 | </listitem> | |
74 | </varlistentry> | |
75 | ||
9b9b3d36 MW |
76 | <varlistentry> |
77 | <term><option>--state=</option></term> | |
78 | ||
79 | <listitem> | |
e16972e6 ZJS |
80 | <para>The argument should be a comma-separated list of unit |
81 | LOAD, SUB, or ACTIVE states. When listing units, show only | |
a8eaaee7 | 82 | those in the specified states. Use <option>--state=failed</option> |
e16972e6 ZJS |
83 | to show only failed units.</para> |
84 | ||
85 | <para>As a special case, if one of the arguments is | |
86 | <option>help</option>, a list of allowed values will be | |
87 | printed and the program will exit.</para> | |
9b9b3d36 MW |
88 | </listitem> |
89 | </varlistentry> | |
90 | ||
4a6022f0 ZJS |
91 | <varlistentry> |
92 | <term><option>-p</option></term> | |
93 | <term><option>--property=</option></term> | |
94 | ||
95 | <listitem> | |
54c31a79 | 96 | <para>When showing unit/job/manager properties with the |
ea539eb6 ZJS |
97 | <command>show</command> command, limit display to properties |
98 | specified in the argument. The argument should be a | |
d2bbca68 | 99 | comma-separated list of property names, such as |
ea539eb6 ZJS |
100 | <literal>MainPID</literal>. Unless specified, all known |
101 | properties are shown. If specified more than once, all | |
102 | properties with the specified names are shown. Shell | |
103 | completion is implemented for property names.</para> | |
104 | ||
105 | <para>For the manager itself, | |
106 | <command>systemctl show</command> will show all available | |
107 | properties. Those properties are documented in | |
108 | <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
109 | </para> | |
110 | ||
111 | <para>Properties for units vary by unit type, so showing any | |
112 | unit (even a non-existent one) is a way to list properties | |
b938cb90 | 113 | pertaining to this type. Similarly, showing any job will list |
ea539eb6 ZJS |
114 | properties pertaining to all jobs. Properties for units are |
115 | documented in | |
116 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
117 | and the pages for individual unit types | |
118 | <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
119 | <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
120 | etc.</para> | |
4a6022f0 ZJS |
121 | </listitem> |
122 | </varlistentry> | |
123 | ||
124 | <varlistentry> | |
125 | <term><option>-a</option></term> | |
126 | <term><option>--all</option></term> | |
127 | ||
128 | <listitem> | |
21b587cf ZJS |
129 | <para>When listing units with <command>list-units</command>, also show inactive units and |
130 | units which are following other units. When showing unit/job/manager properties, show all | |
131 | properties regardless whether they are set or not.</para> | |
132 | ||
133 | <para>To list all units installed in the file system, use the | |
a5e4972c | 134 | <command>list-unit-files</command> command instead.</para> |
e9fbae3f ZJS |
135 | |
136 | <para>When listing units with <command>list-dependencies</command>, recursively show | |
137 | dependencies of all dependent units (by default only dependencies of target units are | |
138 | shown).</para> | |
4fa226ff LW |
139 | |
140 | <para>When used with <command>status</command>, show journal messages in full, even if they include | |
141 | unprintable characters or are very long. By default, fields with unprintable characters are | |
142 | abbreviated as "blob data". (Note that the pager may escape unprintable characters again.)</para> | |
4a6022f0 ZJS |
143 | </listitem> |
144 | </varlistentry> | |
145 | ||
1238ee09 LP |
146 | <varlistentry> |
147 | <term><option>-r</option></term> | |
148 | <term><option>--recursive</option></term> | |
149 | ||
150 | <listitem> | |
151 | <para>When listing units, also show units of local | |
152 | containers. Units of local containers will be prefixed with | |
153 | the container name, separated by a single colon character | |
154 | (<literal>:</literal>).</para> | |
155 | </listitem> | |
156 | </varlistentry> | |
157 | ||
afba4199 ZJS |
158 | <varlistentry> |
159 | <term><option>--reverse</option></term> | |
160 | ||
161 | <listitem> | |
162 | <para>Show reverse dependencies between units with | |
f6375e83 ZJS |
163 | <command>list-dependencies</command>, i.e. follow |
164 | dependencies of type <varname>WantedBy=</varname>, | |
165 | <varname>RequiredBy=</varname>, | |
f6375e83 ZJS |
166 | <varname>PartOf=</varname>, <varname>BoundBy=</varname>, |
167 | instead of <varname>Wants=</varname> and similar. | |
afba4199 ZJS |
168 | </para> |
169 | </listitem> | |
170 | </varlistentry> | |
171 | ||
172 | <varlistentry> | |
173 | <term><option>--after</option></term> | |
9029f642 JSJ |
174 | |
175 | <listitem> | |
176 | <para>With <command>list-dependencies</command>, show the | |
177 | units that are ordered before the specified unit. In other | |
f6375e83 ZJS |
178 | words, recursively list units following the |
179 | <varname>After=</varname> dependency.</para> | |
180 | ||
181 | <para>Note that any <varname>After=</varname> dependency is | |
182 | automatically mirrored to create a | |
183 | <varname>Before=</varname> dependency. Temporal dependencies | |
922d948b | 184 | may be specified explicitly, but are also created implicitly |
f6375e83 ZJS |
185 | for units which are <varname>WantedBy=</varname> targets |
186 | (see | |
187 | <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>), | |
188 | and as a result of other directives (for example | |
189 | <varname>RequiresMountsFor=</varname>). Both explicitly | |
190 | and implicitly introduced dependencies are shown with | |
191 | <command>list-dependencies</command>.</para> | |
82948f6c LP |
192 | |
193 | <para>When passed to the <command>list-jobs</command> command, for each printed job show which other jobs are | |
194 | waiting for it. May be combined with <option>--before</option> to show both the jobs waiting for each job as | |
195 | well as all jobs each job is waiting for.</para> | |
9029f642 JSJ |
196 | </listitem> |
197 | </varlistentry> | |
198 | ||
199 | <varlistentry> | |
afba4199 ZJS |
200 | <term><option>--before</option></term> |
201 | ||
202 | <listitem> | |
9029f642 JSJ |
203 | <para>With <command>list-dependencies</command>, show the |
204 | units that are ordered after the specified unit. In other | |
f6375e83 ZJS |
205 | words, recursively list units following the |
206 | <varname>Before=</varname> dependency.</para> | |
82948f6c LP |
207 | |
208 | <para>When passed to the <command>list-jobs</command> command, for each printed job show which other jobs it | |
209 | is waiting for. May be combined with <option>--after</option> to show both the jobs waiting for each job as | |
210 | well as all jobs each job is waiting for.</para> | |
afba4199 ZJS |
211 | </listitem> |
212 | </varlistentry> | |
213 | ||
4a6022f0 | 214 | <varlistentry> |
98a6e132 | 215 | <term><option>-l</option></term> |
4a6022f0 ZJS |
216 | <term><option>--full</option></term> |
217 | ||
218 | <listitem> | |
69d918b0 ZJS |
219 | <para>Do not ellipsize unit names, process tree entries, |
220 | journal output, or truncate unit descriptions in the output | |
221 | of <command>status</command>, <command>list-units</command>, | |
222 | <command>list-jobs</command>, and | |
223 | <command>list-timers</command>.</para> | |
3b3557c4 JS |
224 | <para>Also, show installation targets in the output of |
225 | <command>is-enabled</command>.</para> | |
4a6022f0 ZJS |
226 | </listitem> |
227 | </varlistentry> | |
228 | ||
4f9a9105 ZJS |
229 | <varlistentry> |
230 | <term><option>--value</option></term> | |
231 | ||
232 | <listitem> | |
233 | <para>When printing properties with <command>show</command>, | |
234 | only print the value, and skip the property name and | |
235 | <literal>=</literal>.</para> | |
236 | </listitem> | |
237 | </varlistentry> | |
238 | ||
991f2a39 ZJS |
239 | <varlistentry> |
240 | <term><option>--show-types</option></term> | |
241 | ||
242 | <listitem> | |
243 | <para>When showing sockets, show the type of the socket.</para> | |
244 | </listitem> | |
245 | </varlistentry> | |
246 | ||
23ade460 | 247 | <varlistentry> |
4dc5b821 | 248 | <term><option>--job-mode=</option></term> |
23ade460 MS |
249 | |
250 | <listitem> | |
e0e009c0 JE |
251 | <para>When queuing a new job, this option controls how to deal with |
252 | already queued jobs. It takes one of <literal>fail</literal>, | |
4dc5b821 LP |
253 | <literal>replace</literal>, |
254 | <literal>replace-irreversibly</literal>, | |
255 | <literal>isolate</literal>, | |
256 | <literal>ignore-dependencies</literal>, | |
257 | <literal>ignore-requirements</literal> or | |
258 | <literal>flush</literal>. Defaults to | |
259 | <literal>replace</literal>, except when the | |
260 | <command>isolate</command> command is used which implies the | |
261 | <literal>isolate</literal> job mode.</para> | |
262 | ||
263 | <para>If <literal>fail</literal> is specified and a requested | |
264 | operation conflicts with a pending job (more specifically: | |
265 | causes an already pending start job to be reversed into a stop | |
266 | job or vice versa), cause the operation to fail.</para> | |
267 | ||
268 | <para>If <literal>replace</literal> (the default) is | |
269 | specified, any conflicting pending job will be replaced, as | |
270 | necessary.</para> | |
271 | ||
272 | <para>If <literal>replace-irreversibly</literal> is specified, | |
273 | operate like <literal>replace</literal>, but also mark the new | |
274 | jobs as irreversible. This prevents future conflicting | |
9a92e77e DS |
275 | transactions from replacing these jobs (or even being enqueued |
276 | while the irreversible jobs are still pending). Irreversible | |
277 | jobs can still be cancelled using the <command>cancel</command> | |
d60cb656 AJ |
278 | command. This job mode should be used on any transaction which |
279 | pulls in <filename>shutdown.target</filename>.</para> | |
4dc5b821 LP |
280 | |
281 | <para><literal>isolate</literal> is only valid for start | |
282 | operations and causes all other units to be stopped when the | |
283 | specified unit is started. This mode is always used when the | |
284 | <command>isolate</command> command is used.</para> | |
285 | ||
286 | <para><literal>flush</literal> will cause all queued jobs to | |
287 | be canceled when the new job is enqueued.</para> | |
288 | ||
289 | <para>If <literal>ignore-dependencies</literal> is specified, | |
290 | then all unit dependencies are ignored for this new job and | |
291 | the operation is executed immediately. If passed, no required | |
292 | units of the unit passed will be pulled in, and no ordering | |
293 | dependencies will be honored. This is mostly a debugging and | |
294 | rescue tool for the administrator and should not be used by | |
295 | applications.</para> | |
296 | ||
297 | <para><literal>ignore-requirements</literal> is similar to | |
b040723e | 298 | <literal>ignore-dependencies</literal>, but only causes the |
4dc5b821 | 299 | requirement dependencies to be ignored, the ordering |
2dd67817 | 300 | dependencies will still be honored.</para> |
23ade460 | 301 | </listitem> |
4a6022f0 | 302 | |
4a6022f0 ZJS |
303 | </varlistentry> |
304 | ||
ac5e3a50 JS |
305 | <varlistentry> |
306 | <term><option>--fail</option></term> | |
307 | ||
308 | <listitem> | |
309 | <para>Shorthand for <option>--job-mode=</option>fail.</para> | |
310 | <para>When used with the <command>kill</command> command, | |
311 | if no units were killed, the operation results in an error. | |
312 | </para> | |
313 | </listitem> | |
314 | </varlistentry> | |
315 | ||
4a6022f0 ZJS |
316 | <varlistentry> |
317 | <term><option>-i</option></term> | |
318 | <term><option>--ignore-inhibitors</option></term> | |
319 | ||
320 | <listitem> | |
81d39f0d LP |
321 | <para>When system shutdown or a sleep state is requested, ignore inhibitor locks. Applications can establish |
322 | inhibitor locks to avoid that certain important operations (such as CD burning or suchlike) are interrupted | |
323 | by system shutdown or a sleep state. Any user may take these locks and privileged users may override these | |
324 | locks. If any locks are taken, shutdown and sleep state requests will normally fail (unless privileged) and a | |
325 | list of active locks is printed. However, if <option>--ignore-inhibitors</option> is specified, the | |
326 | established locks are ignored and not shown, and the operation attempted anyway, possibly requiring | |
327 | additional privileges.</para> | |
4a6022f0 ZJS |
328 | </listitem> |
329 | </varlistentry> | |
330 | ||
1ae17672 ZJS |
331 | <varlistentry> |
332 | <term><option>--dry-run</option></term> | |
333 | ||
334 | <listitem> | |
335 | <para>Just print what would be done. Currently supported by verbs | |
336 | <command>halt</command>, <command>poweroff</command>, <command>reboot</command>, | |
6cc2b882 JD |
337 | <command>kexec</command>, <command>suspend</command>, <command>hibernate</command>, |
338 | <command>hybrid-sleep</command>, <command>suspend-then-hibernate</command>, | |
1ae17672 ZJS |
339 | <command>default</command>, <command>rescue</command>, |
340 | <command>emergency</command>, and <command>exit</command>.</para> | |
341 | </listitem> | |
342 | </varlistentry> | |
343 | ||
4a6022f0 ZJS |
344 | <varlistentry> |
345 | <term><option>-q</option></term> | |
346 | <term><option>--quiet</option></term> | |
347 | ||
348 | <listitem> | |
bbd46aad ZJS |
349 | <para>Suppress printing of the results of various commands |
350 | and also the hints about truncated log lines. This does not | |
351 | suppress output of commands for which the printed output is | |
352 | the only result (like <command>show</command>). Errors are | |
353 | always printed.</para> | |
4a6022f0 ZJS |
354 | </listitem> |
355 | </varlistentry> | |
356 | ||
357 | <varlistentry> | |
358 | <term><option>--no-block</option></term> | |
359 | ||
360 | <listitem> | |
361 | <para>Do not synchronously wait for the requested operation | |
7b870f60 | 362 | to finish. If this is not specified, the job will be |
4a6022f0 | 363 | verified, enqueued and <command>systemctl</command> will |
3d161f99 | 364 | wait until the unit's start-up is completed. By passing this |
93a08841 MP |
365 | argument, it is only verified and enqueued. This option may not be |
366 | combined with <option>--wait</option>.</para> | |
367 | </listitem> | |
368 | </varlistentry> | |
369 | ||
370 | <varlistentry> | |
371 | <term><option>--wait</option></term> | |
372 | ||
373 | <listitem> | |
374 | <para>Synchronously wait for started units to terminate again. | |
375 | This option may not be combined with <option>--no-block</option>. | |
376 | Note that this will wait forever if any given unit never terminates | |
377 | (by itself or by getting stopped explicitly); particularly services | |
378 | which use <literal>RemainAfterExit=yes</literal>.</para> | |
adb6cd9b FB |
379 | |
380 | <para>When used with <command>is-system-running</command>, wait | |
381 | until the boot process is completed before returning.</para> | |
4a6022f0 ZJS |
382 | </listitem> |
383 | </varlistentry> | |
384 | ||
88ae7333 ZJS |
385 | <xi:include href="user-system-options.xml" xpointer="user" /> |
386 | <xi:include href="user-system-options.xml" xpointer="system" /> | |
4a6022f0 | 387 | |
bef19548 ZJS |
388 | <varlistentry> |
389 | <term><option>--failed</option></term> | |
390 | ||
391 | <listitem> | |
392 | <para>List units in failed state. This is equivalent to | |
393 | <option>--state=failed</option>.</para> | |
394 | </listitem> | |
395 | </varlistentry> | |
599b6322 | 396 | |
4a6022f0 ZJS |
397 | <varlistentry> |
398 | <term><option>--no-wall</option></term> | |
399 | ||
400 | <listitem> | |
6324a8a7 | 401 | <para>Do not send wall message before halt, power-off and reboot.</para> |
4a6022f0 ZJS |
402 | </listitem> |
403 | </varlistentry> | |
404 | ||
405 | <varlistentry> | |
406 | <term><option>--global</option></term> | |
407 | ||
408 | <listitem> | |
409 | <para>When used with <command>enable</command> and | |
410 | <command>disable</command>, operate on the global user | |
411 | configuration directory, thus enabling or disabling a unit | |
412 | file globally for all future logins of all users.</para> | |
413 | </listitem> | |
414 | </varlistentry> | |
415 | ||
416 | <varlistentry> | |
417 | <term><option>--no-reload</option></term> | |
418 | ||
419 | <listitem> | |
420 | <para>When used with <command>enable</command> and | |
421 | <command>disable</command>, do not implicitly reload daemon | |
422 | configuration after executing the changes.</para> | |
423 | </listitem> | |
424 | </varlistentry> | |
425 | ||
426 | <varlistentry> | |
427 | <term><option>--no-ask-password</option></term> | |
428 | ||
429 | <listitem> | |
430 | <para>When used with <command>start</command> and related | |
431 | commands, disables asking for passwords. Background services | |
432 | may require input of a password or passphrase string, for | |
433 | example to unlock system hard disks or cryptographic | |
434 | certificates. Unless this option is specified and the | |
7b870f60 | 435 | command is invoked from a terminal, |
4a6022f0 ZJS |
436 | <command>systemctl</command> will query the user on the |
437 | terminal for the necessary secrets. Use this option to | |
7b870f60 | 438 | switch this behavior off. In this case, the password must be |
4a6022f0 ZJS |
439 | supplied by some other means (for example graphical password |
440 | agents) or the service might fail. This also disables | |
441 | querying the user for authentication for privileged | |
442 | operations.</para> | |
443 | </listitem> | |
4a6022f0 ZJS |
444 | </varlistentry> |
445 | ||
446 | <varlistentry> | |
447 | <term><option>--kill-who=</option></term> | |
448 | ||
449 | <listitem> | |
450 | <para>When used with <command>kill</command>, choose which | |
af7424af LP |
451 | processes to send a signal to. Must be one of |
452 | <option>main</option>, <option>control</option> or | |
453 | <option>all</option> to select whether to kill only the main | |
454 | process, the control process or all processes of the | |
455 | unit. The main process of the unit is the one that defines | |
456 | the life-time of it. A control process of a unit is one that | |
457 | is invoked by the manager to induce state changes of it. For | |
458 | example, all processes started due to the | |
459 | <varname>ExecStartPre=</varname>, | |
460 | <varname>ExecStop=</varname> or | |
461 | <varname>ExecReload=</varname> settings of service units are | |
462 | control processes. Note that there is only one control | |
463 | process per unit at a time, as only one state change is | |
464 | executed at a time. For services of type | |
b8bde116 | 465 | <varname>Type=forking</varname>, the initial process started |
af7424af LP |
466 | by the manager for <varname>ExecStart=</varname> is a |
467 | control process, while the process ultimately forked off by | |
468 | that one is then considered the main process of the unit (if | |
469 | it can be determined). This is different for service units | |
470 | of other types, where the process forked off by the manager | |
471 | for <varname>ExecStart=</varname> is always the main process | |
b8bde116 JE |
472 | itself. A service unit consists of zero or one main process, |
473 | zero or one control process plus any number of additional | |
af7424af | 474 | processes. Not all unit types manage processes of these |
b8bde116 | 475 | types however. For example, for mount units, control processes |
af7424af | 476 | are defined (which are the invocations of |
d31dd62b FB |
477 | <filename>&MOUNT_PATH;</filename> and |
478 | <filename>&UMOUNT_PATH;</filename>), but no main process | |
af7424af LP |
479 | is defined. If omitted, defaults to |
480 | <option>all</option>.</para> | |
4a6022f0 ZJS |
481 | </listitem> |
482 | ||
483 | </varlistentry> | |
484 | ||
485 | <varlistentry> | |
486 | <term><option>-s</option></term> | |
487 | <term><option>--signal=</option></term> | |
488 | ||
489 | <listitem> | |
490 | <para>When used with <command>kill</command>, choose which | |
491 | signal to send to selected processes. Must be one of the | |
b938cb90 | 492 | well-known signal specifiers such as <constant>SIGTERM</constant>, <constant>SIGINT</constant> or |
7b870f60 | 493 | <constant>SIGSTOP</constant>. If omitted, defaults to |
4a6022f0 ZJS |
494 | <option>SIGTERM</option>.</para> |
495 | </listitem> | |
496 | </varlistentry> | |
497 | ||
498 | <varlistentry> | |
499 | <term><option>-f</option></term> | |
500 | <term><option>--force</option></term> | |
501 | ||
502 | <listitem> | |
503 | <para>When used with <command>enable</command>, overwrite | |
504 | any existing conflicting symlinks.</para> | |
505 | ||
39c38ce1 DC |
506 | <para>When used with <command>edit</command>, create all of the |
507 | specified units which do not already exist.</para> | |
508 | ||
924e44b4 LP |
509 | <para>When used with <command>halt</command>, <command>poweroff</command>, <command>reboot</command> or |
510 | <command>kexec</command>, execute the selected operation without shutting down all units. However, all | |
511 | processes will be killed forcibly and all file systems are unmounted or remounted read-only. This is hence a | |
512 | drastic but relatively safe option to request an immediate reboot. If <option>--force</option> is specified | |
513 | twice for these operations (with the exception of <command>kexec</command>), they will be executed | |
514 | immediately, without terminating any processes or unmounting any file systems. Warning: specifying | |
515 | <option>--force</option> twice with any of these operations might result in data loss. Note that when | |
516 | <option>--force</option> is specified twice the selected operation is executed by | |
517 | <command>systemctl</command> itself, and the system manager is not contacted. This means the command should | |
6324a8a7 | 518 | succeed even when the system manager has crashed.</para> |
4a6022f0 ZJS |
519 | </listitem> |
520 | </varlistentry> | |
521 | ||
9ef15026 JS |
522 | <varlistentry> |
523 | <term><option>--message=</option></term> | |
524 | ||
525 | <listitem> | |
6324a8a7 LP |
526 | <para>When used with <command>halt</command>, <command>poweroff</command> or <command>reboot</command>, set a |
527 | short message explaining the reason for the operation. The message will be logged together with the default | |
528 | shutdown message.</para> | |
9ef15026 JS |
529 | </listitem> |
530 | </varlistentry> | |
531 | ||
57ab2eab JS |
532 | <varlistentry> |
533 | <term><option>--now</option></term> | |
534 | ||
535 | <listitem> | |
536 | <para>When used with <command>enable</command>, the units | |
537 | will also be started. When used with <command>disable</command> or | |
538 | <command>mask</command>, the units will also be stopped. The start | |
539 | or stop operation is only carried out when the respective enable or | |
540 | disable operation has been successful.</para> | |
541 | </listitem> | |
542 | </varlistentry> | |
543 | ||
4a6022f0 ZJS |
544 | <varlistentry> |
545 | <term><option>--root=</option></term> | |
546 | ||
547 | <listitem> | |
548 | <para>When used with | |
549 | <command>enable</command>/<command>disable</command>/<command>is-enabled</command> | |
9b914a9d ZJS |
550 | (and related commands), use the specified root path when looking for unit |
551 | files. If this option is present, <command>systemctl</command> will operate on | |
552 | the file system directly, instead of communicating with the <command>systemd</command> | |
553 | daemon to carry out changes.</para> | |
4a6022f0 ZJS |
554 | </listitem> |
555 | ||
556 | </varlistentry> | |
557 | ||
558 | <varlistentry> | |
559 | <term><option>--runtime</option></term> | |
560 | ||
561 | <listitem> | |
1830ac51 MB |
562 | <para>When used with <command>enable</command>, |
563 | <command>disable</command>, <command>edit</command>, | |
564 | (and related commands), make changes only temporarily, so | |
565 | that they are lost on the next reboot. This will have the | |
566 | effect that changes are not made in subdirectories of | |
567 | <filename>/etc</filename> but in <filename>/run</filename>, | |
568 | with identical immediate effects, however, since the latter | |
4a6022f0 | 569 | is lost on reboot, the changes are lost too.</para> |
a330b376 | 570 | |
1830ac51 MB |
571 | <para>Similarly, when used with |
572 | <command>set-property</command>, make changes only | |
573 | temporarily, so that they are lost on the next | |
574 | reboot.</para> | |
4a6022f0 ZJS |
575 | </listitem> |
576 | </varlistentry> | |
577 | ||
d309c1c3 LP |
578 | <varlistentry> |
579 | <term><option>--preset-mode=</option></term> | |
580 | ||
581 | <listitem> | |
582 | <para>Takes one of <literal>full</literal> (the default), | |
583 | <literal>enable-only</literal>, | |
8d0e0ddd | 584 | <literal>disable-only</literal>. When used with the |
d309c1c3 | 585 | <command>preset</command> or <command>preset-all</command> |
8d0e0ddd | 586 | commands, controls whether units shall be disabled and |
d309c1c3 LP |
587 | enabled according to the preset rules, or only enabled, or |
588 | only disabled.</para> | |
589 | </listitem> | |
590 | </varlistentry> | |
591 | ||
4a6022f0 ZJS |
592 | <varlistentry> |
593 | <term><option>-n</option></term> | |
594 | <term><option>--lines=</option></term> | |
595 | ||
596 | <listitem> | |
d5bf4f9b LW |
597 | <para>When used with <command>status</command>, controls the number of journal lines to show, counting from |
598 | the most recent ones. Takes a positive integer argument, or 0 to disable journal output. Defaults to | |
4a6022f0 ZJS |
599 | 10.</para> |
600 | </listitem> | |
601 | </varlistentry> | |
602 | ||
603 | <varlistentry> | |
604 | <term><option>-o</option></term> | |
605 | <term><option>--output=</option></term> | |
606 | ||
607 | <listitem> | |
7b870f60 | 608 | <para>When used with <command>status</command>, controls the |
4a6022f0 | 609 | formatting of the journal entries that are shown. For the |
7b870f60 | 610 | available choices, see |
4a6022f0 ZJS |
611 | <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>. |
612 | Defaults to <literal>short</literal>.</para> | |
613 | </listitem> | |
614 | </varlistentry> | |
615 | ||
5bdf2243 JJ |
616 | <varlistentry> |
617 | <term><option>--firmware-setup</option></term> | |
618 | ||
619 | <listitem> | |
97af80c5 LP |
620 | <para>When used with the <command>reboot</command> command, indicate to the system's firmware to reboot into |
621 | the firmware setup interface. Note that this functionality is not available on all systems.</para> | |
622 | </listitem> | |
623 | </varlistentry> | |
624 | ||
625 | <varlistentry> | |
626 | <term><option>--boot-loader-menu=</option></term> | |
627 | ||
628 | <listitem> | |
629 | <para>When used with the <command>reboot</command> command, indicate to the system's boot loader to show the | |
630 | boot loader menu on the following boot. Takes a time value as parameter — indicating the menu time-out. Pass | |
631 | zero in order to disable the menu time-out. Note that not all boot loaders support this | |
632 | functionality.</para> | |
633 | </listitem> | |
634 | </varlistentry> | |
635 | ||
636 | <varlistentry> | |
637 | <term><option>--boot-loader-entry=</option></term> | |
638 | ||
639 | <listitem> | |
640 | <para>When used with the <command>reboot</command> command, indicate to the system's boot loader to boot into | |
641 | a specific boot loader entry on the following boot. Takes a boot loader entry identifier as argument, or | |
642 | <literal>help</literal> in order to list available entries. Note that not all boot loaders support this | |
643 | functionality.</para> | |
5bdf2243 JJ |
644 | </listitem> |
645 | </varlistentry> | |
646 | ||
5d0c05e5 LN |
647 | <varlistentry> |
648 | <term><option>--plain</option></term> | |
649 | ||
650 | <listitem> | |
7b870f60 | 651 | <para>When used with <command>list-dependencies</command>, |
831d3dc8 | 652 | <command>list-units</command> or <command>list-machines</command>, |
a20e43c0 MT |
653 | the output is printed as a list instead of a tree, and the bullet |
654 | circles are omitted.</para> | |
5d0c05e5 LN |
655 | </listitem> |
656 | </varlistentry> | |
657 | ||
4f50d2ef ZJS |
658 | <xi:include href="user-system-options.xml" xpointer="host" /> |
659 | <xi:include href="user-system-options.xml" xpointer="machine" /> | |
660 | ||
12f15e59 ZJS |
661 | <xi:include href="standard-options.xml" xpointer="no-pager" /> |
662 | <xi:include href="standard-options.xml" xpointer="no-legend" /> | |
dfdebb1b ZJS |
663 | <xi:include href="standard-options.xml" xpointer="help" /> |
664 | <xi:include href="standard-options.xml" xpointer="version" /> | |
4a6022f0 ZJS |
665 | </variablelist> |
666 | </refsect1> | |
667 | ||
668 | <refsect1> | |
669 | <title>Commands</title> | |
670 | ||
671 | <para>The following commands are understood:</para> | |
672 | ||
27722f96 LN |
673 | <refsect2> |
674 | <title>Unit Commands</title> | |
4a6022f0 | 675 | |
27722f96 LN |
676 | <variablelist> |
677 | <varlistentry> | |
e92b3655 | 678 | <term><command>list-units</command> <optional><replaceable>PATTERN</replaceable>…</optional></term> |
4a6022f0 | 679 | |
27722f96 | 680 | <listitem> |
2cdbbc9a LP |
681 | <para>List units that <command>systemd</command> currently has in memory. This includes units that are |
682 | either referenced directly or through a dependency, units that are pinned by applications programmatically, | |
683 | or units that were active in the past and have failed. By default only units which are active, have pending | |
684 | jobs, or have failed are shown; this can be changed with option <option>--all</option>. If one or more | |
05a98afd LP |
685 | <replaceable>PATTERN</replaceable>s are specified, only units matching one of them are shown. The units |
686 | that are shown are additionally filtered by <option>--type=</option> and <option>--state=</option> if those | |
687 | options are specified.</para> | |
991f2a39 | 688 | |
6fdbb3c8 ZJS |
689 | <para>Produces output similar to |
690 | <programlisting> UNIT LOAD ACTIVE SUB DESCRIPTION | |
691 | sys-module-fuse.device loaded active plugged /sys/module/fuse | |
692 | -.mount loaded active mounted Root Mount | |
693 | boot-efi.mount loaded active mounted /boot/efi | |
694 | systemd-journald.service loaded active running Journal Service | |
695 | systemd-logind.service loaded active running Login Service | |
f07b5489 ZJS |
696 | ● user@1000.service loaded failed failed User Manager for UID 1000 |
697 | … | |
6fdbb3c8 ZJS |
698 | systemd-tmpfiles-clean.timer loaded active waiting Daily Cleanup of Temporary Directories |
699 | ||
700 | LOAD = Reflects whether the unit definition was properly loaded. | |
701 | ACTIVE = The high-level unit activation state, i.e. generalization of SUB. | |
702 | SUB = The low-level unit activation state, values depend on unit type. | |
703 | ||
704 | 123 loaded units listed. Pass --all to see loaded but inactive units, too. | |
705 | To show all installed unit files use 'systemctl list-unit-files'. | |
706 | </programlisting> | |
707 | The header and the last unit of a given type are underlined if the | |
708 | terminal supports that. A colored dot is shown next to services which | |
709 | were masked, not found, or otherwise failed.</para> | |
710 | ||
443dee9d | 711 | <para>The LOAD column shows the load state, one of <constant>loaded</constant>, |
c4555ad8 LP |
712 | <constant>not-found</constant>, <constant>bad-setting</constant>, <constant>error</constant>, |
713 | <constant>masked</constant>. The ACTIVE columns shows the general unit state, one of | |
714 | <constant>active</constant>, <constant>reloading</constant>, <constant>inactive</constant>, | |
715 | <constant>failed</constant>, <constant>activating</constant>, <constant>deactivating</constant>. The SUB | |
716 | column shows the unit-type-specific detailed state of the unit, possible values vary by unit type. The list | |
717 | of possible LOAD, ACTIVE, and SUB states is not constant and new systemd releases may both add and remove | |
718 | values. <programlisting>systemctl --state=help</programlisting> command maybe be used to display the | |
719 | current set of possible values.</para> | |
6fdbb3c8 | 720 | |
27722f96 LN |
721 | <para>This is the default command.</para> |
722 | </listitem> | |
723 | </varlistentry> | |
991f2a39 | 724 | |
27722f96 | 725 | <varlistentry> |
e92b3655 | 726 | <term><command>list-sockets</command> <optional><replaceable>PATTERN</replaceable>…</optional></term> |
27722f96 LN |
727 | |
728 | <listitem> | |
2cdbbc9a LP |
729 | <para>List socket units currently in memory, ordered by listening address. If one or more |
730 | <replaceable>PATTERN</replaceable>s are specified, only socket units matching one of them are | |
d8fba7c6 | 731 | shown. Produces output similar to |
27722f96 | 732 | <programlisting> |
991f2a39 ZJS |
733 | LISTEN UNIT ACTIVATES |
734 | /dev/initctl systemd-initctl.socket systemd-initctl.service | |
1eecafb8 | 735 | … |
991f2a39 ZJS |
736 | [::]:22 sshd.socket sshd.service |
737 | kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service | |
738 | ||
9fccdb0f | 739 | 5 sockets listed.</programlisting> |
27722f96 LN |
740 | Note: because the addresses might contains spaces, this output |
741 | is not suitable for programmatic consumption. | |
742 | </para> | |
743 | ||
2cdbbc9a | 744 | <para>Also see <option>--show-types</option>, <option>--all</option>, and <option>--state=</option>.</para> |
27722f96 LN |
745 | </listitem> |
746 | </varlistentry> | |
747 | ||
cbb76c29 | 748 | <varlistentry> |
e92b3655 | 749 | <term><command>list-timers</command> <optional><replaceable>PATTERN</replaceable>…</optional></term> |
cbb76c29 LP |
750 | |
751 | <listitem> | |
2cdbbc9a LP |
752 | <para>List timer units currently in memory, ordered by the time they elapse next. If one or more |
753 | <replaceable>PATTERN</replaceable>s are specified, only units matching one of them are shown. | |
3c3fff44 | 754 | Produces output similar to |
ccdda955 MS |
755 | <programlisting> |
756 | NEXT LEFT LAST PASSED UNIT ACTIVATES | |
757 | n/a n/a Thu 2017-02-23 13:40:29 EST 3 days ago ureadahead-stop.timer ureadahead-stop.service | |
758 | Sun 2017-02-26 18:55:42 EST 1min 14s left Thu 2017-02-23 13:54:44 EST 3 days ago systemd-tmpfiles-clean.timer systemd-tmpfiles-clean.service | |
759 | Sun 2017-02-26 20:37:16 EST 1h 42min left Sun 2017-02-26 11:56:36 EST 6h ago apt-daily.timer apt-daily.service | |
760 | Sun 2017-02-26 20:57:49 EST 2h 3min left Sun 2017-02-26 11:56:36 EST 6h ago snapd.refresh.timer snapd.refresh.service | |
761 | </programlisting> | |
d8fba7c6 | 762 | </para> |
cbb76c29 | 763 | |
ccdda955 MS |
764 | <para><emphasis>NEXT</emphasis> shows the next time the timer will run.</para> |
765 | <para><emphasis>LEFT</emphasis> shows how long till the next time the timer runs.</para> | |
766 | <para><emphasis>LAST</emphasis> shows the last time the timer ran.</para> | |
7456fa02 | 767 | <para><emphasis>PASSED</emphasis> shows how long has passed since the timer last ran.</para> |
ccdda955 | 768 | <para><emphasis>UNIT</emphasis> shows the name of the timer</para> |
785889e5 | 769 | <para><emphasis>ACTIVATES</emphasis> shows the name the service the timer activates when it runs.</para> |
ccdda955 | 770 | |
2cdbbc9a | 771 | <para>Also see <option>--all</option> and <option>--state=</option>.</para> |
cbb76c29 LP |
772 | </listitem> |
773 | </varlistentry> | |
774 | ||
27722f96 | 775 | <varlistentry> |
1eecafb8 | 776 | <term><command>start <replaceable>PATTERN</replaceable>…</command></term> |
27722f96 LN |
777 | |
778 | <listitem> | |
779 | <para>Start (activate) one or more units specified on the | |
780 | command line.</para> | |
e3e0314b | 781 | |
2cdbbc9a LP |
782 | <para>Note that glob patterns operate on the set of primary names of units currently in memory. Units which |
783 | are not active and are not in a failed state usually are not in memory, and will not be matched by any | |
1f00eded LP |
784 | pattern. In addition, in case of instantiated units, systemd is often unaware of the instance name until |
785 | the instance has been started. Therefore, using glob patterns with <command>start</command> has limited | |
786 | usefulness. Also, secondary alias names of units are not considered.</para> | |
27722f96 LN |
787 | </listitem> |
788 | </varlistentry> | |
789 | <varlistentry> | |
1eecafb8 | 790 | <term><command>stop <replaceable>PATTERN</replaceable>…</command></term> |
27722f96 LN |
791 | |
792 | <listitem> | |
793 | <para>Stop (deactivate) one or more units specified on the | |
794 | command line.</para> | |
795 | </listitem> | |
796 | </varlistentry> | |
797 | <varlistentry> | |
1eecafb8 | 798 | <term><command>reload <replaceable>PATTERN</replaceable>…</command></term> |
27722f96 LN |
799 | |
800 | <listitem> | |
801 | <para>Asks all units listed on the command line to reload | |
802 | their configuration. Note that this will reload the | |
803 | service-specific configuration, not the unit configuration | |
804 | file of systemd. If you want systemd to reload the | |
79640424 | 805 | configuration file of a unit, use the |
27722f96 LN |
806 | <command>daemon-reload</command> command. In other words: |
807 | for the example case of Apache, this will reload Apache's | |
808 | <filename>httpd.conf</filename> in the web server, not the | |
809 | <filename>apache.service</filename> systemd unit | |
810 | file.</para> | |
811 | ||
812 | <para>This command should not be confused with the | |
d0a3fb75 | 813 | <command>daemon-reload</command> command.</para> |
27722f96 LN |
814 | </listitem> |
815 | ||
816 | </varlistentry> | |
817 | <varlistentry> | |
1eecafb8 | 818 | <term><command>restart <replaceable>PATTERN</replaceable>…</command></term> |
27722f96 LN |
819 | |
820 | <listitem> | |
c4f2aaa4 LP |
821 | <para>Stop and then start one or more units specified on the command line. If the units are not running |
822 | yet, they will be started.</para> | |
823 | ||
824 | <para>Note that restarting a unit with this command does not necessarily flush out all of the unit's | |
825 | resources before it is started again. For example, the per-service file descriptor storage facility (see | |
8b247b43 | 826 | <varname>FileDescriptorStoreMax=</varname> in |
c4f2aaa4 LP |
827 | <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>) will |
828 | remain intact as long as the unit has a job pending, and is only cleared when the unit is fully stopped and | |
829 | no jobs are pending anymore. If it is intended that the file descriptor store is flushed out, too, during a | |
830 | restart operation an explicit <command>systemctl stop</command> command followed by <command>systemctl | |
831 | start</command> should be issued.</para> | |
27722f96 LN |
832 | </listitem> |
833 | </varlistentry> | |
834 | <varlistentry> | |
1eecafb8 | 835 | <term><command>try-restart <replaceable>PATTERN</replaceable>…</command></term> |
27722f96 LN |
836 | |
837 | <listitem> | |
6539dd7c | 838 | <para>Stop and then start one or more units specified on the |
839 | command line if the units are running. This does nothing | |
840 | if units are not running.</para> | |
2fcee0a5 LP |
841 | <!-- Note that we don't document condrestart here, as that is just compatibility support, and we generally |
842 | don't document that. --> | |
27722f96 LN |
843 | </listitem> |
844 | </varlistentry> | |
845 | <varlistentry> | |
1eecafb8 | 846 | <term><command>reload-or-restart <replaceable>PATTERN</replaceable>…</command></term> |
27722f96 LN |
847 | |
848 | <listitem> | |
ff946d82 LP |
849 | <para>Reload one or more units if they support it. If not, stop and then start them instead. If the units |
850 | are not running yet, they will be started.</para> | |
27722f96 LN |
851 | </listitem> |
852 | </varlistentry> | |
853 | <varlistentry> | |
1eecafb8 | 854 | <term><command>try-reload-or-restart <replaceable>PATTERN</replaceable>…</command></term> |
27722f96 LN |
855 | |
856 | <listitem> | |
ff946d82 LP |
857 | <para>Reload one or more units if they support it. If not, stop and then start them instead. This does |
858 | nothing if the units are not running.</para> | |
2fcee0a5 LP |
859 | <!-- Note that we don't document force-reload here, as that is just compatibility support, and we generally |
860 | don't document that. --> | |
27722f96 LN |
861 | </listitem> |
862 | </varlistentry> | |
863 | <varlistentry> | |
da5e955f | 864 | <term><command>isolate <replaceable>UNIT</replaceable></command></term> |
27722f96 LN |
865 | |
866 | <listitem> | |
26adf774 ZJS |
867 | <para>Start the unit specified on the command line and its dependencies |
868 | and stop all others, unless they have | |
869 | <option>IgnoreOnIsolate=yes</option> (see | |
870 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>). | |
871 | If a unit name with no extension is given, an extension of | |
507e28d8 | 872 | <literal>.target</literal> will be assumed.</para> |
27722f96 LN |
873 | |
874 | <para>This is similar to changing the runlevel in a | |
875 | traditional init system. The <command>isolate</command> | |
876 | command will immediately stop processes that are not enabled | |
877 | in the new unit, possibly including the graphical | |
878 | environment or terminal you are currently using.</para> | |
879 | ||
880 | <para>Note that this is allowed only on units where | |
881 | <option>AllowIsolate=</option> is enabled. See | |
882 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
883 | for details.</para> | |
884 | </listitem> | |
885 | </varlistentry> | |
886 | <varlistentry> | |
1eecafb8 | 887 | <term><command>kill <replaceable>PATTERN</replaceable>…</command></term> |
27722f96 LN |
888 | |
889 | <listitem> | |
890 | <para>Send a signal to one or more processes of the | |
891 | unit. Use <option>--kill-who=</option> to select which | |
0088d631 LP |
892 | process to kill. Use <option>--signal=</option> to select |
893 | the signal to send.</para> | |
27722f96 LN |
894 | </listitem> |
895 | </varlistentry> | |
896 | <varlistentry> | |
1eecafb8 | 897 | <term><command>is-active <replaceable>PATTERN</replaceable>…</command></term> |
27722f96 LN |
898 | |
899 | <listitem> | |
900 | <para>Check whether any of the specified units are active | |
6db27428 ZJS |
901 | (i.e. running). Returns an exit code |
902 | <constant>0</constant> if at least one is active, or | |
903 | non-zero otherwise. Unless <option>--quiet</option> is | |
904 | specified, this will also print the current unit state to | |
905 | standard output.</para> | |
27722f96 LN |
906 | </listitem> |
907 | </varlistentry> | |
908 | <varlistentry> | |
1eecafb8 | 909 | <term><command>is-failed <replaceable>PATTERN</replaceable>…</command></term> |
27722f96 LN |
910 | |
911 | <listitem> | |
6db27428 ZJS |
912 | <para>Check whether any of the specified units are in a |
913 | "failed" state. Returns an exit code | |
914 | <constant>0</constant> if at least one has failed, | |
915 | non-zero otherwise. Unless <option>--quiet</option> is | |
916 | specified, this will also print the current unit state to | |
917 | standard output.</para> | |
27722f96 LN |
918 | </listitem> |
919 | </varlistentry> | |
920 | <varlistentry> | |
1eecafb8 | 921 | <term><command>status</command> <optional><replaceable>PATTERN</replaceable>…|<replaceable>PID</replaceable>…]</optional></term> |
27722f96 LN |
922 | |
923 | <listitem> | |
924 | <para>Show terse runtime status information about one or | |
925 | more units, followed by most recent log data from the | |
8fcf784d | 926 | journal. If no units are specified, show system status. If |
b8bde116 | 927 | combined with <option>--all</option>, also show the status of |
8fcf784d LP |
928 | all units (subject to limitations specified with |
929 | <option>-t</option>). If a PID is passed, show information | |
930 | about the unit the process belongs to.</para> | |
27722f96 LN |
931 | |
932 | <para>This function is intended to generate human-readable | |
e213d1a3 | 933 | output. If you are looking for computer-parsable output, |
b938cb90 | 934 | use <command>show</command> instead. By default, this |
e213d1a3 | 935 | function only shows 10 lines of output and ellipsizes |
4559a721 | 936 | lines to fit in the terminal window. This can be changed |
e213d1a3 ZJS |
937 | with <option>--lines</option> and <option>--full</option>, |
938 | see above. In addition, <command>journalctl | |
939 | --unit=<replaceable>NAME</replaceable></command> or | |
940 | <command>journalctl | |
941 | --user-unit=<replaceable>NAME</replaceable></command> use | |
942 | a similar filter for messages and might be more | |
943 | convenient. | |
944 | </para> | |
ab8864eb | 945 | |
f95b0be7 | 946 | <para>systemd implicitly loads units as necessary, so just running the <command>status</command> will |
ab8864eb MS |
947 | attempt to load a file. The command is thus not useful for determining if something was already loaded or |
948 | not. The units may possibly also be quickly unloaded after the operation is completed if there's no reason | |
949 | to keep it in memory thereafter. | |
950 | </para> | |
951 | ||
952 | <example> | |
953 | <title>Example output from systemctl status </title> | |
954 | ||
955 | <programlisting>$ systemctl status bluetooth | |
956 | ● bluetooth.service - Bluetooth service | |
83ddf5d3 | 957 | Loaded: loaded (/usr/lib/systemd/system/bluetooth.service; enabled; vendor preset: enabled) |
ab8864eb MS |
958 | Active: active (running) since Wed 2017-01-04 13:54:04 EST; 1 weeks 0 days ago |
959 | Docs: man:bluetoothd(8) | |
960 | Main PID: 930 (bluetoothd) | |
961 | Status: "Running" | |
962 | Tasks: 1 | |
963 | Memory: 648.0K | |
964 | CPU: 435ms | |
965 | CGroup: /system.slice/bluetooth.service | |
966 | └─930 /usr/lib/bluetooth/bluetoothd | |
967 | ||
968 | Jan 12 10:46:45 example.com bluetoothd[8900]: Not enough free handles to register service | |
542ca7c9 DR |
969 | Jan 12 10:46:45 example.com bluetoothd[8900]: Current Time Service could not be registered |
970 | Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output error (5) | |
ab8864eb MS |
971 | </programlisting> |
972 | ||
973 | <para>The dot ("●") uses color on supported terminals to summarize the unit state at a glance. White | |
974 | indicates an <literal>inactive</literal> or <literal>deactivating</literal> state. Red indicates a | |
975 | <literal>failed</literal> or <literal>error</literal> state and green indicates an | |
976 | <literal>active</literal>, <literal>reloading</literal> or <literal>activating</literal> state. | |
977 | </para> | |
978 | ||
979 | <para>The "Loaded:" line in the output will show <literal>loaded</literal> if the unit has been loaded into | |
980 | memory. Other possible values for "Loaded:" include: <literal>error</literal> if there was a problem | |
c4555ad8 LP |
981 | loading it, <literal>not-found</literal> if not unit file was found for this unit, |
982 | <literal>bad-setting</literal> if an essential unit file setting could not be parsed and | |
983 | <literal>masked</literal> if the unit file has been masked. Along with showing the path to the unit file, | |
984 | this line will also show the enablement state. Enabled commands start at boot. See the full table of | |
985 | possible enablement states — including the definition of <literal>masked</literal> — in the documentation | |
986 | for the <command>is-enabled</command> command. | |
ab8864eb MS |
987 | </para> |
988 | ||
989 | <para>The "Active:" line shows active state. The value is usually <literal>active</literal> or | |
990 | <literal>inactive</literal>. Active could mean started, bound, plugged in, etc depending on the unit type. | |
991 | The unit could also be in process of changing states, reporting a state of <literal>activating</literal> or | |
992 | <literal>deactivating</literal>. A special <literal>failed</literal> state is entered when the service | |
993 | failed in some way, such as a crash, exiting with an error code or timing out. If the failed state is | |
994 | entered the cause will be logged for later reference.</para> | |
995 | </example> | |
996 | ||
27722f96 LN |
997 | </listitem> |
998 | </varlistentry> | |
999 | <varlistentry> | |
1eecafb8 | 1000 | <term><command>show</command> <optional><replaceable>PATTERN</replaceable>…|<replaceable>JOB</replaceable>…</optional></term> |
27722f96 LN |
1001 | |
1002 | <listitem> | |
33d2308c LP |
1003 | <para>Show properties of one or more units, jobs, or the manager itself. If no argument is specified, |
1004 | properties of the manager will be shown. If a unit name is specified, properties of the unit are shown, and | |
1005 | if a job ID is specified, properties of the job are shown. By default, empty properties are suppressed. Use | |
1006 | <option>--all</option> to show those too. To select specific properties to show, use | |
1007 | <option>--property=</option>. This command is intended to be used whenever computer-parsable output is | |
1008 | required. Use <command>status</command> if you are looking for formatted human-readable output.</para> | |
1009 | ||
1010 | <para>Many properties shown by <command>systemctl show</command> map directly to configuration settings of | |
1011 | the system and service manager and its unit files. Note that the properties shown by the command are | |
1012 | generally more low-level, normalized versions of the original configuration settings and expose runtime | |
1013 | state in addition to configuration. For example, properties shown for service units include the service's | |
1014 | current main process identifier as <literal>MainPID</literal> (which is runtime state), and time settings | |
1015 | are always exposed as properties ending in the <literal>…USec</literal> suffix even if a matching | |
1016 | configuration options end in <literal>…Sec</literal>, because microseconds is the normalized time unit used | |
1017 | by the system and service manager.</para> | |
27722f96 LN |
1018 | </listitem> |
1019 | </varlistentry> | |
e93c33d4 | 1020 | <varlistentry> |
1eecafb8 | 1021 | <term><command>cat <replaceable>PATTERN</replaceable>…</command></term> |
27722f96 | 1022 | |
e93c33d4 | 1023 | <listitem> |
e4c0fbe5 ZJS |
1024 | <para>Show backing files of one or more units. Prints the |
1025 | "fragment" and "drop-ins" (source files) of units. Each | |
1026 | file is preceded by a comment which includes the file | |
d4a48671 LW |
1027 | name. Note that this shows the contents of the backing files |
1028 | on disk, which may not match the system manager's | |
1029 | understanding of these units if any unit files were | |
1030 | updated on disk and the <command>daemon-reload</command> | |
1031 | command wasn't issued since.</para> | |
e93c33d4 SL |
1032 | </listitem> |
1033 | </varlistentry> | |
27722f96 | 1034 | <varlistentry> |
fbf3283b | 1035 | <term><command>set-property <replaceable>UNIT</replaceable> <replaceable>PROPERTY</replaceable>=<replaceable>VALUE</replaceable>…</command></term> |
27722f96 LN |
1036 | |
1037 | <listitem> | |
1038 | <para>Set the specified unit properties at runtime where | |
1039 | this is supported. This allows changing configuration | |
3fde5f30 | 1040 | parameter properties such as resource control settings at |
27722f96 | 1041 | runtime. Not all properties may be changed at runtime, but |
3fde5f30 LP |
1042 | many resource control settings (primarily those in |
1043 | <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>) | |
fbf3283b | 1044 | may. The changes are applied immediately, and stored on disk |
27722f96 | 1045 | for future boots, unless <option>--runtime</option> is |
3fde5f30 LP |
1046 | passed, in which case the settings only apply until the |
1047 | next reboot. The syntax of the property assignment follows | |
27722f96 LN |
1048 | closely the syntax of assignments in unit files.</para> |
1049 | ||
1050 | <para>Example: <command>systemctl set-property foobar.service CPUShares=777</command></para> | |
1051 | ||
e9fd88f2 FB |
1052 | <para>If the specified unit appears to be inactive, the |
1053 | changes will be only stored on disk as described | |
1054 | previously hence they will be effective when the unit will | |
1055 | be started.</para> | |
1056 | ||
27722f96 LN |
1057 | <para>Note that this command allows changing multiple |
1058 | properties at the same time, which is preferable over | |
fbf3283b ZJS |
1059 | setting them individually. Like with unit file configuration |
1060 | settings, assigning an empty list will reset the property. | |
1061 | </para> | |
27722f96 LN |
1062 | </listitem> |
1063 | </varlistentry> | |
1064 | ||
1065 | <varlistentry> | |
1eecafb8 | 1066 | <term><command>help <replaceable>PATTERN</replaceable>…|<replaceable>PID</replaceable>…</command></term> |
27722f96 LN |
1067 | |
1068 | <listitem> | |
1069 | <para>Show manual pages for one or more units, if | |
1070 | available. If a PID is given, the manual pages for the unit | |
1071 | the process belongs to are shown.</para> | |
1072 | </listitem> | |
1073 | </varlistentry> | |
1074 | ||
1075 | <varlistentry> | |
1eecafb8 | 1076 | <term><command>reset-failed [<replaceable>PATTERN</replaceable>…]</command></term> |
27722f96 LN |
1077 | |
1078 | <listitem> | |
ff946d82 LP |
1079 | <para>Reset the <literal>failed</literal> state of the specified units, or if no unit name is passed, reset |
1080 | the state of all units. When a unit fails in some way (i.e. process exiting with non-zero error code, | |
1081 | terminating abnormally or timing out), it will automatically enter the <literal>failed</literal> state and | |
1082 | its exit code and status is recorded for introspection by the administrator until the service is | |
1083 | stopped/re-started or reset with this command.</para> | |
860cc6df LP |
1084 | |
1085 | <para>In addition to resetting the <literal>failed</literal> state of a unit it also resets various other | |
1086 | per-unit properties: the start rate limit counter of all unit types is reset to zero, as is the restart | |
1087 | counter of service units. Thus, if a unit's start limit (as configured with | |
1088 | <varname>StartLimitIntervalSec=</varname>/<varname>StartLimitBurst=</varname>) is hit and the unit refuses | |
1089 | to be started again, use this command to make it startable again.</para> | |
27722f96 LN |
1090 | </listitem> |
1091 | </varlistentry> | |
1092 | ||
1093 | <varlistentry> | |
f6375e83 ZJS |
1094 | <term> |
1095 | <command>list-dependencies</command> | |
da5e955f | 1096 | <optional><replaceable>UNIT</replaceable></optional> |
f6375e83 | 1097 | </term> |
27722f96 LN |
1098 | |
1099 | <listitem> | |
f6375e83 ZJS |
1100 | <para>Shows units required and wanted by the specified |
1101 | unit. This recursively lists units following the | |
1102 | <varname>Requires=</varname>, | |
f6375e83 | 1103 | <varname>Requisite=</varname>, |
fb30c438 | 1104 | <varname>ConsistsOf=</varname>, |
f6375e83 ZJS |
1105 | <varname>Wants=</varname>, <varname>BindsTo=</varname> |
1106 | dependencies. If no unit is specified, | |
1107 | <filename>default.target</filename> is implied.</para> | |
1108 | ||
1109 | <para>By default, only target units are recursively | |
1110 | expanded. When <option>--all</option> is passed, all other | |
1111 | units are recursively expanded as well.</para> | |
1112 | ||
1113 | <para>Options <option>--reverse</option>, | |
1114 | <option>--after</option>, <option>--before</option> | |
1115 | may be used to change what types of dependencies | |
1116 | are shown.</para> | |
ff5bd14b LP |
1117 | |
1118 | <para>Note that this command only lists units currently loaded into memory by the service manager. In | |
1119 | particular, this command is not suitable to get a comprehensive list at all reverse dependencies on a | |
1120 | specific unit, as it won't list the dependencies declared by units currently not loaded.</para> | |
27722f96 LN |
1121 | </listitem> |
1122 | </varlistentry> | |
1123 | </variablelist> | |
1124 | </refsect2> | |
1125 | ||
1126 | <refsect2> | |
1127 | <title>Unit File Commands</title> | |
1128 | ||
1129 | <variablelist> | |
1130 | <varlistentry> | |
e92b3655 | 1131 | <term><command>list-unit-files</command> <optional><replaceable>PATTERN…</replaceable></optional></term> |
27722f96 LN |
1132 | |
1133 | <listitem> | |
3990961d LP |
1134 | <para>List unit files installed on the system, in combination with their enablement state (as reported by |
1135 | <command>is-enabled</command>). If one or more <replaceable>PATTERN</replaceable>s are specified, only unit | |
1136 | files whose name matches one of them are shown (patterns matching unit file system paths are not | |
1137 | supported).</para> | |
27722f96 LN |
1138 | </listitem> |
1139 | </varlistentry> | |
1140 | ||
1141 | <varlistentry> | |
da5e955f | 1142 | <term><command>enable <replaceable>UNIT</replaceable>…</command></term> |
1eecafb8 | 1143 | <term><command>enable <replaceable>PATH</replaceable>…</command></term> |
27722f96 LN |
1144 | |
1145 | <listitem> | |
3990961d LP |
1146 | <para>Enable one or more units or unit instances. This will create a set of symlinks, as encoded in the |
1147 | <literal>[Install]</literal> sections of the indicated unit files. After the symlinks have been created, | |
1148 | the system manager configuration is reloaded (in a way equivalent to <command>daemon-reload</command>), in | |
1149 | order to ensure the changes are taken into account immediately. Note that this does | |
1150 | <emphasis>not</emphasis> have the effect of also starting any of the units being enabled. If this is | |
1151 | desired, combine this command with the <option>--now</option> switch, or invoke <command>start</command> | |
1152 | with appropriate arguments later. Note that in case of unit instance enablement (i.e. enablement of units of | |
1153 | the form <filename>foo@bar.service</filename>), symlinks named the same as instances are created in the | |
2dd67817 | 1154 | unit configuration directory, however they point to the single template unit file they are instantiated |
3990961d LP |
1155 | from.</para> |
1156 | ||
93f07c87 ZJS |
1157 | <para>This command expects either valid unit names (in which case various unit file directories are |
1158 | automatically searched for unit files with appropriate names), or absolute paths to unit files (in which | |
1159 | case these files are read directly). If a specified unit file is located outside of the usual unit file | |
1160 | directories, an additional symlink is created, linking it into the unit configuration path, thus ensuring | |
2f3828e5 ZJS |
1161 | it is found when requested by commands such as <command>start</command>. The file system where the linked |
1162 | unit files are located must be accessible when systemd is started (e.g. anything underneath | |
1163 | <filename>/home</filename> or <filename>/var</filename> is not allowed, unless those directories are | |
1164 | located on the root file system).</para> | |
3990961d LP |
1165 | |
1166 | <para>This command will print the file system operations executed. This output may be suppressed by passing | |
1167 | <option>--quiet</option>. | |
27722f96 LN |
1168 | </para> |
1169 | ||
3990961d LP |
1170 | <para>Note that this operation creates only the symlinks suggested in the <literal>[Install]</literal> |
1171 | section of the unit files. While this command is the recommended way to manipulate the unit configuration | |
1172 | directory, the administrator is free to make additional changes manually by placing or removing symlinks | |
1173 | below this directory. This is particularly useful to create configurations that deviate from the suggested | |
1174 | default installation. In this case, the administrator must make sure to invoke | |
1175 | <command>daemon-reload</command> manually as necessary, in order to ensure the changes are taken into | |
1176 | account. | |
27722f96 LN |
1177 | </para> |
1178 | ||
3990961d LP |
1179 | <para>Enabling units should not be confused with starting (activating) units, as done by the |
1180 | <command>start</command> command. Enabling and starting units is orthogonal: units may be enabled without | |
1181 | being started and started without being enabled. Enabling simply hooks the unit into various suggested | |
1182 | places (for example, so that the unit is automatically started on boot or when a particular kind of | |
1183 | hardware is plugged in). Starting actually spawns the daemon process (in case of service units), or binds | |
1184 | the socket (in case of socket units), and so on.</para> | |
1185 | ||
1186 | <para>Depending on whether <option>--system</option>, <option>--user</option>, <option>--runtime</option>, | |
1187 | or <option>--global</option> is specified, this enables the unit for the system, for the calling user only, | |
1d82e6b3 AJ |
1188 | for only this boot of the system, or for all future logins of all users. Note that in the last case, no |
1189 | systemd daemon configuration is reloaded.</para> | |
3990961d LP |
1190 | |
1191 | <para>Using <command>enable</command> on masked units is not supported and results in an error.</para> | |
27722f96 LN |
1192 | </listitem> |
1193 | </varlistentry> | |
1194 | ||
1195 | <varlistentry> | |
da5e955f | 1196 | <term><command>disable <replaceable>UNIT</replaceable>…</command></term> |
27722f96 LN |
1197 | |
1198 | <listitem> | |
3990961d LP |
1199 | <para>Disables one or more units. This removes all symlinks to the unit files backing the specified units |
1200 | from the unit configuration directory, and hence undoes any changes made by <command>enable</command> or | |
1201 | <command>link</command>. Note that this removes <emphasis>all</emphasis> symlinks to matching unit files, | |
1202 | including manually created symlinks, and not just those actually created by <command>enable</command> or | |
1203 | <command>link</command>. Note that while <command>disable</command> undoes the effect of | |
1204 | <command>enable</command>, the two commands are otherwise not symmetric, as <command>disable</command> may | |
1205 | remove more symlinks than a prior <command>enable</command> invocation of the same unit created.</para> | |
1206 | ||
1207 | <para>This command expects valid unit names only, it does not accept paths to unit files.</para> | |
1208 | ||
1209 | <para>In addition to the units specified as arguments, all units are disabled that are listed in the | |
1210 | <varname>Also=</varname> setting contained in the <literal>[Install]</literal> section of any of the unit | |
1211 | files being operated on.</para> | |
1212 | ||
1213 | <para>This command implicitly reloads the system manager configuration after completing the operation. Note | |
1214 | that this command does not implicitly stop the units that are being disabled. If this is desired, either | |
1215 | combine this command with the <option>--now</option> switch, or invoke the <command>stop</command> command | |
1216 | with appropriate arguments later.</para> | |
1217 | ||
1218 | <para>This command will print information about the file system operations (symlink removals) | |
1219 | executed. This output may be suppressed by passing <option>--quiet</option>. | |
27722f96 LN |
1220 | </para> |
1221 | ||
3990961d LP |
1222 | <para>This command honors <option>--system</option>, <option>--user</option>, <option>--runtime</option> |
1223 | and <option>--global</option> in a similar way as <command>enable</command>.</para> | |
27722f96 LN |
1224 | </listitem> |
1225 | </varlistentry> | |
1226 | ||
b619ec8f | 1227 | <varlistentry> |
da5e955f | 1228 | <term><command>reenable <replaceable>UNIT</replaceable>…</command></term> |
b619ec8f LP |
1229 | |
1230 | <listitem> | |
3990961d LP |
1231 | <para>Reenable one or more units, as specified on the command line. This is a combination of |
1232 | <command>disable</command> and <command>enable</command> and is useful to reset the symlinks a unit file is | |
d903a892 | 1233 | enabled with to the defaults configured in its <literal>[Install]</literal> section. This command expects |
1234 | a unit name only, it does not accept paths to unit files.</para> | |
b619ec8f LP |
1235 | </listitem> |
1236 | </varlistentry> | |
1237 | ||
1238 | <varlistentry> | |
da5e955f | 1239 | <term><command>preset <replaceable>UNIT</replaceable>…</command></term> |
b619ec8f LP |
1240 | |
1241 | <listitem> | |
39207373 ZJS |
1242 | <para>Reset the enable/disable status one or more unit files, as specified on |
1243 | the command line, to the defaults configured in the preset policy files. This | |
1244 | has the same effect as <command>disable</command> or | |
1245 | <command>enable</command>, depending how the unit is listed in the preset | |
1246 | files.</para> | |
b619ec8f | 1247 | |
39207373 ZJS |
1248 | <para>Use <option>--preset-mode=</option> to control whether units shall be |
1249 | enabled and disabled, or only enabled, or only disabled.</para> | |
1250 | ||
1251 | <para>If the unit carries no install information, it will be silently ignored | |
da5e955f | 1252 | by this command. <replaceable>UNIT</replaceable> must be the real unit name, |
d923e42e | 1253 | any alias names are ignored silently.</para> |
b619ec8f | 1254 | |
39207373 | 1255 | <para>For more information on the preset policy format, see |
b619ec8f | 1256 | <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>. |
39207373 | 1257 | For more information on the concept of presets, please consult the |
28a0ad81 | 1258 | <ulink url="https://www.freedesktop.org/wiki/Software/systemd/Preset">Preset</ulink> |
b619ec8f LP |
1259 | document.</para> |
1260 | </listitem> | |
1261 | </varlistentry> | |
1262 | ||
1263 | <varlistentry> | |
1264 | <term><command>preset-all</command></term> | |
1265 | ||
1266 | <listitem> | |
1267 | <para>Resets all installed unit files to the defaults | |
1268 | configured in the preset policy file (see above).</para> | |
1269 | ||
1270 | <para>Use <option>--preset-mode=</option> to control | |
1271 | whether units shall be enabled and disabled, or only | |
1272 | enabled, or only disabled.</para> | |
1273 | </listitem> | |
1274 | </varlistentry> | |
1275 | ||
27722f96 | 1276 | <varlistentry> |
da5e955f | 1277 | <term><command>is-enabled <replaceable>UNIT</replaceable>…</command></term> |
27722f96 LN |
1278 | |
1279 | <listitem> | |
1280 | <para>Checks whether any of the specified unit files are | |
171754aa ZJS |
1281 | enabled (as with <command>enable</command>). Returns an |
1282 | exit code of 0 if at least one is enabled, non-zero | |
1283 | otherwise. Prints the current enable status (see table). | |
1284 | To suppress this output, use <option>--quiet</option>. | |
3b3557c4 | 1285 | To show installation targets, use <option>--full</option>. |
171754aa ZJS |
1286 | </para> |
1287 | ||
1288 | <table> | |
1289 | <title> | |
1290 | <command>is-enabled</command> output | |
1291 | </title> | |
1292 | ||
1293 | <tgroup cols='3'> | |
1294 | <thead> | |
1295 | <row> | |
94f099d8 LP |
1296 | <entry>Name</entry> |
1297 | <entry>Description</entry> | |
1298 | <entry>Exit Code</entry> | |
171754aa ZJS |
1299 | </row> |
1300 | </thead> | |
1301 | <tbody> | |
1302 | <row> | |
1303 | <entry><literal>enabled</literal></entry> | |
5cd8ae31 | 1304 | <entry morerows='1'>Enabled via <filename>.wants/</filename>, <filename>.requires/</filename> or <varname>Alias=</varname> symlinks (permanently in <filename>/etc/systemd/system/</filename>, or transiently in <filename>/run/systemd/system/</filename>).</entry> |
171754aa ZJS |
1305 | <entry morerows='1'>0</entry> |
1306 | </row> | |
1307 | <row> | |
1308 | <entry><literal>enabled-runtime</literal></entry> | |
1309 | </row> | |
1310 | <row> | |
1311 | <entry><literal>linked</literal></entry> | |
48563081 | 1312 | <entry morerows='1'>Made available through one or more symlinks to the unit file (permanently in <filename>/etc/systemd/system/</filename> or transiently in <filename>/run/systemd/system/</filename>), even though the unit file might reside outside of the unit file search path.</entry> |
94f099d8 | 1313 | <entry morerows='1'>> 0</entry> |
171754aa ZJS |
1314 | </row> |
1315 | <row> | |
1316 | <entry><literal>linked-runtime</literal></entry> | |
1317 | </row> | |
1318 | <row> | |
1319 | <entry><literal>masked</literal></entry> | |
48563081 | 1320 | <entry morerows='1'>Completely disabled, so that any start operation on it fails (permanently in <filename>/etc/systemd/system/</filename> or transiently in <filename>/run/systemd/systemd/</filename>).</entry> |
94f099d8 | 1321 | <entry morerows='1'>> 0</entry> |
171754aa ZJS |
1322 | </row> |
1323 | <row> | |
1324 | <entry><literal>masked-runtime</literal></entry> | |
1325 | </row> | |
1326 | <row> | |
1327 | <entry><literal>static</literal></entry> | |
f4139308 | 1328 | <entry>The unit file is not enabled, and has no provisions for enabling in the <literal>[Install]</literal> unit file section.</entry> |
91f0ac7d | 1329 | <entry>0</entry> |
171754aa | 1330 | </row> |
aedd4012 JS |
1331 | <row> |
1332 | <entry><literal>indirect</literal></entry> | |
d9b4b48f | 1333 | <entry>The unit file itself is not enabled, but it has a non-empty <varname>Also=</varname> setting in the <literal>[Install]</literal> unit file section, listing other unit files that might be enabled, or it has an alias under a different name through a symlink that is not specified in Also=. For template unit file, an instance different than the one specified in <varname>DefaultInstance=</varname> is enabled.</entry> |
aedd4012 JS |
1334 | <entry>0</entry> |
1335 | </row> | |
171754aa ZJS |
1336 | <row> |
1337 | <entry><literal>disabled</literal></entry> | |
f4139308 | 1338 | <entry>The unit file is not enabled, but contains an <literal>[Install]</literal> section with installation instructions.</entry> |
94f099d8 | 1339 | <entry>> 0</entry> |
171754aa | 1340 | </row> |
f4139308 LP |
1341 | <row> |
1342 | <entry><literal>generated</literal></entry> | |
1343 | <entry>The unit file was generated dynamically via a generator tool. See <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>. Generated unit files may not be enabled, they are enabled implicitly by their generator.</entry> | |
1344 | <entry>0</entry> | |
1345 | </row> | |
e4fca67f LP |
1346 | <row> |
1347 | <entry><literal>transient</literal></entry> | |
1348 | <entry>The unit file has been created dynamically with the runtime API. Transient units may not be enabled.</entry> | |
1349 | <entry>0</entry> | |
1350 | </row> | |
0ec0deaa LP |
1351 | <row> |
1352 | <entry><literal>bad</literal></entry> | |
f4139308 | 1353 | <entry>The unit file is invalid or another error occurred. Note that <command>is-enabled</command> will not actually return this state, but print an error message instead. However the unit file listing printed by <command>list-unit-files</command> might show it.</entry> |
0ec0deaa LP |
1354 | <entry>> 0</entry> |
1355 | </row> | |
171754aa ZJS |
1356 | </tbody> |
1357 | </tgroup> | |
1358 | </table> | |
1359 | ||
27722f96 LN |
1360 | </listitem> |
1361 | </varlistentry> | |
1362 | ||
27722f96 | 1363 | <varlistentry> |
da5e955f | 1364 | <term><command>mask <replaceable>UNIT</replaceable>…</command></term> |
27722f96 LN |
1365 | |
1366 | <listitem> | |
3990961d LP |
1367 | <para>Mask one or more units, as specified on the command line. This will link these unit files to |
1368 | <filename>/dev/null</filename>, making it impossible to start them. This is a stronger version of | |
1369 | <command>disable</command>, since it prohibits all kinds of activation of the unit, including enablement | |
1370 | and manual activation. Use this option with care. This honors the <option>--runtime</option> option to only | |
1371 | mask temporarily until the next reboot of the system. The <option>--now</option> option may be used to | |
1372 | ensure that the units are also stopped. This command expects valid unit names only, it does not accept unit | |
1373 | file paths.</para> | |
27722f96 LN |
1374 | </listitem> |
1375 | </varlistentry> | |
1376 | ||
1377 | <varlistentry> | |
da5e955f | 1378 | <term><command>unmask <replaceable>UNIT</replaceable>…</command></term> |
27722f96 LN |
1379 | |
1380 | <listitem> | |
3990961d LP |
1381 | <para>Unmask one or more unit files, as specified on the command line. This will undo the effect of |
1382 | <command>mask</command>. This command expects valid unit names only, it does not accept unit file | |
1383 | paths.</para> | |
27722f96 LN |
1384 | </listitem> |
1385 | </varlistentry> | |
1386 | ||
1387 | <varlistentry> | |
1eecafb8 | 1388 | <term><command>link <replaceable>PATH</replaceable>…</command></term> |
27722f96 LN |
1389 | |
1390 | <listitem> | |
3990961d LP |
1391 | <para>Link a unit file that is not in the unit file search paths into the unit file search path. This |
1392 | command expects an absolute path to a unit file. The effect of this may be undone with | |
1393 | <command>disable</command>. The effect of this command is that a unit file is made available for commands | |
2f3828e5 ZJS |
1394 | such as <command>start</command>, even though it is not installed directly in the unit search path. The |
1395 | file system where the linked unit files are located must be accessible when systemd is started | |
1396 | (e.g. anything underneath <filename>/home</filename> or <filename>/var</filename> is not allowed, unless | |
1397 | those directories are located on the root file system).</para> | |
27722f96 LN |
1398 | </listitem> |
1399 | </varlistentry> | |
1400 | ||
344ca755 | 1401 | <varlistentry> |
da5e955f | 1402 | <term><command>revert <replaceable>UNIT</replaceable>…</command></term> |
344ca755 LP |
1403 | |
1404 | <listitem> | |
1405 | <para>Revert one or more unit files to their vendor versions. This command removes drop-in configuration | |
1406 | files that modify the specified units, as well as any user-configured unit file that overrides a matching | |
1407 | vendor supplied unit file. Specifically, for a unit <literal>foo.service</literal> the matching directories | |
1408 | <literal>foo.service.d/</literal> with all their contained files are removed, both below the persistent and | |
1409 | runtime configuration directories (i.e. below <filename>/etc/systemd/system</filename> and | |
1410 | <filename>/run/systemd/system</filename>); if the unit file has a vendor-supplied version (i.e. a unit file | |
b17649ee | 1411 | located below <filename>/usr</filename>) any matching persistent or runtime unit file that overrides it is |
344ca755 LP |
1412 | removed, too. Note that if a unit file has no vendor-supplied version (i.e. is only defined below |
1413 | <filename>/etc/systemd/system</filename> or <filename>/run/systemd/system</filename>, but not in a unit | |
1414 | file stored below <filename>/usr</filename>), then it is not removed. Also, if a unit is masked, it is | |
1415 | unmasked.</para> | |
1416 | ||
1417 | <para>Effectively, this command may be used to undo all changes made with <command>systemctl | |
1418 | edit</command>, <command>systemctl set-property</command> and <command>systemctl mask</command> and puts | |
1419 | the original unit file with its settings back in effect.</para> | |
1420 | </listitem> | |
1421 | </varlistentry> | |
1422 | ||
27722f96 | 1423 | <varlistentry> |
b619ec8f | 1424 | <term><command>add-wants <replaceable>TARGET</replaceable> |
da5e955f | 1425 | <replaceable>UNIT</replaceable>…</command></term> |
b619ec8f | 1426 | <term><command>add-requires <replaceable>TARGET</replaceable> |
da5e955f | 1427 | <replaceable>UNIT</replaceable>…</command></term> |
27722f96 LN |
1428 | |
1429 | <listitem> | |
853382da | 1430 | <para>Adds <literal>Wants=</literal> or <literal>Requires=</literal> |
a8eaaee7 | 1431 | dependencies, respectively, to the specified |
853382da | 1432 | <replaceable>TARGET</replaceable> for one or more units. </para> |
27722f96 | 1433 | |
b619ec8f LP |
1434 | <para>This command honors <option>--system</option>, |
1435 | <option>--user</option>, <option>--runtime</option> and | |
a8eaaee7 | 1436 | <option>--global</option> in a way similar to |
b619ec8f | 1437 | <command>enable</command>.</para> |
27722f96 | 1438 | |
27722f96 LN |
1439 | </listitem> |
1440 | </varlistentry> | |
7d4fb3b1 RC |
1441 | |
1442 | <varlistentry> | |
da5e955f | 1443 | <term><command>edit <replaceable>UNIT</replaceable>…</command></term> |
7d4fb3b1 RC |
1444 | |
1445 | <listitem> | |
1446 | <para>Edit a drop-in snippet or a whole replacement file if | |
1447 | <option>--full</option> is specified, to extend or override the | |
1448 | specified unit.</para> | |
1449 | ||
1450 | <para>Depending on whether <option>--system</option> (the default), | |
1451 | <option>--user</option>, or <option>--global</option> is specified, | |
a8eaaee7 | 1452 | this command creates a drop-in file for each unit either for the system, |
b938cb90 | 1453 | for the calling user, or for all futures logins of all users. Then, |
7d4fb3b1 RC |
1454 | the editor (see the "Environment" section below) is invoked on |
1455 | temporary files which will be written to the real location if the | |
1456 | editor exits successfully.</para> | |
1457 | ||
1458 | <para>If <option>--full</option> is specified, this will copy the | |
1459 | original units instead of creating drop-in files.</para> | |
1460 | ||
39c38ce1 DC |
1461 | <para>If <option>--force</option> is specified and any units do |
1462 | not already exist, new unit files will be opened for editing.</para> | |
1463 | ||
7d4fb3b1 RC |
1464 | <para>If <option>--runtime</option> is specified, the changes will |
1465 | be made temporarily in <filename>/run</filename> and they will be | |
1466 | lost on the next reboot.</para> | |
1467 | ||
b938cb90 JE |
1468 | <para>If the temporary file is empty upon exit, the modification of |
1469 | the related unit is canceled.</para> | |
7d4fb3b1 RC |
1470 | |
1471 | <para>After the units have been edited, systemd configuration is | |
1472 | reloaded (in a way that is equivalent to <command>daemon-reload</command>). | |
1473 | </para> | |
1474 | ||
1475 | <para>Note that this command cannot be used to remotely edit units | |
1476 | and that you cannot temporarily edit units which are in | |
b938cb90 | 1477 | <filename>/etc</filename>, since they take precedence over |
7d4fb3b1 RC |
1478 | <filename>/run</filename>.</para> |
1479 | </listitem> | |
1480 | </varlistentry> | |
b619ec8f LP |
1481 | |
1482 | <varlistentry> | |
1483 | <term><command>get-default</command></term> | |
1484 | ||
1485 | <listitem> | |
1486 | <para>Return the default target to boot into. This returns | |
1487 | the target unit name <filename>default.target</filename> | |
1488 | is aliased (symlinked) to.</para> | |
1489 | </listitem> | |
1490 | </varlistentry> | |
1491 | ||
1492 | <varlistentry> | |
da5e955f | 1493 | <term><command>set-default <replaceable>TARGET</replaceable></command></term> |
b619ec8f LP |
1494 | |
1495 | <listitem> | |
1496 | <para>Set the default target to boot into. This sets | |
1497 | (symlinks) the <filename>default.target</filename> alias | |
1498 | to the given target unit.</para> | |
1499 | </listitem> | |
1500 | </varlistentry> | |
1501 | ||
27722f96 LN |
1502 | </variablelist> |
1503 | </refsect2> | |
1504 | ||
0d292f5e LP |
1505 | <refsect2> |
1506 | <title>Machine Commands</title> | |
1507 | ||
1508 | <variablelist> | |
1509 | <varlistentry> | |
e92b3655 | 1510 | <term><command>list-machines</command> <optional><replaceable>PATTERN</replaceable>…</optional></term> |
0d292f5e LP |
1511 | |
1512 | <listitem> | |
1513 | <para>List the host and all running local containers with | |
1514 | their state. If one or more | |
1515 | <replaceable>PATTERN</replaceable>s are specified, only | |
1516 | containers matching one of them are shown. | |
1517 | </para> | |
1518 | </listitem> | |
1519 | </varlistentry> | |
1520 | </variablelist> | |
1521 | </refsect2> | |
1522 | ||
27722f96 LN |
1523 | <refsect2> |
1524 | <title>Job Commands</title> | |
1525 | ||
1526 | <variablelist> | |
1527 | <varlistentry> | |
1eecafb8 | 1528 | <term><command>list-jobs <optional><replaceable>PATTERN…</replaceable></optional></command></term> |
27722f96 LN |
1529 | |
1530 | <listitem> | |
d8fba7c6 ZJS |
1531 | <para>List jobs that are in progress. If one or more |
1532 | <replaceable>PATTERN</replaceable>s are specified, only | |
1533 | jobs for units matching one of them are shown.</para> | |
82948f6c LP |
1534 | |
1535 | <para>When combined with <option>--after</option> or <option>--before</option> the list is augmented with | |
1536 | information on which other job each job is waiting for, and which other jobs are waiting for it, see | |
1537 | above.</para> | |
27722f96 LN |
1538 | </listitem> |
1539 | </varlistentry> | |
1540 | <varlistentry> | |
1eecafb8 | 1541 | <term><command>cancel <replaceable>JOB</replaceable>…</command></term> |
27722f96 LN |
1542 | |
1543 | <listitem> | |
1544 | <para>Cancel one or more jobs specified on the command line | |
1545 | by their numeric job IDs. If no job ID is specified, cancel | |
1546 | all pending jobs.</para> | |
1547 | </listitem> | |
1548 | </varlistentry> | |
1549 | </variablelist> | |
27722f96 LN |
1550 | </refsect2> |
1551 | ||
1552 | <refsect2> | |
1553 | <title>Environment Commands</title> | |
1554 | ||
1555 | <variablelist> | |
1556 | <varlistentry> | |
1557 | <term><command>show-environment</command></term> | |
1558 | ||
1559 | <listitem> | |
804ee07c ZJS |
1560 | <para>Dump the systemd manager environment block. This is the environment |
1561 | block that is passed to all processes the manager spawns. The environment | |
1562 | block will be dumped in straight-forward form suitable for sourcing into | |
1563 | most shells. If no special characters or whitespace is present in the variable | |
1564 | values, no escaping is performed, and the assignments have the form | |
1565 | <literal>VARIABLE=value</literal>. If whitespace or characters which have | |
1566 | special meaning to the shell are present, dollar-single-quote escaping is | |
1567 | used, and assignments have the form <literal>VARIABLE=$'value'</literal>. | |
1568 | This syntax is known to be supported by | |
1569 | <citerefentry project='die-net'><refentrytitle>bash</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
1570 | <citerefentry project='die-net'><refentrytitle>zsh</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
1571 | <citerefentry project='die-net'><refentrytitle>ksh</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
1572 | and | |
1573 | <citerefentry project='die-net'><refentrytitle>busybox</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s | |
1574 | <citerefentry project='die-net'><refentrytitle>ash</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
1575 | but not | |
1576 | <citerefentry project='die-net'><refentrytitle>dash</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
1577 | or | |
1578 | <citerefentry project='die-net'><refentrytitle>fish</refentrytitle><manvolnum>1</manvolnum></citerefentry>. | |
1579 | </para> | |
27722f96 LN |
1580 | </listitem> |
1581 | </varlistentry> | |
1582 | <varlistentry> | |
1eecafb8 | 1583 | <term><command>set-environment <replaceable>VARIABLE=VALUE</replaceable>…</command></term> |
27722f96 LN |
1584 | |
1585 | <listitem> | |
1586 | <para>Set one or more systemd manager environment variables, | |
1587 | as specified on the command line.</para> | |
1588 | </listitem> | |
1589 | </varlistentry> | |
1590 | <varlistentry> | |
1eecafb8 | 1591 | <term><command>unset-environment <replaceable>VARIABLE</replaceable>…</command></term> |
27722f96 LN |
1592 | |
1593 | <listitem> | |
1594 | <para>Unset one or more systemd manager environment | |
1595 | variables. If only a variable name is specified, it will be | |
1596 | removed regardless of its value. If a variable and a value | |
1597 | are specified, the variable is only removed if it has the | |
1598 | specified value.</para> | |
1599 | </listitem> | |
ac3efa8a LP |
1600 | </varlistentry> |
1601 | <varlistentry> | |
3fb90db2 | 1602 | <term> |
b975b0d5 | 1603 | <command>import-environment</command> |
1eecafb8 | 1604 | <optional><replaceable>VARIABLE…</replaceable></optional> |
b975b0d5 | 1605 | </term> |
ac3efa8a LP |
1606 | |
1607 | <listitem> | |
1608 | <para>Import all, one or more environment variables set on | |
1609 | the client into the systemd manager environment block. If | |
73e231ab JE |
1610 | no arguments are passed, the entire environment block is |
1611 | imported. Otherwise, a list of one or more environment | |
1612 | variable names should be passed, whose client-side values | |
ac3efa8a LP |
1613 | are then imported into the manager's environment |
1614 | block.</para> | |
1615 | </listitem> | |
27722f96 LN |
1616 | </varlistentry> |
1617 | </variablelist> | |
1618 | </refsect2> | |
1619 | ||
1620 | <refsect2> | |
1621 | <title>Manager Lifecycle Commands</title> | |
1622 | ||
1623 | <variablelist> | |
1624 | <varlistentry> | |
1625 | <term><command>daemon-reload</command></term> | |
1626 | ||
1627 | <listitem> | |
a8eaaee7 | 1628 | <para>Reload the systemd manager configuration. This will |
432d5965 ZJS |
1629 | rerun all generators (see |
1630 | <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>), | |
1631 | reload all unit files, and recreate the entire dependency | |
1632 | tree. While the daemon is being reloaded, all sockets | |
1633 | systemd listens on behalf of user configuration will stay | |
1634 | accessible.</para> | |
1635 | ||
1636 | <para>This command should not be confused with the | |
1637 | <command>reload</command> command.</para> | |
27722f96 LN |
1638 | </listitem> |
1639 | </varlistentry> | |
1640 | <varlistentry> | |
1641 | <term><command>daemon-reexec</command></term> | |
1642 | ||
1643 | <listitem> | |
1644 | <para>Reexecute the systemd manager. This will serialize the | |
1645 | manager state, reexecute the process and deserialize the | |
1646 | state again. This command is of little use except for | |
79640424 | 1647 | debugging and package upgrades. Sometimes, it might be |
27722f96 | 1648 | helpful as a heavy-weight <command>daemon-reload</command>. |
79640424 | 1649 | While the daemon is being reexecuted, all sockets systemd listening |
27722f96 LN |
1650 | on behalf of user configuration will stay accessible. |
1651 | </para> | |
1652 | </listitem> | |
1653 | </varlistentry> | |
1654 | </variablelist> | |
1655 | </refsect2> | |
1656 | ||
1657 | <refsect2> | |
1658 | <title>System Commands</title> | |
1659 | ||
1660 | <variablelist> | |
99813a19 LP |
1661 | <varlistentry> |
1662 | <term><command>is-system-running</command></term> | |
1663 | ||
1664 | <listitem> | |
2de51fdc | 1665 | <para>Checks whether the system is operational. This |
94f099d8 LP |
1666 | returns success (exit code 0) when the system is fully up |
1667 | and running, specifically not in startup, shutdown or | |
1668 | maintenance mode, and with no failed services. Failure is | |
1669 | returned otherwise (exit code non-zero). In addition, the | |
2de51fdc | 1670 | current state is printed in a short string to standard |
a8eaaee7 | 1671 | output, see the table below. Use <option>--quiet</option> to |
2de51fdc ZJS |
1672 | suppress this output.</para> |
1673 | ||
adb6cd9b FB |
1674 | <para>Use <option>--wait</option> to wait until the boot |
1675 | process is completed before printing the current state and | |
1676 | returning the appropriate error status. If <option>--wait</option> | |
1677 | is in use, states <varname>initializing</varname> or | |
1678 | <varname>starting</varname> will not be reported, instead | |
1679 | the command will block until a later state (such as | |
1680 | <varname>running</varname> or <varname>degraded</varname>) | |
1681 | is reached.</para> | |
1682 | ||
2de51fdc | 1683 | <table> |
94f099d8 LP |
1684 | <title><command>is-system-running</command> output</title> |
1685 | <tgroup cols='3'> | |
1686 | <colspec colname='name'/> | |
1687 | <colspec colname='description'/> | |
1688 | <colspec colname='exit-code'/> | |
2de51fdc ZJS |
1689 | <thead> |
1690 | <row> | |
1691 | <entry>Name</entry> | |
1692 | <entry>Description</entry> | |
94f099d8 | 1693 | <entry>Exit Code</entry> |
2de51fdc ZJS |
1694 | </row> |
1695 | </thead> | |
1696 | <tbody> | |
1697 | <row> | |
1698 | <entry><varname>initializing</varname></entry> | |
1699 | <entry><para>Early bootup, before | |
1fdfa094 LP |
1700 | <filename>basic.target</filename> is reached |
1701 | or the <varname>maintenance</varname> state entered. | |
2de51fdc | 1702 | </para></entry> |
94f099d8 | 1703 | <entry>> 0</entry> |
2de51fdc ZJS |
1704 | </row> |
1705 | <row> | |
1706 | <entry><varname>starting</varname></entry> | |
1fdfa094 LP |
1707 | <entry><para>Late bootup, before the job queue |
1708 | becomes idle for the first time, or one of the | |
1709 | rescue targets are reached.</para></entry> | |
94f099d8 | 1710 | <entry>> 0</entry> |
2de51fdc ZJS |
1711 | </row> |
1712 | <row> | |
1713 | <entry><varname>running</varname></entry> | |
1714 | <entry><para>The system is fully | |
1715 | operational.</para></entry> | |
94f099d8 | 1716 | <entry>0</entry> |
2de51fdc ZJS |
1717 | </row> |
1718 | <row> | |
1719 | <entry><varname>degraded</varname></entry> | |
1720 | <entry><para>The system is operational but one or more | |
1721 | units failed.</para></entry> | |
94f099d8 | 1722 | <entry>> 0</entry> |
2de51fdc ZJS |
1723 | </row> |
1724 | <row> | |
1725 | <entry><varname>maintenance</varname></entry> | |
1fdfa094 | 1726 | <entry><para>The rescue or emergency target is |
2de51fdc | 1727 | active.</para></entry> |
94f099d8 | 1728 | <entry>> 0</entry> |
2de51fdc ZJS |
1729 | </row> |
1730 | <row> | |
1731 | <entry><varname>stopping</varname></entry> | |
1732 | <entry><para>The manager is shutting | |
1733 | down.</para></entry> | |
94f099d8 LP |
1734 | <entry>> 0</entry> |
1735 | </row> | |
1736 | <row> | |
1737 | <entry><varname>offline</varname></entry> | |
1738 | <entry><para>The manager is not | |
1739 | running. Specifically, this is the operational | |
1740 | state if an incompatible program is running as | |
1741 | system manager (PID 1).</para></entry> | |
1742 | <entry>> 0</entry> | |
1743 | </row> | |
1744 | <row> | |
1745 | <entry><varname>unknown</varname></entry> | |
1746 | <entry><para>The operational state could not be | |
1747 | determined, due to lack of resources or another | |
1748 | error cause.</para></entry> | |
1749 | <entry>> 0</entry> | |
2de51fdc ZJS |
1750 | </row> |
1751 | </tbody> | |
1752 | </tgroup> | |
1753 | </table> | |
99813a19 LP |
1754 | </listitem> |
1755 | </varlistentry> | |
1756 | ||
27722f96 LN |
1757 | <varlistentry> |
1758 | <term><command>default</command></term> | |
1759 | ||
1760 | <listitem> | |
6324a8a7 LP |
1761 | <para>Enter default mode. This is equivalent to <command>systemctl isolate default.target</command>. This |
1762 | operation is blocking by default, use <option>--no-block</option> to request asynchronous behavior.</para> | |
27722f96 LN |
1763 | </listitem> |
1764 | </varlistentry> | |
99813a19 | 1765 | |
27722f96 LN |
1766 | <varlistentry> |
1767 | <term><command>rescue</command></term> | |
1768 | ||
1769 | <listitem> | |
6324a8a7 LP |
1770 | <para>Enter rescue mode. This is equivalent to <command>systemctl isolate rescue.target</command>. This |
1771 | operation is blocking by default, use <option>--no-block</option> to request asynchronous behavior.</para> | |
27722f96 LN |
1772 | </listitem> |
1773 | </varlistentry> | |
1774 | <varlistentry> | |
1775 | <term><command>emergency</command></term> | |
1776 | ||
1777 | <listitem> | |
6324a8a7 LP |
1778 | <para>Enter emergency mode. This is equivalent to <command>systemctl isolate |
1779 | emergency.target</command>. This operation is blocking by default, use <option>--no-block</option> to | |
1780 | request asynchronous behavior.</para> | |
27722f96 LN |
1781 | </listitem> |
1782 | </varlistentry> | |
1783 | <varlistentry> | |
1784 | <term><command>halt</command></term> | |
1785 | ||
1786 | <listitem> | |
6324a8a7 LP |
1787 | <para>Shut down and halt the system. This is mostly equivalent to <command>systemctl start halt.target |
1788 | --job-mode=replace-irreversibly --no-block</command>, but also prints a wall message to all users. This command is | |
1789 | asynchronous; it will return after the halt operation is enqueued, without waiting for it to complete. Note | |
1790 | that this operation will simply halt the OS kernel after shutting down, leaving the hardware powered | |
1791 | on. Use <command>systemctl poweroff</command> for powering off the system (see below).</para> | |
1792 | ||
1793 | <para>If combined with <option>--force</option>, shutdown of all running services is skipped, however all | |
1794 | processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the | |
1795 | system halt. If <option>--force</option> is specified twice, the operation is immediately executed without | |
1796 | terminating any processes or unmounting any file systems. This may result in data loss. Note that when | |
1797 | <option>--force</option> is specified twice the halt operation is executed by <command>systemctl</command> | |
1798 | itself, and the system manager is not contacted. This means the command should succeed even when the system | |
1799 | manager has crashed.</para> | |
27722f96 LN |
1800 | </listitem> |
1801 | </varlistentry> | |
1802 | <varlistentry> | |
1803 | <term><command>poweroff</command></term> | |
1804 | ||
1805 | <listitem> | |
6324a8a7 LP |
1806 | <para>Shut down and power-off the system. This is mostly equivalent to <command>systemctl start |
1807 | poweroff.target --job-mode=replace-irreversibly --no-block</command>, but also prints a wall message to all | |
1808 | users. This command is asynchronous; it will return after the power-off operation is enqueued, without | |
1809 | waiting for it to complete.</para> | |
1810 | ||
1811 | <para>If combined with <option>--force</option>, shutdown of all running services is skipped, however all | |
1812 | processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the | |
1813 | powering off. If <option>--force</option> is specified twice, the operation is immediately executed without | |
1814 | terminating any processes or unmounting any file systems. This may result in data loss. Note that when | |
924e44b4 LP |
1815 | <option>--force</option> is specified twice the power-off operation is executed by |
1816 | <command>systemctl</command> itself, and the system manager is not contacted. This means the command should | |
6324a8a7 | 1817 | succeed even when the system manager has crashed.</para> |
27722f96 LN |
1818 | </listitem> |
1819 | </varlistentry> | |
1820 | <varlistentry> | |
e92b3655 | 1821 | <term><command>reboot</command> <optional><replaceable>arg</replaceable></optional></term> |
27722f96 LN |
1822 | |
1823 | <listitem> | |
6324a8a7 LP |
1824 | <para>Shut down and reboot the system. This is mostly equivalent to <command>systemctl start reboot.target |
1825 | --job-mode=replace-irreversibly --no-block</command>, but also prints a wall message to all users. This | |
1826 | command is asynchronous; it will return after the reboot operation is enqueued, without waiting for it to | |
1827 | complete.</para> | |
1828 | ||
1829 | <para>If combined with <option>--force</option>, shutdown of all running services is skipped, however all | |
1830 | processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the | |
1831 | reboot. If <option>--force</option> is specified twice, the operation is immediately executed without | |
1832 | terminating any processes or unmounting any file systems. This may result in data loss. Note that when | |
924e44b4 LP |
1833 | <option>--force</option> is specified twice the reboot operation is executed by |
1834 | <command>systemctl</command> itself, and the system manager is not contacted. This means the command should | |
6324a8a7 LP |
1835 | succeed even when the system manager has crashed.</para> |
1836 | ||
1837 | <para>If the optional argument <replaceable>arg</replaceable> is given, it will be passed as the optional | |
1838 | argument to the <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry> | |
1839 | system call. The value is architecture and firmware specific. As an example, <literal>recovery</literal> | |
1840 | might be used to trigger system recovery, and <literal>fota</literal> might be used to trigger a | |
37185ec8 | 1841 | <quote>firmware over the air</quote> update.</para> |
27722f96 LN |
1842 | </listitem> |
1843 | </varlistentry> | |
b619ec8f | 1844 | |
27722f96 LN |
1845 | <varlistentry> |
1846 | <term><command>kexec</command></term> | |
1847 | ||
1848 | <listitem> | |
6324a8a7 LP |
1849 | <para>Shut down and reboot the system via <command>kexec</command>. This is equivalent to |
1850 | <command>systemctl start kexec.target --job-mode=replace-irreversibly --no-block</command>. This command is | |
1851 | asynchronous; it will return after the reboot operation is enqueued, without waiting for it to | |
1852 | complete.</para> | |
1853 | ||
1854 | <para>If combined with <option>--force</option>, shutdown of all running services is skipped, however all | |
1855 | processes are killed and all file systems are unmounted or mounted read-only, immediately followed by the | |
1856 | reboot.</para> | |
27722f96 LN |
1857 | </listitem> |
1858 | </varlistentry> | |
b619ec8f | 1859 | |
27722f96 | 1860 | <varlistentry> |
e92b3655 | 1861 | <term><command>exit</command> <optional><replaceable>EXIT_CODE</replaceable></optional></term> |
27722f96 LN |
1862 | |
1863 | <listitem> | |
6324a8a7 LP |
1864 | <para>Ask the service manager to quit. This is only supported for user service managers (i.e. in |
1865 | conjunction with the <option>--user</option> option) or in containers and is equivalent to | |
1866 | <command>poweroff</command> otherwise. This command is asynchronous; it will return after the exit | |
1867 | operation is enqueued, without waiting for it to complete.</para> | |
1868 | ||
dcfaecc7 | 1869 | <para>The service manager will exit with the specified exit code, if |
6324a8a7 | 1870 | <replaceable>EXIT_CODE</replaceable> is passed.</para> |
27722f96 | 1871 | </listitem> |
b619ec8f | 1872 | </varlistentry> |
27722f96 | 1873 | |
b619ec8f | 1874 | <varlistentry> |
e92b3655 | 1875 | <term><command>switch-root</command> <replaceable>ROOT</replaceable> <optional><replaceable>INIT</replaceable></optional></term> |
b619ec8f LP |
1876 | |
1877 | <listitem> | |
fb1bad9d LP |
1878 | <para>Switches to a different root directory and executes a new system manager process below it. This is |
1879 | intended for usage in initial RAM disks ("initrd"), and will transition from the initrd's system manager | |
1880 | process (a.k.a. "init" process) to the main system manager process which is loaded from the actual host | |
1881 | volume. This call takes two arguments: the directory that is to become the new root directory, and the path | |
1882 | to the new system manager binary below it to execute as PID 1. If the latter is omitted or the empty | |
1883 | string, a systemd binary will automatically be searched for and used as init. If the system manager path is | |
1884 | omitted, equal to the empty string or identical to the path to the systemd binary, the state of the | |
1885 | initrd's system manager process is passed to the main system manager, which allows later introspection of | |
1886 | the state of the services involved in the initrd boot phase.</para> | |
b619ec8f | 1887 | </listitem> |
27722f96 | 1888 | </varlistentry> |
b619ec8f | 1889 | |
27722f96 LN |
1890 | <varlistentry> |
1891 | <term><command>suspend</command></term> | |
1892 | ||
1893 | <listitem> | |
6324a8a7 LP |
1894 | <para>Suspend the system. This will trigger activation of the special target unit |
1895 | <filename>suspend.target</filename>. This command is asynchronous, and will return after the suspend | |
1896 | operation is successfully enqueued. It will not wait for the suspend/resume cycle to complete.</para> | |
27722f96 LN |
1897 | </listitem> |
1898 | </varlistentry> | |
b619ec8f | 1899 | |
27722f96 LN |
1900 | <varlistentry> |
1901 | <term><command>hibernate</command></term> | |
1902 | ||
1903 | <listitem> | |
6324a8a7 LP |
1904 | <para>Hibernate the system. This will trigger activation of the special target unit |
1905 | <filename>hibernate.target</filename>. This command is asynchronous, and will return after the hibernation | |
1906 | operation is successfully enqueued. It will not wait for the hibernate/thaw cycle to complete.</para> | |
27722f96 LN |
1907 | </listitem> |
1908 | </varlistentry> | |
b619ec8f | 1909 | |
27722f96 LN |
1910 | <varlistentry> |
1911 | <term><command>hybrid-sleep</command></term> | |
1912 | ||
1913 | <listitem> | |
6324a8a7 LP |
1914 | <para>Hibernate and suspend the system. This will trigger activation of the special target unit |
1915 | <filename>hybrid-sleep.target</filename>. This command is asynchronous, and will return after the hybrid | |
1916 | sleep operation is successfully enqueued. It will not wait for the sleep/wake-up cycle to complete.</para> | |
27722f96 LN |
1917 | </listitem> |
1918 | </varlistentry> | |
6cc2b882 JD |
1919 | |
1920 | <varlistentry> | |
1921 | <term><command>suspend-then-hibernate</command></term> | |
1922 | ||
1923 | <listitem> | |
1924 | <para>Suspend the system and hibernate it after the delay specified in <filename>systemd-sleep.conf</filename>. | |
1925 | This will trigger activation of the special target unit <filename>suspend-then-hibernate.target</filename>. | |
1926 | This command is asynchronous, and will return after the hybrid sleep operation is successfully enqueued. | |
1927 | It will not wait for the sleep/wake-up or hibernate/thaw cycle to complete.</para> | |
1928 | </listitem> | |
1929 | </varlistentry> | |
27722f96 LN |
1930 | </variablelist> |
1931 | </refsect2> | |
4a6022f0 | 1932 | |
a7c0e5d7 LP |
1933 | <refsect2> |
1934 | <title>Parameter Syntax</title> | |
1935 | ||
da5e955f | 1936 | <para>Unit commands listed above take either a single unit name (designated as <replaceable>UNIT</replaceable>), |
1eecafb8 | 1937 | or multiple unit specifications (designated as <replaceable>PATTERN</replaceable>…). In the first case, the |
da25e029 ZJS |
1938 | unit name with or without a suffix must be given. If the suffix is not specified (unit name is "abbreviated"), |
1939 | systemctl will append a suitable suffix, <literal>.service</literal> by default, and a type-specific suffix in | |
1940 | case of commands which operate only on specific unit types. For example, | |
e3e0314b ZJS |
1941 | <programlisting># systemctl start sshd</programlisting> and |
1942 | <programlisting># systemctl start sshd.service</programlisting> | |
1943 | are equivalent, as are | |
507e28d8 | 1944 | <programlisting># systemctl isolate default</programlisting> |
e3e0314b | 1945 | and |
507e28d8 | 1946 | <programlisting># systemctl isolate default.target</programlisting> |
da25e029 ZJS |
1947 | Note that (absolute) paths to device nodes are automatically converted to device unit names, and other (absolute) |
1948 | paths to mount unit names. | |
e3e0314b ZJS |
1949 | <programlisting># systemctl status /dev/sda |
1950 | # systemctl status /home</programlisting> | |
1951 | are equivalent to: | |
1952 | <programlisting># systemctl status dev-sda.device | |
1953 | # systemctl status home.mount</programlisting> | |
2cdbbc9a | 1954 | In the second case, shell-style globs will be matched against the primary names of all units currently in memory; |
1f00eded LP |
1955 | literal unit names, with or without a suffix, will be treated as in the first case. This means that literal unit |
1956 | names always refer to exactly one unit, but globs may match zero units and this is not considered an | |
1957 | error.</para> | |
e3e0314b ZJS |
1958 | |
1959 | <para>Glob patterns use | |
decde8cd | 1960 | <citerefentry project='man-pages'><refentrytitle>fnmatch</refentrytitle><manvolnum>3</manvolnum></citerefentry>, |
e3e0314b ZJS |
1961 | so normal shell-style globbing rules are used, and |
1962 | <literal>*</literal>, <literal>?</literal>, | |
1963 | <literal>[]</literal> may be used. See | |
decde8cd | 1964 | <citerefentry project='man-pages'><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry> |
1f00eded | 1965 | for more details. The patterns are matched against the primary names of |
2cdbbc9a | 1966 | units currently in memory, and patterns which do not match anything |
e3e0314b ZJS |
1967 | are silently skipped. For example: |
1968 | <programlisting># systemctl stop sshd@*.service</programlisting> | |
1f00eded | 1969 | will stop all <filename>sshd@.service</filename> instances. Note that alias names of units, and units that aren't |
2cdbbc9a | 1970 | in memory are not considered for glob expansion. |
e3e0314b ZJS |
1971 | </para> |
1972 | ||
da5e955f | 1973 | <para>For unit file commands, the specified <replaceable>UNIT</replaceable> should be the name of the unit file |
1534e170 | 1974 | (possibly abbreviated, see above), or the absolute path to the unit file: |
e3e0314b ZJS |
1975 | <programlisting># systemctl enable foo.service</programlisting> |
1976 | or | |
1977 | <programlisting># systemctl link /path/to/foo.service</programlisting> | |
1978 | </para> | |
a7c0e5d7 LP |
1979 | </refsect2> |
1980 | ||
4a6022f0 ZJS |
1981 | </refsect1> |
1982 | ||
1983 | <refsect1> | |
1984 | <title>Exit status</title> | |
1985 | ||
23a9ffb0 ZJS |
1986 | <para>On success, 0 is returned, a non-zero failure code otherwise.</para> |
1987 | ||
1988 | <para><command>systemctl</command> uses the return codes defined by LSB, as defined in | |
1989 | <ulink url="http://refspecs.linuxbase.org/LSB_3.0.0/LSB-PDA/LSB-PDA/iniscrptact.html">LSB 3.0.0</ulink>. | |
1990 | </para> | |
1991 | ||
1992 | <table> | |
1993 | <title>LSB return codes</title> | |
1994 | ||
1995 | <tgroup cols='3'> | |
1996 | <thead> | |
1997 | <row> | |
1998 | <entry>Value</entry> | |
1999 | <entry>Description in LSB</entry> | |
2000 | <entry>Use in systemd</entry> | |
2001 | </row> | |
2002 | </thead> | |
2003 | <tbody> | |
2004 | <row> | |
2005 | <entry><constant>0</constant></entry> | |
2006 | <entry>"program is running or service is OK"</entry> | |
2007 | <entry>unit is active</entry> | |
2008 | </row> | |
2009 | <row> | |
2010 | <entry><constant>1</constant></entry> | |
2011 | <entry>"program is dead and <filename>/var/run</filename> pid file exists"</entry> | |
2012 | <entry>unit <emphasis>not</emphasis> failed (used by <command>is-failed</command>)</entry> | |
2013 | </row> | |
2014 | <row> | |
2015 | <entry><constant>2</constant></entry> | |
2016 | <entry>"program is dead and <filename>/var/lock</filename> lock file exists"</entry> | |
2017 | <entry>unused</entry> | |
2018 | </row> | |
2019 | <row> | |
2020 | <entry><constant>3</constant></entry> | |
2021 | <entry>"program is not running"</entry> | |
2022 | <entry>unit is not active</entry> | |
2023 | </row> | |
2024 | <row> | |
2025 | <entry><constant>4</constant></entry> | |
2026 | <entry>"program or service status is unknown"</entry> | |
2027 | <entry>no such unit</entry> | |
2028 | </row> | |
2029 | </tbody> | |
2030 | </tgroup> | |
2031 | </table> | |
2032 | ||
2033 | <para>The mapping of LSB service states to systemd unit states is imperfect, so it is better to | |
2034 | not rely on those return values but to look for specific unit states and substates instead. | |
2035 | </para> | |
4a6022f0 ZJS |
2036 | </refsect1> |
2037 | ||
7d4fb3b1 RC |
2038 | <refsect1> |
2039 | <title>Environment</title> | |
2040 | ||
2041 | <variablelist class='environment-variables'> | |
2042 | <varlistentry> | |
2043 | <term><varname>$SYSTEMD_EDITOR</varname></term> | |
2044 | ||
2045 | <listitem><para>Editor to use when editing units; overrides | |
2046 | <varname>$EDITOR</varname> and <varname>$VISUAL</varname>. If neither | |
2047 | <varname>$SYSTEMD_EDITOR</varname> nor <varname>$EDITOR</varname> nor | |
2048 | <varname>$VISUAL</varname> are present or if it is set to an empty | |
2049 | string or if their execution failed, systemctl will try to execute well | |
2050 | known editors in this order: | |
9391a1c3 | 2051 | <citerefentry project='die-net'><refentrytitle>editor</refentrytitle><manvolnum>1</manvolnum></citerefentry>, |
3ba3a79d ZJS |
2052 | <citerefentry project='die-net'><refentrytitle>nano</refentrytitle><manvolnum>1</manvolnum></citerefentry>, |
2053 | <citerefentry project='die-net'><refentrytitle>vim</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
2054 | <citerefentry project='die-net'><refentrytitle>vi</refentrytitle><manvolnum>1</manvolnum></citerefentry>. | |
7d4fb3b1 RC |
2055 | </para></listitem> |
2056 | </varlistentry> | |
2057 | </variablelist> | |
2058 | <xi:include href="less-variables.xml" xpointer="pager"/> | |
2059 | <xi:include href="less-variables.xml" xpointer="less"/> | |
6e16066e | 2060 | <xi:include href="less-variables.xml" xpointer="lesscharset"/> |
7d4fb3b1 | 2061 | </refsect1> |
4a6022f0 ZJS |
2062 | |
2063 | <refsect1> | |
2064 | <title>See Also</title> | |
2065 | <para> | |
2066 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
4a6022f0 ZJS |
2067 | <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, |
2068 | <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
a03fe1a5 | 2069 | <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, |
4a6022f0 | 2070 | <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, |
ee41f602 | 2071 | <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>, |
4a6022f0 | 2072 | <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>, |
5aded369 | 2073 | <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>, |
7d4fb3b1 | 2074 | <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>, |
432d5965 | 2075 | <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>, |
decde8cd | 2076 | <citerefentry project='man-pages'><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry> |
4a6022f0 ZJS |
2077 | </para> |
2078 | </refsect1> | |
7874bcd6 LP |
2079 | |
2080 | </refentry> |