docs/docbook/smbdotconf/logon/logonscript.xml

   1 <samba:parameter name="logon script"
   2                  context="G"
   3                  advanced="1" developer="1"
   4                  xmlns:samba="http://samba.org/common">
   5 <listitem>
   6         <para>This parameter specifies the batch file (.bat) or
   7         NT command file (.cmd) to be downloaded and run on a machine when
   8         a user successfully logs in.  The file must contain the DOS
   9         style CR/LF line endings. Using a DOS-style editor to create the
  10         file is recommended.</para>
  11
  12         <para>The script must be a relative path to the [netlogon]
  13         service.  If the [netlogon] service specifies a <link linkend="PATH">
  14         <parameter moreinfo="none">path</parameter></link> of <filename
  15         moreinfo="none">/usr/local/samba/netlogon</filename>, and <command
  16         moreinfo="none">logon script = STARTUP.BAT</command>, then
  17         the file that will be downloaded is:</para>
  18
  19         <para><filename moreinfo="none">/usr/local/samba/netlogon/STARTUP.BAT</filename></para>
  20
  21         <para>The contents of the batch file are entirely your choice.  A
  22         suggested command would be to add <command moreinfo="none">NET TIME \\SERVER /SET
  23         /YES</command>, to force every machine to synchronize clocks with
  24         the same time server.  Another use would be to add <command moreinfo="none">NET USE
  25         U: \\SERVER\UTILS</command> for commonly used utilities, or <command moreinfo="none">
  26         NET USE Q: \\SERVER\ISO9001_QA</command> for example.</para>
  27
  28         <para>Note that it is particularly important not to allow write
  29         access to the [netlogon] share, or to grant users write permission
  30         on the batch files in a secure environment, as this would allow
  31         the batch files to be arbitrarily modified and security to be
  32         breached.</para>
  33
  34         <para>This option takes the standard substitutions, allowing you
  35         to have separate logon scripts for each user or machine.</para>
  36
  37         <para>This option is only useful if Samba is set up as a logon
  38         server.</para>
  39
  40         <para>Default: <emphasis>no logon script defined</emphasis></para>
  41
  42         <para>Example: <command moreinfo="none">logon script = scripts\%U.bat</command></para>
  43 </listitem>
  44 </samba:parameter>