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.1 <http://docbook.sf.net/>
   5 .\"      Date: 12/09/2009
   6 .\"    Manual:
   7 .\"    Source:
   8 .\"  Language: English
   9 .\"
  10 .TH "CTDB" "1" "12/09/2009" "" ""
  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 deamon 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 .RE
 108 .sp
 109 .it 1 an-trap
 110 .nr an-no-space-flag 1
 111 .nr an-break-flag 1
 112 .br
 113 .ps +1
 114 \fBgeneration\fR
 115 .RS 4
 116 .PP
 117 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\&.
 118 .PP
 119 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\&.
 120 .PP
 121 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\&.
 122 .RE
 123 .sp
 124 .it 1 an-trap
 125 .nr an-no-space-flag 1
 126 .nr an-break-flag 1
 127 .br
 128 .ps +1
 129 \fBVNNMAP\fR
 130 .RS 4
 131 .PP
 132 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\&.
 133 .RE
 134 .sp
 135 .it 1 an-trap
 136 .nr an-no-space-flag 1
 137 .nr an-break-flag 1
 138 .br
 139 .ps +1
 140 \fBRecovery mode\fR
 141 .RS 4
 142 .PP
 143 This is the current recovery mode of the cluster\&. There are two possible modes:
 144 .PP
 145 NORMAL \- The cluster is fully operational\&.
 146 .PP
 147 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\&.
 148 .PP
 149 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\&.
 150 .PP
 151 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\&.
 152 .RE
 153 .sp
 154 .it 1 an-trap
 155 .nr an-no-space-flag 1
 156 .nr an-break-flag 1
 157 .br
 158 .ps +1
 159 \fBRecovery master\fR
 160 .RS 4
 161 .PP
 162 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\&.
 163 .PP
 164 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\&.
 165 .RE
 166 .PP
 167 Example: ctdb status
 168 .PP
 169 Example output:
 170 .sp
 171 .if n \{\
 172 .RS 4
 173 .\}
 174 .nf
 175 Number of nodes:4
 176 pnn:0 11\&.1\&.2\&.200       OK (THIS NODE)
 177 pnn:1 11\&.1\&.2\&.201       OK
 178 pnn:2 11\&.1\&.2\&.202       OK
 179 pnn:3 11\&.1\&.2\&.203       OK
 180 Generation:1362079228
 181 Size:4
 182 hash:0 lmaster:0
 183 hash:1 lmaster:1
 184 hash:2 lmaster:2
 185 hash:3 lmaster:3
 186 Recovery mode:NORMAL (0)
 187 Recovery master:0
 188
 189 .fi
 190 .if n \{\
 191 .RE
 192 .\}
 193 .SS "recmaster"
 194 .PP
 195 This command shows the pnn of the node which is currently the recmaster\&.
 196 .SS "uptime"
 197 .PP
 198 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\&.
 199 .PP
 200 Example: ctdb uptime
 201 .PP
 202 Example output:
 203 .sp
 204 .if n \{\
 205 .RS 4
 206 .\}
 207 .nf
 208 Current time of node          :                Thu Oct 29 10:38:54 2009
 209 Ctdbd start time              : (000 16:54:28) Wed Oct 28 17:44:26 2009
 210 Time of last recovery/failover: (000 16:53:31) Wed Oct 28 17:45:23 2009
 211 Duration of last recovery/failover: 2\&.248552 seconds
 212
 213 .fi
 214 .if n \{\
 215 .RE
 216 .\}
 217 .SS "listnodes"
 218 .PP
 219 This command shows lists the ip addresses of all the nodes in the cluster\&.
 220 .PP
 221 Example: ctdb listnodes
 222 .PP
 223 Example output:
 224 .sp
 225 .if n \{\
 226 .RS 4
 227 .\}
 228 .nf
 229 10\&.0\&.0\&.71
 230 10\&.0\&.0\&.72
 231 10\&.0\&.0\&.73
 232 10\&.0\&.0\&.74
 233
 234 .fi
 235 .if n \{\
 236 .RE
 237 .\}
 238 .SS "ping"
 239 .PP
 240 This command will "ping" all CTDB daemons in the cluster to verify that they are processing commands correctly\&.
 241 .PP
 242 Example: ctdb ping
 243 .PP
 244 Example output:
 245 .sp
 246 .if n \{\
 247 .RS 4
 248 .\}
 249 .nf
 250 response from 0 time=0\&.000054 sec  (3 clients)
 251 response from 1 time=0\&.000144 sec  (2 clients)
 252 response from 2 time=0\&.000105 sec  (2 clients)
 253 response from 3 time=0\&.000114 sec  (2 clients)
 254
 255 .fi
 256 .if n \{\
 257 .RE
 258 .\}
 259 .SS "ip"
 260 .PP
 261 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"\&.
 262 .PP
 263 Example: ctdb ip
 264 .PP
 265 Example output:
 266 .sp
 267 .if n \{\
 268 .RS 4
 269 .\}
 270 .nf
 271 Number of addresses:4
 272 12\&.1\&.1\&.1         0
 273 12\&.1\&.1\&.2         1
 274 12\&.1\&.1\&.3         2
 275 12\&.1\&.1\&.4         3
 276
 277 .fi
 278 .if n \{\
 279 .RE
 280 .\}
 281 .SS "scriptstatus"
 282 .PP
 283 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\&.
 284 .PP
 285 Example: ctdb scriptstatus
 286 .PP
 287 Example output:
 288 .sp
 289 .if n \{\
 290 .RS 4
 291 .\}
 292 .nf
 293 7 scripts were executed last monitoring cycle
 294 00\&.ctdb              Status:OK    Duration:0\&.056 Tue Mar 24 18:56:57 2009
 295 10\&.interface         Status:OK    Duration:0\&.077 Tue Mar 24 18:56:57 2009
 296 11\&.natgw             Status:OK    Duration:0\&.039 Tue Mar 24 18:56:57 2009
 297 20\&.multipathd        Status:OK    Duration:0\&.038 Tue Mar 24 18:56:57 2009
 298 31\&.clamd             Status:DISABLED
 299 40\&.vsftpd            Status:OK    Duration:0\&.045 Tue Mar 24 18:56:57 2009
 300 41\&.httpd             Status:OK    Duration:0\&.039 Tue Mar 24 18:56:57 2009
 301 50\&.samba             Status:ERROR    Duration:0\&.082 Tue Mar 24 18:56:57 2009
 302    OUTPUT:ERROR: Samba tcp port 445 is not responding
 303
 304 .fi
 305 .if n \{\
 306 .RE
 307 .\}
 308 .SS "disablescript <script>"
 309 .PP
 310 This command is used to disable an eventscript\&.
 311 .PP
 312 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\'\&.
 313 .SS "enablescript <script>"
 314 .PP
 315 This command is used to enable an eventscript\&.
 316 .PP
 317 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\'\&.
 318 .SS "getvar <name>"
 319 .PP
 320 Get the runtime value of a tuneable variable\&.
 321 .PP
 322 Example: ctdb getvar MaxRedirectCount
 323 .PP
 324 Example output:
 325 .sp
 326 .if n \{\
 327 .RS 4
 328 .\}
 329 .nf
 330 MaxRedirectCount    = 3
 331
 332 .fi
 333 .if n \{\
 334 .RE
 335 .\}
 336 .SS "setvar <name> <value>"
 337 .PP
 338 Set the runtime value of a tuneable variable\&.
 339 .PP
 340 Example: ctdb setvar MaxRedirectCount 5
 341 .SS "listvars"
 342 .PP
 343 List all tuneable variables\&.
 344 .PP
 345 Example: ctdb listvars
 346 .PP
 347 Example output:
 348 .sp
 349 .if n \{\
 350 .RS 4
 351 .\}
 352 .nf
 353 MaxRedirectCount    = 3
 354 SeqnumInterval      = 1000
 355 ControlTimeout      = 60
 356 TraverseTimeout     = 20
 357 KeepaliveInterval   = 5
 358 KeepaliveLimit      = 5
 359 MaxLACount          = 7
 360 RecoverTimeout      = 20
 361 RecoverInterval     = 1
 362 ElectionTimeout     = 3
 363 TakeoverTimeout     = 5
 364 MonitorInterval     = 15
 365 TickleUpdateInterval = 20
 366 EventScriptTimeout  = 30
 367 EventScriptBanCount = 10
 368 EventScriptUnhealthyOnTimeout = 0
 369 RecoveryGracePeriod = 120
 370 RecoveryBanPeriod   = 300
 371 DatabaseHashSize    = 10000
 372 DatabaseMaxDead     = 5
 373 RerecoveryTimeout   = 10
 374 EnableBans          = 1
 375 DeterministicIPs    = 1
 376 DisableWhenUnhealthy = 0
 377 ReclockPingPeriod   = 60
 378 NoIPFailback        = 0
 379 VerboseMemoryNames  = 0
 380 RecdPingTimeout     = 60
 381 RecdFailCount       = 10
 382 LogLatencyMs        = 0
 383 RecLockLatencyMs    = 1000
 384 RecoveryDropAllIPs  = 60
 385 VerifyRecoveryLock  = 1
 386 VacuumDefaultInterval = 300
 387 VacuumMaxRunTime    = 30
 388 RepackLimit         = 10000
 389 VacuumLimit         = 5000
 390 VacuumMinInterval   = 60
 391 VacuumMaxInterval   = 600
 392 MaxQueueDropMsg     = 1000
 393 UseStatusEvents     = 0
 394 AllowUnhealthyDBRead = 0
 395
 396 .fi
 397 .if n \{\
 398 .RE
 399 .\}
 400 .SS "lvsmaster"
 401 .PP
 402 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\&.
 403 .PP
 404 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\&.
 405 .SS "lvs"
 406 .PP
 407 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\&.
 408 .PP
 409 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\&.
 410 .PP
 411 Example output:
 412 .sp
 413 .if n \{\
 414 .RS 4
 415 .\}
 416 .nf
 417 2:10\&.0\&.0\&.13
 418 3:10\&.0\&.0\&.14
 419
 420 .fi
 421 .if n \{\
 422 .RE
 423 .\}
 424 .SS "getcapabilities"
 425 .PP
 426 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\&.
 427 .PP
 428 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\&.
 429 .PP
 430 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\&.
 431 .PP
 432 Example output:
 433 .sp
 434 .if n \{\
 435 .RS 4
 436 .\}
 437 .nf
 438 RECMASTER: YES
 439 LMASTER: YES
 440 LVS: NO
 441
 442 .fi
 443 .if n \{\
 444 .RE
 445 .\}
 446 .SS "statistics"
 447 .PP
 448 Collect statistics from the CTDB daemon about how many calls it has served\&.
 449 .PP
 450 Example: ctdb statistics
 451 .PP
 452 Example output:
 453 .sp
 454 .if n \{\
 455 .RS 4
 456 .\}
 457 .nf
 458 CTDB version 1
 459  num_clients                        3
 460  frozen                             0
 461  recovering                         0
 462  client_packets_sent           360489
 463  client_packets_recv           360466
 464  node_packets_sent             480931
 465  node_packets_recv             240120
 466  keepalive_packets_sent             4
 467  keepalive_packets_recv             3
 468  node
 469      req_call                       2
 470      reply_call                     2
 471      req_dmaster                    0
 472      reply_dmaster                  0
 473      reply_error                    0
 474      req_message                   42
 475      req_control               120408
 476      reply_control             360439
 477  client
 478      req_call                       2
 479      req_message                   24
 480      req_control               360440
 481  timeouts
 482      call                           0
 483      control                        0
 484      traverse                       0
 485  total_calls                        2
 486  pending_calls                      0
 487  lockwait_calls                     0
 488  pending_lockwait_calls             0
 489  memory_used                     5040
 490  max_hop_count                      0
 491  max_call_latency                   4\&.948321 sec
 492  max_lockwait_latency               0\&.000000 sec
 493
 494 .fi
 495 .if n \{\
 496 .RE
 497 .\}
 498 .SS "statisticsreset"
 499 .PP
 500 This command is used to clear all statistics counters in a node\&.
 501 .PP
 502 Example: ctdb statisticsreset
 503 .SS "getreclock"
 504 .PP
 505 This command is used to show the filename of the reclock file that is used\&.
 506 .PP
 507 Example output:
 508 .sp
 509 .if n \{\
 510 .RS 4
 511 .\}
 512 .nf
 513 Reclock file:/gpfs/\&.ctdb/shared
 514
 515 .fi
 516 .if n \{\
 517 .RE
 518 .\}
 519 .SS "setreclock [filename]"
 520 .PP
 521 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"\&.
 522 .PP
 523 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\&.
 524 .PP
 525 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\&.
 526 .SS "getdebug"
 527 .PP
 528 Get the current debug level for the node\&. the debug level controls what information is written to the log file\&.
 529 .PP
 530 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\&.
 531 .PP
 532 The list of debug levels from highest to lowest are :
 533 .PP
 534 EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
 535 .SS "setdebug <debuglevel>"
 536 .PP
 537 Set the debug level of a node\&. This controls what information will be logged\&.
 538 .PP
 539 The debuglevel is one of EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
 540 .SS "getpid"
 541 .PP
 542 This command will return the process id of the ctdb daemon\&.
 543 .SS "disable"
 544 .PP
 545 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\&.
 546 .SS "enable"
 547 .PP
 548 Re\-enable a node that has been administratively disabled\&.
 549 .SS "stop"
 550 .PP
 551 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\&.
 552 .SS "continue"
 553 .PP
 554 Re\-start a node that has been administratively stopped\&.
 555 .SS "addip <public_ip/mask> <iface>"
 556 .PP
 557 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\&.
 558 .PP
 559 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\&.
 560 .SS "delip <public_ip>"
 561 .PP
 562 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\&.
 563 .PP
 564 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\&.
 565 .SS "moveip <public_ip> <node>"
 566 .PP
 567 This command can be used to manually fail a public ip address to a specific node\&.
 568 .PP
 569 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:
 570 .PP
 571 DeterministicIPs = 0
 572 .PP
 573 NoIPFailback = 1
 574 .SS "shutdown"
 575 .PP
 576 This command will shutdown a specific CTDB daemon\&.
 577 .SS "recover"
 578 .PP
 579 This command will trigger the recovery daemon to do a cluster recovery\&.
 580 .SS "ipreallocate"
 581 .PP
 582 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\&.
 583 .SS "setlmasterrole <on|off>"
 584 .PP
 585 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\&.
 586 .PP
 587 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\&.
 588 .PP
 589 Once this setting has been enabled/disabled, you need to perform a recovery for it to take effect\&.
 590 .PP
 591 See also "ctdb getcapabilities"
 592 .SS "setrecmasterrole <on|off>"
 593 .PP
 594 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\&.
 595 .PP
 596 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\&.
 597 .PP
 598 See also "ctdb getcapabilities"
 599 .SS "killtcp <srcip:port> <dstip:port>"
 600 .PP
 601 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\&.
 602 .SS "gratiousarp <ip> <interface>"
 603 .PP
 604 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\&.
 605 .SS "reloadnodes"
 606 .PP
 607 This command is used when adding new nodes, or removing existing nodes from an existing cluster\&.
 608 .PP
 609 Procedure to add a node:
 610 .PP
 611 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!
 612 .PP
 613 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!
 614 .PP
 615 3, Verify that all the nodes have identical /etc/ctdb/nodes files after you edited them and added the new node!
 616 .PP
 617 4, Run \'ctdb reloadnodes\' to force all nodes to reload the nodesfile\&.
 618 .PP
 619 5, Use \'ctdb status\' on all nodes and verify that they now show the additional node\&.
 620 .PP
 621 6, Install and configure the new node and bring it online\&.
 622 .PP
 623 Procedure to remove a node:
 624 .PP
 625 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!
 626 .PP
 627 2, Shutdown and poerwoff the node to be removed\&.
 628 .PP
 629 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\&.
 630 .PP
 631 4, Run \'ctdb reloadnodes\' to force all nodes to reload the nodesfile\&.
 632 .PP
 633 5, Use \'ctdb status\' on all nodes and verify that the deleted node no longer shows up in the list\&.\&.
 634 .PP
 635 .SS "tickle <srcip:port> <dstip:port>"
 636 .PP
 637 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\&.
 638 .PP
 639 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\&.
 640 .SS "gettickles <ip>"
 641 .PP
 642 This command is used to show which TCP connections are registered with CTDB to be "tickled" if there is a failover\&.
 643 .SS "repack [max_freelist]"
 644 .PP
 645 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\&.
 646 .PP
 647 If [max_freelist] is specified, then a database will only be repacked if it has more than this number of entries in the freelist\&.
 648 .PP
 649 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\&.
 650 .PP
 651 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\&.
 652 .PP
 653 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\&.
 654 .PP
 655 Example: ctdb repack 1000
 656 .PP
 657 By default, this operation is issued from the 00\&.ctdb event script every 5 minutes\&.
 658 .SS "vacuum [max_records]"
 659 .PP
 660 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\&.
 661 .PP
 662 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\&.
 663 .PP
 664 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\&.
 665 .PP
 666 Example: ctdb vacuum
 667 .PP
 668 By default, this operation is issued from the 00\&.ctdb event script every 5 minutes\&.
 669 .SS "backupdb <dbname> <file>"
 670 .PP
 671 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\&.
 672 .SS "restoredb <file>"
 673 .PP
 674 This command restores a persistent database that was previously backed up using backupdb\&.
 675 .SS "wipedb <dbname>"
 676 .PP
 677 This command can be used to remove all content of a database\&.
 678 .SH "DEBUGGING COMMANDS"
 679 .PP
 680 These commands are primarily used for CTDB development and testing and should not be used for normal administration\&.
 681 .SS "process\-exists <pid>"
 682 .PP
 683 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\&.
 684 .SS "getdbmap"
 685 .PP
 686 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\&.
 687 .PP
 688 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\&.
 689 .PP
 690 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"\&.
 691 .PP
 692 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\&.
 693 .PP
 694 Example: ctdb getdbmap
 695 .PP
 696 Example output:
 697 .sp
 698 .if n \{\
 699 .RS 4
 700 .\}
 701 .nf
 702 Number of databases:10
 703 dbid:0x435d3410 name:notify\&.tdb path:/var/ctdb/notify\&.tdb\&.0
 704 dbid:0x42fe72c5 name:locking\&.tdb path:/var/ctdb/locking\&.tdb\&.0 dbid:0x1421fb78 name:brlock\&.tdb path:/var/ctdb/brlock\&.tdb\&.0
 705 dbid:0x17055d90 name:connections\&.tdb path:/var/ctdb/connections\&.tdb\&.0
 706 dbid:0xc0bdde6a name:sessionid\&.tdb path:/var/ctdb/sessionid\&.tdb\&.0
 707 dbid:0x122224da name:test\&.tdb path:/var/ctdb/test\&.tdb\&.0
 708 dbid:0x2672a57f name:idmap2\&.tdb path:/var/ctdb/persistent/idmap2\&.tdb\&.0 PERSISTENT
 709 dbid:0xb775fff6 name:secrets\&.tdb path:/var/ctdb/persistent/secrets\&.tdb\&.0 PERSISTENT
 710 dbid:0xe98e08b6 name:group_mapping\&.tdb path:/var/ctdb/persistent/group_mapping\&.tdb\&.0 PERSISTENT
 711 dbid:0x7bbbd26c name:passdb\&.tdb path:/var/ctdb/persistent/passdb\&.tdb\&.0 PERSISTENT
 712
 713 .fi
 714 .if n \{\
 715 .RE
 716 .\}
 717 .PP
 718 Example output for an unhealthy database:
 719 .sp
 720 .if n \{\
 721 .RS 4
 722 .\}
 723 .nf
 724 Number of databases:1
 725 dbid:0xb775fff6 name:secrets\&.tdb path:/var/ctdb/persistent/secrets\&.tdb\&.0 PERSISTENT UNHEALTHY
 726
 727 .fi
 728 .if n \{\
 729 .RE
 730 .\}
 731 .PP
 732 Example output for a healthy database as machinereadable output \-Y:
 733 .sp
 734 .if n \{\
 735 .RS 4
 736 .\}
 737 .nf
 738 :ID:Name:Path:Persistent:Unhealthy:
 739 :0x7bbbd26c:passdb\&.tdb:/var/ctdb/persistent/passdb\&.tdb\&.0:1:0:
 740
 741 .fi
 742 .if n \{\
 743 .RE
 744 .\}
 745 .SS "getdbstatus <dbname>"
 746 .PP
 747 This command displays more details about a database\&.
 748 .PP
 749 Example: ctdb getdbstatus test\&.tdb\&.0
 750 .PP
 751 Example output:
 752 .sp
 753 .if n \{\
 754 .RS 4
 755 .\}
 756 .nf
 757 dbid: 0x122224da
 758 name: test\&.tdb
 759 path: /var/ctdb/test\&.tdb\&.0
 760 PERSISTENT: no
 761 HEALTH: OK
 762
 763 .fi
 764 .if n \{\
 765 .RE
 766 .\}
 767 .PP
 768 Example: ctdb getdbstatus registry\&.tdb (with a corrupted TDB)
 769 .PP
 770 Example output:
 771 .sp
 772 .if n \{\
 773 .RS 4
 774 .\}
 775 .nf
 776 dbid: 0xf2a58948
 777 name: registry\&.tdb
 778 path: /var/ctdb/persistent/registry\&.tdb\&.0
 779 PERSISTENT: yes
 780 HEALTH: NO\-HEALTHY\-NODES \- ERROR \- Backup of corrupted TDB in \'/var/ctdb/persistent/registry\&.tdb\&.0\&.corrupted\&.20091208091949\&.0Z\'
 781
 782 .fi
 783 .if n \{\
 784 .RE
 785 .\}
 786 .SS "catdb <dbname>"
 787 .PP
 788 This command will dump a clustered TDB database to the screen\&. This is a debugging command\&.
 789 .SS "dumpdbbackup <backup\-file>"
 790 .PP
 791 This command will dump the content of database backup to the screen (similar to ctdb catdb)\&. This is a debugging command\&.
 792 .SS "getmonmode"
 793 .PP
 794 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\&.
 795 .PP
 796 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\&.
 797 .PP
 798 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\&.
 799 .SS "setmonmode <0|1>"
 800 .PP
 801 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\&.
 802 .SS "attach <dbname>"
 803 .PP
 804 This is a debugging command\&. This command will make the CTDB daemon create a new CTDB database and attach to it\&.
 805 .SS "dumpmemory"
 806 .PP
 807 This is a debugging command\&. This command will make the ctdb daemon to write a fill memory allocation map to standard output\&.
 808 .SS "rddumpmemory"
 809 .PP
 810 This is a debugging command\&. This command will dump the talloc memory allocation tree for the recovery daemon to standard output\&.
 811 .SS "freeze"
 812 .PP
 813 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\&.
 814 .PP
 815 This is primarily used by the recovery daemon to stop all samba daemons from accessing any databases while the database is recovered and rebuilt\&.
 816 .SS "thaw"
 817 .PP
 818 Thaw a previously frozen node\&.
 819 .SS "eventscript <arguments>"
 820 .PP
 821 This is a debugging command\&. This command can be used to manually invoke and run the eventscritps with arbitrary arguments\&.
 822 .SS "ban <bantime|0>"
 823 .PP
 824 Administratively ban a node for bantime seconds\&. A bantime of 0 means that the node should be permanently banned\&.
 825 .PP
 826 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\&.
 827 .PP
 828 Nodes are automatically banned if they are the cause of too many cluster recoveries\&.
 829 .SS "unban"
 830 .PP
 831 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\&.
 832 .SH "SEE ALSO"
 833 .PP
 834 ctdbd(1), onnode(1)
 835 \m[blue]\fB\%http://ctdb.samba.org/\fR\m[]
 836 .SH "COPYRIGHT/LICENSE"
 837 .sp
 838 .if n \{\
 839 .RS 4
 840 .\}
 841 .nf
 842 Copyright (C) Andrew Tridgell 2007
 843 Copyright (C) Ronnie sahlberg 2007
 844
 845 This program is free software; you can redistribute it and/or modify
 846 it under the terms of the GNU General Public License as published by
 847 the Free Software Foundation; either version 3 of the License, or (at
 848 your option) any later version\&.
 849
 850 This program is distributed in the hope that it will be useful, but
 851 WITHOUT ANY WARRANTY; without even the implied warranty of
 852 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\&.  See the GNU
 853 General Public License for more details\&.
 854
 855 You should have received a copy of the GNU General Public License
 856 along with this program; if not, see http://www\&.gnu\&.org/licenses/\&.
 857 .fi
 858 .if n \{\
 859 .RE
 860 .\}