summaryrefslogtreecommitdiff
path: root/docs-xml/smbdotconf/misc/addsharecommand.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs-xml/smbdotconf/misc/addsharecommand.xml')
-rw-r--r--docs-xml/smbdotconf/misc/addsharecommand.xml68
1 files changed, 68 insertions, 0 deletions
diff --git a/docs-xml/smbdotconf/misc/addsharecommand.xml b/docs-xml/smbdotconf/misc/addsharecommand.xml
new file mode 100644
index 00000000000..9eb50f3dc3b
--- /dev/null
+++ b/docs-xml/smbdotconf/misc/addsharecommand.xml
@@ -0,0 +1,68 @@
+<samba:parameter name="add share command"
+ context="G"
+ type="string"
+ advanced="1" developer="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>. In order
+ to successfully execute the <parameter moreinfo="none">add share command</parameter>, <command
+ moreinfo="none">smbd</command> requires that the administrator be connected using a root account (i.e. uid == 0).
+ </para>
+
+ <para>
+ If the connected account has <literal>SeDiskOperatorPrivilege</literal>, scripts defined in
+ <parameter moreinfo="none">change share</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 for 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>