ctdb/doc/ctdb.1.xml

   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">
   3 <refentry id="ctdb.1">
   4
   5 <refmeta>
   6         <refentrytitle>ctdb</refentrytitle>
   7         <manvolnum>1</manvolnum>
   8         <refmiscinfo class="source"> </refmiscinfo>
   9         <refmiscinfo class="manual"> </refmiscinfo>
  10 </refmeta>
  11
  12
  13 <refnamediv>
  14         <refname>ctdb</refname>
  15         <refpurpose>clustered tdb database management utility</refpurpose>
  16 </refnamediv>
  17
  18 <refsynopsisdiv>
  19         <cmdsynopsis>
  20                 <command>ctdb [ OPTIONS ] COMMAND ...</command>
  21         </cmdsynopsis>
  22
  23         <cmdsynopsis>
  24                 <command>ctdb</command>
  25                 <arg choice="opt">-n &lt;node&gt;</arg>
  26                 <arg choice="opt">-Y</arg>
  27                 <arg choice="opt">-t &lt;timeout&gt;</arg>
  28                 <arg choice="opt">-T &lt;timelimit&gt;</arg>
  29                 <arg choice="opt">-? --help</arg>
  30                 <arg choice="opt">--usage</arg>
  31                 <arg choice="opt">-d --debug=&lt;INTEGER&gt;</arg>
  32                 <arg choice="opt">--socket=&lt;filename&gt;</arg>
  33         </cmdsynopsis>
  34
  35 </refsynopsisdiv>
  36
  37   <refsect1><title>DESCRIPTION</title>
  38     <para>
  39       ctdb is a utility to view and manage a ctdb cluster.
  40     </para>
  41   </refsect1>
  42
  43
  44   <refsect1>
  45     <title>OPTIONS</title>
  46
  47     <variablelist>
  48       <varlistentry><term>-n &lt;pnn&gt;</term>
  49         <listitem>
  50           <para>
  51             This specifies the physical node number on which to execute the
  52             command. Default is to run the command on the deamon running on
  53             the local host.
  54           </para>
  55           <para>
  56             The physical node number is an integer that describes the node in the
  57             cluster. The first node has physical node number 0.
  58           </para>
  59         </listitem>
  60       </varlistentry>
  61
  62       <varlistentry><term>-Y</term>
  63         <listitem>
  64           <para>
  65             Produce output in machine readable form for easier parsing by scripts. Not all commands support this option.
  66           </para>
  67         </listitem>
  68       </varlistentry>
  69
  70       <varlistentry><term>-t &lt;timeout&gt;</term>
  71         <listitem>
  72           <para>
  73             How long should ctdb wait for the local ctdb daemon to respond to a command before timing out. Default is 3 seconds.
  74           </para>
  75         </listitem>
  76       </varlistentry>
  77
  78       <varlistentry><term>-T &lt;timelimit&gt;</term>
  79         <listitem>
  80           <para>
  81             A limit on how long the ctdb command will run for before it will
  82             be aborted. When this timelimit has been exceeded the ctdb command will
  83             terminate.
  84           </para>
  85         </listitem>
  86       </varlistentry>
  87
  88       <varlistentry><term>-? --help</term>
  89         <listitem>
  90           <para>
  91             Print some help text to the screen.
  92           </para>
  93         </listitem>
  94       </varlistentry>
  95
  96       <varlistentry><term>--usage</term>
  97         <listitem>
  98           <para>
  99             Print useage information to the screen.
 100           </para>
 101         </listitem>
 102       </varlistentry>
 103
 104       <varlistentry><term>-d --debug=&lt;debuglevel&gt;</term>
 105         <listitem>
 106           <para>
 107             Change the debug level for the command. Default is 0.
 108           </para>
 109         </listitem>
 110       </varlistentry>
 111
 112       <varlistentry><term>--socket=&lt;filename&gt;</term>
 113         <listitem>
 114           <para>
 115             Specify the socketname to use when connecting to the local ctdb
 116             daemon. The default is /tmp/ctdb.socket .
 117           </para>
 118           <para>
 119             You only need to specify this parameter if you run multiple ctdb
 120             daemons on the same physical host and thus can not use the default
 121             name for the domain socket.
 122           </para>
 123         </listitem>
 124       </varlistentry>
 125
 126     </variablelist>
 127   </refsect1>
 128
 129
 130   <refsect1><title>Administrative Commands</title>
 131     <para>
 132       These are commands used to monitor and administrate a CTDB cluster.
 133     </para>
 134
 135     <refsect2><title>pnn</title>
 136       <para>
 137         This command displays the pnn of the current node.
 138       </para>
 139     </refsect2>
 140
 141     <refsect2><title>status</title>
 142       <para>
 143         This command shows the current status of the ctdb node.
 144       </para>
 145
 146       <refsect3><title>node status</title>
 147         <para>
 148           Node status reflects the current status of the node. There are five possible states:
 149         </para>
 150         <para>
 151           OK - This node is fully functional.
 152         </para>
 153         <para>
 154           DISCONNECTED - This node could not be connected through the network and is currently not participating in the cluster. If there is a public IP address associated with this node it should have been taken over by a different node. No services are running on this node.
 155         </para>
 156         <para>
 157           DISABLED - This node has been administratively disabled. This node is still functional and participates in the CTDB cluster but its IP addresses have been taken over by a different node and no services are currently being hosted.
 158         </para>
 159         <para>
 160           UNHEALTHY - A service provided by this node is malfunctioning and should be investigated. The CTDB daemon itself is operational and participates in the cluster. Its public IP address has been taken over by a different node and no services are currnetly being hosted. All unhealthy nodes should be investigated and require an administrative action to rectify.
 161         </para>
 162         <para>
 163           BANNED - This node failed too many recovery attempts and has been banned from participating in the cluster for a period of RecoveryBanPeriod seconds. Any public IP address has been taken over by other nodes. This node does not provide any services. All banned nodes should be investigated and require an administrative action to rectify. This node does not perticipate in the CTDB cluster but can still be communicated with. I.e. ctdb commands can be sent to it.
 164         </para>
 165         <para>
 166       STOPPED - A node that is stopped does not host any public ip addresses,
 167       nor is it part of the VNNMAP. A stopped node can not become LVSMASTER,
 168       RECMASTER or NATGW.
 169       This node does not perticipate in the CTDB cluster but can still be
 170       communicated with. I.e. ctdb commands can be sent to it.
 171         </para>
 172         <para>
 173         PARTIALLYONLINE - A node that is partially online participates
 174         in a cluster like a node that is ok. Some interfaces to serve
 175         public ip addresses are down, but at least one interface is up.
 176         See also "ctdb ifaces".
 177         </para>
 178       </refsect3>
 179
 180       <refsect3><title>generation</title>
 181         <para>
 182           The generation id is a number that indicates the current generation
 183           of a cluster instance. Each time a cluster goes through a
 184           reconfiguration or a recovery its generation id will be changed.
 185           </para>
 186           <para>
 187           This number does not have any particular meaning other than to keep
 188           track of when a cluster has gone through a recovery. It is a random
 189           number that represents the current instance of a ctdb cluster
 190           and its databases.
 191           CTDBD uses this number internally to be able to tell when commands
 192           to operate on the cluster and the databases was issued in a different
 193           generation of the cluster, to ensure that commands that operate
 194           on the databases will not survive across a cluster database recovery.
 195           After a recovery, all old outstanding commands will automatically
 196           become invalid.
 197         </para>
 198         <para>
 199           Sometimes this number will be shown as "INVALID". This only means that
 200           the ctdbd daemon has started but it has not yet merged with the cluster through a recovery.
 201           All nodes start with generation "INVALID" and are not assigned a real
 202           generation id until they have successfully been merged with a cluster
 203           through a recovery.
 204         </para>
 205       </refsect3>
 206
 207       <refsect3><title>VNNMAP</title>
 208         <para>
 209           The list of Virtual Node Numbers. This is a list of all nodes that actively participates in the cluster and that share the workload of hosting the Clustered TDB database records.
 210           Only nodes that are participating in the vnnmap can become lmaster or dmaster for a database record.
 211         </para>
 212       </refsect3>
 213
 214       <refsect3><title>Recovery mode</title>
 215         <para>
 216           This is the current recovery mode of the cluster. There are two possible modes:
 217         </para>
 218         <para>
 219           NORMAL - The cluster is fully operational.
 220         </para>
 221         <para>
 222           RECOVERY - The cluster databases have all been frozen, pausing all services while the cluster awaits a recovery process to complete. A recovery process should finish within seconds. If a cluster is stuck in the RECOVERY state this would indicate a cluster malfunction which needs to be investigated.
 223         </para>
 224         <para>
 225         Once the recovery master detects an inconsistency, for example a node
 226         becomes disconnected/connected, the recovery daemon will trigger a
 227         cluster recovery process, where all databases are remerged across the
 228         cluster. When this process starts, the recovery master will first
 229         "freeze" all databases to prevent applications such as samba from
 230         accessing the databases and it will also mark the recovery mode as
 231         RECOVERY.
 232         </para>
 233         <para>
 234         When CTDBD starts up, it will start in RECOVERY mode.
 235         Once the node has been merged into a cluster and all databases
 236         have been recovered, the node mode will change into NORMAL mode
 237         and the databases will be "thawed", allowing samba to access the
 238         databases again.
 239         </para>
 240       </refsect3>
 241
 242       <refsect3><title>Recovery master</title>
 243         <para>
 244           This is the cluster node that is currently designated as the recovery master. This node is responsible of monitoring the consistency of the cluster and to perform the actual recovery process when reqired.
 245         </para>
 246         <para>
 247         Only one node at a time can be the designated recovery master. Which
 248         node is designated the recovery master is decided by an election
 249         process in the recovery daemons running on each node.
 250         </para>
 251       </refsect3>
 252
 253       <para>
 254         Example: ctdb status
 255       </para>
 256       <para>Example output:</para>
 257       <screen format="linespecific">
 258 Number of nodes:4
 259 pnn:0 11.1.2.200       OK (THIS NODE)
 260 pnn:1 11.1.2.201       OK
 261 pnn:2 11.1.2.202       OK
 262 pnn:3 11.1.2.203       OK
 263 Generation:1362079228
 264 Size:4
 265 hash:0 lmaster:0
 266 hash:1 lmaster:1
 267 hash:2 lmaster:2
 268 hash:3 lmaster:3
 269 Recovery mode:NORMAL (0)
 270 Recovery master:0
 271       </screen>
 272     </refsect2>
 273
 274     <refsect2><title>recmaster</title>
 275       <para>
 276         This command shows the pnn of the node which is currently the recmaster.
 277       </para>
 278     </refsect2>
 279
 280     <refsect2><title>uptime</title>
 281       <para>
 282         This command shows the uptime for the ctdb daemon. When the last recovery or ip-failover completed and how long it took. If the "duration" is shown as a negative number, this indicates that there is a recovery/failover in progress and it started that many seconds ago.
 283       </para>
 284
 285       <para>
 286         Example: ctdb uptime
 287       </para>
 288       <para>Example output:</para>
 289       <screen format="linespecific">
 290 Current time of node          :                Thu Oct 29 10:38:54 2009
 291 Ctdbd start time              : (000 16:54:28) Wed Oct 28 17:44:26 2009
 292 Time of last recovery/failover: (000 16:53:31) Wed Oct 28 17:45:23 2009
 293 Duration of last recovery/failover: 2.248552 seconds
 294       </screen>
 295     </refsect2>
 296
 297     <refsect2><title>listnodes</title>
 298       <para>
 299         This command shows lists the ip addresses of all the nodes in the cluster.
 300       </para>
 301
 302       <para>
 303         Example: ctdb listnodes
 304       </para>
 305       <para>Example output:</para>
 306       <screen format="linespecific">
 307 10.0.0.71
 308 10.0.0.72
 309 10.0.0.73
 310 10.0.0.74
 311       </screen>
 312     </refsect2>
 313
 314     <refsect2><title>ping</title>
 315       <para>
 316         This command will "ping" all CTDB daemons in the cluster to verify that they are processing commands correctly.
 317       </para>
 318       <para>
 319         Example: ctdb ping
 320       </para>
 321       <para>
 322         Example output:
 323       </para>
 324       <screen format="linespecific">
 325 response from 0 time=0.000054 sec  (3 clients)
 326 response from 1 time=0.000144 sec  (2 clients)
 327 response from 2 time=0.000105 sec  (2 clients)
 328 response from 3 time=0.000114 sec  (2 clients)
 329       </screen>
 330     </refsect2>
 331
 332     <refsect2><title>ip</title>
 333       <para>
 334         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".
 335       </para>
 336       <para>
 337         Example: ctdb ip
 338       </para>
 339       <para>
 340         Example output:
 341       </para>
 342       <screen format="linespecific">
 343 Number of addresses:4
 344 12.1.1.1         0
 345 12.1.1.2         1
 346 12.1.1.3         2
 347 12.1.1.4         3
 348       </screen>
 349     </refsect2>
 350
 351     <refsect2><title>scriptstatus</title>
 352       <para>
 353         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.
 354       </para>
 355       <para>
 356         Example: ctdb scriptstatus
 357       </para>
 358       <para>
 359         Example output:
 360       </para>
 361       <screen format="linespecific">
 362 7 scripts were executed last monitoring cycle
 363 00.ctdb              Status:OK    Duration:0.056 Tue Mar 24 18:56:57 2009
 364 10.interface         Status:OK    Duration:0.077 Tue Mar 24 18:56:57 2009
 365 11.natgw             Status:OK    Duration:0.039 Tue Mar 24 18:56:57 2009
 366 20.multipathd        Status:OK    Duration:0.038 Tue Mar 24 18:56:57 2009
 367 31.clamd             Status:DISABLED
 368 40.vsftpd            Status:OK    Duration:0.045 Tue Mar 24 18:56:57 2009
 369 41.httpd             Status:OK    Duration:0.039 Tue Mar 24 18:56:57 2009
 370 50.samba             Status:ERROR    Duration:0.082 Tue Mar 24 18:56:57 2009
 371    OUTPUT:ERROR: Samba tcp port 445 is not responding
 372       </screen>
 373     </refsect2>
 374
 375     <refsect2><title>disablescript &lt;script&gt;</title>
 376       <para>
 377         This command is used to disable an eventscript.
 378       </para>
 379       <para>
 380         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'.
 381       </para>
 382     </refsect2>
 383
 384     <refsect2><title>enablescript &lt;script&gt;</title>
 385       <para>
 386         This command is used to enable an eventscript.
 387       </para>
 388       <para>
 389         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'.
 390       </para>
 391     </refsect2>
 392
 393     <refsect2><title>getvar &lt;name&gt;</title>
 394       <para>
 395         Get the runtime value of a tuneable variable.
 396       </para>
 397       <para>
 398         Example: ctdb getvar MaxRedirectCount
 399       </para>
 400       <para>
 401         Example output:
 402       </para>
 403       <screen format="linespecific">
 404 MaxRedirectCount    = 3
 405       </screen>
 406     </refsect2>
 407
 408     <refsect2><title>setvar &lt;name&gt; &lt;value&gt;</title>
 409       <para>
 410         Set the runtime value of a tuneable variable.
 411       </para>
 412       <para>
 413         Example: ctdb setvar MaxRedirectCount 5
 414       </para>
 415     </refsect2>
 416
 417     <refsect2><title>listvars</title>
 418       <para>
 419         List all tuneable variables.
 420       </para>
 421       <para>
 422         Example: ctdb listvars
 423       </para>
 424       <para>
 425         Example output:
 426       </para>
 427       <screen format="linespecific">
 428 MaxRedirectCount    = 3
 429 SeqnumInterval      = 1000
 430 ControlTimeout      = 60
 431 TraverseTimeout     = 20
 432 KeepaliveInterval   = 5
 433 KeepaliveLimit      = 5
 434 MaxLACount          = 7
 435 RecoverTimeout      = 20
 436 RecoverInterval     = 1
 437 ElectionTimeout     = 3
 438 TakeoverTimeout     = 5
 439 MonitorInterval     = 15
 440 TickleUpdateInterval = 20
 441 EventScriptTimeout  = 30
 442 EventScriptBanCount = 10
 443 EventScriptUnhealthyOnTimeout = 0
 444 RecoveryGracePeriod = 120
 445 RecoveryBanPeriod   = 300
 446 DatabaseHashSize    = 10000
 447 DatabaseMaxDead     = 5
 448 RerecoveryTimeout   = 10
 449 EnableBans          = 1
 450 DeterministicIPs    = 1
 451 DisableWhenUnhealthy = 0
 452 ReclockPingPeriod   = 60
 453 NoIPFailback        = 0
 454 VerboseMemoryNames  = 0
 455 RecdPingTimeout     = 60
 456 RecdFailCount       = 10
 457 LogLatencyMs        = 0
 458 RecLockLatencyMs    = 1000
 459 RecoveryDropAllIPs  = 60
 460 VerifyRecoveryLock  = 1
 461 VacuumDefaultInterval = 300
 462 VacuumMaxRunTime    = 30
 463 RepackLimit         = 10000
 464 VacuumLimit         = 5000
 465 VacuumMinInterval   = 60
 466 VacuumMaxInterval   = 600
 467 MaxQueueDropMsg     = 1000
 468 UseStatusEvents     = 0
 469 AllowUnhealthyDBRead = 0
 470       </screen>
 471     </refsect2>
 472
 473     <refsect2><title>lvsmaster</title>
 474       <para>
 475       This command shows which node is currently the LVSMASTER. The
 476       LVSMASTER is the node in the cluster which drives the LVS system and
 477       which receives all incoming traffic from clients.
 478       </para>
 479       <para>
 480       LVS is the mode where the entire CTDB/Samba cluster uses a single
 481       ip address for the entire cluster. In this mode all clients connect to
 482       one specific node which will then multiplex/loadbalance the clients
 483       evenly onto the other nodes in the cluster. This is an alternative to using
 484       public ip addresses. See the manpage for ctdbd for more information
 485       about LVS.
 486       </para>
 487     </refsect2>
 488
 489     <refsect2><title>lvs</title>
 490       <para>
 491       This command shows which nodes in the cluster are currently active in the
 492       LVS configuration. I.e. which nodes we are currently loadbalancing
 493       the single ip address across.
 494       </para>
 495
 496       <para>
 497       LVS will by default only loadbalance across those nodes that are both
 498       LVS capable and also HEALTHY. Except if all nodes are UNHEALTHY in which
 499       case LVS will loadbalance across all UNHEALTHY nodes as well.
 500       LVS will never use nodes that are DISCONNECTED, STOPPED, BANNED or
 501       DISABLED.
 502       </para>
 503
 504       <para>
 505         Example output:
 506       </para>
 507       <screen format="linespecific">
 508 2:10.0.0.13
 509 3:10.0.0.14
 510       </screen>
 511
 512     </refsect2>
 513
 514
 515     <refsect2><title>getcapabilities</title>
 516       <para>
 517       This command shows the capabilities of the current node.
 518       Please see manpage for ctdbd for a full list of all capabilities and
 519       more detailed description.
 520       </para>
 521
 522       <para>
 523       RECMASTER and LMASTER capabilities are primarily used when CTDBD
 524       is used to create a cluster spanning across WAN links. In which case
 525       ctdbd acts as a WAN accelerator.
 526       </para>
 527
 528       <para>
 529       LVS capabile means that the node is participating in LVS, a mode
 530       where the entire CTDB cluster uses one single ip address for the
 531       entire cluster instead of using public ip address failover.
 532       This is an alternative to using a loadbalancing layer-4 switch.
 533       </para>
 534
 535       <para>
 536         Example output:
 537       </para>
 538       <screen format="linespecific">
 539 RECMASTER: YES
 540 LMASTER: YES
 541 LVS: NO
 542       </screen>
 543
 544     </refsect2>
 545
 546     <refsect2><title>statistics</title>
 547       <para>
 548         Collect statistics from the CTDB daemon about how many calls it has served.
 549       </para>
 550       <para>
 551         Example: ctdb statistics
 552       </para>
 553       <para>
 554         Example output:
 555       </para>
 556       <screen format="linespecific">
 557 CTDB version 1
 558  num_clients                        3
 559  frozen                             0
 560  recovering                         0
 561  client_packets_sent           360489
 562  client_packets_recv           360466
 563  node_packets_sent             480931
 564  node_packets_recv             240120
 565  keepalive_packets_sent             4
 566  keepalive_packets_recv             3
 567  node
 568      req_call                       2
 569      reply_call                     2
 570      req_dmaster                    0
 571      reply_dmaster                  0
 572      reply_error                    0
 573      req_message                   42
 574      req_control               120408
 575      reply_control             360439
 576  client
 577      req_call                       2
 578      req_message                   24
 579      req_control               360440
 580  timeouts
 581      call                           0
 582      control                        0
 583      traverse                       0
 584  total_calls                        2
 585  pending_calls                      0
 586  lockwait_calls                     0
 587  pending_lockwait_calls             0
 588  memory_used                     5040
 589  max_hop_count                      0
 590  max_call_latency                   4.948321 sec
 591  max_lockwait_latency               0.000000 sec
 592       </screen>
 593     </refsect2>
 594
 595     <refsect2><title>statisticsreset</title>
 596       <para>
 597         This command is used to clear all statistics counters in a node.
 598       </para>
 599       <para>
 600         Example: ctdb statisticsreset
 601       </para>
 602     </refsect2>
 603
 604     <refsect2><title>getreclock</title>
 605       <para>
 606         This command is used to show the filename of the reclock file that is used.
 607       </para>
 608
 609       <para>
 610         Example output:
 611       </para>
 612       <screen format="linespecific">
 613 Reclock file:/gpfs/.ctdb/shared
 614       </screen>
 615
 616     </refsect2>
 617
 618     <refsect2><title>setreclock [filename]</title>
 619       <para>
 620         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".
 621       </para>
 622
 623       <para>
 624         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.
 625       </para>
 626
 627       <para>
 628         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.
 629       </para>
 630     </refsect2>
 631
 632
 633
 634     <refsect2><title>getdebug</title>
 635       <para>
 636         Get the current debug level for the node. the debug level controls what information is written to the log file.
 637       </para>
 638       <para>
 639         The debug levels are mapped to the corresponding syslog levels.
 640         When a debug level is set, only those messages at that level and higher
 641         levels will be printed.
 642       </para>
 643       <para>
 644         The list of debug levels from highest to lowest are :
 645       </para>
 646       <para>
 647         EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
 648       </para>
 649     </refsect2>
 650
 651     <refsect2><title>setdebug &lt;debuglevel&gt;</title>
 652       <para>
 653         Set the debug level of a node. This controls what information will be logged.
 654       </para>
 655       <para>
 656         The debuglevel is one of EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
 657       </para>
 658     </refsect2>
 659
 660     <refsect2><title>getpid</title>
 661       <para>
 662         This command will return the process id of the ctdb daemon.
 663       </para>
 664     </refsect2>
 665
 666     <refsect2><title>disable</title>
 667       <para>
 668         This command is used to administratively disable a node in the cluster.
 669         A disabled node will still participate in the cluster and host
 670         clustered TDB records but its public ip address has been taken over by
 671         a different node and it no longer hosts any services.
 672       </para>
 673     </refsect2>
 674
 675     <refsect2><title>enable</title>
 676       <para>
 677         Re-enable a node that has been administratively disabled.
 678       </para>
 679     </refsect2>
 680
 681     <refsect2><title>stop</title>
 682       <para>
 683         This command is used to administratively STOP a node in the cluster.
 684         A STOPPED node is connected to the cluster but will not host any
 685         public ip addresse, nor does it participate in the VNNMAP.
 686         The difference between a DISABLED node and a STOPPED node is that
 687         a STOPPED node does not host any parts of the database which means
 688         that a recovery is required to stop/continue nodes.
 689       </para>
 690     </refsect2>
 691
 692     <refsect2><title>continue</title>
 693       <para>
 694         Re-start a node that has been administratively stopped.
 695       </para>
 696     </refsect2>
 697
 698     <refsect2><title>addip &lt;public_ip/mask&gt; &lt;iface&gt;</title>
 699       <para>
 700         This command is used to add a new public ip to a node during runtime.
 701         This allows public addresses to be added to a cluster without having
 702         to restart the ctdb daemons.
 703       </para>
 704       <para>
 705         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.
 706  If you want this change to be permanent you must also update the public addresses file manually.
 707       </para>
 708     </refsect2>
 709
 710     <refsect2><title>delip &lt;public_ip&gt;</title>
 711       <para>
 712         This command is used to remove a public ip from a node during runtime.
 713         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.
 714       </para>
 715       <para>
 716         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.
 717  If you want this change to be permanent you must also update the public addresses file manually.
 718       </para>
 719     </refsect2>
 720
 721     <refsect2><title>moveip &lt;public_ip&gt; &lt;node&gt;</title>
 722       <para>
 723       This command can be used to manually fail a public ip address to a
 724       specific node.
 725       </para>
 726       <para>
 727       In order to manually override the "automatic" distribution of public
 728       ip addresses that ctdb normally provides, this command only works
 729       when you have changed the tunables for the daemon to:
 730       </para>
 731       <para>
 732       DeterministicIPs = 0
 733       </para>
 734       <para>
 735       NoIPFailback = 1
 736       </para>
 737     </refsect2>
 738
 739     <refsect2><title>shutdown</title>
 740       <para>
 741         This command will shutdown a specific CTDB daemon.
 742       </para>
 743     </refsect2>
 744
 745     <refsect2><title>recover</title>
 746       <para>
 747         This command will trigger the recovery daemon to do a cluster
 748         recovery.
 749       </para>
 750     </refsect2>
 751
 752     <refsect2><title>ipreallocate</title>
 753       <para>
 754         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.
 755       </para>
 756     </refsect2>
 757
 758     <refsect2><title>setlmasterrole &lt;on|off&gt;</title>
 759       <para>
 760         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.
 761       </para>
 762
 763       <para>
 764         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.
 765       </para>
 766       <para>
 767         Once this setting has been enabled/disabled, you need to perform a recovery for it to take effect.
 768       </para>
 769       <para>
 770         See also "ctdb getcapabilities"
 771       </para>
 772     </refsect2>
 773
 774     <refsect2><title>setrecmasterrole &lt;on|off&gt;</title>
 775       <para>
 776         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.
 777       </para>
 778
 779       <para>
 780         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.
 781       </para>
 782       <para>
 783         See also "ctdb getcapabilities"
 784       </para>
 785     </refsect2>
 786
 787     <refsect2><title>killtcp &lt;srcip:port&gt; &lt;dstip:port&gt;</title>
 788       <para>
 789         This command will kill the specified TCP connection by issuing a
 790         TCP RST to the srcip:port endpoint. This is a command used by the
 791         ctdb eventscripts.
 792       </para>
 793     </refsect2>
 794
 795     <refsect2><title>gratiousarp &lt;ip&gt; &lt;interface&gt;</title>
 796       <para>
 797         This command will send out a gratious arp for the specified interface
 798         through the specified interface. This command is mainly used by the
 799         ctdb eventscripts.
 800       </para>
 801     </refsect2>
 802
 803     <refsect2><title>reloadnodes</title>
 804       <para>
 805       This command is used when adding new nodes, or removing existing nodes from an existing cluster.
 806       </para>
 807       <para>
 808       Procedure to add a node:
 809       </para>
 810       <para>
 811       1, To expand an existing cluster, first ensure with 'ctdb status' that
 812       all nodes are up and running and that they are all healthy.
 813       Do not try to expand a cluster unless it is completely healthy!
 814       </para>
 815       <para>
 816       2, On all nodes, edit /etc/ctdb/nodes and add the new node as the last
 817       entry to the file. The new node MUST be added to the end of this file!
 818       </para>
 819       <para>
 820       3, Verify that all the nodes have identical /etc/ctdb/nodes files after you edited them and added the new node!
 821       </para>
 822       <para>
 823       4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
 824       </para>
 825       <para>
 826       5, Use 'ctdb status' on all nodes and verify that they now show the additional node.
 827       </para>
 828       <para>
 829       6, Install and configure the new node and bring it online.
 830       </para>
 831       <para>
 832       Procedure to remove a node:
 833       </para>
 834       <para>
 835       1, To remove a node from an existing cluster, first ensure with 'ctdb status' that
 836       all nodes, except the node to be deleted, are up and running and that they are all healthy.
 837       Do not try to remove a node from a cluster unless the cluster is completely healthy!
 838       </para>
 839       <para>
 840       2, Shutdown and poerwoff the node to be removed.
 841       </para>
 842       <para>
 843       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.
 844       </para>
 845       <para>
 846       4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
 847       </para>
 848       <para>
 849       5, Use 'ctdb status' on all nodes and verify that the deleted node no longer shows up in the list..
 850       </para>
 851       <para>
 852       </para>
 853
 854     </refsect2>
 855
 856     <refsect2><title>tickle &lt;srcip:port&gt; &lt;dstip:port&gt;</title>
 857       <para>
 858         This command will will send a TCP tickle to the source host for the
 859         specified TCP connection.
 860         A TCP tickle is a TCP ACK packet with an invalid sequence and
 861         acknowledge number and will when received by the source host result
 862         in it sending an immediate correct ACK back to the other end.
 863       </para>
 864       <para>
 865         TCP tickles are useful to "tickle" clients after a IP failover has
 866         occured since this will make the client immediately recognize the
 867         TCP connection has been disrupted and that the client will need
 868         to reestablish. This greatly speeds up the time it takes for a client
 869         to detect and reestablish after an IP failover in the ctdb cluster.
 870       </para>
 871     </refsect2>
 872
 873     <refsect2><title>gettickles &lt;ip&gt;</title>
 874       <para>
 875         This command is used to show which TCP connections are registered with
 876         CTDB to be "tickled" if there is a failover.
 877       </para>
 878     </refsect2>
 879     <refsect2><title>repack [max_freelist]</title>
 880       <para>
 881         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.
 882         This command is used to defragment a TDB database and pruning the freelist.
 883       </para>
 884
 885         <para>
 886         If [max_freelist] is specified, then a database will only be repacked if it has more than this number of entries in the freelist.
 887         </para>
 888       <para>
 889         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.
 890       </para>
 891
 892       <para>
 893         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.
 894       </para>
 895
 896       <para>
 897         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.
 898         </para>
 899
 900       <para>
 901         Example: ctdb repack 1000
 902       </para>
 903
 904       <para>
 905          By default, this operation is issued from the 00.ctdb event script every 5 minutes.
 906       </para>
 907
 908     </refsect2>
 909
 910     <refsect2><title>vacuum [max_records]</title>
 911       <para>
 912         Over time CTDB databases will fill up with empty deleted records which will lead to a progressive slow down of CTDB database access.
 913         This command is used to prune all databases and delete all empty records from the cluster.
 914       </para>
 915
 916       <para>
 917          By default, vacuum will delete all empty records from all databases.
 918          If [max_records] is specified, the command will only delete the first
 919          [max_records] empty records for each database.
 920       </para>
 921
 922       <para>
 923          Vacuum only deletes records where the local node is the lmaster.
 924          To delete all records from the entire cluster you need to run a vacuum from each node.
 925
 926          This command is not disruptive. Samba is unaffected and will still be able to read/write records normally while the database is being vacuumed.
 927       </para>
 928
 929       <para>
 930         Example: ctdb vacuum
 931       </para>
 932
 933       <para>
 934          By default, this operation is issued from the 00.ctdb event script every 5 minutes.
 935       </para>
 936     </refsect2>
 937
 938     <refsect2><title>backupdb &lt;dbname&gt; &lt;file&gt;</title>
 939       <para>
 940         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.
 941 This is mainly useful for backing up persistent databases such as secrets.tdb and similar.
 942       </para>
 943     </refsect2>
 944
 945     <refsect2><title>restoredb &lt;file&gt;</title>
 946       <para>
 947         This command restores a persistent database that was previously backed up using backupdb.
 948       </para>
 949     </refsect2>
 950
 951     <refsect2><title>wipedb &lt;dbname&gt;</title>
 952       <para>
 953         This command can be used to remove all content of a database.
 954       </para>
 955     </refsect2>
 956   </refsect1>
 957
 958
 959     <refsect2><title>getlog &lt;level&gt;</title>
 960       <para>
 961         In addition to the normal loggign to a log file,
 962         CTDBD also keeps a in-memory ringbuffer containing the most recent
 963         log entries for all log levels (except DEBUG).
 964       </para><para>
 965         This is useful since it allows for keeping continous logs to a file
 966         at a reasonable non-verbose level, but shortly after an incident has
 967         occured, a much more detailed log can be pulled from memory. This
 968         can allow you to avoid having to reproduce an issue due to the
 969         on-disk logs being of insufficient detail.
 970       </para><para>
 971         This command extracts all messages of level or lower log level from
 972         memory and prints it to the screen.
 973       </para>
 974     </refsect2>
 975
 976     <refsect2><title>clearlog</title>
 977       <para>
 978         This command clears the in-memory logging ringbuffer.
 979       </para>
 980     </refsect2>
 981
 982
 983   <refsect1><title>Debugging Commands</title>
 984     <para>
 985       These commands are primarily used for CTDB development and testing and
 986       should not be used for normal administration.
 987     </para>
 988     <refsect2><title>process-exists &lt;pid&gt;</title>
 989       <para>
 990         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.
 991       </para>
 992     </refsect2>
 993
 994     <refsect2><title>getdbmap</title>
 995       <para>
 996         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.
 997       </para>
 998       <para>
 999         If a PERSISTENT database is not in a healthy state the database is
