| blob | 8c977bdad00698b41be8916284d4c9ac00e18204 |
1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ctdb</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="ctdb"><a name="ctdb.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ctdb — clustered tdb database management utility</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">ctdb [ OPTIONS ] COMMAND ...</code> </p></div><div class="cmdsynopsis"><p><code class="command">ctdb</code> [-n <node>] [-Y] [-t <timeout>] [-T <timelimit>] [-? --help] [--usage] [-d --debug=<INTEGER>] [--socket=<filename>] [--print-emptyrecords]</p></div></div><div class="refsect1" title="DESCRIPTION"><a name="id488589"></a><h2>DESCRIPTION</h2><p>
2 ctdb is a utility to view and manage a ctdb cluster.
3 </p></div><div class="refsect1" title="OPTIONS"><a name="id488598"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-n <pnn></span></dt><dd><p>
4 This specifies the physical node number on which to execute the
5 command. Default is to run the command on the daemon running on
6 the local host.
7 </p><p>
8 The physical node number is an integer that describes the node in the
9 cluster. The first node has physical node number 0.
11 Produce output in machine readable form for easier parsing by scripts. Not all commands support this option.
13 How long should ctdb wait for the local ctdb daemon to respond to a command before timing out. Default is 3 seconds.
15 A limit on how long the ctdb command will run for before it will
16 be aborted. When this timelimit has been exceeded the ctdb command will
17 terminate.
19 Print some help text to the screen.
21 Print useage information to the screen.
23 Change the debug level for the command. Default is 0.
25 Specify the socketname to use when connecting to the local ctdb
26 daemon. The default is /tmp/ctdb.socket .
27 </p><p>
28 You only need to specify this parameter if you run multiple ctdb
29 daemons on the same physical host and thus can not use the default
30 name for the domain socket.
32 This enables printing of empty records when dumping databases
33 with the catdb, cattbd and dumpdbbackup commands. Records with
34 empty data segment are considered deleted by ctdb and cleaned
35 by the vacuuming mechanism, so this switch can come in handy for
36 debugging the vacuuming behaviour.
37 </p></dd></dl></div></div><div class="refsect1" title="Administrative Commands"><a name="id488738"></a><h2>Administrative Commands</h2><p>
38 These are commands used to monitor and administrate a CTDB cluster.
40 This command displays the pnn of the current node.
42 This command shows the current status of the ctdb node.
44 Node status reflects the current status of the node. There are five possible states:
45 </p><p>
46 OK - This node is fully functional.
47 </p><p>
48 DISCONNECTED - This node could not be connected through the network and is currently not participating 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.
49 </p><p>
50 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.
51 </p><p>
52 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.
53 </p><p>
54 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.
55 </p><p>
56 STOPPED - A node that is stopped does not host any public ip addresses,
57 nor is it part of the VNNMAP. A stopped node can not become LVSMASTER,
58 RECMASTER or NATGW.
59 This node does not perticipate in the CTDB cluster but can still be
60 communicated with. I.e. ctdb commands can be sent to it.
61 </p><p>
62 PARTIALLYONLINE - A node that is partially online participates
63 in a cluster like a node that is ok. Some interfaces to serve
64 public ip addresses are down, but at least one interface is up.
65 See also "ctdb ifaces".
67 The generation id is a number that indicates the current generation
68 of a cluster instance. Each time a cluster goes through a
69 reconfiguration or a recovery its generation id will be changed.
70 </p><p>
71 This number does not have any particular meaning other than to keep
72 track of when a cluster has gone through a recovery. It is a random
73 number that represents the current instance of a ctdb cluster
74 and its databases.
75 CTDBD uses this number internally to be able to tell when commands
76 to operate on the cluster and the databases was issued in a different
77 generation of the cluster, to ensure that commands that operate
78 on the databases will not survive across a cluster database recovery.
79 After a recovery, all old outstanding commands will automatically
80 become invalid.
81 </p><p>
82 Sometimes this number will be shown as "INVALID". This only means that
83 the ctdbd daemon has started but it has not yet merged with the cluster through a recovery.
84 All nodes start with generation "INVALID" and are not assigned a real
85 generation id until they have successfully been merged with a cluster
86 through a recovery.
88 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.
89 Only nodes that are participating in the vnnmap can become lmaster or dmaster for a database record.
90 </p></div><div class="refsect3" title="Recovery mode"><a name="id488848"></a><h4>Recovery mode</h4><p>
91 This is the current recovery mode of the cluster. There are two possible modes:
92 </p><p>
93 NORMAL - The cluster is fully operational.
94 </p><p>
95 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.
96 </p><p>
97 Once the recovery master detects an inconsistency, for example a node
98 becomes disconnected/connected, the recovery daemon will trigger a
99 cluster recovery process, where all databases are remerged across the
100 cluster. When this process starts, the recovery master will first
101 "freeze" all databases to prevent applications such as samba from
102 accessing the databases and it will also mark the recovery mode as
103 RECOVERY.
104 </p><p>
105 When CTDBD starts up, it will start in RECOVERY mode.
106 Once the node has been merged into a cluster and all databases
107 have been recovered, the node mode will change into NORMAL mode
108 and the databases will be "thawed", allowing samba to access the
109 databases again.
110 </p></div><div class="refsect3" title="Recovery master"><a name="id488880"></a><h4>Recovery master</h4><p>
111 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.
112 </p><p>
113 Only one node at a time can be the designated recovery master. Which
114 node is designated the recovery master is decided by an election
115 process in the recovery daemons running on each node.
116 </p></div><p>
117 Example: ctdb status
119 Number of nodes:4
120 pnn:0 11.1.2.200 OK (THIS NODE)
121 pnn:1 11.1.2.201 OK
122 pnn:2 11.1.2.202 OK
123 pnn:3 11.1.2.203 OK
124 Generation:1362079228
125 Size:4
130 Recovery mode:NORMAL (0)
131 Recovery master:0
132 </pre></div><div class="refsect2" title="recmaster"><a name="id488912"></a><h3>recmaster</h3><p>
133 This command shows the pnn of the node which is currently the recmaster.
135 This command shows the uptime for the ctdb daemon. When the last recovery or ip-failover completed and how long it took. If the "duration" is shown as a negative number, this indicates that there is a recovery/failover in progress and it started that many seconds ago.
136 </p><p>
137 Example: ctdb uptime
142 Duration of last recovery/failover: 2.248552 seconds
143 </pre></div><div class="refsect2" title="listnodes"><a name="id488948"></a><h3>listnodes</h3><p>
144 This command shows lists the ip addresses of all the nodes in the cluster.
145 </p><p>
146 Example: ctdb listnodes
148 10.0.0.71
149 10.0.0.72
150 10.0.0.73
151 10.0.0.74
153 This command will "ping" all CTDB daemons in the cluster to verify that they are processing commands correctly.
154 </p><p>
155 Example: ctdb ping
156 </p><p>
157 Example output:
164 This command will display the list of network interfaces, which could
165 host public addresses, along with their status.
166 </p><p>
167 Example: ctdb ifaces
168 </p><p>
169 Example output:
171 Interfaces on node 0
172 name:eth5 link:up references:2
173 name:eth4 link:down references:0
174 name:eth3 link:up references:1
175 name:eth2 link:up references:1
176 </pre><p>
177 Example: ctdb ifaces -Y
178 </p><p>
179 Example output:
181 :Name:LinkStatus:References:
186 </pre></div><div class="refsect2" title="setifacelink <iface> <status>"><a name="id489031"></a><h3>setifacelink <iface> <status></h3><p>
187 This command will set the status of a network interface.
190 </p><p>
191 Example: ctdb setifacelink eth0 up
193 This command will display the list of public addresses that are provided by the cluster and which physical node is currently serving this ip. By default this command will ONLY show those public addresses that are known to the node itself. To see the full list of all public ips across the cluster you must use "ctdb ip -n all".
194 </p><p>
195 Example: ctdb ip
196 </p><p>
197 Example output:
199 Public IPs on node 0
208 </pre><p>
209 Example: ctdb ip -Y
210 </p><p>
211 Example output:
213 :Public IP:Node:ActiveInterface:AvailableInterfaces:ConfiguredInterfaces:
222 </pre></div><div class="refsect2" title="ipinfo <ip>"><a name="id445732"></a><h3>ipinfo <ip></h3><p>
223 This command will display details about the specified public addresses.
224 </p><p>
225 Example: ctdb ipinfo 172.31.92.85
226 </p><p>
227 Example output:
230 IP:172.31.92.85
231 CurrentNode:0
232 NumInterfaces:2
235 </pre></div><div class="refsect2" title="scriptstatus"><a name="id445754"></a><h3>scriptstatus</h3><p>
236 This command displays which scripts where run in the previous monitoring cycle and the result of each script. If a script failed with an error, causing the node to become unhealthy, the output from that script is also shown.
237 </p><p>
238 Example: ctdb scriptstatus
239 </p><p>
240 Example output:
242 7 scripts were executed last monitoring cycle
247 31.clamd Status:DISABLED
251 OUTPUT:ERROR: Samba tcp port 445 is not responding
252 </pre></div><div class="refsect2" title="disablescript <script>"><a name="id445784"></a><h3>disablescript <script></h3><p>
253 This command is used to disable an eventscript.
254 </p><p>
255 This will take effect the next time the eventscripts are being executed so it can take a short while until this is reflected in 'scriptstatus'.
256 </p></div><div class="refsect2" title="enablescript <script>"><a name="id445797"></a><h3>enablescript <script></h3><p>
257 This command is used to enable an eventscript.
258 </p><p>
259 This will take effect the next time the eventscripts are being executed so it can take a short while until this is reflected in 'scriptstatus'.
260 </p></div><div class="refsect2" title="getvar <name>"><a name="id445811"></a><h3>getvar <name></h3><p>
261 Get the runtime value of a tuneable variable.
262 </p><p>
263 Example: ctdb getvar MaxRedirectCount
264 </p><p>
265 Example output:
267 MaxRedirectCount = 3
268 </pre></div><div class="refsect2" title="setvar <name> <value>"><a name="id445832"></a><h3>setvar <name> <value></h3><p>
269 Set the runtime value of a tuneable variable.
270 </p><p>
271 Example: ctdb setvar MaxRedirectCount 5
273 List all tuneable variables.
274 </p><p>
275 Example: ctdb listvars
276 </p><p>
277 Example output:
279 MaxRedirectCount = 3
280 SeqnumInterval = 1000
281 ControlTimeout = 60
282 TraverseTimeout = 20
283 KeepaliveInterval = 5
284 KeepaliveLimit = 5
285 RecoverTimeout = 20
286 RecoverInterval = 1
287 ElectionTimeout = 3
288 TakeoverTimeout = 9
289 MonitorInterval = 15
290 TickleUpdateInterval = 20
291 EventScriptTimeout = 30
292 EventScriptTimeoutCount = 1
293 EventScriptUnhealthyOnTimeout = 0
294 RecoveryGracePeriod = 120
295 RecoveryBanPeriod = 300
296 DatabaseHashSize = 100001
297 DatabaseMaxDead = 5
298 RerecoveryTimeout = 10
299 EnableBans = 1
300 DeterministicIPs = 1
301 ReclockPingPeriod = 60
302 NoIPFailback = 0
303 DisableIPFailover = 0
304 VerboseMemoryNames = 0
305 RecdPingTimeout = 60
306 RecdFailCount = 10
307 LogLatencyMs = 0
308 RecLockLatencyMs = 1000
309 RecoveryDropAllIPs = 120
310 VerifyRecoveryLock = 1
311 VacuumDefaultInterval = 10
312 VacuumMaxRunTime = 30
313 RepackLimit = 10000
314 VacuumLimit = 5000
315 VacuumMinInterval = 10
316 VacuumMaxInterval = 10
317 VacuumFastPathCount = 60
318 MaxQueueDropMsg = 1000000
319 UseStatusEvents = 0
320 AllowUnhealthyDBRead = 0
321 StatHistoryInterval = 1
322 DeferredAttachTO = 120
323 </pre></div><div class="refsect2" title="lvsmaster"><a name="id445876"></a><h3>lvsmaster</h3><p>
324 This command shows which node is currently the LVSMASTER. The
325 LVSMASTER is the node in the cluster which drives the LVS system and
326 which receives all incoming traffic from clients.
327 </p><p>
328 LVS is the mode where the entire CTDB/Samba cluster uses a single
329 ip address for the entire cluster. In this mode all clients connect to
330 one specific node which will then multiplex/loadbalance the clients
331 evenly onto the other nodes in the cluster. This is an alternative to using
332 public ip addresses. See the manpage for ctdbd for more information
333 about LVS.
335 This command shows which nodes in the cluster are currently active in the
336 LVS configuration. I.e. which nodes we are currently loadbalancing
337 the single ip address across.
338 </p><p>
339 LVS will by default only loadbalance across those nodes that are both
340 LVS capable and also HEALTHY. Except if all nodes are UNHEALTHY in which
341 case LVS will loadbalance across all UNHEALTHY nodes as well.
342 LVS will never use nodes that are DISCONNECTED, STOPPED, BANNED or
343 DISABLED.
344 </p><p>
345 Example output:
349 </pre></div><div class="refsect2" title="getcapabilities"><a name="id445919"></a><h3>getcapabilities</h3><p>
350 This command shows the capabilities of the current node.
351 Please see manpage for ctdbd for a full list of all capabilities and
352 more detailed description.
353 </p><p>
354 RECMASTER and LMASTER capabilities are primarily used when CTDBD
355 is used to create a cluster spanning across WAN links. In which case
356 ctdbd acts as a WAN accelerator.
357 </p><p>
358 LVS capabile means that the node is participating in LVS, a mode
359 where the entire CTDB cluster uses one single ip address for the
360 entire cluster instead of using public ip address failover.
361 This is an alternative to using a loadbalancing layer-4 switch.
362 </p><p>
363 Example output:
365 RECMASTER: YES
366 LMASTER: YES
367 LVS: NO
368 </pre></div><div class="refsect2" title="statistics"><a name="id445949"></a><h3>statistics</h3><p>
369 Collect statistics from the CTDB daemon about how many calls it has served.
370 </p><p>
371 Example: ctdb statistics
372 </p><p>
373 Example output:
375 CTDB version 1
376 num_clients 3
377 frozen 0
378 recovering 0
379 client_packets_sent 360489
380 client_packets_recv 360466
381 node_packets_sent 480931
382 node_packets_recv 240120
383 keepalive_packets_sent 4
384 keepalive_packets_recv 3
385 node
386 req_call 2
387 reply_call 2
388 req_dmaster 0
389 reply_dmaster 0
390 reply_error 0
391 req_message 42
392 req_control 120408
393 reply_control 360439
394 client
395 req_call 2
396 req_message 24
397 req_control 360440
398 timeouts
399 call 0
400 control 0
401 traverse 0
402 total_calls 2
403 pending_calls 0
404 lockwait_calls 0
405 pending_lockwait_calls 0
406 memory_used 5040
407 max_hop_count 0
408 max_call_latency 4.948321 sec
409 max_lockwait_latency 0.000000 sec
410 </pre></div><div class="refsect2" title="statisticsreset"><a name="id445982"></a><h3>statisticsreset</h3><p>
411 This command is used to clear all statistics counters in a node.
412 </p><p>
413 Example: ctdb statisticsreset
414 </p></div><div class="refsect2" title="getreclock"><a name="id445995"></a><h3>getreclock</h3><p>
415 This command is used to show the filename of the reclock file that is used.
416 </p><p>
417 Example output:
419 Reclock file:/gpfs/.ctdb/shared
420 </pre></div><div class="refsect2" title="setreclock [filename]"><a name="id446013"></a><h3>setreclock [filename]</h3><p>
421 This command is used to modify, or clear, the file that is used as the reclock file at runtime. When this command is used, the reclock file checks are disabled. To re-enable the checks the administrator needs to activate the "VerifyRecoveryLock" tunable using "ctdb setvar".
422 </p><p>
423 If run with no parameter this will remove the reclock file completely. If run with a parameter the parameter specifies the new filename to use for the recovery lock.
424 </p><p>
425 This command only affects the runtime settings of a ctdb node and will be lost when ctdb is restarted. For persistent changes to the reclock file setting you must edit /etc/sysconfig/ctdb.
427 Get the current debug level for the node. the debug level controls what information is written to the log file.
428 </p><p>
429 The debug levels are mapped to the corresponding syslog levels.
430 When a debug level is set, only those messages at that level and higher
431 levels will be printed.
432 </p><p>
433 The list of debug levels from highest to lowest are :
434 </p><p>
435 EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
436 </p></div><div class="refsect2" title="setdebug <debuglevel>"><a name="id446055"></a><h3>setdebug <debuglevel></h3><p>
437 Set the debug level of a node. This controls what information will be logged.
438 </p><p>
439 The debuglevel is one of EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
441 This command will return the process id of the ctdb daemon.
443 This command is used to administratively disable a node in the cluster.
444 A disabled node will still participate in the cluster and host
445 clustered TDB records but its public ip address has been taken over by
446 a different node and it no longer hosts any services.
448 Re-enable a node that has been administratively disabled.
450 This command is used to administratively STOP a node in the cluster.
451 A STOPPED node is connected to the cluster but will not host any
452 public ip addresse, nor does it participate in the VNNMAP.
453 The difference between a DISABLED node and a STOPPED node is that
454 a STOPPED node does not host any parts of the database which means
455 that a recovery is required to stop/continue nodes.
457 Re-start a node that has been administratively stopped.
458 </p></div><div class="refsect2" title="addip <public_ip/mask> <iface>"><a name="id446118"></a><h3>addip <public_ip/mask> <iface></h3><p>
459 This command is used to add a new public ip to a node during runtime.
460 This allows public addresses to be added to a cluster without having
461 to restart the ctdb daemons.
462 </p><p>
463 Note that this only updates the runtime instance of ctdb. Any changes will be lost next time ctdb is restarted and the public addresses file is re-read.
464 If you want this change to be permanent you must also update the public addresses file manually.
465 </p></div><div class="refsect2" title="delip <public_ip>"><a name="id446135"></a><h3>delip <public_ip></h3><p>
466 This command is used to remove a public ip from a node during runtime.
467 If this public ip is currently hosted by the node it being removed from, the ip will first be failed over to another node, if possible, before it is removed.
468 </p><p>
469 Note that this only updates the runtime instance of ctdb. Any changes will be lost next time ctdb is restarted and the public addresses file is re-read.
470 If you want this change to be permanent you must also update the public addresses file manually.
471 </p></div><div class="refsect2" title="moveip <public_ip> <node>"><a name="id446151"></a><h3>moveip <public_ip> <node></h3><p>
472 This command can be used to manually fail a public ip address to a
473 specific node.
474 </p><p>
475 In order to manually override the "automatic" distribution of public
476 ip addresses that ctdb normally provides, this command only works
477 when you have changed the tunables for the daemon to:
478 </p><p>
479 DeterministicIPs = 0
480 </p><p>
481 NoIPFailback = 1
483 This command will shutdown a specific CTDB daemon.
485 This command will trigger the recovery daemon to do a cluster
486 recovery.
487 </p></div><div class="refsect2" title="ipreallocate"><a name="id446192"></a><h3>ipreallocate</h3><p>
488 This command will force the recovery master to perform a full ip reallocation process and redistribute all ip addresses. This is useful to "reset" the allocations back to its default state if they have been changed using the "moveip" command. While a "recover" will also perform this reallocation, a recovery is much more hevyweight since it will also rebuild all the databases.
489 </p></div><div class="refsect2" title="setlmasterrole <on|off>"><a name="id446204"></a><h3>setlmasterrole <on|off></h3><p>
490 This command is used ot enable/disable the LMASTER capability for a node at runtime. This capability determines whether or not a node can be used as an LMASTER for records in the database. A node that does not have the LMASTER capability will not show up in the vnnmap.
491 </p><p>
492 Nodes will by default have this capability, but it can be stripped off nodes by the setting in the sysconfig file or by using this command.
493 </p><p>
494 Once this setting has been enabled/disabled, you need to perform a recovery for it to take effect.
495 </p><p>
496 See also "ctdb getcapabilities"
497 </p></div><div class="refsect2" title="setrecmasterrole <on|off>"><a name="id446228"></a><h3>setrecmasterrole <on|off></h3><p>
498 This command is used ot enable/disable the RECMASTER capability for a node at runtime. This capability determines whether or not a node can be used as an RECMASTER for the cluster. A node that does not have the RECMASTER capability can not win a recmaster election. A node that already is the recmaster for the cluster when the capability is stripped off the node will remain the recmaster until the next cluster election.
499 </p><p>
500 Nodes will by default have this capability, but it can be stripped off nodes by the setting in the sysconfig file or by using this command.
501 </p><p>
502 See also "ctdb getcapabilities"
503 </p></div><div class="refsect2" title="killtcp <srcip:port> <dstip:port>"><a name="id446248"></a><h3>killtcp <srcip:port> <dstip:port></h3><p>
504 This command will kill the specified TCP connection by issuing a
505 TCP RST to the srcip:port endpoint. This is a command used by the
506 ctdb eventscripts.
507 </p></div><div class="refsect2" title="gratiousarp <ip> <interface>"><a name="id446259"></a><h3>gratiousarp <ip> <interface></h3><p>
508 This command will send out a gratious arp for the specified interface
509 through the specified interface. This command is mainly used by the
510 ctdb eventscripts.
511 </p></div><div class="refsect2" title="reloadnodes"><a name="id446269"></a><h3>reloadnodes</h3><p>
512 This command is used when adding new nodes, or removing existing nodes from an existing cluster.
513 </p><p>
514 Procedure to add a node:
515 </p><p>
516 1, To expand an existing cluster, first ensure with 'ctdb status' that
517 all nodes are up and running and that they are all healthy.
518 Do not try to expand a cluster unless it is completely healthy!
519 </p><p>
520 2, On all nodes, edit /etc/ctdb/nodes and add the new node as the last
521 entry to the file. The new node MUST be added to the end of this file!
522 </p><p>
523 3, Verify that all the nodes have identical /etc/ctdb/nodes files after you edited them and added the new node!
524 </p><p>
525 4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
526 </p><p>
527 5, Use 'ctdb status' on all nodes and verify that they now show the additional node.
528 </p><p>
529 6, Install and configure the new node and bring it online.
530 </p><p>
531 Procedure to remove a node:
532 </p><p>
533 1, To remove a node from an existing cluster, first ensure with 'ctdb status' that
534 all nodes, except the node to be deleted, are up and running and that they are all healthy.
535 Do not try to remove a node from a cluster unless the cluster is completely healthy!
536 </p><p>
537 2, Shutdown and poweroff the node to be removed.
538 </p><p>
539 3, On all other nodes, edit the /etc/ctdb/nodes file and comment out the node to be removed. Do not delete the line for that node, just comment it out by adding a '#' at the beginning of the line.
540 </p><p>
541 4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
542 </p><p>
543 5, Use 'ctdb status' on all nodes and verify that the deleted node no longer shows up in the list..
544 </p><p>
545 </p></div><div class="refsect2" title="tickle <srcip:port> <dstip:port>"><a name="id489904"></a><h3>tickle <srcip:port> <dstip:port></h3><p>
546 This command will will send a TCP tickle to the source host for the
547 specified TCP connection.
548 A TCP tickle is a TCP ACK packet with an invalid sequence and
549 acknowledge number and will when received by the source host result
550 in it sending an immediate correct ACK back to the other end.
551 </p><p>
552 TCP tickles are useful to "tickle" clients after a IP failover has
553 occured since this will make the client immediately recognize the
554 TCP connection has been disrupted and that the client will need
555 to reestablish. This greatly speeds up the time it takes for a client
556 to detect and reestablish after an IP failover in the ctdb cluster.
557 </p></div><div class="refsect2" title="gettickles <ip>"><a name="id489922"></a><h3>gettickles <ip></h3><p>
558 This command is used to show which TCP connections are registered with
559 CTDB to be "tickled" if there is a failover.
560 </p></div><div class="refsect2" title="repack [max_freelist]"><a name="id489932"></a><h3>repack [max_freelist]</h3><p>
561 Over time, when records are created and deleted in a TDB, the TDB list of free space will become fragmented. This can lead to a slowdown in accessing TDB records.
562 This command is used to defragment a TDB database and pruning the freelist.
563 </p><p>
564 If [max_freelist] is specified, then a database will only be repacked if it has more than this number of entries in the freelist.
565 </p><p>
566 During repacking of the database, the entire TDB database will be locked to prevent writes. If samba tries to write to a record in the database during a repack operation, samba will block until the repacking has completed.
567 </p><p>
568 This command can be disruptive and can cause samba to block for the duration of the repack operation. In general, a repack operation will take less than one second to complete.
569 </p><p>
570 A repack operation will only defragment the local TDB copy of the CTDB database. You need to run this command on all of the nodes to repack a CTDB database completely.
571 </p><p>
572 Example: ctdb repack 1000
573 </p><p>
575 </p></div><div class="refsect2" title="vacuum [max_records]"><a name="id489969"></a><h3>vacuum [max_records]</h3><p>
576 Over time CTDB databases will fill up with empty deleted records which will lead to a progressive slow down of CTDB database access.
577 This command is used to prune all databases and delete all empty records from the cluster.
578 </p><p>
579 By default, vacuum will delete all empty records from all databases.
580 If [max_records] is specified, the command will only delete the first
581 [max_records] empty records for each database.
582 </p><p>
583 Vacuum only deletes records where the local node is the lmaster.
584 To delete all records from the entire cluster you need to run a vacuum from each node.
586 This command is not disruptive. Samba is unaffected and will still be able to read/write records normally while the database is being vacuumed.
587 </p><p>
588 Example: ctdb vacuum
589 </p><p>
591 </p></div><div class="refsect2" title="backupdb <dbname> <file>"><a name="id489998"></a><h3>backupdb <dbname> <file></h3><p>
592 This command can be used to copy the entire content of a database out to a file. This file can later be read back into ctdb using the restoredb command.
593 This is mainly useful for backing up persistent databases such as secrets.tdb and similar.
594 </p></div><div class="refsect2" title="restoredb <file> [<dbname>]"><a name="id490009"></a><h3>restoredb <file> [<dbname>]</h3><p>
595 This command restores a persistent database that was previously backed up using backupdb.
596 By default the data will be restored back into the same database as
597 it was created from. By specifying dbname you can restore the data
598 into a different database.
599 </p></div><div class="refsect2" title="wipedb <dbname>"><a name="id490020"></a><h3>wipedb <dbname></h3><p>
600 This command can be used to remove all content of a database.
601 </p></div></div><div class="refsect2" title="getlog <level>"><a name="id490029"></a><h3>getlog <level></h3><p>
602 In addition to the normal loggign to a log file,
603 CTDBD also keeps a in-memory ringbuffer containing the most recent
604 log entries for all log levels (except DEBUG).
605 </p><p>
606 This is useful since it allows for keeping continuous logs to a file
607 at a reasonable non-verbose level, but shortly after an incident has
608 occured, a much more detailed log can be pulled from memory. This
609 can allow you to avoid having to reproduce an issue due to the
610 on-disk logs being of insufficient detail.
611 </p><p>
612 This command extracts all messages of level or lower log level from
613 memory and prints it to the screen.
615 This command clears the in-memory logging ringbuffer.
616 </p></div><div class="refsect1" title="Debugging Commands"><a name="id490056"></a><h2>Debugging Commands</h2><p>
617 These commands are primarily used for CTDB development and testing and
618 should not be used for normal administration.
619 </p><div class="refsect2" title="process-exists <pid>"><a name="id490065"></a><h3>process-exists <pid></h3><p>
620 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.
622 This command lists all clustered TDB databases that the CTDB daemon has attached to. Some databases are flagged as PERSISTENT, this means that the database stores data persistently and the data will remain across reboots. One example of such a database is secrets.tdb where information about how the cluster was joined to the domain is stored.
623 </p><p>
624 If a PERSISTENT database is not in a healthy state the database is
625 flagged as UNHEALTHY. If there's at least one completely healthy node running in
626 the cluster, it's possible that the content is restored by a recovery
627 run automaticly. Otherwise an administrator needs to analyze the
628 problem.
629 </p><p>
632 and (if samba or tdb-utils are installed) "tdbtool check".
633 </p><p>
634 Most databases are not persistent and only store the state information that the currently running samba daemons need. These databases are always wiped when ctdb/samba starts and when a node is rebooted.
635 </p><p>
636 Example: ctdb getdbmap
637 </p><p>
638 Example output:
640 Number of databases:10
651 </pre><p>
652 Example output for an unhealthy database:
654 Number of databases:1
656 </pre><p>
657 Example output for a healthy database as machinereadable output -Y:
659 :ID:Name:Path:Persistent:Unhealthy:
661 </pre></div><div class="refsect2" title="getdbstatus <dbname>"><a name="id490140"></a><h3>getdbstatus <dbname></h3><p>
662 This command displays more details about a database.
663 </p><p>
664 Example: ctdb getdbstatus test.tdb.0
665 </p><p>
666 Example output:
668 dbid: 0x122224da
669 name: test.tdb
670 path: /var/ctdb/test.tdb.0
671 PERSISTENT: no
672 HEALTH: OK
673 </pre><p>
674 Example: ctdb getdbstatus registry.tdb (with a corrupted TDB)
675 </p><p>
676 Example output:
678 dbid: 0xf2a58948
679 name: registry.tdb
680 path: /var/ctdb/persistent/registry.tdb.0
681 PERSISTENT: yes
682 HEALTH: NO-HEALTHY-NODES - ERROR - Backup of corrupted TDB in '/var/ctdb/persistent/registry.tdb.0.corrupted.20091208091949.0Z'
683 </pre></div><div class="refsect2" title="catdb <dbname>"><a name="id490175"></a><h3>catdb <dbname></h3><p>
684 This command will dump a clustered TDB database to the screen. This is a debugging command.
685 </p></div><div class="refsect2" title="cattdb <dbname>"><a name="id490184"></a><h3>cattdb <dbname></h3><p>
686 This command will dump the content of the local TDB database to the screen. This is a debugging command.
687 </p></div><div class="refsect2" title="dumpdbbackup <backup-file>"><a name="id490194"></a><h3>dumpdbbackup <backup-file></h3><p>
688 This command will dump the content of database backup to the screen
689 (similar to ctdb catdb). This is a debugging command.
690 </p></div><div class="refsect2" title="getmonmode"><a name="id490204"></a><h3>getmonmode</h3><p>
691 This command returns the monutoring mode of a node. The monitoring mode is either ACTIVE or DISABLED. Normally a node will continuously monitor that all other nodes that are expected are in fact connected and that they respond to commands.
692 </p><p>
693 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.
694 </p><p>
695 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.
696 </p></div><div class="refsect2" title="setmonmode <0|1>"><a name="id490229"></a><h3>setmonmode <0|1></h3><p>
697 This command can be used to explicitly 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.
698 </p></div><div class="refsect2" title="attach <dbname> [persistent]"><a name="id490241"></a><h3>attach <dbname> [persistent]</h3><p>
699 This is a debugging command. This command will make the CTDB daemon create a new CTDB database and attach to it.
700 </p></div><div class="refsect2" title="dumpmemory"><a name="id490251"></a><h3>dumpmemory</h3><p>
701 This is a debugging command. This command will make the ctdb
702 daemon to write a fill memory allocation map to standard output.
703 </p></div><div class="refsect2" title="rddumpmemory"><a name="id490261"></a><h3>rddumpmemory</h3><p>
704 This is a debugging command. This command will dump the talloc memory
705 allocation tree for the recovery daemon to standard output.
707 Thaw a previously frozen node.
708 </p></div><div class="refsect2" title="eventscript <arguments>"><a name="id490279"></a><h3>eventscript <arguments></h3><p>
709 This is a debugging command. This command can be used to manually
710 invoke and run the eventscritps with arbitrary arguments.
711 </p></div><div class="refsect2" title="ban <bantime|0>"><a name="id490289"></a><h3>ban <bantime|0></h3><p>
712 Administratively ban a node for bantime seconds. A bantime of 0 means that the node should be permanently banned.
713 </p><p>
714 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 another node and no services are hosted.
715 </p><p>
716 Nodes are automatically banned if they are the cause of too many
717 cluster recoveries.
718 </p><p>
719 This is primarily a testing command. Note that the recovery daemon controls the overall ban state and it may automatically unban nodes at will. Meaning that a node that has been banned by the administrator can and ofter are unbanned before the admin specifid timeout triggers. If wanting to "drop" a node out from the cluster for mainentance or other reasons, use the "stop" / "continue" commands instad of "ban" / "unban".
721 This command is used to unban a node that has either been
722 administratively banned using the ban command or has been automatically
723 banned by the recovery daemon.
724 </p></div></div><div class="refsect1" title="SEE ALSO"><a name="id490326"></a><h2>SEE ALSO</h2><p>
727 </p></div><div class="refsect1" title="COPYRIGHT/LICENSE"><a name="id490339"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
730 <br>
731 This program is free software; you can redistribute it and/or modify<br>
732 it under the terms of the GNU General Public License as published by<br>
734 your option) any later version.<br>
735 <br>
736 This program is distributed in the hope that it will be useful, but<br>
737 WITHOUT ANY WARRANTY; without even the implied warranty of<br>
738 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU<br>
739 General Public License for more details.<br>
740 <br>
741 You should have received a copy of the GNU General Public License<br>
742 along with this program; if not, see http://www.gnu.org/licenses/.<br>
743 </p></div></div></div></body></html>