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 --fail
171 Shorthand for --job-mode=fail.
172 When used with the kill command, if no units were killed, the
174 operation results in an error.
175 -i, --ignore-inhibitors
177 When system shutdown or a sleep state is requested, ignore
178 inhibitor locks. Applications can establish inhibitor locks to
179 avoid that certain important operations (such as CD burning or
180 suchlike) are interrupted by system shutdown or a sleep state. Any
181 user may take these locks and privileged users may override these
182 locks. If any locks are taken, shutdown and sleep state requests
183 will normally fail (unless privileged) and a list of active locks
184 is printed. However, if --ignore-inhibitors is specified, the
185 established locks are ignored and not shown, and the operation
186 attempted anyway, possibly requiring additional privileges.
187 --dry-run
189 Just print what would be done. Currently supported by verbs halt,
190 poweroff, reboot, kexec, suspend, hibernate, hybrid-sleep,
191 suspend-then-hibernate, default, rescue, emergency, and exit.
192 -q, --quiet
194 Suppress printing of the results of various commands and also the
195 hints about truncated log lines. This does not suppress output of
196 commands for which the printed output is the only result (like
197 show). Errors are always printed.
198 --no-block
200 Do not synchronously wait for the requested operation to finish. If
201 this is not specified, the job will be verified, enqueued and
202 systemctl will wait until the unit's start-up is completed. By
203 passing this argument, it is only verified and enqueued. This
204 option may not be combined with --wait.
205 --wait
207 Synchronously wait for started units to terminate again. This
208 option may not be combined with --no-block. Note that this will
209 wait forever if any given unit never terminates (by itself or by
210 getting stopped explicitly); particularly services which use
211 "RemainAfterExit=yes".
212 When used with is-system-running, wait until the boot process is
214 completed before returning.
215 --user
217 Talk to the service manager of the calling user, rather than the
218 service manager of the system.
219 --system
221 Talk to the service manager of the system. This is the implied
222 default.
223 --failed
225 List units in failed state. This is equivalent to --state=failed.
226 --no-wall
228 Do not send wall message before halt, power-off and reboot.
229 --global
231 When used with enable and disable, operate on the global user
232 configuration directory, thus enabling or disabling a unit file
233 globally for all future logins of all users.
234 --no-reload
236 When used with enable and disable, do not implicitly reload daemon
237 configuration after executing the changes.
238 --no-ask-password
240 When used with start and related commands, disables asking for
241 passwords. Background services may require input of a password or
242 passphrase string, for example to unlock system hard disks or
243 cryptographic certificates. Unless this option is specified and the
244 command is invoked from a terminal, systemctl will query the user
245 on the terminal for the necessary secrets. Use this option to
246 switch this behavior off. In this case, the password must be
247 supplied by some other means (for example graphical password
248 agents) or the service might fail. This also disables querying the
249 user for authentication for privileged operations.
250 --kill-who=
252 When used with kill, choose which processes to send a signal to.
253 Must be one of main, control or all to select whether to kill only
254 the main process, the control process or all processes of the unit.
255 The main process of the unit is the one that defines the life-time
256 of it. A control process of a unit is one that is invoked by the
257 manager to induce state changes of it. For example, all processes
258 started due to the ExecStartPre=, ExecStop= or ExecReload= settings
259 of service units are control processes. Note that there is only one
260 control process per unit at a time, as only one state change is
261 executed at a time. For services of type Type=forking, the initial
262 process started by the manager for ExecStart= is a control process,
263 while the process ultimately forked off by that one is then
264 considered the main process of the unit (if it can be determined).
265 This is different for service units of other types, where the
266 process forked off by the manager for ExecStart= is always the main
267 process itself. A service unit consists of zero or one main
268 process, zero or one control process plus any number of additional
269 processes. Not all unit types manage processes of these types
270 however. For example, for mount units, control processes are
271 defined (which are the invocations of /usr/bin/mount and
272 /usr/bin/umount), but no main process is defined. If omitted,
273 defaults to all.
274 -s, --signal=
276 When used with kill, choose which signal to send to selected
277 processes. Must be one of the well-known signal specifiers such as
278 SIGTERM, SIGINT or SIGSTOP. If omitted, defaults to SIGTERM.
279 -f, --force
281 When used with enable, overwrite any existing conflicting symlinks.
282 When used with edit, create all of the specified units which do not
284 already exist.
285 When used with halt, poweroff, reboot or kexec, execute the
287 selected operation without shutting down all units. However, all
288 processes will be killed forcibly and all file systems are
289 unmounted or remounted read-only. This is hence a drastic but
290 relatively safe option to request an immediate reboot. If --force
291 is specified twice for these operations (with the exception of
292 kexec), they will be executed immediately, without terminating any
293 processes or unmounting any file systems. Warning: specifying
294 --force twice with any of these operations might result in data
295 loss. Note that when --force is specified twice the selected
296 operation is executed by systemctl itself, and the system manager
297 is not contacted. This means the command should succeed even when
298 the system manager has crashed.
299 --message=
301 When used with halt, poweroff or reboot, set a short message
302 explaining the reason for the operation. The message will be logged
303 together with the default shutdown message.
304 --now
306 When used with enable, the units will also be started. When used
307 with disable or mask, the units will also be stopped. The start or
308 stop operation is only carried out when the respective enable or
309 disable operation has been successful.
310 --root=
312 When used with enable/disable/is-enabled (and related commands),
313 use the specified root path when looking for unit files. If this
314 option is present, systemctl will operate on the file system
315 directly, instead of communicating with the systemd daemon to carry
316 out changes.
317 --runtime
319 When used with enable, disable, edit, (and related commands), make
320 changes only temporarily, so that they are lost on the next reboot.
321 This will have the effect that changes are not made in
322 subdirectories of /etc but in /run, with identical immediate
323 effects, however, since the latter is lost on reboot, the changes
324 are lost too.
325 Similarly, when used with set-property, make changes only
327 temporarily, so that they are lost on the next reboot.
328 --preset-mode=
330 Takes one of "full" (the default), "enable-only", "disable-only".
331 When used with the preset or preset-all commands, controls whether
332 units shall be disabled and enabled according to the preset rules,
333 or only enabled, or only disabled.
334 -n, --lines=
336 When used with status, controls the number of journal lines to
337 show, counting from the most recent ones. Takes a positive integer
338 argument, or 0 to disable journal output. Defaults to 10.
339 -o, --output=
341 When used with status, controls the formatting of the journal
342 entries that are shown. For the available choices, see
343 journalctl(1). Defaults to "short".
344 --firmware-setup
346 When used with the reboot command, indicate to the system's
347 firmware to boot into setup mode. Note that this is currently only
348 supported on some EFI systems and only if the system was booted in
349 EFI mode.
350 --plain
352 When used with list-dependencies, list-units or list-machines, the
353 output is printed as a list instead of a tree, and the bullet
354 circles are omitted.
355 -H, --host=
357 Execute the operation remotely. Specify a hostname, or a username
358 and hostname separated by "@", to connect to. The hostname may
359 optionally be suffixed by a port ssh is listening on, seperated by
360 ":", and then a container name, separated by "/", which connects
361 directly to a specific container on the specified host. This will
362 use SSH to talk to the remote machine manager instance. Container
363 names may be enumerated with machinectl -H HOST. Put IPv6 addresses
364 in brackets.
365 -M, --machine=
367 Execute operation on a local container. Specify a container name to
368 connect to.
369 --no-pager
371 Do not pipe output into a pager.
372 --no-legend
374 Do not print the legend, i.e. column headers and the footer with
375 hints.
376 -h, --help
378 Print a short help text and exit.
379 --version
381 Print a short version string and exit.
382
384 The following commands are understood:
385 Unit Commands
387 list-units [PATTERN...]
388 List units that systemd currently has in memory. This includes
389 units that are either referenced directly or through a dependency,
390 units that are pinned by applications programmatically, or units
391 that were active in the past and have failed. By default only units
392 which are active, have pending jobs, or have failed are shown; this
393 can be changed with option --all. If one or more PATTERNs are
394 specified, only units matching one of them are shown. The units
395 that are shown are additionally filtered by --type= and --state= if
396 those options are specified.
397 Produces output similar to
399 UNIT LOAD ACTIVE SUB DESCRIPTION
401 sys-module-fuse.device loaded active plugged /sys/module/fuse
402 -.mount loaded active mounted Root Mount
403 boot-efi.mount loaded active mounted /boot/efi
404 systemd-journald.service loaded active running Journal Service
405 systemd-logind.service loaded active running Login Service
406 ● user@1000.service loaded failed failed User Manager for UID 1000
407 ...
408 systemd-tmpfiles-clean.timer loaded active waiting Daily Cleanup of Temporary Directories
409 LOAD = Reflects whether the unit definition was properly loaded.
411 ACTIVE = The high-level unit activation state, i.e. generalization of SUB.
412 SUB = The low-level unit activation state, values depend on unit type.
413 123 loaded units listed. Pass --all to see loaded but inactive units, too.
415 To show all installed unit files use 'systemctl list-unit-files'.
416 The header and the last unit of a given type are underlined if the
419 terminal supports that. A colored dot is shown next to services
420 which were masked, not found, or otherwise failed.
421 The LOAD column shows the load state, one of loaded, not-found,
423 bad-setting, error, masked. The ACTIVE columns shows the general
424 unit state, one of active, reloading, inactive, failed, activating,
425 deactivating. The SUB column shows the unit-type-specific detailed
426 state of the unit, possible values vary by unit type. The list of
427 possible LOAD, ACTIVE, and SUB states is not constant and new
428 systemd releases may both add and remove values.
429 systemctl --state=help
431 command maybe be used to display the current set of possible
433 values.
434 This is the default command.
436 list-sockets [PATTERN...]
438 List socket units currently in memory, ordered by listening
439 address. If one or more PATTERNs are specified, only socket units
440 matching one of them are shown. Produces output similar to
441 LISTEN UNIT ACTIVATES
443 /dev/initctl systemd-initctl.socket systemd-initctl.service
444 ...
445 [::]:22 sshd.socket sshd.service
446 kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
447 5 sockets listed.
449 Note: because the addresses might contains spaces, this output is
451 not suitable for programmatic consumption.
452 Also see --show-types, --all, and --state=.
454 list-timers [PATTERN...]
456 List timer units currently in memory, ordered by the time they
457 elapse next. If one or more PATTERNs are specified, only units
458 matching one of them are shown. Produces output similar to
459 NEXT LEFT LAST PASSED UNIT ACTIVATES
461 n/a n/a Thu 2017-02-23 13:40:29 EST 3 days ago ureadahead-stop.timer ureadahead-stop.service
462 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
463 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
464 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
465 NEXT shows the next time the timer will run.
468 LEFT shows how long till the next time the timer runs.
470 LAST shows the last time the timer ran.
472 PASSED shows how long has passed since the timer last ran.
474 UNIT shows the name of the timer
476 ACTIVATES shows the name the service the timer activates when it
478 runs.
479 Also see --all and --state=.
481 start PATTERN...
483 Start (activate) one or more units specified on the command line.
484 Note that glob patterns operate on the set of primary names of
486 units currently in memory. Units which are not active and are not
487 in a failed state usually are not in memory, and will not be
488 matched by any pattern. In addition, in case of instantiated units,
489 systemd is often unaware of the instance name until the instance
490 has been started. Therefore, using glob patterns with start has
491 limited usefulness. Also, secondary alias names of units are not
492 considered.
493 stop PATTERN...
495 Stop (deactivate) one or more units specified on the command line.
496 reload PATTERN...
498 Asks all units listed on the command line to reload their
499 configuration. Note that this will reload the service-specific
500 configuration, not the unit configuration file of systemd. If you
501 want systemd to reload the configuration file of a unit, use the
502 daemon-reload command. In other words: for the example case of
503 Apache, this will reload Apache's httpd.conf in the web server, not
504 the apache.service systemd unit file.
505 This command should not be confused with the daemon-reload command.
507 restart PATTERN...
509 Stop and then start one or more units specified on the command
510 line. If the units are not running yet, they will be started.
511 Note that restarting a unit with this command does not necessarily
513 flush out all of the unit's resources before it is started again.
514 For example, the per-service file descriptor storage facility (see
515 FileDescriptorStoreMax= in systemd.service(5)) will remain intact
516 as long as the unit has a job pending, and is only cleared when the
517 unit is fully stopped and no jobs are pending anymore. If it is
518 intended that the file descriptor store is flushed out, too, during
519 a restart operation an explicit systemctl stop command followed by
520 systemctl start should be issued.
521 try-restart PATTERN...
523 Stop and then start one or more units specified on the command line
524 if the units are running. This does nothing if units are not
525 running.
526 reload-or-restart PATTERN...
528 Reload one or more units if they support it. If not, stop and then
529 start them instead. If the units are not running yet, they will be
530 started.
531 try-reload-or-restart PATTERN...
533 Reload one or more units if they support it. If not, stop and then
534 start them instead. This does nothing if the units are not running.
535 isolate UNIT
537 Start the unit specified on the command line and its dependencies
538 and stop all others, unless they have IgnoreOnIsolate=yes (see
539 systemd.unit(5)). If a unit name with no extension is given, an
540 extension of ".target" will be assumed.
541 This is similar to changing the runlevel in a traditional init
543 system. The isolate command will immediately stop processes that
544 are not enabled in the new unit, possibly including the graphical
545 environment or terminal you are currently using.
546 Note that this is allowed only on units where AllowIsolate= is
548 enabled. See systemd.unit(5) for details.
549 kill PATTERN...
551 Send a signal to one or more processes of the unit. Use --kill-who=
552 to select which process to kill. Use --signal= to select the signal
553 to send.
554 is-active PATTERN...
556 Check whether any of the specified units are active (i.e. running).
557 Returns an exit code 0 if at least one is active, or non-zero
558 otherwise. Unless --quiet is specified, this will also print the
559 current unit state to standard output.
560 is-failed PATTERN...
562 Check whether any of the specified units are in a "failed" state.
563 Returns an exit code 0 if at least one has failed, non-zero
564 otherwise. Unless --quiet is specified, this will also print the
565 current unit state to standard output.
566 status [PATTERN...|PID...]]
568 Show terse runtime status information about one or more units,
569 followed by most recent log data from the journal. If no units are
570 specified, show system status. If combined with --all, also show
571 the status of all units (subject to limitations specified with -t).
572 If a PID is passed, show information about the unit the process
573 belongs to.
574 This function is intended to generate human-readable output. If you
576 are looking for computer-parsable output, use show instead. By
577 default, this function only shows 10 lines of output and ellipsizes
578 lines to fit in the terminal window. This can be changed with
579 --lines and --full, see above. In addition, journalctl --unit=NAME
580 or journalctl --user-unit=NAME use a similar filter for messages
581 and might be more convenient.
582 systemd implicitly loads units as necessary, so just running the
584 status will attempt to load a file. The command is thus not useful
585 for determining if something was already loaded or not. The units
586 may possibly also be quickly unloaded after the operation is
587 completed if there's no reason to keep it in memory thereafter.
588 Example 1. Example output from systemctl status
590 $ systemctl status bluetooth
592 ● bluetooth.service - Bluetooth service
593 Loaded: loaded (/usr/lib/systemd/system/bluetooth.service; enabled; vendor preset: enabled)
594 Active: active (running) since Wed 2017-01-04 13:54:04 EST; 1 weeks 0 days ago
595 Docs: man:bluetoothd(8)
596 Main PID: 930 (bluetoothd)
597 Status: "Running"
598 Tasks: 1
599 Memory: 648.0K
600 CPU: 435ms
601 CGroup: /system.slice/bluetooth.service
602 └─930 /usr/lib/bluetooth/bluetoothd
603 Jan 12 10:46:45 example.com bluetoothd[8900]: Not enough free handles to register service
605 Jan 12 10:46:45 example.com bluetoothd[8900]: Current Time Service could not be registered
606 Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output error (5)
607 The dot ("●") uses color on supported terminals to summarize the
609 unit state at a glance. White indicates an "inactive" or
610 "deactivating" state. Red indicates a "failed" or "error" state and
611 green indicates an "active", "reloading" or "activating" state.
612 The "Loaded:" line in the output will show "loaded" if the unit has
614 been loaded into memory. Other possible values for "Loaded:"
615 include: "error" if there was a problem loading it, "not-found" if
616 not unit file was found for this unit, "bad-setting" if an
617 essential unit file setting could not be parsed and "masked" if the
618 unit file has been masked. Along with showing the path to the unit
619 file, this line will also show the enablement state. Enabled
620 commands start at boot. See the full table of possible enablement
621 states — including the definition of "masked" — in the
622 documentation for the is-enabled command.
623 The "Active:" line shows active state. The value is usually
625 "active" or "inactive". Active could mean started, bound, plugged
626 in, etc depending on the unit type. The unit could also be in
627 process of changing states, reporting a state of "activating" or
628 "deactivating". A special "failed" state is entered when the
629 service failed in some way, such as a crash, exiting with an error
630 code or timing out. If the failed state is entered the cause will
631 be logged for later reference.
632 show [PATTERN...|JOB...]
634 Show properties of one or more units, jobs, or the manager itself.
635 If no argument is specified, properties of the manager will be
636 shown. If a unit name is specified, properties of the unit are
637 shown, and if a job ID is specified, properties of the job are
638 shown. By default, empty properties are suppressed. Use --all to
639 show those too. To select specific properties to show, use
640 --property=. This command is intended to be used whenever
641 computer-parsable output is required. Use status if you are looking
642 for formatted human-readable output.
643 Many properties shown by systemctl show map directly to
645 configuration settings of the system and service manager and its
646 unit files. Note that the properties shown by the command are
647 generally more low-level, normalized versions of the original
648 configuration settings and expose runtime state in addition to
649 configuration. For example, properties shown for service units
650 include the service's current main process identifier as "MainPID"
651 (which is runtime state), and time settings are always exposed as
652 properties ending in the "...USec" suffix even if a matching
653 configuration options end in "...Sec", because microseconds is the
654 normalized time unit used by the system and service manager.
655 cat PATTERN...
657 Show backing files of one or more units. Prints the "fragment" and
658 "drop-ins" (source files) of units. Each file is preceded by a
659 comment which includes the file name. Note that this shows the
660 contents of the backing files on disk, which may not match the
661 system manager's understanding of these units if any unit files
662 were updated on disk and the daemon-reload command wasn't issued
663 since.
664 set-property UNIT PROPERTY=VALUE...
666 Set the specified unit properties at runtime where this is
667 supported. This allows changing configuration parameter properties
668 such as resource control settings at runtime. Not all properties
669 may be changed at runtime, but many resource control settings
670 (primarily those in systemd.resource-control(5)) may. The changes
671 are applied immediately, and stored on disk for future boots,
672 unless --runtime is passed, in which case the settings only apply
673 until the next reboot. The syntax of the property assignment
674 follows closely the syntax of assignments in unit files.
675 Example: systemctl set-property foobar.service CPUShares=777
677 If the specified unit appears to be inactive, the changes will be
679 only stored on disk as described previously hence they will be
680 effective when the unit will be started.
681 Note that this command allows changing multiple properties at the
683 same time, which is preferable over setting them individually. Like
684 with unit file configuration settings, assigning an empty list will
685 reset the property.
686 help PATTERN...|PID...
688 Show manual pages for one or more units, if available. If a PID is
689 given, the manual pages for the unit the process belongs to are
690 shown.
691 reset-failed [PATTERN...]
693 Reset the "failed" state of the specified units, or if no unit name
694 is passed, reset the state of all units. When a unit fails in some
695 way (i.e. process exiting with non-zero error code, terminating
696 abnormally or timing out), it will automatically enter the "failed"
697 state and its exit code and status is recorded for introspection by
698 the administrator until the service is stopped/re-started or reset
699 with this command.
700 In addition to resetting the "failed" state of a unit it also
702 resets various other per-unit properties: the start rate limit
703 counter of all unit types is reset to zero, as is the restart
704 counter of service units. Thus, if a unit's start limit (as
705 configured with StartLimitIntervalSec=/StartLimitBurst=) is hit and
706 the unit refuses to be started again, use this command to make it
707 startable again.
708 list-dependencies [UNIT]
710 Shows units required and wanted by the specified unit. This
711 recursively lists units following the Requires=, Requisite=,
712 ConsistsOf=, Wants=, BindsTo= dependencies. If no unit is
713 specified, default.target is implied.
714 By default, only target units are recursively expanded. When --all
716 is passed, all other units are recursively expanded as well.
717 Options --reverse, --after, --before may be used to change what
719 types of dependencies are shown.
720 Note that this command only lists units currently loaded into
722 memory by the service manager. In particular, this command is not
723 suitable to get a comprehensive list at all reverse dependencies on
724 a specific unit, as it won't list the dependencies declared by
725 units currently not loaded.
726 Unit File Commands
728 list-unit-files [PATTERN...]
729 List unit files installed on the system, in combination with their
730 enablement state (as reported by is-enabled). If one or more
731 PATTERNs are specified, only unit files whose name matches one of
732 them are shown (patterns matching unit file system paths are not
733 supported).
734 enable UNIT..., enable PATH...
736 Enable one or more units or unit instances. This will create a set
737 of symlinks, as encoded in the "[Install]" sections of the
738 indicated unit files. After the symlinks have been created, the
739 system manager configuration is reloaded (in a way equivalent to
740 daemon-reload), in order to ensure the changes are taken into
741 account immediately. Note that this does not have the effect of
742 also starting any of the units being enabled. If this is desired,
743 combine this command with the --now switch, or invoke start with
744 appropriate arguments later. Note that in case of unit instance
745 enablement (i.e. enablement of units of the form foo@bar.service),
746 symlinks named the same as instances are created in the unit
747 configuration directory, however they point to the single template
748 unit file they are instantiated from.
749 This command expects either valid unit names (in which case various
751 unit file directories are automatically searched for unit files
752 with appropriate names), or absolute paths to unit files (in which
753 case these files are read directly). If a specified unit file is
754 located outside of the usual unit file directories, an additional
755 symlink is created, linking it into the unit configuration path,
756 thus ensuring it is found when requested by commands such as start.
757 The file system where the linked unit files are located must be
758 accessible when systemd is started (e.g. anything underneath /home
759 or /var is not allowed, unless those directories are located on the
760 root file system).
761 This command will print the file system operations executed. This
763 output may be suppressed by passing --quiet.
764 Note that this operation creates only the symlinks suggested in the
766 "[Install]" section of the unit files. While this command is the
767 recommended way to manipulate the unit configuration directory, the
768 administrator is free to make additional changes manually by
769 placing or removing symlinks below this directory. This is
770 particularly useful to create configurations that deviate from the
771 suggested default installation. In this case, the administrator
772 must make sure to invoke daemon-reload manually as necessary, in
773 order to ensure the changes are taken into account.
774 Enabling units should not be confused with starting (activating)
776 units, as done by the start command. Enabling and starting units is
777 orthogonal: units may be enabled without being started and started
778 without being enabled. Enabling simply hooks the unit into various
779 suggested places (for example, so that the unit is automatically
780 started on boot or when a particular kind of hardware is plugged
781 in). Starting actually spawns the daemon process (in case of
782 service units), or binds the socket (in case of socket units), and
783 so on.
784 Depending on whether --system, --user, --runtime, or --global is
786 specified, this enables the unit for the system, for the calling
787 user only, for only this boot of the system, or for all future
788 logins of all users. Note that in the last case, no systemd daemon
789 configuration is reloaded.
790 Using enable on masked units is not supported and results in an
792 error.
793 disable UNIT...
795 Disables one or more units. This removes all symlinks to the unit
796 files backing the specified units from the unit configuration
797 directory, and hence undoes any changes made by enable or link.
798 Note that this removes all symlinks to matching unit files,
799 including manually created symlinks, and not just those actually
800 created by enable or link. Note that while disable undoes the
801 effect of enable, the two commands are otherwise not symmetric, as
802 disable may remove more symlinks than a prior enable invocation of
803 the same unit created.
804 This command expects valid unit names only, it does not accept
806 paths to unit files.
807 In addition to the units specified as arguments, all units are
809 disabled that are listed in the Also= setting contained in the
810 "[Install]" section of any of the unit files being operated on.
811 This command implicitly reloads the system manager configuration
813 after completing the operation. Note that this command does not
814 implicitly stop the units that are being disabled. If this is
815 desired, either combine this command with the --now switch, or
816 invoke the stop command with appropriate arguments later.
817 This command will print information about the file system
819 operations (symlink removals) executed. This output may be
820 suppressed by passing --quiet.
821 This command honors --system, --user, --runtime and --global in a
823 similar way as enable.
824 reenable UNIT...
826 Reenable one or more units, as specified on the command line. This
827 is a combination of disable and enable and is useful to reset the
828 symlinks a unit file is enabled with to the defaults configured in
829 its "[Install]" section. This command expects a unit name only, it
830 does not accept paths to unit files.
831 preset UNIT...
833 Reset the enable/disable status one or more unit files, as
834 specified on the command line, to the defaults configured in the
835 preset policy files. This has the same effect as disable or enable,
836 depending how the unit is listed in the preset files.
837 Use --preset-mode= to control whether units shall be enabled and
839 disabled, or only enabled, or only disabled.
840 If the unit carries no install information, it will be silently
842 ignored by this command. UNIT must be the real unit name, any
843 alias names are ignored silently.
844 For more information on the preset policy format, see
846 systemd.preset(5). For more information on the concept of presets,
847 please consult the Preset[1] document.
848 preset-all
850 Resets all installed unit files to the defaults configured in the
851 preset policy file (see above).
852 Use --preset-mode= to control whether units shall be enabled and
854 disabled, or only enabled, or only disabled.
855 is-enabled UNIT...
857 Checks whether any of the specified unit files are enabled (as with
858 enable). Returns an exit code of 0 if at least one is enabled,
859 non-zero otherwise. Prints the current enable status (see table).
860 To suppress this output, use --quiet. To show installation targets,
861 use --full.
862 Table 1. is-enabled output
864 ┌──────────────────┬─────────────────────────┬───────────┐
865 │Name │ Description │ Exit Code │
866 ├──────────────────┼─────────────────────────┼───────────┤
867 │"enabled" │ Enabled via │ │
868 ├──────────────────┤ .wants/, .requires/ │ │
869 │"enabled-runtime" │ or Alias= symlinks │ │
870 │ │ (permanently in │ 0 │
871 │ │ /etc/systemd/system/, │ │
872 │ │ or transiently in │ │
873 │ │ /run/systemd/system/). │ │
874 ├──────────────────┼─────────────────────────┼───────────┤
875 │"linked" │ Made available through │ │
876 ├──────────────────┤ one or more symlinks │ │
877 │"linked-runtime" │ to the unit file │ │
878 │ │ (permanently in │ │
879 │ │ /etc/systemd/system/ │ │
880 │ │ or transiently in │ > 0 │
881 │ │ /run/systemd/system/), │ │
882 │ │ even though the unit │ │
883 │ │ file might reside │ │
884 │ │ outside of the unit │ │
885 │ │ file search path. │ │
886 ├──────────────────┼─────────────────────────┼───────────┤
887 │"masked" │ Completely disabled, │ │
888 ├──────────────────┤ so that any start │ │
889 │"masked-runtime" │ operation on it fails │ │
890 │ │ (permanently in │ > 0 │
891 │ │ /etc/systemd/system/ │ │
892 │ │ or transiently in │ │
893 │ │ /run/systemd/systemd/). │ │
894 ├──────────────────┼─────────────────────────┼───────────┤
895 │"static" │ The unit file is not │ 0 │
896 │ │ enabled, and has no │ │
897 │ │ provisions for enabling │ │
898 │ │ in the "[Install]" unit │ │
899 │ │ file section. │ │
900 ├──────────────────┼─────────────────────────┼───────────┤
901 │"indirect" │ The unit file itself is │ 0 │
902 │ │ not enabled, but it has │ │
903 │ │ a non-empty Also= │ │
904 │ │ setting in the │ │
905 │ │ "[Install]" unit file │ │
906 │ │ section, listing other │ │
907 │ │ unit files that might │ │
908 │ │ be enabled, or it has │ │
909 │ │ an alias under a │ │
910 │ │ different name through │ │
911 │ │ a symlink that is not │ │
912 │ │ specified in Also=. For │ │
913 │ │ template unit file, an │ │
914 │ │ instance different than │ │
915 │ │ the one specified in │ │
916 │ │ DefaultInstance= is │ │
917 │ │ enabled. │ │
918 ├──────────────────┼─────────────────────────┼───────────┤
919 │"disabled" │ The unit file is not │ > 0 │
920 │ │ enabled, but contains │ │
921 │ │ an "[Install]" section │ │
922 │ │ with installation │ │
923 │ │ instructions. │ │
924 ├──────────────────┼─────────────────────────┼───────────┤
925 │"generated" │ The unit file was │ 0 │
926 │ │ generated dynamically │ │
927 │ │ via a generator tool. │ │
928 │ │ See │ │
929 │ │ systemd.generator(7). │ │
930 │ │ Generated unit files │ │
931 │ │ may not be enabled, │ │
932 │ │ they are enabled │ │
933 │ │ implicitly by their │ │
934 │ │ generator. │ │
935 ├──────────────────┼─────────────────────────┼───────────┤
936 │"transient" │ The unit file has been │ 0 │
937 │ │ created dynamically │ │
938 │ │ with the runtime API. │ │
939 │ │ Transient units may not │ │
940 │ │ be enabled. │ │
941 ├──────────────────┼─────────────────────────┼───────────┤
942 │"bad" │ The unit file is │ > 0 │
943 │ │ invalid or another │ │
944 │ │ error occurred. Note │ │
945 │ │ that is-enabled will │ │
946 │ │ not actually return │ │
947 │ │ this state, but print │ │
948 │ │ an error message │ │
949 │ │ instead. However the │ │
950 │ │ unit file listing │ │
951 │ │ printed by │ │
952 │ │ list-unit-files might │ │
953 │ │ show it. │ │
954 └──────────────────┴─────────────────────────┴───────────┘
955 mask UNIT...
957 Mask one or more units, as specified on the command line. This will
958 link these unit files to /dev/null, making it impossible to start
959 them. This is a stronger version of disable, since it prohibits all
960 kinds of activation of the unit, including enablement and manual
961 activation. Use this option with care. This honors the --runtime
962 option to only mask temporarily until the next reboot of the
963 system. The --now option may be used to ensure that the units are
964 also stopped. This command expects valid unit names only, it does
965 not accept unit file paths.
966 unmask UNIT...
968 Unmask one or more unit files, as specified on the command line.
969 This will undo the effect of mask. This command expects valid unit
970 names only, it does not accept unit file paths.
971 link PATH...
973 Link a unit file that is not in the unit file search paths into the
974 unit file search path. This command expects an absolute path to a
975 unit file. The effect of this may be undone with disable. The
976 effect of this command is that a unit file is made available for
977 commands such as start, even though it is not installed directly in
978 the unit search path. The file system where the linked unit files
979 are located must be accessible when systemd is started (e.g.
980 anything underneath /home or /var is not allowed, unless those
981 directories are located on the root file system).
982 revert UNIT...
984 Revert one or more unit files to their vendor versions. This
985 command removes drop-in configuration files that modify the
986 specified units, as well as any user-configured unit file that
987 overrides a matching vendor supplied unit file. Specifically, for a
988 unit "foo.service" the matching directories "foo.service.d/" with
989 all their contained files are removed, both below the persistent
990 and runtime configuration directories (i.e. below
991 /etc/systemd/system and /run/systemd/system); if the unit file has
992 a vendor-supplied version (i.e. a unit file located below /usr) any
993 matching persistent or runtime unit file that overrides it is
994 removed, too. Note that if a unit file has no vendor-supplied
995 version (i.e. is only defined below /etc/systemd/system or
996 /run/systemd/system, but not in a unit file stored below /usr),
997 then it is not removed. Also, if a unit is masked, it is unmasked.
998 Effectively, this command may be used to undo all changes made with
1000 systemctl edit, systemctl set-property and systemctl mask and puts
1001 the original unit file with its settings back in effect.
1002 add-wants TARGET UNIT..., add-requires TARGET UNIT...
1004 Adds "Wants=" or "Requires=" dependencies, respectively, to the
1005 specified TARGET for one or more units.
1006 This command honors --system, --user, --runtime and --global in a
1008 way similar to enable.
1009 edit UNIT...
1011 Edit a drop-in snippet or a whole replacement file if --full is
1012 specified, to extend or override the specified unit.
1013 Depending on whether --system (the default), --user, or --global is
1015 specified, this command creates a drop-in file for each unit either
1016 for the system, for the calling user, or for all futures logins of
1017 all users. Then, the editor (see the "Environment" section below)
1018 is invoked on temporary files which will be written to the real
1019 location if the editor exits successfully.
1020 If --full is specified, this will copy the original units instead
1022 of creating drop-in files.
1023 If --force is specified and any units do not already exist, new
1025 unit files will be opened for editing.
1026 If --runtime is specified, the changes will be made temporarily in
1028 /run and they will be lost on the next reboot.
1029 If the temporary file is empty upon exit, the modification of the
1031 related unit is canceled.
1032 After the units have been edited, systemd configuration is reloaded
1034 (in a way that is equivalent to daemon-reload).
1035 Note that this command cannot be used to remotely edit units and
1037 that you cannot temporarily edit units which are in /etc, since
1038 they take precedence over /run.
1039 get-default
1041 Return the default target to boot into. This returns the target
1042 unit name default.target is aliased (symlinked) to.
1043 set-default TARGET
1045 Set the default target to boot into. This sets (symlinks) the
1046 default.target alias to the given target unit.
1047 Machine Commands
1049 list-machines [PATTERN...]
1050 List the host and all running local containers with their state. If
1051 one or more PATTERNs are specified, only containers matching one of
1052 them are shown.
1053 Job Commands
1055 list-jobs [PATTERN...]
1056 List jobs that are in progress. If one or more PATTERNs are
1057 specified, only jobs for units matching one of them are shown.
1058 When combined with --after or --before the list is augmented with
1060 information on which other job each job is waiting for, and which
1061 other jobs are waiting for it, see above.
1062 cancel JOB...
1064 Cancel one or more jobs specified on the command line by their
1065 numeric job IDs. If no job ID is specified, cancel all pending
1066 jobs.
1067 Environment Commands
1069 show-environment
1070 Dump the systemd manager environment block. This is the environment
1071 block that is passed to all processes the manager spawns. The
1072 environment block will be dumped in straight-forward form suitable
1073 for sourcing into most shells. If no special characters or
1074 whitespace is present in the variable values, no escaping is
1075 performed, and the assignments have the form "VARIABLE=value". If
1076 whitespace or characters which have special meaning to the shell
1077 are present, dollar-single-quote escaping is used, and assignments
1078 have the form "VARIABLE=$'value'". This syntax is known to be
1079 supported by bash(1), zsh(1), ksh(1), and busybox(1)'s ash(1), but
1080 not dash(1) or fish(1).
1081 set-environment VARIABLE=VALUE...
1083 Set one or more systemd manager environment variables, as specified
1084 on the command line.
1085 unset-environment VARIABLE...
1087 Unset one or more systemd manager environment variables. If only a
1088 variable name is specified, it will be removed regardless of its
1089 value. If a variable and a value are specified, the variable is
1090 only removed if it has the specified value.
1091 import-environment [VARIABLE...]
1093 Import all, one or more environment variables set on the client
1094 into the systemd manager environment block. If no arguments are
1095 passed, the entire environment block is imported. Otherwise, a list
1096 of one or more environment variable names should be passed, whose
1097 client-side values are then imported into the manager's environment
1098 block.
1099 Manager Lifecycle Commands
1101 daemon-reload
1102 Reload the systemd manager configuration. This will rerun all
1103 generators (see systemd.generator(7)), reload all unit files, and
1104 recreate the entire dependency tree. While the daemon is being
1105 reloaded, all sockets systemd listens on behalf of user
1106 configuration will stay accessible.
1107 This command should not be confused with the reload command.
1109 daemon-reexec
1111 Reexecute the systemd manager. This will serialize the manager
1112 state, reexecute the process and deserialize the state again. This
1113 command is of little use except for debugging and package upgrades.
1114 Sometimes, it might be helpful as a heavy-weight daemon-reload.
1115 While the daemon is being reexecuted, all sockets systemd listening
1116 on behalf of user configuration will stay accessible.
1117 System Commands
1119 is-system-running
1120 Checks whether the system is operational. This returns success
1121 (exit code 0) when the system is fully up and running, specifically
1122 not in startup, shutdown or maintenance mode, and with no failed
1123 services. Failure is returned otherwise (exit code non-zero). In
1124 addition, the current state is printed in a short string to
1125 standard output, see the table below. Use --quiet to suppress this
1126 output.
1127 Use --wait to wait until the boot process is completed before
1129 printing the current state and returning the appropriate error
1130 status. If --wait is in use, states initializing or starting will
1131 not be reported, instead the command will block until a later state
1132 (such as running or degraded) is reached.
1133 Table 2. is-system-running output
1135 ┌─────────────┬─────────────────────┬───────────┐
1136 │Name │ Description │ Exit Code │
1137 ├─────────────┼─────────────────────┼───────────┤
1138 │initializing │ Early bootup, │ > 0 │
1139 │ │ before basic.target │ │
1140 │ │ is reached or the │ │
1141 │ │ maintenance state │ │
1142 │ │ entered. │ │
1143 ├─────────────┼─────────────────────┼───────────┤
1144 │starting │ Late bootup, before │ > 0 │
1145 │ │ the job queue │ │
1146 │ │ becomes idle for │ │
1147 │ │ the first time, or │ │
1148 │ │ one of the rescue │ │
1149 │ │ targets are │ │
1150 │ │ reached. │ │
1151 ├─────────────┼─────────────────────┼───────────┤
1152 │running │ The system is fully │ 0 │
1153 │ │ operational. │ │
1154 ├─────────────┼─────────────────────┼───────────┤
1155 │degraded │ The system is │ > 0 │
1156 │ │ operational but one │ │
1157 │ │ or more units │ │
1158 │ │ failed. │ │
1159 ├─────────────┼─────────────────────┼───────────┤
1160 │maintenance │ The rescue or │ > 0 │
1161 │ │ emergency target is │ │
1162 │ │ active. │ │
1163 ├─────────────┼─────────────────────┼───────────┤
1164 │stopping │ The manager is │ > 0 │
1165 │ │ shutting down. │ │
1166 ├─────────────┼─────────────────────┼───────────┤
1167 │offline │ The manager is not │ > 0 │
1168 │ │ running. │ │
1169 │ │ Specifically, this │ │
1170 │ │ is the operational │ │
1171 │ │ state if an │ │
1172 │ │ incompatible │ │
1173 │ │ program is running │ │
1174 │ │ as system manager │ │
1175 │ │ (PID 1). │ │
1176 ├─────────────┼─────────────────────┼───────────┤
1177 │unknown │ The operational │ > 0 │
1178 │ │ state could not be │ │
1179 │ │ determined, due to │ │
1180 │ │ lack of resources │ │
1181 │ │ or another error │ │
1182 │ │ cause. │ │
1183 └─────────────┴─────────────────────┴───────────┘
1184 default
1186 Enter default mode. This is equivalent to systemctl isolate
1187 default.target. This operation is blocking by default, use
1188 --no-block to request asynchronous behavior.
1189 rescue
1191 Enter rescue mode. This is equivalent to systemctl isolate
1192 rescue.target. This operation is blocking by default, use
1193 --no-block to request asynchronous behavior.
1194 emergency
1196 Enter emergency mode. This is equivalent to systemctl isolate
1197 emergency.target. This operation is blocking by default, use
1198 --no-block to request asynchronous behavior.
1199 halt
1201 Shut down and halt the system. This is mostly equivalent to
1202 systemctl start halt.target --job-mode=replace-irreversibly
1203 --no-block, but also prints a wall message to all users. This
1204 command is asynchronous; it will return after the halt operation is
1205 enqueued, without waiting for it to complete. Note that this
1206 operation will simply halt the OS kernel after shutting down,
1207 leaving the hardware powered on. Use systemctl poweroff for
1208 powering off the system (see below).
1209 If combined with --force, shutdown of all running services is
1211 skipped, however all processes are killed and all file systems are
1212 unmounted or mounted read-only, immediately followed by the system
1213 halt. If --force is specified twice, the operation is immediately
1214 executed without terminating any processes or unmounting any file
1215 systems. This may result in data loss. Note that when --force is
1216 specified twice the halt operation is executed by systemctl itself,
1217 and the system manager is not contacted. This means the command
1218 should succeed even when the system manager has crashed.
1219 poweroff
1221 Shut down and power-off the system. This is mostly equivalent to
1222 systemctl start poweroff.target --job-mode=replace-irreversibly
1223 --no-block, but also prints a wall message to all users. This
1224 command is asynchronous; it will return after the power-off
1225 operation is enqueued, without waiting for it to complete.
1226 If combined with --force, shutdown of all running services is
1228 skipped, however all processes are killed and all file systems are
1229 unmounted or mounted read-only, immediately followed by the
1230 powering off. If --force is specified twice, the operation is
1231 immediately executed without terminating any processes or
1232 unmounting any file systems. This may result in data loss. Note
1233 that when --force is specified twice the power-off operation is
1234 executed by systemctl itself, and the system manager is not
1235 contacted. This means the command should succeed even when the
1236 system manager has crashed.
1237 reboot [arg]
1239 Shut down and reboot the system. This is mostly equivalent to
1240 systemctl start reboot.target --job-mode=replace-irreversibly
1241 --no-block, but also prints a wall message to all users. This
1242 command is asynchronous; it will return after the reboot operation
1243 is enqueued, without waiting for it to complete.
1244 If combined with --force, shutdown of all running services is
1246 skipped, however all processes are killed and all file systems are
1247 unmounted or mounted read-only, immediately followed by the reboot.
1248 If --force is specified twice, the operation is immediately
1249 executed without terminating any processes or unmounting any file
1250 systems. This may result in data loss. Note that when --force is
1251 specified twice the reboot operation is executed by systemctl
1252 itself, and the system manager is not contacted. This means the
1253 command should succeed even when the system manager has crashed.
1254 If the optional argument arg is given, it will be passed as the
1256 optional argument to the reboot(2) system call. The value is
1257 architecture and firmware specific. As an example, "recovery" might
1258 be used to trigger system recovery, and "fota" might be used to
1259 trigger a “firmware over the air” update.
1260 kexec
1262 Shut down and reboot the system via kexec. This is equivalent to
1263 systemctl start kexec.target --job-mode=replace-irreversibly
1264 --no-block. This command is asynchronous; it will return after the
1265 reboot operation is enqueued, without waiting for it to complete.
1266 If combined with --force, shutdown of all running services is
1268 skipped, however all processes are killed and all file systems are
1269 unmounted or mounted read-only, immediately followed by the reboot.
1270 exit [EXIT_CODE]
1272 Ask the service manager to quit. This is only supported for user
1273 service managers (i.e. in conjunction with the --user option) or in
1274 containers and is equivalent to poweroff otherwise. This command is
1275 asynchronous; it will return after the exit operation is enqueued,
1276 without waiting for it to complete.
1277 The service manager will exit with the specified exit code, if
1279 EXIT_CODE is passed.
1280 switch-root ROOT [INIT]
1282 Switches to a different root directory and executes a new system
1283 manager process below it. This is intended for usage in initial RAM
1284 disks ("initrd"), and will transition from the initrd's system
1285 manager process (a.k.a. "init" process) to the main system manager
1286 process which is loaded from the actual host volume. This call
1287 takes two arguments: the directory that is to become the new root
1288 directory, and the path to the new system manager binary below it
1289 to execute as PID 1. If the latter is omitted or the empty string,
1290 a systemd binary will automatically be searched for and used as
1291 init. If the system manager path is omitted, equal to the empty
1292 string or identical to the path to the systemd binary, the state of
1293 the initrd's system manager process is passed to the main system
1294 manager, which allows later introspection of the state of the
1295 services involved in the initrd boot phase.
1296 suspend
1298 Suspend the system. This will trigger activation of the special
1299 target unit suspend.target. This command is asynchronous, and will
1300 return after the suspend operation is successfully enqueued. It
1301 will not wait for the suspend/resume cycle to complete.
1302 hibernate
1304 Hibernate the system. This will trigger activation of the special
1305 target unit hibernate.target. This command is asynchronous, and
1306 will return after the hibernation operation is successfully
1307 enqueued. It will not wait for the hibernate/thaw cycle to
1308 complete.
1309 hybrid-sleep
1311 Hibernate and suspend the system. This will trigger activation of
1312 the special target unit hybrid-sleep.target. This command is
1313 asynchronous, and will return after the hybrid sleep operation is
1314 successfully enqueued. It will not wait for the sleep/wake-up cycle
1315 to complete.
1316 suspend-then-hibernate
1318 Suspend the system and hibernate it after the delay specified in
1319 systemd-sleep.conf. This will trigger activation of the special
1320 target unit suspend-then-hibernate.target. This command is
1321 asynchronous, and will return after the hybrid sleep operation is
1322 successfully enqueued. It will not wait for the sleep/wake-up or
1323 hibernate/thaw cycle to complete.
1324 Parameter Syntax
1326 Unit commands listed above take either a single unit name (designated
1327 as UNIT), or multiple unit specifications (designated as PATTERN...).
1328 In the first case, the unit name with or without a suffix must be
1329 given. If the suffix is not specified (unit name is "abbreviated"),
1330 systemctl will append a suitable suffix, ".service" by default, and a
1331 type-specific suffix in case of commands which operate only on specific
1332 unit types. For example,
1333 # systemctl start sshd
1335 and
1337 # systemctl start sshd.service
1339 are equivalent, as are
1341 # systemctl isolate default
1343 and
1345 # systemctl isolate default.target
1347 Note that (absolute) paths to device nodes are automatically converted
1349 to device unit names, and other (absolute) paths to mount unit names.
1350 # systemctl status /dev/sda
1352 # systemctl status /home
1353 are equivalent to:
1355 # systemctl status dev-sda.device
1357 # systemctl status home.mount
1358 In the second case, shell-style globs will be matched against the
1360 primary names of all units currently in memory; literal unit names,
1361 with or without a suffix, will be treated as in the first case. This
1362 means that literal unit names always refer to exactly one unit, but
1363 globs may match zero units and this is not considered an error.
1364 Glob patterns use fnmatch(3), so normal shell-style globbing rules are
1366 used, and "*", "?", "[]" may be used. See glob(7) for more details. The
1367 patterns are matched against the primary names of units currently in
1368 memory, and patterns which do not match anything are silently skipped.
1369 For example:
1370 # systemctl stop sshd@*.service
1372 will stop all sshd@.service instances. Note that alias names of units,
1374 and units that aren't in memory are not considered for glob expansion.
1375 For unit file commands, the specified UNIT should be the name of the
1377 unit file (possibly abbreviated, see above), or the absolute path to
1378 the unit file:
1379 # systemctl enable foo.service
1381 or
1383 # systemctl link /path/to/foo.service
1385
1388 On success, 0 is returned, a non-zero failure code otherwise.
1389 systemctl uses the return codes defined by LSB, as defined in LSB
1391 3.0.0[2].
1392 Table 3. LSB return codes
1394 ┌──────┬─────────────────────┬─────────────────────┐
1395 │Value │ Description in LSB │ Use in systemd │
1396 ├──────┼─────────────────────┼─────────────────────┤
1397 │0 │ "program is running │ unit is active │
1398 │ │ or service is OK" │ │
1399 ├──────┼─────────────────────┼─────────────────────┤
1400 │1 │ "program is dead │ unit not failed │
1401 │ │ and /var/run pid │ (used by is-failed) │
1402 │ │ file exists" │ │
1403 ├──────┼─────────────────────┼─────────────────────┤
1404 │2 │ "program is dead │ unused │
1405 │ │ and /var/lock lock │ │
1406 │ │ file exists" │ │
1407 ├──────┼─────────────────────┼─────────────────────┤
1408 │3 │ "program is not │ unit is not active │
1409 │ │ running" │ │
1410 ├──────┼─────────────────────┼─────────────────────┤
1411 │4 │ "program or service │ no such unit │
1412 │ │ status is unknown" │ │
1413 └──────┴─────────────────────┴─────────────────────┘
1414 The mapping of LSB service states to systemd unit states is imperfect,
1416 so it is better to not rely on those return values but to look for
1417 specific unit states and substates instead.
1418
1420 $SYSTEMD_EDITOR
1421 Editor to use when editing units; overrides $EDITOR and $VISUAL. If
1422 neither $SYSTEMD_EDITOR nor $EDITOR nor $VISUAL are present or if
1423 it is set to an empty string or if their execution failed,
1424 systemctl will try to execute well known editors in this order:
1425 editor(1), nano(1), vim(1), vi(1).
1426 $SYSTEMD_PAGER
1428 Pager to use when --no-pager is not given; overrides $PAGER. If
1429 neither $SYSTEMD_PAGER nor $PAGER are set, a set of well-known
1430 pager implementations are tried in turn, including less(1) and
1431 more(1), until one is found. If no pager implementation is
1432 discovered no pager is invoked. Setting this environment variable
1433 to an empty string or the value "cat" is equivalent to passing
1434 --no-pager.
1435 $SYSTEMD_LESS
1437 Override the options passed to less (by default "FRSXMK").
1438 If the value of $SYSTEMD_LESS does not include "K", and the pager
1440 that is invoked is less, Ctrl+C will be ignored by the executable.
1441 This allows less to handle Ctrl+C itself.
1442 $SYSTEMD_LESSCHARSET
1444 Override the charset passed to less (by default "utf-8", if the
1445 invoking terminal is determined to be UTF-8 compatible).
1446
1448 systemd(1), journalctl(1), loginctl(1), machinectl(1), systemd.unit(5),
1449 systemd.resource-control(5), systemd.special(7), wall(1),
1450 systemd.preset(5), systemd.generator(7), glob(7)
1451
1453 1. Preset
1454 https://www.freedesktop.org/wiki/Software/systemd/Preset
1455 2. LSB 3.0.0
1457 http://refspecs.linuxbase.org/LSB_3.0.0/LSB-PDA/LSB-PDA/iniscrptact.html
1458systemd 241 SYSTEMCTL(1)