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