Debian Codegraph @

upstream/debian-unstable/man1/smbcontrol.1

raw
1 '\" t
2 .\" Title: smbcontrol
3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 05/26/2026
6 .\" Manual: User Commands
7 .\" Source: Samba 4.24.3-Debian-4.24.3+dfsg-1
8 .\" Language: English
9 .\"
10 .TH "SMBCONTROL" "1" "05/26/2026" "Samba 4\&.24\&.3\-Debian\-4\&.24\&.3+dfs" "User Commands"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 smbcontrol \- send messages to smbd, nmbd or winbindd processes
32 .SH "SYNOPSIS"
33 .HP \w'\ 'u
34 smbcontrol [\-?|\-\-help] [\-\-usage] [\-t|\-\-timeout] [\-d|\-\-debuglevel=DEBUGLEVEL] [\-\-debug\-stdout] [\-\-configfile=CONFIGFILE] [\-\-option=name=value] [\-l|\-\-log\-basename=LOGFILEBASE] [\-\-leak\-report] [\-\-leak\-report\-full]
35 .HP \w'\ 'u
36 smbcontrol [destination] [message\-type] [parameter]
37 .SH "DESCRIPTION"
38 .PP
39 This tool is part of the
40 \fBsamba\fR(7)
41 suite\&.
42 .PP
43 smbcontrol
44 is a very small program, which sends messages to a
45 \fBsmbd\fR(8), a
46 \fBnmbd\fR(8), or a
47 \fBwinbindd\fR(8)
48 daemon running on the system\&.
49 .SH "OPTIONS"
50 .PP
51 \-t|\-\-timeout
52 .RS 4
53 Set timeout to seconds\&.
54 .RE
55 .PP
56 destination
57 .RS 4
58 One of
59 \fInmbd\fR,
60 \fIsmbd\fR,
61 \fIwinbindd\fR
62 or a process ID\&.
63 .sp
64 The
65 \fIall\fR
66 destination causes the message to "broadcast" to all running daemons including nmbd and winbind\&. This is a change for Samba 3\&.3, prior to this the parameter smbd used to do this\&.
67 .sp
68 The
69 \fIsmbd\fR
70 destination causes the message to be sent to the smbd daemon specified in the
71 smbd\&.pid
72 file\&.
73 .sp
74 The
75 \fInmbd\fR
76 destination causes the message to be sent to the nmbd daemon specified in the
77 nmbd\&.pid
78 file\&.
79 .sp
80 The
81 \fIwinbindd\fR
82 destination causes the message to be sent to the winbind daemon specified in the
83 winbindd\&.pid
84 file\&.
85 .sp
86 If a single process ID is given, the message is sent to only that process\&.
87 .RE
88 .PP
89 message\-type
90 .RS 4
91 Type of message to send\&. See the section
92 \fBMESSAGE\-TYPES\fR
93 for details\&.
94 .RE
95 .PP
96 parameters
97 .RS 4
98 any parameters required for the message\-type
99 .RE
100 .PP
101 \-?|\-\-help
102 .RS 4
103 Print a summary of command line options\&.
104 .RE
105 .PP
106 \-\-usage
107 .RS 4
108 Display brief usage message\&.
109 .RE
110 .PP
111 \-d|\-\-debuglevel=level
112 .RS 4
113 \fIlevel\fR
114 is an integer from 0 to 10\&. The default value if this parameter is not specified is 1 for client applications\&.
115 .sp
116 The higher this value, the more detail will be logged to the log files about the activities of the server\&. At level 0, only critical errors and serious warnings will be logged\&. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\&.
117 .sp
118 Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\&. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\&.
119 .sp
120 Note that specifying this parameter here will override the
121 \m[blue]\fBlog level\fR\m[]
122 parameter in the
123 /etc/samba/smb\&.conf
124 file\&.
125 .RE
126 .PP
127 \-\-debug\-stdout
128 .RS 4
129 This will redirect debug output to STDOUT\&. By default all clients are logging to STDERR\&.
130 .RE
131 .PP
132 \-\-configfile=<configuration file>
133 .RS 4
134 The file specified contains the configuration details required by the client\&. The information in this file can be general for client and server or only provide client specific like options such as
135 \m[blue]\fBclient smb encrypt\fR\m[]\&. See
136 /etc/samba/smb\&.conf
137 for more information\&. The default configuration file name is determined at compile time\&.
138 .RE
139 .PP
140 \-\-option=<name>=<value>
141 .RS 4
142 Set the
143 \fBsmb.conf\fR(5)
144 option "<name>" to value "<value>" from the command line\&. This overrides compiled\-in defaults and options read from the configuration file\&. If a name or a value includes a space, wrap whole \-\-option=name=value into quotes\&.
145 .RE
146 .PP
147 \-l|\-\-log\-basename=logdirectory
148 .RS 4
149 Base directory name for log/debug files\&. The extension
150 \fB"\&.progname"\fR
151 will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
152 .RE
153 .PP
154 \-\-leak\-report
155 .RS 4
156 Enable talloc leak reporting on exit\&.
157 .RE
158 .PP
159 \-\-leak\-report\-full
160 .RS 4
161 Enable full talloc leak reporting on exit\&.
162 .RE
163 .PP
164 \-V|\-\-version
165 .RS 4
166 Prints the program version number\&.
167 .RE
168 .SH "MESSAGE\-TYPES"
169 .PP
170 Available message types are:
171 .PP
172 close\-share
173 .RS 4
174 Order smbd to close the client connections to the named share\&. Note that this doesn\*(Aqt affect client connections to any other shares\&. This message\-type takes an argument of the share name for which client connections will be closed, or the "*" character which will close all currently open shares\&. This may be useful if you made changes to the access controls on the share\&. This message can only be sent to
175 \fBsmbd\fR\&.
176 .RE
177 .PP
178 close\-denied\-share
179 .RS 4
180 Behave like
181 \fBclose\-share\fR, but don\*(Aqt disconnect users that are still allowed to access the share\&. It can safely be sent to all smbds after changing share access controls\&. It will only affect users who have been denied access since having connected initially\&. This message can only be sent to
182 \fBsmbd\fR\&.
183 .RE
184 .PP
185 debug
186 .RS 4
187 Set debug level to the value specified by the parameter\&. This can be sent to any of the destinations\&. If this message is sent to either the smbd or winbindd daemons, the parent process will rebroadcast the message to all child processes changing the debug level in each one\&.
188 .RE
189 .PP
190 kill\-client\-ip
191 .RS 4
192 Order smbd to close the client connections from a given IP address\&. This message\-type takes an argument of the IP address from which client connections will be closed\&. This message can only be sent to
193 \fBsmbd\fR\&.
194 .RE
195 .PP
196 force\-election
197 .RS 4
198 This message causes the
199 nmbd
200 daemon to force a new browse master election\&.
201 .RE
202 .PP
203 ping
204 .RS 4
205 Send specified number of "ping" messages and wait for the same number of reply "pong" messages\&. This can be sent to any of the destinations\&.
206 .RE
207 .PP
208 profile
209 .RS 4
210 Change profile settings of a daemon, based on the parameter\&. The parameter can be "on" to turn on profile stats collection, "off" to turn off profile stats collection, "count" to enable only collection of count stats (time stats are disabled), and "flush" to zero the current profile stats\&. This can be sent to any smbd or nmbd destinations\&.
211 .RE
212 .PP
213 debuglevel
214 .RS 4
215 Request debuglevel of a certain daemon and write it to stdout\&. This can be sent to any of the destinations\&.
216 .RE
217 .PP
218 profilelevel
219 .RS 4
220 Request profilelevel of a certain daemon and write it to stdout\&. This can be sent to any smbd or nmbd destinations\&.
221 .RE
222 .PP
223 printnotify
224 .RS 4
225 Order smbd to send a printer notify message to any Windows NT clients connected to a printer\&. This message\-type takes the following arguments:
226 .PP
227 queuepause printername
228 .RS 4
229 Send a queue pause change notify message to the printer specified\&.
230 .RE
231 .PP
232 queueresume printername
233 .RS 4
234 Send a queue resume change notify message for the printer specified\&.
235 .RE
236 .PP
237 jobpause printername unixjobid
238 .RS 4
239 Send a job pause change notify message for the printer and unix jobid specified\&.
240 .RE
241 .PP
242 jobresume printername unixjobid
243 .RS 4
244 Send a job resume change notify message for the printer and unix jobid specified\&.
245 .RE
246 .PP
247 jobdelete printername unixjobid
248 .RS 4
249 Send a job delete change notify message for the printer and unix jobid specified\&.
250 .RE
251 .sp
252 Note that this message only sends notification that an event has occurred\&. It doesn\*(Aqt actually cause the event to happen\&.
253 .sp
254 This message can only be sent to
255 \fBsmbd\fR\&.
256 .RE
257 .PP
258 dmalloc\-mark
259 .RS 4
260 Set a mark for dmalloc\&. Can be sent to both smbd and nmbd\&. Only available if samba is built with dmalloc support\&.
261 .RE
262 .PP
263 dmalloc\-log\-changed
264 .RS 4
265 Dump the pointers that have changed since the mark set by dmalloc\-mark\&. Can be sent to both smbd and nmbd\&. Only available if samba is built with dmalloc support\&.
266 .RE
267 .PP
268 shutdown
269 .RS 4
270 Shut down specified daemon\&. Can be sent to both smbd and nmbd\&.
271 .RE
272 .PP
273 pool\-usage
274 .RS 4
275 Print a human\-readable description of all talloc(pool) memory usage by the specified daemon/process\&. Available for both smbd and nmbd\&.
276 .RE
277 .PP
278 ringbuf\-log
279 .RS 4
280 Fetch and print the ringbuf log\&. Requires
281 \fIlogging = ringbuf\fR\&. Available for smbd, winbindd and nmbd\&.
282 .RE
283 .PP
284 drvupgrade
285 .RS 4
286 Force clients of printers using specified driver to update their local version of the driver\&. Can only be sent to smbd\&.
287 .RE
288 .PP
289 reload\-config
290 .RS 4
291 Force daemon to reload smb\&.conf configuration file\&. Can be sent to
292 \fBsmbd\fR,
293 \fBnmbd\fR, or
294 \fBwinbindd\fR\&.
295 .RE
296 .PP
297 reload\-printers
298 .RS 4
299 Force smbd to reload printers\&. Can only be sent to
300 \fBsmbd\fR\&.
301 .RE
302 .PP
303 idmap
304 .RS 4
305 Notify about changes of id mapping\&. Can be sent to
306 \fBsmbd\fR
307 or (not implemented yet)
308 \fBwinbindd\fR\&.
309 .PP
310 flush [uid|gid]
311 .RS 4
312 Flush caches for sid <\-> gid and/or sid <\-> uid mapping\&.
313 .RE
314 .PP
315 delete <ID>
316 .RS 4
317 Remove a mapping from cache\&. The mapping is given by <ID> which may either be a sid: S\-x\-\&.\&.\&., a gid: "GID number" or a uid: "UID number"\&.
318 .RE
319 .PP
320 kill <ID>
321 .RS 4
322 Remove a mapping from cache\&. Terminate
323 \fBsmbd\fR
324 if the id is currently in use\&.
325 .RE
326 .RE
327 .PP
328 num\-children
329 .RS 4
330 Query the number of smbd child processes\&. This message can only be sent to
331 \fBsmbd\fR\&.
332 .RE
333 .PP
334 reload\-certs
335 .RS 4
336 Instruct the LDAP server of a Samba AD DC to reload the TLS certificates protecting ldaps:// connections\&. This message can only be sent to
337 \fBldap_server\fR\&.
338 .RE
339 .SH "VERSION"
340 .PP
341 This man page is part of version 4\&.24\&.3\-Debian\-4\&.24\&.3+dfsg\-1 of the Samba suite\&.
342 .SH "SEE ALSO"
343 .PP
344 \fBnmbd\fR(8)
345 and
346 \fBsmbd\fR(8)\&.
347 .SH "AUTHOR"
348 .PP
349 The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.