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="id2478418"></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="id2478428"></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="id2479699"></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="id2479708"></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="id2479717"></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="id2479726"></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="id2479787"></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="id2479822"></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="id2479836"></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="id2528526"></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="id2528562"></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="id2528573"></a><h3>uptime</h3><p>
 124         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.
 125       </p><p>
 126         Example: ctdb uptime
 127       </p><p>Example output:</p><pre class="screen">
 128 Current time of node          :                Thu Oct 29 10:38:54 2009
 129 Ctdbd start time              : (000 16:54:28) Wed Oct 28 17:44:26 2009
 130 Time of last recovery/failover: (000 16:53:31) Wed Oct 28 17:45:23 2009
 131 Duration of last recovery/failover: 2.248552 seconds
 132       </pre></div><div class="refsect2" lang="en"><a name="id2528604"></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="id2528627"></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="id2528654"></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="id2528682"></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="id2528718"></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="id2528734"></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="id2528751"></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="id2528774"></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="id2528788"></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    = 3
 209 SeqnumInterval      = 1000
 210 ControlTimeout      = 60
 211 TraverseTimeout     = 20
 212 KeepaliveInterval   = 5
 213 KeepaliveLimit      = 5
 214 MaxLACount          = 7
 215 RecoverTimeout      = 20
 216 RecoverInterval     = 1
 217 ElectionTimeout     = 3
 218 TakeoverTimeout     = 5
 219 MonitorInterval     = 15
 220 TickleUpdateInterval = 20
 221 EventScriptTimeout  = 30
 222 EventScriptBanCount = 10
 223 EventScriptUnhealthyOnTimeout = 0
 224 RecoveryGracePeriod = 120
 225 RecoveryBanPeriod   = 300
 226 DatabaseHashSize    = 10000
 227 DatabaseMaxDead     = 5
 228 RerecoveryTimeout   = 10
 229 EnableBans          = 1
 230 DeterministicIPs    = 1
 231 DisableWhenUnhealthy = 0
 232 ReclockPingPeriod   = 60
 233 NoIPFailback        = 0
 234 VerboseMemoryNames  = 0
 235 RecdPingTimeout     = 60
 236 RecdFailCount       = 10
 237 LogLatencyMs        = 0
 238 RecLockLatencyMs    = 1000
 239 RecoveryDropAllIPs  = 60
 240 VerifyRecoveryLock  = 1
 241 VacuumDefaultInterval = 300
 242 VacuumMaxRunTime    = 30
 243 RepackLimit         = 10000
 244 VacuumLimit         = 5000
 245 VacuumMinInterval   = 60
 246 VacuumMaxInterval   = 600
 247 MaxQueueDropMsg     = 1000
 248 UseStatusEvents     = 0
 249 AllowUnhealthyDBRead = 0
 250       </pre></div><div class="refsect2" lang="en"><a name="id2528846"></a><h3>lvsmaster</h3><p>
 251       This command shows which node is currently the LVSMASTER. The
 252       LVSMASTER is the node in the cluster which drives the LVS system and
 253       which receives all incoming traffic from clients.
 254       </p><p>
 255       LVS is the mode where the entire CTDB/Samba cluster uses a single
 256       ip address for the entire cluster. In this mode all clients connect to
 257       one specific node which will then multiplex/loadbalance the clients
 258       evenly onto the other nodes in the cluster. This is an alternative to using
 259       public ip addresses. See the manpage for ctdbd for more information
 260       about LVS.
 261       </p></div><div class="refsect2" lang="en"><a name="id2528868"></a><h3>lvs</h3><p>
 262       This command shows which nodes in the cluster are currently active in the
 263       LVS configuration. I.e. which nodes we are currently loadbalancing
 264       the single ip address across.
 265       </p><p>
 266       LVS will by default only loadbalance across those nodes that are both
 267       LVS capable and also HEALTHY. Except if all nodes are UNHEALTHY in which
 268       case LVS will loadbalance across all UNHEALTHY nodes as well.
 269       LVS will never use nodes that are DISCONNECTED, STOPPED, BANNED or
 270       DISABLED.
 271       </p><p>
 272         Example output:
 273       </p><pre class="screen">
 274 2:10.0.0.13
 275 3:10.0.0.14
 276       </pre></div><div class="refsect2" lang="en"><a name="id2528898"></a><h3>getcapabilities</h3><p>
 277       This command shows the capabilities of the current node.
 278       Please see manpage for ctdbd for a full list of all capabilities and
 279       more detailed description.
 280       </p><p>
 281       RECMASTER and LMASTER capabilities are primarily used when CTDBD
 282       is used to create a cluster spanning across WAN links. In which case
 283       ctdbd acts as a WAN accelerator.
 284       </p><p>
 285       LVS capabile means that the node is participating in LVS, a mode
 286       where the entire CTDB cluster uses one single ip address for the
 287       entire cluster instead of using public ip address failover.
 288       This is an alternative to using a loadbalancing layer-4 switch.
 289       </p><p>
 290         Example output:
 291       </p><pre class="screen">
 292 RECMASTER: YES
 293 LMASTER: YES
 294 LVS: NO
 295       </pre></div><div class="refsect2" lang="en"><a name="id2528935"></a><h3>statistics</h3><p>
 296         Collect statistics from the CTDB daemon about how many calls it has served.
 297       </p><p>
 298         Example: ctdb statistics
 299       </p><p>
 300         Example output:
 301       </p><pre class="screen">
 302 CTDB version 1
 303  num_clients                        3
 304  frozen                             0
 305  recovering                         0
 306  client_packets_sent           360489
 307  client_packets_recv           360466
 308  node_packets_sent             480931
 309  node_packets_recv             240120
 310  keepalive_packets_sent             4
 311  keepalive_packets_recv             3
 312  node
 313      req_call                       2
 314      reply_call                     2
 315      req_dmaster                    0
 316      reply_dmaster                  0
 317      reply_error                    0
 318      req_message                   42
 319      req_control               120408
 320      reply_control             360439
 321  client
 322      req_call                       2
 323      req_message                   24
 324      req_control               360440
 325  timeouts
 326      call                           0
 327      control                        0
 328      traverse                       0
 329  total_calls                        2
 330  pending_calls                      0
 331  lockwait_calls                     0
 332  pending_lockwait_calls             0
 333  memory_used                     5040
 334  max_hop_count                      0
 335  max_call_latency                   4.948321 sec
 336  max_lockwait_latency               0.000000 sec
 337       </pre></div><div class="refsect2" lang="en"><a name="id2528999"></a><h3>statisticsreset</h3><p>
 338         This command is used to clear all statistics counters in a node.
 339       </p><p>
 340         Example: ctdb statisticsreset
 341       </p></div><div class="refsect2" lang="en"><a name="id2529013"></a><h3>getreclock</h3><p>
 342         This command is used to show the filename of the reclock file that is used.
 343       </p><p>
 344         Example output:
 345       </p><pre class="screen">
 346 Reclock file:/gpfs/.ctdb/shared
 347       </pre></div><div class="refsect2" lang="en"><a name="id2529033"></a><h3>setreclock [filename]</h3><p>
 348         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".
 349       </p><p>
 350         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.
 351       </p><p>
 352         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.
 353       </p></div><div class="refsect2" lang="en"><a name="id2529059"></a><h3>getdebug</h3><p>
 354         Get the current debug level for the node. the debug level controls what information is written to the log file.
 355       </p><p>
 356         The debug levels are mapped to the corresponding syslog levels.
 357         When a debug level is set, only those messages at that level and higher
 358         levels will be printed.
 359       </p><p>
 360         The list of debug levels from highest to lowest are :
 361       </p><p>
 362         EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
 363       </p></div><div class="refsect2" lang="en"><a name="id2529085"></a><h3>setdebug &lt;debuglevel&gt;</h3><p>
 364         Set the debug level of a node. This controls what information will be logged.
 365       </p><p>
 366         The debuglevel is one of EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
 367       </p></div><div class="refsect2" lang="en"><a name="id2529101"></a><h3>getpid</h3><p>
 368         This command will return the process id of the ctdb daemon.
 369       </p></div><div class="refsect2" lang="en"><a name="id2529111"></a><h3>disable</h3><p>
 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.
 374       </p></div><div class="refsect2" lang="en"><a name="id2529125"></a><h3>enable</h3><p>
 375         Re-enable a node that has been administratively disabled.
 376       </p></div><div class="refsect2" lang="en"><a name="id2529135"></a><h3>stop</h3><p>
 377         This command is used to administratively STOP a node in the cluster.
 378         A STOPPED node is connected to the cluster but will not host any
 379         public ip addresse, nor does it participate in the VNNMAP.
 380         The difference between a DISABLED node and a STOPPED node is that
 381         a STOPPED node does not host any parts of the database which means
 382         that a recovery is required to stop/continue nodes.
 383       </p></div><div class="refsect2" lang="en"><a name="id2529151"></a><h3>continue</h3><p>
 384         Re-start a node that has been administratively stopped.
 385       </p></div><div class="refsect2" lang="en"><a name="id2529161"></a><h3>addip &lt;public_ip/mask&gt; &lt;iface&gt;</h3><p>
 386         This command is used to add a new public ip to a node during runtime.
 387         This allows public addresses to be added to a cluster without having
 388         to restart the ctdb daemons.
 389       </p><p>
 390         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.
 391  If you want this change to be permanent you must also update the public addresses file manually.
 392       </p></div><div class="refsect2" lang="en"><a name="id2529181"></a><h3>delip &lt;public_ip&gt;</h3><p>
 393         This command is used to remove a public ip from a node during runtime.
 394         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.
 395       </p><p>
 396         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.
 397  If you want this change to be permanent you must also update the public addresses file manually.
 398       </p></div><div class="refsect2" lang="en"><a name="id2529202"></a><h3>moveip &lt;public_ip&gt; &lt;node&gt;</h3><p>
 399       This command can be used to manually fail a public ip address to a
 400       specific node.
 401       </p><p>
 402       In order to manually override the "automatic" distribution of public
 403       ip addresses that ctdb normally provides, this command only works
 404       when you have changed the tunables for the daemon to:
 405       </p><p>
 406       DeterministicIPs = 0
 407       </p><p>
 408       NoIPFailback = 1
 409       </p></div><div class="refsect2" lang="en"><a name="id2529227"></a><h3>shutdown</h3><p>
 410         This command will shutdown a specific CTDB daemon.
 411       </p></div><div class="refsect2" lang="en"><a name="id2529237"></a><h3>recover</h3><p>
 412         This command will trigger the recovery daemon to do a cluster
 413         recovery.
 414       </p></div><div class="refsect2" lang="en"><a name="id2529247"></a><h3>ipreallocate</h3><p>
 415         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.
 416       </p></div><div class="refsect2" lang="en"><a name="id2529263"></a><h3>setlmasterrole &lt;on|off&gt;</h3><p>
 417         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.
 418       </p><p>
 419         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.
 420       </p><p>
 421         Once this setting has been enabled/disabled, you need to perform a recovery for it to take effect.
 422       </p><p>
 423         See also "ctdb getcapabilities"
 424       </p></div><div class="refsect2" lang="en"><a name="id2529292"></a><h3>setrecmasterrole &lt;on|off&gt;</h3><p>
 425         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.
 426       </p><p>
 427         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.
 428       </p><p>
 429         See also "ctdb getcapabilities"
 430       </p></div><div class="refsect2" lang="en"><a name="id2529318"></a><h3>killtcp &lt;srcip:port&gt; &lt;dstip:port&gt;</h3><p>
 431         This command will kill the specified TCP connection by issuing a
 432         TCP RST to the srcip:port endpoint. This is a command used by the
 433         ctdb eventscripts.
 434       </p></div><div class="refsect2" lang="en"><a name="id2529331"></a><h3>gratiousarp &lt;ip&gt; &lt;interface&gt;</h3><p>
 435         This command will send out a gratious arp for the specified interface
 436         through the specified interface. This command is mainly used by the
 437         ctdb eventscripts.
 438       </p></div><div class="refsect2" lang="en"><a name="id2529343"></a><h3>reloadnodes</h3><p>
 439       This command is used when adding new nodes, or removing existing nodes from an existing cluster.
 440       </p><p>
 441       Procedure to add a node:
 442       </p><p>
 443       1, To expand an existing cluster, first ensure with 'ctdb status' that
 444       all nodes are up and running and that they are all healthy.
 445       Do not try to expand a cluster unless it is completely healthy!
 446       </p><p>
 447       2, On all nodes, edit /etc/ctdb/nodes and add the new node as the last
 448       entry to the file. The new node MUST be added to the end of this file!
 449       </p><p>
 450       3, Verify that all the nodes have identical /etc/ctdb/nodes files after you edited them and added the new node!
 451       </p><p>
 452       4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
 453       </p><p>
 454       5, Use 'ctdb status' on all nodes and verify that they now show the additional node.
 455       </p><p>
 456       6, Install and configure the new node and bring it online.
 457       </p><p>
 458       Procedure to remove a node:
 459       </p><p>
 460       1, To remove a node from an existing cluster, first ensure with 'ctdb status' that
 461       all nodes, except the node to be deleted, are up and running and that they are all healthy.
 462       Do not try to remove a node from a cluster unless the cluster is completely healthy!
 463       </p><p>
 464       2, Shutdown and poerwoff the node to be removed.
 465       </p><p>
 466       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.
 467       </p><p>
 468       4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
 469       </p><p>
 470       5, Use 'ctdb status' on all nodes and verify that the deleted node no longer shows up in the list..
 471       </p><p>
 472       </p></div><div class="refsect2" lang="en"><a name="id2529427"></a><h3>tickle &lt;srcip:port&gt; &lt;dstip:port&gt;</h3><p>
 473         This command will will send a TCP tickle to the source host for the
 474         specified TCP connection.
 475         A TCP tickle is a TCP ACK packet with an invalid sequence and
 476         acknowledge number and will when received by the source host result
 477         in it sending an immediate correct ACK back to the other end.
 478       </p><p>
 479         TCP tickles are useful to "tickle" clients after a IP failover has
 480         occured since this will make the client immediately recognize the
 481         TCP connection has been disrupted and that the client will need
 482         to reestablish. This greatly speeds up the time it takes for a client
 483         to detect and reestablish after an IP failover in the ctdb cluster.
 484       </p></div><div class="refsect2" lang="en"><a name="id2529452"></a><h3>gettickles &lt;ip&gt;</h3><p>
 485         This command is used to show which TCP connections are registered with
 486         CTDB to be "tickled" if there is a failover.
 487       </p></div><div class="refsect2" lang="en"><a name="id2529463"></a><h3>repack [max_freelist]</h3><p>
 488         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.
 489         This command is used to defragment a TDB database and pruning the freelist.
 490       </p><p>
 491         If [max_freelist] is specified, then a database will only be repacked if it has more than this number of entries in the freelist.
 492         </p><p>
 493         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.
 494       </p><p>
 495         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.
 496       </p><p>
 497         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.
 498         </p><p>
 499         Example: ctdb repack 1000
 500       </p><p>
 501          By default, this operation is issued from the 00.ctdb event script every 5 minutes.
 502       </p></div><div class="refsect2" lang="en"><a name="id2529510"></a><h3>vacuum [max_records]</h3><p>
 503         Over time CTDB databases will fill up with empty deleted records which will lead to a progressive slow down of CTDB database access.
 504         This command is used to prune all databases and delete all empty records from the cluster.
 505       </p><p>
 506          By default, vacuum will delete all empty records from all databases.
 507          If [max_records] is specified, the command will only delete the first
 508          [max_records] empty records for each database.
 509       </p><p>
 510          Vacuum only deletes records where the local node is the lmaster.
 511          To delete all records from the entire cluster you need to run a vacuum from each node.
 512
 513          This command is not disruptive. Samba is unaffected and will still be able to read/write records normally while the database is being vacuumed.
 514       </p><p>
 515         Example: ctdb vacuum
 516       </p><p>
 517          By default, this operation is issued from the 00.ctdb event script every 5 minutes.
 518       </p></div><div class="refsect2" lang="en"><a name="id2529545"></a><h3>backupdb &lt;dbname&gt; &lt;file&gt;</h3><p>
 519         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.
 520 This is mainly useful for backing up persistent databases such as secrets.tdb and similar.
 521       </p></div><div class="refsect2" lang="en"><a name="id2529559"></a><h3>restoredb &lt;file&gt;</h3><p>
 522         This command restores a persistent database that was previously backed up using backupdb.
 523       </p></div><div class="refsect2" lang="en"><a name="id2476127"></a><h3>wipedb &lt;dbname&gt;</h3><p>
 524         This command can be used to remove all content of a database.
 525       </p></div></div><div class="refsect2" lang="en"><a name="id2476138"></a><h3>getlog &lt;level&gt;</h3><p>
 526         In addition to the normal loggign to a log file,
 527         CTDBD also keeps a in-memory ringbuffer containing the most recent
 528         log entries for all log levels (except DEBUG).
 529       </p><p>
 530         This is useful since it allows for keeping continous logs to a file
 531         at a reasonable non-verbose level, but shortly after an incident has
 532         occured, a much more detailed log can be pulled from memory. This
 533         can allow you to avoid having to reproduce an issue due to the
 534         on-disk logs being of insufficient detail.
 535       </p><p>
 536         This command extracts all messages of level or lower log level from
 537         memory and prints it to the screen.
 538       </p></div><div class="refsect2" lang="en"><a name="id2476161"></a><h3>clearlog</h3><p>
 539         This command clears the in-memory logging ringbuffer.
 540       </p></div><div class="refsect1" lang="en"><a name="id2476171"></a><h2>Debugging Commands</h2><p>
 541       These commands are primarily used for CTDB development and testing and
 542       should not be used for normal administration.
 543     </p><div class="refsect2" lang="en"><a name="id2476182"></a><h3>process-exists &lt;pid&gt;</h3><p>
 544         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.
 545       </p></div><div class="refsect2" lang="en"><a name="id2476194"></a><h3>getdbmap</h3><p>
 546         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.
 547       </p><p>
 548         If a PERSISTENT database is not in a healthy state the database is
 549         flagged as UNHEALTHY. If there's at least one completely healthy node running in
 550         the cluster, it's possible that the content is restored by a recovery
 551         run automaticly. Otherwise an administrator needs to analyze the
 552         problem.
 553       </p><p>
 554         See also "ctdb getdbstatus", "ctdb backupdb", "ctdb restoredb",
 555         "ctdb dumpbackup", "ctdb wipedb", "ctdb setvar AllowUnhealthyDBRead 1"
 556         and (if samba or tdb-utils are installed) "tdbtool check".
 557         </p><p>
 558         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.
 559       </p><p>
 560         Example: ctdb getdbmap
 561       </p><p>
 562         Example output:
 563       </p><pre class="screen">
 564 Number of databases:10
 565 dbid:0x435d3410 name:notify.tdb path:/var/ctdb/notify.tdb.0
 566 dbid:0x42fe72c5 name:locking.tdb path:/var/ctdb/locking.tdb.0 dbid:0x1421fb78 name:brlock.tdb path:/var/ctdb/brlock.tdb.0
 567 dbid:0x17055d90 name:connections.tdb path:/var/ctdb/connections.tdb.0
 568 dbid:0xc0bdde6a name:sessionid.tdb path:/var/ctdb/sessionid.tdb.0
 569 dbid:0x122224da name:test.tdb path:/var/ctdb/test.tdb.0
 570 dbid:0x2672a57f name:idmap2.tdb path:/var/ctdb/persistent/idmap2.tdb.0 PERSISTENT
 571 dbid:0xb775fff6 name:secrets.tdb path:/var/ctdb/persistent/secrets.tdb.0 PERSISTENT
 572 dbid:0xe98e08b6 name:group_mapping.tdb path:/var/ctdb/persistent/group_mapping.tdb.0 PERSISTENT
 573 dbid:0x7bbbd26c name:passdb.tdb path:/var/ctdb/persistent/passdb.tdb.0 PERSISTENT
 574       </pre><p>
 575         Example output for an unhealthy database:
 576       </p><pre class="screen">
 577 Number of databases:1
 578 dbid:0xb775fff6 name:secrets.tdb path:/var/ctdb/persistent/secrets.tdb.0 PERSISTENT UNHEALTHY
 579       </pre><p>
 580         Example output for a healthy database as machinereadable output -Y:
 581       </p><pre class="screen">
 582 :ID:Name:Path:Persistent:Unhealthy:
 583 :0x7bbbd26c:passdb.tdb:/var/ctdb/persistent/passdb.tdb.0:1:0:
 584       </pre></div><div class="refsect2" lang="en"><a name="id2476279"></a><h3>getdbstatus &lt;dbname&gt;</h3><p>
 585         This command displays more details about a database.
 586       </p><p>
 587         Example: ctdb getdbstatus test.tdb.0
 588       </p><p>
 589         Example output:
 590       </p><pre class="screen">
 591 dbid: 0x122224da
 592 name: test.tdb
 593 path: /var/ctdb/test.tdb.0
 594 PERSISTENT: no
 595 HEALTH: OK
 596       </pre><p>
 597         Example: ctdb getdbstatus registry.tdb (with a corrupted TDB)
 598       </p><p>
 599         Example output:
 600       </p><pre class="screen">
 601 dbid: 0xf2a58948
 602 name: registry.tdb
 603 path: /var/ctdb/persistent/registry.tdb.0
 604 PERSISTENT: yes
 605 HEALTH: NO-HEALTHY-NODES - ERROR - Backup of corrupted TDB in '/var/ctdb/persistent/registry.tdb.0.corrupted.20091208091949.0Z'
 606       </pre></div><div class="refsect2" lang="en"><a name="id2476322"></a><h3>catdb &lt;dbname&gt;</h3><p>
 607         This command will dump a clustered TDB database to the screen. This is a debugging command.
 608       </p></div><div class="refsect2" lang="en"><a name="id2476332"></a><h3>dumpdbbackup &lt;backup-file&gt;</h3><p>
 609         This command will dump the content of database backup to the screen
 610         (similar to ctdb catdb). This is a debugging command.
 611       </p></div><div class="refsect2" lang="en"><a name="id2476344"></a><h3>getmonmode</h3><p>
 612         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.
 613       </p><p>
 614         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.
 615       </p><p>
 616         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.
 617       </p></div><div class="refsect2" lang="en"><a name="id2476375"></a><h3>setmonmode &lt;0|1&gt;</h3><p>
 618         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.
 619       </p></div><div class="refsect2" lang="en"><a name="id2476390"></a><h3>attach &lt;dbname&gt;</h3><p>
 620         This is a debugging command. This command will make the CTDB daemon create a new CTDB database and attach to it.
 621       </p></div><div class="refsect2" lang="en"><a name="id2476402"></a><h3>dumpmemory</h3><p>
 622         This is a debugging command. This command will make the ctdb
 623         daemon to write a fill memory allocation map to standard output.
 624       </p></div><div class="refsect2" lang="en"><a name="id2476413"></a><h3>rddumpmemory</h3><p>
 625         This is a debugging command. This command will dump the talloc memory
 626         allocation tree for the recovery daemon to standard output.
 627       </p></div><div class="refsect2" lang="en"><a name="id2476424"></a><h3>freeze</h3><p>
 628         This command will lock all the local TDB databases causing clients
 629         that are accessing these TDBs such as samba3 to block until the
 630         databases are thawed.
 631       </p><p>
 632         This is primarily used by the recovery daemon to stop all samba
 633         daemons from accessing any databases while the database is recovered
 634         and rebuilt.
 635       </p></div><div class="refsect2" lang="en"><a name="id2476443"></a><h3>thaw</h3><p>
 636         Thaw a previously frozen node.
 637       </p></div><div class="refsect2" lang="en"><a name="id2476452"></a><h3>eventscript &lt;arguments&gt;</h3><p>
 638         This is a debugging command. This command can be used to manually
 639         invoke and run the eventscritps with arbitrary arguments.
 640       </p></div><div class="refsect2" lang="en"><a name="id2476464"></a><h3>ban &lt;bantime|0&gt;</h3><p>
 641         Administratively ban a node for bantime seconds. A bantime of 0 means that the node should be permanently banned.
 642       </p><p>
 643         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.
 644       </p><p>
 645         Nodes are automatically banned if they are the cause of too many
 646         cluster recoveries.
 647       </p></div><div class="refsect2" lang="en"><a name="id2476488"></a><h3>unban</h3><p>
 648         This command is used to unban a node that has either been
 649         administratively banned using the ban command or has been automatically
 650         banned by the recovery daemon.
 651       </p></div></div><div class="refsect1" lang="en"><a name="id2476501"></a><h2>SEE ALSO</h2><p>
 652       ctdbd(1), onnode(1)
 653       <a class="ulink" href="http://ctdb.samba.org/" target="_top">http://ctdb.samba.org/</a>
 654     </p></div><div class="refsect1" lang="en"><a name="id2476514"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
 655 Copyright (C) Andrew Tridgell 2007<br>
 656 Copyright (C) Ronnie sahlberg 2007<br>
 657 <br>
 658 This program is free software; you can redistribute it and/or modify<br>
 659 it under the terms of the GNU General Public License as published by<br>
 660 the Free Software Foundation; either version 3 of the License, or (at<br>
 661 your option) any later version.<br>
 662 <br>
 663 This program is distributed in the hope that it will be useful, but<br>
 664 WITHOUT ANY WARRANTY; without even the implied warranty of<br>
 665 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU<br>
 666 General Public License for more details.<br>
 667 <br>
 668 You should have received a copy of the GNU General Public License<br>
 669 along with this program; if not, see http://www.gnu.org/licenses/.<br>
 670 </p></div></div></div></body></html>