1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
6 <refentrytitle>ctdb</refentrytitle>
7 <manvolnum>1</manvolnum>
8 <refmiscinfo class="source">ctdb</refmiscinfo>
9 <refmiscinfo class="manual">CTDB - clustered TDB database</refmiscinfo>
14 <refname>ctdb</refname>
15 <refpurpose>clustered tdb database management utility</refpurpose>
20 <command>ctdb [ OPTIONS ] COMMAND ...</command>
24 <command>ctdb</command>
25 <arg choice="opt">-n <node></arg>
26 <arg choice="opt">-Y</arg>
27 <arg choice="opt">-t <timeout></arg>
28 <arg choice="opt">-T <timelimit></arg>
29 <arg choice="opt">-? --help</arg>
30 <arg choice="opt">--usage</arg>
31 <arg choice="opt">-d --debug=<INTEGER></arg>
32 <arg choice="opt">--socket=<filename></arg>
33 <arg choice="opt">--print-emptyrecords</arg>
34 <arg choice="opt">--print-datasize</arg>
35 <arg choice="opt">--print-lmaster</arg>
36 <arg choice="opt">--print-hash</arg>
37 <arg choice="opt">--print-recordflags</arg>
42 <refsect1><title>DESCRIPTION</title>
44 ctdb is a utility to view and manage a ctdb cluster.
50 <title>OPTIONS</title>
53 <varlistentry><term>-n <pnn></term>
56 This specifies the physical node number on which to execute the
57 command. Default is to run the command on the daemon running on
61 The physical node number is an integer that describes the node in the
62 cluster. The first node has physical node number 0.
67 <varlistentry><term>-Y</term>
70 Produce output in machine readable form for easier parsing by scripts. Not all commands support this option.
75 <varlistentry><term>-t <timeout></term>
78 How long should ctdb wait for the local ctdb daemon to respond to a command before timing out. Default is 3 seconds.
83 <varlistentry><term>-T <timelimit></term>
86 A limit on how long the ctdb command will run for before it will
87 be aborted. When this timelimit has been exceeded the ctdb command will
93 <varlistentry><term>-? --help</term>
96 Print some help text to the screen.
101 <varlistentry><term>--usage</term>
104 Print useage information to the screen.
109 <varlistentry><term>-d --debug=<debuglevel></term>
112 Change the debug level for the command. Default is 0.
117 <varlistentry><term>--socket=<filename></term>
120 Specify the socketname to use when connecting to the local ctdb
121 daemon. The default is /tmp/ctdb.socket .
124 You only need to specify this parameter if you run multiple ctdb
125 daemons on the same physical host and thus can not use the default
126 name for the domain socket.
131 <varlistentry><term>--print-emptyrecords</term>
134 This enables printing of empty records when dumping databases
135 with the catdb, cattbd and dumpdbbackup commands. Records with
136 empty data segment are considered deleted by ctdb and cleaned
137 by the vacuuming mechanism, so this switch can come in handy for
138 debugging the vacuuming behaviour.
143 <varlistentry><term>--print-datasize</term>
146 This lets database dumps (catdb, cattdb, dumpdbbackup) print the
147 size of the record data instead of dumping the data contents.
152 <varlistentry><term>--print-lmaster</term>
155 This lets catdb print the lmaster for each record.
160 <varlistentry><term>--print-hash</term>
163 This lets database dumps (catdb, cattdb, dumpdbbackup) print the
164 hash for each record.
169 <varlistentry><term>--print-recordflags</term>
172 This lets catdb and dumpdbbackup print the
173 record flags for each record. Note that cattdb always
183 <refsect1><title>Administrative Commands</title>
185 These are commands used to monitor and administrate a CTDB cluster.
188 <refsect2><title>pnn</title>
190 This command displays the pnn of the current node.
194 <refsect2><title>status</title>
196 This command shows the current status of the ctdb node.
199 <refsect3><title>node status</title>
201 Node status reflects the current status of the node. There are five possible states:
204 OK - This node is fully functional.
207 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.
210 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.
213 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.
216 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.
219 STOPPED - A node that is stopped does not host any public ip addresses,
220 nor is it part of the VNNMAP. A stopped node can not become LVSMASTER,
222 This node does not perticipate in the CTDB cluster but can still be
223 communicated with. I.e. ctdb commands can be sent to it.
226 PARTIALLYONLINE - A node that is partially online participates
227 in a cluster like a node that is ok. Some interfaces to serve
228 public ip addresses are down, but at least one interface is up.
229 See also "ctdb ifaces".
233 <refsect3><title>generation</title>
235 The generation id is a number that indicates the current generation
236 of a cluster instance. Each time a cluster goes through a
237 reconfiguration or a recovery its generation id will be changed.
240 This number does not have any particular meaning other than to keep
241 track of when a cluster has gone through a recovery. It is a random
242 number that represents the current instance of a ctdb cluster
244 CTDBD uses this number internally to be able to tell when commands
245 to operate on the cluster and the databases was issued in a different
246 generation of the cluster, to ensure that commands that operate
247 on the databases will not survive across a cluster database recovery.
248 After a recovery, all old outstanding commands will automatically
252 Sometimes this number will be shown as "INVALID". This only means that
253 the ctdbd daemon has started but it has not yet merged with the cluster through a recovery.
254 All nodes start with generation "INVALID" and are not assigned a real
255 generation id until they have successfully been merged with a cluster
260 <refsect3><title>VNNMAP</title>
262 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.
263 Only nodes that are participating in the vnnmap can become lmaster or dmaster for a database record.
267 <refsect3><title>Recovery mode</title>
269 This is the current recovery mode of the cluster. There are two possible modes:
272 NORMAL - The cluster is fully operational.
275 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.
278 Once the recovery master detects an inconsistency, for example a node
279 becomes disconnected/connected, the recovery daemon will trigger a
280 cluster recovery process, where all databases are remerged across the
281 cluster. When this process starts, the recovery master will first
282 "freeze" all databases to prevent applications such as samba from
283 accessing the databases and it will also mark the recovery mode as
287 When CTDBD starts up, it will start in RECOVERY mode.
288 Once the node has been merged into a cluster and all databases
289 have been recovered, the node mode will change into NORMAL mode
290 and the databases will be "thawed", allowing samba to access the
295 <refsect3><title>Recovery master</title>
297 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.
300 Only one node at a time can be the designated recovery master. Which
301 node is designated the recovery master is decided by an election
302 process in the recovery daemons running on each node.
309 <para>Example output:</para>
310 <screen format="linespecific">
312 pnn:0 11.1.2.200 OK (THIS NODE)
316 Generation:1362079228
322 Recovery mode:NORMAL (0)
327 <refsect2><title>recmaster</title>
329 This command shows the pnn of the node which is currently the recmaster.
333 <refsect2><title>uptime</title>
335 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.
341 <para>Example output:</para>
342 <screen format="linespecific">
343 Current time of node : Thu Oct 29 10:38:54 2009
344 Ctdbd start time : (000 16:54:28) Wed Oct 28 17:44:26 2009
345 Time of last recovery/failover: (000 16:53:31) Wed Oct 28 17:45:23 2009
346 Duration of last recovery/failover: 2.248552 seconds
350 <refsect2><title>listnodes</title>
352 This command shows lists the ip addresses of all the nodes in the cluster.
356 Example: ctdb listnodes
358 <para>Example output:</para>
359 <screen format="linespecific">
367 <refsect2><title>ping</title>
369 This command will "ping" all CTDB daemons in the cluster to verify that they are processing commands correctly.
377 <screen format="linespecific">
378 response from 0 time=0.000054 sec (3 clients)
379 response from 1 time=0.000144 sec (2 clients)
380 response from 2 time=0.000105 sec (2 clients)
381 response from 3 time=0.000114 sec (2 clients)
385 <refsect2><title>runstate [setup|first_recovery|startup|running]</title>
387 Print the runstate of the specified node. Runstates are used
388 to serialise important state transitions in CTDB, particularly
392 If one or more optional runstate arguments are specified then
393 the node must be in one of these runstates for the command to
397 Example: ctdb runstate
402 <screen format="linespecific">
407 <refsect2><title>ifaces</title>
409 This command will display the list of network interfaces, which could
410 host public addresses, along with their status.
418 <screen format="linespecific">
420 name:eth5 link:up references:2
421 name:eth4 link:down references:0
422 name:eth3 link:up references:1
423 name:eth2 link:up references:1
426 Example: ctdb ifaces -Y
431 <screen format="linespecific">
432 :Name:LinkStatus:References:
440 <refsect2><title>setifacelink <iface> <status></title>
442 This command will set the status of a network interface.
443 The status needs to be "up" or "down". This is typically
444 used in the 10.interfaces script in the "monitor" event.
447 Example: ctdb setifacelink eth0 up
451 <refsect2><title>ip</title>
453 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".
461 <screen format="linespecific">
463 172.31.91.82 node[1] active[] available[eth2,eth3] configured[eth2,eth3]
464 172.31.91.83 node[0] active[eth3] available[eth2,eth3] configured[eth2,eth3]
465 172.31.91.84 node[1] active[] available[eth2,eth3] configured[eth2,eth3]
466 172.31.91.85 node[0] active[eth2] available[eth2,eth3] configured[eth2,eth3]
467 172.31.92.82 node[1] active[] available[eth5] configured[eth4,eth5]
468 172.31.92.83 node[0] active[eth5] available[eth5] configured[eth4,eth5]
469 172.31.92.84 node[1] active[] available[eth5] configured[eth4,eth5]
470 172.31.92.85 node[0] active[eth5] available[eth5] configured[eth4,eth5]
478 <screen format="linespecific">
479 :Public IP:Node:ActiveInterface:AvailableInterfaces:ConfiguredInterfaces:
480 :172.31.91.82:1::eth2,eth3:eth2,eth3:
481 :172.31.91.83:0:eth3:eth2,eth3:eth2,eth3:
482 :172.31.91.84:1::eth2,eth3:eth2,eth3:
483 :172.31.91.85:0:eth2:eth2,eth3:eth2,eth3:
484 :172.31.92.82:1::eth5:eth4,eth5:
485 :172.31.92.83:0:eth5:eth5:eth4,eth5:
486 :172.31.92.84:1::eth5:eth4,eth5:
487 :172.31.92.85:0:eth5:eth5:eth4,eth5:
491 <refsect2><title>ipinfo <ip></title>
493 This command will display details about the specified public addresses.
496 Example: ctdb ipinfo 172.31.92.85
501 <screen format="linespecific">
502 Public IP[172.31.92.85] info on node 0
506 Interface[1]: Name:eth4 Link:down References:0
507 Interface[2]: Name:eth5 Link:up References:2 (active)
511 <refsect2><title>scriptstatus</title>
513 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.
516 Example: ctdb scriptstatus
521 <screen format="linespecific">
522 7 scripts were executed last monitoring cycle
523 00.ctdb Status:OK Duration:0.056 Tue Mar 24 18:56:57 2009
524 10.interface Status:OK Duration:0.077 Tue Mar 24 18:56:57 2009
525 11.natgw Status:OK Duration:0.039 Tue Mar 24 18:56:57 2009
526 20.multipathd Status:OK Duration:0.038 Tue Mar 24 18:56:57 2009
527 31.clamd Status:DISABLED
528 40.vsftpd Status:OK Duration:0.045 Tue Mar 24 18:56:57 2009
529 41.httpd Status:OK Duration:0.039 Tue Mar 24 18:56:57 2009
530 50.samba Status:ERROR Duration:0.082 Tue Mar 24 18:56:57 2009
531 OUTPUT:ERROR: Samba tcp port 445 is not responding
535 <refsect2><title>disablescript <script></title>
537 This command is used to disable an eventscript.
540 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'.
544 <refsect2><title>enablescript <script></title>
546 This command is used to enable an eventscript.
549 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'.
553 <refsect2><title>getvar <name></title>
555 Get the runtime value of a tuneable variable.
558 Example: ctdb getvar MaxRedirectCount
563 <screen format="linespecific">
568 <refsect2><title>setvar <name> <value></title>
570 Set the runtime value of a tuneable variable.
573 Example: ctdb setvar MaxRedirectCount 5
577 <refsect2><title>listvars</title>
579 List all tuneable variables, except the values of the obsolete tunables
580 like VacuumMinInterval. The obsolete tunables can be retrieved only
581 explicitly with the "ctdb getvar" command.
584 Example: ctdb listvars
589 <screen format="linespecific">
591 SeqnumInterval = 1000
594 KeepaliveInterval = 5
601 TickleUpdateInterval = 20
602 EventScriptTimeout = 30
603 EventScriptTimeoutCount = 1
604 RecoveryGracePeriod = 120
605 RecoveryBanPeriod = 300
606 DatabaseHashSize = 100001
608 RerecoveryTimeout = 10
612 ReclockPingPeriod = 60
614 DisableIPFailover = 0
615 VerboseMemoryNames = 0
619 RecLockLatencyMs = 1000
620 RecoveryDropAllIPs = 120
621 VerifyRecoveryLock = 1
623 VacuumMaxRunTime = 30
626 VacuumFastPathCount = 60
627 MaxQueueDropMsg = 1000000
629 AllowUnhealthyDBRead = 0
630 StatHistoryInterval = 1
631 DeferredAttachTO = 120
632 AllowClientDBAttach = 1
633 RecoverPDBBySeqNum = 0
637 <refsect2><title>lvsmaster</title>
639 This command shows which node is currently the LVSMASTER. The
640 LVSMASTER is the node in the cluster which drives the LVS system and
641 which receives all incoming traffic from clients.
644 LVS is the mode where the entire CTDB/Samba cluster uses a single
645 ip address for the entire cluster. In this mode all clients connect to
646 one specific node which will then multiplex/loadbalance the clients
647 evenly onto the other nodes in the cluster. This is an alternative to using
648 public ip addresses. See the manpage for ctdbd for more information
653 <refsect2><title>lvs</title>
655 This command shows which nodes in the cluster are currently active in the
656 LVS configuration. I.e. which nodes we are currently loadbalancing
657 the single ip address across.
661 LVS will by default only loadbalance across those nodes that are both
662 LVS capable and also HEALTHY. Except if all nodes are UNHEALTHY in which
663 case LVS will loadbalance across all UNHEALTHY nodes as well.
664 LVS will never use nodes that are DISCONNECTED, STOPPED, BANNED or
671 <screen format="linespecific">
679 <refsect2><title>getcapabilities</title>
681 This command shows the capabilities of the current node.
682 Please see manpage for ctdbd for a full list of all capabilities and
683 more detailed description.
687 RECMASTER and LMASTER capabilities are primarily used when CTDBD
688 is used to create a cluster spanning across WAN links. In which case
689 ctdbd acts as a WAN accelerator.
693 LVS capabile means that the node is participating in LVS, a mode
694 where the entire CTDB cluster uses one single ip address for the
695 entire cluster instead of using public ip address failover.
696 This is an alternative to using a loadbalancing layer-4 switch.
702 <screen format="linespecific">
710 <refsect2><title>statistics</title>
712 Collect statistics from the CTDB daemon about how many calls it has served.
715 Example: ctdb statistics
720 <screen format="linespecific">
725 client_packets_sent 360489
726 client_packets_recv 360466
727 node_packets_sent 480931
728 node_packets_recv 240120
729 keepalive_packets_sent 4
730 keepalive_packets_recv 3
751 pending_lockwait_calls 0
754 max_call_latency 4.948321 sec
755 max_lockwait_latency 0.000000 sec
759 <refsect2><title>statisticsreset</title>
761 This command is used to clear all statistics counters in a node.
764 Example: ctdb statisticsreset
768 <refsect2><title>getreclock</title>
770 This command is used to show the filename of the reclock file that is used.
776 <screen format="linespecific">
777 Reclock file:/gpfs/.ctdb/shared
782 <refsect2><title>setreclock [filename]</title>
784 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".
788 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.
792 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.
798 <refsect2><title>getdebug</title>
800 Get the current debug level for the node. the debug level controls what information is written to the log file.
803 The debug levels are mapped to the corresponding syslog levels.
804 When a debug level is set, only those messages at that level and higher
805 levels will be printed.
808 The list of debug levels from highest to lowest are :
811 EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
815 <refsect2><title>setdebug <debuglevel></title>
817 Set the debug level of a node. This controls what information will be logged.
820 The debuglevel is one of EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
824 <refsect2><title>getpid</title>
826 This command will return the process id of the ctdb daemon.
830 <refsect2><title>disable</title>
832 This command is used to administratively disable a node in the cluster.
833 A disabled node will still participate in the cluster and host
834 clustered TDB records but its public ip address has been taken over by
835 a different node and it no longer hosts any services.
839 <refsect2><title>enable</title>
841 Re-enable a node that has been administratively disabled.
845 <refsect2><title>stop</title>
847 This command is used to administratively STOP a node in the cluster.
848 A STOPPED node is connected to the cluster but will not host any
849 public ip addresse, nor does it participate in the VNNMAP.
850 The difference between a DISABLED node and a STOPPED node is that
851 a STOPPED node does not host any parts of the database which means
852 that a recovery is required to stop/continue nodes.
856 <refsect2><title>continue</title>
858 Re-start a node that has been administratively stopped.
862 <refsect2><title>addip <public_ip/mask> <iface></title>
864 This command is used to add a new public ip to a node during runtime.
865 This allows public addresses to be added to a cluster without having
866 to restart the ctdb daemons.
869 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.
870 If you want this change to be permanent you must also update the public addresses file manually.
874 <refsect2><title>delip <public_ip></title>
876 This command is used to remove a public ip from a node during runtime.
877 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.
880 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.
881 If you want this change to be permanent you must also update the public addresses file manually.
885 <refsect2><title>moveip <public_ip> <node></title>
887 This command can be used to manually fail a public ip address to a
891 In order to manually override the "automatic" distribution of public
892 ip addresses that ctdb normally provides, this command only works
893 when you have changed the tunables for the daemon to:
903 <refsect2><title>shutdown</title>
905 This command will shutdown a specific CTDB daemon.
909 <refsect2><title>recover</title>
911 This command will trigger the recovery daemon to do a cluster
916 <refsect2><title>ipreallocate</title>
918 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.
922 <refsect2><title>setlmasterrole <on|off></title>
924 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.
928 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.
931 Once this setting has been enabled/disabled, you need to perform a recovery for it to take effect.
934 See also "ctdb getcapabilities"
938 <refsect2><title>setrecmasterrole <on|off></title>
940 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.
944 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.
947 See also "ctdb getcapabilities"
951 <refsect2><title>killtcp <srcip:port> <dstip:port></title>
953 This command will kill the specified TCP connection by issuing a
954 TCP RST to the srcip:port endpoint. This is a command used by the
959 <refsect2><title>gratiousarp <ip> <interface></title>
961 This command will send out a gratious arp for the specified interface
962 through the specified interface. This command is mainly used by the
967 <refsect2><title>reloadnodes</title>
969 This command is used when adding new nodes, or removing existing nodes from an existing cluster.
972 Procedure to add a node:
975 1, To expand an existing cluster, first ensure with 'ctdb status' that
976 all nodes are up and running and that they are all healthy.
977 Do not try to expand a cluster unless it is completely healthy!
980 2, On all nodes, edit /etc/ctdb/nodes and add the new node as the last
981 entry to the file. The new node MUST be added to the end of this file!
984 3, Verify that all the nodes have identical /etc/ctdb/nodes files after you edited them and added the new node!
987 4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
990 5, Use 'ctdb status' on all nodes and verify that they now show the additional node.
993 6, Install and configure the new node and bring it online.
996 Procedure to remove a node:
999 1, To remove a node from an existing cluster, first ensure with 'ctdb status' that
1000 all nodes, except the node to be deleted, are up and running and that they are all healthy.
1001 Do not try to remove a node from a cluster unless the cluster is completely healthy!
1004 2, Shutdown and poweroff the node to be removed.
1007 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.
1010 4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
1013 5, Use 'ctdb status' on all nodes and verify that the deleted node no longer shows up in the list..
1020 <refsect2><title>reloadips</title>
1022 This command is used to reload the public addresses file and update the
1023 ip configuration of the running daemon.
1026 Procedure to update the public address configuration on a single node:
1029 1, Update the /etc/ctdb/public_addresses file on the node
1032 2, Run 'ctdb reloadips' on the node.
1035 The file will then be reloaded on the node and addresses will be added
1036 or removed as required to match the newly loaded file. When updating
1037 a single node it may take a little while before any newly added
1038 addresses are failed onto the node.
1045 Procedure to update the public address configuration on whole cluster:
1048 1, Update the /etc/ctdb/public_addresses file on all nodes
1051 2, Run 'ctdb reloadips -n all'.
1054 This command will then force all nodes to reload and update the
1055 addresses. This process is controlled and synchronized by the recovery
1056 master to ensure that all addresses are added to all nodes as one
1057 single operation, after which any required ip node rebalancing may
1064 <refsect2><title>tickle <srcip:port> <dstip:port></title>
1066 This command will will send a TCP tickle to the source host for the
1067 specified TCP connection.
1068 A TCP tickle is a TCP ACK packet with an invalid sequence and
1069 acknowledge number and will when received by the source host result
1070 in it sending an immediate correct ACK back to the other end.
1073 TCP tickles are useful to "tickle" clients after a IP failover has
1074 occured since this will make the client immediately recognize the
1075 TCP connection has been disrupted and that the client will need
1076 to reestablish. This greatly speeds up the time it takes for a client
1077 to detect and reestablish after an IP failover in the ctdb cluster.
1081 <refsect2><title>gettickles <ip></title>
1083 This command is used to show which TCP connections are registered with
1084 CTDB to be "tickled" if there is a failover.
1087 <refsect2><title>repack [max_freelist]</title>
1089 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.
1090 This command is used to defragment a TDB database and pruning the freelist.
1094 If [max_freelist] is specified, then a database will only be repacked if it has more than this number of entries in the freelist.
1097 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.
1101 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.
1105 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.
1109 Example: ctdb repack 1000
1113 By default, this operation is issued from the 00.ctdb event script every 5 minutes.
1118 <refsect2><title>vacuum [max_records]</title>
1120 Over time CTDB databases will fill up with empty deleted records which will lead to a progressive slow down of CTDB database access.
1121 This command is used to prune all databases and delete all empty records from the cluster.
1125 By default, vacuum will delete all empty records from all databases.
1126 If [max_records] is specified, the command will only delete the first
1127 [max_records] empty records for each database.
1131 Vacuum only deletes records where the local node is the lmaster.
1132 To delete all records from the entire cluster you need to run a vacuum from each node.
1134 This command is not disruptive. Samba is unaffected and will still be able to read/write records normally while the database is being vacuumed.
1138 Example: ctdb vacuum
1142 By default, this operation is issued from the 00.ctdb event script every 5 minutes.
1146 <refsect2><title>backupdb <dbname> <file></title>
1148 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.
1149 This is mainly useful for backing up persistent databases such as secrets.tdb and similar.
1153 <refsect2><title>restoredb <file> [<dbname>]</title>
1155 This command restores a persistent database that was previously backed up using backupdb.
1156 By default the data will be restored back into the same database as
1157 it was created from. By specifying dbname you can restore the data
1158 into a different database.
1162 <refsect2><title>wipedb <dbname></title>
1164 This command can be used to remove all content of a database.
1170 <refsect2><title>getlog [<level>] [recoverd]</title>
1172 In addition to the normal logging to a log file,
1173 CTDBD also keeps a in-memory ringbuffer containing the most recent
1174 log entries for all log levels (except DEBUG).
1177 This is useful since it allows for keeping continuous logs to a file
1178 at a reasonable non-verbose level, but shortly after an incident has
1179 occured, a much more detailed log can be pulled from memory. This
1180 can allow you to avoid having to reproduce an issue due to the
1181 on-disk logs being of insufficient detail.
1184 This command extracts all messages of level or lower log level
1185 from memory and prints it to the screen. The level is not
1186 specified it defaults to NOTICE.
1189 By default, logs are extracted from the main CTDB daemon. If
1190 the recoverd option is given then logs are extracted from the
1195 <refsect2><title>clearlog [recoverd]</title>
1197 This command clears the in-memory logging ringbuffer.
1200 By default, logs are cleared in the main CTDB daemon. If the
1201 recoverd option is given then logs are cleared in the recovery
1206 <refsect2><title>setdbreadonly <dbname|hash></title>
1208 This command will enable the ReadOnly record support for a database.
1209 This is an experimental feature to improve performance for contended
1210 records primarily in locking.tdb and brlock.tdb.
1211 When enabling this feature you must set it on all nodes in the cluster.
1212 For now, this feature requires a special patch to samba in order to
1218 <refsect1><title>Debugging Commands</title>
1220 These commands are primarily used for CTDB development and testing and
1221 should not be used for normal administration.
1223 <refsect2><title>process-exists <pid></title>
1225 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.
1229 <refsect2><title>getdbmap</title>
1231 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.
1234 If a PERSISTENT database is not in a healthy state the database is
1235 flagged as UNHEALTHY. If there's at least one completely healthy node running in
1236 the cluster, it's possible that the content is restored by a recovery
1237 run automaticly. Otherwise an administrator needs to analyze the
1241 See also "ctdb getdbstatus", "ctdb backupdb", "ctdb restoredb",
1242 "ctdb dumpbackup", "ctdb wipedb", "ctdb setvar AllowUnhealthyDBRead 1"
1243 and (if samba or tdb-utils are installed) "tdbtool check".
1246 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.
1249 Example: ctdb getdbmap
1254 <screen format="linespecific">
1255 Number of databases:10
1256 dbid:0x435d3410 name:notify.tdb path:/var/ctdb/notify.tdb.0
1257 dbid:0x42fe72c5 name:locking.tdb path:/var/ctdb/locking.tdb.0
1258 dbid:0x1421fb78 name:brlock.tdb path:/var/ctdb/brlock.tdb.0
1259 dbid:0x17055d90 name:connections.tdb path:/var/ctdb/connections.tdb.0
1260 dbid:0xc0bdde6a name:sessionid.tdb path:/var/ctdb/sessionid.tdb.0
1261 dbid:0x122224da name:test.tdb path:/var/ctdb/test.tdb.0
1262 dbid:0x2672a57f name:idmap2.tdb path:/var/ctdb/persistent/idmap2.tdb.0 PERSISTENT
1263 dbid:0xb775fff6 name:secrets.tdb path:/var/ctdb/persistent/secrets.tdb.0 PERSISTENT
1264 dbid:0xe98e08b6 name:group_mapping.tdb path:/var/ctdb/persistent/group_mapping.tdb.0 PERSISTENT
1265 dbid:0x7bbbd26c name:passdb.tdb path:/var/ctdb/persistent/passdb.tdb.0 PERSISTENT
1268 Example output for an unhealthy database:
1270 <screen format="linespecific">
1271 Number of databases:1
1272 dbid:0xb775fff6 name:secrets.tdb path:/var/ctdb/persistent/secrets.tdb.0 PERSISTENT UNHEALTHY
1276 Example output for a healthy database as machinereadable output -Y:
1278 <screen format="linespecific">
1279 :ID:Name:Path:Persistent:Unhealthy:
1280 :0x7bbbd26c:passdb.tdb:/var/ctdb/persistent/passdb.tdb.0:1:0:
1284 <refsect2><title>getdbstatus <dbname></title>
1286 This command displays more details about a database.
1289 Example: ctdb getdbstatus test.tdb.0
1294 <screen format="linespecific">
1297 path: /var/ctdb/test.tdb.0
1302 Example: ctdb getdbstatus registry.tdb (with a corrupted TDB)
1307 <screen format="linespecific">
1310 path: /var/ctdb/persistent/registry.tdb.0
1312 HEALTH: NO-HEALTHY-NODES - ERROR - Backup of corrupted TDB in '/var/ctdb/persistent/registry.tdb.0.corrupted.20091208091949.0Z'
1316 <refsect2><title>catdb <dbname></title>
1318 This command will dump a clustered TDB database to the screen. This is a debugging command.
1322 <refsect2><title>cattdb <dbname></title>
1324 This command will dump the content of the local TDB database to the screen. This is a debugging command.
1328 <refsect2><title>dumpdbbackup <backup-file></title>
1330 This command will dump the content of database backup to the screen
1331 (similar to ctdb catdb). This is a debugging command.
1335 <refsect2><title>getmonmode</title>
1337 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.
1340 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.
1343 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.
1348 <refsect2><title>setmonmode <0|1></title>
1350 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.
1354 <refsect2><title>attach <dbname> [persistent]</title>
1356 This is a debugging command. This command will make the CTDB daemon create a new CTDB database and attach to it.
1360 <refsect2><title>dumpmemory</title>
1362 This is a debugging command. This command will make the ctdb
1363 daemon to write a fill memory allocation map to standard output.
1367 <refsect2><title>rddumpmemory</title>
1369 This is a debugging command. This command will dump the talloc memory
1370 allocation tree for the recovery daemon to standard output.
1374 <refsect2><title>thaw</title>
1376 Thaw a previously frozen node.
1381 <refsect2><title>eventscript <arguments></title>
1383 This is a debugging command. This command can be used to manually
1384 invoke and run the eventscritps with arbitrary arguments.
1388 <refsect2><title>ban <bantime|0></title>
1390 Administratively ban a node for bantime seconds. A bantime of 0 means that the node should be permanently banned.
1393 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.
1396 Nodes are automatically banned if they are the cause of too many
1400 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".
1404 <refsect2><title>unban</title>
1406 This command is used to unban a node that has either been
1407 administratively banned using the ban command or has been automatically
1408 banned by the recovery daemon.
1413 <refsect2><title>check_srvids <srvid> ...</title>
1415 This command checks whether a set of srvid message ports are registered on the
1416 node or not. The command takes a list of values to check.
1419 Example: ctdb check_srvids 1 2 3 14765
1424 <screen format="linespecific">
1425 Server id 0:1 does not exist
1426 Server id 0:2 does not exist
1427 Server id 0:3 does not exist
1428 Server id 0:14765 exists
1434 <refsect1><title>SEE ALSO</title>
1437 <ulink url="http://ctdb.samba.org/"/>
1440 <refsect1><title>COPYRIGHT/LICENSE</title>
1442 Copyright (C) Andrew Tridgell 2007
1443 Copyright (C) Ronnie sahlberg 2007
1445 This program is free software; you can redistribute it and/or modify
1446 it under the terms of the GNU General Public License as published by
1447 the Free Software Foundation; either version 3 of the License, or (at
1448 your option) any later version.
1450 This program is distributed in the hope that it will be useful, but
1451 WITHOUT ANY WARRANTY; without even the implied warranty of
1452 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1453 General Public License for more details.
1455 You should have received a copy of the GNU General Public License
1456 along with this program; if not, see http://www.gnu.org/licenses/.