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