doc/ctdb.1

   1 '\" t
   2 .\"     Title: ctdb
   3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
   5 .\"      Date: 05/20/2010
   6 .\"    Manual: CTDB - clustered TDB database
   7 .\"    Source: ctdb
   8 .\"  Language: English
   9 .\"
  10 .TH "CTDB" "1" "05/20/2010" "ctdb" "CTDB \- clustered TDB database"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 ctdb \- clustered tdb database management utility
  23 .SH "SYNOPSIS"
  24 .HP \w'\fBctdb\ [\ OPTIONS\ ]\ COMMAND\ \&.\&.\&.\fR\ 'u
  25 \fBctdb [ OPTIONS ] COMMAND \&.\&.\&.\fR
  26 .HP \w'\fBctdb\fR\ 'u
  27 \fBctdb\fR [\-n\ <node>] [\-Y] [\-t\ <timeout>] [\-T\ <timelimit>] [\-?\ \-\-help] [\-\-usage] [\-d\ \-\-debug=<INTEGER>] [\-\-socket=<filename>]
  28 .SH "DESCRIPTION"
  29 .PP
  30 ctdb is a utility to view and manage a ctdb cluster\&.
  31 .SH "OPTIONS"
  32 .PP
  33 \-n <pnn>
  34 .RS 4
  35 This specifies the physical node number on which to execute the command\&. Default is to run the command on the daemon running on the local host\&.
  36 .sp
  37 The physical node number is an integer that describes the node in the cluster\&. The first node has physical node number 0\&.
  38 .RE
  39 .PP
  40 \-Y
  41 .RS 4
  42 Produce output in machine readable form for easier parsing by scripts\&. Not all commands support this option\&.
  43 .RE
  44 .PP
  45 \-t <timeout>
  46 .RS 4
  47 How long should ctdb wait for the local ctdb daemon to respond to a command before timing out\&. Default is 3 seconds\&.
  48 .RE
  49 .PP
  50 \-T <timelimit>
  51 .RS 4
  52 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\&.
  53 .RE
  54 .PP
  55 \-? \-\-help
  56 .RS 4
  57 Print some help text to the screen\&.
  58 .RE
  59 .PP
  60 \-\-usage
  61 .RS 4
  62 Print useage information to the screen\&.
  63 .RE
  64 .PP
  65 \-d \-\-debug=<debuglevel>
  66 .RS 4
  67 Change the debug level for the command\&. Default is 0\&.
  68 .RE
  69 .PP
  70 \-\-socket=<filename>
  71 .RS 4
  72 Specify the socketname to use when connecting to the local ctdb daemon\&. The default is /tmp/ctdb\&.socket \&.
  73 .sp
  74 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\&.
  75 .RE
  76 .SH "ADMINISTRATIVE COMMANDS"
  77 .PP
  78 These are commands used to monitor and administrate a CTDB cluster\&.
  79 .SS "pnn"
  80 .PP
  81 This command displays the pnn of the current node\&.
  82 .SS "status"
  83 .PP
  84 This command shows the current status of the ctdb node\&.
  85 .sp
  86 .it 1 an-trap
  87 .nr an-no-space-flag 1
  88 .nr an-break-flag 1
  89 .br
  90 .ps +1
  91 \fBnode status\fR
  92 .RS 4
  93 .PP
  94 Node status reflects the current status of the node\&. There are five possible states:
  95 .PP
  96 OK \- This node is fully functional\&.
  97 .PP
  98 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\&.
  99 .PP
 100 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\&.
 101 .PP
 102 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\&.
 103 .PP
 104 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\&.
 105 .PP
 106 STOPPED \- A node that is stopped does not host any public ip addresses, nor is it part of the VNNMAP\&. A stopped node can not become LVSMASTER, RECMASTER or NATGW\&. This node does not perticipate in the CTDB cluster but can still be communicated with\&. I\&.e\&. ctdb commands can be sent to it\&.
 107 .PP
 108 PARTIALLYONLINE \- A node that is partially online participates in a cluster like a node that is ok\&. Some interfaces to serve public ip addresses are down, but at least one interface is up\&. See also "ctdb ifaces"\&.
 109 .RE
 110 .sp
 111 .it 1 an-trap
 112 .nr an-no-space-flag 1
 113 .nr an-break-flag 1
 114 .br
 115 .ps +1
 116 \fBgeneration\fR
 117 .RS 4
 118 .PP
 119 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\&.
 120 .PP
 121 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\&.
 122 .PP
 123 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\&.
 124 .RE
 125 .sp
 126 .it 1 an-trap
 127 .nr an-no-space-flag 1
 128 .nr an-break-flag 1
 129 .br
 130 .ps +1
 131 \fBVNNMAP\fR
 132 .RS 4
 133 .PP
 134 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\&.
 135 .RE
 136 .sp
 137 .it 1 an-trap
 138 .nr an-no-space-flag 1
 139 .nr an-break-flag 1
 140 .br
 141 .ps +1
 142 \fBRecovery mode\fR
 143 .RS 4
 144 .PP
 145 This is the current recovery mode of the cluster\&. There are two possible modes:
 146 .PP
 147 NORMAL \- The cluster is fully operational\&.
 148 .PP
 149 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\&.
 150 .PP
 151 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\&.
 152 .PP
 153 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\&.
 154 .RE
 155 .sp
 156 .it 1 an-trap
 157 .nr an-no-space-flag 1
 158 .nr an-break-flag 1
 159 .br
 160 .ps +1
 161 \fBRecovery master\fR
 162 .RS 4
 163 .PP
 164 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\&.
 165 .PP
 166 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\&.
 167 .RE
 168 .PP
 169 Example: ctdb status
 170 .PP
 171 Example output:
 172 .sp
 173 .if n \{\
 174 .RS 4
 175 .\}
 176 .nf
 177 Number of nodes:4
 178 pnn:0 11\&.1\&.2\&.200       OK (THIS NODE)
 179 pnn:1 11\&.1\&.2\&.201       OK
 180 pnn:2 11\&.1\&.2\&.202       OK
 181 pnn:3 11\&.1\&.2\&.203       OK
 182 Generation:1362079228
 183 Size:4
 184 hash:0 lmaster:0
 185 hash:1 lmaster:1
 186 hash:2 lmaster:2
 187 hash:3 lmaster:3
 188 Recovery mode:NORMAL (0)
 189 Recovery master:0
 190
 191 .fi
 192 .if n \{\
 193 .RE
 194 .\}
 195 .SS "recmaster"
 196 .PP
 197 This command shows the pnn of the node which is currently the recmaster\&.
 198 .SS "uptime"
 199 .PP
 200 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\&.
 201 .PP
 202 Example: ctdb uptime
 203 .PP
 204 Example output:
 205 .sp
 206 .if n \{\
 207 .RS 4
 208 .\}
 209 .nf
 210 Current time of node          :                Thu Oct 29 10:38:54 2009
 211 Ctdbd start time              : (000 16:54:28) Wed Oct 28 17:44:26 2009
 212 Time of last recovery/failover: (000 16:53:31) Wed Oct 28 17:45:23 2009
 213 Duration of last recovery/failover: 2\&.248552 seconds
 214
 215 .fi
 216 .if n \{\
 217 .RE
 218 .\}
 219 .SS "listnodes"
 220 .PP
 221 This command shows lists the ip addresses of all the nodes in the cluster\&.
 222 .PP
 223 Example: ctdb listnodes
 224 .PP
 225 Example output:
 226 .sp
 227 .if n \{\
 228 .RS 4
 229 .\}
 230 .nf
 231 10\&.0\&.0\&.71
 232 10\&.0\&.0\&.72
 233 10\&.0\&.0\&.73
 234 10\&.0\&.0\&.74
 235
 236 .fi
 237 .if n \{\
 238 .RE
 239 .\}
 240 .SS "ping"
 241 .PP
 242 This command will "ping" all CTDB daemons in the cluster to verify that they are processing commands correctly\&.
 243 .PP
 244 Example: ctdb ping
 245 .PP
 246 Example output:
 247 .sp
 248 .if n \{\
 249 .RS 4
 250 .\}
 251 .nf
 252 response from 0 time=0\&.000054 sec  (3 clients)
 253 response from 1 time=0\&.000144 sec  (2 clients)
 254 response from 2 time=0\&.000105 sec  (2 clients)
 255 response from 3 time=0\&.000114 sec  (2 clients)
 256
 257 .fi
 258 .if n \{\
 259 .RE
 260 .\}
 261 .SS "ifaces"
 262 .PP
 263 This command will display the list of network interfaces, which could host public addresses, along with their status\&.
 264 .PP
 265 Example: ctdb ifaces
 266 .PP
 267 Example output:
 268 .sp
 269 .if n \{\
 270 .RS 4
 271 .\}
 272 .nf
 273 Interfaces on node 0
 274 name:eth5 link:up references:2
 275 name:eth4 link:down references:0
 276 name:eth3 link:up references:1
 277 name:eth2 link:up references:1
 278
 279 .fi
 280 .if n \{\
 281 .RE
 282 .\}
 283 .PP
 284 Example: ctdb ifaces \-Y
 285 .PP
 286 Example output:
 287 .sp
 288 .if n \{\
 289 .RS 4
 290 .\}
 291 .nf
 292 :Name:LinkStatus:References:
 293 :eth5:1:2
 294 :eth4:0:0
 295 :eth3:1:1
 296 :eth2:1:1
 297
 298 .fi
 299 .if n \{\
 300 .RE
 301 .\}
 302 .SS "setifacelink <iface> <status>"
 303 .PP
 304 This command will set the status of a network interface\&. The status needs to be "up" or "down"\&. This is typically used in the 10\&.interfaces script in the "monitor" event\&.
 305 .PP
 306 Example: ctdb setifacelink eth0 up
 307 .SS "ip"
 308 .PP
 309 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"\&.
 310 .PP
 311 Example: ctdb ip
 312 .PP
 313 Example output:
 314 .sp
 315 .if n \{\
 316 .RS 4
 317 .\}
 318 .nf
 319 Public IPs on node 0
 320 172\&.31\&.91\&.82 node[1] active[] available[eth2,eth3] configured[eth2,eth3]
 321 172\&.31\&.91\&.83 node[0] active[eth3] available[eth2,eth3] configured[eth2,eth3]
 322 172\&.31\&.91\&.84 node[1] active[] available[eth2,eth3] configured[eth2,eth3]
 323 172\&.31\&.91\&.85 node[0] active[eth2] available[eth2,eth3] configured[eth2,eth3]
 324 172\&.31\&.92\&.82 node[1] active[] available[eth5] configured[eth4,eth5]
 325 172\&.31\&.92\&.83 node[0] active[eth5] available[eth5] configured[eth4,eth5]
 326 172\&.31\&.92\&.84 node[1] active[] available[eth5] configured[eth4,eth5]
 327 172\&.31\&.92\&.85 node[0] active[eth5] available[eth5] configured[eth4,eth5]
 328
 329 .fi
 330 .if n \{\
 331 .RE
 332 .\}
 333 .PP
 334 Example: ctdb ip \-Y
 335 .PP
 336 Example output:
 337 .sp
 338 .if n \{\
 339 .RS 4
 340 .\}
 341 .nf
 342 :Public IP:Node:ActiveInterface:AvailableInterfaces:ConfiguredInterfaces:
 343 :172\&.31\&.91\&.82:1::eth2,eth3:eth2,eth3:
 344 :172\&.31\&.91\&.83:0:eth3:eth2,eth3:eth2,eth3:
 345 :172\&.31\&.91\&.84:1::eth2,eth3:eth2,eth3:
 346 :172\&.31\&.91\&.85:0:eth2:eth2,eth3:eth2,eth3:
 347 :172\&.31\&.92\&.82:1::eth5:eth4,eth5:
 348 :172\&.31\&.92\&.83:0:eth5:eth5:eth4,eth5:
 349 :172\&.31\&.92\&.84:1::eth5:eth4,eth5:
 350 :172\&.31\&.92\&.85:0:eth5:eth5:eth4,eth5:
 351
 352 .fi
 353 .if n \{\
 354 .RE
 355 .\}
 356 .SS "ipinfo <ip>"
 357 .PP
 358 This command will display details about the specified public addresses\&.
 359 .PP
 360 Example: ctdb ipinfo 172\&.31\&.92\&.85
 361 .PP
 362 Example output:
 363 .sp
 364 .if n \{\
 365 .RS 4
 366 .\}
 367 .nf
 368 Public IP[172\&.31\&.92\&.85] info on node 0
 369 IP:172\&.31\&.92\&.85
 370 CurrentNode:0
 371 NumInterfaces:2
 372 Interface[1]: Name:eth4 Link:down References:0
 373 Interface[2]: Name:eth5 Link:up References:2 (active)
 374
 375 .fi
 376 .if n \{\
 377 .RE
 378 .\}
 379 .SS "scriptstatus"
 380 .PP
 381 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\&.
 382 .PP
 383 Example: ctdb scriptstatus
 384 .PP
 385 Example output:
 386 .sp
 387 .if n \{\
 388 .RS 4
 389 .\}
 390 .nf
 391 7 scripts were executed last monitoring cycle
 392 00\&.ctdb              Status:OK    Duration:0\&.056 Tue Mar 24 18:56:57 2009
 393 10\&.interface         Status:OK    Duration:0\&.077 Tue Mar 24 18:56:57 2009
 394 11\&.natgw             Status:OK    Duration:0\&.039 Tue Mar 24 18:56:57 2009
 395 20\&.multipathd        Status:OK    Duration:0\&.038 Tue Mar 24 18:56:57 2009
 396 31\&.clamd             Status:DISABLED
 397 40\&.vsftpd            Status:OK    Duration:0\&.045 Tue Mar 24 18:56:57 2009
 398 41\&.httpd             Status:OK    Duration:0\&.039 Tue Mar 24 18:56:57 2009
 399 50\&.samba             Status:ERROR    Duration:0\&.082 Tue Mar 24 18:56:57 2009
 400    OUTPUT:ERROR: Samba tcp port 445 is not responding
 401
 402 .fi
 403 .if n \{\
 404 .RE
 405 .\}
 406 .SS "disablescript <script>"
 407 .PP
 408 This command is used to disable an eventscript\&.
 409 .PP
 410 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\'\&.
 411 .SS "enablescript <script>"
 412 .PP
 413 This command is used to enable an eventscript\&.
 414 .PP
 415 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\'\&.
 416 .SS "getvar <name>"
 417 .PP
 418 Get the runtime value of a tuneable variable\&.
 419 .PP
 420 Example: ctdb getvar MaxRedirectCount
 421 .PP
 422 Example output:
 423 .sp
 424 .if n \{\
 425 .RS 4
 426 .\}
 427 .nf
 428 MaxRedirectCount    = 3
 429
 430 .fi
 431 .if n \{\
 432 .RE
 433 .\}
 434 .SS "setvar <name> <value>"
 435 .PP
 436 Set the runtime value of a tuneable variable\&.
 437 .PP
 438 Example: ctdb setvar MaxRedirectCount 5
 439 .SS "listvars"
 440 .PP
 441 List all tuneable variables\&.
 442 .PP
 443 Example: ctdb listvars
 444 .PP
 445 Example output:
 446 .sp
 447 .if n \{\
 448 .RS 4
 449 .\}
 450 .nf
 451 MaxRedirectCount    = 3
 452 SeqnumInterval      = 1000
 453 ControlTimeout      = 60
 454 TraverseTimeout     = 20
 455 KeepaliveInterval   = 5
 456 KeepaliveLimit      = 5
 457 MaxLACount          = 7
 458 RecoverTimeout      = 20
 459 RecoverInterval     = 1
 460 ElectionTimeout     = 3
 461 TakeoverTimeout     = 5
 462 MonitorInterval     = 15
 463 TickleUpdateInterval = 20
 464 EventScriptTimeout  = 30
 465 EventScriptBanCount = 10
 466 EventScriptUnhealthyOnTimeout = 0
 467 RecoveryGracePeriod = 120
 468 RecoveryBanPeriod   = 300
 469 DatabaseHashSize    = 10000
 470 DatabaseMaxDead     = 5
 471 RerecoveryTimeout   = 10
 472 EnableBans          = 1
 473 DeterministicIPs    = 1
 474 DisableWhenUnhealthy = 0
 475 ReclockPingPeriod   = 60
 476 NoIPFailback        = 0
 477 VerboseMemoryNames  = 0
 478 RecdPingTimeout     = 60
 479 RecdFailCount       = 10
 480 LogLatencyMs        = 0
 481 RecLockLatencyMs    = 1000
 482 RecoveryDropAllIPs  = 60
 483 VerifyRecoveryLock  = 1
 484 VacuumDefaultInterval = 300
 485 VacuumMaxRunTime    = 30
 486 RepackLimit         = 10000
 487 VacuumLimit         = 5000
 488 VacuumMinInterval   = 60
 489 VacuumMaxInterval   = 600
 490 MaxQueueDropMsg     = 1000
 491 UseStatusEvents     = 0
 492 AllowUnhealthyDBRead = 0
 493
 494 .fi
 495 .if n \{\
 496 .RE
 497 .\}
 498 .SS "lvsmaster"
 499 .PP
 500 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\&.
 501 .PP
 502 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\&.
 503 .SS "lvs"
 504 .PP
 505 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\&.
 506 .PP
 507 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, STOPPED, BANNED or DISABLED\&.
 508 .PP
 509 Example output:
 510 .sp
 511 .if n \{\
 512 .RS 4
 513 .\}
 514 .nf
 515 2:10\&.0\&.0\&.13
 516 3:10\&.0\&.0\&.14
 517
 518 .fi
 519 .if n \{\
 520 .RE
 521 .\}
 522 .SS "getcapabilities"
 523 .PP
 524 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\&.
 525 .PP
 526 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\&.
 527 .PP
 528 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\&.
 529 .PP
 530 Example output:
 531 .sp
 532 .if n \{\
 533 .RS 4
 534 .\}
 535 .nf
 536 RECMASTER: YES
 537 LMASTER: YES
 538 LVS: NO
 539
 540 .fi
 541 .if n \{\
 542 .RE
 543 .\}
 544 .SS "statistics"
 545 .PP
 546 Collect statistics from the CTDB daemon about how many calls it has served\&.
 547 .PP
 548 Example: ctdb statistics
 549 .PP
 550 Example output:
 551 .sp
 552 .if n \{\
 553 .RS 4
 554 .\}
 555 .nf
 556 CTDB version 1
 557  num_clients                        3
 558  frozen                             0
 559  recovering                         0
 560  client_packets_sent           360489
 561  client_packets_recv           360466
 562  node_packets_sent             480931
 563  node_packets_recv             240120
 564  keepalive_packets_sent             4
 565  keepalive_packets_recv             3
 566  node
 567      req_call                       2
 568      reply_call                     2
 569      req_dmaster                    0
 570      reply_dmaster                  0
 571      reply_error                    0
 572      req_message                   42
 573      req_control               120408
 574      reply_control             360439
 575  client
 576      req_call                       2
 577      req_message                   24
 578      req_control               360440
 579  timeouts
 580      call                           0
 581      control                        0
 582      traverse                       0
 583  total_calls                        2
 584  pending_calls                      0
 585  lockwait_calls                     0
 586  pending_lockwait_calls             0
 587  memory_used                     5040
 588  max_hop_count                      0
 589  max_call_latency                   4\&.948321 sec
 590  max_lockwait_latency               0\&.000000 sec
 591
 592 .fi
 593 .if n \{\
 594 .RE
 595 .\}
 596 .SS "statisticsreset"
 597 .PP
 598 This command is used to clear all statistics counters in a node\&.
 599 .PP
 600 Example: ctdb statisticsreset
 601 .SS "getreclock"
 602 .PP
 603 This command is used to show the filename of the reclock file that is used\&.
 604 .PP
 605 Example output:
 606 .sp
 607 .if n \{\
 608 .RS 4
 609 .\}
 610 .nf
 611 Reclock file:/gpfs/\&.ctdb/shared
 612
 613 .fi
 614 .if n \{\
 615 .RE
 616 .\}
 617 .SS "setreclock [filename]"
 618 .PP
 619 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"\&.
 620 .PP
 621 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\&.
 622 .PP
 623 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\&.
 624 .SS "getdebug"
 625 .PP
 626 Get the current debug level for the node\&. the debug level controls what information is written to the log file\&.
 627 .PP
 628 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\&.
 629 .PP
 630 The list of debug levels from highest to lowest are :
 631 .PP
 632 EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
 633 .SS "setdebug <debuglevel>"
 634 .PP
 635 Set the debug level of a node\&. This controls what information will be logged\&.
 636 .PP
 637 The debuglevel is one of EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
 638 .SS "getpid"
 639 .PP
 640 This command will return the process id of the ctdb daemon\&.
 641 .SS "disable"
 642 .PP
 643 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\&.
 644 .SS "enable"
 645 .PP
 646 Re\-enable a node that has been administratively disabled\&.
 647 .SS "stop"
 648 .PP
 649 This command is used to administratively STOP a node in the cluster\&. A STOPPED node is connected to the cluster but will not host any public ip addresse, nor does it participate in the VNNMAP\&. The difference between a DISABLED node and a STOPPED node is that a STOPPED node does not host any parts of the database which means that a recovery is required to stop/continue nodes\&.
 650 .SS "continue"
 651 .PP
 652 Re\-start a node that has been administratively stopped\&.
 653 .SS "addip <public_ip/mask> <iface>"
 654 .PP
 655 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\&.
 656 .PP
 657 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\&.
 658 .SS "delip <public_ip>"
 659 .PP
 660 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\&.
 661 .PP
 662 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\&.
 663 .SS "moveip <public_ip> <node>"
 664 .PP
 665 This command can be used to manually fail a public ip address to a specific node\&.
 666 .PP
 667 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:
 668 .PP
 669 DeterministicIPs = 0
 670 .PP
 671 NoIPFailback = 1
 672 .SS "shutdown"
 673 .PP
 674 This command will shutdown a specific CTDB daemon\&.
 675 .SS "recover"
 676 .PP
 677 This command will trigger the recovery daemon to do a cluster recovery\&.
 678 .SS "ipreallocate"
 679 .PP
 680 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\&.
 681 .SS "setlmasterrole <on|off>"
 682 .PP
 683 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\&.
 684 .PP
 685 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\&.
 686 .PP
 687 Once this setting has been enabled/disabled, you need to perform a recovery for it to take effect\&.
 688 .PP
 689 See also "ctdb getcapabilities"
 690 .SS "setrecmasterrole <on|off>"
 691 .PP
 692 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\&.
 693 .PP
 694 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\&.
 695 .PP
 696 See also "ctdb getcapabilities"
 697 .SS "killtcp <srcip:port> <dstip:port>"
 698 .PP
 699 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\&.
 700 .SS "gratiousarp <ip> <interface>"
 701 .PP
 702 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\&.
 703 .SS "reloadnodes"
 704 .PP
 705 This command is used when adding new nodes, or removing existing nodes from an existing cluster\&.
 706 .PP
 707 Procedure to add a node:
 708 .PP
 709 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!
 710 .PP
 711 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!
 712 .PP
 713 3, Verify that all the nodes have identical /etc/ctdb/nodes files after you edited them and added the new node!
 714 .PP
 715 4, Run \'ctdb reloadnodes\' to force all nodes to reload the nodesfile\&.
 716 .PP
 717 5, Use \'ctdb status\' on all nodes and verify that they now show the additional node\&.
 718 .PP
 719 6, Install and configure the new node and bring it online\&.
 720 .PP
 721 Procedure to remove a node:
 722 .PP
 723 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!
 724 .PP
 725 2, Shutdown and poerwoff the node to be removed\&.
 726 .PP
 727 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\&.
 728 .PP
 729 4, Run \'ctdb reloadnodes\' to force all nodes to reload the nodesfile\&.
 730 .PP
 731 5, Use \'ctdb status\' on all nodes and verify that the deleted node no longer shows up in the list\&.\&.
 732 .PP
 733 .SS "tickle <srcip:port> <dstip:port>"
 734 .PP
 735 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\&.
 736 .PP
 737 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\&.
 738 .SS "gettickles <ip>"
 739 .PP
 740 This command is used to show which TCP connections are registered with CTDB to be "tickled" if there is a failover\&.
 741 .SS "repack [max_freelist]"
 742 .PP
 743 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\&.
 744 .PP
 745 If [max_freelist] is specified, then a database will only be repacked if it has more than this number of entries in the freelist\&.
 746 .PP
 747 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\&.
 748 .PP
 749 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\&.
 750 .PP
 751 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\&.
 752 .PP
 753 Example: ctdb repack 1000
 754 .PP
 755 By default, this operation is issued from the 00\&.ctdb event script every 5 minutes\&.
 756 .SS "vacuum [max_records]"
 757 .PP
 758 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\&.
 759 .PP
 760 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\&.
 761 .PP
 762 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\&.
 763 .PP
 764 Example: ctdb vacuum
 765 .PP
 766 By default, this operation is issued from the 00\&.ctdb event script every 5 minutes\&.
 767 .SS "backupdb <dbname> <file>"
 768 .PP
 769 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\&.
 770 .SS "restoredb <file> [dbname]"
 771 .PP
 772 This command restores a persistent database that was previously backed up using backupdb\&. By default the data will be restored back into the same database as it was created from\&. By specifying dbname you can restore the data into a different database\&.
 773 .SS "wipedb <dbname>"
 774 .PP
 775 This command can be used to remove all content of a database\&.
 776 .SS "getlog <level>"
 777 .PP
 778 In addition to the normal loggign to a log file, CTDBD also keeps a in\-memory ringbuffer containing the most recent log entries for all log levels (except DEBUG)\&.
 779 .PP
 780 This is useful since it allows for keeping continous logs to a file at a reasonable non\-verbose level, but shortly after an incident has occured, a much more detailed log can be pulled from memory\&. This can allow you to avoid having to reproduce an issue due to the on\-disk logs being of insufficient detail\&.
 781 .PP
 782 This command extracts all messages of level or lower log level from memory and prints it to the screen\&.
 783 .SS "clearlog"
 784 .PP
 785 This command clears the in\-memory logging ringbuffer\&.
 786 .SH "DEBUGGING COMMANDS"
 787 .PP
 788 These commands are primarily used for CTDB development and testing and should not be used for normal administration\&.
 789 .SS "process\-exists <pid>"
 790 .PP
 791 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\&.
 792 .SS "getdbmap"
 793 .PP
 794 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\&.
 795 .PP
 796 If a PERSISTENT database is not in a healthy state the database is flagged as UNHEALTHY\&. If there\'s at least one completely healthy node running in the cluster, it\'s possible that the content is restored by a recovery run automaticly\&. Otherwise an administrator needs to analyze the problem\&.
 797 .PP
 798 See also "ctdb getdbstatus", "ctdb backupdb", "ctdb restoredb", "ctdb dumpbackup", "ctdb wipedb", "ctdb setvar AllowUnhealthyDBRead 1" and (if samba or tdb\-utils are installed) "tdbtool check"\&.
 799 .PP
 800 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\&.
 801 .PP
 802 Example: ctdb getdbmap
 803 .PP
 804 Example output:
 805 .sp
 806 .if n \{\
 807 .RS 4
 808 .\}
 809 .nf
 810 Number of databases:10
 811 dbid:0x435d3410 name:notify\&.tdb path:/var/ctdb/notify\&.tdb\&.0
 812 dbid:0x42fe72c5 name:locking\&.tdb path:/var/ctdb/locking\&.tdb\&.0
 813 dbid:0x1421fb78 name:brlock\&.tdb path:/var/ctdb/brlock\&.tdb\&.0
 814 dbid:0x17055d90 name:connections\&.tdb path:/var/ctdb/connections\&.tdb\&.0
 815 dbid:0xc0bdde6a name:sessionid\&.tdb path:/var/ctdb/sessionid\&.tdb\&.0
 816 dbid:0x122224da name:test\&.tdb path:/var/ctdb/test\&.tdb\&.0
 817 dbid:0x2672a57f name:idmap2\&.tdb path:/var/ctdb/persistent/idmap2\&.tdb\&.0 PERSISTENT
 818 dbid:0xb775fff6 name:secrets\&.tdb path:/var/ctdb/persistent/secrets\&.tdb\&.0 PERSISTENT
 819 dbid:0xe98e08b6 name:group_mapping\&.tdb path:/var/ctdb/persistent/group_mapping\&.tdb\&.0 PERSISTENT
 820 dbid:0x7bbbd26c name:passdb\&.tdb path:/var/ctdb/persistent/passdb\&.tdb\&.0 PERSISTENT
 821
 822 .fi
 823 .if n \{\
 824 .RE
 825 .\}
 826 .PP
 827 Example output for an unhealthy database:
 828 .sp
 829 .if n \{\
 830 .RS 4
 831 .\}
 832 .nf
 833 Number of databases:1
 834 dbid:0xb775fff6 name:secrets\&.tdb path:/var/ctdb/persistent/secrets\&.tdb\&.0 PERSISTENT UNHEALTHY
 835
 836 .fi
 837 .if n \{\
 838 .RE
 839 .\}
 840 .PP
 841 Example output for a healthy database as machinereadable output \-Y:
 842 .sp
 843 .if n \{\
 844 .RS 4
 845 .\}
 846 .nf
 847 :ID:Name:Path:Persistent:Unhealthy:
 848 :0x7bbbd26c:passdb\&.tdb:/var/ctdb/persistent/passdb\&.tdb\&.0:1:0:
 849
 850 .fi
 851 .if n \{\
 852 .RE
 853 .\}
 854 .SS "getdbstatus <dbname>"
 855 .PP
 856 This command displays more details about a database\&.
 857 .PP
 858 Example: ctdb getdbstatus test\&.tdb\&.0
 859 .PP
 860 Example output:
 861 .sp
 862 .if n \{\
 863 .RS 4
 864 .\}
 865 .nf
 866 dbid: 0x122224da
 867 name: test\&.tdb
 868 path: /var/ctdb/test\&.tdb\&.0
 869 PERSISTENT: no
 870 HEALTH: OK
 871
 872 .fi
 873 .if n \{\
 874 .RE
 875 .\}
 876 .PP
 877 Example: ctdb getdbstatus registry\&.tdb (with a corrupted TDB)
 878 .PP
 879 Example output:
 880 .sp
 881 .if n \{\
 882 .RS 4
 883 .\}
 884 .nf
 885 dbid: 0xf2a58948
 886 name: registry\&.tdb
 887 path: /var/ctdb/persistent/registry\&.tdb\&.0
 888 PERSISTENT: yes
 889 HEALTH: NO\-HEALTHY\-NODES \- ERROR \- Backup of corrupted TDB in \'/var/ctdb/persistent/registry\&.tdb\&.0\&.corrupted\&.20091208091949\&.0Z\'
 890
 891 .fi
 892 .if n \{\
 893 .RE
 894 .\}
 895 .SS "catdb <dbname>"
 896 .PP
 897 This command will dump a clustered TDB database to the screen\&. This is a debugging command\&.
 898 .SS "dumpdbbackup <backup\-file>"
 899 .PP
 900 This command will dump the content of database backup to the screen (similar to ctdb catdb)\&. This is a debugging command\&.
 901 .SS "getmonmode"
 902 .PP
 903 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\&.
 904 .PP
 905 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\&.
 906 .PP
 907 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\&.
 908 .SS "setmonmode <0|1>"
 909 .PP
 910 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\&.
 911 .SS "attach <dbname>"
 912 .PP
 913 This is a debugging command\&. This command will make the CTDB daemon create a new CTDB database and attach to it\&.
 914 .SS "dumpmemory"
 915 .PP
 916 This is a debugging command\&. This command will make the ctdb daemon to write a fill memory allocation map to standard output\&.
 917 .SS "rddumpmemory"
 918 .PP
 919 This is a debugging command\&. This command will dump the talloc memory allocation tree for the recovery daemon to standard output\&.
 920 .SS "freeze"
 921 .PP
 922 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\&.
 923 .PP
 924 This is primarily used by the recovery daemon to stop all samba daemons from accessing any databases while the database is recovered and rebuilt\&.
 925 .SS "thaw"
 926 .PP
 927 Thaw a previously frozen node\&.
 928 .SS "eventscript <arguments>"
 929 .PP
 930 This is a debugging command\&. This command can be used to manually invoke and run the eventscritps with arbitrary arguments\&.
 931 .SS "ban <bantime|0>"
 932 .PP
 933 Administratively ban a node for bantime seconds\&. A bantime of 0 means that the node should be permanently banned\&.
 934 .PP
 935 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\&.
 936 .PP
 937 Nodes are automatically banned if they are the cause of too many cluster recoveries\&.
 938 .SS "unban"
 939 .PP
 940 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\&.
 941 .SH "SEE ALSO"
 942 .PP
 943 ctdbd(1), onnode(1)
 944 \m[blue]\fB\%http://ctdb.samba.org/\fR\m[]
 945 .SH "COPYRIGHT/LICENSE"
 946 .sp
 947 .if n \{\
 948 .RS 4
 949 .\}
 950 .nf
 951 Copyright (C) Andrew Tridgell 2007
 952 Copyright (C) Ronnie sahlberg 2007
 953
 954 This program is free software; you can redistribute it and/or modify
 955 it under the terms of the GNU General Public License as published by
 956 the Free Software Foundation; either version 3 of the License, or (at
 957 your option) any later version\&.
 958
 959 This program is distributed in the hope that it will be useful, but
 960 WITHOUT ANY WARRANTY; without even the implied warranty of
 961 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\&.  See the GNU
 962 General Public License for more details\&.
 963
 964 You should have received a copy of the GNU General Public License
 965 along with this program; if not, see http://www\&.gnu\&.org/licenses/\&.
 966 .fi
 967 .if n \{\
 968 .RE
 969 .\}