docs-xml/smbdotconf/misc/changesharecommand.xml

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