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