1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="smbcontrol.1">
6 <refentrytitle>smbcontrol</refentrytitle>
7 <manvolnum>1</manvolnum>
8 <refmiscinfo class="source">Samba</refmiscinfo>
9 <refmiscinfo class="manual">User Commands</refmiscinfo>
10 <refmiscinfo class="version">4.7</refmiscinfo>
15 <refname>smbcontrol</refname>
16 <refpurpose>send messages to smbd, nmbd or winbindd processes</refpurpose>
21 <command>smbcontrol</command>
23 <arg>-t|--timeout</arg>
27 <command>smbcontrol</command>
28 <arg>destination</arg>
29 <arg>message-type</arg>
35 <title>DESCRIPTION</title>
37 <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
38 <manvolnum>7</manvolnum></citerefentry> suite.</para>
40 <para><command>smbcontrol</command> is a very small program, which
41 sends messages to a <citerefentry><refentrytitle>smbd</refentrytitle>
42 <manvolnum>8</manvolnum></citerefentry>, a <citerefentry><refentrytitle>nmbd</refentrytitle>
43 <manvolnum>8</manvolnum></citerefentry>, or a <citerefentry><refentrytitle>winbindd</refentrytitle>
44 <manvolnum>8</manvolnum></citerefentry> daemon running on the system.</para>
49 <title>OPTIONS</title>
53 &popt.common.samba.client;
55 <term>-t|--timeout</term>
57 Set timeout to seconds.
62 <term>destination</term>
63 <listitem><para>One of <parameter>nmbd</parameter>,
64 <parameter>smbd</parameter>, <parameter>winbindd</parameter>
65 or a process ID.</para>
67 <para>The <parameter>all</parameter> destination causes the
68 message to "broadcast" to all running daemons including nmbd and
69 winbind. This is a change for Samba 3.3, prior to this the
70 parameter smbd used to do this.</para>
72 <para>The <parameter>smbd</parameter> destination causes the
73 message to be sent to the smbd daemon specified in the
74 <filename>smbd.pid</filename> file.</para>
76 <para>The <parameter>nmbd</parameter> destination causes the
77 message to be sent to the nmbd daemon specified in the
78 <filename>nmbd.pid</filename> file.</para>
80 <para>The <parameter>winbindd</parameter> destination causes the
81 message to be sent to the winbind daemon specified in the
82 <filename>winbindd.pid</filename> file.</para>
84 <para>If a single process ID is given, the message is sent
85 to only that process.</para></listitem>
89 <term>message-type</term>
90 <listitem><para>Type of message to send. See
91 the section <constant>MESSAGE-TYPES</constant> for details.
92 </para></listitem></varlistentry>
97 <term>parameters</term>
98 <listitem><para>any parameters required for the message-type</para>
106 <title>MESSAGE-TYPES</title>
108 <para>Available message types are:</para>
111 <varlistentry><term>close-share</term>
112 <listitem><para>Order smbd to close the client
113 connections to the named share. Note that this doesn't affect client
114 connections to any other shares. This message-type takes an argument of the
115 share name for which client connections will be closed, or the
116 "*" character which will close all currently open shares.
117 This may be useful if you made changes to the access controls on the share.
118 This message can only be sent to <constant>smbd</constant>.</para>
124 <listitem><para>Set debug level to the value specified by the
125 parameter. This can be sent to any of the destinations. If this
126 message is sent to either the smbd or winbindd daemons, the parent
127 process will rebroadcast the message to all child processes changing
128 the debug level in each one.</para>
133 <term>kill-client-ip</term>
134 <listitem><para>Order smbd to close the client connections from a
135 given IP address. This message-type takes an argument of the IP
136 address from which client connections will be closed. This message
137 can only be sent to <constant>smbd</constant>.</para>
142 <term>force-election</term>
143 <listitem><para>This message causes the <command>nmbd</command> daemon to
144 force a new browse master election. </para>
145 </listitem></varlistentry>
150 Send specified number of "ping" messages and
151 wait for the same number of reply "pong" messages. This can be sent to
152 any of the destinations.</para>
158 <listitem><para>Change profile settings of a daemon, based on the
159 parameter. The parameter can be "on" to turn on profile stats
160 collection, "off" to turn off profile stats collection, "count"
161 to enable only collection of count stats (time stats are
162 disabled), and "flush" to zero the current profile stats. This can
163 be sent to any smbd or nmbd destinations.</para>
164 </listitem></varlistentry>
167 <term>debuglevel</term>
169 Request debuglevel of a certain daemon and write it to stdout. This
170 can be sent to any of the destinations.</para>
175 <term>profilelevel</term>
177 Request profilelevel of a certain daemon and write it to stdout.
178 This can be sent to any smbd or nmbd destinations.</para>
183 <term>printnotify</term>
185 Order smbd to send a printer notify message to any Windows NT clients
186 connected to a printer. This message-type takes the following arguments:
192 <term>queuepause printername</term>
193 <listitem><para>Send a queue pause change notify
194 message to the printer specified.</para></listitem>
198 <term>queueresume printername</term>
199 <listitem><para>Send a queue resume change notify
200 message for the printer specified.</para></listitem>
204 <term>jobpause printername unixjobid</term>
205 <listitem><para>Send a job pause change notify
206 message for the printer and unix jobid
207 specified.</para></listitem>
211 <term>jobresume printername unixjobid</term>
212 <listitem><para>Send a job resume change notify
213 message for the printer and unix jobid
214 specified.</para></listitem>
218 <term>jobdelete printername unixjobid</term>
219 <listitem><para>Send a job delete change notify
220 message for the printer and unix jobid
221 specified.</para></listitem>
226 Note that this message only sends notification that an
227 event has occurred. It doesn't actually cause the
231 <para>This message can only be sent to <constant>smbd</constant>. </para>
236 <term>dmalloc-mark</term>
237 <listitem><para>Set a mark for dmalloc. Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support. </para></listitem>
241 <term>dmalloc-log-changed</term>
243 Dump the pointers that have changed since the mark set by dmalloc-mark.
244 Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support. </para></listitem>
248 <term>shutdown</term>
249 <listitem><para>Shut down specified daemon. Can be sent to both smbd and nmbd.</para></listitem>
253 <term>pool-usage</term>
254 <listitem><para>Print a human-readable description of all
255 talloc(pool) memory usage by the specified daemon/process. Available
256 for both smbd and nmbd.</para></listitem>
260 <term>drvupgrade</term>
261 <listitem><para>Force clients of printers using specified driver
262 to update their local version of the driver. Can only be
263 sent to smbd.</para></listitem>
267 <term>reload-config</term>
268 <listitem><para>Force daemon to reload smb.conf configuration file. Can be sent
269 to <constant>smbd</constant>, <constant>nmbd</constant>, or <constant>winbindd</constant>.
274 <term>reload-printers</term>
275 <listitem><para>Force smbd to reload printers. Can only be sent to
276 <constant>smbd</constant>.
282 <listitem><para>Notify about changes of id mapping. Can be sent
283 to <constant>smbd</constant> or (not implemented yet) <constant>winbindd</constant>.
288 <term>flush [uid|gid]</term>
289 <listitem><para>Flush caches for sid <-> gid and/or sid <-> uid mapping.
293 <term>delete <ID></term>
294 <listitem><para>Remove a mapping from cache. The mapping is given by <ID>
295 which may either be a sid: S-x-..., a gid: "GID number" or a uid: "UID number".
299 <term>kill <ID></term>
300 <listitem><para>Remove a mapping from cache. Terminate <constant>smbd</constant> if
301 the id is currently in use.</para></listitem>
307 <term>num-children</term>
308 <listitem><para>Query the number of smbd child processes. This
309 message can only be sent
310 to <constant>smbd</constant>.</para></listitem>
317 <title>VERSION</title>
319 <para>This man page is correct for version 3 of
320 the Samba suite.</para>
324 <title>SEE ALSO</title>
325 <para><citerefentry><refentrytitle>nmbd</refentrytitle>
326 <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>smbd</refentrytitle>
327 <manvolnum>8</manvolnum></citerefentry>.</para>
331 <title>AUTHOR</title>
333 <para>The original Samba software and related utilities
334 were created by Andrew Tridgell. Samba is now developed
335 by the Samba Team as an Open Source project similar
336 to the way the Linux kernel is developed.</para>
338 <para>The original Samba man pages were written by Karl Auer.
339 The man page sources were converted to YODL format (another
340 excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
341 ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
342 release by Jeremy Allison. The conversion to DocBook for
343 Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for
344 Samba 3.0 was done by Alexander Bokovoy.</para>