ctdb/doc/ctdb.1.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry
   3         PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   4         "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
   5 <refentry id="ctdb.1">
   6
   7   <refentryinfo>
   8     <author>
   9       <contrib>
  10         This documentation was written by
  11         Ronnie Sahlberg,
  12         Amitay Isaacs,
  13         Martin Schwenke
  14       </contrib>
  15     </author>
  16
  17     <copyright>
  18       <year>2007</year>
  19       <holder>Andrew Tridgell</holder>
  20       <holder>Ronnie Sahlberg</holder>
  21     </copyright>
  22     <legalnotice>
  23       <para>
  24         This program is free software; you can redistribute it and/or
  25         modify it under the terms of the GNU General Public License as
  26         published by the Free Software Foundation; either version 3 of
  27         the License, or (at your option) any later version.
  28       </para>
  29       <para>
  30         This program is distributed in the hope that it will be
  31         useful, but WITHOUT ANY WARRANTY; without even the implied
  32         warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  33         PURPOSE.  See the GNU General Public License for more details.
  34       </para>
  35       <para>
  36         You should have received a copy of the GNU General Public
  37         License along with this program; if not, see
  38         <ulink url="http://www.gnu.org/licenses"/>.
  39       </para>
  40     </legalnotice>
  41   </refentryinfo>
  42
  43   <refmeta>
  44     <refentrytitle>ctdb</refentrytitle>
  45     <manvolnum>1</manvolnum>
  46     <refmiscinfo class="source">ctdb</refmiscinfo>
  47     <refmiscinfo class="manual">CTDB - clustered TDB database</refmiscinfo>
  48   </refmeta>
  49
  50   <refnamediv>
  51     <refname>ctdb</refname>
  52     <refpurpose>CTDB management utility</refpurpose>
  53   </refnamediv>
  54
  55   <refsynopsisdiv>
  56     <cmdsynopsis>
  57       <command>ctdb</command>
  58       <arg rep="repeat"><replaceable>OPTION</replaceable></arg>
  59       <arg choice="req"><replaceable>COMMAND</replaceable></arg>
  60       <arg choice="opt"><replaceable>COMMAND-ARGS</replaceable></arg>
  61     </cmdsynopsis>
  62   </refsynopsisdiv>
  63
  64   <refsect1>
  65     <title>DESCRIPTION</title>
  66     <para>
  67       ctdb is a utility to view and manage a CTDB cluster.
  68     </para>
  69
  70     <para>
  71       The following terms are used when referring to nodes in a
  72       cluster:
  73       <variablelist>
  74         <varlistentry>
  75           <term>PNN</term>
  76           <listitem>
  77             <para>
  78               Physical Node Number.  The physical node number is an
  79               integer that describes the node in the cluster. The
  80               first node has physical node number 0.  in a cluster.
  81             </para>
  82           </listitem>
  83         </varlistentry>
  84         <varlistentry>
  85           <term>PNN-LIST</term>
  86           <listitem>
  87             <para>
  88               This is either a single PNN, a comma-separate list of PNNs
  89               or "all".
  90             </para>
  91           </listitem>
  92         </varlistentry>
  93       </variablelist>
  94     </para>
  95
  96     <para>
  97       Commands that reference a database use the following terms:
  98       <variablelist>
  99         <varlistentry>
 100           <term>DB</term>
 101           <listitem>
 102             <para>
 103               This is either a database name, such as
 104               <filename>locking.tdb</filename> or a database ID such
 105               as "0x42fe72c5".
 106             </para>
 107           </listitem>
 108         </varlistentry>
 109         <varlistentry>
 110           <term>DB-LIST</term>
 111           <listitem>
 112             <para>
 113               A space separated list of at least one
 114               <parameter>DB</parameter>.
 115             </para>
 116           </listitem>
 117         </varlistentry>
 118       </variablelist>
 119     </para>
 120   </refsect1>
 121
 122   <refsect1>
 123     <title>OPTIONS</title>
 124
 125     <variablelist>
 126       <varlistentry><term>-n <parameter>PNN</parameter></term>
 127       <listitem>
 128         <para>
 129           The node specified by PNN should be queried for the
 130           requested information.  Default is to query the daemon
 131           running on the local host.
 132         </para>
 133       </listitem>
 134       </varlistentry>
 135
 136       <varlistentry><term>-Y</term>
 137       <listitem>
 138         <para>
 139           Produce output in machine readable form for easier parsing
 140           by scripts. This uses a field delimiter of ':'.  Not all
 141           commands support this option.
 142         </para>
 143       </listitem>
 144       </varlistentry>
 145
 146       <varlistentry><term>-x <parameter>SEPARATOR</parameter></term>
 147       <listitem>
 148         <para>
 149           Use SEPARATOR to delimit fields in machine readable output.
 150           This implies -Y.
 151         </para>
 152       </listitem>
 153       </varlistentry>
 154
 155       <varlistentry><term>-X</term>
 156       <listitem>
 157         <para>
 158           Produce output in machine readable form for easier parsing
 159           by scripts. This uses a field delimiter of '|'.  Not all
 160           commands support this option.
 161         </para>
 162         <para>
 163           This is equivalent to "-x|" and avoids some shell quoting
 164           issues.
 165         </para>
 166       </listitem>
 167       </varlistentry>
 168
 169       <varlistentry><term>-t <parameter>TIMEOUT</parameter></term>
 170       <listitem>
 171         <para>
 172           Indicates that ctdb should wait up to TIMEOUT seconds for
 173           a response to most commands sent to the CTDB daemon.  The
 174           default is 10 seconds.
 175         </para>
 176       </listitem>
 177       </varlistentry>
 178
 179       <varlistentry><term>-T <parameter>TIMELIMIT</parameter></term>
 180       <listitem>
 181         <para>
 182           Indicates that TIMELIMIT is the maximum run time (in
 183           seconds) for the ctdb command.  When TIMELIMIT is exceeded
 184           the ctdb command will terminate with an error.  The default
 185           is 120 seconds.
 186         </para>
 187       </listitem>
 188       </varlistentry>
 189
 190       <varlistentry><term>-? --help</term>
 191       <listitem>
 192         <para>
 193           Print some help text to the screen.
 194         </para>
 195       </listitem>
 196       </varlistentry>
 197
 198       <varlistentry><term>--usage</term>
 199       <listitem>
 200         <para>
 201           Print useage information to the screen.
 202         </para>
 203       </listitem>
 204       </varlistentry>
 205
 206       <varlistentry><term>-d --debug=<parameter>DEBUGLEVEL</parameter></term>
 207       <listitem>
 208         <para>
 209           Change the debug level for the command. Default is NOTICE.
 210         </para>
 211       </listitem>
 212       </varlistentry>
 213     </variablelist>
 214   </refsect1>
 215
 216
 217   <refsect1>
 218     <title>ADMINISTRATIVE COMMANDS</title>
 219     <para>
 220       These are commands used to monitor and administer a CTDB cluster.
 221     </para>
 222
 223     <refsect2>
 224       <title>pnn</title>
 225       <para>
 226         This command displays the PNN of the current node.
 227       </para>
 228     </refsect2>
 229
 230     <refsect2>
 231       <title>status</title>
 232       <para>
 233         This command shows the current status of all CTDB nodes based
 234         on information from the queried node.
 235       </para>
 236
 237       <para>
 238         Note: If the the queried node is INACTIVE then the status
 239         might not be current.
 240       </para>
 241
 242       <refsect3>
 243         <title>Node status</title>
 244         <para>
 245           This includes the number of physical nodes and the status of
 246           each node.  See <citerefentry><refentrytitle>ctdb</refentrytitle>
 247           <manvolnum>7</manvolnum></citerefentry> for information
 248           about node states.
 249         </para>
 250       </refsect3>
 251
 252       <refsect3>
 253         <title>Generation</title>
 254         <para>
 255           The generation id is a number that indicates the current generation
 256           of a cluster instance. Each time a cluster goes through a
 257           reconfiguration or a recovery its generation id will be changed.
 258         </para>
 259         <para>
 260           This number does not have any particular meaning other than
 261           to keep track of when a cluster has gone through a
 262           recovery. It is a random number that represents the current
 263           instance of a ctdb cluster and its databases.  The CTDB
 264           daemon uses this number internally to be able to tell when
 265           commands to operate on the cluster and the databases was
 266           issued in a different generation of the cluster, to ensure
 267           that commands that operate on the databases will not survive
 268           across a cluster database recovery.  After a recovery, all
 269           old outstanding commands will automatically become invalid.
 270         </para>
 271         <para>
 272           Sometimes this number will be shown as "INVALID". This only means that
 273           the ctdbd daemon has started but it has not yet merged with the cluster through a recovery.
 274           All nodes start with generation "INVALID" and are not assigned a real
 275           generation id until they have successfully been merged with a cluster
 276           through a recovery.
 277         </para>
 278       </refsect3>
 279
 280       <refsect3>
 281         <title>Virtual Node Number (VNN) map</title>
 282         <para>
 283           Consists of the number of virtual nodes and mapping from
 284           virtual node numbers to physical node numbers.  Only nodes
 285           that are participating in the VNN map can become lmaster for
 286           database records.
 287         </para>
 288       </refsect3>
 289
 290       <refsect3>
 291         <title>Recovery mode</title>
 292         <para>
 293           This is the current recovery mode of the cluster. There are two possible modes:
 294         </para>
 295         <para>
 296           NORMAL - The cluster is fully operational.
 297         </para>
 298         <para>
 299           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.
 300         </para>
 301         <para>
 302           Once the recovery master detects an inconsistency, for example a node
 303           becomes disconnected/connected, the recovery daemon will trigger a
 304           cluster recovery process, where all databases are remerged across the
 305           cluster. When this process starts, the recovery master will first
 306           "freeze" all databases to prevent applications such as samba from
 307           accessing the databases and it will also mark the recovery mode as
 308           RECOVERY.
 309         </para>
 310         <para>
 311           When the CTDB daemon starts up, it will start in RECOVERY
 312           mode.  Once the node has been merged into a cluster and all
 313           databases have been recovered, the node mode will change into
 314           NORMAL mode and the databases will be "thawed", allowing samba
 315           to access the databases again.
 316         </para>
 317       </refsect3>
 318       <refsect3>
 319         <title>Recovery master</title>
 320         <para>
 321           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.
 322         </para>
 323         <para>
 324           Only one node at a time can be the designated recovery master. Which
 325           node is designated the recovery master is decided by an election
 326           process in the recovery daemons running on each node.
 327         </para>
 328       </refsect3>
 329
 330       <refsect3>
 331         <title>Example</title>
 332         <screen>
 333 # ctdb status
 334 Number of nodes:4
 335 pnn:0 192.168.2.200       OK (THIS NODE)
 336 pnn:1 192.168.2.201       OK
 337 pnn:2 192.168.2.202       OK
 338 pnn:3 192.168.2.203       OK
 339 Generation:1362079228
 340 Size:4
 341 hash:0 lmaster:0
 342 hash:1 lmaster:1
 343 hash:2 lmaster:2
 344 hash:3 lmaster:3
 345 Recovery mode:NORMAL (0)
 346 Recovery master:0
 347         </screen>
 348       </refsect3>
 349     </refsect2>
 350
 351     <refsect2>
 352       <title>nodestatus <optional><parameter>PNN-LIST</parameter></optional></title>
 353       <para>
 354         This command is similar to the <command>status</command>
 355         command.  It displays the "node status" subset of output.  The
 356         main differences are:
 357       </para>
 358
 359       <itemizedlist>
 360         <listitem>
 361           <para>
 362             The exit code is the bitwise-OR of the flags for each
 363             specified node, while <command>ctdb status</command> exits
 364             with 0 if it was able to retrieve status for all nodes.
 365           </para>
 366         </listitem>
 367
 368         <listitem>
 369           <para>
 370             <command>ctdb status</command> provides status information
 371             for all nodes.  <command>ctdb nodestatus</command>
 372             defaults to providing status for only the current node.
 373             If PNN-LIST is provided then status is given for
 374             the indicated node(s).
 375           </para>
 376         </listitem>
 377       </itemizedlist>
 378
 379       <para>
 380         A common invocation in scripts is <command>ctdb nodestatus
 381         all</command> to check whether all nodes in a cluster are
 382         healthy.
 383       </para>
 384
 385       <refsect3>
 386         <title>Example</title>
 387         <screen>
 388 # ctdb nodestatus
 389 pnn:0 10.0.0.30        OK (THIS NODE)
 390
 391 # ctdb nodestatus all
 392 Number of nodes:2
 393 pnn:0 10.0.0.30        OK (THIS NODE)
 394 pnn:1 10.0.0.31        OK
 395         </screen>
 396       </refsect3>
 397     </refsect2>
 398
 399     <refsect2>
 400       <title>recmaster</title>
 401       <para>
 402         This command shows the pnn of the node which is currently the recmaster.
 403       </para>
 404
 405       <para>
 406         Note: If the the queried node is INACTIVE then the status
 407         might not be current.
 408       </para>
 409     </refsect2>
 410
 411     <refsect2>
 412       <title>uptime</title>
 413       <para>
 414         This command shows the uptime for the ctdb daemon. When the last recovery or ip-failover completed and how long it took. If the "duration" is shown as a negative number, this indicates that there is a recovery/failover in progress and it started that many seconds ago.
 415       </para>
 416
 417       <refsect3>
 418         <title>Example</title>
 419         <screen>
 420 # ctdb uptime
 421 Current time of node          :                Thu Oct 29 10:38:54 2009
 422 Ctdbd start time              : (000 16:54:28) Wed Oct 28 17:44:26 2009
 423 Time of last recovery/failover: (000 16:53:31) Wed Oct 28 17:45:23 2009
 424 Duration of last recovery/failover: 2.248552 seconds
 425         </screen>
 426       </refsect3>
 427     </refsect2>
 428
 429     <refsect2>
 430       <title>listnodes</title>
 431       <para>
 432         This command shows lists the ip addresses of all the nodes in the cluster.
 433       </para>
 434
 435       <refsect3>
 436         <title>Example</title>
 437         <screen>
 438 # ctdb listnodes
 439 192.168.2.200
 440 192.168.2.201
 441 192.168.2.202
 442 192.168.2.203
 443         </screen>
 444       </refsect3>
 445     </refsect2>
 446
 447     <refsect2>
 448       <title>natgw {master|list|status}</title>
 449       <para>
 450         This command shows different aspects of NAT gateway status.
 451         For an overview of CTDB's NAT gateway functionality please see
 452         the <citetitle>NAT GATEWAY</citetitle> section in
 453         <citerefentry><refentrytitle>ctdb</refentrytitle>
 454         <manvolnum>7</manvolnum></citerefentry>.
 455       </para>
 456
 457       <variablelist>
 458         <varlistentry>
 459           <term>master</term>
 460           <listitem>
 461             <para>
 462               Show the PNN and private IP address of the current NAT
 463               gateway master node.
 464             </para>
 465             <para>
 466               Example output:
 467             </para>
 468             <screen>
 469 1 192.168.2.201
 470             </screen>
 471           </listitem>
 472         </varlistentry>
 473         <varlistentry>
 474           <term>list</term>
 475           <listitem>
 476             <para>
 477               List the private IP addresses of nodes in the current
 478               NAT gateway group, annotating the master node.
 479             </para>
 480             <para>
 481               Example output:
 482             </para>
 483             <screen>
 484 192.168.2.200
 485 192.168.2.201   MASTER
 486 192.168.2.202
 487 192.168.2.203
 488             </screen>
 489           </listitem>
 490         </varlistentry>
 491         <varlistentry>
 492           <term>status</term>
 493           <listitem>
 494             <para>
 495               List the nodes in the current NAT gateway group and
 496               their status.
 497             </para>
 498             <para>
 499               Example output:
 500             </para>
 501             <screen>
 502 pnn:0 192.168.2.200       UNHEALTHY (THIS NODE)
 503 pnn:1 192.168.2.201       OK
 504 pnn:2 192.168.2.202       OK
 505 pnn:3 192.168.2.203       OK
 506             </screen>
 507           </listitem>
 508         </varlistentry>
 509       </variablelist>
 510     </refsect2>
 511
 512     <refsect2>
 513       <title>ping</title>
 514       <para>
 515         This command will "ping" specified CTDB nodes in the cluster
 516         to verify that they are running.
 517       </para>
 518       <refsect3>
 519         <title>Example</title>
 520         <screen>
 521 # ctdb ping
 522 response from 0 time=0.000054 sec  (3 clients)
 523         </screen>
 524       </refsect3>
 525     </refsect2>
 526
 527     <refsect2>
 528       <title>ifaces</title>
 529       <para>
 530         This command will display the list of network interfaces, which could
 531         host public addresses, along with their status.
 532       </para>
 533       <refsect3>
 534         <title>Example</title>
 535         <screen>
 536 # ctdb ifaces
 537 Interfaces on node 0
 538 name:eth5 link:up references:2
 539 name:eth4 link:down references:0
 540 name:eth3 link:up references:1
 541 name:eth2 link:up references:1
 542
 543 # ctdb -X ifaces
 544 |Name|LinkStatus|References|
 545 |eth5|1|2|
 546 |eth4|0|0|
 547 |eth3|1|1|
 548 |eth2|1|1|
 549         </screen>
 550       </refsect3>
 551     </refsect2>
 552
 553     <refsect2>
 554       <title>ip</title>
 555       <para>
 556         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 all".
 557       </para>
 558       <refsect3>
 559         <title>Example</title>
 560         <screen>
 561 # ctdb ip -v
 562 Public IPs on node 0
 563 172.31.91.82 node[1] active[] available[eth2,eth3] configured[eth2,eth3]
 564 172.31.91.83 node[0] active[eth3] available[eth2,eth3] configured[eth2,eth3]
 565 172.31.91.84 node[1] active[] available[eth2,eth3] configured[eth2,eth3]
 566 172.31.91.85 node[0] active[eth2] available[eth2,eth3] configured[eth2,eth3]
 567 172.31.92.82 node[1] active[] available[eth5] configured[eth4,eth5]
 568 172.31.92.83 node[0] active[eth5] available[eth5] configured[eth4,eth5]
 569 172.31.92.84 node[1] active[] available[eth5] configured[eth4,eth5]
 570 172.31.92.85 node[0] active[eth5] available[eth5] configured[eth4,eth5]
 571
 572 # ctdb -X ip -v
 573 |Public IP|Node|ActiveInterface|AvailableInterfaces|ConfiguredInterfaces|
 574 |172.31.91.82|1||eth2,eth3|eth2,eth3|
 575 |172.31.91.83|0|eth3|eth2,eth3|eth2,eth3|
 576 |172.31.91.84|1||eth2,eth3|eth2,eth3|
 577 |172.31.91.85|0|eth2|eth2,eth3|eth2,eth3|
 578 |172.31.92.82|1||eth5|eth4,eth5|
 579 |172.31.92.83|0|eth5|eth5|eth4,eth5|
 580 |172.31.92.84|1||eth5|eth4,eth5|
 581 |172.31.92.85|0|eth5|eth5|eth4,eth5|
 582         </screen>
 583       </refsect3>
 584     </refsect2>
 585
 586     <refsect2>
 587       <title>ipinfo <parameter>IP</parameter></title>
 588       <para>
 589         This command will display details about the specified public addresses.
 590       </para>
 591       <refsect3>
 592         <title>Example</title>
 593         <screen>
 594 # ctdb ipinfo 172.31.92.85
 595 Public IP[172.31.92.85] info on node 0
 596 IP:172.31.92.85
 597 CurrentNode:0
 598 NumInterfaces:2
 599 Interface[1]: Name:eth4 Link:down References:0
 600 Interface[2]: Name:eth5 Link:up References:2 (active)
 601         </screen>
 602       </refsect3>
 603     </refsect2>
 604
 605     <refsect2>
 606       <title>event run|status|script list|script enable|script disable</title>
 607       <para>
 608         This command is used to control event daemon and to inspect
 609         status of various events.
 610       </para>
 611
 612       <para>
 613         The commands below require a component to be specified.  In
 614         the current version the only valid component is
 615         <literal>legacy</literal>.
 616       </para>
 617
 618       <variablelist>
 619         <varlistentry>
 620           <term>run <parameter>TIMEOUT</parameter> <parameter>COMPONENT</parameter> <parameter>EVENT</parameter> <optional><parameter>ARGUMENTS</parameter></optional> </term>
 621           <listitem>
 622             <para>
 623              This command can be used to manually run specified EVENT
 624              in COMPONENT with optional ARGUMENTS.  The event will be
 625              allowed to run a maximum of TIMEOUT seconds.  If TIMEOUT
 626              is 0, then there is no time limit for running the event.
 627             </para>
 628           </listitem>
 629         </varlistentry>
 630
 631         <varlistentry>
 632           <term>status <parameter>COMPONENT</parameter> <parameter>EVENT</parameter></term>
 633           <listitem>
 634             <para>
 635               This command displays the last execution status of the
 636               specified EVENT in COMPONENT.
 637             </para>
 638             <para>
 639               The command will terminate with the exit status
 640               corresponding to the overall status of event that is
 641               displayed.
 642             </para>
 643             <para>
 644               The output is the list of event scripts executed.
 645               Each line shows the name, status, duration and start time
 646               for each script.
 647             </para>
 648             <para>
 649               Example output:
 650             </para>
 651             <screen>
 652 00.ctdb              OK         0.014 Sat Dec 17 19:39:11 2016
 653 01.reclock           OK         0.013 Sat Dec 17 19:39:11 2016
 654 05.system            OK         0.029 Sat Dec 17 19:39:11 2016
 655 06.nfs               OK         0.014 Sat Dec 17 19:39:11 2016
 656 10.interface         OK         0.037 Sat Dec 17 19:39:11 2016
 657 11.natgw             OK         0.011 Sat Dec 17 19:39:11 2016
 658 11.routing           OK         0.007 Sat Dec 17 19:39:11 2016
 659 13.per_ip_routing    OK         0.007 Sat Dec 17 19:39:11 2016
 660 20.multipathd        OK         0.007 Sat Dec 17 19:39:11 2016
 661 31.clamd             OK         0.007 Sat Dec 17 19:39:11 2016
 662 40.vsftpd            OK         0.013 Sat Dec 17 19:39:11 2016
 663 41.httpd             OK         0.018 Sat Dec 17 19:39:11 2016
 664 49.winbind           OK         0.023 Sat Dec 17 19:39:11 2016
 665 50.samba             OK         0.100 Sat Dec 17 19:39:12 2016
 666 60.nfs               OK         0.376 Sat Dec 17 19:39:12 2016
 667 70.iscsi             OK         0.009 Sat Dec 17 19:39:12 2016
 668 91.lvs               OK         0.007 Sat Dec 17 19:39:12 2016
 669             </screen>
 670           </listitem>
 671         </varlistentry>
 672
 673         <varlistentry>
 674           <term>script list <parameter>COMPONENT</parameter></term>
 675           <listitem>
 676             <para>
 677               List the available event scripts in COMPONENT.  Enabled
 678               scripts are flagged with a '*'.
 679             </para>
 680             <para>
 681               Generally, event scripts are provided by CTDB.  However,
 682               local or 3rd party event scripts may also be available.
 683               These are shown in a separate section after those
 684               provided by CTDB.
 685             </para>
 686             <para>
 687               Example output:
 688             </para>
 689             <screen>
 690 * 00.ctdb
 691 * 01.reclock
 692 * 05.system
 693 * 06.nfs
 694 * 10.interface
 695   11.natgw
 696   11.routing
 697   13.per_ip_routing
 698   20.multipathd
 699   31.clamd
 700   40.vsftpd
 701   41.httpd
 702 * 49.winbind
 703 * 50.samba
 704 * 60.nfs
 705   70.iscsi
 706   91.lvs
 707
 708 * 02.local
 709             </screen>
 710           </listitem>
 711         </varlistentry>
 712
 713         <varlistentry>
 714           <term>script enable <parameter>COMPONENT</parameter> <parameter>SCRIPT</parameter></term>
 715           <listitem>
 716             <para>
 717               Enable the specified event SCRIPT in COMPONENT.  Only
 718               enabled scripts will be executed when running any event.
 719             </para>
 720           </listitem>
 721         </varlistentry>
 722
 723         <varlistentry>
 724           <term>script disable <parameter>COMPONENT</parameter> <parameter>SCRIPT</parameter></term>
 725           <listitem>
 726             <para>
 727               Disable the specified event SCRIPT in COMPONENT.  This
 728               will prevent the script from executing when running any
 729               event.
 730             </para>
 731           </listitem>
 732         </varlistentry>
 733       </variablelist>
 734     </refsect2>
 735
 736     <refsect2>
 737       <title>scriptstatus</title>
 738       <para>
 739         This command displays which event scripts where run in the previous
 740         monitoring cycle and the result of each script. If a script
 741         failed with an error, causing the node to become unhealthy,
 742         the output from that script is also shown.
 743       </para>
 744       <para>
 745         This command is deprecated.  It's provided for backward
 746         compatibility.  In place of <command>ctdb scriptstatus</command>,
 747         use <command>ctdb event status</command>.
 748       </para>
 749       <refsect3>
 750         <title>Example</title>
 751         <screen>
 752 # ctdb scriptstatus
 753 00.ctdb              OK         0.011 Sat Dec 17 19:40:46 2016
 754 01.reclock           OK         0.010 Sat Dec 17 19:40:46 2016
 755 05.system            OK         0.030 Sat Dec 17 19:40:46 2016
 756 06.nfs               OK         0.014 Sat Dec 17 19:40:46 2016
 757 10.interface         OK         0.041 Sat Dec 17 19:40:46 2016
 758 11.natgw             OK         0.008 Sat Dec 17 19:40:46 2016
 759 11.routing           OK         0.007 Sat Dec 17 19:40:46 2016
 760 13.per_ip_routing    OK         0.007 Sat Dec 17 19:40:46 2016
 761 20.multipathd        OK         0.007 Sat Dec 17 19:40:46 2016
 762 31.clamd             OK         0.007 Sat Dec 17 19:40:46 2016
 763 40.vsftpd            OK         0.013 Sat Dec 17 19:40:46 2016
 764 41.httpd             OK         0.015 Sat Dec 17 19:40:46 2016
 765 49.winbind           OK         0.022 Sat Dec 17 19:40:46 2016
 766 50.samba             ERROR      0.077 Sat Dec 17 19:40:46 2016
 767   OUTPUT: ERROR: samba tcp port 445 is not responding
 768       </screen>
 769       </refsect3>
 770     </refsect2>
 771
 772     <refsect2>
 773       <title>listvars</title>
 774       <para>
 775         List all tuneable variables, except the values of the obsolete tunables
 776         like VacuumMinInterval. The obsolete tunables can be retrieved only
 777         explicitly with the "ctdb getvar" command.
 778       </para>
 779       <refsect3>
 780         <title>Example</title>
 781         <screen>
 782 # ctdb listvars
 783 SeqnumInterval          = 1000
 784 ControlTimeout          = 60
 785 TraverseTimeout         = 20
 786 KeepaliveInterval       = 5
 787 KeepaliveLimit          = 5
 788 RecoverTimeout          = 120
 789 RecoverInterval         = 1
 790 ElectionTimeout         = 3
 791 TakeoverTimeout         = 9
 792 MonitorInterval         = 15
 793 TickleUpdateInterval    = 20
 794 EventScriptTimeout      = 30
 795 MonitorTimeoutCount     = 20
 796 RecoveryGracePeriod     = 120
 797 RecoveryBanPeriod       = 300
 798 DatabaseHashSize        = 100001
 799 DatabaseMaxDead         = 5
 800 RerecoveryTimeout       = 10
 801 EnableBans              = 1
 802 NoIPFailback            = 0
 803 VerboseMemoryNames      = 0
 804 RecdPingTimeout         = 60
 805 RecdFailCount           = 10
 806 LogLatencyMs            = 0
 807 RecLockLatencyMs        = 1000
 808 RecoveryDropAllIPs      = 120
 809 VacuumInterval          = 10
 810 VacuumMaxRunTime        = 120
 811 RepackLimit             = 10000
 812 VacuumLimit             = 5000
 813 VacuumFastPathCount     = 60
 814 MaxQueueDropMsg         = 1000000
 815 AllowUnhealthyDBRead    = 0
 816 StatHistoryInterval     = 1
 817 DeferredAttachTO        = 120
 818 AllowClientDBAttach     = 1
 819 RecoverPDBBySeqNum      = 1
 820 DeferredRebalanceOnNodeAdd = 300
 821 FetchCollapse           = 1
 822 HopcountMakeSticky      = 50
 823 StickyDuration          = 600
 824 StickyPindown           = 200
 825 NoIPTakeover            = 0
 826 DBRecordCountWarn       = 100000
 827 DBRecordSizeWarn        = 10000000
 828 DBSizeWarn              = 100000000
 829 PullDBPreallocation     = 10485760
 830 LockProcessesPerDB      = 200
 831 RecBufferSizeLimit      = 1000000
 832 QueueBufferSize         = 1024
 833 IPAllocAlgorithm        = 2
 834         </screen>
 835       </refsect3>
 836     </refsect2>
 837
 838     <refsect2>
 839       <title>getvar <parameter>NAME</parameter></title>
 840       <para>
 841         Get the runtime value of a tuneable variable.
 842       </para>
 843       <refsect3>
 844         <title>Example</title>
 845         <screen>
 846 # ctdb getvar MonitorInterval
 847 MonitorInterval         = 15
 848         </screen>
 849       </refsect3>
 850     </refsect2>
 851
 852     <refsect2>
 853       <title>setvar <parameter>NAME</parameter> <parameter>VALUE</parameter></title>
 854       <para>
 855         Set the runtime value of a tuneable variable.
 856       </para>
 857       <refsect3>
 858         <title>Example</title>
 859         <screen>
 860 # ctdb setvar MonitorInterval 20
 861         </screen>
 862       </refsect3>
 863     </refsect2>
 864
 865     <refsect2>
 866       <title>lvs {master|list|status}</title>
 867       <para>
 868         This command shows different aspects of LVS status.  For an
 869         overview of CTDB's LVS functionality please see the
 870         <citetitle>LVS</citetitle> section in
 871         <citerefentry><refentrytitle>ctdb</refentrytitle>
 872         <manvolnum>7</manvolnum></citerefentry>.
 873       </para>
 874
 875       <variablelist>
 876         <varlistentry>
 877           <term>master</term>
 878           <listitem>
 879             <para>
 880               Shows the PNN of the current LVS master node.
 881             </para>
 882       <para>
 883         Example output:
 884       </para>
 885       <screen>
 886 2
 887       </screen>
 888           </listitem>
 889         </varlistentry>
 890         <varlistentry>
 891           <term>list</term>
 892           <listitem>
 893             <para>
 894               Lists the currently usable LVS nodes.
 895             </para>
 896       <para>
 897         Example output:
 898       </para>
 899       <screen>
 900 2 10.0.0.13
 901 3 10.0.0.14
 902       </screen>
 903           </listitem>
 904         </varlistentry>
 905         <varlistentry>
 906           <term>status</term>
 907           <listitem>
 908             <para>
 909               List the nodes in the current LVS group and their status.
 910             </para>
 911       <para>
 912         Example output:
 913       </para>
 914       <screen>
 915 pnn:0 10.0.0.11        UNHEALTHY (THIS NODE)
 916 pnn:1 10.0.0.12        UNHEALTHY
 917 pnn:2 10.0.0.13        OK
 918 pnn:3 10.0.0.14        OK
 919       </screen>
 920           </listitem>
 921         </varlistentry>
 922       </variablelist>
 923
 924     </refsect2>
 925
 926
 927     <refsect2>
 928       <title>getcapabilities</title>
 929
 930       <para>
 931         This command shows the capabilities of the current node.  See
 932         the <citetitle>CAPABILITIES</citetitle> section in
 933         <citerefentry><refentrytitle>ctdb</refentrytitle>
 934         <manvolnum>7</manvolnum></citerefentry> for more details.
 935       </para>
 936
 937       <para>
 938         Example output:
 939       </para>
 940       <screen>
 941 RECMASTER: YES
 942 LMASTER: YES
 943       </screen>
 944
 945     </refsect2>
 946
 947     <refsect2>
 948       <title>statistics</title>
 949       <para>
 950         Collect statistics from the CTDB daemon about
 951         how many calls it has served.  Information about
 952         various fields in statistics can be found in
 953         <citerefentry><refentrytitle>ctdb-statistics</refentrytitle>
 954         <manvolnum>7</manvolnum></citerefentry>.
 955       </para>
 956       <refsect3>
 957         <title>Example</title>
 958         <screen>
 959 # ctdb statistics
 960 CTDB version 1
 961 Current time of statistics  :                Tue Mar  8 15:18:51 2016
 962 Statistics collected since  : (003 21:31:32) Fri Mar  4 17:47:19 2016
 963  num_clients                        9
 964  frozen                             0
 965  recovering                         0
 966  num_recoveries                     2
 967  client_packets_sent          8170534
 968  client_packets_recv          7166132
 969  node_packets_sent           16549998
 970  node_packets_recv            5244418
 971  keepalive_packets_sent        201969
 972  keepalive_packets_recv        201969
 973  node
 974      req_call                      26
 975      reply_call                     0
 976      req_dmaster                    9
 977      reply_dmaster                 12
 978      reply_error                    0
 979      req_message              1339231
 980      req_control              8177506
 981      reply_control            6831284
 982  client
 983      req_call                      15
 984      req_message               334809
 985      req_control              6831308
 986  timeouts
 987      call                           0
 988      control                        0
 989      traverse                       0
 990  locks
 991      num_calls                      8
 992      num_current                    0
 993      num_pending                    0
 994      num_failed                     0
 995  total_calls                       15
 996  pending_calls                      0
 997  childwrite_calls                   0
 998  pending_childwrite_calls             0
 999  memory_used                   394879
