]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/systemd.exec.xml
Add SPDX license identifiers to man pages
[thirdparty/systemd.git] / man / systemd.exec.xml
CommitLineData
023a4f67 1<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
dd1eb43b 2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
12b42c76 3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
dd1eb43b
LP
4
5<!--
572eb058
ZJS
6 SPDX-License-Identifier: LGPL-2.1+
7
dd1eb43b
LP
8 This file is part of systemd.
9
10 Copyright 2010 Lennart Poettering
11
12 systemd is free software; you can redistribute it and/or modify it
5430f7f2
LP
13 under the terms of the GNU Lesser General Public License as published by
14 the Free Software Foundation; either version 2.1 of the License, or
dd1eb43b
LP
15 (at your option) any later version.
16
17 systemd is distributed in the hope that it will be useful, but
18 WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5430f7f2 20 Lesser General Public License for more details.
dd1eb43b 21
5430f7f2 22 You should have received a copy of the GNU Lesser General Public License
dd1eb43b
LP
23 along with systemd; If not, see <http://www.gnu.org/licenses/>.
24-->
25
26<refentry id="systemd.exec">
798d3a52
ZJS
27 <refentryinfo>
28 <title>systemd.exec</title>
29 <productname>systemd</productname>
30
31 <authorgroup>
32 <author>
33 <contrib>Developer</contrib>
34 <firstname>Lennart</firstname>
35 <surname>Poettering</surname>
36 <email>lennart@poettering.net</email>
37 </author>
38 </authorgroup>
39 </refentryinfo>
40
41 <refmeta>
42 <refentrytitle>systemd.exec</refentrytitle>
43 <manvolnum>5</manvolnum>
44 </refmeta>
45
46 <refnamediv>
47 <refname>systemd.exec</refname>
48 <refpurpose>Execution environment configuration</refpurpose>
49 </refnamediv>
50
51 <refsynopsisdiv>
52 <para><filename><replaceable>service</replaceable>.service</filename>,
53 <filename><replaceable>socket</replaceable>.socket</filename>,
54 <filename><replaceable>mount</replaceable>.mount</filename>,
55 <filename><replaceable>swap</replaceable>.swap</filename></para>
56 </refsynopsisdiv>
57
58 <refsect1>
59 <title>Description</title>
60
61 <para>Unit configuration files for services, sockets, mount
62 points, and swap devices share a subset of configuration options
63 which define the execution environment of spawned
64 processes.</para>
65
66 <para>This man page lists the configuration options shared by
67 these four unit types. See
68 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
69 for the common options of all unit configuration files, and
70 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
71 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
72 <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
73 and
74 <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>
75 for more information on the specific unit configuration files. The
76 execution specific configuration options are configured in the
77 [Service], [Socket], [Mount], or [Swap] sections, depending on the
78 unit type.</para>
74b47bbd 79
c7458f93 80 <para>In addition, options which control resources through Linux Control Groups (cgroups) are listed in
74b47bbd
ZJS
81 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
82 Those options complement options listed here.</para>
798d3a52
ZJS
83 </refsect1>
84
c129bd5d 85 <refsect1>
45f09f93
JL
86 <title>Implicit Dependencies</title>
87
88 <para>A few execution parameters result in additional, automatic dependencies to be added:</para>
89
90 <itemizedlist>
91 <listitem><para>Units with <varname>WorkingDirectory=</varname>, <varname>RootDirectory=</varname>, <varname>RootImage=</varname>,
92 <varname>RuntimeDirectory=</varname>, <varname>StateDirectory=</varname>, <varname>CacheDirectory=</varname>,
93 <varname>LogsDirectory=</varname> or <varname>ConfigurationDirectory=</varname> set automatically gain dependencies
94 of type <varname>Requires=</varname> and <varname>After=</varname> on all mount units required to access the specified paths.
95 This is equivalent to having them listed explicitly in <varname>RequiresMountsFor=</varname>.</para></listitem>
96
97 <listitem><para>Similar, units with <varname>PrivateTmp=</varname> enabled automatically get mount unit dependencies for all
98 mounts required to access <filename>/tmp</filename> and <filename>/var/tmp</filename>. They will also gain an
99 automatic <varname>After=</varname> dependency on
100 <citerefentry><refentrytitle>systemd-tmpfiles-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para></listitem>
101
102 <listitem><para>Units whose standard output or error output is connected to <option>journal</option>, <option>syslog</option>
103 or <option>kmsg</option> (or their combinations with console output, see below) automatically acquire dependencies
104 of type <varname>After=</varname> on <filename>systemd-journald.socket</filename>.</para></listitem>
105 </itemizedlist>
c129bd5d
LP
106 </refsect1>
107
45f09f93
JL
108 <!-- We don't have any default dependency here. -->
109
798d3a52
ZJS
110 <refsect1>
111 <title>Options</title>
112
113 <variablelist class='unit-directives'>
114
115 <varlistentry>
116 <term><varname>WorkingDirectory=</varname></term>
117
d251207d
LP
118 <listitem><para>Takes a directory path relative to the service's root directory specified by
119 <varname>RootDirectory=</varname>, or the special value <literal>~</literal>. Sets the working directory for
120 executed processes. If set to <literal>~</literal>, the home directory of the user specified in
121 <varname>User=</varname> is used. If not set, defaults to the root directory when systemd is running as a
122 system instance and the respective user's home directory if run as user. If the setting is prefixed with the
123 <literal>-</literal> character, a missing working directory is not considered fatal. If
915e6d16
LP
124 <varname>RootDirectory=</varname>/<varname>RootImage=</varname> is not set, then
125 <varname>WorkingDirectory=</varname> is relative to the root of the system running the service manager. Note
126 that setting this parameter might result in additional dependencies to be added to the unit (see
127 above).</para></listitem>
798d3a52
ZJS
128 </varlistentry>
129
130 <varlistentry>
131 <term><varname>RootDirectory=</varname></term>
132
d251207d
LP
133 <listitem><para>Takes a directory path relative to the host's root directory (i.e. the root of the system
134 running the service manager). Sets the root directory for executed processes, with the <citerefentry
135 project='man-pages'><refentrytitle>chroot</refentrytitle><manvolnum>2</manvolnum></citerefentry> system
136 call. If this is used, it must be ensured that the process binary and all its auxiliary files are available in
137 the <function>chroot()</function> jail. Note that setting this parameter might result in additional
138 dependencies to be added to the unit (see above).</para>
139
5d997827
LP
140 <para>The <varname>MountAPIVFS=</varname> and <varname>PrivateUsers=</varname> settings are particularly useful
141 in conjunction with <varname>RootDirectory=</varname>. For details, see below.</para></listitem>
142 </varlistentry>
143
915e6d16
LP
144 <varlistentry>
145 <term><varname>RootImage=</varname></term>
146 <listitem><para>Takes a path to a block device node or regular file as argument. This call is similar to
6cf5a964 147 <varname>RootDirectory=</varname> however mounts a file system hierarchy from a block device node or loopback
915e6d16
LP
148 file instead of a directory. The device node or file system image file needs to contain a file system without a
149 partition table, or a file system within an MBR/MS-DOS or GPT partition table with only a single
150 Linux-compatible partition, or a set of file systems within a GPT partition table that follows the <ulink
28a0ad81 151 url="https://www.freedesktop.org/wiki/Specifications/DiscoverablePartitionsSpec/">Discoverable Partitions
915e6d16
LP
152 Specification</ulink>.</para></listitem>
153 </varlistentry>
154
5d997827
LP
155 <varlistentry>
156 <term><varname>MountAPIVFS=</varname></term>
157
158 <listitem><para>Takes a boolean argument. If on, a private mount namespace for the unit's processes is created
ef3116b5
ZJS
159 and the API file systems <filename>/proc</filename>, <filename>/sys</filename>, and <filename>/dev</filename>
160 are mounted inside of it, unless they are already mounted. Note that this option has no effect unless used in
161 conjunction with <varname>RootDirectory=</varname>/<varname>RootImage=</varname> as these three mounts are
162 generally mounted in the host anyway, and unless the root directory is changed, the private mount namespace
163 will be a 1:1 copy of the host's, and include these three mounts. Note that the <filename>/dev</filename> file
164 system of the host is bind mounted if this option is used without <varname>PrivateDevices=</varname>. To run
165 the service with a private, minimal version of <filename>/dev/</filename>, combine this option with
5d997827 166 <varname>PrivateDevices=</varname>.</para></listitem>
798d3a52
ZJS
167 </varlistentry>
168
169 <varlistentry>
170 <term><varname>User=</varname></term>
171 <term><varname>Group=</varname></term>
172
29206d46 173 <listitem><para>Set the UNIX user or group that the processes are executed as, respectively. Takes a single
565dab8e 174 user or group name, or a numeric ID as argument. For system services (services run by the system service manager,
47da760e
LP
175 i.e. managed by PID 1) and for user services of the root user (services managed by root's instance of
176 <command>systemd --user</command>), the default is <literal>root</literal>, but <varname>User=</varname> may be
177 used to specify a different user. For user services of any other user, switching user identity is not
178 permitted, hence the only valid setting is the same user the user's service manager is running as. If no group
179 is set, the default group of the user is used. This setting does not affect commands whose command line is
565dab8e
LP
180 prefixed with <literal>+</literal>.</para>
181
182 <para>Note that restrictions on the user/group name syntax are enforced: the specified name must consist only
183 of the characters a-z, A-Z, 0-9, <literal>_</literal> and <literal>-</literal>, except for the first character
184 which must be one of a-z, A-Z or <literal>_</literal> (i.e. numbers and <literal>-</literal> are not permitted
185 as first character). The user/group name must have at least one character, and at most 31. These restrictions
186 are enforced in order to avoid ambiguities and to ensure user/group names and unit files remain portable among
187 Linux systems.</para>
188
189 <para>When used in conjunction with <varname>DynamicUser=</varname> the user/group name specified is
190 dynamically allocated at the time the service is started, and released at the time the service is stopped —
191 unless it is already allocated statically (see below). If <varname>DynamicUser=</varname> is not used the
192 specified user and group must have been created statically in the user database no later than the moment the
193 service is started, for example using the
194 <citerefentry><refentrytitle>sysusers.d</refentrytitle><manvolnum>5</manvolnum></citerefentry> facility, which
195 is applied at boot or package install time.</para></listitem>
29206d46
LP
196 </varlistentry>
197
198 <varlistentry>
199 <term><varname>DynamicUser=</varname></term>
200
201 <listitem><para>Takes a boolean parameter. If set, a UNIX user and group pair is allocated dynamically when the
202 unit is started, and released as soon as it is stopped. The user and group will not be added to
203 <filename>/etc/passwd</filename> or <filename>/etc/group</filename>, but are managed transiently during
204 runtime. The <citerefentry><refentrytitle>nss-systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
205 glibc NSS module provides integration of these dynamic users/groups into the system's user and group
206 databases. The user and group name to use may be configured via <varname>User=</varname> and
207 <varname>Group=</varname> (see above). If these options are not used and dynamic user/group allocation is
208 enabled for a unit, the name of the dynamic user/group is implicitly derived from the unit name. If the unit
209 name without the type suffix qualifies as valid user name it is used directly, otherwise a name incorporating a
210 hash of it is used. If a statically allocated user or group of the configured name already exists, it is used
3bd493dc
YW
211 and no dynamic user/group is allocated. Note that if <varname>User=</varname> is specified and the static group
212 with the name exists, then it is required that the static user with the name already exists. Similarly,
213 if <varname>Group=</varname> is specified and the static user with the name exists, then it is required that
214 the static group with the name already exists. Dynamic users/groups are allocated from the UID/GID range
29206d46
LP
215 61184…65519. It is recommended to avoid this range for regular system or login users. At any point in time
216 each UID/GID from this range is only assigned to zero or one dynamically allocated users/groups in
217 use. However, UID/GIDs are recycled after a unit is terminated. Care should be taken that any processes running
218 as part of a unit for which dynamic users/groups are enabled do not leave files or directories owned by these
219 users/groups around, as a different unit might get the same UID/GID assigned later on, and thus gain access to
63bb64a0 220 these files or directories. If <varname>DynamicUser=</varname> is enabled, <varname>RemoveIPC=</varname>,
00d9ef85
LP
221 <varname>PrivateTmp=</varname> are implied. This ensures that the lifetime of IPC objects and temporary files
222 created by the executed processes is bound to the runtime of the service, and hence the lifetime of the dynamic
223 user/group. Since <filename>/tmp</filename> and <filename>/var/tmp</filename> are usually the only
224 world-writable directories on a system this ensures that a unit making use of dynamic user/group allocation
63bb64a0
LP
225 cannot leave files around after unit termination. Moreover <varname>ProtectSystem=strict</varname> and
226 <varname>ProtectHome=read-only</varname> are implied, thus prohibiting the service to write to arbitrary file
227 system locations. In order to allow the service to write to certain directories, they have to be whitelisted
4a628360
LP
228 using <varname>ReadWritePaths=</varname>, but care must be taken so that UID/GID recycling doesn't create
229 security issues involving files created by the service. Use <varname>RuntimeDirectory=</varname> (see below) in
230 order to assign a writable runtime directory to a service, owned by the dynamic user/group and removed
231 automatically when the unit is terminated. Use <varname>StateDirectory=</varname>,
232 <varname>CacheDirectory=</varname> and <varname>LogsDirectory=</varname> in order to assign a set of writable
233 directories for specific purposes to the service in a way that they are protected from vulnerabilities due to
234 UID reuse (see below). Defaults to off.</para></listitem>
798d3a52
ZJS
235 </varlistentry>
236
237 <varlistentry>
238 <term><varname>SupplementaryGroups=</varname></term>
239
240 <listitem><para>Sets the supplementary Unix groups the
241 processes are executed as. This takes a space-separated list
242 of group names or IDs. This option may be specified more than
b938cb90
JE
243 once, in which case all listed groups are set as supplementary
244 groups. When the empty string is assigned, the list of
798d3a52
ZJS
245 supplementary groups is reset, and all assignments prior to
246 this one will have no effect. In any way, this option does not
247 override, but extends the list of supplementary groups
248 configured in the system group database for the
43eb109a 249 user. This does not affect commands prefixed with <literal>+</literal>.</para></listitem>
798d3a52
ZJS
250 </varlistentry>
251
00d9ef85
LP
252 <varlistentry>
253 <term><varname>RemoveIPC=</varname></term>
254
255 <listitem><para>Takes a boolean parameter. If set, all System V and POSIX IPC objects owned by the user and
256 group the processes of this unit are run as are removed when the unit is stopped. This setting only has an
257 effect if at least one of <varname>User=</varname>, <varname>Group=</varname> and
258 <varname>DynamicUser=</varname> are used. It has no effect on IPC objects owned by the root user. Specifically,
259 this removes System V semaphores, as well as System V and POSIX shared memory segments and message queues. If
260 multiple units use the same user or group the IPC objects are removed when the last of these units is
261 stopped. This setting is implied if <varname>DynamicUser=</varname> is set.</para></listitem>
262 </varlistentry>
263
798d3a52
ZJS
264 <varlistentry>
265 <term><varname>Nice=</varname></term>
266
267 <listitem><para>Sets the default nice level (scheduling
268 priority) for executed processes. Takes an integer between -20
269 (highest priority) and 19 (lowest priority). See
270 <citerefentry><refentrytitle>setpriority</refentrytitle><manvolnum>2</manvolnum></citerefentry>
271 for details.</para></listitem>
272 </varlistentry>
273
274 <varlistentry>
275 <term><varname>OOMScoreAdjust=</varname></term>
276
277 <listitem><para>Sets the adjustment level for the
278 Out-Of-Memory killer for executed processes. Takes an integer
279 between -1000 (to disable OOM killing for this process) and
280 1000 (to make killing of this process under memory pressure
281 very likely). See <ulink
282 url="https://www.kernel.org/doc/Documentation/filesystems/proc.txt">proc.txt</ulink>
283 for details.</para></listitem>
284 </varlistentry>
285
286 <varlistentry>
287 <term><varname>IOSchedulingClass=</varname></term>
288
b938cb90 289 <listitem><para>Sets the I/O scheduling class for executed
798d3a52
ZJS
290 processes. Takes an integer between 0 and 3 or one of the
291 strings <option>none</option>, <option>realtime</option>,
292 <option>best-effort</option> or <option>idle</option>. See
293 <citerefentry><refentrytitle>ioprio_set</refentrytitle><manvolnum>2</manvolnum></citerefentry>
294 for details.</para></listitem>
295 </varlistentry>
296
297 <varlistentry>
298 <term><varname>IOSchedulingPriority=</varname></term>
299
b938cb90 300 <listitem><para>Sets the I/O scheduling priority for executed
798d3a52
ZJS
301 processes. Takes an integer between 0 (highest priority) and 7
302 (lowest priority). The available priorities depend on the
b938cb90 303 selected I/O scheduling class (see above). See
798d3a52
ZJS
304 <citerefentry><refentrytitle>ioprio_set</refentrytitle><manvolnum>2</manvolnum></citerefentry>
305 for details.</para></listitem>
306 </varlistentry>
307
308 <varlistentry>
309 <term><varname>CPUSchedulingPolicy=</varname></term>
310
311 <listitem><para>Sets the CPU scheduling policy for executed
312 processes. Takes one of
313 <option>other</option>,
314 <option>batch</option>,
315 <option>idle</option>,
316 <option>fifo</option> or
317 <option>rr</option>. See
318 <citerefentry><refentrytitle>sched_setscheduler</refentrytitle><manvolnum>2</manvolnum></citerefentry>
319 for details.</para></listitem>
320 </varlistentry>
321
322 <varlistentry>
323 <term><varname>CPUSchedulingPriority=</varname></term>
324
325 <listitem><para>Sets the CPU scheduling priority for executed
326 processes. The available priority range depends on the
327 selected CPU scheduling policy (see above). For real-time
328 scheduling policies an integer between 1 (lowest priority) and
329 99 (highest priority) can be used. See
330 <citerefentry><refentrytitle>sched_setscheduler</refentrytitle><manvolnum>2</manvolnum></citerefentry>
331 for details. </para></listitem>
332 </varlistentry>
333
334 <varlistentry>
335 <term><varname>CPUSchedulingResetOnFork=</varname></term>
336
337 <listitem><para>Takes a boolean argument. If true, elevated
338 CPU scheduling priorities and policies will be reset when the
339 executed processes fork, and can hence not leak into child
340 processes. See
341 <citerefentry><refentrytitle>sched_setscheduler</refentrytitle><manvolnum>2</manvolnum></citerefentry>
342 for details. Defaults to false.</para></listitem>
343 </varlistentry>
344
345 <varlistentry>
346 <term><varname>CPUAffinity=</varname></term>
347
348 <listitem><para>Controls the CPU affinity of the executed
71b1c27a
FB
349 processes. Takes a list of CPU indices or ranges separated by
350 either whitespace or commas. CPU ranges are specified by the
351 lower and upper CPU indices separated by a dash.
b938cb90 352 This option may be specified more than once, in which case the
798d3a52
ZJS
353 specified CPU affinity masks are merged. If the empty string
354 is assigned, the mask is reset, all assignments prior to this
355 will have no effect. See
356 <citerefentry><refentrytitle>sched_setaffinity</refentrytitle><manvolnum>2</manvolnum></citerefentry>
357 for details.</para></listitem>
358 </varlistentry>
359
360 <varlistentry>
361 <term><varname>UMask=</varname></term>
362
363 <listitem><para>Controls the file mode creation mask. Takes an
364 access mode in octal notation. See
365 <citerefentry><refentrytitle>umask</refentrytitle><manvolnum>2</manvolnum></citerefentry>
366 for details. Defaults to 0022.</para></listitem>
367 </varlistentry>
368
369 <varlistentry>
370 <term><varname>Environment=</varname></term>
371
372 <listitem><para>Sets environment variables for executed
373 processes. Takes a space-separated list of variable
b938cb90 374 assignments. This option may be specified more than once, in
798d3a52
ZJS
375 which case all listed variables will be set. If the same
376 variable is set twice, the later setting will override the
377 earlier setting. If the empty string is assigned to this
378 option, the list of environment variables is reset, all prior
379 assignments have no effect. Variable expansion is not
380 performed inside the strings, however, specifier expansion is
381 possible. The $ character has no special meaning. If you need
b8e485fa 382 to assign a value containing spaces or the equals sign to a variable, use double
798d3a52
ZJS
383 quotes (") for the assignment.</para>
384
385 <para>Example:
386 <programlisting>Environment="VAR1=word1 word2" VAR2=word3 "VAR3=$word 5 6"</programlisting>
387 gives three variables <literal>VAR1</literal>,
388 <literal>VAR2</literal>, <literal>VAR3</literal>
389 with the values <literal>word1 word2</literal>,
390 <literal>word3</literal>, <literal>$word 5 6</literal>.
391 </para>
392
393 <para>
394 See
395 <citerefentry project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry>
396 for details about environment variables.</para></listitem>
397 </varlistentry>
398 <varlistentry>
399 <term><varname>EnvironmentFile=</varname></term>
400 <listitem><para>Similar to <varname>Environment=</varname> but
401 reads the environment variables from a text file. The text
402 file should contain new-line-separated variable assignments.
8f0d2981
RM
403 Empty lines, lines without an <literal>=</literal> separator,
404 or lines starting with ; or # will be ignored,
798d3a52
ZJS
405 which may be used for commenting. A line ending with a
406 backslash will be concatenated with the following one,
407 allowing multiline variable definitions. The parser strips
408 leading and trailing whitespace from the values of
409 assignments, unless you use double quotes (").</para>
410
411 <para>The argument passed should be an absolute filename or
412 wildcard expression, optionally prefixed with
413 <literal>-</literal>, which indicates that if the file does
414 not exist, it will not be read and no error or warning message
415 is logged. This option may be specified more than once in
416 which case all specified files are read. If the empty string
417 is assigned to this option, the list of file to read is reset,
418 all prior assignments have no effect.</para>
419
420 <para>The files listed with this directive will be read
421 shortly before the process is executed (more specifically,
422 after all processes from a previous unit state terminated.
423 This means you can generate these files in one unit state, and
f407824d
DH
424 read it with this option in the next).</para>
425
426 <para>Settings from these
798d3a52
ZJS
427 files override settings made with
428 <varname>Environment=</varname>. If the same variable is set
429 twice from these files, the files will be read in the order
430 they are specified and the later setting will override the
431 earlier setting.</para></listitem>
432 </varlistentry>
433
b4c14404
FB
434 <varlistentry>
435 <term><varname>PassEnvironment=</varname></term>
436
00819cc1
LP
437 <listitem><para>Pass environment variables set for the system service manager to executed processes. Takes a
438 space-separated list of variable names. This option may be specified more than once, in which case all listed
439 variables will be passed. If the empty string is assigned to this option, the list of environment variables to
440 pass is reset, all prior assignments have no effect. Variables specified that are not set for the system
441 manager will not be passed and will be silently ignored. Note that this option is only relevant for the system
442 service manager, as system services by default do not automatically inherit any environment variables set for
443 the service manager itself. However, in case of the user service manager all environment variables are passed
444 to the executed processes anyway, hence this option is without effect for the user service manager.</para>
445
446 <para>Variables set for invoked processes due to this setting are subject to being overridden by those
447 configured with <varname>Environment=</varname> or <varname>EnvironmentFile=</varname>.</para>
b4c14404
FB
448
449 <para>Example:
450 <programlisting>PassEnvironment=VAR1 VAR2 VAR3</programlisting>
451 passes three variables <literal>VAR1</literal>,
452 <literal>VAR2</literal>, <literal>VAR3</literal>
453 with the values set for those variables in PID1.</para>
454
455 <para>
456 See
457 <citerefentry project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry>
458 for details about environment variables.</para></listitem>
459 </varlistentry>
460
00819cc1
LP
461 <varlistentry>
462 <term><varname>UnsetEnvironment=</varname></term>
463
464 <listitem><para>Explicitly unset environment variable assignments that would normally be passed from the
465 service manager to invoked processes of this unit. Takes a space-separated list of variable names or variable
466 assignments. This option may be specified more than once, in which case all listed variables/assignments will
467 be unset. If the empty string is assigned to this option, the list of environment variables/assignments to
468 unset is reset. If a variable assignment is specified (that is: a variable name, followed by
469 <literal>=</literal>, followed by its value), then any environment variable matching this precise assignment is
470 removed. If a variable name is specified (that is a variable name without any following <literal>=</literal> or
471 value), then any assignment matching the variable name, regardless of its value is removed. Note that the
472 effect of <varname>UnsetEnvironment=</varname> is applied as final step when the environment list passed to
473 executed processes is compiled. That means it may undo assignments from any configuration source, including
474 assignments made through <varname>Environment=</varname> or <varname>EnvironmentFile=</varname>, inherited from
475 the system manager's global set of environment variables, inherited via <varname>PassEnvironment=</varname>,
476 set by the service manager itself (such as <varname>$NOTIFY_SOCKET</varname> and such), or set by a PAM module
477 (in case <varname>PAMName=</varname> is used).</para>
478
479 <para>
480 See
481 <citerefentry project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry>
482 for details about environment variables.</para></listitem>
483 </varlistentry>
484
798d3a52
ZJS
485 <varlistentry>
486 <term><varname>StandardInput=</varname></term>
487 <listitem><para>Controls where file descriptor 0 (STDIN) of
488 the executed processes is connected to. Takes one of
489 <option>null</option>,
490 <option>tty</option>,
491 <option>tty-force</option>,
52c239d7
LB
492 <option>tty-fail</option>,
493 <option>socket</option> or
494 <option>fd</option>.</para>
798d3a52
ZJS
495
496 <para>If <option>null</option> is selected, standard input
497 will be connected to <filename>/dev/null</filename>, i.e. all
498 read attempts by the process will result in immediate
499 EOF.</para>
500
501 <para>If <option>tty</option> is selected, standard input is
502 connected to a TTY (as configured by
503 <varname>TTYPath=</varname>, see below) and the executed
504 process becomes the controlling process of the terminal. If
505 the terminal is already being controlled by another process,
506 the executed process waits until the current controlling
507 process releases the terminal.</para>
508
509 <para><option>tty-force</option> is similar to
510 <option>tty</option>, but the executed process is forcefully
511 and immediately made the controlling process of the terminal,
512 potentially removing previous controlling processes from the
513 terminal.</para>
514
515 <para><option>tty-fail</option> is similar to
516 <option>tty</option> but if the terminal already has a
517 controlling process start-up of the executed process
518 fails.</para>
519
520 <para>The <option>socket</option> option is only valid in
521 socket-activated services, and only when the socket
522 configuration file (see
523 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>
524 for details) specifies a single socket only. If this option is
525 set, standard input will be connected to the socket the
526 service was activated from, which is primarily useful for
527 compatibility with daemons designed for use with the
528 traditional
b5c7d097 529 <citerefentry project='freebsd'><refentrytitle>inetd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
798d3a52
ZJS
530 daemon.</para>
531
52c239d7
LB
532 <para>The <option>fd</option> option connects
533 the input stream to a single file descriptor provided by a socket unit.
534 A custom named file descriptor can be specified as part of this option,
535 after a <literal>:</literal> (e.g. <literal>fd:<replaceable>foobar</replaceable></literal>).
536 If no name is specified, <literal>stdin</literal> is assumed
537 (i.e. <literal>fd</literal> is equivalent to <literal>fd:stdin</literal>).
538 At least one socket unit defining such name must be explicitly provided via the
539 <varname>Sockets=</varname> option, and file descriptor name may differ
540 from the name of its containing socket unit.
541 If multiple matches are found, the first one will be used.
542 See <varname>FileDescriptorName=</varname> in
543 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>
544 for more details about named descriptors and ordering.</para>
545
798d3a52
ZJS
546 <para>This setting defaults to
547 <option>null</option>.</para></listitem>
548 </varlistentry>
c129bd5d 549
798d3a52
ZJS
550 <varlistentry>
551 <term><varname>StandardOutput=</varname></term>
552 <listitem><para>Controls where file descriptor 1 (STDOUT) of
553 the executed processes is connected to. Takes one of
554 <option>inherit</option>,
555 <option>null</option>,
556 <option>tty</option>,
557 <option>journal</option>,
558 <option>syslog</option>,
559 <option>kmsg</option>,
560 <option>journal+console</option>,
561 <option>syslog+console</option>,
52c239d7
LB
562 <option>kmsg+console</option>,
563 <option>socket</option> or
564 <option>fd</option>.</para>
798d3a52
ZJS
565
566 <para><option>inherit</option> duplicates the file descriptor
567 of standard input for standard output.</para>
568
569 <para><option>null</option> connects standard output to
570 <filename>/dev/null</filename>, i.e. everything written to it
571 will be lost.</para>
572
573 <para><option>tty</option> connects standard output to a tty
574 (as configured via <varname>TTYPath=</varname>, see below). If
575 the TTY is used for output only, the executed process will not
576 become the controlling process of the terminal, and will not
577 fail or wait for other processes to release the
578 terminal.</para>
579
580 <para><option>journal</option> connects standard output with
581 the journal which is accessible via
582 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
583 Note that everything that is written to syslog or kmsg (see
584 below) is implicitly stored in the journal as well, the
585 specific two options listed below are hence supersets of this
586 one.</para>
587
588 <para><option>syslog</option> connects standard output to the
589 <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
590 system syslog service, in addition to the journal. Note that
591 the journal daemon is usually configured to forward everything
592 it receives to syslog anyway, in which case this option is no
593 different from <option>journal</option>.</para>
594
595 <para><option>kmsg</option> connects standard output with the
596 kernel log buffer which is accessible via
597 <citerefentry project='man-pages'><refentrytitle>dmesg</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
598 in addition to the journal. The journal daemon might be
599 configured to send all logs to kmsg anyway, in which case this
600 option is no different from <option>journal</option>.</para>
601
602 <para><option>journal+console</option>,
603 <option>syslog+console</option> and
604 <option>kmsg+console</option> work in a similar way as the
605 three options above but copy the output to the system console
606 as well.</para>
607
608 <para><option>socket</option> connects standard output to a
609 socket acquired via socket activation. The semantics are
610 similar to the same option of
611 <varname>StandardInput=</varname>.</para>
612
52c239d7
LB
613 <para>The <option>fd</option> option connects
614 the output stream to a single file descriptor provided by a socket unit.
615 A custom named file descriptor can be specified as part of this option,
616 after a <literal>:</literal> (e.g. <literal>fd:<replaceable>foobar</replaceable></literal>).
617 If no name is specified, <literal>stdout</literal> is assumed
618 (i.e. <literal>fd</literal> is equivalent to <literal>fd:stdout</literal>).
619 At least one socket unit defining such name must be explicitly provided via the
620 <varname>Sockets=</varname> option, and file descriptor name may differ
621 from the name of its containing socket unit.
622 If multiple matches are found, the first one will be used.
623 See <varname>FileDescriptorName=</varname> in
624 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>
625 for more details about named descriptors and ordering.</para>
626
dfe85b38
LP
627 <para>If the standard output (or error output, see below) of a unit is connected to the journal, syslog or the
628 kernel log buffer, the unit will implicitly gain a dependency of type <varname>After=</varname> on
b0e8cec2
LP
629 <filename>systemd-journald.socket</filename> (also see the "Implicit Dependencies" section above). Also note
630 that in this case stdout (or stderr, see below) will be an <constant>AF_UNIX</constant> stream socket, and not
631 a pipe or FIFO that can be re-opened. This means when executing shell scripts the construct <command>echo
632 "hello" &gt; /dev/stderr</command> for writing text to stderr will not work. To mitigate this use the construct
633 <command>echo "hello" >&amp;2</command> instead, which is mostly equivalent and avoids this pitfall.</para>
28c75e25 634
798d3a52 635 <para>This setting defaults to the value set with
79849927 636 <varname>DefaultStandardOutput=</varname> in
798d3a52 637 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
c129bd5d
LP
638 which defaults to <option>journal</option>. Note that setting
639 this parameter might result in additional dependencies to be
b0e8cec2
LP
640 added to the unit (see above).</para>
641 </listitem>
798d3a52 642 </varlistentry>
c129bd5d 643
798d3a52
ZJS
644 <varlistentry>
645 <term><varname>StandardError=</varname></term>
646 <listitem><para>Controls where file descriptor 2 (STDERR) of
647 the executed processes is connected to. The available options
648 are identical to those of <varname>StandardOutput=</varname>,
52c239d7 649 with some exceptions: if set to <option>inherit</option> the
798d3a52 650 file descriptor used for standard output is duplicated for
52c239d7
LB
651 standard error, while <option>fd</option> operates on the error
652 stream and will look by default for a descriptor named
653 <literal>stderr</literal>.</para>
654
655 <para>This setting defaults to the value set with
79849927 656 <varname>DefaultStandardError=</varname> in
798d3a52 657 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
c129bd5d
LP
658 which defaults to <option>inherit</option>. Note that setting
659 this parameter might result in additional dependencies to be
660 added to the unit (see above).</para></listitem>
798d3a52 661 </varlistentry>
c129bd5d 662
798d3a52
ZJS
663 <varlistentry>
664 <term><varname>TTYPath=</varname></term>
665 <listitem><para>Sets the terminal device node to use if
666 standard input, output, or error are connected to a TTY (see
667 above). Defaults to
668 <filename>/dev/console</filename>.</para></listitem>
669 </varlistentry>
670 <varlistentry>
671 <term><varname>TTYReset=</varname></term>
672 <listitem><para>Reset the terminal device specified with
673 <varname>TTYPath=</varname> before and after execution.
674 Defaults to <literal>no</literal>.</para></listitem>
675 </varlistentry>
676 <varlistentry>
677 <term><varname>TTYVHangup=</varname></term>
678 <listitem><para>Disconnect all clients which have opened the
679 terminal device specified with <varname>TTYPath=</varname>
680 before and after execution. Defaults to
681 <literal>no</literal>.</para></listitem>
682 </varlistentry>
683 <varlistentry>
684 <term><varname>TTYVTDisallocate=</varname></term>
685 <listitem><para>If the terminal device specified with
686 <varname>TTYPath=</varname> is a virtual console terminal, try
687 to deallocate the TTY before and after execution. This ensures
688 that the screen and scrollback buffer is cleared. Defaults to
689 <literal>no</literal>.</para></listitem>
690 </varlistentry>
4d14b2bd 691
798d3a52
ZJS
692 <varlistentry>
693 <term><varname>SyslogIdentifier=</varname></term>
4d14b2bd
LP
694 <listitem><para>Sets the process name ("<command>syslog</command> tag") to prefix log lines sent to the logging
695 system or the kernel log buffer with. If not set, defaults to the process name of the executed process. This
696 option is only useful when <varname>StandardOutput=</varname> or <varname>StandardError=</varname> are set to
697 <option>journal</option>, <option>syslog</option> or <option>kmsg</option> (or to the same settings in
698 combination with <option>+console</option>) and only applies to log messages written to stdout or
699 stderr.</para></listitem>
798d3a52 700 </varlistentry>
4d14b2bd 701
798d3a52
ZJS
702 <varlistentry>
703 <term><varname>SyslogFacility=</varname></term>
4d14b2bd
LP
704 <listitem><para>Sets the <command>syslog</command> facility identifier to use when logging. One of
705 <option>kern</option>, <option>user</option>, <option>mail</option>, <option>daemon</option>,
706 <option>auth</option>, <option>syslog</option>, <option>lpr</option>, <option>news</option>,
707 <option>uucp</option>, <option>cron</option>, <option>authpriv</option>, <option>ftp</option>,
708 <option>local0</option>, <option>local1</option>, <option>local2</option>, <option>local3</option>,
709 <option>local4</option>, <option>local5</option>, <option>local6</option> or <option>local7</option>. See
798d3a52 710 <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
4d14b2bd
LP
711 for details. This option is only useful when <varname>StandardOutput=</varname> or
712 <varname>StandardError=</varname> are set to <option>journal</option>, <option>syslog</option> or
713 <option>kmsg</option> (or to the same settings in combination with <option>+console</option>), and only applies
714 to log messages written to stdout or stderr. Defaults to <option>daemon</option>.</para></listitem>
798d3a52 715 </varlistentry>
4d14b2bd 716
798d3a52
ZJS
717 <varlistentry>
718 <term><varname>SyslogLevel=</varname></term>
4d14b2bd
LP
719 <listitem><para>The default <command>syslog</command> log level to use when logging to the logging system or
720 the kernel log buffer. One of <option>emerg</option>, <option>alert</option>, <option>crit</option>,
721 <option>err</option>, <option>warning</option>, <option>notice</option>, <option>info</option>,
722 <option>debug</option>. See <citerefentry
723 project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry> for
724 details. This option is only useful when <varname>StandardOutput=</varname> or
725 <varname>StandardError=</varname> are set to <option>journal</option>, <option>syslog</option> or
726 <option>kmsg</option> (or to the same settings in combination with <option>+console</option>), and only applies
727 to log messages written to stdout or stderr. Note that individual lines output by executed processes may be
728 prefixed with a different log level which can be used to override the default log level specified here. The
729 interpretation of these prefixes may be disabled with <varname>SyslogLevelPrefix=</varname>, see below. For
730 details, see <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
798d3a52 731
4d14b2bd 732 Defaults to <option>info</option>.</para></listitem>
798d3a52
ZJS
733 </varlistentry>
734
735 <varlistentry>
736 <term><varname>SyslogLevelPrefix=</varname></term>
4d14b2bd
LP
737 <listitem><para>Takes a boolean argument. If true and <varname>StandardOutput=</varname> or
738 <varname>StandardError=</varname> are set to <option>journal</option>, <option>syslog</option> or
739 <option>kmsg</option> (or to the same settings in combination with <option>+console</option>), log lines
740 written by the executed process that are prefixed with a log level will be processed with this log level set
741 but the prefix removed. If set to false, the interpretation of these prefixes is disabled and the logged lines
742 are passed on as-is. This only applies to log messages written to stdout or stderr. For details
743 about this prefixing see
744 <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>. Defaults to
745 true.</para></listitem>
798d3a52
ZJS
746 </varlistentry>
747
8b8de13d
LP
748 <varlistentry>
749 <term><varname>LogLevelMax=</varname></term>
750 <listitem><para>Configures filtering by log level of log messages generated by this unit. Takes a
751 <command>syslog</command> log level, one of <option>emerg</option> (lowest log level, only highest priority
752 messages), <option>alert</option>, <option>crit</option>, <option>err</option>, <option>warning</option>,
753 <option>notice</option>, <option>info</option>, <option>debug</option> (highest log level, also lowest priority
754 messages). See <citerefentry
755 project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry> for
756 details. By default no filtering is applied (i.e. the default maximum log level is <option>debug</option>). Use
757 this option to configure the logging system to drop log messages of a specific service above the specified
758 level. For example, set <varname>LogLevelMax=</varname><option>info</option> in order to turn off debug logging
759 of a particularly chatty unit. Note that the the configured level is applied to any log messages written by any
760 of the processes belonging to this unit, sent via any supported logging protocol. The filtering is applied
761 early in the logging pipeline, before any kind of further processing is done. Moreover, messages which pass
762 through this filter successfully might still be dropped by filters applied at a later stage in the logging
763 subsystem. For example, <varname>MaxLevelStore=</varname> configured in
764 <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> might
765 prohibit messages of higher log levels to be stored on disk, even though the per-unit
766 <varname>LogLevelMax=</varname> permitted it to be processed.</para></listitem>
767 </varlistentry>
768
769 <varlistentry>
770 <term><varname>LogExtraFields=</varname></term>
771 <listitem><para>Configures additional log metadata fields to include in all log records generated by processes
772 associated with this unit. This setting takes one or more journal field assignments in the format
773 <literal>FIELD=VALUE</literal> separated by whitespace. See
774 <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
775 details on the journal field concept. Even though the underlying journal implementation permits binary field
776 values, this setting accepts only valid UTF-8 values. To include space characters in a journal field value,
777 enclose the assignment in double quotes ("). The usual specifiers are expanded in all assignments (see
778 below). Note that this setting is not only useful for attaching additional metadata to log records of a unit,
779 but given that all fields and values are indexed may also be used to implement cross-unit log record
780 matching. Assign an empty string to reset the list.</para></listitem>
781 </varlistentry>
782
798d3a52
ZJS
783 <varlistentry>
784 <term><varname>TimerSlackNSec=</varname></term>
785 <listitem><para>Sets the timer slack in nanoseconds for the
786 executed processes. The timer slack controls the accuracy of
787 wake-ups triggered by timers. See
788 <citerefentry><refentrytitle>prctl</refentrytitle><manvolnum>2</manvolnum></citerefentry>
789 for more information. Note that in contrast to most other time
790 span definitions this parameter takes an integer value in
791 nano-seconds if no unit is specified. The usual time units are
792 understood too.</para></listitem>
793 </varlistentry>
794
795 <varlistentry>
796 <term><varname>LimitCPU=</varname></term>
797 <term><varname>LimitFSIZE=</varname></term>
798 <term><varname>LimitDATA=</varname></term>
799 <term><varname>LimitSTACK=</varname></term>
800 <term><varname>LimitCORE=</varname></term>
801 <term><varname>LimitRSS=</varname></term>
802 <term><varname>LimitNOFILE=</varname></term>
803 <term><varname>LimitAS=</varname></term>
804 <term><varname>LimitNPROC=</varname></term>
805 <term><varname>LimitMEMLOCK=</varname></term>
806 <term><varname>LimitLOCKS=</varname></term>
807 <term><varname>LimitSIGPENDING=</varname></term>
808 <term><varname>LimitMSGQUEUE=</varname></term>
809 <term><varname>LimitNICE=</varname></term>
810 <term><varname>LimitRTPRIO=</varname></term>
811 <term><varname>LimitRTTIME=</varname></term>
29857001
LP
812 <listitem><para>Set soft and hard limits on various resources for executed processes. See
813 <citerefentry><refentrytitle>setrlimit</refentrytitle><manvolnum>2</manvolnum></citerefentry> for details on
814 the resource limit concept. Resource limits may be specified in two formats: either as single value to set a
815 specific soft and hard limit to the same value, or as colon-separated pair <option>soft:hard</option> to set
79849927 816 both limits individually (e.g. <literal>LimitAS=4G:16G</literal>). Use the string <option>infinity</option>
29857001
LP
817 to configure no limit on a specific resource. The multiplicative suffixes K, M, G, T, P and E (to the base
818 1024) may be used for resource limits measured in bytes (e.g. LimitAS=16G). For the limits referring to time
819 values, the usual time units ms, s, min, h and so on may be used (see
820 <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
821 details). Note that if no time unit is specified for <varname>LimitCPU=</varname> the default unit of seconds
822 is implied, while for <varname>LimitRTTIME=</varname> the default unit of microseconds is implied. Also, note
823 that the effective granularity of the limits might influence their enforcement. For example, time limits
824 specified for <varname>LimitCPU=</varname> will be rounded up implicitly to multiples of 1s. For
825 <varname>LimitNICE=</varname> the value may be specified in two syntaxes: if prefixed with <literal>+</literal>
826 or <literal>-</literal>, the value is understood as regular Linux nice value in the range -20..19. If not
827 prefixed like this the value is understood as raw resource limit parameter in the range 0..40 (with 0 being
828 equivalent to 1).</para>
a4c18002
LP
829
830 <para>Note that most process resource limits configured with
831 these options are per-process, and processes may fork in order
832 to acquire a new set of resources that are accounted
833 independently of the original process, and may thus escape
834 limits set. Also note that <varname>LimitRSS=</varname> is not
835 implemented on Linux, and setting it has no effect. Often it
836 is advisable to prefer the resource controls listed in
837 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
838 over these per-process limits, as they apply to services as a
839 whole, may be altered dynamically at runtime, and are
840 generally more expressive. For example,
841 <varname>MemoryLimit=</varname> is a more powerful (and
842 working) replacement for <varname>LimitRSS=</varname>.</para>
798d3a52 843
f4c9356d
LP
844 <para>For system units these resource limits may be chosen freely. For user units however (i.e. units run by a
845 per-user instance of
846 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>), these limits are
847 bound by (possibly more restrictive) per-user limits enforced by the OS.</para>
848
849 <para>Resource limits not configured explicitly for a unit default to the value configured in the various
850 <varname>DefaultLimitCPU=</varname>, <varname>DefaultLimitFSIZE=</varname>, … options available in
851 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, and –
852 if not configured there – the kernel or per-user defaults, as defined by the OS (the latter only for user
853 services, see above).</para>
854
798d3a52 855 <table>
f4c9356d 856 <title>Resource limit directives, their equivalent <command>ulimit</command> shell commands and the unit used</title>
798d3a52 857
a4c18002 858 <tgroup cols='3'>
798d3a52
ZJS
859 <colspec colname='directive' />
860 <colspec colname='equivalent' />
a4c18002 861 <colspec colname='unit' />
798d3a52
ZJS
862 <thead>
863 <row>
864 <entry>Directive</entry>
f4c9356d 865 <entry><command>ulimit</command> equivalent</entry>
a4c18002 866 <entry>Unit</entry>
798d3a52
ZJS
867 </row>
868 </thead>
869 <tbody>
870 <row>
a4c18002 871 <entry>LimitCPU=</entry>
798d3a52 872 <entry>ulimit -t</entry>
a4c18002 873 <entry>Seconds</entry>
798d3a52
ZJS
874 </row>
875 <row>
a4c18002 876 <entry>LimitFSIZE=</entry>
798d3a52 877 <entry>ulimit -f</entry>
a4c18002 878 <entry>Bytes</entry>
798d3a52
ZJS
879 </row>
880 <row>
a4c18002 881 <entry>LimitDATA=</entry>
798d3a52 882 <entry>ulimit -d</entry>
a4c18002 883 <entry>Bytes</entry>
798d3a52
ZJS
884 </row>
885 <row>
a4c18002 886 <entry>LimitSTACK=</entry>
798d3a52 887 <entry>ulimit -s</entry>
a4c18002 888 <entry>Bytes</entry>
798d3a52
ZJS
889 </row>
890 <row>
a4c18002 891 <entry>LimitCORE=</entry>
798d3a52 892 <entry>ulimit -c</entry>
a4c18002 893 <entry>Bytes</entry>
798d3a52
ZJS
894 </row>
895 <row>
a4c18002 896 <entry>LimitRSS=</entry>
798d3a52 897 <entry>ulimit -m</entry>
a4c18002 898 <entry>Bytes</entry>
798d3a52
ZJS
899 </row>
900 <row>
a4c18002 901 <entry>LimitNOFILE=</entry>
798d3a52 902 <entry>ulimit -n</entry>
a4c18002 903 <entry>Number of File Descriptors</entry>
798d3a52
ZJS
904 </row>
905 <row>
a4c18002 906 <entry>LimitAS=</entry>
798d3a52 907 <entry>ulimit -v</entry>
a4c18002 908 <entry>Bytes</entry>
798d3a52
ZJS
909 </row>
910 <row>
a4c18002 911 <entry>LimitNPROC=</entry>
798d3a52 912 <entry>ulimit -u</entry>
a4c18002 913 <entry>Number of Processes</entry>
798d3a52
ZJS
914 </row>
915 <row>
a4c18002 916 <entry>LimitMEMLOCK=</entry>
798d3a52 917 <entry>ulimit -l</entry>
a4c18002 918 <entry>Bytes</entry>
798d3a52
ZJS
919 </row>
920 <row>
a4c18002 921 <entry>LimitLOCKS=</entry>
798d3a52 922 <entry>ulimit -x</entry>
a4c18002 923 <entry>Number of Locks</entry>
798d3a52
ZJS
924 </row>
925 <row>
a4c18002 926 <entry>LimitSIGPENDING=</entry>
798d3a52 927 <entry>ulimit -i</entry>
a4c18002 928 <entry>Number of Queued Signals</entry>
798d3a52
ZJS
929 </row>
930 <row>
a4c18002 931 <entry>LimitMSGQUEUE=</entry>
798d3a52 932 <entry>ulimit -q</entry>
a4c18002 933 <entry>Bytes</entry>
798d3a52
ZJS
934 </row>
935 <row>
a4c18002 936 <entry>LimitNICE=</entry>
798d3a52 937 <entry>ulimit -e</entry>
a4c18002 938 <entry>Nice Level</entry>
798d3a52
ZJS
939 </row>
940 <row>
a4c18002 941 <entry>LimitRTPRIO=</entry>
798d3a52 942 <entry>ulimit -r</entry>
a4c18002 943 <entry>Realtime Priority</entry>
798d3a52
ZJS
944 </row>
945 <row>
a4c18002 946 <entry>LimitRTTIME=</entry>
798d3a52 947 <entry>No equivalent</entry>
a4c18002 948 <entry>Microseconds</entry>
798d3a52
ZJS
949 </row>
950 </tbody>
951 </tgroup>
a4c18002 952 </table></listitem>
798d3a52
ZJS
953 </varlistentry>
954
955 <varlistentry>
956 <term><varname>PAMName=</varname></term>
9eb484fa
LP
957 <listitem><para>Sets the PAM service name to set up a session as. If set, the executed process will be
958 registered as a PAM session under the specified service name. This is only useful in conjunction with the
959 <varname>User=</varname> setting, and is otherwise ignored. If not set, no PAM session will be opened for the
960 executed processes. See <citerefentry
961 project='man-pages'><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry> for
962 details.</para>
963
964 <para>Note that for each unit making use of this option a PAM session handler process will be maintained as
965 part of the unit and stays around as long as the unit is active, to ensure that appropriate actions can be
966 taken when the unit and hence the PAM session terminates. This process is named <literal>(sd-pam)</literal> and
5aaeeffb
LP
967 is an immediate child process of the unit's main process.</para>
968
969 <para>Note that when this option is used for a unit it is very likely (depending on PAM configuration) that the
970 main unit process will be migrated to its own session scope unit when it is activated. This process will hence
971 be associated with two units: the unit it was originally started from (and for which
972 <varname>PAMName=</varname> was configured), and the session scope unit. Any child processes of that process
973 will however be associated with the session scope unit only. This has implications when used in combination
974 with <varname>NotifyAccess=</varname><option>all</option>, as these child processes will not be able to affect
975 changes in the original unit through notification messages. These messages will be considered belonging to the
976 session scope unit and not the original unit. It is hence not recommended to use <varname>PAMName=</varname> in
977 combination with <varname>NotifyAccess=</varname><option>all</option>.</para>
978 </listitem>
798d3a52
ZJS
979 </varlistentry>
980
981 <varlistentry>
982 <term><varname>CapabilityBoundingSet=</varname></term>
983
479050b3
LP
984 <listitem><para>Controls which capabilities to include in the capability bounding set for the executed
985 process. See <citerefentry
986 project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
b2656f1b
LP
987 details. Takes a whitespace-separated list of capability names, e.g. <constant>CAP_SYS_ADMIN</constant>,
988 <constant>CAP_DAC_OVERRIDE</constant>, <constant>CAP_SYS_PTRACE</constant>. Capabilities listed will be
989 included in the bounding set, all others are removed. If the list of capabilities is prefixed with
990 <literal>~</literal>, all but the listed capabilities will be included, the effect of the assignment
991 inverted. Note that this option also affects the respective capabilities in the effective, permitted and
992 inheritable capability sets. If this option is not used, the capability bounding set is not modified on process
993 execution, hence no limits on the capabilities of the process are enforced. This option may appear more than
de7070b4
YW
994 once, in which case the bounding sets are merged by <constant>AND</constant>, or by <constant>OR</constant>
995 if the lines are prefixed with <literal>~</literal> (see below). If the empty string is assigned
996 to this option, the bounding set is reset to the empty capability set, and all prior settings have no effect.
997 If set to <literal>~</literal> (without any further argument), the bounding set is reset to the full set of available
b2656f1b 998 capabilities, also undoing any previous settings. This does not affect commands prefixed with
de7070b4
YW
999 <literal>+</literal>.</para>
1000
1001 <para>Example: if a unit has the following,
1002 <programlisting>CapabilityBoundingSet=CAP_A CAP_B
1003CapabilityBoundingSet=CAP_B CAP_C</programlisting>
1004 then <constant>CAP_A</constant>, <constant>CAP_B</constant>, and <constant>CAP_C</constant> are set.
1005 If the second line is prefixed with <literal>~</literal>, e.g.,
1006 <programlisting>CapabilityBoundingSet=CAP_A CAP_B
1007CapabilityBoundingSet=~CAP_B CAP_C</programlisting>
1008 then, only <constant>CAP_A</constant> is set.</para></listitem>
798d3a52
ZJS
1009 </varlistentry>
1010
ece87975
IP
1011 <varlistentry>
1012 <term><varname>AmbientCapabilities=</varname></term>
1013
b2656f1b
LP
1014 <listitem><para>Controls which capabilities to include in the ambient capability set for the executed
1015 process. Takes a whitespace-separated list of capability names, e.g. <constant>CAP_SYS_ADMIN</constant>,
1016 <constant>CAP_DAC_OVERRIDE</constant>, <constant>CAP_SYS_PTRACE</constant>. This option may appear more than
de7070b4
YW
1017 once in which case the ambient capability sets are merged (see the above examples in
1018 <varname>CapabilityBoundingSet=</varname>). If the list of capabilities is prefixed with
b2656f1b
LP
1019 <literal>~</literal>, all but the listed capabilities will be included, the effect of the assignment
1020 inverted. If the empty string is assigned to this option, the ambient capability set is reset to the empty
1021 capability set, and all prior settings have no effect. If set to <literal>~</literal> (without any further
1022 argument), the ambient capability set is reset to the full set of available capabilities, also undoing any
1023 previous settings. Note that adding capabilities to ambient capability set adds them to the process's inherited
1024 capability set. </para><para> Ambient capability sets are useful if you want to execute a process as a
1025 non-privileged user but still want to give it some capabilities. Note that in this case option
1026 <constant>keep-caps</constant> is automatically added to <varname>SecureBits=</varname> to retain the
1027 capabilities over the user change. <varname>AmbientCapabilities=</varname> does not affect commands prefixed
1028 with <literal>+</literal>.</para></listitem>
ece87975
IP
1029 </varlistentry>
1030
798d3a52
ZJS
1031 <varlistentry>
1032 <term><varname>SecureBits=</varname></term>
1033 <listitem><para>Controls the secure bits set for the executed
1034 process. Takes a space-separated combination of options from
1035 the following list:
1036 <option>keep-caps</option>,
1037 <option>keep-caps-locked</option>,
1038 <option>no-setuid-fixup</option>,
1039 <option>no-setuid-fixup-locked</option>,
1040 <option>noroot</option>, and
1041 <option>noroot-locked</option>.
b938cb90 1042 This option may appear more than once, in which case the secure
798d3a52 1043 bits are ORed. If the empty string is assigned to this option,
43eb109a 1044 the bits are reset to 0. This does not affect commands prefixed with <literal>+</literal>.
cf677fe6 1045 See <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
798d3a52
ZJS
1046 for details.</para></listitem>
1047 </varlistentry>
1048
798d3a52 1049 <varlistentry>
2a624c36
AP
1050 <term><varname>ReadWritePaths=</varname></term>
1051 <term><varname>ReadOnlyPaths=</varname></term>
1052 <term><varname>InaccessiblePaths=</varname></term>
798d3a52 1053
effbd6d2
LP
1054 <listitem><para>Sets up a new file system namespace for executed processes. These options may be used to limit
1055 access a process might have to the file system hierarchy. Each setting takes a space-separated list of paths
1056 relative to the host's root directory (i.e. the system running the service manager). Note that if paths
1057 contain symlinks, they are resolved relative to the root directory set with
915e6d16 1058 <varname>RootDirectory=</varname>/<varname>RootImage=</varname>.</para>
effbd6d2
LP
1059
1060 <para>Paths listed in <varname>ReadWritePaths=</varname> are accessible from within the namespace with the same
1061 access modes as from outside of it. Paths listed in <varname>ReadOnlyPaths=</varname> are accessible for
1062 reading only, writing will be refused even if the usual file access controls would permit this. Nest
1063 <varname>ReadWritePaths=</varname> inside of <varname>ReadOnlyPaths=</varname> in order to provide writable
1064 subdirectories within read-only directories. Use <varname>ReadWritePaths=</varname> in order to whitelist
1065 specific paths for write access if <varname>ProtectSystem=strict</varname> is used. Paths listed in
1066 <varname>InaccessiblePaths=</varname> will be made inaccessible for processes inside the namespace (along with
1067 everything below them in the file system hierarchy).</para>
1068
1069 <para>Note that restricting access with these options does not extend to submounts of a directory that are
1070 created later on. Non-directory paths may be specified as well. These options may be specified more than once,
1071 in which case all paths listed will have limited access from within the namespace. If the empty string is
1072 assigned to this option, the specific list is reset, and all prior assignments have no effect.</para>
1073
e778185b 1074 <para>Paths in <varname>ReadWritePaths=</varname>, <varname>ReadOnlyPaths=</varname> and
5327c910
LP
1075 <varname>InaccessiblePaths=</varname> may be prefixed with <literal>-</literal>, in which case they will be
1076 ignored when they do not exist. If prefixed with <literal>+</literal> the paths are taken relative to the root
915e6d16
LP
1077 directory of the unit, as configured with <varname>RootDirectory=</varname>/<varname>RootImage=</varname>,
1078 instead of relative to the root directory of the host (see above). When combining <literal>-</literal> and
1079 <literal>+</literal> on the same path make sure to specify <literal>-</literal> first, and <literal>+</literal>
1080 second.</para>
5327c910
LP
1081
1082 <para>Note that using this setting will disconnect propagation of mounts from the service to the host
1083 (propagation in the opposite direction continues to work). This means that this setting may not be used for
1084 services which shall be able to install mount points in the main mount namespace. Note that the effect of these
1085 settings may be undone by privileged processes. In order to set up an effective sandboxed environment for a
1086 unit it is thus recommended to combine these settings with either
1087 <varname>CapabilityBoundingSet=~CAP_SYS_ADMIN</varname> or
1088 <varname>SystemCallFilter=~@mount</varname>.</para></listitem>
798d3a52
ZJS
1089 </varlistentry>
1090
d2d6c096
LP
1091 <varlistentry>
1092 <term><varname>BindPaths=</varname></term>
1093 <term><varname>BindReadOnlyPaths=</varname></term>
1094
1095 <listitem><para>Configures unit-specific bind mounts. A bind mount makes a particular file or directory
1096 available at an additional place in the unit's view of the file system. Any bind mounts created with this
1097 option are specific to the unit, and are not visible in the host's mount table. This option expects a
1098 whitespace separated list of bind mount definitions. Each definition consists of a colon-separated triple of
1099 source path, destination path and option string, where the latter two are optional. If only a source path is
1100 specified the source and destination is taken to be the same. The option string may be either
1101 <literal>rbind</literal> or <literal>norbind</literal> for configuring a recursive or non-recursive bind
98063016 1102 mount. If the destination path is omitted, the option string must be omitted too.</para>
d2d6c096
LP
1103
1104 <para><varname>BindPaths=</varname> creates regular writable bind mounts (unless the source file system mount
1105 is already marked read-only), while <varname>BindReadOnlyPaths=</varname> creates read-only bind mounts. These
1106 settings may be used more than once, each usage appends to the unit's list of bind mounts. If the empty string
1107 is assigned to either of these two options the entire list of bind mounts defined prior to this is reset. Note
1108 that in this case both read-only and regular bind mounts are reset, regardless which of the two settings is
1109 used.</para>
1110
915e6d16
LP
1111 <para>This option is particularly useful when <varname>RootDirectory=</varname>/<varname>RootImage=</varname>
1112 is used. In this case the source path refers to a path on the host file system, while the destination path
1113 refers to a path below the root directory of the unit.</para></listitem>
d2d6c096
LP
1114 </varlistentry>
1115
798d3a52
ZJS
1116 <varlistentry>
1117 <term><varname>PrivateTmp=</varname></term>
1118
00d9ef85
LP
1119 <listitem><para>Takes a boolean argument. If true, sets up a new file system namespace for the executed
1120 processes and mounts private <filename>/tmp</filename> and <filename>/var/tmp</filename> directories inside it
1121 that is not shared by processes outside of the namespace. This is useful to secure access to temporary files of
1122 the process, but makes sharing between processes via <filename>/tmp</filename> or <filename>/var/tmp</filename>
1123 impossible. If this is enabled, all temporary files created by a service in these directories will be removed
1124 after the service is stopped. Defaults to false. It is possible to run two or more units within the same
1125 private <filename>/tmp</filename> and <filename>/var/tmp</filename> namespace by using the
798d3a52 1126 <varname>JoinsNamespaceOf=</varname> directive, see
00d9ef85 1127 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
effbd6d2
LP
1128 details. This setting is implied if <varname>DynamicUser=</varname> is set. For this setting the same
1129 restrictions regarding mount propagation and privileges apply as for <varname>ReadOnlyPaths=</varname> and
d71f0505
LP
1130 related calls, see above. Enabling this setting has the side effect of adding <varname>Requires=</varname> and
1131 <varname>After=</varname> dependencies on all mount units necessary to access <filename>/tmp</filename> and
1132 <filename>/var/tmp</filename>. Moreover an implicitly <varname>After=</varname> ordering on
1133 <citerefentry><refentrytitle>systemd-tmpfiles-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
b0238568
ZJS
1134 is added.</para>
1135
1136 <para>Note that the implementation of this setting might be impossible (for example if mount namespaces
1137 are not available), and the unit should be written in a way that does not solely rely on this setting for
1138 security.</para></listitem>
798d3a52
ZJS
1139 </varlistentry>
1140
1141 <varlistentry>
1142 <term><varname>PrivateDevices=</varname></term>
1143
b0238568
ZJS
1144 <listitem><para>Takes a boolean argument. If true, sets up a new <filename>/dev</filename> mount for the
1145 executed processes and only adds API pseudo devices such as <filename>/dev/null</filename>,
1146 <filename>/dev/zero</filename> or
effbd6d2 1147 <filename>/dev/random</filename> (as well as the pseudo TTY subsystem) to it, but no physical devices such as
9221aec8
DH
1148 <filename>/dev/sda</filename>, system memory <filename>/dev/mem</filename>, system ports
1149 <filename>/dev/port</filename> and others. This is useful to securely turn off physical device access by the
8f81a5f6
DH
1150 executed process. Defaults to false. Enabling this option will install a system call filter to block low-level
1151 I/O system calls that are grouped in the <varname>@raw-io</varname> set, will also remove
2cd0a735
DH
1152 <constant>CAP_MKNOD</constant> and <constant>CAP_SYS_RAWIO</constant> from the capability bounding set for
1153 the unit (see above), and set <varname>DevicePolicy=closed</varname> (see
798d3a52 1154 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
effbd6d2
LP
1155 for details). Note that using this setting will disconnect propagation of mounts from the service to the host
1156 (propagation in the opposite direction continues to work). This means that this setting may not be used for
b0238568
ZJS
1157 services which shall be able to install mount points in the main mount namespace. The new <filename>/dev</filename>
1158 will be mounted read-only and 'noexec'. The latter may break old programs which try to set up executable memory by
effbd6d2 1159 using <citerefentry><refentrytitle>mmap</refentrytitle><manvolnum>2</manvolnum></citerefentry> of
2d35b79c
YW
1160 <filename>/dev/zero</filename> instead of using <constant>MAP_ANON</constant>. For this setting the same restrictions
1161 regarding mount propagation and privileges apply as for <varname>ReadOnlyPaths=</varname> and related calls, see above.
a7db8614 1162 If turned on and if running in user mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant>
2d35b79c 1163 capability (e.g. setting <varname>User=</varname>), <varname>NoNewPrivileges=yes</varname> is implied.
b0238568
ZJS
1164 </para>
1165
1166 <para>Note that the implementation of this setting might be impossible (for example if mount namespaces
1167 are not available), and the unit should be written in a way that does not solely rely on this setting for
1168 security.</para></listitem>
798d3a52
ZJS
1169 </varlistentry>
1170
1171 <varlistentry>
1172 <term><varname>PrivateNetwork=</varname></term>
1173
1174 <listitem><para>Takes a boolean argument. If true, sets up a
1175 new network namespace for the executed processes and
1176 configures only the loopback network device
1177 <literal>lo</literal> inside it. No other network devices will
1178 be available to the executed process. This is useful to
b0238568 1179 turn off network access by the executed process.
798d3a52
ZJS
1180 Defaults to false. It is possible to run two or more units
1181 within the same private network namespace by using the
1182 <varname>JoinsNamespaceOf=</varname> directive, see
1183 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1184 for details. Note that this option will disconnect all socket
1185 families from the host, this includes AF_NETLINK and AF_UNIX.
1186 The latter has the effect that AF_UNIX sockets in the abstract
1187 socket namespace will become unavailable to the processes
1188 (however, those located in the file system will continue to be
b0238568
ZJS
1189 accessible).</para>
1190
1191 <para>Note that the implementation of this setting might be impossible (for example if network namespaces
1192 are not available), and the unit should be written in a way that does not solely rely on this setting for
1193 security.</para></listitem>
798d3a52
ZJS
1194 </varlistentry>
1195
1196 <varlistentry>
d251207d
LP
1197 <term><varname>PrivateUsers=</varname></term>
1198
1199 <listitem><para>Takes a boolean argument. If true, sets up a new user namespace for the executed processes and
1200 configures a minimal user and group mapping, that maps the <literal>root</literal> user and group as well as
1201 the unit's own user and group to themselves and everything else to the <literal>nobody</literal> user and
1202 group. This is useful to securely detach the user and group databases used by the unit from the rest of the
1203 system, and thus to create an effective sandbox environment. All files, directories, processes, IPC objects and
2dd67817 1204 other resources owned by users/groups not equaling <literal>root</literal> or the unit's own will stay visible
d251207d
LP
1205 from within the unit but appear owned by the <literal>nobody</literal> user and group. If this mode is enabled,
1206 all unit processes are run without privileges in the host user namespace (regardless if the unit's own
1207 user/group is <literal>root</literal> or not). Specifically this means that the process will have zero process
1208 capabilities on the host's user namespace, but full capabilities within the service's user namespace. Settings
1209 such as <varname>CapabilityBoundingSet=</varname> will affect only the latter, and there's no way to acquire
1210 additional capabilities in the host's user namespace. Defaults to off.</para>
1211
915e6d16
LP
1212 <para>This setting is particularly useful in conjunction with
1213 <varname>RootDirectory=</varname>/<varname>RootImage=</varname>, as the need to synchronize the user and group
1214 databases in the root directory and on the host is reduced, as the only users and groups who need to be matched
b0238568
ZJS
1215 are <literal>root</literal>, <literal>nobody</literal> and the unit's own user and group.</para>
1216
1217 <para>Note that the implementation of this setting might be impossible (for example if user namespaces
1218 are not available), and the unit should be written in a way that does not solely rely on this setting for
1219 security.</para></listitem>
d251207d
LP
1220 </varlistentry>
1221
798d3a52
ZJS
1222 <varlistentry>
1223 <term><varname>ProtectSystem=</varname></term>
1224
3f815163
LP
1225 <listitem><para>Takes a boolean argument or the special values <literal>full</literal> or
1226 <literal>strict</literal>. If true, mounts the <filename>/usr</filename> and <filename>/boot</filename>
1227 directories read-only for processes invoked by this unit. If set to <literal>full</literal>, the
1228 <filename>/etc</filename> directory is mounted read-only, too. If set to <literal>strict</literal> the entire
1229 file system hierarchy is mounted read-only, except for the API file system subtrees <filename>/dev</filename>,
1230 <filename>/proc</filename> and <filename>/sys</filename> (protect these directories using
1231 <varname>PrivateDevices=</varname>, <varname>ProtectKernelTunables=</varname>,
1232 <varname>ProtectControlGroups=</varname>). This setting ensures that any modification of the vendor-supplied
1233 operating system (and optionally its configuration, and local mounts) is prohibited for the service. It is
1234 recommended to enable this setting for all long-running services, unless they are involved with system updates
1235 or need to modify the operating system in other ways. If this option is used,
effbd6d2
LP
1236 <varname>ReadWritePaths=</varname> may be used to exclude specific directories from being made read-only. This
1237 setting is implied if <varname>DynamicUser=</varname> is set. For this setting the same restrictions regarding
1238 mount propagation and privileges apply as for <varname>ReadOnlyPaths=</varname> and related calls, see
1239 above. Defaults to off.</para></listitem>
798d3a52
ZJS
1240 </varlistentry>
1241
1242 <varlistentry>
1243 <term><varname>ProtectHome=</varname></term>
1244
effbd6d2
LP
1245 <listitem><para>Takes a boolean argument or <literal>read-only</literal>. If true, the directories
1246 <filename>/home</filename>, <filename>/root</filename> and <filename>/run/user</filename> are made inaccessible
1247 and empty for processes invoked by this unit. If set to <literal>read-only</literal>, the three directories are
1248 made read-only instead. It is recommended to enable this setting for all long-running services (in particular
1249 network-facing ones), to ensure they cannot get access to private user data, unless the services actually
1250 require access to the user's private data. This setting is implied if <varname>DynamicUser=</varname> is
1251 set. For this setting the same restrictions regarding mount propagation and privileges apply as for
1252 <varname>ReadOnlyPaths=</varname> and related calls, see above.</para></listitem>
59eeb84b
LP
1253 </varlistentry>
1254
1255 <varlistentry>
1256 <term><varname>ProtectKernelTunables=</varname></term>
1257
1258 <listitem><para>Takes a boolean argument. If true, kernel variables accessible through
49accde7
DH
1259 <filename>/proc/sys</filename>, <filename>/sys</filename>, <filename>/proc/sysrq-trigger</filename>,
1260 <filename>/proc/latency_stats</filename>, <filename>/proc/acpi</filename>,
1261 <filename>/proc/timer_stats</filename>, <filename>/proc/fs</filename> and <filename>/proc/irq</filename> will
525872bf
LP
1262 be made read-only to all processes of the unit. Usually, tunable kernel variables should be initialized only at
1263 boot-time, for example with the
1264 <citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry> mechanism. Few
1265 services need to write to these at runtime; it is hence recommended to turn this on for most services. For this
1266 setting the same restrictions regarding mount propagation and privileges apply as for
1267 <varname>ReadOnlyPaths=</varname> and related calls, see above. Defaults to off. If turned on and if running
1268 in user mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant> capability (e.g. services
1269 for which <varname>User=</varname> is set), <varname>NoNewPrivileges=yes</varname> is implied. Note that this
1270 option does not prevent indirect changes to kernel tunables effected by IPC calls to other processes. However,
1271 <varname>InaccessiblePaths=</varname> may be used to make relevant IPC file system objects inaccessible. If
1272 <varname>ProtectKernelTunables=</varname> is set, <varname>MountAPIVFS=yes</varname> is
1273 implied.</para></listitem>
59eeb84b
LP
1274 </varlistentry>
1275
85265556
DH
1276 <varlistentry>
1277 <term><varname>ProtectKernelModules=</varname></term>
1278
1279 <listitem><para>Takes a boolean argument. If true, explicit module loading will
1280 be denied. This allows to turn off module load and unload operations on modular
1281 kernels. It is recommended to turn this on for most services that do not need special
1282 file systems or extra kernel modules to work. Default to off. Enabling this option
1283 removes <constant>CAP_SYS_MODULE</constant> from the capability bounding set for
1284 the unit, and installs a system call filter to block module system calls,
1285 also <filename>/usr/lib/modules</filename> is made inaccessible. For this
1286 setting the same restrictions regarding mount propagation and privileges
1287 apply as for <varname>ReadOnlyPaths=</varname> and related calls, see above.
1288 Note that limited automatic module loading due to user configuration or kernel
1289 mapping tables might still happen as side effect of requested user operations,
1290 both privileged and unprivileged. To disable module auto-load feature please see
1291 <citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1292 <constant>kernel.modules_disabled</constant> mechanism and
1293 <filename>/proc/sys/kernel/modules_disabled</filename> documentation.
1294 If turned on and if running in user mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant>
1295 capability (e.g. setting <varname>User=</varname>), <varname>NoNewPrivileges=yes</varname>
1296 is implied.
1297 </para></listitem>
1298 </varlistentry>
1299
59eeb84b
LP
1300 <varlistentry>
1301 <term><varname>ProtectControlGroups=</varname></term>
1302
effbd6d2
LP
1303 <listitem><para>Takes a boolean argument. If true, the Linux Control Groups (<citerefentry
1304 project='man-pages'><refentrytitle>cgroups</refentrytitle><manvolnum>7</manvolnum></citerefentry>) hierarchies
1305 accessible through <filename>/sys/fs/cgroup</filename> will be made read-only to all processes of the
1306 unit. Except for container managers no services should require write access to the control groups hierarchies;
1307 it is hence recommended to turn this on for most services. For this setting the same restrictions regarding
1308 mount propagation and privileges apply as for <varname>ReadOnlyPaths=</varname> and related calls, see
525872bf
LP
1309 above. Defaults to off. If <varname>ProtectControlGroups=</varname> is set, <varname>MountAPIVFS=yes</varname> is
1310 implied.</para></listitem>
798d3a52
ZJS
1311 </varlistentry>
1312
1313 <varlistentry>
1314 <term><varname>MountFlags=</varname></term>
1315
effbd6d2
LP
1316 <listitem><para>Takes a mount propagation flag: <option>shared</option>, <option>slave</option> or
1317 <option>private</option>, which control whether mounts in the file system namespace set up for this unit's
7141028d 1318 processes will receive or propagate mounts and unmounts. See <citerefentry
effbd6d2
LP
1319 project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
1320 details. Defaults to <option>shared</option>. Use <option>shared</option> to ensure that mounts and unmounts
fa2a3966
IK
1321 are propagated from systemd's namespace to the service's namespace and vice versa. Use <option>slave</option>
1322 to run processes so that none of their mounts and unmounts will propagate to the host. Use <option>private</option>
374e6922 1323 to also ensure that no mounts and unmounts from the host will propagate into the unit processes' namespace.
4b957756
IK
1324 If this is set to <option>slave</option> or <option>private</option>, any mounts created by spawned processes
1325 will be unmounted after the completion of the current command line of <varname>ExecStartPre=</varname>,
1326 <varname>ExecStartPost=</varname>, <varname>ExecStart=</varname>,
1327 and <varname>ExecStopPost=</varname>. Note that
effbd6d2
LP
1328 <option>slave</option> means that file systems mounted on the host might stay mounted continuously in the
1329 unit's namespace, and thus keep the device busy. Note that the file system namespace related options
1330 (<varname>PrivateTmp=</varname>, <varname>PrivateDevices=</varname>, <varname>ProtectSystem=</varname>,
1331 <varname>ProtectHome=</varname>, <varname>ProtectKernelTunables=</varname>,
1332 <varname>ProtectControlGroups=</varname>, <varname>ReadOnlyPaths=</varname>,
1333 <varname>InaccessiblePaths=</varname>, <varname>ReadWritePaths=</varname>) require that mount and unmount
1334 propagation from the unit's file system namespace is disabled, and hence downgrade <option>shared</option> to
798d3a52
ZJS
1335 <option>slave</option>. </para></listitem>
1336 </varlistentry>
1337
1338 <varlistentry>
1339 <term><varname>UtmpIdentifier=</varname></term>
1340
1341 <listitem><para>Takes a four character identifier string for
023a4f67
LP
1342 an <citerefentry
1343 project='man-pages'><refentrytitle>utmp</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1344 and wtmp entry for this service. This should only be
1345 set for services such as <command>getty</command>
1346 implementations (such as <citerefentry
1347 project='die-net'><refentrytitle>agetty</refentrytitle><manvolnum>8</manvolnum></citerefentry>)
798d3a52 1348 where utmp/wtmp entries must be created and cleared before and
023a4f67
LP
1349 after execution, or for services that shall be executed as if
1350 they were run by a <command>getty</command> process (see
1351 below). If the configured string is longer than four
798d3a52
ZJS
1352 characters, it is truncated and the terminal four characters
1353 are used. This setting interprets %I style string
1354 replacements. This setting is unset by default, i.e. no
1355 utmp/wtmp entries are created or cleaned up for this
1356 service.</para></listitem>
1357 </varlistentry>
1358
023a4f67
LP
1359 <varlistentry>
1360 <term><varname>UtmpMode=</varname></term>
1361
1362 <listitem><para>Takes one of <literal>init</literal>,
1363 <literal>login</literal> or <literal>user</literal>. If
1364 <varname>UtmpIdentifier=</varname> is set, controls which
1365 type of <citerefentry
1366 project='man-pages'><refentrytitle>utmp</refentrytitle><manvolnum>5</manvolnum></citerefentry>/wtmp
1367 entries for this service are generated. This setting has no
1368 effect unless <varname>UtmpIdentifier=</varname> is set
1369 too. If <literal>init</literal> is set, only an
1370 <constant>INIT_PROCESS</constant> entry is generated and the
6cd16034
LP
1371 invoked process must implement a
1372 <command>getty</command>-compatible utmp/wtmp logic. If
1373 <literal>login</literal> is set, first an
a8eaaee7 1374 <constant>INIT_PROCESS</constant> entry, followed by a
6cd16034 1375 <constant>LOGIN_PROCESS</constant> entry is generated. In
b938cb90 1376 this case, the invoked process must implement a <citerefentry
023a4f67
LP
1377 project='die-net'><refentrytitle>login</refentrytitle><manvolnum>1</manvolnum></citerefentry>-compatible
1378 utmp/wtmp logic. If <literal>user</literal> is set, first an
1379 <constant>INIT_PROCESS</constant> entry, then a
a8eaaee7 1380 <constant>LOGIN_PROCESS</constant> entry and finally a
023a4f67 1381 <constant>USER_PROCESS</constant> entry is generated. In this
b938cb90 1382 case, the invoked process may be any process that is suitable
023a4f67
LP
1383 to be run as session leader. Defaults to
1384 <literal>init</literal>.</para></listitem>
1385 </varlistentry>
1386
798d3a52
ZJS
1387 <varlistentry>
1388 <term><varname>SELinuxContext=</varname></term>
1389
1390 <listitem><para>Set the SELinux security context of the
1391 executed process. If set, this will override the automated
1392 domain transition. However, the policy still needs to
1393 authorize the transition. This directive is ignored if SELinux
1394 is disabled. If prefixed by <literal>-</literal>, all errors
43eb109a 1395 will be ignored. This does not affect commands prefixed with <literal>+</literal>.
cf677fe6 1396 See <citerefentry project='die-net'><refentrytitle>setexeccon</refentrytitle><manvolnum>3</manvolnum></citerefentry>
798d3a52
ZJS
1397 for details.</para></listitem>
1398 </varlistentry>
1399
1400 <varlistentry>
1401 <term><varname>AppArmorProfile=</varname></term>
1402
1403 <listitem><para>Takes a profile name as argument. The process
1404 executed by the unit will switch to this profile when started.
1405 Profiles must already be loaded in the kernel, or the unit
1406 will fail. This result in a non operation if AppArmor is not
1407 enabled. If prefixed by <literal>-</literal>, all errors will
43eb109a 1408 be ignored. This does not affect commands prefixed with <literal>+</literal>.</para></listitem>
798d3a52
ZJS
1409 </varlistentry>
1410
1411 <varlistentry>
1412 <term><varname>SmackProcessLabel=</varname></term>
1413
1414 <listitem><para>Takes a <option>SMACK64</option> security
1415 label as argument. The process executed by the unit will be
1416 started under this label and SMACK will decide whether the
b938cb90 1417 process is allowed to run or not, based on it. The process
798d3a52
ZJS
1418 will continue to run under the label specified here unless the
1419 executable has its own <option>SMACK64EXEC</option> label, in
1420 which case the process will transition to run under that
1421 label. When not specified, the label that systemd is running
1422 under is used. This directive is ignored if SMACK is
1423 disabled.</para>
1424
1425 <para>The value may be prefixed by <literal>-</literal>, in
1426 which case all errors will be ignored. An empty value may be
cf677fe6 1427 specified to unset previous assignments. This does not affect
43eb109a 1428 commands prefixed with <literal>+</literal>.</para>
798d3a52
ZJS
1429 </listitem>
1430 </varlistentry>
1431
1432 <varlistentry>
1433 <term><varname>IgnoreSIGPIPE=</varname></term>
1434
1435 <listitem><para>Takes a boolean argument. If true, causes
1436 <constant>SIGPIPE</constant> to be ignored in the executed
1437 process. Defaults to true because <constant>SIGPIPE</constant>
1438 generally is useful only in shell pipelines.</para></listitem>
1439 </varlistentry>
1440
1441 <varlistentry>
1442 <term><varname>NoNewPrivileges=</varname></term>
1443
add00535
LP
1444 <listitem><para>Takes a boolean argument. If true, ensures that the service process and all its children can
1445 never gain new privileges through <function>execve()</function> (e.g. via setuid or setgid bits, or filesystem
1446 capabilities). This is the simplest and most effective way to ensure that a process and its children can never
a7db8614 1447 elevate privileges again. Defaults to false, but certain settings force
add00535
LP
1448 <varname>NoNewPrivileges=yes</varname>, ignoring the value of this setting. This is the case when
1449 <varname>SystemCallFilter=</varname>, <varname>SystemCallArchitectures=</varname>,
1450 <varname>RestrictAddressFamilies=</varname>, <varname>RestrictNamespaces=</varname>,
1451 <varname>PrivateDevices=</varname>, <varname>ProtectKernelTunables=</varname>,
1452 <varname>ProtectKernelModules=</varname>, <varname>MemoryDenyWriteExecute=</varname>, or
a6fabe38
ZJS
1453 <varname>RestrictRealtime=</varname> are specified.</para>
1454
1455 <para>Also see
1456 <ulink url="https://www.kernel.org/doc/html/latest/userspace-api/no_new_privs.html">No New Privileges Flag</ulink>.
1457 </para></listitem>
798d3a52
ZJS
1458 </varlistentry>
1459
1460 <varlistentry>
1461 <term><varname>SystemCallFilter=</varname></term>
1462
c79aff9a
LP
1463 <listitem><para>Takes a space-separated list of system call names. If this setting is used, all system calls
1464 executed by the unit processes except for the listed ones will result in immediate process termination with the
1465 <constant>SIGSYS</constant> signal (whitelisting). If the first character of the list is <literal>~</literal>,
1466 the effect is inverted: only the listed system calls will result in immediate process termination
8cfa775f
YW
1467 (blacklisting). Blacklisted system calls and system call groups may optionally be suffixed with a colon
1468 (<literal>:</literal>) and <literal>errno</literal> error number (between 0 and 4095) or errno name such as
1469 <constant>EPERM</constant>, <constant>EACCES</constant> or <constant>EUCLEAN</constant>. This value will be
1470 returned when a blacklisted system call is triggered, instead of terminating the processes immediately.
1471 This value takes precedence over the one given in <varname>SystemCallErrorNumber=</varname>.
1472 If running in user mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant>
c79aff9a
LP
1473 capability (e.g. setting <varname>User=nobody</varname>), <varname>NoNewPrivileges=yes</varname> is
1474 implied. This feature makes use of the Secure Computing Mode 2 interfaces of the kernel ('seccomp filtering')
1475 and is useful for enforcing a minimal sandboxing environment. Note that the <function>execve</function>,
1476 <function>exit</function>, <function>exit_group</function>, <function>getrlimit</function>,
1477 <function>rt_sigreturn</function>, <function>sigreturn</function> system calls and the system calls for
1478 querying time and sleeping are implicitly whitelisted and do not need to be listed explicitly. This option may
1479 be specified more than once, in which case the filter masks are merged. If the empty string is assigned, the
1480 filter is reset, all prior assignments will have no effect. This does not affect commands prefixed with
1481 <literal>+</literal>.</para>
798d3a52 1482
0b8fab97
LP
1483 <para>Note that on systems supporting multiple ABIs (such as x86/x86-64) it is recommended to turn off
1484 alternative ABIs for services, so that they cannot be used to circumvent the restrictions of this
1485 option. Specifically, it is recommended to combine this option with
1486 <varname>SystemCallArchitectures=native</varname> or similar.</para>
1487
2ca8dc15
LP
1488 <para>Note that strict system call filters may impact execution and error handling code paths of the service
1489 invocation. Specifically, access to the <function>execve</function> system call is required for the execution
1490 of the service binary — if it is blocked service invocation will necessarily fail. Also, if execution of the
1491 service binary fails for some reason (for example: missing service executable), the error handling logic might
1492 require access to an additional set of system calls in order to process and log this failure correctly. It
1493 might be necessary to temporarily disable system call filters in order to simplify debugging of such
1494 failures.</para>
1495
798d3a52
ZJS
1496 <para>If you specify both types of this option (i.e.
1497 whitelisting and blacklisting), the first encountered will
1498 take precedence and will dictate the default action
1499 (termination or approval of a system call). Then the next
1500 occurrences of this option will add or delete the listed
1501 system calls from the set of the filtered system calls,
1502 depending of its type and the default action. (For example, if
1503 you have started with a whitelisting of
1504 <function>read</function> and <function>write</function>, and
1505 right after it add a blacklisting of
1506 <function>write</function>, then <function>write</function>
201c1cc2
TM
1507 will be removed from the set.)</para>
1508
1509 <para>As the number of possible system
1510 calls is large, predefined sets of system calls are provided.
1511 A set starts with <literal>@</literal> character, followed by
1512 name of the set.
1513
1514 <table>
1515 <title>Currently predefined system call sets</title>
1516
1517 <tgroup cols='2'>
1518 <colspec colname='set' />
1519 <colspec colname='description' />
1520 <thead>
1521 <row>
1522 <entry>Set</entry>
1523 <entry>Description</entry>
1524 </row>
1525 </thead>
1526 <tbody>
44898c53
LP
1527 <row>
1528 <entry>@aio</entry>
1529 <entry>Asynchronous I/O (<citerefentry project='man-pages'><refentrytitle>io_setup</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>io_submit</refentrytitle><manvolnum>2</manvolnum></citerefentry>, and related calls)</entry>
1530 </row>
133ddbbe
LP
1531 <row>
1532 <entry>@basic-io</entry>
1533 <entry>System calls for basic I/O: reading, writing, seeking, file descriptor duplication and closing (<citerefentry project='man-pages'><refentrytitle>read</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>write</refentrytitle><manvolnum>2</manvolnum></citerefentry>, and related calls)</entry>
1534 </row>
44898c53
LP
1535 <row>
1536 <entry>@chown</entry>
1537 <entry>Changing file ownership (<citerefentry project='man-pages'><refentrytitle>chown</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>fchownat</refentrytitle><manvolnum>2</manvolnum></citerefentry>, and related calls)</entry>
1538 </row>
201c1cc2
TM
1539 <row>
1540 <entry>@clock</entry>
1f9ac68b
LP
1541 <entry>System calls for changing the system clock (<citerefentry project='man-pages'><refentrytitle>adjtimex</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>settimeofday</refentrytitle><manvolnum>2</manvolnum></citerefentry>, and related calls)</entry>
1542 </row>
1543 <row>
1544 <entry>@cpu-emulation</entry>
1545 <entry>System calls for CPU emulation functionality (<citerefentry project='man-pages'><refentrytitle>vm86</refentrytitle><manvolnum>2</manvolnum></citerefentry> and related calls)</entry>
1546 </row>
1547 <row>
1548 <entry>@debug</entry>
1549 <entry>Debugging, performance monitoring and tracing functionality (<citerefentry project='man-pages'><refentrytitle>ptrace</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>perf_event_open</refentrytitle><manvolnum>2</manvolnum></citerefentry> and related calls)</entry>
201c1cc2 1550 </row>
1a1b13c9
LP
1551 <row>
1552 <entry>@file-system</entry>
1553 <entry>File system operations: opening, creating files and directories for read and write, renaming and removing them, reading file properties, or creating hard and symbolic links.</entry>
1554 </row>
201c1cc2
TM
1555 <row>
1556 <entry>@io-event</entry>
1f9ac68b 1557 <entry>Event loop system calls (<citerefentry project='man-pages'><refentrytitle>poll</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>select</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>epoll</refentrytitle><manvolnum>7</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>eventfd</refentrytitle><manvolnum>2</manvolnum></citerefentry> and related calls)</entry>
201c1cc2
TM
1558 </row>
1559 <row>
1560 <entry>@ipc</entry>
cd5bfd7e 1561 <entry>Pipes, SysV IPC, POSIX Message Queues and other IPC (<citerefentry project='man-pages'><refentrytitle>mq_overview</refentrytitle><manvolnum>7</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>svipc</refentrytitle><manvolnum>7</manvolnum></citerefentry>)</entry>
1f9ac68b
LP
1562 </row>
1563 <row>
1564 <entry>@keyring</entry>
1565 <entry>Kernel keyring access (<citerefentry project='man-pages'><refentrytitle>keyctl</refentrytitle><manvolnum>2</manvolnum></citerefentry> and related calls)</entry>
201c1cc2 1566 </row>
cd0ddf6f
LP
1567 <row>
1568 <entry>@memlock</entry>
1569 <entry>Locking of memory into RAM (<citerefentry project='man-pages'><refentrytitle>mlock</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>mlockall</refentrytitle><manvolnum>2</manvolnum></citerefentry> and related calls)</entry>
1570 </row>
201c1cc2
TM
1571 <row>
1572 <entry>@module</entry>
d5efc18b 1573 <entry>Loading and unloading of kernel modules (<citerefentry project='man-pages'><refentrytitle>init_module</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>delete_module</refentrytitle><manvolnum>2</manvolnum></citerefentry> and related calls)</entry>
201c1cc2
TM
1574 </row>
1575 <row>
1576 <entry>@mount</entry>
d5efc18b 1577 <entry>Mounting and unmounting of file systems (<citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>chroot</refentrytitle><manvolnum>2</manvolnum></citerefentry>, and related calls)</entry>
201c1cc2
TM
1578 </row>
1579 <row>
1580 <entry>@network-io</entry>
1f9ac68b 1581 <entry>Socket I/O (including local AF_UNIX): <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>unix</refentrytitle><manvolnum>7</manvolnum></citerefentry></entry>
201c1cc2
TM
1582 </row>
1583 <row>
1584 <entry>@obsolete</entry>
1f9ac68b 1585 <entry>Unusual, obsolete or unimplemented (<citerefentry project='man-pages'><refentrytitle>create_module</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>gtty</refentrytitle><manvolnum>2</manvolnum></citerefentry>, …)</entry>
201c1cc2
TM
1586 </row>
1587 <row>
1588 <entry>@privileged</entry>
1f9ac68b 1589 <entry>All system calls which need super-user capabilities (<citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>)</entry>
201c1cc2
TM
1590 </row>
1591 <row>
1592 <entry>@process</entry>
d5efc18b 1593 <entry>Process control, execution, namespaceing operations (<citerefentry project='man-pages'><refentrytitle>clone</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>kill</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>namespaces</refentrytitle><manvolnum>7</manvolnum></citerefentry>, …</entry>
201c1cc2
TM
1594 </row>
1595 <row>
1596 <entry>@raw-io</entry>
aa6b9cec 1597 <entry>Raw I/O port access (<citerefentry project='man-pages'><refentrytitle>ioperm</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>iopl</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <function>pciconfig_read()</function>, …)</entry>
201c1cc2 1598 </row>
bd2ab3f4
LP
1599 <row>
1600 <entry>@reboot</entry>
1601 <entry>System calls for rebooting and reboot preparation (<citerefentry project='man-pages'><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <function>kexec()</function>, …)</entry>
1602 </row>
133ddbbe
LP
1603 <row>
1604 <entry>@resources</entry>
1605 <entry>System calls for changing resource limits, memory and scheduling parameters (<citerefentry project='man-pages'><refentrytitle>setrlimit</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>setpriority</refentrytitle><manvolnum>2</manvolnum></citerefentry>, …)</entry>
1606 </row>
6eaaeee9
LP
1607 <row>
1608 <entry>@setuid</entry>
1609 <entry>System calls for changing user ID and group ID credentials, (<citerefentry project='man-pages'><refentrytitle>setuid</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>setgid</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>setresuid</refentrytitle><manvolnum>2</manvolnum></citerefentry>, …)</entry>
1610 </row>
cd0ddf6f
LP
1611 <row>
1612 <entry>@signal</entry>
1613 <entry>System calls for manipulating and handling process signals (<citerefentry project='man-pages'><refentrytitle>signal</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>sigprocmask</refentrytitle><manvolnum>2</manvolnum></citerefentry>, …)</entry>
1614 </row>
bd2ab3f4
LP
1615 <row>
1616 <entry>@swap</entry>
1617 <entry>System calls for enabling/disabling swap devices (<citerefentry project='man-pages'><refentrytitle>swapon</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>swapoff</refentrytitle><manvolnum>2</manvolnum></citerefentry>)</entry>
1618 </row>
44898c53
LP
1619 <row>
1620 <entry>@sync</entry>
1621 <entry>Synchronizing files and memory to disk: (<citerefentry project='man-pages'><refentrytitle>fsync</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>msync</refentrytitle><manvolnum>2</manvolnum></citerefentry>, and related calls)</entry>
1622 </row>
cd0ddf6f
LP
1623 <row>
1624 <entry>@timer</entry>
1625 <entry>System calls for scheduling operations by time (<citerefentry project='man-pages'><refentrytitle>alarm</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>timer_create</refentrytitle><manvolnum>2</manvolnum></citerefentry>, …)</entry>
1626 </row>
201c1cc2
TM
1627 </tbody>
1628 </tgroup>
1629 </table>
1630
869feb33
ZJS
1631 Note, that as new system calls are added to the kernel, additional system calls might be
1632 added to the groups above. Contents of the sets may also change between systemd
1633 versions. In addition, the list of system calls depends on the kernel version and
1634 architecture for which systemd was compiled. Use
1635 <command>systemd-analyze syscall-filter</command> to list the actual list of system calls in
1636 each filter.
1637 </para>
effbd6d2
LP
1638
1639 <para>It is recommended to combine the file system namespacing related options with
1640 <varname>SystemCallFilter=~@mount</varname>, in order to prohibit the unit's processes to undo the
1641 mappings. Specifically these are the options <varname>PrivateTmp=</varname>,
1642 <varname>PrivateDevices=</varname>, <varname>ProtectSystem=</varname>, <varname>ProtectHome=</varname>,
1643 <varname>ProtectKernelTunables=</varname>, <varname>ProtectControlGroups=</varname>,
1644 <varname>ReadOnlyPaths=</varname>, <varname>InaccessiblePaths=</varname> and
1645 <varname>ReadWritePaths=</varname>.</para></listitem>
798d3a52
ZJS
1646 </varlistentry>
1647
1648 <varlistentry>
1649 <term><varname>SystemCallErrorNumber=</varname></term>
1650
3df90f24
YW
1651 <listitem><para>Takes an <literal>errno</literal> error number (between 1 and 4095) or errno name such as
1652 <constant>EPERM</constant>, <constant>EACCES</constant> or <constant>EUCLEAN</constant>, to return when the
1653 system call filter configured with <varname>SystemCallFilter=</varname> is triggered, instead of terminating
1654 the process immediately. When this setting is not used, or when the empty string is assigned, the process
1655 will be terminated immediately when the filter is triggered.</para></listitem>
798d3a52
ZJS
1656 </varlistentry>
1657
1658 <varlistentry>
1659 <term><varname>SystemCallArchitectures=</varname></term>
1660
0b8fab97
LP
1661 <listitem><para>Takes a space-separated list of architecture identifiers to include in the system call
1662 filter. The known architecture identifiers are the same as for <varname>ConditionArchitecture=</varname>
1663 described in <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1664 as well as <constant>x32</constant>, <constant>mips64-n32</constant>, <constant>mips64-le-n32</constant>, and
1665 the special identifier <constant>native</constant>. Only system calls of the specified architectures will be
1666 permitted to processes of this unit. This is an effective way to disable compatibility with non-native
1667 architectures for processes, for example to prohibit execution of 32-bit x86 binaries on 64-bit x86-64
1668 systems. The special <constant>native</constant> identifier implicitly maps to the native architecture of the
1669 system (or more strictly: to the architecture the system manager is compiled for). If running in user mode, or
1670 in system mode, but without the <constant>CAP_SYS_ADMIN</constant> capability (e.g. setting
1671 <varname>User=nobody</varname>), <varname>NoNewPrivileges=yes</varname> is implied. Note that setting this
1672 option to a non-empty list implies that <constant>native</constant> is included too. By default, this option is
1673 set to the empty list, i.e. no system call architecture filtering is applied.</para>
1674
1675 <para>Note that system call filtering is not equally effective on all architectures. For example, on x86
1676 filtering of network socket-related calls is not possible, due to ABI limitations — a limitation that x86-64
1677 does not have, however. On systems supporting multiple ABIs at the same time — such as x86/x86-64 — it is hence
1678 recommended to limit the set of permitted system call architectures so that secondary ABIs may not be used to
1679 circumvent the restrictions applied to the native ABI of the system. In particular, setting
c29ebc1a 1680 <varname>SystemCallArchitectures=native</varname> is a good choice for disabling non-native ABIs.</para>
0b8fab97
LP
1681
1682 <para>System call architectures may also be restricted system-wide via the
1683 <varname>SystemCallArchitectures=</varname> option in the global configuration. See
1684 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
1685 details.</para></listitem>
798d3a52
ZJS
1686 </varlistentry>
1687
1688 <varlistentry>
1689 <term><varname>RestrictAddressFamilies=</varname></term>
1690
142bd808
LP
1691 <listitem><para>Restricts the set of socket address families accessible to the processes of this unit. Takes a
1692 space-separated list of address family names to whitelist, such as <constant>AF_UNIX</constant>,
1693 <constant>AF_INET</constant> or <constant>AF_INET6</constant>. When prefixed with <constant>~</constant> the
1694 listed address families will be applied as blacklist, otherwise as whitelist. Note that this restricts access
1695 to the <citerefentry
1696 project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call
1697 only. Sockets passed into the process by other means (for example, by using socket activation with socket
1698 units, see <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
1699 are unaffected. Also, sockets created with <function>socketpair()</function> (which creates connected AF_UNIX
1700 sockets only) are unaffected. Note that this option has no effect on 32-bit x86, s390, s390x, mips, mips-le,
0b8fab97
LP
1701 ppc, ppc-le, pcc64, ppc64-le and is ignored (but works correctly on other ABIs, including x86-64). Note that on
1702 systems supporting multiple ABIs (such as x86/x86-64) it is recommended to turn off alternative ABIs for
1703 services, so that they cannot be used to circumvent the restrictions of this option. Specifically, it is
1704 recommended to combine this option with <varname>SystemCallArchitectures=native</varname> or similar. If
142bd808
LP
1705 running in user mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant> capability
1706 (e.g. setting <varname>User=nobody</varname>), <varname>NoNewPrivileges=yes</varname> is implied. By default,
1707 no restrictions apply, all address families are accessible to processes. If assigned the empty string, any
1708 previous address familiy restriction changes are undone. This setting does not affect commands prefixed with
1709 <literal>+</literal>.</para>
1710
1711 <para>Use this option to limit exposure of processes to remote access, in particular via exotic and sensitive
1712 network protocols, such as <constant>AF_PACKET</constant>. Note that in most cases, the local
1713 <constant>AF_UNIX</constant> address family should be included in the configured whitelist as it is frequently
1714 used for local communication, including for
798d3a52 1715 <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>2</manvolnum></citerefentry>
142bd808 1716 logging.</para></listitem>
798d3a52
ZJS
1717 </varlistentry>
1718
add00535
LP
1719 <varlistentry>
1720 <term><varname>RestrictNamespaces=</varname></term>
1721
1722 <listitem><para>Restricts access to Linux namespace functionality for the processes of this unit. For details
1723 about Linux namespaces, see
98e9d710 1724 <citerefentry project='man-pages'><refentrytitle>namespaces</refentrytitle><manvolnum>7</manvolnum></citerefentry>. Either takes a
add00535
LP
1725 boolean argument, or a space-separated list of namespace type identifiers. If false (the default), no
1726 restrictions on namespace creation and switching are made. If true, access to any kind of namespacing is
1727 prohibited. Otherwise, a space-separated list of namespace type identifiers must be specified, consisting of
1728 any combination of: <constant>cgroup</constant>, <constant>ipc</constant>, <constant>net</constant>,
1729 <constant>mnt</constant>, <constant>pid</constant>, <constant>user</constant> and <constant>uts</constant>. Any
1730 namespace type listed is made accessible to the unit's processes, access to namespace types not listed is
ceabfb88 1731 prohibited (whitelisting). By prepending the list with a single tilde character (<literal>~</literal>) the
add00535
LP
1732 effect may be inverted: only the listed namespace types will be made inaccessible, all unlisted ones are
1733 permitted (blacklisting). If the empty string is assigned, the default namespace restrictions are applied,
1734 which is equivalent to false. Internally, this setting limits access to the
1735 <citerefentry><refentrytitle>unshare</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
1736 <citerefentry><refentrytitle>clone</refentrytitle><manvolnum>2</manvolnum></citerefentry> and
1737 <citerefentry><refentrytitle>setns</refentrytitle><manvolnum>2</manvolnum></citerefentry> system calls, taking
1738 the specified flags parameters into account. Note that — if this option is used — in addition to restricting
1739 creation and switching of the specified types of namespaces (or all of them, if true) access to the
ae9d60ce 1740 <function>setns()</function> system call with a zero flags parameter is prohibited. This setting is only
a3645cc6
JC
1741 supported on x86, x86-64, mips, mips-le, mips64, mips64-le, mips64-n32, mips64-le-n32, ppc64, ppc64-le,
1742 s390 and s390x, and enforces no restrictions on other architectures. If running in user
ae9d60ce
LP
1743 mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant> capability (e.g. setting
1744 <varname>User=</varname>), <varname>NoNewPrivileges=yes</varname> is implied. </para></listitem>
add00535
LP
1745 </varlistentry>
1746
798d3a52
ZJS
1747 <varlistentry>
1748 <term><varname>Personality=</varname></term>
1749
7882632d
LP
1750 <listitem><para>Controls which kernel architecture <citerefentry
1751 project='man-pages'><refentrytitle>uname</refentrytitle><manvolnum>2</manvolnum></citerefentry> shall report,
1752 when invoked by unit processes. Takes one of the architecture identifiers <constant>x86</constant>,
1753 <constant>x86-64</constant>, <constant>ppc</constant>, <constant>ppc-le</constant>, <constant>ppc64</constant>,
1754 <constant>ppc64-le</constant>, <constant>s390</constant> or <constant>s390x</constant>. Which personality
1755 architectures are supported depends on the system architecture. Usually the 64bit versions of the various
1756 system architectures support their immediate 32bit personality architecture counterpart, but no others. For
1757 example, <constant>x86-64</constant> systems support the <constant>x86-64</constant> and
1758 <constant>x86</constant> personalities but no others. The personality feature is useful when running 32-bit
1759 services on a 64-bit host system. If not specified, the personality is left unmodified and thus reflects the
1760 personality of the host system's kernel.</para></listitem>
798d3a52
ZJS
1761 </varlistentry>
1762
1763 <varlistentry>
78e864e5
TM
1764 <term><varname>LockPersonality=</varname></term>
1765
e8d85bc0 1766 <listitem><para>Takes a boolean argument. If set, locks down the <citerefentry
78e864e5
TM
1767 project='man-pages'><refentrytitle>personality</refentrytitle><manvolnum>2</manvolnum></citerefentry> system
1768 call so that the kernel execution domain may not be changed from the default or the personality selected with
1769 <varname>Personality=</varname> directive. This may be useful to improve security, because odd personality
1770 emulations may be poorly tested and source of vulnerabilities. If running in user mode, or in system mode, but
1771 without the <constant>CAP_SYS_ADMIN</constant> capability (e.g. setting <varname>User=</varname>),
1772 <varname>NoNewPrivileges=yes</varname> is implied.</para></listitem>
1773 </varlistentry>
1774
b1edf445
LP
1775 <varlistentry>
1776 <term><varname>KeyringMode=</varname></term>
1777
1778 <listitem><para>Controls how the kernel session keyring is set up for the service (see <citerefentry
1779 project='man-pages'><refentrytitle>session-keyring</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
1780 details on the session keyring). Takes one of <option>inherit</option>, <option>private</option>,
1781 <option>shared</option>. If set to <option>inherit</option> no special keyring setup is done, and the kernel's
1782 default behaviour is applied. If <option>private</option> is used a new session keyring is allocated when a
1783 service process is invoked, and it is not linked up with any user keyring. This is the recommended setting for
1784 system services, as this ensures that multiple services running under the same system user ID (in particular
1785 the root user) do not share their key material among each other. If <option>shared</option> is used a new
1786 session keyring is allocated as for <option>private</option>, but the user keyring of the user configured with
1787 <varname>User=</varname> is linked into it, so that keys assigned to the user may be requested by the unit's
1788 processes. In this modes multiple units running processes under the same user ID may share key material. Unless
1789 <option>inherit</option> is selected the unique invocation ID for the unit (see below) is added as a protected
1790 key by the name <literal>invocation_id</literal> to the newly created session keyring. Defaults to
1791 <option>private</option> for the system service manager and to <option>inherit</option> for the user service
1792 manager.</para></listitem>
78e864e5
TM
1793 </varlistentry>
1794
1795 <varlistentry>
798d3a52 1796 <term><varname>RuntimeDirectory=</varname></term>
4a628360
LP
1797 <term><varname>StateDirectory=</varname></term>
1798 <term><varname>CacheDirectory=</varname></term>
1799 <term><varname>LogsDirectory=</varname></term>
1800 <term><varname>ConfigurationDirectory=</varname></term>
798d3a52 1801
4a628360
LP
1802 <listitem><para>These options take a whitespace-separated list of directory names. The specified directory
1803 names must be relative, and may not include <literal>.</literal> or <literal>..</literal>. If set, one or more
1804 directories by the specified names will be created (including their parents) below <filename>/run</filename>
1805 (or <varname>$XDG_RUNTIME_DIR</varname> for user services), <filename>/var/lib</filename> (or
1806 <varname>$XDG_CONFIG_HOME</varname> for user services), <filename>/var/cache</filename> (or
1807 <varname>$XDG_CACHE_HOME</varname> for user services), <filename>/var/log</filename> (or
1808 <varname>$XDG_CONFIG_HOME</varname><filename>/log</filename> for user services), or <filename>/etc</filename>
1809 (or <varname>$XDG_CONFIG_HOME</varname> for user services), respectively, when the unit is started.</para>
1810
1811 <para>In case of <varname>RuntimeDirectory=</varname> the lowest subdirectories are removed when the unit is
1812 stopped. It is possible to preserve the specified directories in this case if
1813 <varname>RuntimeDirectoryPreserve=</varname> is configured to <option>restart</option> or <option>yes</option>
1814 (see below). The directories specified with <varname>StateDirectory=</varname>,
1815 <varname>CacheDirectory=</varname>, <varname>LogsDirectory=</varname>,
1816 <varname>ConfigurationDirectory=</varname> are not removed when the unit is stopped.</para>
1817
1818 <para>Except in case of <varname>ConfigurationDirectory=</varname>, the innermost specified directories will be
1819 owned by the user and group specified in <varname>User=</varname> and <varname>Group=</varname>. If the
1820 specified directories already exist and their owning user or group do not match the configured ones, all files
1821 and directories below the specified directories as well as the directories themselves will have their file
1822 ownership recursively changed to match what is configured. As an optimization, if the specified directories are
1823 already owned by the right user and group, files and directories below of them are left as-is, even if they do
1824 not match what is requested. The innermost specified directories will have their access mode adjusted to the
1825 what is specified in <varname>RuntimeDirectoryMode=</varname>, <varname>StateDirectoryMode=</varname>,
1826 <varname>CacheDirectoryMode=</varname>, <varname>LogsDirectoryMode=</varname> and
1827 <varname>ConfigurationDirectoryMode=</varname>.</para>
1828
fdfcb946 1829 <para>These options imply <varname>BindPaths=</varname> for the specified paths. When combined with
4a628360 1830 <varname>RootDirectory=</varname> or <varname>RootImage=</varname> these paths always reside on the host and
fdfcb946
YW
1831 are mounted from there into the unit's file system namespace.</para>
1832
1833 <para>If <varname>DynamicUser=</varname> is used in conjunction with <varname>StateDirectory=</varname>,
1834 <varname>CacheDirectory=</varname> and <varname>LogsDirectory=</varname> is slightly altered: the directories
1835 are created below <filename>/var/lib/private</filename>, <filename>/var/cache/private</filename> and
4a628360
LP
1836 <filename>/var/log/private</filename>, respectively, which are host directories made inaccessible to
1837 unprivileged users, which ensures that access to these directories cannot be gained through dynamic user ID
1838 recycling. Symbolic links are created to hide this difference in behaviour. Both from perspective of the host
1839 and from inside the unit, the relevant directories hence always appear directly below
fdfcb946 1840 <filename>/var/lib</filename>, <filename>/var/cache</filename> and <filename>/var/log</filename>.</para>
4a628360
LP
1841
1842 <para>Use <varname>RuntimeDirectory=</varname> to manage one or more runtime directories for the unit and bind
1843 their lifetime to the daemon runtime. This is particularly useful for unprivileged daemons that cannot create
23a7448e 1844 runtime directories in <filename>/run</filename> due to lack of privileges, and to make sure the runtime
4a628360
LP
1845 directory is cleaned up automatically after use. For runtime directories that require more complex or different
1846 configuration or lifetime guarantees, please consider using
23a7448e
YW
1847 <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
1848
1849 <para>Example: if a system service unit has the following,
1850 <programlisting>RuntimeDirectory=foo/bar baz</programlisting>
1851 the service manager creates <filename>/run/foo</filename> (if it does not exist), <filename>/run/foo/bar</filename>,
1852 and <filename>/run/baz</filename>. The directories <filename>/run/foo/bar</filename> and <filename>/run/baz</filename>
1853 except <filename>/run/foo</filename> are owned by the user and group specified in <varname>User=</varname> and
1854 <varname>Group=</varname>, and removed when the service is stopped.
1855 </para></listitem>
3536f49e 1856
3536f49e
YW
1857 </varlistentry>
1858
189cd8c2
ZJS
1859 <varlistentry>
1860 <term><varname>RuntimeDirectoryMode=</varname></term>
3536f49e
YW
1861 <term><varname>StateDirectoryMode=</varname></term>
1862 <term><varname>CacheDirectoryMode=</varname></term>
1863 <term><varname>LogsDirectoryMode=</varname></term>
1864 <term><varname>ConfigurationDirectoryMode=</varname></term>
189cd8c2
ZJS
1865
1866 <listitem><para>Specifies the access mode of the directories specified in
3536f49e
YW
1867 <varname>RuntimeDirectory=</varname>, <varname>StateDirectory=</varname>, <varname>CacheDirectory=</varname>,
1868 <varname>LogsDirectory=</varname>, or <varname>ConfigurationDirectory=</varname>, respectively, as an octal number.
1869 Defaults to <constant>0755</constant>. See "Permissions" in
23a7448e
YW
1870 <citerefentry project='man-pages'><refentrytitle>path_resolution</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1871 for a discussion of the meaning of permission bits.
189cd8c2
ZJS
1872 </para></listitem>
1873 </varlistentry>
1874
53f47dfc
YW
1875 <varlistentry>
1876 <term><varname>RuntimeDirectoryPreserve=</varname></term>
1877
1878 <listitem><para>Takes a boolean argument or <option>restart</option>.
1879 If set to <option>no</option> (the default), the directories specified in <varname>RuntimeDirectory=</varname>
1880 are always removed when the service stops. If set to <option>restart</option> the directories are preserved
1881 when the service is both automatically and manually restarted. Here, the automatic restart means the operation
1882 specified in <varname>Restart=</varname>, and manual restart means the one triggered by
1883 <command>systemctl restart foo.service</command>. If set to <option>yes</option>, then the directories are not
1884 removed when the service is stopped. Note that since the runtime directory <filename>/run</filename> is a mount
1885 point of <literal>tmpfs</literal>, then for system services the directories specified in
1886 <varname>RuntimeDirectory=</varname> are removed when the system is rebooted.
189cd8c2
ZJS
1887 </para></listitem>
1888 </varlistentry>
1889
f3e43635
TM
1890 <varlistentry>
1891 <term><varname>MemoryDenyWriteExecute=</varname></term>
1892
1893 <listitem><para>Takes a boolean argument. If set, attempts to create memory mappings that are writable and
8a50cf69
LP
1894 executable at the same time, or to change existing memory mappings to become executable, or mapping shared
1895 memory segments as executable are prohibited. Specifically, a system call filter is added that rejects
1896 <citerefentry><refentrytitle>mmap</refentrytitle><manvolnum>2</manvolnum></citerefentry> system calls with both
1897 <constant>PROT_EXEC</constant> and <constant>PROT_WRITE</constant> set,
b835eeb4
ZJS
1898 <citerefentry><refentrytitle>mprotect</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1899 or <citerefentry><refentrytitle>pkey_mprotect</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1900 system calls with <constant>PROT_EXEC</constant> set and
8a50cf69 1901 <citerefentry><refentrytitle>shmat</refentrytitle><manvolnum>2</manvolnum></citerefentry> system calls with
03c3c520
ZJS
1902 <constant>SHM_EXEC</constant> set. Note that this option is incompatible with programs and libraries that
1903 generate program code dynamically at runtime, including JIT execution engines, executable stacks, and code
8a50cf69
LP
1904 "trampoline" feature of various C compilers. This option improves service security, as it makes harder for
1905 software exploits to change running code dynamically. Note that this feature is fully available on x86-64, and
0b8fab97
LP
1906 partially on x86. Specifically, the <function>shmat()</function> protection is not available on x86. Note that
1907 on systems supporting multiple ABIs (such as x86/x86-64) it is recommended to turn off alternative ABIs for
1908 services, so that they cannot be used to circumvent the restrictions of this option. Specifically, it is
1909 recommended to combine this option with <varname>SystemCallArchitectures=native</varname> or similar. If
1910 running in user mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant> capability
3536f49e 1911 (e.g. setting <varname>User=</varname>), <varname>NoNewPrivileges=yes</varname> is implied.</para></listitem>
f3e43635
TM
1912 </varlistentry>
1913
f4170c67
LP
1914 <varlistentry>
1915 <term><varname>RestrictRealtime=</varname></term>
1916
1917 <listitem><para>Takes a boolean argument. If set, any attempts to enable realtime scheduling in a process of
1918 the unit are refused. This restricts access to realtime task scheduling policies such as
1919 <constant>SCHED_FIFO</constant>, <constant>SCHED_RR</constant> or <constant>SCHED_DEADLINE</constant>. See
0a07667d 1920 <citerefentry project='man-pages'><refentrytitle>sched</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details about
a7db8614
DH
1921 these scheduling policies. If running in user mode, or in system mode, but
1922 without the <constant>CAP_SYS_ADMIN</constant> capability
1923 (e.g. setting <varname>User=</varname>), <varname>NoNewPrivileges=yes</varname>
1924 is implied. Realtime scheduling policies may be used to monopolize CPU time for longer periods
f4170c67
LP
1925 of time, and may hence be used to lock up or otherwise trigger Denial-of-Service situations on the system. It
1926 is hence recommended to restrict access to realtime scheduling to the few programs that actually require
1927 them. Defaults to off.</para></listitem>
1928 </varlistentry>
1929
798d3a52
ZJS
1930 </variablelist>
1931 </refsect1>
1932
1933 <refsect1>
1934 <title>Environment variables in spawned processes</title>
1935
00819cc1
LP
1936 <para>Processes started by the service manager are executed with an environment variable block assembled from
1937 multiple sources. Processes started by the system service manager generally do not inherit environment variables
1938 set for the service manager itself (but this may be altered via <varname>PassEnvironment=</varname>), but processes
1939 started by the user service manager instances generally do inherit all environment variables set for the service
1940 manager itself.</para>
1941
1942 <para>For each invoked process the list of environment variables set is compiled from the following sources:</para>
1943
1944 <itemizedlist>
1945 <listitem><para>Variables globally configured for the service manager, using the
1946 <varname>DefaultEnvironment=</varname> setting in
1947 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, the kernel command line option <varname>systemd.setenv=</varname> (see
1948 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>) or via
1949 <command>systemctl set-environment</command> (see <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>).</para></listitem>
1950
1951 <listitem><para>Variables defined by the service manager itself (see the list below)</para></listitem>
1952
1953 <listitem><para>Variables set in the service manager's own environment variable block (subject to <varname>PassEnvironment=</varname> for the system service manager)</para></listitem>
1954
1955 <listitem><para>Variables set via <varname>Environment=</varname> in the unit file</para></listitem>
1956
1957 <listitem><para>Variables read from files specified via <varname>EnvironmentFiles=</varname> in the unit file</para></listitem>
1958
1959 <listitem><para>Variables set by any PAM modules in case <varname>PAMName=</varname> is in effect, cf. <citerefentry project='man-pages'><refentrytitle>pam_env</refentrytitle><manvolnum>8</manvolnum></citerefentry></para></listitem>
1960 </itemizedlist>
1961
1962 <para>If the same environment variables are set by multiple of these sources, the later source — according to the
1963 order of the list above — wins. Note that as final step all variables listed in
1964 <varname>UnsetEnvironment=</varname> are removed again from the compiled environment variable list, immediately
1965 before it is passed to the executed process.</para>
1966
1967 <para>The following select environment variables are set by the service manager itself for each invoked process:</para>
798d3a52
ZJS
1968
1969 <variablelist class='environment-variables'>
1970 <varlistentry>
1971 <term><varname>$PATH</varname></term>
1972
1973 <listitem><para>Colon-separated list of directories to use
1974 when launching executables. Systemd uses a fixed value of
1975 <filename>/usr/local/sbin</filename>:<filename>/usr/local/bin</filename>:<filename>/usr/sbin</filename>:<filename>/usr/bin</filename>:<filename>/sbin</filename>:<filename>/bin</filename>.
1976 </para></listitem>
1977 </varlistentry>
1978
1979 <varlistentry>
1980 <term><varname>$LANG</varname></term>
1981
1982 <listitem><para>Locale. Can be set in
3ba3a79d 1983 <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
798d3a52
ZJS
1984 or on the kernel command line (see
1985 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
1986 and
1987 <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>).
1988 </para></listitem>
1989 </varlistentry>
1990
1991 <varlistentry>
1992 <term><varname>$USER</varname></term>
1993 <term><varname>$LOGNAME</varname></term>
1994 <term><varname>$HOME</varname></term>
1995 <term><varname>$SHELL</varname></term>
1996
1997 <listitem><para>User name (twice), home directory, and the
23deef88
LP
1998 login shell. The variables are set for the units that have
1999 <varname>User=</varname> set, which includes user
2000 <command>systemd</command> instances. See
3ba3a79d 2001 <citerefentry project='die-net'><refentrytitle>passwd</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
798d3a52
ZJS
2002 </para></listitem>
2003 </varlistentry>
2004
4b58153d
LP
2005 <varlistentry>
2006 <term><varname>$INVOCATION_ID</varname></term>
2007
2008 <listitem><para>Contains a randomized, unique 128bit ID identifying each runtime cycle of the unit, formatted
2009 as 32 character hexadecimal string. A new ID is assigned each time the unit changes from an inactive state into
2010 an activating or active state, and may be used to identify this specific runtime cycle, in particular in data
2011 stored offline, such as the journal. The same ID is passed to all processes run as part of the
2012 unit.</para></listitem>
2013 </varlistentry>
2014
798d3a52
ZJS
2015 <varlistentry>
2016 <term><varname>$XDG_RUNTIME_DIR</varname></term>
2017
2018 <listitem><para>The directory for volatile state. Set for the
2019 user <command>systemd</command> instance, and also in user
2020 sessions. See
2021 <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
2022 </para></listitem>
2023 </varlistentry>
2024
2025 <varlistentry>
2026 <term><varname>$XDG_SESSION_ID</varname></term>
2027 <term><varname>$XDG_SEAT</varname></term>
2028 <term><varname>$XDG_VTNR</varname></term>
2029
2030 <listitem><para>The identifier of the session, the seat name,
2031 and virtual terminal of the session. Set by
2032 <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
2033 for login sessions. <varname>$XDG_SEAT</varname> and
2034 <varname>$XDG_VTNR</varname> will only be set when attached to
2035 a seat and a tty.</para></listitem>
2036 </varlistentry>
2037
2038 <varlistentry>
2039 <term><varname>$MAINPID</varname></term>
2040
2dd67817 2041 <listitem><para>The PID of the unit's main process if it is
798d3a52
ZJS
2042 known. This is only set for control processes as invoked by
2043 <varname>ExecReload=</varname> and similar. </para></listitem>
2044 </varlistentry>
2045
2046 <varlistentry>
2047 <term><varname>$MANAGERPID</varname></term>
2048
2049 <listitem><para>The PID of the user <command>systemd</command>
2050 instance, set for processes spawned by it. </para></listitem>
2051 </varlistentry>
2052
2053 <varlistentry>
2054 <term><varname>$LISTEN_FDS</varname></term>
2055 <term><varname>$LISTEN_PID</varname></term>
5c019cf2 2056 <term><varname>$LISTEN_FDNAMES</varname></term>
798d3a52
ZJS
2057
2058 <listitem><para>Information about file descriptors passed to a
2059 service for socket activation. See
2060 <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
2061 </para></listitem>
2062 </varlistentry>
2063
5c019cf2
EV
2064 <varlistentry>
2065 <term><varname>$NOTIFY_SOCKET</varname></term>
2066
2067 <listitem><para>The socket
2068 <function>sd_notify()</function> talks to. See
2069 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
2070 </para></listitem>
2071 </varlistentry>
2072
2073 <varlistentry>
2074 <term><varname>$WATCHDOG_PID</varname></term>
2075 <term><varname>$WATCHDOG_USEC</varname></term>
2076
2077 <listitem><para>Information about watchdog keep-alive notifications. See
2078 <citerefentry><refentrytitle>sd_watchdog_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
2079 </para></listitem>
2080 </varlistentry>
2081
798d3a52
ZJS
2082 <varlistentry>
2083 <term><varname>$TERM</varname></term>
2084
2085 <listitem><para>Terminal type, set only for units connected to
2086 a terminal (<varname>StandardInput=tty</varname>,
2087 <varname>StandardOutput=tty</varname>, or
2088 <varname>StandardError=tty</varname>). See
2089 <citerefentry project='man-pages'><refentrytitle>termcap</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
2090 </para></listitem>
2091 </varlistentry>
7bce046b
LP
2092
2093 <varlistentry>
2094 <term><varname>$JOURNAL_STREAM</varname></term>
2095
2096 <listitem><para>If the standard output or standard error output of the executed processes are connected to the
2097 journal (for example, by setting <varname>StandardError=journal</varname>) <varname>$JOURNAL_STREAM</varname>
2098 contains the device and inode numbers of the connection file descriptor, formatted in decimal, separated by a
2099 colon (<literal>:</literal>). This permits invoked processes to safely detect whether their standard output or
2100 standard error output are connected to the journal. The device and inode numbers of the file descriptors should
2101 be compared with the values set in the environment variable to determine whether the process output is still
2102 connected to the journal. Note that it is generally not sufficient to only check whether
2103 <varname>$JOURNAL_STREAM</varname> is set at all as services might invoke external processes replacing their
2104 standard output or standard error output, without unsetting the environment variable.</para>
2105
ab2116b1
LP
2106 <para>If both standard output and standard error of the executed processes are connected to the journal via a
2107 stream socket, this environment variable will contain information about the standard error stream, as that's
2108 usually the preferred destination for log data. (Note that typically the same stream is used for both standard
2109 output and standard error, hence very likely the environment variable contains device and inode information
2110 matching both stream file descriptors.)</para>
2111
7bce046b
LP
2112 <para>This environment variable is primarily useful to allow services to optionally upgrade their used log
2113 protocol to the native journal protocol (using
2114 <citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry> and other
2115 functions) if their standard output or standard error output is connected to the journal anyway, thus enabling
2116 delivery of structured metadata along with logged messages.</para></listitem>
2117 </varlistentry>
136dc4c4
LP
2118
2119 <varlistentry>
2120 <term><varname>$SERVICE_RESULT</varname></term>
2121
2122 <listitem><para>Only defined for the service unit type, this environment variable is passed to all
2123 <varname>ExecStop=</varname> and <varname>ExecStopPost=</varname> processes, and encodes the service
38a7c3c0
LP
2124 "result". Currently, the following values are defined:</para>
2125
2126 <table>
2127 <title>Defined <varname>$SERVICE_RESULT</varname> values</title>
2128 <tgroup cols='2'>
2129 <colspec colname='result'/>
2130 <colspec colname='meaning'/>
2131 <thead>
2132 <row>
2133 <entry>Value</entry>
2134 <entry>Meaning</entry>
2135 </row>
2136 </thead>
2137
2138 <tbody>
2139 <row>
2140 <entry><literal>success</literal></entry>
e124ccdf 2141 <entry>The service ran successfully and exited cleanly.</entry>
38a7c3c0
LP
2142 </row>
2143 <row>
2144 <entry><literal>protocol</literal></entry>
e124ccdf 2145 <entry>A protocol violation occurred: the service did not take the steps required by its unit configuration (specifically what is configured in its <varname>Type=</varname> setting).</entry>
38a7c3c0
LP
2146 </row>
2147 <row>
2148 <entry><literal>timeout</literal></entry>
e124ccdf 2149 <entry>One of the steps timed out.</entry>
38a7c3c0
LP
2150 </row>
2151 <row>
2152 <entry><literal>exit-code</literal></entry>
e124ccdf 2153 <entry>Service process exited with a non-zero exit code; see <varname>$EXIT_CODE</varname> below for the actual exit code returned.</entry>
38a7c3c0
LP
2154 </row>
2155 <row>
2156 <entry><literal>signal</literal></entry>
e124ccdf 2157 <entry>A service process was terminated abnormally by a signal, without dumping core. See <varname>$EXIT_CODE</varname> below for the actual signal causing the termination.</entry>
38a7c3c0
LP
2158 </row>
2159 <row>
2160 <entry><literal>core-dump</literal></entry>
e124ccdf 2161 <entry>A service process terminated abnormally with a signal and dumped core. See <varname>$EXIT_CODE</varname> below for the signal causing the termination.</entry>
38a7c3c0
LP
2162 </row>
2163 <row>
2164 <entry><literal>watchdog</literal></entry>
e124ccdf 2165 <entry>Watchdog keep-alive ping was enabled for the service, but the deadline was missed.</entry>
38a7c3c0
LP
2166 </row>
2167 <row>
2168 <entry><literal>start-limit-hit</literal></entry>
e124ccdf 2169 <entry>A start limit was defined for the unit and it was hit, causing the unit to fail to start. See <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s <varname>StartLimitIntervalSec=</varname> and <varname>StartLimitBurst=</varname> for details.</entry>
38a7c3c0
LP
2170 </row>
2171 <row>
2172 <entry><literal>resources</literal></entry>
2173 <entry>A catch-all condition in case a system operation failed.</entry>
2174 </row>
2175 </tbody>
2176 </tgroup>
2177 </table>
136dc4c4
LP
2178
2179 <para>This environment variable is useful to monitor failure or successful termination of a service. Even
2180 though this variable is available in both <varname>ExecStop=</varname> and <varname>ExecStopPost=</varname>, it
2181 is usually a better choice to place monitoring tools in the latter, as the former is only invoked for services
2182 that managed to start up correctly, and the latter covers both services that failed during their start-up and
2183 those which failed during their runtime.</para></listitem>
2184 </varlistentry>
2185
2186 <varlistentry>
2187 <term><varname>$EXIT_CODE</varname></term>
2188 <term><varname>$EXIT_STATUS</varname></term>
2189
2190 <listitem><para>Only defined for the service unit type, these environment variables are passed to all
2191 <varname>ExecStop=</varname>, <varname>ExecStopPost=</varname> processes and contain exit status/code
2192 information of the main process of the service. For the precise definition of the exit code and status, see
2193 <citerefentry><refentrytitle>wait</refentrytitle><manvolnum>2</manvolnum></citerefentry>. <varname>$EXIT_CODE</varname>
2194 is one of <literal>exited</literal>, <literal>killed</literal>,
2195 <literal>dumped</literal>. <varname>$EXIT_STATUS</varname> contains the numeric exit code formatted as string
2196 if <varname>$EXIT_CODE</varname> is <literal>exited</literal>, and the signal name in all other cases. Note
2197 that these environment variables are only set if the service manager succeeded to start and identify the main
e64e1bfd
ZJS
2198 process of the service.</para>
2199
2200 <table>
2201 <title>Summary of possible service result variable values</title>
2202 <tgroup cols='3'>
2203 <colspec colname='result' />
e64e1bfd 2204 <colspec colname='code' />
a4e26faf 2205 <colspec colname='status' />
e64e1bfd
ZJS
2206 <thead>
2207 <row>
2208 <entry><varname>$SERVICE_RESULT</varname></entry>
e64e1bfd 2209 <entry><varname>$EXIT_CODE</varname></entry>
a4e26faf 2210 <entry><varname>$EXIT_STATUS</varname></entry>
e64e1bfd
ZJS
2211 </row>
2212 </thead>
2213
2214 <tbody>
38a7c3c0
LP
2215 <row>
2216 <entry valign="top"><literal>success</literal></entry>
2217 <entry valign="top"><literal>exited</literal></entry>
2218 <entry><literal>0</literal></entry>
2219 </row>
a4e26faf
JW
2220 <row>
2221 <entry morerows="1" valign="top"><literal>protocol</literal></entry>
2222 <entry valign="top">not set</entry>
2223 <entry>not set</entry>
2224 </row>
2225 <row>
2226 <entry><literal>exited</literal></entry>
2227 <entry><literal>0</literal></entry>
2228 </row>
29df65f9
ZJS
2229 <row>
2230 <entry morerows="1" valign="top"><literal>timeout</literal></entry>
2231 <entry valign="top"><literal>killed</literal></entry>
6757c06a 2232 <entry><literal>TERM</literal>, <literal>KILL</literal></entry>
29df65f9 2233 </row>
29df65f9
ZJS
2234 <row>
2235 <entry valign="top"><literal>exited</literal></entry>
6757c06a
LP
2236 <entry><literal>0</literal>, <literal>1</literal>, <literal>2</literal>, <literal
2237 >3</literal>, …, <literal>255</literal></entry>
29df65f9 2238 </row>
e64e1bfd
ZJS
2239 <row>
2240 <entry valign="top"><literal>exit-code</literal></entry>
2241 <entry valign="top"><literal>exited</literal></entry>
38a7c3c0 2242 <entry><literal>1</literal>, <literal>2</literal>, <literal
6757c06a 2243 >3</literal>, …, <literal>255</literal></entry>
e64e1bfd 2244 </row>
e64e1bfd
ZJS
2245 <row>
2246 <entry valign="top"><literal>signal</literal></entry>
2247 <entry valign="top"><literal>killed</literal></entry>
6757c06a 2248 <entry><literal>HUP</literal>, <literal>INT</literal>, <literal>KILL</literal>, …</entry>
e64e1bfd 2249 </row>
e64e1bfd
ZJS
2250 <row>
2251 <entry valign="top"><literal>core-dump</literal></entry>
2252 <entry valign="top"><literal>dumped</literal></entry>
6757c06a 2253 <entry><literal>ABRT</literal>, <literal>SEGV</literal>, <literal>QUIT</literal>, …</entry>
e64e1bfd 2254 </row>
e64e1bfd
ZJS
2255 <row>
2256 <entry morerows="2" valign="top"><literal>watchdog</literal></entry>
2257 <entry><literal>dumped</literal></entry>
2258 <entry><literal>ABRT</literal></entry>
2259 </row>
2260 <row>
2261 <entry><literal>killed</literal></entry>
6757c06a 2262 <entry><literal>TERM</literal>, <literal>KILL</literal></entry>
e64e1bfd
ZJS
2263 </row>
2264 <row>
2265 <entry><literal>exited</literal></entry>
6757c06a
LP
2266 <entry><literal>0</literal>, <literal>1</literal>, <literal>2</literal>, <literal
2267 >3</literal>, …, <literal>255</literal></entry>
e64e1bfd 2268 </row>
38a7c3c0
LP
2269 <row>
2270 <entry><literal>start-limit-hit</literal></entry>
2271 <entry>not set</entry>
2272 <entry>not set</entry>
2273 </row>
e64e1bfd
ZJS
2274 <row>
2275 <entry><literal>resources</literal></entry>
2276 <entry>any of the above</entry>
2277 <entry>any of the above</entry>
2278 </row>
29df65f9 2279 <row>
38a7c3c0 2280 <entry namest="results" nameend="status">Note: the process may be also terminated by a signal not sent by systemd. In particular the process may send an arbitrary signal to itself in a handler for any of the non-maskable signals. Nevertheless, in the <literal>timeout</literal> and <literal>watchdog</literal> rows above only the signals that systemd sends have been included. Moreover, using <varname>SuccessExitStatus=</varname> additional exit statuses may be declared to indicate clean termination, which is not reflected by this table.</entry>
29df65f9 2281 </row>
e64e1bfd
ZJS
2282 </tbody>
2283 </tgroup>
2284 </table>
2285
2286 </listitem>
2287 </varlistentry>
798d3a52 2288 </variablelist>
798d3a52
ZJS
2289 </refsect1>
2290
91a8f867
JS
2291 <refsect1>
2292 <title>Process exit codes</title>
2293
2294 <para>When invoking a unit process the service manager possibly fails to apply the execution parameters configured
2295 with the settings above. In that case the already created service process will exit with a non-zero exit code
2296 before the configured command line is executed. (Or in other words, the child process possibly exits with these
2297 error codes, after having been created by the <citerefentry
2298 project='man-pages'><refentrytitle>fork</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call, but
2299 before the matching <citerefentry
2300 project='man-pages'><refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call is
2301 called.) Specifically, exit codes defined by the C library, by the LSB specification and by the systemd service
2302 manager itself are used.</para>
2303
2304 <para>The following basic service exit codes are defined by the C library.</para>
2305
2306 <table>
2307 <title>Basic C library exit codes</title>
2308 <tgroup cols='3'>
2309 <thead>
2310 <row>
2311 <entry>Exit Code</entry>
2312 <entry>Symbolic Name</entry>
2313 <entry>Description</entry>
2314 </row>
2315 </thead>
2316 <tbody>
2317 <row>
2318 <entry>0</entry>
2319 <entry><constant>EXIT_SUCCESS</constant></entry>
2320 <entry>Generic success code.</entry>
2321 </row>
2322 <row>
2323 <entry>1</entry>
2324 <entry><constant>EXIT_FAILURE</constant></entry>
2325 <entry>Generic failure or unspecified error.</entry>
2326 </row>
2327 </tbody>
2328 </tgroup>
2329 </table>
2330
2331 <para>The following service exit codes are defined by the <ulink
2332 url="https://refspecs.linuxbase.org/LSB_5.0.0/LSB-Core-generic/LSB-Core-generic/iniscrptact.html">LSB specification
2333 </ulink>.
2334 </para>
2335
2336 <table>
2337 <title>LSB service exit codes</title>
2338 <tgroup cols='3'>
2339 <thead>
2340 <row>
2341 <entry>Exit Code</entry>
2342 <entry>Symbolic Name</entry>
2343 <entry>Description</entry>
2344 </row>
2345 </thead>
2346 <tbody>
2347 <row>
2348 <entry>2</entry>
2349 <entry><constant>EXIT_INVALIDARGUMENT</constant></entry>
2350 <entry>Invalid or excess arguments.</entry>
2351 </row>
2352 <row>
2353 <entry>3</entry>
2354 <entry><constant>EXIT_NOTIMPLEMENTED</constant></entry>
2355 <entry>Unimplemented feature.</entry>
2356 </row>
2357 <row>
2358 <entry>4</entry>
2359 <entry><constant>EXIT_NOPERMISSION</constant></entry>
2360 <entry>The user has insufficient privileges.</entry>
2361 </row>
2362 <row>
2363 <entry>5</entry>
2364 <entry><constant>EXIT_NOTINSTALLED</constant></entry>
2365 <entry>The program is not installed.</entry>
2366 </row>
2367 <row>
2368 <entry>6</entry>
2369 <entry><constant>EXIT_NOTCONFIGURED</constant></entry>
2370 <entry>The program is not configured.</entry>
2371 </row>
2372 <row>
2373 <entry>7</entry>
2374 <entry><constant>EXIT_NOTRUNNING</constant></entry>
2375 <entry>The program is not running.</entry>
2376 </row>
2377 </tbody>
2378 </tgroup>
2379 </table>
2380
2381 <para>
2382 The LSB specification suggests that error codes 200 and above are reserved for implementations. Some of them are
2383 used by the service manager to indicate problems during process invocation:
2384 </para>
2385 <table>
2386 <title>systemd-specific exit codes</title>
2387 <tgroup cols='3'>
2388 <thead>
2389 <row>
2390 <entry>Exit Code</entry>
2391 <entry>Symbolic Name</entry>
2392 <entry>Description</entry>
2393 </row>
2394 </thead>
2395 <tbody>
2396 <row>
2397 <entry>200</entry>
2398 <entry><constant>EXIT_CHDIR</constant></entry>
2399 <entry>Changing to the requested working directory failed. See <varname>WorkingDirectory=</varname> above.</entry>
2400 </row>
2401 <row>
2402 <entry>201</entry>
2403 <entry><constant>EXIT_NICE</constant></entry>
2404 <entry>Failed to set up process scheduling priority (nice level). See <varname>Nice=</varname> above.</entry>
2405 </row>
2406 <row>
2407 <entry>202</entry>
2408 <entry><constant>EXIT_FDS</constant></entry>
2409 <entry>Failed to close unwanted file descriptors, or to adjust passed file descriptors.</entry>
2410 </row>
2411 <row>
2412 <entry>203</entry>
2413 <entry><constant>EXIT_EXEC</constant></entry>
2414 <entry>The actual process execution failed (specifically, the <citerefentry project='man-pages'><refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call). Most likely this is caused by a missing or non-accessible executable file.</entry>
2415 </row>
2416 <row>
2417 <entry>204</entry>
2418 <entry><constant>EXIT_MEMORY</constant></entry>
2419 <entry>Failed to perform an action due to memory shortage.</entry>
2420 </row>
2421 <row>
2422 <entry>205</entry>
2423 <entry><constant>EXIT_LIMITS</constant></entry>
dcfaecc7 2424 <entry>Failed to adjust resource limits. See <varname>LimitCPU=</varname> and related settings above.</entry>
91a8f867
JS
2425 </row>
2426 <row>
2427 <entry>206</entry>
2428 <entry><constant>EXIT_OOM_ADJUST</constant></entry>
2429 <entry>Failed to adjust the OOM setting. See <varname>OOMScoreAdjust=</varname> above.</entry>
2430 </row>
2431 <row>
2432 <entry>207</entry>
2433 <entry><constant>EXIT_SIGNAL_MASK</constant></entry>
2434 <entry>Failed to set process signal mask.</entry>
2435 </row>
2436 <row>
2437 <entry>208</entry>
2438 <entry><constant>EXIT_STDIN</constant></entry>
2439 <entry>Failed to set up standard input. See <varname>StandardInput=</varname> above.</entry>
2440 </row>
2441 <row>
2442 <entry>209</entry>
2443 <entry><constant>EXIT_STDOUT</constant></entry>
2444 <entry>Failed to set up standard output. See <varname>StandardOutput=</varname> above.</entry>
2445 </row>
2446 <row>
2447 <entry>210</entry>
2448 <entry><constant>EXIT_CHROOT</constant></entry>
2449 <entry>Failed to change root directory (<citerefentry project='man-pages'><refentrytitle>chroot</refentrytitle><manvolnum>2</manvolnum></citerefentry>). See <varname>RootDirectory=</varname>/<varname>RootImage=</varname> above.</entry>
2450 </row>
2451 <row>
2452 <entry>211</entry>
2453 <entry><constant>EXIT_IOPRIO</constant></entry>
2454 <entry>Failed to set up IO scheduling priority. See <varname>IOSchedulingClass=</varname>/<varname>IOSchedulingPriority=</varname> above.</entry>
2455 </row>
2456 <row>
2457 <entry>212</entry>
2458 <entry><constant>EXIT_TIMERSLACK</constant></entry>
2459 <entry>Failed to set up timer slack. See <varname>TimerSlackNSec=</varname> above.</entry>
2460 </row>
2461 <row>
2462 <entry>213</entry>
2463 <entry><constant>EXIT_SECUREBITS</constant></entry>
2464 <entry>Failed to set process secure bits. See <varname>SecureBits=</varname> above.</entry>
2465 </row>
2466 <row>
2467 <entry>214</entry>
2468 <entry><constant>EXIT_SETSCHEDULER</constant></entry>
2469 <entry>Failed to set up CPU scheduling. See <varname>CPUSchedulingPolicy=</varname>/<varname>CPUSchedulingPriority=</varname> above.</entry>
2470 </row>
2471 <row>
2472 <entry>215</entry>
2473 <entry><constant>EXIT_CPUAFFINITY</constant></entry>
2474 <entry>Failed to set up CPU affinity. See <varname>CPUAffinity=</varname> above.</entry>
2475 </row>
2476 <row>
2477 <entry>216</entry>
2478 <entry><constant>EXIT_GROUP</constant></entry>
2479 <entry>Failed to determine or change group credentials. See <varname>Group=</varname>/<varname>SupplementaryGroups=</varname> above.</entry>
2480 </row>
2481 <row>
2482 <entry>217</entry>
2483 <entry><constant>EXIT_USER</constant></entry>
2484 <entry>Failed to determine or change user credentials, or to set up user namespacing. See <varname>User=</varname>/<varname>PrivateUsers=</varname> above.</entry>
2485 </row>
2486 <row>
2487 <entry>218</entry>
2488 <entry><constant>EXIT_CAPABILITIES</constant></entry>
2489 <entry>Failed to drop capabilities, or apply ambient capabilities. See <varname>CapabilityBoundingSet=</varname>/<varname>AmbientCapabilities=</varname> above.</entry>
2490 </row>
2491 <row>
2492 <entry>219</entry>
2493 <entry><constant>EXIT_CGROUP</constant></entry>
2494 <entry>Setting up the service control group failed.</entry>
2495 </row>
2496 <row>
2497 <entry>220</entry>
2498 <entry><constant>EXIT_SETSID</constant></entry>
2499 <entry>Failed to create new process session.</entry>
2500 </row>
2501 <row>
2502 <entry>221</entry>
2503 <entry><constant>EXIT_CONFIRM</constant></entry>
2504 <entry>Execution has been cancelled by the user. See the <varname>systemd.confirm_spawn=</varname> kernel command line setting on <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details.</entry>
2505 </row>
2506 <row>
2507 <entry>222</entry>
2508 <entry><constant>EXIT_STDERR</constant></entry>
2509 <entry>Failed to set up standard error output. See <varname>StandardError=</varname> above.</entry>
2510 </row>
2511 <row>
2512 <entry>224</entry>
2513 <entry><constant>EXIT_PAM</constant></entry>
2514 <entry>Failed to set up PAM session. See <varname>PAMName=</varname> above.</entry>
2515 </row>
2516 <row>
2517 <entry>225</entry>
2518 <entry><constant>EXIT_NETWORK</constant></entry>
2519 <entry>Failed to set up network namespacing. See <varname>PrivateNetwork=</varname> above.</entry>
2520 </row>
2521 <row>
2522 <entry>226</entry>
2523 <entry><constant>EXIT_NAMESPACE</constant></entry>
2524 <entry>Failed to set up mount namespacing. See <varname>ReadOnlyPaths=</varname> and related settings above.</entry>
2525 </row>
2526 <row>
2527 <entry>227</entry>
2528 <entry><constant>EXIT_NO_NEW_PRIVILEGES</constant></entry>
dcfaecc7 2529 <entry>Failed to disable new privileges. See <varname>NoNewPrivileges=yes</varname> above.</entry>
91a8f867
JS
2530 </row>
2531 <row>
2532 <entry>228</entry>
2533 <entry><constant>EXIT_SECCOMP</constant></entry>
2534 <entry>Failed to apply system call filters. See <varname>SystemCallFilter=</varname> and related settings above.</entry>
2535 </row>
2536 <row>
2537 <entry>229</entry>
2538 <entry><constant>EXIT_SELINUX_CONTEXT</constant></entry>
2539 <entry>Determining or changing SELinux context failed. See <varname>SELinuxContext=</varname> above.</entry>
2540 </row>
2541 <row>
2542 <entry>230</entry>
2543 <entry><constant>EXIT_PERSONALITY</constant></entry>
dcfaecc7 2544 <entry>Failed to set up an execution domain (personality). See <varname>Personality=</varname> above.</entry>
91a8f867
JS
2545 </row>
2546 <row>
2547 <entry>231</entry>
2548 <entry><constant>EXIT_APPARMOR_PROFILE</constant></entry>
2549 <entry>Failed to prepare changing AppArmor profile. See <varname>AppArmorProfile=</varname> above.</entry>
2550 </row>
2551 <row>
2552 <entry>232</entry>
2553 <entry><constant>EXIT_ADDRESS_FAMILIES</constant></entry>
2554 <entry>Failed to restrict address families. See <varname>RestrictAddressFamilies=</varname> above.</entry>
2555 </row>
2556 <row>
2557 <entry>233</entry>
2558 <entry><constant>EXIT_RUNTIME_DIRECTORY</constant></entry>
2559 <entry>Setting up runtime directory failed. See <varname>RuntimeDirectory=</varname> and related settings above.</entry>
2560 </row>
2561 <row>
2562 <entry>235</entry>
2563 <entry><constant>EXIT_CHOWN</constant></entry>
2564 <entry>Failed to adjust socket ownership. Used for socket units only.</entry>
2565 </row>
2566 <row>
2567 <entry>236</entry>
2568 <entry><constant>EXIT_SMACK_PROCESS_LABEL</constant></entry>
2569 <entry>Failed to set SMACK label. See <varname>SmackProcessLabel=</varname> above.</entry>
2570 </row>
2571 <row>
2572 <entry>237</entry>
2573 <entry><constant>EXIT_KEYRING</constant></entry>
2574 <entry>Failed to set up kernel keyring.</entry>
2575 </row>
2576 <row>
2577 <entry>238</entry>
2578 <entry><constant>EXIT_STATE_DIRECTORY</constant></entry>
dcfaecc7 2579 <entry>Failed to set up unit's state directory. See <varname>StateDirectory=</varname> above.</entry>
91a8f867
JS
2580 </row>
2581 <row>
2582 <entry>239</entry>
2583 <entry><constant>EXIT_CACHE_DIRECTORY</constant></entry>
dcfaecc7 2584 <entry>Failed to set up unit's cache directory. See <varname>CacheDirectory=</varname> above.</entry>
91a8f867
JS
2585 </row>
2586 <row>
2587 <entry>240</entry>
2588 <entry><constant>EXIT_LOGS_DIRECTORY</constant></entry>
dcfaecc7 2589 <entry>Failed to set up unit's logging directory. See <varname>LogsDirectory=</varname> above.</entry>
91a8f867
JS
2590 </row>
2591 <row>
2592 <entry>241</entry>
2593 <entry><constant>EXIT_CONFIGURATION_DIRECTORY</constant></entry>
dcfaecc7 2594 <entry>Failed to set up unit's configuration directory. See <varname>ConfigurationDirectory=</varname> above.</entry>
91a8f867
JS
2595 </row>
2596 </tbody>
2597 </tgroup>
2598 </table>
2599 </refsect1>
2600
798d3a52
ZJS
2601 <refsect1>
2602 <title>See Also</title>
2603 <para>
2604 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2605 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
869feb33 2606 <citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
798d3a52
ZJS
2607 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
2608 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2609 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2610 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2611 <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2612 <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2613 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2614 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
a4c18002 2615 <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
798d3a52
ZJS
2616 <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
2617 <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
2618 <citerefentry project='man-pages'><refentrytitle>exec</refentrytitle><manvolnum>3</manvolnum></citerefentry>
2619 </para>
2620 </refsect1>
dd1eb43b 2621
e64e1bfd 2622
dd1eb43b 2623</refentry>