doc/ctdb.1.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="ctdb.1">
   4
   5 <refmeta>
   6         <refentrytitle>ctdb</refentrytitle>
   7         <manvolnum>1</manvolnum>
   8 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>ctdb</refname>
  13         <refpurpose>clustered tdb database management utility</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17         <cmdsynopsis>
  18                 <command>ctdb [ OPTIONS ] COMMAND ...</command>
  19         </cmdsynopsis>
  20
  21         <cmdsynopsis>
  22                 <command>ctdb</command>
  23                 <arg choice="opt">-n &lt;node&gt;</arg>
  24                 <arg choice="opt">-Y</arg>
  25                 <arg choice="opt">-t &lt;timeout&gt;</arg>
  26                 <arg choice="opt">-T &lt;timelimit&gt;</arg>
  27                 <arg choice="opt">-? --help</arg>
  28                 <arg choice="opt">--usage</arg>
  29                 <arg choice="opt">-d --debug=&lt;INTEGER&gt;</arg>
  30                 <arg choice="opt">--socket=&lt;filename&gt;</arg>
  31         </cmdsynopsis>
  32
  33 </refsynopsisdiv>
  34
  35   <refsect1><title>DESCRIPTION</title>
  36     <para>
  37       ctdb is a utility to view and manage a ctdb cluster.
  38     </para>
  39   </refsect1>
  40
  41
  42   <refsect1>
  43     <title>OPTIONS</title>
  44
  45     <variablelist>
  46       <varlistentry><term>-n &lt;pnn&gt;</term>
  47         <listitem>
  48           <para>
  49             This specifies the physical node number on which to execute the
  50             command. Default is to run the command on the deamon running on
  51             the local host.
  52           </para>
  53           <para>
  54             The physical node number is an integer that describes the node in the
  55             cluster. The first node has physical node number 0.
  56           </para>
  57         </listitem>
  58       </varlistentry>
  59
  60       <varlistentry><term>-Y</term>
  61         <listitem>
  62           <para>
  63             Produce output in machine readable form for easier parsing by scripts. Not all commands support this option.
  64           </para>
  65         </listitem>
  66       </varlistentry>
  67
  68       <varlistentry><term>-t &lt;timeout&gt;</term>
  69         <listitem>
  70           <para>
  71             How long should ctdb wait for the local ctdb daemon to respond to a command before timing out. Default is 3 seconds.
  72           </para>
  73         </listitem>
  74       </varlistentry>
  75
  76       <varlistentry><term>-T &lt;timelimit&gt;</term>
  77         <listitem>
  78           <para>
  79             A limit on how long the ctdb command will run for before it will
  80             be aborted. When this timelimit has been exceeded the ctdb command will
  81             terminate.
  82           </para>
  83         </listitem>
  84       </varlistentry>
  85
  86       <varlistentry><term>-? --help</term>
  87         <listitem>
  88           <para>
  89             Print some help text to the screen.
  90           </para>
  91         </listitem>
  92       </varlistentry>
  93
  94       <varlistentry><term>--usage</term>
  95         <listitem>
  96           <para>
  97             Print useage information to the screen.
  98           </para>
  99         </listitem>
 100       </varlistentry>
 101
 102       <varlistentry><term>-d --debug=&lt;debuglevel&gt;</term>
 103         <listitem>
 104           <para>
 105             Change the debug level for the command. Default is 0.
 106           </para>
 107         </listitem>
 108       </varlistentry>
 109
 110       <varlistentry><term>--socket=&lt;filename&gt;</term>
 111         <listitem>
 112           <para>
 113             Specify the socketname to use when connecting to the local ctdb
 114             daemon. The default is /tmp/ctdb.socket .
 115           </para>
 116           <para>
 117             You only need to specify this parameter if you run multiple ctdb
 118             daemons on the same physical host and thus can not use the default
 119             name for the domain socket.
 120           </para>
 121         </listitem>
 122       </varlistentry>
 123
 124     </variablelist>
 125   </refsect1>
 126
 127
 128   <refsect1><title>Administrative Commands</title>
 129     <para>
 130       These are commands used to monitor and administrate a CTDB cluster.
 131     </para>
 132
 133     <refsect2><title>status</title>
 134       <para>
 135         This command shows the current status of the ctdb node.
 136       </para>
 137
 138       <refsect3><title>node status</title>
 139         <para>
 140           Node status reflects the current status of the node. There are four possible states:
 141         </para>
 142         <para>
 143           OK - This node is fully functional.
 144         </para>
 145         <para>
 146           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.
 147         </para>
 148         <para>
 149           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.
 150         </para>
 151         <para>
 152           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.
 153         </para>
 154         <para>
 155           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.
 156         </para>
 157       </refsect3>
 158
 159       <refsect3><title>generation</title>
 160         <para>
 161           The generation id is a number that indicates the current generation
 162           of a cluster instance. Each time a cluster goes through a
 163           reconfiguration or a recovery its generation id will be changed.
 164         </para>
 165       </refsect3>
 166
 167       <refsect3><title>VNNMAP</title>
 168         <para>
 169           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.
 170           Only nodes that are participating in the vnnmap can become lmaster or dmaster for a database record.
 171         </para>
 172       </refsect3>
 173
 174       <refsect3><title>Recovery mode</title>
 175         <para>
 176           This is the current recovery mode of the cluster. There are two possible modes:
 177         </para>
 178         <para>
 179           NORMAL - The cluster is fully operational.
 180         </para>
 181         <para>
 182           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.
 183         </para>
 184       </refsect3>
 185
 186       <refsect3><title>Recovery master</title>
 187         <para>
 188           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.
 189         </para>
 190       </refsect3>
 191
 192       <para>
 193         Example: ctdb status
 194       </para>
 195       <para>Example output:</para>
 196       <screen format="linespecific">
 197 Number of nodes:4
 198 pnn:0 11.1.2.200       OK (THIS NODE)
 199 pnn:1 11.1.2.201       OK
 200 pnn:2 11.1.2.202       OK
 201 pnn:3 11.1.2.203       OK
 202 Generation:1362079228
 203 Size:4
 204 hash:0 lmaster:0
 205 hash:1 lmaster:1
 206 hash:2 lmaster:2
 207 hash:3 lmaster:3
 208 Recovery mode:NORMAL (0)
 209 Recovery master:0
 210       </screen>
 211     </refsect2>
 212
 213     <refsect2><title>ping</title>
 214       <para>
 215         This command will "ping" all CTDB daemons in the cluster to verify that they are processing commands correctly.
 216       </para>
 217       <para>
 218         Example: ctdb ping
 219       </para>
 220       <para>
 221         Example output:
 222       </para>
 223       <screen format="linespecific">
 224 response from 0 time=0.000054 sec  (3 clients)
 225 response from 1 time=0.000144 sec  (2 clients)
 226 response from 2 time=0.000105 sec  (2 clients)
 227 response from 3 time=0.000114 sec  (2 clients)
 228       </screen>
 229     </refsect2>
 230
 231     <refsect2><title>ip</title>
 232       <para>
 233         This command will display the list of public addresses that are provided by the cluster and which physical node is currently serving this ip.
 234       </para>
 235       <para>
 236         Example: ctdb ip
 237       </para>
 238       <para>
 239         Example output:
 240       </para>
 241       <screen format="linespecific">
 242 Number of addresses:4
 243 12.1.1.1         0
 244 12.1.1.2         1
 245 12.1.1.3         2
 246 12.1.1.4         3
 247       </screen>
 248     </refsect2>
 249
 250     <refsect2><title>getvar &lt;name&gt;</title>
 251       <para>
 252         Get the runtime value of a tuneable variable.
 253       </para>
 254       <para>
 255         Example: ctdb getvar MaxRedirectCount
 256       </para>
 257       <para>
 258         Example output:
 259       </para>
 260       <screen format="linespecific">
 261 MaxRedirectCount    = 3
 262       </screen>
 263     </refsect2>
 264
 265     <refsect2><title>setvar &lt;name&gt; &lt;value&gt;</title>
 266       <para>
 267         Set the runtime value of a tuneable variable.
 268       </para>
 269       <para>
 270         Example: ctdb setvar MaxRedirectCount 5
 271       </para>
 272     </refsect2>
 273
 274     <refsect2><title>listvars</title>
 275       <para>
 276         List all tuneable variables.
 277       </para>
 278       <para>
 279         Example: ctdb listvars
 280       </para>
 281       <para>
 282         Example output:
 283       </para>
 284       <screen format="linespecific">
 285 MaxRedirectCount    = 5
 286 SeqnumFrequency     = 1
 287 ControlTimeout      = 60
 288 TraverseTimeout     = 20
 289 KeepaliveInterval   = 2
 290 KeepaliveLimit      = 3
 291 MaxLACount          = 7
 292 RecoverTimeout      = 5
 293 RecoverInterval     = 1
 294 ElectionTimeout     = 3
 295 TakeoverTimeout     = 5
 296 MonitorInterval     = 15
 297 EventScriptTimeout  = 20
 298 RecoveryGracePeriod = 60
 299 RecoveryBanPeriod   = 300
 300       </screen>
 301     </refsect2>
 302
 303     <refsect2><title>statistics</title>
 304       <para>
 305         Collect statistics from the CTDB daemon about how many calls it has served.
 306       </para>
 307       <para>
 308         Example: ctdb statistics
 309       </para>
 310       <para>
 311         Example output:
 312       </para>
 313       <screen format="linespecific">
 314 CTDB version 1
 315  num_clients                        3
 316  frozen                             0
 317  recovering                         0
 318  client_packets_sent           360489
 319  client_packets_recv           360466
 320  node_packets_sent             480931
 321  node_packets_recv             240120
 322  keepalive_packets_sent             4
 323  keepalive_packets_recv             3
 324  node
 325      req_call                       2
 326      reply_call                     2
 327      req_dmaster                    0
 328      reply_dmaster                  0
 329      reply_error                    0
 330      req_message                   42
 331      req_control               120408
 332      reply_control             360439
 333  client
 334      req_call                       2
 335      req_message                   24
 336      req_control               360440
 337  timeouts
 338      call                           0
 339      control                        0
 340      traverse                       0
 341  total_calls                        2
 342  pending_calls                      0
 343  lockwait_calls                     0
 344  pending_lockwait_calls             0
 345  memory_used                     5040
 346  max_hop_count                      0
 347  max_call_latency                   4.948321 sec
 348  max_lockwait_latency               0.000000 sec
 349       </screen>
 350     </refsect2>
 351
 352     <refsect2><title>statisticsreset</title>
 353       <para>
 354         This command is used to clear all statistics counters in a node.
 355       </para>
 356       <para>
 357         Example: ctdb statisticsreset
 358       </para>
 359     </refsect2>
 360
 361     <refsect2><title>getdebug</title>
 362       <para>
 363         Get the current debug level for the node. the debug level controls what information is written to the log file.
 364       </para>
 365     </refsect2>
 366
 367     <refsect2><title>setdebug &lt;debuglevel&gt;</title>
 368       <para>
 369         Set the debug level of a node. This is a number between 0 and 9 and controls what information will be written to the logfile.
 370       </para>
 371     </refsect2>
 372
 373     <refsect2><title>getpid</title>
 374       <para>
 375         This command will return the process id of the ctdb daemon.
 376       </para>
 377     </refsect2>
 378
 379     <refsect2><title>disable</title>
 380       <para>
 381         This command is used to administratively disable a node in the cluster.
 382         A disabled node will still participate in the cluster and host
 383         clustered TDB records but its public ip address has been taken over by
 384         a different node and it no longer hosts any services.
 385       </para>
 386     </refsect2>
 387
 388     <refsect2><title>enable</title>
 389       <para>
 390         Re-enable a node that has been administratively disabled.
 391       </para>
 392     </refsect2>
 393
 394     <refsect2><title>ban &lt;bantime|0&gt;</title>
 395       <para>
 396         Administratively ban a node for bantime seconds. A bantime of 0 means that the node should be permanently banned.
 397       </para>
 398       <para>
 399         A banned node does not participate in the cluster and does not host any records for the clustered TDB. Its ip address has been taken over by an other node and no services are hosted.
 400       </para>
 401       <para>
 402         Nodes are automatically banned if they are the cause of too many
 403         cluster recoveries.
 404       </para>
 405     </refsect2>
 406
 407     <refsect2><title>unban</title>
 408       <para>
 409         This command is used to unban a node that has either been
 410         administratively banned using the ban command or has been automatically
 411         banned by the recovery daemon.
 412       </para>
 413     </refsect2>
 414
 415     <refsect2><title>shutdown</title>
 416       <para>
 417         This command will shutdown a specific CTDB daemon.
 418       </para>
 419     </refsect2>
 420
 421     <refsect2><title>recover</title>
 422       <para>
 423         This command will trigger the recovery daemon to do a cluster
 424         recovery.
 425       </para>
 426     </refsect2>
 427
 428     <refsect2><title>killtcp &lt;srcip:port&gt; &lt;dstip:port&gt;</title>
 429       <para>
 430         This command will kill the specified TCP connection by issuing a
 431         TCP RST to the srcip:port endpoint.
 432       </para>
 433     </refsect2>
 434
 435     <refsect2><title>tickle &lt;srcip:port&gt; &lt;dstip:port&gt;</title>
 436       <para>
 437         This command will will send a TCP tickle to the source host for the
 438         specified TCP connection.
 439         A TCP tickle is a TCP ACK packet with an invalid sequence and
 440         acknowledge number and will when received by the source host result
 441         in it sending an immediate correct ACK back to the other end.
 442       </para>
 443       <para>
 444         TCP tickles are useful to "tickle" clients after a IP failover has
 445         occured since this will make the client immediately recognize the
 446         TCP connection has been disrupted and that the client will need
 447         to reestablish. This greatly speeds up the time it takes for a client
 448         to detect and reestablish after an IP failover in the ctdb cluster.
 449       </para>
 450     </refsect2>
 451
 452     <refsect2><title>repack [max_freelist]</title>
 453       <para>
 454         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.
 455         This command is used to defragment a TDB database and pruning the freelist.
 456       </para>
 457
 458         <para>
 459         If [max_freelist] is specified, then a database will only be repacked if it has more than this number of entries in the freelist.
 460         </para>
 461       <para>
 462         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.
 463       </para>
 464
 465       <para>
 466         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.
 467       </para>
 468
 469       <para>
 470         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.
 471         </para>
 472
 473       <para>
 474         Example: ctdb repack 1000
 475       </para>
 476
 477       <para>
 478          By default, this operation is issued from the 00.ctdb event script every 5 minutes.
 479       </para>
 480
 481     </refsect2>
 482
 483     <refsect2><title>vacuum [max_records]</title>
 484       <para>
 485         Over time CTDB databases will fill up with empty deleted records which will lead to a progressive slow down of CTDB database access.
 486         This command is used to prune all databases and delete all empty records from the cluster.
 487       </para>
 488
 489       <para>
 490          By default, vacuum will delete all empty records from all databases.
 491          If [max_records] is specified, the command will only delete the first
 492          [max_records] empty records for each database.
 493       </para>
 494
 495       <para>
 496          Vacuum only deletes records where the local node is the lmaster.
 497          To delete all records from the entire cluster you need to run a vacuum from each node.
 498
 499          This command is not disruptive. Samba is unaffected and will still be able to read/write records normally while the database is being vacuumed.
 500       </para>
 501
 502       <para>
 503         Example: ctdb vacuum
 504       </para>
 505
 506       <para>
 507          By default, this operation is issued from the 00.ctdb event script every 5 minutes.
 508       </para>
 509     </refsect2>
 510
 511   </refsect1>
 512
 513
 514   <refsect1><title>Debugging Commands</title>
 515     <para>
 516       These commands are primarily used for CTDB development and testing and
 517       should not be used for normal administration.
 518     </para>
 519     <refsect2><title>process-exists &lt;pid&gt;</title>
 520       <para>
 521         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.
 522       </para>
 523     </refsect2>
 524
 525     <refsect2><title>getdbmap</title>
 526       <para>
 527         This command lists all clustered TDB databases that the CTDB daemon has attahced to.
 528       </para>
 529       <para>
 530         Example: ctdb getdbmap
 531       </para>
 532       <para>
 533         Example output:
 534       </para>
 535       <screen format="linespecific">
 536 Number of databases:4
 537 dbid:0x42fe72c5 name:locking.tdb path:/var/ctdb/locking.tdb.0
 538 dbid:0x1421fb78 name:brlock.tdb path:/var/ctdb/brlock.tdb.0
 539 dbid:0x17055d90 name:connections.tdb path:/var/ctdb/connections.tdb.0
 540 dbid:0xc0bdde6a name:sessionid.tdb path:/var/ctdb/sessionid.tdb.0
 541       </screen>
 542     </refsect2>
 543
 544     <refsect2><title>catdb &lt;dbname&gt;</title>
 545       <para>
 546         This command will dump a clustered TDB database to the screen. This is a debugging command.
 547       </para>
 548     </refsect2>
 549
 550     <refsect2><title>getmonmode</title>
 551       <para>
 552         This command returns the monutoring mode of a node. The monitoring mode is either ACTIVE or DISABLED. Normally a node will continously monitor that all other nodes that are expected are in fact connected and that they respond to commands.
 553       </para>
 554       <para>
 555         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.
 556       </para>
 557       <para>
 558         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.
 559       </para>
 560     </refsect2>
 561
 562
 563     <refsect2><title>setmonmode &lt;0|1&gt;</title>
 564       <para>
 565         This command can be used to explicitely disable/enable monitoring mode on a node. The main purpose is if one wants to attach GDB to a running ctdb daemon but wants to prevent the other nodes from marking it as DISCONNECTED and issuing a recovery. To do this, set monitoring mode to 0 on all nodes before attaching with GDB. Remember to set monitoring mode back to 1 afterwards.
 566       </para>
 567     </refsect2>
 568
 569     <refsect2><title>attach &lt;dbname&gt;</title>
 570       <para>
 571         This is a debugging command. This command will make the CTDB daemon create a new CTDB database and attach to it.
 572       </para>
 573     </refsect2>
 574
 575     <refsect2><title>dumpmemory</title>
 576       <para>
 577         This is a debugging command. This command will make the ctdb daemon to write a fill memory allocation map to the log file.
 578       </para>
 579     </refsect2>
 580
 581     <refsect2><title>freeze</title>
 582       <para>
 583         This command will lock all the local TDB databases causing clients
 584         that are accessing these TDBs such as samba3 to block until the
 585         databases are thawed.
 586       </para>
 587       <para>
 588         This is primarily used by the recovery daemon to stop all samba
 589         daemons from accessing any databases while the database is recovered
 590         and rebuilt.
 591       </para>
 592     </refsect2>
 593
 594     <refsect2><title>thaw</title>
 595       <para>
 596         Thaw a previously frozen node.
 597       </para>
 598     </refsect2>
 599
 600   </refsect1>
 601
 602
 603   <refsect1><title>SEE ALSO</title>
 604     <para>
 605       ctdbd(1), onnode(1)
 606       <ulink url="http://ctdb.samba.org/"/>
 607     </para>
 608   </refsect1>
 609   <refsect1><title>COPYRIGHT/LICENSE</title>
 610 <literallayout>
 611 Copyright (C) Andrew Tridgell 2007
 612 Copyright (C) Ronnie sahlberg 2007
 613
 614 This program is free software; you can redistribute it and/or modify
 615 it under the terms of the GNU General Public License as published by
 616 the Free Software Foundation; either version 3 of the License, or (at
 617 your option) any later version.
 618
 619 This program is distributed in the hope that it will be useful, but
 620 WITHOUT ANY WARRANTY; without even the implied warranty of
 621 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 622 General Public License for more details.
 623
 624 You should have received a copy of the GNU General Public License
 625 along with this program; if not, see http://www.gnu.org/licenses/.
 626 </literallayout>
 627   </refsect1>
 628 </refentry>