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