1000         flagged as UNHEALTHY. If there's at least one completely healthy node running in
1001         the cluster, it's possible that the content is restored by a recovery
1002         run automaticly. Otherwise an administrator needs to analyze the
1003         problem.
1004       </para>
1005       <para>
1006         See also "ctdb getdbstatus", "ctdb backupdb", "ctdb restoredb",
1007         "ctdb dumpbackup", "ctdb wipedb", "ctdb setvar AllowUnhealthyDBRead 1"
1008         and (if samba or tdb-utils are installed) "tdbtool check".
1009         </para>
1010         <para>
1011         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.
1012       </para>
1013       <para>
1014         Example: ctdb getdbmap
1015       </para>
1016       <para>
1017         Example output:
1018       </para>
1019       <screen format="linespecific">
1020 Number of databases:10
1021 dbid:0x435d3410 name:notify.tdb path:/var/ctdb/notify.tdb.0
1022 dbid:0x42fe72c5 name:locking.tdb path:/var/ctdb/locking.tdb.0 dbid:0x1421fb78 name:brlock.tdb path:/var/ctdb/brlock.tdb.0
1023 dbid:0x17055d90 name:connections.tdb path:/var/ctdb/connections.tdb.0
1024 dbid:0xc0bdde6a name:sessionid.tdb path:/var/ctdb/sessionid.tdb.0
1025 dbid:0x122224da name:test.tdb path:/var/ctdb/test.tdb.0
1026 dbid:0x2672a57f name:idmap2.tdb path:/var/ctdb/persistent/idmap2.tdb.0 PERSISTENT
1027 dbid:0xb775fff6 name:secrets.tdb path:/var/ctdb/persistent/secrets.tdb.0 PERSISTENT
1028 dbid:0xe98e08b6 name:group_mapping.tdb path:/var/ctdb/persistent/group_mapping.tdb.0 PERSISTENT
1029 dbid:0x7bbbd26c name:passdb.tdb path:/var/ctdb/persistent/passdb.tdb.0 PERSISTENT
1030       </screen>
1031       <para>
1032         Example output for an unhealthy database:
1033       </para>
1034       <screen format="linespecific">
1035 Number of databases:1
1036 dbid:0xb775fff6 name:secrets.tdb path:/var/ctdb/persistent/secrets.tdb.0 PERSISTENT UNHEALTHY
1037       </screen>
1038
1039       <para>
1040         Example output for a healthy database as machinereadable output -Y:
1041       </para>
1042       <screen format="linespecific">
1043 :ID:Name:Path:Persistent:Unhealthy:
1044 :0x7bbbd26c:passdb.tdb:/var/ctdb/persistent/passdb.tdb.0:1:0:
1045       </screen>
1046     </refsect2>
1047
1048     <refsect2><title>getdbstatus &lt;dbname&gt;</title>
1049       <para>
1050         This command displays more details about a database.
1051       </para>
1052       <para>
1053         Example: ctdb getdbstatus test.tdb.0
1054       </para>
1055       <para>
1056         Example output:
1057       </para>
1058       <screen format="linespecific">
1059 dbid: 0x122224da
1060 name: test.tdb
1061 path: /var/ctdb/test.tdb.0
1062 PERSISTENT: no
1063 HEALTH: OK
1064       </screen>
1065       <para>
1066         Example: ctdb getdbstatus registry.tdb (with a corrupted TDB)
1067       </para>
1068       <para>
1069         Example output:
1070       </para>
1071       <screen format="linespecific">
1072 dbid: 0xf2a58948
1073 name: registry.tdb
1074 path: /var/ctdb/persistent/registry.tdb.0
1075 PERSISTENT: yes
1076 HEALTH: NO-HEALTHY-NODES - ERROR - Backup of corrupted TDB in '/var/ctdb/persistent/registry.tdb.0.corrupted.20091208091949.0Z'
1077       </screen>
1078     </refsect2>
1079
1080     <refsect2><title>catdb &lt;dbname&gt;</title>
1081       <para>
1082         This command will dump a clustered TDB database to the screen. This is a debugging command.
1083       </para>
1084     </refsect2>
1085
1086     <refsect2><title>dumpdbbackup &lt;backup-file&gt;</title>
1087       <para>
1088         This command will dump the content of database backup to the screen
1089         (similar to ctdb catdb). This is a debugging command.
1090       </para>
1091     </refsect2>
1092
1093     <refsect2><title>getmonmode</title>
1094       <para>
1095         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.
1096       </para>
1097       <para>
1098         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.
1099       </para>
1100       <para>
1101         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.
1102       </para>
1103     </refsect2>
1104
1105
1106     <refsect2><title>setmonmode &lt;0|1&gt;</title>
1107       <para>
1108         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.
1109       </para>
1110     </refsect2>
1111
1112     <refsect2><title>attach &lt;dbname&gt;</title>
1113       <para>
1114         This is a debugging command. This command will make the CTDB daemon create a new CTDB database and attach to it.
1115       </para>
1116     </refsect2>
1117
1118     <refsect2><title>dumpmemory</title>
1119       <para>
1120         This is a debugging command. This command will make the ctdb
1121         daemon to write a fill memory allocation map to standard output.
1122       </para>
1123     </refsect2>
1124
1125     <refsect2><title>rddumpmemory</title>
1126       <para>
1127         This is a debugging command. This command will dump the talloc memory
1128         allocation tree for the recovery daemon to standard output.
1129       </para>
1130     </refsect2>
1131
1132     <refsect2><title>freeze</title>
1133       <para>
1134         This command will lock all the local TDB databases causing clients
1135         that are accessing these TDBs such as samba3 to block until the
1136         databases are thawed.
1137       </para>
1138       <para>
1139         This is primarily used by the recovery daemon to stop all samba
1140         daemons from accessing any databases while the database is recovered
1141         and rebuilt.
1142       </para>
1143     </refsect2>
1144
1145     <refsect2><title>thaw</title>
1146       <para>
1147         Thaw a previously frozen node.
1148       </para>
1149     </refsect2>
1150
1151
1152     <refsect2><title>eventscript &lt;arguments&gt;</title>
1153       <para>
1154         This is a debugging command. This command can be used to manually
1155         invoke and run the eventscritps with arbitrary arguments.
1156       </para>
1157     </refsect2>
1158
1159     <refsect2><title>ban &lt;bantime|0&gt;</title>
1160       <para>
1161         Administratively ban a node for bantime seconds. A bantime of 0 means that the node should be permanently banned.
1162       </para>
1163       <para>
1164         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.
1165       </para>
1166       <para>
1167         Nodes are automatically banned if they are the cause of too many
1168         cluster recoveries.
1169       </para>
1170     </refsect2>
1171
1172     <refsect2><title>unban</title>
1173       <para>
1174         This command is used to unban a node that has either been
1175         administratively banned using the ban command or has been automatically
1176         banned by the recovery daemon.
1177       </para>
1178     </refsect2>
1179
1180
1181   </refsect1>
1182
1183   <refsect1><title>SEE ALSO</title>
1184     <para>
1185       ctdbd(1), onnode(1)
1186       <ulink url="http://ctdb.samba.org/"/>
1187     </para>
1188   </refsect1>
1189   <refsect1><title>COPYRIGHT/LICENSE</title>
1190 <literallayout>
1191 Copyright (C) Andrew Tridgell 2007
1192 Copyright (C) Ronnie sahlberg 2007
1193
1194 This program is free software; you can redistribute it and/or modify
1195 it under the terms of the GNU General Public License as published by
1196 the Free Software Foundation; either version 3 of the License, or (at
1197 your option) any later version.
1198
1199 This program is distributed in the hope that it will be useful, but
1200 WITHOUT ANY WARRANTY; without even the implied warranty of
1201 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
1202 General Public License for more details.
1203
1204 You should have received a copy of the GNU General Public License
1205 along with this program; if not, see http://www.gnu.org/licenses/.
1206 </literallayout>
1207   </refsect1>
1208 </refentry>