docs/docbook/manpages/smbcontrol.1.sgml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
   2 <refentry id="smbcontrol">
   3
   4 <refmeta>
   5         <refentrytitle>smbcontrol</refentrytitle>
   6         <manvolnum>1</manvolnum>
   7 </refmeta>
   8
   9
  10 <refnamediv>
  11         <refname>smbcontrol</refname>
  12         <refpurpose>send messages to smbd, nmbd or winbindd processes</refpurpose>
  13 </refnamediv>
  14
  15 <refsynopsisdiv>
  16         <cmdsynopsis>
  17                 <command>smbcontrol</command>
  18                 <arg>-i</arg>
  19         </cmdsynopsis>
  20
  21         <cmdsynopsis>
  22                 <command>smbcontrol</command>
  23                 <arg>destination</arg>
  24                 <arg>message-type</arg>
  25                 <arg>parameter</arg>
  26         </cmdsynopsis>
  27 </refsynopsisdiv>
  28
  29 <refsect1>
  30         <title>DESCRIPTION</title>
  31
  32         <para>This tool is part of the <ulink url="samba.7.html">
  33         Samba</ulink> suite.</para>
  34
  35         <para><command>smbcontrol</command> is a very small program, which
  36         sends messages to an <ulink url="smbd.8.html">smbd(8)</ulink>,
  37         an <ulink url="nmbd.8.html">nmbd(8)</ulink>
  38         or a <ulink url="winbindd.8.html">winbindd(8)</ulink>
  39         daemon running on the system.</para>
  40 </refsect1>
  41
  42
  43 <refsect1>
  44         <title>OPTIONS</title>
  45
  46         <variablelist>
  47                 <varlistentry>
  48                 <term>-i</term>
  49                 <listitem><para>Run interactively. Individual commands
  50                 of the form destination message-type parameters can be entered
  51                 on STDIN. An empty command line or a "q" will quit the
  52                 program.</para></listitem>
  53                 </varlistentry>
  54
  55                 <varlistentry>
  56                 <term>destination</term>
  57                 <listitem><para>One of <parameter>nmbd</parameter>
  58                 <parameter>smbd</parameter> or a process ID.</para>
  59
  60                 <para>The <parameter>smbd</parameter> destination causes the
  61                 message to "broadcast" to all smbd daemons.</para>
  62
  63                 <para>The <parameter>nmbd</parameter> destination causes the
  64                 message to be sent to the nmbd daemon specified in the
  65                 <filename>nmbd.pid</filename> file.</para>
  66
  67                 <para>If a single process ID is given, the message is sent
  68                 to only that process.</para></listitem>
  69                 </varlistentry>
  70
  71
  72                 <varlistentry>
  73                 <term>message-type</term>
  74                 <listitem><para>One of: <constant>close-share</constant>,
  75                 <constant>debug</constant>,
  76                 <constant>force-election</constant>, <constant>ping
  77                 </constant>, <constant>profile</constant>, <constant>
  78                 debuglevel</constant>, <constant>profilelevel</constant>,
  79                 or <constant>printnotify</constant>.</para>
  80
  81                 <para>The <constant>close-share</constant> message-type sends a
  82                 message to smbd which will then close the client connections to
  83                 the named share. Note that this doesn't affect client connections
  84                 to any other shares. This message-type takes an argument of the
  85                 share name for which client connections will be closed, or the
  86                 "*" character which will close all currently open shares.
  87                 This may be useful if you made changes to the access controls on the share.
  88                 This message can only be sent to <constant>smbd</constant>.</para>
  89
  90                 <para>The <constant>debug</constant> message-type allows
  91                 the debug level to be set to the value specified by the
  92                 parameter. This can be sent to any of the destinations.</para>
  93
  94                 <para>The <constant>force-election</constant> message-type can only be
  95                 sent to the <constant>nmbd</constant> destination. This message
  96                 causes the <command>nmbd</command> daemon to force a new browse
  97                 master election.</para>
  98
  99                 <para>The <constant>ping</constant> message-type sends the
 100                 number of "ping" messages specified by the parameter and waits
 101                 for the same number of  reply "pong" messages. This can be sent to
 102                 any of the destinations.</para>
 103
 104                 <para>The <constant>profile</constant> message-type sends a
 105                 message to an smbd to change the profile settings based on the
 106                 parameter. The parameter can be "on" to turn on profile stats
 107                 collection, "off" to turn off profile stats collection, "count"
 108                 to enable only collection of count stats (time stats are
 109                 disabled), and "flush" to zero the current profile stats. This can
 110                 be sent to any smbd or nmbd destinations.</para>
 111
 112                 <para>The <constant>debuglevel</constant> message-type sends
 113                 a "request debug level" message. The current debug level setting
 114                 is returned by a  "debuglevel" message. This can be
 115                 sent to any of the destinations.</para>
 116
 117                 <para>The <constant>profilelevel</constant> message-type sends
 118                 a "request profile level" message.  The current profile level
 119                 setting is returned by a  "profilelevel" message. This can be sent
 120                 to any smbd or nmbd destinations.</para>
 121
 122                 <para>The <constant>printnotify</constant> message-type sends a
 123                 message to smbd which in turn sends a printer notify message to
 124                 any Windows NT clients connected to a printer. This message-type
 125                 takes the following arguments:
 126
 127                 <variablelist>
 128
 129                     <varlistentry>
 130                     <term>queuepause printername</term>
 131                     <listitem><para>Send a queue pause change notify
 132                     message to the printer specified.</para></listitem>
 133                     </varlistentry>
 134
 135                     <varlistentry>
 136                     <term>queueresume printername</term>
 137                     <listitem><para>Send a queue resume change notify
 138                     message for the printer specified.</para></listitem>
 139                     </varlistentry>
 140
 141                     <varlistentry>
 142                     <term>jobpause printername unixjobid</term>
 143                     <listitem><para>Send a job pause change notify
 144                     message for the printer and unix jobid
 145                     specified.</para></listitem>
 146                     </varlistentry>
 147
 148                     <varlistentry>
 149                     <term>jobresume printername unixjobid</term>
 150                     <listitem><para>Send a job resume change notify
 151                     message for the printer and unix jobid
 152                     specified.</para></listitem>
 153                     </varlistentry>
 154
 155                     <varlistentry>
 156                     <term>jobdelete printername unixjobid</term>
 157                     <listitem><para>Send a job delete change notify
 158                     message for the printer and unix jobid
 159                     specified.</para></listitem>
 160                     </varlistentry>
 161
 162                 </variablelist>
 163
 164                 Note that this message only sends notification that an
 165                 event has occured.  It doesn't actually cause the
 166                 event to happen.
 167
 168                 This message can only be sent to <constant>smbd</constant>.
 169                 </para>
 170
 171                 </listitem>
 172                 </varlistentry>
 173
 174
 175                 <varlistentry>
 176                 <term>parameters</term>
 177                 <listitem><para>any parameters required for the message-type</para>
 178                 </listitem>
 179                 </varlistentry>
 180         </variablelist>
 181
 182 </refsect1>
 183
 184 <refsect1>
 185         <title>VERSION</title>
 186
 187         <para>This man page is correct for version 2.2 of
 188         the Samba suite.</para>
 189 </refsect1>
 190
 191 <refsect1>
 192         <title>SEE ALSO</title>
 193         <para><ulink url="nmbd.8.html"><command>nmbd(8)</command></ulink>,
 194         and <ulink url="smbd.8.html"><command>smbd(8)</command></ulink>.
 195         </para>
 196 </refsect1>
 197
 198 <refsect1>
 199         <title>AUTHOR</title>
 200
 201         <para>The original Samba software and related utilities
 202         were created by Andrew Tridgell. Samba is now developed
 203         by the Samba Team as an Open Source project similar
 204         to the way the Linux kernel is developed.</para>
 205
 206         <para>The original Samba man pages were written by Karl Auer.
 207         The man page sources were converted to YODL format (another
 208         excellent piece of Open Source software, available at
 209         <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 210         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 211         release by Jeremy Allison.  The conversion to DocBook for
 212         Samba 2.2 was done by Gerald Carter</para>
 213 </refsect1>
 214
 215 </refentry>