1 <?xml version="1.0" encoding="iso-8859-1"?>
3 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
4 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
10 This documentation was written by
19 <holder>Andrew Tridgell</holder>
20 <holder>Ronnie Sahlberg</holder>
24 This program is free software; you can redistribute it and/or
25 modify it under the terms of the GNU General Public License as
26 published by the Free Software Foundation; either version 3 of
27 the License, or (at your option) any later version.
30 This program is distributed in the hope that it will be
31 useful, but WITHOUT ANY WARRANTY; without even the implied
32 warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
33 PURPOSE. See the GNU General Public License for more details.
36 You should have received a copy of the GNU General Public
37 License along with this program; if not, see
38 <ulink url="http://www.gnu.org/licenses"/>.
44 <refentrytitle>ctdb</refentrytitle>
45 <manvolnum>1</manvolnum>
46 <refmiscinfo class="source">ctdb</refmiscinfo>
47 <refmiscinfo class="manual">CTDB - clustered TDB database</refmiscinfo>
51 <refname>ctdb</refname>
52 <refpurpose>CTDB management utility</refpurpose>
57 <command>ctdb</command>
58 <arg rep="repeat"><replaceable>OPTION</replaceable></arg>
59 <arg choice="req"><replaceable>COMMAND</replaceable></arg>
60 <arg choice="opt"><replaceable>COMMAND-ARGS</replaceable></arg>
65 <title>DESCRIPTION</title>
67 ctdb is a utility to view and manage a CTDB cluster.
71 The following terms are used when referring to nodes in a
78 Physical Node Number. The physical node number is an
79 integer that describes the node in the cluster. The
80 first node has physical node number 0. in a cluster.
88 This is either a single PNN, a comma-separate list of PNNs
97 Commands that reference a database use the following terms:
103 This is either a database name, such as
104 <filename>locking.tdb</filename> or a database ID such
113 A space separated list of at least one
114 <parameter>DB</parameter>.
123 <title>OPTIONS</title>
126 <varlistentry><term>-n <parameter>PNN-LIST</parameter></term>
129 The nodes specified by PNN-LIST should be queried for the
130 requested information. Default is to query the daemon
131 running on the local host.
136 <varlistentry><term>-Y</term>
139 Produce output in machine readable form for easier parsing
140 by scripts. This uses a field delimiter of ':'. Not all
141 commands support this option.
146 <varlistentry><term>-x <parameter>SEPARATOR</parameter></term>
149 Use SEPARATOR to delimit fields in machine readable output.
155 <varlistentry><term>-X</term>
158 Produce output in machine readable form for easier parsing
159 by scripts. This uses a field delimiter of '|'. Not all
160 commands support this option.
163 This is equivalent to "-x|" and avoids some shell quoting
169 <varlistentry><term>-t <parameter>TIMEOUT</parameter></term>
172 Indicates that ctdb should wait up to TIMEOUT seconds for
173 a response to most commands sent to the CTDB daemon. The
174 default is 10 seconds.
179 <varlistentry><term>-T <parameter>TIMELIMIT</parameter></term>
182 Indicates that TIMELIMIT is the maximum run time (in
183 seconds) for the ctdb command. When TIMELIMIT is exceeded
184 the ctdb command will terminate with an error. The default
190 <varlistentry><term>-? --help</term>
193 Print some help text to the screen.
198 <varlistentry><term>--usage</term>
201 Print useage information to the screen.
206 <varlistentry><term>-d --debug=<parameter>DEBUGLEVEL</parameter></term>
209 Change the debug level for the command. Default is NOTICE (2).
214 <varlistentry><term>--socket=<parameter>FILENAME</parameter></term>
217 Specify that FILENAME is the name of the Unix domain
218 socket to use when connecting to the local CTDB
219 daemon. The default is
220 <filename>/usr/local/var/run/ctdb/ctdbd.socket</filename>.
229 <title>ADMINISTRATIVE COMMANDS</title>
231 These are commands used to monitor and administer a CTDB cluster.
237 This command displays the PNN of the current node.
244 This command displays the PNN of the current node without
245 contacting the CTDB daemon. It parses the nodes file
246 directly, so can produce unexpected output if the nodes file
247 has been edited but has not been reloaded.
252 <title>status</title>
254 This command shows the current status of all CTDB nodes based
255 on information from the queried node.
259 Note: If the the queried node is INACTIVE then the status
260 might not be current.
264 <title>Node status</title>
266 This includes the number of physical nodes and the status of
267 each node. See <citerefentry><refentrytitle>ctdb</refentrytitle>
268 <manvolnum>7</manvolnum></citerefentry> for information
274 <title>Generation</title>
276 The generation id is a number that indicates the current generation
277 of a cluster instance. Each time a cluster goes through a
278 reconfiguration or a recovery its generation id will be changed.
281 This number does not have any particular meaning other than
282 to keep track of when a cluster has gone through a
283 recovery. It is a random number that represents the current
284 instance of a ctdb cluster and its databases. The CTDB
285 daemon uses this number internally to be able to tell when
286 commands to operate on the cluster and the databases was
287 issued in a different generation of the cluster, to ensure
288 that commands that operate on the databases will not survive
289 across a cluster database recovery. After a recovery, all
290 old outstanding commands will automatically become invalid.
293 Sometimes this number will be shown as "INVALID". This only means that
294 the ctdbd daemon has started but it has not yet merged with the cluster through a recovery.
295 All nodes start with generation "INVALID" and are not assigned a real
296 generation id until they have successfully been merged with a cluster
302 <title>Virtual Node Number (VNN) map</title>
304 Consists of the number of virtual nodes and mapping from
305 virtual node numbers to physical node numbers. Virtual
306 nodes host CTDB databases. Only nodes that are
307 participating in the VNN map can become lmaster or dmaster
308 for database records.
313 <title>Recovery mode</title>
315 This is the current recovery mode of the cluster. There are two possible modes:
318 NORMAL - The cluster is fully operational.
321 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.
324 Once the recovery master detects an inconsistency, for example a node
325 becomes disconnected/connected, the recovery daemon will trigger a
326 cluster recovery process, where all databases are remerged across the
327 cluster. When this process starts, the recovery master will first
328 "freeze" all databases to prevent applications such as samba from
329 accessing the databases and it will also mark the recovery mode as
333 When the CTDB daemon starts up, it will start in RECOVERY
334 mode. Once the node has been merged into a cluster and all
335 databases have been recovered, the node mode will change into
336 NORMAL mode and the databases will be "thawed", allowing samba
337 to access the databases again.
341 <title>Recovery master</title>
343 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.
346 Only one node at a time can be the designated recovery master. Which
347 node is designated the recovery master is decided by an election
348 process in the recovery daemons running on each node.
353 <title>Example</title>
357 pnn:0 192.168.2.200 OK (THIS NODE)
358 pnn:1 192.168.2.201 OK
359 pnn:2 192.168.2.202 OK
360 pnn:3 192.168.2.203 OK
361 Generation:1362079228
367 Recovery mode:NORMAL (0)
374 <title>nodestatus <optional><parameter>PNN-LIST</parameter></optional></title>
376 This command is similar to the <command>status</command>
377 command. It displays the "node status" subset of output. The
378 main differences are:
384 The exit code is the bitwise-OR of the flags for each
385 specified node, while <command>ctdb status</command> exits
386 with 0 if it was able to retrieve status for all nodes.
392 <command>ctdb status</command> provides status information
393 for all nodes. <command>ctdb nodestatus</command>
394 defaults to providing status for only the current node.
395 If PNN-LIST is provided then status is given for
396 the indicated node(s).
402 A common invocation in scripts is <command>ctdb nodestatus
403 all</command> to check whether all nodes in a cluster are
408 <title>Example</title>
411 pnn:0 10.0.0.30 OK (THIS NODE)
413 # ctdb nodestatus all
415 pnn:0 10.0.0.30 OK (THIS NODE)
422 <title>recmaster</title>
424 This command shows the pnn of the node which is currently the recmaster.
428 Note: If the the queried node is INACTIVE then the status
429 might not be current.
434 <title>uptime</title>
436 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.
440 <title>Example</title>
443 Current time of node : Thu Oct 29 10:38:54 2009
444 Ctdbd start time : (000 16:54:28) Wed Oct 28 17:44:26 2009
445 Time of last recovery/failover: (000 16:53:31) Wed Oct 28 17:45:23 2009
446 Duration of last recovery/failover: 2.248552 seconds
452 <title>listnodes</title>
454 This command shows lists the ip addresses of all the nodes in the cluster.
458 <title>Example</title>
470 <title>natgwlist</title>
472 Show the current NAT gateway master and the status of all
473 nodes in the current NAT gateway group. See the
474 <citetitle>NAT GATEWAY</citetitle> section in
475 <citerefentry><refentrytitle>ctdb</refentrytitle>
476 <manvolnum>7</manvolnum></citerefentry> for more details.
480 <title>Example</title>
485 pnn:0 192.168.2.200 OK (THIS NODE)
486 pnn:1 192.168.2.201 OK
487 pnn:2 192.168.2.202 OK
488 pnn:3 192.168.2.203 OK
496 This command will "ping" specified CTDB nodes in the cluster
497 to verify that they are running.
500 <title>Example</title>
503 response from 0 time=0.000054 sec (3 clients)
509 <title>ifaces</title>
511 This command will display the list of network interfaces, which could
512 host public addresses, along with their status.
515 <title>Example</title>
519 name:eth5 link:up references:2
520 name:eth4 link:down references:0
521 name:eth3 link:up references:1
522 name:eth2 link:up references:1
525 |Name|LinkStatus|References|
537 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 all".
540 <title>Example</title>
544 172.31.91.82 node[1] active[] available[eth2,eth3] configured[eth2,eth3]
545 172.31.91.83 node[0] active[eth3] available[eth2,eth3] configured[eth2,eth3]
546 172.31.91.84 node[1] active[] available[eth2,eth3] configured[eth2,eth3]
547 172.31.91.85 node[0] active[eth2] available[eth2,eth3] configured[eth2,eth3]
548 172.31.92.82 node[1] active[] available[eth5] configured[eth4,eth5]
549 172.31.92.83 node[0] active[eth5] available[eth5] configured[eth4,eth5]
550 172.31.92.84 node[1] active[] available[eth5] configured[eth4,eth5]
551 172.31.92.85 node[0] active[eth5] available[eth5] configured[eth4,eth5]
554 |Public IP|Node|ActiveInterface|AvailableInterfaces|ConfiguredInterfaces|
555 |172.31.91.82|1||eth2,eth3|eth2,eth3|
556 |172.31.91.83|0|eth3|eth2,eth3|eth2,eth3|
557 |172.31.91.84|1||eth2,eth3|eth2,eth3|
558 |172.31.91.85|0|eth2|eth2,eth3|eth2,eth3|
559 |172.31.92.82|1||eth5|eth4,eth5|
560 |172.31.92.83|0|eth5|eth5|eth4,eth5|
561 |172.31.92.84|1||eth5|eth4,eth5|
562 |172.31.92.85|0|eth5|eth5|eth4,eth5|
568 <title>ipinfo <parameter>IP</parameter></title>
570 This command will display details about the specified public addresses.
573 <title>Example</title>
575 # ctdb ipinfo 172.31.92.85
576 Public IP[172.31.92.85] info on node 0
580 Interface[1]: Name:eth4 Link:down References:0
581 Interface[2]: Name:eth5 Link:up References:2 (active)
587 <title>scriptstatus</title>
589 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.
592 <title>Example</title>
595 7 scripts were executed last monitoring cycle
596 00.ctdb Status:OK Duration:0.056 Tue Mar 24 18:56:57 2009
597 10.interface Status:OK Duration:0.077 Tue Mar 24 18:56:57 2009
598 11.natgw Status:OK Duration:0.039 Tue Mar 24 18:56:57 2009
599 20.multipathd Status:OK Duration:0.038 Tue Mar 24 18:56:57 2009
600 31.clamd Status:DISABLED
601 40.vsftpd Status:OK Duration:0.045 Tue Mar 24 18:56:57 2009
602 41.httpd Status:OK Duration:0.039 Tue Mar 24 18:56:57 2009
603 50.samba Status:ERROR Duration:0.082 Tue Mar 24 18:56:57 2009
604 OUTPUT:ERROR: Samba tcp port 445 is not responding
610 <title>disablescript <parameter>SCRIPT</parameter></title>
612 This command is used to disable an eventscript.
615 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'.
620 <title>enablescript <parameter>SCRIPT</parameter></title>
622 This command is used to enable an eventscript.
625 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'.
630 <title>listvars</title>
632 List all tuneable variables, except the values of the obsolete tunables
633 like VacuumMinInterval. The obsolete tunables can be retrieved only
634 explicitly with the "ctdb getvar" command.
637 <title>Example</title>
641 SeqnumInterval = 1000
644 KeepaliveInterval = 5
651 TickleUpdateInterval = 20
652 EventScriptTimeout = 30
653 EventScriptTimeoutCount = 1
654 RecoveryGracePeriod = 120
655 RecoveryBanPeriod = 300
656 DatabaseHashSize = 100001
658 RerecoveryTimeout = 10
662 ReclockPingPeriod = 60
664 DisableIPFailover = 0
665 VerboseMemoryNames = 0
669 RecLockLatencyMs = 1000
670 RecoveryDropAllIPs = 120
672 VacuumMaxRunTime = 30
675 VacuumFastPathCount = 60
676 MaxQueueDropMsg = 1000000
678 AllowUnhealthyDBRead = 0
679 StatHistoryInterval = 1
680 DeferredAttachTO = 120
681 AllowClientDBAttach = 1
682 RecoverPDBBySeqNum = 0
688 <title>getvar <parameter>NAME</parameter></title>
690 Get the runtime value of a tuneable variable.
693 <title>Example</title>
695 # ctdb getvar MaxRedirectCount
702 <title>setvar <parameter>NAME</parameter> <parameter>VALUE</parameter></title>
704 Set the runtime value of a tuneable variable.
707 Example: ctdb setvar MaxRedirectCount 5
712 <title>lvsmaster</title>
714 This command shows which node is currently the LVSMASTER. The
715 LVSMASTER is the node in the cluster which drives the LVS system and
716 which receives all incoming traffic from clients.
719 LVS is the mode where the entire CTDB/Samba cluster uses a single
720 ip address for the entire cluster. In this mode all clients connect to
721 one specific node which will then multiplex/loadbalance the clients
722 evenly onto the other nodes in the cluster. This is an alternative to using
723 public ip addresses. See the manpage for ctdbd for more information
731 This command shows which nodes in the cluster are currently active in the
732 LVS configuration. I.e. which nodes we are currently loadbalancing
733 the single ip address across.
737 LVS will by default only loadbalance across those nodes that are both
738 LVS capable and also HEALTHY. Except if all nodes are UNHEALTHY in which
739 case LVS will loadbalance across all UNHEALTHY nodes as well.
740 LVS will never use nodes that are DISCONNECTED, STOPPED, BANNED or
756 <title>getcapabilities</title>
759 This command shows the capabilities of the current node. See
760 the <citetitle>CAPABILITIES</citetitle> section in
761 <citerefentry><refentrytitle>ctdb</refentrytitle>
762 <manvolnum>7</manvolnum></citerefentry> for more details.
778 <title>statistics</title>
780 Collect statistics from the CTDB daemon about
781 how many calls it has served. Information about
782 various fields in statistics can be found in
783 <citerefentry><refentrytitle>ctdb-statistics</refentrytitle>
784 <manvolnum>7</manvolnum></citerefentry>.
787 <title>Example</title>
794 client_packets_sent 360489
795 client_packets_recv 360466
796 node_packets_sent 480931
797 node_packets_recv 240120
798 keepalive_packets_sent 4
799 keepalive_packets_recv 3
820 pending_lockwait_calls 0
823 max_call_latency 4.948321 sec
824 max_lockwait_latency 0.000000 sec
830 <title>statisticsreset</title>
832 This command is used to clear all statistics counters in a node.
835 Example: ctdb statisticsreset
840 <title>dbstatistics <parameter>DB</parameter></title>
842 Display statistics about the database DB. Information
843 about various fields in dbstatistics can be found in
844 <citerefentry><refentrytitle>ctdb-statistics</refentrytitle>
845 <manvolnum>7</manvolnum></citerefentry>.
848 <title>Example</title>
850 # ctdb dbstatistics locking.tdb
851 DB Statistics: locking.tdb
859 hop_count_buckets: 28087 2 1 0 0 0 0 0 0 0 0 0 0 0 0 0
860 lock_buckets: 0 14188 38 76 32 19 3 0 0 0 0 0 0 0 0 0
861 locks_latency MIN/AVG/MAX 0.001066/0.012686/4.202292 sec out of 14356
863 Count:8 Key:ff5bd7cb3ee3822edc1f0000000000000000000000000000
869 <title>getreclock</title>
871 Show the name of the recovery lock file, if any.
878 Reclock file:/clusterfs/.ctdb/recovery.lock
885 setreclock <optional><parameter>FILE</parameter></optional>
889 FILE specifies the name of the recovery lock file. If the
890 recovery lock file is changed at run-time then this will cause
891 a recovery, which in turn causes the recovery lock to be
896 If no FILE is specified then a recovery lock file will no
901 This command only affects the run-time setting of a single
902 CTDB node. This setting <emphasis>must</emphasis> be changed
903 on all nodes simultaneously. For information about configuring
904 the recovery lock file please see the
905 <citetitle>CTDB_RECOVERY_LOCK</citetitle> entry in
906 <citerefentry><refentrytitle>ctdbd.conf</refentrytitle>
907 <manvolnum>5</manvolnum></citerefentry> and the
908 <citetitle>--reclock</citetitle> entry in
909 <citerefentry><refentrytitle>ctdbd</refentrytitle>
910 <manvolnum>1</manvolnum></citerefentry>. For information
911 about the recovery lock please see the <citetitle>RECOVERY
912 LOCK</citetitle> section in
913 <citerefentry><refentrytitle>ctdb</refentrytitle>
914 <manvolnum>7</manvolnum></citerefentry>.
921 <title>getdebug</title>
923 Get the current debug level for the node. the debug level controls what information is written to the log file.
926 The debug levels are mapped to the corresponding syslog levels.
927 When a debug level is set, only those messages at that level and higher
928 levels will be printed.
931 The list of debug levels from highest to lowest are :
934 ERR WARNING NOTICE INFO DEBUG
939 <title>setdebug <parameter>DEBUGLEVEL</parameter></title>
941 Set the debug level of a node. This controls what information will be logged.
944 The debuglevel is one of ERR WARNING NOTICE INFO DEBUG
949 <title>getpid</title>
951 This command will return the process id of the ctdb daemon.
956 <title>disable</title>
958 This command is used to administratively disable a node in the cluster.
959 A disabled node will still participate in the cluster and host
960 clustered TDB records but its public ip address has been taken over by
961 a different node and it no longer hosts any services.
966 <title>enable</title>
968 Re-enable a node that has been administratively disabled.
975 This command is used to administratively STOP a node in the cluster.
976 A STOPPED node is connected to the cluster but will not host any
977 public ip addresse, nor does it participate in the VNNMAP.
978 The difference between a DISABLED node and a STOPPED node is that
979 a STOPPED node does not host any parts of the database which means
980 that a recovery is required to stop/continue nodes.
985 <title>continue</title>
987 Re-start a node that has been administratively stopped.
992 <title>addip <parameter>IPADDR</parameter>/<parameter>mask</parameter> <parameter>IFACE</parameter></title>
994 This command is used to add a new public ip to a node during runtime.
995 This allows public addresses to be added to a cluster without having
996 to restart the ctdb daemons.
999 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.
1000 If you want this change to be permanent you must also update the public addresses file manually.
1005 <title>delip <parameter>IPADDR</parameter></title>
1007 This command is used to remove a public ip from a node during runtime.
1008 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.
1011 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.
1012 If you want this change to be permanent you must also update the public addresses file manually.
1017 <title>moveip <parameter>IPADDR</parameter> <parameter>PNN</parameter></title>
1019 This command can be used to manually fail a public ip address to a
1023 In order to manually override the "automatic" distribution of public
1024 ip addresses that ctdb normally provides, this command only works
1025 when you have changed the tunables for the daemon to:
1028 DeterministicIPs = 0
1036 <title>shutdown</title>
1038 This command will shutdown a specific CTDB daemon.
1043 <title>setlmasterrole on|off</title>
1045 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.
1049 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.
1052 Once this setting has been enabled/disabled, you need to perform a recovery for it to take effect.
1055 See also "ctdb getcapabilities"
1060 <title>setrecmasterrole on|off</title>
1062 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.
1066 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.
1069 See also "ctdb getcapabilities"
1074 <title>reloadnodes</title>
1076 This command is used when adding new nodes, or removing
1077 existing nodes from an existing cluster.
1080 Procedure to add nodes:
1085 To expand an existing cluster, first ensure with
1086 <command>ctdb status</command> that all nodes are up and
1087 running and that they are all healthy. Do not try to
1088 expand a cluster unless it is completely healthy!
1093 On all nodes, edit <filename>/usr/local/etc/ctdb/nodes</filename>
1094 and <emphasis>add the new nodes at the end of this
1100 Verify that all the nodes have identical
1101 <filename>/usr/local/etc/ctdb/nodes</filename> files after adding
1107 Run <command>ctdb reloadnodes</command> to force all nodes
1108 to reload the nodes file.
1113 Use <command>ctdb status</command> on all nodes and verify
1114 that they now show the additional nodes.
1119 Install and configure the new node and bring it online.
1124 Procedure to remove nodes:
1129 To remove nodes from an existing cluster, first ensure
1130 with <command>ctdb status</command> that all nodes, except
1131 the node to be deleted, are up and running and that they
1132 are all healthy. Do not try to remove nodes from a
1133 cluster unless the cluster is completely healthy!
1138 Shutdown and power off the node to be removed.
1143 On all other nodes, edit the
1144 <filename>/usr/local/etc/ctdb/nodes</filename> file and
1145 <emphasis>comment out</emphasis> the nodes to be removed.
1146 <emphasis>Do not delete the lines for the deleted
1147 nodes</emphasis>, just comment them out by adding a '#' at
1148 the beginning of the lines.
1153 Run <command>ctdb reloadnodes</command> to force all nodes
1154 to reload the nodes file.
1159 Use <command>ctdb status</command> on all nodes and verify
1160 that the deleted nodes are no longer listed.
1170 <optional><parameter>PNN-LIST</parameter></optional>
1173 This command reloads the public addresses configuration file
1174 on the specified nodes. When it completes addresses will be
1175 reconfigured and reassigned across the cluster as necessary.
1180 <title>getdbmap</title>
1182 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.
1185 If a PERSISTENT database is not in a healthy state the database is
1186 flagged as UNHEALTHY. If there's at least one completely healthy node running in
1187 the cluster, it's possible that the content is restored by a recovery
1188 run automaticly. Otherwise an administrator needs to analyze the
1192 See also "ctdb getdbstatus", "ctdb backupdb", "ctdb restoredb",
1193 "ctdb dumpbackup", "ctdb wipedb", "ctdb setvar AllowUnhealthyDBRead 1"
1194 and (if samba or tdb-utils are installed) "tdbtool check".
1197 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.
1201 <title>Example</title>
1204 Number of databases:10
1205 dbid:0x435d3410 name:notify.tdb path:/usr/local/var/lib/ctdb/notify.tdb.0
1206 dbid:0x42fe72c5 name:locking.tdb path:/usr/local/var/lib/ctdb/locking.tdb.0
1207 dbid:0x1421fb78 name:brlock.tdb path:/usr/local/var/lib/ctdb/brlock.tdb.0
1208 dbid:0x17055d90 name:connections.tdb path:/usr/local/var/lib/ctdb/connections.tdb.0
1209 dbid:0xc0bdde6a name:sessionid.tdb path:/usr/local/var/lib/ctdb/sessionid.tdb.0
1210 dbid:0x122224da name:test.tdb path:/usr/local/var/lib/ctdb/test.tdb.0
1211 dbid:0x2672a57f name:idmap2.tdb path:/usr/local/var/lib/ctdb/persistent/idmap2.tdb.0 PERSISTENT
1212 dbid:0xb775fff6 name:secrets.tdb path:/usr/local/var/lib/ctdb/persistent/secrets.tdb.0 PERSISTENT
1213 dbid:0xe98e08b6 name:group_mapping.tdb path:/usr/local/var/lib/ctdb/persistent/group_mapping.tdb.0 PERSISTENT
1214 dbid:0x7bbbd26c name:passdb.tdb path:/usr/local/var/lib/ctdb/persistent/passdb.tdb.0 PERSISTENT
1216 # ctdb getdbmap # example for unhealthy database
1217 Number of databases:1
1218 dbid:0xb775fff6 name:secrets.tdb path:/usr/local/var/lib/ctdb/persistent/secrets.tdb.0 PERSISTENT UNHEALTHY
1221 |ID|Name|Path|Persistent|Unhealthy|
1222 |0x7bbbd26c|passdb.tdb|/usr/local/var/lib/ctdb/persistent/passdb.tdb.0|1|0|
1230 <parameter>DB</parameter>
1231 <parameter>FILE</parameter>
1234 Copy the contents of database DB to FILE. FILE can later be
1235 read back using <command>restoredb</command>. This is mainly
1236 useful for backing up persistent databases such as
1237 <filename>secrets.tdb</filename> and similar.
1244 <parameter>FILE</parameter>
1245 <optional><parameter>DB</parameter></optional>
1248 This command restores a persistent database that was
1249 previously backed up using backupdb. By default the data will
1250 be restored back into the same database as it was created
1251 from. By specifying dbname you can restore the data into a
1257 <title>setdbreadonly <parameter>DB</parameter></title>
1259 This command will enable the read-only record support for a
1260 database. This is an experimental feature to improve
1261 performance for contended records primarily in locking.tdb and
1262 brlock.tdb. When enabling this feature you must set it on all
1263 nodes in the cluster.
1268 <title>setdbsticky <parameter>DB</parameter></title>
1270 This command will enable the sticky record support for the
1271 specified database. This is an experimental feature to
1272 improve performance for contended records primarily in
1273 locking.tdb and brlock.tdb. When enabling this feature you
1274 must set it on all nodes in the cluster.
1281 <title>INTERNAL COMMANDS</title>
1284 Internal commands are used by CTDB's scripts and are not
1285 required for managing a CTDB cluster. Their parameters and
1286 behaviour are subject to change.
1290 <title>gettickles <parameter>IPADDR</parameter></title>
1292 Show TCP connections that are registered with CTDB to be
1293 "tickled" if there is a failover.
1298 <title>gratiousarp <parameter>IPADDR</parameter> <parameter>INTERFACE</parameter></title>
1300 Send out a gratious ARP for the specified interface through
1301 the specified interface. This command is mainly used by the
1307 <title>killtcp</title>
1309 Read a list of TCP connections, one per line, from standard
1310 input and terminate each connection. A connection is
1314 <parameter>SRC-IPADDR</parameter>:<parameter>SRC-PORT</parameter> <parameter>DST-IPADDR</parameter>:<parameter>DST-PORT</parameter>
1317 Each connection is terminated by issuing a TCP RST to the
1318 SRC-IPADDR:SRC-PORT endpoint.
1321 A single connection can be specified on the command-line
1322 rather than on standard input.
1328 pdelete <parameter>DB</parameter> <parameter>KEY</parameter>
1337 pfetch <parameter>DB</parameter> <parameter>KEY</parameter>
1340 Print the value associated with KEY in DB.
1347 <parameter>DB</parameter>
1348 <parameter>KEY</parameter>
1349 <parameter>FILE</parameter>
1352 Store KEY in DB with contents of FILE as the associated value.
1359 <parameter>DB</parameter>
1360 <optional><parameter>FILE</parameter></optional>
1363 Read a list of key-value pairs, one per line from FILE, and
1364 store them in DB using a single transaction. An empty value
1365 is equivalent to deleting the given key.
1368 The key and value should be separated by spaces or tabs. Each
1369 key/value should be a printable string enclosed in
1375 <title>runstate [setup|first_recovery|startup|running]</title>
1377 Print the runstate of the specified node. Runstates are used
1378 to serialise important state transitions in CTDB, particularly
1382 If one or more optional runstate arguments are specified then
1383 the node must be in one of these runstates for the command to
1387 <title>Example</title>
1396 <title>setifacelink <parameter>IFACE</parameter> up|down</title>
1398 Set the internal state of network interface IFACE. This is
1399 typically used in the <filename>10.interface</filename> script
1400 in the "monitor" event.
1403 Example: ctdb setifacelink eth0 up
1408 <title>setnatgwstate on|off</title>
1410 Enable or disable the NAT gateway master capability on a node.
1415 <title>tickle <parameter>SRC-IPADDR</parameter>:<parameter>SRC-PORT</parameter> <parameter>DST-IPADDR</parameter>:<parameter>DST-PORT</parameter></title>
1417 Send a TCP tickle to the source host for the specified TCP
1418 connection. A TCP tickle is a TCP ACK packet with an invalid
1419 sequence and acknowledge number and will when received by the
1420 source host result in it sending an immediate correct ACK back
1424 TCP tickles are useful to "tickle" clients after a IP failover has
1425 occured since this will make the client immediately recognize the
1426 TCP connection has been disrupted and that the client will need
1427 to reestablish. This greatly speeds up the time it takes for a client
1428 to detect and reestablish after an IP failover in the ctdb cluster.
1433 <title>version</title>
1435 Display the CTDB version.
1442 <title>DEBUGGING COMMANDS</title>
1444 These commands are primarily used for CTDB development and testing and
1445 should not be used for normal administration.
1450 <title>OPTIONS</title>
1453 <varlistentry><term>--print-emptyrecords</term>
1456 This enables printing of empty records when dumping databases
1457 with the catdb, cattbd and dumpdbbackup commands. Records with
1458 empty data segment are considered deleted by ctdb and cleaned
1459 by the vacuuming mechanism, so this switch can come in handy for
1460 debugging the vacuuming behaviour.
1465 <varlistentry><term>--print-datasize</term>
1468 This lets database dumps (catdb, cattdb, dumpdbbackup) print the
1469 size of the record data instead of dumping the data contents.
1474 <varlistentry><term>--print-lmaster</term>
1477 This lets catdb print the lmaster for each record.
1482 <varlistentry><term>--print-hash</term>
1485 This lets database dumps (catdb, cattdb, dumpdbbackup) print the
1486 hash for each record.
1491 <varlistentry><term>--print-recordflags</term>
1494 This lets catdb and dumpdbbackup print the
1495 record flags for each record. Note that cattdb always
1505 <title>process-exists <parameter>PID</parameter></title>
1507 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.
1512 <title>getdbstatus <parameter>DB</parameter></title>
1514 This command displays more details about a database.
1517 <title>Example</title>
1519 # ctdb getdbstatus test.tdb.0
1522 path: /usr/local/var/lib/ctdb/test.tdb.0
1526 # ctdb getdbstatus registry.tdb # with a corrupted TDB
1529 path: /usr/local/var/lib/ctdb/persistent/registry.tdb.0
1531 HEALTH: NO-HEALTHY-NODES - ERROR - Backup of corrupted TDB in '/usr/local/var/lib/ctdb/persistent/registry.tdb.0.corrupted.20091208091949.0Z'
1537 <title>catdb <parameter>DB</parameter></title>
1539 Print a dump of the clustered TDB database DB.
1544 <title>cattdb <parameter>DB</parameter></title>
1546 Print a dump of the contents of the local TDB database DB.
1551 <title>dumpdbbackup <parameter>FILE</parameter></title>
1553 Print a dump of the contents from database backup FILE,
1554 similar to <command>catdb</command>.
1559 <title>wipedb <parameter>DB</parameter></title>
1561 Remove all contents of database DB.
1566 <title>recover</title>
1568 This command will trigger the recovery daemon to do a cluster
1574 <title>ipreallocate, sync</title>
1576 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.
1581 <title>getmonmode</title>
1583 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.
1586 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.
1589 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.
1595 <title>setmonmode 0|1</title>
1597 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.
1602 <title>attach <parameter>DBNAME</parameter> [persistent]</title>
1604 Create a new CTDB database called DBNAME and attach to it on
1610 <title>detach <parameter>DB-LIST</parameter></title>
1612 Detach specified non-persistent database(s) from the cluster. This
1613 command will disconnect specified database(s) on all nodes in
1614 the cluster. This command should only be used when none of the
1615 specified database(s) are in use.
1618 All nodes should be active and tunable AllowClientDBAccess should
1619 be disabled on all nodes before detaching databases.
1624 <title>dumpmemory</title>
1626 This is a debugging command. This command will make the ctdb
1627 daemon to write a fill memory allocation map to standard output.
1632 <title>rddumpmemory</title>
1634 This is a debugging command. This command will dump the talloc memory
1635 allocation tree for the recovery daemon to standard output.
1642 Thaw a previously frozen node.
1648 <title>eventscript <parameter>ARGUMENTS</parameter></title>
1650 This is a debugging command. This command can be used to manually
1651 invoke and run the eventscritps with arbitrary arguments.
1656 <title>ban <parameter>BANTIME</parameter></title>
1658 Administratively ban a node for BANTIME seconds. The node
1659 will be unbanned after BANTIME seconds have elapsed.
1662 A banned node does not participate in the cluster. It does
1663 not host any records for the clustered TDB and does not host
1664 any public IP addresses.
1667 Nodes are automatically banned if they misbehave. For
1668 example, a node may be banned if it causes too many cluster
1672 To administratively exclude a node from a cluster use the
1673 <command>stop</command> command.
1678 <title>unban</title>
1680 This command is used to unban a node that has either been
1681 administratively banned using the ban command or has been
1682 automatically banned.
1689 <optional><parameter>PNN-LIST</parameter></optional>
1692 This command marks the given nodes as rebalance targets in the
1693 LCP2 IP allocation algorithm. The
1694 <command>reloadips</command> command will do this as necessary
1695 so this command should not be needed.
1700 <title>check_srvids <parameter>SRVID</parameter> ...</title>
1702 This command checks whether a set of srvid message ports are
1703 registered on the node or not. The command takes a list of
1707 <title>Example</title>
1709 # ctdb check_srvids 1 2 3 14765
1710 Server id 0:1 does not exist
1711 Server id 0:2 does not exist
1712 Server id 0:3 does not exist
1713 Server id 0:14765 exists
1720 <!-- UNDOCUMENTED: showban stats disablemonitor enablemonitor
1721 isnotrecmaster addtickle deltickle regsrvid unregsrvid chksrvid
1722 getsrvids rebalanceip setdbprio getdbprio msglisten msgsend
1723 tfetch tstore readkey writekey
1724 checktcpport getdbseqnum ipiface
1728 <title>SEE ALSO</title>
1730 <citerefentry><refentrytitle>ctdbd</refentrytitle>
1731 <manvolnum>1</manvolnum></citerefentry>,
1733 <citerefentry><refentrytitle>onnode</refentrytitle>
1734 <manvolnum>1</manvolnum></citerefentry>,
1736 <citerefentry><refentrytitle>ctdb</refentrytitle>
1737 <manvolnum>7</manvolnum></citerefentry>,
1739 <citerefentry><refentrytitle>ctdb-statistics</refentrytitle>
1740 <manvolnum>7</manvolnum></citerefentry>,
1742 <citerefentry><refentrytitle>ctdb-tunables</refentrytitle>
1743 <manvolnum>7</manvolnum></citerefentry>,
1745 <ulink url="http://ctdb.samba.org/"/>