man/systemctl.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6 This file is part of systemd.
   7
   8 Copyright 2010 Lennart Poettering
   9
  10 systemd is free software; you can redistribute it and/or modify it
  11 under the terms of the GNU Lesser General Public License as published by
  12 the Free Software Foundation; either version 2.1 of the License, or
  13 (at your option) any later version.
  14
  15 systemd is distributed in the hope that it will be useful, but
  16 WITHOUT ANY WARRANTY; without even the implied warranty of
  17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18 Lesser General Public License for more details.
  19
  20 You should have received a copy of the GNU Lesser General Public License
  21 along with systemd; If not, see <http://www.gnu.org/licenses/>.
  22 -->
  23
  24 <refentry id="systemctl"
  25           xmlns:xi="http://www.w3.org/2001/XInclude">
  26
  27   <refentryinfo>
  28     <title>systemctl</title>
  29     <productname>systemd</productname>
  30
  31     <authorgroup>
  32       <author>
  33         <contrib>Developer</contrib>
  34         <firstname>Lennart</firstname>
  35         <surname>Poettering</surname>
  36         <email>lennart@poettering.net</email>
  37       </author>
  38     </authorgroup>
  39   </refentryinfo>
  40
  41   <refmeta>
  42     <refentrytitle>systemctl</refentrytitle>
  43     <manvolnum>1</manvolnum>
  44   </refmeta>
  45
  46   <refnamediv>
  47     <refname>systemctl</refname>
  48     <refpurpose>Control the systemd system and service manager</refpurpose>
  49   </refnamediv>
  50
  51   <refsynopsisdiv>
  52     <cmdsynopsis>
  53       <command>systemctl</command>
  54       <arg choice="opt" rep="repeat">OPTIONS</arg>
  55       <arg choice="plain">COMMAND</arg>
  56       <arg choice="opt" rep="repeat">NAME</arg>
  57     </cmdsynopsis>
  58   </refsynopsisdiv>
  59
  60   <refsect1>
  61     <title>Description</title>
  62
  63     <para><command>systemctl</command> may be used to
  64     introspect and control the state of the
  65     <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  66     system and service manager.</para>
  67   </refsect1>
  68
  69   <refsect1>
  70     <title>Options</title>
  71
  72     <para>The following options are understood:</para>
  73
  74     <variablelist>
  75       <varlistentry>
  76         <term><option>-t</option></term>
  77         <term><option>--type=</option></term>
  78
  79         <listitem>
  80           <para>The argument should be a comma-separated list of unit
  81           types such as <option>service</option> and
  82           <option>socket</option>.
  83           </para>
  84
  85           <para>If one of the arguments is a unit type, when listing
  86           units, limit display to certain unit types. Otherwise, units
  87           of all types will be shown.</para>
  88
  89           <para>As a special case, if one of the arguments is
  90           <option>help</option>, a list of allowed values will be
  91           printed and the program will exit.</para>
  92         </listitem>
  93       </varlistentry>
  94
  95       <varlistentry>
  96         <term><option>--state=</option></term>
  97
  98         <listitem>
  99         <para>The argument should be a comma-separated list of unit LOAD,
 100         SUB, or ACTIVE states. When listing units, show only those
 101         in specified states.</para>
 102         </listitem>
 103       </varlistentry>
 104
 105       <varlistentry>
 106         <term><option>-p</option></term>
 107         <term><option>--property=</option></term>
 108
 109         <listitem>
 110           <para>When showing unit/job/manager properties with the
 111           <command>show</command> command, limit display to certain
 112           properties as specified as argument. If not specified, all
 113           set properties are shown. The argument should be a
 114           comma-separated list of property names, such as
 115           <literal>MainPID</literal>. If specified more than once, all
 116           properties with the specified names are shown.</para>
 117         </listitem>
 118       </varlistentry>
 119
 120       <varlistentry>
 121         <term><option>-a</option></term>
 122         <term><option>--all</option></term>
 123
 124         <listitem>
 125           <para>When listing units, show all loaded units, regardless
 126           of their state, including inactive units. When showing
 127           unit/job/manager properties, show all properties regardless
 128           whether they are set or not.</para>
 129           <para>To list all units installed on the system, use the
 130           <command>list-unit-files</command> command instead.</para>
 131         </listitem>
 132       </varlistentry>
 133
 134       <varlistentry>
 135         <term><option>-r</option></term>
 136         <term><option>--recursive</option></term>
 137
 138         <listitem>
 139           <para>When listing units, also show units of local
 140           containers. Units of local containers will be prefixed with
 141           the container name, separated by a single colon character
 142           (<literal>:</literal>).</para>
 143         </listitem>
 144       </varlistentry>
 145
 146       <varlistentry>
 147         <term><option>--reverse</option></term>
 148
 149         <listitem>
 150           <para>Show reverse dependencies between units with
 151           <command>list-dependencies</command>, i.e. units with
 152           dependencies of type <varname>Wants=</varname> or
 153           <varname>Requires=</varname> on the given unit.
 154           </para>
 155         </listitem>
 156       </varlistentry>
 157
 158       <varlistentry>
 159         <term><option>--after</option></term>
 160
 161         <listitem>
 162           <para>With <command>list-dependencies</command>, show the
 163           units that are ordered before the specified unit. In other
 164           words, list the units that are in the <varname>After=</varname>
 165           directive of the specified unit, have the specified unit in
 166           their <varname>Before=</varname> directive, or are otherwise
 167           implicit dependencies of the specified unit.</para>
 168         </listitem>
 169       </varlistentry>
 170
 171       <varlistentry>
 172         <term><option>--before</option></term>
 173
 174         <listitem>
 175           <para>With <command>list-dependencies</command>, show the
 176           units that are ordered after the specified unit. In other
 177           words, list the units that are in the <varname>Before=</varname>
 178           directive of the specified unit, have the specified unit in
 179           their <varname>After=</varname> directive, or otherwise depend
 180           on the specified unit.</para>
 181         </listitem>
 182       </varlistentry>
 183
 184       <varlistentry>
 185         <term><option>-l</option></term>
 186         <term><option>--full</option></term>
 187
 188         <listitem>
 189           <para>Do not ellipsize unit names, process tree entries,
 190           journal output, or truncate unit descriptions in the output
 191           of <command>status</command>, <command>list-units</command>,
 192           <command>list-jobs</command>, and
 193           <command>list-timers</command>.</para>
 194         </listitem>
 195       </varlistentry>
 196
 197       <varlistentry>
 198         <term><option>--show-types</option></term>
 199
 200         <listitem>
 201           <para>When showing sockets, show the type of the socket.</para>
 202         </listitem>
 203       </varlistentry>
 204
 205       <varlistentry>
 206         <term><option>--job-mode=</option></term>
 207
 208         <listitem>
 209         <para>When queuing a new job, this option controls how to deal with
 210         already queued jobs. It takes one of <literal>fail</literal>,
 211         <literal>replace</literal>,
 212         <literal>replace-irreversibly</literal>,
 213         <literal>isolate</literal>,
 214         <literal>ignore-dependencies</literal>,
 215         <literal>ignore-requirements</literal> or
 216         <literal>flush</literal>. Defaults to
 217         <literal>replace</literal>, except when the
 218         <command>isolate</command> command is used which implies the
 219         <literal>isolate</literal> job mode.</para>
 220
 221         <para>If <literal>fail</literal> is specified and a requested
 222         operation conflicts with a pending job (more specifically:
 223         causes an already pending start job to be reversed into a stop
 224         job or vice versa), cause the operation to fail.</para>
 225
 226         <para>If <literal>replace</literal> (the default) is
 227         specified, any conflicting pending job will be replaced, as
 228         necessary.</para>
 229
 230         <para>If <literal>replace-irreversibly</literal> is specified,
 231         operate like <literal>replace</literal>, but also mark the new
 232         jobs as irreversible. This prevents future conflicting
 233         transactions from replacing these jobs (or even being enqueued
 234         while the irreversible jobs are still pending). Irreversible
 235         jobs can still be cancelled using the <command>cancel</command>
 236         command.</para>
 237
 238         <para><literal>isolate</literal> is only valid for start
 239         operations and causes all other units to be stopped when the
 240         specified unit is started. This mode is always used when the
 241         <command>isolate</command> command is used.</para>
 242
 243         <para><literal>flush</literal> will cause all queued jobs to
 244         be canceled when the new job is enqueued.</para>
 245
 246         <para>If <literal>ignore-dependencies</literal> is specified,
 247         then all unit dependencies are ignored for this new job and
 248         the operation is executed immediately. If passed, no required
 249         units of the unit passed will be pulled in, and no ordering
 250         dependencies will be honored. This is mostly a debugging and
 251         rescue tool for the administrator and should not be used by
 252         applications.</para>
 253
 254         <para><literal>ignore-requirements</literal> is similar to
 255         <literal>ignore-dependencies</literal>, but only causes the
 256         requirement dependencies to be ignored, the ordering
 257         dependencies will still be honoured.</para>
 258         </listitem>
 259
 260       </varlistentry>
 261
 262       <varlistentry>
 263         <term><option>-i</option></term>
 264         <term><option>--ignore-inhibitors</option></term>
 265
 266         <listitem>
 267           <para>When system shutdown or a sleep state is requested,
 268           ignore inhibitor locks. Applications can establish inhibitor
 269           locks to avoid that certain important operations (such as CD
 270           burning or suchlike) are interrupted by system shutdown or a
 271           sleep state. Any user may take these locks and privileged
 272           users may override these locks. If any locks are taken,
 273           shutdown and sleep state requests will normally fail
 274           (regardless of whether privileged or not) and a list of active locks
 275           is printed. However, if <option>--ignore-inhibitors</option>
 276           is specified, the locks are ignored and not printed, and the
 277           operation attempted anyway, possibly requiring additional
 278           privileges.</para>
 279         </listitem>
 280       </varlistentry>
 281
 282       <varlistentry>
 283         <term><option>-q</option></term>
 284         <term><option>--quiet</option></term>
 285
 286         <listitem>
 287           <para>Suppress output to standard output in
 288           <command>snapshot</command>,
 289           <command>is-active</command>,
 290           <command>is-failed</command>,
 291           <command>enable</command> and
 292         <command>disable</command>.</para>
 293         </listitem>
 294       </varlistentry>
 295
 296       <varlistentry>
 297         <term><option>--no-block</option></term>
 298
 299         <listitem>
 300           <para>Do not synchronously wait for the requested operation
 301           to finish. If this is not specified, the job will be
 302           verified, enqueued and <command>systemctl</command> will
 303           wait until it is completed. By passing this argument, it is
 304           only verified and enqueued.</para>
 305         </listitem>
 306       </varlistentry>
 307
 308       <varlistentry>
 309         <term><option>--no-legend</option></term>
 310
 311         <listitem>
 312           <para>Do not print the legend, i.e. the column headers and
 313           the footer with hints.</para>
 314         </listitem>
 315       </varlistentry>
 316
 317       <xi:include href="user-system-options.xml" xpointer="user" />
 318       <xi:include href="user-system-options.xml" xpointer="system" />
 319
 320       <varlistentry>
 321         <term><option>--no-wall</option></term>
 322
 323         <listitem>
 324           <para>Do not send wall message before halt, power-off,
 325           reboot.</para>
 326         </listitem>
 327       </varlistentry>
 328
 329       <varlistentry>
 330         <term><option>--global</option></term>
 331
 332         <listitem>
 333           <para>When used with <command>enable</command> and
 334           <command>disable</command>, operate on the global user
 335           configuration directory, thus enabling or disabling a unit
 336           file globally for all future logins of all users.</para>
 337         </listitem>
 338       </varlistentry>
 339
 340       <varlistentry>
 341         <term><option>--no-reload</option></term>
 342
 343         <listitem>
 344           <para>When used with <command>enable</command> and
 345           <command>disable</command>, do not implicitly reload daemon
 346           configuration after executing the changes.</para>
 347         </listitem>
 348       </varlistentry>
 349
 350       <varlistentry>
 351         <term><option>--no-ask-password</option></term>
 352
 353         <listitem>
 354           <para>When used with <command>start</command> and related
 355           commands, disables asking for passwords. Background services
 356           may require input of a password or passphrase string, for
 357           example to unlock system hard disks or cryptographic
 358           certificates. Unless this option is specified and the
 359           command is invoked from a terminal,
 360           <command>systemctl</command> will query the user on the
 361           terminal for the necessary secrets. Use this option to
 362           switch this behavior off. In this case, the password must be
 363           supplied by some other means (for example graphical password
 364           agents) or the service might fail. This also disables
 365           querying the user for authentication for privileged
 366           operations.</para>
 367         </listitem>
 368
 369       </varlistentry>
 370
 371       <varlistentry>
 372         <term><option>--kill-who=</option></term>
 373
 374         <listitem>
 375           <para>When used with <command>kill</command>, choose which
 376           processes to send a signal to. Must be one of
 377           <option>main</option>, <option>control</option> or
 378           <option>all</option> to select whether to kill only the main
 379           process, the control process or all processes of the
 380           unit. The main process of the unit is the one that defines
 381           the life-time of it. A control process of a unit is one that
 382           is invoked by the manager to induce state changes of it. For
 383           example, all processes started due to the
 384           <varname>ExecStartPre=</varname>,
 385           <varname>ExecStop=</varname> or
 386           <varname>ExecReload=</varname> settings of service units are
 387           control processes. Note that there is only one control
 388           process per unit at a time, as only one state change is
 389           executed at a time. For services of type
 390           <varname>Type=forking</varname>, the initial process started
 391           by the manager for <varname>ExecStart=</varname> is a
 392           control process, while the process ultimately forked off by
 393           that one is then considered the main process of the unit (if
 394           it can be determined). This is different for service units
 395           of other types, where the process forked off by the manager
 396           for <varname>ExecStart=</varname> is always the main process
 397           itself. A service unit consists of zero or one main process,
 398           zero or one control process plus any number of additional
 399           processes. Not all unit types manage processes of these
 400           types however. For example, for mount units, control processes
 401           are defined (which are the invocations of
 402           <filename>/usr/bin/mount</filename> and
 403           <filename>/usr/bin/umount</filename>), but no main process
 404           is defined. If omitted, defaults to
 405           <option>all</option>.</para>
 406         </listitem>
 407
 408       </varlistentry>
 409
 410       <varlistentry>
 411         <term><option>-s</option></term>
 412         <term><option>--signal=</option></term>
 413
 414         <listitem>
 415           <para>When used with <command>kill</command>, choose which
 416           signal to send to selected processes. Must be one of the
 417           well known signal specifiers such as <constant>SIGTERM</constant>, <constant>SIGINT</constant> or
 418           <constant>SIGSTOP</constant>. If omitted, defaults to
 419           <option>SIGTERM</option>.</para>
 420         </listitem>
 421       </varlistentry>
 422
 423       <varlistentry>
 424         <term><option>-f</option></term>
 425         <term><option>--force</option></term>
 426
 427         <listitem>
 428           <para>When used with <command>enable</command>, overwrite
 429           any existing conflicting symlinks.</para>
 430
 431           <para>When used with <command>halt</command>,
 432           <command>poweroff</command>, <command>reboot</command> or
 433           <command>kexec</command>, execute the selected operation
 434           without shutting down all units. However, all processes will
 435           be killed forcibly and all file systems are unmounted or
 436           remounted read-only. This is hence a drastic but relatively
 437           safe option to request an immediate reboot. If
 438           <option>--force</option> is specified twice for these
 439           operations, they will be executed immediately without
 440           terminating any processes or unmounting any file
 441           systems. Warning: specifying <option>--force</option> twice
 442           with any of these operations might result in data
 443           loss.</para>
 444         </listitem>
 445       </varlistentry>
 446
 447       <varlistentry>
 448         <term><option>--root=</option></term>
 449
 450         <listitem>
 451           <para>When used with
 452           <command>enable</command>/<command>disable</command>/<command>is-enabled</command>
 453           (and related commands), use alternative root path when
 454           looking for unit files.</para>
 455         </listitem>
 456
 457       </varlistentry>
 458
 459       <varlistentry>
 460         <term><option>--runtime</option></term>
 461
 462         <listitem>
 463           <para>When used with <command>enable</command>,
 464           <command>disable</command>,
 465           (and related commands), make changes only temporarily, so
 466           that they are lost on the next reboot. This will have the
 467           effect that changes are not made in subdirectories of
 468           <filename>/etc</filename> but in <filename>/run</filename>,
 469           with identical immediate effects, however, since the latter
 470           is lost on reboot, the changes are lost too.</para>
 471
 472           <para>Similarly, when used with
 473           <command>set-property</command>, make changes only
 474           temporarily, so that they are lost on the next
 475           reboot.</para>
 476         </listitem>
 477       </varlistentry>
 478
 479       <varlistentry>
 480         <term><option>--preset-mode=</option></term>
 481
 482         <listitem>
 483           <para>Takes one of <literal>full</literal> (the default),
 484           <literal>enable-only</literal>,
 485           <literal>disable-only</literal>. When use with the
 486           <command>preset</command> or <command>preset-all</command>
 487           commands controls whether units shall be disabled and
 488           enabled according to the preset rules, or only enabled, or
 489           only disabled.</para>
 490         </listitem>
 491       </varlistentry>
 492
 493       <varlistentry>
 494         <term><option>-n</option></term>
 495         <term><option>--lines=</option></term>
 496
 497         <listitem>
 498           <para>When used with <command>status</command>, controls the
 499           number of journal lines to show, counting from the most
 500           recent ones. Takes a positive integer argument. Defaults to
 501           10.</para>
 502         </listitem>
 503       </varlistentry>
 504
 505       <varlistentry>
 506         <term><option>-o</option></term>
 507         <term><option>--output=</option></term>
 508
 509         <listitem>
 510           <para>When used with <command>status</command>, controls the
 511           formatting of the journal entries that are shown. For the
 512           available choices, see
 513           <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
 514           Defaults to <literal>short</literal>.</para>
 515         </listitem>
 516       </varlistentry>
 517
 518       <varlistentry>
 519         <term><option>--plain</option></term>
 520
 521         <listitem>
 522           <para>When used with <command>list-dependencies</command>,
 523           the output is printed as a list instead of a tree.</para>
 524         </listitem>
 525       </varlistentry>
 526
 527       <xi:include href="user-system-options.xml" xpointer="host" />
 528       <xi:include href="user-system-options.xml" xpointer="machine" />
 529
 530       <xi:include href="standard-options.xml" xpointer="help" />
 531       <xi:include href="standard-options.xml" xpointer="version" />
 532       <xi:include href="standard-options.xml" xpointer="no-pager" />
 533     </variablelist>
 534   </refsect1>
 535
 536   <refsect1>
 537     <title>Commands</title>
 538
 539     <para>The following commands are understood:</para>
 540
 541     <refsect2>
 542       <title>Unit Commands</title>
 543
 544       <variablelist>
 545         <varlistentry>
 546           <term><command>list-units <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
 547
 548           <listitem>
 549             <para>List known units (subject to limitations specified
 550             with <option>-t</option>). If one or more
 551             <replaceable>PATTERN</replaceable>s are specified, only
 552             units matching one of them are shown.</para>
 553
 554             <para>This is the default command.</para>
 555           </listitem>
 556         </varlistentry>
 557
 558         <varlistentry>
 559           <term><command>list-sockets <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
 560
 561           <listitem>
 562             <para>List socket units ordered by listening address.
 563             If one or more <replaceable>PATTERN</replaceable>s are
 564             specified, only socket units matching one of them are
 565             shown. Produces output similar to
 566             <programlisting>
 567 LISTEN           UNIT                        ACTIVATES
 568 /dev/initctl     systemd-initctl.socket      systemd-initctl.service
 569 ...
 570 [::]:22          sshd.socket                 sshd.service
 571 kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
 572
 573 5 sockets listed.</programlisting>
 574             Note: because the addresses might contains spaces, this output
 575             is not suitable for programmatic consumption.
 576             </para>
 577
 578             <para>See also the options <option>--show-types</option>,
 579             <option>--all</option>, and <option>--failed</option>.</para>
 580           </listitem>
 581         </varlistentry>
 582
 583         <varlistentry>
 584           <term><command>list-timers <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
 585
 586           <listitem>
 587             <para>List timer units ordered by the time they elapse
 588             next. If one or more <replaceable>PATTERN</replaceable>s
 589             are specified, only units matching one of them are shown.
 590             </para>
 591
 592             <para>See also the options <option>--all</option> and
 593             <option>--failed</option>.</para>
 594           </listitem>
 595         </varlistentry>
 596
 597         <varlistentry>
 598           <term><command>start <replaceable>PATTERN</replaceable>...</command></term>
 599
 600           <listitem>
 601             <para>Start (activate) one or more units specified on the
 602             command line.</para>
 603
 604             <para>Note that glob patterns operate on a list of currently
 605             loaded units. Units which are not active and are not in a
 606             failed state usually are not loaded, and would not be
 607             matched by any pattern. In addition, in case of
 608             instantiated units, systemd is often unaware of the
 609             instance name until the instance has been started. Therefore,
 610             using glob patterns with <command>start</command>
 611             has limited usefulness.</para>
 612           </listitem>
 613         </varlistentry>
 614         <varlistentry>
 615           <term><command>stop <replaceable>PATTERN</replaceable>...</command></term>
 616
 617           <listitem>
 618             <para>Stop (deactivate) one or more units specified on the
 619             command line.</para>
 620           </listitem>
 621         </varlistentry>
 622         <varlistentry>
 623           <term><command>reload <replaceable>PATTERN</replaceable>...</command></term>
 624
 625           <listitem>
 626             <para>Asks all units listed on the command line to reload
 627             their configuration. Note that this will reload the
 628             service-specific configuration, not the unit configuration
 629             file of systemd. If you want systemd to reload the
 630             configuration file of a unit, use the
 631             <command>daemon-reload</command> command. In other words:
 632             for the example case of Apache, this will reload Apache's
 633             <filename>httpd.conf</filename> in the web server, not the
 634             <filename>apache.service</filename> systemd unit
 635             file.</para>
 636
 637             <para>This command should not be confused with the
 638             <command>daemon-reload</command> or <command>load</command>
 639             commands.</para>
 640           </listitem>
 641
 642         </varlistentry>
 643         <varlistentry>
 644           <term><command>restart <replaceable>PATTERN</replaceable>...</command></term>
 645
 646           <listitem>
 647             <para>Restart one or more units specified on the command
 648             line. If the units are not running yet, they will be
 649             started.</para>
 650           </listitem>
 651         </varlistentry>
 652         <varlistentry>
 653           <term><command>try-restart <replaceable>PATTERN</replaceable>...</command></term>
 654
 655           <listitem>
 656             <para>Restart one or more units specified on the command
 657             line if the units are running. This does nothing if units are not
 658             running.  Note that, for compatibility with Red Hat init
 659             scripts, <command>condrestart</command> is equivalent to this
 660             command.</para>
 661           </listitem>
 662         </varlistentry>
 663         <varlistentry>
 664           <term><command>reload-or-restart <replaceable>PATTERN</replaceable>...</command></term>
 665
 666           <listitem>
 667             <para>Reload one or more units if they support it. If not,
 668             restart them instead. If the units are not running yet, they
 669             will be started.</para>
 670           </listitem>
 671         </varlistentry>
 672         <varlistentry>
 673           <term><command>reload-or-try-restart <replaceable>PATTERN</replaceable>...</command></term>
 674
 675           <listitem>
 676             <para>Reload one or more units if they support it. If not,
 677             restart them instead. This does nothing if the units are not
 678             running. Note that, for compatibility with SysV init scripts,
 679             <command>force-reload</command> is equivalent to this
 680             command.</para>
 681           </listitem>
 682         </varlistentry>
 683         <varlistentry>
 684           <term><command>isolate <replaceable>NAME</replaceable></command></term>
 685
 686           <listitem>
 687             <para>Start the unit specified on the command line and its
 688             dependencies and stop all others.</para>
 689
 690             <para>This is similar to changing the runlevel in a
 691             traditional init system. The <command>isolate</command>
 692             command will immediately stop processes that are not enabled
 693             in the new unit, possibly including the graphical
 694             environment or terminal you are currently using.</para>
 695
 696             <para>Note that this is allowed only on units where
 697             <option>AllowIsolate=</option> is enabled. See
 698             <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
 699             for details.</para>
 700           </listitem>
 701         </varlistentry>
 702         <varlistentry>
 703           <term><command>kill <replaceable>PATTERN</replaceable>...</command></term>
 704
 705           <listitem>
 706             <para>Send a signal to one or more processes of the
 707             unit. Use <option>--kill-who=</option> to select which
 708             process to kill. Use <option>--signal=</option> to select
 709             the signal to send.</para>
 710           </listitem>
 711         </varlistentry>
 712         <varlistentry>
 713           <term><command>is-active <replaceable>PATTERN</replaceable>...</command></term>
 714
 715           <listitem>
 716             <para>Check whether any of the specified units are active
 717             (i.e. running). Returns an exit code
 718             <constant>0</constant> if at least one is active, or
 719             non-zero otherwise. Unless <option>--quiet</option> is
 720             specified, this will also print the current unit state to
 721             standard output.</para>
 722           </listitem>
 723         </varlistentry>
 724         <varlistentry>
 725           <term><command>is-failed <replaceable>PATTERN</replaceable>...</command></term>
 726
 727           <listitem>
 728             <para>Check whether any of the specified units are in a
 729             "failed" state. Returns an exit code
 730             <constant>0</constant> if at least one has failed,
 731             non-zero otherwise. Unless <option>--quiet</option> is
 732             specified, this will also print the current unit state to
 733             standard output.</para>
 734           </listitem>
 735         </varlistentry>
 736         <varlistentry>
 737           <term><command>status</command> <optional><replaceable>PATTERN</replaceable>...|<replaceable>PID</replaceable>...]</optional></term>
 738
 739           <listitem>
 740             <para>Show terse runtime status information about one or
 741             more units, followed by most recent log data from the
 742             journal. If no units are specified, show system status. If
 743             combined with <option>--all</option>, also show the status of
 744             all units (subject to limitations specified with
 745             <option>-t</option>). If a PID is passed, show information
 746             about the unit the process belongs to.</para>
 747
 748             <para>This function is intended to generate human-readable
 749             output. If you are looking for computer-parsable output,
 750             use <command>show</command> instead. By default this
 751             function only shows 10 lines of output and ellipsizes
 752             lines to fit in the terminal window. This can be changes
 753             with <option>--lines</option> and <option>--full</option>,
 754             see above. In addition, <command>journalctl
 755             --unit=<replaceable>NAME</replaceable></command> or
 756             <command>journalctl
 757             --user-unit=<replaceable>NAME</replaceable></command> use
 758             a similar filter for messages and might be more
 759             convenient.
 760             </para>
 761           </listitem>
 762         </varlistentry>
 763         <varlistentry>
 764           <term><command>show</command> <optional><replaceable>PATTERN</replaceable>...|<replaceable>JOB</replaceable>...</optional></term>
 765
 766           <listitem>
 767             <para>Show properties of one or more units, jobs, or the
 768             manager itself. If no argument is specified, properties of
 769             the manager will be shown. If a unit name is specified,
 770             properties of the unit is shown, and if a job id is
 771             specified, properties of the job is shown. By default, empty
 772             properties are suppressed. Use <option>--all</option> to
 773             show those too. To select specific properties to show, use
 774             <option>--property=</option>. This command is intended to be
 775             used whenever computer-parsable output is required. Use
 776             <command>status</command> if you are looking for formatted
 777             human-readable output.</para>
 778           </listitem>
 779         </varlistentry>
 780         <varlistentry>
 781           <term><command>cat <replaceable>PATTERN</replaceable>...</command></term>
 782
 783           <listitem>
 784             <para>Show backing files of one or more units. Prints the
 785             "fragment" and "drop-ins" (source files) of units. Each
 786             file is preceded by a comment which includes the file
 787             name.</para>
 788           </listitem>
 789         </varlistentry>
 790         <varlistentry>
 791           <term><command>set-property <replaceable>NAME</replaceable> <replaceable>ASSIGNMENT</replaceable>...</command></term>
 792
 793           <listitem>
 794             <para>Set the specified unit properties at runtime where
 795             this is supported. This allows changing configuration
 796             parameter properties such as resource control settings at
 797             runtime. Not all properties may be changed at runtime, but
 798             many resource control settings (primarily those in
 799             <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
 800             may. The changes are applied instantly, and stored on disk
 801             for future boots, unless <option>--runtime</option> is
 802             passed, in which case the settings only apply until the
 803             next reboot. The syntax of the property assignment follows
 804             closely the syntax of assignments in unit files.</para>
 805
 806             <para>Example: <command>systemctl set-property foobar.service CPUShares=777</command></para>
 807
 808             <para>Note that this command allows changing multiple
 809             properties at the same time, which is preferable over
 810             setting them individually. Like unit file configuration
 811             settings, assigning the empty list to list parameters will
 812             reset the list.</para>
 813           </listitem>
 814         </varlistentry>
 815
 816         <varlistentry>
 817           <term><command>help <replaceable>PATTERN</replaceable>...|<replaceable>PID</replaceable>...</command></term>
 818
 819           <listitem>
 820             <para>Show manual pages for one or more units, if
 821             available. If a PID is given, the manual pages for the unit
 822             the process belongs to are shown.</para>
 823           </listitem>
 824         </varlistentry>
 825
 826         <varlistentry>
 827           <term><command>reset-failed [<replaceable>PATTERN</replaceable>...]</command></term>
 828
 829           <listitem>
 830             <para>Reset the <literal>failed</literal> state of the
 831             specified units, or if no unit name is passed, reset the state of all
 832             units. When a unit fails in some way (i.e. process exiting
 833             with non-zero error code, terminating abnormally or timing
 834             out), it will automatically enter the
 835             <literal>failed</literal> state and its exit code and status
 836             is recorded for introspection by the administrator until the
 837             service is restarted or reset with this command.</para>
 838           </listitem>
 839         </varlistentry>
 840
 841         <varlistentry>
 842           <term><command>list-dependencies <replaceable>NAME</replaceable></command></term>
 843
 844           <listitem>
 845             <para>Shows required and wanted units of the specified
 846             unit. If no unit is specified,
 847             <filename>default.target</filename> is implied. Target units
 848             are recursively expanded.  When <option>--all</option> is
 849             passed, all other units are recursively expanded as
 850             well.</para>
 851           </listitem>
 852         </varlistentry>
 853       </variablelist>
 854     </refsect2>
 855
 856     <refsect2>
 857       <title>Unit File Commands</title>
 858
 859       <variablelist>
 860         <varlistentry>
 861           <term><command>list-unit-files <optional><replaceable>PATTERN...</replaceable></optional></command></term>
 862
 863           <listitem>
 864             <para>List installed unit files. If one or more
 865             <replaceable>PATTERN</replaceable>s are specified, only
 866             units whose filename (just the last component of the path)
 867             matches one of them are shown.</para>
 868           </listitem>
 869         </varlistentry>
 870
 871         <varlistentry>
 872           <term><command>enable <replaceable>NAME</replaceable>...</command></term>
 873
 874           <listitem>
 875             <para>Enable one or more unit files or unit file instances,
 876             as specified on the command line. This will create a number
 877             of symlinks as encoded in the <literal>[Install]</literal>
 878             sections of the unit files. After the symlinks have been
 879             created, the systemd configuration is reloaded (in a way that
 880             is equivalent to <command>daemon-reload</command>) to ensure
 881             the changes are taken into account immediately. Note that
 882             this does <emphasis>not</emphasis> have the effect of also
 883             starting any of the units being enabled. If this
 884             is desired, a separate <command>start</command> command must
 885             be invoked for the unit. Also note that in case of instance
 886             enablement, symlinks named the same as instances are created in
 887             the install location, however they all point to the same
 888             template unit file.</para>
 889
 890             <para>This command will print the actions executed. This
 891             output may be suppressed by passing <option>--quiet</option>.
 892             </para>
 893
 894             <para>Note that this operation creates only the suggested
 895             symlinks for the units. While this command is the
 896             recommended way to manipulate the unit configuration
 897             directory, the administrator is free to make additional
 898             changes manually by placing or removing symlinks in the
 899             directory. This is particularly useful to create
 900             configurations that deviate from the suggested default
 901             installation. In this case, the administrator must make sure
 902             to invoke <command>daemon-reload</command> manually as
 903             necessary to ensure the changes are taken into account.
 904             </para>
 905
 906             <para>Enabling units should not be confused with starting
 907             (activating) units, as done by the <command>start</command>
 908             command. Enabling and starting units is orthogonal: units
 909             may be enabled without being started and started without
 910             being enabled. Enabling simply hooks the unit into various
 911             suggested places (for example, so that the unit is
 912             automatically started on boot or when a particular kind of
 913             hardware is plugged in). Starting actually spawns the daemon
 914             process (in case of service units), or binds the socket (in
 915             case of socket units), and so on.</para>
 916
 917             <para>Depending on whether <option>--system</option>,
 918             <option>--user</option>, <option>--runtime</option>,
 919             or <option>--global</option> is specified, this enables the unit
 920             for the system, for the calling user only, for only this boot of
 921             the system, or for all future logins of all users, or only this
 922             boot.  Note that in the last case, no systemd daemon
 923             configuration is reloaded.</para>
 924           </listitem>
 925         </varlistentry>
 926
 927         <varlistentry>
 928           <term><command>disable <replaceable>NAME</replaceable>...</command></term>
 929
 930           <listitem>
 931             <para>Disables one or more units. This removes all symlinks
 932             to the specified unit files from the unit configuration
 933             directory, and hence undoes the changes made by
 934             <command>enable</command>. Note however that this removes
 935             all symlinks to the unit files (i.e. including manual
 936             additions), not just those actually created by
 937             <command>enable</command>. This call implicitly reloads the
 938             systemd daemon configuration after completing the disabling
 939             of the units. Note that this command does not implicitly
 940             stop the units that are being disabled. If this is desired,
 941             an additional <command>stop</command> command should be
 942             executed afterwards.</para>
 943
 944             <para>This command will print the actions executed. This
 945             output may be suppressed by passing <option>--quiet</option>.
 946             </para>
 947
 948             <para>This command honors <option>--system</option>,
 949             <option>--user</option>, <option>--runtime</option> and
 950             <option>--global</option> in a similar way as
 951             <command>enable</command>.</para>
 952           </listitem>
 953         </varlistentry>
 954
 955         <varlistentry>
 956           <term><command>is-enabled <replaceable>NAME</replaceable>...</command></term>
 957
 958           <listitem>
 959             <para>Checks whether any of the specified unit files are
 960             enabled (as with <command>enable</command>). Returns an
 961             exit code of 0 if at least one is enabled, non-zero
 962             otherwise. Prints the current enable status (see table).
 963             To suppress this output, use <option>--quiet</option>.
 964             </para>
 965
 966             <table>
 967               <title>
 968                 <command>is-enabled</command> output
 969               </title>
 970
 971               <tgroup cols='3'>
 972                 <thead>
 973                   <row>
 974                     <entry>Printed string</entry>
 975                     <entry>Meaning</entry>
 976                     <entry>Return value</entry>
 977                   </row>
 978                 </thead>
 979                 <tbody>
 980                   <row>
 981                     <entry><literal>enabled</literal></entry>
 982                     <entry morerows='1'>Enabled through a symlink in <filename>.wants</filename> directory (permanently or just in <filename>/run</filename>)</entry>
 983                     <entry morerows='1'>0</entry>
 984                   </row>
 985                   <row>
 986                     <entry><literal>enabled-runtime</literal></entry>
 987                   </row>
 988                   <row>
 989                     <entry><literal>linked</literal></entry>
 990                     <entry morerows='1'>Made available through a symlink to the unit file (permanently or just in <filename>/run</filename>)</entry>
 991                     <entry morerows='1'>1</entry>
 992                   </row>
 993                   <row>
 994                     <entry><literal>linked-runtime</literal></entry>
 995                   </row>
 996                   <row>
 997                     <entry><literal>masked</literal></entry>
 998                     <entry morerows='1'>Disabled entirely (permanently or just in <filename>/run</filename>)</entry>
 999                     <entry morerows='1'>1</entry>
1000                   </row>
1001                   <row>
1002                     <entry><literal>masked-runtime</literal></entry>
1003                   </row>
1004                   <row>
1005                     <entry><literal>static</literal></entry>
1006                     <entry>Unit is not enabled, but has no provisions for enabling in [Install] section</entry>
1007                     <entry>0</entry>
1008                   </row>
1009                   <row>
1010                     <entry><literal>disabled</literal></entry>
1011                     <entry>Unit is not enabled</entry>
1012                     <entry>1</entry>
1013                   </row>
1014                 </tbody>
1015               </tgroup>
1016             </table>
1017
1018           </listitem>
1019         </varlistentry>
1020
1021         <varlistentry>
1022           <term><command>reenable <replaceable>NAME</replaceable>...</command></term>
1023
1024           <listitem>
1025             <para>Reenable one or more unit files, as specified on the
1026             command line. This is a combination of
1027             <command>disable</command> and <command>enable</command> and
1028             is useful to reset the symlinks a unit is enabled with to
1029             the defaults configured in the <literal>[Install]</literal>
1030             section of the unit file.</para>
1031           </listitem>
1032         </varlistentry>
1033
1034         <varlistentry>
1035           <term><command>preset <replaceable>NAME</replaceable>...</command></term>
1036
1037           <listitem>
1038             <para>Reset one or more unit files, as specified on the
1039             command line, to the defaults configured in the preset
1040             policy files. This has the same effect as
1041             <command>disable</command> or <command>enable</command>,
1042             depending how the unit is listed in the preset files.</para>
1043
1044             <para>Use <option>--preset-mode=</option> to control
1045             whether units shall be enabled and disabled, or only
1046             enabled, or only disabled.</para>
1047
1048             <para>For more information on the preset policy format,
1049             see
1050             <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
1051             For more information on the concept of presets, please
1052             consult the <ulink
1053             url="http://freedesktop.org/wiki/Software/systemd/Preset">Preset</ulink>
1054             document.</para>
1055           </listitem>
1056         </varlistentry>
1057
1058         <varlistentry>
1059           <term><command>preset-all</command></term>
1060
1061           <listitem>
1062             <para>Resets all installed unit files to the defaults
1063             configured in the preset policy file (see above).</para>
1064
1065             <para>Use <option>--preset-mode=</option> to control
1066             whether units shall be enabled and disabled, or only
1067             enabled, or only disabled.</para>
1068           </listitem>
1069         </varlistentry>
1070
1071         <varlistentry>
1072           <term><command>mask <replaceable>NAME</replaceable>...</command></term>
1073
1074           <listitem>
1075             <para>Mask one or more unit files, as specified on the
1076             command line. This will link these units to
1077             <filename>/dev/null</filename>, making it impossible to
1078             start them. This is a stronger version of
1079             <command>disable</command>, since it prohibits all kinds of
1080             activation of the unit, including manual activation. Use
1081             this option with care. This honors the
1082             <option>--runtime</option> option to only mask temporarily
1083             until the next reboot of the system.</para>
1084           </listitem>
1085         </varlistentry>
1086
1087         <varlistentry>
1088           <term><command>unmask <replaceable>NAME</replaceable>...</command></term>
1089
1090           <listitem>
1091             <para>Unmask one or more unit files, as specified on the
1092             command line. This will undo the effect of
1093             <command>mask</command>.</para>
1094           </listitem>
1095         </varlistentry>
1096
1097         <varlistentry>
1098           <term><command>link <replaceable>FILENAME</replaceable>...</command></term>
1099
1100           <listitem>
1101             <para>Link a unit file that is not in the unit file search
1102             paths into the unit file search path. This requires an
1103             absolute path to a unit file. The effect of this can be
1104             undone with <command>disable</command>. The effect of this
1105             command is that a unit file is available for
1106             <command>start</command> and other commands although it
1107             is not installed directly in the unit search path.</para>
1108           </listitem>
1109         </varlistentry>
1110
1111         <varlistentry>
1112           <term><command>get-default</command></term>
1113
1114           <listitem>
1115             <para>Get the default target specified
1116             via <filename>default.target</filename> link.</para>
1117           </listitem>
1118         </varlistentry>
1119
1120         <varlistentry>
1121           <term><command>set-default <replaceable>NAME</replaceable></command></term>
1122
1123           <listitem>
1124             <para>Set the default target to boot into. Command links
1125             <filename>default.target</filename> to the given unit.</para>
1126           </listitem>
1127         </varlistentry>
1128       </variablelist>
1129     </refsect2>
1130
1131     <refsect2>
1132       <title>Machine Commands</title>
1133
1134       <variablelist>
1135         <varlistentry>
1136           <term><command>list-machines <optional><replaceable>PATTERN</replaceable>...</optional></command></term>
1137
1138           <listitem>
1139             <para>List the host and all running local containers with
1140             their state. If one or more
1141             <replaceable>PATTERN</replaceable>s are specified, only
1142             containers matching one of them are shown.
1143             </para>
1144           </listitem>
1145         </varlistentry>
1146       </variablelist>
1147     </refsect2>
1148
1149     <refsect2>
1150       <title>Job Commands</title>
1151
1152       <variablelist>
1153         <varlistentry>
1154           <term><command>list-jobs <optional><replaceable>PATTERN...</replaceable></optional></command></term>
1155
1156           <listitem>
1157             <para>List jobs that are in progress. If one or more
1158             <replaceable>PATTERN</replaceable>s are specified, only
1159             jobs for units matching one of them are shown.</para>
1160           </listitem>
1161         </varlistentry>
1162         <varlistentry>
1163           <term><command>cancel <replaceable>JOB</replaceable>...</command></term>
1164
1165           <listitem>
1166             <para>Cancel one or more jobs specified on the command line
1167             by their numeric job IDs. If no job ID is specified, cancel
1168             all pending jobs.</para>
1169           </listitem>
1170         </varlistentry>
1171       </variablelist>
1172     </refsect2>
1173
1174     <refsect2>
1175       <title>Snapshot Commands</title>
1176
1177       <variablelist>
1178         <varlistentry>
1179           <term><command>snapshot <optional><replaceable>NAME</replaceable></optional></command></term>
1180
1181           <listitem>
1182             <para>Create a snapshot. If a snapshot name is specified,
1183             the new snapshot will be named after it. If none is
1184             specified, an automatic snapshot name is generated. In
1185             either case, the snapshot name used is printed to standard
1186             output, unless <option>--quiet</option> is specified.
1187             </para>
1188
1189             <para>A snapshot refers to a saved state of the systemd
1190             manager. It is implemented itself as a unit that is
1191             generated dynamically with this command and has dependencies
1192             on all units active at the time. At a later time, the user
1193             may return to this state by using the
1194             <command>isolate</command> command on the snapshot unit.
1195             </para>
1196
1197             <para>Snapshots are only useful for saving and restoring
1198             which units are running or are stopped, they do not
1199             save/restore any other state. Snapshots are dynamic and lost
1200             on reboot.</para>
1201           </listitem>
1202         </varlistentry>
1203         <varlistentry>
1204           <term><command>delete <replaceable>PATTERN</replaceable>...</command></term>
1205
1206           <listitem>
1207             <para>Remove a snapshot previously created with
1208             <command>snapshot</command>.</para>
1209           </listitem>
1210         </varlistentry>
1211       </variablelist>
1212     </refsect2>
1213
1214     <refsect2>
1215       <title>Environment Commands</title>
1216
1217       <variablelist>
1218         <varlistentry>
1219           <term><command>show-environment</command></term>
1220
1221           <listitem>
1222             <para>Dump the systemd manager environment block. The
1223             environment block will be dumped in straight-forward form
1224             suitable for sourcing into a shell script. This environment
1225             block will be passed to all processes the manager
1226             spawns.</para>
1227           </listitem>
1228         </varlistentry>
1229         <varlistentry>
1230           <term><command>set-environment <replaceable>VARIABLE=VALUE</replaceable>...</command></term>
1231
1232           <listitem>
1233             <para>Set one or more systemd manager environment variables,
1234             as specified on the command line.</para>
1235           </listitem>
1236         </varlistentry>
1237         <varlistentry>
1238           <term><command>unset-environment <replaceable>VARIABLE</replaceable>...</command></term>
1239
1240           <listitem>
1241             <para>Unset one or more systemd manager environment
1242             variables. If only a variable name is specified, it will be
1243             removed regardless of its value. If a variable and a value
1244             are specified, the variable is only removed if it has the
1245             specified value.</para>
1246           </listitem>
1247         </varlistentry>
1248         <varlistentry>
1249           <term><command>import-environment <replaceable>VARIABLE</replaceable>...</command></term>
1250
1251           <listitem>
1252             <para>Import all, one or more environment variables set on
1253             the client into the systemd manager environment block. If
1254             no arguments are passed, the entire environment block is
1255             imported. Otherwise, a list of one or more environment
1256             variable names should be passed, whose client-side values
1257             are then imported into the manager's environment
1258             block.</para>
1259           </listitem>
1260         </varlistentry>
1261       </variablelist>
1262     </refsect2>
1263
1264     <refsect2>
1265       <title>Manager Lifecycle Commands</title>
1266
1267       <variablelist>
1268         <varlistentry>
1269           <term><command>daemon-reload</command></term>
1270
1271           <listitem>
1272             <para>Reload systemd manager configuration. This will reload
1273             all unit files and recreate the entire dependency
1274             tree. While the daemon is being reloaded, all sockets systemd
1275             listens on on behalf of user configuration will stay
1276             accessible.</para> <para>This command should not be confused
1277             with the <command>load</command> or
1278             <command>reload</command> commands.</para>
1279           </listitem>
1280         </varlistentry>
1281         <varlistentry>
1282           <term><command>daemon-reexec</command></term>
1283
1284           <listitem>
1285             <para>Reexecute the systemd manager. This will serialize the
1286             manager state, reexecute the process and deserialize the
1287             state again. This command is of little use except for
1288             debugging and package upgrades. Sometimes, it might be
1289             helpful as a heavy-weight <command>daemon-reload</command>.
1290             While the daemon is being reexecuted, all sockets systemd listening
1291             on behalf of user configuration will stay accessible.
1292             </para>
1293           </listitem>
1294         </varlistentry>
1295       </variablelist>
1296     </refsect2>
1297
1298     <refsect2>
1299       <title>System Commands</title>
1300
1301       <variablelist>
1302         <varlistentry>
1303           <term><command>default</command></term>
1304
1305           <listitem>
1306             <para>Enter default mode. This is mostly equivalent to
1307             <command>isolate default.target</command>.</para>
1308           </listitem>
1309         </varlistentry>
1310         <varlistentry>
1311           <term><command>rescue</command></term>
1312
1313           <listitem>
1314             <para>Enter rescue mode. This is mostly equivalent to
1315             <command>isolate rescue.target</command>, but also prints a
1316             wall message to all users.</para>
1317           </listitem>
1318         </varlistentry>
1319         <varlistentry>
1320           <term><command>emergency</command></term>
1321
1322           <listitem>
1323             <para>Enter emergency mode. This is mostly equivalent to
1324             <command>isolate emergency.target</command>, but also prints
1325             a wall message to all users.</para>
1326           </listitem>
1327         </varlistentry>
1328         <varlistentry>
1329           <term><command>halt</command></term>
1330
1331           <listitem>
1332             <para>Shut down and halt the system. This is mostly equivalent to
1333             <command>start halt.target --irreversible</command>, but also
1334             prints a wall message to all users.  If combined with
1335             <option>--force</option>, shutdown of all running services is
1336             skipped, however all processes are killed and all file
1337             systems are unmounted or mounted read-only, immediately
1338             followed by the system halt.  If <option>--force</option> is
1339             specified twice, the operation is immediately executed
1340             without terminating any processes or unmounting any file
1341             systems. This may result in data loss.</para>
1342           </listitem>
1343         </varlistentry>
1344         <varlistentry>
1345           <term><command>poweroff</command></term>
1346
1347           <listitem>
1348             <para>Shut down and power-off the system. This is mostly
1349             equivalent to <command>start poweroff.target --irreversible</command>,
1350             but also prints a wall message to all users. If combined with
1351             <option>--force</option>, shutdown of all running services is
1352             skipped, however all processes are killed and all file
1353             systems are unmounted or mounted read-only, immediately
1354             followed by the powering off. If <option>--force</option> is
1355             specified twice, the operation is immediately executed
1356             without terminating any processes or unmounting any file
1357             systems. This may result in data loss.</para>
1358           </listitem>
1359         </varlistentry>
1360         <varlistentry>
1361           <term><command>reboot <optional><replaceable>arg</replaceable></optional></command></term>
1362
1363           <listitem>
1364             <para>Shut down and reboot the system. This is mostly
1365             equivalent to <command>start reboot.target --irreversible</command>,
1366             but also prints a wall message to all users. If combined with
1367             <option>--force</option>, shutdown of all running services is
1368             skipped, however all processes are killed and all file
1369             systems are unmounted or mounted read-only, immediately
1370             followed by the reboot. If <option>--force</option> is
1371             specified twice, the operation is immediately executed
1372             without terminating any processes or unmounting any file
1373             systems. This may result in data loss.</para>
1374
1375             <para>If the optional argument
1376             <replaceable>arg</replaceable> is given, it will be passed
1377             as the optional argument to the
1378             <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1379             system call. The value is architecture and firmware
1380             specific. As an example, <literal>recovery</literal> might
1381             be used to trigger system recovery, and
1382             <literal>fota</literal> might be used to trigger a
1383             <quote>firmware over the air</quote> update.</para>
1384           </listitem>
1385         </varlistentry>
1386         <varlistentry>
1387           <term><command>kexec</command></term>
1388
1389           <listitem>
1390             <para>Shut down and reboot the system via kexec. This is
1391             mostly equivalent to <command>start kexec.target --irreversible</command>,
1392             but also prints a wall message to all users. If combined
1393             with <option>--force</option>, shutdown of all running
1394             services is skipped, however all processes are killed and
1395             all file systems are unmounted or mounted read-only,
1396             immediately followed by the reboot.</para>
1397           </listitem>
1398         </varlistentry>
1399         <varlistentry>
1400           <term><command>exit</command></term>
1401
1402           <listitem>
1403             <para>Ask the systemd manager to quit. This is only
1404             supported for user service managers (i.e. in conjunction
1405             with the <option>--user</option> option) and will fail
1406             otherwise.</para>
1407           </listitem>
1408
1409         </varlistentry>
1410         <varlistentry>
1411           <term><command>suspend</command></term>
1412
1413           <listitem>
1414             <para>Suspend the system. This will trigger activation of
1415             the special <filename>suspend.target</filename> target.
1416             </para>
1417           </listitem>
1418         </varlistentry>
1419         <varlistentry>
1420           <term><command>hibernate</command></term>
1421
1422           <listitem>
1423             <para>Hibernate the system. This will trigger activation of
1424             the special <filename>hibernate.target</filename> target.
1425             </para>
1426           </listitem>
1427         </varlistentry>
1428         <varlistentry>
1429           <term><command>hybrid-sleep</command></term>
1430
1431           <listitem>
1432             <para>Hibernate and suspend the system. This will trigger
1433             activation of the special
1434             <filename>hybrid-sleep.target</filename> target.</para>
1435           </listitem>
1436         </varlistentry>
1437         <varlistentry>
1438           <term><command>switch-root <replaceable>ROOT</replaceable> <optional><replaceable>INIT</replaceable></optional></command></term>
1439
1440           <listitem>
1441             <para>Switches to a different root directory and executes a
1442             new system manager process below it. This is intended for
1443             usage in initial RAM disks ("initrd"), and will transition
1444             from the initrd's system manager process (a.k.a "init"
1445             process) to the main system manager process. This call takes two
1446             arguments: the directory that is to become the new root directory, and
1447             the path to the new system manager binary below it to
1448             execute as PID 1. If the latter is omitted or the empty
1449             string, a systemd binary will automatically be searched for
1450             and used as init. If the system manager path is omitted or
1451             equal to the empty string, the state of the initrd's system
1452             manager process is passed to the main system manager, which
1453             allows later introspection of the state of the services
1454             involved in the initrd boot.</para>
1455           </listitem>
1456         </varlistentry>
1457       </variablelist>
1458     </refsect2>
1459
1460     <refsect2>
1461       <title>Parameter Syntax</title>
1462
1463       <para>Unit commands listed above take either a single unit name
1464       (designated as <replaceable>NAME</replaceable>), or multiple
1465       unit specifications (designated as
1466       <replaceable>PATTERN</replaceable>...). In the first case, the
1467       unit name with or without a suffix must be given. If the suffix
1468       is not specified, systemctl will append a suitable suffix,
1469       <literal>.service</literal> by default, and a type-specific
1470       suffix in case of commands which operate only on specific unit
1471       types. For example,
1472       <programlisting># systemctl start sshd</programlisting> and
1473       <programlisting># systemctl start sshd.service</programlisting>
1474       are equivalent, as are
1475       <programlisting># systemctl isolate snapshot-11</programlisting>
1476       and
1477       <programlisting># systemctl isolate snapshot-11.snapshot</programlisting>
1478       Note that (absolute) paths to device nodes are automatically
1479       converted to device unit names, and other (absolute) paths to
1480       mount unit names.
1481       <programlisting># systemctl status /dev/sda
1482 # systemctl status /home</programlisting>
1483       are equivalent to:
1484       <programlisting># systemctl status dev-sda.device
1485 # systemctl status home.mount</programlisting>
1486       In the second case, shell-style globs will be matched against
1487       currently loaded units; literal unit names, with or without
1488       a suffix, will be treated as in the first case. This means that
1489       literal unit names always refer to exactly one unit, but globs
1490       may match zero units and this is not considered an error.</para>
1491
1492       <para>Glob patterns use
1493       <citerefentry><refentrytitle>fnmatch</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
1494       so normal shell-style globbing rules are used, and
1495       <literal>*</literal>, <literal>?</literal>,
1496       <literal>[]</literal> may be used. See
1497       <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1498       for more details. The patterns are matched against the names of
1499       currently loaded units, and patterns which do not match anything
1500       are silently skipped. For example:
1501       <programlisting># systemctl stop sshd@*.service</programlisting>
1502       will stop all <filename>sshd@.service</filename> instances.
1503       </para>
1504
1505       <para>For unit file commands, the specified
1506       <replaceable>NAME</replaceable> should be the full name of the
1507       unit file, or the absolute path to the unit file:
1508       <programlisting># systemctl enable foo.service</programlisting>
1509       or
1510       <programlisting># systemctl link /path/to/foo.service</programlisting>
1511       </para>
1512     </refsect2>
1513
1514   </refsect1>
1515
1516   <refsect1>
1517     <title>Exit status</title>
1518
1519     <para>On success, 0 is returned, a non-zero failure
1520     code otherwise.</para>
1521   </refsect1>
1522
1523   <xi:include href="less-variables.xml" />
1524
1525   <refsect1>
1526     <title>See Also</title>
1527     <para>
1528       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1529       <citerefentry><refentrytitle>systemadm</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1530       <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1531       <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1532       <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1533       <citerefentry><refentrytitle>systemd.resource-management</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1534       <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
1535       <citerefentry><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
1536       <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1537       <citerefentry><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1538     </para>
1539   </refsect1>
1540
1541 </refentry>