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 31.clamd             Status:DISABLED
 360 40.vsftpd            Status:OK    Duration:0.045 Tue Mar 24 18:56:57 2009
 361 41.httpd             Status:OK    Duration:0.039 Tue Mar 24 18:56:57 2009
 362 50.samba             Status:ERROR    Duration:0.082 Tue Mar 24 18:56:57 2009
 363    OUTPUT:ERROR: Samba tcp port 445 is not responding
 364       </screen>
 365     </refsect2>
 366
 367     <refsect2><title>disablescript &lt;script&gt;</title>
 368       <para>
 369         This command is used to disable an eventscript.
 370       </para>
 371       <para>
 372         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'.
 373       </para>
 374     </refsect2>
 375
 376     <refsect2><title>enablescript &lt;script&gt;</title>
 377       <para>
 378         This command is used to enable an eventscript.
 379       </para>
 380       <para>
 381         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'.
 382       </para>
 383     </refsect2>
 384
 385     <refsect2><title>getvar &lt;name&gt;</title>
 386       <para>
 387         Get the runtime value of a tuneable variable.
 388       </para>
 389       <para>
 390         Example: ctdb getvar MaxRedirectCount
 391       </para>
 392       <para>
 393         Example output:
 394       </para>
 395       <screen format="linespecific">
 396 MaxRedirectCount    = 3
 397       </screen>
 398     </refsect2>
 399
 400     <refsect2><title>setvar &lt;name&gt; &lt;value&gt;</title>
 401       <para>
 402         Set the runtime value of a tuneable variable.
 403       </para>
 404       <para>
 405         Example: ctdb setvar MaxRedirectCount 5
 406       </para>
 407     </refsect2>
 408
 409     <refsect2><title>listvars</title>
 410       <para>
 411         List all tuneable variables.
 412       </para>
 413       <para>
 414         Example: ctdb listvars
 415       </para>
 416       <para>
 417         Example output:
 418       </para>
 419       <screen format="linespecific">
 420 MaxRedirectCount    = 5
 421 SeqnumFrequency     = 1
 422 ControlTimeout      = 60
 423 TraverseTimeout     = 20
 424 KeepaliveInterval   = 2
 425 KeepaliveLimit      = 3
 426 MaxLACount          = 7
 427 RecoverTimeout      = 5
 428 RecoverInterval     = 1
 429 ElectionTimeout     = 3
 430 TakeoverTimeout     = 5
 431 MonitorInterval     = 15
 432 EventScriptTimeout  = 20
 433 RecoveryGracePeriod = 60
 434 RecoveryBanPeriod   = 300
 435       </screen>
 436     </refsect2>
 437
 438     <refsect2><title>lvsmaster</title>
 439       <para>
 440       This command shows which node is currently the LVSMASTER. The
 441       LVSMASTER is the node in the cluster which drives the LVS system and
 442       which receives all incoming traffic from clients.
 443       </para>
 444       <para>
 445       LVS is the mode where the entire CTDB/Samba cluster uses a single
 446       ip address for the entire cluster. In this mode all clients connect to
 447       one specific node which will then multiplex/loadbalance the clients
 448       evenly onto the other nodes in the cluster. This is an alternative to using
 449       public ip addresses. See the manpage for ctdbd for more information
 450       about LVS.
 451       </para>
 452     </refsect2>
 453
 454     <refsect2><title>lvs</title>
 455       <para>
 456       This command shows which nodes in the cluster are currently active in the
 457       LVS configuration. I.e. which nodes we are currently loadbalancing
 458       the single ip address across.
 459       </para>
 460
 461       <para>
 462       LVS will by default only loadbalance across those nodes that are both
 463       LVS capable and also HEALTHY. Except if all nodes are UNHEALTHY in which
 464       case LVS will loadbalance across all UNHEALTHY nodes as well.
 465       LVS will never use nodes that are DISCONNECTED, STOPPED, BANNED or
 466       DISABLED.
 467       </para>
 468
 469       <para>
 470         Example output:
 471       </para>
 472       <screen format="linespecific">
 473 2:10.0.0.13
 474 3:10.0.0.14
 475       </screen>
 476
 477     </refsect2>
 478
 479
 480     <refsect2><title>getcapabilities</title>
 481       <para>
 482       This command shows the capabilities of the current node.
 483       Please see manpage for ctdbd for a full list of all capabilities and
 484       more detailed description.
 485       </para>
 486
 487       <para>
 488       RECMASTER and LMASTER capabilities are primarily used when CTDBD
 489       is used to create a cluster spanning across WAN links. In which case
 490       ctdbd acts as a WAN accelerator.
 491       </para>
 492
 493       <para>
 494       LVS capabile means that the node is participating in LVS, a mode
 495       where the entire CTDB cluster uses one single ip address for the
 496       entire cluster instead of using public ip address failover.
 497       This is an alternative to using a loadbalancing layer-4 switch.
 498       </para>
 499
 500       <para>
 501         Example output:
 502       </para>
 503       <screen format="linespecific">
 504 RECMASTER: YES
 505 LMASTER: YES
 506 LVS: NO
 507       </screen>
 508
 509     </refsect2>
 510
 511     <refsect2><title>statistics</title>
 512       <para>
 513         Collect statistics from the CTDB daemon about how many calls it has served.
 514       </para>
 515       <para>
 516         Example: ctdb statistics
 517       </para>
 518       <para>
 519         Example output:
 520       </para>
 521       <screen format="linespecific">
 522 CTDB version 1
 523  num_clients                        3
 524  frozen                             0
 525  recovering                         0
 526  client_packets_sent           360489
 527  client_packets_recv           360466
 528  node_packets_sent             480931
 529  node_packets_recv             240120
 530  keepalive_packets_sent             4
 531  keepalive_packets_recv             3
 532  node
 533      req_call                       2
 534      reply_call                     2
 535      req_dmaster                    0
 536      reply_dmaster                  0
 537      reply_error                    0
 538      req_message                   42
 539      req_control               120408
 540      reply_control             360439
 541  client
 542      req_call                       2
 543      req_message                   24
 544      req_control               360440
 545  timeouts
 546      call                           0
 547      control                        0
 548      traverse                       0
 549  total_calls                        2
 550  pending_calls                      0
 551  lockwait_calls                     0
 552  pending_lockwait_calls             0
 553  memory_used                     5040
 554  max_hop_count                      0
 555  max_call_latency                   4.948321 sec
 556  max_lockwait_latency               0.000000 sec
 557       </screen>
 558     </refsect2>
 559
 560     <refsect2><title>statisticsreset</title>
 561       <para>
 562         This command is used to clear all statistics counters in a node.
 563       </para>
 564       <para>
 565         Example: ctdb statisticsreset
 566       </para>
 567     </refsect2>
 568
 569     <refsect2><title>getreclock</title>
 570       <para>
 571         This command is used to show the filename of the reclock file that is used.
 572       </para>
 573
 574       <para>
 575         Example output:
 576       </para>
 577       <screen format="linespecific">
 578 Reclock file:/gpfs/.ctdb/shared
 579       </screen>
 580
 581     </refsect2>
 582
 583     <refsect2><title>setreclock [filename]</title>
 584       <para>
 585         This command is used to modify, or clear, the file that is used as the reclock file at runtime.
 586       </para>
 587
 588       <para>
 589         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.
 590       </para>
 591
 592       <para>
 593         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.
 594       </para>
 595     </refsect2>
 596
 597
 598
 599     <refsect2><title>getdebug</title>
 600       <para>
 601         Get the current debug level for the node. the debug level controls what information is written to the log file.
 602       </para>
 603       <para>
 604         The debug levels are mapped to the corresponding syslog levels.
 605         When a debug level is set, only those messages at that level and higher
 606         levels will be printed.
 607       </para>
 608       <para>
 609         The list of debug levels from highest to lowest are :
 610       </para>
 611       <para>
 612         EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
 613       </para>
 614     </refsect2>
 615
 616     <refsect2><title>setdebug &lt;debuglevel&gt;</title>
 617       <para>
 618         Set the debug level of a node. This controls what information will be logged.
 619       </para>
 620       <para>
 621         The debuglevel is one of EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
 622       </para>
 623     </refsect2>
 624
 625     <refsect2><title>getpid</title>
 626       <para>
 627         This command will return the process id of the ctdb daemon.
 628       </para>
 629     </refsect2>
 630
 631     <refsect2><title>disable</title>
 632       <para>
 633         This command is used to administratively disable a node in the cluster.
 634         A disabled node will still participate in the cluster and host
 635         clustered TDB records but its public ip address has been taken over by
 636         a different node and it no longer hosts any services.
 637       </para>
 638     </refsect2>
 639
 640     <refsect2><title>enable</title>
 641       <para>
 642         Re-enable a node that has been administratively disabled.
 643       </para>
 644     </refsect2>
 645
 646     <refsect2><title>stop</title>
 647       <para>
 648         This command is used to administratively STOP a node in the cluster.
 649         A STOPPED node is connected to the cluster but will not host any
 650         public ip addresse, nor does it participate in the VNNMAP.
 651         The difference between a DISABLED node and a STOPPED node is that
 652         a STOPPED node does not host any parts of the database which means
 653         that a recovery is required to stop/continue nodes.
 654       </para>
 655     </refsect2>
 656
 657     <refsect2><title>continue</title>
 658       <para>
 659         Re-start a node that has been administratively stopped.
 660       </para>
 661     </refsect2>
 662
 663     <refsect2><title>addip &lt;public_ip/mask&gt; &lt;iface&gt;</title>
 664       <para>
 665         This command is used to add a new public ip to a node during runtime.
 666         This allows public addresses to be added to a cluster without having
 667         to restart the ctdb daemons.
 668       </para>
 669       <para>
 670         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.
 671  If you want this change to be permanent you must also update the public addresses file manually.
 672       </para>
 673     </refsect2>
 674
 675     <refsect2><title>delip &lt;public_ip&gt;</title>
 676       <para>
 677         This command is used to remove a public ip from a node during runtime.
 678         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.
 679       </para>
 680       <para>
 681         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.
 682  If you want this change to be permanent you must also update the public addresses file manually.
 683       </para>
 684     </refsect2>
 685
 686     <refsect2><title>moveip &lt;public_ip&gt; &lt;node&gt;</title>
 687       <para>
 688       This command can be used to manually fail a public ip address to a
 689       specific node.
 690       </para>
 691       <para>
 692       In order to manually override the "automatic" distribution of public
 693       ip addresses that ctdb normally provides, this command only works
 694       when you have changed the tunables for the daemon to:
 695       </para>
 696       <para>
 697       DeterministicIPs = 0
 698       </para>
 699       <para>
 700       NoIPFailback = 1
 701       </para>
 702     </refsect2>
 703
 704     <refsect2><title>shutdown</title>
 705       <para>
 706         This command will shutdown a specific CTDB daemon.
 707       </para>
 708     </refsect2>
 709
 710     <refsect2><title>recover</title>
 711       <para>
 712         This command will trigger the recovery daemon to do a cluster
 713         recovery.
 714       </para>
 715     </refsect2>
 716
 717     <refsect2><title>ipreallocate</title>
 718       <para>
 719         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.
 720       </para>
 721     </refsect2>
 722
 723     <refsect2><title>setlmasterrole &lt;on|off&gt;</title>
 724       <para>
 725         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.
 726       </para>
 727
 728       <para>
 729         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.
 730       </para>
 731       <para>
 732         Once this setting has been enabled/disabled, you need to perform a recovery for it to take effect.
 733       </para>
 734       <para>
 735         See also "ctdb getcapabilities"
 736       </para>
 737     </refsect2>
 738
 739     <refsect2><title>setrecmasterrole &lt;on|off&gt;</title>
 740       <para>
 741         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.
 742       </para>
 743
 744       <para>
 745         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.
 746       </para>
 747       <para>
 748         See also "ctdb getcapabilities"
 749       </para>
 750     </refsect2>
 751
 752     <refsect2><title>killtcp &lt;srcip:port&gt; &lt;dstip:port&gt;</title>
 753       <para>
 754         This command will kill the specified TCP connection by issuing a
 755         TCP RST to the srcip:port endpoint. This is a command used by the
 756         ctdb eventscripts.
 757       </para>
 758     </refsect2>
 759
 760     <refsect2><title>gratiousarp &lt;ip&gt; &lt;interface&gt;</title>
 761       <para>
 762         This command will send out a gratious arp for the specified interface
 763         through the specified interface. This command is mainly used by the
 764         ctdb eventscripts.
 765       </para>
 766     </refsect2>
 767
 768     <refsect2><title>reloadnodes</title>
 769       <para>
 770       This command is used when adding new nodes, or removing existing nodes from an existing cluster.
 771       </para>
 772       <para>
 773       Procedure to add a node:
 774       </para>
 775       <para>
 776       1, To expand an existing cluster, first ensure with 'ctdb status' that
 777       all nodes are up and running and that they are all healthy.
 778       Do not try to expand a cluster unless it is completely healthy!
 779       </para>
 780       <para>
 781       2, On all nodes, edit /etc/ctdb/nodes and add the new node as the last
 782       entry to the file. The new node MUST be added to the end of this file!
 783       </para>
 784       <para>
 785       3, Verify that all the nodes have identical /etc/ctdb/nodes files after you edited them and added the new node!
 786       </para>
 787       <para>
 788       4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
 789       </para>
 790       <para>
 791       5, Use 'ctdb status' on all nodes and verify that they now show the additional node.
 792       </para>
 793       <para>
 794       6, Install and configure the new node and bring it online.
 795       </para>
 796       <para>
 797       Procedure to remove a node:
 798       </para>
 799       <para>
 800       1, To remove a node from an existing cluster, first ensure with 'ctdb status' that
 801       all nodes, except the node to be deleted, are up and running and that they are all healthy.
 802       Do not try to remove a node from a cluster unless the cluster is completely healthy!
 803       </para>
 804       <para>
 805       2, Shutdown and poerwoff the node to be removed.
 806       </para>
 807       <para>
 808       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.
 809       </para>
 810       <para>
 811       4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
 812       </para>
 813       <para>
 814       5, Use 'ctdb status' on all nodes and verify that the deleted node no longer shows up in the list..
 815       </para>
 816       <para>
 817       </para>
 818
 819     </refsect2>
 820
 821     <refsect2><title>tickle &lt;srcip:port&gt; &lt;dstip:port&gt;</title>
 822       <para>
 823         This command will will send a TCP tickle to the source host for the
 824         specified TCP connection.
 825         A TCP tickle is a TCP ACK packet with an invalid sequence and
 826         acknowledge number and will when received by the source host result
 827         in it sending an immediate correct ACK back to the other end.
 828       </para>
 829       <para>
 830         TCP tickles are useful to "tickle" clients after a IP failover has
 831         occured since this will make the client immediately recognize the
 832         TCP connection has been disrupted and that the client will need
 833         to reestablish. This greatly speeds up the time it takes for a client
 834         to detect and reestablish after an IP failover in the ctdb cluster.
 835       </para>
 836     </refsect2>
 837
 838     <refsect2><title>gettickles &lt;ip&gt;</title>
 839       <para>
 840         This command is used to show which TCP connections are registered with
 841         CTDB to be "tickled" if there is a failover.
 842       </para>
 843     </refsect2>
 844     <refsect2><title>repack [max_freelist]</title>
 845       <para>
 846         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.
 847         This command is used to defragment a TDB database and pruning the freelist.
 848       </para>
 849
 850         <para>
 851         If [max_freelist] is specified, then a database will only be repacked if it has more than this number of entries in the freelist.
 852         </para>
 853       <para>
 854         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.
 855       </para>
 856
 857       <para>
 858         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.
 859       </para>
 860
 861       <para>
 862         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.
 863         </para>
 864
 865       <para>
 866         Example: ctdb repack 1000
 867       </para>
 868
 869       <para>
 870          By default, this operation is issued from the 00.ctdb event script every 5 minutes.
 871       </para>
 872
 873     </refsect2>
 874
 875     <refsect2><title>vacuum [max_records]</title>
 876       <para>
 877         Over time CTDB databases will fill up with empty deleted records which will lead to a progressive slow down of CTDB database access.
 878         This command is used to prune all databases and delete all empty records from the cluster.
 879       </para>
 880
 881       <para>
 882          By default, vacuum will delete all empty records from all databases.
 883          If [max_records] is specified, the command will only delete the first
 884          [max_records] empty records for each database.
 885       </para>
 886
 887       <para>
 888          Vacuum only deletes records where the local node is the lmaster.
 889          To delete all records from the entire cluster you need to run a vacuum from each node.
 890
 891          This command is not disruptive. Samba is unaffected and will still be able to read/write records normally while the database is being vacuumed.
 892       </para>
 893
 894       <para>
 895         Example: ctdb vacuum
 896       </para>
 897
 898       <para>
 899          By default, this operation is issued from the 00.ctdb event script every 5 minutes.
 900       </para>
 901     </refsect2>
 902
 903     <refsect2><title>backupdb &lt;database&gt; &lt;file&gt;</title>
 904       <para>
 905         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.
 906 This is mainly useful for backing up persistent databases such as secrets.tdb and similar.
 907       </para>
 908     </refsect2>
 909
 910     <refsect2><title>restoredb &lt;file&gt;</title>
 911       <para>
 912         This command restores a persistent database that was previously backed up using backupdb.
 913       </para>
 914     </refsect2>
 915
 916   </refsect1>
 917
 918
 919   <refsect1><title>Debugging Commands</title>
 920     <para>
 921       These commands are primarily used for CTDB development and testing and
 922       should not be used for normal administration.
 923     </para>
 924     <refsect2><title>process-exists &lt;pid&gt;</title>
 925       <para>
 926         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.
 927       </para>
 928     </refsect2>
 929
 930     <refsect2><title>getdbmap</title>
 931       <para>
 932         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.
 933         </para>
 934         <para>
 935         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.
 936       </para>
 937       <para>
 938         Example: ctdb getdbmap
 939       </para>
 940       <para>
 941         Example output:
 942       </para>
 943       <screen format="linespecific">
 944 Number of databases:10
 945 dbid:0x435d3410 name:notify.tdb path:/var/ctdb/notify.tdb.0
 946 dbid:0x42fe72c5 name:locking.tdb path:/var/ctdb/locking.tdb.0 dbid:0x1421fb78 name:brlock.tdb path:/var/ctdb/brlock.tdb.0
 947 dbid:0x17055d90 name:connections.tdb path:/var/ctdb/connections.tdb.0
 948 dbid:0xc0bdde6a name:sessionid.tdb path:/var/ctdb/sessionid.tdb.0
 949 dbid:0x122224da name:test.tdb path:/var/ctdb/test.tdb.0
 950 dbid:0x2672a57f name:idmap2.tdb path:/var/ctdb/persistent/idmap2.tdb.0 PERSISTENT
 951 dbid:0xb775fff6 name:secrets.tdb path:/var/ctdb/persistent/secrets.tdb.0 PERSISTENT
 952 dbid:0xe98e08b6 name:group_mapping.tdb path:/var/ctdb/persistent/group_mapping.tdb.0 PERSISTENT
 953 dbid:0x7bbbd26c name:passdb.tdb path:/var/ctdb/persistent/passdb.tdb.0 PERSISTENT
 954       </screen>
 955     </refsect2>
 956
 957     <refsect2><title>catdb &lt;dbname&gt;</title>
 958       <para>
 959         This command will dump a clustered TDB database to the screen. This is a debugging command.
 960       </para>
 961     </refsect2>
 962
 963     <refsect2><title>getmonmode</title>
 964       <para>
 965         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.
 966       </para>
 967       <para>
 968         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.
 969       </para>
 970       <para>
 971         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.
 972       </para>
 973     </refsect2>
 974
 975
 976     <refsect2><title>setmonmode &lt;0|1&gt;</title>
 977       <para>
 978         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.
 979       </para>
 980     </refsect2>
 981
 982     <refsect2><title>attach &lt;dbname&gt;</title>
 983       <para>
 984         This is a debugging command. This command will make the CTDB daemon create a new CTDB database and attach to it.
 985       </para>
 986     </refsect2>
 987
 988     <refsect2><title>dumpmemory</title>
 989       <para>
 990         This is a debugging command. This command will make the ctdb
 991         daemon to write a fill memory allocation map to standard output.
 992       </para>
 993     </refsect2>
 994
 995     <refsect2><title>rddumpmemory</title>
 996       <para>
 997         This is a debugging command. This command will dump the talloc memory
 998         allocation tree for the recovery daemon to standard output.
 999       </para>
