]> git.ipfire.org Git - thirdparty/systemd.git/blob - man/systemd.resource-control.xml
Merge pull request #13636 from traylenator/manpage
[thirdparty/systemd.git] / man / systemd.resource-control.xml
1 <?xml version='1.0'?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
5
6 <refentry id="systemd.resource-control">
7 <refentryinfo>
8 <title>systemd.resource-control</title>
9 <productname>systemd</productname>
10 </refentryinfo>
11
12 <refmeta>
13 <refentrytitle>systemd.resource-control</refentrytitle>
14 <manvolnum>5</manvolnum>
15 </refmeta>
16
17 <refnamediv>
18 <refname>systemd.resource-control</refname>
19 <refpurpose>Resource control unit settings</refpurpose>
20 </refnamediv>
21
22 <refsynopsisdiv>
23 <para>
24 <filename><replaceable>slice</replaceable>.slice</filename>,
25 <filename><replaceable>scope</replaceable>.scope</filename>,
26 <filename><replaceable>service</replaceable>.service</filename>,
27 <filename><replaceable>socket</replaceable>.socket</filename>,
28 <filename><replaceable>mount</replaceable>.mount</filename>,
29 <filename><replaceable>swap</replaceable>.swap</filename>
30 </para>
31 </refsynopsisdiv>
32
33 <refsect1>
34 <title>Description</title>
35
36 <para>Unit configuration files for services, slices, scopes, sockets, mount points, and swap devices share a subset
37 of configuration options for resource control of spawned processes. Internally, this relies on the Linux Control
38 Groups (cgroups) kernel concept for organizing processes in a hierarchical tree of named groups for the purpose of
39 resource management.</para>
40
41 <para>This man page lists the configuration options shared by
42 those six unit types. See
43 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
44 for the common options of all unit configuration files, and
45 <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
46 <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
47 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
48 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
49 <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
50 and
51 <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>
52 for more information on the specific unit configuration files. The
53 resource control configuration options are configured in the
54 [Slice], [Scope], [Service], [Socket], [Mount], or [Swap]
55 sections, depending on the unit type.</para>
56
57 <para>In addition, options which control resources available to programs
58 <emphasis>executed</emphasis> by systemd are listed in
59 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
60 Those options complement options listed here.</para>
61
62 <para>See the <ulink
63 url="https://www.freedesktop.org/wiki/Software/systemd/ControlGroupInterface/">New
64 Control Group Interfaces</ulink> for an introduction on how to make
65 use of resource control APIs from programs.</para>
66 </refsect1>
67
68 <refsect1>
69 <title>Implicit Dependencies</title>
70
71 <para>The following dependencies are implicitly added:</para>
72
73 <itemizedlist>
74 <listitem><para>Units with the <varname>Slice=</varname> setting set automatically acquire
75 <varname>Requires=</varname> and <varname>After=</varname> dependencies on the specified
76 slice unit.</para></listitem>
77 </itemizedlist>
78 </refsect1>
79
80 <!-- We don't have any default dependency here. -->
81
82 <refsect1>
83 <title>Unified and Legacy Control Group Hierarchies</title>
84
85 <para>The unified control group hierarchy is the new version of kernel control group interface, see <ulink
86 url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink>. Depending on the resource type,
87 there are differences in resource control capabilities. Also, because of interface changes, some resource types
88 have separate set of options on the unified hierarchy.</para>
89
90 <para>
91 <variablelist>
92
93 <varlistentry>
94 <term><option>CPU</option></term>
95 <listitem>
96 <para><varname>CPUWeight=</varname> and <varname>StartupCPUWeight=</varname> replace
97 <varname>CPUShares=</varname> and <varname>StartupCPUShares=</varname>, respectively.</para>
98
99 <para>The <literal>cpuacct</literal> controller does not exist separately on the unified hierarchy.</para>
100 </listitem>
101 </varlistentry>
102
103 <varlistentry>
104 <term><option>Memory</option></term>
105 <listitem>
106 <para><varname>MemoryMax=</varname> replaces <varname>MemoryLimit=</varname>. <varname>MemoryLow=</varname>
107 and <varname>MemoryHigh=</varname> are effective only on unified hierarchy.</para>
108 </listitem>
109 </varlistentry>
110
111 <varlistentry>
112 <term><option>IO</option></term>
113 <listitem>
114 <para><varname>IO</varname> prefixed settings are a superset of and replace <varname>BlockIO</varname>
115 prefixed ones. On unified hierarchy, IO resource control also applies to buffered writes.</para>
116 </listitem>
117 </varlistentry>
118
119 </variablelist>
120 </para>
121
122 <para>To ease the transition, there is best-effort translation between the two versions of settings. For each
123 controller, if any of the settings for the unified hierarchy are present, all settings for the legacy hierarchy are
124 ignored. If the resulting settings are for the other type of hierarchy, the configurations are translated before
125 application.</para>
126
127 <para>Legacy control group hierarchy (see <ulink
128 url="https://www.kernel.org/doc/Documentation/cgroup-v1/cgroups.txt">cgroups.txt</ulink>), also called cgroup-v1,
129 doesn't allow safe delegation of controllers to unprivileged processes. If the system uses the legacy control group
130 hierarchy, resource control is disabled for systemd user instance, see
131 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
132 </para>
133 </refsect1>
134
135 <refsect1>
136 <title>Options</title>
137
138 <para>Units of the types listed above can have settings
139 for resource control configuration:</para>
140
141 <variablelist class='unit-directives'>
142
143 <varlistentry>
144 <term><varname>CPUAccounting=</varname></term>
145
146 <listitem>
147 <para>Turn on CPU usage accounting for this unit. Takes a
148 boolean argument. Note that turning on CPU accounting for
149 one unit will also implicitly turn it on for all units
150 contained in the same slice and for all its parent slices
151 and the units contained therein. The system default for this
152 setting may be controlled with
153 <varname>DefaultCPUAccounting=</varname> in
154 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
155 </listitem>
156 </varlistentry>
157
158 <varlistentry>
159 <term><varname>CPUWeight=<replaceable>weight</replaceable></varname></term>
160 <term><varname>StartupCPUWeight=<replaceable>weight</replaceable></varname></term>
161
162 <listitem>
163 <para>Assign the specified CPU time weight to the processes executed, if the unified control group hierarchy
164 is used on the system. These options take an integer value and control the <literal>cpu.weight</literal>
165 control group attribute. The allowed range is 1 to 10000. Defaults to 100. For details about this control
166 group attribute, see <ulink
167 url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink> and <ulink
168 url="https://www.kernel.org/doc/Documentation/scheduler/sched-design-CFS.txt">sched-design-CFS.txt</ulink>.
169 The available CPU time is split up among all units within one slice relative to their CPU time weight.</para>
170
171 <para>While <varname>StartupCPUWeight=</varname> only applies to the startup phase of the system,
172 <varname>CPUWeight=</varname> applies to normal runtime of the system, and if the former is not set also to
173 the startup phase. Using <varname>StartupCPUWeight=</varname> allows prioritizing specific services at
174 boot-up differently than during normal runtime.</para>
175
176 <para>These settings replace <varname>CPUShares=</varname> and <varname>StartupCPUShares=</varname>.</para>
177 </listitem>
178 </varlistentry>
179
180 <varlistentry>
181 <term><varname>CPUQuota=</varname></term>
182
183 <listitem>
184 <para>Assign the specified CPU time quota to the processes executed. Takes a percentage value, suffixed with
185 "%". The percentage specifies how much CPU time the unit shall get at maximum, relative to the total CPU time
186 available on one CPU. Use values &gt; 100% for allotting CPU time on more than one CPU. This controls the
187 <literal>cpu.max</literal> attribute on the unified control group hierarchy and
188 <literal>cpu.cfs_quota_us</literal> on legacy. For details about these control group attributes, see <ulink
189 url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink> and <ulink
190 url="https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt">sched-bwc.txt</ulink>.</para>
191
192 <para>Example: <varname>CPUQuota=20%</varname> ensures that the executed processes will never get more than
193 20% CPU time on one CPU.</para>
194
195 </listitem>
196 </varlistentry>
197
198 <varlistentry>
199 <term><varname>CPUQuotaPeriodSec=</varname></term>
200
201 <listitem>
202 <para>Assign the duration over which the CPU time quota specified by <varname>CPUQuota=</varname> is measured.
203 Takes a time duration value in seconds, with an optional suffix such as "ms" for milliseconds (or "s" for seconds.)
204 The default setting is 100ms. The period is clamped to the range supported by the kernel, which is [1ms, 1000ms].
205 Additionally, the period is adjusted up so that the quota interval is also at least 1ms.
206 Setting <varname>CPUQuotaPeriodSec=</varname> to an empty value resets it to the default.</para>
207
208 <para>This controls the second field of <literal>cpu.max</literal> attribute on the unified control group hierarchy
209 and <literal>cpu.cfs_period_us</literal> on legacy. For details about these control group attributes, see
210 <ulink url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink> and
211 <ulink url="https://www.kernel.org/doc/Documentation/scheduler/sched-design-CFS.txt">sched-design-CFS.txt</ulink>.</para>
212
213 <para>Example: <varname>CPUQuotaPeriodSec=10ms</varname> to request that the CPU quota is measured in periods of 10ms.</para>
214 </listitem>
215 </varlistentry>
216
217 <varlistentry>
218 <term><varname>AllowedCPUs=</varname></term>
219
220 <listitem>
221 <para>Restrict processes to be executed on specific CPUs. Takes a list of CPU indices or ranges separated by either
222 whitespace or commas. CPU ranges are specified by the lower and upper CPU indices separated by a dash.</para>
223
224 <para>Setting <varname>AllowedCPUs=</varname> doesn't guarantee that all of the CPUs will be used by the processes
225 as it may be limited by parent units. The effective configuration is reported as <varname>EffectiveCPUs=</varname>.</para>
226
227 <para>This setting is supported only with the unified control group hierarchy.</para>
228 </listitem>
229 </varlistentry>
230
231 <varlistentry>
232 <term><varname>AllowedMemoryNodes=</varname></term>
233
234 <listitem>
235 <para>Restrict processes to be executed on specific memory NUMA nodes. Takes a list of memory NUMA nodes indices
236 or ranges separated by either whitespace or commas. Memory NUMA nodes ranges are specified by the lower and upper
237 CPU indices separated by a dash.</para>
238
239 <para>Setting <varname>AllowedMemoryNodes=</varname> doesn't guarantee that all of the memory NUMA nodes will
240 be used by the processes as it may be limited by parent units. The effective configuration is reported as
241 <varname>EffectiveMemoryNodes=</varname>.</para>
242
243 <para>This setting is supported only with the unified control group hierarchy.</para>
244 </listitem>
245 </varlistentry>
246
247 <varlistentry>
248 <term><varname>MemoryAccounting=</varname></term>
249
250 <listitem>
251 <para>Turn on process and kernel memory accounting for this
252 unit. Takes a boolean argument. Note that turning on memory
253 accounting for one unit will also implicitly turn it on for
254 all units contained in the same slice and for all its parent
255 slices and the units contained therein. The system default
256 for this setting may be controlled with
257 <varname>DefaultMemoryAccounting=</varname> in
258 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
259 </listitem>
260 </varlistentry>
261
262 <varlistentry>
263 <term><varname>MemoryMin=<replaceable>bytes</replaceable></varname></term>
264
265 <listitem>
266 <para>Specify the memory usage protection of the executed processes in this unit. If the memory usages of
267 this unit and all its ancestors are below their minimum boundaries, this unit's memory won't be reclaimed.</para>
268
269 <para>Takes a memory size in bytes. If the value is suffixed with K, M, G or T, the specified memory size is
270 parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively. Alternatively, a
271 percentage value may be specified, which is taken relative to the installed physical memory on the
272 system. This controls the <literal>memory.min</literal> control group attribute. For details about this
273 control group attribute, see <ulink
274 url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink>.</para>
275
276 <para>This setting is supported only if the unified control group hierarchy is used and disables
277 <varname>MemoryLimit=</varname>.</para>
278
279 <para>Units may have their children use a default <literal>memory.min</literal> value by specifying
280 <varname>DefaultMemoryMin=</varname>, which has the same semantics as <varname>MemoryMin=</varname>. This setting
281 does not affect <literal>memory.min</literal> in the unit itself.</para>
282 </listitem>
283 </varlistentry>
284
285 <varlistentry>
286 <term><varname>MemoryLow=<replaceable>bytes</replaceable></varname></term>
287
288 <listitem>
289 <para>Specify the best-effort memory usage protection of the executed processes in this unit. If the memory
290 usages of this unit and all its ancestors are below their low boundaries, this unit's memory won't be
291 reclaimed as long as memory can be reclaimed from unprotected units.</para>
292
293 <para>Takes a memory size in bytes. If the value is suffixed with K, M, G or T, the specified memory size is
294 parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively. Alternatively, a
295 percentage value may be specified, which is taken relative to the installed physical memory on the
296 system. This controls the <literal>memory.low</literal> control group attribute. For details about this
297 control group attribute, see <ulink
298 url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink>.</para>
299
300 <para>This setting is supported only if the unified control group hierarchy is used and disables
301 <varname>MemoryLimit=</varname>.</para>
302
303 <para>Units may have their children use a default <literal>memory.low</literal> value by specifying
304 <varname>DefaultMemoryLow=</varname>, which has the same semantics as <varname>MemoryLow=</varname>. This setting
305 does not affect <literal>memory.low</literal> in the unit itself.</para>
306 </listitem>
307 </varlistentry>
308
309 <varlistentry>
310 <term><varname>MemoryHigh=<replaceable>bytes</replaceable></varname></term>
311
312 <listitem>
313 <para>Specify the high limit on memory usage of the executed processes in this unit. Memory usage may go
314 above the limit if unavoidable, but the processes are heavily slowed down and memory is taken away
315 aggressively in such cases. This is the main mechanism to control memory usage of a unit.</para>
316
317 <para>Takes a memory size in bytes. If the value is suffixed with K, M, G or T, the specified memory size is
318 parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively. Alternatively, a
319 percentage value may be specified, which is taken relative to the installed physical memory on the
320 system. If assigned the
321 special value <literal>infinity</literal>, no memory limit is applied. This controls the
322 <literal>memory.high</literal> control group attribute. For details about this control group attribute, see
323 <ulink url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink>.</para>
324
325 <para>This setting is supported only if the unified control group hierarchy is used and disables
326 <varname>MemoryLimit=</varname>.</para>
327 </listitem>
328 </varlistentry>
329
330 <varlistentry>
331 <term><varname>MemoryMax=<replaceable>bytes</replaceable></varname></term>
332
333 <listitem>
334 <para>Specify the absolute limit on memory usage of the executed processes in this unit. If memory usage
335 cannot be contained under the limit, out-of-memory killer is invoked inside the unit. It is recommended to
336 use <varname>MemoryHigh=</varname> as the main control mechanism and use <varname>MemoryMax=</varname> as the
337 last line of defense.</para>
338
339 <para>Takes a memory size in bytes. If the value is suffixed with K, M, G or T, the specified memory size is
340 parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively. Alternatively, a
341 percentage value may be specified, which is taken relative to the installed physical memory on the system. If
342 assigned the special value <literal>infinity</literal>, no memory limit is applied. This controls the
343 <literal>memory.max</literal> control group attribute. For details about this control group attribute, see
344 <ulink url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink>.</para>
345
346 <para>This setting replaces <varname>MemoryLimit=</varname>.</para>
347 </listitem>
348 </varlistentry>
349
350 <varlistentry>
351 <term><varname>MemorySwapMax=<replaceable>bytes</replaceable></varname></term>
352
353 <listitem>
354 <para>Specify the absolute limit on swap usage of the executed processes in this unit.</para>
355
356 <para>Takes a swap size in bytes. If the value is suffixed with K, M, G or T, the specified swap size is
357 parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively. If assigned the
358 special value <literal>infinity</literal>, no swap limit is applied. This controls the
359 <literal>memory.swap.max</literal> control group attribute. For details about this control group attribute,
360 see <ulink url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink>.</para>
361
362 <para>This setting is supported only if the unified control group hierarchy is used and disables
363 <varname>MemoryLimit=</varname>.</para>
364 </listitem>
365 </varlistentry>
366
367 <varlistentry>
368 <term><varname>TasksAccounting=</varname></term>
369
370 <listitem>
371 <para>Turn on task accounting for this unit. Takes a
372 boolean argument. If enabled, the system manager will keep
373 track of the number of tasks in the unit. The number of
374 tasks accounted this way includes both kernel threads and
375 userspace processes, with each thread counting
376 individually. Note that turning on tasks accounting for one
377 unit will also implicitly turn it on for all units contained
378 in the same slice and for all its parent slices and the
379 units contained therein. The system default for this setting
380 may be controlled with
381 <varname>DefaultTasksAccounting=</varname> in
382 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
383 </listitem>
384 </varlistentry>
385
386 <varlistentry>
387 <term><varname>TasksMax=<replaceable>N</replaceable></varname></term>
388
389 <listitem>
390 <para>Specify the maximum number of tasks that may be created in the unit. This ensures that the number of
391 tasks accounted for the unit (see above) stays below a specific limit. This either takes an absolute number
392 of tasks or a percentage value that is taken relative to the configured maximum number of tasks on the
393 system. If assigned the special value <literal>infinity</literal>, no tasks limit is applied. This controls
394 the <literal>pids.max</literal> control group attribute. For details about this control group attribute, see
395 <ulink url="https://www.kernel.org/doc/Documentation/cgroup-v1/pids.txt">pids.txt</ulink>.</para>
396
397 <para>The
398 system default for this setting may be controlled with
399 <varname>DefaultTasksMax=</varname> in
400 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
401 </listitem>
402 </varlistentry>
403
404 <varlistentry>
405 <term><varname>IOAccounting=</varname></term>
406
407 <listitem>
408 <para>Turn on Block I/O accounting for this unit, if the unified control group hierarchy is used on the
409 system. Takes a boolean argument. Note that turning on block I/O accounting for one unit will also implicitly
410 turn it on for all units contained in the same slice and all for its parent slices and the units contained
411 therein. The system default for this setting may be controlled with <varname>DefaultIOAccounting=</varname>
412 in
413 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
414
415 <para>This setting replaces <varname>BlockIOAccounting=</varname> and disables settings prefixed with
416 <varname>BlockIO</varname> or <varname>StartupBlockIO</varname>.</para>
417 </listitem>
418 </varlistentry>
419
420 <varlistentry>
421 <term><varname>IOWeight=<replaceable>weight</replaceable></varname></term>
422 <term><varname>StartupIOWeight=<replaceable>weight</replaceable></varname></term>
423
424 <listitem>
425 <para>Set the default overall block I/O weight for the executed processes, if the unified control group
426 hierarchy is used on the system. Takes a single weight value (between 1 and 10000) to set the default block
427 I/O weight. This controls the <literal>io.weight</literal> control group attribute, which defaults to
428 100. For details about this control group attribute, see <ulink
429 url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink>. The available I/O
430 bandwidth is split up among all units within one slice relative to their block I/O weight.</para>
431
432 <para>While <varname>StartupIOWeight=</varname> only applies
433 to the startup phase of the system,
434 <varname>IOWeight=</varname> applies to the later runtime of
435 the system, and if the former is not set also to the startup
436 phase. This allows prioritizing specific services at boot-up
437 differently than during runtime.</para>
438
439 <para>These settings replace <varname>BlockIOWeight=</varname> and <varname>StartupBlockIOWeight=</varname>
440 and disable settings prefixed with <varname>BlockIO</varname> or <varname>StartupBlockIO</varname>.</para>
441 </listitem>
442 </varlistentry>
443
444 <varlistentry>
445 <term><varname>IODeviceWeight=<replaceable>device</replaceable> <replaceable>weight</replaceable></varname></term>
446
447 <listitem>
448 <para>Set the per-device overall block I/O weight for the executed processes, if the unified control group
449 hierarchy is used on the system. Takes a space-separated pair of a file path and a weight value to specify
450 the device specific weight value, between 1 and 10000. (Example: <literal>/dev/sda 1000</literal>). The file
451 path may be specified as path to a block device node or as any other file, in which case the backing block
452 device of the file system of the file is determined. This controls the <literal>io.weight</literal> control
453 group attribute, which defaults to 100. Use this option multiple times to set weights for multiple devices.
454 For details about this control group attribute, see <ulink
455 url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink>.</para>
456
457 <para>This setting replaces <varname>BlockIODeviceWeight=</varname> and disables settings prefixed with
458 <varname>BlockIO</varname> or <varname>StartupBlockIO</varname>.</para>
459 </listitem>
460 </varlistentry>
461
462 <varlistentry>
463 <term><varname>IOReadBandwidthMax=<replaceable>device</replaceable> <replaceable>bytes</replaceable></varname></term>
464 <term><varname>IOWriteBandwidthMax=<replaceable>device</replaceable> <replaceable>bytes</replaceable></varname></term>
465
466 <listitem>
467 <para>Set the per-device overall block I/O bandwidth maximum limit for the executed processes, if the unified
468 control group hierarchy is used on the system. This limit is not work-conserving and the executed processes
469 are not allowed to use more even if the device has idle capacity. Takes a space-separated pair of a file
470 path and a bandwidth value (in bytes per second) to specify the device specific bandwidth. The file path may
471 be a path to a block device node, or as any other file in which case the backing block device of the file
472 system of the file is used. If the bandwidth is suffixed with K, M, G, or T, the specified bandwidth is
473 parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes, respectively, to the base of 1000. (Example:
474 "/dev/disk/by-path/pci-0000:00:1f.2-scsi-0:0:0:0 5M"). This controls the <literal>io.max</literal> control
475 group attributes. Use this option multiple times to set bandwidth limits for multiple devices. For details
476 about this control group attribute, see <ulink
477 url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink>.
478 </para>
479
480 <para>These settings replace <varname>BlockIOReadBandwidth=</varname> and
481 <varname>BlockIOWriteBandwidth=</varname> and disable settings prefixed with <varname>BlockIO</varname> or
482 <varname>StartupBlockIO</varname>.</para>
483 </listitem>
484 </varlistentry>
485
486 <varlistentry>
487 <term><varname>IOReadIOPSMax=<replaceable>device</replaceable> <replaceable>IOPS</replaceable></varname></term>
488 <term><varname>IOWriteIOPSMax=<replaceable>device</replaceable> <replaceable>IOPS</replaceable></varname></term>
489
490 <listitem>
491 <para>Set the per-device overall block I/O IOs-Per-Second maximum limit for the executed processes, if the
492 unified control group hierarchy is used on the system. This limit is not work-conserving and the executed
493 processes are not allowed to use more even if the device has idle capacity. Takes a space-separated pair of
494 a file path and an IOPS value to specify the device specific IOPS. The file path may be a path to a block
495 device node, or as any other file in which case the backing block device of the file system of the file is
496 used. If the IOPS is suffixed with K, M, G, or T, the specified IOPS is parsed as KiloIOPS, MegaIOPS,
497 GigaIOPS, or TeraIOPS, respectively, to the base of 1000. (Example:
498 "/dev/disk/by-path/pci-0000:00:1f.2-scsi-0:0:0:0 1K"). This controls the <literal>io.max</literal> control
499 group attributes. Use this option multiple times to set IOPS limits for multiple devices. For details about
500 this control group attribute, see <ulink
501 url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink>.
502 </para>
503
504 <para>These settings are supported only if the unified control group hierarchy is used and disable settings
505 prefixed with <varname>BlockIO</varname> or <varname>StartupBlockIO</varname>.</para>
506 </listitem>
507 </varlistentry>
508
509 <varlistentry>
510 <term><varname>IODeviceLatencyTargetSec=<replaceable>device</replaceable> <replaceable>target</replaceable></varname></term>
511
512 <listitem>
513 <para>Set the per-device average target I/O latency for the executed processes, if the unified control group
514 hierarchy is used on the system. Takes a file path and a timespan separated by a space to specify
515 the device specific latency target. (Example: "/dev/sda 25ms"). The file path may be specified
516 as path to a block device node or as any other file, in which case the backing block device of the file
517 system of the file is determined. This controls the <literal>io.latency</literal> control group
518 attribute. Use this option multiple times to set latency target for multiple devices. For details about this
519 control group attribute, see <ulink
520 url="https://www.kernel.org/doc/Documentation/cgroup-v2.txt">cgroup-v2.txt</ulink>.</para>
521
522 <para>Implies <literal>IOAccounting=yes</literal>.</para>
523
524 <para>These settings are supported only if the unified control group hierarchy is used.</para>
525 </listitem>
526 </varlistentry>
527
528 <varlistentry>
529 <term><varname>IPAccounting=</varname></term>
530
531 <listitem>
532 <para>Takes a boolean argument. If true, turns on IPv4 and IPv6 network traffic accounting for packets sent
533 or received by the unit. When this option is turned on, all IPv4 and IPv6 sockets created by any process of
534 the unit are accounted for.</para>
535
536 <para>When this option is used in socket units, it applies to all IPv4 and IPv6 sockets
537 associated with it (including both listening and connection sockets where this applies). Note that for
538 socket-activated services, this configuration setting and the accounting data of the service unit and the
539 socket unit are kept separate, and displayed separately. No propagation of the setting and the collected
540 statistics is done, in either direction. Moreover, any traffic sent or received on any of the socket unit's
541 sockets is accounted to the socket unit — and never to the service unit it might have activated, even if the
542 socket is used by it.</para>
543
544 <para>The system default for this setting may be controlled with <varname>DefaultIPAccounting=</varname> in
545 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
546 </listitem>
547 </varlistentry>
548
549 <varlistentry>
550 <term><varname>IPAddressAllow=<replaceable>ADDRESS[/PREFIXLENGTH]…</replaceable></varname></term>
551 <term><varname>IPAddressDeny=<replaceable>ADDRESS[/PREFIXLENGTH]…</replaceable></varname></term>
552
553 <listitem>
554 <para>Turn on address range network traffic filtering for IP packets sent and received over
555 <constant>AF_INET</constant> and <constant>AF_INET6</constant> sockets. Both directives take a
556 space separated list of IPv4 or IPv6 addresses, each optionally suffixed with an address prefix
557 length in bits (separated by a <literal>/</literal> character). If the latter is omitted, the
558 address is considered a host address, i.e. the prefix covers the whole address (32 for IPv4, 128
559 for IPv6).</para>
560
561 <para>The access lists configured with this option are applied to all sockets created by processes
562 of this unit (or in the case of socket units, associated with it). The lists are implicitly
563 combined with any lists configured for any of the parent slice units this unit might be a member
564 of. By default all access lists are empty. Both ingress and egress traffic is filtered by these
565 settings. In case of ingress traffic the source IP address is checked against these access lists,
566 in case of egress traffic the destination IP address is checked. When configured the lists are
567 enforced as follows:</para>
568
569 <itemizedlist>
570 <listitem><para>Access will be granted in case an IP packet's destination/source address matches
571 any entry in the <varname>IPAddressAllow=</varname> setting.</para></listitem>
572
573 <listitem><para>Otherwise, access will be denied in case its destination/source address matches
574 any entry in the <varname>IPAddressDeny=</varname> setting.</para></listitem>
575
576 <listitem><para>Otherwise, access will be granted.</para></listitem>
577 </itemizedlist>
578
579 <para>In order to implement a whitelisting IP firewall, it is recommended to use a
580 <varname>IPAddressDeny=</varname><constant>any</constant> setting on an upper-level slice unit (such as the
581 root slice <filename>-.slice</filename> or the slice containing all system services
582 <filename>system.slice</filename> – see
583 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
584 details on these slice units), plus individual per-service <varname>IPAddressAllow=</varname> lines
585 permitting network access to relevant services, and only them.</para>
586
587 <para>Note that for socket-activated services, the IP access list configured on the socket unit applies to
588 all sockets associated with it directly, but not to any sockets created by the ultimately activated services
589 for it. Conversely, the IP access list configured for the service is not applied to any sockets passed into
590 the service via socket activation. Thus, it is usually a good idea, to replicate the IP access lists on both
591 the socket and the service unit, however it often makes sense to maintain one list more open and the other
592 one more restricted, depending on the usecase.</para>
593
594 <para>If these settings are used multiple times in the same unit the specified lists are combined. If an
595 empty string is assigned to these settings the specific access list is reset and all previous settings undone.</para>
596
597 <para>In place of explicit IPv4 or IPv6 address and prefix length specifications a small set of symbolic
598 names may be used. The following names are defined:</para>
599
600 <table>
601 <title>Special address/network names</title>
602
603 <tgroup cols='3'>
604 <colspec colname='name'/>
605 <colspec colname='definition'/>
606 <colspec colname='meaning'/>
607
608 <thead>
609 <row>
610 <entry>Symbolic Name</entry>
611 <entry>Definition</entry>
612 <entry>Meaning</entry>
613 </row>
614 </thead>
615
616 <tbody>
617 <row>
618 <entry><constant>any</constant></entry>
619 <entry>0.0.0.0/0 ::/0</entry>
620 <entry>Any host</entry>
621 </row>
622
623 <row>
624 <entry><constant>localhost</constant></entry>
625 <entry>127.0.0.0/8 ::1/128</entry>
626 <entry>All addresses on the local loopback</entry>
627 </row>
628
629 <row>
630 <entry><constant>link-local</constant></entry>
631 <entry>169.254.0.0/16 fe80::/64</entry>
632 <entry>All link-local IP addresses</entry>
633 </row>
634
635 <row>
636 <entry><constant>multicast</constant></entry>
637 <entry>224.0.0.0/4 ff00::/8</entry>
638 <entry>All IP multicasting addresses</entry>
639 </row>
640 </tbody>
641 </tgroup>
642 </table>
643
644 <para>Note that these settings might not be supported on some systems (for example if eBPF control group
645 support is not enabled in the underlying kernel or container manager). These settings will have no effect in
646 that case. If compatibility with such systems is desired it is hence recommended to not exclusively rely on
647 them for IP security.</para>
648 </listitem>
649 </varlistentry>
650
651 <varlistentry>
652 <term><varname>IPIngressFilterPath=<replaceable>BPF_FS_PROGRAMM_PATH</replaceable></varname></term>
653 <term><varname>IPEgressFilterPath=<replaceable>BPF_FS_PROGRAMM_PATH</replaceable></varname></term>
654
655 <listitem>
656 <para>Add custom network traffic filters implemented as BPF programs, applying to all IP packets
657 sent and received over <constant>AF_INET</constant> and <constant>AF_INET6</constant> sockets.
658 Takes an absolute path to a pinned BPF program in the BPF virtual filesystem (<filename>/sys/fs/bpf/</filename>).
659 </para>
660
661 <para>The filters configured with this option are applied to all sockets created by processes
662 of this unit (or in the case of socket units, associated with it). The filters are loaded in addition
663 to filters any of the parent slice units this unit might be a member of as well as any
664 <varname>IPAddressAllow=</varname> and <varname>IPAddressDeny=</varname> filters in any of these units.
665 By default there are no filters specified.</para>
666
667 <para>If these settings are used multiple times in the same unit all the specified programs are attached. If an
668 empty string is assigned to these settings the program list is reset and all previous specified programs ignored.</para>
669
670 <para>Note that for socket-activated services, the IP filter programs configured on the socket unit apply to
671 all sockets associated with it directly, but not to any sockets created by the ultimately activated services
672 for it. Conversely, the IP filter programs configured for the service are not applied to any sockets passed into
673 the service via socket activation. Thus, it is usually a good idea, to replicate the IP filter programs on both
674 the socket and the service unit, however it often makes sense to maintain one configuration more open and the other
675 one more restricted, depending on the usecase.</para>
676
677 <para>Note that these settings might not be supported on some systems (for example if eBPF control group
678 support is not enabled in the underlying kernel or container manager). These settings will fail the service in
679 that case. If compatibility with such systems is desired it is hence recommended to attach your filter manually
680 (requires <varname>Delegate=</varname><constant>yes</constant>) instead of using this setting.</para>
681 </listitem>
682 </varlistentry>
683
684 <varlistentry>
685 <term><varname>DeviceAllow=</varname></term>
686
687 <listitem>
688 <para>Control access to specific device nodes by the executed processes. Takes two space-separated
689 strings: a device node specifier followed by a combination of <constant>r</constant>,
690 <constant>w</constant>, <constant>m</constant> to control <emphasis>r</emphasis>eading,
691 <emphasis>w</emphasis>riting, or creation of the specific device node(s) by the unit
692 (<emphasis>m</emphasis>knod), respectively. On cgroup-v1 this controls the
693 <literal>devices.allow</literal> control group attribute. For details about this control group
694 attribute, see <ulink
695 url="https://www.kernel.org/doc/Documentation/cgroup-v1/devices.txt">devices.txt</ulink>. On
696 cgroup-v2 this functionality is implemented using eBPF filtering.</para>
697
698 <para>The device node specifier is either a path to a device node in the file system, starting with
699 <filename>/dev/</filename>, or a string starting with either <literal>char-</literal> or
700 <literal>block-</literal> followed by a device group name, as listed in
701 <filename>/proc/devices</filename>. The latter is useful to whitelist all current and future
702 devices belonging to a specific device group at once. The device group is matched according to
703 filename globbing rules, you may hence use the <literal>*</literal> and <literal>?</literal>
704 wildcards. (Note that such globbing wildcards are not available for device node path
705 specifications!) In order to match device nodes by numeric major/minor, use device node paths in
706 the <filename>/dev/char/</filename> and <filename>/dev/block/</filename> directories. However,
707 matching devices by major/minor is generally not recommended as assignments are neither stable nor
708 portable between systems or different kernel versions.</para>
709
710 <para>Examples: <filename>/dev/sda5</filename> is a path to a device node, referring to an ATA or
711 SCSI block device. <literal>char-pts</literal> and <literal>char-alsa</literal> are specifiers for
712 all pseudo TTYs and all ALSA sound devices, respectively. <literal>char-cpu/*</literal> is a
713 specifier matching all CPU related device groups.</para>
714
715 <para>Note that whitelists defined this way should only reference device groups which are
716 resolvable at the time the unit is started. Any device groups not resolvable then are not added to
717 the device whitelist. In order to work around this limitation, consider extending service units
718 with an <command>ExecStartPre=/sbin/modprobe…</command> line that loads the necessary
719 kernel module implementing the device group if missing. Example: <programlisting>…
720 [Service]
721 ExecStartPre=-/sbin/modprobe -abq loop
722 DeviceAllow=block-loop
723 DeviceAllow=/dev/loop-control
724 …</programlisting></para>
725
726 </listitem>
727 </varlistentry>
728
729 <varlistentry>
730 <term><varname>DevicePolicy=auto|closed|strict</varname></term>
731
732 <listitem>
733 <para>
734 Control the policy for allowing device access:
735 </para>
736 <variablelist>
737 <varlistentry>
738 <term><option>strict</option></term>
739 <listitem>
740 <para>means to only allow types of access that are
741 explicitly specified.</para>
742 </listitem>
743 </varlistentry>
744
745 <varlistentry>
746 <term><option>closed</option></term>
747 <listitem>
748 <para>in addition, allows access to standard pseudo
749 devices including
750 <filename>/dev/null</filename>,
751 <filename>/dev/zero</filename>,
752 <filename>/dev/full</filename>,
753 <filename>/dev/random</filename>, and
754 <filename>/dev/urandom</filename>.
755 </para>
756 </listitem>
757 </varlistentry>
758
759 <varlistentry>
760 <term><option>auto</option></term>
761 <listitem>
762 <para>
763 in addition, allows access to all devices if no
764 explicit <varname>DeviceAllow=</varname> is present.
765 This is the default.
766 </para>
767 </listitem>
768 </varlistentry>
769 </variablelist>
770 </listitem>
771 </varlistentry>
772
773 <varlistentry>
774 <term><varname>Slice=</varname></term>
775
776 <listitem>
777 <para>The name of the slice unit to place the unit
778 in. Defaults to <filename>system.slice</filename> for all
779 non-instantiated units of all unit types (except for slice
780 units themselves see below). Instance units are by default
781 placed in a subslice of <filename>system.slice</filename>
782 that is named after the template name.</para>
783
784 <para>This option may be used to arrange systemd units in a
785 hierarchy of slices each of which might have resource
786 settings applied.</para>
787
788 <para>For units of type slice, the only accepted value for
789 this setting is the parent slice. Since the name of a slice
790 unit implies the parent slice, it is hence redundant to ever
791 set this parameter directly for slice units.</para>
792
793 <para>Special care should be taken when relying on the default slice assignment in templated service units
794 that have <varname>DefaultDependencies=no</varname> set, see
795 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, section
796 "Default Dependencies" for details.</para>
797
798 </listitem>
799 </varlistentry>
800
801 <varlistentry>
802 <term><varname>Delegate=</varname></term>
803
804 <listitem>
805 <para>Turns on delegation of further resource control partitioning to processes of the unit. Units where this
806 is enabled may create and manage their own private subhierarchy of control groups below the control group of
807 the unit itself. For unprivileged services (i.e. those using the <varname>User=</varname> setting) the unit's
808 control group will be made accessible to the relevant user. When enabled the service manager will refrain
809 from manipulating control groups or moving processes below the unit's control group, so that a clear concept
810 of ownership is established: the control group tree above the unit's control group (i.e. towards the root
811 control group) is owned and managed by the service manager of the host, while the control group tree below
812 the unit's control group is owned and managed by the unit itself. Takes either a boolean argument or a list
813 of control group controller names. If true, delegation is turned on, and all supported controllers are
814 enabled for the unit, making them available to the unit's processes for management. If false, delegation is
815 turned off entirely (and no additional controllers are enabled). If set to a list of controllers, delegation
816 is turned on, and the specified controllers are enabled for the unit. Note that additional controllers than
817 the ones specified might be made available as well, depending on configuration of the containing slice unit
818 or other units contained in it. Note that assigning the empty string will enable delegation, but reset the
819 list of controllers, all assignments prior to this will have no effect. Defaults to false.</para>
820
821 <para>Note that controller delegation to less privileged code is only safe on the unified control group
822 hierarchy. Accordingly, access to the specified controllers will not be granted to unprivileged services on
823 the legacy hierarchy, even when requested.</para>
824
825 <para>The following controller names may be specified: <option>cpu</option>, <option>cpuacct</option>,
826 <option>io</option>, <option>blkio</option>, <option>memory</option>, <option>devices</option>,
827 <option>pids</option>. Not all of these controllers are available on all kernels however, and some are
828 specific to the unified hierarchy while others are specific to the legacy hierarchy. Also note that the
829 kernel might support further controllers, which aren't covered here yet as delegation is either not supported
830 at all for them or not defined cleanly.</para>
831
832 <para>For further details on the delegation model consult <ulink
833 url="https://systemd.io/CGROUP_DELEGATION">Control Group APIs and Delegation</ulink>.</para>
834 </listitem>
835 </varlistentry>
836
837 <varlistentry>
838 <term><varname>DisableControllers=</varname></term>
839
840 <listitem>
841 <para>Disables controllers from being enabled for a unit's children. If a controller listed is already in use
842 in its subtree, the controller will be removed from the subtree. This can be used to avoid child units being
843 able to implicitly or explicitly enable a controller. Defaults to not disabling any controllers.</para>
844
845 <para>It may not be possible to successfully disable a controller if the unit or any child of the unit in
846 question delegates controllers to its children, as any delegated subtree of the cgroup hierarchy is unmanaged
847 by systemd.</para>
848
849 <para>Multiple controllers may be specified, separated by spaces. You may also pass
850 <varname>DisableControllers=</varname> multiple times, in which case each new instance adds another controller
851 to disable. Passing <varname>DisableControllers=</varname> by itself with no controller name present resets
852 the disabled controller list.</para>
853
854 <para>Valid controllers are <option>cpu</option>, <option>cpuacct</option>, <option>io</option>,
855 <option>blkio</option>, <option>memory</option>, <option>devices</option>, and <option>pids</option>.</para>
856 </listitem>
857 </varlistentry>
858 </variablelist>
859 </refsect1>
860
861 <refsect1>
862 <title>Deprecated Options</title>
863
864 <para>The following options are deprecated. Use the indicated superseding options instead:</para>
865
866 <variablelist class='unit-directives'>
867
868 <varlistentry>
869 <term><varname>CPUShares=<replaceable>weight</replaceable></varname></term>
870 <term><varname>StartupCPUShares=<replaceable>weight</replaceable></varname></term>
871
872 <listitem>
873 <para>Assign the specified CPU time share weight to the processes executed. These options take an integer
874 value and control the <literal>cpu.shares</literal> control group attribute. The allowed range is 2 to
875 262144. Defaults to 1024. For details about this control group attribute, see <ulink
876 url="https://www.kernel.org/doc/Documentation/scheduler/sched-design-CFS.txt">sched-design-CFS.txt</ulink>.
877 The available CPU time is split up among all units within one slice relative to their CPU time share
878 weight.</para>
879
880 <para>While <varname>StartupCPUShares=</varname> only applies to the startup phase of the system,
881 <varname>CPUShares=</varname> applies to normal runtime of the system, and if the former is not set also to
882 the startup phase. Using <varname>StartupCPUShares=</varname> allows prioritizing specific services at
883 boot-up differently than during normal runtime.</para>
884
885 <para>Implies <literal>CPUAccounting=yes</literal>.</para>
886
887 <para>These settings are deprecated. Use <varname>CPUWeight=</varname> and
888 <varname>StartupCPUWeight=</varname> instead.</para>
889 </listitem>
890 </varlistentry>
891
892 <varlistentry>
893 <term><varname>MemoryLimit=<replaceable>bytes</replaceable></varname></term>
894
895 <listitem>
896 <para>Specify the limit on maximum memory usage of the executed processes. The limit specifies how much
897 process and kernel memory can be used by tasks in this unit. Takes a memory size in bytes. If the value is
898 suffixed with K, M, G or T, the specified memory size is parsed as Kilobytes, Megabytes, Gigabytes, or
899 Terabytes (with the base 1024), respectively. Alternatively, a percentage value may be specified, which is
900 taken relative to the installed physical memory on the system. If assigned the special value
901 <literal>infinity</literal>, no memory limit is applied. This controls the
902 <literal>memory.limit_in_bytes</literal> control group attribute. For details about this control group
903 attribute, see <ulink
904 url="https://www.kernel.org/doc/Documentation/cgroup-v1/memory.txt">memory.txt</ulink>.</para>
905
906 <para>Implies <literal>MemoryAccounting=yes</literal>.</para>
907
908 <para>This setting is deprecated. Use <varname>MemoryMax=</varname> instead.</para>
909 </listitem>
910 </varlistentry>
911
912 <varlistentry>
913 <term><varname>BlockIOAccounting=</varname></term>
914
915 <listitem>
916 <para>Turn on Block I/O accounting for this unit, if the legacy control group hierarchy is used on the
917 system. Takes a boolean argument. Note that turning on block I/O accounting for one unit will also implicitly
918 turn it on for all units contained in the same slice and all for its parent slices and the units contained
919 therein. The system default for this setting may be controlled with
920 <varname>DefaultBlockIOAccounting=</varname> in
921 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
922
923 <para>This setting is deprecated. Use <varname>IOAccounting=</varname> instead.</para>
924 </listitem>
925 </varlistentry>
926
927 <varlistentry>
928 <term><varname>BlockIOWeight=<replaceable>weight</replaceable></varname></term>
929 <term><varname>StartupBlockIOWeight=<replaceable>weight</replaceable></varname></term>
930
931 <listitem><para>Set the default overall block I/O weight for the executed processes, if the legacy control
932 group hierarchy is used on the system. Takes a single weight value (between 10 and 1000) to set the default
933 block I/O weight. This controls the <literal>blkio.weight</literal> control group attribute, which defaults to
934 500. For details about this control group attribute, see <ulink
935 url="https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt">blkio-controller.txt</ulink>.
936 The available I/O bandwidth is split up among all units within one slice relative to their block I/O
937 weight.</para>
938
939 <para>While <varname>StartupBlockIOWeight=</varname> only
940 applies to the startup phase of the system,
941 <varname>BlockIOWeight=</varname> applies to the later runtime
942 of the system, and if the former is not set also to the
943 startup phase. This allows prioritizing specific services at
944 boot-up differently than during runtime.</para>
945
946 <para>Implies
947 <literal>BlockIOAccounting=yes</literal>.</para>
948
949 <para>These settings are deprecated. Use <varname>IOWeight=</varname> and <varname>StartupIOWeight=</varname>
950 instead.</para>
951
952 </listitem>
953 </varlistentry>
954
955 <varlistentry>
956 <term><varname>BlockIODeviceWeight=<replaceable>device</replaceable> <replaceable>weight</replaceable></varname></term>
957
958 <listitem>
959 <para>Set the per-device overall block I/O weight for the executed processes, if the legacy control group
960 hierarchy is used on the system. Takes a space-separated pair of a file path and a weight value to specify
961 the device specific weight value, between 10 and 1000. (Example: "/dev/sda 500"). The file path may be
962 specified as path to a block device node or as any other file, in which case the backing block device of the
963 file system of the file is determined. This controls the <literal>blkio.weight_device</literal> control group
964 attribute, which defaults to 1000. Use this option multiple times to set weights for multiple devices. For
965 details about this control group attribute, see <ulink
966 url="https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt">blkio-controller.txt</ulink>.</para>
967
968 <para>Implies
969 <literal>BlockIOAccounting=yes</literal>.</para>
970
971 <para>This setting is deprecated. Use <varname>IODeviceWeight=</varname> instead.</para>
972 </listitem>
973 </varlistentry>
974
975 <varlistentry>
976 <term><varname>BlockIOReadBandwidth=<replaceable>device</replaceable> <replaceable>bytes</replaceable></varname></term>
977 <term><varname>BlockIOWriteBandwidth=<replaceable>device</replaceable> <replaceable>bytes</replaceable></varname></term>
978
979 <listitem>
980 <para>Set the per-device overall block I/O bandwidth limit for the executed processes, if the legacy control
981 group hierarchy is used on the system. Takes a space-separated pair of a file path and a bandwidth value (in
982 bytes per second) to specify the device specific bandwidth. The file path may be a path to a block device
983 node, or as any other file in which case the backing block device of the file system of the file is used. If
984 the bandwidth is suffixed with K, M, G, or T, the specified bandwidth is parsed as Kilobytes, Megabytes,
985 Gigabytes, or Terabytes, respectively, to the base of 1000. (Example:
986 "/dev/disk/by-path/pci-0000:00:1f.2-scsi-0:0:0:0 5M"). This controls the
987 <literal>blkio.throttle.read_bps_device</literal> and <literal>blkio.throttle.write_bps_device</literal>
988 control group attributes. Use this option multiple times to set bandwidth limits for multiple devices. For
989 details about these control group attributes, see <ulink
990 url="https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt">blkio-controller.txt</ulink>.
991 </para>
992
993 <para>Implies
994 <literal>BlockIOAccounting=yes</literal>.</para>
995
996 <para>These settings are deprecated. Use <varname>IOReadBandwidthMax=</varname> and
997 <varname>IOWriteBandwidthMax=</varname> instead.</para>
998 </listitem>
999 </varlistentry>
1000
1001 </variablelist>
1002 </refsect1>
1003
1004 <refsect1>
1005 <title>See Also</title>
1006 <para>
1007 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1008 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1009 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1010 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1011 <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1012 <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1013 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1014 <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1015 <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1016 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1017 <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1018 <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1019 The documentation for control groups and specific controllers in the Linux kernel:
1020 <ulink url="https://www.kernel.org/doc/Documentation/cgroup-v1/cgroups.txt">cgroups.txt</ulink>,
1021 <ulink url="https://www.kernel.org/doc/Documentation/cgroup-v1/cpuacct.txt">cpuacct.txt</ulink>,
1022 <ulink url="https://www.kernel.org/doc/Documentation/cgroup-v1/memory.txt">memory.txt</ulink>,
1023 <ulink url="https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt">blkio-controller.txt</ulink>.
1024 <ulink url="https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt">sched-bwc.txt</ulink>.
1025 </para>
1026 </refsect1>
1027 </refentry>