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>]</p></div></div><div class="refsect1" title="DESCRIPTION"><a name="id2485540"></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="id2485550"></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
8 The physical node number is an integer that describes the node in the
9 cluster. The first node has physical node number 0.
10 </p></dd><dt><span class="term">-Y</span></dt><dd><p>
11 Produce output in machine readable form for easier parsing by scripts. Not all commands support this option.
12 </p></dd><dt><span class="term">-t <timeout></span></dt><dd><p>
13 How long should ctdb wait for the local ctdb daemon to respond to a command before timing out. Default is 3 seconds.
14 </p></dd><dt><span class="term">-T <timelimit></span></dt><dd><p>
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
18 </p></dd><dt><span class="term">-? --help</span></dt><dd><p>
19 Print some help text to the screen.
20 </p></dd><dt><span class="term">--usage</span></dt><dd><p>
21 Print useage information to the screen.
22 </p></dd><dt><span class="term">-d --debug=<debuglevel></span></dt><dd><p>
23 Change the debug level for the command. Default is 0.
24 </p></dd><dt><span class="term">--socket=<filename></span></dt><dd><p>
25 Specify the socketname to use when connecting to the local ctdb
26 daemon. The default is /tmp/ctdb.socket .
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.
31 </p></dd></dl></div></div><div class="refsect1" title="Administrative Commands"><a name="id2485687"></a><h2>Administrative Commands</h2><p>
32 These are commands used to monitor and administrate a CTDB cluster.
33 </p><div class="refsect2" title="pnn"><a name="id2485696"></a><h3>pnn</h3><p>
34 This command displays the pnn of the current node.
35 </p></div><div class="refsect2" title="status"><a name="id2485706"></a><h3>status</h3><p>
36 This command shows the current status of the ctdb node.
37 </p><div class="refsect3" title="node status"><a name="id2485715"></a><h4>node status</h4><p>
38 Node status reflects the current status of the node. There are five possible states:
40 OK - This node is fully functional.
42 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.
44 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.
46 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.
48 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.
50 STOPPED - A node that is stopped does not host any public ip addresses,
51 nor is it part of the VNNMAP. A stopped node can not become LVSMASTER,
53 This node does not perticipate in the CTDB cluster but can still be
54 communicated with. I.e. ctdb commands can be sent to it.
56 PARTIALLYONLINE - A node that is partially online participates
57 in a cluster like a node that is ok. Some interfaces to serve
58 public ip addresses are down, but at least one interface is up.
59 See also "ctdb ifaces".
60 </p></div><div class="refsect3" title="generation"><a name="id2485783"></a><h4>generation</h4><p>
61 The generation id is a number that indicates the current generation
62 of a cluster instance. Each time a cluster goes through a
63 reconfiguration or a recovery its generation id will be changed.
65 This number does not have any particular meaning other than to keep
66 track of when a cluster has gone through a recovery. It is a random
67 number that represents the current instance of a ctdb cluster
69 CTDBD uses this number internally to be able to tell when commands
70 to operate on the cluster and the databases was issued in a different
71 generation of the cluster, to ensure that commands that operate
72 on the databases will not survive across a cluster database recovery.
73 After a recovery, all old outstanding commands will automatically
76 Sometimes this number will be shown as "INVALID". This only means that
77 the ctdbd daemon has started but it has not yet merged with the cluster through a recovery.
78 All nodes start with generation "INVALID" and are not assigned a real
79 generation id until they have successfully been merged with a cluster
81 </p></div><div class="refsect3" title="VNNMAP"><a name="id2538082"></a><h4>VNNMAP</h4><p>
82 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.
83 Only nodes that are participating in the vnnmap can become lmaster or dmaster for a database record.
84 </p></div><div class="refsect3" title="Recovery mode"><a name="id2538096"></a><h4>Recovery mode</h4><p>
85 This is the current recovery mode of the cluster. There are two possible modes:
87 NORMAL - The cluster is fully operational.
89 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.
91 Once the recovery master detects an inconsistency, for example a node
92 becomes disconnected/connected, the recovery daemon will trigger a
93 cluster recovery process, where all databases are remerged across the
94 cluster. When this process starts, the recovery master will first
95 "freeze" all databases to prevent applications such as samba from
96 accessing the databases and it will also mark the recovery mode as
99 When CTDBD starts up, it will start in RECOVERY mode.
100 Once the node has been merged into a cluster and all databases
101 have been recovered, the node mode will change into NORMAL mode
102 and the databases will be "thawed", allowing samba to access the
104 </p></div><div class="refsect3" title="Recovery master"><a name="id2538138"></a><h4>Recovery master</h4><p>
105 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.
107 Only one node at a time can be the designated recovery master. Which
108 node is designated the recovery master is decided by an election
109 process in the recovery daemons running on each node.
112 </p><p>Example output:</p><pre class="screen">
114 pnn:0 11.1.2.200 OK (THIS NODE)
118 Generation:1362079228
124 Recovery mode:NORMAL (0)
126 </pre></div><div class="refsect2" title="recmaster"><a name="id2538176"></a><h3>recmaster</h3><p>
127 This command shows the pnn of the node which is currently the recmaster.
128 </p></div><div class="refsect2" title="uptime"><a name="id2538184"></a><h3>uptime</h3><p>
129 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.
132 </p><p>Example output:</p><pre class="screen">
133 Current time of node : Thu Oct 29 10:38:54 2009
134 Ctdbd start time : (000 16:54:28) Wed Oct 28 17:44:26 2009
135 Time of last recovery/failover: (000 16:53:31) Wed Oct 28 17:45:23 2009
136 Duration of last recovery/failover: 2.248552 seconds
137 </pre></div><div class="refsect2" title="listnodes"><a name="id2538215"></a><h3>listnodes</h3><p>
138 This command shows lists the ip addresses of all the nodes in the cluster.
140 Example: ctdb listnodes
141 </p><p>Example output:</p><pre class="screen">
146 </pre></div><div class="refsect2" title="ping"><a name="id2538239"></a><h3>ping</h3><p>
147 This command will "ping" all CTDB daemons in the cluster to verify that they are processing commands correctly.
152 </p><pre class="screen">
153 response from 0 time=0.000054 sec (3 clients)
154 response from 1 time=0.000144 sec (2 clients)
155 response from 2 time=0.000105 sec (2 clients)
156 response from 3 time=0.000114 sec (2 clients)
157 </pre></div><div class="refsect2" title="ifaces"><a name="id2538265"></a><h3>ifaces</h3><p>
158 This command will display the list of network interfaces, which could
159 host public addresses, along with their status.
164 </p><pre class="screen">
166 name:eth5 link:up references:2
167 name:eth4 link:down references:0
168 name:eth3 link:up references:1
169 name:eth2 link:up references:1
171 Example: ctdb ifaces -Y
174 </p><pre class="screen">
175 :Name:LinkStatus:References:
180 </pre></div><div class="refsect2" title="setifacelink <iface> <status>"><a name="id2538305"></a><h3>setifacelink <iface> <status></h3><p>
181 This command will set the status of a network interface.
182 The status needs to be "up" or "down". This is typically
183 used in the 10.interfaces script in the "monitor" event.
185 Example: ctdb setifacelink eth0 up
186 </p></div><div class="refsect2" title="ip"><a name="id2538321"></a><h3>ip</h3><p>
187 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".
192 </p><pre class="screen">
194 172.31.91.82 node[1] active[] available[eth2,eth3] configured[eth2,eth3]
195 172.31.91.83 node[0] active[eth3] available[eth2,eth3] configured[eth2,eth3]
196 172.31.91.84 node[1] active[] available[eth2,eth3] configured[eth2,eth3]
197 172.31.91.85 node[0] active[eth2] available[eth2,eth3] configured[eth2,eth3]
198 172.31.92.82 node[1] active[] available[eth5] configured[eth4,eth5]
199 172.31.92.83 node[0] active[eth5] available[eth5] configured[eth4,eth5]
200 172.31.92.84 node[1] active[] available[eth5] configured[eth4,eth5]
201 172.31.92.85 node[0] active[eth5] available[eth5] configured[eth4,eth5]
206 </p><pre class="screen">
207 :Public IP:Node:ActiveInterface:AvailableInterfaces:ConfiguredInterfaces:
208 :172.31.91.82:1::eth2,eth3:eth2,eth3:
209 :172.31.91.83:0:eth3:eth2,eth3:eth2,eth3:
210 :172.31.91.84:1::eth2,eth3:eth2,eth3:
211 :172.31.91.85:0:eth2:eth2,eth3:eth2,eth3:
212 :172.31.92.82:1::eth5:eth4,eth5:
213 :172.31.92.83:0:eth5:eth5:eth4,eth5:
214 :172.31.92.84:1::eth5:eth4,eth5:
215 :172.31.92.85:0:eth5:eth5:eth4,eth5:
216 </pre></div><div class="refsect2" title="ipinfo <ip>"><a name="id2538376"></a><h3>ipinfo <ip></h3><p>
217 This command will display details about the specified public addresses.
219 Example: ctdb ipinfo 172.31.92.85
222 </p><pre class="screen">
223 Public IP[172.31.92.85] info on node 0
227 Interface[1]: Name:eth4 Link:down References:0
228 Interface[2]: Name:eth5 Link:up References:2 (active)
229 </pre></div><div class="refsect2" title="scriptstatus"><a name="id2538403"></a><h3>scriptstatus</h3><p>
230 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.
232 Example: ctdb scriptstatus
235 </p><pre class="screen">
236 7 scripts were executed last monitoring cycle
237 00.ctdb Status:OK Duration:0.056 Tue Mar 24 18:56:57 2009
238 10.interface Status:OK Duration:0.077 Tue Mar 24 18:56:57 2009
239 11.natgw Status:OK Duration:0.039 Tue Mar 24 18:56:57 2009
240 20.multipathd Status:OK Duration:0.038 Tue Mar 24 18:56:57 2009
241 31.clamd Status:DISABLED
242 40.vsftpd Status:OK Duration:0.045 Tue Mar 24 18:56:57 2009
243 41.httpd Status:OK Duration:0.039 Tue Mar 24 18:56:57 2009
244 50.samba Status:ERROR Duration:0.082 Tue Mar 24 18:56:57 2009
245 OUTPUT:ERROR: Samba tcp port 445 is not responding
246 </pre></div><div class="refsect2" title="disablescript <script>"><a name="id2538439"></a><h3>disablescript <script></h3><p>
247 This command is used to disable an eventscript.
249 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'.
250 </p></div><div class="refsect2" title="enablescript <script>"><a name="id2538455"></a><h3>enablescript <script></h3><p>
251 This command is used to enable an eventscript.
253 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'.
254 </p></div><div class="refsect2" title="getvar <name>"><a name="id2538471"></a><h3>getvar <name></h3><p>
255 Get the runtime value of a tuneable variable.
257 Example: ctdb getvar MaxRedirectCount
260 </p><pre class="screen">
262 </pre></div><div class="refsect2" title="setvar <name> <value>"><a name="id2538494"></a><h3>setvar <name> <value></h3><p>
263 Set the runtime value of a tuneable variable.
265 Example: ctdb setvar MaxRedirectCount 5
266 </p></div><div class="refsect2" title="listvars"><a name="id2538509"></a><h3>listvars</h3><p>
267 List all tuneable variables.
269 Example: ctdb listvars
272 </p><pre class="screen">
274 SeqnumInterval = 1000
277 KeepaliveInterval = 5
285 TickleUpdateInterval = 20
286 EventScriptTimeout = 30
287 EventScriptBanCount = 10
288 EventScriptUnhealthyOnTimeout = 0
289 RecoveryGracePeriod = 120
290 RecoveryBanPeriod = 300
291 DatabaseHashSize = 10000
293 RerecoveryTimeout = 10
296 DisableWhenUnhealthy = 0
297 ReclockPingPeriod = 60
299 VerboseMemoryNames = 0
303 RecLockLatencyMs = 1000
304 RecoveryDropAllIPs = 60
305 VerifyRecoveryLock = 1
306 VacuumDefaultInterval = 300
307 VacuumMaxRunTime = 30
310 VacuumMinInterval = 60
311 VacuumMaxInterval = 600
312 MaxQueueDropMsg = 1000
314 AllowUnhealthyDBRead = 0
315 </pre></div><div class="refsect2" title="lvsmaster"><a name="id2538549"></a><h3>lvsmaster</h3><p>
316 This command shows which node is currently the LVSMASTER. The
317 LVSMASTER is the node in the cluster which drives the LVS system and
318 which receives all incoming traffic from clients.
320 LVS is the mode where the entire CTDB/Samba cluster uses a single
321 ip address for the entire cluster. In this mode all clients connect to
322 one specific node which will then multiplex/loadbalance the clients
323 evenly onto the other nodes in the cluster. This is an alternative to using
324 public ip addresses. See the manpage for ctdbd for more information
326 </p></div><div class="refsect2" title="lvs"><a name="id2538571"></a><h3>lvs</h3><p>
327 This command shows which nodes in the cluster are currently active in the
328 LVS configuration. I.e. which nodes we are currently loadbalancing
329 the single ip address across.
331 LVS will by default only loadbalance across those nodes that are both
332 LVS capable and also HEALTHY. Except if all nodes are UNHEALTHY in which
333 case LVS will loadbalance across all UNHEALTHY nodes as well.
334 LVS will never use nodes that are DISCONNECTED, STOPPED, BANNED or
338 </p><pre class="screen">
341 </pre></div><div class="refsect2" title="getcapabilities"><a name="id2538601"></a><h3>getcapabilities</h3><p>
342 This command shows the capabilities of the current node.
343 Please see manpage for ctdbd for a full list of all capabilities and
344 more detailed description.
346 RECMASTER and LMASTER capabilities are primarily used when CTDBD
347 is used to create a cluster spanning across WAN links. In which case
348 ctdbd acts as a WAN accelerator.
350 LVS capabile means that the node is participating in LVS, a mode
351 where the entire CTDB cluster uses one single ip address for the
352 entire cluster instead of using public ip address failover.
353 This is an alternative to using a loadbalancing layer-4 switch.
356 </p><pre class="screen">
360 </pre></div><div class="refsect2" title="statistics"><a name="id2538638"></a><h3>statistics</h3><p>
361 Collect statistics from the CTDB daemon about how many calls it has served.
363 Example: ctdb statistics
366 </p><pre class="screen">
371 client_packets_sent 360489
372 client_packets_recv 360466
373 node_packets_sent 480931
374 node_packets_recv 240120
375 keepalive_packets_sent 4
376 keepalive_packets_recv 3
397 pending_lockwait_calls 0
400 max_call_latency 4.948321 sec
401 max_lockwait_latency 0.000000 sec
402 </pre></div><div class="refsect2" title="statisticsreset"><a name="id2538681"></a><h3>statisticsreset</h3><p>
403 This command is used to clear all statistics counters in a node.
405 Example: ctdb statisticsreset
406 </p></div><div class="refsect2" title="getreclock"><a name="id2538695"></a><h3>getreclock</h3><p>
407 This command is used to show the filename of the reclock file that is used.
410 </p><pre class="screen">
411 Reclock file:/gpfs/.ctdb/shared
412 </pre></div><div class="refsect2" title="setreclock [filename]"><a name="id2538715"></a><h3>setreclock [filename]</h3><p>
413 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".
415 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.
417 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.
418 </p></div><div class="refsect2" title="getdebug"><a name="id2538742"></a><h3>getdebug</h3><p>
419 Get the current debug level for the node. the debug level controls what information is written to the log file.
421 The debug levels are mapped to the corresponding syslog levels.
422 When a debug level is set, only those messages at that level and higher
423 levels will be printed.
425 The list of debug levels from highest to lowest are :
427 EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
428 </p></div><div class="refsect2" title="setdebug <debuglevel>"><a name="id2538767"></a><h3>setdebug <debuglevel></h3><p>
429 Set the debug level of a node. This controls what information will be logged.
431 The debuglevel is one of EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
432 </p></div><div class="refsect2" title="getpid"><a name="id2538783"></a><h3>getpid</h3><p>
433 This command will return the process id of the ctdb daemon.
434 </p></div><div class="refsect2" title="disable"><a name="id2538793"></a><h3>disable</h3><p>
435 This command is used to administratively disable a node in the cluster.
436 A disabled node will still participate in the cluster and host
437 clustered TDB records but its public ip address has been taken over by
438 a different node and it no longer hosts any services.
439 </p></div><div class="refsect2" title="enable"><a name="id2538807"></a><h3>enable</h3><p>
440 Re-enable a node that has been administratively disabled.
441 </p></div><div class="refsect2" title="stop"><a name="id2538817"></a><h3>stop</h3><p>
442 This command is used to administratively STOP a node in the cluster.
443 A STOPPED node is connected to the cluster but will not host any
444 public ip addresse, nor does it participate in the VNNMAP.
445 The difference between a DISABLED node and a STOPPED node is that
446 a STOPPED node does not host any parts of the database which means
447 that a recovery is required to stop/continue nodes.
448 </p></div><div class="refsect2" title="continue"><a name="id2538833"></a><h3>continue</h3><p>
449 Re-start a node that has been administratively stopped.
450 </p></div><div class="refsect2" title="addip <public_ip/mask> <iface>"><a name="id2538843"></a><h3>addip <public_ip/mask> <iface></h3><p>
451 This command is used to add a new public ip to a node during runtime.
452 This allows public addresses to be added to a cluster without having
453 to restart the ctdb daemons.
455 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.
456 If you want this change to be permanent you must also update the public addresses file manually.
457 </p></div><div class="refsect2" title="delip <public_ip>"><a name="id2538863"></a><h3>delip <public_ip></h3><p>
458 This command is used to remove a public ip from a node during runtime.
459 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.
461 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.
462 If you want this change to be permanent you must also update the public addresses file manually.
463 </p></div><div class="refsect2" title="moveip <public_ip> <node>"><a name="id2538884"></a><h3>moveip <public_ip> <node></h3><p>
464 This command can be used to manually fail a public ip address to a
467 In order to manually override the "automatic" distribution of public
468 ip addresses that ctdb normally provides, this command only works
469 when you have changed the tunables for the daemon to:
474 </p></div><div class="refsect2" title="shutdown"><a name="id2538909"></a><h3>shutdown</h3><p>
475 This command will shutdown a specific CTDB daemon.
476 </p></div><div class="refsect2" title="recover"><a name="id2538919"></a><h3>recover</h3><p>
477 This command will trigger the recovery daemon to do a cluster
479 </p></div><div class="refsect2" title="ipreallocate"><a name="id2538929"></a><h3>ipreallocate</h3><p>
480 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.
481 </p></div><div class="refsect2" title="setlmasterrole <on|off>"><a name="id2538945"></a><h3>setlmasterrole <on|off></h3><p>
482 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.
484 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.
486 Once this setting has been enabled/disabled, you need to perform a recovery for it to take effect.
488 See also "ctdb getcapabilities"
489 </p></div><div class="refsect2" title="setrecmasterrole <on|off>"><a name="id2538974"></a><h3>setrecmasterrole <on|off></h3><p>
490 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.
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.
494 See also "ctdb getcapabilities"
495 </p></div><div class="refsect2" title="killtcp <srcip:port> <dstip:port>"><a name="id2539000"></a><h3>killtcp <srcip:port> <dstip:port></h3><p>
496 This command will kill the specified TCP connection by issuing a
497 TCP RST to the srcip:port endpoint. This is a command used by the
499 </p></div><div class="refsect2" title="gratiousarp <ip> <interface>"><a name="id2539013"></a><h3>gratiousarp <ip> <interface></h3><p>
500 This command will send out a gratious arp for the specified interface
501 through the specified interface. This command is mainly used by the
503 </p></div><div class="refsect2" title="reloadnodes"><a name="id2539025"></a><h3>reloadnodes</h3><p>
504 This command is used when adding new nodes, or removing existing nodes from an existing cluster.
506 Procedure to add a node:
508 1, To expand an existing cluster, first ensure with 'ctdb status' that
509 all nodes are up and running and that they are all healthy.
510 Do not try to expand a cluster unless it is completely healthy!
512 2, On all nodes, edit /etc/ctdb/nodes and add the new node as the last
513 entry to the file. The new node MUST be added to the end of this file!
515 3, Verify that all the nodes have identical /etc/ctdb/nodes files after you edited them and added the new node!
517 4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
519 5, Use 'ctdb status' on all nodes and verify that they now show the additional node.
521 6, Install and configure the new node and bring it online.
523 Procedure to remove a node:
525 1, To remove a node from an existing cluster, first ensure with 'ctdb status' that
526 all nodes, except the node to be deleted, are up and running and that they are all healthy.
527 Do not try to remove a node from a cluster unless the cluster is completely healthy!
529 2, Shutdown and poerwoff the node to be removed.
531 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.
533 4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
535 5, Use 'ctdb status' on all nodes and verify that the deleted node no longer shows up in the list..
537 </p></div><div class="refsect2" title="tickle <srcip:port> <dstip:port>"><a name="id2539109"></a><h3>tickle <srcip:port> <dstip:port></h3><p>
538 This command will will send a TCP tickle to the source host for the
539 specified TCP connection.
540 A TCP tickle is a TCP ACK packet with an invalid sequence and
541 acknowledge number and will when received by the source host result
542 in it sending an immediate correct ACK back to the other end.
544 TCP tickles are useful to "tickle" clients after a IP failover has
545 occured since this will make the client immediately recognize the
546 TCP connection has been disrupted and that the client will need
547 to reestablish. This greatly speeds up the time it takes for a client
548 to detect and reestablish after an IP failover in the ctdb cluster.
549 </p></div><div class="refsect2" title="gettickles <ip>"><a name="id2539134"></a><h3>gettickles <ip></h3><p>
550 This command is used to show which TCP connections are registered with
551 CTDB to be "tickled" if there is a failover.
552 </p></div><div class="refsect2" title="repack [max_freelist]"><a name="id2539145"></a><h3>repack [max_freelist]</h3><p>
553 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.
554 This command is used to defragment a TDB database and pruning the freelist.
556 If [max_freelist] is specified, then a database will only be repacked if it has more than this number of entries in the freelist.
558 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.
560 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.
562 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.
564 Example: ctdb repack 1000
566 By default, this operation is issued from the 00.ctdb event script every 5 minutes.
567 </p></div><div class="refsect2" title="vacuum [max_records]"><a name="id2483662"></a><h3>vacuum [max_records]</h3><p>
568 Over time CTDB databases will fill up with empty deleted records which will lead to a progressive slow down of CTDB database access.
569 This command is used to prune all databases and delete all empty records from the cluster.
571 By default, vacuum will delete all empty records from all databases.
572 If [max_records] is specified, the command will only delete the first
573 [max_records] empty records for each database.
575 Vacuum only deletes records where the local node is the lmaster.
576 To delete all records from the entire cluster you need to run a vacuum from each node.
578 This command is not disruptive. Samba is unaffected and will still be able to read/write records normally while the database is being vacuumed.
582 By default, this operation is issued from the 00.ctdb event script every 5 minutes.
583 </p></div><div class="refsect2" title="backupdb <dbname> <file>"><a name="id2483698"></a><h3>backupdb <dbname> <file></h3><p>
584 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.
585 This is mainly useful for backing up persistent databases such as secrets.tdb and similar.
586 </p></div><div class="refsect2" title="restoredb <file> [dbname]"><a name="id2483712"></a><h3>restoredb <file> [dbname]</h3><p>
587 This command restores a persistent database that was previously backed up using backupdb.
588 By default the data will be restored back into the same database as
589 it was created from. By specifying dbname you can restore the data
590 into a different database.
591 </p></div><div class="refsect2" title="wipedb <dbname>"><a name="id2483726"></a><h3>wipedb <dbname></h3><p>
592 This command can be used to remove all content of a database.
593 </p></div></div><div class="refsect2" title="getlog <level>"><a name="id2483738"></a><h3>getlog <level></h3><p>
594 In addition to the normal loggign to a log file,
595 CTDBD also keeps a in-memory ringbuffer containing the most recent
596 log entries for all log levels (except DEBUG).
598 This is useful since it allows for keeping continous logs to a file
599 at a reasonable non-verbose level, but shortly after an incident has
600 occured, a much more detailed log can be pulled from memory. This
601 can allow you to avoid having to reproduce an issue due to the
602 on-disk logs being of insufficient detail.
604 This command extracts all messages of level or lower log level from
605 memory and prints it to the screen.
606 </p></div><div class="refsect2" title="clearlog"><a name="id2483761"></a><h3>clearlog</h3><p>
607 This command clears the in-memory logging ringbuffer.
608 </p></div><div class="refsect1" title="Debugging Commands"><a name="id2483771"></a><h2>Debugging Commands</h2><p>
609 These commands are primarily used for CTDB development and testing and
610 should not be used for normal administration.
611 </p><div class="refsect2" title="process-exists <pid>"><a name="id2483782"></a><h3>process-exists <pid></h3><p>
612 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.
613 </p></div><div class="refsect2" title="getdbmap"><a name="id2483794"></a><h3>getdbmap</h3><p>
614 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.
616 If a PERSISTENT database is not in a healthy state the database is
617 flagged as UNHEALTHY. If there's at least one completely healthy node running in
618 the cluster, it's possible that the content is restored by a recovery
619 run automaticly. Otherwise an administrator needs to analyze the
622 See also "ctdb getdbstatus", "ctdb backupdb", "ctdb restoredb",
623 "ctdb dumpbackup", "ctdb wipedb", "ctdb setvar AllowUnhealthyDBRead 1"
624 and (if samba or tdb-utils are installed) "tdbtool check".
626 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.
628 Example: ctdb getdbmap
631 </p><pre class="screen">
632 Number of databases:10
633 dbid:0x435d3410 name:notify.tdb path:/var/ctdb/notify.tdb.0
634 dbid:0x42fe72c5 name:locking.tdb path:/var/ctdb/locking.tdb.0
635 dbid:0x1421fb78 name:brlock.tdb path:/var/ctdb/brlock.tdb.0
636 dbid:0x17055d90 name:connections.tdb path:/var/ctdb/connections.tdb.0
637 dbid:0xc0bdde6a name:sessionid.tdb path:/var/ctdb/sessionid.tdb.0
638 dbid:0x122224da name:test.tdb path:/var/ctdb/test.tdb.0
639 dbid:0x2672a57f name:idmap2.tdb path:/var/ctdb/persistent/idmap2.tdb.0 PERSISTENT
640 dbid:0xb775fff6 name:secrets.tdb path:/var/ctdb/persistent/secrets.tdb.0 PERSISTENT
641 dbid:0xe98e08b6 name:group_mapping.tdb path:/var/ctdb/persistent/group_mapping.tdb.0 PERSISTENT
642 dbid:0x7bbbd26c name:passdb.tdb path:/var/ctdb/persistent/passdb.tdb.0 PERSISTENT
644 Example output for an unhealthy database:
645 </p><pre class="screen">
646 Number of databases:1
647 dbid:0xb775fff6 name:secrets.tdb path:/var/ctdb/persistent/secrets.tdb.0 PERSISTENT UNHEALTHY
649 Example output for a healthy database as machinereadable output -Y:
650 </p><pre class="screen">
651 :ID:Name:Path:Persistent:Unhealthy:
652 :0x7bbbd26c:passdb.tdb:/var/ctdb/persistent/passdb.tdb.0:1:0:
653 </pre></div><div class="refsect2" title="getdbstatus <dbname>"><a name="id2483879"></a><h3>getdbstatus <dbname></h3><p>
654 This command displays more details about a database.
656 Example: ctdb getdbstatus test.tdb.0
659 </p><pre class="screen">
662 path: /var/ctdb/test.tdb.0
666 Example: ctdb getdbstatus registry.tdb (with a corrupted TDB)
669 </p><pre class="screen">
672 path: /var/ctdb/persistent/registry.tdb.0
674 HEALTH: NO-HEALTHY-NODES - ERROR - Backup of corrupted TDB in '/var/ctdb/persistent/registry.tdb.0.corrupted.20091208091949.0Z'
675 </pre></div><div class="refsect2" title="catdb <dbname>"><a name="id2483921"></a><h3>catdb <dbname></h3><p>
676 This command will dump a clustered TDB database to the screen. This is a debugging command.
677 </p></div><div class="refsect2" title="dumpdbbackup <backup-file>"><a name="id2483932"></a><h3>dumpdbbackup <backup-file></h3><p>
678 This command will dump the content of database backup to the screen
679 (similar to ctdb catdb). This is a debugging command.
680 </p></div><div class="refsect2" title="getmonmode"><a name="id2483944"></a><h3>getmonmode</h3><p>
681 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.
683 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.
685 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.
686 </p></div><div class="refsect2" title="setmonmode <0|1>"><a name="id2483974"></a><h3>setmonmode <0|1></h3><p>
687 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.
688 </p></div><div class="refsect2" title="attach <dbname>"><a name="id2483997"></a><h3>attach <dbname></h3><p>
689 This is a debugging command. This command will make the CTDB daemon create a new CTDB database and attach to it.
690 </p></div><div class="refsect2" title="dumpmemory"><a name="id2484008"></a><h3>dumpmemory</h3><p>
691 This is a debugging command. This command will make the ctdb
692 daemon to write a fill memory allocation map to standard output.
693 </p></div><div class="refsect2" title="rddumpmemory"><a name="id2484019"></a><h3>rddumpmemory</h3><p>
694 This is a debugging command. This command will dump the talloc memory
695 allocation tree for the recovery daemon to standard output.
696 </p></div><div class="refsect2" title="freeze"><a name="id2484031"></a><h3>freeze</h3><p>
697 This command will lock all the local TDB databases causing clients
698 that are accessing these TDBs such as samba3 to block until the
699 databases are thawed.
701 This is primarily used by the recovery daemon to stop all samba
702 daemons from accessing any databases while the database is recovered
704 </p></div><div class="refsect2" title="thaw"><a name="id2484049"></a><h3>thaw</h3><p>
705 Thaw a previously frozen node.
706 </p></div><div class="refsect2" title="eventscript <arguments>"><a name="id2484059"></a><h3>eventscript <arguments></h3><p>
707 This is a debugging command. This command can be used to manually
708 invoke and run the eventscritps with arbitrary arguments.
709 </p></div><div class="refsect2" title="ban <bantime|0>"><a name="id2484070"></a><h3>ban <bantime|0></h3><p>
710 Administratively ban a node for bantime seconds. A bantime of 0 means that the node should be permanently banned.
712 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.
714 Nodes are automatically banned if they are the cause of too many
716 </p></div><div class="refsect2" title="unban"><a name="id2484094"></a><h3>unban</h3><p>
717 This command is used to unban a node that has either been
718 administratively banned using the ban command or has been automatically
719 banned by the recovery daemon.
720 </p></div></div><div class="refsect1" title="SEE ALSO"><a name="id2484107"></a><h2>SEE ALSO</h2><p>
722 <a class="ulink" href="http://ctdb.samba.org/" target="_top">http://ctdb.samba.org/</a>
723 </p></div><div class="refsect1" title="COPYRIGHT/LICENSE"><a name="id2484121"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
724 Copyright (C) Andrew Tridgell 2007<br>
725 Copyright (C) Ronnie sahlberg 2007<br>
727 This program is free software; you can redistribute it and/or modify<br>
728 it under the terms of the GNU General Public License as published by<br>
729 the Free Software Foundation; either version 3 of the License, or (at<br>
730 your option) any later version.<br>
732 This program is distributed in the hope that it will be useful, but<br>
733 WITHOUT ANY WARRANTY; without even the implied warranty of<br>
734 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU<br>
735 General Public License for more details.<br>
737 You should have received a copy of the GNU General Public License<br>
738 along with this program; if not, see http://www.gnu.org/licenses/.<br>
739 </p></div></div></div></body></html>