docs-xml/manpages/smbcontrol.1.xml

   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">
   4
   5 <refmeta>
   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.0</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>smbcontrol</refname>
  16         <refpurpose>send messages to smbd, nmbd or winbindd processes</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <cmdsynopsis>
  21                 <command>smbcontrol</command>
  22                 <arg>-s</arg>
  23                 <arg>-t|--timeout</arg>
  24         </cmdsynopsis>
  25
  26         <cmdsynopsis>
  27                 <command>smbcontrol</command>
  28                 <arg>destination</arg>
  29                 <arg>message-type</arg>
  30                 <arg>parameter</arg>
  31         </cmdsynopsis>
  32 </refsynopsisdiv>
  33
  34 <refsect1>
  35         <title>DESCRIPTION</title>
  36
  37         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  38         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  39
  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>
  45 </refsect1>
  46
  47
  48 <refsect1>
  49         <title>OPTIONS</title>
  50
  51         <variablelist>
  52                 &popt.autohelp;
  53                 &stdarg.configfile;
  54                 &popt.common.samba.client;
  55                 <varlistentry>
  56                 <term>-t|--timeout</term>
  57                 <listitem><para>
  58                                 Set timeout to seconds.
  59                 </para></listitem>
  60                 </varlistentry>
  61
  62                 <varlistentry>
  63                 <term>destination</term>
  64                 <listitem><para>One of <parameter>nmbd</parameter>, <parameter>smbd</parameter> or a process ID.</para>
  65
  66                 <para>The <parameter>all</parameter> destination causes the
  67                 message to "broadcast" to all running daemons including nmbd and
  68                 winbind. This is a change for Samba 3.3, prior to this the
  69                 parameter smbd used to do this.</para>
  70
  71                 <para>The <parameter>smbd</parameter> destination causes the
  72                 message to be sent to the smbd daemon specified in the
  73                 <filename>smbd.pid</filename> file.</para>
  74
  75                 <para>The <parameter>nmbd</parameter> destination causes the
  76                 message to be sent to the nmbd daemon specified in the
  77                 <filename>nmbd.pid</filename> file.</para>
  78
  79                 <para>The <parameter>winbindd</parameter> destination causes the
  80                 message to be sent to the winbind daemon specified in the
  81                 <filename>winbindd.pid</filename> file.</para>
  82
  83                 <para>If a single process ID is given, the message is sent
  84                 to only that process.</para></listitem>
  85                 </varlistentry>
  86
  87                 <varlistentry>
  88                 <term>message-type</term>
  89                 <listitem><para>Type of message to send. See
  90                 the section <constant>MESSAGE-TYPES</constant> for details.
  91                 </para></listitem></varlistentry>
  92
  93
  94
  95                 <varlistentry>
  96                 <term>parameters</term>
  97                 <listitem><para>any parameters required for the message-type</para>
  98                 </listitem>
  99                 </varlistentry>
 100         </variablelist>
 101
 102 </refsect1>
 103
 104 <refsect1>
 105         <title>MESSAGE-TYPES</title>
 106
 107         <para>Available message types are:</para>
 108
 109         <variablelist>
 110         <varlistentry><term>close-share</term>
 111         <listitem><para>Order smbd to close the client
 112         connections to the named share. Note that this doesn't affect client
 113         connections to any other shares. This message-type takes an argument of the
 114         share name for which client connections will be closed, or the
 115         "*" character which will close all currently open shares.
 116         This may be useful if you made changes to the access controls on the share.
 117         This message can only be sent to <constant>smbd</constant>.</para>
 118         </listitem>
 119         </varlistentry>
 120
 121         <varlistentry>
 122         <term>debug</term>
 123         <listitem><para>Set debug level to the value specified by the
 124         parameter. This can be sent to any of the destinations. If this
 125         message is sent to either the smbd or winbindd daemons, the parent
 126         process will rebroadcast the message to all child processes changing
 127         the debug level in each one.</para>
 128         </listitem>
 129         </varlistentry>
 130
 131         <varlistentry>
 132         <term>force-election</term>
 133         <listitem><para>This message causes the <command>nmbd</command> daemon to
 134         force a new browse master election. </para>
 135         </listitem></varlistentry>
 136
 137         <varlistentry>
 138         <term>ping</term>
 139         <listitem><para>
 140         Send specified number of "ping" messages and
 141         wait for the same number of  reply "pong" messages. This can be sent to
 142         any of the destinations.</para>
 143         </listitem>
 144         </varlistentry>
 145
 146         <varlistentry>
 147         <term>profile</term>
 148         <listitem><para>Change profile settings of a daemon, based on the
 149         parameter. The parameter can be "on" to turn on profile stats
 150         collection, "off" to turn off profile stats collection, "count"
 151         to enable only collection of count stats (time stats are
 152         disabled), and "flush" to zero the current profile stats. This can
 153         be sent to any smbd or nmbd destinations.</para>
 154         </listitem></varlistentry>
 155
 156         <varlistentry>
 157         <term>debuglevel</term>
 158         <listitem><para>
 159         Request debuglevel of a certain daemon and write it to stdout. This
 160         can be sent to any of the destinations.</para>
 161         </listitem>
 162         </varlistentry>
 163
 164         <varlistentry>
 165         <term>profilelevel</term>
 166         <listitem><para>
 167         Request profilelevel of a certain daemon and write it to stdout.
 168         This can be sent to any smbd or nmbd destinations.</para>
 169         </listitem>
 170         </varlistentry>
 171
 172         <varlistentry>
 173         <term>printnotify</term>
 174         <listitem><para>
 175         Order smbd to send a printer notify message to any Windows NT clients
 176         connected to a printer. This message-type takes the following arguments:
 177         </para>
 178
 179         <variablelist>
 180
 181             <varlistentry>
 182             <term>queuepause printername</term>
 183             <listitem><para>Send a queue pause change notify
 184             message to the printer specified.</para></listitem>
 185             </varlistentry>
 186
 187             <varlistentry>
 188             <term>queueresume printername</term>
 189             <listitem><para>Send a queue resume change notify
 190             message for the printer specified.</para></listitem>
 191             </varlistentry>
 192
 193                 <varlistentry>
 194             <term>jobpause printername unixjobid</term>
 195             <listitem><para>Send a job pause change notify
 196             message for the printer and unix jobid
 197             specified.</para></listitem>
 198             </varlistentry>
 199
 200             <varlistentry>
 201             <term>jobresume printername unixjobid</term>
 202             <listitem><para>Send a job resume change notify
 203             message for the printer and unix jobid
 204             specified.</para></listitem>
 205             </varlistentry>
 206
 207             <varlistentry>
 208             <term>jobdelete printername unixjobid</term>
 209             <listitem><para>Send a job delete change notify
 210             message for the printer and unix jobid
 211             specified.</para></listitem>
 212             </varlistentry>
 213         </variablelist>
 214
 215         <para>
 216         Note that this message only sends notification that an
 217         event has occurred.  It doesn't actually cause the
 218         event to happen.
 219         </para>
 220
 221         <para>This message can only be sent to <constant>smbd</constant>. </para>
 222         </listitem>
 223         </varlistentry>
 224
 225         <varlistentry>
 226         <term>dmalloc-mark</term>
 227         <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>
 228         </varlistentry>
 229
 230         <varlistentry>
 231         <term>dmalloc-log-changed</term>
 232         <listitem><para>
 233         Dump the pointers that have changed since the mark set by dmalloc-mark.
 234         Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support. </para></listitem>
 235         </varlistentry>
 236
 237         <varlistentry>
 238         <term>shutdown</term>
 239         <listitem><para>Shut down specified daemon. Can be sent to both smbd and nmbd.</para></listitem>
 240         </varlistentry>
 241
 242         <varlistentry>
 243         <term>pool-usage</term>
 244         <listitem><para>Print a human-readable description of all
 245         talloc(pool) memory usage by the specified daemon/process. Available
 246         for both smbd and nmbd.</para></listitem>
 247         </varlistentry>
 248
 249         <varlistentry>
 250         <term>drvupgrade</term>
 251         <listitem><para>Force clients of printers using specified driver
 252         to update their local version of the driver. Can only be
 253         sent to smbd.</para></listitem>
 254         </varlistentry>
 255
 256         <varlistentry>
 257         <term>reload-config</term>
 258         <listitem><para>Force daemon to reload smb.conf configuration file. Can be sent
 259         to <constant>smbd</constant>, <constant>nmbd</constant>, or <constant>winbindd</constant>.
 260         </para></listitem>
 261         </varlistentry>
 262
 263         <varlistentry>
 264         <term>reload-printers</term>
 265         <listitem><para>Force smbd to reload printers. Can only be sent to
 266         <constant>smbd</constant>.
 267         </para></listitem>
 268         </varlistentry>
 269
 270         <varlistentry>
 271         <term>idmap</term>
 272         <listitem><para>Notify about changes of id mapping. Can be sent
 273         to <constant>smbd</constant> or (not implemented yet) <constant>winbindd</constant>.
 274         </para></listitem>
 275
 276         <variablelist>
 277           <varlistentry>
 278             <term>flush [uid|gid]</term>
 279             <listitem><para>Flush caches for sid &lt;-&gt; gid and/or sid &lt;-&gt; uid mapping.
 280             </para></listitem>
 281           </varlistentry>
 282           <varlistentry>
 283             <term>delete &lt;ID&gt;</term>
 284             <listitem><para>Remove a mapping from cache. The mapping is given by &lt;ID&gt;
 285             which may either be a sid: S-x-..., a gid: "GID number" or a uid: "UID number".
 286             </para></listitem>
 287           </varlistentry>
 288           <varlistentry>
 289             <term>kill &lt;ID&gt;</term>
 290             <listitem><para>Remove a mapping from cache. Terminate <constant>smbd</constant> if
 291             the id is currently in use.</para></listitem>
 292           </varlistentry>
 293         </variablelist>
 294         </varlistentry>
 295
 296 </variablelist>
 297 </refsect1>
 298
 299 <refsect1>
 300         <title>VERSION</title>
 301
 302         <para>This man page is correct for version 3 of
 303         the Samba suite.</para>
 304 </refsect1>
 305
 306 <refsect1>
 307         <title>SEE ALSO</title>
 308         <para><citerefentry><refentrytitle>nmbd</refentrytitle>
 309         <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>smbd</refentrytitle>
 310         <manvolnum>8</manvolnum></citerefentry>.</para>
 311 </refsect1>
 312
 313 <refsect1>
 314         <title>AUTHOR</title>
 315
 316         <para>The original Samba software and related utilities
 317         were created by Andrew Tridgell. Samba is now developed
 318         by the Samba Team as an Open Source project similar
 319         to the way the Linux kernel is developed.</para>
 320
 321         <para>The original Samba man pages were written by Karl Auer.
 322         The man page sources were converted to YODL format (another
 323         excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 324         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 325         release by Jeremy Allison.  The conversion to DocBook for
 326         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for
 327         Samba 3.0 was done by Alexander Bokovoy.</para>
 328 </refsect1>
 329
 330 </refentry>