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