summaryrefslogtreecommitdiffstats
path: root/docs-xml/smbdotconf/misc/changesharecommand.xml
diff options
context:
space:
mode:
Diffstat (limited to 'docs-xml/smbdotconf/misc/changesharecommand.xml')
-rw-r--r--docs-xml/smbdotconf/misc/changesharecommand.xml80
1 files changed, 80 insertions, 0 deletions
diff --git a/docs-xml/smbdotconf/misc/changesharecommand.xml b/docs-xml/smbdotconf/misc/changesharecommand.xml
new file mode 100644
index 0000000..4cc7451
--- /dev/null
+++ b/docs-xml/smbdotconf/misc/changesharecommand.xml
@@ -0,0 +1,80 @@
+<samba:parameter name="change 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">change share command</parameter> is used to define an external
+program or script which will modify an existing service definition in <filename
+moreinfo="none">smb.conf</filename>.
+ </para>
+
+ <para>
+ In order to successfully execute the
+ <parameter moreinfo="none">change 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">change share command</parameter>
+ parameter are executed as root.
+ </para>
+
+ <para>
+ When executed, <command moreinfo="none">smbd</command> will automatically invoke the
+ <parameter moreinfo="none">change share command</parameter> with six 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>
+
+ <listitem>
+ <para><parameter moreinfo="none">CSC policy</parameter> - client side caching
+ policy in string form. Valid values are: manual, documents, programs, disable.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ This parameter is only used to modify existing file share definitions.
+ To modify printer shares, use the &quot;Printers...&quot; folder as seen
+ when browsing the Samba host.
+ </para>
+</description>
+
+<related>add share command</related>
+<related>delete share command</related>
+<value type="default"></value>
+<value type="example">/usr/local/bin/changeshare</value>
+</samba:parameter>