1
0
mirror of https://github.com/samba-team/samba.git synced 2024-12-25 23:21:54 +03:00
samba-mirror/docs-xml/smbdotconf/misc/deletesharecommand.xml
Michael Adam 64b720d284 docs:smbdotconf: make formatting of headers uniform.
Signed-off-by: Michael Adam <obnox@samba.org>
Reviewed-by: Jeremy Allison <jra@samba.org>
2015-07-31 01:55:29 +02:00

52 lines
1.8 KiB
XML

<samba:parameter name="delete share command"
context="G"
type="string"
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
<description>
<para>
Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server
Manager. The <parameter moreinfo="none">delete share command</parameter> is used to define an external
program or script which will remove an existing service definition from
<filename moreinfo="none">smb.conf</filename>.
</para>
<para>In order to successfully execute the
<parameter moreinfo="none">delete share command</parameter>,
<command moreinfo="none">smbd</command> requires that the administrator
connects using a root account (i.e. uid == 0) or has the
<literal>SeDiskOperatorPrivilege</literal>.
Scripts defined in the <parameter moreinfo="none">delete share command</parameter>
parameter are executed as root.
</para>
<para>
When executed, <command moreinfo="none">smbd</command> will automatically invoke the
<parameter moreinfo="none">delete share command</parameter> with two parameters.
</para>
<itemizedlist>
<listitem>
<para><parameter moreinfo="none">configFile</parameter> - the location
of the global <filename moreinfo="none">smb.conf</filename> file.
</para>
</listitem>
<listitem>
<para><parameter moreinfo="none">shareName</parameter> - the name of
the existing service.
</para>
</listitem>
</itemizedlist>
<para>
This parameter is only used to remove file shares. To delete printer shares,
see the <smbconfoption name="deleteprinter command"/>.
</para>
</description>
<related>add share command</related>
<related>change share command</related>
<value type="default"></value>
<value type="example">/usr/local/bin/delshare</value>
</samba:parameter>