ctdb/doc/ctdb.1.xml

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