17db96d56Sopenharmony_ci
27db96d56Sopenharmony_ci:mod:`nis` --- Interface to Sun's NIS (Yellow Pages)
37db96d56Sopenharmony_ci====================================================
47db96d56Sopenharmony_ci
57db96d56Sopenharmony_ci.. module:: nis
67db96d56Sopenharmony_ci   :platform: Unix
77db96d56Sopenharmony_ci   :synopsis: Interface to Sun's NIS (Yellow Pages) library.
87db96d56Sopenharmony_ci   :deprecated:
97db96d56Sopenharmony_ci
107db96d56Sopenharmony_ci.. moduleauthor:: Fred Gansevles <Fred.Gansevles@cs.utwente.nl>
117db96d56Sopenharmony_ci.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
127db96d56Sopenharmony_ci
137db96d56Sopenharmony_ci.. deprecated-removed:: 3.11 3.13
147db96d56Sopenharmony_ci   The :mod:`nis` module is deprecated
157db96d56Sopenharmony_ci   (see :pep:`PEP 594 <594#nis>` for details).
167db96d56Sopenharmony_ci
177db96d56Sopenharmony_ci--------------
187db96d56Sopenharmony_ci
197db96d56Sopenharmony_ciThe :mod:`nis` module gives a thin wrapper around the NIS library, useful for
207db96d56Sopenharmony_cicentral administration of several hosts.
217db96d56Sopenharmony_ci
227db96d56Sopenharmony_ciBecause NIS exists only on Unix systems, this module is only available for Unix.
237db96d56Sopenharmony_ci
247db96d56Sopenharmony_ci.. include:: ../includes/wasm-notavail.rst
257db96d56Sopenharmony_ci
267db96d56Sopenharmony_ciThe :mod:`nis` module defines the following functions:
277db96d56Sopenharmony_ci
287db96d56Sopenharmony_ci
297db96d56Sopenharmony_ci.. function:: match(key, mapname, domain=default_domain)
307db96d56Sopenharmony_ci
317db96d56Sopenharmony_ci   Return the match for *key* in map *mapname*, or raise an error
327db96d56Sopenharmony_ci   (:exc:`nis.error`) if there is none. Both should be strings, *key* is 8-bit
337db96d56Sopenharmony_ci   clean. Return value is an arbitrary array of bytes (may contain ``NULL`` and
347db96d56Sopenharmony_ci   other joys).
357db96d56Sopenharmony_ci
367db96d56Sopenharmony_ci   Note that *mapname* is first checked if it is an alias to another name.
377db96d56Sopenharmony_ci
387db96d56Sopenharmony_ci   The *domain* argument allows overriding the NIS domain used for the lookup. If
397db96d56Sopenharmony_ci   unspecified, lookup is in the default NIS domain.
407db96d56Sopenharmony_ci
417db96d56Sopenharmony_ci
427db96d56Sopenharmony_ci.. function:: cat(mapname, domain=default_domain)
437db96d56Sopenharmony_ci
447db96d56Sopenharmony_ci   Return a dictionary mapping *key* to *value* such that ``match(key,
457db96d56Sopenharmony_ci   mapname)==value``. Note that both keys and values of the dictionary are
467db96d56Sopenharmony_ci   arbitrary arrays of bytes.
477db96d56Sopenharmony_ci
487db96d56Sopenharmony_ci   Note that *mapname* is first checked if it is an alias to another name.
497db96d56Sopenharmony_ci
507db96d56Sopenharmony_ci   The *domain* argument allows overriding the NIS domain used for the lookup. If
517db96d56Sopenharmony_ci   unspecified, lookup is in the default NIS domain.
527db96d56Sopenharmony_ci
537db96d56Sopenharmony_ci
547db96d56Sopenharmony_ci.. function:: maps(domain=default_domain)
557db96d56Sopenharmony_ci
567db96d56Sopenharmony_ci   Return a list of all valid maps.
577db96d56Sopenharmony_ci
587db96d56Sopenharmony_ci   The *domain* argument allows overriding the NIS domain used for the lookup. If
597db96d56Sopenharmony_ci   unspecified, lookup is in the default NIS domain.
607db96d56Sopenharmony_ci
617db96d56Sopenharmony_ci
627db96d56Sopenharmony_ci.. function:: get_default_domain()
637db96d56Sopenharmony_ci
647db96d56Sopenharmony_ci   Return the system default NIS domain.
657db96d56Sopenharmony_ci
667db96d56Sopenharmony_ci
677db96d56Sopenharmony_ciThe :mod:`nis` module defines the following exception:
687db96d56Sopenharmony_ci
697db96d56Sopenharmony_ci.. exception:: error
707db96d56Sopenharmony_ci
717db96d56Sopenharmony_ci   An error raised when a NIS function returns an error code.
727db96d56Sopenharmony_ci
73