docs/htmldocs/smbcontrol.1.html

   1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbcontrol</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbcontrol.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>smbcontrol &#8212; send messages to smbd, nmbd or winbindd processes</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt>smbcontrol</tt>  [-i] [-s]</p></div><div class="cmdsynopsis"><p><tt>smbcontrol</tt>  [destination] [message-type] [parameter]</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html">Samba(7)</a> suite.</p><p><b>smbcontrol</b> is a very small program, which
   2         sends messages to a <a href="smbd.8.html">smbd(8)</a>, a <a href="nmbd.8.html">nmbd(8)</a>, or a <a href="winbindd.8.html">winbindd(8)</a> daemon running on the system.</p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-h|--help</span></dt><dd><p>Print a summary of command line options.
   3 </p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the
   4 configuration details required by the server.  The
   5 information in this file includes server-specific
   6 information such as what printcap file to use, as well
   7 as descriptions of all the services that the server is
   8 to provide. See <a href="smb.conf.5.html" target="_top"><tt>
   9 smb.conf(5)</tt></a> for more information.
  10 The default configuration file name is determined at
  11 compile time.</p></dd><dt><span class="term">-i</span></dt><dd><p>Run interactively. Individual commands
  12                 of the form destination message-type parameters can be entered
  13                 on STDIN. An empty command line or a &quot;q&quot; will quit the
  14                 program.</p></dd><dt><span class="term">destination</span></dt><dd><p>One of <i><tt>nmbd</tt></i>, <i><tt>smbd</tt></i> or a process ID.</p><p>The <i><tt>smbd</tt></i> destination causes the
  15                 message to &quot;broadcast&quot; to all smbd daemons.</p><p>The <i><tt>nmbd</tt></i> destination causes the
  16                 message to be sent to the nmbd daemon specified in the
  17                 <tt>nmbd.pid</tt> file.</p><p>If a single process ID is given, the message is sent
  18                 to only that process.</p></dd><dt><span class="term">message-type</span></dt><dd><p>Type of message to send. See
  19                 the section <tt>MESSAGE-TYPES</tt> for details.
  20                 </p></dd><dt><span class="term">parameters</span></dt><dd><p>any parameters required for the message-type</p></dd></dl></div></div><div class="refsect1" lang="en"><h2>MESSAGE-TYPES</h2><p>Available message types are:</p><div class="variablelist"><dl><dt><span class="term">close-share</span></dt><dd><p>Order smbd to close the client
  21         connections to the named share. Note that this doesn't affect client
  22         connections to any other shares. This message-type takes an argument of the
  23         share name for which client connections will be closed, or the
  24         &quot;*&quot; character which will close all currently open shares.
  25         This may be useful if you made changes to the access controls on the share.
  26         This message can only be sent to <tt>smbd</tt>.</p></dd><dt><span class="term">debug</span></dt><dd><p>Set debug level to the value specified by the
  27         parameter. This can be sent to any of the destinations.</p></dd><dt><span class="term">force-election</span></dt><dd><p>This message causes the <b>nmbd</b> daemon to
  28         force a new browse master election. </p></dd><dt><span class="term">ping</span></dt><dd><p>
  29         Send specified number of &quot;ping&quot; messages and
  30         wait for the same number of  reply &quot;pong&quot; messages. This can be sent to
  31         any of the destinations.</p></dd><dt><span class="term">profile</span></dt><dd><p>Change profile settings of a daemon, based on the
  32         parameter. The parameter can be &quot;on&quot; to turn on profile stats
  33         collection, &quot;off&quot; to turn off profile stats collection, &quot;count&quot;
  34         to enable only collection of count stats (time stats are
  35         disabled), and &quot;flush&quot; to zero the current profile stats. This can
  36         be sent to any smbd or nmbd destinations.</p></dd><dt><span class="term">debuglevel</span></dt><dd><p>
  37         Request debuglevel of a certain daemon and write it to stdout. This
  38         can be sent to any of the destinations.</p></dd><dt><span class="term">profilelevel</span></dt><dd><p>
  39         Request profilelevel of a certain daemon and write it to stdout.
  40         This can be sent to any smbd or nmbd destinations.</p></dd><dt><span class="term">printnotify</span></dt><dd><p>
  41         Order smbd to send a printer notify message to any Windows NT clients
  42         connected to a printer. This message-type takes the following arguments:
  43         </p><div class="variablelist"><dl><dt><span class="term">queuepause printername</span></dt><dd><p>Send a queue pause change notify
  44             message to the printer specified.</p></dd><dt><span class="term">queueresume printername</span></dt><dd><p>Send a queue resume change notify
  45             message for the printer specified.</p></dd><dt><span class="term">jobpause printername unixjobid</span></dt><dd><p>Send a job pause change notify
  46             message for the printer and unix jobid
  47             specified.</p></dd><dt><span class="term">jobresume printername unixjobid</span></dt><dd><p>Send a job resume change notify
  48             message for the printer and unix jobid
  49             specified.</p></dd><dt><span class="term">jobdelete printername unixjobid</span></dt><dd><p>Send a job delete change notify
  50             message for the printer and unix jobid
  51             specified.</p></dd></dl></div><p>
  52         Note that this message only sends notification that an
  53         event has occured.  It doesn't actually cause the
  54         event to happen.
  55         </p><p>This message can only be sent to <tt>smbd</tt>. </p></dd><dt><span class="term">samsync</span></dt><dd><p>Order smbd to synchronise sam database from PDC (being BDC). Can only be sent to <tt>smbd</tt>. </p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Not working at the moment</p></div></dd><dt><span class="term">samrepl</span></dt><dd><p>Send sam replication message, with specified serial. Can only be sent to <tt>smbd</tt>. Should not be used manually.</p></dd><dt><span class="term">dmalloc-mark</span></dt><dd><p>Set a mark for dmalloc. Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support. </p></dd><dt><span class="term">dmalloc-log-changed</span></dt><dd><p>
  56         Dump the pointers that have changed since the mark set by dmalloc-mark.
  57         Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support. </p></dd><dt><span class="term">shutdown</span></dt><dd><p>Shut down specified daemon. Can be sent to both smbd and nmbd.</p></dd><dt><span class="term">pool-usage</span></dt><dd><p>Print a human-readable description of all
  58         talloc(pool) memory usage by the specified daemon/process. Available
  59         for both smbd and nmbd.</p></dd><dt><span class="term">drvupgrade</span></dt><dd><p>Force clients of printers using specified driver
  60         to update their local version of the driver. Can only be
  61         sent to smbd.</p></dd></dl></div></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of
  62         the Samba suite.</p></div><div class="refsect1" lang="en"><h2>SEE ALSO</h2><p><a href="nmbd.8.html">nmbd(8)</a> and <a href="smbd.8.html">smbd(8)</a>.</p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities
  63         were created by Andrew Tridgell. Samba is now developed
  64         by the Samba Team as an Open Source project similar
  65         to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer.
  66         The man page sources were converted to YODL format (another
  67         excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top">
  68         ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0
  69         release by Jeremy Allison.  The conversion to DocBook for
  70         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for
  71         Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html>