docs-xml/manpages/idmap_nss.8.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="idmap_nss.8">
   4
   5 <refmeta>
   6         <refentrytitle>idmap_nss</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">&doc.version;</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>idmap_nss</refname>
  16         <refpurpose>Samba's idmap_nss Backend for Winbind</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <title>DESCRIPTION</title>
  21
  22         <para>The idmap_nss plugin provides a means to map Unix users and groups
  23         to Windows accounts. This provides a simple means of ensuring that the SID
  24         for a Unix user named jsmith is reported as the one assigned to
  25         DOMAIN\jsmith which is necessary for reporting ACLs on files and printers
  26         stored on a Samba member server.
  27         </para>
  28 </refsynopsisdiv>
  29
  30 <refsect1>
  31         <title>IDMAP OPTIONS</title>
  32
  33         <variablelist>
  34                 <varlistentry>
  35                 <term>range = low - high</term>
  36                 <listitem><para>
  37                         Defines the available matching UID and GID range for which the
  38                         backend is authoritative. Note that the range acts as a filter.
  39                         Returned UIDs or GIDs by NSS modules that fall outside the range
  40                         are ignored and the corresponding maps discarded. It is intended
  41                         as a way to avoid accidental UID/GID overlaps between local and
  42                         remotely defined IDs.
  43                 </para></listitem>
  44                 </varlistentry>
  45
  46                 <varlistentry>
  47                 <term>use_upn = &lt;yes | no&gt;</term>
  48                 <listitem>
  49                 <para>
  50                         Some NSS modules can return and handle UPNs and/or down-level
  51                         logon names (e.g., DOMAIN\user or user@REALM).
  52                 </para>
  53                 <para>
  54                         If this parameter is enabled the returned names from NSS will be
  55                         parsed and the resulting namespace will be used as the authoritative
  56                         namespace instead of the IDMAP domain name. Also, down-level logon
  57                         names will be sent to NSS instead of the plain username to give NSS
  58                         modules a hint about the user's correct domain.
  59                 </para>
  60                 <para>Default: no</para>
  61                 </listitem>
  62                 </varlistentry>
  63
  64         </variablelist>
  65 </refsect1>
  66
  67
  68 <refsect1>
  69         <title>EXAMPLES</title>
  70
  71         <para>
  72     This example shows how to use idmap_nss to obtain the local account ID's
  73     for its own domain (SAMBA) from NSS, whilst allocating new mappings for
  74     the default domain (*) and any trusted domains.
  75         </para>
  76
  77         <programlisting>
  78         [global]
  79         idmap config * : backend = tdb
  80         idmap config * : range = 1000000-1999999
  81
  82         idmap config SAMBA : backend  = nss
  83         idmap config SAMBA : range = 1000-999999
  84         </programlisting>
  85 </refsect1>
  86
  87 <refsect1>
  88         <title>AUTHOR</title>
  89
  90         <para>
  91         The original Samba software and related utilities
  92         were created by Andrew Tridgell. Samba is now developed
  93         by the Samba Team as an Open Source project similar
  94         to the way the Linux kernel is developed.
  95         </para>
  96 </refsect1>
  97
  98 </refentry>