update lib/replace from samba4
[vlendec/samba-autobuild/.git] / ctdb / doc / ctdb.1
1 .\"     Title: ctdb
2 .\"    Author: 
3 .\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
4 .\"      Date: 07/05/2007
5 .\"    Manual: 
6 .\"    Source: 
7 .\"
8 .TH "CTDB" "1" "07/05/2007" "" ""
9 .\" disable hyphenation
10 .nh
11 .\" disable justification (adjust text to left margin only)
12 .ad l
13 .SH "NAME"
14 ctdb \- clustered tdb database management utility
15 .SH "SYNOPSIS"
16 .HP 29
17 \fBctdb [ OPTIONS ] COMMAND ...\fR
18 .HP 5
19 \fBctdb\fR [\-n\ <node>] [\-Y] [\-t\ <timeout>] [\-?\ \-\-help] [\-\-usage] [\-d\ \-\-debug=<INTEGER>] [\-\-socket=<filename>]
20 .SH "DESCRIPTION"
21 .PP
22 ctdb is a utility to view and manage a ctdb cluster.
23 .SH "OPTIONS"
24 .PP
25 \-n <node>
26 .RS 4
27 This specifies on which node to execute the command. Default is to run the command on the deamon running on the local host.
28 .RE
29 .PP
30 \-Y
31 .RS 4
32 Produce output in machinereadable form for easier parsing by scripts. Not all commands support this option.
33 .RE
34 .PP
35 \-t <timeout>
36 .RS 4
37 How long should ctdb wait for a command to complete before timing out. Default is 3 seconds.
38 .RE
39 .PP
40 \-? \-\-help
41 .RS 4
42 Print some help text to the screen.
43 .RE
44 .PP
45 \-\-usage
46 .RS 4
47 Print useage information to the screen.
48 .RE
49 .PP
50 \-d \-\-debug=<debuglevel>
51 .RS 4
52 Change the debug level for the command. Default is 0.
53 .RE
54 .PP
55 \-\-socket=<filename>
56 .RS 4
57 Specify the socketname to use when connecting to the local ctdb daemon. The default is /tmp/ctdb.socket .
58 .sp
59 You only need to specify this parameter if you run multiple ctdb daemons on the same physical host and thus can not use the default name for the domain socket.
60 .RE
61 .SH "ADMINISTRATIVE COMMANDS"
62 .PP
63 These are commands used to monitor and administrate a CTDB cluster.
64 .SS "status"
65 .PP
66 This command shows the current status of the ctdb node.
67 .sp
68 .it 1 an-trap
69 .nr an-no-space-flag 1
70 .nr an-break-flag 1
71 .br
72 \fBnode status\fR
73 .RS
74 .PP
75 Node status reflects the current status of the node. There are four possible states:
76 .PP
77 OK \- This node is fully functional.
78 .PP
79 DISCONNECTED \- This node could not be connected through the network and is currently not parcipitating in the cluster. If there is a public IP address associated with this node it should have been taken over by a different node. No services are running on this node.
80 .PP
81 DISABLED \- This node has been administratively disabled. This node is still functional and participates in the CTDB cluster but its IP addresses have been taken over by a different node and no services are currently being hosted.
82 .PP
83 UNHEALTHY \- A service provided by this node is malfunctioning and should be investigated. The CTDB daemon itself is operational and participates in the cluster. Its public IP address has been taken over by a different node and no services are currnetly being hosted. All unhealthy nodes should be investigated and require an administrative action to rectify.
84 .PP
85 BANNED \- This node failed too many recovery attempts and has been banned from participating in the cluster for a period of RecoveryBanPeriod seconds. Any public IP address has been taken over by other nodes. This node does not provide any services. All banned nodes should be investigated and require an administrative action to rectify. This node does not perticipate in the CTDB cluster but can still be communicated with. I.e. ctdb commands can be sent to it.
86 .RE
87 .sp
88 .it 1 an-trap
89 .nr an-no-space-flag 1
90 .nr an-break-flag 1
91 .br
92 \fBgeneration\fR
93 .RS
94 .PP
95 The generation id is a number that indicates the current generation of a cluster instance. Each time a cluster goes through a reconfiguration or a recovery its generation id will be changed.
96 .RE
97 .sp
98 .it 1 an-trap
99 .nr an-no-space-flag 1
100 .nr an-break-flag 1
101 .br
102 \fBVNNMAP\fR
103 .RS
104 .PP
105 The list of Virtual Node Numbers. This is a list of all nodes that actively participates in the cluster and that share the workload of hosting the Clustered TDB database records. Only nodes that are parcipitating in the vnnmap can become lmaster or dmaster for a database record.
106 .RE
107 .sp
108 .it 1 an-trap
109 .nr an-no-space-flag 1
110 .nr an-break-flag 1
111 .br
112 \fBRecovery mode\fR
113 .RS
114 .PP
115 This is the current recovery mode of the cluster. There are two possible modes:
116 .PP
117 NORMAL \- The cluster is fully operational.
118 .PP
119 RECOVERY \- The cluster databases have all been frozen, pausing all services while the cluster awaits a recovery process to complete. A recovery process should finish within seconds. If a cluster is stuck in the RECOVERY state this would indicate a cluster malfunction which needs to be investigated.
120 .RE
121 .sp
122 .it 1 an-trap
123 .nr an-no-space-flag 1
124 .nr an-break-flag 1
125 .br
126 \fBRecovery master\fR
127 .RS
128 .PP
129 This is the cluster node that is currently designated as the recovery master. This node is responsible of monitoring the consistency of the cluster and to perform the actual recovery process when reqired.
130 .RE
131 .PP
132 Example: ctdb status
133 .PP
134 Example output:
135 .sp
136 .RS 4
137 .nf
138 Number of nodes:4
139 vnn:0 11.1.2.200       OK (THIS NODE)
140 vnn:1 11.1.2.201       OK
141 vnn:2 11.1.2.202       OK
142 vnn:3 11.1.2.203       OK
143 Generation:1362079228
144 Size:4
145 hash:0 lmaster:0
146 hash:1 lmaster:1
147 hash:2 lmaster:2
148 hash:3 lmaster:3
149 Recovery mode:NORMAL (0)
150 Recovery master:0
151       
152 .fi
153 .RE
154 .SS "ping"
155 .PP
156 This command will "ping" all CTDB daemons in the cluster to verify that they are processing commands correctly.
157 .PP
158 Example: ctdb ping
159 .PP
160 Example output:
161 .sp
162 .RS 4
163 .nf
164 response from 0 time=0.000054 sec  (3 clients)
165 response from 1 time=0.000144 sec  (2 clients)
166 response from 2 time=0.000105 sec  (2 clients)
167 response from 3 time=0.000114 sec  (2 clients)
168       
169 .fi
170 .RE
171 .SS "ip"
172 .PP
173 This command will display the list of public addresses that are provided by the cluster and which physical node is currently serving this ip.
174 .PP
175 Example: ctdb ip
176 .PP
177 Example output:
178 .sp
179 .RS 4
180 .nf
181 Number of nodes:4
182 12.1.1.1         0
183 12.1.1.2         1
184 12.1.1.3         2
185 12.1.1.4         3
186       
187 .fi
188 .RE
189 .SS "getvar <name>"
190 .PP
191 Get the runtime value of a tuneable variable.
192 .PP
193 Example: ctdb getvar MaxRedirectCount
194 .PP
195 Example output:
196 .sp
197 .RS 4
198 .nf
199 MaxRedirectCount    = 3
200       
201 .fi
202 .RE
203 .SS "setvar <name> <value>"
204 .PP
205 Set the runtime value of a tuneable variable.
206 .PP
207 Example: ctdb setvar MaxRedirectCount 5
208 .SS "listvars"
209 .PP
210 List all tuneable variables.
211 .PP
212 Example: ctdb listvars
213 .PP
214 Example output:
215 .sp
216 .RS 4
217 .nf
218 MaxRedirectCount    = 5
219 SeqnumFrequency     = 1
220 ControlTimeout      = 60
221 TraverseTimeout     = 20
222 KeepaliveInterval   = 2
223 KeepaliveLimit      = 3
224 MaxLACount          = 7
225 RecoverTimeout      = 5
226 RecoverInterval     = 1
227 ElectionTimeout     = 3
228 TakeoverTimeout     = 5
229 MonitorInterval     = 15
230 EventScriptTimeout  = 20
231 RecoveryGracePeriod = 60
232 RecoveryBanPeriod   = 300
233       
234 .fi
235 .RE
236 .SS "statistics"
237 .PP
238 Collect statistics from the CTDB daemon about how many calls it has served.
239 .PP
240 Example: ctdb statistics
241 .PP
242 Example output:
243 .sp
244 .RS 4
245 .nf
246 CTDB version 1
247  num_clients                        3
248  frozen                             0
249  recovering                         0
250  client_packets_sent           360489
251  client_packets_recv           360466
252  node_packets_sent             480931
253  node_packets_recv             240120
254  keepalive_packets_sent             4
255  keepalive_packets_recv             3
256  node
257      req_call                       2
258      reply_call                     2
259      req_dmaster                    0
260      reply_dmaster                  0
261      reply_error                    0
262      req_message                   42
263      req_control               120408
264      reply_control             360439
265  client
266      req_call                       2
267      req_message                   24
268      req_control               360440
269  timeouts
270      call                           0
271      control                        0
272      traverse                       0
273  total_calls                        2
274  pending_calls                      0
275  lockwait_calls                     0
276  pending_lockwait_calls             0
277  memory_used                     5040
278  max_hop_count                      0
279  max_call_latency                   4.948321 sec
280  max_lockwait_latency               0.000000 sec
281       
282 .fi
283 .RE
284 .SS "statisticsreset"
285 .PP
286 This command is used to clear all statistics counters in a node.
287 .PP
288 Example: ctdb statisticsreset
289 .SS "getdebug"
290 .PP
291 Get the current debug level for the node. the debug level controls what information is written to the log file.
292 .SS "setdebug <debuglevel>"
293 .PP
294 Set the debug level of a node. This is a number between 0 and 9 and controls what information will be written to the logfile.
295 .SS "getpid"
296 .PP
297 This command will return the process id of the ctdb daemon.
298 .SS "disable"
299 .PP
300 This command is used to administratively disable a node in the cluster. A disabled node will still participate in the cluster and host clustered TDB records but its public ip address has been taken over by a different node and it no longer hosts any services.
301 .SS "enable"
302 .PP
303 Re\-enable a node that has been administratively disabled.
304 .SS "ban <bantime|0>"
305 .PP
306 Administratively ban a node for bantime seconds. A bantime of 0 means that the node should be permanently banned.
307 .PP
308 A banned node does not participate in the cluster and does not host any records for the clustered TDB. Its ip address has been taken over by an other node and no services are hosted.
309 .PP
310 Nodes are automatically banned if they are the cause of too many cluster recoveries.
311 .SS "unban"
312 .PP
313 This command is used to unban a node that has either been administratively banned using the ban command or has been automatically banned by the recovery daemon.
314 .SS "shutdown"
315 .PP
316 This command will shutdown a specific CTDB daemon.
317 .SS "recover"
318 .PP
319 This command will trigger the recovery daemon to do a cluster recovery.
320 .SS "killtcp <srcip:port> <dstip:port>"
321 .PP
322 This command will kill the specified TCP connection by issuing a TCP RST to the srcip:port endpoint.
323 .SS "tickle <srcip:port> <dstip:port>"
324 .PP
325 This command will will send a TCP tickle to the source host for the specified TCP connection. A TCP tickle is a TCP ACK packet with an invalid sequence and acknowledge number and will when received by the source host result in it sending an immediate correct ACK back to the other end.
326 .PP
327 TCP tickles are useful to "tickle" clients after a IP failover has occured since this will make the client immediately recognize the TCP connection has been disrupted and that the client will need to reestablish. This greatly speeds up the time it takes for a client to detect and reestablish after an IP failover in the ctdb cluster.
328 .SH "DEBUGGING COMMANDS"
329 .PP
330 These commands are primarily used for CTDB development and testing and should not be used for normal administration.
331 .SS "process\-exists <pid>"
332 .PP
333 This command checks if a specific process exists on the CTDB host. This is mainly used by Samba to check if remote instances of samba are still running or not.
334 .SS "getdbmap"
335 .PP
336 This command lists all clustered TDB databases that the CTDB daemon has attahced to.
337 .PP
338 Example: ctdb getdbmap
339 .PP
340 Example output:
341 .sp
342 .RS 4
343 .nf
344 Number of databases:4
345 dbid:0x42fe72c5 name:locking.tdb path:/var/ctdb/locking.tdb.0
346 dbid:0x1421fb78 name:brlock.tdb path:/var/ctdb/brlock.tdb.0
347 dbid:0x17055d90 name:connections.tdb path:/var/ctdb/connections.tdb.0
348 dbid:0xc0bdde6a name:sessionid.tdb path:/var/ctdb/sessionid.tdb.0
349       
350 .fi
351 .RE
352 .SS "catdb <dbname>"
353 .PP
354 This command will dump a clustered TDB database to the screen. This is a debugging command.
355 .SS "getmonmode"
356 .PP
357 This command returns the monutoring mode of a node. The monitoring mode is either ACTIVE or DISABLED. Normally a node will continously monitor that all other nodes that are expected are in fact connected and that they respond to commands.
358 .PP
359 ACTIVE \- This is the normal mode. The node is actively monitoring all other nodes, both that the transport is connected and also that the node responds to commands. If a node becomes unavailable, it will be marked as DISCONNECTED and a recovery is initiated to restore the cluster.
360 .PP
361 DISABLED \- This node is not monitoring that other nodes are available. In this mode a node failure will not be detected and no recovery will be performed. This mode is useful when for debugging purposes one wants to attach GDB to a ctdb process but wants to prevent the rest of the cluster from marking this node as DISCONNECTED and do a recovery.
362 .SS "setmonmode <0|1>"
363 .PP
364 This command can be used to explicitely disable/enable monitoring mode on a node. The main purpose is if one wants to attach GDB to a running ctdb daemon but wants to prevent the other nodes from marking it as DISCONNECTED and issuing a recovery. To do this, set monitoring mode to 0 on all nodes before attaching with GDB. Remember to set monitoring mode back to 1 afterwards.
365 .SS "attach <dbname>"
366 .PP
367 This is a debugging command. This command will make the CTDB daemon create a new CTDB database and attach to it.
368 .SS "dumpmemory"
369 .PP
370 This is a debugging command. This command will make the ctdb daemon to write a fill memory allocation map to the log file.
371 .SS "freeze"
372 .PP
373 This command will lock all the local TDB databases causing clients that are accessing these TDBs such as samba3 to block until the databases are thawed.
374 .PP
375 This is primarily used by the recovery daemon to stop all samba daemons from accessing any databases while the database is recovered and rebuilt.
376 .SS "thaw"
377 .PP
378 Thaw a previously frozen node.
379 .SH "SEE ALSO"
380 .PP
381 ctdbd(1), onnode(1)
382 \fI\%http://ctdb.samba.org/\fR
383 .SH "COPYRIGHT/LICENSE"
384 .sp
385 .RS 4
386 .nf
387 Copyright (C) Andrew Tridgell 2007
388 Copyright (C) Ronnie sahlberg 2007
389
390 This program is free software; you can redistribute it and/or modify
391 it under the terms of the GNU General Public License as published by
392 the Free Software Foundation; either version 3 of the License, or (at
393 your option) any later version.
394
395 This program is distributed in the hope that it will be useful, but
396 WITHOUT ANY WARRANTY; without even the implied warranty of
397 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
398 General Public License for more details.
399
400 You should have received a copy of the GNU General Public License
401 along with this program; if not, write to the Free Software
402 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
403 .fi
404 .RE