docs-xml/smbdotconf/security/renameuserscript.xml

   1 <samba:parameter name="rename user script"
   2                  context="G"
   3                  advanced="1" developer="1"
   4                                  type="string"
   5                                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
   6 <description>
   7     <para>
   8         This is the full pathname to a script that will be run as root by <citerefentry><refentrytitle>smbd</refentrytitle>
   9         <manvolnum>8</manvolnum></citerefentry> under special circumstances described below.
  10         </para>
  11
  12         <para>
  13         When a user with admin authority or SeAddUserPrivilege rights renames a user (e.g.: from the NT4 User Manager
  14         for Domains), this script will be run to rename the POSIX user.  Two variables, <literal>%uold</literal> and
  15         <literal>%unew</literal>, will be substituted with the old and new usernames, respectively.  The script should
  16         return 0 upon successful completion, and nonzero otherwise.
  17         </para>
  18
  19         <note><para>
  20         The script has all responsibility to rename all the necessary data that is accessible in this posix method.
  21         This can mean different requirements for different backends.  The tdbsam and smbpasswd backends will take care
  22         of the contents of their respective files, so the script is responsible only for changing the POSIX username, and
  23         other data that may required for your circumstances, such as home directory.  Please also consider whether or
  24         not you need to rename the actual home directories themselves.  The ldapsam backend will not make any changes,
  25         because of the potential issues with renaming the LDAP naming attribute.  In this case the script is
  26         responsible for changing the attribute that samba uses (uid) for locating users, as well as any data that
  27         needs to change for other applications using the same directory.
  28         </para></note>
  29
  30 </description>
  31
  32 <value type="default"></value>
  33 </samba:parameter>