1SMBCONTROL(1) User Commands SMBCONTROL(1)
2
6 smbcontrol - send messages to smbd, nmbd or winbindd processes
7
9 smbcontrol [-?|--help] [--usage] [-t|--timeout]
10 [-d|--debuglevel=DEBUGLEVEL] [--debug-stdout]
11 [--configfile=CONFIGFILE] [--option=name=value]
12 [-l|--log-basename=LOGFILEBASE] [--leak-report] [--leak-report-full]
13 smbcontrol [destination] [message-type] [parameter]
15
17 This tool is part of the samba(7) suite.
18 smbcontrol is a very small program, which sends messages to a smbd(8),
20 a nmbd(8), or a winbindd(8) daemon running on the system.
21
23 -t|--timeout
24 Set timeout to seconds.
25 destination
27 One of nmbd, smbd, winbindd or a process ID.
28 The all destination causes the message to "broadcast" to all
30 running daemons including nmbd and winbind. This is a change for
31 Samba 3.3, prior to this the parameter smbd used to do this.
32 The smbd destination causes the message to be sent to the smbd
34 daemon specified in the smbd.pid file.
35 The nmbd destination causes the message to be sent to the nmbd
37 daemon specified in the nmbd.pid file.
38 The winbindd destination causes the message to be sent to the
40 winbind daemon specified in the winbindd.pid file.
41 If a single process ID is given, the message is sent to only that
43 process.
44 message-type
46 Type of message to send. See the section MESSAGE-TYPES for details.
47 parameters
49 any parameters required for the message-type
50 -?|--help
52 Print a summary of command line options.
53 --usage
55 Display brief usage message.
56 -d|--debuglevel=DEBUGLEVEL
58 level is an integer from 0 to 10. The default value if this
59 parameter is not specified is 1 for client applications.
60 The higher this value, the more detail will be logged to the log
62 files about the activities of the server. At level 0, only critical
63 errors and serious warnings will be logged. Level 1 is a reasonable
64 level for day-to-day running - it generates a small amount of
65 information about operations carried out.
66 Levels above 1 will generate considerable amounts of log data, and
68 should only be used when investigating a problem. Levels above 3
69 are designed for use only by developers and generate HUGE amounts
70 of log data, most of which is extremely cryptic.
71 Note that specifying this parameter here will override the log
73 level parameter in the /etc/samba/smb.conf file.
74 --debug-stdout
76 This will redirect debug output to STDOUT. By default all clients
77 are logging to STDERR.
78 --configfile=<configuration file>
80 The file specified contains the configuration details required by
81 the client. The information in this file can be general for client
82 and server or only provide client specific like options such as
83 client smb encrypt. See /etc/samba/smb.conf for more information.
84 The default configuration file name is determined at compile time.
85 --option=<name>=<value>
87 Set the smb.conf(5) option "<name>" to value "<value>" from the
88 command line. This overrides compiled-in defaults and options read
89 from the configuration file. If a name or a value includes a space,
90 wrap whole --option=name=value into quotes.
91 -l|--log-basename=logdirectory
93 Base directory name for log/debug files. The extension ".progname"
94 will be appended (e.g. log.smbclient, log.smbd, etc...). The log
95 file is never removed by the client.
96 --leak-report
98 Enable talloc leak reporting on exit.
99 --leak-report-full
101 Enable full talloc leak reporting on exit.
102 -V|--version
104 Prints the program version number.
105
107 Available message types are:
108 close-share
110 Order smbd to close the client connections to the named share. Note
111 that this doesn't affect client connections to any other shares.
112 This message-type takes an argument of the share name for which
113 client connections will be closed, or the "*" character which will
114 close all currently open shares. This may be useful if you made
115 changes to the access controls on the share. This message can only
116 be sent to smbd.
117 close-denied-share
119 Behave like close-share, but don't disconnect users that are still
120 allowed to access the share. It can safely be sent to all smbds
121 after changing share access controls. It will only affect users who
122 have been denied access since having connected initially. This
123 message can only be sent to smbd.
124 debug
126 Set debug level to the value specified by the parameter. This can
127 be sent to any of the destinations. If this message is sent to
128 either the smbd or winbindd daemons, the parent process will
129 rebroadcast the message to all child processes changing the debug
130 level in each one.
131 kill-client-ip
133 Order smbd to close the client connections from a given IP address.
134 This message-type takes an argument of the IP address from which
135 client connections will be closed. This message can only be sent to
136 smbd.
137 force-election
139 This message causes the nmbd daemon to force a new browse master
140 election.
141 ping
143 Send specified number of "ping" messages and wait for the same
144 number of reply "pong" messages. This can be sent to any of the
145 destinations.
146 profile
148 Change profile settings of a daemon, based on the parameter. The
149 parameter can be "on" to turn on profile stats collection, "off" to
150 turn off profile stats collection, "count" to enable only
151 collection of count stats (time stats are disabled), and "flush" to
152 zero the current profile stats. This can be sent to any smbd or
153 nmbd destinations.
154 debuglevel
156 Request debuglevel of a certain daemon and write it to stdout. This
157 can be sent to any of the destinations.
158 profilelevel
160 Request profilelevel of a certain daemon and write it to stdout.
161 This can be sent to any smbd or nmbd destinations.
162 printnotify
164 Order smbd to send a printer notify message to any Windows NT
165 clients connected to a printer. This message-type takes the
166 following arguments:
167 queuepause printername
169 Send a queue pause change notify message to the printer
170 specified.
171 queueresume printername
173 Send a queue resume change notify message for the printer
174 specified.
175 jobpause printername unixjobid
177 Send a job pause change notify message for the printer and unix
178 jobid specified.
179 jobresume printername unixjobid
181 Send a job resume change notify message for the printer and
182 unix jobid specified.
183 jobdelete printername unixjobid
185 Send a job delete change notify message for the printer and
186 unix jobid specified.
187 Note that this message only sends notification that an event has
189 occurred. It doesn't actually cause the event to happen.
190 This message can only be sent to smbd.
192 dmalloc-mark
194 Set a mark for dmalloc. Can be sent to both smbd and nmbd. Only
195 available if samba is built with dmalloc support.
196 dmalloc-log-changed
198 Dump the pointers that have changed since the mark set by
199 dmalloc-mark. Can be sent to both smbd and nmbd. Only available if
200 samba is built with dmalloc support.
201 shutdown
203 Shut down specified daemon. Can be sent to both smbd and nmbd.
204 pool-usage
206 Print a human-readable description of all talloc(pool) memory usage
207 by the specified daemon/process. Available for both smbd and nmbd.
208 ringbuf-log
210 Fetch and print the ringbuf log. Requires logging = ringbuf.
211 Available for smbd, winbindd and nmbd.
212 drvupgrade
214 Force clients of printers using specified driver to update their
215 local version of the driver. Can only be sent to smbd.
216 reload-config
218 Force daemon to reload smb.conf configuration file. Can be sent to
219 smbd, nmbd, or winbindd.
220 reload-printers
222 Force smbd to reload printers. Can only be sent to smbd.
223 idmap
225 Notify about changes of id mapping. Can be sent to smbd or (not
226 implemented yet) winbindd.
227 flush [uid|gid]
229 Flush caches for sid <-> gid and/or sid <-> uid mapping.
230 delete <ID>
232 Remove a mapping from cache. The mapping is given by <ID> which
233 may either be a sid: S-x-..., a gid: "GID number" or a uid:
234 "UID number".
235 kill <ID>
237 Remove a mapping from cache. Terminate smbd if the id is
238 currently in use.
239 num-children
241 Query the number of smbd child processes. This message can only be
242 sent to smbd.
243
245 This man page is part of version 4.17.5 of the Samba suite.
246
248 nmbd(8) and smbd(8).
249
251 The original Samba software and related utilities were created by
252 Andrew Tridgell. Samba is now developed by the Samba Team as an Open
253 Source project similar to the way the Linux kernel is developed.
254Samba 4.17.5 01/26/2023 SMBCONTROL(1)