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>
12 <refname>ctdb</refname>
13 <refpurpose>clustered tdb database management utility</refpurpose>
18 <command>ctdb [ OPTIONS ] COMMAND ...</command>
22 <command>ctdb</command>
23 <arg choice="opt">-n <node></arg>
24 <arg choice="opt">-Y</arg>
25 <arg choice="opt">-t <timeout></arg>
26 <arg choice="opt">-? --help</arg>
27 <arg choice="opt">--usage</arg>
28 <arg choice="opt">-d --debug=<INTEGER></arg>
29 <arg choice="opt">--socket=<filename></arg>
34 <refsect1><title>DESCRIPTION</title>
36 ctdb is a utility to view and manage a ctdb cluster.
42 <title>OPTIONS</title>
45 <varlistentry><term>-n <vnn></term>
48 This specifies the virtual node number on which to execute the
49 command. Default is to run the command on the deamon running on
53 The virtual node number is an integer that describes the node in the
54 cluster. The first node has virtual node number 0.
59 <varlistentry><term>-Y</term>
62 Produce output in machine readable form for easier parsing by scripts. Not all commands support this option.
67 <varlistentry><term>-t <timeout></term>
70 How long should ctdb wait for a command to complete before timing out. Default is 3 seconds.
75 <varlistentry><term>-? --help</term>
78 Print some help text to the screen.
83 <varlistentry><term>--usage</term>
86 Print useage information to the screen.
91 <varlistentry><term>-d --debug=<debuglevel></term>
94 Change the debug level for the command. Default is 0.
99 <varlistentry><term>--socket=<filename></term>
102 Specify the socketname to use when connecting to the local ctdb
103 daemon. The default is /tmp/ctdb.socket .
106 You only need to specify this parameter if you run multiple ctdb
107 daemons on the same physical host and thus can not use the default
108 name for the domain socket.
117 <refsect1><title>Administrative Commands</title>
119 These are commands used to monitor and administrate a CTDB cluster.
122 <refsect2><title>status</title>
124 This command shows the current status of the ctdb node.
127 <refsect3><title>node status</title>
129 Node status reflects the current status of the node. There are four possible states:
132 OK - This node is fully functional.
135 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.
138 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.
141 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.
144 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.
148 <refsect3><title>generation</title>
150 The generation id is a number that indicates the current generation
151 of a cluster instance. Each time a cluster goes through a
152 reconfiguration or a recovery its generation id will be changed.
156 <refsect3><title>VNNMAP</title>
158 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.
159 Only nodes that are participating in the vnnmap can become lmaster or dmaster for a database record.
163 <refsect3><title>Recovery mode</title>
165 This is the current recovery mode of the cluster. There are two possible modes:
168 NORMAL - The cluster is fully operational.
171 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.
175 <refsect3><title>Recovery master</title>
177 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.
184 <para>Example output:</para>
185 <screen format="linespecific">
187 vnn:0 11.1.2.200 OK (THIS NODE)
191 Generation:1362079228
197 Recovery mode:NORMAL (0)
202 <refsect2><title>ping</title>
204 This command will "ping" all CTDB daemons in the cluster to verify that they are processing commands correctly.
212 <screen format="linespecific">
213 response from 0 time=0.000054 sec (3 clients)
214 response from 1 time=0.000144 sec (2 clients)
215 response from 2 time=0.000105 sec (2 clients)
216 response from 3 time=0.000114 sec (2 clients)
220 <refsect2><title>ip</title>
222 This command will display the list of public addresses that are provided by the cluster and which physical node is currently serving this ip.
230 <screen format="linespecific">
231 Number of addresses:4
239 <refsect2><title>getvar <name></title>
241 Get the runtime value of a tuneable variable.
244 Example: ctdb getvar MaxRedirectCount
249 <screen format="linespecific">
254 <refsect2><title>setvar <name> <value></title>
256 Set the runtime value of a tuneable variable.
259 Example: ctdb setvar MaxRedirectCount 5
263 <refsect2><title>listvars</title>
265 List all tuneable variables.
268 Example: ctdb listvars
273 <screen format="linespecific">
278 KeepaliveInterval = 2
286 EventScriptTimeout = 20
287 RecoveryGracePeriod = 60
288 RecoveryBanPeriod = 300
292 <refsect2><title>statistics</title>
294 Collect statistics from the CTDB daemon about how many calls it has served.
297 Example: ctdb statistics
302 <screen format="linespecific">
307 client_packets_sent 360489
308 client_packets_recv 360466
309 node_packets_sent 480931
310 node_packets_recv 240120
311 keepalive_packets_sent 4
312 keepalive_packets_recv 3
333 pending_lockwait_calls 0
336 max_call_latency 4.948321 sec
337 max_lockwait_latency 0.000000 sec
341 <refsect2><title>statisticsreset</title>
343 This command is used to clear all statistics counters in a node.
346 Example: ctdb statisticsreset
350 <refsect2><title>getdebug</title>
352 Get the current debug level for the node. the debug level controls what information is written to the log file.
356 <refsect2><title>setdebug <debuglevel></title>
358 Set the debug level of a node. This is a number between 0 and 9 and controls what information will be written to the logfile.
362 <refsect2><title>getpid</title>
364 This command will return the process id of the ctdb daemon.
368 <refsect2><title>disable</title>
370 This command is used to administratively disable a node in the cluster.
371 A disabled node will still participate in the cluster and host
372 clustered TDB records but its public ip address has been taken over by
373 a different node and it no longer hosts any services.
377 <refsect2><title>enable</title>
379 Re-enable a node that has been administratively disabled.
383 <refsect2><title>ban <bantime|0></title>
385 Administratively ban a node for bantime seconds. A bantime of 0 means that the node should be permanently banned.
388 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 an other node and no services are hosted.
391 Nodes are automatically banned if they are the cause of too many
396 <refsect2><title>unban</title>
398 This command is used to unban a node that has either been
399 administratively banned using the ban command or has been automatically
400 banned by the recovery daemon.
404 <refsect2><title>shutdown</title>
406 This command will shutdown a specific CTDB daemon.
410 <refsect2><title>recover</title>
412 This command will trigger the recovery daemon to do a cluster
417 <refsect2><title>killtcp <srcip:port> <dstip:port></title>
419 This command will kill the specified TCP connection by issuing a
420 TCP RST to the srcip:port endpoint.
424 <refsect2><title>tickle <srcip:port> <dstip:port></title>
426 This command will will send a TCP tickle to the source host for the
427 specified TCP connection.
428 A TCP tickle is a TCP ACK packet with an invalid sequence and
429 acknowledge number and will when received by the source host result
430 in it sending an immediate correct ACK back to the other end.
433 TCP tickles are useful to "tickle" clients after a IP failover has
434 occured since this will make the client immediately recognize the
435 TCP connection has been disrupted and that the client will need
436 to reestablish. This greatly speeds up the time it takes for a client
437 to detect and reestablish after an IP failover in the ctdb cluster.
444 <refsect1><title>Debugging Commands</title>
446 These commands are primarily used for CTDB development and testing and
447 should not be used for normal administration.
449 <refsect2><title>process-exists <pid></title>
451 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.
455 <refsect2><title>getdbmap</title>
457 This command lists all clustered TDB databases that the CTDB daemon has attahced to.
460 Example: ctdb getdbmap
465 <screen format="linespecific">
466 Number of databases:4
467 dbid:0x42fe72c5 name:locking.tdb path:/var/ctdb/locking.tdb.0
468 dbid:0x1421fb78 name:brlock.tdb path:/var/ctdb/brlock.tdb.0
469 dbid:0x17055d90 name:connections.tdb path:/var/ctdb/connections.tdb.0
470 dbid:0xc0bdde6a name:sessionid.tdb path:/var/ctdb/sessionid.tdb.0
474 <refsect2><title>catdb <dbname></title>
476 This command will dump a clustered TDB database to the screen. This is a debugging command.
480 <refsect2><title>getmonmode</title>
482 This command returns the monutoring mode of a node. The monitoring mode is either ACTIVE or DISABLED. Normally a node will continously monitor that all other nodes that are expected are in fact connected and that they respond to commands.
485 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.
488 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.
493 <refsect2><title>setmonmode <0|1></title>
495 This command can be used to explicitely 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.
499 <refsect2><title>attach <dbname></title>
501 This is a debugging command. This command will make the CTDB daemon create a new CTDB database and attach to it.
505 <refsect2><title>dumpmemory</title>
507 This is a debugging command. This command will make the ctdb daemon to write a fill memory allocation map to the log file.
511 <refsect2><title>freeze</title>
513 This command will lock all the local TDB databases causing clients
514 that are accessing these TDBs such as samba3 to block until the
515 databases are thawed.
518 This is primarily used by the recovery daemon to stop all samba
519 daemons from accessing any databases while the database is recovered
524 <refsect2><title>thaw</title>
526 Thaw a previously frozen node.
533 <refsect1><title>SEE ALSO</title>
536 <ulink url="http://ctdb.samba.org/"/>
539 <refsect1><title>COPYRIGHT/LICENSE</title>
541 Copyright (C) Andrew Tridgell 2007
542 Copyright (C) Ronnie sahlberg 2007
544 This program is free software; you can redistribute it and/or modify
545 it under the terms of the GNU General Public License as published by
546 the Free Software Foundation; either version 3 of the License, or (at
547 your option) any later version.
549 This program is distributed in the hope that it will be useful, but
550 WITHOUT ANY WARRANTY; without even the implied warranty of
551 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
552 General Public License for more details.
554 You should have received a copy of the GNU General Public License
555 along with this program; if not, see http://www.gnu.org/licenses/.