]>
Commit | Line | Data |
---|---|---|
9393a877 LP |
1 | <?xml version="1.0"?> |
2 | <!--*-nxml-*--> | |
3a54a157 | 3 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" |
eea10b26 | 4 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> |
db9ecf05 | 5 | <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> |
14f01575 FS |
6 | <refentry id="systemd-sysctl.service" |
7 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
9393a877 | 8 | |
798d3a52 ZJS |
9 | <refentryinfo> |
10 | <title>systemd-sysctl.service</title> | |
11 | <productname>systemd</productname> | |
798d3a52 | 12 | </refentryinfo> |
9393a877 | 13 | |
798d3a52 ZJS |
14 | <refmeta> |
15 | <refentrytitle>systemd-sysctl.service</refentrytitle> | |
16 | <manvolnum>8</manvolnum> | |
17 | </refmeta> | |
9393a877 | 18 | |
798d3a52 ZJS |
19 | <refnamediv> |
20 | <refname>systemd-sysctl.service</refname> | |
21 | <refname>systemd-sysctl</refname> | |
22 | <refpurpose>Configure kernel parameters at boot</refpurpose> | |
23 | </refnamediv> | |
9393a877 | 24 | |
798d3a52 | 25 | <refsynopsisdiv> |
14f01575 FS |
26 | <cmdsynopsis> |
27 | <command>/usr/lib/systemd/systemd-sysctl</command> | |
28 | <arg choice="opt" rep="repeat">OPTIONS</arg> | |
29 | <arg choice="opt" rep="repeat"><replaceable>CONFIGFILE</replaceable></arg> | |
30 | </cmdsynopsis> | |
798d3a52 | 31 | <para><filename>systemd-sysctl.service</filename></para> |
798d3a52 | 32 | </refsynopsisdiv> |
9393a877 | 33 | |
798d3a52 ZJS |
34 | <refsect1> |
35 | <title>Description</title> | |
9393a877 | 36 | |
b938cb90 | 37 | <para><filename>systemd-sysctl.service</filename> is an early boot |
798d3a52 | 38 | service that configures |
3ba3a79d | 39 | <citerefentry project='man-pages'><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry> |
7382a3cc | 40 | kernel parameters by invoking <command>/usr/lib/systemd/systemd-sysctl</command>.</para> |
9393a877 | 41 | |
7382a3cc ZJS |
42 | <para>When invoked with no arguments, <command>/usr/lib/systemd/systemd-sysctl</command> applies |
43 | all directives from configuration files listed in | |
44 | <citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
45 | If one or more filenames are passed on the command line, only the directives in these files are | |
46 | applied.</para> | |
47 | ||
48 | <para>In addition, <option>--prefix=</option> option may be used to limit which sysctl | |
49 | settings are applied.</para> | |
14f01575 | 50 | |
798d3a52 | 51 | <para>See |
2d56bdab | 52 | <citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry> |
7382a3cc | 53 | for information about the configuration of sysctl settings. After sysctl configuration is |
3b121157 | 54 | changed on disk, it must be written to the files in <filename>/proc/sys/</filename> before it |
7382a3cc ZJS |
55 | takes effect. It is possible to update specific settings, or simply to reload all configuration, |
56 | see Examples below.</para> | |
798d3a52 | 57 | </refsect1> |
9393a877 | 58 | |
14f01575 FS |
59 | <refsect1><title>Options</title> |
60 | <variablelist> | |
7382a3cc ZJS |
61 | <varlistentry id='prefix'> |
62 | <term><option>--prefix=</option></term> | |
14f01575 FS |
63 | <listitem> |
64 | <para>Only apply rules with the specified prefix.</para> | |
ec07c3c8 AK |
65 | |
66 | <xi:include href="version-info.xml" xpointer="v230"/> | |
14f01575 FS |
67 | </listitem> |
68 | </varlistentry> | |
e88748c1 QD |
69 | <varlistentry id='strict'> |
70 | <term><option>--strict=</option></term> | |
71 | <listitem> | |
72 | <para>Always return non-zero exit code on failure (including invalid sysctl variable | |
73 | name and insufficient permissions), unless the sysctl variable name is prefixed with a "-" | |
74 | character.</para> | |
ec07c3c8 AK |
75 | |
76 | <xi:include href="version-info.xml" xpointer="v252"/> | |
e88748c1 QD |
77 | </listitem> |
78 | </varlistentry> | |
14f01575 | 79 | |
3c51c626 | 80 | <xi:include href="standard-options.xml" xpointer="cat-config" /> |
f80f5dd6 | 81 | <xi:include href="standard-options.xml" xpointer="tldr" /> |
dcd5c891 | 82 | <xi:include href="standard-options.xml" xpointer="no-pager" /> |
14f01575 FS |
83 | <xi:include href="standard-options.xml" xpointer="help" /> |
84 | <xi:include href="standard-options.xml" xpointer="version" /> | |
85 | ||
86 | </variablelist> | |
87 | </refsect1> | |
39f0d1d2 LP |
88 | |
89 | <refsect1> | |
90 | <title>Credentials</title> | |
91 | ||
92 | <para><command>systemd-sysctl</command> supports the service credentials logic as implemented by | |
bbfb25f4 | 93 | <varname>ImportCredential=</varname>/<varname>LoadCredential=</varname>/<varname>SetCredential=</varname> |
658dc909 | 94 | (see <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for |
39f0d1d2 LP |
95 | details). The following credentials are used when passed in:</para> |
96 | ||
8914f7e8 | 97 | <variablelist class='system-credentials'> |
39f0d1d2 | 98 | <varlistentry> |
8914f7e8 | 99 | <term><varname>sysctl.extra</varname></term> |
39f0d1d2 LP |
100 | |
101 | <listitem><para>The contents of this credential may contain additional lines to operate on. The | |
3acb6ede LP |
102 | credential contents should follow the same format as any other <filename>sysctl.d/</filename> drop-in |
103 | configuration file. If this credential is passed it is processed after all of the drop-in files read | |
104 | from the file system. The settings configured in the credential hence take precedence over those in | |
ec07c3c8 AK |
105 | the file system.</para> |
106 | ||
107 | <xi:include href="version-info.xml" xpointer="v252"/></listitem> | |
39f0d1d2 LP |
108 | </varlistentry> |
109 | </variablelist> | |
110 | ||
111 | <para>Note that by default the <filename>systemd-sysctl.service</filename> unit file is set up to inherit | |
112 | the <literal>sysctl.extra</literal> credential from the service manager.</para> | |
113 | </refsect1> | |
14f01575 | 114 | |
7382a3cc ZJS |
115 | <refsect1> |
116 | <title>Examples</title> | |
117 | ||
118 | <example> | |
119 | <title>Reset all sysctl settings</title> | |
120 | ||
121 | <programlisting>systemctl restart systemd-sysctl</programlisting> | |
122 | </example> | |
123 | ||
124 | <example> | |
125 | <title>View coredump handler configuration</title> | |
126 | ||
127 | <programlisting># sysctl kernel.core_pattern | |
128 | kernel.core_pattern = |/usr/libexec/abrt-hook-ccpp %s %c %p %u %g %t %P %I | |
129 | </programlisting> | |
130 | </example> | |
131 | ||
132 | <example> | |
133 | <title>Update coredump handler configuration</title> | |
134 | ||
135 | <programlisting># /usr/lib/systemd/systemd-sysctl --prefix kernel.core_pattern</programlisting> | |
136 | ||
137 | <para>This searches all the directories listed in | |
138 | <citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry> | |
139 | for configuration files and writes <filename>/proc/sys/kernel/core_pattern</filename>.</para> | |
140 | </example> | |
141 | ||
142 | <example> | |
143 | <title>Update coredump handler configuration according to a specific file</title> | |
144 | ||
145 | <programlisting># /usr/lib/systemd/systemd-sysctl 50-coredump.conf</programlisting> | |
146 | ||
147 | <para>This applies all the settings found in <filename>50-coredump.conf</filename>. | |
148 | Either <filename>/etc/sysctl.d/50-coredump.conf</filename>, or | |
149 | <filename>/run/sysctl.d/50-coredump.conf</filename>, or | |
150 | <filename>/usr/lib/sysctl.d/50-coredump.conf</filename> will be used, in the order | |
151 | of preference.</para> | |
152 | </example> | |
153 | ||
154 | <para>See | |
155 | <citerefentry project='man-pages'><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
156 | for various ways to directly apply sysctl settings.</para> | |
157 | </refsect1> | |
158 | ||
798d3a52 ZJS |
159 | <refsect1> |
160 | <title>See Also</title> | |
13a69c12 DT |
161 | <para><simplelist type="inline"> |
162 | <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> | |
163 | <member><citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> | |
164 | <member><citerefentry project='man-pages'><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> | |
165 | </simplelist></para> | |
798d3a52 | 166 | </refsect1> |
9393a877 LP |
167 | |
168 | </refentry> |