1SYSTEMCTL(1) systemctl SYSTEMCTL(1)
2
3
4
6 systemctl - Control the systemd system and service manager
7
9 systemctl [OPTIONS...] COMMAND [UNIT...]
10
12 systemctl may be used to introspect and control the state of the
13 "systemd" system and service manager. Please refer to systemd(1) for an
14 introduction into the basic concepts and functionality this tool
15 manages.
16
18 The following commands are understood:
19
20 Unit Commands (Introspection and Modification)
21 list-units [PATTERN...]
22 List units that systemd currently has in memory. This includes
23 units that are either referenced directly or through a dependency,
24 units that are pinned by applications programmatically, or units
25 that were active in the past and have failed. By default only units
26 which are active, have pending jobs, or have failed are shown; this
27 can be changed with option --all. If one or more PATTERNs are
28 specified, only units matching one of them are shown. The units
29 that are shown are additionally filtered by --type= and --state= if
30 those options are specified.
31
32 Note that this command does not show unit templates, but only
33 instances of unit templates. Units templates that aren't
34 instantiated are not runnable, and will thus never show up in the
35 output of this command. Specifically this means that foo@.service
36 will never be shown in this list — unless instantiated, e.g. as
37 foo@bar.service. Use list-unit-files (see below) for listing
38 installed unit template files.
39
40 Produces output similar to
41
42 UNIT LOAD ACTIVE SUB DESCRIPTION
43 sys-module-fuse.device loaded active plugged /sys/module/fuse
44 -.mount loaded active mounted Root Mount
45 boot-efi.mount loaded active mounted /boot/efi
46 systemd-journald.service loaded active running Journal Service
47 systemd-logind.service loaded active running Login Service
48 ● user@1000.service loaded failed failed User Manager for UID 1000
49 ...
50 systemd-tmpfiles-clean.timer loaded active waiting Daily Cleanup of Temporary Directories
51
52 LOAD = Reflects whether the unit definition was properly loaded.
53 ACTIVE = The high-level unit activation state, i.e. generalization of SUB.
54 SUB = The low-level unit activation state, values depend on unit type.
55
56 123 loaded units listed. Pass --all to see loaded but inactive units, too.
57 To show all installed unit files use 'systemctl list-unit-files'.
58
59 The header and the last unit of a given type are underlined if the
60 terminal supports that. A colored dot is shown next to services
61 which were masked, not found, or otherwise failed.
62
63 The LOAD column shows the load state, one of loaded, not-found,
64 bad-setting, error, masked. The ACTIVE columns shows the general
65 unit state, one of active, reloading, inactive, failed, activating,
66 deactivating. The SUB column shows the unit-type-specific detailed
67 state of the unit, possible values vary by unit type. The list of
68 possible LOAD, ACTIVE, and SUB states is not constant and new
69 systemd releases may both add and remove values.
70
71 systemctl --state=help
72
73 command maybe be used to display the current set of possible
74 values.
75
76 This is the default command.
77
78 list-sockets [PATTERN...]
79 List socket units currently in memory, ordered by listening
80 address. If one or more PATTERNs are specified, only socket units
81 matching one of them are shown. Produces output similar to
82
83 LISTEN UNIT ACTIVATES
84 /dev/initctl systemd-initctl.socket systemd-initctl.service
85 ...
86 [::]:22 sshd.socket sshd.service
87 kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
88
89 5 sockets listed.
90
91 Note: because the addresses might contains spaces, this output is
92 not suitable for programmatic consumption.
93
94 Also see --show-types, --all, and --state=.
95
96 list-timers [PATTERN...]
97 List timer units currently in memory, ordered by the time they
98 elapse next. If one or more PATTERNs are specified, only units
99 matching one of them are shown. Produces output similar to
100
101 NEXT LEFT LAST PASSED UNIT ACTIVATES
102 n/a n/a Thu 2017-02-23 13:40:29 EST 3 days ago ureadahead-stop.timer ureadahead-stop.service
103 Sun 2017-02-26 18:55:42 EST 1min 14s left Thu 2017-02-23 13:54:44 EST 3 days ago systemd-tmpfiles-clean.timer systemd-tmpfiles-clean.service
104 Sun 2017-02-26 20:37:16 EST 1h 42min left Sun 2017-02-26 11:56:36 EST 6h ago apt-daily.timer apt-daily.service
105 Sun 2017-02-26 20:57:49 EST 2h 3min left Sun 2017-02-26 11:56:36 EST 6h ago snapd.refresh.timer snapd.refresh.service
106
107
108 NEXT shows the next time the timer will run.
109
110 LEFT shows how long till the next time the timer runs.
111
112 LAST shows the last time the timer ran.
113
114 PASSED shows how long has passed since the timer last ran.
115
116 UNIT shows the name of the timer
117
118 ACTIVATES shows the name the service the timer activates when it
119 runs.
120
121 Also see --all and --state=.
122
123 is-active PATTERN...
124 Check whether any of the specified units are active (i.e. running).
125 Returns an exit code 0 if at least one is active, or non-zero
126 otherwise. Unless --quiet is specified, this will also print the
127 current unit state to standard output.
128
129 is-failed PATTERN...
130 Check whether any of the specified units are in a "failed" state.
131 Returns an exit code 0 if at least one has failed, non-zero
132 otherwise. Unless --quiet is specified, this will also print the
133 current unit state to standard output.
134
135 status [PATTERN...|PID...]]
136 Show terse runtime status information about one or more units,
137 followed by most recent log data from the journal. If no units are
138 specified, show system status. If combined with --all, also show
139 the status of all units (subject to limitations specified with -t).
140 If a PID is passed, show information about the unit the process
141 belongs to.
142
143 This function is intended to generate human-readable output. If you
144 are looking for computer-parsable output, use show instead. By
145 default, this function only shows 10 lines of output and ellipsizes
146 lines to fit in the terminal window. This can be changed with
147 --lines and --full, see above. In addition, journalctl --unit=NAME
148 or journalctl --user-unit=NAME use a similar filter for messages
149 and might be more convenient.
150
151 Note that this operation only displays runtime status, i.e.
152 information about the current invocation of the unit (if it is
153 running) or the most recent invocation (if it is not running
154 anymore, and has not been released from memory). Information about
155 earlier invocations, invocations from previous system boots, or
156 prior invocations that have already been released from memory may
157 be retrieved via journalctl --unit=.
158
159 systemd implicitly loads units as necessary, so just running the
160 status will attempt to load a file. The command is thus not useful
161 for determining if something was already loaded or not. The units
162 may possibly also be quickly unloaded after the operation is
163 completed if there's no reason to keep it in memory thereafter.
164
165 Example 1. Example output from systemctl status
166
167 $ systemctl status bluetooth
168 ● bluetooth.service - Bluetooth service
169 Loaded: loaded (/usr/lib/systemd/system/bluetooth.service; enabled; preset: enabled)
170 Active: active (running) since Wed 2017-01-04 13:54:04 EST; 1 weeks 0 days ago
171 Docs: man:bluetoothd(8)
172 Main PID: 930 (bluetoothd)
173 Status: "Running"
174 Tasks: 1
175 Memory: 648.0K
176 CPU: 435ms
177 CGroup: /system.slice/bluetooth.service
178 └─930 /usr/lib/bluetooth/bluetoothd
179
180 Jan 12 10:46:45 example.com bluetoothd[8900]: Not enough free handles to register service
181 Jan 12 10:46:45 example.com bluetoothd[8900]: Current Time Service could not be registered
182 Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output error (5)
183
184 The dot ("●") uses color on supported terminals to summarize the
185 unit state at a glance. Along with its color, its shape varies
186 according to its state: "inactive" or "maintenance" is a white
187 circle ("○"), "active" is a green dot ("●"), "deactivating" is a
188 white dot, "failed" or "error" is a red cross ("×"), and
189 "reloading" is a green clockwise circle arrow ("↻").
190
191 The "Loaded:" line in the output will show "loaded" if the unit has
192 been loaded into memory. Other possible values for "Loaded:"
193 include: "error" if there was a problem loading it, "not-found" if
194 no unit file was found for this unit, "bad-setting" if an essential
195 unit file setting could not be parsed and "masked" if the unit file
196 has been masked. Along with showing the path to the unit file, this
197 line will also show the enablement state. Enabled units are
198 included in the dependency network between units, and thus are
199 started at boot or via some other form of activation. See the full
200 table of possible enablement states — including the definition of
201 "masked" — in the documentation for the is-enabled command.
202
203 The "Active:" line shows active state. The value is usually
204 "active" or "inactive". Active could mean started, bound, plugged
205 in, etc depending on the unit type. The unit could also be in
206 process of changing states, reporting a state of "activating" or
207 "deactivating". A special "failed" state is entered when the
208 service failed in some way, such as a crash, exiting with an error
209 code or timing out. If the failed state is entered the cause will
210 be logged for later reference.
211
212 show [PATTERN...|JOB...]
213 Show properties of one or more units, jobs, or the manager itself.
214 If no argument is specified, properties of the manager will be
215 shown. If a unit name is specified, properties of the unit are
216 shown, and if a job ID is specified, properties of the job are
217 shown. By default, empty properties are suppressed. Use --all to
218 show those too. To select specific properties to show, use
219 --property=. This command is intended to be used whenever
220 computer-parsable output is required. Use status if you are looking
221 for formatted human-readable output.
222
223 Many properties shown by systemctl show map directly to
224 configuration settings of the system and service manager and its
225 unit files. Note that the properties shown by the command are
226 generally more low-level, normalized versions of the original
227 configuration settings and expose runtime state in addition to
228 configuration. For example, properties shown for service units
229 include the service's current main process identifier as "MainPID"
230 (which is runtime state), and time settings are always exposed as
231 properties ending in the "...USec" suffix even if a matching
232 configuration options end in "...Sec", because microseconds is the
233 normalized time unit used internally by the system and service
234 manager.
235
236 For details about many of these properties, see the documentation
237 of the D-Bus interface backing these properties, see
238 org.freedesktop.systemd1(5).
239
240 cat PATTERN...
241 Show backing files of one or more units. Prints the "fragment" and
242 "drop-ins" (source files) of units. Each file is preceded by a
243 comment which includes the file name. Note that this shows the
244 contents of the backing files on disk, which may not match the
245 system manager's understanding of these units if any unit files
246 were updated on disk and the daemon-reload command wasn't issued
247 since.
248
249 help PATTERN...|PID...
250 Show manual pages for one or more units, if available. If a PID is
251 given, the manual pages for the unit the process belongs to are
252 shown.
253
254 list-dependencies [UNIT...]
255 Shows units required and wanted by the specified units. This
256 recursively lists units following the Requires=, Requisite=,
257 ConsistsOf=, Wants=, BindsTo= dependencies. If no units are
258 specified, default.target is implied.
259
260 By default, only target units are recursively expanded. When --all
261 is passed, all other units are recursively expanded as well.
262
263 Options --reverse, --after, --before may be used to change what
264 types of dependencies are shown.
265
266 Note that this command only lists units currently loaded into
267 memory by the service manager. In particular, this command is not
268 suitable to get a comprehensive list at all reverse dependencies on
269 a specific unit, as it won't list the dependencies declared by
270 units currently not loaded.
271
272 start PATTERN...
273 Start (activate) one or more units specified on the command line.
274
275 Note that unit glob patterns expand to names of units currently in
276 memory. Units which are not active and are not in a failed state
277 usually are not in memory, and will not be matched by any pattern.
278 In addition, in case of instantiated units, systemd is often
279 unaware of the instance name until the instance has been started.
280 Therefore, using glob patterns with start has limited usefulness.
281 Also, secondary alias names of units are not considered.
282
283 Option --all may be used to also operate on inactive units which
284 are referenced by other loaded units. Note that this is not the
285 same as operating on "all" possible units, because as the previous
286 paragraph describes, such a list is ill-defined. Nevertheless,
287 systemctl start --all GLOB may be useful if all the units that
288 should match the pattern are pulled in by some target which is
289 known to be loaded.
290
291 stop PATTERN...
292 Stop (deactivate) one or more units specified on the command line.
293
294 This command will fail if the unit does not exist or if stopping of
295 the unit is prohibited (see RefuseManualStop= in systemd.unit(5)).
296 It will not fail if any of the commands configured to stop the unit
297 (ExecStop=, etc.) fail, because the manager will still forcibly
298 terminate the unit.
299
300 reload PATTERN...
301 Asks all units listed on the command line to reload their
302 configuration. Note that this will reload the service-specific
303 configuration, not the unit configuration file of systemd. If you
304 want systemd to reload the configuration file of a unit, use the
305 daemon-reload command. In other words: for the example case of
306 Apache, this will reload Apache's httpd.conf in the web server, not
307 the apache.service systemd unit file.
308
309 This command should not be confused with the daemon-reload command.
310
311 restart PATTERN...
312 Stop and then start one or more units specified on the command
313 line. If the units are not running yet, they will be started.
314
315 Note that restarting a unit with this command does not necessarily
316 flush out all of the unit's resources before it is started again.
317 For example, the per-service file descriptor storage facility (see
318 FileDescriptorStoreMax= in systemd.service(5)) will remain intact
319 as long as the unit has a job pending, and is only cleared when the
320 unit is fully stopped and no jobs are pending anymore. If it is
321 intended that the file descriptor store is flushed out, too, during
322 a restart operation an explicit systemctl stop command followed by
323 systemctl start should be issued.
324
325 try-restart PATTERN...
326 Stop and then start one or more units specified on the command line
327 if the units are running. This does nothing if units are not
328 running.
329
330 reload-or-restart PATTERN...
331 Reload one or more units if they support it. If not, stop and then
332 start them instead. If the units are not running yet, they will be
333 started.
334
335 try-reload-or-restart PATTERN...
336 Reload one or more units if they support it. If not, stop and then
337 start them instead. This does nothing if the units are not running.
338
339 isolate UNIT
340 Start the unit specified on the command line and its dependencies
341 and stop all others, unless they have IgnoreOnIsolate=yes (see
342 systemd.unit(5)). If a unit name with no extension is given, an
343 extension of ".target" will be assumed.
344
345 This command is dangerous, since it will immediately stop processes
346 that are not enabled in the new target, possibly including the
347 graphical environment or terminal you are currently using.
348
349 Note that this is allowed only on units where AllowIsolate= is
350 enabled. See systemd.unit(5) for details.
351
352 kill PATTERN...
353 Send a signal to one or more processes of the unit. Use --kill-who=
354 to select which process to kill. Use --signal= to select the signal
355 to send.
356
357 clean PATTERN...
358 Remove the configuration, state, cache, logs or runtime data of the
359 specified units. Use --what= to select which kind of resource to
360 remove. For service units this may be used to remove the
361 directories configured with ConfigurationDirectory=,
362 StateDirectory=, CacheDirectory=, LogsDirectory= and
363 RuntimeDirectory=, see systemd.exec(5) for details. For timer units
364 this may be used to clear out the persistent timestamp data if
365 Persistent= is used and --what=state is selected, see
366 systemd.timer(5). This command only applies to units that use
367 either of these settings. If --what= is not specified, both the
368 cache and runtime data are removed (as these two types of data are
369 generally redundant and reproducible on the next invocation of the
370 unit).
371
372 freeze PATTERN...
373 Freeze one or more units specified on the command line using cgroup
374 freezer
375
376 Freezing the unit will cause all processes contained within the
377 cgroup corresponding to the unit to be suspended. Being suspended
378 means that unit's processes won't be scheduled to run on CPU until
379 thawed. Note that this command is supported only on systems that
380 use unified cgroup hierarchy. Unit is automatically thawed just
381 before we execute a job against the unit, e.g. before the unit is
382 stopped.
383
384 thaw PATTERN...
385 Thaw (unfreeze) one or more units specified on the command line.
386
387 This is the inverse operation to the freeze command and resumes the
388 execution of processes in the unit's cgroup.
389
390 set-property UNIT PROPERTY=VALUE...
391 Set the specified unit properties at runtime where this is
392 supported. This allows changing configuration parameter properties
393 such as resource control settings at runtime. Not all properties
394 may be changed at runtime, but many resource control settings
395 (primarily those in systemd.resource-control(5)) may. The changes
396 are applied immediately, and stored on disk for future boots,
397 unless --runtime is passed, in which case the settings only apply
398 until the next reboot. The syntax of the property assignment
399 follows closely the syntax of assignments in unit files.
400
401 Example: systemctl set-property foobar.service CPUWeight=200
402
403 If the specified unit appears to be inactive, the changes will be
404 only stored on disk as described previously hence they will be
405 effective when the unit will be started.
406
407 Note that this command allows changing multiple properties at the
408 same time, which is preferable over setting them individually.
409
410 Example: systemctl set-property foobar.service CPUWeight=200
411 MemoryMax=2G IPAccounting=yes
412
413 Like with unit file configuration settings, assigning an empty
414 setting usually resets a property to its defaults.
415
416 Example: systemctl set-property avahi-daemon.service IPAddressDeny=
417
418 bind UNIT PATH [PATH]
419 Bind-mounts a file or directory from the host into the specified
420 unit's mount namespace. The first path argument is the source file
421 or directory on the host, the second path argument is the
422 destination file or directory in the unit's mount namespace. When
423 the latter is omitted, the destination path in the unit's mount
424 namespace is the same as the source path on the host. When combined
425 with the --read-only switch, a ready-only bind mount is created.
426 When combined with the --mkdir switch, the destination path is
427 first created before the mount is applied.
428
429 Note that this option is currently only supported for units that
430 run within a mount namespace (e.g.: with RootImage=,
431 PrivateMounts=, etc.). This command supports bind-mounting
432 directories, regular files, device nodes, AF_UNIX socket nodes, as
433 well as FIFOs. The bind mount is ephemeral, and it is undone as
434 soon as the current unit process exists. Note that the namespace
435 mentioned here, where the bind mount will be added to, is the one
436 where the main service process runs. Other processes (those
437 exececuted by ExecReload=, ExecStartPre=, etc.) run in distinct
438 namespaces.
439
440 mount-image UNIT IMAGE [PATH [PARTITION_NAME:MOUNT_OPTIONS]]
441 Mounts an image from the host into the specified unit's mount
442 namespace. The first path argument is the source image on the host,
443 the second path argument is the destination directory in the unit's
444 mount namespace (i.e. inside RootImage=/RootDirectory=). The
445 following argument, if any, is interpreted as a colon-separated
446 tuple of partition name and comma-separated list of mount options
447 for that partition. The format is the same as the service
448 MountImages= setting. When combined with the --read-only switch, a
449 ready-only mount is created. When combined with the --mkdir switch,
450 the destination path is first created before the mount is applied.
451
452 Note that this option is currently only supported for units that
453 run within a mount namespace (i.e. with RootImage=, PrivateMounts=,
454 etc.). Note that the namespace mentioned here where the image mount
455 will be added to, is the one where the main service process runs.
456 Note that the namespace mentioned here, where the bind mount will
457 be added to, is the one where the main service process runs. Other
458 processes (those exececuted by ExecReload=, ExecStartPre=, etc.)
459 run in distinct namespaces.
460
461 Example:
462
463 systemctl mount-image foo.service /tmp/img.raw /var/lib/image root:ro,nosuid
464
465
466
467 systemctl mount-image --mkdir bar.service /tmp/img.raw /var/lib/baz/img
468
469
470 service-log-level SERVICE [LEVEL]
471 If the LEVEL argument is not given, print the current log level as
472 reported by service SERVICE.
473
474 If the optional argument LEVEL is provided, then change the current
475 log level of the service to LEVEL. The log level should be a
476 typical syslog log level, i.e. a value in the range 0...7 or one of
477 the strings emerg, alert, crit, err, warning, notice, info, debug;
478 see syslog(3) for details.
479
480 The service must have the appropriate BusName=destination property
481 and also implement the generic org.freedesktop.LogControl1(5)
482 interface. (systemctl will use the generic D-Bus protocol to access
483 the org.freedesktop.LogControl1.LogLevel interface for the D-Bus
484 name destination.)
485
486 service-log-target SERVICE [TARGET]
487 If the TARGET argument is not given, print the current log target
488 as reported by service SERVICE.
489
490 If the optional argument TARGET is provided, then change the
491 current log target of the service to TARGET. The log target should
492 be one of the strings console (for log output to the service's
493 standard error stream), kmsg (for log output to the kernel log
494 buffer), journal (for log output to systemd-journald.service(8)
495 using the native journal protocol), syslog (for log output to the
496 classic syslog socket /dev/log), null (for no log output
497 whatsoever) or auto (for an automatically determined choice,
498 typically equivalent to console if the service is invoked
499 interactively, and journal or syslog otherwise).
500
501 For most services, only a small subset of log targets make sense.
502 In particular, most "normal" services should only implement
503 console, journal, and null. Anything else is only appropriate for
504 low-level services that are active in very early boot before proper
505 logging is established.
506
507 The service must have the appropriate BusName=destination property
508 and also implement the generic org.freedesktop.LogControl1(5)
509 interface. (systemctl will use the generic D-Bus protocol to access
510 the org.freedesktop.LogControl1.LogLevel interface for the D-Bus
511 name destination.)
512
513 reset-failed [PATTERN...]
514 Reset the "failed" state of the specified units, or if no unit name
515 is passed, reset the state of all units. When a unit fails in some
516 way (i.e. process exiting with non-zero error code, terminating
517 abnormally or timing out), it will automatically enter the "failed"
518 state and its exit code and status is recorded for introspection by
519 the administrator until the service is stopped/re-started or reset
520 with this command.
521
522 In addition to resetting the "failed" state of a unit it also
523 resets various other per-unit properties: the start rate limit
524 counter of all unit types is reset to zero, as is the restart
525 counter of service units. Thus, if a unit's start limit (as
526 configured with StartLimitIntervalSec=/StartLimitBurst=) is hit and
527 the unit refuses to be started again, use this command to make it
528 startable again.
529
530 Unit File Commands
531 list-unit-files [PATTERN...]
532 List unit files installed on the system, in combination with their
533 enablement state (as reported by is-enabled). If one or more
534 PATTERNs are specified, only unit files whose name matches one of
535 them are shown (patterns matching unit file system paths are not
536 supported).
537
538 Unlike list-units this command will list template units in addition
539 to explicitly instantiated units.
540
541 enable UNIT..., enable PATH...
542 Enable one or more units or unit instances. This will create a set
543 of symlinks, as encoded in the [Install] sections of the indicated
544 unit files. After the symlinks have been created, the system
545 manager configuration is reloaded (in a way equivalent to
546 daemon-reload), in order to ensure the changes are taken into
547 account immediately. Note that this does not have the effect of
548 also starting any of the units being enabled. If this is desired,
549 combine this command with the --now switch, or invoke start with
550 appropriate arguments later. Note that in case of unit instance
551 enablement (i.e. enablement of units of the form foo@bar.service),
552 symlinks named the same as instances are created in the unit
553 configuration directory, however they point to the single template
554 unit file they are instantiated from.
555
556 This command expects either valid unit names (in which case various
557 unit file directories are automatically searched for unit files
558 with appropriate names), or absolute paths to unit files (in which
559 case these files are read directly). If a specified unit file is
560 located outside of the usual unit file directories, an additional
561 symlink is created, linking it into the unit configuration path,
562 thus ensuring it is found when requested by commands such as start.
563 The file system where the linked unit files are located must be
564 accessible when systemd is started (e.g. anything underneath /home/
565 or /var/ is not allowed, unless those directories are located on
566 the root file system).
567
568 This command will print the file system operations executed. This
569 output may be suppressed by passing --quiet.
570
571 Note that this operation creates only the symlinks suggested in the
572 [Install] section of the unit files. While this command is the
573 recommended way to manipulate the unit configuration directory, the
574 administrator is free to make additional changes manually by
575 placing or removing symlinks below this directory. This is
576 particularly useful to create configurations that deviate from the
577 suggested default installation. In this case, the administrator
578 must make sure to invoke daemon-reload manually as necessary, in
579 order to ensure the changes are taken into account.
580
581 Enabling units should not be confused with starting (activating)
582 units, as done by the start command. Enabling and starting units is
583 orthogonal: units may be enabled without being started and started
584 without being enabled. Enabling simply hooks the unit into various
585 suggested places (for example, so that the unit is automatically
586 started on boot or when a particular kind of hardware is plugged
587 in). Starting actually spawns the daemon process (in case of
588 service units), or binds the socket (in case of socket units), and
589 so on.
590
591 Depending on whether --system, --user, --runtime, or --global is
592 specified, this enables the unit for the system, for the calling
593 user only, for only this boot of the system, or for all future
594 logins of all users. Note that in the last case, no systemd daemon
595 configuration is reloaded.
596
597 Using enable on masked units is not supported and results in an
598 error.
599
600 disable UNIT...
601 Disables one or more units. This removes all symlinks to the unit
602 files backing the specified units from the unit configuration
603 directory, and hence undoes any changes made by enable or link.
604 Note that this removes all symlinks to matching unit files,
605 including manually created symlinks, and not just those actually
606 created by enable or link. Note that while disable undoes the
607 effect of enable, the two commands are otherwise not symmetric, as
608 disable may remove more symlinks than a prior enable invocation of
609 the same unit created.
610
611 This command expects valid unit names only, it does not accept
612 paths to unit files.
613
614 In addition to the units specified as arguments, all units are
615 disabled that are listed in the Also= setting contained in the
616 [Install] section of any of the unit files being operated on.
617
618 This command implicitly reloads the system manager configuration
619 after completing the operation. Note that this command does not
620 implicitly stop the units that are being disabled. If this is
621 desired, either combine this command with the --now switch, or
622 invoke the stop command with appropriate arguments later.
623
624 This command will print information about the file system
625 operations (symlink removals) executed. This output may be
626 suppressed by passing --quiet.
627
628 This command honors --system, --user, --runtime and --global in a
629 similar way as enable.
630
631 reenable UNIT...
632 Reenable one or more units, as specified on the command line. This
633 is a combination of disable and enable and is useful to reset the
634 symlinks a unit file is enabled with to the defaults configured in
635 its [Install] section. This command expects a unit name only, it
636 does not accept paths to unit files.
637
638 preset UNIT...
639 Reset the enable/disable status one or more unit files, as
640 specified on the command line, to the defaults configured in the
641 preset policy files. This has the same effect as disable or enable,
642 depending how the unit is listed in the preset files.
643
644 Use --preset-mode= to control whether units shall be enabled and
645 disabled, or only enabled, or only disabled.
646
647 If the unit carries no install information, it will be silently
648 ignored by this command. UNIT must be the real unit name, any
649 alias names are ignored silently.
650
651 For more information on the preset policy format, see
652 systemd.preset(5).
653
654 preset-all
655 Resets all installed unit files to the defaults configured in the
656 preset policy file (see above).
657
658 Use --preset-mode= to control whether units shall be enabled and
659 disabled, or only enabled, or only disabled.
660
661 is-enabled UNIT...
662 Checks whether any of the specified unit files are enabled (as with
663 enable). Returns an exit code of 0 if at least one is enabled,
664 non-zero otherwise. Prints the current enable status (see table).
665 To suppress this output, use --quiet. To show installation targets,
666 use --full.
667
668 Table 1. is-enabled output
669 ┌──────────────────┬─────────────────────────┬───────────┐
670 │Name │ Description │ Exit Code │
671 ├──────────────────┼─────────────────────────┼───────────┤
672 │"enabled" │ Enabled via │ │
673 ├──────────────────┤ .wants/, .requires/ │ │
674 │"enabled-runtime" │ or Alias= symlinks │ │
675 │ │ (permanently in │ 0 │
676 │ │ /etc/systemd/system/, │ │
677 │ │ or transiently in │ │
678 │ │ /run/systemd/system/). │ │
679 ├──────────────────┼─────────────────────────┼───────────┤
680 │"linked" │ Made available through │ │
681 ├──────────────────┤ one or more symlinks │ │
682 │"linked-runtime" │ to the unit file │ │
683 │ │ (permanently in │ │
684 │ │ /etc/systemd/system/ │ │
685 │ │ or transiently in │ > 0 │
686 │ │ /run/systemd/system/), │ │
687 │ │ even though the unit │ │
688 │ │ file might reside │ │
689 │ │ outside of the unit │ │
690 │ │ file search path. │ │
691 ├──────────────────┼─────────────────────────┼───────────┤
692 │"alias" │ The name is an alias │ 0 │
693 │ │ (symlink to another │ │
694 │ │ unit file). │ │
695 ├──────────────────┼─────────────────────────┼───────────┤
696 │"masked" │ Completely disabled, │ │
697 ├──────────────────┤ so that any start │ │
698 │"masked-runtime" │ operation on it fails │ │
699 │ │ (permanently in │ > 0 │
700 │ │ /etc/systemd/system/ │ │
701 │ │ or transiently in │ │
702 │ │ /run/systemd/systemd/). │ │
703 ├──────────────────┼─────────────────────────┼───────────┤
704 │"static" │ The unit file is not │ 0 │
705 │ │ enabled, and has no │ │
706 │ │ provisions for enabling │ │
707 │ │ in the [Install] unit │ │
708 │ │ file section. │ │
709 ├──────────────────┼─────────────────────────┼───────────┤
710 │"indirect" │ The unit file itself is │ 0 │
711 │ │ not enabled, but it has │ │
712 │ │ a non-empty Also= │ │
713 │ │ setting in the │ │
714 │ │ [Install] unit file │ │
715 │ │ section, listing other │ │
716 │ │ unit files that might │ │
717 │ │ be enabled, or it has │ │
718 │ │ an alias under a │ │
719 │ │ different name through │ │
720 │ │ a symlink that is not │ │
721 │ │ specified in Also=. For │ │
722 │ │ template unit files, an │ │
723 │ │ instance different than │ │
724 │ │ the one specified in │ │
725 │ │ DefaultInstance= is │ │
726 │ │ enabled. │ │
727 ├──────────────────┼─────────────────────────┼───────────┤
728 │"disabled" │ The unit file is not │ > 0 │
729 │ │ enabled, but contains │ │
730 │ │ an [Install] section │ │
731 │ │ with installation │ │
732 │ │ instructions. │ │
733 ├──────────────────┼─────────────────────────┼───────────┤
734 │"generated" │ The unit file was │ 0 │
735 │ │ generated dynamically │ │
736 │ │ via a generator tool. │ │
737 │ │ See │ │
738 │ │ systemd.generator(7). │ │
739 │ │ Generated unit files │ │
740 │ │ may not be enabled, │ │
741 │ │ they are enabled │ │
742 │ │ implicitly by their │ │
743 │ │ generator. │ │
744 ├──────────────────┼─────────────────────────┼───────────┤
745 │"transient" │ The unit file has been │ 0 │
746 │ │ created dynamically │ │
747 │ │ with the runtime API. │ │
748 │ │ Transient units may not │ │
749 │ │ be enabled. │ │
750 ├──────────────────┼─────────────────────────┼───────────┤
751 │"bad" │ The unit file is │ > 0 │
752 │ │ invalid or another │ │
753 │ │ error occurred. Note │ │
754 │ │ that is-enabled will │ │
755 │ │ not actually return │ │
756 │ │ this state, but print │ │
757 │ │ an error message │ │
758 │ │ instead. However the │ │
759 │ │ unit file listing │ │
760 │ │ printed by │ │
761 │ │ list-unit-files might │ │
762 │ │ show it. │ │
763 └──────────────────┴─────────────────────────┴───────────┘
764
765 mask UNIT...
766 Mask one or more units, as specified on the command line. This will
767 link these unit files to /dev/null, making it impossible to start
768 them. This is a stronger version of disable, since it prohibits all
769 kinds of activation of the unit, including enablement and manual
770 activation. Use this option with care. This honors the --runtime
771 option to only mask temporarily until the next reboot of the
772 system. The --now option may be used to ensure that the units are
773 also stopped. This command expects valid unit names only, it does
774 not accept unit file paths.
775
776 unmask UNIT...
777 Unmask one or more unit files, as specified on the command line.
778 This will undo the effect of mask. This command expects valid unit
779 names only, it does not accept unit file paths.
780
781 link PATH...
782 Link a unit file that is not in the unit file search paths into the
783 unit file search path. This command expects an absolute path to a
784 unit file. The effect of this may be undone with disable. The
785 effect of this command is that a unit file is made available for
786 commands such as start, even though it is not installed directly in
787 the unit search path. The file system where the linked unit files
788 are located must be accessible when systemd is started (e.g.
789 anything underneath /home/ or /var/ is not allowed, unless those
790 directories are located on the root file system).
791
792 revert UNIT...
793 Revert one or more unit files to their vendor versions. This
794 command removes drop-in configuration files that modify the
795 specified units, as well as any user-configured unit file that
796 overrides a matching vendor supplied unit file. Specifically, for a
797 unit "foo.service" the matching directories "foo.service.d/" with
798 all their contained files are removed, both below the persistent
799 and runtime configuration directories (i.e. below
800 /etc/systemd/system and /run/systemd/system); if the unit file has
801 a vendor-supplied version (i.e. a unit file located below /usr/)
802 any matching persistent or runtime unit file that overrides it is
803 removed, too. Note that if a unit file has no vendor-supplied
804 version (i.e. is only defined below /etc/systemd/system or
805 /run/systemd/system, but not in a unit file stored below /usr/),
806 then it is not removed. Also, if a unit is masked, it is unmasked.
807
808 Effectively, this command may be used to undo all changes made with
809 systemctl edit, systemctl set-property and systemctl mask and puts
810 the original unit file with its settings back in effect.
811
812 add-wants TARGET UNIT..., add-requires TARGET UNIT...
813 Adds "Wants=" or "Requires=" dependencies, respectively, to the
814 specified TARGET for one or more units.
815
816 This command honors --system, --user, --runtime and --global in a
817 way similar to enable.
818
819 edit UNIT...
820 Edit a drop-in snippet or a whole replacement file if --full is
821 specified, to extend or override the specified unit.
822
823 Depending on whether --system (the default), --user, or --global is
824 specified, this command creates a drop-in file for each unit either
825 for the system, for the calling user, or for all futures logins of
826 all users. Then, the editor (see the "Environment" section below)
827 is invoked on temporary files which will be written to the real
828 location if the editor exits successfully.
829
830 If --full is specified, this will copy the original units instead
831 of creating drop-in files.
832
833 If --force is specified and any units do not already exist, new
834 unit files will be opened for editing.
835
836 If --runtime is specified, the changes will be made temporarily in
837 /run/ and they will be lost on the next reboot.
838
839 If the temporary file is empty upon exit, the modification of the
840 related unit is canceled.
841
842 After the units have been edited, systemd configuration is reloaded
843 (in a way that is equivalent to daemon-reload).
844
845 Note that this command cannot be used to remotely edit units and
846 that you cannot temporarily edit units which are in /etc/, since
847 they take precedence over /run/.
848
849 get-default
850 Return the default target to boot into. This returns the target
851 unit name default.target is aliased (symlinked) to.
852
853 set-default TARGET
854 Set the default target to boot into. This sets (symlinks) the
855 default.target alias to the given target unit.
856
857 Machine Commands
858 list-machines [PATTERN...]
859 List the host and all running local containers with their state. If
860 one or more PATTERNs are specified, only containers matching one of
861 them are shown.
862
863 Job Commands
864 list-jobs [PATTERN...]
865 List jobs that are in progress. If one or more PATTERNs are
866 specified, only jobs for units matching one of them are shown.
867
868 When combined with --after or --before the list is augmented with
869 information on which other job each job is waiting for, and which
870 other jobs are waiting for it, see above.
871
872 cancel JOB...
873 Cancel one or more jobs specified on the command line by their
874 numeric job IDs. If no job ID is specified, cancel all pending
875 jobs.
876
877 Environment Commands
878 systemd supports an environment block that is passed to processes the
879 manager spawns. The names of the variables can contain ASCII letters,
880 digits, and the underscore character. Variable names cannot be empty or
881 start with a digit. In variable values, most characters are allowed,
882 but the whole sequence must be valid UTF-8. (Note that control
883 characters like newline (NL), tab (TAB), or the escape character (ESC),
884 are valid ASCII and thus valid UTF-8). The total length of the
885 environment block is limited to _SC_ARG_MAX value defined by
886 sysconf(3).
887
888 show-environment
889 Dump the systemd manager environment block. This is the environment
890 block that is passed to all processes the manager spawns. The
891 environment block will be dumped in straightforward form suitable
892 for sourcing into most shells. If no special characters or
893 whitespace is present in the variable values, no escaping is
894 performed, and the assignments have the form "VARIABLE=value". If
895 whitespace or characters which have special meaning to the shell
896 are present, dollar-single-quote escaping is used, and assignments
897 have the form "VARIABLE=$'value'". This syntax is known to be
898 supported by bash(1), zsh(1), ksh(1), and busybox(1)'s ash(1), but
899 not dash(1) or fish(1).
900
901 set-environment VARIABLE=VALUE...
902 Set one or more systemd manager environment variables, as specified
903 on the command line. This command will fail if variable names and
904 values do not conform to the rules listed above.
905
906 unset-environment VARIABLE...
907 Unset one or more systemd manager environment variables. If only a
908 variable name is specified, it will be removed regardless of its
909 value. If a variable and a value are specified, the variable is
910 only removed if it has the specified value.
911
912 import-environment VARIABLE...
913 Import all, one or more environment variables set on the client
914 into the systemd manager environment block. If a list of
915 environment variable names is passed, client-side values are then
916 imported into the manager's environment block. If any names are not
917 valid environment variable names or have invalid values according
918 to the rules described above, an error is raised. If no arguments
919 are passed, the entire environment block inherited by the systemctl
920 process is imported. In this mode, any inherited invalid
921 environment variables are quietly ignored.
922
923 Importing of the full inherited environment block (calling this
924 command without any arguments) is deprecated. A shell will set
925 dozens of variables which only make sense locally and are only
926 meant for processes which are descendants of the shell. Such
927 variables in the global environment block are confusing to other
928 processes.
929
930 Manager State Commands
931 daemon-reload
932 Reload the systemd manager configuration. This will rerun all
933 generators (see systemd.generator(7)), reload all unit files, and
934 recreate the entire dependency tree. While the daemon is being
935 reloaded, all sockets systemd listens on behalf of user
936 configuration will stay accessible.
937
938 This command should not be confused with the reload command.
939
940 daemon-reexec
941 Reexecute the systemd manager. This will serialize the manager
942 state, reexecute the process and deserialize the state again. This
943 command is of little use except for debugging and package upgrades.
944 Sometimes, it might be helpful as a heavy-weight daemon-reload.
945 While the daemon is being reexecuted, all sockets systemd listening
946 on behalf of user configuration will stay accessible.
947
948 log-level [LEVEL]
949 If no argument is given, print the current log level of the
950 manager. If an optional argument LEVEL is provided, then the
951 command changes the current log level of the manager to LEVEL
952 (accepts the same values as --log-level= described in systemd(1)).
953
954 log-target [TARGET]
955 If no argument is given, print the current log target of the
956 manager. If an optional argument TARGET is provided, then the
957 command changes the current log target of the manager to TARGET
958 (accepts the same values as --log-target=, described in
959 systemd(1)).
960
961 service-watchdogs [yes|no]
962 If no argument is given, print the current state of service runtime
963 watchdogs of the manager. If an optional boolean argument is
964 provided, then globally enables or disables the service runtime
965 watchdogs (WatchdogSec=) and emergency actions (e.g. OnFailure= or
966 StartLimitAction=); see systemd.service(5). The hardware watchdog
967 is not affected by this setting.
968
969 System Commands
970 is-system-running
971 Checks whether the system is operational. This returns success
972 (exit code 0) when the system is fully up and running, specifically
973 not in startup, shutdown or maintenance mode, and with no failed
974 services. Failure is returned otherwise (exit code non-zero). In
975 addition, the current state is printed in a short string to
976 standard output, see the table below. Use --quiet to suppress this
977 output.
978
979 Use --wait to wait until the boot process is completed before
980 printing the current state and returning the appropriate error
981 status. If --wait is in use, states initializing or starting will
982 not be reported, instead the command will block until a later state
983 (such as running or degraded) is reached.
984
985 Table 2. is-system-running output
986 ┌─────────────┬─────────────────────┬───────────┐
987 │Name │ Description │ Exit Code │
988 ├─────────────┼─────────────────────┼───────────┤
989 │initializing │ Early bootup, │ > 0 │
990 │ │ before basic.target │ │
991 │ │ is reached or the │ │
992 │ │ maintenance state │ │
993 │ │ entered. │ │
994 ├─────────────┼─────────────────────┼───────────┤
995 │starting │ Late bootup, before │ > 0 │
996 │ │ the job queue │ │
997 │ │ becomes idle for │ │
998 │ │ the first time, or │ │
999 │ │ one of the rescue │ │
1000 │ │ targets are │ │
1001 │ │ reached. │ │
1002 ├─────────────┼─────────────────────┼───────────┤
1003 │running │ The system is fully │ 0 │
1004 │ │ operational. │ │
1005 ├─────────────┼─────────────────────┼───────────┤
1006 │degraded │ The system is │ > 0 │
1007 │ │ operational but one │ │
1008 │ │ or more units │ │
1009 │ │ failed. │ │
1010 ├─────────────┼─────────────────────┼───────────┤
1011 │maintenance │ The rescue or │ > 0 │
1012 │ │ emergency target is │ │
1013 │ │ active. │ │
1014 ├─────────────┼─────────────────────┼───────────┤
1015 │stopping │ The manager is │ > 0 │
1016 │ │ shutting down. │ │
1017 ├─────────────┼─────────────────────┼───────────┤
1018 │offline │ The manager is not │ > 0 │
1019 │ │ running. │ │
1020 │ │ Specifically, this │ │
1021 │ │ is the operational │ │
1022 │ │ state if an │ │
1023 │ │ incompatible │ │
1024 │ │ program is running │ │
1025 │ │ as system manager │ │
1026 │ │ (PID 1). │ │
1027 ├─────────────┼─────────────────────┼───────────┤
1028 │unknown │ The operational │ > 0 │
1029 │ │ state could not be │ │
1030 │ │ determined, due to │ │
1031 │ │ lack of resources │ │
1032 │ │ or another error │ │
1033 │ │ cause. │ │
1034 └─────────────┴─────────────────────┴───────────┘
1035
1036 default
1037 Enter default mode. This is equivalent to systemctl isolate
1038 default.target. This operation is blocking by default, use
1039 --no-block to request asynchronous behavior.
1040
1041 rescue
1042 Enter rescue mode. This is equivalent to systemctl isolate
1043 rescue.target. This operation is blocking by default, use
1044 --no-block to request asynchronous behavior.
1045
1046 emergency
1047 Enter emergency mode. This is equivalent to systemctl isolate
1048 emergency.target. This operation is blocking by default, use
1049 --no-block to request asynchronous behavior.
1050
1051 halt
1052 Shut down and halt the system. This is mostly equivalent to
1053 systemctl start halt.target --job-mode=replace-irreversibly
1054 --no-block, but also prints a wall message to all users. This
1055 command is asynchronous; it will return after the halt operation is
1056 enqueued, without waiting for it to complete. Note that this
1057 operation will simply halt the OS kernel after shutting down,
1058 leaving the hardware powered on. Use systemctl poweroff for
1059 powering off the system (see below).
1060
1061 If combined with --force, shutdown of all running services is
1062 skipped, however all processes are killed and all file systems are
1063 unmounted or mounted read-only, immediately followed by the system
1064 halt. If --force is specified twice, the operation is immediately
1065 executed without terminating any processes or unmounting any file
1066 systems. This may result in data loss. Note that when --force is
1067 specified twice the halt operation is executed by systemctl itself,
1068 and the system manager is not contacted. This means the command
1069 should succeed even when the system manager has crashed.
1070
1071 poweroff
1072 Shut down and power-off the system. This is mostly equivalent to
1073 systemctl start poweroff.target --job-mode=replace-irreversibly
1074 --no-block, but also prints a wall message to all users. This
1075 command is asynchronous; it will return after the power-off
1076 operation is enqueued, without waiting for it to complete.
1077
1078 If combined with --force, shutdown of all running services is
1079 skipped, however all processes are killed and all file systems are
1080 unmounted or mounted read-only, immediately followed by the
1081 powering off. If --force is specified twice, the operation is
1082 immediately executed without terminating any processes or
1083 unmounting any file systems. This may result in data loss. Note
1084 that when --force is specified twice the power-off operation is
1085 executed by systemctl itself, and the system manager is not
1086 contacted. This means the command should succeed even when the
1087 system manager has crashed.
1088
1089 reboot
1090 Shut down and reboot the system.
1091
1092 This command mostly equivalent to systemctl start reboot.target
1093 --job-mode=replace-irreversibly --no-block, but also prints a wall
1094 message to all users. This command is asynchronous; it will return
1095 after the reboot operation is enqueued, without waiting for it to
1096 complete.
1097
1098 If combined with --force, shutdown of all running services is
1099 skipped, however all processes are killed and all file systems are
1100 unmounted or mounted read-only, immediately followed by the reboot.
1101 If --force is specified twice, the operation is immediately
1102 executed without terminating any processes or unmounting any file
1103 systems. This may result in data loss. Note that when --force is
1104 specified twice the reboot operation is executed by systemctl
1105 itself, and the system manager is not contacted. This means the
1106 command should succeed even when the system manager has crashed.
1107
1108 If the switch --reboot-argument= is given, it will be passed as the
1109 optional argument to the reboot(2) system call.
1110
1111 Options --boot-loader-entry=, --boot-loader-menu=, and
1112 --firmware-setup can be used to select what to do after the reboot.
1113 See the descriptions of those options for details.
1114
1115 kexec
1116 Shut down and reboot the system via kexec. This is equivalent to
1117 systemctl start kexec.target --job-mode=replace-irreversibly
1118 --no-block. This command is asynchronous; it will return after the
1119 reboot operation is enqueued, without waiting for it to complete.
1120
1121 If combined with --force, shutdown of all running services is
1122 skipped, however all processes are killed and all file systems are
1123 unmounted or mounted read-only, immediately followed by the reboot.
1124
1125 exit [EXIT_CODE]
1126 Ask the service manager to quit. This is only supported for user
1127 service managers (i.e. in conjunction with the --user option) or in
1128 containers and is equivalent to poweroff otherwise. This command is
1129 asynchronous; it will return after the exit operation is enqueued,
1130 without waiting for it to complete.
1131
1132 The service manager will exit with the specified exit code, if
1133 EXIT_CODE is passed.
1134
1135 switch-root ROOT [INIT]
1136 Switches to a different root directory and executes a new system
1137 manager process below it. This is intended for usage in initial RAM
1138 disks ("initrd"), and will transition from the initrd's system
1139 manager process (a.k.a. "init" process) to the main system manager
1140 process which is loaded from the actual host volume. This call
1141 takes two arguments: the directory that is to become the new root
1142 directory, and the path to the new system manager binary below it
1143 to execute as PID 1. If the latter is omitted or the empty string,
1144 a systemd binary will automatically be searched for and used as
1145 init. If the system manager path is omitted, equal to the empty
1146 string or identical to the path to the systemd binary, the state of
1147 the initrd's system manager process is passed to the main system
1148 manager, which allows later introspection of the state of the
1149 services involved in the initrd boot phase.
1150
1151 suspend
1152 Suspend the system. This will trigger activation of the special
1153 target unit suspend.target. This command is asynchronous, and will
1154 return after the suspend operation is successfully enqueued. It
1155 will not wait for the suspend/resume cycle to complete.
1156
1157 hibernate
1158 Hibernate the system. This will trigger activation of the special
1159 target unit hibernate.target. This command is asynchronous, and
1160 will return after the hibernation operation is successfully
1161 enqueued. It will not wait for the hibernate/thaw cycle to
1162 complete.
1163
1164 hybrid-sleep
1165 Hibernate and suspend the system. This will trigger activation of
1166 the special target unit hybrid-sleep.target. This command is
1167 asynchronous, and will return after the hybrid sleep operation is
1168 successfully enqueued. It will not wait for the sleep/wake-up cycle
1169 to complete.
1170
1171 suspend-then-hibernate
1172 Suspend the system and hibernate it after the delay specified in
1173 systemd-sleep.conf. This will trigger activation of the special
1174 target unit suspend-then-hibernate.target. This command is
1175 asynchronous, and will return after the hybrid sleep operation is
1176 successfully enqueued. It will not wait for the sleep/wake-up or
1177 hibernate/thaw cycle to complete.
1178
1179 Parameter Syntax
1180 Unit commands listed above take either a single unit name (designated
1181 as UNIT), or multiple unit specifications (designated as PATTERN...).
1182 In the first case, the unit name with or without a suffix must be
1183 given. If the suffix is not specified (unit name is "abbreviated"),
1184 systemctl will append a suitable suffix, ".service" by default, and a
1185 type-specific suffix in case of commands which operate only on specific
1186 unit types. For example,
1187
1188 # systemctl start sshd
1189
1190 and
1191
1192 # systemctl start sshd.service
1193
1194 are equivalent, as are
1195
1196 # systemctl isolate default
1197
1198 and
1199
1200 # systemctl isolate default.target
1201
1202 Note that (absolute) paths to device nodes are automatically converted
1203 to device unit names, and other (absolute) paths to mount unit names.
1204
1205 # systemctl status /dev/sda
1206 # systemctl status /home
1207
1208 are equivalent to:
1209
1210 # systemctl status dev-sda.device
1211 # systemctl status home.mount
1212
1213 In the second case, shell-style globs will be matched against the
1214 primary names of all units currently in memory; literal unit names,
1215 with or without a suffix, will be treated as in the first case. This
1216 means that literal unit names always refer to exactly one unit, but
1217 globs may match zero units and this is not considered an error.
1218
1219 Glob patterns use fnmatch(3), so normal shell-style globbing rules are
1220 used, and "*", "?", "[]" may be used. See glob(7) for more details. The
1221 patterns are matched against the primary names of units currently in
1222 memory, and patterns which do not match anything are silently skipped.
1223 For example:
1224
1225 # systemctl stop sshd@*.service
1226
1227 will stop all sshd@.service instances. Note that alias names of units,
1228 and units that aren't in memory are not considered for glob expansion.
1229
1230 For unit file commands, the specified UNIT should be the name of the
1231 unit file (possibly abbreviated, see above), or the absolute path to
1232 the unit file:
1233
1234 # systemctl enable foo.service
1235
1236 or
1237
1238 # systemctl link /path/to/foo.service
1239
1240
1242 The following options are understood:
1243
1244 -t, --type=
1245 The argument should be a comma-separated list of unit types such as
1246 service and socket.
1247
1248 If one of the arguments is a unit type, when listing units, limit
1249 display to certain unit types. Otherwise, units of all types will
1250 be shown.
1251
1252 As a special case, if one of the arguments is help, a list of
1253 allowed values will be printed and the program will exit.
1254
1255 --state=
1256 The argument should be a comma-separated list of unit LOAD, SUB, or
1257 ACTIVE states. When listing units, show only those in the specified
1258 states. Use --state=failed to show only failed units.
1259
1260 As a special case, if one of the arguments is help, a list of
1261 allowed values will be printed and the program will exit.
1262
1263 -p, --property=
1264 When showing unit/job/manager properties with the show command,
1265 limit display to properties specified in the argument. The argument
1266 should be a comma-separated list of property names, such as
1267 "MainPID". Unless specified, all known properties are shown. If
1268 specified more than once, all properties with the specified names
1269 are shown. Shell completion is implemented for property names.
1270
1271 For the manager itself, systemctl show will show all available
1272 properties, most of which are derived or closely match the options
1273 described in systemd-system.conf(5).
1274
1275 Properties for units vary by unit type, so showing any unit (even a
1276 non-existent one) is a way to list properties pertaining to this
1277 type. Similarly, showing any job will list properties pertaining to
1278 all jobs. Properties for units are documented in systemd.unit(5),
1279 and the pages for individual unit types systemd.service(5),
1280 systemd.socket(5), etc.
1281
1282 -P
1283 Equivalent to --value --property=, i.e. shows the value of the
1284 property without the property name or "=". Note that using -P once
1285 will also affect all properties listed with -p/--property=.
1286
1287 -a, --all
1288 When listing units with list-units, also show inactive units and
1289 units which are following other units. When showing
1290 unit/job/manager properties, show all properties regardless whether
1291 they are set or not.
1292
1293 To list all units installed in the file system, use the
1294 list-unit-files command instead.
1295
1296 When listing units with list-dependencies, recursively show
1297 dependencies of all dependent units (by default only dependencies
1298 of target units are shown).
1299
1300 When used with status, show journal messages in full, even if they
1301 include unprintable characters or are very long. By default, fields
1302 with unprintable characters are abbreviated as "blob data". (Note
1303 that the pager may escape unprintable characters again.)
1304
1305 -r, --recursive
1306 When listing units, also show units of local containers. Units of
1307 local containers will be prefixed with the container name,
1308 separated by a single colon character (":").
1309
1310 --reverse
1311 Show reverse dependencies between units with list-dependencies,
1312 i.e. follow dependencies of type WantedBy=, RequiredBy=, PartOf=,
1313 BoundBy=, instead of Wants= and similar.
1314
1315 --after
1316 With list-dependencies, show the units that are ordered before the
1317 specified unit. In other words, recursively list units following
1318 the After= dependency.
1319
1320 Note that any After= dependency is automatically mirrored to create
1321 a Before= dependency. Temporal dependencies may be specified
1322 explicitly, but are also created implicitly for units which are
1323 WantedBy= targets (see systemd.target(5)), and as a result of other
1324 directives (for example RequiresMountsFor=). Both explicitly and
1325 implicitly introduced dependencies are shown with
1326 list-dependencies.
1327
1328 When passed to the list-jobs command, for each printed job show
1329 which other jobs are waiting for it. May be combined with --before
1330 to show both the jobs waiting for each job as well as all jobs each
1331 job is waiting for.
1332
1333 --before
1334 With list-dependencies, show the units that are ordered after the
1335 specified unit. In other words, recursively list units following
1336 the Before= dependency.
1337
1338 When passed to the list-jobs command, for each printed job show
1339 which other jobs it is waiting for. May be combined with --after to
1340 show both the jobs waiting for each job as well as all jobs each
1341 job is waiting for.
1342
1343 --with-dependencies
1344 When used with status, cat, list-units, and list-unit-files, those
1345 commands print all specified units and the dependencies of those
1346 units.
1347
1348 Options --reverse, --after, --before may be used to change what
1349 types of dependencies are shown.
1350
1351 -l, --full
1352 Do not ellipsize unit names, process tree entries, journal output,
1353 or truncate unit descriptions in the output of status, list-units,
1354 list-jobs, and list-timers.
1355
1356 Also, show installation targets in the output of is-enabled.
1357
1358 --value
1359 When printing properties with show, only print the value, and skip
1360 the property name and "=". Also see option -P above.
1361
1362 --show-types
1363 When showing sockets, show the type of the socket.
1364
1365 --job-mode=
1366 When queuing a new job, this option controls how to deal with
1367 already queued jobs. It takes one of "fail", "replace",
1368 "replace-irreversibly", "isolate", "ignore-dependencies",
1369 "ignore-requirements", "flush", or "triggering". Defaults to
1370 "replace", except when the isolate command is used which implies
1371 the "isolate" job mode.
1372
1373 If "fail" is specified and a requested operation conflicts with a
1374 pending job (more specifically: causes an already pending start job
1375 to be reversed into a stop job or vice versa), cause the operation
1376 to fail.
1377
1378 If "replace" (the default) is specified, any conflicting pending
1379 job will be replaced, as necessary.
1380
1381 If "replace-irreversibly" is specified, operate like "replace", but
1382 also mark the new jobs as irreversible. This prevents future
1383 conflicting transactions from replacing these jobs (or even being
1384 enqueued while the irreversible jobs are still pending).
1385 Irreversible jobs can still be cancelled using the cancel command.
1386 This job mode should be used on any transaction which pulls in
1387 shutdown.target.
1388
1389 "isolate" is only valid for start operations and causes all other
1390 units to be stopped when the specified unit is started. This mode
1391 is always used when the isolate command is used.
1392
1393 "flush" will cause all queued jobs to be canceled when the new job
1394 is enqueued.
1395
1396 If "ignore-dependencies" is specified, then all unit dependencies
1397 are ignored for this new job and the operation is executed
1398 immediately. If passed, no required units of the unit passed will
1399 be pulled in, and no ordering dependencies will be honored. This is
1400 mostly a debugging and rescue tool for the administrator and should
1401 not be used by applications.
1402
1403 "ignore-requirements" is similar to "ignore-dependencies", but only
1404 causes the requirement dependencies to be ignored, the ordering
1405 dependencies will still be honored.
1406
1407 "triggering" may only be used with systemctl stop. In this mode,
1408 the specified unit and any active units that trigger it are
1409 stopped. See the discussion of Triggers= in systemd.unit(5) for
1410 more information about triggering units.
1411
1412 -T, --show-transaction
1413 When enqueuing a unit job (for example as effect of a systemctl
1414 start invocation or similar), show brief information about all jobs
1415 enqueued, covering both the requested job and any added because of
1416 unit dependencies. Note that the output will only include jobs
1417 immediately part of the transaction requested. It is possible that
1418 service start-up program code run as effect of the enqueued jobs
1419 might request further jobs to be pulled in. This means that
1420 completion of the listed jobs might ultimately entail more jobs
1421 than the listed ones.
1422
1423 --fail
1424 Shorthand for --job-mode=fail.
1425
1426 When used with the kill command, if no units were killed, the
1427 operation results in an error.
1428
1429 --check-inhibitors=
1430 When system shutdown or sleep state is request, this option
1431 controls how to deal with inhibitor locks. It takes one of "auto",
1432 "yes" or "no". Defaults to "auto", which will behave like "yes" for
1433 interactive invocations (i.e. from a TTY) and "no" for
1434 non-interactive invocations. "yes" will let the request respect
1435 inhibitor locks. "no" will let the request ignore inhibitor locks.
1436
1437 Applications can establish inhibitor locks to avoid that certain
1438 important operations (such as CD burning or suchlike) are
1439 interrupted by system shutdown or a sleep state. Any user may take
1440 these locks and privileged users may override these locks. If any
1441 locks are taken, shutdown and sleep state requests will normally
1442 fail (unless privileged) and a list of active locks is printed.
1443 However, if "no" is specified or "auto" is specified on a
1444 non-interactive requests, the established locks are ignored and not
1445 shown, and the operation attempted anyway, possibly requiring
1446 additional privileges. May be overridden by --force.
1447
1448 -i
1449 Shortcut for --check-inhibitors=no.
1450
1451 --dry-run
1452 Just print what would be done. Currently supported by verbs halt,
1453 poweroff, reboot, kexec, suspend, hibernate, hybrid-sleep,
1454 suspend-then-hibernate, default, rescue, emergency, and exit.
1455
1456 -q, --quiet
1457 Suppress printing of the results of various commands and also the
1458 hints about truncated log lines. This does not suppress output of
1459 commands for which the printed output is the only result (like
1460 show). Errors are always printed.
1461
1462 --no-block
1463 Do not synchronously wait for the requested operation to finish. If
1464 this is not specified, the job will be verified, enqueued and
1465 systemctl will wait until the unit's start-up is completed. By
1466 passing this argument, it is only verified and enqueued. This
1467 option may not be combined with --wait.
1468
1469 --wait
1470 Synchronously wait for started units to terminate again. This
1471 option may not be combined with --no-block. Note that this will
1472 wait forever if any given unit never terminates (by itself or by
1473 getting stopped explicitly); particularly services which use
1474 "RemainAfterExit=yes".
1475
1476 When used with is-system-running, wait until the boot process is
1477 completed before returning.
1478
1479 --user
1480 Talk to the service manager of the calling user, rather than the
1481 service manager of the system.
1482
1483 --system
1484 Talk to the service manager of the system. This is the implied
1485 default.
1486
1487 --failed
1488 List units in failed state. This is equivalent to --state=failed.
1489
1490 --no-wall
1491 Do not send wall message before halt, power-off and reboot.
1492
1493 --global
1494 When used with enable and disable, operate on the global user
1495 configuration directory, thus enabling or disabling a unit file
1496 globally for all future logins of all users.
1497
1498 --no-reload
1499 When used with enable and disable, do not implicitly reload daemon
1500 configuration after executing the changes.
1501
1502 --no-ask-password
1503 When used with start and related commands, disables asking for
1504 passwords. Background services may require input of a password or
1505 passphrase string, for example to unlock system hard disks or
1506 cryptographic certificates. Unless this option is specified and the
1507 command is invoked from a terminal, systemctl will query the user
1508 on the terminal for the necessary secrets. Use this option to
1509 switch this behavior off. In this case, the password must be
1510 supplied by some other means (for example graphical password
1511 agents) or the service might fail. This also disables querying the
1512 user for authentication for privileged operations.
1513
1514 --kill-who=
1515 When used with kill, choose which processes to send a signal to.
1516 Must be one of main, control or all to select whether to kill only
1517 the main process, the control process or all processes of the unit.
1518 The main process of the unit is the one that defines the life-time
1519 of it. A control process of a unit is one that is invoked by the
1520 manager to induce state changes of it. For example, all processes
1521 started due to the ExecStartPre=, ExecStop= or ExecReload= settings
1522 of service units are control processes. Note that there is only one
1523 control process per unit at a time, as only one state change is
1524 executed at a time. For services of type Type=forking, the initial
1525 process started by the manager for ExecStart= is a control process,
1526 while the process ultimately forked off by that one is then
1527 considered the main process of the unit (if it can be determined).
1528 This is different for service units of other types, where the
1529 process forked off by the manager for ExecStart= is always the main
1530 process itself. A service unit consists of zero or one main
1531 process, zero or one control process plus any number of additional
1532 processes. Not all unit types manage processes of these types
1533 however. For example, for mount units, control processes are
1534 defined (which are the invocations of /usr/bin/mount and
1535 /usr/bin/umount), but no main process is defined. If omitted,
1536 defaults to all.
1537
1538 -s, --signal=
1539 When used with kill, choose which signal to send to selected
1540 processes. Must be one of the well-known signal specifiers such as
1541 SIGTERM, SIGINT or SIGSTOP. If omitted, defaults to SIGTERM.
1542
1543 The special value "help" will list the known values and the program
1544 will exit immediately, and the special value "list" will list known
1545 values along with the numerical signal numbers and the program will
1546 exit immediately.
1547
1548 --what=
1549 Select what type of per-unit resources to remove when the clean
1550 command is invoked, see below. Takes one of configuration, state,
1551 cache, logs, runtime to select the type of resource. This option
1552 may be specified more than once, in which case all specified
1553 resource types are removed. Also accepts the special value all as a
1554 shortcut for specifying all five resource types. If this option is
1555 not specified defaults to the combination of cache and runtime,
1556 i.e. the two kinds of resources that are generally considered to be
1557 redundant and can be reconstructed on next invocation.
1558
1559 -f, --force
1560 When used with enable, overwrite any existing conflicting symlinks.
1561
1562 When used with edit, create all of the specified units which do not
1563 already exist.
1564
1565 When used with halt, poweroff, reboot or kexec, execute the
1566 selected operation without shutting down all units. However, all
1567 processes will be killed forcibly and all file systems are
1568 unmounted or remounted read-only. This is hence a drastic but
1569 relatively safe option to request an immediate reboot. If --force
1570 is specified twice for these operations (with the exception of
1571 kexec), they will be executed immediately, without terminating any
1572 processes or unmounting any file systems. Warning: specifying
1573 --force twice with any of these operations might result in data
1574 loss. Note that when --force is specified twice the selected
1575 operation is executed by systemctl itself, and the system manager
1576 is not contacted. This means the command should succeed even when
1577 the system manager has crashed.
1578
1579 --message=
1580 When used with halt, poweroff or reboot, set a short message
1581 explaining the reason for the operation. The message will be logged
1582 together with the default shutdown message.
1583
1584 --now
1585 When used with enable, the units will also be started. When used
1586 with disable or mask, the units will also be stopped. The start or
1587 stop operation is only carried out when the respective enable or
1588 disable operation has been successful.
1589
1590 --root=
1591 When used with enable/disable/is-enabled (and related commands),
1592 use the specified root path when looking for unit files. If this
1593 option is present, systemctl will operate on the file system
1594 directly, instead of communicating with the systemd daemon to carry
1595 out changes.
1596
1597 --runtime
1598 When used with enable, disable, edit, (and related commands), make
1599 changes only temporarily, so that they are lost on the next reboot.
1600 This will have the effect that changes are not made in
1601 subdirectories of /etc/ but in /run/, with identical immediate
1602 effects, however, since the latter is lost on reboot, the changes
1603 are lost too.
1604
1605 Similarly, when used with set-property, make changes only
1606 temporarily, so that they are lost on the next reboot.
1607
1608 --preset-mode=
1609 Takes one of "full" (the default), "enable-only", "disable-only".
1610 When used with the preset or preset-all commands, controls whether
1611 units shall be disabled and enabled according to the preset rules,
1612 or only enabled, or only disabled.
1613
1614 -n, --lines=
1615 When used with status, controls the number of journal lines to
1616 show, counting from the most recent ones. Takes a positive integer
1617 argument, or 0 to disable journal output. Defaults to 10.
1618
1619 -o, --output=
1620 When used with status, controls the formatting of the journal
1621 entries that are shown. For the available choices, see
1622 journalctl(1). Defaults to "short".
1623
1624 --firmware-setup
1625 When used with the reboot command, indicate to the system's
1626 firmware to reboot into the firmware setup interface. Note that
1627 this functionality is not available on all systems.
1628
1629 --boot-loader-menu=timeout
1630 When used with the reboot command, indicate to the system's boot
1631 loader to show the boot loader menu on the following boot. Takes a
1632 time value as parameter — indicating the menu timeout. Pass zero in
1633 order to disable the menu timeout. Note that not all boot loaders
1634 support this functionality.
1635
1636 --boot-loader-entry=ID
1637 When used with the reboot command, indicate to the system's boot
1638 loader to boot into a specific boot loader entry on the following
1639 boot. Takes a boot loader entry identifier as argument, or "help"
1640 in order to list available entries. Note that not all boot loaders
1641 support this functionality.
1642
1643 --reboot-argument=
1644 This switch is used with reboot. The value is architecture and
1645 firmware specific. As an example, "recovery" might be used to
1646 trigger system recovery, and "fota" might be used to trigger a
1647 “firmware over the air” update.
1648
1649 --plain
1650 When used with list-dependencies, list-units or list-machines, the
1651 output is printed as a list instead of a tree, and the bullet
1652 circles are omitted.
1653
1654 --timestamp=
1655 Change the format of printed timestamps. The following values may
1656 be used:
1657
1658 pretty (this is the default)
1659 "Day YYYY-MM-DD HH:MM:SS TZ"
1660
1661 unix
1662 "@seconds-since-the-epoch"
1663
1664 us, µs
1665 "Day YYYY-MM-DD HH:MM:SS.UUUUUU TZ"
1666
1667 utc
1668 "Day YYYY-MM-DD HH:MM:SS UTC"
1669
1670 us+utc, µs+utc
1671 "Day YYYY-MM-DD HH:MM:SS.UUUUUU UTC"
1672
1673 --mkdir
1674 When used with bind, creates the destination file or directory
1675 before applying the bind mount. Note that even though the name of
1676 this option suggests that it is suitable only for directories, this
1677 option also creates the destination file node to mount over if the
1678 object to mount is not a directory, but a regular file, device
1679 node, socket or FIFO.
1680
1681 --marked
1682 Only allowed with reload-or-restart. Enqueues restart jobs for all
1683 units that have the "needs-restart" mark, and reload jobs for units
1684 that have the "needs-reload" mark. When a unit marked for reload
1685 does not support reload, restart will be queued. Those properties
1686 can be set using set-property Markers=....
1687
1688 Unless --no-block is used, systemctl will wait for the queued jobs
1689 to finish.
1690
1691 --read-only
1692 When used with bind, creates a read-only bind mount.
1693
1694 -H, --host=
1695 Execute the operation remotely. Specify a hostname, or a username
1696 and hostname separated by "@", to connect to. The hostname may
1697 optionally be suffixed by a port ssh is listening on, separated by
1698 ":", and then a container name, separated by "/", which connects
1699 directly to a specific container on the specified host. This will
1700 use SSH to talk to the remote machine manager instance. Container
1701 names may be enumerated with machinectl -H HOST. Put IPv6 addresses
1702 in brackets.
1703
1704 -M, --machine=
1705 Execute operation on a local container. Specify a container name to
1706 connect to, optionally prefixed by a user name to connect as and a
1707 separating "@" character. If the special string ".host" is used in
1708 place of the container name, a connection to the local system is
1709 made (which is useful to connect to a specific user's user bus:
1710 "--user --machine=lennart@.host"). If the "@" syntax is not used,
1711 the connection is made as root user. If the "@" syntax is used
1712 either the left hand side or the right hand side may be omitted
1713 (but not both) in which case the local user name and ".host" are
1714 implied.
1715
1716 --no-pager
1717 Do not pipe output into a pager.
1718
1719 --legend=BOOL
1720 Enable or disable printing of the legend, i.e. column headers and
1721 the footer with hints. The legend is printed by default, unless
1722 disabled with --quiet or similar.
1723
1724 -h, --help
1725 Print a short help text and exit.
1726
1727 --version
1728 Print a short version string and exit.
1729
1731 On success, 0 is returned, a non-zero failure code otherwise.
1732
1733 systemctl uses the return codes defined by LSB, as defined in LSB
1734 3.0.0[1].
1735
1736 Table 3. LSB return codes
1737 ┌──────┬─────────────────────┬─────────────────────┐
1738 │Value │ Description in LSB │ Use in systemd │
1739 ├──────┼─────────────────────┼─────────────────────┤
1740 │0 │ "program is running │ unit is active │
1741 │ │ or service is OK" │ │
1742 ├──────┼─────────────────────┼─────────────────────┤
1743 │1 │ "program is dead │ unit not failed │
1744 │ │ and /var/run pid │ (used by is-failed) │
1745 │ │ file exists" │ │
1746 ├──────┼─────────────────────┼─────────────────────┤
1747 │2 │ "program is dead │ unused │
1748 │ │ and /var/lock lock │ │
1749 │ │ file exists" │ │
1750 ├──────┼─────────────────────┼─────────────────────┤
1751 │3 │ "program is not │ unit is not active │
1752 │ │ running" │ │
1753 ├──────┼─────────────────────┼─────────────────────┤
1754 │4 │ "program or service │ no such unit │
1755 │ │ status is unknown" │ │
1756 └──────┴─────────────────────┴─────────────────────┘
1757
1758 The mapping of LSB service states to systemd unit states is imperfect,
1759 so it is better to not rely on those return values but to look for
1760 specific unit states and substates instead.
1761
1763 $SYSTEMD_EDITOR
1764 Editor to use when editing units; overrides $EDITOR and $VISUAL. If
1765 neither $SYSTEMD_EDITOR nor $EDITOR nor $VISUAL are present or if
1766 it is set to an empty string or if their execution failed,
1767 systemctl will try to execute well known editors in this order:
1768 editor(1), nano(1), vim(1), vi(1).
1769
1770 $SYSTEMD_LOG_LEVEL
1771 The maximum log level of emitted messages (messages with a higher
1772 log level, i.e. less important ones, will be suppressed). Either
1773 one of (in order of decreasing importance) emerg, alert, crit, err,
1774 warning, notice, info, debug, or an integer in the range 0...7. See
1775 syslog(3) for more information.
1776
1777 $SYSTEMD_LOG_COLOR
1778 A boolean. If true, messages written to the tty will be colored
1779 according to priority.
1780
1781 This setting is only useful when messages are written directly to
1782 the terminal, because journalctl(1) and other tools that display
1783 logs will color messages based on the log level on their own.
1784
1785 $SYSTEMD_LOG_TIME
1786 A boolean. If true, console log messages will be prefixed with a
1787 timestamp.
1788
1789 This setting is only useful when messages are written directly to
1790 the terminal or a file, because journalctl(1) and other tools that
1791 display logs will attach timestamps based on the entry metadata on
1792 their own.
1793
1794 $SYSTEMD_LOG_LOCATION
1795 A boolean. If true, messages will be prefixed with a filename and
1796 line number in the source code where the message originates.
1797
1798 Note that the log location is often attached as metadata to journal
1799 entries anyway. Including it directly in the message text can
1800 nevertheless be convenient when debugging programs.
1801
1802 $SYSTEMD_LOG_TARGET
1803 The destination for log messages. One of console (log to the
1804 attached tty), console-prefixed (log to the attached tty but with
1805 prefixes encoding the log level and "facility", see syslog(3), kmsg
1806 (log to the kernel circular log buffer), journal (log to the
1807 journal), journal-or-kmsg (log to the journal if available, and to
1808 kmsg otherwise), auto (determine the appropriate log target
1809 automatically, the default), null (disable log output).
1810
1811 $SYSTEMD_PAGER
1812 Pager to use when --no-pager is not given; overrides $PAGER. If
1813 neither $SYSTEMD_PAGER nor $PAGER are set, a set of well-known
1814 pager implementations are tried in turn, including less(1) and
1815 more(1), until one is found. If no pager implementation is
1816 discovered no pager is invoked. Setting this environment variable
1817 to an empty string or the value "cat" is equivalent to passing
1818 --no-pager.
1819
1820 Note: if $SYSTEMD_PAGERSECURE is not set, $SYSTEMD_PAGER (as well
1821 as $PAGER) will be silently ignored.
1822
1823 $SYSTEMD_LESS
1824 Override the options passed to less (by default "FRSXMK").
1825
1826 Users might want to change two options in particular:
1827
1828 K
1829 This option instructs the pager to exit immediately when Ctrl+C
1830 is pressed. To allow less to handle Ctrl+C itself to switch
1831 back to the pager command prompt, unset this option.
1832
1833 If the value of $SYSTEMD_LESS does not include "K", and the
1834 pager that is invoked is less, Ctrl+C will be ignored by the
1835 executable, and needs to be handled by the pager.
1836
1837 X
1838 This option instructs the pager to not send termcap
1839 initialization and deinitialization strings to the terminal. It
1840 is set by default to allow command output to remain visible in
1841 the terminal even after the pager exits. Nevertheless, this
1842 prevents some pager functionality from working, in particular
1843 paged output cannot be scrolled with the mouse.
1844
1845 See less(1) for more discussion.
1846
1847 $SYSTEMD_LESSCHARSET
1848 Override the charset passed to less (by default "utf-8", if the
1849 invoking terminal is determined to be UTF-8 compatible).
1850
1851 $SYSTEMD_PAGERSECURE
1852 Takes a boolean argument. When true, the "secure" mode of the pager
1853 is enabled; if false, disabled. If $SYSTEMD_PAGERSECURE is not set
1854 at all, secure mode is enabled if the effective UID is not the same
1855 as the owner of the login session, see geteuid(2) and
1856 sd_pid_get_owner_uid(3). In secure mode, LESSSECURE=1 will be set
1857 when invoking the pager, and the pager shall disable commands that
1858 open or create new files or start new subprocesses. When
1859 $SYSTEMD_PAGERSECURE is not set at all, pagers which are not known
1860 to implement secure mode will not be used. (Currently only less(1)
1861 implements secure mode.)
1862
1863 Note: when commands are invoked with elevated privileges, for
1864 example under sudo(8) or pkexec(1), care must be taken to ensure
1865 that unintended interactive features are not enabled. "Secure" mode
1866 for the pager may be enabled automatically as describe above.
1867 Setting SYSTEMD_PAGERSECURE=0 or not removing it from the inherited
1868 environment allows the user to invoke arbitrary commands. Note that
1869 if the $SYSTEMD_PAGER or $PAGER variables are to be honoured,
1870 $SYSTEMD_PAGERSECURE must be set too. It might be reasonable to
1871 completely disable the pager using --no-pager instead.
1872
1873 $SYSTEMD_COLORS
1874 Takes a boolean argument. When true, systemd and related utilities
1875 will use colors in their output, otherwise the output will be
1876 monochrome. Additionally, the variable can take one of the
1877 following special values: "16", "256" to restrict the use of colors
1878 to the base 16 or 256 ANSI colors, respectively. This can be
1879 specified to override the automatic decision based on $TERM and
1880 what the console is connected to.
1881
1882 $SYSTEMD_URLIFY
1883 The value must be a boolean. Controls whether clickable links
1884 should be generated in the output for terminal emulators supporting
1885 this. This can be specified to override the decision that systemd
1886 makes based on $TERM and other conditions.
1887
1889 systemd(1), journalctl(1), loginctl(1), machinectl(1), systemd.unit(5),
1890 systemd.resource-control(5), systemd.special(7), wall(1),
1891 systemd.preset(5), systemd.generator(7), glob(7)
1892
1894 1. LSB 3.0.0
1895 http://refspecs.linuxbase.org/LSB_3.0.0/LSB-PDA/LSB-PDA/iniscrptact.html
1896
1897
1898
1899systemd 251 SYSTEMCTL(1)