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