| 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.4</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>-s</arg>
|
|---|
| 23 | <arg>-t|--timeout</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 | &popt.autohelp;
|
|---|
| 53 | &stdarg.configfile;
|
|---|
| 54 | &popt.common.samba.client;
|
|---|
| 55 | <varlistentry>
|
|---|
| 56 | <term>-t|--timeout</term>
|
|---|
| 57 | <listitem><para>
|
|---|
| 58 | Set timeout to seconds.
|
|---|
| 59 | </para></listitem>
|
|---|
| 60 | </varlistentry>
|
|---|
| 61 |
|
|---|
| 62 | <varlistentry>
|
|---|
| 63 | <term>destination</term>
|
|---|
| 64 | <listitem><para>One of <parameter>nmbd</parameter>,
|
|---|
| 65 | <parameter>smbd</parameter>, <parameter>winbindd</parameter>
|
|---|
| 66 | or a process ID.</para>
|
|---|
| 67 |
|
|---|
| 68 | <para>The <parameter>all</parameter> destination causes the
|
|---|
| 69 | message to "broadcast" to all running daemons including nmbd and
|
|---|
| 70 | winbind. This is a change for Samba 3.3, prior to this the
|
|---|
| 71 | parameter smbd used to do this.</para>
|
|---|
| 72 |
|
|---|
| 73 | <para>The <parameter>smbd</parameter> destination causes the
|
|---|
| 74 | message to be sent to the smbd daemon specified in the
|
|---|
| 75 | <filename>smbd.pid</filename> file.</para>
|
|---|
| 76 |
|
|---|
| 77 | <para>The <parameter>nmbd</parameter> destination causes the
|
|---|
| 78 | message to be sent to the nmbd daemon specified in the
|
|---|
| 79 | <filename>nmbd.pid</filename> file.</para>
|
|---|
| 80 |
|
|---|
| 81 | <para>The <parameter>winbindd</parameter> destination causes the
|
|---|
| 82 | message to be sent to the winbind daemon specified in the
|
|---|
| 83 | <filename>winbindd.pid</filename> file.</para>
|
|---|
| 84 |
|
|---|
| 85 | <para>If a single process ID is given, the message is sent
|
|---|
| 86 | to only that process.</para></listitem>
|
|---|
| 87 | </varlistentry>
|
|---|
| 88 |
|
|---|
| 89 | <varlistentry>
|
|---|
| 90 | <term>message-type</term>
|
|---|
| 91 | <listitem><para>Type of message to send. See
|
|---|
| 92 | the section <constant>MESSAGE-TYPES</constant> for details.
|
|---|
| 93 | </para></listitem></varlistentry>
|
|---|
| 94 |
|
|---|
| 95 |
|
|---|
| 96 |
|
|---|
| 97 | <varlistentry>
|
|---|
| 98 | <term>parameters</term>
|
|---|
| 99 | <listitem><para>any parameters required for the message-type</para>
|
|---|
| 100 | </listitem>
|
|---|
| 101 | </varlistentry>
|
|---|
| 102 | </variablelist>
|
|---|
| 103 |
|
|---|
| 104 | </refsect1>
|
|---|
| 105 |
|
|---|
| 106 | <refsect1>
|
|---|
| 107 | <title>MESSAGE-TYPES</title>
|
|---|
| 108 |
|
|---|
| 109 | <para>Available message types are:</para>
|
|---|
| 110 |
|
|---|
| 111 | <variablelist>
|
|---|
| 112 | <varlistentry><term>close-share</term>
|
|---|
| 113 | <listitem><para>Order smbd to close the client
|
|---|
| 114 | connections to the named share. Note that this doesn't affect client
|
|---|
| 115 | connections to any other shares. This message-type takes an argument of the
|
|---|
| 116 | share name for which client connections will be closed, or the
|
|---|
| 117 | "*" character which will close all currently open shares.
|
|---|
| 118 | This may be useful if you made changes to the access controls on the share.
|
|---|
| 119 | This message can only be sent to <constant>smbd</constant>.</para>
|
|---|
| 120 | </listitem>
|
|---|
| 121 | </varlistentry>
|
|---|
| 122 |
|
|---|
| 123 | <varlistentry>
|
|---|
| 124 | <term>debug</term>
|
|---|
| 125 | <listitem><para>Set debug level to the value specified by the
|
|---|
| 126 | parameter. This can be sent to any of the destinations. If this
|
|---|
| 127 | message is sent to either the smbd or winbindd daemons, the parent
|
|---|
| 128 | process will rebroadcast the message to all child processes changing
|
|---|
| 129 | the debug level in each one.</para>
|
|---|
| 130 | </listitem>
|
|---|
| 131 | </varlistentry>
|
|---|
| 132 |
|
|---|
| 133 | <varlistentry>
|
|---|
| 134 | <term>kill-client-ip</term>
|
|---|
| 135 | <listitem><para>Order smbd to close the client connections from a
|
|---|
| 136 | given IP address. This message-type takes an argument of the IP
|
|---|
| 137 | address from which client connections will be closed. This message
|
|---|
| 138 | can only be sent to <constant>smbd</constant>.</para>
|
|---|
| 139 | </listitem>
|
|---|
| 140 | </varlistentry>
|
|---|
| 141 |
|
|---|
| 142 | <varlistentry>
|
|---|
| 143 | <term>force-election</term>
|
|---|
| 144 | <listitem><para>This message causes the <command>nmbd</command> daemon to
|
|---|
| 145 | force a new browse master election. </para>
|
|---|
| 146 | </listitem></varlistentry>
|
|---|
| 147 |
|
|---|
| 148 | <varlistentry>
|
|---|
| 149 | <term>ping</term>
|
|---|
| 150 | <listitem><para>
|
|---|
| 151 | Send specified number of "ping" messages and
|
|---|
| 152 | wait for the same number of reply "pong" messages. This can be sent to
|
|---|
| 153 | any of the destinations.</para>
|
|---|
| 154 | </listitem>
|
|---|
| 155 | </varlistentry>
|
|---|
| 156 |
|
|---|
| 157 | <varlistentry>
|
|---|
| 158 | <term>profile</term>
|
|---|
| 159 | <listitem><para>Change profile settings of a daemon, based on the
|
|---|
| 160 | parameter. The parameter can be "on" to turn on profile stats
|
|---|
| 161 | collection, "off" to turn off profile stats collection, "count"
|
|---|
| 162 | to enable only collection of count stats (time stats are
|
|---|
| 163 | disabled), and "flush" to zero the current profile stats. This can
|
|---|
| 164 | be sent to any smbd or nmbd destinations.</para>
|
|---|
| 165 | </listitem></varlistentry>
|
|---|
| 166 |
|
|---|
| 167 | <varlistentry>
|
|---|
| 168 | <term>debuglevel</term>
|
|---|
| 169 | <listitem><para>
|
|---|
| 170 | Request debuglevel of a certain daemon and write it to stdout. This
|
|---|
| 171 | can be sent to any of the destinations.</para>
|
|---|
| 172 | </listitem>
|
|---|
| 173 | </varlistentry>
|
|---|
| 174 |
|
|---|
| 175 | <varlistentry>
|
|---|
| 176 | <term>profilelevel</term>
|
|---|
| 177 | <listitem><para>
|
|---|
| 178 | Request profilelevel of a certain daemon and write it to stdout.
|
|---|
| 179 | This can be sent to any smbd or nmbd destinations.</para>
|
|---|
| 180 | </listitem>
|
|---|
| 181 | </varlistentry>
|
|---|
| 182 |
|
|---|
| 183 | <varlistentry>
|
|---|
| 184 | <term>printnotify</term>
|
|---|
| 185 | <listitem><para>
|
|---|
| 186 | Order smbd to send a printer notify message to any Windows NT clients
|
|---|
| 187 | connected to a printer. This message-type takes the following arguments:
|
|---|
| 188 | </para>
|
|---|
| 189 |
|
|---|
| 190 | <variablelist>
|
|---|
| 191 |
|
|---|
| 192 | <varlistentry>
|
|---|
| 193 | <term>queuepause printername</term>
|
|---|
| 194 | <listitem><para>Send a queue pause change notify
|
|---|
| 195 | message to the printer specified.</para></listitem>
|
|---|
| 196 | </varlistentry>
|
|---|
| 197 |
|
|---|
| 198 | <varlistentry>
|
|---|
| 199 | <term>queueresume printername</term>
|
|---|
| 200 | <listitem><para>Send a queue resume change notify
|
|---|
| 201 | message for the printer specified.</para></listitem>
|
|---|
| 202 | </varlistentry>
|
|---|
| 203 |
|
|---|
| 204 | <varlistentry>
|
|---|
| 205 | <term>jobpause printername unixjobid</term>
|
|---|
| 206 | <listitem><para>Send a job pause change notify
|
|---|
| 207 | message for the printer and unix jobid
|
|---|
| 208 | specified.</para></listitem>
|
|---|
| 209 | </varlistentry>
|
|---|
| 210 |
|
|---|
| 211 | <varlistentry>
|
|---|
| 212 | <term>jobresume printername unixjobid</term>
|
|---|
| 213 | <listitem><para>Send a job resume change notify
|
|---|
| 214 | message for the printer and unix jobid
|
|---|
| 215 | specified.</para></listitem>
|
|---|
| 216 | </varlistentry>
|
|---|
| 217 |
|
|---|
| 218 | <varlistentry>
|
|---|
| 219 | <term>jobdelete printername unixjobid</term>
|
|---|
| 220 | <listitem><para>Send a job delete change notify
|
|---|
| 221 | message for the printer and unix jobid
|
|---|
| 222 | specified.</para></listitem>
|
|---|
| 223 | </varlistentry>
|
|---|
| 224 | </variablelist>
|
|---|
| 225 |
|
|---|
| 226 | <para>
|
|---|
| 227 | Note that this message only sends notification that an
|
|---|
| 228 | event has occurred. It doesn't actually cause the
|
|---|
| 229 | event to happen.
|
|---|
| 230 | </para>
|
|---|
| 231 |
|
|---|
| 232 | <para>This message can only be sent to <constant>smbd</constant>. </para>
|
|---|
| 233 | </listitem>
|
|---|
| 234 | </varlistentry>
|
|---|
| 235 |
|
|---|
| 236 | <varlistentry>
|
|---|
| 237 | <term>dmalloc-mark</term>
|
|---|
| 238 | <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>
|
|---|
| 239 | </varlistentry>
|
|---|
| 240 |
|
|---|
| 241 | <varlistentry>
|
|---|
| 242 | <term>dmalloc-log-changed</term>
|
|---|
| 243 | <listitem><para>
|
|---|
| 244 | Dump the pointers that have changed since the mark set by dmalloc-mark.
|
|---|
| 245 | Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support. </para></listitem>
|
|---|
| 246 | </varlistentry>
|
|---|
| 247 |
|
|---|
| 248 | <varlistentry>
|
|---|
| 249 | <term>shutdown</term>
|
|---|
| 250 | <listitem><para>Shut down specified daemon. Can be sent to both smbd and nmbd.</para></listitem>
|
|---|
| 251 | </varlistentry>
|
|---|
| 252 |
|
|---|
| 253 | <varlistentry>
|
|---|
| 254 | <term>pool-usage</term>
|
|---|
| 255 | <listitem><para>Print a human-readable description of all
|
|---|
| 256 | talloc(pool) memory usage by the specified daemon/process. Available
|
|---|
| 257 | for both smbd and nmbd.</para></listitem>
|
|---|
| 258 | </varlistentry>
|
|---|
| 259 |
|
|---|
| 260 | <varlistentry>
|
|---|
| 261 | <term>drvupgrade</term>
|
|---|
| 262 | <listitem><para>Force clients of printers using specified driver
|
|---|
| 263 | to update their local version of the driver. Can only be
|
|---|
| 264 | sent to smbd.</para></listitem>
|
|---|
| 265 | </varlistentry>
|
|---|
| 266 |
|
|---|
| 267 | <varlistentry>
|
|---|
| 268 | <term>reload-config</term>
|
|---|
| 269 | <listitem><para>Force daemon to reload smb.conf configuration file. Can be sent
|
|---|
| 270 | to <constant>smbd</constant>, <constant>nmbd</constant>, or <constant>winbindd</constant>.
|
|---|
| 271 | </para></listitem>
|
|---|
| 272 | </varlistentry>
|
|---|
| 273 |
|
|---|
| 274 | <varlistentry>
|
|---|
| 275 | <term>reload-printers</term>
|
|---|
| 276 | <listitem><para>Force smbd to reload printers. Can only be sent to
|
|---|
| 277 | <constant>smbd</constant>.
|
|---|
| 278 | </para></listitem>
|
|---|
| 279 | </varlistentry>
|
|---|
| 280 |
|
|---|
| 281 | <varlistentry>
|
|---|
| 282 | <term>idmap</term>
|
|---|
| 283 | <listitem><para>Notify about changes of id mapping. Can be sent
|
|---|
| 284 | to <constant>smbd</constant> or (not implemented yet) <constant>winbindd</constant>.
|
|---|
| 285 | </para></listitem>
|
|---|
| 286 |
|
|---|
| 287 | <variablelist>
|
|---|
| 288 | <varlistentry>
|
|---|
| 289 | <term>flush [uid|gid]</term>
|
|---|
| 290 | <listitem><para>Flush caches for sid <-> gid and/or sid <-> uid mapping.
|
|---|
| 291 | </para></listitem>
|
|---|
| 292 | </varlistentry>
|
|---|
| 293 | <varlistentry>
|
|---|
| 294 | <term>delete <ID></term>
|
|---|
| 295 | <listitem><para>Remove a mapping from cache. The mapping is given by <ID>
|
|---|
| 296 | which may either be a sid: S-x-..., a gid: "GID number" or a uid: "UID number".
|
|---|
| 297 | </para></listitem>
|
|---|
| 298 | </varlistentry>
|
|---|
| 299 | <varlistentry>
|
|---|
| 300 | <term>kill <ID></term>
|
|---|
| 301 | <listitem><para>Remove a mapping from cache. Terminate <constant>smbd</constant> if
|
|---|
| 302 | the id is currently in use.</para></listitem>
|
|---|
| 303 | </varlistentry>
|
|---|
| 304 | </variablelist>
|
|---|
| 305 | </varlistentry>
|
|---|
| 306 |
|
|---|
| 307 | <varlistentry>
|
|---|
| 308 | <term>num-children</term>
|
|---|
| 309 | <listitem><para>Query the number of smbd child processes. This
|
|---|
| 310 | message can only be sent
|
|---|
| 311 | to <constant>smbd</constant>.</para></listitem>
|
|---|
| 312 | </varlistentry>
|
|---|
| 313 |
|
|---|
| 314 | </variablelist>
|
|---|
| 315 | </refsect1>
|
|---|
| 316 |
|
|---|
| 317 | <refsect1>
|
|---|
| 318 | <title>VERSION</title>
|
|---|
| 319 |
|
|---|
| 320 | <para>This man page is correct for version 3 of
|
|---|
| 321 | the Samba suite.</para>
|
|---|
| 322 | </refsect1>
|
|---|
| 323 |
|
|---|
| 324 | <refsect1>
|
|---|
| 325 | <title>SEE ALSO</title>
|
|---|
| 326 | <para><citerefentry><refentrytitle>nmbd</refentrytitle>
|
|---|
| 327 | <manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>smbd</refentrytitle>
|
|---|
| 328 | <manvolnum>8</manvolnum></citerefentry>.</para>
|
|---|
| 329 | </refsect1>
|
|---|
| 330 |
|
|---|
| 331 | <refsect1>
|
|---|
| 332 | <title>AUTHOR</title>
|
|---|
| 333 |
|
|---|
| 334 | <para>The original Samba software and related utilities
|
|---|
| 335 | were created by Andrew Tridgell. Samba is now developed
|
|---|
| 336 | by the Samba Team as an Open Source project similar
|
|---|
| 337 | to the way the Linux kernel is developed.</para>
|
|---|
| 338 |
|
|---|
| 339 | <para>The original Samba man pages were written by Karl Auer.
|
|---|
| 340 | The man page sources were converted to YODL format (another
|
|---|
| 341 | excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
|
|---|
| 342 | ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
|
|---|
| 343 | release by Jeremy Allison. The conversion to DocBook for
|
|---|
| 344 | Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for
|
|---|
| 345 | Samba 3.0 was done by Alexander Bokovoy.</para>
|
|---|
| 346 | </refsect1>
|
|---|
| 347 |
|
|---|
| 348 | </refentry>
|
|---|
