1SMBCONTROL(1) User Commands SMBCONTROL(1)
2
6 smbcontrol - send messages to smbd, nmbd or winbindd processes
7
9 smbcontrol [-s] [-t|--timeout]
10 smbcontrol [destination] [message-type] [parameter]
12
14 This tool is part of the samba(7) suite.
15 smbcontrol is a very small program, which sends messages to a smbd(8),
17 a nmbd(8), or a winbindd(8) daemon running on the system.
18
20 -?|--help
21 Print a summary of command line options.
22 --usage
24 Display brief usage message.
25 -s|--configfile=<configuration file>
27 The file specified contains the configuration details required by
28 the server. The information in this file includes server-specific
29 information such as what printcap file to use, as well as
30 descriptions of all the services that the server is to provide. See
31 smb.conf for more information. The default configuration file name
32 is determined at compile time.
33 -d|--debuglevel=level
35 level is an integer from 0 to 10. The default value if this
36 parameter is not specified is 1.
37 The higher this value, the more detail will be logged to the log
39 files about the activities of the server. At level 0, only critical
40 errors and serious warnings will be logged. Level 1 is a reasonable
41 level for day-to-day running - it generates a small amount of
42 information about operations carried out.
43 Levels above 1 will generate considerable amounts of log data, and
45 should only be used when investigating a problem. Levels above 3
46 are designed for use only by developers and generate HUGE amounts
47 of log data, most of which is extremely cryptic.
48 Note that specifying this parameter here will override the log
50 level parameter in the smb.conf file.
51 -V|--version
53 Prints the program version number.
54 -s|--configfile=<configuration file>
56 The file specified contains the configuration details required by
57 the server. The information in this file includes server-specific
58 information such as what printcap file to use, as well as
59 descriptions of all the services that the server is to provide. See
60 smb.conf for more information. The default configuration file name
61 is determined at compile time.
62 -l|--log-basename=logdirectory
64 Base directory name for log/debug files. The extension ".progname"
65 will be appended (e.g. log.smbclient, log.smbd, etc...). The log
66 file is never removed by the client.
67 --option=<name>=<value>
69 Set the smb.conf(5) option "<name>" to value "<value>" from the
70 command line. This overrides compiled-in defaults and options read
71 from the configuration file.
72 -t|--timeout
74 Set timeout to seconds.
75 destination
77 One of nmbd, smbd, winbindd or a process ID.
78 The all destination causes the message to "broadcast" to all
80 running daemons including nmbd and winbind. This is a change for
81 Samba 3.3, prior to this the parameter smbd used to do this.
82 The smbd destination causes the message to be sent to the smbd
84 daemon specified in the smbd.pid file.
85 The nmbd destination causes the message to be sent to the nmbd
87 daemon specified in the nmbd.pid file.
88 The winbindd destination causes the message to be sent to the
90 winbind daemon specified in the winbindd.pid file.
91 If a single process ID is given, the message is sent to only that
93 process.
94 message-type
96 Type of message to send. See the section MESSAGE-TYPES for details.
97 parameters
99 any parameters required for the message-type
100
102 Available message types are:
103 close-share
105 Order smbd to close the client connections to the named share. Note
106 that this doesn´t affect client connections to any other shares.
107 This message-type takes an argument of the share name for which
108 client connections will be closed, or the "*" character which will
109 close all currently open shares. This may be useful if you made
110 changes to the access controls on the share. This message can only
111 be sent to smbd.
112 debug
114 Set debug level to the value specified by the parameter. This can
115 be sent to any of the destinations. If this message is sent to
116 either the smbd or winbindd daemons, the parent process will
117 rebroadcast the message to all child processes changing the debug
118 level in each one.
119 kill-client-ip
121 Order smbd to close the client connections from a given IP address.
122 This message-type takes an argument of the IP address from which
123 client connections will be closed. This message can only be sent to
124 smbd.
125 force-election
127 This message causes the nmbd daemon to force a new browse master
128 election.
129 ping
131 Send specified number of "ping" messages and wait for the same
132 number of reply "pong" messages. This can be sent to any of the
133 destinations.
134 profile
136 Change profile settings of a daemon, based on the parameter. The
137 parameter can be "on" to turn on profile stats collection, "off" to
138 turn off profile stats collection, "count" to enable only
139 collection of count stats (time stats are disabled), and "flush" to
140 zero the current profile stats. This can be sent to any smbd or
141 nmbd destinations.
142 debuglevel
144 Request debuglevel of a certain daemon and write it to stdout. This
145 can be sent to any of the destinations.
146 profilelevel
148 Request profilelevel of a certain daemon and write it to stdout.
149 This can be sent to any smbd or nmbd destinations.
150 printnotify
152 Order smbd to send a printer notify message to any Windows NT
153 clients connected to a printer. This message-type takes the
154 following arguments:
155 queuepause printername
157 Send a queue pause change notify message to the printer
158 specified.
159 queueresume printername
161 Send a queue resume change notify message for the printer
162 specified.
163 jobpause printername unixjobid
165 Send a job pause change notify message for the printer and unix
166 jobid specified.
167 jobresume printername unixjobid
169 Send a job resume change notify message for the printer and
170 unix jobid specified.
171 jobdelete printername unixjobid
173 Send a job delete change notify message for the printer and
174 unix jobid specified.
175 Note that this message only sends notification that an event has
177 occurred. It doesn´t actually cause the event to happen.
178 This message can only be sent to smbd.
180 dmalloc-mark
182 Set a mark for dmalloc. Can be sent to both smbd and nmbd. Only
183 available if samba is built with dmalloc support.
184 dmalloc-log-changed
186 Dump the pointers that have changed since the mark set by
187 dmalloc-mark. Can be sent to both smbd and nmbd. Only available if
188 samba is built with dmalloc support.
189 shutdown
191 Shut down specified daemon. Can be sent to both smbd and nmbd.
192 pool-usage
194 Print a human-readable description of all talloc(pool) memory usage
195 by the specified daemon/process. Available for both smbd and nmbd.
196 drvupgrade
198 Force clients of printers using specified driver to update their
199 local version of the driver. Can only be sent to smbd.
200 reload-config
202 Force daemon to reload smb.conf configuration file. Can be sent to
203 smbd, nmbd, or winbindd.
204 reload-printers
206 Force smbd to reload printers. Can only be sent to smbd.
207 idmap
209 Notify about changes of id mapping. Can be sent to smbd or (not
210 implemented yet) winbindd.
211 flush [uid|gid]
213 Flush caches for sid <-> gid and/or sid <-> uid mapping.
214 delete <ID>
216 Remove a mapping from cache. The mapping is given by <ID> which
217 may either be a sid: S-x-..., a gid: "GID number" or a uid:
218 "UID number".
219 kill <ID>
221 Remove a mapping from cache. Terminate smbd if the id is
222 currently in use.
223 num-children
225 Query the number of smbd child processes. This message can only be
226 sent to smbd.
227
229 This man page is correct for version 3 of the Samba suite.
230
232 nmbd(8) and smbd(8).
233
235 The original Samba software and related utilities were created by
236 Andrew Tridgell. Samba is now developed by the Samba Team as an Open
237 Source project similar to the way the Linux kernel is developed.
238 The original Samba man pages were written by Karl Auer. The man page
240 sources were converted to YODL format (another excellent piece of Open
241 Source software, available at ftp://ftp.icce.rug.nl/pub/unix/) and
242 updated for the Samba 2.0 release by Jeremy Allison. The conversion to
243 DocBook for Samba 2.2 was done by Gerald Carter. The conversion to
244 DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.
245Samba 4.2 06/19/2018 SMBCONTROL(1)