{ "mode": "man", "parameter": "SYSTEMCTL", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/SYSTEMCTL/1/json", "generated": "2026-09-24T12:56:08Z", "synopsis": "systemctl [OPTIONS...] COMMAND [UNIT...]", "sections": { "NAME": { "content": "systemctl - Control the systemd system and service manager\n", "subsections": [] }, "SYNOPSIS": { "content": "systemctl [OPTIONS...] COMMAND [UNIT...]\n", "subsections": [] }, "DESCRIPTION": { "content": "systemctl may be used to introspect and control the state of the \"systemd\" system and service\nmanager. Please refer to systemd(1) for an introduction into the basic concepts and\nfunctionality this tool manages.\n", "subsections": [] }, "COMMANDS": { "content": "The following commands are understood:\n", "subsections": [ { "name": "Unit Commands (Introspection and Modification)", "content": "list-units [PATTERN...]\nList units that systemd currently has in memory. This includes units that are either\nreferenced directly or through a dependency, units that are pinned by applications\nprogrammatically, or units that were active in the past and have failed. By default only\nunits which are active, have pending jobs, or have failed are shown; this can be changed\nwith option --all. If one or more PATTERNs are specified, only units matching one of them\nare shown. The units that are shown are additionally filtered by --type= and --state= if\nthose options are specified.\n\nNote that this command does not show unit templates, but only instances of unit\ntemplates. Units templates that aren't instantiated are not runnable, and will thus never\nshow up in the output of this command. Specifically this means that foo@.service will\nnever be shown in this list — unless instantiated, e.g. as foo@bar.service. Use\nlist-unit-files (see below) for listing installed unit template files.\n\nProduces output similar to\n\nUNIT LOAD ACTIVE SUB DESCRIPTION\nsys-module-fuse.device loaded active plugged /sys/module/fuse\n-.mount loaded active mounted Root Mount\nboot-efi.mount loaded active mounted /boot/efi\nsystemd-journald.service loaded active running Journal Service\nsystemd-logind.service loaded active running Login Service\n● user@1000.service loaded failed failed User Manager for UID 1000\n...\nsystemd-tmpfiles-clean.timer loaded active waiting Daily Cleanup of Temporary Directories\n\nLOAD = Reflects whether the unit definition was properly loaded.\nACTIVE = The high-level unit activation state, i.e. generalization of SUB.\nSUB = The low-level unit activation state, values depend on unit type.\n\n123 loaded units listed. Pass --all to see loaded but inactive units, too.\nTo show all installed unit files use 'systemctl list-unit-files'.\n\nThe header and the last unit of a given type are underlined if the terminal supports\nthat. A colored dot is shown next to services which were masked, not found, or otherwise\nfailed.\n\nThe LOAD column shows the load state, one of loaded, not-found, bad-setting, error,\nmasked. The ACTIVE columns shows the general unit state, one of active, reloading,\ninactive, failed, activating, deactivating. The SUB column shows the unit-type-specific\ndetailed state of the unit, possible values vary by unit type. The list of possible LOAD,\nACTIVE, and SUB states is not constant and new systemd releases may both add and remove\nvalues.\n\nsystemctl --state=help\n\ncommand may be used to display the current set of possible values.\n\nThis is the default command.\n\nlist-automounts [PATTERN...]\nList automount units currently in memory, ordered by mount path. If one or more PATTERNs\nare specified, only automount units matching one of them are shown. Produces output\nsimilar to\n\nWHAT WHERE MOUNTED IDLE TIMEOUT UNIT\n/dev/sdb1 /mnt/test no 120s mnt-test.automount\nbinfmtmisc /proc/sys/fs/binfmtmisc yes 0 proc-sys-fs-binfmtmisc.automount\n\n2 automounts listed.\n\nAlso see --show-types, --all, and --state=.\n\nAdded in version 252.\n\nlist-paths [PATTERN...]\nList path units currently in memory, ordered by path. If one or more PATTERNs are\nspecified, only path units matching one of them are shown. Produces output similar to\n\nPATH CONDITION UNIT ACTIVATES\n/run/systemd/ask-password DirectoryNotEmpty systemd-ask-password-plymouth.path systemd-ask-password-plymouth.service\n/run/systemd/ask-password DirectoryNotEmpty systemd-ask-password-wall.path systemd-ask-password-wall.service\n/var/cache/cups/org.cups.cupsd PathExists cups.path cups.service\n\n3 paths listed.\n\nAlso see --show-types, --all, and --state=.\n\nAdded in version 254.\n\nlist-sockets [PATTERN...]\nList socket units currently in memory, ordered by listening address. If one or more\nPATTERNs are specified, only socket units matching one of them are shown. Produces output\nsimilar to\n\nLISTEN UNIT ACTIVATES\n/dev/initctl systemd-initctl.socket systemd-initctl.service\n...\n[::]:22 sshd.socket sshd.service\nkobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service\n\n5 sockets listed.\n\nNote: because the addresses might contains spaces, this output is not suitable for\nprogrammatic consumption.\n\nAlso see --show-types, --all, and --state=.\n\nAdded in version 202.\n\nlist-timers [PATTERN...]\nList timer units currently in memory, ordered by the time they elapse next. If one or\nmore PATTERNs are specified, only units matching one of them are shown. Produces output\nsimilar to\n\nNEXT LEFT LAST PASSED UNIT ACTIVATES\n- - Thu 2017-02-23 13:40:29 EST 3 days ago ureadahead-stop.timer ureadahead-stop.service\nSun 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\nSun 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\nSun 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\n\n\nNEXT shows the next time the timer will run.\n\nLEFT shows how long till the next time the timer runs.\n\nLAST shows the last time the timer ran.\n\nPASSED shows how long has passed since the timer last ran.\n\nUNIT shows the name of the timer\n\nACTIVATES shows the name the service the timer activates when it runs.\n\nAlso see --all and --state=.\n\nAdded in version 209.\n\nis-active PATTERN...\nCheck whether any of the specified units are active (i.e. running). Returns an exit code\n0 if at least one is active, or non-zero otherwise. Unless --quiet is specified, this\nwill also print the current unit state to standard output.\n\nis-failed [PATTERN...]\nCheck whether any of the specified units is in the \"failed\" state. If no unit is\nspecified, check whether there are any failed units, which corresponds to the \"degraded\"\nstate returned by is-system-running. Returns an exit code 0 if at least one has failed,\nnon-zero otherwise. Unless --quiet is specified, this will also print the current unit or\nsystem state to standard output.\n\nAdded in version 197.\n\nstatus [PATTERN...|PID...]]\nShow runtime status information about the whole system or about one or more units\nfollowed by most recent log data from the journal. If no positional arguments are\nspecified, and no unit filter is given with --type=, --state=, or --failed, shows the\nstatus of the whole system. If combined with --all, follows that with the status of all\nunits. If positional arguments are specified, each positional argument is treated as\neither a unit name to show, or a glob pattern to show units whose names match that\npattern, or a PID to show the unit containing that PID. When --type=, --state=, or\n--failed are used, units are additionally filtered by the TYPE and ACTIVE state.\n\nThis function is intended to generate human-readable output. If you are looking for\ncomputer-parsable output, use show instead. By default, this function only shows 10 lines\nof output and ellipsizes lines to fit in the terminal window. This can be changed with\n--lines and --full, see above. In addition, journalctl --unit=NAME or journalctl\n--user-unit=NAME use a similar filter for messages and might be more convenient.\n\nNote that this operation only displays runtime status, i.e. information about the current\ninvocation of the unit (if it is running) or the most recent invocation (if it is not\nrunning anymore, and has not been released from memory). Information about earlier\ninvocations, invocations from previous system boots, or prior invocations that have\nalready been released from memory may be retrieved via journalctl --unit=.\n\nsystemd implicitly loads units as necessary, so just running the status will attempt to\nload a file. The command is thus not useful for determining if something was already\nloaded or not. The units may possibly also be quickly unloaded after the operation is\ncompleted if there's no reason to keep it in memory thereafter.\n\nExample 1. Example output from systemctl status\n\n$ systemctl status bluetooth\n● bluetooth.service - Bluetooth service\nLoaded: loaded (/usr/lib/systemd/system/bluetooth.service; enabled; preset: enabled)\nActive: active (running) since Wed 2017-01-04 13:54:04 EST; 1 weeks 0 days ago\nDocs: man:bluetoothd(8)\nMain PID: 930 (bluetoothd)\nStatus: \"Running\"\nTasks: 1\nMemory: 648.0K\nCPU: 435ms\nCGroup: /system.slice/bluetooth.service\n└─930 /usr/lib/bluetooth/bluetoothd\n\nJan 12 10:46:45 example.com bluetoothd[8900]: Not enough free handles to register service\nJan 12 10:46:45 example.com bluetoothd[8900]: Current Time Service could not be registered\nJan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output error (5)\n\nThe dot (\"●\") uses color on supported terminals to summarize the unit state at a glance.\nAlong with its color, its shape varies according to its state: \"inactive\" or\n\"maintenance\" is a white circle (\"○\"), \"active\" is a green dot (\"●\"), \"deactivating\" is a\nwhite dot, \"failed\" or \"error\" is a red cross (\"×\"), and \"reloading\" is a green clockwise\ncircle arrow (\"↻\").\n\nThe \"Loaded:\" line in the output will show \"loaded\" if the unit has been loaded into\nmemory. Other possible values for \"Loaded:\" include: \"error\" if there was a problem\nloading it, \"not-found\" if no unit file was found for this unit, \"bad-setting\" if an\nessential unit file setting could not be parsed and \"masked\" if the unit file has been\nmasked. Along with showing the path to the unit file, this line will also show the\nenablement state. Enabled units are included in the dependency network between units, and\nthus are started at boot or via some other form of activation. See the full table of\npossible enablement states — including the definition of \"masked\" — in the documentation\nfor the is-enabled command.\n\nThe \"Active:\" line shows active state. The value is usually \"active\" or \"inactive\".\nActive could mean started, bound, plugged in, etc depending on the unit type. The unit\ncould also be in process of changing states, reporting a state of \"activating\" or\n\"deactivating\". A special \"failed\" state is entered when the service failed in some way,\nsuch as a crash, exiting with an error code or timing out. If the failed state is entered\nthe cause will be logged for later reference.\n\nshow [PATTERN...|JOB...]\nShow properties of one or more units, jobs, or the manager itself. If no argument is\nspecified, properties of the manager will be shown. If a unit name is specified,\nproperties of the unit are shown, and if a job ID is specified, properties of the job are\nshown. By default, empty properties are suppressed. Use --all to show those too. To\nselect specific properties to show, use --property=. This command is intended to be used\nwhenever computer-parsable output is required. Use status if you are looking for\nformatted human-readable output.\n\nMany properties shown by systemctl show map directly to configuration settings of the\nsystem and service manager and its unit files. Note that the properties shown by the\ncommand are generally more low-level, normalized versions of the original configuration\nsettings and expose runtime state in addition to configuration. For example, properties\nshown for service units include the service's current main process identifier as\n\"MainPID\" (which is runtime state), and time settings are always exposed as properties\nending in the \"...USec\" suffix even if a matching configuration options end in \"...Sec\",\nbecause microseconds is the normalized time unit used internally by the system and\nservice manager.\n\nFor details about many of these properties, see the documentation of the D-Bus interface\nbacking these properties, see org.freedesktop.systemd1(5).\n\ncat PATTERN...\nShow backing files of one or more units. Prints the \"fragment\" and \"drop-ins\" (source\nfiles) of units. Each file is preceded by a comment which includes the file name. Note\nthat this shows the contents of the backing files on disk, which may not match the system\nmanager's understanding of these units if any unit files were updated on disk and the\ndaemon-reload command wasn't issued since.\n\nAdded in version 209.\n\nhelp PATTERN...|PID...\nShow manual pages for one or more units, if available. If a PID is given, the manual\npages for the unit the process belongs to are shown.\n\nAdded in version 185.\n\nlist-dependencies [UNIT...]\nShows units required and wanted by the specified units. This recursively lists units\nfollowing the Requires=, Requisite=, Wants=, ConsistsOf=, BindsTo=, and Upholds=\ndependencies. If no units are specified, default.target is implied.\n\nThe units that are shown are additionally filtered by --type= and --state= if those\noptions are specified. Note that we won't be able to use a tree structure in this case,\nso --plain is implied.\n\nBy default, only target units are recursively expanded. When --all is passed, all other\nunits are recursively expanded as well.\n\nOptions --reverse, --after, --before may be used to change what types of dependencies are\nshown.\n\nNote that this command only lists units currently loaded into memory by the service\nmanager. In particular, this command is not suitable to get a comprehensive list at all\nreverse dependencies on a specific unit, as it won't list the dependencies declared by\nunits currently not loaded.\n\nAdded in version 198.\n\nstart PATTERN...\nStart (activate) one or more units specified on the command line.\n\nNote that unit glob patterns expand to names of units currently in memory. Units which\nare not active and are not in a failed state usually are not in memory, and will not be\nmatched by any pattern. In addition, in case of instantiated units, systemd is often\nunaware of the instance name until the instance has been started. Therefore, using glob\npatterns with start has limited usefulness. Also, secondary alias names of units are not\nconsidered.\n\nOption --all may be used to also operate on inactive units which are referenced by other\nloaded units. Note that this is not the same as operating on \"all\" possible units,\nbecause as the previous paragraph describes, such a list is ill-defined. Nevertheless,\nsystemctl start --all GLOB may be useful if all the units that should match the pattern\nare pulled in by some target which is known to be loaded.\n\nstop PATTERN...\nStop (deactivate) one or more units specified on the command line.\n\nThis command will fail if the unit does not exist or if stopping of the unit is\nprohibited (see RefuseManualStop= in systemd.unit(5)). It will not fail if any of the\ncommands configured to stop the unit (ExecStop=, etc.) fail, because the manager will\nstill forcibly terminate the unit.\n\nIf a unit that gets stopped can still be triggered by other units, a warning containing\nthe names of the triggering units is shown. --no-warn can be used to suppress the\nwarning.\n\nreload PATTERN...\nAsks all units listed on the command line to reload their configuration. Note that this\nwill reload the service-specific configuration, not the unit configuration file of\nsystemd. If you want systemd to reload the configuration file of a unit, use the\ndaemon-reload command. In other words: for the example case of Apache, this will reload\nApache's httpd.conf in the web server, not the apache.service systemd unit file.\n\nThis command should not be confused with the daemon-reload command.\n\nrestart PATTERN...\nStop and then start one or more units specified on the command line. If the units are not\nrunning yet, they will be started.\n\nNote that restarting a unit with this command does not necessarily flush out all of the\nunit's resources before it is started again. For example, the per-service file descriptor\nstorage facility (see FileDescriptorStoreMax= in systemd.service(5)) will remain intact\nas long as the unit has a job pending, and is only cleared when the unit is fully stopped\nand no jobs are pending anymore. If it is intended that the file descriptor store is\nflushed out, too, during a restart operation an explicit systemctl stop command followed\nby systemctl start should be issued.\n\ntry-restart PATTERN...\nStop and then start one or more units specified on the command line if the units are\nrunning. This does nothing if units are not running.\n\nreload-or-restart PATTERN...\nReload one or more units if they support it. If not, stop and then start them instead. If\nthe units are not running yet, they will be started.\n\ntry-reload-or-restart PATTERN...\nReload one or more units if they support it. If not, stop and then start them instead.\nThis does nothing if the units are not running.\n\nAdded in version 229.\n\nisolate UNIT\nStart the unit specified on the command line and its dependencies and stop all others,\nunless they have IgnoreOnIsolate=yes (see systemd.unit(5)). If a unit name with no\nextension is given, an extension of \".target\" will be assumed.\n\nThis command is dangerous, since it will immediately stop processes that are not enabled\nin the new target, possibly including the graphical environment or terminal you are\ncurrently using.\n\nNote that this operation is allowed only on units where AllowIsolate= is enabled. See\nsystemd.unit(5) for details.\n\nkill PATTERN...\nSend a UNIX process signal to one or more processes of the unit. Use --kill-whom= to\nselect which process to send the signal to. Use --signal= to select the signal to send.\nCombine with --kill-value= to enqueue a POSIX Realtime Signal with an associated value.\n\nclean PATTERN...\nRemove the configuration, state, cache, logs or runtime data of the specified units. Use\n--what= to select which kind of resource to remove. For service units this may be used to\nremove the directories configured with ConfigurationDirectory=, StateDirectory=,\nCacheDirectory=, LogsDirectory= and RuntimeDirectory=, see systemd.exec(5) for details.\nIt may also be used to clear the file descriptor store as enabled via\nFileDescriptorStoreMax=, see systemd.service(5) for details. For timer units this may be\nused to clear out the persistent timestamp data if Persistent= is used and --what=state\nis selected, see systemd.timer(5). This command only applies to units that use either of\nthese settings. If --what= is not specified, the cache and runtime data as well as the\nfile descriptor store are removed (as these three types of resources are generally\nredundant and reproducible on the next invocation of the unit). Note that the specified\nunits must be stopped to invoke this operation.\n\nAdded in version 243.\n\nfreeze PATTERN...\nFreeze one or more units specified on the command line using cgroup freezer\n\nFreezing the unit will cause all processes contained within the cgroup corresponding to\nthe unit to be suspended. Being suspended means that unit's processes won't be scheduled\nto run on CPU until thawed. Note that this command is supported only on systems that use\nunified cgroup hierarchy. Unit is automatically thawed just before we execute a job\nagainst the unit, e.g. before the unit is stopped.\n\nAdded in version 246.\n\nthaw PATTERN...\nThaw (unfreeze) one or more units specified on the command line.\n\nThis is the inverse operation to the freeze command and resumes the execution of\nprocesses in the unit's cgroup.\n\nAdded in version 246.\n\nset-property UNIT PROPERTY=VALUE...\nSet the specified unit properties at runtime where this is supported. This allows\nchanging configuration parameter properties such as resource control settings at runtime.\nNot all properties may be changed at runtime, but many resource control settings\n(primarily those in systemd.resource-control(5)) may. The changes are applied\nimmediately, and stored on disk for future boots, unless --runtime is passed, in which\ncase the settings only apply until the next reboot. The syntax of the property assignment\nfollows closely the syntax of assignments in unit files.\n\nExample: systemctl set-property foobar.service CPUWeight=200\n\nIf the specified unit appears to be inactive, the changes will be only stored on disk as\ndescribed previously hence they will be effective when the unit will be started.\n\nNote that this command allows changing multiple properties at the same time, which is\npreferable over setting them individually.\n\nExample: systemctl set-property foobar.service CPUWeight=200 MemoryMax=2G\nIPAccounting=yes\n\nLike with unit file configuration settings, assigning an empty setting usually resets a\nproperty to its defaults.\n\nExample: systemctl set-property avahi-daemon.service IPAddressDeny=\n\nAdded in version 206.\n\nbind UNIT PATH [PATH]\nBind-mounts a file or directory from the host into the specified unit's mount namespace.\nThe first path argument is the source file or directory on the host, the second path\nargument is the destination file or directory in the unit's mount namespace. When the\nlatter is omitted, the destination path in the unit's mount namespace is the same as the\nsource path on the host. When combined with the --read-only switch, a ready-only bind\nmount is created. When combined with the --mkdir switch, the destination path is first\ncreated before the mount is applied.\n\nNote that this option is currently only supported for units that run within a mount\nnamespace (e.g.: with RootImage=, PrivateMounts=, etc.). This command supports\nbind-mounting directories, regular files, device nodes, AFUNIX socket nodes, as well as\nFIFOs. The bind mount is ephemeral, and it is undone as soon as the current unit process\nexists. Note that the namespace mentioned here, where the bind mount will be added to, is\nthe one where the main service process runs. Other processes (those exececuted by\nExecReload=, ExecStartPre=, etc.) run in distinct namespaces.\n\nIf supported by the kernel, any prior mount on the selected target will be replaced by\nthe new mount. If not supported, any prior mount will be over-mounted, but remain pinned\nand inaccessible.\n\nAdded in version 248.\n\nmount-image UNIT IMAGE [PATH [PARTITIONNAME:MOUNTOPTIONS]]\nMounts an image from the host into the specified unit's mount namespace. The first path\nargument is the source image on the host, the second path argument is the destination\ndirectory in the unit's mount namespace (i.e. inside RootImage=/RootDirectory=). The\nfollowing argument, if any, is interpreted as a colon-separated tuple of partition name\nand comma-separated list of mount options for that partition. The format is the same as\nthe service MountImages= setting. When combined with the --read-only switch, a ready-only\nmount is created. When combined with the --mkdir switch, the destination path is first\ncreated before the mount is applied.\n\nNote that this option is currently only supported for units that run within a mount\nnamespace (i.e. with RootImage=, PrivateMounts=, etc.). Note that the namespace mentioned\nhere where the image mount will be added to, is the one where the main service process\nruns. Note that the namespace mentioned here, where the bind mount will be added to, is\nthe one where the main service process runs. Other processes (those exececuted by\nExecReload=, ExecStartPre=, etc.) run in distinct namespaces.\n\nIf supported by the kernel, any prior mount on the selected target will be replaced by\nthe new mount. If not supported, any prior mount will be over-mounted, but remain pinned\nand inaccessible.\n\nExample:\n\nsystemctl mount-image foo.service /tmp/img.raw /var/lib/image root:ro,nosuid\n\n\n\nsystemctl mount-image --mkdir bar.service /tmp/img.raw /var/lib/baz/img\n\nAdded in version 248.\n\nservice-log-level SERVICE [LEVEL]\nIf the LEVEL argument is not given, print the current log level as reported by service\nSERVICE.\n\nIf the optional argument LEVEL is provided, then change the current log level of the\nservice to LEVEL. The log level should be a typical syslog log level, i.e. a value in the\nrange 0...7 or one of the strings emerg, alert, crit, err, warning, notice, info, debug;\nsee syslog(3) for details.\n\nThe service must have the appropriate BusName=destination property and also implement the\ngeneric org.freedesktop.LogControl1(5) interface. (systemctl will use the generic D-Bus\nprotocol to access the org.freedesktop.LogControl1.LogLevel interface for the D-Bus name\ndestination.)\n\nAdded in version 247.\n\nservice-log-target SERVICE [TARGET]\nIf the TARGET argument is not given, print the current log target as reported by service\nSERVICE.\n\nIf the optional argument TARGET is provided, then change the current log target of the\nservice to TARGET. The log target should be one of the strings console (for log output to\nthe service's standard error stream), kmsg (for log output to the kernel log buffer),\njournal (for log output to systemd-journald.service(8) using the native journal\nprotocol), syslog (for log output to the classic syslog socket /dev/log), null (for no\nlog output whatsoever) or auto (for an automatically determined choice, typically\nequivalent to console if the service is invoked interactively, and journal or syslog\notherwise).\n\nFor most services, only a small subset of log targets make sense. In particular, most\n\"normal\" services should only implement console, journal, and null. Anything else is only\nappropriate for low-level services that are active in very early boot before proper\nlogging is established.\n\nThe service must have the appropriate BusName=destination property and also implement the\ngeneric org.freedesktop.LogControl1(5) interface. (systemctl will use the generic D-Bus\nprotocol to access the org.freedesktop.LogControl1.LogLevel interface for the D-Bus name\ndestination.)\n\nAdded in version 247.\n\nreset-failed [PATTERN...]\nReset the \"failed\" state of the specified units, or if no unit name is passed, reset the\nstate of all units. When a unit fails in some way (i.e. process exiting with non-zero\nerror code, terminating abnormally or timing out), it will automatically enter the\n\"failed\" state and its exit code and status is recorded for introspection by the\nadministrator until the service is stopped/re-started or reset with this command.\n\nIn addition to resetting the \"failed\" state of a unit it also resets various other\nper-unit properties: the start rate limit counter of all unit types is reset to zero, as\nis the restart counter of service units. Thus, if a unit's start limit (as configured\nwith StartLimitIntervalSec=/StartLimitBurst=) is hit and the unit refuses to be started\nagain, use this command to make it startable again.\n\nwhoami [PID...]\nReturns the units the processes referenced by the given PIDs belong to (one per line). If\nno PID is specified returns the unit the systemctl command is invoked in.\n\nAdded in version 254.\n" }, { "name": "Unit File Commands", "content": "list-unit-files [PATTERN...]\nList unit files installed on the system, in combination with their enablement state (as\nreported by is-enabled). If one or more PATTERNs are specified, only unit files whose\nname matches one of them are shown (patterns matching unit file system paths are not\nsupported).\n\nUnlike list-units this command will list template units in addition to explicitly\ninstantiated units.\n\nAdded in version 233.\n\nenable UNIT..., enable PATH...\nEnable one or more units or unit instances. This will create a set of symlinks, as\nencoded in the [Install] sections of the indicated unit files. After the symlinks have\nbeen created, the system manager configuration is reloaded (in a way equivalent to\ndaemon-reload), in order to ensure the changes are taken into account immediately. Note\nthat this does not have the effect of also starting any of the units being enabled. If\nthis is desired, combine this command with the --now switch, or invoke start with\nappropriate arguments later. Note that in case of unit instance enablement (i.e.\nenablement of units of the form foo@bar.service), symlinks named the same as instances\nare created in the unit configuration directory, however they point to the single\ntemplate unit file they are instantiated from.\n\nThis command expects either valid unit names (in which case various unit file directories\nare automatically searched for unit files with appropriate names), or absolute paths to\nunit files (in which case these files are read directly). If a specified unit file is\nlocated outside of the usual unit file directories, an additional symlink is created,\nlinking it into the unit configuration path, thus ensuring it is found when requested by\ncommands such as start. The file system where the linked unit files are located must be\naccessible when systemd is started (e.g. anything underneath /home/ or /var/ is not\nallowed, unless those directories are located on the root file system).\n\nThis command will print the file system operations executed. This output may be\nsuppressed by passing --quiet.\n\nNote that this operation creates only the symlinks suggested in the [Install] section of\nthe unit files. While this command is the recommended way to manipulate the unit\nconfiguration directory, the administrator is free to make additional changes manually by\nplacing or removing symlinks below this directory. This is particularly useful to create\nconfigurations that deviate from the suggested default installation. In this case, the\nadministrator must make sure to invoke daemon-reload manually as necessary, in order to\nensure the changes are taken into account.\n\nWhen using this operation on units without install information, a warning about it is\nshown. --no-warn can be used to suppress the warning.\n\nEnabling units should not be confused with starting (activating) units, as done by the\nstart command. Enabling and starting units is orthogonal: units may be enabled without\nbeing started and started without being enabled. Enabling simply hooks the unit into\nvarious suggested places (for example, so that the unit is automatically started on boot\nor when a particular kind of hardware is plugged in). Starting actually spawns the daemon\nprocess (in case of service units), or binds the socket (in case of socket units), and so\non.\n\nDepending on whether --system, --user, --runtime, or --global is specified, this enables\nthe unit for the system, for the calling user only, for only this boot of the system, or\nfor all future logins of all users. Note that in the last case, no systemd daemon\nconfiguration is reloaded.\n\nUsing enable on masked units is not supported and results in an error.\n\ndisable UNIT...\nDisables one or more units. This removes all symlinks to the unit files backing the\nspecified units from the unit configuration directory, and hence undoes any changes made\nby enable or link. Note that this removes all symlinks to matching unit files, including\nmanually created symlinks, and not just those actually created by enable or link. Note\nthat while disable undoes the effect of enable, the two commands are otherwise not\nsymmetric, as disable may remove more symlinks than a prior enable invocation of the same\nunit created.\n\nThis command expects valid unit names only, it does not accept paths to unit files.\n\nIn addition to the units specified as arguments, all units are disabled that are listed\nin the Also= setting contained in the [Install] section of any of the unit files being\noperated on.\n\nThis command implicitly reloads the system manager configuration after completing the\noperation. Note that this command does not implicitly stop the units that are being\ndisabled. If this is desired, either combine this command with the --now switch, or\ninvoke the stop command with appropriate arguments later.\n\nThis command will print information about the file system operations (symlink removals)\nexecuted. This output may be suppressed by passing --quiet.\n\nIf a unit gets disabled but its triggering units are still active, a warning containing\nthe names of the triggering units is shown. --no-warn can be used to suppress the\nwarning.\n\nWhen this command is used with --user, the units being operated on might still be enabled\nin global scope, and thus get started automatically even after a successful disablement\nin user scope. In this case, a warning about it is shown, which can be suppressed using\n--no-warn.\n\nThis command honors --system, --user, --runtime, --global and --no-warn in a similar way\nas enable.\n\nAdded in version 238.\n\nreenable UNIT...\nReenable one or more units, as specified on the command line. This is a combination of\ndisable and enable and is useful to reset the symlinks a unit file is enabled with to the\ndefaults configured in its [Install] section. This command expects a unit name only, it\ndoes not accept paths to unit files.\n\nAdded in version 238.\n\npreset UNIT...\nReset the enable/disable status one or more unit files, as specified on the command line,\nto the defaults configured in the preset policy files. This has the same effect as\ndisable or enable, depending how the unit is listed in the preset files.\n\nUse --preset-mode= to control whether units shall be enabled and disabled, or only\nenabled, or only disabled.\n\nIf the unit carries no install information, it will be silently ignored by this command.\nUNIT must be the real unit name, any alias names are ignored silently.\n\nFor more information on the preset policy format, see systemd.preset(5).\n\nAdded in version 238.\n" }, { "name": "preset-all", "content": "Resets all installed unit files to the defaults configured in the preset policy file (see\nabove).\n\nUse --preset-mode= to control whether units shall be enabled and disabled, or only\nenabled, or only disabled.\n\nAdded in version 215.\n\nis-enabled UNIT...\nChecks whether any of the specified unit files are enabled (as with enable). Returns an\nexit code of 0 if at least one is enabled, non-zero otherwise. Prints the current enable\nstatus (see table). To suppress this output, use --quiet. To show installation targets,\nuse --full.\n\nTable 1. is-enabled output\n┌───────────────────┬───────────────────────────┬───────────┐\n│ Name │ Description │ Exit Code │\n├───────────────────┼───────────────────────────┼───────────┤\n│ \"enabled\" │ Enabled via .wants/, │ │\n├───────────────────┤ .requires/ or Alias= │ │\n│ \"enabled-runtime\" │ symlinks (permanently in │ 0 │\n│ │ /etc/systemd/system/, or │ │\n│ │ transiently in │ │\n│ │ /run/systemd/system/). │ │\n├───────────────────┼───────────────────────────┼───────────┤\n│ \"linked\" │ Made available through │ │\n├───────────────────┤ one or more symlinks to │ │\n│ \"linked-runtime\" │ the unit file │ │\n│ │ (permanently in │ │\n│ │ /etc/systemd/system/ or │ │\n│ │ transiently in │ > 0 │\n│ │ /run/systemd/system/), │ │\n│ │ even though the unit file │ │\n│ │ might reside outside of │ │\n│ │ the unit file search │ │\n│ │ path. │ │\n├───────────────────┼───────────────────────────┼───────────┤\n│ \"alias\" │ The name is an alias │ 0 │\n│ │ (symlink to another unit │ │\n│ │ file). │ │\n├───────────────────┼───────────────────────────┼───────────┤\n│ \"masked\" │ Completely disabled, so │ │\n├───────────────────┤ that any start operation │ │\n│ \"masked-runtime\" │ on it fails (permanently │ > 0 │\n│ │ in /etc/systemd/system/ │ │\n│ │ or transiently in │ │\n│ │ /run/systemd/systemd/). │ │\n├───────────────────┼───────────────────────────┼───────────┤\n│ \"static\" │ The unit file is not │ 0 │\n│ │ enabled, and has no │ │\n│ │ provisions for enabling │ │\n│ │ in the [Install] unit │ │\n│ │ file section. │ │\n├───────────────────┼───────────────────────────┼───────────┤\n│ \"indirect\" │ The unit file itself is │ 0 │\n│ │ not enabled, but it has a │ │\n│ │ non-empty Also= setting │ │\n│ │ in the [Install] unit │ │\n│ │ file section, listing │ │\n│ │ other unit files that │ │\n│ │ might be enabled, or it │ │\n│ │ has an alias under a │ │\n│ │ different name through a │ │\n│ │ symlink that is not │ │\n│ │ specified in Also=. For │ │\n│ │ template unit files, an │ │\n│ │ instance different than │ │\n│ │ the one specified in │ │\n│ │ DefaultInstance= is │ │\n│ │ enabled. │ │\n├───────────────────┼───────────────────────────┼───────────┤\n│ \"disabled\" │ The unit file is not │ > 0 │\n│ │ enabled, but contains an │ │\n│ │ [Install] section with │ │\n│ │ installation │ │\n│ │ instructions. │ │\n├───────────────────┼───────────────────────────┼───────────┤\n│ \"generated\" │ The unit file was │ 0 │\n│ │ generated dynamically via │ │\n│ │ a generator tool. See │ │\n│ │ systemd.generator(7). │ │\n│ │ Generated unit files may │ │\n│ │ not be enabled, they are │ │\n│ │ enabled implicitly by │ │\n│ │ their generator. │ │\n├───────────────────┼───────────────────────────┼───────────┤\n│ \"transient\" │ The unit file has been │ 0 │\n│ │ created dynamically with │ │\n│ │ the runtime API. │ │\n│ │ Transient units may not │ │\n│ │ be enabled. │ │\n├───────────────────┼───────────────────────────┼───────────┤\n│ \"bad\" │ The unit file is invalid │ > 0 │\n│ │ or another error │ │\n│ │ occurred. Note that │ │\n│ │ is-enabled will not │ │\n│ │ actually return this │ │\n│ │ state, but print an error │ │\n│ │ message instead. However │ │\n│ │ the unit file listing │ │\n│ │ printed by │ │\n│ │ list-unit-files might │ │\n│ │ show it. │ │\n├───────────────────┼───────────────────────────┼───────────┤\n│ \"not-found\" │ The unit file doesn't │ 4 │\n│ │ exist. │ │\n└───────────────────┴───────────────────────────┴───────────┘\n\nAdded in version 238.\n\nmask UNIT...\nMask one or more units, as specified on the command line. This will link these unit files\nto /dev/null, making it impossible to start them. This is a stronger version of disable,\nsince it prohibits all kinds of activation of the unit, including enablement and manual\nactivation. Use this option with care. This honors the --runtime option to only mask\ntemporarily until the next reboot of the system. The --now option may be used to ensure\nthat the units are also stopped. This command expects valid unit names only, it does not\naccept unit file paths.\n\nNote that this will create a symlink under the unit's name in /etc/systemd/system/ (in\ncase --runtime is not specified) or /run/systemd/system/ (in case --runtime is\nspecified). If a matching unit file already exists under these directories this operation\nwill hence fail. This means that the operation is primarily useful to mask units shipped\nby the vendor (as those are shipped in /usr/lib/systemd/system/ and not the\naforementioned two directories), but typically doesn't work for units created locally (as\nthose are typically placed precisely in the two aforementioned directories). Similar\nrestrictions apply for --user mode, in which case the directories are below the user's\nhome directory however.\n\nIf a unit gets masked but its triggering units are still active, a warning containing the\nnames of the triggering units is shown. --no-warn can be used to suppress the warning.\n\nAdded in version 238.\n\nunmask UNIT...\nUnmask one or more unit files, as specified on the command line. This will undo the\neffect of mask. This command expects valid unit names only, it does not accept unit file\npaths.\n\nAdded in version 238.\n\nlink PATH...\nLink a unit file that is not in the unit file search path into the unit file search path.\nThis command expects an absolute path to a unit file. The effect of this may be undone\nwith disable. The effect of this command is that a unit file is made available for\ncommands such as start, even though it is not installed directly in the unit search path.\nThe file system where the linked unit files are located must be accessible when systemd\nis started (e.g. anything underneath /home/ or /var/ is not allowed, unless those\ndirectories are located on the root file system).\n\nAdded in version 233.\n\nrevert UNIT...\nRevert one or more unit files to their vendor versions. This command removes drop-in\nconfiguration files that modify the specified units, as well as any user-configured unit\nfile that overrides a matching vendor supplied unit file. Specifically, for a unit\n\"foo.service\" the matching directories \"foo.service.d/\" with all their contained files\nare removed, both below the persistent and runtime configuration directories (i.e. below\n/etc/systemd/system and /run/systemd/system); if the unit file has a vendor-supplied\nversion (i.e. a unit file located below /usr/) any matching persistent or runtime unit\nfile that overrides it is removed, too. Note that if a unit file has no vendor-supplied\nversion (i.e. is only defined below /etc/systemd/system or /run/systemd/system, but not\nin a unit file stored below /usr/), then it is not removed. Also, if a unit is masked, it\nis unmasked.\n\nEffectively, this command may be used to undo all changes made with systemctl edit,\nsystemctl set-property and systemctl mask and puts the original unit file with its\nsettings back in effect.\n\nAdded in version 230.\n\nadd-wants TARGET UNIT..., add-requires TARGET UNIT...\nAdds \"Wants=\" or \"Requires=\" dependencies, respectively, to the specified TARGET for one\nor more units.\n\nThis command honors --system, --user, --runtime and --global in a way similar to enable.\n\nAdded in version 217.\n\nedit UNIT...\nEdit a drop-in snippet or a whole replacement file if --full is specified, to extend or\noverride the specified unit.\n\nDepending on whether --system (the default), --user, or --global is specified, this\ncommand creates a drop-in file for each unit either for the system, for the calling user,\nor for all futures logins of all users. Then, the editor (see the \"Environment\" section\nbelow) is invoked on temporary files which will be written to the real location if the\neditor exits successfully.\n\nIf --drop-in= is specified, the given drop-in file name will be used instead of the\ndefault override.conf.\n\nIf --full is specified, this will copy the original units instead of creating drop-in\nfiles.\n\nIf --force is specified and any units do not already exist, new unit files will be opened\nfor editing.\n\nIf --runtime is specified, the changes will be made temporarily in /run/ and they will be\nlost on the next reboot.\n\nIf the temporary file is empty upon exit, the modification of the related unit is\ncanceled.\n\nAfter the units have been edited, systemd configuration is reloaded (in a way that is\nequivalent to daemon-reload).\n\nNote that this command cannot be used to remotely edit units and that you cannot\ntemporarily edit units which are in /etc/, since they take precedence over /run/.\n\nAdded in version 218.\n" }, { "name": "get-default", "content": "Return the default target to boot into. This returns the target unit name default.target\nis aliased (symlinked) to.\n\nAdded in version 205.\n\nset-default TARGET\nSet the default target to boot into. This sets (symlinks) the default.target alias to the\ngiven target unit.\n\nAdded in version 205.\n" }, { "name": "Machine Commands", "content": "list-machines [PATTERN...]\nList the host and all running local containers with their state. If one or more PATTERNs\nare specified, only containers matching one of them are shown.\n\nAdded in version 212.\n" }, { "name": "Job Commands", "content": "list-jobs [PATTERN...]\nList jobs that are in progress. If one or more PATTERNs are specified, only jobs for\nunits matching one of them are shown.\n\nWhen combined with --after or --before the list is augmented with information on which\nother job each job is waiting for, and which other jobs are waiting for it, see above.\n\nAdded in version 233.\n\ncancel [JOB...]\nCancel one or more jobs specified on the command line by their numeric job IDs. If no job\nID is specified, cancel all pending jobs.\n\nAdded in version 233.\n" }, { "name": "Environment Commands", "content": "systemd supports an environment block that is passed to processes the manager spawns. The\nnames of the variables can contain ASCII letters, digits, and the underscore character.\nVariable names cannot be empty or start with a digit. In variable values, most characters are\nallowed, but the whole sequence must be valid UTF-8. (Note that control characters like\nnewline (NL), tab (TAB), or the escape character (ESC), are valid ASCII and thus valid\nUTF-8). The total length of the environment block is limited to SCARGMAX value defined by\nsysconf(3).\n" }, { "name": "show-environment", "content": "Dump the systemd manager environment block. This is the environment block that is passed\nto all processes the manager spawns. The environment block will be dumped in\nstraightforward form suitable for sourcing into most shells. If no special characters or\nwhitespace is present in the variable values, no escaping is performed, and the\nassignments have the form \"VARIABLE=value\". If whitespace or characters which have\nspecial meaning to the shell are present, dollar-single-quote escaping is used, and\nassignments have the form \"VARIABLE=$'value'\". This syntax is known to be supported by\nbash(1), zsh(1), ksh(1), and busybox(1)'s ash(1), but not dash(1) or fish(1).\n\nset-environment VARIABLE=VALUE...\nSet one or more systemd manager environment variables, as specified on the command line.\nThis command will fail if variable names and values do not conform to the rules listed\nabove.\n\nAdded in version 233.\n\nunset-environment VARIABLE...\nUnset one or more systemd manager environment variables. If only a variable name is\nspecified, it will be removed regardless of its value. If a variable and a value are\nspecified, the variable is only removed if it has the specified value.\n\nAdded in version 233.\n\nimport-environment VARIABLE...\nImport all, one or more environment variables set on the client into the systemd manager\nenvironment block. If a list of environment variable names is passed, client-side values\nare then imported into the manager's environment block. If any names are not valid\nenvironment variable names or have invalid values according to the rules described above,\nan error is raised. If no arguments are passed, the entire environment block inherited by\nthe systemctl process is imported. In this mode, any inherited invalid environment\nvariables are quietly ignored.\n\nImporting of the full inherited environment block (calling this command without any\narguments) is deprecated. A shell will set dozens of variables which only make sense\nlocally and are only meant for processes which are descendants of the shell. Such\nvariables in the global environment block are confusing to other processes.\n\nAdded in version 209.\n" }, { "name": "Manager State Commands", "content": "" }, { "name": "daemon-reload", "content": "Reload the systemd manager configuration. This will rerun all generators (see\nsystemd.generator(7)), reload all unit files, and recreate the entire dependency tree.\nWhile the daemon is being reloaded, all sockets systemd listens on behalf of user\nconfiguration will stay accessible.\n\nThis command should not be confused with the reload command.\n" }, { "name": "daemon-reexec", "content": "Reexecute the systemd manager. This will serialize the manager state, reexecute the\nprocess and deserialize the state again. This command is of little use except for\ndebugging and package upgrades. Sometimes, it might be helpful as a heavy-weight\ndaemon-reload. While the daemon is being reexecuted, all sockets systemd listening on\nbehalf of user configuration will stay accessible.\n\nlog-level [LEVEL]\nIf no argument is given, print the current log level of the manager. If an optional\nargument LEVEL is provided, then the command changes the current log level of the manager\nto LEVEL (accepts the same values as --log-level= described in systemd(1)).\n\nAdded in version 244.\n\nlog-target [TARGET]\nIf no argument is given, print the current log target of the manager. If an optional\nargument TARGET is provided, then the command changes the current log target of the\nmanager to TARGET (accepts the same values as --log-target=, described in systemd(1)).\n\nAdded in version 244.\n\nservice-watchdogs [yes|no]\nIf no argument is given, print the current state of service runtime watchdogs of the\nmanager. If an optional boolean argument is provided, then globally enables or disables\nthe service runtime watchdogs (WatchdogSec=) and emergency actions (e.g. OnFailure= or\nStartLimitAction=); see systemd.service(5). The hardware watchdog is not affected by this\nsetting.\n\nAdded in version 244.\n" }, { "name": "System Commands", "content": "" }, { "name": "is-system-running", "content": "Checks whether the system is operational. This returns success (exit code 0) when the\nsystem is fully up and running, specifically not in startup, shutdown or maintenance\nmode, and with no failed services. Failure is returned otherwise (exit code non-zero). In\naddition, the current state is printed in a short string to standard output, see the\ntable below. Use --quiet to suppress this output.\n\nUse --wait to wait until the boot process is completed before printing the current state\nand returning the appropriate error status. If --wait is in use, states initializing or\nstarting will not be reported, instead the command will block until a later state (such\nas running or degraded) is reached.\n\nTable 2. is-system-running output\n┌──────────────┬───────────────────────────┬───────────┐\n│ Name │ Description │ Exit Code │\n├──────────────┼───────────────────────────┼───────────┤\n│ initializing │ Early bootup, before │ > 0 │\n│ │ basic.target is reached │ │\n│ │ or the maintenance state │ │\n│ │ entered. │ │\n├──────────────┼───────────────────────────┼───────────┤\n│ starting │ Late bootup, before the │ > 0 │\n│ │ job queue becomes idle │ │\n│ │ for the first time, or │ │\n│ │ one of the rescue targets │ │\n│ │ are reached. │ │\n├──────────────┼───────────────────────────┼───────────┤\n│ running │ The system is fully │ 0 │\n│ │ operational. │ │\n├──────────────┼───────────────────────────┼───────────┤\n│ degraded │ The system is operational │ > 0 │\n│ │ but one or more units │ │\n│ │ failed. │ │\n├──────────────┼───────────────────────────┼───────────┤\n│ maintenance │ The rescue or emergency │ > 0 │\n│ │ target is active. │ │\n├──────────────┼───────────────────────────┼───────────┤\n│ stopping │ The manager is shutting │ > 0 │\n│ │ down. │ │\n├──────────────┼───────────────────────────┼───────────┤\n│ offline │ The manager is not │ > 0 │\n│ │ running. Specifically, │ │\n│ │ this is the operational │ │\n│ │ state if an incompatible │ │\n│ │ program is running as │ │\n│ │ system manager (PID 1). │ │\n├──────────────┼───────────────────────────┼───────────┤\n│ unknown │ The operational state │ > 0 │\n│ │ could not be determined, │ │\n│ │ due to lack of resources │ │\n│ │ or another error cause. │ │\n└──────────────┴───────────────────────────┴───────────┘\n\nAdded in version 215.\n" }, { "name": "default", "content": "Enter default mode. This is equivalent to systemctl isolate default.target. This\noperation is blocking by default, use --no-block to request asynchronous behavior.\n" }, { "name": "rescue", "content": "Enter rescue mode. This is equivalent to systemctl isolate rescue.target. This operation\nis blocking by default, use --no-block to request asynchronous behavior.\n" }, { "name": "emergency", "content": "Enter emergency mode. This is equivalent to systemctl isolate emergency.target. This\noperation is blocking by default, use --no-block to request asynchronous behavior.\n" }, { "name": "halt", "content": "Shut down and halt the system. This is mostly equivalent to systemctl start halt.target\n--job-mode=replace-irreversibly --no-block, but also prints a wall message to all users.\nThis command is asynchronous; it will return after the halt operation is enqueued,\nwithout waiting for it to complete. Note that this operation will simply halt the OS\nkernel after shutting down, leaving the hardware powered on. Use systemctl poweroff for\npowering off the system (see below).\n\nIf combined with --force, shutdown of all running services is skipped, however all\nprocesses are killed and all file systems are unmounted or mounted read-only, immediately\nfollowed by the system halt. If --force is specified twice, the operation is immediately\nexecuted without terminating any processes or unmounting any file systems. This may\nresult in data loss. Note that when --force is specified twice the halt operation is\nexecuted by systemctl itself, and the system manager is not contacted. This means the\ncommand should succeed even when the system manager has crashed.\n\nIf combined with --when=, shutdown will be scheduled after the given timestamp. And\n--when=cancel will cancel the shutdown.\n" }, { "name": "poweroff", "content": "Shut down and power-off the system. This is mostly equivalent to systemctl start\npoweroff.target --job-mode=replace-irreversibly --no-block, but also prints a wall\nmessage to all users. This command is asynchronous; it will return after the power-off\noperation is enqueued, without waiting for it to complete.\n\nThis command honors --force and --when= in a similar way as halt.\n" }, { "name": "reboot", "content": "Shut down and reboot the system.\n\nThis command mostly equivalent to systemctl start reboot.target\n--job-mode=replace-irreversibly --no-block, but also prints a wall message to all users.\nThis command is asynchronous; it will return after the reboot operation is enqueued,\nwithout waiting for it to complete.\n\nIf the switch --reboot-argument= is given, it will be passed as the optional argument to\nthe reboot(2) system call.\n\nOptions --boot-loader-entry=, --boot-loader-menu=, and --firmware-setup can be used to\nselect what to do after the reboot. See the descriptions of those options for details.\n\nThis command honors --force and --when= in a similar way as halt.\n\nIf a new kernel has been loaded via kexec --load, a kexec will be performed instead of a\nreboot, unless \"SYSTEMCTLSKIPAUTOKEXEC=1\" has been set. If a new root file system has\nbeen set up on \"/run/nextroot/\", a soft-reboot will be performed instead of a reboot,\nunless \"SYSTEMCTLSKIPAUTOSOFTREBOOT=1\" has been set.\n\nAdded in version 246.\n" }, { "name": "kexec", "content": "Shut down and reboot the system via kexec. This command will load a kexec kernel if one\nwasn't loaded yet or fail. A kernel may be loaded earlier by a separate step, this is\nparticularly useful if a custom initrd or additional kernel command line options are\ndesired. The --force can be used to continue without a kexec kernel, i.e. to perform a\nnormal reboot. The final reboot step is equivalent to systemctl start kexec.target\n--job-mode=replace-irreversibly --no-block.\n\nTo load a kernel, an enumeration is performed following the \u001b[34mBoot Loader Specification[1],\nand the default boot entry is loaded. For this step to succeed, the system must be using\nUEFI and the boot loader entries must be configured appropriately. bootctl list may be\nused to list boot entries, see bootctl(1).\n\nThis command is asynchronous; it will return after the reboot operation is enqueued,\nwithout waiting for it to complete.\n\nThis command honors --force and --when= similarly to halt.\n\nIf a new kernel has been loaded via kexec --load, a kexec will be performed when reboot\nis invoked, unless \"SYSTEMCTLSKIPAUTOKEXEC=1\" has been set.\n" }, { "name": "soft-reboot", "content": "Shut down and reboot userspace. This is equivalent to systemctl start soft-reboot.target\n--job-mode=replace-irreversibly --no-block. This command is asynchronous; it will return\nafter the reboot operation is enqueued, without waiting for it to complete.\n\nThis command honors --force and --when= in a similar way as halt.\n\nThis operation only reboots userspace, leaving the kernel running. See systemd-soft-\nreboot.service(8) for details.\n\nIf a new root file system has been set up on \"/run/nextroot/\", a soft-reboot will be\nperformed when reboot is invoked, unless \"SYSTEMCTLSKIPAUTOSOFTREBOOT=1\" has been\nset.\n\nAdded in version 254.\n\nexit [EXITCODE]\nAsk the service manager to quit. This is only supported for user service managers (i.e.\nin conjunction with the --user option) or in containers and is equivalent to poweroff\notherwise. This command is asynchronous; it will return after the exit operation is\nenqueued, without waiting for it to complete.\n\nThe service manager will exit with the specified exit code, if EXITCODE is passed.\n\nAdded in version 227.\n\nswitch-root [ROOT [INIT]]\nSwitches to a different root directory and executes a new system manager process below\nit. This is intended for use in the initrd, and will transition from the initrd's system\nmanager process (a.k.a. \"init\" process, PID 1) to the main system manager process which\nis loaded from the actual host root files system. This call takes two arguments: the\ndirectory that is to become the new root directory, and the path to the new system\nmanager binary below it to execute as PID 1. If both are omitted or the former is an\nempty string it defaults to /sysroot/. If the latter is omitted or is an empty string, a\nsystemd binary will automatically be searched for and used as service manager. If the\nsystem manager path is omitted, equal to the empty string or identical to the path to the\nsystemd binary, the state of the initrd's system manager process is passed to the main\nsystem manager, which allows later introspection of the state of the services involved in\nthe initrd boot phase.\n\nAdded in version 209.\n" }, { "name": "suspend", "content": "Suspend the system. This will trigger activation of the special target unit\nsuspend.target. This command is asynchronous, and will return after the suspend operation\nis successfully enqueued. It will not wait for the suspend/resume cycle to complete.\n" }, { "name": "hibernate", "content": "Hibernate the system. This will trigger activation of the special target unit\nhibernate.target. This command is asynchronous, and will return after the hibernation\noperation is successfully enqueued. It will not wait for the hibernate/thaw cycle to\ncomplete.\n" }, { "name": "hybrid-sleep", "content": "Hibernate and suspend the system. This will trigger activation of the special target unit\nhybrid-sleep.target. This command is asynchronous, and will return after the hybrid sleep\noperation is successfully enqueued. It will not wait for the sleep/wake-up cycle to\ncomplete.\n\nAdded in version 196.\n" }, { "name": "suspend-then-hibernate", "content": "Suspend the system and hibernate it after the delay specified in systemd-sleep.conf. This\nwill trigger activation of the special target unit suspend-then-hibernate.target. This\ncommand is asynchronous, and will return after the hybrid sleep operation is successfully\nenqueued. It will not wait for the sleep/wake-up or hibernate/thaw cycle to complete.\n\nAdded in version 240.\n" }, { "name": "Parameter Syntax", "content": "Unit commands listed above take either a single unit name (designated as UNIT), or multiple\nunit specifications (designated as PATTERN...). In the first case, the unit name with or\nwithout a suffix must be given. If the suffix is not specified (unit name is \"abbreviated\"),\nsystemctl will append a suitable suffix, \".service\" by default, and a type-specific suffix in\ncase of commands which operate only on specific unit types. For example,\n\n# systemctl start sshd\n\nand\n\n# systemctl start sshd.service\n\nare equivalent, as are\n\n# systemctl isolate default\n\nand\n\n# systemctl isolate default.target\n\nNote that (absolute) paths to device nodes are automatically converted to device unit names,\nand other (absolute) paths to mount unit names.\n\n# systemctl status /dev/sda\n# systemctl status /home\n\nare equivalent to:\n\n# systemctl status dev-sda.device\n# systemctl status home.mount\n\nIn the second case, shell-style globs will be matched against the primary names of all units\ncurrently in memory; literal unit names, with or without a suffix, will be treated as in the\nfirst case. This means that literal unit names always refer to exactly one unit, but globs\nmay match zero units and this is not considered an error.\n\nGlob patterns use fnmatch(3), so normal shell-style globbing rules are used, and \"*\", \"?\",\n\"[]\" may be used. See glob(7) for more details. The patterns are matched against the primary\nnames of units currently in memory, and patterns which do not match anything are silently\nskipped. For example:\n\n# systemctl stop sshd@*.service\n\nwill stop all sshd@.service instances. Note that alias names of units, and units that aren't\nin memory are not considered for glob expansion.\n\nFor unit file commands, the specified UNIT should be the name of the unit file (possibly\nabbreviated, see above), or the absolute path to the unit file:\n\n# systemctl enable foo.service\n\nor\n\n# systemctl link /path/to/foo.service\n\n" } ] }, "OPTIONS": { "content": "The following options are understood:\n", "subsections": [ { "name": "-t --type=", "content": "The argument is a comma-separated list of unit types such as service and socket. When\nunits are listed with list-units, list-dependencies, show, or status, only units of the\nspecified types will be shown. By default, units of all types are shown.\n\nAs a special case, if one of the arguments is help, a list of allowed values will be\nprinted and the program will exit.\n", "flag": "-t" }, { "name": "--state=", "content": "The argument is a comma-separated list of unit LOAD, SUB, or ACTIVE states. When listing\nunits with list-units, list-dependencies, show or status, show only those in the\nspecified states. Use --state=failed or --failed to show only failed units.\n\nAs a special case, if one of the arguments is help, a list of allowed values will be\nprinted and the program will exit.\n\nAdded in version 206.\n" }, { "name": "-p --property=", "content": "When showing unit/job/manager properties with the show command, limit display to\nproperties specified in the argument. The argument should be a comma-separated list of\nproperty names, such as \"MainPID\". Unless specified, all known properties are shown. If\nspecified more than once, all properties with the specified names are shown. Shell\ncompletion is implemented for property names.\n\nFor the manager itself, systemctl show will show all available properties, most of which\nare derived or closely match the options described in systemd-system.conf(5).\n\nProperties for units vary by unit type, so showing any unit (even a non-existent one) is\na way to list properties pertaining to this type. Similarly, showing any job will list\nproperties pertaining to all jobs. Properties for units are documented in\nsystemd.unit(5), and the pages for individual unit types systemd.service(5),\nsystemd.socket(5), etc.\n", "flag": "-p" }, { "name": "-P", "content": "Equivalent to --value --property=, i.e. shows the value of the property without the\nproperty name or \"=\". Note that using -P once will also affect all properties listed with\n-p/--property=.\n\nAdded in version 246.\n", "flag": "-P" }, { "name": "-a --all", "content": "When listing units with list-units, also show inactive units and units which are\nfollowing other units. When showing unit/job/manager properties, show all properties\nregardless whether they are set or not.\n\nTo list all units installed in the file system, use the list-unit-files command instead.\n\nWhen listing units with list-dependencies, recursively show dependencies of all dependent\nunits (by default only dependencies of target units are shown).\n\nWhen used with status, show journal messages in full, even if they include unprintable\ncharacters or are very long. By default, fields with unprintable characters are\nabbreviated as \"blob data\". (Note that the pager may escape unprintable characters\nagain.)\n", "flag": "-a", "long": "--all" }, { "name": "-r --recursive", "content": "When listing units, also show units of local containers. Units of local containers will\nbe prefixed with the container name, separated by a single colon character (\":\").\n\nAdded in version 212.\n", "flag": "-r", "long": "--recursive" }, { "name": "--reverse", "content": "Show reverse dependencies between units with list-dependencies, i.e. follow dependencies\nof type WantedBy=, RequiredBy=, UpheldBy=, PartOf=, BoundBy=, instead of Wants= and\nsimilar.\n\nAdded in version 203.\n", "long": "--reverse" }, { "name": "--after", "content": "With list-dependencies, show the units that are ordered before the specified unit. In\nother words, recursively list units following the After= dependency.\n\nNote that any After= dependency is automatically mirrored to create a Before= dependency.\nTemporal dependencies may be specified explicitly, but are also created implicitly for\nunits which are WantedBy= targets (see systemd.target(5)), and as a result of other\ndirectives (for example RequiresMountsFor=). Both explicitly and implicitly introduced\ndependencies are shown with list-dependencies.\n\nWhen passed to the list-jobs command, for each printed job show which other jobs are\nwaiting for it. May be combined with --before to show both the jobs waiting for each job\nas well as all jobs each job is waiting for.\n\nAdded in version 203.\n", "long": "--after" }, { "name": "--before", "content": "With list-dependencies, show the units that are ordered after the specified unit. In\nother words, recursively list units following the Before= dependency.\n\nWhen passed to the list-jobs command, for each printed job show which other jobs it is\nwaiting for. May be combined with --after to show both the jobs waiting for each job as\nwell as all jobs each job is waiting for.\n\nAdded in version 212.\n", "long": "--before" }, { "name": "--with-dependencies", "content": "When used with status, cat, list-units, and list-unit-files, those commands print all\nspecified units and the dependencies of those units.\n\nOptions --reverse, --after, --before may be used to change what types of dependencies are\nshown.\n\nAdded in version 245.\n", "long": "--with-dependencies" }, { "name": "-l --full", "content": "Do not ellipsize unit names, process tree entries, journal output, or truncate unit\ndescriptions in the output of status, list-units, list-jobs, and list-timers.\n\nAlso, show installation targets in the output of is-enabled.\n", "flag": "-l", "long": "--full" }, { "name": "--value", "content": "When printing properties with show, only print the value, and skip the property name and\n\"=\". Also see option -P above.\n\nAdded in version 230.\n", "long": "--value" }, { "name": "--show-types", "content": "When showing sockets, show the type of the socket.\n\nAdded in version 202.\n", "long": "--show-types" }, { "name": "--job-mode=", "content": "When queuing a new job, this option controls how to deal with already queued jobs. It\ntakes one of \"fail\", \"replace\", \"replace-irreversibly\", \"isolate\", \"ignore-dependencies\",\n\"ignore-requirements\", \"flush\", \"triggering\", or \"restart-dependencies\". Defaults to\n\"replace\", except when the isolate command is used which implies the \"isolate\" job mode.\n\nIf \"fail\" is specified and a requested operation conflicts with a pending job (more\nspecifically: causes an already pending start job to be reversed into a stop job or vice\nversa), cause the operation to fail.\n\nIf \"replace\" (the default) is specified, any conflicting pending job will be replaced, as\nnecessary.\n\nIf \"replace-irreversibly\" is specified, operate like \"replace\", but also mark the new\njobs as irreversible. This prevents future conflicting transactions from replacing these\njobs (or even being enqueued while the irreversible jobs are still pending). Irreversible\njobs can still be cancelled using the cancel command. This job mode should be used on any\ntransaction which pulls in shutdown.target.\n\n\"isolate\" is only valid for start operations and causes all other units to be stopped\nwhen the specified unit is started. This mode is always used when the isolate command is\nused.\n\n\"flush\" will cause all queued jobs to be canceled when the new job is enqueued.\n\nIf \"ignore-dependencies\" is specified, then all unit dependencies are ignored for this\nnew job and the operation is executed immediately. If passed, no required units of the\nunit passed will be pulled in, and no ordering dependencies will be honored. This is\nmostly a debugging and rescue tool for the administrator and should not be used by\napplications.\n\n\"ignore-requirements\" is similar to \"ignore-dependencies\", but only causes the\nrequirement dependencies to be ignored, the ordering dependencies will still be honored.\n\n\"triggering\" may only be used with systemctl stop. In this mode, the specified unit and\nany active units that trigger it are stopped. See the discussion of Triggers= in\nsystemd.unit(5) for more information about triggering units.\n\n\"restart-dependencies\" may only be used with systemctl start. In this mode, dependencies\nof the specified unit will receive restart propagation, as if a restart job had been\nenqueued for the unit.\n\nAdded in version 209.\n" }, { "name": "-T --show-transaction", "content": "When enqueuing a unit job (for example as effect of a systemctl start invocation or\nsimilar), show brief information about all jobs enqueued, covering both the requested job\nand any added because of unit dependencies. Note that the output will only include jobs\nimmediately part of the transaction requested. It is possible that service start-up\nprogram code run as effect of the enqueued jobs might request further jobs to be pulled\nin. This means that completion of the listed jobs might ultimately entail more jobs than\nthe listed ones.\n\nAdded in version 242.\n", "flag": "-T", "long": "--show-transaction" }, { "name": "--fail", "content": "Shorthand for --job-mode=fail.\n\nWhen used with the kill command, if no units were killed, the operation results in an\nerror.\n\nAdded in version 227.\n", "long": "--fail" }, { "name": "--check-inhibitors=", "content": "When system shutdown or sleep state is requested, this option controls checking of\ninhibitor locks. It takes one of \"auto\", \"yes\" or \"no\". Defaults to \"auto\", which will\nbehave like \"yes\" for interactive invocations (i.e. from a TTY) and \"no\" for\nnon-interactive invocations. \"yes\" lets the request respect inhibitor locks. \"no\" lets\nthe request ignore inhibitor locks.\n\nApplications can establish inhibitor locks to prevent certain important operations (such\nas CD burning) from being interrupted by system shutdown or sleep. Any user may take\nthese locks and privileged users may override these locks. If any locks are taken,\nshutdown and sleep state requests will normally fail (unless privileged). However, if\n\"no\" is specified or \"auto\" is specified on a non-interactive requests, the operation\nwill be attempted. If locks are present, the operation may require additional privileges.\n\nOption --force provides another way to override inhibitors.\n\nAdded in version 248.\n" }, { "name": "-i", "content": "Shortcut for --check-inhibitors=no.\n\nAdded in version 198.\n", "flag": "-i" }, { "name": "--dry-run", "content": "Just print what would be done. Currently supported by verbs halt, poweroff, reboot,\nkexec, suspend, hibernate, hybrid-sleep, suspend-then-hibernate, default, rescue,\nemergency, and exit.\n\nAdded in version 236.\n", "long": "--dry-run" }, { "name": "-q --quiet", "content": "Suppress printing of the results of various commands and also the hints about truncated\nlog lines. This does not suppress output of commands for which the printed output is the\nonly result (like show). Errors are always printed.\n", "flag": "-q", "long": "--quiet" }, { "name": "--no-warn", "content": "Don't generate the warnings shown by default in the following cases:\n\n• when systemctl is invoked without procfs mounted on /proc/,\n\n• when using enable or disable on units without install information (i.e. don't have or\nhave an empty [Install] section),\n\n• when using disable combined with --user on units that are enabled in global scope,\n\n• when a stop-ped, disable-d, or mask-ed unit still has active triggering units.\n\nAdded in version 253.\n", "long": "--no-warn" }, { "name": "--no-block", "content": "Do not synchronously wait for the requested operation to finish. If this is not\nspecified, the job will be verified, enqueued and systemctl will wait until the unit's\nstart-up is completed. By passing this argument, it is only verified and enqueued. This\noption may not be combined with --wait.\n", "long": "--no-block" }, { "name": "--wait", "content": "Synchronously wait for started units to terminate again. This option may not be combined\nwith --no-block. Note that this will wait forever if any given unit never terminates (by\nitself or by getting stopped explicitly); particularly services which use\n\"RemainAfterExit=yes\".\n\nWhen used with is-system-running, wait until the boot process is completed before\nreturning.\n\nAdded in version 232.\n", "long": "--wait" }, { "name": "--user", "content": "Talk to the service manager of the calling user, rather than the service manager of the\nsystem.\n", "long": "--user" }, { "name": "--system", "content": "Talk to the service manager of the system. This is the implied default.\n", "long": "--system" }, { "name": "--failed", "content": "List units in failed state. This is equivalent to --state=failed.\n\nAdded in version 233.\n", "long": "--failed" }, { "name": "--no-wall", "content": "Do not send wall message before halt, power-off and reboot.\n", "long": "--no-wall" }, { "name": "--global", "content": "When used with enable and disable, operate on the global user configuration directory,\nthus enabling or disabling a unit file globally for all future logins of all users.\n", "long": "--global" }, { "name": "--no-reload", "content": "When used with enable and disable, do not implicitly reload daemon configuration after\nexecuting the changes.\n", "long": "--no-reload" }, { "name": "--no-ask-password", "content": "When used with start and related commands, disables asking for passwords. Background\nservices may require input of a password or passphrase string, for example to unlock\nsystem hard disks or cryptographic certificates. Unless this option is specified and the\ncommand is invoked from a terminal, systemctl will query the user on the terminal for the\nnecessary secrets. Use this option to switch this behavior off. In this case, the\npassword must be supplied by some other means (for example graphical password agents) or\nthe service might fail. This also disables querying the user for authentication for\nprivileged operations.\n", "long": "--no-ask-password" }, { "name": "--kill-whom=", "content": "When used with kill, choose which processes to send a UNIX process signal to. Must be one\nof main, control or all to select whether to kill only the main process, the control\nprocess or all processes of the unit. The main process of the unit is the one that\ndefines the life-time of it. A control process of a unit is one that is invoked by the\nmanager to induce state changes of it. For example, all processes started due to the\nExecStartPre=, ExecStop= or ExecReload= settings of service units are control processes.\nNote that there is only one control process per unit at a time, as only one state change\nis executed at a time. For services of type Type=forking, the initial process started by\nthe manager for ExecStart= is a control process, while the process ultimately forked off\nby that one is then considered the main process of the unit (if it can be determined).\nThis is different for service units of other types, where the process forked off by the\nmanager for ExecStart= is always the main process itself. A service unit consists of zero\nor one main process, zero or one control process plus any number of additional processes.\nNot all unit types manage processes of these types however. For example, for mount units,\ncontrol processes are defined (which are the invocations of /usr/bin/mount and\n/usr/bin/umount), but no main process is defined. If omitted, defaults to all.\n\nAdded in version 252.\n\n--kill-value=INT\nIf used with the kill command, enqueues a signal along with the specified integer value\nparameter to the specified process(es). This operation is only available for POSIX\nRealtime Signals (i.e. --signal=SIGRTMIN+... or --signal=SIGRTMAX-...), and ensures the\nsignals are generated via the sigqueue(3) system call, rather than kill(3). The specified\nvalue must be a 32-bit signed integer, and may be specified either in decimal, in\nhexadecimal (if prefixed with \"0x\"), octal (if prefixed with \"0o\") or binary (if prefixed\nwith \"0b\")\n\nIf this option is used the signal will only be enqueued on the control or main process of\nthe unit, never on other processes belonging to the unit, i.e. --kill-whom=all will only\naffect main and control processes but no other processes.\n\nAdded in version 254.\n" }, { "name": "-s --signal=", "content": "When used with kill, choose which signal to send to selected processes. Must be one of\nthe well-known signal specifiers such as SIGTERM, SIGINT or SIGSTOP. If omitted, defaults\nto SIGTERM.\n\nThe special value \"help\" will list the known values and the program will exit\nimmediately, and the special value \"list\" will list known values along with the numerical\nsignal numbers and the program will exit immediately.\n", "flag": "-s" }, { "name": "--what=", "content": "Select what type of per-unit resources to remove when the clean command is invoked, see\nabove. Takes one of configuration, state, cache, logs, runtime, fdstore to select the\ntype of resource. This option may be specified more than once, in which case all\nspecified resource types are removed. Also accepts the special value all as a shortcut\nfor specifying all six resource types. If this option is not specified defaults to the\ncombination of cache, runtime and fdstore, i.e. the three kinds of resources that are\ngenerally considered to be redundant and can be reconstructed on next invocation. Note\nthat the explicit removal of the fdstore resource type is only useful if the\nFileDescriptorStorePreserve= option is enabled, since the file descriptor store is\notherwise cleaned automatically when the unit is stopped.\n\nAdded in version 243.\n" }, { "name": "-f --force", "content": "When used with enable, overwrite any existing conflicting symlinks.\n\nWhen used with edit, create all of the specified units which do not already exist.\n\nWhen used with halt, poweroff, reboot or kexec, execute the selected operation without\nshutting down all units. However, all processes will be killed forcibly and all file\nsystems are unmounted or remounted read-only. This is hence a drastic but relatively safe\noption to request an immediate reboot. If --force is specified twice for these operations\n(with the exception of kexec), they will be executed immediately, without terminating any\nprocesses or unmounting any file systems. Warning: specifying --force twice with any of\nthese operations might result in data loss. Note that when --force is specified twice the\nselected operation is executed by systemctl itself, and the system manager is not\ncontacted. This means the command should succeed even when the system manager has\ncrashed.\n", "flag": "-f", "long": "--force" }, { "name": "--message=", "content": "When used with halt, poweroff or reboot, set a short message explaining the reason for\nthe operation. The message will be logged together with the default shutdown message.\n\nAdded in version 225.\n" }, { "name": "--now", "content": "When used with enable, the units will also be started. When used with disable or mask,\nthe units will also be stopped. The start or stop operation is only carried out when the\nrespective enable or disable operation has been successful.\n\nAdded in version 220.\n", "long": "--now" }, { "name": "--root=", "content": "When used with enable/disable/is-enabled (and related commands), use the specified root\npath when looking for unit files. If this option is present, systemctl will operate on\nthe file system directly, instead of communicating with the systemd daemon to carry out\nchanges.\n\n--image=image\nTakes a path to a disk image file or block device node. If specified, all operations are\napplied to file system in the indicated disk image. This option is similar to --root=,\nbut operates on file systems stored in disk images or block devices. The disk image\nshould either contain just a file system or a set of file systems within a GPT partition\ntable, following the \u001b[34mDiscoverable Partitions Specification[2]. For further information on\nsupported disk images, see systemd-nspawn(1)'s switch of the same name.\n\nAdded in version 252.\n\n--image-policy=policy\nTakes an image policy string as argument, as per systemd.image-policy(7). The policy is\nenforced when operating on the disk image specified via --image=, see above. If not\nspecified defaults to the \"*\" policy, i.e. all recognized file systems in the image are\nused.\n" }, { "name": "--runtime", "content": "When used with enable, disable, edit, (and related commands), make changes only\ntemporarily, so that they are lost on the next reboot. This will have the effect that\nchanges are not made in subdirectories of /etc/ but in /run/, with identical immediate\neffects, however, since the latter is lost on reboot, the changes are lost too.\n\nSimilarly, when used with set-property, make changes only temporarily, so that they are\nlost on the next reboot.\n", "long": "--runtime" }, { "name": "--preset-mode=", "content": "Takes one of \"full\" (the default), \"enable-only\", \"disable-only\". When used with the\npreset or preset-all commands, controls whether units shall be disabled and enabled\naccording to the preset rules, or only enabled, or only disabled.\n\nAdded in version 215.\n" }, { "name": "-n --lines=", "content": "When used with status, controls the number of journal lines to show, counting from the\nmost recent ones. Takes a positive integer argument, or 0 to disable journal output.\nDefaults to 10.\n", "flag": "-n" }, { "name": "-o --output=", "content": "When used with status, controls the formatting of the journal entries that are shown. For\nthe available choices, see journalctl(1). Defaults to \"short\".\n", "flag": "-o" }, { "name": "--firmware-setup", "content": "When used with the reboot, poweroff, or halt command, indicate to the system's firmware\nto reboot into the firmware setup interface for the next boot. Note that this\nfunctionality is not available on all systems.\n\nAdded in version 220.\n\n--boot-loader-menu=timeout\nWhen used with the reboot, poweroff, or halt command, indicate to the system's boot\nloader to show the boot loader menu on the following boot. Takes a time value as\nparameter — indicating the menu timeout. Pass zero in order to disable the menu timeout.\nNote that not all boot loaders support this functionality.\n\nAdded in version 242.\n\n--boot-loader-entry=ID\nWhen used with the reboot, poweroff, or halt command, indicate to the system's boot\nloader to boot into a specific boot loader entry on the following boot. Takes a boot\nloader entry identifier as argument, or \"help\" in order to list available entries. Note\nthat not all boot loaders support this functionality.\n\nAdded in version 242.\n", "long": "--firmware-setup" }, { "name": "--reboot-argument=", "content": "This switch is used with reboot. The value is architecture and firmware specific. As an\nexample, \"recovery\" might be used to trigger system recovery, and \"fota\" might be used to\ntrigger a “firmware over the air” update.\n\nAdded in version 246.\n" }, { "name": "--plain", "content": "When used with list-dependencies, list-units or list-machines, the output is printed as a\nlist instead of a tree, and the bullet circles are omitted.\n\nAdded in version 203.\n", "long": "--plain" }, { "name": "--timestamp=", "content": "Change the format of printed timestamps. The following values may be used:\n\npretty (this is the default)\n\"Day YYYY-MM-DD HH:MM:SS TZ\"\n\nAdded in version 248.\n\nunix\n\"@seconds-since-the-epoch\"\n\nAdded in version 251.\n\nus, μs\n\"Day YYYY-MM-DD HH:MM:SS.UUUUUU TZ\"\n\nAdded in version 248.\n\nutc\n\"Day YYYY-MM-DD HH:MM:SS UTC\"\n\nAdded in version 248.\n\nus+utc, μs+utc\n\"Day YYYY-MM-DD HH:MM:SS.UUUUUU UTC\"\n\nAdded in version 248.\n\nAdded in version 247.\n" }, { "name": "--mkdir", "content": "When used with bind, creates the destination file or directory before applying the bind\nmount. Note that even though the name of this option suggests that it is suitable only\nfor directories, this option also creates the destination file node to mount over if the\nobject to mount is not a directory, but a regular file, device node, socket or FIFO.\n\nAdded in version 248.\n", "long": "--mkdir" }, { "name": "--marked", "content": "Only allowed with reload-or-restart. Enqueues restart jobs for all units that have the\n\"needs-restart\" mark, and reload jobs for units that have the \"needs-reload\" mark. When a\nunit marked for reload does not support reload, restart will be queued. Those properties\ncan be set using set-property Markers=....\n\nUnless --no-block is used, systemctl will wait for the queued jobs to finish.\n\nAdded in version 248.\n", "long": "--marked" }, { "name": "--read-only", "content": "When used with bind, creates a read-only bind mount.\n\nAdded in version 248.\n\n--drop-in=NAME\nWhen used with edit, use NAME as the drop-in file name instead of override.conf.\n\nAdded in version 253.\n", "long": "--read-only" }, { "name": "--when=", "content": "When used with halt, poweroff, reboot or kexec, schedule the action to be performed at\nthe given timestamp, which should adhere to the syntax documented in systemd.time(7)\nsection \"PARSING TIMESTAMPS\". Specially, if \"show\" is given, the currently scheduled\naction will be shown, which can be canceled by passing an empty string or \"cancel\".\n\nAdded in version 254.\n" }, { "name": "-H --host=", "content": "Execute the operation remotely. Specify a hostname, or a username and hostname separated\nby \"@\", to connect to. The hostname may optionally be suffixed by a port ssh is listening\non, separated by \":\", and then a container name, separated by \"/\", which connects\ndirectly to a specific container on the specified host. This will use SSH to talk to the\nremote machine manager instance. Container names may be enumerated with machinectl -H\nHOST. Put IPv6 addresses in brackets.\n", "flag": "-H" }, { "name": "-M --machine=", "content": "Execute operation on a local container. Specify a container name to connect to,\noptionally prefixed by a user name to connect as and a separating \"@\" character. If the\nspecial string \".host\" is used in place of the container name, a connection to the local\nsystem is made (which is useful to connect to a specific user's user bus: \"--user\n--machine=lennart@.host\"). If the \"@\" syntax is not used, the connection is made as root\nuser. If the \"@\" syntax is used either the left hand side or the right hand side may be\nomitted (but not both) in which case the local user name and \".host\" are implied.\n", "flag": "-M" }, { "name": "--no-pager", "content": "Do not pipe output into a pager.\n\n--legend=BOOL\nEnable or disable printing of the legend, i.e. column headers and the footer with hints.\nThe legend is printed by default, unless disabled with --quiet or similar.\n", "long": "--no-pager" }, { "name": "-h --help", "content": "Print a short help text and exit.\n", "flag": "-h", "long": "--help" }, { "name": "--version", "content": "Print a short version string and exit.\n", "long": "--version" } ] }, "EXIT STATUS": { "content": "On success, 0 is returned, a non-zero failure code otherwise.\n\nsystemctl uses the return codes defined by LSB, as defined in \u001b[34mLSB 3.0.0[3].\n", "subsections": [ { "name": "Table 3. LSB return codes", "content": "┌───────┬───────────────────────────┬──────────────────────────┐\n│ Value │ Description in LSB │ Use in systemd │\n├───────┼───────────────────────────┼──────────────────────────┤\n│ 0 │ \"program is running or │ unit is active │\n│ │ service is OK\" │ │\n├───────┼───────────────────────────┼──────────────────────────┤\n│ 1 │ \"program is dead and │ unit not failed (used by │\n│ │ /var/run pid file exists\" │ is-failed) │\n├───────┼───────────────────────────┼──────────────────────────┤\n│ 2 │ \"program is dead and │ unused │\n│ │ /var/lock lock file │ │\n│ │ exists\" │ │\n├───────┼───────────────────────────┼──────────────────────────┤\n│ 3 │ \"program is not running\" │ unit is not active │\n├───────┼───────────────────────────┼──────────────────────────┤\n│ 4 │ \"program or service │ no such unit │\n│ │ status is unknown\" │ │\n└───────┴───────────────────────────┴──────────────────────────┘\n\n\nThe mapping of LSB service states to systemd unit states is imperfect, so it is better to not\nrely on those return values but to look for specific unit states and substates instead.\n" } ] }, "ENVIRONMENT": { "content": "$SYSTEMDEDITOR\nEditor to use when editing units; overrides $EDITOR and $VISUAL. If neither\n$SYSTEMDEDITOR nor $EDITOR nor $VISUAL are present or if it is set to an empty string or\nif their execution failed, systemctl will try to execute well known editors in this\norder: editor(1), nano(1), vim(1), vi(1).\n\nAdded in version 218.\n\n$SYSTEMDLOGLEVEL\nThe maximum log level of emitted messages (messages with a higher log level, i.e. less\nimportant ones, will be suppressed). Either one of (in order of decreasing importance)\nemerg, alert, crit, err, warning, notice, info, debug, or an integer in the range 0...7.\nSee syslog(3) for more information.\n\n$SYSTEMDLOGCOLOR\nA boolean. If true, messages written to the tty will be colored according to priority.\n\nThis setting is only useful when messages are written directly to the terminal, because\njournalctl(1) and other tools that display logs will color messages based on the log\nlevel on their own.\n\n$SYSTEMDLOGTIME\nA boolean. If true, console log messages will be prefixed with a timestamp.\n\nThis setting is only useful when messages are written directly to the terminal or a file,\nbecause journalctl(1) and other tools that display logs will attach timestamps based on\nthe entry metadata on their own.\n\n$SYSTEMDLOGLOCATION\nA boolean. If true, messages will be prefixed with a filename and line number in the\nsource code where the message originates.\n\nNote that the log location is often attached as metadata to journal entries anyway.\nIncluding it directly in the message text can nevertheless be convenient when debugging\nprograms.\n\n$SYSTEMDLOGTARGET\nThe destination for log messages. One of console (log to the attached tty),\nconsole-prefixed (log to the attached tty but with prefixes encoding the log level and\n\"facility\", see syslog(3), kmsg (log to the kernel circular log buffer), journal (log to\nthe journal), journal-or-kmsg (log to the journal if available, and to kmsg otherwise),\nauto (determine the appropriate log target automatically, the default), null (disable log\noutput).\n\n$SYSTEMDPAGER\nPager to use when --no-pager is not given; overrides $PAGER. If neither $SYSTEMDPAGER\nnor $PAGER are set, a set of well-known pager implementations are tried in turn,\nincluding less(1) and more(1), until one is found. If no pager implementation is\ndiscovered no pager is invoked. Setting this environment variable to an empty string or\nthe value \"cat\" is equivalent to passing --no-pager.\n\nNote: if $SYSTEMDPAGERSECURE is not set, $SYSTEMDPAGER (as well as $PAGER) will be\nsilently ignored.\n\n$SYSTEMDLESS\nOverride the options passed to less (by default \"FRSXMK\").\n\nUsers might want to change two options in particular:\n\nK\nThis option instructs the pager to exit immediately when Ctrl+C is pressed. To allow\nless to handle Ctrl+C itself to switch back to the pager command prompt, unset this\noption.\n\nIf the value of $SYSTEMDLESS does not include \"K\", and the pager that is invoked is\nless, Ctrl+C will be ignored by the executable, and needs to be handled by the pager.\n\nX\nThis option instructs the pager to not send termcap initialization and\ndeinitialization strings to the terminal. It is set by default to allow command\noutput to remain visible in the terminal even after the pager exits. Nevertheless,\nthis prevents some pager functionality from working, in particular paged output\ncannot be scrolled with the mouse.\n\nSee less(1) for more discussion.\n\n$SYSTEMDLESSCHARSET\nOverride the charset passed to less (by default \"utf-8\", if the invoking terminal is\ndetermined to be UTF-8 compatible).\n\n$SYSTEMDPAGERSECURE\nTakes a boolean argument. When true, the \"secure\" mode of the pager is enabled; if false,\ndisabled. If $SYSTEMDPAGERSECURE is not set at all, secure mode is enabled if the\neffective UID is not the same as the owner of the login session, see geteuid(2) and\nsdpidgetowneruid(3). In secure mode, LESSSECURE=1 will be set when invoking the\npager, and the pager shall disable commands that open or create new files or start new\nsubprocesses. When $SYSTEMDPAGERSECURE is not set at all, pagers which are not known to\nimplement secure mode will not be used. (Currently only less(1) implements secure mode.)\n\nNote: when commands are invoked with elevated privileges, for example under sudo(8) or\npkexec(1), care must be taken to ensure that unintended interactive features are not\nenabled. \"Secure\" mode for the pager may be enabled automatically as describe above.\nSetting SYSTEMDPAGERSECURE=0 or not removing it from the inherited environment allows\nthe user to invoke arbitrary commands. Note that if the $SYSTEMDPAGER or $PAGER\nvariables are to be honoured, $SYSTEMDPAGERSECURE must be set too. It might be\nreasonable to completely disable the pager using --no-pager instead.\n\n$SYSTEMDCOLORS\nTakes a boolean argument. When true, systemd and related utilities will use colors in\ntheir output, otherwise the output will be monochrome. Additionally, the variable can\ntake one of the following special values: \"16\", \"256\" to restrict the use of colors to\nthe base 16 or 256 ANSI colors, respectively. This can be specified to override the\nautomatic decision based on $TERM and what the console is connected to.\n\n$SYSTEMDURLIFY\nThe value must be a boolean. Controls whether clickable links should be generated in the\noutput for terminal emulators supporting this. This can be specified to override the\ndecision that systemd makes based on $TERM and other conditions.\n", "subsections": [] }, "SEE ALSO": { "content": "systemd(1), journalctl(1), loginctl(1), machinectl(1), systemd.unit(5), systemd.resource-\ncontrol(5), systemd.special(7), wall(1), systemd.preset(5), systemd.generator(7), glob(7)\n", "subsections": [] }, "NOTES": { "content": "1. Boot Loader Specification\nhttps://uapi-group.org/specifications/specs/bootloaderspecification\n\n2. Discoverable Partitions Specification\nhttps://uapi-group.org/specifications/specs/discoverablepartitionsspecification\n\n3. LSB 3.0.0\nhttp://refspecs.linuxbase.org/LSB3.0.0/LSB-PDA/LSB-PDA/iniscrptact.html\n\nsystemd 255 SYSTEMCTL(1)", "subsections": [] } }, "summary": "systemctl - Control the systemd system and service manager", "flags": [ { "flag": "-t", "long": null, "arg": null, "description": "The argument is a comma-separated list of unit types such as service and socket. When units are listed with list-units, list-dependencies, show, or status, only units of the specified types will be shown. By default, units of all types are shown. As a special case, if one of the arguments is help, a list of allowed values will be printed and the program will exit." }, { "flag": "", "long": null, "arg": null, "description": "The argument is a comma-separated list of unit LOAD, SUB, or ACTIVE states. When listing units with list-units, list-dependencies, show or status, show only those in the specified states. Use --state=failed or --failed to show only failed units. As a special case, if one of the arguments is help, a list of allowed values will be printed and the program will exit. Added in version 206." }, { "flag": "-p", "long": null, "arg": null, "description": "When showing unit/job/manager properties with the show command, limit display to properties specified in the argument. The argument should be a comma-separated list of property names, such as \"MainPID\". Unless specified, all known properties are shown. If specified more than once, all properties with the specified names are shown. Shell completion is implemented for property names. For the manager itself, systemctl show will show all available properties, most of which are derived or closely match the options described in systemd-system.conf(5). Properties for units vary by unit type, so showing any unit (even a non-existent one) is a way to list properties pertaining to this type. Similarly, showing any job will list properties pertaining to all jobs. Properties for units are documented in systemd.unit(5), and the pages for individual unit types systemd.service(5), systemd.socket(5), etc." }, { "flag": "-P", "long": null, "arg": null, "description": "Equivalent to --value --property=, i.e. shows the value of the property without the property name or \"=\". Note that using -P once will also affect all properties listed with -p/--property=. Added in version 246." }, { "flag": "-a", "long": "--all", "arg": null, "description": "When listing units with list-units, also show inactive units and units which are following other units. When showing unit/job/manager properties, show all properties regardless whether they are set or not. To list all units installed in the file system, use the list-unit-files command instead. When listing units with list-dependencies, recursively show dependencies of all dependent units (by default only dependencies of target units are shown). When used with status, show journal messages in full, even if they include unprintable characters or are very long. By default, fields with unprintable characters are abbreviated as \"blob data\". (Note that the pager may escape unprintable characters again.)" }, { "flag": "-r", "long": "--recursive", "arg": null, "description": "When listing units, also show units of local containers. Units of local containers will be prefixed with the container name, separated by a single colon character (\":\"). Added in version 212." }, { "flag": "", "long": "--reverse", "arg": null, "description": "Show reverse dependencies between units with list-dependencies, i.e. follow dependencies of type WantedBy=, RequiredBy=, UpheldBy=, PartOf=, BoundBy=, instead of Wants= and similar. Added in version 203." }, { "flag": "", "long": "--after", "arg": null, "description": "With list-dependencies, show the units that are ordered before the specified unit. In other words, recursively list units following the After= dependency. Note that any After= dependency is automatically mirrored to create a Before= dependency. Temporal dependencies may be specified explicitly, but are also created implicitly for units which are WantedBy= targets (see systemd.target(5)), and as a result of other directives (for example RequiresMountsFor=). Both explicitly and implicitly introduced dependencies are shown with list-dependencies. When passed to the list-jobs command, for each printed job show which other jobs are waiting for it. May be combined with --before to show both the jobs waiting for each job as well as all jobs each job is waiting for. Added in version 203." }, { "flag": "", "long": "--before", "arg": null, "description": "With list-dependencies, show the units that are ordered after the specified unit. In other words, recursively list units following the Before= dependency. When passed to the list-jobs command, for each printed job show which other jobs it is waiting for. May be combined with --after to show both the jobs waiting for each job as well as all jobs each job is waiting for. Added in version 212." }, { "flag": "", "long": "--with-dependencies", "arg": null, "description": "When used with status, cat, list-units, and list-unit-files, those commands print all specified units and the dependencies of those units. Options --reverse, --after, --before may be used to change what types of dependencies are shown. Added in version 245." }, { "flag": "-l", "long": "--full", "arg": null, "description": "Do not ellipsize unit names, process tree entries, journal output, or truncate unit descriptions in the output of status, list-units, list-jobs, and list-timers. Also, show installation targets in the output of is-enabled." }, { "flag": "", "long": "--value", "arg": null, "description": "When printing properties with show, only print the value, and skip the property name and \"=\". Also see option -P above. Added in version 230." }, { "flag": "", "long": "--show-types", "arg": null, "description": "When showing sockets, show the type of the socket. Added in version 202." }, { "flag": "", "long": null, "arg": null, "description": "When queuing a new job, this option controls how to deal with already queued jobs. It takes one of \"fail\", \"replace\", \"replace-irreversibly\", \"isolate\", \"ignore-dependencies\", \"ignore-requirements\", \"flush\", \"triggering\", or \"restart-dependencies\". Defaults to \"replace\", except when the isolate command is used which implies the \"isolate\" job mode. If \"fail\" is specified and a requested operation conflicts with a pending job (more specifically: causes an already pending start job to be reversed into a stop job or vice versa), cause the operation to fail. If \"replace\" (the default) is specified, any conflicting pending job will be replaced, as necessary. If \"replace-irreversibly\" is specified, operate like \"replace\", but also mark the new jobs as irreversible. This prevents future conflicting transactions from replacing these jobs (or even being enqueued while the irreversible jobs are still pending). Irreversible jobs can still be cancelled using the cancel command. This job mode should be used on any transaction which pulls in shutdown.target. \"isolate\" is only valid for start operations and causes all other units to be stopped when the specified unit is started. This mode is always used when the isolate command is used. \"flush\" will cause all queued jobs to be canceled when the new job is enqueued. If \"ignore-dependencies\" is specified, then all unit dependencies are ignored for this new job and the operation is executed immediately. If passed, no required units of the unit passed will be pulled in, and no ordering dependencies will be honored. This is mostly a debugging and rescue tool for the administrator and should not be used by applications. \"ignore-requirements\" is similar to \"ignore-dependencies\", but only causes the requirement dependencies to be ignored, the ordering dependencies will still be honored. \"triggering\" may only be used with systemctl stop. In this mode, the specified unit and any active units that trigger it are stopped. See the discussion of Triggers= in systemd.unit(5) for more information about triggering units. \"restart-dependencies\" may only be used with systemctl start. In this mode, dependencies of the specified unit will receive restart propagation, as if a restart job had been enqueued for the unit. Added in version 209." }, { "flag": "-T", "long": "--show-transaction", "arg": null, "description": "When enqueuing a unit job (for example as effect of a systemctl start invocation or similar), show brief information about all jobs enqueued, covering both the requested job and any added because of unit dependencies. Note that the output will only include jobs immediately part of the transaction requested. It is possible that service start-up program code run as effect of the enqueued jobs might request further jobs to be pulled in. This means that completion of the listed jobs might ultimately entail more jobs than the listed ones. Added in version 242." }, { "flag": "", "long": "--fail", "arg": null, "description": "Shorthand for --job-mode=fail. When used with the kill command, if no units were killed, the operation results in an error. Added in version 227." }, { "flag": "", "long": null, "arg": null, "description": "When system shutdown or sleep state is requested, this option controls checking of inhibitor locks. It takes one of \"auto\", \"yes\" or \"no\". Defaults to \"auto\", which will behave like \"yes\" for interactive invocations (i.e. from a TTY) and \"no\" for non-interactive invocations. \"yes\" lets the request respect inhibitor locks. \"no\" lets the request ignore inhibitor locks. Applications can establish inhibitor locks to prevent certain important operations (such as CD burning) from being interrupted by system shutdown or sleep. Any user may take these locks and privileged users may override these locks. If any locks are taken, shutdown and sleep state requests will normally fail (unless privileged). However, if \"no\" is specified or \"auto\" is specified on a non-interactive requests, the operation will be attempted. If locks are present, the operation may require additional privileges. Option --force provides another way to override inhibitors. Added in version 248." }, { "flag": "-i", "long": null, "arg": null, "description": "Shortcut for --check-inhibitors=no. Added in version 198." }, { "flag": "", "long": "--dry-run", "arg": null, "description": "Just print what would be done. Currently supported by verbs halt, poweroff, reboot, kexec, suspend, hibernate, hybrid-sleep, suspend-then-hibernate, default, rescue, emergency, and exit. Added in version 236." }, { "flag": "-q", "long": "--quiet", "arg": null, "description": "Suppress printing of the results of various commands and also the hints about truncated log lines. This does not suppress output of commands for which the printed output is the only result (like show). Errors are always printed." }, { "flag": "", "long": "--no-warn", "arg": null, "description": "Don't generate the warnings shown by default in the following cases: • when systemctl is invoked without procfs mounted on /proc/, • when using enable or disable on units without install information (i.e. don't have or have an empty [Install] section), • when using disable combined with --user on units that are enabled in global scope, • when a stop-ped, disable-d, or mask-ed unit still has active triggering units. Added in version 253." }, { "flag": "", "long": "--no-block", "arg": null, "description": "Do not synchronously wait for the requested operation to finish. If this is not specified, the job will be verified, enqueued and systemctl will wait until the unit's start-up is completed. By passing this argument, it is only verified and enqueued. This option may not be combined with --wait." }, { "flag": "", "long": "--wait", "arg": null, "description": "Synchronously wait for started units to terminate again. This option may not be combined with --no-block. Note that this will wait forever if any given unit never terminates (by itself or by getting stopped explicitly); particularly services which use \"RemainAfterExit=yes\". When used with is-system-running, wait until the boot process is completed before returning. Added in version 232." }, { "flag": "", "long": "--user", "arg": null, "description": "Talk to the service manager of the calling user, rather than the service manager of the system." }, { "flag": "", "long": "--system", "arg": null, "description": "Talk to the service manager of the system. This is the implied default." }, { "flag": "", "long": "--failed", "arg": null, "description": "List units in failed state. This is equivalent to --state=failed. Added in version 233." }, { "flag": "", "long": "--no-wall", "arg": null, "description": "Do not send wall message before halt, power-off and reboot." }, { "flag": "", "long": "--global", "arg": null, "description": "When used with enable and disable, operate on the global user configuration directory, thus enabling or disabling a unit file globally for all future logins of all users." }, { "flag": "", "long": "--no-reload", "arg": null, "description": "When used with enable and disable, do not implicitly reload daemon configuration after executing the changes." }, { "flag": "", "long": "--no-ask-password", "arg": null, "description": "When used with start and related commands, disables asking for passwords. Background services may require input of a password or passphrase string, for example to unlock system hard disks or cryptographic certificates. Unless this option is specified and the command is invoked from a terminal, systemctl will query the user on the terminal for the necessary secrets. Use this option to switch this behavior off. In this case, the password must be supplied by some other means (for example graphical password agents) or the service might fail. This also disables querying the user for authentication for privileged operations." }, { "flag": "", "long": null, "arg": null, "description": "When used with kill, choose which processes to send a UNIX process signal to. Must be one of main, control or all to select whether to kill only the main process, the control process or all processes of the unit. The main process of the unit is the one that defines the life-time of it. A control process of a unit is one that is invoked by the manager to induce state changes of it. For example, all processes started due to the ExecStartPre=, ExecStop= or ExecReload= settings of service units are control processes. Note that there is only one control process per unit at a time, as only one state change is executed at a time. For services of type Type=forking, the initial process started by the manager for ExecStart= is a control process, while the process ultimately forked off by that one is then considered the main process of the unit (if it can be determined). This is different for service units of other types, where the process forked off by the manager for ExecStart= is always the main process itself. A service unit consists of zero or one main process, zero or one control process plus any number of additional processes. Not all unit types manage processes of these types however. For example, for mount units, control processes are defined (which are the invocations of /usr/bin/mount and /usr/bin/umount), but no main process is defined. If omitted, defaults to all. Added in version 252. --kill-value=INT If used with the kill command, enqueues a signal along with the specified integer value parameter to the specified process(es). This operation is only available for POSIX Realtime Signals (i.e. --signal=SIGRTMIN+... or --signal=SIGRTMAX-...), and ensures the signals are generated via the sigqueue(3) system call, rather than kill(3). The specified value must be a 32-bit signed integer, and may be specified either in decimal, in hexadecimal (if prefixed with \"0x\"), octal (if prefixed with \"0o\") or binary (if prefixed with \"0b\") If this option is used the signal will only be enqueued on the control or main process of the unit, never on other processes belonging to the unit, i.e. --kill-whom=all will only affect main and control processes but no other processes. Added in version 254." }, { "flag": "-s", "long": null, "arg": null, "description": "When used with kill, choose which signal to send to selected processes. Must be one of the well-known signal specifiers such as SIGTERM, SIGINT or SIGSTOP. If omitted, defaults to SIGTERM. The special value \"help\" will list the known values and the program will exit immediately, and the special value \"list\" will list known values along with the numerical signal numbers and the program will exit immediately." }, { "flag": "", "long": null, "arg": null, "description": "Select what type of per-unit resources to remove when the clean command is invoked, see above. Takes one of configuration, state, cache, logs, runtime, fdstore to select the type of resource. This option may be specified more than once, in which case all specified resource types are removed. Also accepts the special value all as a shortcut for specifying all six resource types. If this option is not specified defaults to the combination of cache, runtime and fdstore, i.e. the three kinds of resources that are generally considered to be redundant and can be reconstructed on next invocation. Note that the explicit removal of the fdstore resource type is only useful if the FileDescriptorStorePreserve= option is enabled, since the file descriptor store is otherwise cleaned automatically when the unit is stopped. Added in version 243." }, { "flag": "-f", "long": "--force", "arg": null, "description": "When used with enable, overwrite any existing conflicting symlinks. When used with edit, create all of the specified units which do not already exist. When used with halt, poweroff, reboot or kexec, execute the selected operation without shutting down all units. However, all processes will be killed forcibly and all file systems are unmounted or remounted read-only. This is hence a drastic but relatively safe option to request an immediate reboot. If --force is specified twice for these operations (with the exception of kexec), they will be executed immediately, without terminating any processes or unmounting any file systems. Warning: specifying --force twice with any of these operations might result in data loss. Note that when --force is specified twice the selected operation is executed by systemctl itself, and the system manager is not contacted. This means the command should succeed even when the system manager has crashed." }, { "flag": "", "long": null, "arg": null, "description": "When used with halt, poweroff or reboot, set a short message explaining the reason for the operation. The message will be logged together with the default shutdown message. Added in version 225." }, { "flag": "", "long": "--now", "arg": null, "description": "When used with enable, the units will also be started. When used with disable or mask, the units will also be stopped. The start or stop operation is only carried out when the respective enable or disable operation has been successful. Added in version 220." }, { "flag": "", "long": null, "arg": null, "description": "When used with enable/disable/is-enabled (and related commands), use the specified root path when looking for unit files. If this option is present, systemctl will operate on the file system directly, instead of communicating with the systemd daemon to carry out changes. --image=image Takes a path to a disk image file or block device node. If specified, all operations are applied to file system in the indicated disk image. This option is similar to --root=, but operates on file systems stored in disk images or block devices. The disk image should either contain just a file system or a set of file systems within a GPT partition table, following the \u001b[34mDiscoverable Partitions Specification[2]. For further information on supported disk images, see systemd-nspawn(1)'s switch of the same name. Added in version 252. --image-policy=policy Takes an image policy string as argument, as per systemd.image-policy(7). The policy is enforced when operating on the disk image specified via --image=, see above. If not specified defaults to the \"*\" policy, i.e. all recognized file systems in the image are used." }, { "flag": "", "long": "--runtime", "arg": null, "description": "When used with enable, disable, edit, (and related commands), make changes only temporarily, so that they are lost on the next reboot. This will have the effect that changes are not made in subdirectories of /etc/ but in /run/, with identical immediate effects, however, since the latter is lost on reboot, the changes are lost too. Similarly, when used with set-property, make changes only temporarily, so that they are lost on the next reboot." }, { "flag": "", "long": null, "arg": null, "description": "Takes one of \"full\" (the default), \"enable-only\", \"disable-only\". When used with the preset or preset-all commands, controls whether units shall be disabled and enabled according to the preset rules, or only enabled, or only disabled. Added in version 215." }, { "flag": "-n", "long": null, "arg": null, "description": "When used with status, controls the number of journal lines to show, counting from the most recent ones. Takes a positive integer argument, or 0 to disable journal output. Defaults to 10." }, { "flag": "-o", "long": null, "arg": null, "description": "When used with status, controls the formatting of the journal entries that are shown. For the available choices, see journalctl(1). Defaults to \"short\"." }, { "flag": "", "long": "--firmware-setup", "arg": null, "description": "When used with the reboot, poweroff, or halt command, indicate to the system's firmware to reboot into the firmware setup interface for the next boot. Note that this functionality is not available on all systems. Added in version 220. --boot-loader-menu=timeout When used with the reboot, poweroff, or halt command, indicate to the system's boot loader to show the boot loader menu on the following boot. Takes a time value as parameter — indicating the menu timeout. Pass zero in order to disable the menu timeout. Note that not all boot loaders support this functionality. Added in version 242. --boot-loader-entry=ID When used with the reboot, poweroff, or halt command, indicate to the system's boot loader to boot into a specific boot loader entry on the following boot. Takes a boot loader entry identifier as argument, or \"help\" in order to list available entries. Note that not all boot loaders support this functionality. Added in version 242." }, { "flag": "", "long": null, "arg": null, "description": "This switch is used with reboot. The value is architecture and firmware specific. As an example, \"recovery\" might be used to trigger system recovery, and \"fota\" might be used to trigger a “firmware over the air” update. Added in version 246." }, { "flag": "", "long": "--plain", "arg": null, "description": "When used with list-dependencies, list-units or list-machines, the output is printed as a list instead of a tree, and the bullet circles are omitted. Added in version 203." }, { "flag": "", "long": null, "arg": null, "description": "Change the format of printed timestamps. The following values may be used: pretty (this is the default) \"Day YYYY-MM-DD HH:MM:SS TZ\" Added in version 248. unix \"@seconds-since-the-epoch\" Added in version 251. us, μs \"Day YYYY-MM-DD HH:MM:SS.UUUUUU TZ\" Added in version 248. utc \"Day YYYY-MM-DD HH:MM:SS UTC\" Added in version 248. us+utc, μs+utc \"Day YYYY-MM-DD HH:MM:SS.UUUUUU UTC\" Added in version 248. Added in version 247." }, { "flag": "", "long": "--mkdir", "arg": null, "description": "When used with bind, creates the destination file or directory before applying the bind mount. Note that even though the name of this option suggests that it is suitable only for directories, this option also creates the destination file node to mount over if the object to mount is not a directory, but a regular file, device node, socket or FIFO. Added in version 248." }, { "flag": "", "long": "--marked", "arg": null, "description": "Only allowed with reload-or-restart. Enqueues restart jobs for all units that have the \"needs-restart\" mark, and reload jobs for units that have the \"needs-reload\" mark. When a unit marked for reload does not support reload, restart will be queued. Those properties can be set using set-property Markers=.... Unless --no-block is used, systemctl will wait for the queued jobs to finish. Added in version 248." }, { "flag": "", "long": "--read-only", "arg": null, "description": "When used with bind, creates a read-only bind mount. Added in version 248. --drop-in=NAME When used with edit, use NAME as the drop-in file name instead of override.conf. Added in version 253." }, { "flag": "", "long": null, "arg": null, "description": "When used with halt, poweroff, reboot or kexec, schedule the action to be performed at the given timestamp, which should adhere to the syntax documented in systemd.time(7) section \"PARSING TIMESTAMPS\". Specially, if \"show\" is given, the currently scheduled action will be shown, which can be canceled by passing an empty string or \"cancel\". Added in version 254." }, { "flag": "-H", "long": null, "arg": null, "description": "Execute the operation remotely. Specify a hostname, or a username and hostname separated by \"@\", to connect to. The hostname may optionally be suffixed by a port ssh is listening on, separated by \":\", and then a container name, separated by \"/\", which connects directly to a specific container on the specified host. This will use SSH to talk to the remote machine manager instance. Container names may be enumerated with machinectl -H HOST. Put IPv6 addresses in brackets." }, { "flag": "-M", "long": null, "arg": null, "description": "Execute operation on a local container. Specify a container name to connect to, optionally prefixed by a user name to connect as and a separating \"@\" character. If the special string \".host\" is used in place of the container name, a connection to the local system is made (which is useful to connect to a specific user's user bus: \"--user --machine=lennart@.host\"). If the \"@\" syntax is not used, the connection is made as root user. If the \"@\" syntax is used either the left hand side or the right hand side may be omitted (but not both) in which case the local user name and \".host\" are implied." }, { "flag": "", "long": "--no-pager", "arg": null, "description": "Do not pipe output into a pager. --legend=BOOL Enable or disable printing of the legend, i.e. column headers and the footer with hints. The legend is printed by default, unless disabled with --quiet or similar." }, { "flag": "-h", "long": "--help", "arg": null, "description": "Print a short help text and exit." }, { "flag": "", "long": "--version", "arg": null, "description": "Print a short version string and exit." } ], "examples": [], "see_also": [ { "name": "systemd", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/systemd/1/json" }, { "name": "journalctl", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/journalctl/1/json" }, { "name": "loginctl", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/loginctl/1/json" }, { "name": "machinectl", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/machinectl/1/json" }, { "name": "systemd.unit", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/systemd.unit/5/json" }, { "name": "control", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/control/5/json" }, { "name": "systemd.special", "section": "7", "url": "https://www.chedong.com/phpMan.php/man/systemd.special/7/json" }, { "name": "wall", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/wall/1/json" }, { "name": "systemd.preset", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/systemd.preset/5/json" }, { "name": "systemd.generator", "section": "7", "url": "https://www.chedong.com/phpMan.php/man/systemd.generator/7/json" }, { "name": "glob", "section": "7", "url": "https://www.chedong.com/phpMan.php/man/glob/7/json" } ], "tldr": { "source": "official", "description": "Control the systemd system and service manager.", "examples": [ { "description": "Show all running services", "command": "systemctl status" }, { "description": "List failed units", "command": "systemctl --failed" }, { "description": "Start/Stop/Restart/Reload/Show the status of a service", "command": "systemctl {{start|stop|restart|reload|status}} {{unit}}" }, { "description": "Enable/Disable a unit to be started on bootup", "command": "systemctl {{enable|disable}} {{unit}}" }, { "description": "Reload systemd, scan for new or changed units", "command": "systemctl daemon-reload" }, { "description": "Check if a unit is active/enabled/failed", "command": "systemctl {{is-active|is-enabled|is-failed}} {{unit}}" }, { "description": "List all service/socket/automount units filtering by running/failed state", "command": "systemctl list-units {{-t|--type}} {{service|socket|automount|...}} --state {{failed|running}}" }, { "description": "Show the contents & absolute path of a unit file or edit it", "command": "systemctl {{cat|edit}} {{unit}}" } ] } }