File: facts.rst

package info (click to toggle)
pyinfra 0.2.2%2Bgit20161227.ec708ef-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 11,804 kB
  • ctags: 677
  • sloc: python: 5,944; sh: 71; makefile: 11
file content (477 lines) | stat: -rw-r--r-- 7,131 bytes parent folder | download
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
Facts Index
===========

.. include:: facts_.rst


Apt
---

:code:`apt_sources`
~~~~~~~~~~~~~~~~~~~


    Returns a list of installed apt sources:

    .. code:: python

        {
            'type': 'deb',
            'url': 'http://archive.ubuntu.org',
            'distribution': 'trusty',
            'components', ['main', 'multiverse']
        },
        ...
    


:code:`deb_package(name)`
~~~~~~~~~~~~~~~~~~~~~~~~~


    Returns information on a .deb file.
    


:code:`deb_packages`
~~~~~~~~~~~~~~~~~~~~


    Returns a dict of installed dpkg packages:

    .. code:: python

        'package_name': 'version',
        ...
    


Devices
-------

:code:`block_devices`
~~~~~~~~~~~~~~~~~~~~~


    Returns a dict of (mounted) block devices:

    .. code:: python

        '/dev/sda1': {
            'available': '39489508',
            'used_percent': '3',
            'mount': '/',
            'used': '836392',
            'blocks': '40325900'
        },
        ...
    


:code:`network_devices`
~~~~~~~~~~~~~~~~~~~~~~~


    Gets & returns a dict of network devices:

    .. code:: python

        'eth0': {
            'ipv4': {
                'address': '127.0.0.1',
                'netmask': '255.255.255.255',
                'broadcast': '127.0.0.13'
            },
            'ipv6': {
                'size': '64',
                'address': 'fe80::a00:27ff:fec3:36f0'
            }
        },
        ...
    


Files
-----

:code:`directory(name)`
~~~~~~~~~~~~~~~~~~~~~~~


:code:`file(name)`
~~~~~~~~~~~~~~~~~~


:code:`find_directories(name)`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


    Returns a list of directories from a start point, recursively using find.
    


:code:`find_files(name)`
~~~~~~~~~~~~~~~~~~~~~~~~


    Returns a list of files from a start point, recursively using find.
    


:code:`find_in_file(name)`
~~~~~~~~~~~~~~~~~~~~~~~~~~


    Checks for the existence of text in a file using grep. Returns a list of matching
    lines if the file exists, and ``None`` if the file does not.
    


:code:`find_links(name)`
~~~~~~~~~~~~~~~~~~~~~~~~


    Returns a list of links from a start point, recursively using find.
    


:code:`link(name)`
~~~~~~~~~~~~~~~~~~


:code:`sha1_file(name)`
~~~~~~~~~~~~~~~~~~~~~~~


    Returns a SHA1 hash of a file. Works with both sha1sum and sha1.
    


Gem
---

:code:`gem_packages`
~~~~~~~~~~~~~~~~~~~~


    Returns a dict of installed gem packages:

    .. code:: python

        'package_name': 'version',
        ...
    


Git
---

:code:`git_branch(name)`
~~~~~~~~~~~~~~~~~~~~~~~~


Init
----

