docs/smbdotconf/misc/changesharecommand.xml

   1 <samba:parameter name="change share command"
   2                  context="G"
   3                                  type="string"
   4                  advanced="1" developer="1"
   5                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
   6 <description>
   7         <para>
   8         Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server
   9 Manager.  The <parameter moreinfo="none">change share command</parameter> is used to define an external
  10 program or script which will modify an existing service definition in <filename
  11 moreinfo="none">smb.conf</filename>.  In order to successfully execute the <parameter moreinfo="none">change
  12 share command</parameter>, <command moreinfo="none">smbd</command> requires that the administrator be
  13 connected using a root account (i.e. uid == 0).
  14         </para>
  15
  16         <para>
  17         If the connected account has <literal>SeDiskOperatorPrivilege</literal>, scripts defined in
  18         <parameter moreinfo="none">change share</parameter> parameter are executed as root.
  19         </para>
  20
  21         <para>
  22         When executed, <command moreinfo="none">smbd</command> will automatically invoke the
  23         <parameter moreinfo="none">change share command</parameter> with five parameters.
  24         </para>
  25
  26         <itemizedlist>
  27                 <listitem>
  28                         <para><parameter moreinfo="none">configFile</parameter> - the location
  29                         of the global <filename moreinfo="none">smb.conf</filename> file.
  30                         </para>
  31                 </listitem>
  32
  33                 <listitem>
  34                         <para><parameter moreinfo="none">shareName</parameter> - the name of the new
  35                         share.
  36                         </para>
  37                 </listitem>
  38
  39                 <listitem>
  40                         <para><parameter moreinfo="none">pathName</parameter> - path to an **existing**
  41                         directory on disk.
  42                         </para>
  43                 </listitem>
  44
  45                 <listitem>
  46                         <para><parameter moreinfo="none">comment</parameter> - comment string to associate
  47                         with the new share.
  48                         </para>
  49                 </listitem>
  50
  51                 <listitem>
  52                         <para><parameter moreinfo="none">max
  53                         connections</parameter>
  54                         Number of maximum simultaneous connections to this
  55                         share.
  56                         </para>
  57                 </listitem>
  58         </itemizedlist>
  59
  60         <para>
  61         This parameter is only used modify existing file shares definitions.  To modify
  62         printer shares, use the &quot;Printers...&quot; folder as seen when browsing the Samba host.
  63         </para>
  64 </description>
  65
  66 <related>add share command</related>
  67 <related>delete share command</related>
  68 <value type="default"></value>
  69 <value type="example">/usr/local/bin/addshare</value>
  70 </samba:parameter>