1SYSTEMCTL(1) systemctl SYSTEMCTL(1)
2
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 options are understood:
19 -t, --type=
21 The argument should be a comma-separated list of unit types such as
22 service and socket.
23 If one of the arguments is a unit type, when listing units, limit
25 display to certain unit types. Otherwise, units of all types will
26 be shown.
27 As a special case, if one of the arguments is help, a list of
29 allowed values will be printed and the program will exit.
30 --state=
32 The argument should be a comma-separated list of unit LOAD, SUB, or
33 ACTIVE states. When listing units, show only those in the specified
34 states. Use --state=failed to show only failed units.
35 As a special case, if one of the arguments is help, a list of
37 allowed values will be printed and the program will exit.
38 -p, --property=
40 When showing unit/job/manager properties with the show command,
41 limit display to properties specified in the argument. The argument
42 should be a comma-separated list of property names, such as
43 "MainPID". Unless specified, all known properties are shown. If
44 specified more than once, all properties with the specified names
45 are shown. Shell completion is implemented for property names.
46 For the manager itself, systemctl show will show all available
48 properties. Those properties are documented in systemd-
49 system.conf(5).
50 Properties for units vary by unit type, so showing any unit (even a
52 non-existent one) is a way to list properties pertaining to this
53 type. Similarly, showing any job will list properties pertaining to
54 all jobs. Properties for units are documented in systemd.unit(5),
55 and the pages for individual unit types systemd.service(5),
56 systemd.socket(5), etc.
57 -a, --all
59 When listing units with list-units, also show inactive units and
60 units which are following other units. When showing
61 unit/job/manager properties, show all properties regardless whether
62 they are set or not.
63 To list all units installed in the file system, use the
65 list-unit-files command instead.
66 When listing units with list-dependencies, recursively show
68 dependencies of all dependent units (by default only dependencies
69 of target units are shown).
70 When used with status, show journal messages in full, even if they
72 include unprintable characters or are very long. By default, fields
73 with unprintable characters are abbreviated as "blob data". (Note
74 that the pager may escape unprintable characters again.)
75 -r, --recursive
77 When listing units, also show units of local containers. Units of
78 local containers will be prefixed with the container name,
79 separated by a single colon character (":").
80 --reverse
82 Show reverse dependencies between units with list-dependencies,
83 i.e. follow dependencies of type WantedBy=, RequiredBy=, PartOf=,
84 BoundBy=, instead of Wants= and similar.
85 --after
87 With list-dependencies, show the units that are ordered before the
88 specified unit. In other words, recursively list units following
89 the After= dependency.
90 Note that any After= dependency is automatically mirrored to create
92 a Before= dependency. Temporal dependencies may be specified
93 explicitly, but are also created implicitly for units which are
94 WantedBy= targets (see systemd.target(5)), and as a result of other
95 directives (for example RequiresMountsFor=). Both explicitly and
96 implicitly introduced dependencies are shown with
97 list-dependencies.
98 When passed to the list-jobs command, for each printed job show
100 which other jobs are waiting for it. May be combined with --before
101 to show both the jobs waiting for each job as well as all jobs each
102 job is waiting for.
103 --before
105 With list-dependencies, show the units that are ordered after the
106 specified unit. In other words, recursively list units following
107 the Before= dependency.
108 When passed to the list-jobs command, for each printed job show
110 which other jobs it is waiting for. May be combined with --after to
111 show both the jobs waiting for each job as well as all jobs each
112 job is waiting for.
113 -l, --full
115 Do not ellipsize unit names, process tree entries, journal output,
116 or truncate unit descriptions in the output of status, list-units,
117 list-jobs, and list-timers.
118 Also, show installation targets in the output of is-enabled.
120 --value
122 When printing properties with show, only print the value, and skip
123 the property name and "=".
124 --show-types
126 When showing sockets, show the type of the socket.
127 --job-mode=
129 When queuing a new job, this option controls how to deal with
130 already queued jobs. It takes one of "fail", "replace",
131 "replace-irreversibly", "isolate", "ignore-dependencies",
132 "ignore-requirements" or "flush". Defaults to "replace", except
133 when the isolate command is used which implies the "isolate" job
134 mode.
135 If "fail" is specified and a requested operation conflicts with a
137 pending job (more specifically: causes an already pending start job
138 to be reversed into a stop job or vice versa), cause the operation
139 to fail.
140 If "replace" (the default) is specified, any conflicting pending
142 job will be replaced, as necessary.
143 If "replace-irreversibly" is specified, operate like "replace", but
145 also mark the new jobs as irreversible. This prevents future
146 conflicting transactions from replacing these jobs (or even being
147 enqueued while the irreversible jobs are still pending).
148 Irreversible jobs can still be cancelled using the cancel command.
149 This job mode should be used on any transaction which pulls in
150 shutdown.target.
151 "isolate" is only valid for start operations and causes all other
153 units to be stopped when the specified unit is started. This mode
154 is always used when the isolate command is used.
155 "flush" will cause all queued jobs to be canceled when the new job
157 is enqueued.
158 If "ignore-dependencies" is specified, then all unit dependencies
160 are ignored for this new job and the operation is executed
161 immediately. If passed, no required units of the unit passed will
162 be pulled in, and no ordering dependencies will be honored. This is
163 mostly a debugging and rescue tool for the administrator and should
164 not be used by applications.
165 "ignore-requirements" is similar to "ignore-dependencies", but only
167 causes the requirement dependencies to be ignored, the ordering
168 dependencies will still be honored.
169 -T, --show-transaction
171 When enqueuing a unit job (for example as effect of a systemctl
172 start invocation or similar), show brief information about all jobs
173 enqueued, covering both the requested job and any added because of
174 unit dependencies. Note that the output will only include jobs
175 immediately part of the transaction requested. It is possible that
176 service start-up program code run as effect of the enqueued jobs
177 might request further jobs to be pulled in. This means that
178 completion of the listed jobs might ultimately entail more jobs
179 than the listed ones.
180 --fail
182 Shorthand for --job-mode=fail.
183 When used with the kill command, if no units were killed, the
185 operation results in an error.
186 -i, --ignore-inhibitors
188 When system shutdown or a sleep state is requested, ignore
189 inhibitor locks. Applications can establish inhibitor locks to
190 avoid that certain important operations (such as CD burning or
191 suchlike) are interrupted by system shutdown or a sleep state. Any
192 user may take these locks and privileged users may override these
193 locks. If any locks are taken, shutdown and sleep state requests
194 will normally fail (unless privileged) and a list of active locks
195 is printed. However, if --ignore-inhibitors is specified, the
196 established locks are ignored and not shown, and the operation
197 attempted anyway, possibly requiring additional privileges.
198 --dry-run
200 Just print what would be done. Currently supported by verbs halt,
201 poweroff, reboot, kexec, suspend, hibernate, hybrid-sleep,
202 suspend-then-hibernate, default, rescue, emergency, and exit.
203 -q, --quiet
205 Suppress printing of the results of various commands and also the
206 hints about truncated log lines. This does not suppress output of
207 commands for which the printed output is the only result (like
208 show). Errors are always printed.
209 --no-block
211 Do not synchronously wait for the requested operation to finish. If
212 this is not specified, the job will be verified, enqueued and
213 systemctl will wait until the unit's start-up is completed. By
214 passing this argument, it is only verified and enqueued. This
215 option may not be combined with --wait.
216 --wait
218 Synchronously wait for started units to terminate again. This
219 option may not be combined with --no-block. Note that this will
220 wait forever if any given unit never terminates (by itself or by
221 getting stopped explicitly); particularly services which use
222 "RemainAfterExit=yes".
223 When used with is-system-running, wait until the boot process is
225 completed before returning.
226 --user
228 Talk to the service manager of the calling user, rather than the
229 service manager of the system.
230 --system
232 Talk to the service manager of the system. This is the implied
233 default.
234 --failed
236 List units in failed state. This is equivalent to --state=failed.
237 --no-wall
239 Do not send wall message before halt, power-off and reboot.
240 --global
242 When used with enable and disable, operate on the global user
243 configuration directory, thus enabling or disabling a unit file
244 globally for all future logins of all users.
245 --no-reload
247 When used with enable and disable, do not implicitly reload daemon
248 configuration after executing the changes.
249 --no-ask-password
251 When used with start and related commands, disables asking for
252 passwords. Background services may require input of a password or
253 passphrase string, for example to unlock system hard disks or
254 cryptographic certificates. Unless this option is specified and the
255 command is invoked from a terminal, systemctl will query the user
256 on the terminal for the necessary secrets. Use this option to
257 switch this behavior off. In this case, the password must be
258 supplied by some other means (for example graphical password
259 agents) or the service might fail. This also disables querying the
260 user for authentication for privileged operations.
261 --kill-who=
263 When used with kill, choose which processes to send a signal to.
264 Must be one of main, control or all to select whether to kill only
265 the main process, the control process or all processes of the unit.
266 The main process of the unit is the one that defines the life-time
267 of it. A control process of a unit is one that is invoked by the
268 manager to induce state changes of it. For example, all processes
269 started due to the ExecStartPre=, ExecStop= or ExecReload= settings
270 of service units are control processes. Note that there is only one
271 control process per unit at a time, as only one state change is
272 executed at a time. For services of type Type=forking, the initial
273 process started by the manager for ExecStart= is a control process,
274 while the process ultimately forked off by that one is then
275 considered the main process of the unit (if it can be determined).
276 This is different for service units of other types, where the
277 process forked off by the manager for ExecStart= is always the main
278 process itself. A service unit consists of zero or one main
279 process, zero or one control process plus any number of additional
280 processes. Not all unit types manage processes of these types
281 however. For example, for mount units, control processes are
282 defined (which are the invocations of /usr/bin/mount and
283 /usr/bin/umount), but no main process is defined. If omitted,
284 defaults to all.
285 -s, --signal=
287 When used with kill, choose which signal to send to selected
288 processes. Must be one of the well-known signal specifiers such as
289 SIGTERM, SIGINT or SIGSTOP. If omitted, defaults to SIGTERM.
290 --what=
292 Select what type of per-unit resources to remove when the clean
293 command is invoked, see below. Takes one of configuration, state,
294 cache, logs, runtime to select the type of resource. This option
295 may be specified more than once, in which case all specified
296 resource types are removed. Also accepts the special value all as a
297 shortcut for specifiying all five resource types. If this option is
298 not specified defaults to the combination of cache and runtime,
299 i.e. the two kinds of resources that are generally considered to be
300 redundant and can be reconstructed on next invocation.
301 -f, --force
303 When used with enable, overwrite any existing conflicting symlinks.
304 When used with edit, create all of the specified units which do not
306 already exist.
307 When used with halt, poweroff, reboot or kexec, execute the
309 selected operation without shutting down all units. However, all
310 processes will be killed forcibly and all file systems are
311 unmounted or remounted read-only. This is hence a drastic but
312 relatively safe option to request an immediate reboot. If --force
313 is specified twice for these operations (with the exception of
314 kexec), they will be executed immediately, without terminating any
315 processes or unmounting any file systems. Warning: specifying
316 --force twice with any of these operations might result in data
317 loss. Note that when --force is specified twice the selected
318 operation is executed by systemctl itself, and the system manager
319 is not contacted. This means the command should succeed even when
320 the system manager has crashed.
321 --message=
323 When used with halt, poweroff or reboot, set a short message
324 explaining the reason for the operation. The message will be logged
325 together with the default shutdown message.
326 --now
328 When used with enable, the units will also be started. When used
329 with disable or mask, the units will also be stopped. The start or
330 stop operation is only carried out when the respective enable or
331 disable operation has been successful.
332 --root=
334 When used with enable/disable/is-enabled (and related commands),
335 use the specified root path when looking for unit files. If this
336 option is present, systemctl will operate on the file system
337 directly, instead of communicating with the systemd daemon to carry
338 out changes.
339 --runtime
341 When used with enable, disable, edit, (and related commands), make
342 changes only temporarily, so that they are lost on the next reboot.
343 This will have the effect that changes are not made in
344 subdirectories of /etc but in /run, with identical immediate
345 effects, however, since the latter is lost on reboot, the changes
346 are lost too.
347 Similarly, when used with set-property, make changes only
349 temporarily, so that they are lost on the next reboot.
350 --preset-mode=
352 Takes one of "full" (the default), "enable-only", "disable-only".
353 When used with the preset or preset-all commands, controls whether
354 units shall be disabled and enabled according to the preset rules,
355 or only enabled, or only disabled.
356 -n, --lines=
358 When used with status, controls the number of journal lines to
359 show, counting from the most recent ones. Takes a positive integer
360 argument, or 0 to disable journal output. Defaults to 10.
361 -o, --output=
363 When used with status, controls the formatting of the journal
364 entries that are shown. For the available choices, see
365 journalctl(1). Defaults to "short".
366 --firmware-setup
368 When used with the reboot command, indicate to the system's
369 firmware to reboot into the firmware setup interface. Note that
370 this functionality is not available on all systems.
371 --boot-loader-menu=
373 When used with the reboot command, indicate to the system's boot
374 loader to show the boot loader menu on the following boot. Takes a
375 time value as parameter — indicating the menu time-out. Pass zero
376 in order to disable the menu time-out. Note that not all boot
377 loaders support this functionality.
378 --boot-loader-entry=
380 When used with the reboot command, indicate to the system's boot
381 loader to boot into a specific boot loader entry on the following
382 boot. Takes a boot loader entry identifier as argument, or "help"
383 in order to list available entries. Note that not all boot loaders
384 support this functionality.
385 --plain
387 When used with list-dependencies, list-units or list-machines, the
388 output is printed as a list instead of a tree, and the bullet
389 circles are omitted.
390 -H, --host=
392 Execute the operation remotely. Specify a hostname, or a username
393 and hostname separated by "@", to connect to. The hostname may
394 optionally be suffixed by a port ssh is listening on, separated by
395 ":", and then a container name, separated by "/", which connects
396 directly to a specific container on the specified host. This will
397 use SSH to talk to the remote machine manager instance. Container
398 names may be enumerated with machinectl -H HOST. Put IPv6 addresses
399 in brackets.
400 -M, --machine=
402 Execute operation on a local container. Specify a container name to
403 connect to.
404 --no-pager
406 Do not pipe output into a pager.
407 --no-legend
409 Do not print the legend, i.e. column headers and the footer with
410 hints.
411 -h, --help
413 Print a short help text and exit.
414 --version
416 Print a short version string and exit.
417
419 The following commands are understood:
420 Unit Commands
422 list-units [PATTERN...]
423 List units that systemd currently has in memory. This includes
424 units that are either referenced directly or through a dependency,
425 units that are pinned by applications programmatically, or units
426 that were active in the past and have failed. By default only units
427 which are active, have pending jobs, or have failed are shown; this
428 can be changed with option --all. If one or more PATTERNs are
429 specified, only units matching one of them are shown. The units
430 that are shown are additionally filtered by --type= and --state= if
431 those options are specified.
432 Produces output similar to
434 UNIT LOAD ACTIVE SUB DESCRIPTION
436 sys-module-fuse.device loaded active plugged /sys/module/fuse
437 -.mount loaded active mounted Root Mount
438 boot-efi.mount loaded active mounted /boot/efi
439 systemd-journald.service loaded active running Journal Service
440 systemd-logind.service loaded active running Login Service
441 ● user@1000.service loaded failed failed User Manager for UID 1000
442 ...
443 systemd-tmpfiles-clean.timer loaded active waiting Daily Cleanup of Temporary Directories
444 LOAD = Reflects whether the unit definition was properly loaded.
446 ACTIVE = The high-level unit activation state, i.e. generalization of SUB.
447 SUB = The low-level unit activation state, values depend on unit type.
448 123 loaded units listed. Pass --all to see loaded but inactive units, too.
450 To show all installed unit files use 'systemctl list-unit-files'.
451 The header and the last unit of a given type are underlined if the
454 terminal supports that. A colored dot is shown next to services
455 which were masked, not found, or otherwise failed.
456 The LOAD column shows the load state, one of loaded, not-found,
458 bad-setting, error, masked. The ACTIVE columns shows the general
459 unit state, one of active, reloading, inactive, failed, activating,
460 deactivating. The SUB column shows the unit-type-specific detailed
461 state of the unit, possible values vary by unit type. The list of
462 possible LOAD, ACTIVE, and SUB states is not constant and new
463 systemd releases may both add and remove values.
464 systemctl --state=help
466 command maybe be used to display the current set of possible
468 values.
469 This is the default command.
471 list-sockets [PATTERN...]
473 List socket units currently in memory, ordered by listening
474 address. If one or more PATTERNs are specified, only socket units
475 matching one of them are shown. Produces output similar to
476 LISTEN UNIT ACTIVATES
478 /dev/initctl systemd-initctl.socket systemd-initctl.service
479 ...
480 [::]:22 sshd.socket sshd.service
481 kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
482 5 sockets listed.
484 Note: because the addresses might contains spaces, this output is
486 not suitable for programmatic consumption.
487 Also see --show-types, --all, and --state=.
489 list-timers [PATTERN...]
491 List timer units currently in memory, ordered by the time they
492 elapse next. If one or more PATTERNs are specified, only units
493 matching one of them are shown. Produces output similar to
494 NEXT LEFT LAST PASSED UNIT ACTIVATES
496 n/a n/a Thu 2017-02-23 13:40:29 EST 3 days ago ureadahead-stop.timer ureadahead-stop.service
497 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
498 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
499 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
500 NEXT shows the next time the timer will run.
503 LEFT shows how long till the next time the timer runs.
505 LAST shows the last time the timer ran.
507 PASSED shows how long has passed since the timer last ran.
509 UNIT shows the name of the timer
511 ACTIVATES shows the name the service the timer activates when it
513 runs.
514 Also see --all and --state=.
516 start PATTERN...
518 Start (activate) one or more units specified on the command line.
519 Note that glob patterns operate on the set of primary names of
521 units currently in memory. Units which are not active and are not
522 in a failed state usually are not in memory, and will not be
523 matched by any pattern. In addition, in case of instantiated units,
524 systemd is often unaware of the instance name until the instance
525 has been started. Therefore, using glob patterns with start has
526 limited usefulness. Also, secondary alias names of units are not
527 considered.
528 stop PATTERN...
530 Stop (deactivate) one or more units specified on the command line.
531 This command will fail if the unit does not exist or if stopping of
533 the unit is prohibited (see RefuseManualStop= in systemd.unit(5)).
534 It will not fail if any of the commands configured to stop the unit
535 (ExecStop=, etc.) fail, because the manager will still forcibly
536 terminate the unit.
537 reload PATTERN...
539 Asks all units listed on the command line to reload their
540 configuration. Note that this will reload the service-specific
541 configuration, not the unit configuration file of systemd. If you
542 want systemd to reload the configuration file of a unit, use the
543 daemon-reload command. In other words: for the example case of
544 Apache, this will reload Apache's httpd.conf in the web server, not
545 the apache.service systemd unit file.
546 This command should not be confused with the daemon-reload command.
548 restart PATTERN...
550 Stop and then start one or more units specified on the command
551 line. If the units are not running yet, they will be started.
552 Note that restarting a unit with this command does not necessarily
554 flush out all of the unit's resources before it is started again.
555 For example, the per-service file descriptor storage facility (see
556 FileDescriptorStoreMax= in systemd.service(5)) will remain intact
557 as long as the unit has a job pending, and is only cleared when the
558 unit is fully stopped and no jobs are pending anymore. If it is
559 intended that the file descriptor store is flushed out, too, during
560 a restart operation an explicit systemctl stop command followed by
561 systemctl start should be issued.
562 try-restart PATTERN...
564 Stop and then start one or more units specified on the command line
565 if the units are running. This does nothing if units are not
566 running.
567 reload-or-restart PATTERN...
569 Reload one or more units if they support it. If not, stop and then
570 start them instead. If the units are not running yet, they will be
571 started.
572 try-reload-or-restart PATTERN...
574 Reload one or more units if they support it. If not, stop and then
575 start them instead. This does nothing if the units are not running.
576 isolate UNIT
578 Start the unit specified on the command line and its dependencies
579 and stop all others, unless they have IgnoreOnIsolate=yes (see
580 systemd.unit(5)). If a unit name with no extension is given, an
581 extension of ".target" will be assumed.
582 This is similar to changing the runlevel in a traditional init
584 system. The isolate command will immediately stop processes that
585 are not enabled in the new unit, possibly including the graphical
586 environment or terminal you are currently using.
587 Note that this is allowed only on units where AllowIsolate= is
589 enabled. See systemd.unit(5) for details.
590 kill PATTERN...
592 Send a signal to one or more processes of the unit. Use --kill-who=
593 to select which process to kill. Use --signal= to select the signal
594 to send.
595 clean PATTERN...
597 Remove the configuration, state, cache, logs or runtime data of the
598 specified units. Use --what= to select which kind of resource to
599 remove. For service units this may be used to remove the
600 directories configured with ConfigurationDirectory=,
601 StateDirectory=, CacheDirectory=, LogsDirectory= and
602 RuntimeDirectory=, see systemd.exec(5) for details. For timer units
603 this may be used to clear out the persistent timestamp data if
604 Persistent= is used and --what=state is selected, see
605 systemd.timer(5). This command only applies to units that use
606 either of these settings. If --what= is not specified, both the
607 cache and runtime data are removed (as these two types of data are
608 generally redundant and reproducible on the next invocation of the
609 unit).
610 is-active PATTERN...
612 Check whether any of the specified units are active (i.e. running).
613 Returns an exit code 0 if at least one is active, or non-zero
614 otherwise. Unless --quiet is specified, this will also print the
615 current unit state to standard output.
616 is-failed PATTERN...
618 Check whether any of the specified units are in a "failed" state.
619 Returns an exit code 0 if at least one has failed, non-zero
620 otherwise. Unless --quiet is specified, this will also print the
621 current unit state to standard output.
622 status [PATTERN...|PID...]]
624 Show terse runtime status information about one or more units,
625 followed by most recent log data from the journal. If no units are
626 specified, show system status. If combined with --all, also show
627 the status of all units (subject to limitations specified with -t).
628 If a PID is passed, show information about the unit the process
629 belongs to.
630 This function is intended to generate human-readable output. If you
632 are looking for computer-parsable output, use show instead. By
633 default, this function only shows 10 lines of output and ellipsizes
634 lines to fit in the terminal window. This can be changed with
635 --lines and --full, see above. In addition, journalctl --unit=NAME
636 or journalctl --user-unit=NAME use a similar filter for messages
637 and might be more convenient.
638 systemd implicitly loads units as necessary, so just running the
640 status will attempt to load a file. The command is thus not useful
641 for determining if something was already loaded or not. The units
642 may possibly also be quickly unloaded after the operation is
643 completed if there's no reason to keep it in memory thereafter.
644 Example 1. Example output from systemctl status
646 $ systemctl status bluetooth
648 ● bluetooth.service - Bluetooth service
649 Loaded: loaded (/usr/lib/systemd/system/bluetooth.service; enabled; vendor preset: enabled)
650 Active: active (running) since Wed 2017-01-04 13:54:04 EST; 1 weeks 0 days ago
651 Docs: man:bluetoothd(8)
652 Main PID: 930 (bluetoothd)
653 Status: "Running"
654 Tasks: 1
655 Memory: 648.0K
656 CPU: 435ms
657 CGroup: /system.slice/bluetooth.service
658 └─930 /usr/lib/bluetooth/bluetoothd
659 Jan 12 10:46:45 example.com bluetoothd[8900]: Not enough free handles to register service
661 Jan 12 10:46:45 example.com bluetoothd[8900]: Current Time Service could not be registered
662 Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output error (5)
663 The dot ("●") uses color on supported terminals to summarize the
665 unit state at a glance. White indicates an "inactive" or
666 "deactivating" state. Red indicates a "failed" or "error" state and
667 green indicates an "active", "reloading" or "activating" state.
668 The "Loaded:" line in the output will show "loaded" if the unit has
670 been loaded into memory. Other possible values for "Loaded:"
671 include: "error" if there was a problem loading it, "not-found" if
672 not unit file was found for this unit, "bad-setting" if an
673 essential unit file setting could not be parsed and "masked" if the
674 unit file has been masked. Along with showing the path to the unit
675 file, this line will also show the enablement state. Enabled
676 commands start at boot. See the full table of possible enablement
677 states — including the definition of "masked" — in the
678 documentation for the is-enabled command.
679 The "Active:" line shows active state. The value is usually
681 "active" or "inactive". Active could mean started, bound, plugged
682 in, etc depending on the unit type. The unit could also be in
683 process of changing states, reporting a state of "activating" or
684 "deactivating". A special "failed" state is entered when the
685 service failed in some way, such as a crash, exiting with an error
686 code or timing out. If the failed state is entered the cause will
687 be logged for later reference.
688 show [PATTERN...|JOB...]
690 Show properties of one or more units, jobs, or the manager itself.
691 If no argument is specified, properties of the manager will be
692 shown. If a unit name is specified, properties of the unit are
693 shown, and if a job ID is specified, properties of the job are
694 shown. By default, empty properties are suppressed. Use --all to
695 show those too. To select specific properties to show, use
696 --property=. This command is intended to be used whenever
697 computer-parsable output is required. Use status if you are looking
698 for formatted human-readable output.
699 Many properties shown by systemctl show map directly to
701 configuration settings of the system and service manager and its
702 unit files. Note that the properties shown by the command are
703 generally more low-level, normalized versions of the original
704 configuration settings and expose runtime state in addition to
705 configuration. For example, properties shown for service units
706 include the service's current main process identifier as "MainPID"
707 (which is runtime state), and time settings are always exposed as
708 properties ending in the "...USec" suffix even if a matching
709 configuration options end in "...Sec", because microseconds is the
710 normalized time unit used by the system and service manager.
711 cat PATTERN...
713 Show backing files of one or more units. Prints the "fragment" and
714 "drop-ins" (source files) of units. Each file is preceded by a
715 comment which includes the file name. Note that this shows the
716 contents of the backing files on disk, which may not match the
717 system manager's understanding of these units if any unit files
718 were updated on disk and the daemon-reload command wasn't issued
719 since.
720 set-property UNIT PROPERTY=VALUE...
722 Set the specified unit properties at runtime where this is
723 supported. This allows changing configuration parameter properties
724 such as resource control settings at runtime. Not all properties
725 may be changed at runtime, but many resource control settings
726 (primarily those in systemd.resource-control(5)) may. The changes
727 are applied immediately, and stored on disk for future boots,
728 unless --runtime is passed, in which case the settings only apply
729 until the next reboot. The syntax of the property assignment
730 follows closely the syntax of assignments in unit files.
731 Example: systemctl set-property foobar.service CPUWeight=200
733 If the specified unit appears to be inactive, the changes will be
735 only stored on disk as described previously hence they will be
736 effective when the unit will be started.
737 Note that this command allows changing multiple properties at the
739 same time, which is preferable over setting them individually.
740 Example: systemctl set-property foobar.service CPUWeight=200
742 MemoryMax=2G IPAccounting=yes
743 Like with unit file configuration settings, assigning an empty
745 setting usually resets a property to its defaults.
746 Example: systemctl set-property avahi-daemon.service IPAddressDeny=
748 help PATTERN...|PID...
750 Show manual pages for one or more units, if available. If a PID is
751 given, the manual pages for the unit the process belongs to are
752 shown.
753 reset-failed [PATTERN...]
755 Reset the "failed" state of the specified units, or if no unit name
756 is passed, reset the state of all units. When a unit fails in some
757 way (i.e. process exiting with non-zero error code, terminating
758 abnormally or timing out), it will automatically enter the "failed"
759 state and its exit code and status is recorded for introspection by
760 the administrator until the service is stopped/re-started or reset
761 with this command.
762 In addition to resetting the "failed" state of a unit it also
764 resets various other per-unit properties: the start rate limit
765 counter of all unit types is reset to zero, as is the restart
766 counter of service units. Thus, if a unit's start limit (as
767 configured with StartLimitIntervalSec=/StartLimitBurst=) is hit and
768 the unit refuses to be started again, use this command to make it
769 startable again.
770 list-dependencies [UNIT]
772 Shows units required and wanted by the specified unit. This
773 recursively lists units following the Requires=, Requisite=,
774 ConsistsOf=, Wants=, BindsTo= dependencies. If no unit is
775 specified, default.target is implied.
776 By default, only target units are recursively expanded. When --all
778 is passed, all other units are recursively expanded as well.
779 Options --reverse, --after, --before may be used to change what
781 types of dependencies are shown.
782 Note that this command only lists units currently loaded into
784 memory by the service manager. In particular, this command is not
785 suitable to get a comprehensive list at all reverse dependencies on
786 a specific unit, as it won't list the dependencies declared by
787 units currently not loaded.
788 Unit File Commands
790 list-unit-files [PATTERN...]
791 List unit files installed on the system, in combination with their
792 enablement state (as reported by is-enabled). If one or more
793 PATTERNs are specified, only unit files whose name matches one of
794 them are shown (patterns matching unit file system paths are not
795 supported).
796 enable UNIT..., enable PATH...
798 Enable one or more units or unit instances. This will create a set
799 of symlinks, as encoded in the "[Install]" sections of the
800 indicated unit files. After the symlinks have been created, the
801 system manager configuration is reloaded (in a way equivalent to
802 daemon-reload), in order to ensure the changes are taken into
803 account immediately. Note that this does not have the effect of
804 also starting any of the units being enabled. If this is desired,
805 combine this command with the --now switch, or invoke start with
806 appropriate arguments later. Note that in case of unit instance
807 enablement (i.e. enablement of units of the form foo@bar.service),
808 symlinks named the same as instances are created in the unit
809 configuration directory, however they point to the single template
810 unit file they are instantiated from.
811 This command expects either valid unit names (in which case various
813 unit file directories are automatically searched for unit files
814 with appropriate names), or absolute paths to unit files (in which
815 case these files are read directly). If a specified unit file is
816 located outside of the usual unit file directories, an additional
817 symlink is created, linking it into the unit configuration path,
818 thus ensuring it is found when requested by commands such as start.
819 The file system where the linked unit files are located must be
820 accessible when systemd is started (e.g. anything underneath /home
821 or /var is not allowed, unless those directories are located on the
822 root file system).
823 This command will print the file system operations executed. This
825 output may be suppressed by passing --quiet.
826 Note that this operation creates only the symlinks suggested in the
828 "[Install]" section of the unit files. While this command is the
829 recommended way to manipulate the unit configuration directory, the
830 administrator is free to make additional changes manually by
831 placing or removing symlinks below this directory. This is
832 particularly useful to create configurations that deviate from the
833 suggested default installation. In this case, the administrator
834 must make sure to invoke daemon-reload manually as necessary, in
835 order to ensure the changes are taken into account.
836 Enabling units should not be confused with starting (activating)
838 units, as done by the start command. Enabling and starting units is
839 orthogonal: units may be enabled without being started and started
840 without being enabled. Enabling simply hooks the unit into various
841 suggested places (for example, so that the unit is automatically
842 started on boot or when a particular kind of hardware is plugged
843 in). Starting actually spawns the daemon process (in case of
844 service units), or binds the socket (in case of socket units), and
845 so on.
846 Depending on whether --system, --user, --runtime, or --global is
848 specified, this enables the unit for the system, for the calling
849 user only, for only this boot of the system, or for all future
850 logins of all users. Note that in the last case, no systemd daemon
851 configuration is reloaded.
852 Using enable on masked units is not supported and results in an
854 error.
855 disable UNIT...
857 Disables one or more units. This removes all symlinks to the unit
858 files backing the specified units from the unit configuration
859 directory, and hence undoes any changes made by enable or link.
860 Note that this removes all symlinks to matching unit files,
861 including manually created symlinks, and not just those actually
862 created by enable or link. Note that while disable undoes the
863 effect of enable, the two commands are otherwise not symmetric, as
864 disable may remove more symlinks than a prior enable invocation of
865 the same unit created.
866 This command expects valid unit names only, it does not accept
868 paths to unit files.
869 In addition to the units specified as arguments, all units are
871 disabled that are listed in the Also= setting contained in the
872 "[Install]" section of any of the unit files being operated on.
873 This command implicitly reloads the system manager configuration
875 after completing the operation. Note that this command does not
876 implicitly stop the units that are being disabled. If this is
877 desired, either combine this command with the --now switch, or
878 invoke the stop command with appropriate arguments later.
879 This command will print information about the file system
881 operations (symlink removals) executed. This output may be
882 suppressed by passing --quiet.
883 This command honors --system, --user, --runtime and --global in a
885 similar way as enable.
886 reenable UNIT...
888 Reenable one or more units, as specified on the command line. This
889 is a combination of disable and enable and is useful to reset the
890 symlinks a unit file is enabled with to the defaults configured in
891 its "[Install]" section. This command expects a unit name only, it
892 does not accept paths to unit files.
893 preset UNIT...
895 Reset the enable/disable status one or more unit files, as
896 specified on the command line, to the defaults configured in the
897 preset policy files. This has the same effect as disable or enable,
898 depending how the unit is listed in the preset files.
899 Use --preset-mode= to control whether units shall be enabled and
901 disabled, or only enabled, or only disabled.
902 If the unit carries no install information, it will be silently
904 ignored by this command. UNIT must be the real unit name, any
905 alias names are ignored silently.
906 For more information on the preset policy format, see
908 systemd.preset(5). For more information on the concept of presets,
909 please consult the Preset[1] document.
910 preset-all
912 Resets all installed unit files to the defaults configured in the
913 preset policy file (see above).
914 Use --preset-mode= to control whether units shall be enabled and
916 disabled, or only enabled, or only disabled.
917 is-enabled UNIT...
919 Checks whether any of the specified unit files are enabled (as with
920 enable). Returns an exit code of 0 if at least one is enabled,
921 non-zero otherwise. Prints the current enable status (see table).
922 To suppress this output, use --quiet. To show installation targets,
923 use --full.
924 Table 1. is-enabled output
926 ┌──────────────────┬─────────────────────────┬───────────┐
927 │Name │ Description │ Exit Code │
928 ├──────────────────┼─────────────────────────┼───────────┤
929 │"enabled" │ Enabled via │ │
930 ├──────────────────┤ .wants/, .requires/ │ │
931 │"enabled-runtime" │ or Alias= symlinks │ │
932 │ │ (permanently in │ 0 │
933 │ │ /etc/systemd/system/, │ │
934 │ │ or transiently in │ │
935 │ │ /run/systemd/system/). │ │
936 ├──────────────────┼─────────────────────────┼───────────┤
937 │"linked" │ Made available through │ │
938 ├──────────────────┤ one or more symlinks │ │
939 │"linked-runtime" │ to the unit file │ │
940 │ │ (permanently in │ │
941 │ │ /etc/systemd/system/ │ │
942 │ │ or transiently in │ > 0 │
943 │ │ /run/systemd/system/), │ │
944 │ │ even though the unit │ │
945 │ │ file might reside │ │
946 │ │ outside of the unit │ │
947 │ │ file search path. │ │
948 ├──────────────────┼─────────────────────────┼───────────┤
949 │"masked" │ Completely disabled, │ │
950 ├──────────────────┤ so that any start │ │
951 │"masked-runtime" │ operation on it fails │ │
952 │ │ (permanently in │ > 0 │
953 │ │ /etc/systemd/system/ │ │
954 │ │ or transiently in │ │
955 │ │ /run/systemd/systemd/). │ │
956 ├──────────────────┼─────────────────────────┼───────────┤
957 │"static" │ The unit file is not │ 0 │
958 │ │ enabled, and has no │ │
959 │ │ provisions for enabling │ │
960 │ │ in the "[Install]" unit │ │
961 │ │ file section. │ │
962 ├──────────────────┼─────────────────────────┼───────────┤
963 │"indirect" │ The unit file itself is │ 0 │
964 │ │ not enabled, but it has │ │
965 │ │ a non-empty Also= │ │
966 │ │ setting in the │ │
967 │ │ "[Install]" unit file │ │
968 │ │ section, listing other │ │
969 │ │ unit files that might │ │
970 │ │ be enabled, or it has │ │
971 │ │ an alias under a │ │
972 │ │ different name through │ │
973 │ │ a symlink that is not │ │
974 │ │ specified in Also=. For │ │
975 │ │ template unit file, an │ │
976 │ │ instance different than │ │
977 │ │ the one specified in │ │
978 │ │ DefaultInstance= is │ │
979 │ │ enabled. │ │
980 ├──────────────────┼─────────────────────────┼───────────┤
981 │"disabled" │ The unit file is not │ > 0 │
982 │ │ enabled, but contains │ │
983 │ │ an "[Install]" section │ │
984 │ │ with installation │ │
985 │ │ instructions. │ │
986 ├──────────────────┼─────────────────────────┼───────────┤
987 │"generated" │ The unit file was │ 0 │
988 │ │ generated dynamically │ │
989 │ │ via a generator tool. │ │
990 │ │ See │ │
991 │ │ systemd.generator(7). │ │
992 │ │ Generated unit files │ │
993 │ │ may not be enabled, │ │
994 │ │ they are enabled │ │
995 │ │ implicitly by their │ │
996 │ │ generator. │ │
997 ├──────────────────┼─────────────────────────┼───────────┤
998 │"transient" │ The unit file has been │ 0 │
999 │ │ created dynamically │ │
1000 │ │ with the runtime API. │ │
1001 │ │ Transient units may not │ │
1002 │ │ be enabled. │ │
1003 ├──────────────────┼─────────────────────────┼───────────┤
1004 │"bad" │ The unit file is │ > 0 │
1005 │ │ invalid or another │ │
1006 │ │ error occurred. Note │ │
1007 │ │ that is-enabled will │ │
1008 │ │ not actually return │ │
1009 │ │ this state, but print │ │
1010 │ │ an error message │ │
1011 │ │ instead. However the │ │
1012 │ │ unit file listing │ │
1013 │ │ printed by │ │
1014 │ │ list-unit-files might │ │
1015 │ │ show it. │ │
1016 └──────────────────┴─────────────────────────┴───────────┘
1017 mask UNIT...
1019 Mask one or more units, as specified on the command line. This will
1020 link these unit files to /dev/null, making it impossible to start
1021 them. This is a stronger version of disable, since it prohibits all
1022 kinds of activation of the unit, including enablement and manual
1023 activation. Use this option with care. This honors the --runtime
1024 option to only mask temporarily until the next reboot of the
1025 system. The --now option may be used to ensure that the units are
1026 also stopped. This command expects valid unit names only, it does
1027 not accept unit file paths.
1028 unmask UNIT...
1030 Unmask one or more unit files, as specified on the command line.
1031 This will undo the effect of mask. This command expects valid unit
1032 names only, it does not accept unit file paths.
1033 link PATH...
1035 Link a unit file that is not in the unit file search paths into the
1036 unit file search path. This command expects an absolute path to a
1037 unit file. The effect of this may be undone with disable. The
1038 effect of this command is that a unit file is made available for
1039 commands such as start, even though it is not installed directly in
1040 the unit search path. The file system where the linked unit files
1041 are located must be accessible when systemd is started (e.g.
1042 anything underneath /home or /var is not allowed, unless those
1043 directories are located on the root file system).
1044 revert UNIT...
1046 Revert one or more unit files to their vendor versions. This
1047 command removes drop-in configuration files that modify the
1048 specified units, as well as any user-configured unit file that
1049 overrides a matching vendor supplied unit file. Specifically, for a
1050 unit "foo.service" the matching directories "foo.service.d/" with
1051 all their contained files are removed, both below the persistent
1052 and runtime configuration directories (i.e. below
1053 /etc/systemd/system and /run/systemd/system); if the unit file has
1054 a vendor-supplied version (i.e. a unit file located below /usr) any
1055 matching persistent or runtime unit file that overrides it is
1056 removed, too. Note that if a unit file has no vendor-supplied
1057 version (i.e. is only defined below /etc/systemd/system or
1058 /run/systemd/system, but not in a unit file stored below /usr),
1059 then it is not removed. Also, if a unit is masked, it is unmasked.
1060 Effectively, this command may be used to undo all changes made with
1062 systemctl edit, systemctl set-property and systemctl mask and puts
1063 the original unit file with its settings back in effect.
1064 add-wants TARGET UNIT..., add-requires TARGET UNIT...
1066 Adds "Wants=" or "Requires=" dependencies, respectively, to the
1067 specified TARGET for one or more units.
1068 This command honors --system, --user, --runtime and --global in a
1070 way similar to enable.
1071 edit UNIT...
1073 Edit a drop-in snippet or a whole replacement file if --full is
1074 specified, to extend or override the specified unit.
1075 Depending on whether --system (the default), --user, or --global is
1077 specified, this command creates a drop-in file for each unit either
1078 for the system, for the calling user, or for all futures logins of
1079 all users. Then, the editor (see the "Environment" section below)
1080 is invoked on temporary files which will be written to the real
1081 location if the editor exits successfully.
1082 If --full is specified, this will copy the original units instead
1084 of creating drop-in files.
1085 If --force is specified and any units do not already exist, new
1087 unit files will be opened for editing.
1088 If --runtime is specified, the changes will be made temporarily in
1090 /run and they will be lost on the next reboot.
1091 If the temporary file is empty upon exit, the modification of the
1093 related unit is canceled.
1094 After the units have been edited, systemd configuration is reloaded
1096 (in a way that is equivalent to daemon-reload).
1097 Note that this command cannot be used to remotely edit units and
1099 that you cannot temporarily edit units which are in /etc, since
1100 they take precedence over /run.
1101 get-default
1103 Return the default target to boot into. This returns the target
1104 unit name default.target is aliased (symlinked) to.
1105 set-default TARGET
1107 Set the default target to boot into. This sets (symlinks) the
1108 default.target alias to the given target unit.
1109 Machine Commands
1111 list-machines [PATTERN...]
1112 List the host and all running local containers with their state. If
1113 one or more PATTERNs are specified, only containers matching one of
1114 them are shown.
1115 Job Commands
1117 list-jobs [PATTERN...]
1118 List jobs that are in progress. If one or more PATTERNs are
1119 specified, only jobs for units matching one of them are shown.
1120 When combined with --after or --before the list is augmented with
1122 information on which other job each job is waiting for, and which
1123 other jobs are waiting for it, see above.
1124 cancel JOB...
1126 Cancel one or more jobs specified on the command line by their
1127 numeric job IDs. If no job ID is specified, cancel all pending
1128 jobs.
1129 Environment Commands
1131 show-environment
1132 Dump the systemd manager environment block. This is the environment
1133 block that is passed to all processes the manager spawns. The
1134 environment block will be dumped in straight-forward form suitable
1135 for sourcing into most shells. If no special characters or
1136 whitespace is present in the variable values, no escaping is
1137 performed, and the assignments have the form "VARIABLE=value". If
1138 whitespace or characters which have special meaning to the shell
1139 are present, dollar-single-quote escaping is used, and assignments
1140 have the form "VARIABLE=$'value'". This syntax is known to be
1141 supported by bash(1), zsh(1), ksh(1), and busybox(1)'s ash(1), but
1142 not dash(1) or fish(1).
1143 set-environment VARIABLE=VALUE...
1145 Set one or more systemd manager environment variables, as specified
1146 on the command line.
1147 unset-environment VARIABLE...
1149 Unset one or more systemd manager environment variables. If only a
1150 variable name is specified, it will be removed regardless of its
1151 value. If a variable and a value are specified, the variable is
1152 only removed if it has the specified value.
1153 import-environment [VARIABLE...]
1155 Import all, one or more environment variables set on the client
1156 into the systemd manager environment block. If no arguments are
1157 passed, the entire environment block is imported. Otherwise, a list
1158 of one or more environment variable names should be passed, whose
1159 client-side values are then imported into the manager's environment
1160 block.
1161 Manager Lifecycle Commands
1163 daemon-reload
1164 Reload the systemd manager configuration. This will rerun all
1165 generators (see systemd.generator(7)), reload all unit files, and
1166 recreate the entire dependency tree. While the daemon is being
1167 reloaded, all sockets systemd listens on behalf of user
1168 configuration will stay accessible.
1169 This command should not be confused with the reload command.
1171 daemon-reexec
1173 Reexecute the systemd manager. This will serialize the manager
1174 state, reexecute the process and deserialize the state again. This
1175 command is of little use except for debugging and package upgrades.
1176 Sometimes, it might be helpful as a heavy-weight daemon-reload.
1177 While the daemon is being reexecuted, all sockets systemd listening
1178 on behalf of user configuration will stay accessible.
1179 System Commands
1181 is-system-running
1182 Checks whether the system is operational. This returns success
1183 (exit code 0) when the system is fully up and running, specifically
1184 not in startup, shutdown or maintenance mode, and with no failed
1185 services. Failure is returned otherwise (exit code non-zero). In
1186 addition, the current state is printed in a short string to
1187 standard output, see the table below. Use --quiet to suppress this
1188 output.
1189 Use --wait to wait until the boot process is completed before
1191 printing the current state and returning the appropriate error
1192 status. If --wait is in use, states initializing or starting will
1193 not be reported, instead the command will block until a later state
1194 (such as running or degraded) is reached.
1195 Table 2. is-system-running output
1197 ┌─────────────┬─────────────────────┬───────────┐
1198 │Name │ Description │ Exit Code │
1199 ├─────────────┼─────────────────────┼───────────┤
1200 │initializing │ Early bootup, │ > 0 │
1201 │ │ before basic.target │ │
1202 │ │ is reached or the │ │
1203 │ │ maintenance state │ │
1204 │ │ entered. │ │
1205 ├─────────────┼─────────────────────┼───────────┤
1206 │starting │ Late bootup, before │ > 0 │
1207 │ │ the job queue │ │
1208 │ │ becomes idle for │ │
1209 │ │ the first time, or │ │
1210 │ │ one of the rescue │ │
1211 │ │ targets are │ │
1212 │ │ reached. │ │
1213 ├─────────────┼─────────────────────┼───────────┤
1214 │running │ The system is fully │ 0 │
1215 │ │ operational. │ │
1216 ├─────────────┼─────────────────────┼───────────┤
1217 │degraded │ The system is │ > 0 │
1218 │ │ operational but one │ │
1219 │ │ or more units │ │
1220 │ │ failed. │ │
1221 ├─────────────┼─────────────────────┼───────────┤
1222 │maintenance │ The rescue or │ > 0 │
1223 │ │ emergency target is │ │
1224 │ │ active. │ │
1225 ├─────────────┼─────────────────────┼───────────┤
1226 │stopping │ The manager is │ > 0 │
1227 │ │ shutting down. │ │
1228 ├─────────────┼─────────────────────┼───────────┤
1229 │offline │ The manager is not │ > 0 │
1230 │ │ running. │ │
1231 │ │ Specifically, this │ │
1232 │ │ is the operational │ │
1233 │ │ state if an │ │
1234 │ │ incompatible │ │
1235 │ │ program is running │ │
1236 │ │ as system manager │ │
1237 │ │ (PID 1). │ │
1238 ├─────────────┼─────────────────────┼───────────┤
1239 │unknown │ The operational │ > 0 │
1240 │ │ state could not be │ │
1241 │ │ determined, due to │ │
1242 │ │ lack of resources │ │
1243 │ │ or another error │ │
1244 │ │ cause. │ │
1245 └─────────────┴─────────────────────┴───────────┘
1246 default
1248 Enter default mode. This is equivalent to systemctl isolate
1249 default.target. This operation is blocking by default, use
1250 --no-block to request asynchronous behavior.
1251 rescue
1253 Enter rescue mode. This is equivalent to systemctl isolate
1254 rescue.target. This operation is blocking by default, use
1255 --no-block to request asynchronous behavior.
1256 emergency
1258 Enter emergency mode. This is equivalent to systemctl isolate
1259 emergency.target. This operation is blocking by default, use
1260 --no-block to request asynchronous behavior.
1261 halt
1263 Shut down and halt the system. This is mostly equivalent to
1264 systemctl start halt.target --job-mode=replace-irreversibly
1265 --no-block, but also prints a wall message to all users. This
1266 command is asynchronous; it will return after the halt operation is
1267 enqueued, without waiting for it to complete. Note that this
1268 operation will simply halt the OS kernel after shutting down,
1269 leaving the hardware powered on. Use systemctl poweroff for
1270 powering off the system (see below).
1271 If combined with --force, shutdown of all running services is
1273 skipped, however all processes are killed and all file systems are
1274 unmounted or mounted read-only, immediately followed by the system
1275 halt. If --force is specified twice, the operation is immediately
1276 executed without terminating any processes or unmounting any file
1277 systems. This may result in data loss. Note that when --force is
1278 specified twice the halt operation is executed by systemctl itself,
1279 and the system manager is not contacted. This means the command
1280 should succeed even when the system manager has crashed.
1281 poweroff
1283 Shut down and power-off the system. This is mostly equivalent to
1284 systemctl start poweroff.target --job-mode=replace-irreversibly
1285 --no-block, but also prints a wall message to all users. This
1286 command is asynchronous; it will return after the power-off
1287 operation is enqueued, without waiting for it to complete.
1288 If combined with --force, shutdown of all running services is
1290 skipped, however all processes are killed and all file systems are
1291 unmounted or mounted read-only, immediately followed by the
1292 powering off. If --force is specified twice, the operation is
1293 immediately executed without terminating any processes or
1294 unmounting any file systems. This may result in data loss. Note
1295 that when --force is specified twice the power-off operation is
1296 executed by systemctl itself, and the system manager is not
1297 contacted. This means the command should succeed even when the
1298 system manager has crashed.
1299 reboot [arg]
1301 Shut down and reboot the system. This is mostly equivalent to
1302 systemctl start reboot.target --job-mode=replace-irreversibly
1303 --no-block, but also prints a wall message to all users. This
1304 command is asynchronous; it will return after the reboot operation
1305 is enqueued, without waiting for it to complete.
1306 If combined with --force, shutdown of all running services is
1308 skipped, however all processes are killed and all file systems are
1309 unmounted or mounted read-only, immediately followed by the reboot.
1310 If --force is specified twice, the operation is immediately
1311 executed without terminating any processes or unmounting any file
1312 systems. This may result in data loss. Note that when --force is
1313 specified twice the reboot operation is executed by systemctl
1314 itself, and the system manager is not contacted. This means the
1315 command should succeed even when the system manager has crashed.
1316 If the optional argument arg is given, it will be passed as the
1318 optional argument to the reboot(2) system call. The value is
1319 architecture and firmware specific. As an example, "recovery" might
1320 be used to trigger system recovery, and "fota" might be used to
1321 trigger a “firmware over the air” update.
1322 kexec
1324 Shut down and reboot the system via kexec. This is equivalent to
1325 systemctl start kexec.target --job-mode=replace-irreversibly
1326 --no-block. This command is asynchronous; it will return after the
1327 reboot operation is enqueued, without waiting for it to complete.
1328 If combined with --force, shutdown of all running services is
1330 skipped, however all processes are killed and all file systems are
1331 unmounted or mounted read-only, immediately followed by the reboot.
1332 exit [EXIT_CODE]
1334 Ask the service manager to quit. This is only supported for user
1335 service managers (i.e. in conjunction with the --user option) or in
1336 containers and is equivalent to poweroff otherwise. This command is
1337 asynchronous; it will return after the exit operation is enqueued,
1338 without waiting for it to complete.
1339 The service manager will exit with the specified exit code, if
1341 EXIT_CODE is passed.
1342 switch-root ROOT [INIT]
1344 Switches to a different root directory and executes a new system
1345 manager process below it. This is intended for usage in initial RAM
1346 disks ("initrd"), and will transition from the initrd's system
1347 manager process (a.k.a. "init" process) to the main system manager
1348 process which is loaded from the actual host volume. This call
1349 takes two arguments: the directory that is to become the new root
1350 directory, and the path to the new system manager binary below it
1351 to execute as PID 1. If the latter is omitted or the empty string,
1352 a systemd binary will automatically be searched for and used as
1353 init. If the system manager path is omitted, equal to the empty
1354 string or identical to the path to the systemd binary, the state of
1355 the initrd's system manager process is passed to the main system
1356 manager, which allows later introspection of the state of the
1357 services involved in the initrd boot phase.
1358 suspend
1360 Suspend the system. This will trigger activation of the special
1361 target unit suspend.target. This command is asynchronous, and will
1362 return after the suspend operation is successfully enqueued. It
1363 will not wait for the suspend/resume cycle to complete.
1364 hibernate
1366 Hibernate the system. This will trigger activation of the special
1367 target unit hibernate.target. This command is asynchronous, and
1368 will return after the hibernation operation is successfully
1369 enqueued. It will not wait for the hibernate/thaw cycle to
1370 complete.
1371 hybrid-sleep
1373 Hibernate and suspend the system. This will trigger activation of
1374 the special target unit hybrid-sleep.target. This command is
1375 asynchronous, and will return after the hybrid sleep operation is
1376 successfully enqueued. It will not wait for the sleep/wake-up cycle
1377 to complete.
1378 suspend-then-hibernate
1380 Suspend the system and hibernate it after the delay specified in
1381 systemd-sleep.conf. This will trigger activation of the special
1382 target unit suspend-then-hibernate.target. This command is
1383 asynchronous, and will return after the hybrid sleep operation is
1384 successfully enqueued. It will not wait for the sleep/wake-up or
1385 hibernate/thaw cycle to complete.
1386 Parameter Syntax
1388 Unit commands listed above take either a single unit name (designated
1389 as UNIT), or multiple unit specifications (designated as PATTERN...).
1390 In the first case, the unit name with or without a suffix must be
1391 given. If the suffix is not specified (unit name is "abbreviated"),
1392 systemctl will append a suitable suffix, ".service" by default, and a
1393 type-specific suffix in case of commands which operate only on specific
1394 unit types. For example,
1395 # systemctl start sshd
1397 and
1399 # systemctl start sshd.service
1401 are equivalent, as are
1403 # systemctl isolate default
1405 and
1407 # systemctl isolate default.target
1409 Note that (absolute) paths to device nodes are automatically converted
1411 to device unit names, and other (absolute) paths to mount unit names.
1412 # systemctl status /dev/sda
1414 # systemctl status /home
1415 are equivalent to:
1417 # systemctl status dev-sda.device
1419 # systemctl status home.mount
1420 In the second case, shell-style globs will be matched against the
1422 primary names of all units currently in memory; literal unit names,
1423 with or without a suffix, will be treated as in the first case. This
1424 means that literal unit names always refer to exactly one unit, but
1425 globs may match zero units and this is not considered an error.
1426 Glob patterns use fnmatch(3), so normal shell-style globbing rules are
1428 used, and "*", "?", "[]" may be used. See glob(7) for more details. The
1429 patterns are matched against the primary names of units currently in
1430 memory, and patterns which do not match anything are silently skipped.
1431 For example:
1432 # systemctl stop sshd@*.service
1434 will stop all sshd@.service instances. Note that alias names of units,
1436 and units that aren't in memory are not considered for glob expansion.
1437 For unit file commands, the specified UNIT should be the name of the
1439 unit file (possibly abbreviated, see above), or the absolute path to
1440 the unit file:
1441 # systemctl enable foo.service
1443 or
1445 # systemctl link /path/to/foo.service
1447
1450 On success, 0 is returned, a non-zero failure code otherwise.
1451 systemctl uses the return codes defined by LSB, as defined in LSB
1453 3.0.0[2].
1454 Table 3. LSB return codes
1456 ┌──────┬─────────────────────┬─────────────────────┐
1457 │Value │ Description in LSB │ Use in systemd │
1458 ├──────┼─────────────────────┼─────────────────────┤
1459 │0 │ "program is running │ unit is active │
1460 │ │ or service is OK" │ │
1461 ├──────┼─────────────────────┼─────────────────────┤
1462 │1 │ "program is dead │ unit not failed │
1463 │ │ and /var/run pid │ (used by is-failed) │
1464 │ │ file exists" │ │
1465 ├──────┼─────────────────────┼─────────────────────┤
1466 │2 │ "program is dead │ unused │
1467 │ │ and /var/lock lock │ │
1468 │ │ file exists" │ │
1469 ├──────┼─────────────────────┼─────────────────────┤
1470 │3 │ "program is not │ unit is not active │
1471 │ │ running" │ │
1472 ├──────┼─────────────────────┼─────────────────────┤
1473 │4 │ "program or service │ no such unit │
1474 │ │ status is unknown" │ │
1475 └──────┴─────────────────────┴─────────────────────┘
1476 The mapping of LSB service states to systemd unit states is imperfect,
1478 so it is better to not rely on those return values but to look for
1479 specific unit states and substates instead.
1480
1482 $SYSTEMD_EDITOR
1483 Editor to use when editing units; overrides $EDITOR and $VISUAL. If
1484 neither $SYSTEMD_EDITOR nor $EDITOR nor $VISUAL are present or if
1485 it is set to an empty string or if their execution failed,
1486 systemctl will try to execute well known editors in this order:
1487 editor(1), nano(1), vim(1), vi(1).
1488 $SYSTEMD_PAGER
1490 Pager to use when --no-pager is not given; overrides $PAGER. If
1491 neither $SYSTEMD_PAGER nor $PAGER are set, a set of well-known
1492 pager implementations are tried in turn, including less(1) and
1493 more(1), until one is found. If no pager implementation is
1494 discovered no pager is invoked. Setting this environment variable
1495 to an empty string or the value "cat" is equivalent to passing
1496 --no-pager.
1497 $SYSTEMD_LESS
1499 Override the options passed to less (by default "FRSXMK").
1500 Users might want to change two options in particular:
1502 K
1504 This option instructs the pager to exit immediately when Ctrl+C
1505 is pressed. To allow less to handle Ctrl+C itself to switch
1506 back to the pager command prompt, unset this option.
1507 If the value of $SYSTEMD_LESS does not include "K", and the
1509 pager that is invoked is less, Ctrl+C will be ignored by the
1510 executable, and needs to be handled by the pager.
1511 X
1513 This option instructs the pager to not send termcap
1514 initialization and deinitialization strings to the terminal. It
1515 is set by default to allow command output to remain visible in
1516 the terminal even after the pager exits. Nevertheless, this
1517 prevents some pager functionality from working, in particular
1518 paged output cannot be scrolled with the mouse.
1519 See less(1) for more discussion.
1521 $SYSTEMD_LESSCHARSET
1523 Override the charset passed to less (by default "utf-8", if the
1524 invoking terminal is determined to be UTF-8 compatible).
1525 $SYSTEMD_COLORS
1527 The value must be a boolean. Controls whether colorized output
1528 should be generated. This can be specified to override the decision
1529 that systemd makes based on $TERM and what the console is connected
1530 to.
1531 $SYSTEMD_URLIFY
1533 The value must be a boolean. Controls whether clickable links
1534 should be generated in the output for terminal emulators supporting
1535 this. This can be specified to override the decision that systemd
1536 makes based on $TERM and other conditions.
1537
1539 systemd(1), journalctl(1), loginctl(1), machinectl(1), systemd.unit(5),
1540 systemd.resource-control(5), systemd.special(7), wall(1),
1541 systemd.preset(5), systemd.generator(7), glob(7)
1542
1544 1. Preset
1545 https://www.freedesktop.org/wiki/Software/systemd/Preset
1546 2. LSB 3.0.0
1548 http://refspecs.linuxbase.org/LSB_3.0.0/LSB-PDA/LSB-PDA/iniscrptact.html
1549systemd 243 SYSTEMCTL(1)