:code:`initd_status`
~~~~~~~~~~~~~~~~~~~~


    Low level check for every /etc/init.d/* script. Unfortunately many of these
    mishehave and return exit status 0 while also displaying the help info/not
    offering status support.

    Returns a dict of name -> status.

    Expected codes found at:
        http://refspecs.linuxbase.org/LSB_3.1.0/LSB-Core-generic/LSB-Core-generic/iniscrptact.html
    


:code:`rcd_enabled`
~~~~~~~~~~~~~~~~~~~


    Returns a dict of service name -> whether enabled (on boot) status. Different
    to Linux variants because BSD has no/one runlevel.
    


:code:`rcd_status`
~~~~~~~~~~~~~~~~~~


    Same as ``initd_status`` but for BSD (/etc/rc.d) systems. Unlike Linux/init.d,
    BSD init scripts are well behaved and as such their output can be trusted.
    


:code:`systemd_enabled`
~~~~~~~~~~~~~~~~~~~~~~~


    Returns a dict of name -> whether enabled for systemd managed services.
    


:code:`systemd_status`
~~~~~~~~~~~~~~~~~~~~~~


    Returns a dict of name -> status for systemd managed services.
    


:code:`upstart_status`
~~~~~~~~~~~~~~~~~~~~~~


    Returns a dict of name -> status for upstart managed services.
    


Iptables
--------

:code:`ip6tables_chains(table)`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


    Returns a dict of ip6tables chains & policies:

    .. code:: python

        'NAME': 'POLICY',
        ...
    


:code:`ip6tables_rules(table)`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


    Returns a list of ip6tables rules for a specific table:

    .. code:: python

        {
            'chain': 'PREROUTING',
            'jump': 'DNAT'
        },
        ...
    


:code:`iptables_chains(table)`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


    Returns a dict of iptables chains & policies:

    .. code:: python

        'NAME': 'POLICY',
        ...
    


:code:`iptables_rules(table)`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


    Returns a list of iptables rules for a specific table:

    .. code:: python

        {
            'chain': 'PREROUTING',
            'jump': 'DNAT'
        },
        ...
    


Lxd
---

:code:`lxd_containers`
~~~~~~~~~~~~~~~~~~~~~~


    Returns a list of running LXD containers
    


Npm
---

:code:`npm_local_packages`
~~~~~~~~~~~~~~~~~~~~~~~~~~


    [DEPRECATED] Maintained for backwards-compatability.
    


:code:`npm_packages(directory)`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


    Returns a dict of installed npm packages globally or in a given directory:

    .. code:: python

        'package_name': 'version',
        ...
    


Pip
---

:code:`pip_packages(venv)`
~~~~~~~~~~~~~~~~~~~~~~~~~~


    Returns a dict of installed pip packages globally or in a given virtualenv:

    .. code:: python

        'package_name': 'version',
        ...
    


:code:`pip_virtualenv_packages`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


    [DEPRECATED] Maintained for backwards-compatability.
    


Pkg
---

:code:`pkg_packages`
~~~~~~~~~~~~~~~~~~~~


    Returns a dict of installed pkg packages:

    .. code:: python

        'package_name': 'version',
        ...
    


Server
------

:code:`arch`
~~~~~~~~~~~~


:code:`command(command)`
~~~~~~~~~~~~~~~~~~~~~~~~


:code:`date`
~~~~~~~~~~~~

Returns the current datetime on the server.


:code:`groups`
~~~~~~~~~~~~~~


    Returns a list of groups on the system.
    


:code:`home`
~~~~~~~~~~~~


:code:`hostname`
~~~~~~~~~~~~~~~~


:code:`linux_distribution`
~~~~~~~~~~~~~~~~~~~~~~~~~~


    Returns a dict of the Linux distribution version. Ubuntu, Debian, CentOS,
    Fedora & Gentoo currently. Also contains any key/value items located in
    release files.

    .. code:: python

        {
            'name': 'CentOS',
            'major': 6,
            'minor': 5,
            'release_meta': {
                'DISTRIB_CODENAME': 'trusty',
                ...
            }
        }
    


:code:`os`
~~~~~~~~~~


:code:`os_version`
~~~~~~~~~~~~~~~~~~


:code:`users`
~~~~~~~~~~~~~


    Returns a dict of users -> details:

    .. code:: python

        'user_name': {
            'home': '/home/user_name',
            'shell': '/bin/bash,
            'group': 'main_user_group',
            'groups': [
                'other',
                'groups'
            ]
        },
        ...
    


:code:`which(name)`
~~~~~~~~~~~~~~~~~~~


Yum
---

:code:`rpm_packages`
~~~~~~~~~~~~~~~~~~~~


    Returns a dict of installed rpm packages:

    .. code:: python

        'package_name': 'version',
        ...
    


:code:`rpm_package(name)`
~~~~~~~~~~~~~~~~~~~~~~~~~


    Returns information on a .rpm file.