docs-xml/smbdotconf/misc/changesharecommand.xml

   1 <samba:parameter name="change share command"
   2                  context="G"
   3                  type="string"
   4                  substitution="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>.
  12         </para>
  13
  14         <para>
  15         In order to successfully execute the
  16         <parameter moreinfo="none">change share command</parameter>,
  17         <command moreinfo="none">smbd</command> requires that the administrator
  18         connects using a root account (i.e. uid == 0) or has the
  19         <literal>SeDiskOperatorPrivilege</literal>.
  20         Scripts defined in the <parameter moreinfo="none">change share command</parameter>
  21         parameter are executed as root.
  22         </para>
  23
  24         <para>
  25         When executed, <command moreinfo="none">smbd</command> will automatically invoke the
  26         <parameter moreinfo="none">change share command</parameter> with six parameters.
  27         </para>
  28
  29         <itemizedlist>
  30                 <listitem>
  31                         <para><parameter moreinfo="none">configFile</parameter> - the location
  32                         of the global <filename moreinfo="none">smb.conf</filename> file.
  33                         </para>
  34                 </listitem>
  35
  36                 <listitem>
  37                         <para><parameter moreinfo="none">shareName</parameter> - the name of the new
  38                         share.
  39                         </para>
  40                 </listitem>
  41
  42                 <listitem>
  43                         <para><parameter moreinfo="none">pathName</parameter> - path to an **existing**
  44                         directory on disk.
  45                         </para>
  46                 </listitem>
  47
  48                 <listitem>
  49                         <para><parameter moreinfo="none">comment</parameter> - comment string to associate
  50                         with the new share.
  51                         </para>
  52                 </listitem>
  53
  54                 <listitem>
  55                         <para><parameter moreinfo="none">max
  56                         connections</parameter>
  57                         Number of maximum simultaneous connections to this
  58                         share.
  59                         </para>
  60                 </listitem>
  61
  62                 <listitem>
  63                         <para><parameter moreinfo="none">CSC policy</parameter> - client side caching
  64                         policy in string form. Valid values are: manual, documents, programs, disable.
  65                         </para>
  66                 </listitem>
  67         </itemizedlist>
  68
  69         <para>
  70         This parameter is only used to modify existing file share definitions.
  71         To modify printer shares, use the &quot;Printers...&quot; folder as seen
  72         when browsing the Samba host.
  73         </para>
  74 </description>
  75
  76 <related>add share command</related>
  77 <related>delete share command</related>
  78 <value type="default"></value>
  79 <value type="example">/usr/local/bin/changeshare</value>
  80 </samba:parameter>