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">&doc.version;</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                 &popt.common.samba.client;
  54                 <varlistentry>
  55                 <term>-t|--timeout</term>
  56                 <listitem><para>
  57                                 Set timeout to seconds.
  58                 </para></listitem>
  59                 </varlistentry>
  60
  61                 <varlistentry>
  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>
  66
  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>
  71
  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>
  75
  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>
  79
  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>
  83
  84                 <para>If a single process ID is given, the message is sent
  85                 to only that process.</para></listitem>
  86                 </varlistentry>
  87
  88                 <varlistentry>
  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>
  93
  94
  95
  96                 <varlistentry>
  97                 <term>parameters</term>
  98                 <listitem><para>any parameters required for the message-type</para>
  99                 </listitem>
 100                 </varlistentry>
 101         </variablelist>
 102
 103 </refsect1>
 104
 105 <refsect1>
 106         <title>MESSAGE-TYPES</title>
 107
 108         <para>Available message types are:</para>
 109
 110         <variablelist>
 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>
 119         </listitem>
 120         </varlistentry>
 121
 122         <varlistentry>
 123         <term>debug</term>
 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>
 129         </listitem>
 130         </varlistentry>
 131
 132         <varlistentry>
 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>
 138         </listitem>
 139         </varlistentry>
 140
 141         <varlistentry>
 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>
 146
 147         <varlistentry>
 148         <term>ping</term>
 149         <listitem><para>
 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>
 153         </listitem>
 154         </varlistentry>
 155
 156         <varlistentry>
 157         <term>profile</term>
 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>
 165
 166         <varlistentry>
 167         <term>debuglevel</term>
 168         <listitem><para>
 169         Request debuglevel of a certain daemon and write it to stdout. This
 170         can be sent to any of the destinations.</para>
 171         </listitem>
 172         </varlistentry>
 173
 174         <varlistentry>
 175         <term>profilelevel</term>
 176         <listitem><para>
 177         Request profilelevel of a certain daemon and write it to stdout.
 178         This can be sent to any smbd or nmbd destinations.</para>
 179         </listitem>
 180         </varlistentry>
 181
 182         <varlistentry>
 183         <term>printnotify</term>
 184         <listitem><para>
 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:
 187         </para>
 188
 189         <variablelist>
 190
 191             <varlistentry>
 192             <term>queuepause printername</term>
 193             <listitem><para>Send a queue pause change notify
 194             message to the printer specified.</para></listitem>
 195             </varlistentry>
 196
 197             <varlistentry>
 198             <term>queueresume printername</term>
 199             <listitem><para>Send a queue resume change notify
 200             message for the printer specified.</para></listitem>
 201             </varlistentry>
 202
 203                 <varlistentry>
 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>
 208             </varlistentry>
 209
 210             <varlistentry>
 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>
 215             </varlistentry>
 216
 217             <varlistentry>
 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>
 222             </varlistentry>
 223         </variablelist>
 224
 225         <para>
 226         Note that this message only sends notification that an
 227         event has occurred.  It doesn't actually cause the
 228         event to happen.
 229         </para>
 230
 231         <para>This message can only be sent to <constant>smbd</constant>. </para>
 232         </listitem>
 233         </varlistentry>
 234
 235         <varlistentry>
 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>
 238         </varlistentry>
 239
 240         <varlistentry>
 241         <term>dmalloc-log-changed</term>
 242         <listitem><para>
 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>
 245         </varlistentry>
 246
 247         <varlistentry>
 248         <term>shutdown</term>
 249         <listitem><para>Shut down specified daemon. Can be sent to both smbd and nmbd.</para></listitem>
 250         </varlistentry>
 251
 252         <varlistentry>
 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>
 257         </varlistentry>
 258
 259         <varlistentry>
 260         <term>ringbuf-log</term>
 261         <listitem><para>Fetch and print the ringbuf log. Requires
 262         <parameter>logging = ringbuf</parameter>. Available for smbd, winbindd
 263         and nmbd.</para></listitem>
 264         </varlistentry>
 265
 266         <varlistentry>
 267         <term>drvupgrade</term>
 268         <listitem><para>Force clients of printers using specified driver
 269         to update their local version of the driver. Can only be
 270         sent to smbd.</para></listitem>
 271         </varlistentry>
 272
 273         <varlistentry>
 274         <term>reload-config</term>
 275         <listitem><para>Force daemon to reload smb.conf configuration file. Can be sent
 276         to <constant>smbd</constant>, <constant>nmbd</constant>, or <constant>winbindd</constant>.
 277         </para></listitem>
 278         </varlistentry>
 279
 280         <varlistentry>
 281         <term>reload-printers</term>
 282         <listitem><para>Force smbd to reload printers. Can only be sent to
 283         <constant>smbd</constant>.
 284         </para></listitem>
 285         </varlistentry>
 286
 287         <varlistentry>
 288         <term>idmap</term>
 289         <listitem><para>Notify about changes of id mapping. Can be sent
 290         to <constant>smbd</constant> or (not implemented yet) <constant>winbindd</constant>.
 291         </para></listitem>
 292
 293         <variablelist>
 294           <varlistentry>
 295             <term>flush [uid|gid]</term>
 296             <listitem><para>Flush caches for sid &lt;-&gt; gid and/or sid &lt;-&gt; uid mapping.
 297             </para></listitem>
 298           </varlistentry>
 299           <varlistentry>
 300             <term>delete &lt;ID&gt;</term>
 301             <listitem><para>Remove a mapping from cache. The mapping is given by &lt;ID&gt;
 302             which may either be a sid: S-x-..., a gid: "GID number" or a uid: "UID number".
 303             </para></listitem>
 304           </varlistentry>
 305           <varlistentry>
 306             <term>kill &lt;ID&gt;</term>
 307             <listitem><para>Remove a mapping from cache. Terminate <constant>smbd</constant> if
 308             the id is currently in use.</para></listitem>
 309           </varlistentry>
 310         </variablelist>
 311         </varlistentry>
 312
 313         <varlistentry>
 314         <term>num-children</term>
 315         <listitem><para>Query the number of smbd child processes. This
 316         message can only be sent
 317         to <constant>smbd</constant>.</para></listitem>
 318         </varlistentry>
 319
 320 </variablelist>
 321 </refsect1>
 322
 323 <refsect1>
 324         <title>VERSION</title>
 325
 326         <para>This man page is part of version &doc.version; of
 327         the Samba suite.</para>
 328 </refsect1>
 329
 330 <refsect1>
 331         <title>SEE ALSO</title>
 332         <para><citerefentry><refentrytitle>nmbd</refentrytitle>
 333         <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>smbd</refentrytitle>
 334         <manvolnum>8</manvolnum></citerefentry>.</para>
 335 </refsect1>
 336
 337 <refsect1>
 338         <title>AUTHOR</title>
 339
 340         <para>The original Samba software and related utilities
 341         were created by Andrew Tridgell. Samba is now developed
 342         by the Samba Team as an Open Source project similar
 343         to the way the Linux kernel is developed.</para>
 344 </refsect1>
 345
 346 </refentry>