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