1000  max_hop_count                      1
1001  total_ro_delegations               0
1002  total_ro_revokes                   0
1003  hop_count_buckets: 8 5 0 0 0 0 0 0 0 0 0 0 0 0 0 0
1004  lock_buckets: 0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0
1005  locks_latency      MIN/AVG/MAX     0.010005/0.010418/0.011010 sec out of 8
1006  reclock_ctdbd      MIN/AVG/MAX     0.002538/0.002538/0.002538 sec out of 1
1007  reclock_recd       MIN/AVG/MAX     0.000000/0.000000/0.000000 sec out of 0
1008  call_latency       MIN/AVG/MAX     0.000044/0.002142/0.011702 sec out of 15
1009  childwrite_latency MIN/AVG/MAX     0.000000/0.000000/0.000000 sec out of 0
1010         </screen>
1011       </refsect3>
1012     </refsect2>
1013
1014     <refsect2>
1015       <title>statisticsreset</title>
1016       <para>
1017         This command is used to clear all statistics counters in a node.
1018       </para>
1019       <para>
1020         Example: ctdb statisticsreset
1021       </para>
1022     </refsect2>
1023
1024     <refsect2>
1025       <title>dbstatistics <parameter>DB</parameter></title>
1026       <para>
1027         Display statistics about the database DB.  Information
1028         about various fields in dbstatistics can be found in
1029         <citerefentry><refentrytitle>ctdb-statistics</refentrytitle>
1030         <manvolnum>7</manvolnum></citerefentry>.
1031       </para>
1032       <refsect3>
1033         <title>Example</title>
1034         <screen>
1035 # ctdb dbstatistics locking.tdb
1036 DB Statistics: locking.tdb
1037  ro_delegations                     0
1038  ro_revokes                         0
1039  locks
1040      total                      14356
1041      failed                         0
1042      current                        0
1043      pending                        0
1044  hop_count_buckets: 28087 2 1 0 0 0 0 0 0 0 0 0 0 0 0 0
1045  lock_buckets: 0 14188 38 76 32 19 3 0 0 0 0 0 0 0 0 0
1046  locks_latency      MIN/AVG/MAX     0.001066/0.012686/4.202292 sec out of 14356
1047  vacuum_latency     MIN/AVG/MAX     0.000472/0.002207/15.243570 sec out of 224530
1048  Num Hot Keys:     1
1049      Count:8 Key:ff5bd7cb3ee3822edc1f0000000000000000000000000000
1050         </screen>
1051       </refsect3>
1052     </refsect2>
1053
1054     <refsect2>
1055       <title>getreclock</title>
1056       <para>
1057         Show details of the recovery lock, if any.
1058       </para>
1059
1060       <para>
1061         Example output:
1062       </para>
1063       <screen>
1064         /clusterfs/.ctdb/recovery.lock
1065       </screen>
1066
1067     </refsect2>
1068
1069     <refsect2>
1070       <title>getdebug</title>
1071       <para>
1072         Get the current debug level for the node. the debug level controls what information is written to the log file.
1073       </para>
1074       <para>
1075         The debug levels are mapped to the corresponding syslog levels.
1076         When a debug level is set, only those messages at that level and higher
1077         levels will be printed.
1078       </para>
1079       <para>
1080         The list of debug levels from highest to lowest are :
1081       </para>
1082       <para>
1083         ERROR WARNING NOTICE INFO DEBUG
1084       </para>
1085     </refsect2>
1086
1087     <refsect2>
1088       <title>setdebug <parameter>DEBUGLEVEL</parameter></title>
1089       <para>
1090         Set the debug level of a node. This controls what information will be logged.
1091       </para>
1092       <para>
1093         The debuglevel is one of ERROR WARNING NOTICE INFO DEBUG
1094       </para>
1095     </refsect2>
1096
1097     <refsect2>
1098       <title>getpid</title>
1099       <para>
1100         This command will return the process id of the ctdb daemon.
1101       </para>
1102     </refsect2>
1103
1104     <refsect2>
1105       <title>disable</title>
1106       <para>
1107         This command is used to administratively disable a node in the cluster.
1108         A disabled node will still participate in the cluster and host
1109         clustered TDB records but its public ip address has been taken over by
1110         a different node and it no longer hosts any services.
1111       </para>
1112     </refsect2>
1113
1114     <refsect2>
1115       <title>enable</title>
1116       <para>
1117         Re-enable a node that has been administratively disabled.
1118       </para>
1119     </refsect2>
1120
1121     <refsect2>
1122       <title>stop</title>
1123       <para>
1124         This command is used to administratively STOP a node in the cluster.
1125         A STOPPED node is connected to the cluster but will not host any
1126         public ip addresse, nor does it participate in the VNNMAP.
1127         The difference between a DISABLED node and a STOPPED node is that
1128         a STOPPED node does not host any parts of the database which means
1129         that a recovery is required to stop/continue nodes.
1130       </para>
1131     </refsect2>
1132
1133     <refsect2>
1134       <title>continue</title>
1135       <para>
1136         Re-start a node that has been administratively stopped.
1137       </para>
1138     </refsect2>
1139
1140     <refsect2>
1141       <title>addip <parameter>IPADDR</parameter>/<parameter>mask</parameter> <parameter>IFACE</parameter></title>
1142       <para>
1143         This command is used to add a new public ip to a node
1144         during runtime.  It should be followed by a <command>ctdb
1145         ipreallocate</command>.  This allows public addresses to be
1146         added to a cluster without having to restart the ctdb daemons.
1147       </para>
1148       <para>
1149         Note that this only updates the runtime instance of ctdb. Any
1150         changes will be lost next time ctdb is restarted and the public
1151         addresses file is re-read.  If you want this change to be
1152         permanent you must also update the public addresses file manually.
1153       </para>
1154     </refsect2>
1155
1156     <refsect2>
1157       <title>delip <parameter>IPADDR</parameter></title>
1158       <para>
1159         This command flags IPADDR for deletion from a node at runtime.
1160         It should be followed by a <command>ctdb
1161         ipreallocate</command>.  If IPADDR is currently hosted by the
1162         node it is being removed from, this ensures that the IP will
1163         first be failed over to another node, if possible, and that it
1164         is then actually removed.
1165       </para>
1166       <para>
1167         Note that this only updates the runtime instance of CTDB.  Any
1168         changes will be lost next time CTDB is restarted and the
1169         public addresses file is re-read.  If you want this change to
1170         be permanent you must also update the public addresses file
1171         manually.
1172       </para>
1173     </refsect2>
1174
1175     <refsect2>
1176       <title>moveip <parameter>IPADDR</parameter> <parameter>PNN</parameter></title>
1177       <para>
1178         This command can be used to manually fail a public ip address to a
1179         specific node.
1180       </para>
1181       <para>
1182         In order to manually override the "automatic" distribution of public
1183         ip addresses that ctdb normally provides, this command only works
1184         when you have changed the tunables for the daemon to:
1185       </para>
1186       <para>
1187         IPAllocAlgorithm != 0
1188       </para>
1189       <para>
1190         NoIPFailback = 1
1191       </para>
1192     </refsect2>
1193
1194     <refsect2>
1195       <title>shutdown</title>
1196       <para>
1197         This command will shutdown a specific CTDB daemon.
1198       </para>
1199     </refsect2>
1200
1201     <refsect2>
1202       <title>setlmasterrole on|off</title>
1203       <para>
1204         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.
1205       </para>
1206
1207       <para>
1208         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.
1209       </para>
1210       <para>
1211         Once this setting has been enabled/disabled, you need to perform a recovery for it to take effect.
1212       </para>
1213       <para>
1214         See also "ctdb getcapabilities"
1215       </para>
1216     </refsect2>
1217
1218     <refsect2>
1219       <title>setrecmasterrole on|off</title>
1220       <para>
1221         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.
1222       </para>
1223
1224       <para>
1225         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.
1226       </para>
1227       <para>
1228         See also "ctdb getcapabilities"
1229       </para>
1230     </refsect2>
1231
1232     <refsect2>
1233       <title>reloadnodes</title>
1234       <para>
1235         This command is used when adding new nodes, or removing
1236         existing nodes from an existing cluster.
1237       </para>
1238       <para>
1239         Procedure to add nodes:
1240       </para>
1241       <orderedlist>
1242         <listitem>
1243           <para>
1244              To expand an existing cluster, first ensure with
1245              <command>ctdb status</command> that all nodes are up and
1246              running and that they are all healthy.  Do not try to
1247              expand a cluster unless it is completely healthy!
1248           </para>
1249         </listitem>
1250         <listitem>
1251           <para>
1252             On all nodes, edit <filename>/usr/local/etc/ctdb/nodes</filename>
1253             and <emphasis>add the new nodes at the end of this
1254             file</emphasis>.
1255           </para>
1256         </listitem>
1257         <listitem>
1258           <para>
1259             Verify that all the nodes have identical
1260             <filename>/usr/local/etc/ctdb/nodes</filename> files after adding
1261             the new nodes.
1262           </para>
1263         </listitem>
1264         <listitem>
1265           <para>
1266             Run <command>ctdb reloadnodes</command> to force all nodes
1267             to reload the nodes file.
1268           </para>
1269         </listitem>
1270         <listitem>
1271           <para>
1272             Use <command>ctdb status</command> on all nodes and verify
1273             that they now show the additional nodes.
1274           </para>
1275         </listitem>
1276         <listitem>
1277           <para>
1278             Install and configure the new node and bring it online.
1279           </para>
1280         </listitem>
1281       </orderedlist>
1282       <para>
1283         Procedure to remove nodes:
1284       </para>
1285       <orderedlist>
1286         <listitem>
1287           <para>
1288             To remove nodes from an existing cluster, first ensure
1289             with <command>ctdb status</command> that all nodes, except
1290             the node to be deleted, are up and running and that they
1291             are all healthy.  Do not try to remove nodes from a
1292             cluster unless the cluster is completely healthy!
1293           </para>
1294         </listitem>
1295         <listitem>
1296           <para>
1297             Shutdown and power off the node to be removed.
1298           </para>
1299         </listitem>
1300         <listitem>
1301           <para>
1302             On all other nodes, edit the
1303             <filename>/usr/local/etc/ctdb/nodes</filename> file and
1304             <emphasis>comment out</emphasis> the nodes to be removed.
1305             <emphasis>Do not delete the lines for the deleted
1306             nodes</emphasis>, just comment them out by adding a '#' at
1307             the beginning of the lines.
1308           </para>
1309         </listitem>
1310         <listitem>
1311           <para>
1312             Run <command>ctdb reloadnodes</command> to force all nodes
1313             to reload the nodes file.
1314           </para>
1315         </listitem>
1316         <listitem>
1317           <para>
1318             Use <command>ctdb status</command> on all nodes and verify
1319             that the deleted nodes are no longer listed.
1320           </para>
1321         </listitem>
1322       </orderedlist>
1323
1324     </refsect2>
1325
1326     <refsect2>
1327       <title>
1328         reloadips
1329         <optional><parameter>PNN-LIST</parameter></optional>
1330       </title>
1331       <para>
1332         This command reloads the public addresses configuration file
1333         on the specified nodes.  When it completes addresses will be
1334         reconfigured and reassigned across the cluster as necessary.
1335       </para>
1336
1337       <para>
1338         This command is currently unable to make changes to the
1339         netmask or interfaces associated with existing addresses.
1340         Such changes must be made in 2 steps by deleting addresses in
1341         question and re-adding then.  Unfortunately this will disrupt
1342         connections to the changed addresses.
1343       </para>
1344     </refsect2>
1345
1346     <refsect2>
1347       <title>getdbmap</title>
1348       <para>
1349         This command lists all clustered TDB databases that the CTDB
1350         daemon has attached to. Some databases are flagged as PERSISTENT,
1351         this means that the database stores data persistently and the
1352         data will remain across reboots. One example of such a database
1353         is secrets.tdb where information about how the cluster was joined
1354         to the domain is stored.  Some database are flagged as REPLICATED,
1355         this means that the data in that database is replicated across all
1356         the nodes.  But the data will not remain across reboots.  This
1357         type of database is used by CTDB to store it's internal state.
1358       </para>
1359       <para>
1360         If a PERSISTENT database is not in a healthy state the database
1361         is flagged as UNHEALTHY. If there's at least one completely
1362         healthy node running in the cluster, it's possible that the
1363         content is restored by a recovery run automaticly. Otherwise an
1364         administrator needs to analyze the problem.
1365       </para>
1366       <para>
1367         See also "ctdb getdbstatus", "ctdb backupdb", "ctdb restoredb",
1368         "ctdb dumpbackup", "ctdb wipedb", "ctdb setvar AllowUnhealthyDBRead 1"
1369         and (if samba or tdb-utils are installed) "tdbtool check".
1370       </para>
1371       <para>
1372         Most databases are not persistent and only store the state
1373         information that the currently running samba daemons need. These
1374         databases are always wiped when ctdb/samba starts and when a
1375         node is rebooted.
1376       </para>
1377
1378       <refsect3>
1379         <title>Example</title>
1380         <screen>
1381 # ctdb getdbmap
1382 Number of databases:10
1383 dbid:0x435d3410 name:notify.tdb path:/usr/local/var/lib/ctdb/notify.tdb.0
1384 dbid:0x42fe72c5 name:locking.tdb path:/usr/local/var/lib/ctdb/locking.tdb.0
1385 dbid:0x1421fb78 name:brlock.tdb path:/usr/local/var/lib/ctdb/brlock.tdb.0
1386 dbid:0x17055d90 name:connections.tdb path:/usr/local/var/lib/ctdb/connections.tdb.0
1387 dbid:0xc0bdde6a name:sessionid.tdb path:/usr/local/var/lib/ctdb/sessionid.tdb.0
1388 dbid:0x122224da name:test.tdb path:/usr/local/var/lib/ctdb/test.tdb.0
1389 dbid:0x2672a57f name:idmap2.tdb path:/usr/local/var/lib/ctdb/persistent/idmap2.tdb.0 PERSISTENT
1390 dbid:0xb775fff6 name:secrets.tdb path:/usr/local/var/lib/ctdb/persistent/secrets.tdb.0 PERSISTENT
1391 dbid:0xe98e08b6 name:group_mapping.tdb path:/usr/local/var/lib/ctdb/persistent/group_mapping.tdb.0 PERSISTENT
1392 dbid:0x7bbbd26c name:passdb.tdb path:/usr/local/var/lib/ctdb/persistent/passdb.tdb.0 PERSISTENT
1393
1394 # ctdb getdbmap  # example for unhealthy database
1395 Number of databases:1
1396 dbid:0xb775fff6 name:secrets.tdb path:/usr/local/var/lib/ctdb/persistent/secrets.tdb.0 PERSISTENT UNHEALTHY
1397
1398 # ctdb -X getdbmap
1399 |ID|Name|Path|Persistent|Unhealthy|
1400 |0x7bbbd26c|passdb.tdb|/usr/local/var/lib/ctdb/persistent/passdb.tdb.0|1|0|
1401         </screen>
1402       </refsect3>
1403     </refsect2>
1404
1405     <refsect2>
1406       <title>
1407         backupdb
1408         <parameter>DB</parameter>
1409         <parameter>FILE</parameter>
1410       </title>
1411       <para>
1412         Copy the contents of database DB to FILE.  FILE can later be
1413         read back using <command>restoredb</command>.  This is mainly
1414         useful for backing up persistent databases such as
1415         <filename>secrets.tdb</filename> and similar.
1416       </para>
1417     </refsect2>
1418
1419     <refsect2>
1420       <title>
1421         restoredb
1422         <parameter>FILE</parameter>
1423         <optional><parameter>DB</parameter></optional>
1424       </title>
1425       <para>
1426         This command restores a persistent database that was
1427         previously backed up using backupdb.  By default the data will
1428         be restored back into the same database as it was created
1429         from. By specifying dbname you can restore the data into a
1430         different database.
1431       </para>
1432     </refsect2>
1433
1434     <refsect2>
1435       <title>setdbreadonly <parameter>DB</parameter></title>
1436       <para>
1437         This command will enable the read-only record support for a
1438         database.  This is an experimental feature to improve
1439         performance for contended records primarily in locking.tdb and
1440         brlock.tdb.  When enabling this feature you must set it on all
1441         nodes in the cluster.
1442       </para>
1443     </refsect2>
1444
1445     <refsect2>
1446       <title>setdbsticky <parameter>DB</parameter></title>
1447       <para>
1448         This command will enable the sticky record support for the
1449         specified database.  This is an experimental feature to
1450         improve performance for contended records primarily in
1451         locking.tdb and brlock.tdb.  When enabling this feature you
1452         must set it on all nodes in the cluster.
1453       </para>
1454     </refsect2>
1455
1456   </refsect1>
1457
1458   <refsect1>
1459     <title>INTERNAL COMMANDS</title>
1460
1461     <para>
1462       Internal commands are used by CTDB's scripts and are not
1463       required for managing a CTDB cluster.  Their parameters and
1464       behaviour are subject to change.
1465     </para>
1466
1467     <refsect2>
1468       <title>gettickles <parameter>IPADDR</parameter></title>
1469       <para>
1470         Show TCP connections that are registered with CTDB to be
1471         "tickled" if there is a failover.
1472       </para>
1473     </refsect2>
1474
1475     <refsect2>
1476       <title>gratarp <parameter>IPADDR</parameter> <parameter>INTERFACE</parameter></title>
1477       <para>
1478         Send out a gratuitous ARP for the specified interface through
1479         the specified interface. This command is mainly used by the
1480         ctdb eventscripts.
1481       </para>
1482     </refsect2>
1483
1484     <refsect2>
1485       <title>
1486         pdelete <parameter>DB</parameter> <parameter>KEY</parameter>
1487       </title>
1488       <para>
1489         Delete KEY from DB.
1490       </para>
1491     </refsect2>
1492
1493     <refsect2>
1494       <title>
1495         pfetch <parameter>DB</parameter> <parameter>KEY</parameter>
1496       </title>
1497       <para>
1498         Print the value associated with KEY in DB.
1499       </para>
1500     </refsect2>
1501
1502     <refsect2>
1503       <title>
1504         pstore
1505         <parameter>DB</parameter>
1506         <parameter>KEY</parameter>
1507         <parameter>FILE</parameter>
1508       </title>
1509       <para>
1510         Store KEY in DB with contents of FILE as the associated value.
1511       </para>
1512     </refsect2>
1513
1514     <refsect2>
1515       <title>
1516         ptrans
1517         <parameter>DB</parameter>
1518         <optional><parameter>FILE</parameter></optional>
1519       </title>
1520       <para>
1521         Read a list of key-value pairs, one per line from FILE, and
1522         store them in DB using a single transaction.  An empty value
1523         is equivalent to deleting the given key.
1524       </para>
1525       <para>
1526         The key and value should be separated by spaces or tabs. Each
1527         key/value should be a printable string enclosed in
1528         double-quotes.
1529       </para>
1530     </refsect2>
1531
1532     <refsect2>
1533       <title>runstate [setup|first_recovery|startup|running]</title>
1534       <para>
1535         Print the runstate of the specified node.  Runstates are used
1536         to serialise important state transitions in CTDB, particularly
1537         during startup.
1538       </para>
1539       <para>
1540         If one or more optional runstate arguments are specified then
1541         the node must be in one of these runstates for the command to
1542         succeed.
1543       </para>
1544       <refsect3>
1545         <title>Example</title>
1546         <screen>
1547 # ctdb runstate
1548 RUNNING
1549         </screen>
1550       </refsect3>
1551     </refsect2>
1552
1553     <refsect2>
1554       <title>setifacelink <parameter>IFACE</parameter> up|down</title>
1555       <para>
1556         Set the internal state of network interface IFACE.  This is
1557         typically used in the <filename>10.interface</filename> script
1558         in the "monitor" event.
1559       </para>
1560       <para>
1561         Example: ctdb setifacelink eth0 up
1562       </para>
1563     </refsect2>
1564
1565     <refsect2>
1566       <title>tickle</title>
1567       <para>
1568         Read a list of TCP connections, one per line, from standard
1569         input and send a TCP tickle to the source host for each
1570         connection.  A connection is specified as:
1571       </para>
1572       <synopsis>
1573         <parameter>SRC-IPADDR</parameter>:<parameter>SRC-PORT</parameter> <parameter>DST-IPADDR</parameter>:<parameter>DST-PORT</parameter>
1574       </synopsis>
1575       <para>
1576         A single connection can be specified on the command-line
1577         rather than on standard input.
1578       </para>
1579       <para>
1580         A TCP tickle is a TCP ACK packet with an invalid sequence and
1581         acknowledge number and will when received by the source host
1582         result in it sending an immediate correct ACK back to the
1583         other end.
1584       </para>
1585       <para>
1586         TCP tickles are useful to "tickle" clients after a IP failover has
1587         occurred since this will make the client immediately recognize the
1588         TCP connection has been disrupted and that the client will need
1589         to reestablish. This greatly speeds up the time it takes for a client
1590         to detect and reestablish after an IP failover in the ctdb cluster.
1591       </para>
1592     </refsect2>
1593
1594     <refsect2>
1595       <title>version</title>
1596       <para>
1597         Display the CTDB version.
1598       </para>
1599     </refsect2>
1600
1601   </refsect1>
1602
1603   <refsect1>
1604     <title>DEBUGGING COMMANDS</title>
1605     <para>
1606       These commands are primarily used for CTDB development and testing and
1607       should not be used for normal administration.
1608     </para>
1609
1610
1611     <refsect2>
1612       <title>OPTIONS</title>
1613
1614       <variablelist>
1615         <varlistentry><term>--print-emptyrecords</term>
1616         <listitem>
1617           <para>
1618             This enables printing of empty records when dumping databases
1619             with the catdb, cattbd and dumpdbbackup commands. Records with
1620             empty data segment are considered deleted by ctdb and cleaned
1621             by the vacuuming mechanism, so this switch can come in handy for
1622             debugging the vacuuming behaviour.
1623           </para>
1624         </listitem>
1625         </varlistentry>
1626
1627         <varlistentry><term>--print-datasize</term>
1628         <listitem>
1629           <para>
1630             This lets database dumps (catdb, cattdb, dumpdbbackup) print the
1631             size of the record data instead of dumping the data contents.
1632           </para>
1633         </listitem>
1634         </varlistentry>
1635
1636         <varlistentry><term>--print-lmaster</term>
1637         <listitem>
1638           <para>
1639             This lets catdb print the lmaster for each record.
1640           </para>
1641         </listitem>
1642         </varlistentry>
1643
1644         <varlistentry><term>--print-hash</term>
1645         <listitem>
1646           <para>
1647             This lets database dumps (catdb, cattdb, dumpdbbackup) print the
1648             hash for each record.
1649           </para>
1650         </listitem>
1651         </varlistentry>
1652
1653         <varlistentry><term>--print-recordflags</term>
1654         <listitem>
1655           <para>
1656             This lets catdb and dumpdbbackup print the
1657             record flags for each record. Note that cattdb always
1658             prints the flags.
1659           </para>
1660         </listitem>
1661         </varlistentry>
1662
1663       </variablelist>
1664     </refsect2>
1665
1666     <refsect2>
1667       <title>process-exists <parameter>PID</parameter> <parameter>[SRVID]</parameter></title>
1668       <para>
1669         This command checks if a specific process exists on the CTDB
1670         host. This is mainly used by Samba to check if remote instances
1671         of samba are still running or not.  When the optional SRVID
1672         argument is specified, the command check if a specific process
1673         exists on the CTDB host and has registered for specified SRVID.
1674       </para>
1675     </refsect2>
1676
1677     <refsect2>
1678       <title>getdbstatus <parameter>DB</parameter></title>
1679       <para>
1680         This command displays more details about a database.
1681       </para>
1682       <refsect3>
1683         <title>Example</title>
1684         <screen>
1685 # ctdb getdbstatus test.tdb.0
1686 dbid: 0x122224da
1687 name: test.tdb
1688 path: /usr/local/var/lib/ctdb/test.tdb.0
1689 PERSISTENT: no
1690 HEALTH: OK
1691
1692 # ctdb getdbstatus registry.tdb  # with a corrupted TDB
1693 dbid: 0xf2a58948
1694 name: registry.tdb
1695 path: /usr/local/var/lib/ctdb/persistent/registry.tdb.0
1696 PERSISTENT: yes
1697 HEALTH: NO-HEALTHY-NODES - ERROR - Backup of corrupted TDB in '/usr/local/var/lib/ctdb/persistent/registry.tdb.0.corrupted.20091208091949.0Z'
1698         </screen>
1699       </refsect3>
1700     </refsect2>
1701
1702     <refsect2>
1703       <title>catdb <parameter>DB</parameter></title>
1704       <para>
1705         Print a dump of the clustered TDB database DB.
1706       </para>
1707     </refsect2>
1708
1709     <refsect2>
1710       <title>cattdb <parameter>DB</parameter></title>
1711       <para>
1712         Print a dump of the contents of the local TDB database DB.
1713       </para>
1714     </refsect2>
1715
1716     <refsect2>
1717       <title>dumpdbbackup <parameter>FILE</parameter></title>
1718       <para>
1719         Print a dump of the contents from database backup FILE,
1720         similar to <command>catdb</command>.
1721       </para>
1722     </refsect2>
1723
1724     <refsect2>
1725       <title>wipedb <parameter>DB</parameter></title>
1726       <para>
1727         Remove all contents of database DB.
1728       </para>
1729     </refsect2>
1730
1731     <refsect2>
1732       <title>recover</title>
1733       <para>
1734         This command will trigger the recovery daemon to do a cluster
1735         recovery.
1736       </para>
1737     </refsect2>
1738
1739     <refsect2>
1740       <title>ipreallocate, sync</title>
1741       <para>
1742         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.
1743       </para>
1744     </refsect2>
1745
1746     <refsect2>
1747       <title>attach <parameter>DBNAME</parameter> [persistent|replicated]</title>
1748       <para>
1749         Create a new CTDB database called DBNAME and attach to it on
1750         all nodes.
1751       </para>
1752     </refsect2>
1753
1754     <refsect2>
1755       <title>detach <parameter>DB-LIST</parameter></title>
1756       <para>
1757         Detach specified non-persistent database(s) from the cluster. This
1758         command will disconnect specified database(s) on all nodes in
1759         the cluster.  This command should only be used when none of the
1760         specified database(s) are in use.
1761       </para>
1762       <para>
1763         All nodes should be active and tunable AllowClientDBAccess should
1764         be disabled on all nodes before detaching databases.
1765       </para>
1766     </refsect2>
1767
1768     <refsect2>
1769       <title>dumpmemory</title>
1770       <para>
1771         This is a debugging command. This command will make the ctdb
1772         daemon to write a fill memory allocation map to standard output.
1773       </para>
1774     </refsect2>
1775
1776     <refsect2>
1777       <title>rddumpmemory</title>
1778       <para>
1779         This is a debugging command. This command will dump the talloc memory
1780         allocation tree for the recovery daemon to standard output.
1781       </para>
1782     </refsect2>
1783
1784     <refsect2>
1785       <title>ban <parameter>BANTIME</parameter></title>
1786       <para>
1787         Administratively ban a node for BANTIME seconds.  The node
1788         will be unbanned after BANTIME seconds have elapsed.
1789       </para>
1790       <para>
1791         A banned node does not participate in the cluster.  It does
1792         not host any records for the clustered TDB and does not host
1793         any public IP addresses.
1794       </para>
1795       <para>
1796         Nodes are automatically banned if they misbehave.  For
1797         example, a node may be banned if it causes too many cluster
1798         recoveries.
1799       </para>
1800       <para>
1801         To administratively exclude a node from a cluster use the
1802         <command>stop</command> command.
1803       </para>
1804     </refsect2>
1805
1806     <refsect2>
1807       <title>unban</title>
1808       <para>
1809         This command is used to unban a node that has either been
1810         administratively banned using the ban command or has been
1811         automatically banned.
1812       </para>
1813     </refsect2>
1814
1815   </refsect1>
1816
1817   <!-- UNDOCUMENTED: stats
1818        isnotrecmaster addtickle deltickle
1819        tfetch tstore readkey writekey
1820        checktcpport getdbseqnum
1821   -->
1822
1823   <refsect1>
1824     <title>SEE ALSO</title>
1825     <para>
1826       <citerefentry><refentrytitle>ctdbd</refentrytitle>
1827       <manvolnum>1</manvolnum></citerefentry>,
1828
1829       <citerefentry><refentrytitle>onnode</refentrytitle>
1830       <manvolnum>1</manvolnum></citerefentry>,
1831
1832       <citerefentry><refentrytitle>ctdb</refentrytitle>
1833       <manvolnum>7</manvolnum></citerefentry>,
1834
1835       <citerefentry><refentrytitle>ctdb-statistics</refentrytitle>
1836       <manvolnum>7</manvolnum></citerefentry>,
1837
1838       <citerefentry><refentrytitle>ctdb-tunables</refentrytitle>
1839       <manvolnum>7</manvolnum></citerefentry>,
1840
1841       <ulink url="http://ctdb.samba.org/"/>
1842     </para>
1843   </refsect1>
1844
1845
1846 </refentry>