blob: 49fe62954cce8a04ffd8f4973b077eb0e94bc75b (
plain)
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
|
:mod:`nis` --- Interface to Sun's NIS (Yellow Pages)
====================================================
.. module:: nis
:platform: Unix
:synopsis: Interface to Sun's NIS (Yellow Pages) library.
:deprecated:
.. moduleauthor:: Fred Gansevles <Fred.Gansevles@cs.utwente.nl>
.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
.. deprecated:: 3.11
The :mod:`nis` module is deprecated
(see :pep:`PEP 594 <594#nis>` for details).
--------------
The :mod:`nis` module gives a thin wrapper around the NIS library, useful for
central administration of several hosts.
Because NIS exists only on Unix systems, this module is only available for Unix.
The :mod:`nis` module defines the following functions:
.. function:: match(key, mapname, domain=default_domain)
Return the match for *key* in map *mapname*, or raise an error
(:exc:`nis.error`) if there is none. Both should be strings, *key* is 8-bit
clean. Return value is an arbitrary array of bytes (may contain ``NULL`` and
other joys).
Note that *mapname* is first checked if it is an alias to another name.
The *domain* argument allows overriding the NIS domain used for the lookup. If
unspecified, lookup is in the default NIS domain.
.. function:: cat(mapname, domain=default_domain)
Return a dictionary mapping *key* to *value* such that ``match(key,
mapname)==value``. Note that both keys and values of the dictionary are
arbitrary arrays of bytes.
Note that *mapname* is first checked if it is an alias to another name.
The *domain* argument allows overriding the NIS domain used for the lookup. If
unspecified, lookup is in the default NIS domain.
.. function:: maps(domain=default_domain)
Return a list of all valid maps.
The *domain* argument allows overriding the NIS domain used for the lookup. If
unspecified, lookup is in the default NIS domain.
.. function:: get_default_domain()
Return the system default NIS domain.
The :mod:`nis` module defines the following exception:
.. exception:: error
An error raised when a NIS function returns an error code.
|