doc/ctdb.1

   1 .\"     Title: ctdb
   2 .\"    Author:
   3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
   4 .\"      Date: 07/02/2009
   5 .\"    Manual:
   6 .\"    Source:
   7 .\"
   8 .TH "CTDB" "1" "07/02/2009" "" ""
   9 .\" disable hyphenation
  10 .nh
  11 .\" disable justification (adjust text to left margin only)
  12 .ad l
  13 .SH "NAME"
  14 ctdb - clustered tdb database management utility
  15 .SH "SYNOPSIS"
  16 .HP 29
  17 \fBctdb [ OPTIONS ] COMMAND \.\.\.\fR
  18 .HP 5
  19 \fBctdb\fR [\-n\ <node>] [\-Y] [\-t\ <timeout>] [\-T\ <timelimit>] [\-?\ \-\-help] [\-\-usage] [\-d\ \-\-debug=<INTEGER>] [\-\-socket=<filename>]
  20 .SH "DESCRIPTION"
  21 .PP
  22 ctdb is a utility to view and manage a ctdb cluster\.
  23 .SH "OPTIONS"
  24 .PP
  25 \-n <pnn>
  26 .RS 4
  27 This specifies the physical node number on which to execute the command\. Default is to run the command on the deamon running on the local host\.
  28 .sp
  29 The physical node number is an integer that describes the node in the cluster\. The first node has physical node number 0\.
  30 .RE
  31 .PP
  32 \-Y
  33 .RS 4
  34 Produce output in machine readable form for easier parsing by scripts\. Not all commands support this option\.
  35 .RE
  36 .PP
  37 \-t <timeout>
  38 .RS 4
  39 How long should ctdb wait for the local ctdb daemon to respond to a command before timing out\. Default is 3 seconds\.
  40 .RE
  41 .PP
  42 \-T <timelimit>
  43 .RS 4
  44 A limit on how long the ctdb command will run for before it will be aborted\. When this timelimit has been exceeded the ctdb command will terminate\.
  45 .RE
  46 .PP
  47 \-? \-\-help
  48 .RS 4
  49 Print some help text to the screen\.
  50 .RE
  51 .PP
  52 \-\-usage
  53 .RS 4
  54 Print useage information to the screen\.
  55 .RE
  56 .PP
  57 \-d \-\-debug=<debuglevel>
  58 .RS 4
  59 Change the debug level for the command\. Default is 0\.
  60 .RE
  61 .PP
  62 \-\-socket=<filename>
  63 .RS 4
  64 Specify the socketname to use when connecting to the local ctdb daemon\. The default is /tmp/ctdb\.socket \.
  65 .sp
  66 You only need to specify this parameter if you run multiple ctdb daemons on the same physical host and thus can not use the default name for the domain socket\.
  67 .RE
  68 .SH "ADMINISTRATIVE COMMANDS"
  69 .PP
  70 These are commands used to monitor and administrate a CTDB cluster\.
  71 .SS "pnn"
  72 .PP
  73 This command displays the pnn of the current node\.
  74 .SS "status"
  75 .PP
  76 This command shows the current status of the ctdb node\.
  77 .sp
  78 .it 1 an-trap
  79 .nr an-no-space-flag 1
  80 .nr an-break-flag 1
  81 .br
  82 node status
  83 .RS
  84 .PP
  85 Node status reflects the current status of the node\. There are five possible states:
  86 .PP
  87 OK \- This node is fully functional\.
  88 .PP
  89 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\.
  90 .PP
  91 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\.
  92 .PP
  93 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\.
  94 .PP
  95 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\.
  96 .RE
  97 .sp
  98 .it 1 an-trap
  99 .nr an-no-space-flag 1
 100 .nr an-break-flag 1
 101 .br
 102 generation
 103 .RS
 104 .PP
 105 The generation id is a number that indicates the current generation of a cluster instance\. Each time a cluster goes through a reconfiguration or a recovery its generation id will be changed\.
 106 .PP
 107 This number does not have any particular meaning other than to keep track of when a cluster has gone through a recovery\. It is a random number that represents the current instance of a ctdb cluster and its databases\. CTDBD uses this number internally to be able to tell when commands to operate on the cluster and the databases was issued in a different generation of the cluster, to ensure that commands that operate on the databases will not survive across a cluster database recovery\. After a recovery, all old outstanding commands will automatically become invalid\.
 108 .PP
 109 Sometimes this number will be shown as "INVALID"\. This only means that the ctdbd daemon has started but it has not yet merged with the cluster through a recovery\. All nodes start with generation "INVALID" and are not assigned a real generation id until they have successfully been merged with a cluster through a recovery\.
 110 .RE
 111 .sp
 112 .it 1 an-trap
 113 .nr an-no-space-flag 1
 114 .nr an-break-flag 1
 115 .br
 116 VNNMAP
 117 .RS
 118 .PP
 119 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\. Only nodes that are participating in the vnnmap can become lmaster or dmaster for a database record\.
 120 .RE
 121 .sp
 122 .it 1 an-trap
 123 .nr an-no-space-flag 1
 124 .nr an-break-flag 1
 125 .br
 126 Recovery mode
 127 .RS
 128 .PP
 129 This is the current recovery mode of the cluster\. There are two possible modes:
 130 .PP
 131 NORMAL \- The cluster is fully operational\.
 132 .PP
 133 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\.
 134 .PP
 135 Once the recovery master detects an inconsistency, for example a node becomes disconnected/connected, the recovery daemon will trigger a cluster recovery process, where all databases are remerged across the cluster\. When this process starts, the recovery master will first "freeze" all databases to prevent applications such as samba from accessing the databases and it will also mark the recovery mode as RECOVERY\.
 136 .PP
 137 When CTDBD starts up, it will start in RECOVERY mode\. Once the node has been merged into a cluster and all databases have been recovered, the node mode will change into NORMAL mode and the databases will be "thawed", allowing samba to access the databases again\.
 138 .RE
 139 .sp
 140 .it 1 an-trap
 141 .nr an-no-space-flag 1
 142 .nr an-break-flag 1
 143 .br
 144 Recovery master
 145 .RS
 146 .PP
 147 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\.
 148 .PP
 149 Only one node at a time can be the designated recovery master\. Which node is designated the recovery master is decided by an election process in the recovery daemons running on each node\.
 150 .RE
 151 .PP
 152 Example: ctdb status
 153 .PP
 154 Example output:
 155 .sp
 156 .RS 4
 157 .nf
 158 Number of nodes:4
 159 pnn:0 11\.1\.2\.200       OK (THIS NODE)
 160 pnn:1 11\.1\.2\.201       OK
 161 pnn:2 11\.1\.2\.202       OK
 162 pnn:3 11\.1\.2\.203       OK
 163 Generation:1362079228
 164 Size:4
 165 hash:0 lmaster:0
 166 hash:1 lmaster:1
 167 hash:2 lmaster:2
 168 hash:3 lmaster:3
 169 Recovery mode:NORMAL (0)
 170 Recovery master:0
 171
 172 .fi
 173 .RE
 174 .SS "recmaster"
 175 .PP
 176 This command shows the pnn of the node which is currently the recmaster\.
 177 .SS "uptime"
 178 .PP
 179 This command shows the uptime for the ctdb daemon\. When the last recovery completed and how long the last recovery took\. If the "duration" is shown as a negative number, this indicates that there is a recovery in progress and it started that many seconds ago\.
 180 .PP
 181 Example: ctdb uptime
 182 .PP
 183 Example output:
 184 .sp
 185 .RS 4
 186 .nf
 187 Current time of node  : Tue Mar 24 18:27:54 2009
 188 Ctdbd start time      : (000 00:00:05) Tue Mar 24 18:27:49 2009
 189 Time of last recovery : (000 00:00:05) Tue Mar 24 18:27:49 2009
 190 Duration of last recovery : 0\.000000 seconds
 191
 192 .fi
 193 .RE
 194 .SS "listnodes"
 195 .PP
 196 This command shows lists the ip addresses of all the nodes in the cluster\.
 197 .PP
 198 Example: ctdb listnodes
 199 .PP
 200 Example output:
 201 .sp
 202 .RS 4
 203 .nf
 204 10\.0\.0\.71
 205 10\.0\.0\.72
 206 10\.0\.0\.73
 207 10\.0\.0\.74
 208
 209 .fi
 210 .RE
 211 .SS "ping"
 212 .PP
 213 This command will "ping" all CTDB daemons in the cluster to verify that they are processing commands correctly\.
 214 .PP
 215 Example: ctdb ping
 216 .PP
 217 Example output:
 218 .sp
 219 .RS 4
 220 .nf
 221 response from 0 time=0\.000054 sec  (3 clients)
 222 response from 1 time=0\.000144 sec  (2 clients)
 223 response from 2 time=0\.000105 sec  (2 clients)
 224 response from 3 time=0\.000114 sec  (2 clients)
 225
 226 .fi
 227 .RE
 228 .SS "ip"
 229 .PP
 230 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"\.
 231 .PP
 232 Example: ctdb ip
 233 .PP
 234 Example output:
 235 .sp
 236 .RS 4
 237 .nf
 238 Number of addresses:4
 239 12\.1\.1\.1         0
 240 12\.1\.1\.2         1
 241 12\.1\.1\.3         2
 242 12\.1\.1\.4         3
 243
 244 .fi
 245 .RE
 246 .SS "scriptstatus"
 247 .PP
 248 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\.
 249 .PP
 250 Example: ctdb scriptstatus
 251 .PP
 252 Example output:
 253 .sp
 254 .RS 4
 255 .nf
 256 7 scripts were executed last monitoring cycle
 257 00\.ctdb              Status:OK    Duration:0\.056 Tue Mar 24 18:56:57 2009
 258 10\.interface         Status:OK    Duration:0\.077 Tue Mar 24 18:56:57 2009
 259 11\.natgw             Status:OK    Duration:0\.039 Tue Mar 24 18:56:57 2009
 260 20\.multipathd        Status:OK    Duration:0\.038 Tue Mar 24 18:56:57 2009
 261 40\.vsftpd            Status:OK    Duration:0\.045 Tue Mar 24 18:56:57 2009
 262 41\.httpd             Status:OK    Duration:0\.039 Tue Mar 24 18:56:57 2009
 263 50\.samba             Status:ERROR    Duration:0\.082 Tue Mar 24 18:56:57 2009
 264    OUTPUT:ERROR: Samba tcp port 445 is not responding
 265
 266 .fi
 267 .RE
 268 .SS "getvar <name>"
 269 .PP
 270 Get the runtime value of a tuneable variable\.
 271 .PP
 272 Example: ctdb getvar MaxRedirectCount
 273 .PP
 274 Example output:
 275 .sp
 276 .RS 4
 277 .nf
 278 MaxRedirectCount    = 3
 279
 280 .fi
 281 .RE
 282 .SS "setvar <name> <value>"
 283 .PP
 284 Set the runtime value of a tuneable variable\.
 285 .PP
 286 Example: ctdb setvar MaxRedirectCount 5
 287 .SS "listvars"
 288 .PP
 289 List all tuneable variables\.
 290 .PP
 291 Example: ctdb listvars
 292 .PP
 293 Example output:
 294 .sp
 295 .RS 4
 296 .nf
 297 MaxRedirectCount    = 5
 298 SeqnumFrequency     = 1
 299 ControlTimeout      = 60
 300 TraverseTimeout     = 20
 301 KeepaliveInterval   = 2
 302 KeepaliveLimit      = 3
 303 MaxLACount          = 7
 304 RecoverTimeout      = 5
 305 RecoverInterval     = 1
 306 ElectionTimeout     = 3
 307 TakeoverTimeout     = 5
 308 MonitorInterval     = 15
 309 EventScriptTimeout  = 20
 310 RecoveryGracePeriod = 60
 311 RecoveryBanPeriod   = 300
 312
 313 .fi
 314 .RE
 315 .SS "lvsmaster"
 316 .PP
 317 This command shows which node is currently the LVSMASTER\. The LVSMASTER is the node in the cluster which drives the LVS system and which receives all incoming traffic from clients\.
 318 .PP
 319 LVS is the mode where the entire CTDB/Samba cluster uses a single ip address for the entire cluster\. In this mode all clients connect to one specific node which will then multiplex/loadbalance the clients evenly onto the other nodes in the cluster\. This is an alternative to using public ip addresses\. See the manpage for ctdbd for more information about LVS\.
 320 .SS "lvs"
 321 .PP
 322 This command shows which nodes in the cluster are currently active in the LVS configuration\. I\.e\. which nodes we are currently loadbalancing the single ip address across\.
 323 .PP
 324 LVS will by default only loadbalance across those nodes that are both LVS capable and also HEALTHY\. Except if all nodes are UNHEALTHY in which case LVS will loadbalance across all UNHEALTHY nodes as well\. LVS will never use nodes that are DISCONNECTED, BANNED or DISABLED\.
 325 .PP
 326 Example output:
 327 .sp
 328 .RS 4
 329 .nf
 330 2:10\.0\.0\.13
 331 3:10\.0\.0\.14
 332
 333 .fi
 334 .RE
 335 .SS "getcapabilities"
 336 .PP
 337 This command shows the capabilities of the current node\. Please see manpage for ctdbd for a full list of all capabilities and more detailed description\.
 338 .PP
 339 RECMASTER and LMASTER capabilities are primarily used when CTDBD is used to create a cluster spanning across WAN links\. In which case ctdbd acts as a WAN accelerator\.
 340 .PP
 341 LVS capabile means that the node is participating in LVS, a mode where the entire CTDB cluster uses one single ip address for the entire cluster instead of using public ip address failover\. This is an alternative to using a loadbalancing layer\-4 switch\.
 342 .PP
 343 Example output:
 344 .sp
 345 .RS 4
 346 .nf
 347 RECMASTER: YES
 348 LMASTER: YES
 349 LVS: NO
 350
 351 .fi
 352 .RE
 353 .SS "statistics"
 354 .PP
 355 Collect statistics from the CTDB daemon about how many calls it has served\.
 356 .PP
 357 Example: ctdb statistics
 358 .PP
 359 Example output:
 360 .sp
 361 .RS 4
 362 .nf
 363 CTDB version 1
 364  num_clients                        3
 365  frozen                             0
 366  recovering                         0
 367  client_packets_sent           360489
 368  client_packets_recv           360466
 369  node_packets_sent             480931
 370  node_packets_recv             240120
 371  keepalive_packets_sent             4
 372  keepalive_packets_recv             3
 373  node
 374      req_call                       2
 375      reply_call                     2
 376      req_dmaster                    0
 377      reply_dmaster                  0
 378      reply_error                    0
 379      req_message                   42
 380      req_control               120408
 381      reply_control             360439
 382  client
 383      req_call                       2
 384      req_message                   24
 385      req_control               360440
 386  timeouts
 387      call                           0
 388      control                        0
 389      traverse                       0
 390  total_calls                        2
 391  pending_calls                      0
 392  lockwait_calls                     0
 393  pending_lockwait_calls             0
 394  memory_used                     5040
 395  max_hop_count                      0
 396  max_call_latency                   4\.948321 sec
 397  max_lockwait_latency               0\.000000 sec
 398
 399 .fi
 400 .RE
 401 .SS "statisticsreset"
 402 .PP
 403 This command is used to clear all statistics counters in a node\.
 404 .PP
 405 Example: ctdb statisticsreset
 406 .SS "getreclock"
 407 .PP
 408 This command is used to show the filename of the reclock file that is used\.
 409 .PP
 410 Example output:
 411 .sp
 412 .RS 4
 413 .nf
 414 Reclock file:/gpfs/\.ctdb/shared
 415
 416 .fi
 417 .RE
 418 .SS "setreclock [filename]"
 419 .PP
 420 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"\.
 421 .PP
 422 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\.
 423 .PP
 424 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\.
 425 .SS "getdebug"
 426 .PP
 427 Get the current debug level for the node\. the debug level controls what information is written to the log file\.
 428 .PP
 429 The debug levels are mapped to the corresponding syslog levels\. When a debug level is set, only those messages at that level and higher levels will be printed\.
 430 .PP
 431 The list of debug levels from highest to lowest are :
 432 .PP
 433 EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
 434 .SS "setdebug <debuglevel>"
 435 .PP
 436 Set the debug level of a node\. This controls what information will be logged\.
 437 .PP
 438 The debuglevel is one of EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
 439 .SS "getpid"
 440 .PP
 441 This command will return the process id of the ctdb daemon\.
 442 .SS "disable"
 443 .PP
 444 This command is used to administratively disable a node in the cluster\. A disabled node will still participate in the cluster and host clustered TDB records but its public ip address has been taken over by a different node and it no longer hosts any services\.
 445 .SS "enable"
 446 .PP
 447 Re\-enable a node that has been administratively disabled\.
 448 .SS "ban <bantime|0>"
 449 .PP
 450 Administratively ban a node for bantime seconds\. A bantime of 0 means that the node should be permanently banned\.
 451 .PP
 452 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\.
 453 .PP
 454 Nodes are automatically banned if they are the cause of too many cluster recoveries\.
 455 .SS "addip <public_ip/mask> <iface>"
 456 .PP
 457 This command is used to add a new public ip to a node during runtime\. This allows public addresses to be added to a cluster without having to restart the ctdb daemons\.
 458 .PP
 459 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\. If you want this change to be permanent you must also update the public addresses file manually\.
 460 .SS "delip <public_ip>"
 461 .PP
 462 This command is used to remove a public ip from a node during runtime\. 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\.
 463 .PP
 464 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\. If you want this change to be permanent you must also update the public addresses file manually\.
 465 .SS "moveip <public_ip> <node>"
 466 .PP
 467 This command can be used to manually fail a public ip address to a specific node\.
 468 .PP
 469 In order to manually override the "automatic" distribution of public ip addresses that ctdb normally provides, this command only works when you have changed the tunables for the daemon to:
 470 .PP
 471 DeterministicIPs = 0
 472 .PP
 473 NoIPFailback = 1
 474 .SS "unban"
 475 .PP
 476 This command is used to unban a node that has either been administratively banned using the ban command or has been automatically banned by the recovery daemon\.
 477 .SS "shutdown"
 478 .PP
 479 This command will shutdown a specific CTDB daemon\.
 480 .SS "recover"
 481 .PP
 482 This command will trigger the recovery daemon to do a cluster recovery\.
 483 .SS "ipreallocate"
 484 .PP
 485 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\.
 486 .SS "killtcp <srcip:port> <dstip:port>"
 487 .PP
 488 This command will kill the specified TCP connection by issuing a TCP RST to the srcip:port endpoint\. This is a command used by the ctdb eventscripts\.
 489 .SS "gratiousarp <ip> <interface>"
 490 .PP
 491 This command will send out a gratious arp for the specified interface through the specified interface\. This command is mainly used by the ctdb eventscripts\.
 492 .SS "reloadnodes"
 493 .PP
 494 This command is used when adding new nodes, or removing existing nodes from an existing cluster\.
 495 .PP
 496 Procedure to add a node:
 497 .PP
 498 1, To expand an existing cluster, first ensure with \'ctdb status\' that all nodes are up and running and that they are all healthy\. Do not try to expand a cluster unless it is completely healthy!
 499 .PP
 500 2, On all nodes, edit /etc/ctdb/nodes and add the new node as the last entry to the file\. The new node MUST be added to the end of this file!
 501 .PP
 502 3, Verify that all the nodes have identical /etc/ctdb/nodes files after you edited them and added the new node!
 503 .PP
 504 4, Run \'ctdb reloadnodes\' to force all nodes to reload the nodesfile\.
 505 .PP
 506 5, Use \'ctdb status\' on all nodes and verify that they now show the additional node\.
 507 .PP
 508 6, Install and configure the new node and bring it online\.
 509 .PP
 510 Procedure to remove a node:
 511 .PP
 512 1, To remove a node from an existing cluster, first ensure with \'ctdb status\' that all nodes, except the node to be deleted, are up and running and that they are all healthy\. Do not try to remove a node from a cluster unless the cluster is completely healthy!
 513 .PP
 514 2, Shutdown and poerwoff the node to be removed\.
 515 .PP
 516 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\.
 517 .PP
 518 4, Run \'ctdb reloadnodes\' to force all nodes to reload the nodesfile\.
 519 .PP
 520 5, Use \'ctdb status\' on all nodes and verify that the deleted node no longer shows up in the list\.\.
 521 .PP
 522 .SS "tickle <srcip:port> <dstip:port>"
 523 .PP
 524 This command will will send a TCP tickle to the source host for the specified TCP connection\. A TCP tickle is a TCP ACK packet with an invalid sequence and acknowledge number and will when received by the source host result in it sending an immediate correct ACK back to the other end\.
 525 .PP
 526 TCP tickles are useful to "tickle" clients after a IP failover has occured since this will make the client immediately recognize the TCP connection has been disrupted and that the client will need to reestablish\. This greatly speeds up the time it takes for a client to detect and reestablish after an IP failover in the ctdb cluster\.
 527 .SS "gettickles <ip>"
 528 .PP
 529 This command is used to show which TCP connections are registered with CTDB to be "tickled" if there is a failover\.
 530 .SS "repack [max_freelist]"
 531 .PP
 532 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\. This command is used to defragment a TDB database and pruning the freelist\.
 533 .PP
 534 If [max_freelist] is specified, then a database will only be repacked if it has more than this number of entries in the freelist\.
 535 .PP
 536 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\.
 537 .PP
 538 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\.
 539 .PP
 540 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\.
 541 .PP
 542 Example: ctdb repack 1000
 543 .PP
 544 By default, this operation is issued from the 00\.ctdb event script every 5 minutes\.
 545 .SS "vacuum [max_records]"
 546 .PP
 547 Over time CTDB databases will fill up with empty deleted records which will lead to a progressive slow down of CTDB database access\. This command is used to prune all databases and delete all empty records from the cluster\.
 548 .PP
 549 By default, vacuum will delete all empty records from all databases\. If [max_records] is specified, the command will only delete the first [max_records] empty records for each database\.
 550 .PP
 551 Vacuum only deletes records where the local node is the lmaster\. To delete all records from the entire cluster you need to run a vacuum from each node\. This command is not disruptive\. Samba is unaffected and will still be able to read/write records normally while the database is being vacuumed\.
 552 .PP
 553 Example: ctdb vacuum
 554 .PP
 555 By default, this operation is issued from the 00\.ctdb event script every 5 minutes\.
 556 .SH "DEBUGGING COMMANDS"
 557 .PP
 558 These commands are primarily used for CTDB development and testing and should not be used for normal administration\.
 559 .SS "process\-exists <pid>"
 560 .PP
 561 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\.
 562 .SS "getdbmap"
 563 .PP
 564 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\.
 565 .PP
 566 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\.
 567 .PP
 568 Example: ctdb getdbmap
 569 .PP
 570 Example output:
 571 .sp
 572 .RS 4
 573 .nf
 574 Number of databases:10
 575 dbid:0x435d3410 name:notify\.tdb path:/var/ctdb/notify\.tdb\.0
 576 dbid:0x42fe72c5 name:locking\.tdb path:/var/ctdb/locking\.tdb\.0 dbid:0x1421fb78 name:brlock\.tdb path:/var/ctdb/brlock\.tdb\.0
 577 dbid:0x17055d90 name:connections\.tdb path:/var/ctdb/connections\.tdb\.0
 578 dbid:0xc0bdde6a name:sessionid\.tdb path:/var/ctdb/sessionid\.tdb\.0
 579 dbid:0x122224da name:test\.tdb path:/var/ctdb/test\.tdb\.0
 580 dbid:0x2672a57f name:idmap2\.tdb path:/var/ctdb/persistent/idmap2\.tdb\.0 PERSISTENT
 581 dbid:0xb775fff6 name:secrets\.tdb path:/var/ctdb/persistent/secrets\.tdb\.0 PERSISTENT
 582 dbid:0xe98e08b6 name:group_mapping\.tdb path:/var/ctdb/persistent/group_mapping\.tdb\.0 PERSISTENT
 583 dbid:0x7bbbd26c name:passdb\.tdb path:/var/ctdb/persistent/passdb\.tdb\.0 PERSISTENT
 584
 585 .fi
 586 .RE
 587 .SS "catdb <dbname>"
 588 .PP
 589 This command will dump a clustered TDB database to the screen\. This is a debugging command\.
 590 .SS "getmonmode"
 591 .PP
 592 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\.
 593 .PP
 594 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\.
 595 .PP
 596 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\.
 597 .SS "setmonmode <0|1>"
 598 .PP
 599 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\.
 600 .SS "attach <dbname>"
 601 .PP
 602 This is a debugging command\. This command will make the CTDB daemon create a new CTDB database and attach to it\.
 603 .SS "dumpmemory"
 604 .PP
 605 This is a debugging command\. This command will make the ctdb daemon to write a fill memory allocation map to standard output\.
 606 .SS "rddumpmemory"
 607 .PP
 608 This is a debugging command\. This command will dump the talloc memory allocation tree for the recovery daemon to standard output\.
 609 .SS "freeze"
 610 .PP
 611 This command will lock all the local TDB databases causing clients that are accessing these TDBs such as samba3 to block until the databases are thawed\.
 612 .PP
 613 This is primarily used by the recovery daemon to stop all samba daemons from accessing any databases while the database is recovered and rebuilt\.
 614 .SS "thaw"
 615 .PP
 616 Thaw a previously frozen node\.
 617 .SS "eventscript <arguments>"
 618 .PP
 619 This is a debugging command\. This command can be used to manually invoke and run the eventscritps with arbitrary arguments\.
 620 .SS "backupdb <database> <file>"
 621 .PP
 622 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\. This is mainly useful for backing up persistent databases such as secrets\.tdb and similar\.
 623 .SS "restoredb <file>"
 624 .PP
 625 This command restores a persistent database that was previously backed up using backupdb\.
 626 .SH "SEE ALSO"
 627 .PP
 628 ctdbd(1), onnode(1)
 629 \fI\%http://ctdb.samba.org/\fR
 630 .SH "COPYRIGHT/LICENSE"
 631 .sp
 632 .RS 4
 633 .nf
 634 Copyright (C) Andrew Tridgell 2007
 635 Copyright (C) Ronnie sahlberg 2007
 636
 637 This program is free software; you can redistribute it and/or modify
 638 it under the terms of the GNU General Public License as published by
 639 the Free Software Foundation; either version 3 of the License, or (at
 640 your option) any later version\.
 641
 642 This program is distributed in the hope that it will be useful, but
 643 WITHOUT ANY WARRANTY; without even the implied warranty of
 644 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\.  See the GNU
 645 General Public License for more details\.
 646
 647 You should have received a copy of the GNU General Public License
 648 along with this program; if not, see http://www\.gnu\.org/licenses/\.
 649 .fi
 650 .RE