doc/ctdb.1.html

   1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ctdb</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="ctdb.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ctdb &#8212; clustered tdb database management utility</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">ctdb [ OPTIONS ] COMMAND ...</code> </p></div><div class="cmdsynopsis"><p><code class="command">ctdb</code>  [-n &lt;node&gt;] [-Y] [-t &lt;timeout&gt;] [-T &lt;timelimit&gt;] [-? --help] [--usage] [-d --debug=&lt;INTEGER&gt;] [--socket=&lt;filename&gt;]</p></div></div><div class="refsect1" lang="en"><a name="id2478257"></a><h2>DESCRIPTION</h2><p>
   2       ctdb is a utility to view and manage a ctdb cluster.
   3     </p></div><div class="refsect1" lang="en"><a name="id2478267"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-n &lt;pnn&gt;</span></dt><dd><p>
   4             This specifies the physical node number on which to execute the
   5             command. Default is to run the command on the deamon running on
   6             the local host.
   7           </p><p>
   8             The physical node number is an integer that describes the node in the
   9             cluster. The first node has physical node number 0.
  10           </p></dd><dt><span class="term">-Y</span></dt><dd><p>
  11             Produce output in machine readable form for easier parsing by scripts. Not all commands support this option.
  12           </p></dd><dt><span class="term">-t &lt;timeout&gt;</span></dt><dd><p>
  13             How long should ctdb wait for the local ctdb daemon to respond to a command before timing out. Default is 3 seconds.
  14           </p></dd><dt><span class="term">-T &lt;timelimit&gt;</span></dt><dd><p>
  15             A limit on how long the ctdb command will run for before it will
  16             be aborted. When this timelimit has been exceeded the ctdb command will
  17             terminate.
  18           </p></dd><dt><span class="term">-? --help</span></dt><dd><p>
  19             Print some help text to the screen.
  20           </p></dd><dt><span class="term">--usage</span></dt><dd><p>
  21             Print useage information to the screen.
  22           </p></dd><dt><span class="term">-d --debug=&lt;debuglevel&gt;</span></dt><dd><p>
  23             Change the debug level for the command. Default is 0.
  24           </p></dd><dt><span class="term">--socket=&lt;filename&gt;</span></dt><dd><p>
  25             Specify the socketname to use when connecting to the local ctdb
  26             daemon. The default is /tmp/ctdb.socket .
  27           </p><p>
  28             You only need to specify this parameter if you run multiple ctdb
  29             daemons on the same physical host and thus can not use the default
  30             name for the domain socket.
  31           </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2478404"></a><h2>Administrative Commands</h2><p>
  32       These are commands used to monitor and administrate a CTDB cluster.
  33     </p><div class="refsect2" lang="en"><a name="id2478413"></a><h3>pnn</h3><p>
  34         This command displays the pnn of the current node.
  35       </p></div><div class="refsect2" lang="en"><a name="id2478423"></a><h3>status</h3><p>
  36         This command shows the current status of the ctdb node.
  37       </p><div class="refsect3" lang="en"><a name="id2478621"></a><h4>node status</h4><p>
  38           Node status reflects the current status of the node. There are five possible states:
  39         </p><p>
  40           OK - This node is fully functional.
  41         </p><p>
  42           DISCONNECTED - This node could not be connected through the network and is currently not participating in the cluster. If there is a public IP address associated with this node it should have been taken over by a different node. No services are running on this node.
  43         </p><p>
  44           DISABLED - This node has been administratively disabled. This node is still functional and participates in the CTDB cluster but its IP addresses have been taken over by a different node and no services are currently being hosted.
  45         </p><p>
  46           UNHEALTHY - A service provided by this node is malfunctioning and should be investigated. The CTDB daemon itself is operational and participates in the cluster. Its public IP address has been taken over by a different node and no services are currnetly being hosted. All unhealthy nodes should be investigated and require an administrative action to rectify.
  47         </p><p>
  48           BANNED - This node failed too many recovery attempts and has been banned from participating in the cluster for a period of RecoveryBanPeriod seconds. Any public IP address has been taken over by other nodes. This node does not provide any services. All banned nodes should be investigated and require an administrative action to rectify. This node does not perticipate in the CTDB cluster but can still be communicated with. I.e. ctdb commands can be sent to it.
  49         </p><p>
  50       STOPPED - A node that is stopped does not host any public ip addresses,
  51       nor is it part of the VNNMAP. A stopped node can not become LVSMASTER,
  52       RECMASTER or NATGW.
  53       This node does not perticipate in the CTDB cluster but can still be
  54       communicated with. I.e. ctdb commands can be sent to it.
  55         </p></div><div class="refsect3" lang="en"><a name="id2478682"></a><h4>generation</h4><p>
  56           The generation id is a number that indicates the current generation
  57           of a cluster instance. Each time a cluster goes through a
  58           reconfiguration or a recovery its generation id will be changed.
  59           </p><p>
  60           This number does not have any particular meaning other than to keep
  61           track of when a cluster has gone through a recovery. It is a random
  62           number that represents the current instance of a ctdb cluster
  63           and its databases.
  64           CTDBD uses this number internally to be able to tell when commands
  65           to operate on the cluster and the databases was issued in a different
  66           generation of the cluster, to ensure that commands that operate
  67           on the databases will not survive across a cluster database recovery.
  68           After a recovery, all old outstanding commands will automatically
  69           become invalid.
  70         </p><p>
  71           Sometimes this number will be shown as "INVALID". This only means that
  72           the ctdbd daemon has started but it has not yet merged with the cluster through a recovery.
  73           All nodes start with generation "INVALID" and are not assigned a real
  74           generation id until they have successfully been merged with a cluster
  75           through a recovery.
  76         </p></div><div class="refsect3" lang="en"><a name="id2478717"></a><h4>VNNMAP</h4><p>
  77           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.
  78           Only nodes that are participating in the vnnmap can become lmaster or dmaster for a database record.
  79         </p></div><div class="refsect3" lang="en"><a name="id2478731"></a><h4>Recovery mode</h4><p>
  80           This is the current recovery mode of the cluster. There are two possible modes:
  81         </p><p>
  82           NORMAL - The cluster is fully operational.
  83         </p><p>
  84           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.
  85         </p><p>
  86         Once the recovery master detects an inconsistency, for example a node
  87         becomes disconnected/connected, the recovery daemon will trigger a
  88         cluster recovery process, where all databases are remerged across the
  89         cluster. When this process starts, the recovery master will first
  90         "freeze" all databases to prevent applications such as samba from
  91         accessing the databases and it will also mark the recovery mode as
  92         RECOVERY.
  93         </p><p>
  94         When CTDBD starts up, it will start in RECOVERY mode.
  95         Once the node has been merged into a cluster and all databases
  96         have been recovered, the node mode will change into NORMAL mode
  97         and the databases will be "thawed", allowing samba to access the
  98         databases again.
  99         </p></div><div class="refsect3" lang="en"><a name="id2478773"></a><h4>Recovery master</h4><p>
 100           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.
 101         </p><p>
 102         Only one node at a time can be the designated recovery master. Which
 103         node is designated the recovery master is decided by an election
 104         process in the recovery daemons running on each node.
 105         </p></div><p>
 106         Example: ctdb status
 107       </p><p>Example output:</p><pre class="screen">
 108 Number of nodes:4
 109 pnn:0 11.1.2.200       OK (THIS NODE)
 110 pnn:1 11.1.2.201       OK
 111 pnn:2 11.1.2.202       OK
 112 pnn:3 11.1.2.203       OK
 113 Generation:1362079228
 114 Size:4
 115 hash:0 lmaster:0
 116 hash:1 lmaster:1
 117 hash:2 lmaster:2
 118 hash:3 lmaster:3
 119 Recovery mode:NORMAL (0)
 120 Recovery master:0
 121       </pre></div><div class="refsect2" lang="en"><a name="id2478810"></a><h3>recmaster</h3><p>
 122         This command shows the pnn of the node which is currently the recmaster.
 123       </p></div><div class="refsect2" lang="en"><a name="id2478821"></a><h3>uptime</h3><p>
 124         This command shows the uptime for the ctdb daemon. When the last recovery completed and how long the last recovery took. If the "duration" is shown as a negative number, this indicates that there is a recovery in progress and it started that many seconds ago.
 125       </p><p>
 126         Example: ctdb uptime
 127       </p><p>Example output:</p><pre class="screen">
 128 Current time of node  : Tue Mar 24 18:27:54 2009
 129 Ctdbd start time      : (000 00:00:05) Tue Mar 24 18:27:49 2009
 130 Time of last recovery : (000 00:00:05) Tue Mar 24 18:27:49 2009
 131 Duration of last recovery : 0.000000 seconds
 132       </pre></div><div class="refsect2" lang="en"><a name="id2478851"></a><h3>listnodes</h3><p>
 133         This command shows lists the ip addresses of all the nodes in the cluster.
 134       </p><p>
 135         Example: ctdb listnodes
 136       </p><p>Example output:</p><pre class="screen">
 137 10.0.0.71
 138 10.0.0.72
 139 10.0.0.73
 140 10.0.0.74
 141       </pre></div><div class="refsect2" lang="en"><a name="id2478874"></a><h3>ping</h3><p>
 142         This command will "ping" all CTDB daemons in the cluster to verify that they are processing commands correctly.
 143       </p><p>
 144         Example: ctdb ping
 145       </p><p>
 146         Example output:
 147       </p><pre class="screen">
 148 response from 0 time=0.000054 sec  (3 clients)
 149 response from 1 time=0.000144 sec  (2 clients)
 150 response from 2 time=0.000105 sec  (2 clients)
 151 response from 3 time=0.000114 sec  (2 clients)
 152       </pre></div><div class="refsect2" lang="en"><a name="id2528491"></a><h3>ip</h3><p>
 153         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".
 154       </p><p>
 155         Example: ctdb ip
 156       </p><p>
 157         Example output:
 158       </p><pre class="screen">
 159 Number of addresses:4
 160 12.1.1.1         0
 161 12.1.1.2         1
 162 12.1.1.3         2
 163 12.1.1.4         3
 164       </pre></div><div class="refsect2" lang="en"><a name="id2528519"></a><h3>scriptstatus</h3><p>
 165         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.
 166       </p><p>
 167         Example: ctdb scriptstatus
 168       </p><p>
 169         Example output:
 170       </p><pre class="screen">
 171 7 scripts were executed last monitoring cycle
 172 00.ctdb              Status:OK    Duration:0.056 Tue Mar 24 18:56:57 2009
 173 10.interface         Status:OK    Duration:0.077 Tue Mar 24 18:56:57 2009
 174 11.natgw             Status:OK    Duration:0.039 Tue Mar 24 18:56:57 2009
 175 20.multipathd        Status:OK    Duration:0.038 Tue Mar 24 18:56:57 2009
 176 31.clamd             Status:DISABLED
 177 40.vsftpd            Status:OK    Duration:0.045 Tue Mar 24 18:56:57 2009
 178 41.httpd             Status:OK    Duration:0.039 Tue Mar 24 18:56:57 2009
 179 50.samba             Status:ERROR    Duration:0.082 Tue Mar 24 18:56:57 2009
 180    OUTPUT:ERROR: Samba tcp port 445 is not responding
 181       </pre></div><div class="refsect2" lang="en"><a name="id2528555"></a><h3>disablescript &lt;script&gt;</h3><p>
 182         This command is used to disable an eventscript.
 183       </p><p>
 184         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'.
 185       </p></div><div class="refsect2" lang="en"><a name="id2528572"></a><h3>enablescript &lt;script&gt;</h3><p>
 186         This command is used to enable an eventscript.
 187       </p><p>
 188         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'.
 189       </p></div><div class="refsect2" lang="en"><a name="id2528588"></a><h3>getvar &lt;name&gt;</h3><p>
 190         Get the runtime value of a tuneable variable.
 191       </p><p>
 192         Example: ctdb getvar MaxRedirectCount
 193       </p><p>
 194         Example output:
 195       </p><pre class="screen">
 196 MaxRedirectCount    = 3
 197       </pre></div><div class="refsect2" lang="en"><a name="id2528611"></a><h3>setvar &lt;name&gt; &lt;value&gt;</h3><p>
 198         Set the runtime value of a tuneable variable.
 199       </p><p>
 200         Example: ctdb setvar MaxRedirectCount 5
 201       </p></div><div class="refsect2" lang="en"><a name="id2528626"></a><h3>listvars</h3><p>
 202         List all tuneable variables.
 203       </p><p>
 204         Example: ctdb listvars
 205       </p><p>
 206         Example output:
 207       </p><pre class="screen">
 208 MaxRedirectCount    = 5
 209 SeqnumFrequency     = 1
 210 ControlTimeout      = 60
 211 TraverseTimeout     = 20
 212 KeepaliveInterval   = 2
 213 KeepaliveLimit      = 3
 214 MaxLACount          = 7
 215 RecoverTimeout      = 5
 216 RecoverInterval     = 1
 217 ElectionTimeout     = 3
 218 TakeoverTimeout     = 5
 219 MonitorInterval     = 15
 220 EventScriptTimeout  = 20
 221 RecoveryGracePeriod = 60
 222 RecoveryBanPeriod   = 300
 223       </pre></div><div class="refsect2" lang="en"><a name="id2528654"></a><h3>lvsmaster</h3><p>
 224       This command shows which node is currently the LVSMASTER. The
 225       LVSMASTER is the node in the cluster which drives the LVS system and
 226       which receives all incoming traffic from clients.
 227       </p><p>
 228       LVS is the mode where the entire CTDB/Samba cluster uses a single
 229       ip address for the entire cluster. In this mode all clients connect to
 230       one specific node which will then multiplex/loadbalance the clients
 231       evenly onto the other nodes in the cluster. This is an alternative to using
 232       public ip addresses. See the manpage for ctdbd for more information
 233       about LVS.
 234       </p></div><div class="refsect2" lang="en"><a name="id2528676"></a><h3>lvs</h3><p>
 235       This command shows which nodes in the cluster are currently active in the
 236       LVS configuration. I.e. which nodes we are currently loadbalancing
 237       the single ip address across.
 238       </p><p>
 239       LVS will by default only loadbalance across those nodes that are both
 240       LVS capable and also HEALTHY. Except if all nodes are UNHEALTHY in which
 241       case LVS will loadbalance across all UNHEALTHY nodes as well.
 242       LVS will never use nodes that are DISCONNECTED, STOPPED, BANNED or
 243       DISABLED.
 244       </p><p>
 245         Example output:
 246       </p><pre class="screen">
 247 2:10.0.0.13
 248 3:10.0.0.14
 249       </pre></div><div class="refsect2" lang="en"><a name="id2528706"></a><h3>getcapabilities</h3><p>
 250       This command shows the capabilities of the current node.
 251       Please see manpage for ctdbd for a full list of all capabilities and
 252       more detailed description.
 253       </p><p>
 254       RECMASTER and LMASTER capabilities are primarily used when CTDBD
 255       is used to create a cluster spanning across WAN links. In which case
 256       ctdbd acts as a WAN accelerator.
 257       </p><p>
 258       LVS capabile means that the node is participating in LVS, a mode
 259       where the entire CTDB cluster uses one single ip address for the
 260       entire cluster instead of using public ip address failover.
 261       This is an alternative to using a loadbalancing layer-4 switch.
 262       </p><p>
 263         Example output:
 264       </p><pre class="screen">
 265 RECMASTER: YES
 266 LMASTER: YES
 267 LVS: NO
 268       </pre></div><div class="refsect2" lang="en"><a name="id2528742"></a><h3>statistics</h3><p>
 269         Collect statistics from the CTDB daemon about how many calls it has served.
 270       </p><p>
 271         Example: ctdb statistics
 272       </p><p>
 273         Example output:
 274       </p><pre class="screen">
 275 CTDB version 1
 276  num_clients                        3
 277  frozen                             0
 278  recovering                         0
 279  client_packets_sent           360489
 280  client_packets_recv           360466
 281  node_packets_sent             480931
 282  node_packets_recv             240120
 283  keepalive_packets_sent             4
 284  keepalive_packets_recv             3
 285  node
 286      req_call                       2
 287      reply_call                     2
 288      req_dmaster                    0
 289      reply_dmaster                  0
 290      reply_error                    0
 291      req_message                   42
 292      req_control               120408
 293      reply_control             360439
 294  client
 295      req_call                       2
 296      req_message                   24
 297      req_control               360440
 298  timeouts
 299      call                           0
 300      control                        0
 301      traverse                       0
 302  total_calls                        2
 303  pending_calls                      0
 304  lockwait_calls                     0
 305  pending_lockwait_calls             0
 306  memory_used                     5040
 307  max_hop_count                      0
 308  max_call_latency                   4.948321 sec
 309  max_lockwait_latency               0.000000 sec
 310       </pre></div><div class="refsect2" lang="en"><a name="id2528786"></a><h3>statisticsreset</h3><p>
 311         This command is used to clear all statistics counters in a node.
 312       </p><p>
 313         Example: ctdb statisticsreset
 314       </p></div><div class="refsect2" lang="en"><a name="id2528800"></a><h3>getreclock</h3><p>
 315         This command is used to show the filename of the reclock file that is used.
 316       </p><p>
 317         Example output:
 318       </p><pre class="screen">
 319 Reclock file:/gpfs/.ctdb/shared
 320       </pre></div><div class="refsect2" lang="en"><a name="id2528820"></a><h3>setreclock [filename]</h3><p>
 321         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".
 322       </p><p>
 323         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.
 324       </p><p>
 325         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.
 326       </p></div><div class="refsect2" lang="en"><a name="id2528846"></a><h3>getdebug</h3><p>
 327         Get the current debug level for the node. the debug level controls what information is written to the log file.
 328       </p><p>
 329         The debug levels are mapped to the corresponding syslog levels.
 330         When a debug level is set, only those messages at that level and higher
 331         levels will be printed.
 332       </p><p>
 333         The list of debug levels from highest to lowest are :
 334       </p><p>
 335         EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
 336       </p></div><div class="refsect2" lang="en"><a name="id2528872"></a><h3>setdebug &lt;debuglevel&gt;</h3><p>
 337         Set the debug level of a node. This controls what information will be logged.
 338       </p><p>
 339         The debuglevel is one of EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
 340       </p></div><div class="refsect2" lang="en"><a name="id2528888"></a><h3>getpid</h3><p>
 341         This command will return the process id of the ctdb daemon.
 342       </p></div><div class="refsect2" lang="en"><a name="id2528898"></a><h3>disable</h3><p>
 343         This command is used to administratively disable a node in the cluster.
 344         A disabled node will still participate in the cluster and host
 345         clustered TDB records but its public ip address has been taken over by
 346         a different node and it no longer hosts any services.
 347       </p></div><div class="refsect2" lang="en"><a name="id2528912"></a><h3>enable</h3><p>
 348         Re-enable a node that has been administratively disabled.
 349       </p></div><div class="refsect2" lang="en"><a name="id2528922"></a><h3>stop</h3><p>
 350         This command is used to administratively STOP a node in the cluster.
 351         A STOPPED node is connected to the cluster but will not host any
 352         public ip addresse, nor does it participate in the VNNMAP.
 353         The difference between a DISABLED node and a STOPPED node is that
 354         a STOPPED node does not host any parts of the database which means
 355         that a recovery is required to stop/continue nodes.
 356       </p></div><div class="refsect2" lang="en"><a name="id2528937"></a><h3>continue</h3><p>
 357         Re-start a node that has been administratively stopped.
 358       </p></div><div class="refsect2" lang="en"><a name="id2528948"></a><h3>addip &lt;public_ip/mask&gt; &lt;iface&gt;</h3><p>
 359         This command is used to add a new public ip to a node during runtime.
 360         This allows public addresses to be added to a cluster without having
 361         to restart the ctdb daemons.
 362       </p><p>
 363         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.
 364  If you want this change to be permanent you must also update the public addresses file manually.
 365       </p></div><div class="refsect2" lang="en"><a name="id2528968"></a><h3>delip &lt;public_ip&gt;</h3><p>
 366         This command is used to remove a public ip from a node during runtime.
 367         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.
 368       </p><p>
 369         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.
 370  If you want this change to be permanent you must also update the public addresses file manually.
 371       </p></div><div class="refsect2" lang="en"><a name="id2528989"></a><h3>moveip &lt;public_ip&gt; &lt;node&gt;</h3><p>
 372       This command can be used to manually fail a public ip address to a
 373       specific node.
 374       </p><p>
 375       In order to manually override the "automatic" distribution of public
 376       ip addresses that ctdb normally provides, this command only works
 377       when you have changed the tunables for the daemon to:
 378       </p><p>
 379       DeterministicIPs = 0
 380       </p><p>
 381       NoIPFailback = 1
 382       </p></div><div class="refsect2" lang="en"><a name="id2529014"></a><h3>shutdown</h3><p>
 383         This command will shutdown a specific CTDB daemon.
 384       </p></div><div class="refsect2" lang="en"><a name="id2529024"></a><h3>recover</h3><p>
 385         This command will trigger the recovery daemon to do a cluster
 386         recovery.
 387       </p></div><div class="refsect2" lang="en"><a name="id2529034"></a><h3>ipreallocate</h3><p>
 388         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.
 389       </p></div><div class="refsect2" lang="en"><a name="id2529050"></a><h3>setlmasterrole &lt;on|off&gt;</h3><p>
 390         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.
 391       </p><p>
 392         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.
 393       </p><p>
 394         Once this setting has been enabled/disabled, you need to perform a recovery for it to take effect.
 395       </p><p>
 396         See also "ctdb getcapabilities"
 397       </p></div><div class="refsect2" lang="en"><a name="id2529079"></a><h3>setrecmasterrole &lt;on|off&gt;</h3><p>
 398         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.
 399       </p><p>
 400         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.
 401       </p><p>
 402         See also "ctdb getcapabilities"
 403       </p></div><div class="refsect2" lang="en"><a name="id2529105"></a><h3>killtcp &lt;srcip:port&gt; &lt;dstip:port&gt;</h3><p>
 404         This command will kill the specified TCP connection by issuing a
 405         TCP RST to the srcip:port endpoint. This is a command used by the
 406         ctdb eventscripts.
 407       </p></div><div class="refsect2" lang="en"><a name="id2529118"></a><h3>gratiousarp &lt;ip&gt; &lt;interface&gt;</h3><p>
 408         This command will send out a gratious arp for the specified interface
 409         through the specified interface. This command is mainly used by the
 410         ctdb eventscripts.
 411       </p></div><div class="refsect2" lang="en"><a name="id2529130"></a><h3>reloadnodes</h3><p>
 412       This command is used when adding new nodes, or removing existing nodes from an existing cluster.
 413       </p><p>
 414       Procedure to add a node:
 415       </p><p>
 416       1, To expand an existing cluster, first ensure with 'ctdb status' that
 417       all nodes are up and running and that they are all healthy.
 418       Do not try to expand a cluster unless it is completely healthy!
 419       </p><p>
 420       2, On all nodes, edit /etc/ctdb/nodes and add the new node as the last
 421       entry to the file. The new node MUST be added to the end of this file!
 422       </p><p>
 423       3, Verify that all the nodes have identical /etc/ctdb/nodes files after you edited them and added the new node!
 424       </p><p>
 425       4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
 426       </p><p>
 427       5, Use 'ctdb status' on all nodes and verify that they now show the additional node.
 428       </p><p>
 429       6, Install and configure the new node and bring it online.
 430       </p><p>
 431       Procedure to remove a node:
 432       </p><p>
 433       1, To remove a node from an existing cluster, first ensure with 'ctdb status' that
 434       all nodes, except the node to be deleted, are up and running and that they are all healthy.
 435       Do not try to remove a node from a cluster unless the cluster is completely healthy!
 436       </p><p>
 437       2, Shutdown and poerwoff the node to be removed.
 438       </p><p>
 439       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.
 440       </p><p>
 441       4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
 442       </p><p>
 443       5, Use 'ctdb status' on all nodes and verify that the deleted node no longer shows up in the list..
 444       </p><p>
 445       </p></div><div class="refsect2" lang="en"><a name="id2529214"></a><h3>tickle &lt;srcip:port&gt; &lt;dstip:port&gt;</h3><p>
 446         This command will will send a TCP tickle to the source host for the
 447         specified TCP connection.
 448         A TCP tickle is a TCP ACK packet with an invalid sequence and
 449         acknowledge number and will when received by the source host result
 450         in it sending an immediate correct ACK back to the other end.
 451       </p><p>
 452         TCP tickles are useful to "tickle" clients after a IP failover has
 453         occured since this will make the client immediately recognize the
 454         TCP connection has been disrupted and that the client will need
 455         to reestablish. This greatly speeds up the time it takes for a client
 456         to detect and reestablish after an IP failover in the ctdb cluster.
 457       </p></div><div class="refsect2" lang="en"><a name="id2529239"></a><h3>gettickles &lt;ip&gt;</h3><p>
 458         This command is used to show which TCP connections are registered with
 459         CTDB to be "tickled" if there is a failover.
 460       </p></div><div class="refsect2" lang="en"><a name="id2529250"></a><h3>repack [max_freelist]</h3><p>
 461         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.
 462         This command is used to defragment a TDB database and pruning the freelist.
 463       </p><p>
 464         If [max_freelist] is specified, then a database will only be repacked if it has more than this number of entries in the freelist.
 465         </p><p>
 466         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.
 467       </p><p>
 468         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.
 469       </p><p>
 470         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.
 471         </p><p>
 472         Example: ctdb repack 1000
 473       </p><p>
 474          By default, this operation is issued from the 00.ctdb event script every 5 minutes.
 475       </p></div><div class="refsect2" lang="en"><a name="id2529296"></a><h3>vacuum [max_records]</h3><p>
 476         Over time CTDB databases will fill up with empty deleted records which will lead to a progressive slow down of CTDB database access.
 477         This command is used to prune all databases and delete all empty records from the cluster.
 478       </p><p>
 479          By default, vacuum will delete all empty records from all databases.
 480          If [max_records] is specified, the command will only delete the first
 481          [max_records] empty records for each database.
 482       </p><p>
 483          Vacuum only deletes records where the local node is the lmaster.
 484          To delete all records from the entire cluster you need to run a vacuum from each node.
 485
 486          This command is not disruptive. Samba is unaffected and will still be able to read/write records normally while the database is being vacuumed.
 487       </p><p>
 488         Example: ctdb vacuum
 489       </p><p>
 490          By default, this operation is issued from the 00.ctdb event script every 5 minutes.
 491       </p></div><div class="refsect2" lang="en"><a name="id2529332"></a><h3>backupdb &lt;database&gt; &lt;file&gt;</h3><p>
 492         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.
 493 This is mainly useful for backing up persistent databases such as secrets.tdb and similar.
 494       </p></div><div class="refsect2" lang="en"><a name="id2529346"></a><h3>restoredb &lt;file&gt;</h3><p>
 495         This command restores a persistent database that was previously backed up using backupdb.
 496       </p></div></div><div class="refsect1" lang="en"><a name="id2529358"></a><h2>Debugging Commands</h2><p>
 497       These commands are primarily used for CTDB development and testing and
 498       should not be used for normal administration.
 499     </p><div class="refsect2" lang="en"><a name="id2529368"></a><h3>process-exists &lt;pid&gt;</h3><p>
 500         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.
 501       </p></div><div class="refsect2" lang="en"><a name="id2529381"></a><h3>getdbmap</h3><p>
 502         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.
 503         </p><p>
 504         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.
 505       </p><p>
 506         Example: ctdb getdbmap
 507       </p><p>
 508         Example output:
 509       </p><pre class="screen">
 510 Number of databases:10
 511 dbid:0x435d3410 name:notify.tdb path:/var/ctdb/notify.tdb.0
 512 dbid:0x42fe72c5 name:locking.tdb path:/var/ctdb/locking.tdb.0 dbid:0x1421fb78 name:brlock.tdb path:/var/ctdb/brlock.tdb.0
 513 dbid:0x17055d90 name:connections.tdb path:/var/ctdb/connections.tdb.0
 514 dbid:0xc0bdde6a name:sessionid.tdb path:/var/ctdb/sessionid.tdb.0
 515 dbid:0x122224da name:test.tdb path:/var/ctdb/test.tdb.0
 516 dbid:0x2672a57f name:idmap2.tdb path:/var/ctdb/persistent/idmap2.tdb.0 PERSISTENT
 517 dbid:0xb775fff6 name:secrets.tdb path:/var/ctdb/persistent/secrets.tdb.0 PERSISTENT
 518 dbid:0xe98e08b6 name:group_mapping.tdb path:/var/ctdb/persistent/group_mapping.tdb.0 PERSISTENT
 519 dbid:0x7bbbd26c name:passdb.tdb path:/var/ctdb/persistent/passdb.tdb.0 PERSISTENT
 520       </pre></div><div class="refsect2" lang="en"><a name="id2529427"></a><h3>catdb &lt;dbname&gt;</h3><p>
 521         This command will dump a clustered TDB database to the screen. This is a debugging command.
 522       </p></div><div class="refsect2" lang="en"><a name="id2529438"></a><h3>getmonmode</h3><p>
 523         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.
 524       </p><p>
 525         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.
 526       </p><p>
 527         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.
 528       </p></div><div class="refsect2" lang="en"><a name="id2529468"></a><h3>setmonmode &lt;0|1&gt;</h3><p>
 529         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.
 530       </p></div><div class="refsect2" lang="en"><a name="id2529484"></a><h3>attach &lt;dbname&gt;</h3><p>
 531         This is a debugging command. This command will make the CTDB daemon create a new CTDB database and attach to it.
 532       </p></div><div class="refsect2" lang="en"><a name="id2529495"></a><h3>dumpmemory</h3><p>
 533         This is a debugging command. This command will make the ctdb
 534         daemon to write a fill memory allocation map to standard output.
 535       </p></div><div class="refsect2" lang="en"><a name="id2529507"></a><h3>rddumpmemory</h3><p>
 536         This is a debugging command. This command will dump the talloc memory
 537         allocation tree for the recovery daemon to standard output.
 538       </p></div><div class="refsect2" lang="en"><a name="id2529518"></a><h3>freeze</h3><p>
 539         This command will lock all the local TDB databases causing clients
 540         that are accessing these TDBs such as samba3 to block until the
 541         databases are thawed.
 542       </p><p>
 543         This is primarily used by the recovery daemon to stop all samba
 544         daemons from accessing any databases while the database is recovered
 545         and rebuilt.
 546       </p></div><div class="refsect2" lang="en"><a name="id2529537"></a><h3>thaw</h3><p>
 547         Thaw a previously frozen node.
 548       </p></div><div class="refsect2" lang="en"><a name="id2529546"></a><h3>eventscript &lt;arguments&gt;</h3><p>
 549         This is a debugging command. This command can be used to manually
 550         invoke and run the eventscritps with arbitrary arguments.
 551       </p></div><div class="refsect2" lang="en"><a name="id2529558"></a><h3>ban &lt;bantime|0&gt;</h3><p>
 552         Administratively ban a node for bantime seconds. A bantime of 0 means that the node should be permanently banned.
 553       </p><p>
 554         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.
 555       </p><p>
 556         Nodes are automatically banned if they are the cause of too many
 557         cluster recoveries.
 558       </p></div><div class="refsect2" lang="en"><a name="id2476137"></a><h3>unban</h3><p>
 559         This command is used to unban a node that has either been
 560         administratively banned using the ban command or has been automatically
 561         banned by the recovery daemon.
 562       </p></div></div><div class="refsect1" lang="en"><a name="id2476150"></a><h2>SEE ALSO</h2><p>
 563       ctdbd(1), onnode(1)
 564       <a class="ulink" href="http://ctdb.samba.org/" target="_top">http://ctdb.samba.org/</a>
 565     </p></div><div class="refsect1" lang="en"><a name="id2476163"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
 566 Copyright (C) Andrew Tridgell 2007<br>
 567 Copyright (C) Ronnie sahlberg 2007<br>
 568 <br>
 569 This program is free software; you can redistribute it and/or modify<br>
 570 it under the terms of the GNU General Public License as published by<br>
 571 the Free Software Foundation; either version 3 of the License, or (at<br>
 572 your option) any later version.<br>
 573 <br>
 574 This program is distributed in the hope that it will be useful, but<br>
 575 WITHOUT ANY WARRANTY; without even the implied warranty of<br>
 576 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU<br>
 577 General Public License for more details.<br>
 578 <br>
 579 You should have received a copy of the GNU General Public License<br>
 580 along with this program; if not, see http://www.gnu.org/licenses/.<br>
 581 </p></div></div></div></body></html>