| blob | c854619483b095d3e723386036742693e8e4692c |
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="ctdb.1">
5 <refmeta>
6 <refentrytitle>ctdb</refentrytitle>
7 <manvolnum>1</manvolnum>
8 <refmiscinfo class="source">ctdb</refmiscinfo>
9 <refmiscinfo class="manual">CTDB - clustered TDB database</refmiscinfo>
10 </refmeta>
13 <refnamediv>
14 <refname>ctdb</refname>
15 <refpurpose>clustered tdb database management utility</refpurpose>
16 </refnamediv>
18 <refsynopsisdiv>
19 <cmdsynopsis>
20 <command>ctdb [ OPTIONS ] COMMAND ...</command>
21 </cmdsynopsis>
23 <cmdsynopsis>
24 <command>ctdb</command>
25 <arg choice="opt">-n <node></arg>
26 <arg choice="opt">-Y</arg>
27 <arg choice="opt">-t <timeout></arg>
28 <arg choice="opt">-T <timelimit></arg>
29 <arg choice="opt">-? --help</arg>
30 <arg choice="opt">--usage</arg>
31 <arg choice="opt">-d --debug=<INTEGER></arg>
32 <arg choice="opt">--socket=<filename></arg>
33 <arg choice="opt">--print-emptyrecords</arg>
34 <arg choice="opt">--print-datasize</arg>
35 <arg choice="opt">--print-lmaster</arg>
36 <arg choice="opt">--print-hash</arg>
37 <arg choice="opt">--print-recordflags</arg>
38 </cmdsynopsis>
40 </refsynopsisdiv>
42 <refsect1><title>DESCRIPTION</title>
43 <para>
44 ctdb is a utility to view and manage a ctdb cluster.
45 </para>
46 </refsect1>
49 <refsect1>
50 <title>OPTIONS</title>
52 <variablelist>
53 <varlistentry><term>-n <pnn></term>
54 <listitem>
55 <para>
56 This specifies the physical node number on which to execute the
57 command. Default is to run the command on the daemon running on
58 the local host.
59 </para>
60 <para>
61 The physical node number is an integer that describes the node in the
62 cluster. The first node has physical node number 0.
63 </para>
64 </listitem>
65 </varlistentry>
67 <varlistentry><term>-Y</term>
68 <listitem>
69 <para>
70 Produce output in machine readable form for easier parsing by scripts. Not all commands support this option.
71 </para>
72 </listitem>
73 </varlistentry>
75 <varlistentry><term>-t <timeout></term>
76 <listitem>
77 <para>
78 How long should ctdb wait for the local ctdb daemon to respond to a command before timing out. Default is 3 seconds.
79 </para>
80 </listitem>
81 </varlistentry>
83 <varlistentry><term>-T <timelimit></term>
84 <listitem>
85 <para>
86 A limit on how long the ctdb command will run for before it will
87 be aborted. When this timelimit has been exceeded the ctdb command will
88 terminate.
89 </para>
90 </listitem>
91 </varlistentry>
93 <varlistentry><term>-? --help</term>
94 <listitem>
95 <para>
96 Print some help text to the screen.
97 </para>
98 </listitem>
99 </varlistentry>
101 <varlistentry><term>--usage</term>
102 <listitem>
103 <para>
104 Print useage information to the screen.
105 </para>
106 </listitem>
107 </varlistentry>
109 <varlistentry><term>-d --debug=<debuglevel></term>
110 <listitem>
111 <para>
112 Change the debug level for the command. Default is 0.
113 </para>
114 </listitem>
115 </varlistentry>
117 <varlistentry><term>--socket=<filename></term>
118 <listitem>
119 <para>
120 Specify the socketname to use when connecting to the local ctdb
121 daemon. The default is /tmp/ctdb.socket .
122 </para>
123 <para>
124 You only need to specify this parameter if you run multiple ctdb
125 daemons on the same physical host and thus can not use the default
126 name for the domain socket.
127 </para>
128 </listitem>
129 </varlistentry>
131 <varlistentry><term>--print-emptyrecords</term>
132 <listitem>
133 <para>
134 This enables printing of empty records when dumping databases
135 with the catdb, cattbd and dumpdbbackup commands. Records with
136 empty data segment are considered deleted by ctdb and cleaned
137 by the vacuuming mechanism, so this switch can come in handy for
138 debugging the vacuuming behaviour.
139 </para>
140 </listitem>
141 </varlistentry>
143 <varlistentry><term>--print-datasize</term>
144 <listitem>
145 <para>
146 This lets database dumps (catdb, cattdb, dumpdbbackup) print the
147 size of the record data instead of dumping the data contents.
148 </para>
149 </listitem>
150 </varlistentry>
152 <varlistentry><term>--print-lmaster</term>
153 <listitem>
154 <para>
155 This lets catdb print the lmaster for each record.
156 </para>
157 </listitem>
158 </varlistentry>
160 <varlistentry><term>--print-hash</term>
161 <listitem>
162 <para>
163 This lets database dumps (catdb, cattdb, dumpdbbackup) print the
164 hash for each record.
165 </para>
166 </listitem>
167 </varlistentry>
169 <varlistentry><term>--print-recordflags</term>
170 <listitem>
171 <para>
172 This lets catdb and dumpdbbackup print the
173 record flags for each record. Note that cattdb always
174 prints the flags.
175 </para>
176 </listitem>
177 </varlistentry>
179 </variablelist>
180 </refsect1>
183 <refsect1><title>Administrative Commands</title>
184 <para>
185 These are commands used to monitor and administrate a CTDB cluster.
186 </para>
188 <refsect2><title>pnn</title>
189 <para>
190 This command displays the pnn of the current node.
191 </para>
192 </refsect2>
194 <refsect2><title>status</title>
195 <para>
196 This command shows the current status of the ctdb node.
197 </para>
199 <refsect3><title>node status</title>
200 <para>
201 Node status reflects the current status of the node. There are five possible states:
202 </para>
203 <para>
204 OK - This node is fully functional.
205 </para>
206 <para>
207 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.
208 </para>
209 <para>
210 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.
211 </para>
212 <para>
213 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.
214 </para>
215 <para>
216 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.
217 </para>
218 <para>
219 STOPPED - A node that is stopped does not host any public ip addresses,
220 nor is it part of the VNNMAP. A stopped node can not become LVSMASTER,
221 RECMASTER or NATGW.
222 This node does not perticipate in the CTDB cluster but can still be
223 communicated with. I.e. ctdb commands can be sent to it.
224 </para>
225 <para>
226 PARTIALLYONLINE - A node that is partially online participates
227 in a cluster like a node that is ok. Some interfaces to serve
228 public ip addresses are down, but at least one interface is up.
229 See also "ctdb ifaces".
230 </para>
231 </refsect3>
233 <refsect3><title>generation</title>
234 <para>
235 The generation id is a number that indicates the current generation
236 of a cluster instance. Each time a cluster goes through a
237 reconfiguration or a recovery its generation id will be changed.
238 </para>
239 <para>
240 This number does not have any particular meaning other than to keep
241 track of when a cluster has gone through a recovery. It is a random
242 number that represents the current instance of a ctdb cluster
243 and its databases.
244 CTDBD uses this number internally to be able to tell when commands
245 to operate on the cluster and the databases was issued in a different
246 generation of the cluster, to ensure that commands that operate
247 on the databases will not survive across a cluster database recovery.
248 After a recovery, all old outstanding commands will automatically
249 become invalid.
250 </para>
251 <para>
252 Sometimes this number will be shown as "INVALID". This only means that
253 the ctdbd daemon has started but it has not yet merged with the cluster through a recovery.
254 All nodes start with generation "INVALID" and are not assigned a real
255 generation id until they have successfully been merged with a cluster
256 through a recovery.
257 </para>
258 </refsect3>
260 <refsect3><title>VNNMAP</title>
261 <para>
262 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.
263 Only nodes that are participating in the vnnmap can become lmaster or dmaster for a database record.
264 </para>
265 </refsect3>
267 <refsect3><title>Recovery mode</title>
268 <para>
269 This is the current recovery mode of the cluster. There are two possible modes:
270 </para>
271 <para>
272 NORMAL - The cluster is fully operational.
273 </para>
274 <para>
275 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.
276 </para>
277 <para>
278 Once the recovery master detects an inconsistency, for example a node
279 becomes disconnected/connected, the recovery daemon will trigger a
280 cluster recovery process, where all databases are remerged across the
281 cluster. When this process starts, the recovery master will first
282 "freeze" all databases to prevent applications such as samba from
283 accessing the databases and it will also mark the recovery mode as
284 RECOVERY.
285 </para>
286 <para>
287 When CTDBD starts up, it will start in RECOVERY mode.
288 Once the node has been merged into a cluster and all databases
289 have been recovered, the node mode will change into NORMAL mode
290 and the databases will be "thawed", allowing samba to access the
291 databases again.
292 </para>
293 </refsect3>
295 <refsect3><title>Recovery master</title>
296 <para>
297 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.
298 </para>
299 <para>
300 Only one node at a time can be the designated recovery master. Which
301 node is designated the recovery master is decided by an election
302 process in the recovery daemons running on each node.
303 </para>
304 </refsect3>
306 <para>
307 Example: ctdb status
308 </para>
309 <para>Example output:</para>
310 <screen format="linespecific">
311 Number of nodes:4
312 pnn:0 11.1.2.200 OK (THIS NODE)
313 pnn:1 11.1.2.201 OK
314 pnn:2 11.1.2.202 OK
315 pnn:3 11.1.2.203 OK
316 Generation:1362079228
317 Size:4
318 hash:0 lmaster:0
319 hash:1 lmaster:1
320 hash:2 lmaster:2
321 hash:3 lmaster:3
322 Recovery mode:NORMAL (0)
323 Recovery master:0
324 </screen>
325 </refsect2>
327 <refsect2><title>nodestatus [<nodespec>]</title>
328 <para>
329 This command is similar to the <command>status</command>
330 command. It displays the "node status" subset of output. The
331 main differences are:
332 </para>
334 <itemizedlist>
335 <listitem>
336 <para>
337 The exit code is the bitwise-OR of the flags for each
338 specified node, while <command>ctdb status</command> exits
339 with 0 if it was able to retrieve status for all nodes.
340 </para>
341 </listitem>
343 <listitem>
344 <para>
345 <command>ctdb status</command> provides status information
346 for all nodes. <command>ctdb nodestatus</command>
347 defaults to providing status for only the current node.
348 If <nodespec> is provided then status is given for
349 the indicated node(s).
350 </para>
352 <para>
353 By default, <command>ctdb nodestatus</command> gathers
354 status from the local node. However, if invoked with "-n
355 all" (or similar) then status is gathered from the given
356 node(s). In particular <command>ctdb nodestatus
357 all</command> and <command>ctdb nodestatus -n
358 all</command> will produce different output. It is
359 possible to provide 2 different nodespecs (with and
360 without "-n") but the output is usually confusing!
361 </para>
362 </listitem>
363 </itemizedlist>
365 <para>
366 A common invocation in scripts is <command>ctdb nodestatus
367 all</command> to check whether all nodes in a cluster are
368 healthy.
369 </para>
371 <para>
372 Example: ctdb nodestatus
373 </para>
374 <para>Example output:</para>
375 <screen format="linespecific">
376 # ctdb nodestatus
377 pnn:0 10.0.0.30 OK (THIS NODE)
378 </screen>
380 <para>
381 Example: ctdb nodestatus all
382 </para>
383 <para>Example output:</para>
384 <screen format="linespecific">
385 # ctdb nodestatus all
386 Number of nodes:2
387 pnn:0 10.0.0.30 OK (THIS NODE)
388 pnn:1 10.0.0.31 OK
389 </screen>
390 </refsect2>
392 <refsect2><title>recmaster</title>
393 <para>
394 This command shows the pnn of the node which is currently the recmaster.
395 </para>
396 </refsect2>
398 <refsect2><title>uptime</title>
399 <para>
400 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.
401 </para>
403 <para>
404 Example: ctdb uptime
405 </para>
406 <para>Example output:</para>
407 <screen format="linespecific">
408 Current time of node : Thu Oct 29 10:38:54 2009
409 Ctdbd start time : (000 16:54:28) Wed Oct 28 17:44:26 2009
410 Time of last recovery/failover: (000 16:53:31) Wed Oct 28 17:45:23 2009
411 Duration of last recovery/failover: 2.248552 seconds
412 </screen>
413 </refsect2>
415 <refsect2><title>listnodes</title>
416 <para>
417 This command shows lists the ip addresses of all the nodes in the cluster.
418 </para>
420 <para>
421 Example: ctdb listnodes
422 </para>
423 <para>Example output:</para>
424 <screen format="linespecific">
425 10.0.0.71
426 10.0.0.72
427 10.0.0.73
428 10.0.0.74
429 </screen>
430 </refsect2>
432 <refsect2><title>ping</title>
433 <para>
434 This command will "ping" specified CTDB node in the cluster to
435 verify that they are running.
436 </para>
437 <para>
438 Example: ctdb ping -n all
439 </para>
440 <para>
441 Example output:
442 </para>
443 <screen format="linespecific">
444 response from 0 time=0.000054 sec (3 clients)
445 response from 1 time=0.000144 sec (2 clients)
446 response from 2 time=0.000105 sec (2 clients)
447 response from 3 time=0.000114 sec (2 clients)
448 </screen>
449 </refsect2>
451 <refsect2><title>runstate [setup|first_recovery|startup|running]</title>
452 <para>
453 Print the runstate of the specified node. Runstates are used
454 to serialise important state transitions in CTDB, particularly
455 during startup.
456 </para>
457 <para>
458 If one or more optional runstate arguments are specified then
459 the node must be in one of these runstates for the command to
460 succeed.
461 </para>
462 <para>
463 Example: ctdb runstate
464 </para>
465 <para>
466 Example output:
467 </para>
468 <screen format="linespecific">
469 RUNNING
470 </screen>
471 </refsect2>
473 <refsect2><title>ifaces</title>
474 <para>
475 This command will display the list of network interfaces, which could
476 host public addresses, along with their status.
477 </para>
478 <para>
479 Example: ctdb ifaces
480 </para>
481 <para>
482 Example output:
483 </para>
484 <screen format="linespecific">
485 Interfaces on node 0
486 name:eth5 link:up references:2
487 name:eth4 link:down references:0
488 name:eth3 link:up references:1
489 name:eth2 link:up references:1
490 </screen>
491 <para>
492 Example: ctdb ifaces -Y
493 </para>
494 <para>
495 Example output:
496 </para>
497 <screen format="linespecific">
498 :Name:LinkStatus:References:
499 :eth5:1:2
500 :eth4:0:0
501 :eth3:1:1
502 :eth2:1:1
503 </screen>
504 </refsect2>
506 <refsect2><title>setifacelink <iface> <status></title>
507 <para>
508 This command will set the status of a network interface.
509 The status needs to be "up" or "down". This is typically
510 used in the 10.interfaces script in the "monitor" event.
511 </para>
512 <para>
513 Example: ctdb setifacelink eth0 up
514 </para>
515 </refsect2>
517 <refsect2><title>ip</title>
518 <para>
519 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".
520 </para>
521 <para>
522 Example: ctdb ip
523 </para>
524 <para>
525 Example output:
526 </para>
527 <screen format="linespecific">
528 Public IPs on node 0
529 172.31.91.82 node[1] active[] available[eth2,eth3] configured[eth2,eth3]
530 172.31.91.83 node[0] active[eth3] available[eth2,eth3] configured[eth2,eth3]
531 172.31.91.84 node[1] active[] available[eth2,eth3] configured[eth2,eth3]
532 172.31.91.85 node[0] active[eth2] available[eth2,eth3] configured[eth2,eth3]
533 172.31.92.82 node[1] active[] available[eth5] configured[eth4,eth5]
534 172.31.92.83 node[0] active[eth5] available[eth5] configured[eth4,eth5]
535 172.31.92.84 node[1] active[] available[eth5] configured[eth4,eth5]
536 172.31.92.85 node[0] active[eth5] available[eth5] configured[eth4,eth5]
537 </screen>
538 <para>
539 Example: ctdb ip -Y
540 </para>
541 <para>
542 Example output:
543 </para>
544 <screen format="linespecific">
545 :Public IP:Node:ActiveInterface:AvailableInterfaces:ConfiguredInterfaces:
546 :172.31.91.82:1::eth2,eth3:eth2,eth3:
547 :172.31.91.83:0:eth3:eth2,eth3:eth2,eth3:
548 :172.31.91.84:1::eth2,eth3:eth2,eth3:
549 :172.31.91.85:0:eth2:eth2,eth3:eth2,eth3:
550 :172.31.92.82:1::eth5:eth4,eth5:
551 :172.31.92.83:0:eth5:eth5:eth4,eth5:
552 :172.31.92.84:1::eth5:eth4,eth5:
553 :172.31.92.85:0:eth5:eth5:eth4,eth5:
554 </screen>
555 </refsect2>
557 <refsect2><title>ipinfo <ip></title>
558 <para>
559 This command will display details about the specified public addresses.
560 </para>
561 <para>
562 Example: ctdb ipinfo 172.31.92.85
563 </para>
564 <para>
565 Example output:
566 </para>
567 <screen format="linespecific">
568 Public IP[172.31.92.85] info on node 0
569 IP:172.31.92.85
570 CurrentNode:0
571 NumInterfaces:2
572 Interface[1]: Name:eth4 Link:down References:0
573 Interface[2]: Name:eth5 Link:up References:2 (active)
574 </screen>
575 </refsect2>
577 <refsect2><title>scriptstatus</title>
578 <para>
579 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.
580 </para>
581 <para>
582 Example: ctdb scriptstatus
583 </para>
584 <para>
585 Example output:
586 </para>
587 <screen format="linespecific">
588 7 scripts were executed last monitoring cycle
589 00.ctdb Status:OK Duration:0.056 Tue Mar 24 18:56:57 2009
590 10.interface Status:OK Duration:0.077 Tue Mar 24 18:56:57 2009
591 11.natgw Status:OK Duration:0.039 Tue Mar 24 18:56:57 2009
592 20.multipathd Status:OK Duration:0.038 Tue Mar 24 18:56:57 2009
593 31.clamd Status:DISABLED
594 40.vsftpd Status:OK Duration:0.045 Tue Mar 24 18:56:57 2009
595 41.httpd Status:OK Duration:0.039 Tue Mar 24 18:56:57 2009
596 50.samba Status:ERROR Duration:0.082 Tue Mar 24 18:56:57 2009
597 OUTPUT:ERROR: Samba tcp port 445 is not responding
598 </screen>
599 </refsect2>
601 <refsect2><title>disablescript <script></title>
602 <para>
603 This command is used to disable an eventscript.
604 </para>
605 <para>
606 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'.
607 </para>
608 </refsect2>
610 <refsect2><title>enablescript <script></title>
611 <para>
612 This command is used to enable an eventscript.
613 </para>
614 <para>
615 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'.
616 </para>
617 </refsect2>
619 <refsect2><title>getvar <name></title>
620 <para>
621 Get the runtime value of a tuneable variable.
622 </para>
623 <para>
624 Example: ctdb getvar MaxRedirectCount
625 </para>
626 <para>
627 Example output:
628 </para>
629 <screen format="linespecific">
630 MaxRedirectCount = 3
631 </screen>
632 </refsect2>
634 <refsect2><title>setvar <name> <value></title>
635 <para>
636 Set the runtime value of a tuneable variable.
637 </para>
638 <para>
639 Example: ctdb setvar MaxRedirectCount 5
640 </para>
641 </refsect2>
643 <refsect2><title>listvars</title>
644 <para>
645 List all tuneable variables, except the values of the obsolete tunables
646 like VacuumMinInterval. The obsolete tunables can be retrieved only
647 explicitly with the "ctdb getvar" command.
648 </para>
649 <para>
650 Example: ctdb listvars
651 </para>
652 <para>
653 Example output:
654 </para>
655 <screen format="linespecific">
656 MaxRedirectCount = 3
657 SeqnumInterval = 1000
658 ControlTimeout = 60
659 TraverseTimeout = 20
660 KeepaliveInterval = 5
661 KeepaliveLimit = 5
662 RecoverTimeout = 20
663 RecoverInterval = 1
664 ElectionTimeout = 3
665 TakeoverTimeout = 9
666 MonitorInterval = 15
667 TickleUpdateInterval = 20
668 EventScriptTimeout = 30
669 EventScriptTimeoutCount = 1
670 RecoveryGracePeriod = 120
671 RecoveryBanPeriod = 300
672 DatabaseHashSize = 100001
673 DatabaseMaxDead = 5
674 RerecoveryTimeout = 10
675 EnableBans = 1
676 DeterministicIPs = 0
677 LCP2PublicIPs = 1
678 ReclockPingPeriod = 60
679 NoIPFailback = 0
680 DisableIPFailover = 0
681 VerboseMemoryNames = 0
682 RecdPingTimeout = 60
683 RecdFailCount = 10
684 LogLatencyMs = 0
685 RecLockLatencyMs = 1000
686 RecoveryDropAllIPs = 120
687 VerifyRecoveryLock = 1
688 VacuumInterval = 10
689 VacuumMaxRunTime = 30
690 RepackLimit = 10000
691 VacuumLimit = 5000
692 VacuumFastPathCount = 60
693 MaxQueueDropMsg = 1000000
694 UseStatusEvents = 0
695 AllowUnhealthyDBRead = 0
696 StatHistoryInterval = 1
697 DeferredAttachTO = 120
698 AllowClientDBAttach = 1
699 RecoverPDBBySeqNum = 0
700 </screen>
701 </refsect2>
703 <refsect2><title>lvsmaster</title>
704 <para>
705 This command shows which node is currently the LVSMASTER. The
706 LVSMASTER is the node in the cluster which drives the LVS system and
707 which receives all incoming traffic from clients.
708 </para>
709 <para>
710 LVS is the mode where the entire CTDB/Samba cluster uses a single
711 ip address for the entire cluster. In this mode all clients connect to
712 one specific node which will then multiplex/loadbalance the clients
713 evenly onto the other nodes in the cluster. This is an alternative to using
714 public ip addresses. See the manpage for ctdbd for more information
715 about LVS.
716 </para>
717 </refsect2>
719 <refsect2><title>lvs</title>
720 <para>
721 This command shows which nodes in the cluster are currently active in the
722 LVS configuration. I.e. which nodes we are currently loadbalancing
723 the single ip address across.
724 </para>
726 <para>
727 LVS will by default only loadbalance across those nodes that are both
728 LVS capable and also HEALTHY. Except if all nodes are UNHEALTHY in which
729 case LVS will loadbalance across all UNHEALTHY nodes as well.
730 LVS will never use nodes that are DISCONNECTED, STOPPED, BANNED or
731 DISABLED.
732 </para>
734 <para>
735 Example output:
736 </para>
737 <screen format="linespecific">
738 2:10.0.0.13
739 3:10.0.0.14
740 </screen>
742 </refsect2>
745 <refsect2><title>getcapabilities</title>
746 <para>
747 This command shows the capabilities of the current node.
748 Please see manpage for ctdbd for a full list of all capabilities and
749 more detailed description.
750 </para>
752 <para>
753 RECMASTER and LMASTER capabilities are primarily used when CTDBD
754 is used to create a cluster spanning across WAN links. In which case
755 ctdbd acts as a WAN accelerator.
756 </para>
758 <para>
759 LVS capabile means that the node is participating in LVS, a mode
760 where the entire CTDB cluster uses one single ip address for the
761 entire cluster instead of using public ip address failover.
762 This is an alternative to using a loadbalancing layer-4 switch.
763 </para>
765 <para>
766 Example output:
767 </para>
768 <screen format="linespecific">
769 RECMASTER: YES
770 LMASTER: YES
771 LVS: NO
772 </screen>
774 </refsect2>
776 <refsect2><title>statistics</title>
777 <para>
778 Collect statistics from the CTDB daemon about how many calls it has served.
779 </para>
780 <para>
781 Example: ctdb statistics
782 </para>
783 <para>
784 Example output:
785 </para>
786 <screen format="linespecific">
787 CTDB version 1
788 num_clients 3
789 frozen 0
790 recovering 0
791 client_packets_sent 360489
792 client_packets_recv 360466
793 node_packets_sent 480931
794 node_packets_recv 240120
795 keepalive_packets_sent 4
796 keepalive_packets_recv 3
797 node
798 req_call 2
799 reply_call 2
800 req_dmaster 0
801 reply_dmaster 0
802 reply_error 0
803 req_message 42
804 req_control 120408
805 reply_control 360439
806 client
807 req_call 2
808 req_message 24
809 req_control 360440
810 timeouts
811 call 0
812 control 0
813 traverse 0
814 total_calls 2
815 pending_calls 0
816 lockwait_calls 0
817 pending_lockwait_calls 0
818 memory_used 5040
819 max_hop_count 0
820 max_call_latency 4.948321 sec
821 max_lockwait_latency 0.000000 sec
822 </screen>
823 </refsect2>
825 <refsect2><title>statisticsreset</title>
826 <para>
827 This command is used to clear all statistics counters in a node.
828 </para>
829 <para>
830 Example: ctdb statisticsreset
831 </para>
832 </refsect2>
834 <refsect2><title>getreclock</title>
835 <para>
836 This command is used to show the filename of the reclock file that is used.
837 </para>
839 <para>
840 Example output:
841 </para>
842 <screen format="linespecific">
843 Reclock file:/gpfs/.ctdb/shared
844 </screen>
846 </refsect2>
848 <refsect2><title>setreclock [filename]</title>
849 <para>
850 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".
851 </para>
853 <para>
854 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.
855 </para>
857 <para>
858 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.
859 </para>
860 </refsect2>
864 <refsect2><title>getdebug</title>
865 <para>
866 Get the current debug level for the node. the debug level controls what information is written to the log file.
867 </para>
868 <para>
869 The debug levels are mapped to the corresponding syslog levels.
870 When a debug level is set, only those messages at that level and higher
871 levels will be printed.
872 </para>
873 <para>
874 The list of debug levels from highest to lowest are :
875 </para>
876 <para>
877 EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
878 </para>
879 </refsect2>
881 <refsect2><title>setdebug <debuglevel></title>
882 <para>
883 Set the debug level of a node. This controls what information will be logged.
884 </para>
885 <para>
886 The debuglevel is one of EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
887 </para>
888 </refsect2>
890 <refsect2><title>getpid</title>
891 <para>
892 This command will return the process id of the ctdb daemon.
893 </para>
894 </refsect2>
896 <refsect2><title>disable</title>
897 <para>
898 This command is used to administratively disable a node in the cluster.
899 A disabled node will still participate in the cluster and host
900 clustered TDB records but its public ip address has been taken over by
901 a different node and it no longer hosts any services.
902 </para>
903 </refsect2>
905 <refsect2><title>enable</title>
906 <para>
907 Re-enable a node that has been administratively disabled.
908 </para>
909 </refsect2>
911 <refsect2><title>stop</title>
912 <para>
913 This command is used to administratively STOP a node in the cluster.
914 A STOPPED node is connected to the cluster but will not host any
915 public ip addresse, nor does it participate in the VNNMAP.
916 The difference between a DISABLED node and a STOPPED node is that
917 a STOPPED node does not host any parts of the database which means
918 that a recovery is required to stop/continue nodes.
919 </para>
920 </refsect2>
922 <refsect2><title>continue</title>
923 <para>
924 Re-start a node that has been administratively stopped.
925 </para>
926 </refsect2>
928 <refsect2><title>addip <public_ip/mask> <iface></title>
929 <para>
930 This command is used to add a new public ip to a node during runtime.
931 This allows public addresses to be added to a cluster without having
932 to restart the ctdb daemons.
933 </para>
934 <para>
935 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.
936 If you want this change to be permanent you must also update the public addresses file manually.
937 </para>
938 </refsect2>
940 <refsect2><title>delip <public_ip></title>
941 <para>
942 This command is used to remove a public ip from a node during runtime.
943 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.
944 </para>
945 <para>
946 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.
947 If you want this change to be permanent you must also update the public addresses file manually.
948 </para>
949 </refsect2>
951 <refsect2><title>moveip <public_ip> <node></title>
952 <para>
953 This command can be used to manually fail a public ip address to a
954 specific node.
955 </para>
956 <para>
957 In order to manually override the "automatic" distribution of public
958 ip addresses that ctdb normally provides, this command only works
959 when you have changed the tunables for the daemon to:
960 </para>
961 <para>
962 DeterministicIPs = 0
963 </para>
964 <para>
965 NoIPFailback = 1
966 </para>
967 </refsect2>
969 <refsect2><title>shutdown</title>
970 <para>
971 This command will shutdown a specific CTDB daemon.
972 </para>
973 </refsect2>
975 <refsect2><title>recover</title>
976 <para>
977 This command will trigger the recovery daemon to do a cluster
978 recovery.
979 </para>
980 </refsect2>
982 <refsect2><title>ipreallocate</title>
983 <para>
984 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.
985 </para>
986 </refsect2>
988 <refsect2><title>setlmasterrole <on|off></title>
989 <para>
990 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.
991 </para>
993 <para>
994 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.
995 </para>
996 <para>
997 Once this setting has been enabled/disabled, you need to perform a recovery for it to take effect.
998 </para>
999 <para>
1000 See also "ctdb getcapabilities"
1001 </para>
1002 </refsect2>
1004 <refsect2><title>setrecmasterrole <on|off></title>
1005 <para>
1006 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.
1007 </para>
1009 <para>
1010 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.
1011 </para>
1012 <para>
1013 See also "ctdb getcapabilities"
1014 </para>
1015 </refsect2>
1017 <refsect2><title>killtcp <srcip:port> <dstip:port></title>
1018 <para>
1019 This command will kill the specified TCP connection by issuing a
1020 TCP RST to the srcip:port endpoint. This is a command used by the
1021 ctdb eventscripts.
1022 </para>
1023 </refsect2>
1025 <refsect2><title>gratiousarp <ip> <interface></title>
1026 <para>
1027 This command will send out a gratious arp for the specified interface
1028 through the specified interface. This command is mainly used by the
1029 ctdb eventscripts.
1030 </para>
1031 </refsect2>
1033 <refsect2><title>reloadnodes</title>
1034 <para>
1035 This command is used when adding new nodes, or removing existing nodes from an existing cluster.
1036 </para>
1037 <para>
1038 Procedure to add a node:
1039 </para>
1040 <para>
1041 1, To expand an existing cluster, first ensure with 'ctdb status' that
1042 all nodes are up and running and that they are all healthy.
1043 Do not try to expand a cluster unless it is completely healthy!
1044 </para>
1045 <para>
1046 2, On all nodes, edit /etc/ctdb/nodes and add the new node as the last
1047 entry to the file. The new node MUST be added to the end of this file!
1048 </para>
1049 <para>
1050 3, Verify that all the nodes have identical /etc/ctdb/nodes files after you edited them and added the new node!
1051 </para>
1052 <para>
1053 4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
1054 </para>
1055 <para>
1056 5, Use 'ctdb status' on all nodes and verify that they now show the additional node.
1057 </para>
1058 <para>
1059 6, Install and configure the new node and bring it online.
1060 </para>
1061 <para>
1062 Procedure to remove a node:
1063 </para>
1064 <para>
1065 1, To remove a node from an existing cluster, first ensure with 'ctdb status' that
1066 all nodes, except the node to be deleted, are up and running and that they are all healthy.
1067 Do not try to remove a node from a cluster unless the cluster is completely healthy!
1068 </para>
1069 <para>
1070 2, Shutdown and poweroff the node to be removed.
1071 </para>
1072 <para>
1073 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.
1074 </para>
1075 <para>
1076 4, Run 'ctdb reloadnodes' to force all nodes to reload the nodesfile.
1077 </para>
1078 <para>
1079 5, Use 'ctdb status' on all nodes and verify that the deleted node no longer shows up in the list..
1080 </para>
1081 <para>
1082 </para>
1084 </refsect2>
1086 <refsect2><title>reloadips</title>
1087 <para>
1088 This command is used to reload the public addresses file and update the
1089 ip configuration of the running daemon.
1090 </para>
1091 <para>
1092 Procedure to update the public address configuration on a single node:
1093 </para>
1094 <para>
1095 1, Update the /etc/ctdb/public_addresses file on the node
1096 </para>
1097 <para>
1098 2, Run 'ctdb reloadips' on the node.
1099 </para>
1100 <para>
1101 The file will then be reloaded on the node and addresses will be added
1102 or removed as required to match the newly loaded file. When updating
1103 a single node it may take a little while before any newly added
1104 addresses are failed onto the node.
1105 </para>
1107 <para>
1108 </para>
1110 <para>
1111 Procedure to update the public address configuration on whole cluster:
1112 </para>
1113 <para>
1114 1, Update the /etc/ctdb/public_addresses file on all nodes
1115 </para>
1116 <para>
1117 2, Run 'ctdb reloadips -n all'.
1118 </para>
1119 <para>
1120 This command will then force all nodes to reload and update the
1121 addresses. This process is controlled and synchronized by the recovery
1122 master to ensure that all addresses are added to all nodes as one
1123 single operation, after which any required ip node rebalancing may
1124 may take place.
1125 </para>
1127 </refsect2>
1130 <refsect2><title>tickle <srcip:port> <dstip:port></title>
1131 <para>
1132 This command will will send a TCP tickle to the source host for the
1133 specified TCP connection.
1134 A TCP tickle is a TCP ACK packet with an invalid sequence and
1135 acknowledge number and will when received by the source host result
1136 in it sending an immediate correct ACK back to the other end.
1137 </para>
1138 <para>
1139 TCP tickles are useful to "tickle" clients after a IP failover has
1140 occured since this will make the client immediately recognize the
1141 TCP connection has been disrupted and that the client will need
1142 to reestablish. This greatly speeds up the time it takes for a client
1143 to detect and reestablish after an IP failover in the ctdb cluster.
1144 </para>
1145 </refsect2>
1147 <refsect2><title>gettickles <ip></title>
1148 <para>
1149 This command is used to show which TCP connections are registered with
1150 CTDB to be "tickled" if there is a failover.
1151 </para>
1152 </refsect2>
1153 <refsect2><title>repack [max_freelist]</title>
1154 <para>
1155 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.
1156 This command is used to defragment a TDB database and pruning the freelist.
1157 </para>
1159 <para>
1160 If [max_freelist] is specified, then a database will only be repacked if it has more than this number of entries in the freelist.
1161 </para>
1162 <para>
1163 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.
1164 </para>
1166 <para>
1167 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.
1168 </para>
1170 <para>
1171 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.
1172 </para>
1174 <para>
1175 Example: ctdb repack 1000
1176 </para>
1178 <para>
1179 By default, this operation is issued from the 00.ctdb event script every 5 minutes.
1180 </para>
1182 </refsect2>
1184 <refsect2><title>vacuum [max_records]</title>
1185 <para>
1186 Over time CTDB databases will fill up with empty deleted records which will lead to a progressive slow down of CTDB database access.
1187 This command is used to prune all databases and delete all empty records from the cluster.
1188 </para>
1190 <para>
1191 By default, vacuum will delete all empty records from all databases.
1192 If [max_records] is specified, the command will only delete the first
1193 [max_records] empty records for each database.
1194 </para>
1196 <para>
1197 Vacuum only deletes records where the local node is the lmaster.
1198 To delete all records from the entire cluster you need to run a vacuum from each node.
1200 This command is not disruptive. Samba is unaffected and will still be able to read/write records normally while the database is being vacuumed.
1201 </para>
1203 <para>
1204 Example: ctdb vacuum
1205 </para>
1207 <para>
1208 By default, this operation is issued from the 00.ctdb event script every 5 minutes.
1209 </para>
1210 </refsect2>
1212 <refsect2><title>backupdb <dbname> <file></title>
1213 <para>
1214 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.
1215 This is mainly useful for backing up persistent databases such as secrets.tdb and similar.
1216 </para>
1217 </refsect2>
1219 <refsect2><title>restoredb <file> [<dbname>]</title>
1220 <para>
1221 This command restores a persistent database that was previously backed up using backupdb.
1222 By default the data will be restored back into the same database as
1223 it was created from. By specifying dbname you can restore the data
1224 into a different database.
1225 </para>
1226 </refsect2>
1228 <refsect2><title>wipedb <dbname></title>
1229 <para>
1230 This command can be used to remove all content of a database.
1231 </para>
1232 </refsect2>
1233 </refsect1>
1236 <refsect2><title>getlog [<level>] [recoverd]</title>
1237 <para>
1238 In addition to the normal logging to a log file,
1239 CTDBD also keeps a in-memory ringbuffer containing the most recent
1240 log entries for all log levels (except DEBUG).
1241 </para>
1242 <para>
1243 This is useful since it allows for keeping continuous logs to a file
1244 at a reasonable non-verbose level, but shortly after an incident has
1245 occured, a much more detailed log can be pulled from memory. This
1246 can allow you to avoid having to reproduce an issue due to the
1247 on-disk logs being of insufficient detail.
1248 </para>
1249 <para>
1250 This command extracts all messages of level or lower log level
1251 from memory and prints it to the screen. The level is not
1252 specified it defaults to NOTICE.
1253 </para>
1254 <para>
1255 By default, logs are extracted from the main CTDB daemon. If
1256 the recoverd option is given then logs are extracted from the
1257 recovery daemon.
1258 </para>
1259 </refsect2>
1261 <refsect2><title>clearlog [recoverd]</title>
1262 <para>
1263 This command clears the in-memory logging ringbuffer.
1264 </para>
1265 <para>
1266 By default, logs are cleared in the main CTDB daemon. If the
1267 recoverd option is given then logs are cleared in the recovery
1268 daemon.
1269 </para>
1270 </refsect2>
1272 <refsect2><title>setdbreadonly <dbname|hash></title>
1273 <para>
1274 This command will enable the ReadOnly record support for a database.
1275 This is an experimental feature to improve performance for contended
1276 records primarily in locking.tdb and brlock.tdb.
1277 When enabling this feature you must set it on all nodes in the cluster.
1278 For now, this feature requires a special patch to samba in order to
1279 use it.
1280 </para>
1281 </refsect2>
1284 <refsect1><title>Debugging Commands</title>
1285 <para>
1286 These commands are primarily used for CTDB development and testing and
1287 should not be used for normal administration.
1288 </para>
1289 <refsect2><title>process-exists <pid></title>
1290 <para>
1291 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.
1292 </para>
1293 </refsect2>
1295 <refsect2><title>getdbmap</title>
1296 <para>
1297 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.
1298 </para>
1299 <para>
1300 If a PERSISTENT database is not in a healthy state the database is
1301 flagged as UNHEALTHY. If there's at least one completely healthy node running in
1302 the cluster, it's possible that the content is restored by a recovery
1303 run automaticly. Otherwise an administrator needs to analyze the
1304 problem.
1305 </para>
1306 <para>
1307 See also "ctdb getdbstatus", "ctdb backupdb", "ctdb restoredb",
1308 "ctdb dumpbackup", "ctdb wipedb", "ctdb setvar AllowUnhealthyDBRead 1"
1309 and (if samba or tdb-utils are installed) "tdbtool check".
1310 </para>
1311 <para>
1312 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.
1313 </para>
1314 <para>
1315 Example: ctdb getdbmap
1316 </para>
1317 <para>
1318 Example output:
1319 </para>
1320 <screen format="linespecific">
1321 Number of databases:10
1322 dbid:0x435d3410 name:notify.tdb path:/var/ctdb/notify.tdb.0
1323 dbid:0x42fe72c5 name:locking.tdb path:/var/ctdb/locking.tdb.0
1324 dbid:0x1421fb78 name:brlock.tdb path:/var/ctdb/brlock.tdb.0
1325 dbid:0x17055d90 name:connections.tdb path:/var/ctdb/connections.tdb.0
1326 dbid:0xc0bdde6a name:sessionid.tdb path:/var/ctdb/sessionid.tdb.0
1327 dbid:0x122224da name:test.tdb path:/var/ctdb/test.tdb.0
1328 dbid:0x2672a57f name:idmap2.tdb path:/var/ctdb/persistent/idmap2.tdb.0 PERSISTENT
1329 dbid:0xb775fff6 name:secrets.tdb path:/var/ctdb/persistent/secrets.tdb.0 PERSISTENT
1330 dbid:0xe98e08b6 name:group_mapping.tdb path:/var/ctdb/persistent/group_mapping.tdb.0 PERSISTENT
1331 dbid:0x7bbbd26c name:passdb.tdb path:/var/ctdb/persistent/passdb.tdb.0 PERSISTENT
1332 </screen>
1333 <para>
1334 Example output for an unhealthy database:
1335 </para>
1336 <screen format="linespecific">
1337 Number of databases:1
1338 dbid:0xb775fff6 name:secrets.tdb path:/var/ctdb/persistent/secrets.tdb.0 PERSISTENT UNHEALTHY
1339 </screen>
1341 <para>
1342 Example output for a healthy database as machinereadable output -Y:
1343 </para>
1344 <screen format="linespecific">
1345 :ID:Name:Path:Persistent:Unhealthy:
1346 :0x7bbbd26c:passdb.tdb:/var/ctdb/persistent/passdb.tdb.0:1:0:
1347 </screen>
1348 </refsect2>
1350 <refsect2><title>getdbstatus <dbname></title>
1351 <para>
1352 This command displays more details about a database.
1353 </para>
1354 <para>
1355 Example: ctdb getdbstatus test.tdb.0
1356 </para>
1357 <para>
1358 Example output:
1359 </para>
1360 <screen format="linespecific">
1361 dbid: 0x122224da
1362 name: test.tdb
1363 path: /var/ctdb/test.tdb.0
1364 PERSISTENT: no
1365 HEALTH: OK
1366 </screen>
1367 <para>
1368 Example: ctdb getdbstatus registry.tdb (with a corrupted TDB)
1369 </para>
1370 <para>
1371 Example output:
1372 </para>
1373 <screen format="linespecific">
1374 dbid: 0xf2a58948
1375 name: registry.tdb
1376 path: /var/ctdb/persistent/registry.tdb.0
1377 PERSISTENT: yes
1378 HEALTH: NO-HEALTHY-NODES - ERROR - Backup of corrupted TDB in '/var/ctdb/persistent/registry.tdb.0.corrupted.20091208091949.0Z'
1379 </screen>
1380 </refsect2>
1382 <refsect2><title>catdb <dbname></title>
1383 <para>
1384 This command will dump a clustered TDB database to the screen. This is a debugging command.
1385 </para>
1386 </refsect2>
1388 <refsect2><title>cattdb <dbname></title>
1389 <para>
1390 This command will dump the content of the local TDB database to the screen. This is a debugging command.
1391 </para>
1392 </refsect2>
1394 <refsect2><title>dumpdbbackup <backup-file></title>
1395 <para>
1396 This command will dump the content of database backup to the screen
1397 (similar to ctdb catdb). This is a debugging command.
1398 </para>
1399 </refsect2>
1401 <refsect2><title>getmonmode</title>
1402 <para>
1403 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.
1404 </para>
1405 <para>
1406 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.
1407 </para>
1408 <para>
1409 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.
1410 </para>
1411 </refsect2>
1414 <refsect2><title>setmonmode <0|1></title>
1415 <para>
1416 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.
1417 </para>
1418 </refsect2>
1420 <refsect2><title>attach <dbname> [persistent]</title>
1421 <para>
1422 This is a debugging command. This command will make the CTDB daemon create a new CTDB database and attach to it.
1423 </para>
1424 </refsect2>
1426 <refsect2><title>dumpmemory</title>
1427 <para>
1428 This is a debugging command. This command will make the ctdb
1429 daemon to write a fill memory allocation map to standard output.
1430 </para>
1431 </refsect2>
1433 <refsect2><title>rddumpmemory</title>
1434 <para>
1435 This is a debugging command. This command will dump the talloc memory
1436 allocation tree for the recovery daemon to standard output.
1437 </para>
1438 </refsect2>
1440 <refsect2><title>thaw</title>
1441 <para>
1442 Thaw a previously frozen node.
1443 </para>
1444 </refsect2>
1447 <refsect2><title>eventscript <arguments></title>
1448 <para>
1449 This is a debugging command. This command can be used to manually
1450 invoke and run the eventscritps with arbitrary arguments.
1451 </para>
1452 </refsect2>
1454 <refsect2><title>ban <bantime|0></title>
1455 <para>
1456 Administratively ban a node for bantime seconds. A bantime of 0 means that the node should be permanently banned.
1457 </para>
1458 <para>
1459 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.
1460 </para>
1461 <para>
1462 Nodes are automatically banned if they are the cause of too many
1463 cluster recoveries.
1464 </para>
1465 <para>
1466 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".
1467 </para>
1468 </refsect2>
1470 <refsect2><title>unban</title>
1471 <para>
1472 This command is used to unban a node that has either been
1473 administratively banned using the ban command or has been automatically
1474 banned by the recovery daemon.
1475 </para>
1476 </refsect2>
1479 <refsect2><title>check_srvids <srvid> ...</title>
1480 <para>
1481 This command checks whether a set of srvid message ports are registered on the
1482 node or not. The command takes a list of values to check.
1483 </para>
1484 <para>
1485 Example: ctdb check_srvids 1 2 3 14765
1486 </para>
1487 <para>
1488 Example output:
1489 </para>
1490 <screen format="linespecific">
1491 Server id 0:1 does not exist
1492 Server id 0:2 does not exist
1493 Server id 0:3 does not exist
1494 Server id 0:14765 exists
1495 </screen>
1496 </refsect2>
1498 </refsect1>
1500 <refsect1><title>SEE ALSO</title>
1501 <para>
1502 ctdbd(1), onnode(1)
1503 <ulink url="http://ctdb.samba.org/"/>
1504 </para>
1505 </refsect1>
1506 <refsect1><title>COPYRIGHT/LICENSE</title>
1507 <literallayout>
1508 Copyright (C) Andrew Tridgell 2007
1509 Copyright (C) Ronnie sahlberg 2007
1511 This program is free software; you can redistribute it and/or modify
1512 it under the terms of the GNU General Public License as published by
1513 the Free Software Foundation; either version 3 of the License, or (at
1514 your option) any later version.
1516 This program is distributed in the hope that it will be useful, but
1517 WITHOUT ANY WARRANTY; without even the implied warranty of
1518 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1519 General Public License for more details.
1521 You should have received a copy of the GNU General Public License
1522 along with this program; if not, see http://www.gnu.org/licenses/.
1523 </literallayout>
1524 </refsect1>
1525 </refentry>