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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
<refentry id="smbcontrol">
<refmeta>
<refentrytitle>smbcontrol</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>smbcontrol</refname>
<refpurpose>send messages to smbd or nmbd processes</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>smbcontrol</command>
<arg>-i</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>smbcontrol</command>
<arg>destination</arg>
<arg>message-type</arg>
<arg>parameter</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <ulink url="samba.7.html">
Samba</ulink> suite.</para>
<para><command>smbcontrol</command> is a very small program, which
sends messages to an <ulink url="smbd.8.html">smbd(8)</ulink> or
an <ulink url="nmbd.8.html">nmbd(8)</ulink> daemon running on the
system.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>-i</term>
<listitem><para>Run interactively. Individual commands
of the form destination message-type parameters can be entered
on STDIN. An empty command line or a "q" will quit the
program.</para></listitem>
</varlistentry>
<varlistentry>
<term>destination</term>
<listitem><para>One of <parameter>nmbd</parameter>
<parameter>smbd</parameter> or a process ID.</para>
<para>The <parameter>smbd</parameter> destination causes the
message to "broadcast" to all smbd daemons.</para>
<para>The <parameter>nmbd</parameter> destination causes the
message to be sent to the nmbd daemon specified in the
<filename>nmbd.pid</filename> file.</para>
<para>If a single process ID is given, the message is sent
to only that process.</para></listitem>
</varlistentry>
<varlistentry>
<term>message-type</term>
<listitem><para>One of: <constant>close-share</constant>,
<constant>debug</constant>,
<constant>force-election</constant>, <constant>ping
</constant>, <constant>profile</constant>, <constant>
debuglevel</constant>, <constant>profilelevel</constant>,
or <constant>printer-notify</constant>.</para>
<para>The <constant>close-share</constant> message-type sends a
message to smbd which will then close the client connections to
the named share. Note that this doesn't affect client connections
to any other shares. This message-type takes an argument of the
share name for which client connections will be close, or the
"*" character which will close all currently open shares.
This message can only be sent to <constant>smbd</constant>.</para>
<para>The <constant>debug</constant> message-type allows
the debug level to be set to the value specified by the
parameter. This can be sent to any of the destinations.</para>
<para>The <constant>force-election</constant> message-type can only be
sent to the <constant>nmbd</constant> destination. This message
causes the <command>nmbd</command> daemon to force a new browse
master election.</para>
<para>The <constant>ping</constant> message-type sends the
number of "ping" messages specified by the parameter and waits
for the same number of reply "pong" messages. This can be sent to
any of the destinations.</para>
<para>The <constant>profile</constant> message-type sends a
message to an smbd to change the profile settings based on the
parameter. The parameter can be "on" to turn on profile stats
collection, "off" to turn off profile stats collection, "count"
to enable only collection of count stats (time stats are
disabled), and "flush" to zero the current profile stats. This can
be sent to any of the destinations.</para>
<para>The <constant>debuglevel</constant> message-type sends
a "request debug level" message. The current debug level setting
is returned by a "debuglevel" message. This can be
sent to any of the destinations.</para>
<para>The <constant>profilelevel</constant> message-type sends
a "request profile level" message. The current profile level
setting is returned by a "profilelevel" message. This can be sent
to any of the destinations.</para>
<para>The <constant>printer-notify</constant> message-type sends a
message to smbd which in turn sends a printer notify message to
any Windows NT clients connected to a printer. This message-type
takes an argument of the printer name to send notify messages to.
This message can only be sent to <constant>smbd</constant>.</para>
<para>The <constant>close-share</constant> message-type sends a
message to smbd which forces smbd to close the share that was
specified as an argument. This may be useful if you made changes
to the access controls on the share. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>parameters</term>
<listitem><para>any parameters required for the message-type</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 2.2 of
the Samba suite.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><ulink url="nmbd.8.html"><command>nmbd(8)</command></ulink>,
and <ulink url="smbd.8.html"><command>smbd(8)</command></ulink>.
</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The original Samba man pages were written by Karl Auer.
The man page sources were converted to YODL format (another
excellent piece of Open Source software, available at
<ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
release by Jeremy Allison. The conversion to DocBook for
Samba 2.2 was done by Gerald Carter</para>
</refsect1>
</refentry>
|