1000     </refsect2>
1001
1002     <refsect2><title>freeze</title>
1003       <para>
1004         This command will lock all the local TDB databases causing clients
1005         that are accessing these TDBs such as samba3 to block until the
1006         databases are thawed.
1007       </para>
1008       <para>
1009         This is primarily used by the recovery daemon to stop all samba
1010         daemons from accessing any databases while the database is recovered
1011         and rebuilt.
1012       </para>
1013     </refsect2>
1014
1015     <refsect2><title>thaw</title>
1016       <para>
1017         Thaw a previously frozen node.
1018       </para>
1019     </refsect2>
1020
1021
1022     <refsect2><title>eventscript &lt;arguments&gt;</title>
1023       <para>
1024         This is a debugging command. This command can be used to manually
1025         invoke and run the eventscritps with arbitrary arguments.
1026       </para>
1027     </refsect2>
1028
1029     <refsect2><title>ban &lt;bantime|0&gt;</title>
1030       <para>
1031         Administratively ban a node for bantime seconds. A bantime of 0 means that the node should be permanently banned.
1032       </para>
1033       <para>
1034         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.
1035       </para>
1036       <para>
1037         Nodes are automatically banned if they are the cause of too many
1038         cluster recoveries.
1039       </para>
1040     </refsect2>
1041
1042     <refsect2><title>unban</title>
1043       <para>
1044         This command is used to unban a node that has either been
1045         administratively banned using the ban command or has been automatically
1046         banned by the recovery daemon.
1047       </para>
1048     </refsect2>
1049
1050
1051   </refsect1>
1052
1053   <refsect1><title>SEE ALSO</title>
1054     <para>
1055       ctdbd(1), onnode(1)
1056       <ulink url="http://ctdb.samba.org/"/>
1057     </para>
1058   </refsect1>
1059   <refsect1><title>COPYRIGHT/LICENSE</title>
1060 <literallayout>
1061 Copyright (C) Andrew Tridgell 2007
1062 Copyright (C) Ronnie sahlberg 2007
1063
1064 This program is free software; you can redistribute it and/or modify
1065 it under the terms of the GNU General Public License as published by
1066 the Free Software Foundation; either version 3 of the License, or (at
1067 your option) any later version.
1068
1069 This program is distributed in the hope that it will be useful, but
1070 WITHOUT ANY WARRANTY; without even the implied warranty of
1071 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
1072 General Public License for more details.
1073
1074 You should have received a copy of the GNU General Public License
1075 along with this program; if not, see http://www.gnu.org/licenses/.
1076 </literallayout>
1077   </refsect1>
1078 </refentry>