docs/htmldocs/smbcontrol.1.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <HTML
   3 ><HEAD
   4 ><TITLE
   5 >smbcontrol</TITLE
   6 ><META
   7 NAME="GENERATOR"
   8 CONTENT="Modular DocBook HTML Stylesheet Version 1.77"></HEAD
   9 ><BODY
  10 CLASS="REFENTRY"
  11 BGCOLOR="#FFFFFF"
  12 TEXT="#000000"
  13 LINK="#0000FF"
  14 VLINK="#840084"
  15 ALINK="#0000FF"
  16 ><H1
  17 ><A
  18 NAME="SMBCONTROL"
  19 ></A
  20 >smbcontrol</H1
  21 ><DIV
  22 CLASS="REFNAMEDIV"
  23 ><A
  24 NAME="AEN5"
  25 ></A
  26 ><H2
  27 >Name</H2
  28 >smbcontrol&nbsp;--&nbsp;send messages to smbd, nmbd or winbindd processes</DIV
  29 ><DIV
  30 CLASS="REFSYNOPSISDIV"
  31 ><A
  32 NAME="AEN8"
  33 ></A
  34 ><H2
  35 >Synopsis</H2
  36 ><P
  37 ><B
  38 CLASS="COMMAND"
  39 >smbcontrol</B
  40 >  [-i]</P
  41 ><P
  42 ><B
  43 CLASS="COMMAND"
  44 >smbcontrol</B
  45 >  [destination] [message-type] [parameter]</P
  46 ></DIV
  47 ><DIV
  48 CLASS="REFSECT1"
  49 ><A
  50 NAME="AEN17"
  51 ></A
  52 ><H2
  53 >DESCRIPTION</H2
  54 ><P
  55 >This tool is part of the <A
  56 HREF="samba.7.html"
  57 TARGET="_top"
  58 >       Samba</A
  59 > suite.</P
  60 ><P
  61 ><B
  62 CLASS="COMMAND"
  63 >smbcontrol</B
  64 > is a very small program, which
  65         sends messages to an <A
  66 HREF="smbd.8.html"
  67 TARGET="_top"
  68 >smbd(8)</A
  69 >,
  70         an <A
  71 HREF="nmbd.8.html"
  72 TARGET="_top"
  73 >nmbd(8)</A
  74 >
  75         or a <A
  76 HREF="winbindd.8.html"
  77 TARGET="_top"
  78 >winbindd(8)</A
  79 >
  80         daemon running on the system.</P
  81 ></DIV
  82 ><DIV
  83 CLASS="REFSECT1"
  84 ><A
  85 NAME="AEN26"
  86 ></A
  87 ><H2
  88 >OPTIONS</H2
  89 ><P
  90 ></P
  91 ><DIV
  92 CLASS="VARIABLELIST"
  93 ><DL
  94 ><DT
  95 >-i</DT
  96 ><DD
  97 ><P
  98 >Run interactively. Individual commands
  99                 of the form destination message-type parameters can be entered
 100                 on STDIN. An empty command line or a "q" will quit the
 101                 program.</P
 102 ></DD
 103 ><DT
 104 >destination</DT
 105 ><DD
 106 ><P
 107 >One of <TT
 108 CLASS="PARAMETER"
 109 ><I
 110 >nmbd</I
 111 ></TT
 112 >
 113                 <TT
 114 CLASS="PARAMETER"
 115 ><I
 116 >smbd</I
 117 ></TT
 118 > or a process ID.</P
 119 ><P
 120 >The <TT
 121 CLASS="PARAMETER"
 122 ><I
 123 >smbd</I
 124 ></TT
 125 > destination causes the
 126                 message to "broadcast" to all smbd daemons.</P
 127 ><P
 128 >The <TT
 129 CLASS="PARAMETER"
 130 ><I
 131 >nmbd</I
 132 ></TT
 133 > destination causes the
 134                 message to be sent to the nmbd daemon specified in the
 135                 <TT
 136 CLASS="FILENAME"
 137 >nmbd.pid</TT
 138 > file.</P
 139 ><P
 140 >If a single process ID is given, the message is sent
 141                 to only that process.</P
 142 ></DD
 143 ><DT
 144 >message-type</DT
 145 ><DD
 146 ><P
 147 >One of: <TT
 148 CLASS="CONSTANT"
 149 >close-share</TT
 150 >,
 151                 <TT
 152 CLASS="CONSTANT"
 153 >debug</TT
 154 >,
 155                 <TT
 156 CLASS="CONSTANT"
 157 >force-election</TT
 158 >, <TT
 159 CLASS="CONSTANT"
 160 >ping
 161                 </TT
 162 >, <TT
 163 CLASS="CONSTANT"
 164 >profile</TT
 165 >, <TT
 166 CLASS="CONSTANT"
 167 >               debuglevel</TT
 168 >, <TT
 169 CLASS="CONSTANT"
 170 >profilelevel</TT
 171 >,
 172                 or <TT
 173 CLASS="CONSTANT"
 174 >printnotify</TT
 175 >.</P
 176 ><P
 177 >The <TT
 178 CLASS="CONSTANT"
 179 >close-share</TT
 180 > message-type sends a
 181                 message to smbd which will then close the client connections to
 182                 the named share. Note that this doesn't affect client connections
 183                 to any other shares. This message-type takes an argument of the
 184                 share name for which client connections will be closed, or the
 185                 "*" character which will close all currently open shares.
 186                 This may be useful if you made changes to the access controls on the share.
 187                 This message can only be sent to <TT
 188 CLASS="CONSTANT"
 189 >smbd</TT
 190 >.</P
 191 ><P
 192 >The <TT
 193 CLASS="CONSTANT"
 194 >debug</TT
 195 > message-type allows
 196                 the debug level to be set to the value specified by the
 197                 parameter. This can be sent to any of the destinations.</P
 198 ><P
 199 >The <TT
 200 CLASS="CONSTANT"
 201 >force-election</TT
 202 > message-type can only be
 203                 sent to the <TT
 204 CLASS="CONSTANT"
 205 >nmbd</TT
 206 > destination. This message
 207                 causes the <B
 208 CLASS="COMMAND"
 209 >nmbd</B
 210 > daemon to force a new browse
 211                 master election.</P
 212 ><P
 213 >The <TT
 214 CLASS="CONSTANT"
 215 >ping</TT
 216 > message-type sends the
 217                 number of "ping" messages specified by the parameter and waits
 218                 for the same number of  reply "pong" messages. This can be sent to
 219                 any of the destinations.</P
 220 ><P
 221 >The <TT
 222 CLASS="CONSTANT"
 223 >profile</TT
 224 > message-type sends a
 225                 message to an smbd to change the profile settings based on the
 226                 parameter. The parameter can be "on" to turn on profile stats
 227                 collection, "off" to turn off profile stats collection, "count"
 228                 to enable only collection of count stats (time stats are
 229                 disabled), and "flush" to zero the current profile stats. This can
 230                 be sent to any smbd or nmbd destinations.</P
 231 ><P
 232 >The <TT
 233 CLASS="CONSTANT"
 234 >debuglevel</TT
 235 > message-type sends
 236                 a "request debug level" message. The current debug level setting
 237                 is returned by a  "debuglevel" message. This can be
 238                 sent to any of the destinations.</P
 239 ><P
 240 >The <TT
 241 CLASS="CONSTANT"
 242 >profilelevel</TT
 243 > message-type sends
 244                 a "request profile level" message.  The current profile level
 245                 setting is returned by a  "profilelevel" message. This can be sent
 246                 to any smbd or nmbd destinations.</P
 247 ><P
 248 >The <TT
 249 CLASS="CONSTANT"
 250 >printnotify</TT
 251 > message-type sends a
 252                 message to smbd which in turn sends a printer notify message to
 253                 any Windows NT clients connected to a printer. This message-type
 254                 takes the following arguments:
 255
 256                 <P
 257 ></P
 258 ><DIV
 259 CLASS="VARIABLELIST"
 260 ><DL
 261 ><DT
 262 >queuepause printername</DT
 263 ><DD
 264 ><P
 265 >Send a queue pause change notify
 266                     message to the printer specified.</P
 267 ></DD
 268 ><DT
 269 >queueresume printername</DT
 270 ><DD
 271 ><P
 272 >Send a queue resume change notify
 273                     message for the printer specified.</P
 274 ></DD
 275 ><DT
 276 >jobpause printername unixjobid</DT
 277 ><DD
 278 ><P
 279 >Send a job pause change notify
 280                     message for the printer and unix jobid
 281                     specified.</P
 282 ></DD
 283 ><DT
 284 >jobresume printername unixjobid</DT
 285 ><DD
 286 ><P
 287 >Send a job resume change notify
 288                     message for the printer and unix jobid
 289                     specified.</P
 290 ></DD
 291 ><DT
 292 >jobdelete printername unixjobid</DT
 293 ><DD
 294 ><P
 295 >Send a job delete change notify
 296                     message for the printer and unix jobid
 297                     specified.</P
 298 ></DD
 299 ></DL
 300 ></DIV
 301 >
 302
 303                 Note that this message only sends notification that an
 304                 event has occured.  It doesn't actually cause the
 305                 event to happen.
 306
 307                 This message can only be sent to <TT
 308 CLASS="CONSTANT"
 309 >smbd</TT
 310 >.
 311                 </P
 312 ></DD
 313 ><DT
 314 >parameters</DT
 315 ><DD
 316 ><P
 317 >any parameters required for the message-type</P
 318 ></DD
 319 ></DL
 320 ></DIV
 321 ></DIV
 322 ><DIV
 323 CLASS="REFSECT1"
 324 ><A
 325 NAME="AEN102"
 326 ></A
 327 ><H2
 328 >VERSION</H2
 329 ><P
 330 >This man page is correct for version 2.2 of
 331         the Samba suite.</P
 332 ></DIV
 333 ><DIV
 334 CLASS="REFSECT1"
 335 ><A
 336 NAME="AEN105"
 337 ></A
 338 ><H2
 339 >SEE ALSO</H2
 340 ><P
 341 ><A
 342 HREF="nmbd.8.html"
 343 TARGET="_top"
 344 ><B
 345 CLASS="COMMAND"
 346 >nmbd(8)</B
 347 ></A
 348 >,
 349         and <A
 350 HREF="smbd.8.html"
 351 TARGET="_top"
 352 ><B
 353 CLASS="COMMAND"
 354 >smbd(8)</B
 355 ></A
 356 >.
 357         </P
 358 ></DIV
 359 ><DIV
 360 CLASS="REFSECT1"
 361 ><A
 362 NAME="AEN112"
 363 ></A
 364 ><H2
 365 >AUTHOR</H2
 366 ><P
 367 >The original Samba software and related utilities
 368         were created by Andrew Tridgell. Samba is now developed
 369         by the Samba Team as an Open Source project similar
 370         to the way the Linux kernel is developed.</P
 371 ><P
 372 >The original Samba man pages were written by Karl Auer.
 373         The man page sources were converted to YODL format (another
 374         excellent piece of Open Source software, available at
 375         <A
 376 HREF="ftp://ftp.icce.rug.nl/pub/unix/"
 377 TARGET="_top"
 378 >       ftp://ftp.icce.rug.nl/pub/unix/</A
 379 >) and updated for the Samba 2.0
 380         release by Jeremy Allison.  The conversion to DocBook for
 381         Samba 2.2 was done by Gerald Carter</P
 382 ></DIV
 383 ></BODY
 384 ></HTML
 385 >