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
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
|
'\" t
.TH "SYSTEMD\&.UNIT" "5" "" "systemd 254" "systemd.unit"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
systemd.unit \- Unit configuration
.SH "SYNOPSIS"
.PP
\fIservice\fR\&.service,
\fIsocket\fR\&.socket,
\fIdevice\fR\&.device,
\fImount\fR\&.mount,
\fIautomount\fR\&.automount,
\fIswap\fR\&.swap,
\fItarget\fR\&.target,
\fIpath\fR\&.path,
\fItimer\fR\&.timer,
\fIslice\fR\&.slice,
\fIscope\fR\&.scope
.SS "System Unit Search Path"
.PP
.nf
/etc/systemd/system\&.control/*
/run/systemd/system\&.control/*
/run/systemd/transient/*
/run/systemd/generator\&.early/*
/etc/systemd/system/*
/etc/systemd/system\&.attached/*
/run/systemd/system/*
/run/systemd/system\&.attached/*
/run/systemd/generator/*
\&...
/usr/lib/systemd/system/*
/run/systemd/generator\&.late/*
.fi
.SS "User Unit Search Path"
.PP
.nf
~/\&.config/systemd/user\&.control/*
$XDG_RUNTIME_DIR/systemd/user\&.control/*
$XDG_RUNTIME_DIR/systemd/transient/*
$XDG_RUNTIME_DIR/systemd/generator\&.early/*
~/\&.config/systemd/user/*
$XDG_CONFIG_DIRS/systemd/user/*
/etc/systemd/user/*
$XDG_RUNTIME_DIR/systemd/user/*
/run/systemd/user/*
$XDG_RUNTIME_DIR/systemd/generator/*
$XDG_DATA_HOME/systemd/user/*
$XDG_DATA_DIRS/systemd/user/*
\&...
/usr/lib/systemd/user/*
$XDG_RUNTIME_DIR/systemd/generator\&.late/*
.fi
.SH "DESCRIPTION"
.PP
A unit file is a plain text ini\-style file that encodes information about a service, a socket, a device, a mount point, an automount point, a swap file or partition, a start\-up target, a watched file system path, a timer controlled and supervised by
\fBsystemd\fR(1), a resource management slice or a group of externally created processes\&. See
\fBsystemd.syntax\fR(7)
for a general description of the syntax\&.
.PP
This man page lists the common configuration options of all the unit types\&. These options need to be configured in the [Unit] or [Install] sections of the unit files\&.
.PP
In addition to the generic [Unit] and [Install] sections described here, each unit may have a type\-specific section, e\&.g\&. [Service] for a service unit\&. See the respective man pages for more information:
\fBsystemd.service\fR(5),
\fBsystemd.socket\fR(5),
\fBsystemd.device\fR(5),
\fBsystemd.mount\fR(5),
\fBsystemd.automount\fR(5),
\fBsystemd.swap\fR(5),
\fBsystemd.target\fR(5),
\fBsystemd.path\fR(5),
\fBsystemd.timer\fR(5),
\fBsystemd.slice\fR(5),
\fBsystemd.scope\fR(5)\&.
.PP
Unit files are loaded from a set of paths determined during compilation, described in the next section\&.
.PP
Valid unit names consist of a "unit name prefix", and a suffix specifying the unit type which begins with a dot\&. The "unit name prefix" must consist of one or more valid characters (ASCII letters, digits,
":",
"\-",
"_",
"\&.", and
"\e")\&. The total length of the unit name including the suffix must not exceed 255 characters\&. The unit type suffix must be one of
"\&.service",
"\&.socket",
"\&.device",
"\&.mount",
"\&.automount",
"\&.swap",
"\&.target",
"\&.path",
"\&.timer",
"\&.slice", or
"\&.scope"\&.
.PP
Unit names can be parameterized by a single argument called the "instance name"\&. The unit is then constructed based on a "template file" which serves as the definition of multiple services or other units\&. A template unit must have a single
"@"
at the end of the unit name prefix (right before the type suffix)\&. The name of the full unit is formed by inserting the instance name between
"@"
and the unit type suffix\&. In the unit file itself, the instance parameter may be referred to using
"%i"
and other specifiers, see below\&.
.PP
Unit files may contain additional options on top of those listed here\&. If systemd encounters an unknown option, it will write a warning log message but continue loading the unit\&. If an option or section name is prefixed with
\fBX\-\fR, it is ignored completely by systemd\&. Options within an ignored section do not need the prefix\&. Applications may use this to include additional information in the unit files\&. To access those options, applications need to parse the unit files on their own\&.
.PP
Units can be aliased (have an alternative name), by creating a symlink from the new name to the existing name in one of the unit search paths\&. For example,
systemd\-networkd\&.service
has the alias
dbus\-org\&.freedesktop\&.network1\&.service, created during installation as a symlink, so when
\fBsystemd\fR
is asked through D\-Bus to load
dbus\-org\&.freedesktop\&.network1\&.service, it\*(Aqll load
systemd\-networkd\&.service\&. As another example,
default\&.target
\(em the default system target started at boot \(em is commonly aliased to either
multi\-user\&.target
or
graphical\&.target
to select what is started by default\&. Alias names may be used in commands like
\fBdisable\fR,
\fBstart\fR,
\fBstop\fR,
\fBstatus\fR, and similar, and in all unit dependency directives, including
\fIWants=\fR,
\fIRequires=\fR,
\fIBefore=\fR,
\fIAfter=\fR\&. Aliases cannot be used with the
\fBpreset\fR
command\&.
.PP
Aliases obey the following restrictions: a unit of a certain type ("\&.service",
"\&.socket", \&...) can only be aliased by a name with the same type suffix\&. A plain unit (not a template or an instance), may only be aliased by a plain name\&. A template instance may only be aliased by another template instance, and the instance part must be identical\&. A template may be aliased by another template (in which case the alias applies to all instances of the template)\&. As a special case, a template instance (e\&.g\&.
"alias@inst\&.service") may be a symlink to different template (e\&.g\&.
"template@inst\&.service")\&. In that case, just this specific instance is aliased, while other instances of the template (e\&.g\&.
"alias@foo\&.service",
"alias@bar\&.service") are not aliased\&. Those rules preserve the requirement that the instance (if any) is always uniquely defined for a given unit and all its aliases\&. The target of alias symlink must point to a valid unit file location, i\&.e\&. the symlink target name must match the symlink source name as described, and the destination path must be in one of the unit search paths, see UNIT FILE LOAD PATH section below for more details\&. Note that the target file may not exist, i\&.e\&. the symlink may be dangling\&.
.PP
Unit files may specify aliases through the
\fIAlias=\fR
directive in the [Install] section\&. When the unit is enabled, symlinks will be created for those names, and removed when the unit is disabled\&. For example,
reboot\&.target
specifies
\fIAlias=ctrl\-alt\-del\&.target\fR, so when enabled, the symlink
/etc/systemd/system/ctrl\-alt\-del\&.service
pointing to the
reboot\&.target
file will be created, and when
Ctrl+Alt+Del
is invoked,
\fBsystemd\fR
will look for the
ctrl\-alt\-del\&.service
and execute
reboot\&.service\&.
\fBsystemd\fR
does not look at the [Install] section at all during normal operation, so any directives in that section only have an effect through the symlinks created during enablement\&.
.PP
Along with a unit file
foo\&.service, the directory
foo\&.service\&.wants/
may exist\&. All unit files symlinked from such a directory are implicitly added as dependencies of type
\fIWants=\fR
to the unit\&. Similar functionality exists for
\fIRequires=\fR
type dependencies as well, the directory suffix is
\&.requires/
in this case\&. This functionality is useful to hook units into the start\-up of other units, without having to modify their unit files\&. For details about the semantics of
\fIWants=\fR
and
\fIRequires=\fR, see below\&. The preferred way to create symlinks in the
\&.wants/
or
\&.requires/
directories is by specifying the dependency in [Install] section of the target unit, and creating the symlink in the file system with the
\fBenable\fR
or
\fBpreset\fR
commands of
\fBsystemctl\fR(1)\&. The target can be a normal unit (either plain or a specific instance of a template unit)\&. In case when the source unit is a template, the target can also be a template, in which case the instance will be "propagated" to the target unit to form a valid unit instance\&. The target of symlinks in
\&.wants/
or
\&.requires/
must thus point to a valid unit file location, i\&.e\&. the symlink target name must satisfy the described requirements, and the destination path must be in one of the unit search paths, see UNIT FILE LOAD PATH section below for more details\&. Note that the target file may not exist, i\&.e\&. the symlink may be dangling\&.
.PP
Along with a unit file
foo\&.service, a "drop\-in" directory
foo\&.service\&.d/
may exist\&. All files with the suffix
"\&.conf"
from this directory will be merged in the alphanumeric order and parsed after the main unit file itself has been parsed\&. This is useful to alter or add configuration settings for a unit, without having to modify unit files\&. Each drop\-in file must contain appropriate section headers\&. For instantiated units, this logic will first look for the instance
"\&.d/"
subdirectory (e\&.g\&.
"foo@bar\&.service\&.d/") and read its
"\&.conf"
files, followed by the template
"\&.d/"
subdirectory (e\&.g\&.
"foo@\&.service\&.d/") and the
"\&.conf"
files there\&. Moreover for unit names containing dashes ("\-"), the set of directories generated by repeatedly truncating the unit name after all dashes is searched too\&. Specifically, for a unit name
foo\-bar\-baz\&.service
not only the regular drop\-in directory
foo\-bar\-baz\&.service\&.d/
is searched but also both
foo\-bar\-\&.service\&.d/
and
foo\-\&.service\&.d/\&. This is useful for defining common drop\-ins for a set of related units, whose names begin with a common prefix\&. This scheme is particularly useful for mount, automount and slice units, whose systematic naming structure is built around dashes as component separators\&. Note that equally named drop\-in files further down the prefix hierarchy override those further up, i\&.e\&.
foo\-bar\-\&.service\&.d/10\-override\&.conf
overrides
foo\-\&.service\&.d/10\-override\&.conf\&.
.PP
In cases of unit aliases (described above), dropins for the aliased name and all aliases are loaded\&. In the example of
default\&.target
aliasing
graphical\&.target,
default\&.target\&.d/,
default\&.target\&.wants/,
default\&.target\&.requires/,
graphical\&.target\&.d/,
graphical\&.target\&.wants/,
graphical\&.target\&.requires/
would all be read\&. For templates, dropins for the template, any template aliases, the template instance, and all alias instances are read\&. When just a specific template instance is aliased, then the dropins for the target template, the target template instance, and the alias template instance are read\&.
.PP
In addition to
/etc/systemd/system, the drop\-in
"\&.d/"
directories for system services can be placed in
/usr/lib/systemd/system
or
/run/systemd/system
directories\&. Drop\-in files in
/etc/
take precedence over those in
/run/
which in turn take precedence over those in
/usr/lib/\&. Drop\-in files under any of these directories take precedence over unit files wherever located\&. Multiple drop\-in files with different names are applied in lexicographic order, regardless of which of the directories they reside in\&.
.PP
Units also support a top\-level drop\-in with
\fItype\fR\&.d/, where
\fItype\fR
may be e\&.g\&.
"service"
or
"socket", that allows altering or adding to the settings of all corresponding unit files on the system\&. The formatting and precedence of applying drop\-in configurations follow what is defined above\&. Files in
\fItype\fR\&.d/
have lower precedence compared to files in name\-specific override directories\&. The usual rules apply: multiple drop\-in files with different names are applied in lexicographic order, regardless of which of the directories they reside in, so a file in
\fItype\fR\&.d/
applies to a unit only if there are no drop\-ins or masks with that name in directories with higher precedence\&. See Examples\&.
.PP
Note that while systemd offers a flexible dependency system between units it is recommended to use this functionality only sparingly and instead rely on techniques such as bus\-based or socket\-based activation which make dependencies implicit, resulting in a both simpler and more flexible system\&.
.PP
As mentioned above, a unit may be instantiated from a template file\&. This allows creation of multiple units from a single configuration file\&. If systemd looks for a unit configuration file, it will first search for the literal unit name in the file system\&. If that yields no success and the unit name contains an
"@"
character, systemd will look for a unit template that shares the same name but with the instance string (i\&.e\&. the part between the
"@"
character and the suffix) removed\&. Example: if a service
getty@tty3\&.service
is requested and no file by that name is found, systemd will look for
getty@\&.service
and instantiate a service from that configuration file if it is found\&.
.PP
To refer to the instance string from within the configuration file you may use the special
"%i"
specifier in many of the configuration options\&. See below for details\&.
.PP
If a unit file is empty (i\&.e\&. has the file size 0) or is symlinked to
/dev/null, its configuration will not be loaded and it appears with a load state of
"masked", and cannot be activated\&. Use this as an effective way to fully disable a unit, making it impossible to start it even manually\&.
.PP
The unit file format is covered by the
\m[blue]\fBInterface Portability and Stability Promise\fR\m[]\&\s-2\u[1]\d\s+2\&.
.SH "STRING ESCAPING FOR INCLUSION IN UNIT NAMES"
.PP
Sometimes it is useful to convert arbitrary strings into unit names\&. To facilitate this, a method of string escaping is used, in order to map strings containing arbitrary byte values (except
\fBNUL\fR) into valid unit names and their restricted character set\&. A common special case are unit names that reflect paths to objects in the file system hierarchy\&. Example: a device unit
dev\-sda\&.device
refers to a device with the device node
/dev/sda
in the file system\&.
.PP
The escaping algorithm operates as follows: given a string, any
"/"
character is replaced by
"\-", and all other characters which are not ASCII alphanumerics,
":",
"_"
or
"\&."
are replaced by C\-style
"\ex2d"
escapes\&. In addition,
"\&."
is replaced with such a C\-style escape when it would appear as the first character in the escaped string\&.
.PP
When the input qualifies as absolute file system path, this algorithm is extended slightly: the path to the root directory
"/"
is encoded as single dash
"\-"\&. In addition, any leading, trailing or duplicate
"/"
characters are removed from the string before transformation\&. Example:
/foo//bar/baz/
becomes
"foo\-bar\-baz"\&.
.PP
This escaping is fully reversible, as long as it is known whether the escaped string was a path (the unescaping results are different for paths and non\-path strings)\&. The
\fBsystemd-escape\fR(1)
command may be used to apply and reverse escaping on arbitrary strings\&. Use
\fBsystemd\-escape \-\-path\fR
to escape path strings, and
\fBsystemd\-escape\fR
without
\fB\-\-path\fR
otherwise\&.
.SH "AUTOMATIC DEPENDENCIES"
.SS "Implicit Dependencies"
.PP
A number of unit dependencies are implicitly established, depending on unit type and unit configuration\&. These implicit dependencies can make unit configuration file cleaner\&. For the implicit dependencies in each unit type, please refer to section "Implicit Dependencies" in respective man pages\&.
.PP
For example, service units with
\fIType=dbus\fR
automatically acquire dependencies of type
\fIRequires=\fR
and
\fIAfter=\fR
on
dbus\&.socket\&. See
\fBsystemd.service\fR(5)
for details\&.
.SS "Default Dependencies"
.PP
Default dependencies are similar to implicit dependencies, but can be turned on and off by setting
\fIDefaultDependencies=\fR
to
\fIyes\fR
(the default) and
\fIno\fR, while implicit dependencies are always in effect\&. See section "Default Dependencies" in respective man pages for the effect of enabling
\fIDefaultDependencies=\fR
in each unit types\&.
.PP
For example, target units will complement all configured dependencies of type
\fIWants=\fR
or
\fIRequires=\fR
with dependencies of type
\fIAfter=\fR\&. See
\fBsystemd.target\fR(5)
for details\&. Note that this behavior can be opted out by setting
\fIDefaultDependencies=no\fR
in the specified units, or it can be selectively overridden via an explicit
\fIBefore=\fR
dependency\&.
.SH "UNIT FILE LOAD PATH"
.PP
Unit files are loaded from a set of paths determined during compilation, described in the two tables below\&. Unit files found in directories listed earlier override files with the same name in directories lower in the list\&.
.PP
When the variable
\fI$SYSTEMD_UNIT_PATH\fR
is set, the contents of this variable overrides the unit load path\&. If
\fI$SYSTEMD_UNIT_PATH\fR
ends with an empty component (":"), the usual unit load path will be appended to the contents of the variable\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&1.\ \& Load path when running in system mode (\-\-system)\&.
.TS
allbox tab(:);
lB lB.
T{
Path
T}:T{
Description
T}
.T&
l l
l ^
l l
l l
l l
l l
l l
l l
l l
l l.
T{
/etc/systemd/system\&.control
T}:T{
Persistent and transient configuration created using the dbus API
T}
T{
/run/systemd/system\&.control
T}:
T{
/run/systemd/transient
T}:T{
Dynamic configuration for transient units
T}
T{
/run/systemd/generator\&.early
T}:T{
Generated units with high priority (see \fIearly\-dir\fR in \fBsystemd.generator\fR(7))
T}
T{
/etc/systemd/system
T}:T{
System units created by the administrator
T}
T{
/run/systemd/system
T}:T{
Runtime units
T}
T{
/run/systemd/generator
T}:T{
Generated units with medium priority (see \fInormal\-dir\fR in \fBsystemd.generator\fR(7))
T}
T{
/usr/local/lib/systemd/system
T}:T{
System units installed by the administrator
T}
T{
/usr/lib/systemd/system
T}:T{
System units installed by the distribution package manager
T}
T{
/run/systemd/generator\&.late
T}:T{
Generated units with low priority (see \fIlate\-dir\fR in \fBsystemd.generator\fR(7))
T}
.TE
.sp 1
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&2.\ \& Load path when running in user mode (\-\-user)\&.
.TS
allbox tab(:);
lB lB.
T{
Path
T}:T{
Description
T}
.T&
l l
l ^
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l
l l.
T{
$XDG_CONFIG_HOME/systemd/user\&.control or ~/\&.config/systemd/user\&.control
T}:T{
Persistent and transient configuration created using the dbus API (\fI$XDG_CONFIG_HOME\fR is used if set, ~/\&.config otherwise)
T}
T{
$XDG_RUNTIME_DIR/systemd/user\&.control
T}:
T{
$XDG_RUNTIME_DIR/systemd/transient
T}:T{
Dynamic configuration for transient units
T}
T{
$XDG_RUNTIME_DIR/systemd/generator\&.early
T}:T{
Generated units with high priority (see \fIearly\-dir\fR in \fBsystemd.generator\fR(7))
T}
T{
$XDG_CONFIG_HOME/systemd/user or $HOME/\&.config/systemd/user
T}:T{
User configuration (\fI$XDG_CONFIG_HOME\fR is used if set, ~/\&.config otherwise)
T}
T{
$XDG_CONFIG_DIRS/systemd/user or /etc/xdg/systemd/user
T}:T{
Additional configuration directories as specified by the XDG base directory specification (\fI$XDG_CONFIG_DIRS\fR is used if set, /etc/xdg otherwise)
T}
T{
/etc/systemd/user
T}:T{
User units created by the administrator
T}
T{
$XDG_RUNTIME_DIR/systemd/user
T}:T{
Runtime units (only used when $XDG_RUNTIME_DIR is set)
T}
T{
/run/systemd/user
T}:T{
Runtime units
T}
T{
$XDG_RUNTIME_DIR/systemd/generator
T}:T{
Generated units with medium priority (see \fInormal\-dir\fR in \fBsystemd.generator\fR(7))
T}
T{
$XDG_DATA_HOME/systemd/user or $HOME/\&.local/share/systemd/user
T}:T{
Units of packages that have been installed in the home directory (\fI$XDG_DATA_HOME\fR is used if set, ~/\&.local/share otherwise)
T}
T{
$XDG_DATA_DIRS/systemd/user or /usr/local/share/systemd/user and /usr/share/systemd/user
T}:T{
Additional data directories as specified by the XDG base directory specification (\fI$XDG_DATA_DIRS\fR is used if set, /usr/local/share and /usr/share otherwise)
T}
T{
$dir/systemd/user for each \fI$dir\fR in \fI$XDG_DATA_DIRS\fR
T}:T{
Additional locations for installed user units, one for each entry in \fI$XDG_DATA_DIRS\fR
T}
T{
/usr/local/lib/systemd/user
T}:T{
User units installed by the administrator
T}
T{
/usr/lib/systemd/user
T}:T{
User units installed by the distribution package manager
T}
T{
$XDG_RUNTIME_DIR/systemd/generator\&.late
T}:T{
Generated units with low priority (see \fIlate\-dir\fR in \fBsystemd.generator\fR(7))
T}
.TE
.sp 1
.PP
The set of load paths for the user manager instance may be augmented or changed using various environment variables\&. And environment variables may in turn be set using environment generators, see
\fBsystemd.environment-generator\fR(7)\&. In particular,
\fI$XDG_DATA_HOME\fR
and
\fI$XDG_DATA_DIRS\fR
may be easily set using
\fBsystemd-environment-d-generator\fR(8)\&. Thus, directories listed here are just the defaults\&. To see the actual list that would be used based on compilation options and current environment use
.sp
.if n \{\
.RS 4
.\}
.nf
systemd\-analyze \-\-user unit\-paths
.fi
.if n \{\
.RE
.\}
.PP
Moreover, additional units might be loaded into systemd from directories not on the unit load path by creating a symlink pointing to a unit file in the directories\&. You can use
\fBsystemctl link\fR
for this; see
\fBsystemctl\fR(1)\&. The file system where the linked unit files are located must be accessible when systemd is started (e\&.g\&. anything underneath
/home/
or
/var/
is not allowed, unless those directories are located on the root file system)\&.
.PP
It is important to distinguish "linked unit files" from "unit file aliases": any symlink where the symlink
\fItarget\fR
is within the unit load path becomes an alias: the source name and the target file name must satisfy specific constraints listed above in the discussion of aliases, but the symlink target doesn\*(Aqt have to exist, and in fact the symlink target path is not used, except to check whether the target is within the unit load path\&. In contrast, a symlink which goes outside of the unit load path signifies a linked unit file\&. The symlink is followed when loading the file, but the destination name is otherwise unused (and may even not be a valid unit file name)\&. For example, symlinks
/etc/systemd/system/alias1\&.service
→
service1\&.service,
/etc/systemd/system/alias2\&.service
→
/usr/lib/systemd/service1\&.service,
/etc/systemd/system/alias3\&.service
→
/etc/systemd/system/service1\&.service
are all valid aliases and
service1\&.service
will have four names, even if the unit file is located at
/run/systemd/system/service1\&.service\&. In contrast, a symlink
/etc/systemd/system/link1\&.service
→
\&.\&./link1_service_file
means that
link1\&.service
is a "linked unit" and the contents of
/etc/systemd/link1_service_file
provide its configuration\&.
.SH "UNIT GARBAGE COLLECTION"
.PP
The system and service manager loads a unit\*(Aqs configuration automatically when a unit is referenced for the first time\&. It will automatically unload the unit configuration and state again when the unit is not needed anymore ("garbage collection")\&. A unit may be referenced through a number of different mechanisms:
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 1." 4.2
.\}
Another loaded unit references it with a dependency such as
\fIAfter=\fR,
\fIWants=\fR, \&...
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 2." 4.2
.\}
The unit is currently starting, running, reloading or stopping\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 3.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 3." 4.2
.\}
The unit is currently in the
\fBfailed\fR
state\&. (But see below\&.)
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 4.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 4." 4.2
.\}
A job for the unit is pending\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 5.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 5." 4.2
.\}
The unit is pinned by an active IPC client program\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 6.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 6." 4.2
.\}
The unit is a special "perpetual" unit that is always active and loaded\&. Examples for perpetual units are the root mount unit
\-\&.mount
or the scope unit
init\&.scope
that the service manager itself lives in\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 7.\h'+01'\c
.\}
.el \{\
.sp -1
.IP " 7." 4.2
.\}
The unit has running processes associated with it\&.
.RE
.PP
The garbage collection logic may be altered with the
\fICollectMode=\fR
option, which allows configuration whether automatic unloading of units that are in
\fBfailed\fR
state is permissible, see below\&.
.PP
Note that when a unit\*(Aqs configuration and state is unloaded, all execution results, such as exit codes, exit signals, resource consumption and other statistics are lost, except for what is stored in the log subsystem\&.
.PP
Use
\fBsystemctl daemon\-reload\fR
or an equivalent command to reload unit configuration while the unit is already loaded\&. In this case all configuration settings are flushed out and replaced with the new configuration (which however might not be in effect immediately), however all runtime state is saved/restored\&.
.SH "[UNIT] SECTION OPTIONS"
.PP
The unit file may include a [Unit] section, which carries generic information about the unit that is not dependent on the type of unit:
.PP
\fIDescription=\fR
.RS 4
A short human readable title of the unit\&. This may be used by
\fBsystemd\fR
(and other UIs) as a user\-visible label for the unit, so this string should identify the unit rather than describe it, despite the name\&. This string also shouldn\*(Aqt just repeat the unit name\&.
"Apache2 Web Server"
is a good example\&. Bad examples are
"high\-performance light\-weight HTTP server"
(too generic) or
"Apache2"
(meaningless for people who do not know Apache, duplicates the unit name)\&.
\fBsystemd\fR
may use this string as a noun in status messages ("Starting \fIdescription\fR\&.\&.\&.",
"Started \fIdescription\fR\&.",
"Reached target \fIdescription\fR\&.",
"Failed to start \fIdescription\fR\&."), so it should be capitalized, and should not be a full sentence, or a phrase with a continuous verb\&. Bad examples include
"exiting the container"
or
"updating the database once per day\&."\&.
.RE
.PP
\fIDocumentation=\fR
.RS 4
A space\-separated list of URIs referencing documentation for this unit or its configuration\&. Accepted are only URIs of the types
"http://",
"https://",
"file:",
"info:",
"man:"\&. For more information about the syntax of these URIs, see
\fBuri\fR(7)\&. The URIs should be listed in order of relevance, starting with the most relevant\&. It is a good idea to first reference documentation that explains what the unit\*(Aqs purpose is, followed by how it is configured, followed by any other related documentation\&. This option may be specified more than once, in which case the specified list of URIs is merged\&. If the empty string is assigned to this option, the list is reset and all prior assignments will have no effect\&.
.RE
.PP
\fIWants=\fR
.RS 4
Configures (weak) requirement dependencies on other units\&. This option may be specified more than once or multiple space\-separated units may be specified in one option in which case dependencies for all listed names will be created\&. Dependencies of this type may also be configured outside of the unit configuration file by adding a symlink to a
\&.wants/
directory accompanying the unit file\&. For details, see above\&.
.sp
Units listed in this option will be started if the configuring unit is\&. However, if the listed units fail to start or cannot be added to the transaction, this has no impact on the validity of the transaction as a whole, and this unit will still be started\&. This is the recommended way to hook the start\-up of one unit to the start\-up of another unit\&.
.sp
Note that requirement dependencies do not influence the order in which services are started or stopped\&. This has to be configured independently with the
\fIAfter=\fR
or
\fIBefore=\fR
options\&. If unit
foo\&.service
pulls in unit
bar\&.service
as configured with
\fIWants=\fR
and no ordering is configured with
\fIAfter=\fR
or
\fIBefore=\fR, then both units will be started simultaneously and without any delay between them if
foo\&.service
is activated\&.
.RE
.PP
\fIRequires=\fR
.RS 4
Similar to
\fIWants=\fR, but declares a stronger requirement dependency\&. Dependencies of this type may also be configured by adding a symlink to a
\&.requires/
directory accompanying the unit file\&.
.sp
If this unit gets activated, the units listed will be activated as well\&. If one of the other units fails to activate, and an ordering dependency
\fIAfter=\fR
on the failing unit is set, this unit will not be started\&. Besides, with or without specifying
\fIAfter=\fR, this unit will be stopped (or restarted) if one of the other units is explicitly stopped (or restarted)\&.
.sp
Often, it is a better choice to use
\fIWants=\fR
instead of
\fIRequires=\fR
in order to achieve a system that is more robust when dealing with failing services\&.
.sp
Note that this dependency type does not imply that the other unit always has to be in active state when this unit is running\&. Specifically: failing condition checks (such as
\fIConditionPathExists=\fR,
\fIConditionPathIsSymbolicLink=\fR, \&... \(em see below) do not cause the start job of a unit with a
\fIRequires=\fR
dependency on it to fail\&. Also, some unit types may deactivate on their own (for example, a service process may decide to exit cleanly, or a device may be unplugged by the user), which is not propagated to units having a
\fIRequires=\fR
dependency\&. Use the
\fIBindsTo=\fR
dependency type together with
\fIAfter=\fR
to ensure that a unit may never be in active state without a specific other unit also in active state (see below)\&.
.RE
.PP
\fIRequisite=\fR
.RS 4
Similar to
\fIRequires=\fR\&. However, if the units listed here are not started already, they will not be started and the starting of this unit will fail immediately\&.
\fIRequisite=\fR
does not imply an ordering dependency, even if both units are started in the same transaction\&. Hence this setting should usually be combined with
\fIAfter=\fR, to ensure this unit is not started before the other unit\&.
.sp
When
\fIRequisite=b\&.service\fR
is used on
a\&.service, this dependency will show as
\fIRequisiteOf=a\&.service\fR
in property listing of
b\&.service\&.
\fIRequisiteOf=\fR
dependency cannot be specified directly\&.
.RE
.PP
\fIBindsTo=\fR
.RS 4
Configures requirement dependencies, very similar in style to
\fIRequires=\fR\&. However, this dependency type is stronger: in addition to the effect of
\fIRequires=\fR
it declares that if the unit bound to is stopped, this unit will be stopped too\&. This means a unit bound to another unit that suddenly enters inactive state will be stopped too\&. Units can suddenly, unexpectedly enter inactive state for different reasons: the main process of a service unit might terminate on its own choice, the backing device of a device unit might be unplugged or the mount point of a mount unit might be unmounted without involvement of the system and service manager\&.
.sp
When used in conjunction with
\fIAfter=\fR
on the same unit the behaviour of
\fIBindsTo=\fR
is even stronger\&. In this case, the unit bound to strictly has to be in active state for this unit to also be in active state\&. This not only means a unit bound to another unit that suddenly enters inactive state, but also one that is bound to another unit that gets skipped due to an unmet condition check (such as
\fIConditionPathExists=\fR,
\fIConditionPathIsSymbolicLink=\fR, \&... \(em see below) will be stopped, should it be running\&. Hence, in many cases it is best to combine
\fIBindsTo=\fR
with
\fIAfter=\fR\&.
.sp
When
\fIBindsTo=b\&.service\fR
is used on
a\&.service, this dependency will show as
\fIBoundBy=a\&.service\fR
in property listing of
b\&.service\&.
\fIBoundBy=\fR
dependency cannot be specified directly\&.
.RE
.PP
\fIPartOf=\fR
.RS 4
Configures dependencies similar to
\fIRequires=\fR, but limited to stopping and restarting of units\&. When systemd stops or restarts the units listed here, the action is propagated to this unit\&. Note that this is a one\-way dependency\ \&\(em changes to this unit do not affect the listed units\&.
.sp
When
\fIPartOf=b\&.service\fR
is used on
a\&.service, this dependency will show as
\fIConsistsOf=a\&.service\fR
in property listing of
b\&.service\&.
\fIConsistsOf=\fR
dependency cannot be specified directly\&.
.RE
.PP
\fIUpholds=\fR
.RS 4
Configures dependencies similar to
\fIWants=\fR, but as long as this unit is up, all units listed in
\fIUpholds=\fR
are started whenever found to be inactive or failed, and no job is queued for them\&. While a
\fIWants=\fR
dependency on another unit has a one\-time effect when this units started, a
\fIUpholds=\fR
dependency on it has a continuous effect, constantly restarting the unit if necessary\&. This is an alternative to the
\fIRestart=\fR
setting of service units, to ensure they are kept running whatever happens\&. The restart happens without delay, and usual per\-unit rate\-limit applies\&.
.sp
When
\fIUpholds=b\&.service\fR
is used on
a\&.service, this dependency will show as
\fIUpheldBy=a\&.service\fR
in the property listing of
b\&.service\&.
.RE
.PP
\fIConflicts=\fR
.RS 4
A space\-separated list of unit names\&. Configures negative requirement dependencies\&. If a unit has a
\fIConflicts=\fR
setting on another unit, starting the former will stop the latter and vice versa\&.
.sp
Note that this setting does not imply an ordering dependency, similarly to the
\fIWants=\fR
and
\fIRequires=\fR
dependencies described above\&. This means that to ensure that the conflicting unit is stopped before the other unit is started, an
\fIAfter=\fR
or
\fIBefore=\fR
dependency must be declared\&. It doesn\*(Aqt matter which of the two ordering dependencies is used, because stop jobs are always ordered before start jobs, see the discussion in
\fIBefore=\fR/\fIAfter=\fR
below\&.
.sp
If unit A that conflicts with unit B is scheduled to be started at the same time as B, the transaction will either fail (in case both are required parts of the transaction) or be modified to be fixed (in case one or both jobs are not a required part of the transaction)\&. In the latter case, the job that is not required will be removed, or in case both are not required, the unit that conflicts will be started and the unit that is conflicted is stopped\&.
.RE
.PP
\fIBefore=\fR, \fIAfter=\fR
.RS 4
These two settings expect a space\-separated list of unit names\&. They may be specified more than once, in which case dependencies for all listed names are created\&.
.sp
Those two settings configure ordering dependencies between units\&. If unit
foo\&.service
contains the setting
\fBBefore=bar\&.service\fR
and both units are being started,
bar\&.service\*(Aqs start\-up is delayed until
foo\&.service
has finished starting up\&.
\fIAfter=\fR
is the inverse of
\fIBefore=\fR, i\&.e\&. while
\fIBefore=\fR
ensures that the configured unit is started before the listed unit begins starting up,
\fIAfter=\fR
ensures the opposite, that the listed unit is fully started up before the configured unit is started\&.
.sp
When two units with an ordering dependency between them are shut down, the inverse of the start\-up order is applied\&. I\&.e\&. if a unit is configured with
\fIAfter=\fR
on another unit, the former is stopped before the latter if both are shut down\&. Given two units with any ordering dependency between them, if one unit is shut down and the other is started up, the shutdown is ordered before the start\-up\&. It doesn\*(Aqt matter if the ordering dependency is
\fIAfter=\fR
or
\fIBefore=\fR, in this case\&. It also doesn\*(Aqt matter which of the two is shut down, as long as one is shut down and the other is started up; the shutdown is ordered before the start\-up in all cases\&. If two units have no ordering dependencies between them, they are shut down or started up simultaneously, and no ordering takes place\&. It depends on the unit type when precisely a unit has finished starting up\&. Most importantly, for service units start\-up is considered completed for the purpose of
\fIBefore=\fR/\fIAfter=\fR
when all its configured start\-up commands have been invoked and they either failed or reported start\-up success\&. Note that this does includes
\fIExecStartPost=\fR
(or
\fIExecStopPost=\fR
for the shutdown case)\&.
.sp
Note that those settings are independent of and orthogonal to the requirement dependencies as configured by
\fIRequires=\fR,
\fIWants=\fR,
\fIRequisite=\fR, or
\fIBindsTo=\fR\&. It is a common pattern to include a unit name in both the
\fIAfter=\fR
and
\fIWants=\fR
options, in which case the unit listed will be started before the unit that is configured with these options\&.
.sp
Note that
\fIBefore=\fR
dependencies on device units have no effect and are not supported\&. Devices generally become available as a result of an external hotplug event, and systemd creates the corresponding device unit without delay\&.
.RE
.PP
\fIOnFailure=\fR
.RS 4
A space\-separated list of one or more units that are activated when this unit enters the
"failed"
state\&.
.RE
.PP
\fIOnSuccess=\fR
.RS 4
A space\-separated list of one or more units that are activated when this unit enters the
"inactive"
state\&.
.RE
.PP
\fIPropagatesReloadTo=\fR, \fIReloadPropagatedFrom=\fR
.RS 4
A space\-separated list of one or more units to which reload requests from this unit shall be propagated to, or units from which reload requests shall be propagated to this unit, respectively\&. Issuing a reload request on a unit will automatically also enqueue reload requests on all units that are linked to it using these two settings\&.
.RE
.PP
\fIPropagatesStopTo=\fR, \fIStopPropagatedFrom=\fR
.RS 4
A space\-separated list of one or more units to which stop requests from this unit shall be propagated to, or units from which stop requests shall be propagated to this unit, respectively\&. Issuing a stop request on a unit will automatically also enqueue stop requests on all units that are linked to it using these two settings\&.
.RE
.PP
\fIJoinsNamespaceOf=\fR
.RS 4
For units that start processes (such as service units), lists one or more other units whose network and/or temporary file namespace to join\&. If this is specified on a unit (say, a\&.service has
\fIJoinsNamespaceOf=b\&.service\fR), then this the inverse dependency (\fIJoinsNamespaceOf=a\&.service\fR
for b\&.service) is implied\&. This only applies to unit types which support the
\fIPrivateNetwork=\fR,
\fINetworkNamespacePath=\fR,
\fIPrivateIPC=\fR,
\fIIPCNamespacePath=\fR, and
\fIPrivateTmp=\fR
directives (see
\fBsystemd.exec\fR(5)
for details)\&. If a unit that has this setting set is started, its processes will see the same
/tmp/,
/var/tmp/, IPC namespace and network namespace as one listed unit that is started\&. If multiple listed units are already started and these do not share their namespace, then it is not defined which namespace is joined\&. Note that this setting only has an effect if
\fIPrivateNetwork=\fR/\fINetworkNamespacePath=\fR,
\fIPrivateIPC=\fR/\fIIPCNamespacePath=\fR
and/or
\fIPrivateTmp=\fR
is enabled for both the unit that joins the namespace and the unit whose namespace is joined\&.
.RE
.PP
\fIRequiresMountsFor=\fR
.RS 4
Takes a space\-separated list of absolute paths\&. Automatically adds dependencies of type
\fIRequires=\fR
and
\fIAfter=\fR
for all mount units required to access the specified path\&.
.sp
Mount points marked with
\fBnoauto\fR
are not mounted automatically through
local\-fs\&.target, but are still honored for the purposes of this option, i\&.e\&. they will be pulled in by this unit\&.
.RE
.PP
\fIOnSuccessJobMode=\fR, \fIOnFailureJobMode=\fR
.RS 4
Takes a value of
"fail",
"replace",
"replace\-irreversibly",
"isolate",
"flush",
"ignore\-dependencies"
or
"ignore\-requirements"\&. Defaults to
"replace"\&. Specifies how the units listed in
\fIOnSuccess=\fR/\fIOnFailure=\fR
will be enqueued\&. See
\fBsystemctl\fR(1)\*(Aqs
\fB\-\-job\-mode=\fR
option for details on the possible values\&. If this is set to
"isolate", only a single unit may be listed in
\fIOnSuccess=\fR/\fIOnFailure=\fR\&.
.RE
.PP
\fIIgnoreOnIsolate=\fR
.RS 4
Takes a boolean argument\&. If
\fBtrue\fR, this unit will not be stopped when isolating another unit\&. Defaults to
\fBfalse\fR
for service, target, socket, timer, and path units, and
\fBtrue\fR
for slice, scope, device, swap, mount, and automount units\&.
.RE
.PP
\fIStopWhenUnneeded=\fR
.RS 4
Takes a boolean argument\&. If
\fBtrue\fR, this unit will be stopped when it is no longer used\&. Note that, in order to minimize the work to be executed, systemd will not stop units by default unless they are conflicting with other units, or the user explicitly requested their shut down\&. If this option is set, a unit will be automatically cleaned up if no other active unit requires it\&. Defaults to
\fBfalse\fR\&.
.RE
.PP
\fIRefuseManualStart=\fR, \fIRefuseManualStop=\fR
.RS 4
Takes a boolean argument\&. If
\fBtrue\fR, this unit can only be activated or deactivated indirectly\&. In this case, explicit start\-up or termination requested by the user is denied, however if it is started or stopped as a dependency of another unit, start\-up or termination will succeed\&. This is mostly a safety feature to ensure that the user does not accidentally activate units that are not intended to be activated explicitly, and not accidentally deactivate units that are not intended to be deactivated\&. These options default to
\fBfalse\fR\&.
.RE
.PP
\fIAllowIsolate=\fR
.RS 4
Takes a boolean argument\&. If
\fBtrue\fR, this unit may be used with the
\fBsystemctl isolate\fR
command\&. Otherwise, this will be refused\&. It probably is a good idea to leave this disabled except for target units that shall be used similar to runlevels in SysV init systems, just as a precaution to avoid unusable system states\&. This option defaults to
\fBfalse\fR\&.
.RE
.PP
\fIDefaultDependencies=\fR
.RS 4
Takes a boolean argument\&. If
\fByes\fR, (the default), a few default dependencies will implicitly be created for the unit\&. The actual dependencies created depend on the unit type\&. For example, for service units, these dependencies ensure that the service is started only after basic system initialization is completed and is properly terminated on system shutdown\&. See the respective man pages for details\&. Generally, only services involved with early boot or late shutdown should set this option to
\fBno\fR\&. It is highly recommended to leave this option enabled for the majority of common units\&. If set to
\fBno\fR, this option does not disable all implicit dependencies, just non\-essential ones\&.
.RE
.PP
\fICollectMode=\fR
.RS 4
Tweaks the "garbage collection" algorithm for this unit\&. Takes one of
\fBinactive\fR
or
\fBinactive\-or\-failed\fR\&. If set to
\fBinactive\fR
the unit will be unloaded if it is in the
\fBinactive\fR
state and is not referenced by clients, jobs or other units \(em however it is not unloaded if it is in the
\fBfailed\fR
state\&. In
\fBfailed\fR
mode, failed units are not unloaded until the user invoked
\fBsystemctl reset\-failed\fR
on them to reset the
\fBfailed\fR
state, or an equivalent command\&. This behaviour is altered if this option is set to
\fBinactive\-or\-failed\fR: in this case the unit is unloaded even if the unit is in a
\fBfailed\fR
state, and thus an explicitly resetting of the
\fBfailed\fR
state is not necessary\&. Note that if this mode is used unit results (such as exit codes, exit signals, consumed resources, \&...) are flushed out immediately after the unit completed, except for what is stored in the logging subsystem\&. Defaults to
\fBinactive\fR\&.
.RE
.PP
\fIFailureAction=\fR, \fISuccessAction=\fR
.RS 4
Configure the action to take when the unit stops and enters a failed state or inactive state\&. Takes one of
\fBnone\fR,
\fBreboot\fR,
\fBreboot\-force\fR,
\fBreboot\-immediate\fR,
\fBpoweroff\fR,
\fBpoweroff\-force\fR,
\fBpoweroff\-immediate\fR,
\fBexit\fR,
\fBexit\-force\fR,
\fBsoft\-reboot\fR,
\fBsoft\-reboot\-force\fR,
\fBkexec\fR,
\fBkexec\-force\fR,
\fBhalt\fR,
\fBhalt\-force\fR
and
\fBhalt\-immediate\fR\&. In system mode, all options are allowed\&. In user mode, only
\fBnone\fR,
\fBexit\fR,
\fBexit\-force\fR,
\fBsoft\-reboot\fR
and
\fBsoft\-reboot\-force\fR
are allowed\&. Both options default to
\fBnone\fR\&.
.sp
If
\fBnone\fR
is set, no action will be triggered\&.
\fBreboot\fR
causes a reboot following the normal shutdown procedure (i\&.e\&. equivalent to
\fBsystemctl reboot\fR)\&.
\fBreboot\-force\fR
causes a forced reboot which will terminate all processes forcibly but should cause no dirty file systems on reboot (i\&.e\&. equivalent to
\fBsystemctl reboot \-f\fR) and
\fBreboot\-immediate\fR
causes immediate execution of the
\fBreboot\fR(2)
system call, which might result in data loss (i\&.e\&. equivalent to
\fBsystemctl reboot \-ff\fR)\&. Similarly,
\fBpoweroff\fR,
\fBpoweroff\-force\fR,
\fBpoweroff\-immediate\fR,
\fBkexec\fR,
\fBkexec\-force\fR,
\fBhalt\fR,
\fBhalt\-force\fR
and
\fBhalt\-immediate\fR
have the effect of powering down the system, executing kexec, and halting the system respectively with similar semantics\&.
\fBexit\fR
causes the manager to exit following the normal shutdown procedure, and
\fBexit\-force\fR
causes it terminate without shutting down services\&. When
\fBexit\fR
or
\fBexit\-force\fR
is used by default the exit status of the main process of the unit (if this applies) is returned from the service manager\&. However, this may be overridden with
\fIFailureActionExitStatus=\fR/\fISuccessActionExitStatus=\fR, see below\&.
\fBsoft\-reboot\fR
will trigger a userspace reboot operation\&.
\fBsoft\-reboot\-force\fR
does that too, but does not go through the shutdown transaction beforehand\&.
.RE
.PP
\fIFailureActionExitStatus=\fR, \fISuccessActionExitStatus=\fR
.RS 4
Controls the exit status to propagate back to an invoking container manager (in case of a system service) or service manager (in case of a user manager) when the
\fIFailureAction=\fR/\fISuccessAction=\fR
are set to
\fBexit\fR
or
\fBexit\-force\fR
and the action is triggered\&. By default the exit status of the main process of the triggering unit (if this applies) is propagated\&. Takes a value in the range 0\&...255 or the empty string to request default behaviour\&.
.RE
.PP
\fIJobTimeoutSec=\fR, \fIJobRunningTimeoutSec=\fR
.RS 4
\fIJobTimeoutSec=\fR
specifies a timeout for the whole job that starts running when the job is queued\&.
\fIJobRunningTimeoutSec=\fR
specifies a timeout that starts running when the queued job is actually started\&. If either limit is reached, the job will be cancelled, the unit however will not change state or even enter the
"failed"
mode\&.
.sp
Both settings take a time span with the default unit of seconds, but other units may be specified, see
\fBsystemd.time\fR(5)\&. The default is
"infinity"
(job timeouts disabled), except for device units where
\fIJobRunningTimeoutSec=\fR
defaults to
\fIDefaultDeviceTimeoutSec=\fR\&.
.sp
Note: these timeouts are independent from any unit\-specific timeouts (for example, the timeout set with
\fITimeoutStartSec=\fR
in service units)\&. The job timeout has no effect on the unit itself\&. Or in other words: unit\-specific timeouts are useful to abort unit state changes, and revert them\&. The job timeout set with this option however is useful to abort only the job waiting for the unit state to change\&.
.RE
.PP
\fIJobTimeoutAction=\fR, \fIJobTimeoutRebootArgument=\fR
.RS 4
\fIJobTimeoutAction=\fR
optionally configures an additional action to take when the timeout is hit, see description of
\fIJobTimeoutSec=\fR
and
\fIJobRunningTimeoutSec=\fR
above\&. It takes the same values as
\fIStartLimitAction=\fR\&. Defaults to
\fBnone\fR\&.
.sp
\fIJobTimeoutRebootArgument=\fR
configures an optional reboot string to pass to the
\fBreboot\fR(2)
system call\&.
.RE
.PP
\fIStartLimitIntervalSec=\fR\fI\fIinterval\fR\fR, \fIStartLimitBurst=\fR\fI\fIburst\fR\fR
.RS 4
Configure unit start rate limiting\&. Units which are started more than
\fIburst\fR
times within an
\fIinterval\fR
time span are not permitted to start any more\&. Use
\fIStartLimitIntervalSec=\fR
to configure the checking interval and
\fIStartLimitBurst=\fR
to configure how many starts per interval are allowed\&.
.sp
\fIinterval\fR
is a time span with the default unit of seconds, but other units may be specified, see
\fBsystemd.time\fR(5)\&. Defaults to
\fIDefaultStartLimitIntervalSec=\fR
in manager configuration file, and may be set to 0 to disable any kind of rate limiting\&.
\fIburst\fR
is a number and defaults to
\fIDefaultStartLimitBurst=\fR
in manager configuration file\&.
.sp
These configuration options are particularly useful in conjunction with the service setting
\fIRestart=\fR
(see
\fBsystemd.service\fR(5)); however, they apply to all kinds of starts (including manual), not just those triggered by the
\fIRestart=\fR
logic\&.
.sp
Note that units which are configured for
\fIRestart=\fR, and which reach the start limit are not attempted to be restarted anymore; however, they may still be restarted manually or from a timer or socket at a later point, after the
\fIinterval\fR
has passed\&. From that point on, the restart logic is activated again\&.
\fBsystemctl reset\-failed\fR
will cause the restart rate counter for a service to be flushed, which is useful if the administrator wants to manually start a unit and the start limit interferes with that\&. Rate\-limiting is enforced after any unit condition checks are executed, and hence unit activations with failing conditions do not count towards the rate limit\&.
.sp
When a unit is unloaded due to the garbage collection logic (see above) its rate limit counters are flushed out too\&. This means that configuring start rate limiting for a unit that is not referenced continuously has no effect\&.
.sp
This setting does not apply to slice, target, device, and scope units, since they are unit types whose activation may either never fail, or may succeed only a single time\&.
.RE
.PP
\fIStartLimitAction=\fR
.RS 4
Configure an additional action to take if the rate limit configured with
\fIStartLimitIntervalSec=\fR
and
\fIStartLimitBurst=\fR
is hit\&. Takes the same values as the
\fIFailureAction=\fR/\fISuccessAction=\fR
settings\&. If
\fBnone\fR
is set, hitting the rate limit will trigger no action except that the start will not be permitted\&. Defaults to
\fBnone\fR\&.
.RE
.PP
\fIRebootArgument=\fR
.RS 4
Configure the optional argument for the
\fBreboot\fR(2)
system call if
\fIStartLimitAction=\fR
or
\fIFailureAction=\fR
is a reboot action\&. This works just like the optional argument to
\fBsystemctl reboot\fR
command\&.
.RE
.PP
\fISourcePath=\fR
.RS 4
A path to a configuration file this unit has been generated from\&. This is primarily useful for implementation of generator tools that convert configuration from an external configuration file format into native unit files\&. This functionality should not be used in normal units\&.
.RE
.SS "Conditions and Asserts"
.PP
Unit files may also include a number of
\fICondition\&...=\fR
and
\fIAssert\&...=\fR
settings\&. Before the unit is started, systemd will verify that the specified conditions and asserts are true\&. If not, the starting of the unit will be (mostly silently) skipped (in case of conditions), or aborted with an error message (in case of asserts)\&. Failing conditions or asserts will not result in the unit being moved into the
"failed"
state\&. The conditions and asserts are checked at the time the queued start job is to be executed\&. The ordering dependencies are still respected, so other units are still pulled in and ordered as if this unit was successfully activated, and the conditions and asserts are executed the precise moment the unit would normally start and thus can validate system state after the units ordered before completed initialization\&. Use condition expressions for skipping units that do not apply to the local system, for example because the kernel or runtime environment doesn\*(Aqt require their functionality\&.
.PP
If multiple conditions are specified, the unit will be executed if all of them apply (i\&.e\&. a logical AND is applied)\&. Condition checks can use a pipe symbol ("|") after the equals sign ("Condition\&...=|\&..."), which causes the condition to become a
\fItriggering\fR
condition\&. If at least one triggering condition is defined for a unit, then the unit will be started if at least one of the triggering conditions of the unit applies and all of the regular (i\&.e\&. non\-triggering) conditions apply\&. If you prefix an argument with the pipe symbol and an exclamation mark, the pipe symbol must be passed first, the exclamation second\&. If any of these options is assigned the empty string, the list of conditions is reset completely, all previous condition settings (of any kind) will have no effect\&.
.PP
The
\fIAssertArchitecture=\fR,
\fIAssertVirtualization=\fR, \&... options are similar to conditions but cause the start job to fail (instead of being skipped)\&. The failed check is logged\&. Units with unmet conditions are considered to be in a clean state and will be garbage collected if they are not referenced\&. This means that when queried, the condition failure may or may not show up in the state of the unit\&.
.PP
Note that neither assertion nor condition expressions result in unit state changes\&. Also note that both are checked at the time the job is to be executed, i\&.e\&. long after depending jobs and it itself were queued\&. Thus, neither condition nor assertion expressions are suitable for conditionalizing unit dependencies\&.
.PP
The
\fBcondition\fR
verb of
\fBsystemd-analyze\fR(1)
can be used to test condition and assert expressions\&.
.PP
Except for
\fIConditionPathIsSymbolicLink=\fR, all path checks follow symlinks\&.
.PP
\fIConditionArchitecture=\fR
.RS 4
Check whether the system is running on a specific architecture\&. Takes one of
"x86",
"x86\-64",
"ppc",
"ppc\-le",
"ppc64",
"ppc64\-le",
"ia64",
"parisc",
"parisc64",
"s390",
"s390x",
"sparc",
"sparc64",
"mips",
"mips\-le",
"mips64",
"mips64\-le",
"alpha",
"arm",
"arm\-be",
"arm64",
"arm64\-be",
"sh",
"sh64",
"m68k",
"tilegx",
"cris",
"arc",
"arc\-be", or
"native"\&.
.sp
The architecture is determined from the information returned by
\fBuname\fR(2)
and is thus subject to
\fBpersonality\fR(2)\&. Note that a
\fIPersonality=\fR
setting in the same unit file has no effect on this condition\&. A special architecture name
"native"
is mapped to the architecture the system manager itself is compiled for\&. The test may be negated by prepending an exclamation mark\&.
.RE
.PP
\fIConditionFirmware=\fR
.RS 4
Check whether the system\*(Aqs firmware is of a certain type\&. The following values are possible:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
"uefi"
matches systems with EFI\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
"device\-tree"
matches systems with a device tree\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
"device\-tree\-compatible(\fIvalue\fR)"
matches systems with a device tree that are compatible with
"value"\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
"smbios\-field(\fIfield\fR \fIoperator\fR \fIvalue\fR)"
matches systems with a SMBIOS field containing a certain value\&.
\fIfield\fR
is the name of the SMBIOS field exposed as
"sysfs"
attribute file below
/sys/class/dmi/id/\&.
\fIoperator\fR
is one of
"<",
"<=",
">=",
">",
"==",
"<>"
for version comparisons,
"="
and
"!="
for literal string comparisons, or
"$=",
"!$="
for shell\-style glob comparisons\&.
\fIvalue\fR
is the expected value of the SMBIOS field value (possibly containing shell style globs in case
"$="/"!$="
is used)\&.
.RE
.RE
.PP
\fIConditionVirtualization=\fR
.RS 4
Check whether the system is executed in a virtualized environment and optionally test whether it is a specific implementation\&. Takes either boolean value to check if being executed in any virtualized environment, or one of
"vm"
and
"container"
to test against a generic type of virtualization solution, or one of
"qemu",
"kvm",
"amazon",
"zvm",
"vmware",
"microsoft",
"oracle",
"powervm",
"xen",
"bochs",
"uml",
"bhyve",
"qnx",
"apple",
"sre",
"openvz",
"lxc",
"lxc\-libvirt",
"systemd\-nspawn",
"docker",
"podman",
"rkt",
"wsl",
"proot",
"pouch",
"acrn"
to test against a specific implementation, or
"private\-users"
to check whether we are running in a user namespace\&. See
\fBsystemd-detect-virt\fR(1)
for a full list of known virtualization technologies and their identifiers\&. If multiple virtualization technologies are nested, only the innermost is considered\&. The test may be negated by prepending an exclamation mark\&.
.RE
.PP
\fIConditionHost=\fR
.RS 4
\fIConditionHost=\fR
may be used to match against the hostname or machine ID of the host\&. This either takes a hostname string (optionally with shell style globs) which is tested against the locally set hostname as returned by
\fBgethostname\fR(2), or a machine ID formatted as string (see
\fBmachine-id\fR(5))\&. The test may be negated by prepending an exclamation mark\&.
.RE
.PP
\fIConditionKernelCommandLine=\fR
.RS 4
\fIConditionKernelCommandLine=\fR
may be used to check whether a specific kernel command line option is set (or if prefixed with the exclamation mark \(em unset)\&. The argument must either be a single word, or an assignment (i\&.e\&. two words, separated by
"=")\&. In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment\&. In the latter case, the exact assignment is looked for with right and left hand side matching\&. This operates on the kernel command line communicated to userspace via
/proc/cmdline, except when the service manager is invoked as payload of a container manager, in which case the command line of
PID 1
is used instead (i\&.e\&.
/proc/1/cmdline)\&.
.RE
.PP
\fIConditionKernelVersion=\fR
.RS 4
\fIConditionKernelVersion=\fR
may be used to check whether the kernel version (as reported by
\fBuname \-r\fR) matches a certain expression, or if prefixed with the exclamation mark, does not match\&. The argument must be a list of (potentially quoted) expressions\&. Each expression starts with one of
"="
or
"!="
for string comparisons,
"<",
"<=",
"==",
"<>",
">=",
">"
for version comparisons, or
"$=",
"!$="
for a shell\-style glob match\&. If no operator is specified,
"$="
is implied\&.
.sp
Note that using the kernel version string is an unreliable way to determine which features are supported by a kernel, because of the widespread practice of backporting drivers, features, and fixes from newer upstream kernels into older versions provided by distributions\&. Hence, this check is inherently unportable and should not be used for units which may be used on different distributions\&.
.RE
.PP
\fIConditionCredential=\fR
.RS 4
\fIConditionCredential=\fR
may be used to check whether a credential by the specified name was passed into the service manager\&. See
\m[blue]\fBSystem and Service Credentials\fR\m[]\&\s-2\u[2]\d\s+2
for details about credentials\&. If used in services for the system service manager this may be used to conditionalize services based on system credentials passed in\&. If used in services for the per\-user service manager this may be used to conditionalize services based on credentials passed into the
unit@\&.service
service instance belonging to the user\&. The argument must be a valid credential name\&.
.RE
.PP
\fIConditionEnvironment=\fR
.RS 4
\fIConditionEnvironment=\fR
may be used to check whether a specific environment variable is set (or if prefixed with the exclamation mark \(em unset) in the service manager\*(Aqs environment block\&. The argument may be a single word, to check if the variable with this name is defined in the environment block, or an assignment ("\fIname\fR=\fIvalue\fR"), to check if the variable with this exact value is defined\&. Note that the environment block of the service manager itself is checked, i\&.e\&. not any variables defined with
\fIEnvironment=\fR
or
\fIEnvironmentFile=\fR, as described above\&. This is particularly useful when the service manager runs inside a containerized environment or as per\-user service manager, in order to check for variables passed in by the enclosing container manager or PAM\&.
.RE
.PP
\fIConditionSecurity=\fR
.RS 4
\fIConditionSecurity=\fR
may be used to check whether the given security technology is enabled on the system\&. Currently, the recognized values are
"selinux",
"apparmor",
"tomoyo",
"ima",
"smack",
"audit",
"uefi\-secureboot",
"tpm2"
and
"cvm"\&. The test may be negated by prepending an exclamation mark\&.
.RE
.PP
\fIConditionCapability=\fR
.RS 4
Check whether the given capability exists in the capability bounding set of the service manager (i\&.e\&. this does not check whether capability is actually available in the permitted or effective sets, see
\fBcapabilities\fR(7)
for details)\&. Pass a capability name such as
"CAP_MKNOD", possibly prefixed with an exclamation mark to negate the check\&.
.RE
.PP
\fIConditionACPower=\fR
.RS 4
Check whether the system has AC power, or is exclusively battery powered at the time of activation of the unit\&. This takes a boolean argument\&. If set to
"true", the condition will hold only if at least one AC connector of the system is connected to a power source, or if no AC connectors are known\&. Conversely, if set to
"false", the condition will hold only if there is at least one AC connector known and all AC connectors are disconnected from a power source\&.
.RE
.PP
\fIConditionNeedsUpdate=\fR
.RS 4
Takes one of
/var/
or
/etc/
as argument, possibly prefixed with a
"!"
(to invert the condition)\&. This condition may be used to conditionalize units on whether the specified directory requires an update because
/usr/\*(Aqs modification time is newer than the stamp file
\&.updated
in the specified directory\&. This is useful to implement offline updates of the vendor operating system resources in
/usr/
that require updating of
/etc/
or
/var/
on the next following boot\&. Units making use of this condition should order themselves before
\fBsystemd-update-done.service\fR(8), to make sure they run before the stamp file\*(Aqs modification time gets reset indicating a completed update\&.
.sp
If the
\fIsystemd\&.condition\-needs\-update=\fR
option is specified on the kernel command line (taking a boolean), it will override the result of this condition check, taking precedence over any file modification time checks\&. If the kernel command line option is used,
systemd\-update\-done\&.service
will not have immediate effect on any following
\fIConditionNeedsUpdate=\fR
checks, until the system is rebooted where the kernel command line option is not specified anymore\&.
.sp
Note that to make this scheme effective, the timestamp of
/usr/
should be explicitly updated after its contents are modified\&. The kernel will automatically update modification timestamp on a directory only when immediate children of a directory are modified; an modification of nested files will not automatically result in mtime of
/usr/
being updated\&.
.sp
Also note that if the update method includes a call to execute appropriate post\-update steps itself, it should not touch the timestamp of
/usr/\&. In a typical distribution packaging scheme, packages will do any required update steps as part of the installation or upgrade, to make package contents immediately usable\&.
\fIConditionNeedsUpdate=\fR
should be used with other update mechanisms where such an immediate update does not happen\&.
.RE
.PP
\fIConditionFirstBoot=\fR
.RS 4
Takes a boolean argument\&. This condition may be used to conditionalize units on whether the system is booting up for the first time\&. This roughly means that
/etc/
was unpopulated when the system started booting (for details, see "First Boot Semantics" in
\fBmachine-id\fR(5))\&. First boot is considered finished (this condition will evaluate as false) after the manager has finished the startup phase\&.
.sp
This condition may be used to populate
/etc/
on the first boot after factory reset, or when a new system instance boots up for the first time\&.
.sp
For robustness, units with
\fIConditionFirstBoot=yes\fR
should order themselves before
first\-boot\-complete\&.target
and pull in this passive target with
\fIWants=\fR\&. This ensures that in a case of an aborted first boot, these units will be re\-run during the next system startup\&.
.sp
If the
\fIsystemd\&.condition\-first\-boot=\fR
option is specified on the kernel command line (taking a boolean), it will override the result of this condition check, taking precedence over
/etc/machine\-id
existence checks\&.
.RE
.PP
\fIConditionPathExists=\fR
.RS 4
Check for the existence of a file\&. If the specified absolute path name does not exist, the condition will fail\&. If the absolute path name passed to
\fIConditionPathExists=\fR
is prefixed with an exclamation mark ("!"), the test is negated, and the unit is only started if the path does not exist\&.
.RE
.PP
\fIConditionPathExistsGlob=\fR
.RS 4
\fIConditionPathExistsGlob=\fR
is similar to
\fIConditionPathExists=\fR, but checks for the existence of at least one file or directory matching the specified globbing pattern\&.
.RE
.PP
\fIConditionPathIsDirectory=\fR
.RS 4
\fIConditionPathIsDirectory=\fR
is similar to
\fIConditionPathExists=\fR
but verifies that a certain path exists and is a directory\&.
.RE
.PP
\fIConditionPathIsSymbolicLink=\fR
.RS 4
\fIConditionPathIsSymbolicLink=\fR
is similar to
\fIConditionPathExists=\fR
but verifies that a certain path exists and is a symbolic link\&.
.RE
.PP
\fIConditionPathIsMountPoint=\fR
.RS 4
\fIConditionPathIsMountPoint=\fR
is similar to
\fIConditionPathExists=\fR
but verifies that a certain path exists and is a mount point\&.
.RE
.PP
\fIConditionPathIsReadWrite=\fR
.RS 4
\fIConditionPathIsReadWrite=\fR
is similar to
\fIConditionPathExists=\fR
but verifies that the underlying file system is readable and writable (i\&.e\&. not mounted read\-only)\&.
.RE
.PP
\fIConditionPathIsEncrypted=\fR
.RS 4
\fIConditionPathIsEncrypted=\fR
is similar to
\fIConditionPathExists=\fR
but verifies that the underlying file system\*(Aqs backing block device is encrypted using dm\-crypt/LUKS\&. Note that this check does not cover ext4 per\-directory encryption, and only detects block level encryption\&. Moreover, if the specified path resides on a file system on top of a loopback block device, only encryption above the loopback device is detected\&. It is not detected whether the file system backing the loopback block device is encrypted\&.
.RE
.PP
\fIConditionDirectoryNotEmpty=\fR
.RS 4
\fIConditionDirectoryNotEmpty=\fR
is similar to
\fIConditionPathExists=\fR
but verifies that a certain path exists and is a non\-empty directory\&.
.RE
.PP
\fIConditionFileNotEmpty=\fR
.RS 4
\fIConditionFileNotEmpty=\fR
is similar to
\fIConditionPathExists=\fR
but verifies that a certain path exists and refers to a regular file with a non\-zero size\&.
.RE
.PP
\fIConditionFileIsExecutable=\fR
.RS 4
\fIConditionFileIsExecutable=\fR
is similar to
\fIConditionPathExists=\fR
but verifies that a certain path exists, is a regular file, and marked executable\&.
.RE
.PP
\fIConditionUser=\fR
.RS 4
\fIConditionUser=\fR
takes a numeric
"UID", a UNIX user name, or the special value
"@system"\&. This condition may be used to check whether the service manager is running as the given user\&. The special value
"@system"
can be used to check if the user id is within the system user range\&. This option is not useful for system services, as the system manager exclusively runs as the root user, and thus the test result is constant\&.
.RE
.PP
\fIConditionGroup=\fR
.RS 4
\fIConditionGroup=\fR
is similar to
\fIConditionUser=\fR
but verifies that the service manager\*(Aqs real or effective group, or any of its auxiliary groups, match the specified group or GID\&. This setting does not support the special value
"@system"\&.
.RE
.PP
\fIConditionControlGroupController=\fR
.RS 4
Check whether given cgroup controllers (e\&.g\&.
"cpu") are available for use on the system or whether the legacy v1 cgroup or the modern v2 cgroup hierarchy is used\&.
.sp
Multiple controllers may be passed with a space separating them; in this case the condition will only pass if all listed controllers are available for use\&. Controllers unknown to systemd are ignored\&. Valid controllers are
"cpu",
"io",
"memory", and
"pids"\&. Even if available in the kernel, a particular controller may not be available if it was disabled on the kernel command line with
\fIcgroup_disable=controller\fR\&.
.sp
Alternatively, two special strings
"v1"
and
"v2"
may be specified (without any controller names)\&.
"v2"
will pass if the unified v2 cgroup hierarchy is used, and
"v1"
will pass if the legacy v1 hierarchy or the hybrid hierarchy are used\&. Note that legacy or hybrid hierarchies have been deprecated\&. See
\fBsystemd\fR(1)
for more information\&.
.RE
.PP
\fIConditionMemory=\fR
.RS 4
Verify that the specified amount of system memory is available to the current system\&. Takes a memory size in bytes as argument, optionally prefixed with a comparison operator
"<",
"<=",
"="
(or
"=="),
"!="
(or
"<>"),
">=",
">"\&. On bare\-metal systems compares the amount of physical memory in the system with the specified size, adhering to the specified comparison operator\&. In containers compares the amount of memory assigned to the container instead\&.
.RE
.PP
\fIConditionCPUs=\fR
.RS 4
Verify that the specified number of CPUs is available to the current system\&. Takes a number of CPUs as argument, optionally prefixed with a comparison operator
"<",
"<=",
"="
(or
"=="),
"!="
(or
"<>"),
">=",
">"\&. Compares the number of CPUs in the CPU affinity mask configured of the service manager itself with the specified number, adhering to the specified comparison operator\&. On physical systems the number of CPUs in the affinity mask of the service manager usually matches the number of physical CPUs, but in special and virtual environments might differ\&. In particular, in containers the affinity mask usually matches the number of CPUs assigned to the container and not the physically available ones\&.
.RE
.PP
\fIConditionCPUFeature=\fR
.RS 4
Verify that a given CPU feature is available via the
"CPUID"
instruction\&. This condition only does something on i386 and x86\-64 processors\&. On other processors it is assumed that the CPU does not support the given feature\&. It checks the leaves
"1",
"7",
"0x80000001", and
"0x80000007"\&. Valid values are:
"fpu",
"vme",
"de",
"pse",
"tsc",
"msr",
"pae",
"mce",
"cx8",
"apic",
"sep",
"mtrr",
"pge",
"mca",
"cmov",
"pat",
"pse36",
"clflush",
"mmx",
"fxsr",
"sse",
"sse2",
"ht",
"pni",
"pclmul",
"monitor",
"ssse3",
"fma3",
"cx16",
"sse4_1",
"sse4_2",
"movbe",
"popcnt",
"aes",
"xsave",
"osxsave",
"avx",
"f16c",
"rdrand",
"bmi1",
"avx2",
"bmi2",
"rdseed",
"adx",
"sha_ni",
"syscall",
"rdtscp",
"lm",
"lahf_lm",
"abm",
"constant_tsc"\&.
.RE
.PP
\fIConditionOSRelease=\fR
.RS 4
Verify that a specific
"key=value"
pair is set in the host\*(Aqs
\fBos-release\fR(5)\&.
.sp
Other than exact string matching (with
"="
and
"!="), relative comparisons are supported for versioned parameters (e\&.g\&.
"VERSION_ID"; with
"<",
"<=",
"==",
"<>",
">=",
">"), and shell\-style wildcard comparisons ("*",
"?",
"[]") are supported with the
"$="
(match) and
"!$="
(non\-match)\&.
.RE
.PP
\fIConditionMemoryPressure=\fR, \fIConditionCPUPressure=\fR, \fIConditionIOPressure=\fR
.RS 4
Verify that the overall system (memory, CPU or IO) pressure is below or equal to a threshold\&. This setting takes a threshold value as argument\&. It can be specified as a simple percentage value, suffixed with
"%", in which case the pressure will be measured as an average over the last five minutes before the attempt to start the unit is performed\&. Alternatively, the average timespan can also be specified using
"/"
as a separator, for example:
"10%/1min"\&. The supported timespans match what the kernel provides, and are limited to
"10sec",
"1min"
and
"5min"\&. The
"full"
PSI will be checked first, and if not found
"some"
will be checked\&. For more details, see the documentation on
\m[blue]\fBPSI (Pressure Stall Information)\fR\m[]\&\s-2\u[3]\d\s+2\&.
.sp
Optionally, the threshold value can be prefixed with the slice unit under which the pressure will be checked, followed by a
":"\&. If the slice unit is not specified, the overall system pressure will be measured, instead of a particular cgroup\*(Aqs\&.
.RE
.PP
\fIAssertArchitecture=\fR, \fIAssertVirtualization=\fR, \fIAssertHost=\fR, \fIAssertKernelCommandLine=\fR, \fIAssertKernelVersion=\fR, \fIAssertCredential=\fR, \fIAssertEnvironment=\fR, \fIAssertSecurity=\fR, \fIAssertCapability=\fR, \fIAssertACPower=\fR, \fIAssertNeedsUpdate=\fR, \fIAssertFirstBoot=\fR, \fIAssertPathExists=\fR, \fIAssertPathExistsGlob=\fR, \fIAssertPathIsDirectory=\fR, \fIAssertPathIsSymbolicLink=\fR, \fIAssertPathIsMountPoint=\fR, \fIAssertPathIsReadWrite=\fR, \fIAssertPathIsEncrypted=\fR, \fIAssertDirectoryNotEmpty=\fR, \fIAssertFileNotEmpty=\fR, \fIAssertFileIsExecutable=\fR, \fIAssertUser=\fR, \fIAssertGroup=\fR, \fIAssertControlGroupController=\fR, \fIAssertMemory=\fR, \fIAssertCPUs=\fR, \fIAssertCPUFeature=\fR, \fIAssertOSRelease=\fR, \fIAssertMemoryPressure=\fR, \fIAssertCPUPressure=\fR, \fIAssertIOPressure=\fR
.RS 4
Similar to the
\fIConditionArchitecture=\fR,
\fIConditionVirtualization=\fR, \&..., condition settings described above, these settings add assertion checks to the start\-up of the unit\&. However, unlike the conditions settings, any assertion setting that is not met results in failure of the start job (which means this is logged loudly)\&. Note that hitting a configured assertion does not cause the unit to enter the
"failed"
state (or in fact result in any state change of the unit), it affects only the job queued for it\&. Use assertion expressions for units that cannot operate when specific requirements are not met, and when this is something the administrator or user should look into\&.
.RE
.SH "MAPPING OF UNIT PROPERTIES TO THEIR INVERSES"
.PP
Unit settings that create a relationship with a second unit usually show up in properties of both units, for example in
\fBsystemctl show\fR
output\&. In some cases the name of the property is the same as the name of the configuration setting, but not always\&. This table lists the properties that are shown on two units which are connected through some dependency, and shows which property on "source" unit corresponds to which property on the "target" unit\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&3.\ \& "Forward" and "reverse" unit properties
.TS
allbox tab(:);
lB lB lB s.
T{
"Forward" property
T}:T{
"Reverse" property
T}:T{
Where used
T}
.T&
l l l s
l l ^ ^
l l l l
l l l l
l l l l
l l l l
l l l l
l l l l
l l l l
l l l s
l l l s
l l ^ ^
l l l s
l l ^ ^
l l l l.
T{
\fIBefore=\fR
T}:T{
\fIAfter=\fR
T}:T{
[Unit] section
T}
T{
\fIAfter=\fR
T}:T{
\fIBefore=\fR
T}::
T{
\fIRequires=\fR
T}:T{
\fIRequiredBy=\fR
T}:T{
[Unit] section
T}:T{
[Install] section
T}
T{
\fIWants=\fR
T}:T{
\fIWantedBy=\fR
T}:T{
[Unit] section
T}:T{
[Install] section
T}
T{
\fIUpholds=\fR
T}:T{
\fIUpheldBy=\fR
T}:T{
[Unit] section
T}:T{
[Install] section
T}
T{
\fIPartOf=\fR
T}:T{
\fIConsistsOf=\fR
T}:T{
[Unit] section
T}:T{
an automatic property
T}
T{
\fIBindsTo=\fR
T}:T{
\fIBoundBy=\fR
T}:T{
[Unit] section
T}:T{
an automatic property
T}
T{
\fIRequisite=\fR
T}:T{
\fIRequisiteOf=\fR
T}:T{
[Unit] section
T}:T{
an automatic property
T}
T{
\fIConflicts=\fR
T}:T{
\fIConflictedBy=\fR
T}:T{
[Unit] section
T}:T{
an automatic property
T}
T{
\fITriggers=\fR
T}:T{
\fITriggeredBy=\fR
T}:T{
Automatic properties, see notes below
T}
T{
\fIPropagatesReloadTo=\fR
T}:T{
\fIReloadPropagatedFrom=\fR
T}:T{
[Unit] section
T}
T{
\fIReloadPropagatedFrom=\fR
T}:T{
\fIPropagatesReloadTo=\fR
T}::
T{
\fIPropagatesStopTo=\fR
T}:T{
\fIStopPropagatedFrom=\fR
T}:T{
[Unit] section
T}
T{
\fIStopPropagatedFrom=\fR
T}:T{
\fIPropagatesStopTo=\fR
T}::
T{
\fIFollowing=\fR
T}:T{
n/a
T}:T{
An automatic property
T}:T{
\ \&
T}
.TE
.sp 1
.PP
Note:
\fIWantedBy=\fR,
\fIRequiredBy=\fR, and
\fIUpheldBy=\fR
are used in the [Install] section to create symlinks in
\&.wants/,
\&.requires/, and
\&.upholds/
directories\&. They cannot be used directly as a unit configuration setting\&.
.PP
Note:
\fIConsistsOf=\fR,
\fIBoundBy=\fR,
\fIRequisiteOf=\fR,
\fIConflictedBy=\fR
are created implicitly along with their reverses and cannot be specified directly\&.
.PP
Note:
\fITriggers=\fR
is created implicitly between a socket, path unit, or an automount unit, and the unit they activate\&. By default a unit with the same name is triggered, but this can be overridden using
\fISockets=\fR,
\fIService=\fR, and
\fIUnit=\fR
settings\&. See
\fBsystemd.service\fR(5),
\fBsystemd.socket\fR(5),
\fBsystemd.path\fR(5), and
\fBsystemd.automount\fR(5)
for details\&.
\fITriggeredBy=\fR
is created implicitly on the triggered unit\&.
.PP
Note:
\fIFollowing=\fR
is used to group device aliases and points to the "primary" device unit that systemd is using to track device state, usually corresponding to a sysfs path\&. It does not show up in the "target" unit\&.
.SH "[INSTALL] SECTION OPTIONS"
.PP
Unit files may include an [Install] section, which carries installation information for the unit\&. This section is not interpreted by
\fBsystemd\fR(1)
during runtime; it is used by the
\fBenable\fR
and
\fBdisable\fR
commands of the
\fBsystemctl\fR(1)
tool during installation of a unit\&.
.PP
\fIAlias=\fR
.RS 4
A space\-separated list of additional names this unit shall be installed under\&. The names listed here must have the same suffix (i\&.e\&. type) as the unit filename\&. This option may be specified more than once, in which case all listed names are used\&. At installation time,
\fBsystemctl enable\fR
will create symlinks from these names to the unit filename\&. Note that not all unit types support such alias names, and this setting is not supported for them\&. Specifically, mount, slice, swap, and automount units do not support aliasing\&.
.RE
.PP
\fIWantedBy=\fR, \fIRequiredBy=\fR, \fIUpheldBy=\fR
.RS 4
This option may be used more than once, or a space\-separated list of unit names may be given\&. A symbolic link is created in the
\&.wants/,
\&.requires/, or
\&.upholds/
directory of each of the listed units when this unit is installed by
\fBsystemctl enable\fR\&. This has the effect of a dependency of type
\fIWants=\fR,
\fIRequires=\fR, or
\fIUpholds=\fR
being added from the listed unit to the current unit\&. See the description of the mentioned dependency types in the [Unit] section for details\&.
.sp
In case of template units listing non template units, the listing unit must have
\fIDefaultInstance=\fR
set, or
\fBsystemctl enable\fR
must be called with an instance name\&. The instance (default or specified) will be added to the
\&.wants/,
\&.requires/, or
\&.upholds/
list of the listed unit\&. For example,
\fBWantedBy=getty\&.target\fR
in a service
getty@\&.service
will result in
\fBsystemctl enable getty@tty2\&.service\fR
creating a
getty\&.target\&.wants/getty@tty2\&.service
link to
getty@\&.service\&. This also applies to listing specific instances of templated units: this specific instance will gain the dependency\&. A template unit may also list a template unit, in which case a generic dependency will be added where each instance of the listing unit will have a dependency on an instance of the listed template with the same instance value\&. For example,
\fBWantedBy=container@\&.target\fR
in a service
monitor@\&.service
will result in
\fBsystemctl enable monitor@\&.service\fR
creating a
container@\&.target\&.wants/monitor@\&.service
link to
monitor@\&.service, which applies to all instances of
container@\&.target\&.
.RE
.PP
\fIAlso=\fR
.RS 4
Additional units to install/deinstall when this unit is installed/deinstalled\&. If the user requests installation/deinstallation of a unit with this option configured,
\fBsystemctl enable\fR
and
\fBsystemctl disable\fR
will automatically install/uninstall units listed in this option as well\&.
.sp
This option may be used more than once, or a space\-separated list of unit names may be given\&.
.RE
.PP
\fIDefaultInstance=\fR
.RS 4
In template unit files, this specifies for which instance the unit shall be enabled if the template is enabled without any explicitly set instance\&. This option has no effect in non\-template unit files\&. The specified string must be usable as instance identifier\&.
.RE
.PP
The following specifiers are interpreted in the Install section: %a, %b, %B, %g, %G, %H, %i, %j, %l, %m, %n, %N, %o, %p, %u, %U, %v, %w, %W, %%\&. For their meaning see the next section\&.
.SH "SPECIFIERS"
.PP
Many settings resolve specifiers which may be used to write generic unit files referring to runtime or unit parameters that are replaced when the unit files are loaded\&. Specifiers must be known and resolvable for the setting to be valid\&. The following specifiers are understood:
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&4.\ \&Specifiers available in unit files
.TS
allbox tab(:);
lB lB lB.
T{
Specifier
T}:T{
Meaning
T}:T{
Details
T}
.T&
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l.
T{
"%a"
T}:T{
Architecture
T}:T{
A short string identifying the architecture of the local system\&. A string such as \fBx86\fR, \fBx86\-64\fR or \fBarm64\fR\&. See the architectures defined for \fIConditionArchitecture=\fR above for a full list\&.
T}
T{
"%A"
T}:T{
Operating system image version
T}:T{
The operating system image version identifier of the running system, as read from the \fIIMAGE_VERSION=\fR field of /etc/os\-release\&. If not set, resolves to an empty string\&. See \fBos-release\fR(5) for more information\&.
T}
T{
"%b"
T}:T{
Boot ID
T}:T{
The boot ID of the running system, formatted as string\&. See \fBrandom\fR(4) for more information\&.
T}
T{
"%B"
T}:T{
Operating system build ID
T}:T{
The operating system build identifier of the running system, as read from the \fIBUILD_ID=\fR field of /etc/os\-release\&. If not set, resolves to an empty string\&. See \fBos-release\fR(5) for more information\&.
T}
T{
"%C"
T}:T{
Cache directory root
T}:T{
This is either /var/cache (for the system manager) or the path "$XDG_CACHE_HOME" resolves to (for user managers)\&.
T}
T{
"%d"
T}:T{
Credentials directory
T}:T{
This is the value of the "$CREDENTIALS_DIRECTORY" environment variable if available\&. See section "Credentials" in \fBsystemd.exec\fR(5) for more information\&.
T}
T{
"%E"
T}:T{
Configuration directory root
T}:T{
This is either /etc/ (for the system manager) or the path "$XDG_CONFIG_HOME" resolves to (for user managers)\&.
T}
T{
"%f"
T}:T{
Unescaped filename
T}:T{
This is either the unescaped instance name (if applicable) with / prepended (if applicable), or the unescaped prefix name prepended with /\&. This implements unescaping according to the rules for escaping absolute file system paths discussed above\&.
T}
T{
"%g"
T}:T{
User group
T}:T{
This is the name of the group running the service manager instance\&. In case of the system manager this resolves to "root"\&.
T}
T{
"%G"
T}:T{
User GID
T}:T{
This is the numeric GID of the user running the service manager instance\&. In case of the system manager this resolves to "0"\&.
T}
T{
"%h"
T}:T{
User home directory
T}:T{
This is the home directory of the \fIuser running the service manager instance\fR\&. In case of the system manager this resolves to "/root"\&.
Note that this setting is \fInot\fR influenced by the \fIUser=\fR setting configurable in the [Service] section of the service unit\&.
T}
T{
"%H"
T}:T{
Host name
T}:T{
The hostname of the running system at the point in time the unit configuration is loaded\&.
T}
T{
"%i"
T}:T{
Instance name
T}:T{
For instantiated units this is the string between the first "@" character and the type suffix\&. Empty for non\-instantiated units\&.
T}
T{
"%I"
T}:T{
Unescaped instance name
T}:T{
Same as "%i", but with escaping undone\&.
T}
T{
"%j"
T}:T{
Final component of the prefix
T}:T{
This is the string between the last "\-" and the end of the prefix name\&. If there is no "\-", this is the same as "%p"\&.
T}
T{
"%J"
T}:T{
Unescaped final component of the prefix
T}:T{
Same as "%j", but with escaping undone\&.
T}
T{
"%l"
T}:T{
Short host name
T}:T{
The hostname of the running system at the point in time the unit configuration is loaded, truncated at the first dot to remove any domain component\&.
T}
T{
"%L"
T}:T{
Log directory root
T}:T{
This is either /var/log (for the system manager) or the path \fI$XDG_STATE_HOME\fR resolves to with /log appended (for user managers)\&.
T}
T{
"%m"
T}:T{
Machine ID
T}:T{
The machine ID of the running system, formatted as string\&. See \fBmachine-id\fR(5) for more information\&.
T}
T{
"%M"
T}:T{
Operating system image identifier
T}:T{
The operating system image identifier of the running system, as read from the \fIIMAGE_ID=\fR field of /etc/os\-release\&. If not set, resolves to an empty string\&. See \fBos-release\fR(5) for more information\&.
T}
T{
"%n"
T}:T{
Full unit name
T}:T{
\ \&
T}
T{
"%N"
T}:T{
Full unit name
T}:T{
Same as "%n", but with the type suffix removed\&.
T}
T{
"%o"
T}:T{
Operating system ID
T}:T{
The operating system identifier of the running system, as read from the \fIID=\fR field of /etc/os\-release\&. See \fBos-release\fR(5) for more information\&.
T}
T{
"%p"
T}:T{
Prefix name
T}:T{
For instantiated units, this refers to the string before the first "@" character of the unit name\&. For non\-instantiated units, same as "%N"\&.
T}
T{
"%P"
T}:T{
Unescaped prefix name
T}:T{
Same as "%p", but with escaping undone\&.
T}
T{
"%q"
T}:T{
Pretty host name
T}:T{
The pretty hostname of the running system at the point in time the unit configuration is loaded, as read from the \fIPRETTY_HOSTNAME=\fR field of /etc/machine\-info\&. If not set, resolves to the short hostname\&. See \fBmachine-info\fR(5) for more information\&.
T}
T{
"%s"
T}:T{
User shell
T}:T{
This is the shell of the user running the service manager instance\&.
T}
T{
"%S"
T}:T{
State directory root
T}:T{
This is either /var/lib (for the system manager) or the path \fI$XDG_STATE_HOME\fR resolves to (for user managers)\&.
T}
T{
"%t"
T}:T{
Runtime directory root
T}:T{
This is either /run/ (for the system manager) or the path "$XDG_RUNTIME_DIR" resolves to (for user managers)\&.
T}
T{
"%T"
T}:T{
Directory for temporary files
T}:T{
This is either /tmp or the path "$TMPDIR", "$TEMP" or "$TMP" are set to\&. (Note that the directory may be specified without a trailing slash\&.)
T}
T{
"%u"
T}:T{
User name
T}:T{
This is the name of the \fIuser running the service manager instance\fR\&. In case of the system manager this resolves to "root"\&.
Note that this setting is \fInot\fR influenced by the \fIUser=\fR setting configurable in the [Service] section of the service unit\&.
T}
T{
"%U"
T}:T{
User UID
T}:T{
This is the numeric UID of the \fIuser running the service manager instance\fR\&. In case of the system manager this resolves to "0"\&.
Note that this setting is \fInot\fR influenced by the \fIUser=\fR setting configurable in the [Service] section of the service unit\&.
T}
T{
"%v"
T}:T{
Kernel release
T}:T{
Identical to \fBuname \-r\fR output\&.
T}
T{
"%V"
T}:T{
Directory for larger and persistent temporary files
T}:T{
This is either /var/tmp or the path "$TMPDIR", "$TEMP" or "$TMP" are set to\&. (Note that the directory may be specified without a trailing slash\&.)
T}
T{
"%w"
T}:T{
Operating system version ID
T}:T{
The operating system version identifier of the running system, as read from the \fIVERSION_ID=\fR field of /etc/os\-release\&. If not set, resolves to an empty string\&. See \fBos-release\fR(5) for more information\&.
T}
T{
"%W"
T}:T{
Operating system variant ID
T}:T{
The operating system variant identifier of the running system, as read from the \fIVARIANT_ID=\fR field of /etc/os\-release\&. If not set, resolves to an empty string\&. See \fBos-release\fR(5) for more information\&.
T}
T{
"%y"
T}:T{
The path to the fragment
T}:T{
This is the path where the main part of the unit file is located\&. For linked unit files, the real path outside of the unit search directories is used\&. For units that don\*(Aqt have a fragment file, this specifier will raise an error\&.
T}
T{
"%Y"
T}:T{
The directory of the fragment
T}:T{
This is the directory part of "%y"\&.
T}
T{
"%%"
T}:T{
Single percent sign
T}:T{
Use "%%" in place of "%" to specify a single percent sign\&.
T}
.TE
.sp 1
.SH "EXAMPLES"
.PP
\fBExample\ \&1.\ \&Allowing units to be enabled\fR
.PP
The following snippet (highlighted) allows a unit (e\&.g\&.
foo\&.service) to be enabled via
\fBsystemctl enable\fR:
.sp
.if n \{\
.RS 4
.\}
.nf
[Unit]
Description=Foo
[Service]
ExecStart=/usr/sbin/foo\-daemon
\fI[Install]\fR
\fIWantedBy=multi\-user\&.target\fR
.fi
.if n \{\
.RE
.\}
.PP
After running
\fBsystemctl enable\fR, a symlink
/etc/systemd/system/multi\-user\&.target\&.wants/foo\&.service
linking to the actual unit will be created\&. It tells systemd to pull in the unit when starting
multi\-user\&.target\&. The inverse
\fBsystemctl disable\fR
will remove that symlink again\&.
.PP
\fBExample\ \&2.\ \&Overriding vendor settings\fR
.PP
There are two methods of overriding vendor settings in unit files: copying the unit file from
/usr/lib/systemd/system
to
/etc/systemd/system
and modifying the chosen settings\&. Alternatively, one can create a directory named
\fIunit\fR\&.d/
within
/etc/systemd/system
and place a drop\-in file
\fIname\fR\&.conf
there that only changes the specific settings one is interested in\&. Note that multiple such drop\-in files are read if present, processed in lexicographic order of their filename\&.
.PP
The advantage of the first method is that one easily overrides the complete unit, the vendor unit is not parsed at all anymore\&. It has the disadvantage that improvements to the unit file by the vendor are not automatically incorporated on updates\&.
.PP
The advantage of the second method is that one only overrides the settings one specifically wants, where updates to the unit by the vendor automatically apply\&. This has the disadvantage that some future updates by the vendor might be incompatible with the local changes\&.
.PP
This also applies for user instances of systemd, but with different locations for the unit files\&. See the section on unit load paths for further details\&.
.PP
Suppose there is a vendor\-supplied unit
/usr/lib/systemd/system/httpd\&.service
with the following contents:
.sp
.if n \{\
.RS 4
.\}
.nf
[Unit]
Description=Some HTTP server
After=remote\-fs\&.target sqldb\&.service
Requires=sqldb\&.service
AssertPathExists=/srv/webserver
[Service]
Type=notify
ExecStart=/usr/sbin/some\-fancy\-httpd\-server
Nice=5
[Install]
WantedBy=multi\-user\&.target
.fi
.if n \{\
.RE
.\}
.PP
Now one wants to change some settings as an administrator: firstly, in the local setup,
/srv/webserver
might not exist, because the HTTP server is configured to use
/srv/www
instead\&. Secondly, the local configuration makes the HTTP server also depend on a memory cache service,
memcached\&.service, that should be pulled in (\fIRequires=\fR) and also be ordered appropriately (\fIAfter=\fR)\&. Thirdly, in order to harden the service a bit more, the administrator would like to set the
\fIPrivateTmp=\fR
setting (see
\fBsystemd.exec\fR(5)
for details)\&. And lastly, the administrator would like to reset the niceness of the service to its default value of 0\&.
.PP
The first possibility is to copy the unit file to
/etc/systemd/system/httpd\&.service
and change the chosen settings:
.sp
.if n \{\
.RS 4
.\}
.nf
[Unit]
Description=Some HTTP server
After=remote\-fs\&.target sqldb\&.service \fImemcached\&.service\fR
Requires=sqldb\&.service \fImemcached\&.service\fR
AssertPathExists=\fI/srv/www\fR
[Service]
Type=notify
ExecStart=/usr/sbin/some\-fancy\-httpd\-server
\fINice=0\fR
\fIPrivateTmp=yes\fR
[Install]
WantedBy=multi\-user\&.target
.fi
.if n \{\
.RE
.\}
.PP
Alternatively, the administrator could create a drop\-in file
/etc/systemd/system/httpd\&.service\&.d/local\&.conf
with the following contents:
.sp
.if n \{\
.RS 4
.\}
.nf
[Unit]
After=memcached\&.service
Requires=memcached\&.service
# Reset all assertions and then re\-add the condition we want
AssertPathExists=
AssertPathExists=/srv/www
[Service]
Nice=0
PrivateTmp=yes
.fi
.if n \{\
.RE
.\}
.PP
Note that for drop\-in files, if one wants to remove entries from a setting that is parsed as a list (and is not a dependency), such as
\fIAssertPathExists=\fR
(or e\&.g\&.
\fIExecStart=\fR
in service units), one needs to first clear the list before re\-adding all entries except the one that is to be removed\&. Dependencies (\fIAfter=\fR, etc\&.) cannot be reset to an empty list, so dependencies can only be added in drop\-ins\&. If you want to remove dependencies, you have to override the entire unit\&.
.PP
\fBExample\ \&3.\ \&Top level drop\-ins with template units\fR
.PP
Top level per\-type drop\-ins can be used to change some aspect of all units of a particular type\&. For example, by creating the
/etc/systemd/system/service\&.d/
directory with a drop\-in file, the contents of the drop\-in file can be applied to all service units\&. We can take this further by having the top\-level drop\-in instantiate a secondary helper unit\&. Consider for example the following set of units and drop\-in files where we install an
\fIOnFailure=\fR
dependency for all service units\&.
.PP
/etc/systemd/system/failure\-handler@\&.service:
.sp
.if n \{\
.RS 4
.\}
.nf
[Unit]
Description=My failure handler for %i
[Service]
Type=oneshot
# Perform some special action for when %i exits unexpectedly\&.
ExecStart=/usr/sbin/myfailurehandler %i
.fi
.if n \{\
.RE
.\}
.PP
We can then add an instance of
failure\-handler@\&.service
as an
\fIOnFailure=\fR
dependency for all service units\&.
.PP
/etc/systemd/system/service\&.d/10\-all\&.conf:
.sp
.if n \{\
.RS 4
.\}
.nf
[Unit]
OnFailure=failure\-handler@%N\&.service
.fi
.if n \{\
.RE
.\}
.PP
Now, after running
\fBsystemctl daemon\-reload\fR
all services will have acquired an
\fIOnFailure=\fR
dependency on
failure\-handler@%N\&.service\&. The template instance units will also have gained the dependency which results in the creation of a recursive dependency chain\&. systemd will try to detect these recursive dependency chains where a template unit directly and recursively depends on itself and will remove such dependencies automatically if it finds them\&. If systemd doesn\*(Aqt detect the recursive dependency chain, we can break the chain ourselves by disabling the drop\-in for the template instance units via a symlink to
/dev/null:
.sp
.if n \{\
.RS 4
.\}
.nf
\fBmkdir /etc/systemd/system/failure\-handler@\&.service\&.d/\fR
\fBln \-s /dev/null /etc/systemd/system/failure\-handler@\&.service\&.d/10\-all\&.conf\fR
\fBsystemctl daemon\-reload\fR
.fi
.if n \{\
.RE
.\}
.PP
This ensures that if a
failure\-handler@\&.service
instance fails it will not trigger an instance named
failure\-handler@failure\-handler\&.service\&.
.SH "SEE ALSO"
.PP
\fBsystemd\fR(1),
\fBsystemctl\fR(1),
\fBsystemd-system.conf\fR(5),
\fBsystemd.special\fR(7),
\fBsystemd.service\fR(5),
\fBsystemd.socket\fR(5),
\fBsystemd.device\fR(5),
\fBsystemd.mount\fR(5),
\fBsystemd.automount\fR(5),
\fBsystemd.swap\fR(5),
\fBsystemd.target\fR(5),
\fBsystemd.path\fR(5),
\fBsystemd.timer\fR(5),
\fBsystemd.scope\fR(5),
\fBsystemd.slice\fR(5),
\fBsystemd.time\fR(7),
\fBsystemd-analyze\fR(1),
\fBcapabilities\fR(7),
\fBsystemd.directives\fR(7),
\fBuname\fR(1)
.SH "NOTES"
.IP " 1." 4
Interface Portability and Stability Promise
.RS 4
\%https://systemd.io/PORTABILITY_AND_STABILITY/
.RE
.IP " 2." 4
System and Service Credentials
.RS 4
\%https://systemd.io/CREDENTIALS
.RE
.IP " 3." 4
PSI (Pressure Stall Information)
.RS 4
\%https://docs.kernel.org/accounting/psi.html
.RE
|