samba-mirror/docs-xml/smbdotconf/misc/addsharecommand.xml

<samba:parameter name="add share command"
                 context="G"
                 type="string"
                 substitution="1"
                 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">add share command</parameter> is used to define an external program
	or script which will add a new service definition to
	<filename moreinfo="none">smb.conf</filename>.
	</para>

	<para>
	In order to successfully execute the
	<parameter moreinfo="none">add 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">add share command</parameter>
	parameter are executed as root.
	</para>

	<para>
	When executed, <command moreinfo="none">smbd</command> will automatically invoke the
	<parameter moreinfo="none">add share command</parameter> with five 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 new share.
			</para>
		</listitem>

		<listitem>
			<para><parameter moreinfo="none">pathName</parameter> - path to an **existing**
			directory on disk.
			</para>
		</listitem>

		<listitem>
			<para><parameter moreinfo="none">comment</parameter> - comment string to associate with the new
			share.
			</para>
		</listitem>

		<listitem>
			<para><parameter moreinfo="none">max
			connections</parameter>
			Number of maximum simultaneous connections to this
			share.
			</para>
		</listitem>
	</itemizedlist>

	<para>
	This parameter is only used to add file shares. To add printer shares, see the <smbconfoption
	name="addprinter command"/>.
	</para>
</description>

<related>change share command</related>
<related>delete share command</related>
<value type="default"></value>
<value type="example">/usr/local/bin/addshare</value>
</samba:parameter>