1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>systemctl</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><style>
a.headerlink {
color: #c60f0f;
font-size: 0.8em;
padding: 0 4px 0 4px;
text-decoration: none;
visibility: hidden;
}
a.headerlink:hover {
background-color: #c60f0f;
color: white;
}
h1:hover > a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, dt:hover > a.headerlink {
visibility: visible;
}
</style><a href="index.html">Index </a>·
<a href="systemd.directives.html">Directives </a>·
<a href="../python-systemd/index.html">Python </a>·
<a href="../libudev/index.html">libudev </a>·
<a href="../libudev/index.html">gudev </a><span style="float:right">systemd 215</span><hr><div class="refentry"><a name="systemctl"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>systemctl — Control the systemd system and service manager</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">systemctl</code> [OPTIONS...] COMMAND [NAME...]</p></div></div><div class="refsect1"><a name="idm214173287904"></a><h2 id="Description">Description<a class="headerlink" title="Permalink to this headline" href="#Description">¶</a></h2><p><span class="command"><strong>systemctl</strong></span> may be used to
introspect and control the state of the
<a href="systemd.html"><span class="citerefentry"><span class="refentrytitle">systemd</span>(1)</span></a>
system and service manager.</p></div><div class="refsect1"><a name="idm214173285312"></a><h2 id="Options">Options<a class="headerlink" title="Permalink to this headline" href="#Options">¶</a></h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt id="-t"><span class="term"><code class="option">-t</code>, </span><span class="term"><code class="option">--type=</code></span><a class="headerlink" title="Permalink to this term" href="#-t">¶</a></dt><dd><p>The argument should be a comma-separated list of unit
types such as <code class="option">service</code> and
<code class="option">socket</code>.
</p><p>If one of the arguments is a unit type, when listing
units, limit display to certain unit types. Otherwise, units
of all types will be shown.</p><p>As a special case, if one of the arguments is
<code class="option">help</code>, a list of allowed values will be
printed and the program will exit.</p></dd><dt id="--state="><span class="term"><code class="option">--state=</code></span><a class="headerlink" title="Permalink to this term" href="#--state=">¶</a></dt><dd><p>The argument should be a comma-separated list of unit LOAD,
SUB, or ACTIVE states. When listing units, show only those
in specified states.</p></dd><dt id="-p"><span class="term"><code class="option">-p</code>, </span><span class="term"><code class="option">--property=</code></span><a class="headerlink" title="Permalink to this term" href="#-p">¶</a></dt><dd><p>When showing unit/job/manager properties with the
<span class="command"><strong>show</strong></span> command, limit display to certain
properties as specified as argument. If not specified, all
set properties are shown. The argument should be a
comma-separated list of property names, such as
"<code class="literal">MainPID</code>". If specified more than once, all
properties with the specified names are shown.</p></dd><dt id="-a"><span class="term"><code class="option">-a</code>, </span><span class="term"><code class="option">--all</code></span><a class="headerlink" title="Permalink to this term" href="#-a">¶</a></dt><dd><p>When listing units, show all loaded units, regardless
of their state, including inactive units. When showing
unit/job/manager properties, show all properties regardless
whether they are set or not.</p><p>To list all units installed on the system, use the
<span class="command"><strong>list-unit-files</strong></span> command instead.</p></dd><dt id="-r"><span class="term"><code class="option">-r</code>, </span><span class="term"><code class="option">--recursive</code></span><a class="headerlink" title="Permalink to this term" href="#-r">¶</a></dt><dd><p>When listing units, also show units of local
containers. Units of local containers will be prefixed with
the container name, separated by a single colon character
("<code class="literal">:</code>").</p></dd><dt id="--reverse"><span class="term"><code class="option">--reverse</code></span><a class="headerlink" title="Permalink to this term" href="#--reverse">¶</a></dt><dd><p>Show reverse dependencies between units with
<span class="command"><strong>list-dependencies</strong></span>, i.e. units with
dependencies of type <code class="varname">Wants=</code> or
<code class="varname">Requires=</code> on the given unit.
</p></dd><dt id="--after"><span class="term"><code class="option">--after</code></span><a class="headerlink" title="Permalink to this term" href="#--after">¶</a></dt><dd><p>With <span class="command"><strong>list-dependencies</strong></span>, show the
units that are ordered before the specified unit. In other
words, list the units that are in the <code class="varname">After=</code>
directive of the specified unit, have the specified unit in
their <code class="varname">Before=</code> directive, or are otherwise
implicit dependencies of the specified unit.</p></dd><dt id="--before"><span class="term"><code class="option">--before</code></span><a class="headerlink" title="Permalink to this term" href="#--before">¶</a></dt><dd><p>With <span class="command"><strong>list-dependencies</strong></span>, show the
units that are ordered after the specified unit. In other
words, list the units that are in the <code class="varname">Before=</code>
directive of the specified unit, have the specified unit in
their <code class="varname">After=</code> directive, or otherwise depend
on the specified unit.</p></dd><dt id="-l"><span class="term"><code class="option">-l</code>, </span><span class="term"><code class="option">--full</code></span><a class="headerlink" title="Permalink to this term" href="#-l">¶</a></dt><dd><p>Do not ellipsize unit names, process tree entries,
journal output, or truncate unit descriptions in the output
of <span class="command"><strong>status</strong></span>, <span class="command"><strong>list-units</strong></span>,
<span class="command"><strong>list-jobs</strong></span>, and
<span class="command"><strong>list-timers</strong></span>.</p></dd><dt id="--show-types"><span class="term"><code class="option">--show-types</code></span><a class="headerlink" title="Permalink to this term" href="#--show-types">¶</a></dt><dd><p>When showing sockets, show the type of the socket.</p></dd><dt id="--job-mode="><span class="term"><code class="option">--job-mode=</code></span><a class="headerlink" title="Permalink to this term" href="#--job-mode=">¶</a></dt><dd><p>When queuing a new job, this option controls how to deal with
already queued jobs. It takes one of "<code class="literal">fail</code>",
"<code class="literal">replace</code>",
"<code class="literal">replace-irreversibly</code>",
"<code class="literal">isolate</code>",
"<code class="literal">ignore-dependencies</code>",
"<code class="literal">ignore-requirements</code>" or
"<code class="literal">flush</code>". Defaults to
"<code class="literal">replace</code>", except when the
<span class="command"><strong>isolate</strong></span> command is used which implies the
"<code class="literal">isolate</code>" job mode.</p><p>If "<code class="literal">fail</code>" is specified and a requested
operation conflicts with a pending job (more specifically:
causes an already pending start job to be reversed into a stop
job or vice versa), cause the operation to fail.</p><p>If "<code class="literal">replace</code>" (the default) is
specified, any conflicting pending job will be replaced, as
necessary.</p><p>If "<code class="literal">replace-irreversibly</code>" is specified,
operate like "<code class="literal">replace</code>", but also mark the new
jobs as irreversible. This prevents future conflicting
transactions from replacing these jobs (or even being enqueued
while the irreversible jobs are still pending). Irreversible
jobs can still be cancelled using the <span class="command"><strong>cancel</strong></span>
command.</p><p>"<code class="literal">isolate</code>" is only valid for start
operations and causes all other units to be stopped when the
specified unit is started. This mode is always used when the
<span class="command"><strong>isolate</strong></span> command is used.</p><p>"<code class="literal">flush</code>" will cause all queued jobs to
be canceled when the new job is enqueued.</p><p>If "<code class="literal">ignore-dependencies</code>" is specified,
then all unit dependencies are ignored for this new job and
the operation is executed immediately. If passed, no required
units of the unit passed will be pulled in, and no ordering
dependencies will be honored. This is mostly a debugging and
rescue tool for the administrator and should not be used by
applications.</p><p>"<code class="literal">ignore-requirements</code>" is similar to
"<code class="literal">ignore-dependencies</code>", but only causes the
requirement dependencies to be ignored, the ordering
dependencies will still be honoured.</p></dd><dt id="-i"><span class="term"><code class="option">-i</code>, </span><span class="term"><code class="option">--ignore-inhibitors</code></span><a class="headerlink" title="Permalink to this term" href="#-i">¶</a></dt><dd><p>When system shutdown or a sleep state is requested,
ignore inhibitor locks. Applications can establish inhibitor
locks to avoid that certain important operations (such as CD
burning or suchlike) are interrupted by system shutdown or a
sleep state. Any user may take these locks and privileged
users may override these locks. If any locks are taken,
shutdown and sleep state requests will normally fail
(regardless of whether privileged or not) and a list of active locks
is printed. However, if <code class="option">--ignore-inhibitors</code>
is specified, the locks are ignored and not printed, and the
operation attempted anyway, possibly requiring additional
privileges.</p></dd><dt id="-q"><span class="term"><code class="option">-q</code>, </span><span class="term"><code class="option">--quiet</code></span><a class="headerlink" title="Permalink to this term" href="#-q">¶</a></dt><dd><p>Suppress output to standard output in
<span class="command"><strong>snapshot</strong></span>,
<span class="command"><strong>is-active</strong></span>,
<span class="command"><strong>is-failed</strong></span>,
<span class="command"><strong>is-enabled</strong></span>,
<span class="command"><strong>is-system-running</strong></span>,
<span class="command"><strong>enable</strong></span> and
<span class="command"><strong>disable</strong></span>.</p></dd><dt id="--no-block"><span class="term"><code class="option">--no-block</code></span><a class="headerlink" title="Permalink to this term" href="#--no-block">¶</a></dt><dd><p>Do not synchronously wait for the requested operation
to finish. If this is not specified, the job will be
verified, enqueued and <span class="command"><strong>systemctl</strong></span> will
wait until it is completed. By passing this argument, it is
only verified and enqueued.</p></dd><dt id="--no-legend"><span class="term"><code class="option">--no-legend</code></span><a class="headerlink" title="Permalink to this term" href="#--no-legend">¶</a></dt><dd><p>Do not print the legend, i.e. the column headers and
the footer with hints.</p></dd><dt id="--user"><span class="term"><code class="option">--user</code></span><a class="headerlink" title="Permalink to this term" href="#--user">¶</a></dt><dd><p><a name="user-text"></a>Talk to the service manager of the calling user,
rather than the service manager of the system.</p></dd><dt id="--system"><span class="term"><code class="option">--system</code></span><a class="headerlink" title="Permalink to this term" href="#--system">¶</a></dt><dd><p><a name="system-text"></a>Talk to the service manager of the system. This is the
implied default.</p></dd><dt id="--no-wall"><span class="term"><code class="option">--no-wall</code></span><a class="headerlink" title="Permalink to this term" href="#--no-wall">¶</a></dt><dd><p>Do not send wall message before halt, power-off,
reboot.</p></dd><dt id="--global"><span class="term"><code class="option">--global</code></span><a class="headerlink" title="Permalink to this term" href="#--global">¶</a></dt><dd><p>When used with <span class="command"><strong>enable</strong></span> and
<span class="command"><strong>disable</strong></span>, operate on the global user
configuration directory, thus enabling or disabling a unit
file globally for all future logins of all users.</p></dd><dt id="--no-reload"><span class="term"><code class="option">--no-reload</code></span><a class="headerlink" title="Permalink to this term" href="#--no-reload">¶</a></dt><dd><p>When used with <span class="command"><strong>enable</strong></span> and
<span class="command"><strong>disable</strong></span>, do not implicitly reload daemon
configuration after executing the changes.</p></dd><dt id="--no-ask-password"><span class="term"><code class="option">--no-ask-password</code></span><a class="headerlink" title="Permalink to this term" href="#--no-ask-password">¶</a></dt><dd><p>When used with <span class="command"><strong>start</strong></span> and related
commands, disables asking for passwords. Background services
may require input of a password or passphrase string, for
example to unlock system hard disks or cryptographic
certificates. Unless this option is specified and the
command is invoked from a terminal,
<span class="command"><strong>systemctl</strong></span> will query the user on the
terminal for the necessary secrets. Use this option to
switch this behavior off. In this case, the password must be
supplied by some other means (for example graphical password
agents) or the service might fail. This also disables
querying the user for authentication for privileged
operations.</p></dd><dt id="--kill-who="><span class="term"><code class="option">--kill-who=</code></span><a class="headerlink" title="Permalink to this term" href="#--kill-who=">¶</a></dt><dd><p>When used with <span class="command"><strong>kill</strong></span>, choose which
processes to send a signal to. Must be one of
<code class="option">main</code>, <code class="option">control</code> or
<code class="option">all</code> to select whether to kill only the main
process, the control process or all processes of the
unit. The main process of the unit is the one that defines
the life-time of it. A control process of a unit is one that
is invoked by the manager to induce state changes of it. For
example, all processes started due to the
<code class="varname">ExecStartPre=</code>,
<code class="varname">ExecStop=</code> or
<code class="varname">ExecReload=</code> settings of service units are
control processes. Note that there is only one control
process per unit at a time, as only one state change is
executed at a time. For services of type
<code class="varname">Type=forking</code>, the initial process started
by the manager for <code class="varname">ExecStart=</code> is a
control process, while the process ultimately forked off by
that one is then considered the main process of the unit (if
it can be determined). This is different for service units
of other types, where the process forked off by the manager
for <code class="varname">ExecStart=</code> is always the main process
itself. A service unit consists of zero or one main process,
zero or one control process plus any number of additional
processes. Not all unit types manage processes of these
types however. For example, for mount units, control processes
are defined (which are the invocations of
<code class="filename">/usr/bin/mount</code> and
<code class="filename">/usr/bin/umount</code>), but no main process
is defined. If omitted, defaults to
<code class="option">all</code>.</p></dd><dt id="-s"><span class="term"><code class="option">-s</code>, </span><span class="term"><code class="option">--signal=</code></span><a class="headerlink" title="Permalink to this term" href="#-s">¶</a></dt><dd><p>When used with <span class="command"><strong>kill</strong></span>, choose which
signal to send to selected processes. Must be one of the
well known signal specifiers such as <code class="constant">SIGTERM</code>, <code class="constant">SIGINT</code> or
<code class="constant">SIGSTOP</code>. If omitted, defaults to
<code class="option">SIGTERM</code>.</p></dd><dt id="-f"><span class="term"><code class="option">-f</code>, </span><span class="term"><code class="option">--force</code></span><a class="headerlink" title="Permalink to this term" href="#-f">¶</a></dt><dd><p>When used with <span class="command"><strong>enable</strong></span>, overwrite
any existing conflicting symlinks.</p><p>When used with <span class="command"><strong>halt</strong></span>,
<span class="command"><strong>poweroff</strong></span>, <span class="command"><strong>reboot</strong></span> or
<span class="command"><strong>kexec</strong></span>, execute the selected operation
without shutting down all units. However, all processes will
be killed forcibly and all file systems are unmounted or
remounted read-only. This is hence a drastic but relatively
safe option to request an immediate reboot. If
<code class="option">--force</code> is specified twice for these
operations, they will be executed immediately without
terminating any processes or unmounting any file
systems. Warning: specifying <code class="option">--force</code> twice
with any of these operations might result in data
loss.</p></dd><dt id="--root="><span class="term"><code class="option">--root=</code></span><a class="headerlink" title="Permalink to this term" href="#--root=">¶</a></dt><dd><p>When used with
<span class="command"><strong>enable</strong></span>/<span class="command"><strong>disable</strong></span>/<span class="command"><strong>is-enabled</strong></span>
(and related commands), use alternative root path when
looking for unit files.</p></dd><dt id="--runtime"><span class="term"><code class="option">--runtime</code></span><a class="headerlink" title="Permalink to this term" href="#--runtime">¶</a></dt><dd><p>When used with <span class="command"><strong>enable</strong></span>,
<span class="command"><strong>disable</strong></span>,
(and related commands), make changes only temporarily, so
that they are lost on the next reboot. This will have the
effect that changes are not made in subdirectories of
<code class="filename">/etc</code> but in <code class="filename">/run</code>,
with identical immediate effects, however, since the latter
is lost on reboot, the changes are lost too.</p><p>Similarly, when used with
<span class="command"><strong>set-property</strong></span>, make changes only
temporarily, so that they are lost on the next
reboot.</p></dd><dt id="--preset-mode="><span class="term"><code class="option">--preset-mode=</code></span><a class="headerlink" title="Permalink to this term" href="#--preset-mode=">¶</a></dt><dd><p>Takes one of "<code class="literal">full</code>" (the default),
"<code class="literal">enable-only</code>",
"<code class="literal">disable-only</code>". When used with the
<span class="command"><strong>preset</strong></span> or <span class="command"><strong>preset-all</strong></span>
commands, controls whether units shall be disabled and
enabled according to the preset rules, or only enabled, or
only disabled.</p></dd><dt id="-n"><span class="term"><code class="option">-n</code>, </span><span class="term"><code class="option">--lines=</code></span><a class="headerlink" title="Permalink to this term" href="#-n">¶</a></dt><dd><p>When used with <span class="command"><strong>status</strong></span>, controls the
number of journal lines to show, counting from the most
recent ones. Takes a positive integer argument. Defaults to
10.</p></dd><dt id="-o"><span class="term"><code class="option">-o</code>, </span><span class="term"><code class="option">--output=</code></span><a class="headerlink" title="Permalink to this term" href="#-o">¶</a></dt><dd><p>When used with <span class="command"><strong>status</strong></span>, controls the
formatting of the journal entries that are shown. For the
available choices, see
<a href="journalctl.html"><span class="citerefentry"><span class="refentrytitle">journalctl</span>(1)</span></a>.
Defaults to "<code class="literal">short</code>".</p></dd><dt id="--plain"><span class="term"><code class="option">--plain</code></span><a class="headerlink" title="Permalink to this term" href="#--plain">¶</a></dt><dd><p>When used with <span class="command"><strong>list-dependencies</strong></span>,
the output is printed as a list instead of a tree.</p></dd><dt id="-H"><span class="term"><code class="option">-H</code>, </span><span class="term"><code class="option">--host=</code></span><a class="headerlink" title="Permalink to this term" href="#-H">¶</a></dt><dd><p><a name="host-text"></a>Execute the operation remotely. Specify a hostname, or a
username and hostname separated by "<code class="literal">@</code>", to
connect to. The hostname may optionally be suffixed by a
container name, separated by "<code class="literal">:</code>", which
connects directly to a specific container on the specified
host. This will use SSH to talk to the remote machine manager
instance. Container names may be enumerated with
<span class="command"><strong>machinectl -H
<em class="replaceable"><code>HOST</code></em></strong></span>.</p></dd><dt id="-M"><span class="term"><code class="option">-M</code>, </span><span class="term"><code class="option">--machine=</code></span><a class="headerlink" title="Permalink to this term" href="#-M">¶</a></dt><dd><p><a name="machine-text"></a>Execute operation on a local container. Specify a
container name to connect to.</p></dd><dt id="-h"><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span><a class="headerlink" title="Permalink to this term" href="#-h">¶</a></dt><dd><p><a name="help-text"></a>Print a short help text and exit.
</p></dd><dt id="--version"><span class="term"><code class="option">--version</code></span><a class="headerlink" title="Permalink to this term" href="#--version">¶</a></dt><dd><p><a name="version-text"></a>Print a short version string and exit.</p></dd><dt id="--no-pager"><span class="term"><code class="option">--no-pager</code></span><a class="headerlink" title="Permalink to this term" href="#--no-pager">¶</a></dt><dd><p>Do not pipe output into a pager.</p></dd></dl></div></div><div class="refsect1"><a name="idm214168669712"></a><h2 id="Commands">Commands<a class="headerlink" title="Permalink to this headline" href="#Commands">¶</a></h2><p>The following commands are understood:</p><div class="refsect2"><a name="idm214168668688"></a><h3 id="Unit Commands">Unit Commands<a class="headerlink" title="Permalink to this headline" href="#Unit%20Commands">¶</a></h3><div class="variablelist"><dl class="variablelist"><dt id="list-units PATTERN..."><span class="term"><span class="command"><strong>list-units [<span class="optional"><em class="replaceable"><code>PATTERN</code></em>...</span>]</strong></span></span><a class="headerlink" title="Permalink to this term" href="#list-units%20PATTERN...">¶</a></dt><dd><p>List known units (subject to limitations specified
with <code class="option">-t</code>). If one or more
<em class="replaceable"><code>PATTERN</code></em>s are specified, only
units matching one of them are shown.</p><p>This is the default command.</p></dd><dt id="list-sockets PATTERN..."><span class="term"><span class="command"><strong>list-sockets [<span class="optional"><em class="replaceable"><code>PATTERN</code></em>...</span>]</strong></span></span><a class="headerlink" title="Permalink to this term" href="#list-sockets%20PATTERN...">¶</a></dt><dd><p>List socket units ordered by listening address.
If one or more <em class="replaceable"><code>PATTERN</code></em>s are
specified, only socket units matching one of them are
shown. Produces output similar to
</p><pre class="programlisting">
LISTEN UNIT ACTIVATES
/dev/initctl systemd-initctl.socket systemd-initctl.service
...
[::]:22 sshd.socket sshd.service
kobject-uevent 1 systemd-udevd-kernel.socket systemd-udevd.service
5 sockets listed.</pre><p>
Note: because the addresses might contains spaces, this output
is not suitable for programmatic consumption.
</p><p>See also the options <code class="option">--show-types</code>,
<code class="option">--all</code>, and <code class="option">--failed</code>.</p></dd><dt id="list-timers PATTERN..."><span class="term"><span class="command"><strong>list-timers [<span class="optional"><em class="replaceable"><code>PATTERN</code></em>...</span>]</strong></span></span><a class="headerlink" title="Permalink to this term" href="#list-timers%20PATTERN...">¶</a></dt><dd><p>List timer units ordered by the time they elapse
next. If one or more <em class="replaceable"><code>PATTERN</code></em>s
are specified, only units matching one of them are shown.
</p><p>See also the options <code class="option">--all</code> and
<code class="option">--failed</code>.</p></dd><dt id="start PATTERN..."><span class="term"><span class="command"><strong>start <em class="replaceable"><code>PATTERN</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#start%20PATTERN...">¶</a></dt><dd><p>Start (activate) one or more units specified on the
command line.</p><p>Note that glob patterns operate on a list of currently
loaded units. Units which are not active and are not in a
failed state usually are not loaded, and would not be
matched by any pattern. In addition, in case of
instantiated units, systemd is often unaware of the
instance name until the instance has been started. Therefore,
using glob patterns with <span class="command"><strong>start</strong></span>
has limited usefulness.</p></dd><dt id="stop PATTERN..."><span class="term"><span class="command"><strong>stop <em class="replaceable"><code>PATTERN</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#stop%20PATTERN...">¶</a></dt><dd><p>Stop (deactivate) one or more units specified on the
command line.</p></dd><dt id="reload PATTERN..."><span class="term"><span class="command"><strong>reload <em class="replaceable"><code>PATTERN</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#reload%20PATTERN...">¶</a></dt><dd><p>Asks all units listed on the command line to reload
their configuration. Note that this will reload the
service-specific configuration, not the unit configuration
file of systemd. If you want systemd to reload the
configuration file of a unit, use the
<span class="command"><strong>daemon-reload</strong></span> command. In other words:
for the example case of Apache, this will reload Apache's
<code class="filename">httpd.conf</code> in the web server, not the
<code class="filename">apache.service</code> systemd unit
file.</p><p>This command should not be confused with the
<span class="command"><strong>daemon-reload</strong></span> or <span class="command"><strong>load</strong></span>
commands.</p></dd><dt id="restart PATTERN..."><span class="term"><span class="command"><strong>restart <em class="replaceable"><code>PATTERN</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#restart%20PATTERN...">¶</a></dt><dd><p>Restart one or more units specified on the command
line. If the units are not running yet, they will be
started.</p></dd><dt id="try-restart PATTERN..."><span class="term"><span class="command"><strong>try-restart <em class="replaceable"><code>PATTERN</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#try-restart%20PATTERN...">¶</a></dt><dd><p>Restart one or more units specified on the command
line if the units are running. This does nothing if units are not
running. Note that, for compatibility with Red Hat init
scripts, <span class="command"><strong>condrestart</strong></span> is equivalent to this
command.</p></dd><dt id="reload-or-restart PATTERN..."><span class="term"><span class="command"><strong>reload-or-restart <em class="replaceable"><code>PATTERN</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#reload-or-restart%20PATTERN...">¶</a></dt><dd><p>Reload one or more units if they support it. If not,
restart them instead. If the units are not running yet, they
will be started.</p></dd><dt id="reload-or-try-restart PATTERN..."><span class="term"><span class="command"><strong>reload-or-try-restart <em class="replaceable"><code>PATTERN</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#reload-or-try-restart%20PATTERN...">¶</a></dt><dd><p>Reload one or more units if they support it. If not,
restart them instead. This does nothing if the units are not
running. Note that, for compatibility with SysV init scripts,
<span class="command"><strong>force-reload</strong></span> is equivalent to this
command.</p></dd><dt id="isolate NAME"><span class="term"><span class="command"><strong>isolate <em class="replaceable"><code>NAME</code></em></strong></span></span><a class="headerlink" title="Permalink to this term" href="#isolate%20NAME">¶</a></dt><dd><p>Start the unit specified on the command line and its
dependencies and stop all others.</p><p>This is similar to changing the runlevel in a
traditional init system. The <span class="command"><strong>isolate</strong></span>
command will immediately stop processes that are not enabled
in the new unit, possibly including the graphical
environment or terminal you are currently using.</p><p>Note that this is allowed only on units where
<code class="option">AllowIsolate=</code> is enabled. See
<a href="systemd.unit.html"><span class="citerefentry"><span class="refentrytitle">systemd.unit</span>(5)</span></a>
for details.</p></dd><dt id="kill PATTERN..."><span class="term"><span class="command"><strong>kill <em class="replaceable"><code>PATTERN</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#kill%20PATTERN...">¶</a></dt><dd><p>Send a signal to one or more processes of the
unit. Use <code class="option">--kill-who=</code> to select which
process to kill. Use <code class="option">--signal=</code> to select
the signal to send.</p></dd><dt id="is-active PATTERN..."><span class="term"><span class="command"><strong>is-active <em class="replaceable"><code>PATTERN</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#is-active%20PATTERN...">¶</a></dt><dd><p>Check whether any of the specified units are active
(i.e. running). Returns an exit code
<code class="constant">0</code> if at least one is active, or
non-zero otherwise. Unless <code class="option">--quiet</code> is
specified, this will also print the current unit state to
standard output.</p></dd><dt id="is-failed PATTERN..."><span class="term"><span class="command"><strong>is-failed <em class="replaceable"><code>PATTERN</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#is-failed%20PATTERN...">¶</a></dt><dd><p>Check whether any of the specified units are in a
"failed" state. Returns an exit code
<code class="constant">0</code> if at least one has failed,
non-zero otherwise. Unless <code class="option">--quiet</code> is
specified, this will also print the current unit state to
standard output.</p></dd><dt id="status PATTERN...|PID...]"><span class="term"><span class="command"><strong>status</strong></span> [<span class="optional"><em class="replaceable"><code>PATTERN</code></em>...|<em class="replaceable"><code>PID</code></em>...]</span>]</span><a class="headerlink" title="Permalink to this term" href="#status%20PATTERN...%7CPID...%5D">¶</a></dt><dd><p>Show terse runtime status information about one or
more units, followed by most recent log data from the
journal. If no units are specified, show system status. If
combined with <code class="option">--all</code>, also show the status of
all units (subject to limitations specified with
<code class="option">-t</code>). If a PID is passed, show information
about the unit the process belongs to.</p><p>This function is intended to generate human-readable
output. If you are looking for computer-parsable output,
use <span class="command"><strong>show</strong></span> instead. By default this
function only shows 10 lines of output and ellipsizes
lines to fit in the terminal window. This can be changes
with <code class="option">--lines</code> and <code class="option">--full</code>,
see above. In addition, <span class="command"><strong>journalctl
--unit=<em class="replaceable"><code>NAME</code></em></strong></span> or
<span class="command"><strong>journalctl
--user-unit=<em class="replaceable"><code>NAME</code></em></strong></span> use
a similar filter for messages and might be more
convenient.
</p></dd><dt id="show PATTERN...|JOB..."><span class="term"><span class="command"><strong>show</strong></span> [<span class="optional"><em class="replaceable"><code>PATTERN</code></em>...|<em class="replaceable"><code>JOB</code></em>...</span>]</span><a class="headerlink" title="Permalink to this term" href="#show%20PATTERN...%7CJOB...">¶</a></dt><dd><p>Show properties of one or more units, jobs, or the
manager itself. If no argument is specified, properties of
the manager will be shown. If a unit name is specified,
properties of the unit is shown, and if a job id is
specified, properties of the job is shown. By default, empty
properties are suppressed. Use <code class="option">--all</code> to
show those too. To select specific properties to show, use
<code class="option">--property=</code>. This command is intended to be
used whenever computer-parsable output is required. Use
<span class="command"><strong>status</strong></span> if you are looking for formatted
human-readable output.</p></dd><dt id="cat PATTERN..."><span class="term"><span class="command"><strong>cat <em class="replaceable"><code>PATTERN</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#cat%20PATTERN...">¶</a></dt><dd><p>Show backing files of one or more units. Prints the
"fragment" and "drop-ins" (source files) of units. Each
file is preceded by a comment which includes the file
name.</p></dd><dt id="set-property NAME ASSIGNMENT..."><span class="term"><span class="command"><strong>set-property <em class="replaceable"><code>NAME</code></em> <em class="replaceable"><code>ASSIGNMENT</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#set-property%20NAME%20ASSIGNMENT...">¶</a></dt><dd><p>Set the specified unit properties at runtime where
this is supported. This allows changing configuration
parameter properties such as resource control settings at
runtime. Not all properties may be changed at runtime, but
many resource control settings (primarily those in
<a href="systemd.resource-control.html"><span class="citerefentry"><span class="refentrytitle">systemd.resource-control</span>(5)</span></a>)
may. The changes are applied instantly, and stored on disk
for future boots, unless <code class="option">--runtime</code> is
passed, in which case the settings only apply until the
next reboot. The syntax of the property assignment follows
closely the syntax of assignments in unit files.</p><p>Example: <span class="command"><strong>systemctl set-property foobar.service CPUShares=777</strong></span></p><p>Note that this command allows changing multiple
properties at the same time, which is preferable over
setting them individually. Like unit file configuration
settings, assigning the empty list to list parameters will
reset the list.</p></dd><dt id="help PATTERN...|PID..."><span class="term"><span class="command"><strong>help <em class="replaceable"><code>PATTERN</code></em>...|<em class="replaceable"><code>PID</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#help%20PATTERN...%7CPID...">¶</a></dt><dd><p>Show manual pages for one or more units, if
available. If a PID is given, the manual pages for the unit
the process belongs to are shown.</p></dd><dt id="reset-failed [PATTERN...]"><span class="term"><span class="command"><strong>reset-failed [<em class="replaceable"><code>PATTERN</code></em>...]</strong></span></span><a class="headerlink" title="Permalink to this term" href="#reset-failed%20%5BPATTERN...%5D">¶</a></dt><dd><p>Reset the "<code class="literal">failed</code>" state of the
specified units, or if no unit name is passed, reset the state of all
units. When a unit fails in some way (i.e. process exiting
with non-zero error code, terminating abnormally or timing
out), it will automatically enter the
"<code class="literal">failed</code>" state and its exit code and status
is recorded for introspection by the administrator until the
service is restarted or reset with this command.</p></dd><dt id="list-dependencies NAME"><span class="term"><span class="command"><strong>list-dependencies <em class="replaceable"><code>NAME</code></em></strong></span></span><a class="headerlink" title="Permalink to this term" href="#list-dependencies%20NAME">¶</a></dt><dd><p>Shows required and wanted units of the specified
unit. If no unit is specified,
<code class="filename">default.target</code> is implied. Target units
are recursively expanded. When <code class="option">--all</code> is
passed, all other units are recursively expanded as
well.</p></dd></dl></div></div><div class="refsect2"><a name="idm214168583040"></a><h3 id="Unit File Commands">Unit File Commands<a class="headerlink" title="Permalink to this headline" href="#Unit%20File%20Commands">¶</a></h3><div class="variablelist"><dl class="variablelist"><dt id="list-unit-files PATTERN..."><span class="term"><span class="command"><strong>list-unit-files [<span class="optional"><em class="replaceable"><code>PATTERN...</code></em></span>]</strong></span></span><a class="headerlink" title="Permalink to this term" href="#list-unit-files%20PATTERN...">¶</a></dt><dd><p>List installed unit files. If one or more
<em class="replaceable"><code>PATTERN</code></em>s are specified, only
units whose filename (just the last component of the path)
matches one of them are shown.</p></dd><dt id="enable NAME..."><span class="term"><span class="command"><strong>enable <em class="replaceable"><code>NAME</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#enable%20NAME...">¶</a></dt><dd><p>Enable one or more unit files or unit file instances,
as specified on the command line. This will create a number
of symlinks as encoded in the "<code class="literal">[Install]</code>"
sections of the unit files. After the symlinks have been
created, the systemd configuration is reloaded (in a way that
is equivalent to <span class="command"><strong>daemon-reload</strong></span>) to ensure
the changes are taken into account immediately. Note that
this does <span class="emphasis"><em>not</em></span> have the effect of also
starting any of the units being enabled. If this
is desired, a separate <span class="command"><strong>start</strong></span> command must
be invoked for the unit. Also note that in case of instance
enablement, symlinks named the same as instances are created in
the install location, however they all point to the same
template unit file.</p><p>This command will print the actions executed. This
output may be suppressed by passing <code class="option">--quiet</code>.
</p><p>Note that this operation creates only the suggested
symlinks for the units. While this command is the
recommended way to manipulate the unit configuration
directory, the administrator is free to make additional
changes manually by placing or removing symlinks in the
directory. This is particularly useful to create
configurations that deviate from the suggested default
installation. In this case, the administrator must make sure
to invoke <span class="command"><strong>daemon-reload</strong></span> manually as
necessary to ensure the changes are taken into account.
</p><p>Enabling units should not be confused with starting
(activating) units, as done by the <span class="command"><strong>start</strong></span>
command. Enabling and starting units is orthogonal: units
may be enabled without being started and started without
being enabled. Enabling simply hooks the unit into various
suggested places (for example, so that the unit is
automatically started on boot or when a particular kind of
hardware is plugged in). Starting actually spawns the daemon
process (in case of service units), or binds the socket (in
case of socket units), and so on.</p><p>Depending on whether <code class="option">--system</code>,
<code class="option">--user</code>, <code class="option">--runtime</code>,
or <code class="option">--global</code> is specified, this enables the unit
for the system, for the calling user only, for only this boot of
the system, or for all future logins of all users, or only this
boot. Note that in the last case, no systemd daemon
configuration is reloaded.</p></dd><dt id="disable NAME..."><span class="term"><span class="command"><strong>disable <em class="replaceable"><code>NAME</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#disable%20NAME...">¶</a></dt><dd><p>Disables one or more units. This removes all symlinks
to the specified unit files from the unit configuration
directory, and hence undoes the changes made by
<span class="command"><strong>enable</strong></span>. Note however that this removes
all symlinks to the unit files (i.e. including manual
additions), not just those actually created by
<span class="command"><strong>enable</strong></span>. This call implicitly reloads the
systemd daemon configuration after completing the disabling
of the units. Note that this command does not implicitly
stop the units that are being disabled. If this is desired,
an additional <span class="command"><strong>stop</strong></span> command should be
executed afterwards.</p><p>This command will print the actions executed. This
output may be suppressed by passing <code class="option">--quiet</code>.
</p><p>This command honors <code class="option">--system</code>,
<code class="option">--user</code>, <code class="option">--runtime</code> and
<code class="option">--global</code> in a similar way as
<span class="command"><strong>enable</strong></span>.</p></dd><dt id="is-enabled NAME..."><span class="term"><span class="command"><strong>is-enabled <em class="replaceable"><code>NAME</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#is-enabled%20NAME...">¶</a></dt><dd><p>Checks whether any of the specified unit files are
enabled (as with <span class="command"><strong>enable</strong></span>). Returns an
exit code of 0 if at least one is enabled, non-zero
otherwise. Prints the current enable status (see table).
To suppress this output, use <code class="option">--quiet</code>.
</p><div class="table"><a name="idm214168555792"></a><p class="title"><b>Table 1.
<span class="command">is-enabled</span> output
</b></p><div class="table-contents"><table summary="
is-enabled output
" border="1"><colgroup><col><col><col></colgroup><thead><tr><th>Printed string</th><th>Meaning</th><th>Return value</th></tr></thead><tbody><tr><td>"<code class="literal">enabled</code>"</td><td rowspan="2">Enabled through a symlink in <code class="filename">.wants</code> directory (permanently or just in <code class="filename">/run</code>)</td><td rowspan="2">0</td></tr><tr><td>"<code class="literal">enabled-runtime</code>"</td></tr><tr><td>"<code class="literal">linked</code>"</td><td rowspan="2">Made available through a symlink to the unit file (permanently or just in <code class="filename">/run</code>)</td><td rowspan="2">1</td></tr><tr><td>"<code class="literal">linked-runtime</code>"</td></tr><tr><td>"<code class="literal">masked</code>"</td><td rowspan="2">Disabled entirely (permanently or just in <code class="filename">/run</code>)</td><td rowspan="2">1</td></tr><tr><td>"<code class="literal">masked-runtime</code>"</td></tr><tr><td>"<code class="literal">static</code>"</td><td>Unit is not enabled, but has no provisions for enabling in [Install] section</td><td>0</td></tr><tr><td>"<code class="literal">disabled</code>"</td><td>Unit is not enabled</td><td>1</td></tr></tbody></table></div></div><br class="table-break"></dd><dt id="reenable NAME..."><span class="term"><span class="command"><strong>reenable <em class="replaceable"><code>NAME</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#reenable%20NAME...">¶</a></dt><dd><p>Reenable one or more unit files, as specified on the
command line. This is a combination of
<span class="command"><strong>disable</strong></span> and <span class="command"><strong>enable</strong></span> and
is useful to reset the symlinks a unit is enabled with to
the defaults configured in the "<code class="literal">[Install]</code>"
section of the unit file.</p></dd><dt id="preset NAME..."><span class="term"><span class="command"><strong>preset <em class="replaceable"><code>NAME</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#preset%20NAME...">¶</a></dt><dd><p>Reset one or more unit files, as specified on the
command line, to the defaults configured in the preset
policy files. This has the same effect as
<span class="command"><strong>disable</strong></span> or <span class="command"><strong>enable</strong></span>,
depending how the unit is listed in the preset files.</p><p>Use <code class="option">--preset-mode=</code> to control
whether units shall be enabled and disabled, or only
enabled, or only disabled.</p><p>For more information on the preset policy format,
see
<a href="systemd.preset.html"><span class="citerefentry"><span class="refentrytitle">systemd.preset</span>(5)</span></a>.
For more information on the concept of presets, please
consult the <a class="ulink" href="http://freedesktop.org/wiki/Software/systemd/Preset" target="_top">Preset</a>
document.</p></dd><dt id="preset-all"><span class="term"><span class="command"><strong>preset-all</strong></span></span><a class="headerlink" title="Permalink to this term" href="#preset-all">¶</a></dt><dd><p>Resets all installed unit files to the defaults
configured in the preset policy file (see above).</p><p>Use <code class="option">--preset-mode=</code> to control
whether units shall be enabled and disabled, or only
enabled, or only disabled.</p></dd><dt id="mask NAME..."><span class="term"><span class="command"><strong>mask <em class="replaceable"><code>NAME</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#mask%20NAME...">¶</a></dt><dd><p>Mask one or more unit files, as specified on the
command line. This will link these units to
<code class="filename">/dev/null</code>, making it impossible to
start them. This is a stronger version of
<span class="command"><strong>disable</strong></span>, since it prohibits all kinds of
activation of the unit, including manual activation. Use
this option with care. This honors the
<code class="option">--runtime</code> option to only mask temporarily
until the next reboot of the system.</p></dd><dt id="unmask NAME..."><span class="term"><span class="command"><strong>unmask <em class="replaceable"><code>NAME</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#unmask%20NAME...">¶</a></dt><dd><p>Unmask one or more unit files, as specified on the
command line. This will undo the effect of
<span class="command"><strong>mask</strong></span>.</p></dd><dt id="link FILENAME..."><span class="term"><span class="command"><strong>link <em class="replaceable"><code>FILENAME</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#link%20FILENAME...">¶</a></dt><dd><p>Link a unit file that is not in the unit file search
paths into the unit file search path. This requires an
absolute path to a unit file. The effect of this can be
undone with <span class="command"><strong>disable</strong></span>. The effect of this
command is that a unit file is available for
<span class="command"><strong>start</strong></span> and other commands although it
is not installed directly in the unit search path.</p></dd><dt id="get-default"><span class="term"><span class="command"><strong>get-default</strong></span></span><a class="headerlink" title="Permalink to this term" href="#get-default">¶</a></dt><dd><p>Get the default target specified
via <code class="filename">default.target</code> link.</p></dd><dt id="set-default NAME"><span class="term"><span class="command"><strong>set-default <em class="replaceable"><code>NAME</code></em></strong></span></span><a class="headerlink" title="Permalink to this term" href="#set-default%20NAME">¶</a></dt><dd><p>Set the default target to boot into. Command links
<code class="filename">default.target</code> to the given unit.</p></dd></dl></div></div><div class="refsect2"><a name="idm214168502768"></a><h3 id="Machine Commands">Machine Commands<a class="headerlink" title="Permalink to this headline" href="#Machine%20Commands">¶</a></h3><div class="variablelist"><dl class="variablelist"><dt id="list-machines PATTERN..."><span class="term"><span class="command"><strong>list-machines [<span class="optional"><em class="replaceable"><code>PATTERN</code></em>...</span>]</strong></span></span><a class="headerlink" title="Permalink to this term" href="#list-machines%20PATTERN...">¶</a></dt><dd><p>List the host and all running local containers with
their state. If one or more
<em class="replaceable"><code>PATTERN</code></em>s are specified, only
containers matching one of them are shown.
</p></dd></dl></div></div><div class="refsect2"><a name="idm214168498576"></a><h3 id="Job Commands">Job Commands<a class="headerlink" title="Permalink to this headline" href="#Job%20Commands">¶</a></h3><div class="variablelist"><dl class="variablelist"><dt id="list-jobs PATTERN..."><span class="term"><span class="command"><strong>list-jobs [<span class="optional"><em class="replaceable"><code>PATTERN...</code></em></span>]</strong></span></span><a class="headerlink" title="Permalink to this term" href="#list-jobs%20PATTERN...">¶</a></dt><dd><p>List jobs that are in progress. If one or more
<em class="replaceable"><code>PATTERN</code></em>s are specified, only
jobs for units matching one of them are shown.</p></dd><dt id="cancel JOB..."><span class="term"><span class="command"><strong>cancel <em class="replaceable"><code>JOB</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#cancel%20JOB...">¶</a></dt><dd><p>Cancel one or more jobs specified on the command line
by their numeric job IDs. If no job ID is specified, cancel
all pending jobs.</p></dd></dl></div></div><div class="refsect2"><a name="idm214168492112"></a><h3 id="Snapshot Commands">Snapshot Commands<a class="headerlink" title="Permalink to this headline" href="#Snapshot%20Commands">¶</a></h3><div class="variablelist"><dl class="variablelist"><dt id="snapshot NAME"><span class="term"><span class="command"><strong>snapshot [<span class="optional"><em class="replaceable"><code>NAME</code></em></span>]</strong></span></span><a class="headerlink" title="Permalink to this term" href="#snapshot%20NAME">¶</a></dt><dd><p>Create a snapshot. If a snapshot name is specified,
the new snapshot will be named after it. If none is
specified, an automatic snapshot name is generated. In
either case, the snapshot name used is printed to standard
output, unless <code class="option">--quiet</code> is specified.
</p><p>A snapshot refers to a saved state of the systemd
manager. It is implemented itself as a unit that is
generated dynamically with this command and has dependencies
on all units active at the time. At a later time, the user
may return to this state by using the
<span class="command"><strong>isolate</strong></span> command on the snapshot unit.
</p><p>Snapshots are only useful for saving and restoring
which units are running or are stopped, they do not
save/restore any other state. Snapshots are dynamic and lost
on reboot.</p></dd><dt id="delete PATTERN..."><span class="term"><span class="command"><strong>delete <em class="replaceable"><code>PATTERN</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#delete%20PATTERN...">¶</a></dt><dd><p>Remove a snapshot previously created with
<span class="command"><strong>snapshot</strong></span>.</p></dd></dl></div></div><div class="refsect2"><a name="idm214168483120"></a><h3 id="Environment Commands">Environment Commands<a class="headerlink" title="Permalink to this headline" href="#Environment%20Commands">¶</a></h3><div class="variablelist"><dl class="variablelist"><dt id="show-environment"><span class="term"><span class="command"><strong>show-environment</strong></span></span><a class="headerlink" title="Permalink to this term" href="#show-environment">¶</a></dt><dd><p>Dump the systemd manager environment block. The
environment block will be dumped in straight-forward form
suitable for sourcing into a shell script. This environment
block will be passed to all processes the manager
spawns.</p></dd><dt id="set-environment VARIABLE=VALUE..."><span class="term"><span class="command"><strong>set-environment <em class="replaceable"><code>VARIABLE=VALUE</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#set-environment%20VARIABLE=VALUE...">¶</a></dt><dd><p>Set one or more systemd manager environment variables,
as specified on the command line.</p></dd><dt id="unset-environment VARIABLE..."><span class="term"><span class="command"><strong>unset-environment <em class="replaceable"><code>VARIABLE</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#unset-environment%20VARIABLE...">¶</a></dt><dd><p>Unset one or more systemd manager environment
variables. If only a variable name is specified, it will be
removed regardless of its value. If a variable and a value
are specified, the variable is only removed if it has the
specified value.</p></dd><dt id="import-environment VARIABLE..."><span class="term"><span class="command"><strong>import-environment <em class="replaceable"><code>VARIABLE</code></em>...</strong></span></span><a class="headerlink" title="Permalink to this term" href="#import-environment%20VARIABLE...">¶</a></dt><dd><p>Import all, one or more environment variables set on
the client into the systemd manager environment block. If
no arguments are passed, the entire environment block is
imported. Otherwise, a list of one or more environment
variable names should be passed, whose client-side values
are then imported into the manager's environment
block.</p></dd></dl></div></div><div class="refsect2"><a name="idm214173480768"></a><h3 id="Manager Lifecycle Commands">Manager Lifecycle Commands<a class="headerlink" title="Permalink to this headline" href="#Manager%20Lifecycle%20Commands">¶</a></h3><div class="variablelist"><dl class="variablelist"><dt id="daemon-reload"><span class="term"><span class="command"><strong>daemon-reload</strong></span></span><a class="headerlink" title="Permalink to this term" href="#daemon-reload">¶</a></dt><dd><p>Reload systemd manager configuration. This will reload
all unit files and recreate the entire dependency
tree. While the daemon is being reloaded, all sockets systemd
listens on on behalf of user configuration will stay
accessible.</p><p>This command should not be confused
with the <span class="command"><strong>load</strong></span> or
<span class="command"><strong>reload</strong></span> commands.</p></dd><dt id="daemon-reexec"><span class="term"><span class="command"><strong>daemon-reexec</strong></span></span><a class="headerlink" title="Permalink to this term" href="#daemon-reexec">¶</a></dt><dd><p>Reexecute the systemd manager. This will serialize the
manager state, reexecute the process and deserialize the
state again. This command is of little use except for
debugging and package upgrades. Sometimes, it might be
helpful as a heavy-weight <span class="command"><strong>daemon-reload</strong></span>.
While the daemon is being reexecuted, all sockets systemd listening
on behalf of user configuration will stay accessible.
</p></dd></dl></div></div><div class="refsect2"><a name="idm214168455376"></a><h3 id="System Commands">System Commands<a class="headerlink" title="Permalink to this headline" href="#System%20Commands">¶</a></h3><div class="variablelist"><dl class="variablelist"><dt id="is-system-running"><span class="term"><span class="command"><strong>is-system-running</strong></span></span><a class="headerlink" title="Permalink to this term" href="#is-system-running">¶</a></dt><dd><p>Checks whether the system is running. This returns
success when the system is fully up and running, meaning
not in startup, shutdown or maintainance mode. Failure is
returned otherwise. In addition, the current state is
printed in a short string to standard output. Use
<code class="option">--quiet</code> to suppress output of this state
string.</p></dd><dt id="default"><span class="term"><span class="command"><strong>default</strong></span></span><a class="headerlink" title="Permalink to this term" href="#default">¶</a></dt><dd><p>Enter default mode. This is mostly equivalent to
<span class="command"><strong>isolate default.target</strong></span>.</p></dd><dt id="rescue"><span class="term"><span class="command"><strong>rescue</strong></span></span><a class="headerlink" title="Permalink to this term" href="#rescue">¶</a></dt><dd><p>Enter rescue mode. This is mostly equivalent to
<span class="command"><strong>isolate rescue.target</strong></span>, but also prints a
wall message to all users.</p></dd><dt id="emergency"><span class="term"><span class="command"><strong>emergency</strong></span></span><a class="headerlink" title="Permalink to this term" href="#emergency">¶</a></dt><dd><p>Enter emergency mode. This is mostly equivalent to
<span class="command"><strong>isolate emergency.target</strong></span>, but also prints
a wall message to all users.</p></dd><dt id="halt"><span class="term"><span class="command"><strong>halt</strong></span></span><a class="headerlink" title="Permalink to this term" href="#halt">¶</a></dt><dd><p>Shut down and halt the system. This is mostly equivalent to
<span class="command"><strong>start halt.target --irreversible</strong></span>, but also
prints a wall message to all users. If combined with
<code class="option">--force</code>, shutdown of all running services is
skipped, however all processes are killed and all file
systems are unmounted or mounted read-only, immediately
followed by the system halt. If <code class="option">--force</code> is
specified twice, the operation is immediately executed
without terminating any processes or unmounting any file
systems. This may result in data loss.</p></dd><dt id="poweroff"><span class="term"><span class="command"><strong>poweroff</strong></span></span><a class="headerlink" title="Permalink to this term" href="#poweroff">¶</a></dt><dd><p>Shut down and power-off the system. This is mostly
equivalent to <span class="command"><strong>start poweroff.target --irreversible</strong></span>,
but also prints a wall message to all users. If combined with
<code class="option">--force</code>, shutdown of all running services is
skipped, however all processes are killed and all file
systems are unmounted or mounted read-only, immediately
followed by the powering off. If <code class="option">--force</code> is
specified twice, the operation is immediately executed
without terminating any processes or unmounting any file
systems. This may result in data loss.</p></dd><dt id="reboot arg"><span class="term"><span class="command"><strong>reboot [<span class="optional"><em class="replaceable"><code>arg</code></em></span>]</strong></span></span><a class="headerlink" title="Permalink to this term" href="#reboot%20arg">¶</a></dt><dd><p>Shut down and reboot the system. This is mostly
equivalent to <span class="command"><strong>start reboot.target --irreversible</strong></span>,
but also prints a wall message to all users. If combined with
<code class="option">--force</code>, shutdown of all running services is
skipped, however all processes are killed and all file
systems are unmounted or mounted read-only, immediately
followed by the reboot. If <code class="option">--force</code> is
specified twice, the operation is immediately executed
without terminating any processes or unmounting any file
systems. This may result in data loss.</p><p>If the optional argument
<em class="replaceable"><code>arg</code></em> is given, it will be passed
as the optional argument to the
<a href="reboot.html"><span class="citerefentry"><span class="refentrytitle">reboot</span>(2)</span></a>
system call. The value is architecture and firmware
specific. As an example, "<code class="literal">recovery</code>" might
be used to trigger system recovery, and
"<code class="literal">fota</code>" might be used to trigger a
<span class="quote">“<span class="quote">firmware over the air</span>”</span> update.</p></dd><dt id="kexec"><span class="term"><span class="command"><strong>kexec</strong></span></span><a class="headerlink" title="Permalink to this term" href="#kexec">¶</a></dt><dd><p>Shut down and reboot the system via kexec. This is
mostly equivalent to <span class="command"><strong>start kexec.target --irreversible</strong></span>,
but also prints a wall message to all users. If combined
with <code class="option">--force</code>, shutdown of all running
services is skipped, however all processes are killed and
all file systems are unmounted or mounted read-only,
immediately followed by the reboot.</p></dd><dt id="exit"><span class="term"><span class="command"><strong>exit</strong></span></span><a class="headerlink" title="Permalink to this term" href="#exit">¶</a></dt><dd><p>Ask the systemd manager to quit. This is only
supported for user service managers (i.e. in conjunction
with the <code class="option">--user</code> option) and will fail
otherwise.</p></dd><dt id="suspend"><span class="term"><span class="command"><strong>suspend</strong></span></span><a class="headerlink" title="Permalink to this term" href="#suspend">¶</a></dt><dd><p>Suspend the system. This will trigger activation of
the special <code class="filename">suspend.target</code> target.
</p></dd><dt id="hibernate"><span class="term"><span class="command"><strong>hibernate</strong></span></span><a class="headerlink" title="Permalink to this term" href="#hibernate">¶</a></dt><dd><p>Hibernate the system. This will trigger activation of
the special <code class="filename">hibernate.target</code> target.
</p></dd><dt id="hybrid-sleep"><span class="term"><span class="command"><strong>hybrid-sleep</strong></span></span><a class="headerlink" title="Permalink to this term" href="#hybrid-sleep">¶</a></dt><dd><p>Hibernate and suspend the system. This will trigger
activation of the special
<code class="filename">hybrid-sleep.target</code> target.</p></dd><dt id="switch-root ROOT INIT"><span class="term"><span class="command"><strong>switch-root <em class="replaceable"><code>ROOT</code></em> [<span class="optional"><em class="replaceable"><code>INIT</code></em></span>]</strong></span></span><a class="headerlink" title="Permalink to this term" href="#switch-root%20ROOT%20INIT">¶</a></dt><dd><p>Switches to a different root directory and executes a
new system manager process below it. This is intended for
usage in initial RAM disks ("initrd"), and will transition
from the initrd's system manager process (a.k.a "init"
process) to the main system manager process. This call takes two
arguments: the directory that is to become the new root directory, and
the path to the new system manager binary below it to
execute as PID 1. If the latter is omitted or the empty
string, a systemd binary will automatically be searched for
and used as init. If the system manager path is omitted or
equal to the empty string, the state of the initrd's system
manager process is passed to the main system manager, which
allows later introspection of the state of the services
involved in the initrd boot.</p></dd></dl></div></div><div class="refsect2"><a name="idm214168410608"></a><h3 id="Parameter Syntax">Parameter Syntax<a class="headerlink" title="Permalink to this headline" href="#Parameter%20Syntax">¶</a></h3><p>Unit commands listed above take either a single unit name
(designated as <em class="replaceable"><code>NAME</code></em>), or multiple
unit specifications (designated as
<em class="replaceable"><code>PATTERN</code></em>...). In the first case, the
unit name with or without a suffix must be given. If the suffix
is not specified, systemctl will append a suitable suffix,
"<code class="literal">.service</code>" by default, and a type-specific
suffix in case of commands which operate only on specific unit
types. For example,
</p><pre class="programlisting"># systemctl start sshd</pre><p> and
</p><pre class="programlisting"># systemctl start sshd.service</pre><p>
are equivalent, as are
</p><pre class="programlisting"># systemctl isolate snapshot-11</pre><p>
and
</p><pre class="programlisting"># systemctl isolate snapshot-11.snapshot</pre><p>
Note that (absolute) paths to device nodes are automatically
converted to device unit names, and other (absolute) paths to
mount unit names.
</p><pre class="programlisting"># systemctl status /dev/sda
# systemctl status /home</pre><p>
are equivalent to:
</p><pre class="programlisting"># systemctl status dev-sda.device
# systemctl status home.mount</pre><p>
In the second case, shell-style globs will be matched against
currently loaded units; literal unit names, with or without
a suffix, will be treated as in the first case. This means that
literal unit names always refer to exactly one unit, but globs
may match zero units and this is not considered an error.</p><p>Glob patterns use
<a href="fnmatch.html"><span class="citerefentry"><span class="refentrytitle">fnmatch</span>(3)</span></a>,
so normal shell-style globbing rules are used, and
"<code class="literal">*</code>", "<code class="literal">?</code>",
"<code class="literal">[]</code>" may be used. See
<a href="glob.html"><span class="citerefentry"><span class="refentrytitle">glob</span>(7)</span></a>
for more details. The patterns are matched against the names of
currently loaded units, and patterns which do not match anything
are silently skipped. For example:
</p><pre class="programlisting"># systemctl stop sshd@*.service</pre><p>
will stop all <code class="filename">sshd@.service</code> instances.
</p><p>For unit file commands, the specified
<em class="replaceable"><code>NAME</code></em> should be the full name of the
unit file, or the absolute path to the unit file:
</p><pre class="programlisting"># systemctl enable foo.service</pre><p>
or
</p><pre class="programlisting"># systemctl link /path/to/foo.service</pre><p>
</p></div></div><div class="refsect1"><a name="idm214168395616"></a><h2 id="Exit status">Exit status<a class="headerlink" title="Permalink to this headline" href="#Exit%20status">¶</a></h2><p>On success, 0 is returned, a non-zero failure
code otherwise.</p></div><div class="refsect1"><a name="idm214152885568"></a><h2 id="Environment">Environment<a class="headerlink" title="Permalink to this headline" href="#Environment">¶</a></h2><div class="variablelist"><dl class="variablelist"><dt id="$SYSTEMD_PAGER"><span class="term"><code class="varname">$SYSTEMD_PAGER</code></span><a class="headerlink" title="Permalink to this term" href="#%24SYSTEMD_PAGER">¶</a></dt><dd><p>Pager to use when
<code class="option">--no-pager</code> is not given;
overrides <code class="varname">$PAGER</code>. Setting
this to an empty string or the value
"<code class="literal">cat</code>" is equivalent to passing
<code class="option">--no-pager</code>.</p></dd><dt id="$SYSTEMD_LESS"><span class="term"><code class="varname">$SYSTEMD_LESS</code></span><a class="headerlink" title="Permalink to this term" href="#%24SYSTEMD_LESS">¶</a></dt><dd><p>Override the default
options passed to
<span class="command"><strong>less</strong></span>
("<code class="literal">FRSXMK</code>").</p></dd></dl></div></div><div class="refsect1"><a name="idm214168393888"></a><h2 id="See Also">See Also<a class="headerlink" title="Permalink to this headline" href="#See%20Also">¶</a></h2><p>
<a href="systemd.html"><span class="citerefentry"><span class="refentrytitle">systemd</span>(1)</span></a>,
<a href="systemadm.html"><span class="citerefentry"><span class="refentrytitle">systemadm</span>(1)</span></a>,
<a href="journalctl.html"><span class="citerefentry"><span class="refentrytitle">journalctl</span>(1)</span></a>,
<a href="loginctl.html"><span class="citerefentry"><span class="refentrytitle">loginctl</span>(1)</span></a>,
<a href="systemd.unit.html"><span class="citerefentry"><span class="refentrytitle">systemd.unit</span>(5)</span></a>,
<a href="systemd.resource-management.html"><span class="citerefentry"><span class="refentrytitle">systemd.resource-management</span>(5)</span></a>,
<a href="systemd.special.html"><span class="citerefentry"><span class="refentrytitle">systemd.special</span>(7)</span></a>,
<a href="wall.html"><span class="citerefentry"><span class="refentrytitle">wall</span>(1)</span></a>,
<a href="systemd.preset.html"><span class="citerefentry"><span class="refentrytitle">systemd.preset</span>(5)</span></a>
<a href="glob.html"><span class="citerefentry"><span class="refentrytitle">glob</span>(7)</span></a>
</p></div></div></body></html>
|
