summaryrefslogtreecommitdiff
path: root/docs-xml/smbdotconf/misc/addsharecommand.xml
blob: 9eb50f3dc3b6a6d6de3ca342db2c7725ed7b7add (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
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>