| 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.2</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>smbd</parameter> destination causes the
|
|---|
| 67 | message to "broadcast" to all smbd daemons.</para>
|
|---|
| 68 |
|
|---|
| 69 | <para>The <parameter>nmbd</parameter> destination causes the
|
|---|
| 70 | message to be sent to the nmbd daemon specified in the
|
|---|
| 71 | <filename>nmbd.pid</filename> file.</para>
|
|---|
| 72 |
|
|---|
| 73 | <para>If a single process ID is given, the message is sent
|
|---|
| 74 | to only that process.</para></listitem>
|
|---|
| 75 | </varlistentry>
|
|---|
| 76 |
|
|---|
| 77 |
|
|---|
| 78 | <varlistentry>
|
|---|
| 79 | <term>message-type</term>
|
|---|
| 80 | <listitem><para>Type of message to send. See
|
|---|
| 81 | the section <constant>MESSAGE-TYPES</constant> for details.
|
|---|
| 82 | </para></listitem></varlistentry>
|
|---|
| 83 |
|
|---|
| 84 |
|
|---|
| 85 |
|
|---|
| 86 | <varlistentry>
|
|---|
| 87 | <term>parameters</term>
|
|---|
| 88 | <listitem><para>any parameters required for the message-type</para>
|
|---|
| 89 | </listitem>
|
|---|
| 90 | </varlistentry>
|
|---|
| 91 | </variablelist>
|
|---|
| 92 |
|
|---|
| 93 | </refsect1>
|
|---|
| 94 |
|
|---|
| 95 | <refsect1>
|
|---|
| 96 | <title>MESSAGE-TYPES</title>
|
|---|
| 97 |
|
|---|
| 98 | <para>Available message types are:</para>
|
|---|
| 99 |
|
|---|
| 100 | <variablelist>
|
|---|
| 101 | <varlistentry><term>close-share</term>
|
|---|
| 102 | <listitem><para>Order smbd to close the client
|
|---|
| 103 | connections to the named share. Note that this doesn't affect client
|
|---|
| 104 | connections to any other shares. This message-type takes an argument of the
|
|---|
| 105 | share name for which client connections will be closed, or the
|
|---|
| 106 | "*" character which will close all currently open shares.
|
|---|
| 107 | This may be useful if you made changes to the access controls on the share.
|
|---|
| 108 | This message can only be sent to <constant>smbd</constant>.</para>
|
|---|
| 109 | </listitem>
|
|---|
| 110 | </varlistentry>
|
|---|
| 111 |
|
|---|
| 112 | <varlistentry>
|
|---|
| 113 | <term>debug</term>
|
|---|
| 114 | <listitem><para>Set debug level to the value specified by the
|
|---|
| 115 | parameter. This can be sent to any of the destinations.</para>
|
|---|
| 116 | </listitem>
|
|---|
| 117 | </varlistentry>
|
|---|
| 118 |
|
|---|
| 119 | <varlistentry>
|
|---|
| 120 | <term>force-election</term>
|
|---|
| 121 | <listitem><para>This message causes the <command>nmbd</command> daemon to
|
|---|
| 122 | force a new browse master election. </para>
|
|---|
| 123 | </listitem></varlistentry>
|
|---|
| 124 |
|
|---|
| 125 | <varlistentry>
|
|---|
| 126 | <term>ping</term>
|
|---|
| 127 | <listitem><para>
|
|---|
| 128 | Send specified number of "ping" messages and
|
|---|
| 129 | wait for the same number of reply "pong" messages. This can be sent to
|
|---|
| 130 | any of the destinations.</para>
|
|---|
| 131 | </listitem>
|
|---|
| 132 | </varlistentry>
|
|---|
| 133 |
|
|---|
| 134 | <varlistentry>
|
|---|
| 135 | <term>profile</term>
|
|---|
| 136 | <listitem><para>Change profile settings of a daemon, based on the
|
|---|
| 137 | parameter. The parameter can be "on" to turn on profile stats
|
|---|
| 138 | collection, "off" to turn off profile stats collection, "count"
|
|---|
| 139 | to enable only collection of count stats (time stats are
|
|---|
| 140 | disabled), and "flush" to zero the current profile stats. This can
|
|---|
| 141 | be sent to any smbd or nmbd destinations.</para>
|
|---|
| 142 | </listitem></varlistentry>
|
|---|
| 143 |
|
|---|
| 144 | <varlistentry>
|
|---|
| 145 | <term>debuglevel</term>
|
|---|
| 146 | <listitem><para>
|
|---|
| 147 | Request debuglevel of a certain daemon and write it to stdout. This
|
|---|
| 148 | can be sent to any of the destinations.</para>
|
|---|
| 149 | </listitem>
|
|---|
| 150 | </varlistentry>
|
|---|
| 151 |
|
|---|
| 152 | <varlistentry>
|
|---|
| 153 | <term>profilelevel</term>
|
|---|
| 154 | <listitem><para>
|
|---|
| 155 | Request profilelevel of a certain daemon and write it to stdout.
|
|---|
| 156 | This can be sent to any smbd or nmbd destinations.</para>
|
|---|
| 157 | </listitem>
|
|---|
| 158 | </varlistentry>
|
|---|
| 159 |
|
|---|
| 160 | <varlistentry>
|
|---|
| 161 | <term>printnotify</term>
|
|---|
| 162 | <listitem><para>
|
|---|
| 163 | Order smbd to send a printer notify message to any Windows NT clients
|
|---|
| 164 | connected to a printer. This message-type takes the following arguments:
|
|---|
| 165 | </para>
|
|---|
| 166 |
|
|---|
| 167 | <variablelist>
|
|---|
| 168 |
|
|---|
| 169 | <varlistentry>
|
|---|
| 170 | <term>queuepause printername</term>
|
|---|
| 171 | <listitem><para>Send a queue pause change notify
|
|---|
| 172 | message to the printer specified.</para></listitem>
|
|---|
| 173 | </varlistentry>
|
|---|
| 174 |
|
|---|
| 175 | <varlistentry>
|
|---|
| 176 | <term>queueresume printername</term>
|
|---|
| 177 | <listitem><para>Send a queue resume change notify
|
|---|
| 178 | message for the printer specified.</para></listitem>
|
|---|
| 179 | </varlistentry>
|
|---|
| 180 |
|
|---|
| 181 | <varlistentry>
|
|---|
| 182 | <term>jobpause printername unixjobid</term>
|
|---|
| 183 | <listitem><para>Send a job pause change notify
|
|---|
| 184 | message for the printer and unix jobid
|
|---|
| 185 | specified.</para></listitem>
|
|---|
| 186 | </varlistentry>
|
|---|
| 187 |
|
|---|
| 188 | <varlistentry>
|
|---|
| 189 | <term>jobresume printername unixjobid</term>
|
|---|
| 190 | <listitem><para>Send a job resume change notify
|
|---|
| 191 | message for the printer and unix jobid
|
|---|
| 192 | specified.</para></listitem>
|
|---|
| 193 | </varlistentry>
|
|---|
| 194 |
|
|---|
| 195 | <varlistentry>
|
|---|
| 196 | <term>jobdelete printername unixjobid</term>
|
|---|
| 197 | <listitem><para>Send a job delete change notify
|
|---|
| 198 | message for the printer and unix jobid
|
|---|
| 199 | specified.</para></listitem>
|
|---|
| 200 | </varlistentry>
|
|---|
| 201 | </variablelist>
|
|---|
| 202 |
|
|---|
| 203 | <para>
|
|---|
| 204 | Note that this message only sends notification that an
|
|---|
| 205 | event has occured. It doesn't actually cause the
|
|---|
| 206 | event to happen.
|
|---|
| 207 | </para>
|
|---|
| 208 |
|
|---|
| 209 | <para>This message can only be sent to <constant>smbd</constant>. </para>
|
|---|
| 210 | </listitem>
|
|---|
| 211 | </varlistentry>
|
|---|
| 212 |
|
|---|
| 213 | <varlistentry>
|
|---|
| 214 | <term>samsync</term>
|
|---|
| 215 | <listitem><para>Order smbd to synchronise sam database from PDC (being BDC). Can only be sent to <constant>smbd</constant>. </para>
|
|---|
| 216 | <note><para>Not working at the moment</para></note>
|
|---|
| 217 | </listitem>
|
|---|
| 218 | </varlistentry>
|
|---|
| 219 |
|
|---|
| 220 | <varlistentry>
|
|---|
| 221 | <term>samrepl</term>
|
|---|
| 222 | <listitem><para>Send sam replication message, with specified serial. Can only be sent to <constant>smbd</constant>. Should not be used manually.</para></listitem>
|
|---|
| 223 | </varlistentry>
|
|---|
| 224 |
|
|---|
| 225 | <varlistentry>
|
|---|
| 226 | <term>dmalloc-mark</term>
|
|---|
| 227 | <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>
|
|---|
| 228 | </varlistentry>
|
|---|
| 229 |
|
|---|
| 230 | <varlistentry>
|
|---|
| 231 | <term>dmalloc-log-changed</term>
|
|---|
| 232 | <listitem><para>
|
|---|
| 233 | Dump the pointers that have changed since the mark set by dmalloc-mark.
|
|---|
| 234 | Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support. </para></listitem>
|
|---|
| 235 | </varlistentry>
|
|---|
| 236 |
|
|---|
| 237 | <varlistentry>
|
|---|
| 238 | <term>shutdown</term>
|
|---|
| 239 | <listitem><para>Shut down specified daemon. Can be sent to both smbd and nmbd.</para></listitem>
|
|---|
| 240 | </varlistentry>
|
|---|
| 241 |
|
|---|
| 242 | <varlistentry>
|
|---|
| 243 | <term>pool-usage</term>
|
|---|
| 244 | <listitem><para>Print a human-readable description of all
|
|---|
| 245 | talloc(pool) memory usage by the specified daemon/process. Available
|
|---|
| 246 | for both smbd and nmbd.</para></listitem>
|
|---|
| 247 | </varlistentry>
|
|---|
| 248 |
|
|---|
| 249 | <varlistentry>
|
|---|
|
|---|
