{ "content": [ { "type": "text", "text": "# systemd-analyze (man)\n\n## NAME\n\nsystemd-analyze - Analyze and debug system manager\n\n## SYNOPSIS\n\nsystemd-analyze [OPTIONS...] [time]\nsystemd-analyze [OPTIONS...] blame\nsystemd-analyze [OPTIONS...] critical-chain [UNIT...]\nsystemd-analyze [OPTIONS...] dump [PATTERN...]\nsystemd-analyze [OPTIONS...] plot [>file.svg]\nsystemd-analyze [OPTIONS...] dot [PATTERN...] [>file.dot]\nsystemd-analyze [OPTIONS...] unit-files\nsystemd-analyze [OPTIONS...] unit-paths\nsystemd-analyze [OPTIONS...] exit-status [STATUS...]\nsystemd-analyze [OPTIONS...] capability [CAPABILITY...]\nsystemd-analyze [OPTIONS...] condition CONDITION...\nsystemd-analyze [OPTIONS...] syscall-filter [SET...]\nsystemd-analyze [OPTIONS...] filesystems [SET...]\nsystemd-analyze [OPTIONS...] calendar SPEC...\nsystemd-analyze [OPTIONS...] timestamp TIMESTAMP...\nsystemd-analyze [OPTIONS...] timespan SPAN...\nsystemd-analyze [OPTIONS...] cat-config NAME|PATH...\nsystemd-analyze [OPTIONS...] compare-versions VERSION1 [OP] VERSION2\nsystemd-analyze [OPTIONS...] verify FILE...\nsystemd-analyze [OPTIONS...] security [UNIT...]\nsystemd-analyze [OPTIONS...] inspect-elf FILE...\nsystemd-analyze [OPTIONS...] malloc [D-BUS SERVICE...]\nsystemd-analyze [OPTIONS...] fdstore UNIT...\nsystemd-analyze [OPTIONS...] image-policy POLICY...\nsystemd-analyze [OPTIONS...] pcrs [PCR...]\nsystemd-analyze [OPTIONS...] srk > FILE\n\n## DESCRIPTION\n\nsystemd-analyze may be used to determine system boot-up performance statistics and retrieve\nother state and tracing information from the system and service manager, and to verify the\ncorrectness of unit files. It is also used to access special functions useful for advanced\nsystem manager debugging.\n\n## TLDR\n\n> Analyze and debug system manager.\n\n- Print the last system startup time:\n `systemd-analyze`\n- List all running units, ordered by the time they took to initialize:\n `systemd-analyze blame`\n- Print a tree of the time-critical chain of bootup units:\n `systemd-analyze critical-chain`\n- Create an SVG file showing when each system service started, highlighting the time that they spent on initialization:\n `systemd-analyze plot > {{path/to/file.svg}}`\n- Plot a dependency graph and convert it to an SVG file:\n `systemd-analyze dot | dot -T {{svg}} > {{path/to/file.svg}}`\n- Show security scores of running units:\n `systemd-analyze security`\n- View all udev rules together without showing comments:\n `systemd-analyze cat-config udev/rules.d --tldr`\n\n*Source: tldr-pages*\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION** (30 subsections)\n- **OPTIONS** (14 subsections)\n- **EXIT STATUS**\n- **ENVIRONMENT**\n- **EXAMPLES** (2 subsections)\n- **SEE ALSO**\n- **NOTES**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "systemd-analyze", "section": "", "mode": "man", "summary": "systemd-analyze - Analyze and debug system manager", "synopsis": "systemd-analyze [OPTIONS...] [time]\nsystemd-analyze [OPTIONS...] blame\nsystemd-analyze [OPTIONS...] critical-chain [UNIT...]\nsystemd-analyze [OPTIONS...] dump [PATTERN...]\nsystemd-analyze [OPTIONS...] plot [>file.svg]\nsystemd-analyze [OPTIONS...] dot [PATTERN...] [>file.dot]\nsystemd-analyze [OPTIONS...] unit-files\nsystemd-analyze [OPTIONS...] unit-paths\nsystemd-analyze [OPTIONS...] exit-status [STATUS...]\nsystemd-analyze [OPTIONS...] capability [CAPABILITY...]\nsystemd-analyze [OPTIONS...] condition CONDITION...\nsystemd-analyze [OPTIONS...] syscall-filter [SET...]\nsystemd-analyze [OPTIONS...] filesystems [SET...]\nsystemd-analyze [OPTIONS...] calendar SPEC...\nsystemd-analyze [OPTIONS...] timestamp TIMESTAMP...\nsystemd-analyze [OPTIONS...] timespan SPAN...\nsystemd-analyze [OPTIONS...] cat-config NAME|PATH...\nsystemd-analyze [OPTIONS...] compare-versions VERSION1 [OP] VERSION2\nsystemd-analyze [OPTIONS...] verify FILE...\nsystemd-analyze [OPTIONS...] security [UNIT...]\nsystemd-analyze [OPTIONS...] inspect-elf FILE...\nsystemd-analyze [OPTIONS...] malloc [D-BUS SERVICE...]\nsystemd-analyze [OPTIONS...] fdstore UNIT...\nsystemd-analyze [OPTIONS...] image-policy POLICY...\nsystemd-analyze [OPTIONS...] pcrs [PCR...]\nsystemd-analyze [OPTIONS...] srk > FILE", "tldr_summary": "Analyze and debug system manager.", "tldr_examples": [ { "description": "Print the last system startup time", "command": "systemd-analyze" }, { "description": "List all running units, ordered by the time they took to initialize", "command": "systemd-analyze blame" }, { "description": "Print a tree of the time-critical chain of bootup units", "command": "systemd-analyze critical-chain" }, { "description": "Create an SVG file showing when each system service started, highlighting the time that they spent on initialization", "command": "systemd-analyze plot > {{path/to/file.svg}}" }, { "description": "Plot a dependency graph and convert it to an SVG file", "command": "systemd-analyze dot | dot -T {{svg}} > {{path/to/file.svg}}" }, { "description": "Show security scores of running units", "command": "systemd-analyze security" }, { "description": "View all udev rules together without showing comments", "command": "systemd-analyze cat-config udev/rules.d --tldr" } ], "tldr_source": "official", "flags": [ { "flag": "", "long": "--system", "arg": null, "description": "Operates on the system systemd instance. This is the implied default. Added in version 209." }, { "flag": "", "long": "--user", "arg": null, "description": "Operates on the user systemd instance. Added in version 186." }, { "flag": "", "long": "--global", "arg": null, "description": "Operates on the system-wide configuration for user systemd instance. Added in version 238. --order, --require When used in conjunction with the dot command (see above), selects which dependencies are shown in the dependency graph. If --order is passed, only dependencies of type After= or Before= are shown. If --require is passed, only dependencies of type Requires=, Requisite=, Wants= and Conflicts= are shown. If neither is passed, this shows dependencies of all these types. Added in version 198. --from-pattern=, --to-pattern= When used in conjunction with the dot command (see above), this selects which relationships are shown in the dependency graph. Both options require a glob(7) pattern as an argument, which will be matched against the left-hand and the right-hand, respectively, nodes of a relationship. Each of these can be used more than once, in which case the unit name must match one of the values. When tests for both sides of the relation are present, a relation must pass both tests to be shown. When patterns are also specified as positional arguments, they must match at least one side of the relation. In other words, patterns specified with those two options will trim the list of edges matched by the positional arguments, if any are given, and fully determine the list of edges shown otherwise. Added in version 201. --fuzz=timespan When used in conjunction with the critical-chain command (see above), also show units, which finished timespan earlier, than the latest unit in the same level. The unit of timespan is seconds unless specified with a different unit, e.g. \"50ms\". Added in version 203." }, { "flag": "", "long": "--man", "arg": "no", "description": "Do not invoke man(1) to verify the existence of man pages listed in Documentation=. Added in version 235." }, { "flag": "", "long": "--generators", "arg": null, "description": "Invoke unit generators, see systemd.generator(7). Some generators require root privileges. Under a normal user, running with generators enabled will generally result in some warnings. Added in version 235. --recursive-errors=MODE Control verification of units and their dependencies and whether systemd-analyze verify exits with a non-zero process exit status or not. With yes, return a non-zero process exit status when warnings arise during verification of either the specified unit or any of its associated dependencies. With no, return a non-zero process exit status when warnings arise during verification of only the specified unit. With one, return a non-zero process exit status when warnings arise during verification of either the specified unit or its immediate dependencies. If this option is not specified, zero is returned as the exit status regardless whether warnings arise during verification or not. Added in version 250. --root=PATH With cat-files and verify, operate on files underneath the specified root path PATH. Added in version 239. --image=PATH With cat-files and verify, operate on files inside the specified image path PATH. Added in version 250. --image-policy=policy Takes an image policy string as argument, as per systemd.image-policy(7). The policy is enforced when operating on the disk image specified via --image=, see above. If not specified defaults to the \"*\" policy, i.e. all recognized file systems in the image are used. --offline=BOOL With security, perform an offline security review of the specified unit files, i.e. does not have to rely on PID 1 to acquire security information for the files like the security verb when used by itself does. This means that --offline= can be used with --root= and --image= as well. If a unit's overall exposure level is above that set by --threshold= (default value is 100), --offline= will return an error. Added in version 250. --profile=PATH With security --offline=, takes into consideration the specified portable profile when assessing unit settings. The profile can be passed by name, in which case the well-known system locations will be searched, or it can be the full path to a specific drop-in file. Added in version 250. --threshold=NUMBER With security, allow the user to set a custom value to compare the overall exposure level with, for the specified unit files. If a unit's overall exposure level, is greater than that set by the user, security will return an error. --threshold= can be used with --offline= as well and its default value is 100. Added in version 250. --security-policy=PATH With security, allow the user to define a custom set of requirements formatted as a JSON file against which to compare the specified unit file(s) and determine their overall exposure level to security threats. Table 1. Accepted Assessment Test Identifiers ┌──────────────────────────────────────────────────────────┐ │ Assessment Test Identifier │ ├──────────────────────────────────────────────────────────┤ │ UserOrDynamicUser │ ├──────────────────────────────────────────────────────────┤ │ SupplementaryGroups │ ├──────────────────────────────────────────────────────────┤ │ PrivateMounts │ ├──────────────────────────────────────────────────────────┤ │ PrivateDevices │ ├──────────────────────────────────────────────────────────┤ │ PrivateTmp │ ├──────────────────────────────────────────────────────────┤ │ PrivateNetwork │ ├──────────────────────────────────────────────────────────┤ │ PrivateUsers │ ├──────────────────────────────────────────────────────────┤ │ ProtectControlGroups │ ├──────────────────────────────────────────────────────────┤ │ ProtectKernelModules │ ├──────────────────────────────────────────────────────────┤ │ ProtectKernelTunables │ ├──────────────────────────────────────────────────────────┤ │ ProtectKernelLogs │ ├──────────────────────────────────────────────────────────┤ │ ProtectClock │ ├──────────────────────────────────────────────────────────┤ │ ProtectHome │ ├──────────────────────────────────────────────────────────┤ │ ProtectHostname │ ├──────────────────────────────────────────────────────────┤ │ ProtectSystem │ ├──────────────────────────────────────────────────────────┤ │ RootDirectoryOrRootImage │ ├──────────────────────────────────────────────────────────┤ │ LockPersonality │ ├──────────────────────────────────────────────────────────┤ │ MemoryDenyWriteExecute │ ├──────────────────────────────────────────────────────────┤ │ NoNewPrivileges │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPSYSADMIN │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPSETUIDGIDPCAP │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPSYSPTRACE │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPSYSTIME │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPNETADMIN │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPSYSRAWIO │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPSYSMODULE │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPAUDIT │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPSYSLOG │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPSYSNICERESOURCE │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPMKNOD │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPCHOWNFSETIDSETFCAP │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPDACFOWNERIPCOWNER │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPKILL │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPNETBINDSERVICEBROADCASTRAW │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPSYSBOOT │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPMAC │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPLINUXIMMUTABLE │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPIPCLOCK │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPSYSCHROOT │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPBLOCKSUSPEND │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPWAKEALARM │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPLEASE │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPSYSTTYCONFIG │ ├──────────────────────────────────────────────────────────┤ │ CapabilityBoundingSetCAPBPF │ ├──────────────────────────────────────────────────────────┤ │ UMask │ ├──────────────────────────────────────────────────────────┤ │ KeyringMode │ ├──────────────────────────────────────────────────────────┤ │ ProtectProc │ ├──────────────────────────────────────────────────────────┤ │ ProcSubset │ ├──────────────────────────────────────────────────────────┤ │ NotifyAccess │ ├──────────────────────────────────────────────────────────┤ │ RemoveIPC │ ├──────────────────────────────────────────────────────────┤ │ Delegate │ ├──────────────────────────────────────────────────────────┤ │ RestrictRealtime │ ├──────────────────────────────────────────────────────────┤ │ RestrictSUIDSGID │ ├──────────────────────────────────────────────────────────┤ │ RestrictNamespacesuser │ ├──────────────────────────────────────────────────────────┤ │ RestrictNamespacesmnt │ ├──────────────────────────────────────────────────────────┤ │ RestrictNamespacesipc │ ├──────────────────────────────────────────────────────────┤ │ RestrictNamespacespid │ ├──────────────────────────────────────────────────────────┤ │ RestrictNamespacescgroup │ ├──────────────────────────────────────────────────────────┤ │ RestrictNamespacesuts │ ├──────────────────────────────────────────────────────────┤ │ RestrictNamespacesnet │ ├──────────────────────────────────────────────────────────┤ │ RestrictAddressFamiliesAFINETINET6 │ ├──────────────────────────────────────────────────────────┤ │ RestrictAddressFamiliesAFUNIX │ ├──────────────────────────────────────────────────────────┤ │ RestrictAddressFamiliesAFNETLINK │ ├──────────────────────────────────────────────────────────┤ │ RestrictAddressFamiliesAFPACKET │ ├──────────────────────────────────────────────────────────┤ │ RestrictAddressFamiliesOTHER │ ├──────────────────────────────────────────────────────────┤ │ SystemCallArchitectures │ ├──────────────────────────────────────────────────────────┤ │ SystemCallFilterswap │ ├──────────────────────────────────────────────────────────┤ │ SystemCallFilterobsolete │ ├──────────────────────────────────────────────────────────┤ │ SystemCallFilterclock │ ├──────────────────────────────────────────────────────────┤ │ SystemCallFiltercpuemulation │ ├──────────────────────────────────────────────────────────┤ │ SystemCallFilterdebug │ ├──────────────────────────────────────────────────────────┤ │ SystemCallFiltermount │ ├──────────────────────────────────────────────────────────┤ │ SystemCallFiltermodule │ ├──────────────────────────────────────────────────────────┤ │ SystemCallFilterrawio │ ├──────────────────────────────────────────────────────────┤ │ SystemCallFilterreboot │ ├──────────────────────────────────────────────────────────┤ │ SystemCallFilterprivileged │ ├──────────────────────────────────────────────────────────┤ │ SystemCallFilterresources │ ├──────────────────────────────────────────────────────────┤ │ IPAddressDeny │ ├──────────────────────────────────────────────────────────┤ │ DeviceAllow │ ├──────────────────────────────────────────────────────────┤ │ AmbientCapabilities │ └──────────────────────────────────────────────────────────┘ See example \"JSON Policy\" below. Added in version 250. --json=MODE With the security command, generate a JSON formatted output of the security analysis table. The format is a JSON array with objects containing the following fields: set which indicates if the setting has been enabled or not, name which is what is used to refer to the setting, jsonfield which is the JSON compatible identifier of the setting, description which is an outline of the setting state, and exposure which is a number in the range 0.0...10.0, where a higher value corresponds to a higher security threat. The JSON version of the table is printed to standard output. The MODE passed to the option can be one of three: off which is the default, pretty and short which respectively output a prettified or shorted JSON version of the security table. With the plot command, generate a JSON formatted output of the raw time data. The format is a JSON array with objects containing the following fields: name which is the unit name, activated which is the time after startup the service was activated, activating which is how long after startup the service was initially started, time which is how long the service took to activate from when it was initially started, deactivated which is the time after startup that the service was deactivated, deactivating which is the time after startup that the service was initially told to deactivate. Added in version 250. --iterations=NUMBER When used with the calendar command, show the specified number of iterations the specified calendar expression will elapse next. Defaults to 1. Added in version 242. --base-time=TIMESTAMP When used with the calendar command, show next iterations relative to the specified point in time. If not specified defaults to the current time. Added in version 244. --unit=UNIT When used with the condition command, evaluate all the Condition*=... and Assert*=... assignments in the specified unit file. The full unit search path is formed by combining the directories for the specified unit with the usual unit load paths. The variable $SYSTEMDUNITPATH is supported, and may be used to replace or augment the compiled in set of unit load paths; see systemd.unit(5). All units files present in the directory containing the specified unit will be used in preference to the other paths. Added in version 250." }, { "flag": "", "long": "--table", "arg": null, "description": "When used with the plot command, the raw time data is output in a table. Added in version 253." }, { "flag": "", "long": "--no-legend", "arg": null, "description": "When used with the plot command in combination with either --table or --json=, no legends or hints are included in the output. Added in version 253." }, { "flag": "-H", "long": null, "arg": null, "description": "Execute the operation remotely. Specify a hostname, or a username and hostname separated by \"@\", to connect to. The hostname may optionally be suffixed by a port ssh is listening on, separated by \":\", and then a container name, separated by \"/\", which connects directly to a specific container on the specified host. This will use SSH to talk to the remote machine manager instance. Container names may be enumerated with machinectl -H HOST. Put IPv6 addresses in brackets." }, { "flag": "-M", "long": null, "arg": null, "description": "Execute operation on a local container. Specify a container name to connect to, optionally prefixed by a user name to connect as and a separating \"@\" character. If the special string \".host\" is used in place of the container name, a connection to the local system is made (which is useful to connect to a specific user's user bus: \"--user --machine=lennart@.host\"). If the \"@\" syntax is not used, the connection is made as root user. If the \"@\" syntax is used either the left hand side or the right hand side may be omitted (but not both) in which case the local user name and \".host\" are implied." }, { "flag": "-q", "long": "--quiet", "arg": null, "description": "Suppress hints and other non-essential output. Added in version 250." }, { "flag": "", "long": "--tldr", "arg": null, "description": "With cat-config, only print the \"interesting\" parts of the configuration files, skipping comments and empty lines and section headers followed only by comments and empty lines. Added in version 255." }, { "flag": "-h", "long": "--help", "arg": null, "description": "Print a short help text and exit." }, { "flag": "", "long": "--version", "arg": null, "description": "Print a short version string and exit." }, { "flag": "", "long": "--no-pager", "arg": null, "description": "Do not pipe output into a pager." } ], "examples": [ "The JSON file passed as a path parameter to --security-policy= has a top-level JSON object,", "with keys being the assessment test identifiers mentioned above. The values in the file", "should be JSON objects with one or more of the following fields: descriptionna (string),", "(unsigned integer). If any of these fields corresponding to a specific id of the unit file is", "missing from the JSON object, the default built-in field value corresponding to that same id", "is used for security analysis as default. The weight and range fields are used in determining", "the overall exposure level of the unit files: the value of each setting is assigned a badness", "score, which is multiplied by the policy weight and divided by the policy range to determine", "the overall exposure that the setting implies. The computed badness is summed across all", "settings in the unit file, normalized to the 1...100 range, and used to determine the overall", "exposure level of the unit. By allowing users to manipulate these fields, the 'security' verb", "gives them the option to decide for themself which ids are more important and hence should", "have a greater effect on the exposure level. A weight of \"0\" means the setting will not be", "checked.", "\"PrivateDevices\":", "\"descriptiongood\": \"Service has no access to hardware devices\",", "\"descriptionbad\": \"Service potentially has access to hardware devices\",", "\"weight\": 1000,", "\"range\": 1", "},", "\"PrivateMounts\":", "\"descriptiongood\": \"Service cannot install system mounts\",", "\"descriptionbad\": \"Service may install system mounts\",", "\"weight\": 1000,", "\"range\": 1", "},", "\"PrivateNetwork\":", "\"descriptiongood\": \"Service has no access to the host's network\",", "\"descriptionbad\": \"Service has access to the host's network\",", "\"weight\": 2500,", "\"range\": 1", "},", "\"PrivateTmp\":", "\"descriptiongood\": \"Service has no access to other software's temporary files\",", "\"descriptionbad\": \"Service has access to other software's temporary files\",", "\"weight\": 1000,", "\"range\": 1", "},", "\"PrivateUsers\":", "\"descriptiongood\": \"Service does not have access to other users\",", "\"descriptionbad\": \"Service has access to other users\",", "\"weight\": 1000,", "\"range\": 1" ], "see_also": [ { "name": "systemd", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/systemd/1/json" }, { "name": "systemctl", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/systemctl/1/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 52, "subsections": [] }, { "name": "DESCRIPTION", "lines": 7, "subsections": [ { "name": "systemd-analyze time", "lines": 6 }, { "name": "Example 1. Show how long the boot took", "lines": 10 }, { "name": "systemd-analyze blame", "lines": 13 }, { "name": "Example 2. Show which units took the most time during boot", "lines": 21 }, { "name": "Example 3. systemd-analyze critical-chain", "lines": 21 }, { "name": "Example 4. Show the internal state of user manager", "lines": 23 }, { "name": "systemd-analyze plot", "lines": 4 }, { "name": "Example 5. Plot a bootchart", "lines": 14 }, { "name": "-Tsvg >systemd.svg --order --require", "lines": 5, "long": "--require" }, { "name": "Example 6. Plot all dependencies of any unit whose name starts with \"avahi-daemon\"", "lines": 3 }, { "name": "Example 7. Plot the dependencies between all known target units", "lines": 4 }, { "name": "systemd-analyze unit-paths", "lines": 4 }, { "name": "Example 8. Show all paths for generated units", "lines": 22 }, { "name": "Example 9. Show some example exit status names", "lines": 16 }, { "name": "Example 10. Show some example capability names", "lines": 13 }, { "name": "Example 11. Evaluate conditions that check kernel versions", "lines": 29 }, { "name": "Example 12. Show leap days in the near future", "lines": 19 }, { "name": "Example 13. Show parsing of timestamps", "lines": 25 }, { "name": "Example 14. Show parsing of timespans", "lines": 20 }, { "name": "Example 15. Showing logind configuration", "lines": 31 }, { "name": "Example 16. Compare versions of a package", "lines": 32 }, { "name": "Example 17. Misspelt directives", "lines": 19 }, { "name": "Example 18. Missing service units", "lines": 15 }, { "name": "Example 19. Aliasing a unit", "lines": 46 }, { "name": "Example 20. Analyze systemd-logind.service", "lines": 15 }, { "name": "Example 21. Print information about a core file as JSON", "lines": 26 }, { "name": "Example 22. Table output", "lines": 19 }, { "name": "Example 23. Example Output", "lines": 23 }, { "name": "Example 24. Example Output", "lines": 27 }, { "name": "systemd-analyze srk > \u001b[4mFILE", "lines": 5 } ] }, { "name": "OPTIONS", "lines": 2, "subsections": [ { "name": "--system", "lines": 4, "long": "--system" }, { "name": "--user", "lines": 4, "long": "--user" }, { "name": "--global", "lines": 35, "long": "--global" }, { "name": "--man=no", "lines": 4, "long": "--man", "arg": "no" }, { "name": "--generators", "lines": 274, "long": "--generators" }, { "name": "--table", "lines": 4, "long": "--table" }, { "name": "--no-legend", "lines": 5, "long": "--no-legend" }, { "name": "-H --host=", "lines": 7, "flag": "-H" }, { "name": "-M --machine=", "lines": 8, "flag": "-M" }, { "name": "-q --quiet", "lines": 4, "flag": "-q", "long": "--quiet" }, { "name": "--tldr", "lines": 5, "long": "--tldr" }, { "name": "-h --help", "lines": 2, "flag": "-h", "long": "--help" }, { "name": "--version", "lines": 2, "long": "--version" }, { "name": "--no-pager", "lines": 2, "long": "--no-pager" } ] }, { "name": "EXIT STATUS", "lines": 6, "subsections": [] }, { "name": "ENVIRONMENT", "lines": 112, "subsections": [] }, { "name": "EXAMPLES", "lines": 1, "subsections": [ { "name": "Example 25. JSON Policy", "lines": 3 }, { "name": "description_good (string), description_bad (string),", "lines": 51 } ] }, { "name": "SEE ALSO", "lines": 2, "subsections": [] }, { "name": "NOTES", "lines": 7, "subsections": [] } ], "sections": { "NAME": { "content": "systemd-analyze - Analyze and debug system manager\n", "subsections": [] }, "SYNOPSIS": { "content": "systemd-analyze [OPTIONS...] [time]\n\nsystemd-analyze [OPTIONS...] blame\n\nsystemd-analyze [OPTIONS...] critical-chain [UNIT...]\n\nsystemd-analyze [OPTIONS...] dump [PATTERN...]\n\nsystemd-analyze [OPTIONS...] plot [>file.svg]\n\nsystemd-analyze [OPTIONS...] dot [PATTERN...] [>file.dot]\n\nsystemd-analyze [OPTIONS...] unit-files\n\nsystemd-analyze [OPTIONS...] unit-paths\n\nsystemd-analyze [OPTIONS...] exit-status [STATUS...]\n\nsystemd-analyze [OPTIONS...] capability [CAPABILITY...]\n\nsystemd-analyze [OPTIONS...] condition CONDITION...\n\nsystemd-analyze [OPTIONS...] syscall-filter [SET...]\n\nsystemd-analyze [OPTIONS...] filesystems [SET...]\n\nsystemd-analyze [OPTIONS...] calendar SPEC...\n\nsystemd-analyze [OPTIONS...] timestamp TIMESTAMP...\n\nsystemd-analyze [OPTIONS...] timespan SPAN...\n\nsystemd-analyze [OPTIONS...] cat-config NAME|PATH...\n\nsystemd-analyze [OPTIONS...] compare-versions VERSION1 [OP] VERSION2\n\nsystemd-analyze [OPTIONS...] verify FILE...\n\nsystemd-analyze [OPTIONS...] security [UNIT...]\n\nsystemd-analyze [OPTIONS...] inspect-elf FILE...\n\nsystemd-analyze [OPTIONS...] malloc [D-BUS SERVICE...]\n\nsystemd-analyze [OPTIONS...] fdstore UNIT...\n\nsystemd-analyze [OPTIONS...] image-policy POLICY...\n\nsystemd-analyze [OPTIONS...] pcrs [PCR...]\n\nsystemd-analyze [OPTIONS...] srk > FILE\n", "subsections": [] }, "DESCRIPTION": { "content": "systemd-analyze may be used to determine system boot-up performance statistics and retrieve\nother state and tracing information from the system and service manager, and to verify the\ncorrectness of unit files. It is also used to access special functions useful for advanced\nsystem manager debugging.\n\nIf no command is passed, systemd-analyze time is implied.\n", "subsections": [ { "name": "systemd-analyze time", "content": "This command prints the time spent in the kernel before userspace has been reached, the time\nspent in the initrd before normal system userspace has been reached, and the time normal\nsystem userspace took to initialize. Note that these measurements simply measure the time\npassed up to the point where all system services have been spawned, but not necessarily until\nthey fully finished initialization or the disk is idle.\n" }, { "name": "Example 1. Show how long the boot took", "content": "# in a container\n$ systemd-analyze time\nStartup finished in 296ms (userspace)\nmulti-user.target reached after 275ms in userspace\n\n# on a real machine\n$ systemd-analyze time\nStartup finished in 2.584s (kernel) + 19.176s (initrd) + 47.847s (userspace) = 1min 9.608s\nmulti-user.target reached after 47.820s in userspace\n" }, { "name": "systemd-analyze blame", "content": "This command prints a list of all running units, ordered by the time they took to initialize.\nThis information may be used to optimize boot-up times. Note that the output might be\nmisleading as the initialization of one service might be slow simply because it waits for the\ninitialization of another service to complete. Also note: systemd-analyze blame doesn't\ndisplay results for services with Type=simple, because systemd considers such services to be\nstarted immediately, hence no measurement of the initialization delays can be done. Also note\nthat this command only shows the time units took for starting up, it does not show how long\nunit jobs spent in the execution queue. In particular it shows the time units spent in\n\"activating\" state, which is not defined for units such as device units that transition\ndirectly from \"inactive\" to \"active\". This command hence gives an impression of the\nperformance of program code, but cannot accurately reflect latency introduced by waiting for\nhardware and similar events.\n" }, { "name": "Example 2. Show which units took the most time during boot", "content": "$ systemd-analyze blame\n32.875s pmlogger.service\n20.905s systemd-networkd-wait-online.service\n13.299s dev-vda1.device\n...\n23ms sysroot.mount\n11ms initrd-udevadm-cleanup-db.service\n3ms sys-kernel-config.mount\n\n\nsystemd-analyze critical-chain [UNIT...]\nThis command prints a tree of the time-critical chain of units (for each of the specified\nUNITs or for the default target otherwise). The time after the unit is active or started is\nprinted after the \"@\" character. The time the unit takes to start is printed after the \"+\"\ncharacter. Note that the output might be misleading as the initialization of services might\ndepend on socket activation and because of the parallel execution of units. Also, similarly\nto the blame command, this only takes into account the time units spent in \"activating\"\nstate, and hence does not cover units that never went through an \"activating\" state (such as\ndevice units that transition directly from \"inactive\" to \"active\"). Moreover it does not show\ninformation on jobs (and in particular not jobs that timed out).\n" }, { "name": "Example 3. systemd-analyze critical-chain", "content": "$ systemd-analyze critical-chain\nmulti-user.target @47.820s\n└─pmie.service @35.968s +548ms\n└─pmcd.service @33.715s +2.247s\n└─network-online.target @33.712s\n└─systemd-networkd-wait-online.service @12.804s +20.905s\n└─systemd-networkd.service @11.109s +1.690s\n└─systemd-udevd.service @9.201s +1.904s\n└─systemd-tmpfiles-setup-dev.service @7.306s +1.776s\n└─kmod-static-nodes.service @6.976s +177ms\n└─systemd-journald.socket\n└─system.slice\n└─-.slice\n\nsystemd-analyze dump [pattern...]\nWithout any parameter, this command outputs a (usually very long) human-readable\nserialization of the complete service manager state. Optional glob pattern may be specified,\ncausing the output to be limited to units whose names match one of the patterns. The output\nformat is subject to change without notice and should not be parsed by applications. This\ncommand is rate limited for unprivileged users.\n" }, { "name": "Example 4. Show the internal state of user manager", "content": "$ systemd-analyze --user dump\nTimestamp userspace: Thu 2019-03-14 23:28:07 CET\nTimestamp finish: Thu 2019-03-14 23:28:07 CET\nTimestamp generators-start: Thu 2019-03-14 23:28:07 CET\nTimestamp generators-finish: Thu 2019-03-14 23:28:07 CET\nTimestamp units-load-start: Thu 2019-03-14 23:28:07 CET\nTimestamp units-load-finish: Thu 2019-03-14 23:28:07 CET\n-> Unit proc-timerlist.mount:\nDescription: /proc/timerlist\n...\n-> Unit default.target:\nDescription: Main user target\n...\n\nsystemd-analyze malloc [D-Bus service...]\nThis command can be used to request the output of the internal memory state (as returned by\nmallocinfo(3)) of a D-Bus service. If no service is specified, the query will be sent to\norg.freedesktop.systemd1 (the system or user service manager). The output format is not\nguaranteed to be stable and should not be parsed by applications.\n\nThe service must implement the org.freedesktop.MemoryAllocation1 interface. In the systemd\nsuite, it is currently only implemented by the manager.\n" }, { "name": "systemd-analyze plot", "content": "This command prints either an SVG graphic, detailing which system services have been started\nat what time, highlighting the time they spent on initialization, or the raw time data in\nJSON or table format.\n" }, { "name": "Example 5. Plot a bootchart", "content": "$ systemd-analyze plot >bootup.svg\n$ eog bootup.svg&\n\nNote that this plot is based on the most recent per-unit timing data of loaded units. This\nmeans that if a unit gets started, then stopped and then started again the information shown\nwill cover the most recent start cycle, not the first one. Thus it's recommended to consult\nthis information only shortly after boot, so that this distinction doesn't matter. Moreover,\nunits that are not referenced by any other unit through a dependency might be unloaded by the\nservice manager once they terminate (and did not fail). Such units will not show up in the\nplot.\n\nsystemd-analyze dot [pattern...]\nThis command generates textual dependency graph description in dot format for further\nprocessing with the GraphViz dot(1) tool. Use a command line like systemd-analyze dot | dot" }, { "name": "-Tsvg >systemd.svg --order --require", "content": "passed, the generated graph will show both ordering and requirement dependencies. Optional\npattern globbing style specifications (e.g. *.target) may be given at the end. A unit\ndependency is included in the graph if any of these patterns match either the origin or\ndestination node.\n", "long": "--require" }, { "name": "Example 6. Plot all dependencies of any unit whose name starts with \"avahi-daemon\"", "content": "$ systemd-analyze dot 'avahi-daemon.*' | dot -Tsvg >avahi.svg\n$ eog avahi.svg\n" }, { "name": "Example 7. Plot the dependencies between all known target units", "content": "$ systemd-analyze dot --to-pattern='*.target' --from-pattern='*.target' \\\n| dot -Tsvg >targets.svg\n$ eog targets.svg\n" }, { "name": "systemd-analyze unit-paths", "content": "This command outputs a list of all directories from which unit files, .d overrides, and\n.wants, .requires symlinks may be loaded. Combine with --user to retrieve the list for the\nuser manager instance, and --global for the global configuration of user manager instances.\n" }, { "name": "Example 8. Show all paths for generated units", "content": "$ systemd-analyze unit-paths | grep '^/run'\n/run/systemd/system.control\n/run/systemd/transient\n/run/systemd/generator.early\n/run/systemd/system\n/run/systemd/system.attached\n/run/systemd/generator\n/run/systemd/generator.late\n\nNote that this verb prints the list that is compiled into systemd-analyze itself, and does\nnot communicate with the running manager. Use\n\nsystemctl [--user] [--global] show -p UnitPath --value\n\nto retrieve the actual list that the manager uses, with any empty directories omitted.\n\nsystemd-analyze exit-status [STATUS...]\nThis command prints a list of exit statuses along with their \"class\", i.e. the source of the\ndefinition (one of \"glibc\", \"systemd\", \"LSB\", or \"BSD\"), see the Process Exit Codes section\nin systemd.exec(5). If no additional arguments are specified, all known statuses are shown.\nOtherwise, only the definitions for the specified codes are shown.\n" }, { "name": "Example 9. Show some example exit status names", "content": "$ systemd-analyze exit-status 0 1 {63..65}\nNAME STATUS CLASS\nSUCCESS 0 glibc\nFAILURE 1 glibc\n- 63 -\nUSAGE 64 BSD\nDATAERR 65 BSD\n\nsystemd-analyze capability [CAPABILITY...]\nThis command prints a list of Linux capabilities along with their numeric IDs. See\ncapabilities(7) for details. If no argument is specified the full list of capabilities known\nto the service manager and the kernel is shown. Capabilities defined by the kernel but not\nknown to the service manager are shown as \"cap???\". Optionally, if arguments are specified\nthey may refer to specific cabilities by name or numeric ID, in which case only the indicated\ncapabilities are shown in the table.\n" }, { "name": "Example 10. Show some example capability names", "content": "$ systemd-analyze capability 0 1 {30..32}\nNAME NUMBER\ncapchown 0\ncapdacoverride 1\ncapauditcontrol 30\ncapsetfcap 31\ncapmacoverride 32\n\nsystemd-analyze condition CONDITION...\nThis command will evaluate Condition*=... and Assert*=... assignments, and print their\nvalues, and the resulting value of the combined condition set. See systemd.unit(5) for a list\nof available conditions and asserts.\n" }, { "name": "Example 11. Evaluate conditions that check kernel versions", "content": "$ systemd-analyze condition 'ConditionKernelVersion = ! <4.0' \\\n'ConditionKernelVersion = >=5.1' \\\n'ConditionACPower=|false' \\\n'ConditionArchitecture=|!arm' \\\n'AssertPathExists=/etc/os-release'\ntest.service: AssertPathExists=/etc/os-release succeeded.\nAsserts succeeded.\ntest.service: ConditionArchitecture=|!arm succeeded.\ntest.service: ConditionACPower=|false failed.\ntest.service: ConditionKernelVersion=>=5.1 succeeded.\ntest.service: ConditionKernelVersion=!<4.0 succeeded.\nConditions succeeded.\n\nsystemd-analyze syscall-filter [SET...]\nThis command will list system calls contained in the specified system call set SET, or all\nknown sets if no sets are specified. Argument SET must include the \"@\" prefix.\n\nsystemd-analyze filesystems [SET...]\nThis command will list filesystems in the specified filesystem set SET, or all known sets if\nno sets are specified. Argument SET must include the \"@\" prefix.\n\nsystemd-analyze calendar EXPRESSION...\nThis command will parse and normalize repetitive calendar time events, and will calculate\nwhen they elapse next. This takes the same input as the OnCalendar= setting in\nsystemd.timer(5), following the syntax described in systemd.time(7). By default, only the\nnext time the calendar expression will elapse is shown; use --iterations= to show the\nspecified number of next times the expression elapses. Each time the expression elapses forms\na timestamp, see the timestamp verb below.\n" }, { "name": "Example 12. Show leap days in the near future", "content": "$ systemd-analyze calendar --iterations=5 '*-2-29 0:0:0'\nOriginal form: *-2-29 0:0:0\nNormalized form: *-02-29 00:00:00\nNext elapse: Sat 2020-02-29 00:00:00 UTC\nFrom now: 11 months 15 days left\nIter. #2: Thu 2024-02-29 00:00:00 UTC\nFrom now: 4 years 11 months left\nIter. #3: Tue 2028-02-29 00:00:00 UTC\nFrom now: 8 years 11 months left\nIter. #4: Sun 2032-02-29 00:00:00 UTC\nFrom now: 12 years 11 months left\nIter. #5: Fri 2036-02-29 00:00:00 UTC\nFrom now: 16 years 11 months left\n\nsystemd-analyze timestamp TIMESTAMP...\nThis command parses a timestamp (i.e. a single point in time) and outputs the normalized form\nand the difference between this timestamp and now. The timestamp should adhere to the syntax\ndocumented in systemd.time(7), section \"PARSING TIMESTAMPS\".\n" }, { "name": "Example 13. Show parsing of timestamps", "content": "$ systemd-analyze timestamp yesterday now tomorrow\nOriginal form: yesterday\nNormalized form: Mon 2019-05-20 00:00:00 CEST\n(in UTC): Sun 2019-05-19 22:00:00 UTC\nUNIX seconds: @15583032000\nFrom now: 1 day 9h ago\n\nOriginal form: now\nNormalized form: Tue 2019-05-21 09:48:39 CEST\n(in UTC): Tue 2019-05-21 07:48:39 UTC\nUNIX seconds: @1558424919.659757\nFrom now: 43us ago\n\nOriginal form: tomorrow\nNormalized form: Wed 2019-05-22 00:00:00 CEST\n(in UTC): Tue 2019-05-21 22:00:00 UTC\nUNIX seconds: @15584760000\nFrom now: 14h left\n\nsystemd-analyze timespan EXPRESSION...\nThis command parses a time span (i.e. a difference between two timestamps) and outputs the\nnormalized form and the equivalent value in microseconds. The time span should adhere to the\nsyntax documented in systemd.time(7), section \"PARSING TIME SPANS\". Values without units are\nparsed as seconds.\n" }, { "name": "Example 14. Show parsing of timespans", "content": "$ systemd-analyze timespan 1s 300s '1year 0.000001s'\nOriginal: 1s\nμs: 1000000\nHuman: 1s\n\nOriginal: 300s\nμs: 300000000\nHuman: 5min\n\nOriginal: 1year 0.000001s\nμs: 31557600000001\nHuman: 1y 1us\n\nsystemd-analyze cat-config NAME|PATH...\nThis command is similar to systemctl cat, but operates on config files. It will copy the\ncontents of a config file and any drop-ins to standard output, using the usual systemd set of\ndirectories and rules for precedence. Each argument must be either an absolute path including\nthe prefix (such as /etc/systemd/logind.conf or /usr/lib/systemd/logind.conf), or a name\nrelative to the prefix (such as systemd/logind.conf).\n" }, { "name": "Example 15. Showing logind configuration", "content": "$ systemd-analyze cat-config systemd/logind.conf\n# /etc/systemd/logind.conf\n...\n[Login]\nNAutoVTs=8\n...\n\n# /usr/lib/systemd/logind.conf.d/20-test.conf\n... some override from another package\n\n# /etc/systemd/logind.conf.d/50-override.conf\n... some administrator override\n\n\nsystemd-analyze compare-versions VERSION1 [OP] \u001b[4mVERSION2\nThis command has two distinct modes of operation, depending on whether the operator OP is\nspecified.\n\nIn the first mode — when OP is not specified — it will compare the two version strings and\nprint either \"VERSION1 < VERSION2\", or \"VERSION1 == VERSION2\", or \"VERSION1 > VERSION2\" as\nappropriate.\n\nThe exit status is 0 if the versions are equal, 11 if the version of the right is smaller,\nand 12 if the version of the left is smaller. (This matches the convention used by\nrpmdev-vercmp.)\n\nIn the second mode — when OP is specified — it will compare the two version strings using the\noperation OP and return 0 (success) if they condition is satisfied, and 1 (failure)\notherwise. OP may be lt, le, eq, ne, ge, gt. In this mode, no output is printed. (This\nmatches the convention used by dpkg(1) --compare-versions.)\n" }, { "name": "Example 16. Compare versions of a package", "content": "$ systemd-analyze compare-versions systemd-250~rc1.fc36.aarch64 systemd-251.fc36.aarch64\nsystemd-250~rc1.fc36.aarch64 < systemd-251.fc36.aarch64\n$ echo $?\n12\n\n$ systemd-analyze compare-versions 1 lt 2; echo $?\n0\n$ systemd-analyze compare-versions 1 ge 2; echo $?\n1\n\n\nsystemd-analyze verify FILE...\nThis command will load unit files and print warnings if any errors are detected. Files\nspecified on the command line will be loaded, but also any other units referenced by them. A\nunit's name on disk can be overridden by specifying an alias after a colon; see below for an\nexample. The full unit search path is formed by combining the directories for all command\nline arguments, and the usual unit load paths. The variable $SYSTEMDUNITPATH is supported,\nand may be used to replace or augment the compiled in set of unit load paths; see\nsystemd.unit(5). All units files present in the directories containing the command line\narguments will be used in preference to the other paths.\n\nThe following errors are currently detected:\n\n• unknown sections and directives,\n\n• missing dependencies which are required to start the given unit,\n\n• man pages listed in Documentation= which are not found in the system,\n\n• commands listed in ExecStart= and similar which are not found in the system or not\nexecutable.\n" }, { "name": "Example 17. Misspelt directives", "content": "$ cat ./user.slice\n[Unit]\nWhatIsThis=11\nDocumentation=man:nosuchfile(1)\nRequires=different.service\n\n[Service]\nDescription=x\n\n$ systemd-analyze verify ./user.slice\n[./user.slice:9] Unknown lvalue 'WhatIsThis' in section 'Unit'\n[./user.slice:13] Unknown section 'Service'. Ignoring.\nError: org.freedesktop.systemd1.LoadFailed:\nUnit different.service failed to load:\nNo such file or directory.\nFailed to create user.slice/start: Invalid argument\nuser.slice: man nosuchfile(1) command failed with code 16\n\n" }, { "name": "Example 18. Missing service units", "content": "$ tail ./a.socket ./b.socket\n==> ./a.socket <==\n[Socket]\nListenStream=100\n\n==> ./b.socket <==\n[Socket]\nListenStream=100\nAccept=yes\n\n$ systemd-analyze verify ./a.socket ./b.socket\nService a.service not loaded, a.socket cannot be started.\nService b@0.service not loaded, b.socket cannot be started.\n\n" }, { "name": "Example 19. Aliasing a unit", "content": "$ cat /tmp/source\n[Unit]\nDescription=Hostname printer\n\n[Service]\nType=simple\nExecStart=/usr/bin/echo %H\nMysteryKey=true\n\n$ systemd-analyze verify /tmp/source\nFailed to prepare filename /tmp/source: Invalid argument\n\n$ systemd-analyze verify /tmp/source:alias.service\nalias.service:7: Unknown key name 'MysteryKey' in section 'Service', ignoring.\n\n\nsystemd-analyze security [UNIT...]\nThis command analyzes the security and sandboxing settings of one or more specified service\nunits. If at least one unit name is specified the security settings of the specified service\nunits are inspected and a detailed analysis is shown. If no unit name is specified, all\ncurrently loaded, long-running service units are inspected and a terse table with results\nshown. The command checks for various security-related service settings, assigning each a\nnumeric \"exposure level\" value, depending on how important a setting is. It then calculates\nan overall exposure level for the whole unit, which is an estimation in the range 0.0...10.0\nindicating how exposed a service is security-wise. High exposure levels indicate very little\napplied sandboxing. Low exposure levels indicate tight sandboxing and strongest security\nrestrictions. Note that this only analyzes the per-service security features systemd itself\nimplements. This means that any additional security mechanisms applied by the service code\nitself are not accounted for. The exposure level determined this way should not be\nmisunderstood: a high exposure level neither means that there is no effective sandboxing\napplied by the service code itself, nor that the service is actually vulnerable to remote or\nlocal attacks. High exposure levels do indicate however that most likely the service might\nbenefit from additional settings applied to them.\n\nPlease note that many of the security and sandboxing settings individually can be\ncircumvented — unless combined with others. For example, if a service retains the privilege\nto establish or undo mount points many of the sandboxing options can be undone by the service\ncode itself. Due to that is essential that each service uses the most comprehensive and\nstrict sandboxing and security settings possible. The tool will take into account some of\nthese combinations and relationships between the settings, but not all. Also note that the\nsecurity and sandboxing settings analyzed here only apply to the operations executed by the\nservice code itself. If a service has access to an IPC system (such as D-Bus) it might\nrequest operations from other services that are not subject to the same restrictions. Any\ncomprehensive security and sandboxing analysis is hence incomplete if the IPC access policy\nis not validated too.\n" }, { "name": "Example 20. Analyze systemd-logind.service", "content": "$ systemd-analyze security --no-pager systemd-logind.service\nNAME DESCRIPTION EXPOSURE\n✗ PrivateNetwork= Service has access to the host's network 0.5\n✗ User=/DynamicUser= Service runs as root user 0.4\n✗ DeviceAllow= Service has no device ACL 0.2\n✓ IPAddressDeny= Service blocks all IP address ranges\n...\n→ Overall exposure level for systemd-logind.service: 4.1 OK 🙂\n\nsystemd-analyze inspect-elf FILE...\nThis command will load the specified files, and if they are ELF objects (executables,\nlibraries, core files, etc.) it will parse the embedded packaging metadata, if any, and print\nit in a table or json format. See the \u001b[34mPackaging Metadata[1] documentation for more\ninformation.\n" }, { "name": "Example 21. Print information about a core file as JSON", "content": "$ systemd-analyze inspect-elf --json=pretty \\\ncore.fsverity.1000.f77dac5dc161402aa44e15b7dd9dcf97.58561.1637106137000000\n{\n\"elfType\" : \"coredump\",\n\"elfArchitecture\" : \"AMD x86-64\",\n\"/home/bluca/git/fsverity-utils/fsverity\" : {\n\"type\" : \"deb\",\n\"name\" : \"fsverity-utils\",\n\"version\" : \"1.3-1\",\n\"buildId\" : \"7c895ecd2a271f93e96268f479fdc3c64a2ec4ee\"\n},\n\"/home/bluca/git/fsverity-utils/libfsverity.so.0\" : {\n\"type\" : \"deb\",\n\"name\" : \"fsverity-utils\",\n\"version\" : \"1.3-1\",\n\"buildId\" : \"b5e428254abf14237b0ae70ed85fffbb98a78f88\"\n}\n}\n\n\nsystemd-analyze fdstore UNIT...\nLists the current contents of the specified service unit's file descriptor store. This shows\nnames, inode types, device numbers, inode numbers, paths and open modes of the open file\ndescriptors. The specified units must have FileDescriptorStoreMax= enabled, see\nsystemd.service(5) for details.\n" }, { "name": "Example 22. Table output", "content": "$ systemd-analyze fdstore systemd-journald.service\nFDNAME TYPE DEVNO INODE RDEVNO PATH FLAGS\nstored sock 0:8 4218620 - socket:[4218620] ro\nstored sock 0:8 4213198 - socket:[4213198] ro\nstored sock 0:8 4213190 - socket:[4213190] ro\n...\n\nNote: the \"DEVNO\" column refers to the major/minor numbers of the device node backing the\nfile system the file descriptor's inode is on. The \"RDEVNO\" column refers to the major/minor\nnumbers of the device node itself if the file descriptor refers to one. Compare with\ncorresponding .stdev and .strdev fields in struct stat (see stat(2) for details). The\nlisted inode numbers in the \"INODE\" column are on the file system indicated by \"DEVNO\".\n\nsystemd-analyze image-policy POLICY...\nThis command analyzes the specified image policy string, as per systemd.image-policy(7). The\npolicy is normalized and simplified. For each currently defined partition identifier (as per\nthe \u001b[34mDiscoverable Partitions Specification[2]) the effect of the image policy string is shown\nin tabular form.\n" }, { "name": "Example 23. Example Output", "content": "$ systemd-analyze image-policy swap=encrypted:usr=read-only-on+verity:root=encrypted\nAnalyzing policy: root=encrypted:usr=verity+read-only-on:swap=encrypted\nLong form: root=encrypted:usr=verity+read-only-on:swap=encrypted:=unused+absent\n\nPARTITION MODE READ-ONLY GROWFS\nroot encrypted - -\nusr verity yes -\nhome ignore - -\nsrv ignore - -\nesp ignore - -\nxbootldr ignore - -\nswap encrypted - -\nroot-verity ignore - -\nusr-verity unprotected yes -\nroot-verity-sig ignore - -\nusr-verity-sig ignore - -\ntmp ignore - -\nvar ignore - -\ndefault ignore - -\n\nsystemd-analyze pcrs [PCR...]\nThis command shows the known TPM2 PCRs along with their identifying names and current values.\n" }, { "name": "Example 24. Example Output", "content": "$ systemd-analyze pcrs\nNR NAME SHA256\n0 platform-code bcd2eb527108bbb1f5528409bcbe310aa9b74f687854cc5857605993f3d9eb11\n1 platform-config b60622856eb7ce52637b80f30a520e6e87c347daa679f3335f4f1a600681bb01\n2 external-code 1471262403e9a62f9c392941300b4807fbdb6f0bfdd50abfab752732087017dd\n3 external-config 3d458cfe55cc03ea1f443f1562beec8df51c75e14a9fcf9a7234a13f198e7969\n4 boot-loader-code 939f7fa1458e1f7ce968874d908e524fc0debf890383d355e4ce347b7b78a95c\n5 boot-loader-config 864c61c5ea5ecbdb6951e6cb6d9c1f4b4eac79772f7fe13b8bece569d83d3768\n6 - 3d458cfe55cc03ea1f443f1562beec8df51c75e14a9fcf9a7234a13f198e7969\n7 secure-boot-policy 9c905bd9b9891bfb889b90a54c4b537b889cfa817c4389cc25754823a9443255\n8 - 0000000000000000000000000000000000000000000000000000000000000000\n9 kernel-initrd 9caa29b128113ef42aa53d421f03437be57211e5ebafc0fa8b5d4514ee37ff0c\n10 ima 5ea9e3dab53eb6b483b6ec9e3b2c712bea66bca1b155637841216e0094387400\n11 kernel-boot 0000000000000000000000000000000000000000000000000000000000000000\n12 kernel-config 627ffa4b405e911902fe1f1a8b0164693b31acab04f805f15bccfe2209c7eace\n13 sysexts 0000000000000000000000000000000000000000000000000000000000000000\n14 shim-policy 0000000000000000000000000000000000000000000000000000000000000000\n15 system-identity 0000000000000000000000000000000000000000000000000000000000000000\n16 debug 0000000000000000000000000000000000000000000000000000000000000000\n17 - ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff\n18 - ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff\n19 - ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff\n20 - ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff\n21 - ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff\n22 - ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff\n23 application-support 0000000000000000000000000000000000000000000000000000000000000000\n" }, { "name": "systemd-analyze srk > \u001b[4mFILE", "content": "This command reads the Storage Root Key (SRK) from the TPM2 device, and writes it in\nmarshalled TPM2BPUBLIC format to stdout. Example:\n\nsystemd-analyze srk > srk.tpm2bpublic\n" } ] }, "OPTIONS": { "content": "The following options are understood:\n", "subsections": [ { "name": "--system", "content": "Operates on the system systemd instance. This is the implied default.\n\nAdded in version 209.\n", "long": "--system" }, { "name": "--user", "content": "Operates on the user systemd instance.\n\nAdded in version 186.\n", "long": "--user" }, { "name": "--global", "content": "Operates on the system-wide configuration for user systemd instance.\n\nAdded in version 238.\n\n--order, --require\nWhen used in conjunction with the dot command (see above), selects which dependencies are\nshown in the dependency graph. If --order is passed, only dependencies of type After= or\nBefore= are shown. If --require is passed, only dependencies of type Requires=,\nRequisite=, Wants= and Conflicts= are shown. If neither is passed, this shows\ndependencies of all these types.\n\nAdded in version 198.\n\n--from-pattern=, --to-pattern=\nWhen used in conjunction with the dot command (see above), this selects which\nrelationships are shown in the dependency graph. Both options require a glob(7) pattern\nas an argument, which will be matched against the left-hand and the right-hand,\nrespectively, nodes of a relationship.\n\nEach of these can be used more than once, in which case the unit name must match one of\nthe values. When tests for both sides of the relation are present, a relation must pass\nboth tests to be shown. When patterns are also specified as positional arguments, they\nmust match at least one side of the relation. In other words, patterns specified with\nthose two options will trim the list of edges matched by the positional arguments, if any\nare given, and fully determine the list of edges shown otherwise.\n\nAdded in version 201.\n\n--fuzz=timespan\nWhen used in conjunction with the critical-chain command (see above), also show units,\nwhich finished timespan earlier, than the latest unit in the same level. The unit of\ntimespan is seconds unless specified with a different unit, e.g. \"50ms\".\n\nAdded in version 203.\n", "long": "--global" }, { "name": "--man=no", "content": "Do not invoke man(1) to verify the existence of man pages listed in Documentation=.\n\nAdded in version 235.\n", "long": "--man", "arg": "no" }, { "name": "--generators", "content": "Invoke unit generators, see systemd.generator(7). Some generators require root\nprivileges. Under a normal user, running with generators enabled will generally result in\nsome warnings.\n\nAdded in version 235.\n\n--recursive-errors=MODE\nControl verification of units and their dependencies and whether systemd-analyze verify\nexits with a non-zero process exit status or not. With yes, return a non-zero process\nexit status when warnings arise during verification of either the specified unit or any\nof its associated dependencies. With no, return a non-zero process exit status when\nwarnings arise during verification of only the specified unit. With one, return a\nnon-zero process exit status when warnings arise during verification of either the\nspecified unit or its immediate dependencies. If this option is not specified, zero is\nreturned as the exit status regardless whether warnings arise during verification or not.\n\nAdded in version 250.\n\n--root=PATH\nWith cat-files and verify, operate on files underneath the specified root path PATH.\n\nAdded in version 239.\n\n--image=PATH\nWith cat-files and verify, operate on files inside the specified image path PATH.\n\nAdded in version 250.\n\n--image-policy=policy\nTakes an image policy string as argument, as per systemd.image-policy(7). The policy is\nenforced when operating on the disk image specified via --image=, see above. If not\nspecified defaults to the \"*\" policy, i.e. all recognized file systems in the image are\nused.\n\n--offline=BOOL\nWith security, perform an offline security review of the specified unit files, i.e. does\nnot have to rely on PID 1 to acquire security information for the files like the security\nverb when used by itself does. This means that --offline= can be used with --root= and\n--image= as well. If a unit's overall exposure level is above that set by --threshold=\n(default value is 100), --offline= will return an error.\n\nAdded in version 250.\n\n--profile=PATH\nWith security --offline=, takes into consideration the specified portable profile when\nassessing unit settings. The profile can be passed by name, in which case the well-known\nsystem locations will be searched, or it can be the full path to a specific drop-in file.\n\nAdded in version 250.\n\n--threshold=NUMBER\nWith security, allow the user to set a custom value to compare the overall exposure level\nwith, for the specified unit files. If a unit's overall exposure level, is greater than\nthat set by the user, security will return an error. --threshold= can be used with\n--offline= as well and its default value is 100.\n\nAdded in version 250.\n\n--security-policy=PATH\nWith security, allow the user to define a custom set of requirements formatted as a JSON\nfile against which to compare the specified unit file(s) and determine their overall\nexposure level to security threats.\n\nTable 1. Accepted Assessment Test Identifiers\n┌──────────────────────────────────────────────────────────┐\n│ Assessment Test Identifier │\n├──────────────────────────────────────────────────────────┤\n│ UserOrDynamicUser │\n├──────────────────────────────────────────────────────────┤\n│ SupplementaryGroups │\n├──────────────────────────────────────────────────────────┤\n│ PrivateMounts │\n├──────────────────────────────────────────────────────────┤\n│ PrivateDevices │\n├──────────────────────────────────────────────────────────┤\n│ PrivateTmp │\n├──────────────────────────────────────────────────────────┤\n│ PrivateNetwork │\n├──────────────────────────────────────────────────────────┤\n│ PrivateUsers │\n├──────────────────────────────────────────────────────────┤\n│ ProtectControlGroups │\n├──────────────────────────────────────────────────────────┤\n│ ProtectKernelModules │\n├──────────────────────────────────────────────────────────┤\n│ ProtectKernelTunables │\n├──────────────────────────────────────────────────────────┤\n│ ProtectKernelLogs │\n├──────────────────────────────────────────────────────────┤\n│ ProtectClock │\n├──────────────────────────────────────────────────────────┤\n│ ProtectHome │\n├──────────────────────────────────────────────────────────┤\n│ ProtectHostname │\n├──────────────────────────────────────────────────────────┤\n│ ProtectSystem │\n├──────────────────────────────────────────────────────────┤\n│ RootDirectoryOrRootImage │\n├──────────────────────────────────────────────────────────┤\n│ LockPersonality │\n├──────────────────────────────────────────────────────────┤\n│ MemoryDenyWriteExecute │\n├──────────────────────────────────────────────────────────┤\n│ NoNewPrivileges │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPSYSADMIN │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPSETUIDGIDPCAP │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPSYSPTRACE │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPSYSTIME │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPNETADMIN │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPSYSRAWIO │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPSYSMODULE │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPAUDIT │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPSYSLOG │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPSYSNICERESOURCE │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPMKNOD │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPCHOWNFSETIDSETFCAP │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPDACFOWNERIPCOWNER │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPKILL │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPNETBINDSERVICEBROADCASTRAW │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPSYSBOOT │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPMAC │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPLINUXIMMUTABLE │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPIPCLOCK │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPSYSCHROOT │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPBLOCKSUSPEND │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPWAKEALARM │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPLEASE │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPSYSTTYCONFIG │\n├──────────────────────────────────────────────────────────┤\n│ CapabilityBoundingSetCAPBPF │\n├──────────────────────────────────────────────────────────┤\n│ UMask │\n├──────────────────────────────────────────────────────────┤\n│ KeyringMode │\n├──────────────────────────────────────────────────────────┤\n│ ProtectProc │\n├──────────────────────────────────────────────────────────┤\n│ ProcSubset │\n├──────────────────────────────────────────────────────────┤\n│ NotifyAccess │\n├──────────────────────────────────────────────────────────┤\n│ RemoveIPC │\n├──────────────────────────────────────────────────────────┤\n│ Delegate │\n├──────────────────────────────────────────────────────────┤\n│ RestrictRealtime │\n├──────────────────────────────────────────────────────────┤\n│ RestrictSUIDSGID │\n├──────────────────────────────────────────────────────────┤\n│ RestrictNamespacesuser │\n├──────────────────────────────────────────────────────────┤\n│ RestrictNamespacesmnt │\n├──────────────────────────────────────────────────────────┤\n│ RestrictNamespacesipc │\n├──────────────────────────────────────────────────────────┤\n│ RestrictNamespacespid │\n├──────────────────────────────────────────────────────────┤\n│ RestrictNamespacescgroup │\n├──────────────────────────────────────────────────────────┤\n│ RestrictNamespacesuts │\n├──────────────────────────────────────────────────────────┤\n│ RestrictNamespacesnet │\n├──────────────────────────────────────────────────────────┤\n│ RestrictAddressFamiliesAFINETINET6 │\n├──────────────────────────────────────────────────────────┤\n│ RestrictAddressFamiliesAFUNIX │\n├──────────────────────────────────────────────────────────┤\n│ RestrictAddressFamiliesAFNETLINK │\n├──────────────────────────────────────────────────────────┤\n│ RestrictAddressFamiliesAFPACKET │\n├──────────────────────────────────────────────────────────┤\n│ RestrictAddressFamiliesOTHER │\n├──────────────────────────────────────────────────────────┤\n│ SystemCallArchitectures │\n├──────────────────────────────────────────────────────────┤\n│ SystemCallFilterswap │\n├──────────────────────────────────────────────────────────┤\n│ SystemCallFilterobsolete │\n├──────────────────────────────────────────────────────────┤\n│ SystemCallFilterclock │\n├──────────────────────────────────────────────────────────┤\n│ SystemCallFiltercpuemulation │\n├──────────────────────────────────────────────────────────┤\n│ SystemCallFilterdebug │\n├──────────────────────────────────────────────────────────┤\n│ SystemCallFiltermount │\n├──────────────────────────────────────────────────────────┤\n│ SystemCallFiltermodule │\n├──────────────────────────────────────────────────────────┤\n│ SystemCallFilterrawio │\n├──────────────────────────────────────────────────────────┤\n│ SystemCallFilterreboot │\n├──────────────────────────────────────────────────────────┤\n│ SystemCallFilterprivileged │\n├──────────────────────────────────────────────────────────┤\n│ SystemCallFilterresources │\n├──────────────────────────────────────────────────────────┤\n│ IPAddressDeny │\n├──────────────────────────────────────────────────────────┤\n│ DeviceAllow │\n├──────────────────────────────────────────────────────────┤\n│ AmbientCapabilities │\n└──────────────────────────────────────────────────────────┘\n\nSee example \"JSON Policy\" below.\n\nAdded in version 250.\n\n--json=MODE\nWith the security command, generate a JSON formatted output of the security analysis\ntable. The format is a JSON array with objects containing the following fields: set which\nindicates if the setting has been enabled or not, name which is what is used to refer to\nthe setting, jsonfield which is the JSON compatible identifier of the setting,\ndescription which is an outline of the setting state, and exposure which is a number in\nthe range 0.0...10.0, where a higher value corresponds to a higher security threat. The\nJSON version of the table is printed to standard output. The MODE passed to the option\ncan be one of three: off which is the default, pretty and short which respectively output\na prettified or shorted JSON version of the security table. With the plot command,\ngenerate a JSON formatted output of the raw time data. The format is a JSON array with\nobjects containing the following fields: name which is the unit name, activated which is\nthe time after startup the service was activated, activating which is how long after\nstartup the service was initially started, time which is how long the service took to\nactivate from when it was initially started, deactivated which is the time after startup\nthat the service was deactivated, deactivating which is the time after startup that the\nservice was initially told to deactivate.\n\nAdded in version 250.\n\n--iterations=NUMBER\nWhen used with the calendar command, show the specified number of iterations the\nspecified calendar expression will elapse next. Defaults to 1.\n\nAdded in version 242.\n\n--base-time=TIMESTAMP\nWhen used with the calendar command, show next iterations relative to the specified point\nin time. If not specified defaults to the current time.\n\nAdded in version 244.\n\n--unit=UNIT\nWhen used with the condition command, evaluate all the Condition*=... and Assert*=...\nassignments in the specified unit file. The full unit search path is formed by combining\nthe directories for the specified unit with the usual unit load paths. The variable\n$SYSTEMDUNITPATH is supported, and may be used to replace or augment the compiled in\nset of unit load paths; see systemd.unit(5). All units files present in the directory\ncontaining the specified unit will be used in preference to the other paths.\n\nAdded in version 250.\n", "long": "--generators" }, { "name": "--table", "content": "When used with the plot command, the raw time data is output in a table.\n\nAdded in version 253.\n", "long": "--table" }, { "name": "--no-legend", "content": "When used with the plot command in combination with either --table or --json=, no legends\nor hints are included in the output.\n\nAdded in version 253.\n", "long": "--no-legend" }, { "name": "-H --host=", "content": "Execute the operation remotely. Specify a hostname, or a username and hostname separated\nby \"@\", to connect to. The hostname may optionally be suffixed by a port ssh is listening\non, separated by \":\", and then a container name, separated by \"/\", which connects\ndirectly to a specific container on the specified host. This will use SSH to talk to the\nremote machine manager instance. Container names may be enumerated with machinectl -H\nHOST. Put IPv6 addresses in brackets.\n", "flag": "-H" }, { "name": "-M --machine=", "content": "Execute operation on a local container. Specify a container name to connect to,\noptionally prefixed by a user name to connect as and a separating \"@\" character. If the\nspecial string \".host\" is used in place of the container name, a connection to the local\nsystem is made (which is useful to connect to a specific user's user bus: \"--user\n--machine=lennart@.host\"). If the \"@\" syntax is not used, the connection is made as root\nuser. If the \"@\" syntax is used either the left hand side or the right hand side may be\nomitted (but not both) in which case the local user name and \".host\" are implied.\n", "flag": "-M" }, { "name": "-q --quiet", "content": "Suppress hints and other non-essential output.\n\nAdded in version 250.\n", "flag": "-q", "long": "--quiet" }, { "name": "--tldr", "content": "With cat-config, only print the \"interesting\" parts of the configuration files, skipping\ncomments and empty lines and section headers followed only by comments and empty lines.\n\nAdded in version 255.\n", "long": "--tldr" }, { "name": "-h --help", "content": "Print a short help text and exit.\n", "flag": "-h", "long": "--help" }, { "name": "--version", "content": "Print a short version string and exit.\n", "long": "--version" }, { "name": "--no-pager", "content": "Do not pipe output into a pager.\n", "long": "--no-pager" } ] }, "EXIT STATUS": { "content": "For most commands, 0 is returned on success, and a non-zero failure code otherwise.\n\nWith the verb compare-versions, in the two-argument form, 12, 0, 11 is returned if the second\nversion string is respectively larger, equal, or smaller to the first. In the three-argument\nform, 0 or 1 if the condition is respectively true or false.\n", "subsections": [] }, "ENVIRONMENT": { "content": "$SYSTEMDLOGLEVEL\nThe maximum log level of emitted messages (messages with a higher log level, i.e. less\nimportant ones, will be suppressed). Either one of (in order of decreasing importance)\nemerg, alert, crit, err, warning, notice, info, debug, or an integer in the range 0...7.\nSee syslog(3) for more information.\n\n$SYSTEMDLOGCOLOR\nA boolean. If true, messages written to the tty will be colored according to priority.\n\nThis setting is only useful when messages are written directly to the terminal, because\njournalctl(1) and other tools that display logs will color messages based on the log\nlevel on their own.\n\n$SYSTEMDLOGTIME\nA boolean. If true, console log messages will be prefixed with a timestamp.\n\nThis setting is only useful when messages are written directly to the terminal or a file,\nbecause journalctl(1) and other tools that display logs will attach timestamps based on\nthe entry metadata on their own.\n\n$SYSTEMDLOGLOCATION\nA boolean. If true, messages will be prefixed with a filename and line number in the\nsource code where the message originates.\n\nNote that the log location is often attached as metadata to journal entries anyway.\nIncluding it directly in the message text can nevertheless be convenient when debugging\nprograms.\n\n$SYSTEMDLOGTID\nA boolean. If true, messages will be prefixed with the current numerical thread ID (TID).\n\nNote that the this information is attached as metadata to journal entries anyway.\nIncluding it directly in the message text can nevertheless be convenient when debugging\nprograms.\n\n$SYSTEMDLOGTARGET\nThe destination for log messages. One of console (log to the attached tty),\nconsole-prefixed (log to the attached tty but with prefixes encoding the log level and\n\"facility\", see syslog(3), kmsg (log to the kernel circular log buffer), journal (log to\nthe journal), journal-or-kmsg (log to the journal if available, and to kmsg otherwise),\nauto (determine the appropriate log target automatically, the default), null (disable log\noutput).\n\n$SYSTEMDLOGRATELIMITKMSG\nWhether to ratelimit kmsg or not. Takes a boolean. Defaults to \"true\". If disabled,\nsystemd will not ratelimit messages written to kmsg.\n\n$SYSTEMDPAGER\nPager to use when --no-pager is not given; overrides $PAGER. If neither $SYSTEMDPAGER\nnor $PAGER are set, a set of well-known pager implementations are tried in turn,\nincluding less(1) and more(1), until one is found. If no pager implementation is\ndiscovered no pager is invoked. Setting this environment variable to an empty string or\nthe value \"cat\" is equivalent to passing --no-pager.\n\nNote: if $SYSTEMDPAGERSECURE is not set, $SYSTEMDPAGER (as well as $PAGER) will be\nsilently ignored.\n\n$SYSTEMDLESS\nOverride the options passed to less (by default \"FRSXMK\").\n\nUsers might want to change two options in particular:\n\nK\nThis option instructs the pager to exit immediately when Ctrl+C is pressed. To allow\nless to handle Ctrl+C itself to switch back to the pager command prompt, unset this\noption.\n\nIf the value of $SYSTEMDLESS does not include \"K\", and the pager that is invoked is\nless, Ctrl+C will be ignored by the executable, and needs to be handled by the pager.\n\nX\nThis option instructs the pager to not send termcap initialization and\ndeinitialization strings to the terminal. It is set by default to allow command\noutput to remain visible in the terminal even after the pager exits. Nevertheless,\nthis prevents some pager functionality from working, in particular paged output\ncannot be scrolled with the mouse.\n\nSee less(1) for more discussion.\n\n$SYSTEMDLESSCHARSET\nOverride the charset passed to less (by default \"utf-8\", if the invoking terminal is\ndetermined to be UTF-8 compatible).\n\n$SYSTEMDPAGERSECURE\nTakes a boolean argument. When true, the \"secure\" mode of the pager is enabled; if false,\ndisabled. If $SYSTEMDPAGERSECURE is not set at all, secure mode is enabled if the\neffective UID is not the same as the owner of the login session, see geteuid(2) and\nsdpidgetowneruid(3). In secure mode, LESSSECURE=1 will be set when invoking the\npager, and the pager shall disable commands that open or create new files or start new\nsubprocesses. When $SYSTEMDPAGERSECURE is not set at all, pagers which are not known to\nimplement secure mode will not be used. (Currently only less(1) implements secure mode.)\n\nNote: when commands are invoked with elevated privileges, for example under sudo(8) or\npkexec(1), care must be taken to ensure that unintended interactive features are not\nenabled. \"Secure\" mode for the pager may be enabled automatically as describe above.\nSetting SYSTEMDPAGERSECURE=0 or not removing it from the inherited environment allows\nthe user to invoke arbitrary commands. Note that if the $SYSTEMDPAGER or $PAGER\nvariables are to be honoured, $SYSTEMDPAGERSECURE must be set too. It might be\nreasonable to completely disable the pager using --no-pager instead.\n\n$SYSTEMDCOLORS\nTakes a boolean argument. When true, systemd and related utilities will use colors in\ntheir output, otherwise the output will be monochrome. Additionally, the variable can\ntake one of the following special values: \"16\", \"256\" to restrict the use of colors to\nthe base 16 or 256 ANSI colors, respectively. This can be specified to override the\nautomatic decision based on $TERM and what the console is connected to.\n\n$SYSTEMDURLIFY\nThe value must be a boolean. Controls whether clickable links should be generated in the\noutput for terminal emulators supporting this. This can be specified to override the\ndecision that systemd makes based on $TERM and other conditions.\n", "subsections": [] }, "EXAMPLES": { "content": "", "subsections": [ { "name": "Example 25. JSON Policy", "content": "The JSON file passed as a path parameter to --security-policy= has a top-level JSON object,\nwith keys being the assessment test identifiers mentioned above. The values in the file\nshould be JSON objects with one or more of the following fields: descriptionna (string)," }, { "name": "description_good (string), description_bad (string),", "content": "(unsigned integer). If any of these fields corresponding to a specific id of the unit file is\nmissing from the JSON object, the default built-in field value corresponding to that same id\nis used for security analysis as default. The weight and range fields are used in determining\nthe overall exposure level of the unit files: the value of each setting is assigned a badness\nscore, which is multiplied by the policy weight and divided by the policy range to determine\nthe overall exposure that the setting implies. The computed badness is summed across all\nsettings in the unit file, normalized to the 1...100 range, and used to determine the overall\nexposure level of the unit. By allowing users to manipulate these fields, the 'security' verb\ngives them the option to decide for themself which ids are more important and hence should\nhave a greater effect on the exposure level. A weight of \"0\" means the setting will not be\nchecked.\n\n{\n\"PrivateDevices\":\n{\n\"descriptiongood\": \"Service has no access to hardware devices\",\n\"descriptionbad\": \"Service potentially has access to hardware devices\",\n\"weight\": 1000,\n\"range\": 1\n},\n\"PrivateMounts\":\n{\n\"descriptiongood\": \"Service cannot install system mounts\",\n\"descriptionbad\": \"Service may install system mounts\",\n\"weight\": 1000,\n\"range\": 1\n},\n\"PrivateNetwork\":\n{\n\"descriptiongood\": \"Service has no access to the host's network\",\n\"descriptionbad\": \"Service has access to the host's network\",\n\"weight\": 2500,\n\"range\": 1\n},\n\"PrivateTmp\":\n{\n\"descriptiongood\": \"Service has no access to other software's temporary files\",\n\"descriptionbad\": \"Service has access to other software's temporary files\",\n\"weight\": 1000,\n\"range\": 1\n},\n\"PrivateUsers\":\n{\n\"descriptiongood\": \"Service does not have access to other users\",\n\"descriptionbad\": \"Service has access to other users\",\n\"weight\": 1000,\n\"range\": 1\n}\n}\n\n" } ] }, "SEE ALSO": { "content": "systemd(1), systemctl(1)\n", "subsections": [] }, "NOTES": { "content": "1. Packaging Metadata\nhttps://systemd.io/COREDUMPPACKAGEMETADATA/\n\n2. Discoverable Partitions Specification\nhttps://uapi-group.org/specifications/specs/discoverablepartitionsspecification\n\nsystemd 255 SYSTEMD-ANALYZE(1)", "subsections": [] } } } }