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