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>
37 <refsect1><title>DESCRIPTION</title>
39 ctdb is a utility to view and manage a ctdb cluster.
45 <title>OPTIONS</title>
48 <varlistentry><term>-n <pnn></term>
51 This specifies the physical node number on which to execute the
52 command. Default is to run the command on the daemon running on
56 The physical node number is an integer that describes the node in the
57 cluster. The first node has physical node number 0.
62 <varlistentry><term>-Y</term>
65 Produce output in machine readable form for easier parsing by scripts. Not all commands support this option.
70 <varlistentry><term>-t <timeout></term>
73 How long should ctdb wait for the local ctdb daemon to respond to a command before timing out. Default is 3 seconds.
78 <varlistentry><term>-T <timelimit></term>
81 A limit on how long the ctdb command will run for before it will
82 be aborted. When this timelimit has been exceeded the ctdb command will
88 <varlistentry><term>-? --help</term>
91 Print some help text to the screen.
96 <varlistentry><term>--usage</term>
99 Print useage information to the screen.
104 <varlistentry><term>-d --debug=<debuglevel></term>
107 Change the debug level for the command. Default is 0.
112 <varlistentry><term>--socket=<filename></term>
115 Specify the socketname to use when connecting to the local ctdb
116 daemon. The default is /tmp/ctdb.socket .
119 You only need to specify this parameter if you run multiple ctdb
120 daemons on the same physical host and thus can not use the default
121 name for the domain socket.
130 <refsect1><title>Administrative Commands</title>
132 These are commands used to monitor and administrate a CTDB cluster.
135 <refsect2><title>pnn</title>
137 This command displays the pnn of the current node.
141 <refsect2><title>status</title>
143 This command shows the current status of the ctdb node.
146 <refsect3><title>node status</title>
148 Node status reflects the current status of the node. There are five possible states:
151 OK - This node is fully functional.
154 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.
157 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.
160 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.
163 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.
166 STOPPED - A node that is stopped does not host any public ip addresses,
167 nor is it part of the VNNMAP. A stopped node can not become LVSMASTER,
169 This node does not perticipate in the CTDB cluster but can still be
170 communicated with. I.e. ctdb commands can be sent to it.
173 PARTIALLYONLINE - A node that is partially online participates
174 in a cluster like a node that is ok. Some interfaces to serve
175 public ip addresses are down, but at least one interface is up.
176 See also "ctdb ifaces".
180 <refsect3><title>generation</title>
182 The generation id is a number that indicates the current generation
183 of a cluster instance. Each time a cluster goes through a
184 reconfiguration or a recovery its generation id will be changed.
187 This number does not have any particular meaning other than to keep
188 track of when a cluster has gone through a recovery. It is a random
189 number that represents the current instance of a ctdb cluster
191 CTDBD uses this number internally to be able to tell when commands
192 to operate on the cluster and the databases was issued in a different
193 generation of the cluster, to ensure that commands that operate
194 on the databases will not survive across a cluster database recovery.
195 After a recovery, all old outstanding commands will automatically
199 Sometimes this number will be shown as "INVALID". This only means that
200 the ctdbd daemon has started but it has not yet merged with the cluster through a recovery.
201 All nodes start with generation "INVALID" and are not assigned a real
202 generation id until they have successfully been merged with a cluster
207 <refsect3><title>VNNMAP</title>
209 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.
210 Only nodes that are participating in the vnnmap can become lmaster or dmaster for a database record.
214 <refsect3><title>Recovery mode</title>
216 This is the current recovery mode of the cluster. There are two possible modes:
219 NORMAL - The cluster is fully operational.
222 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.
225 Once the recovery master detects an inconsistency, for example a node
226 becomes disconnected/connected, the recovery daemon will trigger a
227 cluster recovery process, where all databases are remerged across the
228 cluster. When this process starts, the recovery master will first
229 "freeze" all databases to prevent applications such as samba from
230 accessing the databases and it will also mark the recovery mode as
234 When CTDBD starts up, it will start in RECOVERY mode.
235 Once the node has been merged into a cluster and all databases
236 have been recovered, the node mode will change into NORMAL mode
237 and the databases will be "thawed", allowing samba to access the
242 <refsect3><title>Recovery master</title>
244 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.
247 Only one node at a time can be the designated recovery master. Which
248 node is designated the recovery master is decided by an election
249 process in the recovery daemons running on each node.
256 <para>Example output:</para>
257 <screen format="linespecific">
259 pnn:0 11.1.2.200 OK (THIS NODE)
263 Generation:1362079228
269 Recovery mode:NORMAL (0)
274 <refsect2><title>recmaster</title>
276 This command shows the pnn of the node which is currently the recmaster.
280 <refsect2><title>uptime</title>
282 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.
288 <para>Example output:</para>
289 <screen format="linespecific">
290 Current time of node : Thu Oct 29 10:38:54 2009
291 Ctdbd start time : (000 16:54:28) Wed Oct 28 17:44:26 2009
292 Time of last recovery/failover: (000 16:53:31) Wed Oct 28 17:45:23 2009
293 Duration of last recovery/failover: 2.248552 seconds
297 <refsect2><title>listnodes</title>
299 This command shows lists the ip addresses of all the nodes in the cluster.
303 Example: ctdb listnodes
305 <para>Example output:</para>
306 <screen format="linespecific">
314 <refsect2><title>ping</title>
316 This command will "ping" all CTDB daemons in the cluster to verify that they are processing commands correctly.
324 <screen format="linespecific">
325 response from 0 time=0.000054 sec (3 clients)
326 response from 1 time=0.000144 sec (2 clients)
327 response from 2 time=0.000105 sec (2 clients)
328 response from 3 time=0.000114 sec (2 clients)
332 <refsect2><title>ifaces</title>
334 This command will display the list of network interfaces, which could
335 host public addresses, along with their status.
343 <screen format="linespecific">
345 name:eth5 link:up references:2
346 name:eth4 link:down references:0
347 name:eth3 link:up references:1
348 name:eth2 link:up references:1
351 Example: ctdb ifaces -Y
356 <screen format="linespecific">
357 :Name:LinkStatus:References:
365 <refsect2><title>setifacelink <iface> <status></title>
367 This command will set the status of a network interface.
368 The status needs to be "up" or "down". This is typically
369 used in the 10.interfaces script in the "monitor" event.
372 Example: ctdb setifacelink eth0 up
376 <refsect2><title>ip</title>
378 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".
386 <screen format="linespecific">
388 172.31.91.82 node[1] active[] available[eth2,eth3] configured[eth2,eth3]
389 172.31.91.83 node[0] active[eth3] available[eth2,eth3] configured[eth2,eth3]
390 172.31.91.84 node[1] active[] available[eth2,eth3] configured[eth2,eth3]
391 172.31.91.85 node[0] active[eth2] available[eth2,eth3] configured[eth2,eth3]
392 172.31.92.82 node[1] active[] available[eth5] configured[eth4,eth5]
393 172.31.92.83 node[0] active[eth5] available[eth5] configured[eth4,eth5]
394 172.31.92.84 node[1] active[] available[eth5] configured[eth4,eth5]
395 172.31.92.85 node[0] active[eth5] available[eth5] configured[eth4,eth5]
403 <screen format="linespecific">
404 :Public IP:Node:ActiveInterface:AvailableInterfaces:ConfiguredInterfaces:
405 :172.31.91.82:1::eth2,eth3:eth2,eth3:
406 :172.31.91.83:0:eth3:eth2,eth3:eth2,eth3:
407 :172.31.91.84:1::eth2,eth3:eth2,eth3:
408 :172.31.91.85:0:eth2:eth2,eth3:eth2,eth3:
409 :172.31.92.82:1::eth5:eth4,eth5:
410 :172.31.92.83:0:eth5:eth5:eth4,eth5:
411 :172.31.92.84:1::eth5:eth4,eth5:
412 :172.31.92.85:0:eth5:eth5:eth4,eth5:
416 <refsect2><title>ipinfo <ip></title>
418 This command will display details about the specified public addresses.
421 Example: ctdb ipinfo 172.31.92.85
426 <screen format="linespecific">
427 Public IP[172.31.92.85] info on node 0
431 Interface[1]: Name:eth4 Link:down References:0
432 Interface[2]: Name:eth5 Link:up References:2 (active)
436 <refsect2><title>scriptstatus</title>
438 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.
441 Example: ctdb scriptstatus
446 <screen format="linespecific">
447 7 scripts were executed last monitoring cycle
448 00.ctdb Status:OK Duration:0.056 Tue Mar 24 18:56:57 2009
449 10.interface Status:OK Duration:0.077 Tue Mar 24 18:56:57 2009
450 11.natgw Status:OK Duration:0.039 Tue Mar 24 18:56:57 2009
451 20.multipathd Status:OK Duration:0.038 Tue Mar 24 18:56:57 2009
452 31.clamd Status:DISABLED
453 40.vsftpd Status:OK Duration:0.045 Tue Mar 24 18:56:57 2009
454 41.httpd Status:OK Duration:0.039 Tue Mar 24 18:56:57 2009
455 50.samba Status:ERROR Duration:0.082 Tue Mar 24 18:56:57 2009
456 OUTPUT:ERROR: Samba tcp port 445 is not responding
460 <refsect2><title>disablescript <script></title>
462 This command is used to disable an eventscript.
465 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'.
469 <refsect2><title>enablescript <script></title>
471 This command is used to enable an eventscript.
474 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'.
478 <refsect2><title>getvar <name></title>
480 Get the runtime value of a tuneable variable.
483 Example: ctdb getvar MaxRedirectCount
488 <screen format="linespecific">
493 <refsect2><title>setvar <name> <value></title>
495 Set the runtime value of a tuneable variable.
498 Example: ctdb setvar MaxRedirectCount 5
502 <refsect2><title>listvars</title>
504 List all tuneable variables.
507 Example: ctdb listvars
512 <screen format="linespecific">
514 SeqnumInterval = 1000
517 KeepaliveInterval = 5
524 TickleUpdateInterval = 20
525 EventScriptTimeout = 30
526 EventScriptTimeoutCount = 1
527 EventScriptUnhealthyOnTimeout = 0
528 RecoveryGracePeriod = 120
529 RecoveryBanPeriod = 300
530 DatabaseHashSize = 100001
532 RerecoveryTimeout = 10
535 ReclockPingPeriod = 60
537 DisableIPFailover = 0
538 VerboseMemoryNames = 0
542 RecLockLatencyMs = 1000
543 RecoveryDropAllIPs = 120
544 VerifyRecoveryLock = 1
545 VacuumDefaultInterval = 10
546 VacuumMaxRunTime = 30
549 VacuumMinInterval = 10
550 VacuumMaxInterval = 10
551 VacuumFastPathCount = 60
552 MaxQueueDropMsg = 1000000
554 AllowUnhealthyDBRead = 0
555 StatHistoryInterval = 1
556 DeferredAttachTO = 120
560 <refsect2><title>lvsmaster</title>
562 This command shows which node is currently the LVSMASTER. The
563 LVSMASTER is the node in the cluster which drives the LVS system and
564 which receives all incoming traffic from clients.
567 LVS is the mode where the entire CTDB/Samba cluster uses a single
568 ip address for the entire cluster. In this mode all clients connect to
569 one specific node which will then multiplex/loadbalance the clients
570 evenly onto the other nodes in the cluster. This is an alternative to using
571 public ip addresses. See the manpage for ctdbd for more information
576 <refsect2><title>lvs</title>
578 This command shows which nodes in the cluster are currently active in the
579 LVS configuration. I.e. which nodes we are currently loadbalancing
580 the single ip address across.
584 LVS will by default only loadbalance across those nodes that are both
585 LVS capable and also HEALTHY. Except if all nodes are UNHEALTHY in which
586 case LVS will loadbalance across all UNHEALTHY nodes as well.
587 LVS will never use nodes that are DISCONNECTED, STOPPED, BANNED or
594 <screen format="linespecific">
602 <refsect2><title>getcapabilities</title>
604 This command shows the capabilities of the current node.
605 Please see manpage for ctdbd for a full list of all capabilities and
606 more detailed description.
610 RECMASTER and LMASTER capabilities are primarily used when CTDBD
611 is used to create a cluster spanning across WAN links. In which case
612 ctdbd acts as a WAN accelerator.
616 LVS capabile means that the node is participating in LVS, a mode
617 where the entire CTDB cluster uses one single ip address for the
618 entire cluster instead of using public ip address failover.
619 This is an alternative to using a loadbalancing layer-4 switch.
625 <screen format="linespecific">
633 <refsect2><title>statistics</title>
635 Collect statistics from the CTDB daemon about how many calls it has served.
638 Example: ctdb statistics
643 <screen format="linespecific">
648 client_packets_sent 360489
649 client_packets_recv 360466
650 node_packets_sent 480931
651 node_packets_recv 240120
652 keepalive_packets_sent 4
653 keepalive_packets_recv 3
674 pending_lockwait_calls 0
677 max_call_latency 4.948321 sec
678 max_lockwait_latency 0.000000 sec
682 <refsect2><title>statisticsreset</title>
684 This command is used to clear all statistics counters in a node.
687 Example: ctdb statisticsreset
691 <refsect2><title>getreclock</title>
693 This command is used to show the filename of the reclock file that is used.
699 <screen format="linespecific">
700 Reclock file:/gpfs/.ctdb/shared
705 <refsect2><title>setreclock [filename]</title>
707 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".
711 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.
715 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.
721 <refsect2><title>getdebug</title>
723 Get the current debug level for the node. the debug level controls what information is written to the log file.
726 The debug levels are mapped to the corresponding syslog levels.
727 When a debug level is set, only those messages at that level and higher
728 levels will be printed.
731 The list of debug levels from highest to lowest are :
734 EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
738 <refsect2><title>setdebug <debuglevel></title>
740 Set the debug level of a node. This controls what information will be logged.
743 The debuglevel is one of EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
747 <refsect2><title>getpid</title>
749 This command will return the process id of the ctdb daemon.
753 <refsect2><title>disable</title>
755 This command is used to administratively disable a node in the cluster.
756 A disabled node will still participate in the cluster and host
757 clustered TDB records but its public ip address has been taken over by
758 a different node and it no longer hosts any services.
762 <refsect2><title>enable</title>
764 Re-enable a node that has been administratively disabled.
768 <refsect2><title>stop</title>
770 This command is used to administratively STOP a node in the cluster.
771 A STOPPED node is connected to the cluster but will not host any
772 public ip addresse, nor does it participate in the VNNMAP.
773 The difference between a DISABLED node and a STOPPED node is that
774 a STOPPED node does not host any parts of the database which means
775 that a recovery is required to stop/continue nodes.
779 <refsect2><title>continue</title>
781 Re-start a node that has been administratively stopped.
785 <refsect2><title>addip <public_ip/mask> <iface></title>
787 This command is used to add a new public ip to a node during runtime.
788 This allows public addresses to be added to a cluster without having
789 to restart the ctdb daemons.
792 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.
793 If you want this change to be permanent you must also update the public addresses file manually.
797 <refsect2><title>delip <public_ip></title>
799 This command is used to remove a public ip from a node during runtime.
800 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.
803 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.
804 If you want this change to be permanent you must also update the public addresses file manually.
808 <refsect2><title>moveip <public_ip> <node></title>
810 This command can be used to manually fail a public ip address to a
814 In order to manually override the "automatic" distribution of public
815 ip addresses that ctdb normally provides, this command only works
816 when you have changed the tunables for the daemon to:
826 <refsect2><title>shutdown</title>
828 This command will shutdown a specific CTDB daemon.
832 <refsect2><title>recover</title>
834 This command will trigger the recovery daemon to do a cluster
839 <refsect2><title>ipreallocate</title>
841 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.
845 <refsect2><title>setlmasterrole <on|off></title>
847 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.
851 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.
854 Once this setting has been enabled/disabled, you need to perform a recovery for it to take effect.
857 See also "ctdb getcapabilities"
861 <refsect2><title>setrecmasterrole <on|off></title>
863 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.
867 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.
870 See also "ctdb getcapabilities"
874 <refsect2><title>killtcp <srcip:port> <dstip:port></title>
876 This command will kill the specified TCP connection by issuing a
877 TCP RST to the srcip:port endpoint. This is a command used by the
882 <refsect2><title>gratiousarp <ip> <interface></title>
884 This command will send out a gratious arp for the specified interface
885 through the specified interface. This command is mainly used by the
890 <refsect2><title>reloadnodes</title>
892 This command is used when adding new nodes, or removing existing nodes from an existing cluster.
895 Procedure to add a node:
898 1, To expand an existing cluster, first ensure with 'ctdb status' that
899 all nodes are up and running and that they are all healthy.
900 Do not try to expand a cluster unless it is completely healthy!
903 2, On all nodes, edit /etc/ctdb/nodes and add the new node as the last
904 entry to the file. The new node MUST be added to the end of this file!
907 3, Verify that all the nodes have identical /etc/ctdb/nodes files after you edited them and added the new node!
910 4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
913 5, Use 'ctdb status' on all nodes and verify that they now show the additional node.
916 6, Install and configure the new node and bring it online.
919 Procedure to remove a node:
922 1, To remove a node from an existing cluster, first ensure with 'ctdb status' that
923 all nodes, except the node to be deleted, are up and running and that they are all healthy.
924 Do not try to remove a node from a cluster unless the cluster is completely healthy!
927 2, Shutdown and poweroff the node to be removed.
930 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.
933 4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
936 5, Use 'ctdb status' on all nodes and verify that the deleted node no longer shows up in the list..
943 <refsect2><title>tickle <srcip:port> <dstip:port></title>
945 This command will will send a TCP tickle to the source host for the
946 specified TCP connection.
947 A TCP tickle is a TCP ACK packet with an invalid sequence and
948 acknowledge number and will when received by the source host result
949 in it sending an immediate correct ACK back to the other end.
952 TCP tickles are useful to "tickle" clients after a IP failover has
953 occured since this will make the client immediately recognize the
954 TCP connection has been disrupted and that the client will need
955 to reestablish. This greatly speeds up the time it takes for a client
956 to detect and reestablish after an IP failover in the ctdb cluster.
960 <refsect2><title>gettickles <ip></title>
962 This command is used to show which TCP connections are registered with
963 CTDB to be "tickled" if there is a failover.
966 <refsect2><title>repack [max_freelist]</title>
968 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.
969 This command is used to defragment a TDB database and pruning the freelist.
973 If [max_freelist] is specified, then a database will only be repacked if it has more than this number of entries in the freelist.
976 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.
980 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.
984 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.
988 Example: ctdb repack 1000
992 By default, this operation is issued from the 00.ctdb event script every 5 minutes.
997 <refsect2><title>vacuum [max_records]</title>
999 Over time CTDB databases will fill up with empty deleted records which will lead to a progressive slow down of CTDB database access.
1000 This command is used to prune all databases and delete all empty records from the cluster.
1004 By default, vacuum will delete all empty records from all databases.
1005 If [max_records] is specified, the command will only delete the first
1006 [max_records] empty records for each database.
1010 Vacuum only deletes records where the local node is the lmaster.
1011 To delete all records from the entire cluster you need to run a vacuum from each node.
1013 This command is not disruptive. Samba is unaffected and will still be able to read/write records normally while the database is being vacuumed.
1017 Example: ctdb vacuum
1021 By default, this operation is issued from the 00.ctdb event script every 5 minutes.
1025 <refsect2><title>backupdb <dbname> <file></title>
1027 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.
1028 This is mainly useful for backing up persistent databases such as secrets.tdb and similar.
1032 <refsect2><title>restoredb <file> [<dbname>]</title>
1034 This command restores a persistent database that was previously backed up using backupdb.
1035 By default the data will be restored back into the same database as
1036 it was created from. By specifying dbname you can restore the data
1037 into a different database.
1041 <refsect2><title>wipedb <dbname></title>
1043 This command can be used to remove all content of a database.
1049 <refsect2><title>getlog <level></title>
1051 In addition to the normal loggign to a log file,
1052 CTDBD also keeps a in-memory ringbuffer containing the most recent
1053 log entries for all log levels (except DEBUG).
1055 This is useful since it allows for keeping continuous logs to a file
1056 at a reasonable non-verbose level, but shortly after an incident has
1057 occured, a much more detailed log can be pulled from memory. This
1058 can allow you to avoid having to reproduce an issue due to the
1059 on-disk logs being of insufficient detail.
1061 This command extracts all messages of level or lower log level from
1062 memory and prints it to the screen.
1066 <refsect2><title>clearlog</title>
1068 This command clears the in-memory logging ringbuffer.
1073 <refsect1><title>Debugging Commands</title>
1075 These commands are primarily used for CTDB development and testing and
1076 should not be used for normal administration.
1078 <refsect2><title>process-exists <pid></title>
1080 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.
1084 <refsect2><title>getdbmap</title>
1086 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.
1089 If a PERSISTENT database is not in a healthy state the database is
1090 flagged as UNHEALTHY. If there's at least one completely healthy node running in
1091 the cluster, it's possible that the content is restored by a recovery
1092 run automaticly. Otherwise an administrator needs to analyze the
1096 See also "ctdb getdbstatus", "ctdb backupdb", "ctdb restoredb",
1097 "ctdb dumpbackup", "ctdb wipedb", "ctdb setvar AllowUnhealthyDBRead 1"
1098 and (if samba or tdb-utils are installed) "tdbtool check".
1101 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.
1104 Example: ctdb getdbmap
1109 <screen format="linespecific">
1110 Number of databases:10
1111 dbid:0x435d3410 name:notify.tdb path:/var/ctdb/notify.tdb.0
1112 dbid:0x42fe72c5 name:locking.tdb path:/var/ctdb/locking.tdb.0
1113 dbid:0x1421fb78 name:brlock.tdb path:/var/ctdb/brlock.tdb.0
1114 dbid:0x17055d90 name:connections.tdb path:/var/ctdb/connections.tdb.0
1115 dbid:0xc0bdde6a name:sessionid.tdb path:/var/ctdb/sessionid.tdb.0
1116 dbid:0x122224da name:test.tdb path:/var/ctdb/test.tdb.0
1117 dbid:0x2672a57f name:idmap2.tdb path:/var/ctdb/persistent/idmap2.tdb.0 PERSISTENT
1118 dbid:0xb775fff6 name:secrets.tdb path:/var/ctdb/persistent/secrets.tdb.0 PERSISTENT
1119 dbid:0xe98e08b6 name:group_mapping.tdb path:/var/ctdb/persistent/group_mapping.tdb.0 PERSISTENT
1120 dbid:0x7bbbd26c name:passdb.tdb path:/var/ctdb/persistent/passdb.tdb.0 PERSISTENT
1123 Example output for an unhealthy database:
1125 <screen format="linespecific">
1126 Number of databases:1
1127 dbid:0xb775fff6 name:secrets.tdb path:/var/ctdb/persistent/secrets.tdb.0 PERSISTENT UNHEALTHY
1131 Example output for a healthy database as machinereadable output -Y:
1133 <screen format="linespecific">
1134 :ID:Name:Path:Persistent:Unhealthy:
1135 :0x7bbbd26c:passdb.tdb:/var/ctdb/persistent/passdb.tdb.0:1:0:
1139 <refsect2><title>getdbstatus <dbname></title>
1141 This command displays more details about a database.
1144 Example: ctdb getdbstatus test.tdb.0
1149 <screen format="linespecific">
1152 path: /var/ctdb/test.tdb.0
1157 Example: ctdb getdbstatus registry.tdb (with a corrupted TDB)
1162 <screen format="linespecific">
1165 path: /var/ctdb/persistent/registry.tdb.0
1167 HEALTH: NO-HEALTHY-NODES - ERROR - Backup of corrupted TDB in '/var/ctdb/persistent/registry.tdb.0.corrupted.20091208091949.0Z'
1171 <refsect2><title>catdb <dbname></title>
1173 This command will dump a clustered TDB database to the screen. This is a debugging command.
1177 <refsect2><title>cattdb <dbname></title>
1179 This command will dump the content of the local TDB database to the screen. This is a debugging command.
1183 <refsect2><title>dumpdbbackup <backup-file></title>
1185 This command will dump the content of database backup to the screen
1186 (similar to ctdb catdb). This is a debugging command.
1190 <refsect2><title>getmonmode</title>
1192 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.
1195 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.
1198 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.
1203 <refsect2><title>setmonmode <0|1></title>
1205 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.
1209 <refsect2><title>attach <dbname> [persistent]</title>
1211 This is a debugging command. This command will make the CTDB daemon create a new CTDB database and attach to it.
1215 <refsect2><title>dumpmemory</title>
1217 This is a debugging command. This command will make the ctdb
1218 daemon to write a fill memory allocation map to standard output.
1222 <refsect2><title>rddumpmemory</title>
1224 This is a debugging command. This command will dump the talloc memory
1225 allocation tree for the recovery daemon to standard output.
1229 <refsect2><title>thaw</title>
1231 Thaw a previously frozen node.
1236 <refsect2><title>eventscript <arguments></title>
1238 This is a debugging command. This command can be used to manually
1239 invoke and run the eventscritps with arbitrary arguments.
1243 <refsect2><title>ban <bantime|0></title>
1245 Administratively ban a node for bantime seconds. A bantime of 0 means that the node should be permanently banned.
1248 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.
1251 Nodes are automatically banned if they are the cause of too many
1255 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".
1259 <refsect2><title>unban</title>
1261 This command is used to unban a node that has either been
1262 administratively banned using the ban command or has been automatically
1263 banned by the recovery daemon.
1270 <refsect1><title>SEE ALSO</title>
1273 <ulink url="http://ctdb.samba.org/"/>
1276 <refsect1><title>COPYRIGHT/LICENSE</title>
1278 Copyright (C) Andrew Tridgell 2007
1279 Copyright (C) Ronnie sahlberg 2007
1281 This program is free software; you can redistribute it and/or modify
1282 it under the terms of the GNU General Public License as published by
1283 the Free Software Foundation; either version 3 of the License, or (at
1284 your option) any later version.
1286 This program is distributed in the hope that it will be useful, but
1287 WITHOUT ANY WARRANTY; without even the implied warranty of
1288 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1289 General Public License for more details.
1291 You should have received a copy of the GNU General Public License
1292 along with this program; if not, see http://www.gnu.org/licenses/.