source: vendor/current/docs-xml/smbdotconf/misc/deletesharecommand.xml

Last change on this file was 988, checked in by Silvan Scherrer, 9 years ago

Samba Server: update vendor to version 4.4.3

File size: 1.8 KB
Line 
1<samba:parameter name="delete 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">delete share command</parameter> is used to define an external
9 program or script which will remove an existing service definition from
10 <filename moreinfo="none">smb.conf</filename>.
11 </para>
12
13 <para>In order to successfully execute the
14 <parameter moreinfo="none">delete share command</parameter>,
15 <command moreinfo="none">smbd</command> requires that the administrator
16 connects using a root account (i.e. uid == 0) or has the
17 <literal>SeDiskOperatorPrivilege</literal>.
18 Scripts defined in the <parameter moreinfo="none">delete share command</parameter>
19 parameter are executed as root.
20 </para>
21
22 <para>
23 When executed, <command moreinfo="none">smbd</command> will automatically invoke the
24 <parameter moreinfo="none">delete share command</parameter> with two parameters.
25 </para>
26
27 <itemizedlist>
28 <listitem>
29 <para><parameter moreinfo="none">configFile</parameter> - the location
30 of the global <filename moreinfo="none">smb.conf</filename> file.
31 </para>
32 </listitem>
33
34 <listitem>
35 <para><parameter moreinfo="none">shareName</parameter> - the name of
36 the existing service.
37 </para>
38 </listitem>
39 </itemizedlist>
40
41 <para>
42 This parameter is only used to remove file shares. To delete printer shares,
43 see the <smbconfoption name="deleteprinter command"/>.
44 </para>
45</description>
46
47<related>add share command</related>
48<related>change share command</related>
49<value type="default"></value>
50<value type="example">/usr/local/bin/delshare</value>
51</samba:parameter>
Note: See TracBrowser for help on using the repository browser.