1SMBCONTROL(1)                    User Commands                   SMBCONTROL(1)
2
3
4

NAME

6       smbcontrol - send messages to smbd, nmbd or winbindd processes
7

SYNOPSIS

9       smbcontrol [-i] [-s]
10
11       smbcontrol [destination] [message-type] [parameter]
12

DESCRIPTION

14       This tool is part of the samba(7) suite.
15
16       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

OPTIONS

20       -?|--help
21           Print a summary of command line options.
22
23       -s|--configfile <configuration file>
24           The file specified contains the configuration details required by
25           the server. The information in this file includes server-specific
26           information such as what printcap file to use, as well as
27           descriptions of all the services that the server is to provide. See
28           smb.conf for more information. The default configuration file name
29           is determined at compile time.
30
31       -i
32           Run interactively. Individual commands of the form destination
33           message-type parameters can be entered on STDIN. An empty command
34           line or a "q" will quit the program.
35
36       destination
37           One of nmbd, smbd or a process ID.
38
39           The all destination causes the message to "broadcast" to all
40           running daemons including nmbd and winbind. This is a change for
41           Samba 3.3, prior to this the parameter smbd used to do this.
42
43           The smbd destination causes the message to be sent to the smbd
44           daemon specified in the smbd.pid file.
45
46           The nmbd destination causes the message to be sent to the nmbd
47           daemon specified in the nmbd.pid file.
48
49           The winbindd destination causes the message to be sent to the
50           winbind daemon specified in the winbindd.pid file.
51
52           If a single process ID is given, the message is sent to only that
53           process.
54
55       message-type
56           Type of message to send. See the section MESSAGE-TYPES for details.
57
58       parameters
59           any parameters required for the message-type
60

MESSAGE-TYPES

62       Available message types are:
63
64       close-share
65           Order smbd to close the client connections to the named share. Note
66           that this doesn't affect client connections to any other shares.
67           This message-type takes an argument of the share name for which
68           client connections will be closed, or the "*" character which will
69           close all currently open shares. This may be useful if you made
70           changes to the access controls on the share. This message can only
71           be sent to smbd.
72
73       debug
74           Set debug level to the value specified by the parameter. This can
75           be sent to any of the destinations. If this message is sent to
76           either the smbd or winbindd daemons, the parent process will
77           rebroadcast the message to all child processes changing the debug
78           level in each one.
79
80       force-election
81           This message causes the nmbd daemon to force a new browse master
82           election.
83
84       ping
85           Send specified number of "ping" messages and wait for the same
86           number of reply "pong" messages. This can be sent to any of the
87           destinations.
88
89       profile
90           Change profile settings of a daemon, based on the parameter. The
91           parameter can be "on" to turn on profile stats collection, "off" to
92           turn off profile stats collection, "count" to enable only
93           collection of count stats (time stats are disabled), and "flush" to
94           zero the current profile stats. This can be sent to any smbd or
95           nmbd destinations.
96
97       debuglevel
98           Request debuglevel of a certain daemon and write it to stdout. This
99           can be sent to any of the destinations.
100
101       profilelevel
102           Request profilelevel of a certain daemon and write it to stdout.
103           This can be sent to any smbd or nmbd destinations.
104
105       printnotify
106           Order smbd to send a printer notify message to any Windows NT
107           clients connected to a printer. This message-type takes the
108           following arguments:
109
110           queuepause printername
111               Send a queue pause change notify message to the printer
112               specified.
113
114           queueresume printername
115               Send a queue resume change notify message for the printer
116               specified.
117
118           jobpause printername unixjobid
119               Send a job pause change notify message for the printer and unix
120               jobid specified.
121
122           jobresume printername unixjobid
123               Send a job resume change notify message for the printer and
124               unix jobid specified.
125
126           jobdelete printername unixjobid
127               Send a job delete change notify message for the printer and
128               unix jobid specified.
129
130           Note that this message only sends notification that an event has
131           occurred. It doesn't actually cause the event to happen.
132
133           This message can only be sent to smbd.
134
135       samsync
136           Order smbd to synchronise sam database from PDC (being BDC). Can
137           only be sent to smbd.
138
139               Note
140               Not working at the moment
141
142       samrepl
143           Send sam replication message, with specified serial. Can only be
144           sent to smbd. Should not be used manually.
145
146       dmalloc-mark
147           Set a mark for dmalloc. Can be sent to both smbd and nmbd. Only
148           available if samba is built with dmalloc support.
149
150       dmalloc-log-changed
151           Dump the pointers that have changed since the mark set by
152           dmalloc-mark. Can be sent to both smbd and nmbd. Only available if
153           samba is built with dmalloc support.
154
155       shutdown
156           Shut down specified daemon. Can be sent to both smbd and nmbd.
157
158       pool-usage
159           Print a human-readable description of all talloc(pool) memory usage
160           by the specified daemon/process. Available for both smbd and nmbd.
161
162       drvupgrade
163           Force clients of printers using specified driver to update their
164           local version of the driver. Can only be sent to smbd.
165
166       reload-config
167           Force daemon to reload smb.conf configuration file. Can be sent to
168           smbd, nmbd, or winbindd.
169
170       idmap
171           Notify about changes of id mapping. Can be sent to smbd or (not
172           implemented yet) winbindd.
173
174           flush [uid|gid]
175               Flush caches for sid <-> gid and/or sid <-> uid mapping.
176
177           delete <ID>
178               Remove a mapping from cache. The mapping is given by <ID> which
179               may either be a sid: S-x-..., a gid: "GID number" or a uid:
180               "UID number".
181
182           kill <ID>
183               Remove a mapping from cache. Terminate smbd if the id is
184               currently in use.
185

VERSION

187       This man page is correct for version 3 of the Samba suite.
188

SEE ALSO

190       nmbd(8) and smbd(8).
191

AUTHOR

193       The original Samba software and related utilities were created by
194       Andrew Tridgell. Samba is now developed by the Samba Team as an Open
195       Source project similar to the way the Linux kernel is developed.
196
197       The original Samba man pages were written by Karl Auer. The man page
198       sources were converted to YODL format (another excellent piece of Open
199       Source software, available at ftp://ftp.icce.rug.nl/pub/unix/) and
200       updated for the Samba 2.0 release by Jeremy Allison. The conversion to
201       DocBook for Samba 2.2 was done by Gerald Carter. The conversion to
202       DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.
203
204
205
206Samba 3.6                         04/11/2016                     SMBCONTROL(1)
Impressum