doc/ctdb.1

   1 .\" ** You probably do not want to edit this file directly **
   2 .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
   3 .\" Instead of manually editing it, you probably should edit the DocBook XML
   4 .\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
   5 .TH "CTDB" "1" "11/30/2011" "ctdb" "CTDB \- clustered TDB database"
   6 .\" disable hyphenation
   7 .nh
   8 .\" disable justification (adjust text to left margin only)
   9 .ad l
  10 .SH "NAME"
  11 ctdb \- clustered tdb database management utility
  12 .SH "SYNOPSIS"
  13 .HP 29
  14 \fBctdb [ OPTIONS ] COMMAND ...\fR
  15 .HP 5
  16 \fBctdb\fR [\-n\ <node>] [\-Y] [\-t\ <timeout>] [\-T\ <timelimit>] [\-?\ \-\-help] [\-\-usage] [\-d\ \-\-debug=<INTEGER>] [\-\-socket=<filename>] [\-\-print\-emptyrecords] [\-\-print\-datasize] [\-\-print\-lmaster] [\-\-print\-hash] [\-\-print\-recordflags]
  17 .SH "DESCRIPTION"
  18 .PP
  19 ctdb is a utility to view and manage a ctdb cluster.
  20 .SH "OPTIONS"
  21 .TP
  22 \-n <pnn>
  23 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.
  24 .sp
  25 The physical node number is an integer that describes the node in the cluster. The first node has physical node number 0.
  26 .TP
  27 \-Y
  28 Produce output in machine readable form for easier parsing by scripts. Not all commands support this option.
  29 .TP
  30 \-t <timeout>
  31 How long should ctdb wait for the local ctdb daemon to respond to a command before timing out. Default is 3 seconds.
  32 .TP
  33 \-T <timelimit>
  34 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.
  35 .TP
  36 \-? \-\-help
  37 Print some help text to the screen.
  38 .TP
  39 \-\-usage
  40 Print useage information to the screen.
  41 .TP
  42 \-d \-\-debug=<debuglevel>
  43 Change the debug level for the command. Default is 0.
  44 .TP
  45 \-\-socket=<filename>
  46 Specify the socketname to use when connecting to the local ctdb daemon. The default is /tmp/ctdb.socket .
  47 .sp
  48 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.
  49 .TP
  50 \-\-print\-emptyrecords
  51 This enables printing of empty records when dumping databases with the catdb, cattbd and dumpdbbackup commands. Records with empty data segment are considered deleted by ctdb and cleaned by the vacuuming mechanism, so this switch can come in handy for debugging the vacuuming behaviour.
  52 .TP
  53 \-\-print\-datasize
  54 This lets database dumps (catdb, cattdb, dumpdbbackup) print the size of the record data instead of dumping the data contents.
  55 .TP
  56 \-\-print\-lmaster
  57 This lets catdb print the lmaster for each record.
  58 .TP
  59 \-\-print\-hash
  60 This lets database dumps (catdb, cattdb, dumpdbbackup) print the hash for each record.
  61 .TP
  62 \-\-print\-recordflags
  63 This lets catdb and dumpdbbackup print the record flags for each record. Note that cattdb always prints the flags.
  64 .SH "ADMINISTRATIVE COMMANDS"
  65 .PP
  66 These are commands used to monitor and administrate a CTDB cluster.
  67 .SS "pnn"
  68 .PP
  69 This command displays the pnn of the current node.
  70 .SS "status"
  71 .PP
  72 This command shows the current status of the ctdb node.
  73 .sp
  74 .it 1 an-trap
  75 .nr an-no-space-flag 1
  76 .nr an-break-flag 1
  77 .br
  78 \fBnode status\fR
  79 .RS 3
  80 .PP
  81 Node status reflects the current status of the node. There are five possible states:
  82 .PP
  83 OK \- This node is fully functional.
  84 .PP
  85 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.
  86 .PP
  87 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.
  88 .PP
  89 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.
  90 .PP
  91 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.
  92 .PP
  93 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.
  94 .PP
  95 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".
  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 \fBgeneration\fR
 103 .RS 3
 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 \fBVNNMAP\fR
 117 .RS 3
 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 \fBRecovery mode\fR
 127 .RS 3
 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 \fBRecovery master\fR
 145 .RS 3
 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 .nf
 157 Number of nodes:4
 158 pnn:0 11.1.2.200       OK (THIS NODE)
 159 pnn:1 11.1.2.201       OK
 160 pnn:2 11.1.2.202       OK
 161 pnn:3 11.1.2.203       OK
 162 Generation:1362079228
 163 Size:4
 164 hash:0 lmaster:0
 165 hash:1 lmaster:1
 166 hash:2 lmaster:2
 167 hash:3 lmaster:3
 168 Recovery mode:NORMAL (0)
 169 Recovery master:0
 170
 171 .fi
 172 .SS "recmaster"
 173 .PP
 174 This command shows the pnn of the node which is currently the recmaster.
 175 .SS "uptime"
 176 .PP
 177 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.
 178 .PP
 179 Example: ctdb uptime
 180 .PP
 181 Example output:
 182 .sp
 183 .nf
 184 Current time of node          :                Thu Oct 29 10:38:54 2009
 185 Ctdbd start time              : (000 16:54:28) Wed Oct 28 17:44:26 2009
 186 Time of last recovery/failover: (000 16:53:31) Wed Oct 28 17:45:23 2009
 187 Duration of last recovery/failover: 2.248552 seconds
 188
 189 .fi
 190 .SS "listnodes"
 191 .PP
 192 This command shows lists the ip addresses of all the nodes in the cluster.
 193 .PP
 194 Example: ctdb listnodes
 195 .PP
 196 Example output:
 197 .sp
 198 .nf
 199 10.0.0.71
 200 10.0.0.72
 201 10.0.0.73
 202 10.0.0.74
 203
 204 .fi
 205 .SS "ping"
 206 .PP
 207 This command will "ping" all CTDB daemons in the cluster to verify that they are processing commands correctly.
 208 .PP
 209 Example: ctdb ping
 210 .PP
 211 Example output:
 212 .sp
 213 .nf
 214 response from 0 time=0.000054 sec  (3 clients)
 215 response from 1 time=0.000144 sec  (2 clients)
 216 response from 2 time=0.000105 sec  (2 clients)
 217 response from 3 time=0.000114 sec  (2 clients)
 218
 219 .fi
 220 .SS "ifaces"
 221 .PP
 222 This command will display the list of network interfaces, which could host public addresses, along with their status.
 223 .PP
 224 Example: ctdb ifaces
 225 .PP
 226 Example output:
 227 .sp
 228 .nf
 229 Interfaces on node 0
 230 name:eth5 link:up references:2
 231 name:eth4 link:down references:0
 232 name:eth3 link:up references:1
 233 name:eth2 link:up references:1
 234
 235 .fi
 236 .PP
 237 Example: ctdb ifaces \-Y
 238 .PP
 239 Example output:
 240 .sp
 241 .nf
 242 :Name:LinkStatus:References:
 243 :eth5:1:2
 244 :eth4:0:0
 245 :eth3:1:1
 246 :eth2:1:1
 247
 248 .fi
 249 .SS "setifacelink <iface> <status>"
 250 .PP
 251 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.
 252 .PP
 253 Example: ctdb setifacelink eth0 up
 254 .SS "ip"
 255 .PP
 256 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".
 257 .PP
 258 Example: ctdb ip
 259 .PP
 260 Example output:
 261 .sp
 262 .nf
 263 Public IPs on node 0
 264 172.31.91.82 node[1] active[] available[eth2,eth3] configured[eth2,eth3]
 265 172.31.91.83 node[0] active[eth3] available[eth2,eth3] configured[eth2,eth3]
 266 172.31.91.84 node[1] active[] available[eth2,eth3] configured[eth2,eth3]
 267 172.31.91.85 node[0] active[eth2] available[eth2,eth3] configured[eth2,eth3]
 268 172.31.92.82 node[1] active[] available[eth5] configured[eth4,eth5]
 269 172.31.92.83 node[0] active[eth5] available[eth5] configured[eth4,eth5]
 270 172.31.92.84 node[1] active[] available[eth5] configured[eth4,eth5]
 271 172.31.92.85 node[0] active[eth5] available[eth5] configured[eth4,eth5]
 272
 273 .fi
 274 .PP
 275 Example: ctdb ip \-Y
 276 .PP
 277 Example output:
 278 .sp
 279 .nf
 280 :Public IP:Node:ActiveInterface:AvailableInterfaces:ConfiguredInterfaces:
 281 :172.31.91.82:1::eth2,eth3:eth2,eth3:
 282 :172.31.91.83:0:eth3:eth2,eth3:eth2,eth3:
 283 :172.31.91.84:1::eth2,eth3:eth2,eth3:
 284 :172.31.91.85:0:eth2:eth2,eth3:eth2,eth3:
 285 :172.31.92.82:1::eth5:eth4,eth5:
 286 :172.31.92.83:0:eth5:eth5:eth4,eth5:
 287 :172.31.92.84:1::eth5:eth4,eth5:
 288 :172.31.92.85:0:eth5:eth5:eth4,eth5:
 289
 290 .fi
 291 .SS "ipinfo <ip>"
 292 .PP
 293 This command will display details about the specified public addresses.
 294 .PP
 295 Example: ctdb ipinfo 172.31.92.85
 296 .PP
 297 Example output:
 298 .sp
 299 .nf
 300 Public IP[172.31.92.85] info on node 0
 301 IP:172.31.92.85
 302 CurrentNode:0
 303 NumInterfaces:2
 304 Interface[1]: Name:eth4 Link:down References:0
 305 Interface[2]: Name:eth5 Link:up References:2 (active)
 306
 307 .fi
 308 .SS "scriptstatus"
 309 .PP
 310 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.
 311 .PP
 312 Example: ctdb scriptstatus
 313 .PP
 314 Example output:
 315 .sp
 316 .nf
 317 7 scripts were executed last monitoring cycle
 318 00.ctdb              Status:OK    Duration:0.056 Tue Mar 24 18:56:57 2009
 319 10.interface         Status:OK    Duration:0.077 Tue Mar 24 18:56:57 2009
 320 11.natgw             Status:OK    Duration:0.039 Tue Mar 24 18:56:57 2009
 321 20.multipathd        Status:OK    Duration:0.038 Tue Mar 24 18:56:57 2009
 322 31.clamd             Status:DISABLED
 323 40.vsftpd            Status:OK    Duration:0.045 Tue Mar 24 18:56:57 2009
 324 41.httpd             Status:OK    Duration:0.039 Tue Mar 24 18:56:57 2009
 325 50.samba             Status:ERROR    Duration:0.082 Tue Mar 24 18:56:57 2009
 326    OUTPUT:ERROR: Samba tcp port 445 is not responding
 327
 328 .fi
 329 .SS "disablescript <script>"
 330 .PP
 331 This command is used to disable an eventscript.
 332 .PP
 333 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'.
 334 .SS "enablescript <script>"
 335 .PP
 336 This command is used to enable an eventscript.
 337 .PP
 338 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'.
 339 .SS "getvar <name>"
 340 .PP
 341 Get the runtime value of a tuneable variable.
 342 .PP
 343 Example: ctdb getvar MaxRedirectCount
 344 .PP
 345 Example output:
 346 .sp
 347 .nf
 348 MaxRedirectCount    = 3
 349
 350 .fi
 351 .SS "setvar <name> <value>"
 352 .PP
 353 Set the runtime value of a tuneable variable.
 354 .PP
 355 Example: ctdb setvar MaxRedirectCount 5
 356 .SS "listvars"
 357 .PP
 358 List all tuneable variables.
 359 .PP
 360 Example: ctdb listvars
 361 .PP
 362 Example output:
 363 .sp
 364 .nf
 365 MaxRedirectCount    = 3
 366 SeqnumInterval      = 1000
 367 ControlTimeout      = 60
 368 TraverseTimeout     = 20
 369 KeepaliveInterval   = 5
 370 KeepaliveLimit      = 5
 371 RecoverTimeout      = 20
 372 RecoverInterval     = 1
 373 ElectionTimeout     = 3
 374 TakeoverTimeout     = 9
 375 MonitorInterval     = 15
 376 TickleUpdateInterval = 20
 377 EventScriptTimeout  = 30
 378 EventScriptTimeoutCount = 1
 379 EventScriptUnhealthyOnTimeout = 0
 380 RecoveryGracePeriod = 120
 381 RecoveryBanPeriod   = 300
 382 DatabaseHashSize    = 100001
 383 DatabaseMaxDead     = 5
 384 RerecoveryTimeout   = 10
 385 EnableBans          = 1
 386 DeterministicIPs    = 1
 387 ReclockPingPeriod   = 60
 388 NoIPFailback        = 0
 389 DisableIPFailover   = 0
 390 VerboseMemoryNames  = 0
 391 RecdPingTimeout     = 60
 392 RecdFailCount       = 10
 393 LogLatencyMs        = 0
 394 RecLockLatencyMs    = 1000
 395 RecoveryDropAllIPs  = 120
 396 VerifyRecoveryLock  = 1
 397 VacuumDefaultInterval = 10
 398 VacuumMaxRunTime    = 30
 399 RepackLimit         = 10000
 400 VacuumLimit         = 5000
 401 VacuumMinInterval   = 10
 402 VacuumMaxInterval   = 10
 403 VacuumFastPathCount = 60
 404 MaxQueueDropMsg     = 1000000
 405 UseStatusEvents     = 0
 406 AllowUnhealthyDBRead = 0
 407 StatHistoryInterval = 1
 408 DeferredAttachTO    = 120
 409
 410 .fi
 411 .SS "lvsmaster"
 412 .PP
 413 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.
 414 .PP
 415 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.
 416 .SS "lvs"
 417 .PP
 418 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.
 419 .PP
 420 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.
 421 .PP
 422 Example output:
 423 .sp
 424 .nf
 425 2:10.0.0.13
 426 3:10.0.0.14
 427
 428 .fi
 429 .SS "getcapabilities"
 430 .PP
 431 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.
 432 .PP
 433 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.
 434 .PP
 435 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.
 436 .PP
 437 Example output:
 438 .sp
 439 .nf
 440 RECMASTER: YES
 441 LMASTER: YES
 442 LVS: NO
 443
 444 .fi
 445 .SS "statistics"
 446 .PP
 447 Collect statistics from the CTDB daemon about how many calls it has served.
 448 .PP
 449 Example: ctdb statistics
 450 .PP
 451 Example output:
 452 .sp
 453 .nf
 454 CTDB version 1
 455  num_clients                        3
 456  frozen                             0
 457  recovering                         0
 458  client_packets_sent           360489
 459  client_packets_recv           360466
 460  node_packets_sent             480931
 461  node_packets_recv             240120
 462  keepalive_packets_sent             4
 463  keepalive_packets_recv             3
 464  node
 465      req_call                       2
 466      reply_call                     2
 467      req_dmaster                    0
 468      reply_dmaster                  0
 469      reply_error                    0
 470      req_message                   42
 471      req_control               120408
 472      reply_control             360439
 473  client
 474      req_call                       2
 475      req_message                   24
 476      req_control               360440
 477  timeouts
 478      call                           0
 479      control                        0
 480      traverse                       0
 481  total_calls                        2
 482  pending_calls                      0
 483  lockwait_calls                     0
 484  pending_lockwait_calls             0
 485  memory_used                     5040
 486  max_hop_count                      0
 487  max_call_latency                   4.948321 sec
 488  max_lockwait_latency               0.000000 sec
 489
 490 .fi
 491 .SS "statisticsreset"
 492 .PP
 493 This command is used to clear all statistics counters in a node.
 494 .PP
 495 Example: ctdb statisticsreset
 496 .SS "getreclock"
 497 .PP
 498 This command is used to show the filename of the reclock file that is used.
 499 .PP
 500 Example output:
 501 .sp
 502 .nf
 503 Reclock file:/gpfs/.ctdb/shared
 504
 505 .fi
 506 .SS "setreclock [filename]"
 507 .PP
 508 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".
 509 .PP
 510 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.
 511 .PP
 512 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.
 513 .SS "getdebug"
 514 .PP
 515 Get the current debug level for the node. the debug level controls what information is written to the log file.
 516 .PP
 517 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.
 518 .PP
 519 The list of debug levels from highest to lowest are :
 520 .PP
 521 EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
 522 .SS "setdebug <debuglevel>"
 523 .PP
 524 Set the debug level of a node. This controls what information will be logged.
 525 .PP
 526 The debuglevel is one of EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
 527 .SS "getpid"
 528 .PP
 529 This command will return the process id of the ctdb daemon.
 530 .SS "disable"
 531 .PP
 532 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.
 533 .SS "enable"
 534 .PP
 535 Re\-enable a node that has been administratively disabled.
 536 .SS "stop"
 537 .PP
 538 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.
 539 .SS "continue"
 540 .PP
 541 Re\-start a node that has been administratively stopped.
 542 .SS "addip <public_ip/mask> <iface>"
 543 .PP
 544 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.
 545 .PP
 546 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.
 547 .SS "delip <public_ip>"
 548 .PP
 549 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.
 550 .PP
 551 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.
 552 .SS "moveip <public_ip> <node>"
 553 .PP
 554 This command can be used to manually fail a public ip address to a specific node.
 555 .PP
 556 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:
 557 .PP
 558 DeterministicIPs = 0
 559 .PP
 560 NoIPFailback = 1
 561 .SS "shutdown"
 562 .PP
 563 This command will shutdown a specific CTDB daemon.
 564 .SS "recover"
 565 .PP
 566 This command will trigger the recovery daemon to do a cluster recovery.
 567 .SS "ipreallocate"
 568 .PP
 569 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.
 570 .SS "setlmasterrole <on|off>"
 571 .PP
 572 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.
 573 .PP
 574 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.
 575 .PP
 576 Once this setting has been enabled/disabled, you need to perform a recovery for it to take effect.
 577 .PP
 578 See also "ctdb getcapabilities"
 579 .SS "setrecmasterrole <on|off>"
 580 .PP
 581 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.
 582 .PP
 583 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.
 584 .PP
 585 See also "ctdb getcapabilities"
 586 .SS "killtcp <srcip:port> <dstip:port>"
 587 .PP
 588 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.
 589 .SS "gratiousarp <ip> <interface>"
 590 .PP
 591 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.
 592 .SS "reloadnodes"
 593 .PP
 594 This command is used when adding new nodes, or removing existing nodes from an existing cluster.
 595 .PP
 596 Procedure to add a node:
 597 .PP
 598 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!
 599 .PP
 600 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!
 601 .PP
 602 3, Verify that all the nodes have identical /etc/ctdb/nodes files after you edited them and added the new node!
 603 .PP
 604 4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
 605 .PP
 606 5, Use 'ctdb status' on all nodes and verify that they now show the additional node.
 607 .PP
 608 6, Install and configure the new node and bring it online.
 609 .PP
 610 Procedure to remove a node:
 611 .PP
 612 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!
 613 .PP
 614 2, Shutdown and poweroff the node to be removed.
 615 .PP
 616 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.
 617 .PP
 618 4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
 619 .PP
 620 5, Use 'ctdb status' on all nodes and verify that the deleted node no longer shows up in the list..
 621 .PP
 622 .SS "tickle <srcip:port> <dstip:port>"
 623 .PP
 624 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.
 625 .PP
 626 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.
 627 .SS "gettickles <ip>"
 628 .PP
 629 This command is used to show which TCP connections are registered with CTDB to be "tickled" if there is a failover.
 630 .SS "repack [max_freelist]"
 631 .PP
 632 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.
 633 .PP
 634 If [max_freelist] is specified, then a database will only be repacked if it has more than this number of entries in the freelist.
 635 .PP
 636 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.
 637 .PP
 638 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.
 639 .PP
 640 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.
 641 .PP
 642 Example: ctdb repack 1000
 643 .PP
 644 By default, this operation is issued from the 00.ctdb event script every 5 minutes.
 645 .SS "vacuum [max_records]"
 646 .PP
 647 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.
 648 .PP
 649 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.
 650 .PP
 651 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.
 652 .PP
 653 Example: ctdb vacuum
 654 .PP
 655 By default, this operation is issued from the 00.ctdb event script every 5 minutes.
 656 .SS "backupdb <dbname> <file>"
 657 .PP
 658 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.
 659 .SS "restoredb <file> [<dbname>]"
 660 .PP
 661 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.
 662 .SS "wipedb <dbname>"
 663 .PP
 664 This command can be used to remove all content of a database.
 665 .SS "getlog <level>"
 666 .PP
 667 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).
 668 .PP
 669 This is useful since it allows for keeping continuous 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.
 670 .PP
 671 This command extracts all messages of level or lower log level from memory and prints it to the screen.
 672 .SS "clearlog"
 673 .PP
 674 This command clears the in\-memory logging ringbuffer.
 675 .SH "DEBUGGING COMMANDS"
 676 .PP
 677 These commands are primarily used for CTDB development and testing and should not be used for normal administration.
 678 .SS "process\-exists <pid>"
 679 .PP
 680 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.
 681 .SS "getdbmap"
 682 .PP
 683 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.
 684 .PP
 685 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.
 686 .PP
 687 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".
 688 .PP
 689 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.
 690 .PP
 691 Example: ctdb getdbmap
 692 .PP
 693 Example output:
 694 .sp
 695 .nf
 696 Number of databases:10
 697 dbid:0x435d3410 name:notify.tdb path:/var/ctdb/notify.tdb.0
 698 dbid:0x42fe72c5 name:locking.tdb path:/var/ctdb/locking.tdb.0
 699 dbid:0x1421fb78 name:brlock.tdb path:/var/ctdb/brlock.tdb.0
 700 dbid:0x17055d90 name:connections.tdb path:/var/ctdb/connections.tdb.0
 701 dbid:0xc0bdde6a name:sessionid.tdb path:/var/ctdb/sessionid.tdb.0
 702 dbid:0x122224da name:test.tdb path:/var/ctdb/test.tdb.0
 703 dbid:0x2672a57f name:idmap2.tdb path:/var/ctdb/persistent/idmap2.tdb.0 PERSISTENT
 704 dbid:0xb775fff6 name:secrets.tdb path:/var/ctdb/persistent/secrets.tdb.0 PERSISTENT
 705 dbid:0xe98e08b6 name:group_mapping.tdb path:/var/ctdb/persistent/group_mapping.tdb.0 PERSISTENT
 706 dbid:0x7bbbd26c name:passdb.tdb path:/var/ctdb/persistent/passdb.tdb.0 PERSISTENT
 707
 708 .fi
 709 .PP
 710 Example output for an unhealthy database:
 711 .sp
 712 .nf
 713 Number of databases:1
 714 dbid:0xb775fff6 name:secrets.tdb path:/var/ctdb/persistent/secrets.tdb.0 PERSISTENT UNHEALTHY
 715
 716 .fi
 717 .PP
 718 Example output for a healthy database as machinereadable output \-Y:
 719 .sp
 720 .nf
 721 :ID:Name:Path:Persistent:Unhealthy:
 722 :0x7bbbd26c:passdb.tdb:/var/ctdb/persistent/passdb.tdb.0:1:0:
 723
 724 .fi
 725 .SS "getdbstatus <dbname>"
 726 .PP
 727 This command displays more details about a database.
 728 .PP
 729 Example: ctdb getdbstatus test.tdb.0
 730 .PP
 731 Example output:
 732 .sp
 733 .nf
 734 dbid: 0x122224da
 735 name: test.tdb
 736 path: /var/ctdb/test.tdb.0
 737 PERSISTENT: no
 738 HEALTH: OK
 739
 740 .fi
 741 .PP
 742 Example: ctdb getdbstatus registry.tdb (with a corrupted TDB)
 743 .PP
 744 Example output:
 745 .sp
 746 .nf
 747 dbid: 0xf2a58948
 748 name: registry.tdb
 749 path: /var/ctdb/persistent/registry.tdb.0
 750 PERSISTENT: yes
 751 HEALTH: NO\-HEALTHY\-NODES \- ERROR \- Backup of corrupted TDB in '/var/ctdb/persistent/registry.tdb.0.corrupted.20091208091949.0Z'
 752
 753 .fi
 754 .SS "catdb <dbname>"
 755 .PP
 756 This command will dump a clustered TDB database to the screen. This is a debugging command.
 757 .SS "cattdb <dbname>"
 758 .PP
 759 This command will dump the content of the local TDB database to the screen. This is a debugging command.
 760 .SS "dumpdbbackup <backup\-file>"
 761 .PP
 762 This command will dump the content of database backup to the screen (similar to ctdb catdb). This is a debugging command.
 763 .SS "getmonmode"
 764 .PP
 765 This command returns the monutoring mode of a node. The monitoring mode is either ACTIVE or DISABLED. Normally a node will continuously monitor that all other nodes that are expected are in fact connected and that they respond to commands.
 766 .PP
 767 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.
 768 .PP
 769 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.
 770 .SS "setmonmode <0|1>"
 771 .PP
 772 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.
 773 .SS "attach <dbname> [persistent]"
 774 .PP
 775 This is a debugging command. This command will make the CTDB daemon create a new CTDB database and attach to it.
 776 .SS "dumpmemory"
 777 .PP
 778 This is a debugging command. This command will make the ctdb daemon to write a fill memory allocation map to standard output.
 779 .SS "rddumpmemory"
 780 .PP
 781 This is a debugging command. This command will dump the talloc memory allocation tree for the recovery daemon to standard output.
 782 .SS "thaw"
 783 .PP
 784 Thaw a previously frozen node.
 785 .SS "eventscript <arguments>"
 786 .PP
 787 This is a debugging command. This command can be used to manually invoke and run the eventscritps with arbitrary arguments.
 788 .SS "ban <bantime|0>"
 789 .PP
 790 Administratively ban a node for bantime seconds. A bantime of 0 means that the node should be permanently banned.
 791 .PP
 792 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.
 793 .PP
 794 Nodes are automatically banned if they are the cause of too many cluster recoveries.
 795 .PP
 796 This is primarily a testing command. Note that the recovery daemon controls the overall ban state and it may automatically unban nodes at will. Meaning that a node that has been banned by the administrator can and ofter are unbanned before the admin specifid timeout triggers. If wanting to "drop" a node out from the cluster for mainentance or other reasons, use the "stop" / "continue" commands instad of "ban" / "unban".
 797 .SS "unban"
 798 .PP
 799 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.
 800 .SS "check_srvids <srvid> ..."
 801 .PP
 802 This command checks whether a set of srvid message ports are registered on the node or not. The command takes a list of values to check.
 803 .PP
 804 Example: ctdb check_srvids 1 2 3 14765
 805 .PP
 806 Example output:
 807 .sp
 808 .nf
 809 Server id 0:1 does not exist
 810 Server id 0:2 does not exist
 811 Server id 0:3 does not exist
 812 Server id 0:14765 exists
 813
 814 .fi
 815 .SH "SEE ALSO"
 816 .PP
 817 ctdbd(1), onnode(1)
 818 \fI\%http://ctdb.samba.org/\fR
 819 .SH "COPYRIGHT/LICENSE"
 820 .sp
 821 .nf
 822 Copyright (C) Andrew Tridgell 2007
 823 Copyright (C) Ronnie sahlberg 2007
 824
 825 This program is free software; you can redistribute it and/or modify
 826 it under the terms of the GNU General Public License as published by
 827 the Free Software Foundation; either version 3 of the License, or (at
 828 your option) any later version.
 829
 830 This program is distributed in the hope that it will be useful, but
 831 WITHOUT ANY WARRANTY; without even the implied warranty of
 832 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 833 General Public License for more details.
 834
 835 You should have received a copy of the GNU General Public License
 836 along with this program; if not, see http://www.gnu.org/licenses/.
 837 .fi