HALF ECHO LEARN / REFERENCE COLLECTION
v262.2man/systemd-analyze.xml
Git blob: a7f438343f66a8f284bb620e1f853f5715791ea1
Lines 1–1000 of 2,002
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
<refentry id="systemd-analyze" conditional='ENABLE_ANALYZE'
xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>systemd-analyze</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>systemd-analyze</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>systemd-analyze</refname>
<refpurpose>Analyze and debug system manager</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg>time</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">blame</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">critical-chain</arg>
<arg choice="opt" rep="repeat"><replaceable>UNIT</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">dump</arg>
<arg choice="opt" rep="repeat"><replaceable>PATTERN</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">plot</arg>
<arg choice="opt">>file.svg</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">dot</arg>
<arg choice="opt" rep="repeat"><replaceable>PATTERN</replaceable></arg>
<arg choice="opt">>file.dot</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">unit-files</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">unit-gdb</arg>
<arg choice="plain"><replaceable>SERVICE</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">unit-paths</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">unit-shell</arg>
<arg choice="plain"><replaceable>SERVICE</replaceable></arg>
<arg choice="opt" rep="repeat"><replaceable>COMMAND</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">exit-status</arg>
<arg choice="opt" rep="repeat"><replaceable>STATUS</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">capability</arg>
<group choice="opt">
<arg choice="plain" rep="repeat"><replaceable>CAPABILITY</replaceable></arg>
<arg choice="plain">
<group choice="req">
<arg choice="plain">-m</arg>
<arg choice="plain">--mask</arg>
</group>
<replaceable>MASK</replaceable>
</arg>
</group>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">condition</arg>
<arg choice="plain"><replaceable>CONDITION</replaceable>…</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">syscall-filter</arg>
<arg choice="opt"><replaceable>SET</replaceable>…</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">filesystems</arg>
<arg choice="opt"><replaceable>SET</replaceable>…</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">calendar</arg>
<arg choice="plain" rep="repeat"><replaceable>SPEC</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">timestamp</arg>
<arg choice="plain" rep="repeat"><replaceable>TIMESTAMP</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">timespan</arg>
<arg choice="plain" rep="repeat"><replaceable>SPAN</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">cat-config</arg>
<arg choice="plain" rep="repeat"><replaceable>NAME</replaceable>|<replaceable>PATH</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">compare-versions</arg>
<arg choice="plain"><replaceable>VERSION1</replaceable></arg>
<arg choice="opt"><replaceable>OP</replaceable></arg>
<arg choice="plain"><replaceable>VERSION2</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">verify</arg>
<arg choice="plain" rep="repeat"><replaceable>FILE</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">security</arg>
<arg choice="opt" rep="repeat"><replaceable>UNIT</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">inspect-elf</arg>
<arg choice="plain" rep="repeat"><replaceable>FILE</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">malloc</arg>
<arg choice="opt" rep="repeat"><replaceable>D-BUS SERVICE</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">fdstore</arg>
<arg choice="plain" rep="repeat"><replaceable>UNIT</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">image-policy</arg>
<arg choice="plain" rep="repeat"><replaceable>POLICY</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">has-tpm2</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">identify-tpm2</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">pcrs</arg>
<arg choice="opt" rep="repeat"><replaceable>PCR</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">nvpcrs</arg>
<arg choice="opt" rep="repeat"><replaceable>NVPCR</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">srk</arg>
<arg choice="opt"><replaceable>>FILE</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">architectures</arg>
<arg choice="opt" rep="repeat"><replaceable>NAME</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">smbios11</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">chid</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-analyze</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">transient-settings</arg>
<arg choice="plain" rep="repeat"><replaceable>TYPE</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para><command>systemd-analyze</command> may be used to determine
system boot-up performance statistics and retrieve other state and
tracing information from the system and service manager, and to
verify the correctness of unit files. It is also used to access
special functions useful for advanced system manager debugging.</para>
<para>If no command is passed, <command>systemd-analyze
time</command> is implied.</para>
<refsect2>
<title><command>systemd-analyze time</command></title>
<para>This command prints the time spent in the kernel before userspace has been reached, the time
spent in the initrd before normal system userspace has been reached, and the time normal system
userspace took to initialize. Note that these measurements simply measure the time passed up to the
point where all system services have been spawned, but not necessarily until they fully finished
initialization or the disk is idle.</para>
<para>If the manager carried shutdown timestamps across a kexec-based live update (i.e. they were
restored from the previous boot through the Live Update Orchestrator), the previous boot's shutdown
phases are prepended to the chain, so the full shutdown plus bootup sequence is shown and summed into
the total: the time spent stopping units (<literal>(stopping)</literal>), the time the manager took to
hand off to
<citerefentry><refentrytitle>systemd-shutdown</refentrytitle><manvolnum>8</manvolnum></citerefentry>
(<literal>(exit)</literal>) and the time spent in <command>systemd-shutdown</command> itself
(<literal>(systemd-shutdown)</literal>) are added before the firmware/loader/kernel/initrd/userspace
phases.</para>
<example>
<title><command>Show how long the boot took</command></title>
<programlisting># in a container
$ systemd-analyze time
Startup finished in 296ms (userspace)
multi-user.target reached after 275ms in userspace
# on a real machine
$ systemd-analyze time
Startup finished in 2.584s (kernel) + 19.176s (initrd) + 47.847s (userspace) = 1min 9.608s
multi-user.target reached after 47.820s in userspace
</programlisting>
</example>
</refsect2>
<refsect2>
<title><command>systemd-analyze blame</command></title>
<para>This command prints a list of all running units, ordered by the time they took to initialize.
This information may be used to optimize boot-up times. Note that the output might be misleading as the
initialization of one service might be slow simply because it waits for the initialization of another
service to complete. Also note: <command>systemd-analyze blame</command> does not display results for
services with <varname>Type=simple</varname>, because systemd considers such services to be started
immediately, hence no measurement of the initialization delays can be done. Also note that this command
only shows the time units took for starting up, it does not show how long unit jobs spent in the
execution queue. In particular it shows the time units spent in <literal>activating</literal> state,
which is not defined for units such as device units that transition directly from
<literal>inactive</literal> to <literal>active</literal>. This command hence gives an impression of the
performance of program code, but cannot accurately reflect latency introduced by waiting for
hardware and similar events.</para>
<example>
<title><command>Show which units took the most time during boot</command></title>
<programlisting>$ systemd-analyze blame
32.875s pmlogger.service
20.905s systemd-networkd-wait-online.service
13.299s dev-vda1.device
...
23ms sysroot.mount
11ms initrd-udevadm-cleanup-db.service
3ms sys-kernel-config.mount
</programlisting>
</example>
</refsect2>
<refsect2>
<title><command>systemd-analyze critical-chain <optional><replaceable>UNIT</replaceable>...</optional></command></title>
<para>This command prints a tree of the time-critical chain of units (for each of the specified
<replaceable>UNIT</replaceable>s or for the default target otherwise). The time after the unit is
active or started is printed after the "@" character. The time the unit takes to start is printed after
the "+" character. Note that the output might be misleading as the initialization of services might
depend on socket activation and because of the parallel execution of units. Also, similarly to the
<command>blame</command> command, this only takes into account the time units spent in
<literal>activating</literal> state, and hence does not cover units that never went through an
<literal>activating</literal> state (such as device units that transition directly from
<literal>inactive</literal> to <literal>active</literal>). Moreover, it does not show information on
jobs (and in particular not jobs that timed out).</para>
<example>
<title><command>systemd-analyze critical-chain</command></title>
<programlisting>$ systemd-analyze critical-chain
multi-user.target @47.820s
└─pmie.service @35.968s +548ms
└─pmcd.service @33.715s +2.247s
└─network-online.target @33.712s
└─systemd-networkd-wait-online.service @12.804s +20.905s
└─systemd-networkd.service @11.109s +1.690s
└─systemd-udevd.service @9.201s +1.904s
└─systemd-tmpfiles-setup-dev.service @7.306s +1.776s
└─kmod-static-nodes.service @6.976s +177ms
└─systemd-journald.socket
└─system.slice
└─-.slice
</programlisting>
</example>
</refsect2>
<refsect2>
<title><command>systemd-analyze dump [<replaceable>pattern</replaceable>…]</command></title>
<para>Without any parameter, this command outputs a (usually very long) human-readable serialization of
the complete service manager state. Optional glob pattern may be specified, causing the output to be
limited to units whose names match one of the patterns. The output format is subject to change without
notice and should not be parsed by applications. This command is rate limited for unprivileged users.</para>
<example>
<title>Show the internal state of user manager</title>
<programlisting>$ systemd-analyze --user dump
Timestamp userspace: Thu 2019-03-14 23:28:07 CET
Timestamp finish: Thu 2019-03-14 23:28:07 CET
Timestamp generators-start: Thu 2019-03-14 23:28:07 CET
Timestamp generators-finish: Thu 2019-03-14 23:28:07 CET
Timestamp units-load-start: Thu 2019-03-14 23:28:07 CET
Timestamp units-load-finish: Thu 2019-03-14 23:28:07 CET
-> Unit proc-timer_list.mount:
Description: /proc/timer_list
...
-> Unit default.target:
Description: Main user target
...
</programlisting>
</example>
</refsect2>
<refsect2>
<title><command>systemd-analyze malloc [<replaceable>D-Bus service</replaceable>…]</command></title>
<para>This command can be used to request the output of the internal memory state (as returned by
<citerefentry project='man-pages'><refentrytitle>malloc_info</refentrytitle><manvolnum>3</manvolnum></citerefentry>)
of a D-Bus service. If no service is specified, the query will be sent to
<filename>org.freedesktop.systemd1</filename> (the system or user service manager). The output format
is not guaranteed to be stable and should not be parsed by applications.</para>
<para>The service must implement the <filename>org.freedesktop.MemoryAllocation1</filename> interface.
In the systemd suite, it is currently only implemented by the manager.</para>
</refsect2>
<refsect2>
<title><command>systemd-analyze plot</command></title>
<para>This command prints either an SVG graphic, detailing which system services have been started at what
time, highlighting the time they spent on initialization, or the raw time data in JSON or table format.</para>
<example>
<title><command>Plot a bootchart</command></title>
<programlisting>$ systemd-analyze plot >bootup.svg
$ eog bootup.svg&
</programlisting>
</example>
<para>Note that this plot is based on the most recent per-unit timing data of loaded units. This means
that if a unit gets started, then stopped and then started again the information shown will cover the
most recent start cycle, not the first one. Thus it is recommended to consult this information only
shortly after boot, so that this distinction does not matter. Moreover, units that are not referenced by
any other unit through a dependency might be unloaded by the service manager once they terminate (and
did not fail). Such units will not show up in the plot.</para>
</refsect2>
<refsect2>
<title><command>systemd-analyze dot [<replaceable>pattern</replaceable>...]</command></title>
<para>This command generates textual dependency graph description in dot format for further processing
with the GraphViz
<citerefentry project='die-net'><refentrytitle>dot</refentrytitle><manvolnum>1</manvolnum></citerefentry>
tool. Use a command line like <command>systemd-analyze dot | dot -Tsvg >systemd.svg</command> to
generate a graphical dependency tree. Unless <option>--order</option> or <option>--require</option> is
passed, the generated graph will show both ordering and requirement dependencies. Optional pattern
globbing style specifications (e.g. <filename>*.target</filename>) may be given at the end. A unit
dependency is included in the graph if any of these patterns match either the origin or destination
node.</para>
<example>
<title>Plot all dependencies of any unit whose name starts with <literal>avahi-daemon</literal>
</title>
<programlisting>$ systemd-analyze dot 'avahi-daemon.*' | dot -Tsvg >avahi.svg
$ eog avahi.svg</programlisting>
</example>
<example>
<title>Plot the dependencies between all known target units</title>
<programlisting>$ systemd-analyze dot --to-pattern='*.target' --from-pattern='*.target' \
| dot -Tsvg >targets.svg
$ eog targets.svg</programlisting>
</example>
</refsect2>
<refsect2>
<title><command>systemd-analyze unit-paths</command></title>
<para>This command outputs a list of all directories from which unit files, <filename>.d</filename>
overrides, and <filename>.wants</filename>, <filename>.requires</filename> symlinks may be
loaded. Combine with <option>--user</option> to retrieve the list for the user manager instance, and
<option>--global</option> for the global configuration of user manager instances.</para>
<example>
<title><command>Show all paths for generated units</command></title>
<programlisting>$ systemd-analyze unit-paths | grep '^/run'
/run/systemd/system.control
/run/systemd/transient
/run/systemd/generator.early
/run/systemd/system
/run/systemd/system.attached
/run/systemd/generator
/run/systemd/generator.late
</programlisting>
</example>
<para>Note that this verb prints the list that is compiled into <command>systemd-analyze</command>
itself, and does not communicate with the running manager. Use
<programlisting>systemctl [--user] [--global] show -p UnitPath --value</programlisting>
to retrieve the actual list that the manager uses, with any empty directories omitted.</para>
</refsect2>
<refsect2>
<title><command>systemd-analyze exit-status <optional><replaceable>STATUS</replaceable>...</optional></command></title>
<para>This command prints a list of exit statuses along with their "class", i.e. the source of the
definition (one of <literal>libc</literal>, <literal>systemd</literal>, <literal>LSB</literal>, or
<literal>BSD</literal>), see the Process Exit Codes section in
<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
If no additional arguments are specified, all known statuses are shown. Otherwise, only the
definitions for the specified codes are shown.</para>
<example>
<title><command>Show some example exit status names</command></title>
<programlisting>$ systemd-analyze exit-status 0 1 {63..65}
NAME STATUS CLASS
SUCCESS 0 libc
FAILURE 1 libc
- 63 -
USAGE 64 BSD
DATAERR 65 BSD
</programlisting>
</example>
</refsect2>
<refsect2>
<title>
<command>systemd-analyze capability
<group choice="opt">
<arg choice="plain" rep="repeat"><replaceable>CAPABILITY</replaceable></arg>
<arg choice="plain">
<group choice="req">
<arg choice="plain">-m</arg>
<arg choice="plain">--mask</arg>
</group>
<replaceable>MASK</replaceable>
</arg>
</group>
</command>
</title>
<para>This command prints a list of Linux capabilities along with their numeric IDs. See <citerefentry
project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
for details. If no argument is specified the full list of capabilities known to the service manager and
the kernel is shown. Capabilities defined by the kernel but not known to the service manager are shown
as <literal>cap_???</literal>. Optionally, if arguments are specified they may refer to specific
cabilities by name or numeric ID, in which case only the indicated capabilities are shown in the
table.</para>
<para>Alternatively, if <option>--mask</option> is passed, a single numeric argument must be specified,
which is interpreted as a hexadecimal capability mask. In this case, only the capabilities present in
the mask are shown in the table. This mode is intended to aid in decoding capability sets available
via various debugging interfaces (e.g. <literal>/proc/PID/status</literal>).</para>
<example>
<title><command>Show some example capability names</command></title>
<programlisting>$ systemd-analyze capability 0 1 {30..32}
NAME NUMBER
cap_chown 0
cap_dac_override 1
cap_audit_control 30
cap_setfcap 31
cap_mac_override 32</programlisting>
</example>
<example>
<title><command>Decode a capability mask extracted from /proc</command></title>
<programlisting>$ systemd-analyze capability -m 0000000000003c00
NAME NUMBER
cap_net_bind_service 10
cap_net_broadcast 11
cap_net_admin 12
cap_net_raw 13
</programlisting>
</example>
</refsect2>
<refsect2>
<title><command>systemd-analyze condition <replaceable>CONDITION</replaceable>...</command></title>
<para>This command will evaluate <varname index="false">Condition*=...</varname> and
<varname index="false">Assert*=...</varname> assignments, and print their values, and
the resulting value of the combined condition set. See
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for a list of available conditions and asserts.</para>
<example>
<title>Evaluate conditions that check kernel versions</title>
<programlisting>$ systemd-analyze condition 'ConditionVersion = ! <4.0' \
'ConditionVersion = >=5.1' \
'ConditionACPower=|false' \
'ConditionArchitecture=|!arm' \
'AssertPathExists=/etc/os-release'
test.service: AssertPathExists=/etc/os-release succeeded.
Asserts succeeded.
test.service: ConditionArchitecture=|!arm succeeded.
test.service: ConditionACPower=|false failed.
test.service: ConditionVersion=>=5.1 succeeded.
test.service: ConditionVersion=!<4.0 succeeded.
Conditions succeeded.</programlisting>
</example>
</refsect2>
<refsect2>
<title><command>systemd-analyze syscall-filter <optional><replaceable>SET</replaceable>...</optional></command></title>
<para>This command will list system calls contained in the specified system call set
<replaceable>SET</replaceable>, or all known sets if no sets are specified. Argument
<replaceable>SET</replaceable> must include the <literal>@</literal> prefix.</para>
</refsect2>
<refsect2>
<title><command>systemd-analyze filesystems <optional><replaceable>SET</replaceable>...</optional></command></title>
<para>This command will list filesystems in the specified filesystem set
<replaceable>SET</replaceable>, or all known sets if no sets are specified. Argument
<replaceable>SET</replaceable> must include the <literal>@</literal> prefix.</para>
</refsect2>
<refsect2>
<title><command>systemd-analyze calendar <replaceable>EXPRESSION</replaceable>...</command></title>
<para>This command will parse and normalize repetitive calendar time events, and will calculate when
they elapse next. This takes the same input as the <varname>OnCalendar=</varname> setting in
<citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
following the syntax described in
<citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>. By
default, only the next time the calendar expression will elapse is shown; use
<option>--iterations=</option> to show the specified number of next times the expression
elapses. Each time the expression elapses forms a timestamp, see the <command>timestamp</command>
verb below.</para>
<example>
<title>Show leap days in the near future</title>
<programlisting>$ systemd-analyze calendar --iterations=5 '*-2-29 0:0:0'
Original form: *-2-29 0:0:0
Normalized form: *-02-29 00:00:00
Next elapse: Sat 2020-02-29 00:00:00 UTC
From now: 11 months 15 days left
Iter. #2: Thu 2024-02-29 00:00:00 UTC
From now: 4 years 11 months left
Iter. #3: Tue 2028-02-29 00:00:00 UTC
From now: 8 years 11 months left
Iter. #4: Sun 2032-02-29 00:00:00 UTC
From now: 12 years 11 months left
Iter. #5: Fri 2036-02-29 00:00:00 UTC
From now: 16 years 11 months left
</programlisting>
</example>
</refsect2>
<refsect2>
<title><command>systemd-analyze timestamp <replaceable>TIMESTAMP</replaceable>...</command></title>
<para>This command parses a timestamp (i.e. a single point in time) and outputs the normalized form and
the difference between this timestamp and now. The timestamp should adhere to the syntax documented in
<citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
section "PARSING TIMESTAMPS".</para>
<example>
<title>Show parsing of timestamps</title>
<programlisting>$ systemd-analyze timestamp yesterday now tomorrow
Original form: yesterday
Normalized form: Mon 2019-05-20 00:00:00 CEST
(in UTC): Sun 2019-05-19 22:00:00 UTC
UNIX seconds: @15583032000
From now: 1 day 9h ago
Original form: now
Normalized form: Tue 2019-05-21 09:48:39 CEST
(in UTC): Tue 2019-05-21 07:48:39 UTC
UNIX seconds: @1558424919.659757
From now: 43us ago
Original form: tomorrow
Normalized form: Wed 2019-05-22 00:00:00 CEST
(in UTC): Tue 2019-05-21 22:00:00 UTC
UNIX seconds: @15584760000
From now: 14h left
</programlisting>
</example>
</refsect2>
<refsect2>
<title><command>systemd-analyze timespan <replaceable>EXPRESSION</replaceable>...</command></title>
<para>This command parses a time span (i.e. a difference between two timestamps) and outputs the
normalized form and the equivalent value in microseconds. The time span should adhere to the syntax
documented in
<citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
section "PARSING TIME SPANS". Values without units are parsed as seconds.</para>
<example>
<title>Show parsing of timespans</title>
<programlisting>$ systemd-analyze timespan 1s 300s '1year 0.000001s'
Original: 1s
μs: 1000000
Human: 1s
Original: 300s
μs: 300000000
Human: 5min
Original: 1year 0.000001s
μs: 31557600000001
Human: 1y 1us
</programlisting>
</example>
</refsect2>
<refsect2>
<title><command>systemd-analyze cat-config</command>
<replaceable>NAME</replaceable>|<replaceable>PATH</replaceable>...</title>
<para>This command is similar to <command>systemctl cat</command>, but operates on config files. It
will copy the contents of a config file and any drop-ins to standard output, using the usual systemd
set of directories and rules for precedence. Each argument must be either an absolute path including
the prefix (such as <filename>/etc/systemd/logind.conf</filename> or
<filename>/usr/lib/systemd/logind.conf</filename>), or a name relative to the prefix (such as
<filename>systemd/logind.conf</filename>).</para>
<example>
<title>Showing logind configuration</title>
<programlisting>$ systemd-analyze cat-config systemd/logind.conf
# /etc/systemd/logind.conf
...
[Login]
NAutoVTs=8
...
# /usr/lib/systemd/logind.conf.d/20-test.conf
... some override from another package
# /etc/systemd/logind.conf.d/50-override.conf
... some administrator override
</programlisting>
</example>
</refsect2>
<refsect2>
<title><command>systemd-analyze compare-versions
<replaceable>VERSION1</replaceable>
<optional><replaceable>OP</replaceable></optional>
<replaceable>VERSION2</replaceable></command></title>
<para>This command has two distinct modes of operation, depending on whether the operator
<replaceable>OP</replaceable> is specified.</para>
<para>In the first mode — when <replaceable>OP</replaceable> is not specified —, it will compare the two
version strings and print either <literal><replaceable>VERSION1</replaceable> <
<replaceable>VERSION2</replaceable></literal>, or <literal><replaceable>VERSION1</replaceable> ==
<replaceable>VERSION2</replaceable></literal>, or <literal><replaceable>VERSION1</replaceable> >
<replaceable>VERSION2</replaceable></literal> as appropriate.</para>
<para>The exit status is <constant>0</constant> if the versions are equal, <constant>11</constant> if
the version of the right is smaller, and <constant>12</constant> if the version of the left is
smaller. (This matches the convention used by <command>rpmdev-vercmp</command>.)</para>
<para>In the second mode — when <replaceable>OP</replaceable> is specified — it will compare the two
version strings using the operation <replaceable>OP</replaceable> and return <constant>0</constant>
(success) if they condition is satisfied, and <constant>1</constant> (failure)
otherwise. <constant>OP</constant> may be <command>lt</command>, <command>le</command>,
<command>eq</command>, <command>ne</command>, <command>ge</command>, <command>gt</command>. In this
mode, no output is printed.
(This matches the convention used by
<citerefentry project='die-net'><refentrytitle>dpkg</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<option>--compare-versions</option>.)</para>
<example>
<title>Compare versions of a package</title>
<programlisting>
$ systemd-analyze compare-versions systemd-250~rc1.fc36.aarch64 systemd-251.fc36.aarch64
systemd-250~rc1.fc36.aarch64 < systemd-251.fc36.aarch64
$ echo $?
12
$ systemd-analyze compare-versions 1 lt 2; echo $?
0
$ systemd-analyze compare-versions 1 ge 2; echo $?
1
</programlisting>
</example>
</refsect2>
<refsect2>
<title><command>systemd-analyze verify <replaceable>FILE</replaceable>...</command></title>
<para>This command will load unit files and print warnings if any errors are detected. Files specified
on the command line will be loaded, but also any other units referenced by them. A unit's name on disk
can be overridden by specifying an alias after a colon; see below for an example. The full unit search
path is formed by combining the directories for all command line arguments, and the usual unit load
paths. The variable <varname>$SYSTEMD_UNIT_PATH</varname> is supported, and may be used to replace or
augment the compiled in set of unit load paths; see
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. All
units files present in the directories containing the command line arguments will be used in preference
to the other paths. If a template unit without an instance name is specified (e.g.
<filename>foo@.service</filename>), <literal>test_instance</literal> will be used as the instance
name, which can be controlled by <option>--instance=</option> option.</para>
<para>The following errors are currently detected:</para>
<itemizedlist>
<listitem><para>unknown sections and directives,</para></listitem>
<listitem><para>missing dependencies which are required to start the given unit,</para></listitem>
<listitem><para>man pages listed in <varname>Documentation=</varname> which are not found in the
system,</para></listitem>
<listitem><para>commands listed in <varname>ExecStart=</varname> and similar which are not found in
the system or not executable.</para></listitem>
</itemizedlist>
<example>
<title>Misspelt directives</title>
<programlisting>$ cat ./user.slice
[Unit]
WhatIsThis=11
Documentation=man:nosuchfile(1)
Requires=different.service
[Service]
Description=x
$ systemd-analyze verify ./user.slice
[./user.slice:9] Unknown lvalue 'WhatIsThis' in section 'Unit'
[./user.slice:13] Unknown section 'Service'. Ignoring.
Error: org.freedesktop.systemd1.LoadFailed:
Unit different.service failed to load:
No such file or directory.
Failed to create user.slice/start: Invalid argument
user.slice: man nosuchfile(1) command failed with code 16
</programlisting>
</example>
<example>
<title>Missing service units</title>
<programlisting>$ tail ./a.socket ./b.socket
==> ./a.socket <==
[Socket]
ListenStream=100
==> ./b.socket <==
[Socket]
ListenStream=100
Accept=yes
$ systemd-analyze verify ./a.socket ./b.socket
Service a.service not loaded, a.socket cannot be started.
Service b@0.service not loaded, b.socket cannot be started.
</programlisting>
</example>
<example>
<title>Aliasing a unit</title>
<programlisting>$ cat /tmp/source
[Unit]
Description=Hostname printer
[Service]
Type=simple
ExecStart=/usr/bin/echo %H
MysteryKey=true
$ systemd-analyze verify /tmp/source
Failed to prepare filename /tmp/source: Invalid argument
$ systemd-analyze verify /tmp/source:alias.service
alias.service:7: Unknown key name 'MysteryKey' in section 'Service', ignoring.
</programlisting>
</example>
</refsect2>
<refsect2>
<title><command>systemd-analyze security <optional><replaceable>UNIT</replaceable>...</optional></command></title>
<para>This command analyzes the security and sandboxing settings of one or more specified service
units. If at least one unit name is specified the security settings of the specified service units are
inspected and a detailed analysis is shown. If no unit name is specified, all currently loaded,
long-running service units are inspected and a terse table with results shown. The command checks for
various security-related service settings, assigning each a numeric "exposure level" value, depending
on how important a setting is. It then calculates an overall exposure level for the whole unit, which
is an estimation in the range 0.0…10.0 indicating how exposed a service is security-wise. High exposure
levels indicate very little applied sandboxing. Low exposure levels indicate tight sandboxing and
strongest security restrictions. Note that this only analyzes the per-service security features systemd
itself implements. This means that any additional security mechanisms applied by the service code
itself are not accounted for. The exposure level determined this way should not be misunderstood: a
high exposure level neither means that there is no effective sandboxing applied by the service code
itself, nor that the service is actually vulnerable to remote or local attacks. High exposure levels do
indicate however that most likely the service might benefit from additional settings applied to
them.</para>
<para>Please note that many of the security and sandboxing settings individually can be circumvented —
unless combined with others. For example, if a service retains the privilege to establish or undo mount
points many of the sandboxing options can be undone by the service code itself. Due to that is
essential that each service uses the most comprehensive and strict sandboxing and security settings
possible. The tool will take into account some of these combinations and relationships between the
settings, but not all. Also note that the security and sandboxing settings analyzed here only apply to
the operations executed by the service code itself. If a service has access to an IPC system (such as
D-Bus) it might request operations from other services that are not subject to the same
restrictions. Any comprehensive security and sandboxing analysis is hence incomplete if the IPC access
policy is not validated too.</para>
<example>
<title>Analyze <filename index="false">systemd-logind.service</filename></title>
<programlisting>$ systemd-analyze security --no-pager systemd-logind.service
NAME DESCRIPTION EXPOSURE
✗ PrivateNetwork= Service has access to the host's network 0.5
✗ User=/DynamicUser= Service runs as root user 0.4
✗ DeviceAllow= Service has no device ACL 0.2
✓ IPAddressDeny= Service blocks all IP address ranges
...
→ Overall exposure level for systemd-logind.service: 4.1 OK 🙂
</programlisting>
</example>
</refsect2>
<refsect2>
<title><command>systemd-analyze inspect-elf <replaceable>FILE</replaceable>...</command></title>
<para>This command will load the specified files, and if they are ELF objects (executables,
libraries, core files, etc.) it will parse the embedded packaging metadata, if any, and print
it in a table or json format. See the
<ulink url="https://systemd.io/PACKAGE_METADATA_FOR_EXECUTABLE_FILES/">
Package Metadata for Executable Files</ulink> document for more information.</para>
<example>
<title>Print information about a core file as JSON</title>
<programlisting>$ systemd-analyze inspect-elf --json=pretty \
core.fsverity.1000.f77dac5dc161402aa44e15b7dd9dcf97.58561.1637106137000000
{
"elfType" : "coredump",
"elfArchitecture" : "AMD x86-64",
"/home/bluca/git/fsverity-utils/fsverity" : {
"type" : "deb",
"name" : "fsverity-utils",
"version" : "1.3-1",
"buildId" : "7c895ecd2a271f93e96268f479fdc3c64a2ec4ee"
},
"/home/bluca/git/fsverity-utils/libfsverity.so.0" : {
"type" : "deb",
"name" : "fsverity-utils",
"version" : "1.3-1",
"buildId" : "b5e428254abf14237b0ae70ed85fffbb98a78f88"
}
}
</programlisting>
</example>
</refsect2>
<refsect2>
<title><command>systemd-analyze dlopen-metadata <replaceable>FILE</replaceable></command></title>
<para>This command will load the specified file, and if it is an ELF object (executables,
libraries, core files, etc.) it will parse the embedded dlopen metadata, if any, and print
it in a table or json format. See the
<ulink url="https://systemd.io/ELF_DLOPEN_METADATA/">
dlopen() Metadata for ELF Files</ulink> document for more information.</para>
</refsect2>
<refsect2>
<title><command>systemd-analyze fdstore <replaceable>UNIT</replaceable>...</command></title>
<para>Lists the current contents of the specified service unit's file descriptor store. This shows
names, inode types, device numbers, inode numbers, paths and open modes of the open file
descriptors. The specified units must have <varname>FileDescriptorStoreMax=</varname> enabled, see
<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
details.</para>
<example>
<title>Table output</title>
<programlisting>$ systemd-analyze fdstore systemd-journald.service
FDNAME TYPE DEVNO INODE RDEVNO PATH FLAGS
stored sock 0:8 4218620 - socket:[4218620] ro
stored sock 0:8 4213198 - socket:[4213198] ro
stored sock 0:8 4213190 - socket:[4213190] ro
…</programlisting>
</example>
<para>Note: the "DEVNO" column refers to the major/minor numbers of the device node backing the file
system the file descriptor's inode is on. The "RDEVNO" column refers to the major/minor numbers of the
device node itself if the file descriptor refers to one. Compare with corresponding
<varname>.st_dev</varname> and <varname>.st_rdev</varname> fields in <type>struct stat</type> (see
<citerefentry
project='man-pages'><refentrytitle>stat</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
details). The listed inode numbers in the "INODE" column are on the file system indicated by
"DEVNO".</para>
</refsect2>
<refsect2>
<title><command>systemd-analyze image-policy <replaceable>POLICY</replaceable>…</command></title>
<para>This command analyzes the specified image policy string, as per
<citerefentry><refentrytitle>systemd.image-policy</refentrytitle><manvolnum>7</manvolnum></citerefentry>. The
policy is normalized and simplified. For each currently defined partition identifier (as per the <ulink
url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">UAPI.2 Discoverable
Partitions Specification</ulink>) the effect of the image policy string is shown in tabular form.</para>
<example>
<title>Example Output</title>
<programlisting>$ systemd-analyze image-policy swap=encrypted:usr=read-only-on+verity:root=encrypted
Analyzing policy: root=encrypted:usr=verity+read-only-on:swap=encrypted
Long form: root=encrypted:usr=verity+read-only-on:swap=encrypted:=unused+absent
PARTITION MODE READ-ONLY GROWFS
root encrypted - -
usr verity yes -
home ignore - -
srv ignore - -
esp ignore - -
xbootldr ignore - -