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