docs-xml/smbdotconf/misc/deletesharecommand.xml

   1 <samba:parameter name="delete 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">delete share command</parameter> is used to define an external
  10         program or script which will remove an existing service definition from
  11         <filename moreinfo="none">smb.conf</filename>.  In order to successfully execute the
  12         <parameter moreinfo="none">delete share command</parameter>, <command moreinfo="none">smbd</command>
  13         requires that the administrator be 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">delete share command</parameter> with two 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
  35                         the existing service.
  36                         </para>
  37                 </listitem>
  38         </itemizedlist>
  39
  40         <para>
  41         This parameter is only used to remove file shares.  To delete printer shares,
  42         see the <smbconfoption name="deleteprinter command"/>.
  43         </para>
  44 </description>
  45
  46 <related>add share command</related>
  47 <related>delete share command</related>
  48 <value type="default"></value>
  49 <value type="example">/usr/local/bin/delshare</value>
  50 </samba:parameter>