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.1</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>-i</arg>
  23                 <arg>-s</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                 &stdarg.help;
  53                 &stdarg.configfile;
  54                 &popt.common.samba;
  55                 <varlistentry>
  56                 <term>-i</term>
  57                 <listitem><para>Run interactively. Individual commands
  58                 of the form destination message-type parameters can be entered
  59                 on STDIN. An empty command line or a "q" will quit the
  60                 program.</para></listitem>
  61                 </varlistentry>
  62
  63                 <varlistentry>
  64                 <term>destination</term>
  65                 <listitem><para>One of <parameter>nmbd</parameter>, <parameter>smbd</parameter> 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>force-election</term>
 134         <listitem><para>This message causes the <command>nmbd</command> daemon to
 135         force a new browse master election. </para>
 136         </listitem></varlistentry>
 137
 138         <varlistentry>
 139         <term>ping</term>
 140         <listitem><para>
 141         Send specified number of "ping" messages and
 142         wait for the same number of  reply "pong" messages. This can be sent to
 143         any of the destinations.</para>
 144         </listitem>
 145         </varlistentry>
 146
 147         <varlistentry>
 148         <term>profile</term>
 149         <listitem><para>Change profile settings of a daemon, based on the
 150         parameter. The parameter can be "on" to turn on profile stats
 151         collection, "off" to turn off profile stats collection, "count"
 152         to enable only collection of count stats (time stats are
 153         disabled), and "flush" to zero the current profile stats. This can
 154         be sent to any smbd or nmbd destinations.</para>
 155         </listitem></varlistentry>
 156
 157         <varlistentry>
 158         <term>debuglevel</term>
 159         <listitem><para>
 160         Request debuglevel of a certain daemon and write it to stdout. This
 161         can be sent to any of the destinations.</para>
 162         </listitem>
 163         </varlistentry>
 164
 165         <varlistentry>
 166         <term>profilelevel</term>
 167         <listitem><para>
 168         Request profilelevel of a certain daemon and write it to stdout.
 169         This can be sent to any smbd or nmbd destinations.</para>
 170         </listitem>
 171         </varlistentry>
 172
 173         <varlistentry>
 174         <term>printnotify</term>
 175         <listitem><para>
 176         Order smbd to send a printer notify message to any Windows NT clients
 177         connected to a printer. This message-type takes the following arguments:
 178         </para>
 179
 180         <variablelist>
 181
 182             <varlistentry>
 183             <term>queuepause printername</term>
 184             <listitem><para>Send a queue pause change notify
 185             message to the printer specified.</para></listitem>
 186             </varlistentry>
 187
 188             <varlistentry>
 189             <term>queueresume printername</term>
 190             <listitem><para>Send a queue resume change notify
 191             message for the printer specified.</para></listitem>
 192             </varlistentry>
 193
 194                 <varlistentry>
 195             <term>jobpause printername unixjobid</term>
 196             <listitem><para>Send a job pause change notify
 197             message for the printer and unix jobid
 198             specified.</para></listitem>
 199             </varlistentry>
 200
 201             <varlistentry>
 202             <term>jobresume printername unixjobid</term>
 203             <listitem><para>Send a job resume change notify
 204             message for the printer and unix jobid
 205             specified.</para></listitem>
 206             </varlistentry>
 207
 208             <varlistentry>
 209             <term>jobdelete printername unixjobid</term>
 210             <listitem><para>Send a job delete change notify
 211             message for the printer and unix jobid
 212             specified.</para></listitem>
 213             </varlistentry>
 214         </variablelist>
 215
 216         <para>
 217         Note that this message only sends notification that an
 218         event has occurred.  It doesn't actually cause the
 219         event to happen.
 220         </para>
 221
 222         <para>This message can only be sent to <constant>smbd</constant>. </para>
 223         </listitem>
 224         </varlistentry>
 225
 226         <varlistentry>
 227         <term>dmalloc-mark</term>
 228         <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>
 229         </varlistentry>
 230
 231         <varlistentry>
 232         <term>dmalloc-log-changed</term>
 233         <listitem><para>
 234         Dump the pointers that have changed since the mark set by dmalloc-mark.
 235         Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support. </para></listitem>
 236         </varlistentry>
 237
 238         <varlistentry>
 239         <term>shutdown</term>
 240         <listitem><para>Shut down specified daemon. Can be sent to both smbd and nmbd.</para></listitem>
 241         </varlistentry>
 242
 243         <varlistentry>
 244         <term>pool-usage</term>
 245         <listitem><para>Print a human-readable description of all
 246         talloc(pool) memory usage by the specified daemon/process. Available
 247         for both smbd and nmbd.</para></listitem>
 248         </varlistentry>
 249
 250         <varlistentry>
 251         <term>drvupgrade</term>
 252         <listitem><para>Force clients of printers using specified driver
 253         to update their local version of the driver. Can only be
 254         sent to smbd.</para></listitem>
 255         </varlistentry>
 256
 257         <varlistentry>
 258         <term>reload-config</term>
 259         <listitem><para>Force daemon to reload smb.conf configuration file. Can be sent
 260         to <constant>smbd</constant>, <constant>nmbd</constant>, or <constant>winbindd</constant>.
 261         </para></listitem>
 262         </varlistentry>
 263
 264         <varlistentry>
 265         <term>reload-printers</term>
 266         <listitem><para>Force smbd to reload printers. Can only be sent to
 267         <constant>smbd</constant>.
 268         </para></listitem>
 269         </varlistentry>
 270
 271         <varlistentry>
 272         <term>idmap</term>
 273         <listitem><para>Notify about changes of id mapping. Can be sent
 274         to <constant>smbd</constant> or (not implemented yet) <constant>winbindd</constant>.
 275         </para></listitem>
 276
 277         <variablelist>
 278           <varlistentry>
 279             <term>flush [uid|gid]</term>
 280             <listitem><para>Flush caches for sid &lt;-&gt; gid and/or sid &lt;-&gt; uid mapping.
 281             </para></listitem>
 282           </varlistentry>
 283           <varlistentry>
 284             <term>delete &lt;ID&gt;</term>
 285             <listitem><para>Remove a mapping from cache. The mapping is given by &lt;ID&gt;
 286             which may either be a sid: S-x-..., a gid: "GID number" or a uid: "UID number".
 287             </para></listitem>
 288           </varlistentry>
 289           <varlistentry>
 290             <term>kill &lt;ID&gt;</term>
 291             <listitem><para>Remove a mapping from cache. Terminate <constant>smbd</constant> if
 292             the id is currently in use.</para></listitem>
 293           </varlistentry>
 294         </variablelist>
 295         </varlistentry>
 296
 297 </variablelist>
 298 </refsect1>
 299
 300 <refsect1>
 301         <title>VERSION</title>
 302
 303         <para>This man page is correct for version 3 of
 304         the Samba suite.</para>
 305 </refsect1>
 306
 307 <refsect1>
 308         <title>SEE ALSO</title>
 309         <para><citerefentry><refentrytitle>nmbd</refentrytitle>
 310         <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>smbd</refentrytitle>
 311         <manvolnum>8</manvolnum></citerefentry>.</para>
 312 </refsect1>
 313
 314 <refsect1>
 315         <title>AUTHOR</title>
 316
 317         <para>The original Samba software and related utilities
 318         were created by Andrew Tridgell. Samba is now developed
 319         by the Samba Team as an Open Source project similar
 320         to the way the Linux kernel is developed.</para>
 321
 322         <para>The original Samba man pages were written by Karl Auer.
 323         The man page sources were converted to YODL format (another
 324         excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 325         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 326         release by Jeremy Allison.  The conversion to DocBook for
 327         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for
 328         Samba 3.0 was done by Alexander Bokovoy.</para>
 329 </refsect1>
 330
 331 </refentry>