source: branches/samba-3.3.x/docs-xml/smbdotconf/misc/addsharecommand.xml

Last change on this file was 217, checked in by Herwig Bauernfeind, 16 years ago

Import Samba 3.3 branch at 3.3.0 level docs-xml (psmedley's port)

File size: 2.2 KB
Line 
1<samba:parameter name="add share command"
2 context="G"
3 type="string"
4 advanced="1" developer="1"
5 xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
6<description>
7 <para>
8 Samba 2.2.0 introduced the ability to dynamically add and delete shares via the Windows NT 4.0 Server
9 Manager. The <parameter moreinfo="none">add share command</parameter> is used to define an external program
10 or script which will add a new service definition to
11 <filename moreinfo="none">smb.conf</filename>.
12 </para>
13
14 <para>
15 In order to successfully execute the
16 <parameter moreinfo="none">add share command</parameter>,
17 <command moreinfo="none">smbd</command> requires that the administrator
18 connects using a root account (i.e. uid == 0) or has the
19 <literal>SeDiskOperatorPrivilege</literal>.
20 Scripts defined in the <parameter moreinfo="none">add share command</parameter>
21 parameter are executed as root.
22 </para>
23
24 <para>
25 When executed, <command moreinfo="none">smbd</command> will automatically invoke the
26 <parameter moreinfo="none">add share command</parameter> with five parameters.
27 </para>
28
29 <itemizedlist>
30 <listitem>
31 <para><parameter moreinfo="none">configFile</parameter> - the location of the global <filename
32 moreinfo="none">smb.conf</filename> file.
33 </para>
34 </listitem>
35
36 <listitem>
37 <para><parameter moreinfo="none">shareName</parameter> - the name of the new share.
38 </para>
39 </listitem>
40
41 <listitem>
42 <para><parameter moreinfo="none">pathName</parameter> - path to an **existing**
43 directory on disk.
44 </para>
45 </listitem>
46
47 <listitem>
48 <para><parameter moreinfo="none">comment</parameter> - comment string to associate with the new
49 share.
50 </para>
51 </listitem>
52
53 <listitem>
54 <para><parameter moreinfo="none">max
55 connections</parameter>
56 Number of maximum simultaneous connections to this
57 share.
58 </para>
59 </listitem>
60 </itemizedlist>
61
62 <para>
63 This parameter is only used to add file shares. To add printer shares, see the <smbconfoption
64 name="addprinter command"/>.
65 </para>
66</description>
67
68<related>change share command</related>
69<related>delete share command</related>
70<value type="default"></value>
71<value type="example">/usr/local/bin/addshare</value>
72</samba:parameter>
Note: See TracBrowser for help on using the repository browser.