-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathserver.html
More file actions
801 lines (764 loc) · 64.5 KB
/
server.html
File metadata and controls
801 lines (764 loc) · 64.5 KB
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
<!DOCTYPE html>
<html lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="stylesheet" type="text/css" href="../_static/css/bootstrap.min.css" />
<link rel="stylesheet" type="text/css" href="../_static/css/bootstrap-theme.min.css" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@3" />
<meta name="docsearch:version" content="3.x" />
<meta name="docsearch:language" content="en" />
<title>Server Operations — pyinfra documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/guzzle.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=5349f25f" />
<link rel="stylesheet" type="text/css" href="../_static/guzzle.css?v=fb44425a" />
<script src="../_static/documentation_options.js?v=5929fcd5"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="icon" href="../_static/logo_small.png"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Snap Operations" href="snap.html" />
<link rel="prev" title="Selinux Operations" href="selinux.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="snap.html" title="Snap Operations"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="selinux.html" title="Selinux Operations"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Home</a> »</li>
<li class="nav-item nav-item-1"><a href="../operations.html" accesskey="U">Operations Index</a> »</li>
<li class="nav-item nav-item-this"><a href="">Server Operations</a></li>
</ul>
</div>
<div class="container-wrapper">
<header>
<nav>
<a target="_blank" href="https://pyinfra.com">pyinfra.com<span class="glyphicon glyphicon glyphicon-share" aria-hidden="true"></span></a>
<a target="_blank" href="https://github.com/Fizzadar/pyinfra">GitHub<span class="glyphicon glyphicon glyphicon-share" aria-hidden="true"></span></a>
</nav>
<div id="header-sidebar">
<a href="../index.html" class="text-logo">
<img src="../_static/logo_small.png" />
pyinfra <small>3.x</small>
</a>
<form id="main-search" class="form-inline" action="../search.html" method="GET" role="form">
<div id="docsearch">
<input id="search-input" name="q" type="text" class="form-control" placeholder="Search...">
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</div>
</form>
</div>
<div id="mobile-toggle">
<a id="toggle-menu" href="#"><span class="glyphicon glyphicon-align-justify" aria-hidden="true"></span></a>
<a href="../index.html" class="text-logo">
<img src="../_static/logo_small.png" />
</a>
</div>
</header>
<div id="left-column">
<div class="sphinxsidebar">
<div class="sidebar-block">
<div class="sidebar-toc">
<p class="caption" role="heading"><span class="caption-text">Using pyinfra</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../getting-started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../using-operations.html">Using Operations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../inventory-data.html">Inventory & Data</a></li>
<li class="toctree-l1"><a class="reference internal" href="../arguments.html">Global Arguments</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cli.html">Using the CLI</a></li>
<li class="toctree-l1"><a class="reference internal" href="../faq.html">Frequently Asked Questions</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Deploy Reference</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../operations.html">Operations Index</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="apk.html">Apk Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="apt.html">Apt Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="brew.html">Brew Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="bsdinit.html">Bsdinit Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="cargo.html">Cargo Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="choco.html">Choco Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="crontab.html">Crontab Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="dnf.html">Dnf Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="docker.html">Docker Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="files.html">Files Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="flatpak.html">Flatpak Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="gem.html">Gem Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="git.html">Git Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="iptables.html">Iptables Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="launchd.html">Launchd Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="lxd.html">Lxd Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="mysql.html">Mysql Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="npm.html">Npm Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="openrc.html">Openrc Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="opkg.html">Opkg Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="pacman.html">Pacman Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="pip.html">Pip Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="pipx.html">Pipx Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="pkg.html">Pkg Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="pkgin.html">Pkgin Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="postgres.html">Postgres Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="postgresql.html">Postgresql Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="puppet.html">Puppet Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="python.html">Python Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="runit.html">Runit Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="selinux.html">Selinux Operations</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Server Operations</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#server-group"><code class="code docutils literal notranslate"><span class="pre">server.group</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#server-hostname"><code class="code docutils literal notranslate"><span class="pre">server.hostname</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#server-locale"><code class="code docutils literal notranslate"><span class="pre">server.locale</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#server-modprobe"><code class="code docutils literal notranslate"><span class="pre">server.modprobe</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#server-mount"><code class="code docutils literal notranslate"><span class="pre">server.mount</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#server-packages"><code class="code docutils literal notranslate"><span class="pre">server.packages</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#server-reboot"><code class="code docutils literal notranslate"><span class="pre">server.reboot</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#server-script"><code class="code docutils literal notranslate"><span class="pre">server.script</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#server-script-template"><code class="code docutils literal notranslate"><span class="pre">server.script_template</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#server-security-limit"><code class="code docutils literal notranslate"><span class="pre">server.security_limit</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#server-service"><code class="code docutils literal notranslate"><span class="pre">server.service</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#server-shell"><code class="code docutils literal notranslate"><span class="pre">server.shell</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#server-sysctl"><code class="code docutils literal notranslate"><span class="pre">server.sysctl</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#server-timezone"><code class="code docutils literal notranslate"><span class="pre">server.timezone</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#server-user"><code class="code docutils literal notranslate"><span class="pre">server.user</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#server-user-authorized-keys"><code class="code docutils literal notranslate"><span class="pre">server.user_authorized_keys</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#server-wait"><code class="code docutils literal notranslate"><span class="pre">server.wait</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="snap.html">Snap Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="ssh.html">Ssh Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="systemd.html">Systemd Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="sysvinit.html">Sysvinit Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="upstart.html">Upstart Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="vzctl.html">Vzctl Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="xbps.html">Xbps Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="yum.html">Yum Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="zfs.html">Zfs Operations</a></li>
<li class="toctree-l2"><a class="reference internal" href="zypper.html">Zypper Operations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../facts.html">Facts Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="../connectors.html">Connectors Index</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">How pyinfra Works</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../deploy-process.html">How pyinfra Works</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/deploys.html">Packaging Deploys</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/operations.html">Writing Operations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/facts.html">Writing Facts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/connectors.html">Writing Connectors</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/index.html">Using the API</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Meta</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../support.html">Help & Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../compatibility.html">Compatibility</a></li>
<li class="toctree-l1"><a class="reference internal" href="../performance.html">Performance</a></li>
<li class="toctree-l1"><a class="reference internal" href="../changes.html">Changes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../api/reference.html">API Reference</a></li>
</ul>
</div>
</div>
</div>
</div>
<div id="right-column">
<div class="document clearer body" role="main">
<section id="server-operations">
<h1>Server Operations<a class="headerlink" href="#server-operations" title="Link to this heading">¶</a></h1>
<p>The server module takes care of os-level state. Targets POSIX compatibility, tested on
Linux/BSD.</p>
<p>Facts used in these operations: <a class="reference internal" href="../facts/files.html#facts-files-directory"><span class="std std-ref">files.Directory</span></a>, <a class="reference internal" href="../facts/files.html#facts-files-findinfile"><span class="std std-ref">files.FindInFile</span></a>, <a class="reference internal" href="../facts/server.html#facts-server-groups"><span class="std std-ref">server.Groups</span></a>, <a class="reference internal" href="../facts/server.html#facts-server-home"><span class="std std-ref">server.Home</span></a>, <a class="reference internal" href="../facts/server.html#facts-server-hostname"><span class="std std-ref">server.Hostname</span></a>, <a class="reference internal" href="../facts/server.html#facts-server-kernel"><span class="std std-ref">server.Kernel</span></a>, <a class="reference internal" href="../facts/server.html#facts-server-kernelmodules"><span class="std std-ref">server.KernelModules</span></a>, <a class="reference internal" href="../facts/files.html#facts-files-link"><span class="std std-ref">files.Link</span></a>, <a class="reference internal" href="../facts/server.html#facts-server-locales"><span class="std std-ref">server.Locales</span></a>, <a class="reference internal" href="../facts/server.html#facts-server-mounts"><span class="std std-ref">server.Mounts</span></a>, <a class="reference internal" href="../facts/server.html#facts-server-os"><span class="std std-ref">server.Os</span></a>, <a class="reference internal" href="../facts/server.html#facts-server-sysctl"><span class="std std-ref">server.Sysctl</span></a>, <a class="reference internal" href="../facts/server.html#facts-server-timezone"><span class="std std-ref">server.Timezone</span></a>, <a class="reference internal" href="../facts/server.html#facts-server-users"><span class="std std-ref">server.Users</span></a>, <a class="reference internal" href="../facts/server.html#facts-server-which"><span class="std std-ref">server.Which</span></a>.</p>
<section id="server-group">
<span id="operations-server-group"></span><h2><code class="code docutils literal notranslate"><span class="pre">server.group</span></code><a class="headerlink" href="#server-group" title="Link to this heading">¶</a></h2>
<p>Add/remove system groups.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="n">group</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">present</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">system</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">gid</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p><strong>group</strong>: name of the group to ensure</p></li>
<li><p><strong>present</strong>: whether the group should be present or not</p></li>
<li><p><strong>system</strong>: whether to create a system group</p></li>
<li><p><strong>gid</strong>: use a specific groupid number</p></li>
</ul>
<dl class="simple">
<dt>System users:</dt><dd><p>System users don’t exist on BSD, so the argument is ignored for BSD targets.</p>
</dd>
</dl>
<p><strong>Examples:</strong></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">group</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"Create docker group"</span><span class="p">,</span>
<span class="n">group</span><span class="o">=</span><span class="s2">"docker"</span><span class="p">,</span>
<span class="p">)</span>
<span class="c1"># multiple groups</span>
<span class="k">for</span> <span class="n">group</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">"wheel"</span><span class="p">,</span> <span class="s2">"lusers"</span><span class="p">]:</span>
<span class="n">server</span><span class="o">.</span><span class="n">group</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="sa">f</span><span class="s2">"Create the group </span><span class="si">{</span><span class="n">group</span><span class="si">}</span><span class="s2">"</span><span class="p">,</span>
<span class="n">group</span><span class="o">=</span><span class="n">group</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
<dl class="simple">
<dt>Note:</dt><dd><p>This operation also inherits all <a class="reference internal" href="../arguments.html"><span class="doc">global arguments</span></a>.</p>
</dd>
</dl>
</section>
<section id="server-hostname">
<span id="operations-server-hostname"></span><h2><code class="code docutils literal notranslate"><span class="pre">server.hostname</span></code><a class="headerlink" href="#server-hostname" title="Link to this heading">¶</a></h2>
<p>Set the system hostname using <code class="docutils literal notranslate"><span class="pre">hostnamectl</span></code> or <code class="docutils literal notranslate"><span class="pre">hostname</span></code> on older systems.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">hostname</span><span class="p">(</span><span class="n">hostname</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">hostname_file</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p><strong>hostname</strong>: the hostname that should be set</p></li>
<li><p><strong>hostname_file</strong>: the file that permanently sets the hostname</p></li>
</ul>
<dl>
<dt>Hostname file:</dt><dd><p>The hostname file only matters on systems that do not have <code class="docutils literal notranslate"><span class="pre">hostnamectl</span></code>,
which is part of <code class="docutils literal notranslate"><span class="pre">systemd</span></code>.</p>
<p>By default pyinfra will auto detect this by targeting <code class="docutils literal notranslate"><span class="pre">/etc/hostname</span></code>
on Linux and <code class="docutils literal notranslate"><span class="pre">/etc/myname</span></code> on OpenBSD.</p>
<p>To completely disable writing the hostname file, set <code class="docutils literal notranslate"><span class="pre">hostname_file=False</span></code>.</p>
</dd>
</dl>
<p><strong>Example:</strong></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">hostname</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"Set the hostname"</span><span class="p">,</span>
<span class="n">hostname</span><span class="o">=</span><span class="s2">"server1.example.com"</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
<dl class="simple">
<dt>Note:</dt><dd><p>This operation also inherits all <a class="reference internal" href="../arguments.html"><span class="doc">global arguments</span></a>.</p>
</dd>
</dl>
</section>
<section id="server-locale">
<span id="operations-server-locale"></span><h2><code class="code docutils literal notranslate"><span class="pre">server.locale</span></code><a class="headerlink" href="#server-locale" title="Link to this heading">¶</a></h2>
<p>Enable/Disable locale.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">locale</span><span class="p">(</span><span class="n">locale</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">present</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p><strong>locale</strong>: name of the locale to enable/disable</p></li>
<li><p><strong>present</strong>: whether this locale should be present or not</p></li>
</ul>
<p><strong>Examples:</strong></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">locale</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"Ensure en_GB.UTF-8 locale is not present"</span><span class="p">,</span>
<span class="n">locale</span><span class="o">=</span><span class="s2">"en_GB.UTF-8"</span><span class="p">,</span>
<span class="n">present</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">server</span><span class="o">.</span><span class="n">locale</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"Ensure en_GB.UTF-8 locale is present"</span><span class="p">,</span>
<span class="n">locale</span><span class="o">=</span><span class="s2">"en_GB.UTF-8"</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
<dl class="simple">
<dt>Note:</dt><dd><p>This operation also inherits all <a class="reference internal" href="../arguments.html"><span class="doc">global arguments</span></a>.</p>
</dd>
</dl>
</section>
<section id="server-modprobe">
<span id="operations-server-modprobe"></span><h2><code class="code docutils literal notranslate"><span class="pre">server.modprobe</span></code><a class="headerlink" href="#server-modprobe" title="Link to this heading">¶</a></h2>
<p>Load/unload kernel modules.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">modprobe</span><span class="p">(</span><span class="n">module</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">present</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">force</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p><strong>module</strong>: name of the module to manage</p></li>
<li><p><strong>present</strong>: whether the module should be loaded or not</p></li>
<li><p><strong>force</strong>: whether to force any add/remove modules</p></li>
</ul>
<p><strong>Example:</strong></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">modprobe</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"Silly example for modprobe"</span><span class="p">,</span>
<span class="n">module</span><span class="o">=</span><span class="s2">"floppy"</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
<dl class="simple">
<dt>Note:</dt><dd><p>This operation also inherits all <a class="reference internal" href="../arguments.html"><span class="doc">global arguments</span></a>.</p>
</dd>
</dl>
</section>
<section id="server-mount">
<span id="operations-server-mount"></span><h2><code class="code docutils literal notranslate"><span class="pre">server.mount</span></code><a class="headerlink" href="#server-mount" title="Link to this heading">¶</a></h2>
<p>Manage mounted filesystems.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">mount</span><span class="p">(</span>
<span class="n">path</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">mounted</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">options</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">device</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">fs_type</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p><strong>path</strong>: the path of the mounted filesystem</p></li>
<li><p><strong>mounted</strong>: whether the filesystem should be mounted</p></li>
<li><p><strong>options</strong>: the mount options</p></li>
</ul>
<dl class="simple">
<dt>Options:</dt><dd><p>If the currently mounted filesystem does not have all of the provided
options it will be remounted with the options provided.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">/etc/fstab</span></code>:</dt><dd><p>This operation does not attempt to modify the on disk fstab file - for
that you should use the <a class="reference external" href="./files.html#files-line">files.line operation</a>.</p>
</dd>
<dt>Note:</dt><dd><p>This operation also inherits all <a class="reference internal" href="../arguments.html"><span class="doc">global arguments</span></a>.</p>
</dd>
</dl>
</section>
<section id="server-packages">
<span id="operations-server-packages"></span><h2><code class="code docutils literal notranslate"><span class="pre">server.packages</span></code><a class="headerlink" href="#server-packages" title="Link to this heading">¶</a></h2>
<p>Add or remove system packages. This command checks for the presence of all the
system package managers pyinfra can handle and executes the relevant operation.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">packages</span><span class="p">(</span><span class="n">packages</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">present</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p><strong>packages</strong>: list of packages to ensure</p></li>
<li><p><strong>present</strong>: whether the packages should be installed</p></li>
</ul>
<p><strong>Example:</strong></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">packages</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"Install Vim and vimpager"</span><span class="p">,</span>
<span class="n">packages</span><span class="o">=</span><span class="p">[</span><span class="s2">"vimpager"</span><span class="p">,</span> <span class="s2">"vim"</span><span class="p">],</span>
<span class="p">)</span>
</pre></div>
</div>
<dl class="simple">
<dt>Note:</dt><dd><p>This operation also inherits all <a class="reference internal" href="../arguments.html"><span class="doc">global arguments</span></a>.</p>
</dd>
</dl>
</section>
<section id="server-reboot">
<span id="operations-server-reboot"></span><h2><code class="code docutils literal notranslate"><span class="pre">server.reboot</span></code><a class="headerlink" href="#server-reboot" title="Link to this heading">¶</a></h2>
<div class="important admonition">
<p class="admonition-title">Stateless operation</p>
<p>This operation will always execute commands and is not idempotent.</p>
</div>
<p>Reboot the server and wait for reconnection.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">reboot</span><span class="p">(</span><span class="n">delay</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> <span class="n">interval</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">reboot_timeout</span><span class="o">=</span><span class="mi">300</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p><strong>delay</strong>: number of seconds to wait before attempting reconnect</p></li>
<li><p><strong>interval</strong>: interval (s) between reconnect attempts</p></li>
<li><p><strong>reboot_timeout</strong>: total time before giving up reconnecting</p></li>
</ul>
<p><strong>Example:</strong></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">pyinfra.operations</span><span class="w"> </span><span class="kn">import</span> <span class="n">server</span>
<span class="n">server</span><span class="o">.</span><span class="n">reboot</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"Reboot the server and wait to reconnect"</span><span class="p">,</span>
<span class="n">delay</span><span class="o">=</span><span class="mi">60</span><span class="p">,</span>
<span class="n">reboot_timeout</span><span class="o">=</span><span class="mi">600</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
<dl class="simple">
<dt>Note:</dt><dd><p>This operation also inherits all <a class="reference internal" href="../arguments.html"><span class="doc">global arguments</span></a>.</p>
</dd>
</dl>
</section>
<section id="server-script">
<span id="operations-server-script"></span><h2><code class="code docutils literal notranslate"><span class="pre">server.script</span></code><a class="headerlink" href="#server-script" title="Link to this heading">¶</a></h2>
<div class="important admonition">
<p class="admonition-title">Stateless operation</p>
<p>This operation will always execute commands and is not idempotent.</p>
</div>
<p>Upload and execute a local script on the remote host.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">script</span><span class="p">(</span><span class="n">src</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="p">(),</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p><strong>src</strong>: local script filename to upload & execute</p></li>
<li><p><strong>args</strong>: iterable to pass as arguments to the script</p></li>
</ul>
<p><strong>Example:</strong></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Note: This assumes there is a file in files/hello.bash locally.</span>
<span class="n">server</span><span class="o">.</span><span class="n">script</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"Hello"</span><span class="p">,</span>
<span class="n">src</span><span class="o">=</span><span class="s2">"files/hello.bash"</span><span class="p">,</span>
<span class="p">)</span>
<span class="c1"># Example passing arguments to the script</span>
<span class="n">server</span><span class="o">.</span><span class="n">script</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"Hello"</span><span class="p">,</span>
<span class="n">src</span><span class="o">=</span><span class="s2">"files/hello.bash"</span><span class="p">,</span>
<span class="n">args</span><span class="o">=</span><span class="p">(</span><span class="s2">"do-something"</span><span class="p">,</span> <span class="s2">"with-this"</span><span class="p">),</span>
<span class="p">)</span>
</pre></div>
</div>
<dl class="simple">
<dt>Note:</dt><dd><p>This operation also inherits all <a class="reference internal" href="../arguments.html"><span class="doc">global arguments</span></a>.</p>
</dd>
</dl>
</section>
<section id="server-script-template">
<span id="operations-server-script-template"></span><h2><code class="code docutils literal notranslate"><span class="pre">server.script_template</span></code><a class="headerlink" href="#server-script-template" title="Link to this heading">¶</a></h2>
<div class="important admonition">
<p class="admonition-title">Stateless operation</p>
<p>This operation will always execute commands and is not idempotent.</p>
</div>
<p>Generate, upload and execute a local script template on the remote host.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">script_template</span><span class="p">(</span><span class="n">src</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="p">(),</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p><strong>src</strong>: local script template filename</p></li>
</ul>
<p><strong>Example:</strong></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Example showing how to pass python variable to a script template file.</span>
<span class="c1"># The .j2 file can use `{{ some_var }}` to be interpolated.</span>
<span class="c1"># To see output need to run pyinfra with '-v'</span>
<span class="c1"># Note: This assumes there is a file in templates/hello2.bash.j2 locally.</span>
<span class="n">some_var</span> <span class="o">=</span> <span class="s1">'blah blah blah '</span>
<span class="n">server</span><span class="o">.</span><span class="n">script_template</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"Hello from script"</span><span class="p">,</span>
<span class="n">src</span><span class="o">=</span><span class="s2">"templates/hello2.bash.j2"</span><span class="p">,</span>
<span class="n">some_var</span><span class="o">=</span><span class="n">some_var</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
<dl class="simple">
<dt>Note:</dt><dd><p>This operation also inherits all <a class="reference internal" href="../arguments.html"><span class="doc">global arguments</span></a>.</p>
</dd>
</dl>
</section>
<section id="server-security-limit">
<span id="operations-server-security-limit"></span><h2><code class="code docutils literal notranslate"><span class="pre">server.security_limit</span></code><a class="headerlink" href="#server-security-limit" title="Link to this heading">¶</a></h2>
<p>Edit /etc/security/limits.conf configuration.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">security_limit</span><span class="p">(</span><span class="n">domain</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">limit_type</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">item</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">value</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p><strong>domain</strong>: the domain (user, group, or wildcard) for the limit</p></li>
<li><p><strong>limit_type</strong>: the type of limit (hard or soft)</p></li>
<li><p><strong>item</strong>: the item to limit (e.g., nofile, nproc)</p></li>
<li><p><strong>value</strong>: the value for the limit</p></li>
</ul>
<p><strong>Example:</strong></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">security_limit</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"Set nofile limit for all users"</span><span class="p">,</span>
<span class="n">domain</span><span class="o">=</span><span class="s1">'*'</span><span class="p">,</span>
<span class="n">limit_type</span><span class="o">=</span><span class="s1">'soft'</span><span class="p">,</span>
<span class="n">item</span><span class="o">=</span><span class="s1">'nofile'</span><span class="p">,</span>
<span class="n">value</span><span class="o">=</span><span class="mi">1024</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
<dl class="simple">
<dt>Note:</dt><dd><p>This operation also inherits all <a class="reference internal" href="../arguments.html"><span class="doc">global arguments</span></a>.</p>
</dd>
</dl>
</section>
<section id="server-service">
<span id="operations-server-service"></span><h2><code class="code docutils literal notranslate"><span class="pre">server.service</span></code><a class="headerlink" href="#server-service" title="Link to this heading">¶</a></h2>
<p>Manage the state of services. This command checks for the presence of all the
Linux init systems pyinfra can handle and executes the relevant operation.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">service</span><span class="p">(</span>
<span class="n">service</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">running</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">restarted</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">reloaded</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">command</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">enabled</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p><strong>service</strong>: name of the service to manage</p></li>
<li><p><strong>running</strong>: whether the service should be running</p></li>
<li><p><strong>restarted</strong>: whether the service should be restarted</p></li>
<li><p><strong>reloaded</strong>: whether the service should be reloaded</p></li>
<li><p><strong>command</strong>: custom command execute</p></li>
<li><p><strong>enabled</strong>: whether this service should be enabled/disabled on boot</p></li>
</ul>
<p><strong>Example:</strong></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">service</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"Enable open-vm-tools service"</span><span class="p">,</span>
<span class="n">service</span><span class="o">=</span><span class="s2">"open-vm-tools"</span><span class="p">,</span>
<span class="n">enabled</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
<dl class="simple">
<dt>Note:</dt><dd><p>This operation also inherits all <a class="reference internal" href="../arguments.html"><span class="doc">global arguments</span></a>.</p>
</dd>
</dl>
</section>
<section id="server-shell">
<span id="operations-server-shell"></span><h2><code class="code docutils literal notranslate"><span class="pre">server.shell</span></code><a class="headerlink" href="#server-shell" title="Link to this heading">¶</a></h2>
<div class="important admonition">
<p class="admonition-title">Stateless operation</p>
<p>This operation will always execute commands and is not idempotent.</p>
</div>
<p>Run raw shell code on server during a deploy. If the command would
modify data that would be in a fact, the fact would not be updated
since facts are only run at the start of a deploy.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">shell</span><span class="p">(</span><span class="n">commands</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p><strong>commands</strong>: command or list of commands to execute on the remote server</p></li>
</ul>
<p><strong>Example:</strong></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">shell</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"Run lxd auto init"</span><span class="p">,</span>
<span class="n">commands</span><span class="o">=</span><span class="p">[</span><span class="s2">"lxd init --auto"</span><span class="p">],</span>
<span class="p">)</span>
</pre></div>
</div>
<dl class="simple">
<dt>Note:</dt><dd><p>This operation also inherits all <a class="reference internal" href="../arguments.html"><span class="doc">global arguments</span></a>.</p>
</dd>
</dl>
</section>
<section id="server-sysctl">
<span id="operations-server-sysctl"></span><h2><code class="code docutils literal notranslate"><span class="pre">server.sysctl</span></code><a class="headerlink" href="#server-sysctl" title="Link to this heading">¶</a></h2>
<p>Edit sysctl configuration.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">sysctl</span><span class="p">(</span>
<span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">value</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">int</span> <span class="o">|</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span> <span class="o">|</span> <span class="nb">int</span><span class="p">],</span> <span class="n">persist</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="n">persist_file</span><span class="o">=</span><span class="s2">"/etc/sysctl.conf"</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p><strong>key</strong>: name of the sysctl setting to ensure</p></li>
<li><p><strong>value</strong>: the value or list of values the sysctl should be</p></li>
<li><p><strong>persist</strong>: whether to write this sysctl to the config</p></li>
<li><p><strong>persist_file</strong>: file to write the sysctl to persist on reboot</p></li>
</ul>
<p><strong>Example:</strong></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">sysctl</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"Change the fs.file-max value"</span><span class="p">,</span>
<span class="n">key</span><span class="o">=</span><span class="s2">"fs.file-max"</span><span class="p">,</span>
<span class="n">value</span><span class="o">=</span><span class="mi">100000</span><span class="p">,</span>
<span class="n">persist</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
<dl class="simple">
<dt>Note:</dt><dd><p>This operation also inherits all <a class="reference internal" href="../arguments.html"><span class="doc">global arguments</span></a>.</p>
</dd>
</dl>
</section>
<section id="server-timezone">
<span id="operations-server-timezone"></span><h2><code class="code docutils literal notranslate"><span class="pre">server.timezone</span></code><a class="headerlink" href="#server-timezone" title="Link to this heading">¶</a></h2>
<p>Set the system timezone.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">timezone</span><span class="p">(</span><span class="n">timezone</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<p>Uses <code class="docutils literal notranslate"><span class="pre">timedatectl</span></code> when available (systemd systems), otherwise falls back to
symlinking <code class="docutils literal notranslate"><span class="pre">/etc/localtime</span></code> directly.</p>
<ul class="simple">
<li><p><strong>timezone</strong>: the timezone to set (e.g. <code class="docutils literal notranslate"><span class="pre">Europe/Amsterdam</span></code>, <code class="docutils literal notranslate"><span class="pre">UTC</span></code>)</p></li>
</ul>
<p><strong>Example:</strong></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">timezone</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"Set the timezone to Europe/Amsterdam"</span><span class="p">,</span>
<span class="n">timezone</span><span class="o">=</span><span class="s2">"Europe/Amsterdam"</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
<dl class="simple">
<dt>Note:</dt><dd><p>This operation also inherits all <a class="reference internal" href="../arguments.html"><span class="doc">global arguments</span></a>.</p>
</dd>
</dl>
</section>
<section id="server-user">
<span id="operations-server-user"></span><h2><code class="code docutils literal notranslate"><span class="pre">server.user</span></code><a class="headerlink" href="#server-user" title="Link to this heading">¶</a></h2>
<p>Add/remove/update system users & their ssh <cite>authorized_keys</cite>.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">user</span><span class="p">(</span>
<span class="n">user</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">present</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">home</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">shell</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">group</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">groups</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">append</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="n">public_keys</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">delete_keys</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">ensure_home</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">create_home</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">system</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">uid</span><span class="p">:</span> <span class="nb">int</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">comment</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">unique</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">password</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p><strong>user</strong>: name of the user to ensure</p></li>
<li><p><strong>present</strong>: whether this user should exist</p></li>
<li><p><strong>home</strong>: the users home directory</p></li>
<li><p><strong>shell</strong>: the users shell</p></li>
<li><p><strong>group</strong>: the users primary group</p></li>
<li><p><strong>groups</strong>: the users secondary groups</p></li>
<li><p><strong>append</strong>: whether to add <cite>user</cite> to <cite>groups</cite>, w/o losing membership of other groups</p></li>
<li><p><strong>public_keys</strong>: list of public keys to attach to this user, <code class="docutils literal notranslate"><span class="pre">home</span></code> must be specified</p></li>
<li><p><strong>delete_keys</strong>: whether to remove any keys not specified in <code class="docutils literal notranslate"><span class="pre">public_keys</span></code></p></li>
<li><p><strong>ensure_home</strong>: whether to ensure the <code class="docutils literal notranslate"><span class="pre">home</span></code> directory exists</p></li>
<li><p><strong>create_home</strong>: whether user create new user home directories from the system skeleton</p></li>
<li><p><strong>system</strong>: whether to create a system account</p></li>
<li><p><strong>uid</strong>: use a specific userid number</p></li>
<li><p><strong>comment</strong>: the user GECOS comment</p></li>
<li><p><strong>unique</strong>: prevent creating users with duplicate UID</p></li>
<li><p><strong>password</strong>: set the encrypted password for the user</p></li>
</ul>
<dl class="simple">
<dt>Home directory:</dt><dd><p>When <code class="docutils literal notranslate"><span class="pre">ensure_home</span></code> or <code class="docutils literal notranslate"><span class="pre">public_keys</span></code> are provided, <code class="docutils literal notranslate"><span class="pre">home</span></code> defaults to
<code class="docutils literal notranslate"><span class="pre">/home/{name}</span></code>. When <code class="docutils literal notranslate"><span class="pre">create_home</span></code> is <code class="docutils literal notranslate"><span class="pre">True</span></code> any newly created users
will be created with the <code class="docutils literal notranslate"><span class="pre">-m</span></code> flag to build a new home directory from the
systems skeleton directory.</p>
</dd>
<dt>Public keys:</dt><dd><p>These can be provided as strings containing the public key or as a path to
a public key file which pyinfra will read.</p>
</dd>
</dl>
<p><strong>Examples:</strong></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">user</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"Ensure user is removed"</span><span class="p">,</span>
<span class="n">user</span><span class="o">=</span><span class="s2">"kevin"</span><span class="p">,</span>
<span class="n">present</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">server</span><span class="o">.</span><span class="n">user</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"Ensure myweb user exists"</span><span class="p">,</span>
<span class="n">user</span><span class="o">=</span><span class="s2">"myweb"</span><span class="p">,</span>
<span class="n">shell</span><span class="o">=</span><span class="s2">"/bin/bash"</span><span class="p">,</span>
<span class="p">)</span>
<span class="c1"># multiple users</span>
<span class="k">for</span> <span class="n">user</span> <span class="ow">in</span> <span class="p">[</span><span class="s2">"kevin"</span><span class="p">,</span> <span class="s2">"bob"</span><span class="p">]:</span>
<span class="n">server</span><span class="o">.</span><span class="n">user</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="sa">f</span><span class="s2">"Ensure user </span><span class="si">{</span><span class="n">user</span><span class="si">}</span><span class="s2"> is removed"</span><span class="p">,</span>
<span class="n">user</span><span class="o">=</span><span class="n">user</span><span class="p">,</span>
<span class="n">present</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
<dl class="simple">
<dt>Note:</dt><dd><p>This operation also inherits all <a class="reference internal" href="../arguments.html"><span class="doc">global arguments</span></a>.</p>
</dd>
</dl>
</section>
<section id="server-user-authorized-keys">
<span id="operations-server-user-authorized-keys"></span><h2><code class="code docutils literal notranslate"><span class="pre">server.user_authorized_keys</span></code><a class="headerlink" href="#server-user-authorized-keys" title="Link to this heading">¶</a></h2>
<p>Manage <cite>authorized_keys</cite> of system users.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">user_authorized_keys</span><span class="p">(</span>
<span class="n">user</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">public_keys</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">group</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">delete_keys</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
<span class="n">authorized_key_directory</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">authorized_key_filename</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p><strong>user</strong>: name of the user to ensure</p></li>
<li><p><strong>public_keys</strong>: list of public keys to attach to this user, <code class="docutils literal notranslate"><span class="pre">home</span></code> must be specified</p></li>
<li><p><strong>group</strong>: the users primary group</p></li>
<li><p><strong>delete_keys</strong>: whether to remove any keys not specified in <code class="docutils literal notranslate"><span class="pre">public_keys</span></code></p></li>
</ul>
<dl class="simple">
<dt>Public keys:</dt><dd><p>These can be provided as strings containing the public key or as a path to
a public key file which pyinfra will read.</p>
</dd>
</dl>
<p><strong>Examples:</strong></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">user_authorized_keys</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"Ensure user has a public key"</span><span class="p">,</span>
<span class="n">user</span><span class="o">=</span><span class="s2">"kevin"</span><span class="p">,</span>
<span class="n">public_keys</span><span class="o">=</span><span class="p">[</span><span class="s2">"ed25519..."</span><span class="p">],</span>
<span class="p">)</span>
</pre></div>
</div>
<dl class="simple">
<dt>Note:</dt><dd><p>This operation also inherits all <a class="reference internal" href="../arguments.html"><span class="doc">global arguments</span></a>.</p>
</dd>
</dl>
</section>
<section id="server-wait">
<span id="operations-server-wait"></span><h2><code class="code docutils literal notranslate"><span class="pre">server.wait</span></code><a class="headerlink" href="#server-wait" title="Link to this heading">¶</a></h2>
<div class="important admonition">
<p class="admonition-title">Stateless operation</p>
<p>This operation will always execute commands and is not idempotent.</p>
</div>
<p>Waits for a port to come active on the target machine. Requires netstat, checks every
second.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">wait</span><span class="p">(</span><span class="n">port</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<ul class="simple">
<li><p><strong>port</strong>: port number to wait for</p></li>
</ul>
<p><strong>Example:</strong></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">wait</span><span class="p">(</span>
<span class="n">name</span><span class="o">=</span><span class="s2">"Wait for webserver to start"</span><span class="p">,</span>
<span class="n">port</span><span class="o">=</span><span class="mi">80</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
<dl class="simple">
<dt>Note:</dt><dd><p>This operation also inherits all <a class="reference internal" href="../arguments.html"><span class="doc">global arguments</span></a>.</p>
</dd>
</dl>
</section>
</section>
</div>
<nav class="footer-relations">
<ul class="pager">
<li class="previous"><a href="selinux.html">
<span aria-hidden="true">←</span> Selinux Operations
</a></li>
<li class="next"><a href="snap.html">
Snap Operations <span aria-hidden="true">→</span>
</a></li>
</ul>
</nav>
<div class="clearer"></div>
</div>
<div class="clearfix"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="snap.html" title="Snap Operations"
>next</a> |</li>
<li class="right" >
<a href="selinux.html" title="Selinux Operations"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Home</a> »</li>
<li class="nav-item nav-item-1"><a href="../operations.html" >Operations Index</a> »</li>
<li class="nav-item nav-item-this"><a href="">Server Operations</a></li>
</ul>
</div>
<script type="text/javascript" src="../_static/js/jquery.min.js"></script>
<script type="text/javascript" src="../_static/js/bootstrap.min.js"></script>
<script type="text/javascript">
$("a#toggle-menu").click(function () {
$("#left-column").slideToggle(100);
});
var currentIndexItem = document.querySelector('ul.current ul.current li.current');
if (currentIndexItem) {
currentIndexItem.scrollIntoView({'block': 'center'});
}
</script>
<div class="footer">
</div>
<script src="https://cdn.jsdelivr.net/npm/@docsearch/js@3"></script>
<script type="text/javascript">
docsearch({
apiKey: '25a25b5f5310f306641f9ce07dcb06eb',
appId: 'XXGX6EX4KA',
indexName: 'pyinfra',
container: '#docsearch',
searchParameters: {
facetFilters: ["version:3.x", "lang:en"],
},
debug: false,
});
</script>
<script async defer data-domain="docs.pyinfra.com" src="https://stats.oxygem.com/js/index.js"></script>
</body>
</html>