]> git.ipfire.org Git - thirdparty/systemd.git/blob - man/systemd-analyze.xml
projects / thirdparty / systemd.git / blob
? search:


b0c7ad4e761de4aa41c396caafdc5ca4521844b7
[thirdparty/systemd.git] / man / systemd-analyze.xml
1 <?xml version='1.0'?> <!--*-nxml-*-->
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-or-later -->
5
6 <refentry id="systemd-analyze" conditional='ENABLE_ANALYZE'
7 xmlns:xi="http://www.w3.org/2001/XInclude">
8
9 <refentryinfo>
10 <title>systemd-analyze</title>
11 <productname>systemd</productname>
12 </refentryinfo>
13
14 <refmeta>
15 <refentrytitle>systemd-analyze</refentrytitle>
16 <manvolnum>1</manvolnum>
17 </refmeta>
18
19 <refnamediv>
20 <refname>systemd-analyze</refname>
21 <refpurpose>Analyze and debug system manager</refpurpose>
22 </refnamediv>
23
24 <refsynopsisdiv>
25 <cmdsynopsis>
26 <command>systemd-analyze</command>
27 <arg choice="opt" rep="repeat">OPTIONS</arg>
28 <arg>time</arg>
29 </cmdsynopsis>
30 <cmdsynopsis>
31 <command>systemd-analyze</command>
32 <arg choice="opt" rep="repeat">OPTIONS</arg>
33 <arg choice="plain">blame</arg>
34 </cmdsynopsis>
35 <cmdsynopsis>
36 <command>systemd-analyze</command>
37 <arg choice="opt" rep="repeat">OPTIONS</arg>
38 <arg choice="plain">critical-chain</arg>
39 <arg choice="opt" rep="repeat"><replaceable>UNIT</replaceable></arg>
40 </cmdsynopsis>
41
42 <cmdsynopsis>
43 <command>systemd-analyze</command>
44 <arg choice="opt" rep="repeat">OPTIONS</arg>
45 <arg choice="plain">dump</arg>
46 <arg choice="opt" rep="repeat"><replaceable>PATTERN</replaceable></arg>
47 </cmdsynopsis>
48
49 <cmdsynopsis>
50 <command>systemd-analyze</command>
51 <arg choice="opt" rep="repeat">OPTIONS</arg>
52 <arg choice="plain">plot</arg>
53 <arg choice="opt">>file.svg</arg>
54 </cmdsynopsis>
55 <cmdsynopsis>
56 <command>systemd-analyze</command>
57 <arg choice="opt" rep="repeat">OPTIONS</arg>
58 <arg choice="plain">dot</arg>
59 <arg choice="opt" rep="repeat"><replaceable>PATTERN</replaceable></arg>
60 <arg choice="opt">>file.dot</arg>
61 </cmdsynopsis>
62
63 <cmdsynopsis>
64 <command>systemd-analyze</command>
65 <arg choice="opt" rep="repeat">OPTIONS</arg>
66 <arg choice="plain">unit-files</arg>
67 </cmdsynopsis>
68 <cmdsynopsis>
69 <command>systemd-analyze</command>
70 <arg choice="opt" rep="repeat">OPTIONS</arg>
71 <arg choice="plain">unit-paths</arg>
72 </cmdsynopsis>
73 <cmdsynopsis>
74 <command>systemd-analyze</command>
75 <arg choice="opt" rep="repeat">OPTIONS</arg>
76 <arg choice="plain">exit-status</arg>
77 <arg choice="opt" rep="repeat"><replaceable>STATUS</replaceable></arg>
78 </cmdsynopsis>
79 <cmdsynopsis>
80 <command>systemd-analyze</command>
81 <arg choice="opt" rep="repeat">OPTIONS</arg>
82 <arg choice="plain">capability</arg>
83 <arg choice="opt" rep="repeat"><replaceable>CAPABILITY</replaceable></arg>
84 </cmdsynopsis>
85 <cmdsynopsis>
86 <command>systemd-analyze</command>
87 <arg choice="opt" rep="repeat">OPTIONS</arg>
88 <arg choice="plain">condition</arg>
89 <arg choice="plain"><replaceable>CONDITION</replaceable>…</arg>
90 </cmdsynopsis>
91 <cmdsynopsis>
92 <command>systemd-analyze</command>
93 <arg choice="opt" rep="repeat">OPTIONS</arg>
94 <arg choice="plain">syscall-filter</arg>
95 <arg choice="opt"><replaceable>SET</replaceable>…</arg>
96 </cmdsynopsis>
97 <cmdsynopsis>
98 <command>systemd-analyze</command>
99 <arg choice="opt" rep="repeat">OPTIONS</arg>
100 <arg choice="plain">filesystems</arg>
101 <arg choice="opt"><replaceable>SET</replaceable>…</arg>
102 </cmdsynopsis>
103 <cmdsynopsis>
104 <command>systemd-analyze</command>
105 <arg choice="opt" rep="repeat">OPTIONS</arg>
106 <arg choice="plain">calendar</arg>
107 <arg choice="plain" rep="repeat"><replaceable>SPEC</replaceable></arg>
108 </cmdsynopsis>
109 <cmdsynopsis>
110 <command>systemd-analyze</command>
111 <arg choice="opt" rep="repeat">OPTIONS</arg>
112 <arg choice="plain">timestamp</arg>
113 <arg choice="plain" rep="repeat"><replaceable>TIMESTAMP</replaceable></arg>
114 </cmdsynopsis>
115 <cmdsynopsis>
116 <command>systemd-analyze</command>
117 <arg choice="opt" rep="repeat">OPTIONS</arg>
118 <arg choice="plain">timespan</arg>
119 <arg choice="plain" rep="repeat"><replaceable>SPAN</replaceable></arg>
120 </cmdsynopsis>
121 <cmdsynopsis>
122 <command>systemd-analyze</command>
123 <arg choice="opt" rep="repeat">OPTIONS</arg>
124 <arg choice="plain">cat-config</arg>
125 <arg choice="plain" rep="repeat"><replaceable>NAME</replaceable>|<replaceable>PATH</replaceable></arg>
126 </cmdsynopsis>
127 <cmdsynopsis>
128 <command>systemd-analyze</command>
129 <arg choice="opt" rep="repeat">OPTIONS</arg>
130 <arg choice="plain">compare-versions</arg>
131 <arg choice="plain"><replaceable>VERSION1</replaceable></arg>
132 <arg choice="opt"><replaceable>OP</replaceable></arg>
133 <arg choice="plain"><replaceable>VERSION2</replaceable></arg>
134 </cmdsynopsis>
135 <cmdsynopsis>
136 <command>systemd-analyze</command>
137 <arg choice="opt" rep="repeat">OPTIONS</arg>
138 <arg choice="plain">verify</arg>
139 <arg choice="opt" rep="repeat"><replaceable>FILE</replaceable></arg>
140 </cmdsynopsis>
141 <cmdsynopsis>
142 <command>systemd-analyze</command>
143 <arg choice="opt" rep="repeat">OPTIONS</arg>
144 <arg choice="plain">security</arg>
145 <arg choice="plain" rep="repeat"><replaceable>UNIT</replaceable></arg>
146 </cmdsynopsis>
147 <cmdsynopsis>
148 <command>systemd-analyze</command>
149 <arg choice="opt" rep="repeat">OPTIONS</arg>
150 <arg choice="plain">inspect-elf</arg>
151 <arg choice="plain" rep="repeat"><replaceable>FILE</replaceable></arg>
152 </cmdsynopsis>
153 <cmdsynopsis>
154 <command>systemd-analyze</command>
155 <arg choice="opt" rep="repeat">OPTIONS</arg>
156 <arg choice="plain">malloc</arg>
157 <arg choice="opt" rep="repeat"><replaceable>D-BUS SERVICE</replaceable></arg>
158 </cmdsynopsis>
159 <cmdsynopsis>
160 <command>systemd-analyze</command>
161 <arg choice="opt" rep="repeat">OPTIONS</arg>
162 <arg choice="plain">fdstore</arg>
163 <arg choice="opt" rep="repeat"><replaceable>UNIT</replaceable></arg>
164 </cmdsynopsis>
165 <cmdsynopsis>
166 <command>systemd-analyze</command>
167 <arg choice="opt" rep="repeat">OPTIONS</arg>
168 <arg choice="plain">image-policy</arg>
169 <arg choice="plain" rep="repeat"><replaceable>POLICY</replaceable></arg>
170 </cmdsynopsis>
171 </refsynopsisdiv>
172
173 <refsect1>
174 <title>Description</title>
175
176 <para><command>systemd-analyze</command> may be used to determine
177 system boot-up performance statistics and retrieve other state and
178 tracing information from the system and service manager, and to
179 verify the correctness of unit files. It is also used to access
180 special functions useful for advanced system manager debugging.</para>
181
182 <para>If no command is passed, <command>systemd-analyze
183 time</command> is implied.</para>
184
185 <refsect2>
186 <title><command>systemd-analyze time</command></title>
187
188 <para>This command prints the time spent in the kernel before userspace has been reached, the time
189 spent in the initrd before normal system userspace has been reached, and the time normal system
190 userspace took to initialize. Note that these measurements simply measure the time passed up to the
191 point where all system services have been spawned, but not necessarily until they fully finished
192 initialization or the disk is idle.</para>
193
194 <example>
195 <title><command>Show how long the boot took</command></title>
196
197 <programlisting># in a container
198 $ systemd-analyze time
199 Startup finished in 296ms (userspace)
200 multi-user.target reached after 275ms in userspace
201
202 # on a real machine
203 $ systemd-analyze time
204 Startup finished in 2.584s (kernel) + 19.176s (initrd) + 47.847s (userspace) = 1min 9.608s
205 multi-user.target reached after 47.820s in userspace
206 </programlisting>
207 </example>
208 </refsect2>
209
210 <refsect2>
211 <title><command>systemd-analyze blame</command></title>
212
213 <para>This command prints a list of all running units, ordered by the time they took to initialize.
214 This information may be used to optimize boot-up times. Note that the output might be misleading as the
215 initialization of one service might be slow simply because it waits for the initialization of another
216 service to complete. Also note: <command>systemd-analyze blame</command> doesn't display results for
217 services with <varname>Type=simple</varname>, because systemd considers such services to be started
218 immediately, hence no measurement of the initialization delays can be done. Also note that this command
219 only shows the time units took for starting up, it does not show how long unit jobs spent in the
220 execution queue. In particular it shows the time units spent in <literal>activating</literal> state,
221 which is not defined for units such as device units that transition directly from
222 <literal>inactive</literal> to <literal>active</literal>. This command hence gives an impression of the
223 performance of program code, but cannot accurately reflect latency introduced by waiting for
224 hardware and similar events.</para>
225
226 <example>
227 <title><command>Show which units took the most time during boot</command></title>
228
229 <programlisting>$ systemd-analyze blame
230 32.875s pmlogger.service
231 20.905s systemd-networkd-wait-online.service
232 13.299s dev-vda1.device
233 ...
234 23ms sysroot.mount
235 11ms initrd-udevadm-cleanup-db.service
236 3ms sys-kernel-config.mount
237 </programlisting>
238 </example>
239 </refsect2>
240
241 <refsect2>
242 <title><command>systemd-analyze critical-chain <optional><replaceable>UNIT</replaceable>...</optional></command></title>
243
244 <para>This command prints a tree of the time-critical chain of units (for each of the specified
245 <replaceable>UNIT</replaceable>s or for the default target otherwise). The time after the unit is
246 active or started is printed after the "@" character. The time the unit takes to start is printed after
247 the "+" character. Note that the output might be misleading as the initialization of services might
248 depend on socket activation and because of the parallel execution of units. Also, similarly to the
249 <command>blame</command> command, this only takes into account the time units spent in
250 <literal>activating</literal> state, and hence does not cover units that never went through an
251 <literal>activating</literal> state (such as device units that transition directly from
252 <literal>inactive</literal> to <literal>active</literal>). Moreover it does not show information on
253 jobs (and in particular not jobs that timed out).</para>
254
255 <example>
256 <title><command>systemd-analyze critical-chain</command></title>
257
258 <programlisting>$ systemd-analyze critical-chain
259 multi-user.target @47.820s
260 └─pmie.service @35.968s +548ms
261 └─pmcd.service @33.715s +2.247s
262 └─network-online.target @33.712s
263 └─systemd-networkd-wait-online.service @12.804s +20.905s
264 └─systemd-networkd.service @11.109s +1.690s
265 └─systemd-udevd.service @9.201s +1.904s
266 └─systemd-tmpfiles-setup-dev.service @7.306s +1.776s
267 └─kmod-static-nodes.service @6.976s +177ms
268 └─systemd-journald.socket
269 └─system.slice
270 └─-.slice
271 </programlisting>
272 </example>
273 </refsect2>
274
275 <refsect2>
276 <title><command>systemd-analyze dump [<replaceable>pattern</replaceable>…]</command></title>
277
278 <para>Without any parameter, this command outputs a (usually very long) human-readable serialization of
279 the complete service manager state. Optional glob pattern may be specified, causing the output to be
280 limited to units whose names match one of the patterns. The output format is subject to change without
281 notice and should not be parsed by applications. This command is rate limited for unprivileged users.</para>
282
283 <example>
284 <title>Show the internal state of user manager</title>
285
286 <programlisting>$ systemd-analyze --user dump
287 Timestamp userspace: Thu 2019-03-14 23:28:07 CET
288 Timestamp finish: Thu 2019-03-14 23:28:07 CET
289 Timestamp generators-start: Thu 2019-03-14 23:28:07 CET
290 Timestamp generators-finish: Thu 2019-03-14 23:28:07 CET
291 Timestamp units-load-start: Thu 2019-03-14 23:28:07 CET
292 Timestamp units-load-finish: Thu 2019-03-14 23:28:07 CET
293 -> Unit proc-timer_list.mount:
294 Description: /proc/timer_list
295 ...
296 -> Unit default.target:
297 Description: Main user target
298 ...
299 </programlisting>
300 </example>
301 </refsect2>
302
303 <refsect2>
304 <title><command>systemd-analyze malloc [<replaceable>D-Bus service</replaceable>…]</command></title>
305
306 <para>This command can be used to request the output of the internal memory state (as returned by
307 <citerefentry project='man-pages'><refentrytitle>malloc_info</refentrytitle><manvolnum>3</manvolnum></citerefentry>)
308 of a D-Bus service. If no service is specified, the query will be sent to
309 <filename>org.freedesktop.systemd1</filename> (the system or user service manager). The output format
310 is not guaranteed to be stable and should not be parsed by applications.</para>
311
312 <para>The service must implement the <filename>org.freedesktop.MemoryAllocation1</filename> interface.
313 In the systemd suite, it is currently only implemented by the manager.</para>
314 </refsect2>
315
316 <refsect2>
317 <title><command>systemd-analyze plot</command></title>
318
319 <para>This command prints either an SVG graphic, detailing which system services have been started at what
320 time, highlighting the time they spent on initialization, or the raw time data in JSON or table format.</para>
321
322 <example>
323 <title><command>Plot a bootchart</command></title>
324
325 <programlisting>$ systemd-analyze plot >bootup.svg
326 $ eog bootup.svg&amp;
327 </programlisting>
328 </example>
329
330 <para>Note that this plot is based on the most recent per-unit timing data of loaded units. This means
331 that if a unit gets started, then stopped and then started again the information shown will cover the
332 most recent start cycle, not the first one. Thus it's recommended to consult this information only
333 shortly after boot, so that this distinction doesn't matter. Moreover, units that are not referenced by
334 any other unit through a dependency might be unloaded by the service manager once they terminate (and
335 did not fail). Such units will not show up in the plot.</para>
336 </refsect2>
337
338 <refsect2>
339 <title><command>systemd-analyze dot [<replaceable>pattern</replaceable>...]</command></title>
340
341 <para>This command generates textual dependency graph description in dot format for further processing
342 with the GraphViz
343 <citerefentry project='die-net'><refentrytitle>dot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
344 tool. Use a command line like <command>systemd-analyze dot | dot -Tsvg >systemd.svg</command> to
345 generate a graphical dependency tree. Unless <option>--order</option> or <option>--require</option> is
346 passed, the generated graph will show both ordering and requirement dependencies. Optional pattern
347 globbing style specifications (e.g. <filename>*.target</filename>) may be given at the end. A unit
348 dependency is included in the graph if any of these patterns match either the origin or destination
349 node.</para>
350
351 <example>
352 <title>Plot all dependencies of any unit whose name starts with <literal>avahi-daemon</literal>
353 </title>
354
355 <programlisting>$ systemd-analyze dot 'avahi-daemon.*' | dot -Tsvg >avahi.svg
356 $ eog avahi.svg</programlisting>
357 </example>
358
359 <example>
360 <title>Plot the dependencies between all known target units</title>
361
362 <programlisting>$ systemd-analyze dot --to-pattern='*.target' --from-pattern='*.target' \
363 | dot -Tsvg >targets.svg
364 $ eog targets.svg</programlisting>
365 </example>
366 </refsect2>
367
368 <refsect2>
369 <title><command>systemd-analyze unit-paths</command></title>
370
371 <para>This command outputs a list of all directories from which unit files, <filename>.d</filename>
372 overrides, and <filename>.wants</filename>, <filename>.requires</filename> symlinks may be
373 loaded. Combine with <option>--user</option> to retrieve the list for the user manager instance, and
374 <option>--global</option> for the global configuration of user manager instances.</para>
375
376 <example>
377 <title><command>Show all paths for generated units</command></title>
378
379 <programlisting>$ systemd-analyze unit-paths | grep '^/run'
380 /run/systemd/system.control
381 /run/systemd/transient
382 /run/systemd/generator.early
383 /run/systemd/system
384 /run/systemd/system.attached
385 /run/systemd/generator
386 /run/systemd/generator.late
387 </programlisting>
388 </example>
389
390 <para>Note that this verb prints the list that is compiled into <command>systemd-analyze</command>
391 itself, and does not communicate with the running manager. Use
392 <programlisting>systemctl [--user] [--global] show -p UnitPath --value</programlisting>
393 to retrieve the actual list that the manager uses, with any empty directories omitted.</para>
394 </refsect2>
395
396 <refsect2>
397 <title><command>systemd-analyze exit-status <optional><replaceable>STATUS</replaceable>...</optional></command></title>
398
399 <para>This command prints a list of exit statuses along with their "class", i.e. the source of the
400 definition (one of <literal>glibc</literal>, <literal>systemd</literal>, <literal>LSB</literal>, or
401 <literal>BSD</literal>), see the Process Exit Codes section in
402 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
403 If no additional arguments are specified, all known statuses are shown. Otherwise, only the
404 definitions for the specified codes are shown.</para>
405
406 <example>
407 <title><command>Show some example exit status names</command></title>
408
409 <programlisting>$ systemd-analyze exit-status 0 1 {63..65}
410 NAME STATUS CLASS
411 SUCCESS 0 glibc
412 FAILURE 1 glibc
413 - 63 -
414 USAGE 64 BSD
415 DATAERR 65 BSD
416 </programlisting>
417 </example>
418 </refsect2>
419
420 <refsect2>
421 <title><command>systemd-analyze capability <optional><replaceable>CAPABILITY</replaceable>...</optional></command></title>
422
423 <para>This command prints a list of Linux capabilities along with their numeric IDs. See <citerefentry
424 project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
425 for details. If no argument is specified the full list of capabilities known to the service manager and
426 the kernel is shown. Capabilities defined by the kernel but not known to the service manager are shown
427 as <literal>cap_???</literal>. Optionally, if arguments are specified they may refer to specific
428 cabilities by name or numeric ID, in which case only the indicated capabilities are shown in the
429 table.</para>
430
431 <example>
432 <title><command>Show some example capability names</command></title>
433
434 <programlisting>$ systemd-analyze capability 0 1 {30..32}
435 NAME NUMBER
436 cap_chown 0
437 cap_dac_override 1
438 cap_audit_control 30
439 cap_setfcap 31
440 cap_mac_override 32</programlisting>
441 </example>
442 </refsect2>
443
444 <refsect2>
445 <title><command>systemd-analyze condition <replaceable>CONDITION</replaceable>...</command></title>
446
447 <para>This command will evaluate <varname index="false">Condition*=...</varname> and
448 <varname index="false">Assert*=...</varname> assignments, and print their values, and
449 the resulting value of the combined condition set. See
450 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
451 for a list of available conditions and asserts.</para>
452
453 <example>
454 <title>Evaluate conditions that check kernel versions</title>
455
456 <programlisting>$ systemd-analyze condition 'ConditionKernelVersion = ! &lt;4.0' \
457 'ConditionKernelVersion = &gt;=5.1' \
458 'ConditionACPower=|false' \
459 'ConditionArchitecture=|!arm' \
460 'AssertPathExists=/etc/os-release'
461 test.service: AssertPathExists=/etc/os-release succeeded.
462 Asserts succeeded.
463 test.service: ConditionArchitecture=|!arm succeeded.
464 test.service: ConditionACPower=|false failed.
465 test.service: ConditionKernelVersion=&gt;=5.1 succeeded.
466 test.service: ConditionKernelVersion=!&lt;4.0 succeeded.
467 Conditions succeeded.</programlisting>
468 </example>
469 </refsect2>
470
471 <refsect2>
472 <title><command>systemd-analyze syscall-filter <optional><replaceable>SET</replaceable>...</optional></command></title>
473
474 <para>This command will list system calls contained in the specified system call set
475 <replaceable>SET</replaceable>, or all known sets if no sets are specified. Argument
476 <replaceable>SET</replaceable> must include the <literal>@</literal> prefix.</para>
477 </refsect2>
478
479 <refsect2>
480 <title><command>systemd-analyze filesystems <optional><replaceable>SET</replaceable>...</optional></command></title>
481
482 <para>This command will list filesystems in the specified filesystem set
483 <replaceable>SET</replaceable>, or all known sets if no sets are specified. Argument
484 <replaceable>SET</replaceable> must include the <literal>@</literal> prefix.</para>
485 </refsect2>
486
487 <refsect2>
488 <title><command>systemd-analyze calendar <replaceable>EXPRESSION</replaceable>...</command></title>
489
490 <para>This command will parse and normalize repetitive calendar time events, and will calculate when
491 they elapse next. This takes the same input as the <varname>OnCalendar=</varname> setting in
492 <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
493 following the syntax described in
494 <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>. By
495 default, only the next time the calendar expression will elapse is shown; use
496 <option>--iterations=</option> to show the specified number of next times the expression
497 elapses. Each time the expression elapses forms a timestamp, see the <command>timestamp</command>
498 verb below.</para>
499
500 <example>
501 <title>Show leap days in the near future</title>
502
503 <programlisting>$ systemd-analyze calendar --iterations=5 '*-2-29 0:0:0'
504 Original form: *-2-29 0:0:0
505 Normalized form: *-02-29 00:00:00
506 Next elapse: Sat 2020-02-29 00:00:00 UTC
507 From now: 11 months 15 days left
508 Iter. #2: Thu 2024-02-29 00:00:00 UTC
509 From now: 4 years 11 months left
510 Iter. #3: Tue 2028-02-29 00:00:00 UTC
511 From now: 8 years 11 months left
512 Iter. #4: Sun 2032-02-29 00:00:00 UTC
513 From now: 12 years 11 months left
514 Iter. #5: Fri 2036-02-29 00:00:00 UTC
515 From now: 16 years 11 months left
516 </programlisting>
517 </example>
518 </refsect2>
519
520 <refsect2>
521 <title><command>systemd-analyze timestamp <replaceable>TIMESTAMP</replaceable>...</command></title>
522
523 <para>This command parses a timestamp (i.e. a single point in time) and outputs the normalized form and
524 the difference between this timestamp and now. The timestamp should adhere to the syntax documented in
525 <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
526 section "PARSING TIMESTAMPS".</para>
527
528 <example>
529 <title>Show parsing of timestamps</title>
530
531 <programlisting>$ systemd-analyze timestamp yesterday now tomorrow
532 Original form: yesterday
533 Normalized form: Mon 2019-05-20 00:00:00 CEST
534 (in UTC): Sun 2019-05-19 22:00:00 UTC
535 UNIX seconds: @15583032000
536 From now: 1 day 9h ago
537
538 Original form: now
539 Normalized form: Tue 2019-05-21 09:48:39 CEST
540 (in UTC): Tue 2019-05-21 07:48:39 UTC
541 UNIX seconds: @1558424919.659757
542 From now: 43us ago
543
544 Original form: tomorrow
545 Normalized form: Wed 2019-05-22 00:00:00 CEST
546 (in UTC): Tue 2019-05-21 22:00:00 UTC
547 UNIX seconds: @15584760000
548 From now: 14h left
549 </programlisting>
550 </example>
551 </refsect2>
552
553 <refsect2>
554 <title><command>systemd-analyze timespan <replaceable>EXPRESSION</replaceable>...</command></title>
555
556 <para>This command parses a time span (i.e. a difference between two timestamps) and outputs the
557 normalized form and the equivalent value in microseconds. The time span should adhere to the syntax
558 documented in
559 <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
560 section "PARSING TIME SPANS". Values without units are parsed as seconds.</para>
561
562 <example>
563 <title>Show parsing of timespans</title>
564
565 <programlisting>$ systemd-analyze timespan 1s 300s '1year 0.000001s'
566 Original: 1s
567 μs: 1000000
568 Human: 1s
569
570 Original: 300s
571 μs: 300000000
572 Human: 5min
573
574 Original: 1year 0.000001s
575 μs: 31557600000001
576 Human: 1y 1us
577 </programlisting>
578 </example>
579 </refsect2>
580
581 <refsect2>
582 <title><command>systemd-analyze cat-config</command>
583 <replaceable>NAME</replaceable>|<replaceable>PATH</replaceable>...</title>
584
585 <para>This command is similar to <command>systemctl cat</command>, but operates on config files. It
586 will copy the contents of a config file and any drop-ins to standard output, using the usual systemd
587 set of directories and rules for precedence. Each argument must be either an absolute path including
588 the prefix (such as <filename>/etc/systemd/logind.conf</filename> or
589 <filename>/usr/lib/systemd/logind.conf</filename>), or a name relative to the prefix (such as
590 <filename>systemd/logind.conf</filename>).</para>
591
592 <example>
593 <title>Showing logind configuration</title>
594 <programlisting>$ systemd-analyze cat-config systemd/logind.conf
595 # /etc/systemd/logind.conf
596 ...
597 [Login]
598 NAutoVTs=8
599 ...
600
601 # /usr/lib/systemd/logind.conf.d/20-test.conf
602 ... some override from another package
603
604 # /etc/systemd/logind.conf.d/50-override.conf
605 ... some administrator override
606 </programlisting>
607 </example>
608 </refsect2>
609
610 <refsect2>
611 <title><command>systemd-analyze compare-versions
612 <replaceable>VERSION1</replaceable>
613 <optional><replaceable>OP</replaceable></optional>
614 <replaceable>VERSION2</replaceable></command></title>
615
616 <para>This command has two distinct modes of operation, depending on whether the operator
617 <replaceable>OP</replaceable> is specified.</para>
618
619 <para>In the first mode — when <replaceable>OP</replaceable> is not specified — it will compare the two
620 version strings and print either <literal><replaceable>VERSION1</replaceable> &lt;
621 <replaceable>VERSION2</replaceable></literal>, or <literal><replaceable>VERSION1</replaceable> ==
622 <replaceable>VERSION2</replaceable></literal>, or <literal><replaceable>VERSION1</replaceable> &gt;
623 <replaceable>VERSION2</replaceable></literal> as appropriate.</para>
624
625 <para>The exit status is <constant>0</constant> if the versions are equal, <constant>11</constant> if
626 the version of the right is smaller, and <constant>12</constant> if the version of the left is
627 smaller. (This matches the convention used by <command>rpmdev-vercmp</command>.)</para>
628
629 <para>In the second mode — when <replaceable>OP</replaceable> is specified — it will compare the two
630 version strings using the operation <replaceable>OP</replaceable> and return <constant>0</constant>
631 (success) if they condition is satisfied, and <constant>1</constant> (failure)
632 otherwise. <constant>OP</constant> may be <command>lt</command>, <command>le</command>,
633 <command>eq</command>, <command>ne</command>, <command>ge</command>, <command>gt</command>. In this
634 mode, no output is printed.
635 (This matches the convention used by
636 <citerefentry project='die-net'><refentrytitle>dpkg</refentrytitle><manvolnum>1</manvolnum></citerefentry>
637 <option>--compare-versions</option>.)</para>
638
639 <example>
640 <title>Compare versions of a package</title>
641
642 <programlisting>
643 $ systemd-analyze compare-versions systemd-250~rc1.fc36.aarch64 systemd-251.fc36.aarch64
644 systemd-250~rc1.fc36.aarch64 &lt; systemd-251.fc36.aarch64
645 $ echo $?
646 12
647
648 $ systemd-analyze compare-versions 1 lt 2; echo $?
649 0
650 $ systemd-analyze compare-versions 1 ge 2; echo $?
651 1
652 </programlisting>
653 </example>
654 </refsect2>
655
656 <refsect2>
657 <title><command>systemd-analyze verify <replaceable>FILE</replaceable>...</command></title>
658
659 <para>This command will load unit files and print warnings if any errors are detected. Files specified
660 on the command line will be loaded, but also any other units referenced by them. A unit's name on disk
661 can be overridden by specifying an alias after a colon; see below for an example. The full unit search
662 path is formed by combining the directories for all command line arguments, and the usual unit load
663 paths. The variable <varname>$SYSTEMD_UNIT_PATH</varname> is supported, and may be used to replace or
664 augment the compiled in set of unit load paths; see
665 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. All
666 units files present in the directories containing the command line arguments will be used in preference
667 to the other paths.</para>
668
669 <para>The following errors are currently detected:</para>
670 <itemizedlist>
671 <listitem><para>unknown sections and directives,</para></listitem>
672
673 <listitem><para>missing dependencies which are required to start the given unit,</para></listitem>
674
675 <listitem><para>man pages listed in <varname>Documentation=</varname> which are not found in the
676 system,</para></listitem>
677
678 <listitem><para>commands listed in <varname>ExecStart=</varname> and similar which are not found in
679 the system or not executable.</para></listitem>
680 </itemizedlist>
681
682 <example>
683 <title>Misspelt directives</title>
684
685 <programlisting>$ cat ./user.slice
686 [Unit]
687 WhatIsThis=11
688 Documentation=man:nosuchfile(1)
689 Requires=different.service
690
691 [Service]
692 Description=x
693
694 $ systemd-analyze verify ./user.slice
695 [./user.slice:9] Unknown lvalue 'WhatIsThis' in section 'Unit'
696 [./user.slice:13] Unknown section 'Service'. Ignoring.
697 Error: org.freedesktop.systemd1.LoadFailed:
698 Unit different.service failed to load:
699 No such file or directory.
700 Failed to create user.slice/start: Invalid argument
701 user.slice: man nosuchfile(1) command failed with code 16
702 </programlisting>
703 </example>
704
705 <example>
706 <title>Missing service units</title>
707
708 <programlisting>$ tail ./a.socket ./b.socket
709 ==> ./a.socket &lt;==
710 [Socket]
711 ListenStream=100
712
713 ==> ./b.socket &lt;==
714 [Socket]
715 ListenStream=100
716 Accept=yes
717
718 $ systemd-analyze verify ./a.socket ./b.socket
719 Service a.service not loaded, a.socket cannot be started.
720 Service b@0.service not loaded, b.socket cannot be started.
721 </programlisting>
722 </example>
723
724 <example>
725 <title>Aliasing a unit</title>
726
727 <programlisting>$ cat /tmp/source
728 [Unit]
729 Description=Hostname printer
730
731 [Service]
732 Type=simple
733 ExecStart=/usr/bin/echo %H
734 MysteryKey=true
735
736 $ systemd-analyze verify /tmp/source
737 Failed to prepare filename /tmp/source: Invalid argument
738
739 $ systemd-analyze verify /tmp/source:alias.service
740 /tmp/systemd-analyze-XXXXXX/alias.service:7: Unknown key name 'MysteryKey' in section 'Service', ignoring.
741 </programlisting>
742 </example>
743
744 </refsect2>
745
746 <refsect2>
747 <title><command>systemd-analyze security <optional><replaceable>UNIT</replaceable>...</optional></command></title>
748
749 <para>This command analyzes the security and sandboxing settings of one or more specified service
750 units. If at least one unit name is specified the security settings of the specified service units are
751 inspected and a detailed analysis is shown. If no unit name is specified, all currently loaded,
752 long-running service units are inspected and a terse table with results shown. The command checks for
753 various security-related service settings, assigning each a numeric "exposure level" value, depending
754 on how important a setting is. It then calculates an overall exposure level for the whole unit, which
755 is an estimation in the range 0.0…10.0 indicating how exposed a service is security-wise. High exposure
756 levels indicate very little applied sandboxing. Low exposure levels indicate tight sandboxing and
757 strongest security restrictions. Note that this only analyzes the per-service security features systemd
758 itself implements. This means that any additional security mechanisms applied by the service code
759 itself are not accounted for. The exposure level determined this way should not be misunderstood: a
760 high exposure level neither means that there is no effective sandboxing applied by the service code
761 itself, nor that the service is actually vulnerable to remote or local attacks. High exposure levels do
762 indicate however that most likely the service might benefit from additional settings applied to
763 them.</para>
764
765 <para>Please note that many of the security and sandboxing settings individually can be circumvented —
766 unless combined with others. For example, if a service retains the privilege to establish or undo mount
767 points many of the sandboxing options can be undone by the service code itself. Due to that is
768 essential that each service uses the most comprehensive and strict sandboxing and security settings
769 possible. The tool will take into account some of these combinations and relationships between the
770 settings, but not all. Also note that the security and sandboxing settings analyzed here only apply to
771 the operations executed by the service code itself. If a service has access to an IPC system (such as
772 D-Bus) it might request operations from other services that are not subject to the same
773 restrictions. Any comprehensive security and sandboxing analysis is hence incomplete if the IPC access
774 policy is not validated too.</para>
775
776 <example>
777 <title>Analyze <filename index="false">systemd-logind.service</filename></title>
778
779 <programlisting>$ systemd-analyze security --no-pager systemd-logind.service
780 NAME DESCRIPTION EXPOSURE
781 ✗ PrivateNetwork= Service has access to the host's network 0.5
782 ✗ User=/DynamicUser= Service runs as root user 0.4
783 ✗ DeviceAllow= Service has no device ACL 0.2
784 ✓ IPAddressDeny= Service blocks all IP address ranges
785 ...
786 → Overall exposure level for systemd-logind.service: 4.1 OK 🙂
787 </programlisting>
788 </example>
789 </refsect2>
790
791 <refsect2>
792 <title><command>systemd-analyze inspect-elf <replaceable>FILE</replaceable>...</command></title>
793
794 <para>This command will load the specified files, and if they are ELF objects (executables,
795 libraries, core files, etc.) it will parse the embedded packaging metadata, if any, and print
796 it in a table or json format. See the <ulink url="https://systemd.io/COREDUMP_PACKAGE_METADATA/">
797 Packaging Metadata</ulink> documentation for more information.</para>
798
799 <example>
800 <title>Table output</title>
801
802 <programlisting>$ systemd-analyze inspect-elf --json=pretty /tmp/core.fsverity.1000.f77dac5dc161402aa44e15b7dd9dcf97.58561.1637106137000000
803 {
804 "elfType" : "coredump",
805 "elfArchitecture" : "AMD x86-64",
806 "/home/bluca/git/fsverity-utils/fsverity" : {
807 "type" : "deb",
808 "name" : "fsverity-utils",
809 "version" : "1.3-1",
810 "buildId" : "7c895ecd2a271f93e96268f479fdc3c64a2ec4ee"
811 },
812 "/home/bluca/git/fsverity-utils/libfsverity.so.0" : {
813 "type" : "deb",
814 "name" : "fsverity-utils",
815 "version" : "1.3-1",
816 "buildId" : "b5e428254abf14237b0ae70ed85fffbb98a78f88"
817 }
818 }
819 </programlisting>
820 </example>
821 </refsect2>
822
823 <refsect2>
824 <title><command>systemd-analyze fdstore <optional><replaceable>UNIT</replaceable>...</optional></command></title>
825
826 <para>Lists the current contents of the specified service unit's file descriptor store. This shows
827 names, inode types, device numbers, inode numbers, paths and open modes of the open file
828 descriptors. The specified units must have <varname>FileDescriptorStoreMax=</varname> enabled, see
829 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
830 details.</para>
831
832 <example>
833 <title>Table output</title>
834 <programlisting>$ systemd-analyze fdstore systemd-journald.service
835 FDNAME TYPE DEVNO INODE RDEVNO PATH FLAGS
836 stored sock 0:8 4218620 - socket:[4218620] ro
837 stored sock 0:8 4213198 - socket:[4213198] ro
838 stored sock 0:8 4213190 - socket:[4213190] ro
839 …</programlisting>
840 </example>
841
842 <para>Note: the "DEVNO" column refers to the major/minor numbers of the device node backing the file
843 system the file descriptor's inode is on. The "RDEVNO" column refers to the major/minor numbers of the
844 device node itself if the file descriptor refers to one. Compare with corresponding
845 <varname>.st_dev</varname> and <varname>.st_rdev</varname> fields in <type>struct stat</type> (see
846 <citerefentry
847 project='man-pages'><refentrytitle>stat</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
848 details). The listed inode numbers in the "INODE" column are on the file system indicated by
849 "DEVNO".</para>
850 </refsect2>
851
852 <refsect2>
853 <title><command>systemd-analyze image-policy <optional><replaceable>POLICY</replaceable>…</optional></command></title>
854
855 <para>This command analyzes the specified image policy string, as per
856 <citerefentry><refentrytitle>systemd.image-policy</refentrytitle><manvolnum>7</manvolnum></citerefentry>. The
857 policy is normalized and simplified. For each currently defined partition identifier (as per the <ulink
858 url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable
859 Partitions Specification</ulink> the effect of the image policy string is shown in tabular form.</para>
860
861 <example>
862 <title>Example Output</title>
863
864 <programlisting>$ systemd-analyze image-policy swap=encrypted:usr=read-only-on+verity:root=encrypted
865 Analyzing policy: root=encrypted:usr=verity+read-only-on:swap=encrypted
866 Long form: root=encrypted:usr=verity+read-only-on:swap=encrypted:=unused+absent
867
868 PARTITION MODE READ-ONLY GROWFS
869 root encrypted - -
870 usr verity yes -
871 home ignore - -
872 srv ignore - -
873 esp ignore - -
874 xbootldr ignore - -
875 swap encrypted - -
876 root-verity ignore - -
877 usr-verity unprotected yes -
878 root-verity-sig ignore - -
879 usr-verity-sig ignore - -
880 tmp ignore - -
881 var ignore - -
882 default ignore - -</programlisting>
883 </example>
884 </refsect2>
885 </refsect1>
886
887 <refsect1>
888 <title>Options</title>
889
890 <para>The following options are understood:</para>
891
892 <variablelist>
893 <varlistentry>
894 <term><option>--system</option></term>
895
896 <listitem><para>Operates on the system systemd instance. This
897 is the implied default.</para></listitem>
898 </varlistentry>
899
900 <varlistentry>
901 <term><option>--user</option></term>
902
903 <listitem><para>Operates on the user systemd
904 instance.</para></listitem>
905 </varlistentry>
906
907 <varlistentry>
908 <term><option>--global</option></term>
909
910 <listitem><para>Operates on the system-wide configuration for
911 user systemd instance.</para></listitem>
912 </varlistentry>
913
914 <varlistentry>
915 <term><option>--order</option></term>
916 <term><option>--require</option></term>
917
918 <listitem><para>When used in conjunction with the
919 <command>dot</command> command (see above), selects which
920 dependencies are shown in the dependency graph. If
921 <option>--order</option> is passed, only dependencies of type
922 <varname>After=</varname> or <varname>Before=</varname> are
923 shown. If <option>--require</option> is passed, only
924 dependencies of type <varname>Requires=</varname>,
925 <varname>Requisite=</varname>,
926 <varname>Wants=</varname> and <varname>Conflicts=</varname>
927 are shown. If neither is passed, this shows dependencies of
928 all these types.</para></listitem>
929 </varlistentry>
930
931 <varlistentry>
932 <term><option>--from-pattern=</option></term>
933 <term><option>--to-pattern=</option></term>
934
935 <listitem><para>When used in conjunction with the
936 <command>dot</command> command (see above), this selects which
937 relationships are shown in the dependency graph. Both options
938 require a
939 <citerefentry project='man-pages'><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
940 pattern as an argument, which will be matched against the
941 left-hand and the right-hand, respectively, nodes of a
942 relationship.</para>
943
944 <para>Each of these can be used more than once, in which case
945 the unit name must match one of the values. When tests for
946 both sides of the relation are present, a relation must pass
947 both tests to be shown. When patterns are also specified as
948 positional arguments, they must match at least one side of the
949 relation. In other words, patterns specified with those two
950 options will trim the list of edges matched by the positional
951 arguments, if any are given, and fully determine the list of
952 edges shown otherwise.</para></listitem>
953 </varlistentry>
954
955 <varlistentry>
956 <term><option>--fuzz=</option><replaceable>timespan</replaceable></term>
957
958 <listitem><para>When used in conjunction with the
959 <command>critical-chain</command> command (see above), also
960 show units, which finished <replaceable>timespan</replaceable>
961 earlier, than the latest unit in the same level. The unit of
962 <replaceable>timespan</replaceable> is seconds unless
963 specified with a different unit, e.g.
964 "50ms".</para></listitem>
965 </varlistentry>
966
967 <varlistentry>
968 <term><option>--man=no</option></term>
969
970 <listitem><para>Do not invoke
971 <citerefentry project='man-pages'><refentrytitle>man</refentrytitle><manvolnum>1</manvolnum></citerefentry>
972 to verify the existence of man pages listed in <varname>Documentation=</varname>.</para></listitem>
973 </varlistentry>
974
975 <varlistentry>
976 <term><option>--generators</option></term>
977
978 <listitem><para>Invoke unit generators, see
979 <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
980 Some generators require root privileges. Under a normal user, running with
981 generators enabled will generally result in some warnings.</para></listitem>
982 </varlistentry>
983
984 <varlistentry>
985 <term><option>--recursive-errors=<replaceable>MODE</replaceable></option></term>
986
987 <listitem><para>Control verification of units and their dependencies and whether
988 <command>systemd-analyze verify</command> exits with a non-zero process exit status or not. With
989 <command>yes</command>, return a non-zero process exit status when warnings arise during verification
990 of either the specified unit or any of its associated dependencies. With <command>no</command>,
991 return a non-zero process exit status when warnings arise during verification of only the specified
992 unit. With <command>one</command>, return a non-zero process exit status when warnings arise during
993 verification of either the specified unit or its immediate dependencies. If this option is not
994 specified, zero is returned as the exit status regardless whether warnings arise during verification
995 or not.</para></listitem>
996 </varlistentry>
997
998 <varlistentry>
999 <term><option>--root=<replaceable>PATH</replaceable></option></term>
1000
1001 <listitem><para>With <command>cat-files</command> and <command>verify</command>,
1002 operate on files underneath the specified root path <replaceable>PATH</replaceable>.</para></listitem>
1003 </varlistentry>
1004
1005 <varlistentry>
1006 <term><option>--image=<replaceable>PATH</replaceable></option></term>
1007
1008 <listitem><para>With <command>cat-files</command> and <command>verify</command>,
1009 operate on files inside the specified image path <replaceable>PATH</replaceable>.</para></listitem>
1010 </varlistentry>
1011
1012 <xi:include href="standard-options.xml" xpointer="image-policy-open" />
1013
1014 <varlistentry>
1015 <term><option>--offline=<replaceable>BOOL</replaceable></option></term>
1016
1017 <listitem><para>With <command>security</command>, perform an offline security review
1018 of the specified unit files, i.e. does not have to rely on PID 1 to acquire security
1019 information for the files like the <command>security</command> verb when used by itself does.
1020 This means that <option>--offline=</option> can be used with <option>--root=</option> and
1021 <option>--image=</option> as well. If a unit's overall exposure level is above that set by
1022 <option>--threshold=</option> (default value is 100), <option>--offline=</option> will return
1023 an error.</para></listitem>
1024 </varlistentry>
1025
1026 <varlistentry>
1027 <term><option>--profile=<replaceable>PATH</replaceable></option></term>
1028
1029 <listitem><para>With <command>security</command> <option>--offline=</option>, takes into
1030 consideration the specified portable profile when assessing unit settings.
1031 The profile can be passed by name, in which case the well-known system locations will
1032 be searched, or it can be the full path to a specific drop-in file.</para></listitem>
1033 </varlistentry>
1034
1035 <varlistentry>
1036 <term><option>--threshold=<replaceable>NUMBER</replaceable></option></term>
1037
1038 <listitem><para>With <command>security</command>, allow the user to set a custom value
1039 to compare the overall exposure level with, for the specified unit files. If a unit's
1040 overall exposure level, is greater than that set by the user, <command>security</command>
1041 will return an error. <option>--threshold=</option> can be used with <option>--offline=</option>
1042 as well and its default value is 100.</para></listitem>
1043 </varlistentry>
1044
1045 <varlistentry>
1046 <term><option>--security-policy=<replaceable>PATH</replaceable></option></term>
1047
1048 <listitem><para>With <command>security</command>, allow the user to define a custom set of
1049 requirements formatted as a JSON file against which to compare the specified unit file(s)
1050 and determine their overall exposure level to security threats.</para>
1051
1052 <table>
1053 <title>Accepted Assessment Test Identifiers</title>
1054
1055 <tgroup cols='1'>
1056 <colspec colname='directive' />
1057 <thead>
1058 <row>
1059 <entry>Assessment Test Identifier</entry>
1060 </row>
1061 </thead>
1062 <tbody>
1063 <row>
1064 <entry>UserOrDynamicUser</entry>
1065 </row>
1066 <row>
1067 <entry>SupplementaryGroups</entry>
1068 </row>
1069 <row>
1070 <entry>PrivateMounts</entry>
1071 </row>
1072 <row>
1073 <entry>PrivateDevices</entry>
1074 </row>
1075 <row>
1076 <entry>PrivateTmp</entry>
1077 </row>
1078 <row>
1079 <entry>PrivateNetwork</entry>
1080 </row>
1081 <row>
1082 <entry>PrivateUsers</entry>
1083 </row>
1084 <row>
1085 <entry>ProtectControlGroups</entry>
1086 </row>
1087 <row>
1088 <entry>ProtectKernelModules</entry>
1089 </row>
1090 <row>
1091 <entry>ProtectKernelTunables</entry>
1092 </row>
1093 <row>
1094 <entry>ProtectKernelLogs</entry>
1095 </row>
1096 <row>
1097 <entry>ProtectClock</entry>
1098 </row>
1099 <row>
1100 <entry>ProtectHome</entry>
1101 </row>
1102 <row>
1103 <entry>ProtectHostname</entry>
1104 </row>
1105 <row>
1106 <entry>ProtectSystem</entry>
1107 </row>
1108 <row>
1109 <entry>RootDirectoryOrRootImage</entry>
1110 </row>
1111 <row>
1112 <entry>LockPersonality</entry>
1113 </row>
1114 <row>
1115 <entry>MemoryDenyWriteExecute</entry>
1116 </row>
1117 <row>
1118 <entry>NoNewPrivileges</entry>
1119 </row>
1120 <row>
1121 <entry>CapabilityBoundingSet_CAP_SYS_ADMIN</entry>
1122 </row>
1123 <row>
1124 <entry>CapabilityBoundingSet_CAP_SET_UID_GID_PCAP</entry>
1125 </row>
1126 <row>
1127 <entry>CapabilityBoundingSet_CAP_SYS_PTRACE</entry>
1128 </row>
1129 <row>
1130 <entry>CapabilityBoundingSet_CAP_SYS_TIME</entry>
1131 </row>
1132 <row>
1133 <entry>CapabilityBoundingSet_CAP_NET_ADMIN</entry>
1134 </row>
1135 <row>
1136 <entry>CapabilityBoundingSet_CAP_SYS_RAWIO</entry>
1137 </row>
1138 <row>
1139 <entry>CapabilityBoundingSet_CAP_SYS_MODULE</entry>
1140 </row>
1141 <row>
1142 <entry>CapabilityBoundingSet_CAP_AUDIT</entry>
1143 </row>
1144 <row>
1145 <entry>CapabilityBoundingSet_CAP_SYSLOG</entry>
1146 </row>
1147 <row>
1148 <entry>CapabilityBoundingSet_CAP_SYS_NICE_RESOURCE</entry>
1149 </row>
1150 <row>
1151 <entry>CapabilityBoundingSet_CAP_MKNOD</entry>
1152 </row>
1153 <row>
1154 <entry>CapabilityBoundingSet_CAP_CHOWN_FSETID_SETFCAP</entry>
1155 </row>
1156 <row>
1157 <entry>CapabilityBoundingSet_CAP_DAC_FOWNER_IPC_OWNER</entry>
1158 </row>
1159 <row>
1160 <entry>CapabilityBoundingSet_CAP_KILL</entry>
1161 </row>
1162 <row>
1163 <entry>CapabilityBoundingSet_CAP_NET_BIND_SERVICE_BROADCAST_RAW</entry>
1164 </row>
1165 <row>
1166 <entry>CapabilityBoundingSet_CAP_SYS_BOOT</entry>
1167 </row>
1168 <row>
1169 <entry>CapabilityBoundingSet_CAP_MAC</entry>
1170 </row>
1171 <row>
1172 <entry>CapabilityBoundingSet_CAP_LINUX_IMMUTABLE</entry>
1173 </row>
1174 <row>
1175 <entry>CapabilityBoundingSet_CAP_IPC_LOCK</entry>
1176 </row>
1177 <row>
1178 <entry>CapabilityBoundingSet_CAP_SYS_CHROOT</entry>
1179 </row>
1180 <row>
1181 <entry>CapabilityBoundingSet_CAP_BLOCK_SUSPEND</entry>
1182 </row>
1183 <row>
1184 <entry>CapabilityBoundingSet_CAP_WAKE_ALARM</entry>
1185 </row>
1186 <row>
1187 <entry>CapabilityBoundingSet_CAP_LEASE</entry>
1188 </row>
1189 <row>
1190 <entry>CapabilityBoundingSet_CAP_SYS_TTY_CONFIG</entry>
1191 </row>
1192 <row>
1193 <entry>UMask</entry>
1194 </row>
1195 <row>
1196 <entry>KeyringMode</entry>
1197 </row>
1198 <row>
1199 <entry>ProtectProc</entry>
1200 </row>
1201 <row>
1202 <entry>ProcSubset</entry>
1203 </row>
1204 <row>
1205 <entry>NotifyAccess</entry>
1206 </row>
1207 <row>
1208 <entry>RemoveIPC</entry>
1209 </row>
1210 <row>
1211 <entry>Delegate</entry>
1212 </row>
1213 <row>
1214 <entry>RestrictRealtime</entry>
1215 </row>
1216 <row>
1217 <entry>RestrictSUIDSGID</entry>
1218 </row>
1219 <row>
1220 <entry>RestrictNamespaces_user</entry>
1221 </row>
1222 <row>
1223 <entry>RestrictNamespaces_mnt</entry>
1224 </row>
1225 <row>
1226 <entry>RestrictNamespaces_ipc</entry>
1227 </row>
1228 <row>
1229 <entry>RestrictNamespaces_pid</entry>
1230 </row>
1231 <row>
1232 <entry>RestrictNamespaces_cgroup</entry>
1233 </row>
1234 <row>
1235 <entry>RestrictNamespaces_uts</entry>
1236 </row>
1237 <row>
1238 <entry>RestrictNamespaces_net</entry>
1239 </row>
1240 <row>
1241 <entry>RestrictAddressFamilies_AF_INET_INET6</entry>
1242 </row>
1243 <row>
1244 <entry>RestrictAddressFamilies_AF_UNIX</entry>
1245 </row>
1246 <row>
1247 <entry>RestrictAddressFamilies_AF_NETLINK</entry>
1248 </row>
1249 <row>
1250 <entry>RestrictAddressFamilies_AF_PACKET</entry>
1251 </row>
1252 <row>
1253 <entry>RestrictAddressFamilies_OTHER</entry>
1254 </row>
1255 <row>
1256 <entry>SystemCallArchitectures</entry>
1257 </row>
1258 <row>
1259 <entry>SystemCallFilter_swap</entry>
1260 </row>
1261 <row>
1262 <entry>SystemCallFilter_obsolete</entry>
1263 </row>
1264 <row>
1265 <entry>SystemCallFilter_clock</entry>
1266 </row>
1267 <row>
1268 <entry>SystemCallFilter_cpu_emulation</entry>
1269 </row>
1270 <row>
1271 <entry>SystemCallFilter_debug</entry>
1272 </row>
1273 <row>
1274 <entry>SystemCallFilter_mount</entry>
1275 </row>
1276 <row>
1277 <entry>SystemCallFilter_module</entry>
1278 </row>
1279 <row>
1280 <entry>SystemCallFilter_raw_io</entry>
1281 </row>
1282 <row>
1283 <entry>SystemCallFilter_reboot</entry>
1284 </row>
1285 <row>
1286 <entry>SystemCallFilter_privileged</entry>
1287 </row>
1288 <row>
1289 <entry>SystemCallFilter_resources</entry>
1290 </row>
1291 <row>
1292 <entry>IPAddressDeny</entry>
1293 </row>
1294 <row>
1295 <entry>DeviceAllow</entry>
1296 </row>
1297 <row>
1298 <entry>AmbientCapabilities</entry>
1299 </row>
1300 </tbody>
1301 </tgroup>
1302 </table>
1303
1304 <para>See example "JSON Policy" below.</para></listitem>
1305 </varlistentry>
1306
1307 <varlistentry>
1308 <term><option>--json=<replaceable>MODE</replaceable></option></term>
1309
1310 <listitem><para>With the <command>security</command> command, generate a JSON formatted
1311 output of the security analysis table. The format is a JSON array with objects
1312 containing the following fields: <varname>set</varname> which indicates if the setting has
1313 been enabled or not, <varname>name</varname> which is what is used to refer to the setting,
1314 <varname>json_field</varname> which is the JSON compatible identifier of the setting,
1315 <varname>description</varname> which is an outline of the setting state, and
1316 <varname>exposure</varname> which is a number in the range 0.0…10.0, where a higher value
1317 corresponds to a higher security threat. The JSON version of the table is printed to standard
1318 output. The <replaceable>MODE</replaceable> passed to the option can be one of three:
1319 <option>off</option> which is the default, <option>pretty</option> and <option>short</option>
1320 which respectively output a prettified or shorted JSON version of the security table.
1321
1322 With the <command>plot</command> command, generate a JSON formatted output of the raw time data.
1323 The format is a JSON array with objects containing the following fields: <varname>name</varname>
1324 which is the unit name, <varname>activated</varname> which is the time after startup the
1325 service was activated, <varname>activating</varname> which is how long after startup the service
1326 was initially started, <varname>time</varname> which is how long the service took to activate
1327 from when it was initially started, <varname>deactivated</varname> which is the time after startup
1328 that the service was deactivated, <varname>deactivating</varname> which is the time after startup
1329 that the service was initially told to deactivate.
1330 </para></listitem>
1331 </varlistentry>
1332
1333 <varlistentry>
1334 <term><option>--iterations=<replaceable>NUMBER</replaceable></option></term>
1335
1336 <listitem><para>When used with the <command>calendar</command> command, show the specified number of
1337 iterations the specified calendar expression will elapse next. Defaults to 1.</para></listitem>
1338 </varlistentry>
1339
1340 <varlistentry>
1341 <term><option>--base-time=<replaceable>TIMESTAMP</replaceable></option></term>
1342
1343 <listitem><para>When used with the <command>calendar</command> command, show next iterations relative
1344 to the specified point in time. If not specified defaults to the current time.</para></listitem>
1345 </varlistentry>
1346
1347 <varlistentry>
1348 <term><option>--unit=<replaceable>UNIT</replaceable></option></term>
1349
1350 <listitem><para>When used with the <command>condition</command> command, evaluate all the
1351 <varname index="false">Condition*=...</varname> and <varname index="false">Assert*=...</varname>
1352 assignments in the specified unit file. The full unit search path is formed by combining the
1353 directories for the specified unit with the usual unit load paths. The variable
1354 <varname>$SYSTEMD_UNIT_PATH</varname> is supported, and may be used to replace or augment the
1355 compiled in set of unit load paths; see
1356 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. All
1357 units files present in the directory containing the specified unit will be used in preference to the
1358 other paths.</para></listitem>
1359 </varlistentry>
1360
1361 <varlistentry>
1362 <term><option>--table</option></term>
1363
1364 <listitem><para>When used with the <command>plot</command> command, the raw time data is output in a table.
1365 </para></listitem>
1366 </varlistentry>
1367
1368 <varlistentry>
1369 <term><option>--no-legend</option></term>
1370
1371 <listitem><para>When used with the <command>plot</command> command in combination with either
1372 <option>--table</option> or <option>--json=</option>, no legends or hints are included in the output.
1373 </para></listitem>
1374 </varlistentry>
1375
1376 <xi:include href="user-system-options.xml" xpointer="host" />
1377 <xi:include href="user-system-options.xml" xpointer="machine" />
1378
1379 <varlistentry>
1380 <term><option>--quiet</option></term>
1381
1382 <listitem><para>Suppress hints and other non-essential output.</para></listitem>
1383 </varlistentry>
1384
1385 <xi:include href="standard-options.xml" xpointer="help" />
1386 <xi:include href="standard-options.xml" xpointer="version" />
1387 <xi:include href="standard-options.xml" xpointer="no-pager" />
1388 </variablelist>
1389
1390 </refsect1>
1391
1392 <refsect1>
1393 <title>Exit status</title>
1394
1395 <para>For most commands, 0 is returned on success, and a non-zero failure code otherwise.</para>
1396
1397 <para>With the verb <command>compare-versions</command>, in the two-argument form,
1398 <constant>12</constant>, <constant>0</constant>, <constant>11</constant> is returned if the second
1399 version string is respectively larger, equal, or smaller to the first. In the three-argument form,
1400 <constant>0</constant> or <constant>1</constant> if the condition is respectively true or false.</para>
1401 </refsect1>
1402
1403 <xi:include href="common-variables.xml" />
1404
1405 <refsect1>
1406 <title>Examples</title>
1407
1408 <example>
1409 <title>JSON Policy</title>
1410
1411 <para>The JSON file passed as a path parameter to <option>--security-policy=</option> has a top-level
1412 JSON object, with keys being the assessment test identifiers mentioned above. The values in the file
1413 should be JSON objects with one or more of the following fields: <option>description_na</option>
1414 (string), <option>description_good</option> (string), <option>description_bad</option> (string),
1415 <option>weight</option> (unsigned integer), and <option>range</option> (unsigned integer). If any of
1416 these fields corresponding to a specific id of the unit file is missing from the JSON object, the
1417 default built-in field value corresponding to that same id is used for security analysis as default.
1418 The weight and range fields are used in determining the overall exposure level of the unit files: the
1419 value of each setting is assigned a badness score, which is multiplied by the policy weight and divided
1420 by the policy range to determine the overall exposure that the setting implies. The computed badness is
1421 summed across all settings in the unit file, normalized to the 1…100 range, and used to determine the
1422 overall exposure level of the unit. By allowing users to manipulate these fields, the 'security' verb
1423 gives them the option to decide for themself which ids are more important and hence should have a
1424 greater effect on the exposure level. A weight of <literal>0</literal> means the setting will not be
1425 checked.</para>
1426
1427 <programlisting>
1428 {
1429 "PrivateDevices":
1430 {
1431 "description_good": "Service has no access to hardware devices",
1432 "description_bad": "Service potentially has access to hardware devices",
1433 "weight": 1000,
1434 "range": 1
1435 },
1436 "PrivateMounts":
1437 {
1438 "description_good": "Service cannot install system mounts",
1439 "description_bad": "Service may install system mounts",
1440 "weight": 1000,
1441 "range": 1
1442 },
1443 "PrivateNetwork":
1444 {
1445 "description_good": "Service has no access to the host's network",
1446 "description_bad": "Service has access to the host's network",
1447 "weight": 2500,
1448 "range": 1
1449 },
1450 "PrivateTmp":
1451 {
1452 "description_good": "Service has no access to other software's temporary files",
1453 "description_bad": "Service has access to other software's temporary files",
1454 "weight": 1000,
1455 "range": 1
1456 },
1457 "PrivateUsers":
1458 {
1459 "description_good": "Service does not have access to other users",
1460 "description_bad": "Service has access to other users",
1461 "weight": 1000,
1462 "range": 1
1463 }
1464 }
1465 </programlisting>
1466 </example>
1467 </refsect1>
1468
1469 <refsect1>
1470 <title>See Also</title>
1471 <para>
1472 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1473 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
1474 </para>
1475 </refsect1>
1476
1477 </refentry>
Unnamed repository; edit this file 'description' to name the repository.