| blob | a204583b62c60108740bdf36cdf20be48fbcb3fa |
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry
3 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
4 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
5 <refentry id="ctdb.1">
7 <refentryinfo>
8 <author>
9 <contrib>
10 This documentation was written by
11 Ronnie Sahlberg,
12 Amitay Isaacs,
13 Martin Schwenke
14 </contrib>
15 </author>
17 <copyright>
18 <year>2007</year>
19 <holder>Andrew Tridgell</holder>
20 <holder>Ronnie Sahlberg</holder>
21 </copyright>
22 <legalnotice>
23 <para>
24 This program is free software; you can redistribute it and/or
25 modify it under the terms of the GNU General Public License as
26 published by the Free Software Foundation; either version 3 of
27 the License, or (at your option) any later version.
28 </para>
29 <para>
30 This program is distributed in the hope that it will be
31 useful, but WITHOUT ANY WARRANTY; without even the implied
32 warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
33 PURPOSE. See the GNU General Public License for more details.
34 </para>
35 <para>
36 You should have received a copy of the GNU General Public
37 License along with this program; if not, see
38 <ulink url="http://www.gnu.org/licenses"/>.
39 </para>
40 </legalnotice>
41 </refentryinfo>
43 <refmeta>
44 <refentrytitle>ctdb</refentrytitle>
45 <manvolnum>1</manvolnum>
46 <refmiscinfo class="source">ctdb</refmiscinfo>
47 <refmiscinfo class="manual">CTDB - clustered TDB database</refmiscinfo>
48 </refmeta>
50 <refnamediv>
51 <refname>ctdb</refname>
52 <refpurpose>CTDB management utility</refpurpose>
53 </refnamediv>
55 <refsynopsisdiv>
56 <cmdsynopsis>
57 <command>ctdb</command>
58 <arg rep="repeat"><replaceable>OPTION</replaceable></arg>
59 <arg choice="req"><replaceable>COMMAND</replaceable></arg>
60 <arg choice="opt"><replaceable>COMMAND-ARGS</replaceable></arg>
61 </cmdsynopsis>
62 </refsynopsisdiv>
64 <refsect1>
65 <title>DESCRIPTION</title>
66 <para>
67 ctdb is a utility to view and manage a CTDB cluster.
68 </para>
70 <para>
71 The following terms are used when referring to nodes in a
72 cluster:
73 <variablelist>
74 <varlistentry>
75 <term>PNN</term>
76 <listitem>
77 <para>
78 Physical Node Number. The physical node number is an
79 integer that describes the node in the cluster. The
80 first node has physical node number 0. in a cluster.
81 </para>
82 </listitem>
83 </varlistentry>
84 <varlistentry>
85 <term>PNN-LIST</term>
86 <listitem>
87 <para>
88 This is either a single PNN, a comma-separate list of PNNs
89 or "all".
90 </para>
91 </listitem>
92 </varlistentry>
93 </variablelist>
94 </para>
96 <para>
97 Commands that reference a database use the following terms:
98 <variablelist>
99 <varlistentry>
100 <term>DB</term>
101 <listitem>
102 <para>
103 This is either a database name, such as
104 <filename>locking.tdb</filename> or a database ID such
105 as "0x42fe72c5".
106 </para>
107 </listitem>
108 </varlistentry>
109 <varlistentry>
110 <term>DB-LIST</term>
111 <listitem>
112 <para>
113 A space separated list of at least one
114 <parameter>DB</parameter>.
115 </para>
116 </listitem>
117 </varlistentry>
118 </variablelist>
119 </para>
120 </refsect1>
122 <refsect1>
123 <title>OPTIONS</title>
125 <variablelist>
126 <varlistentry><term>-n <parameter>PNN</parameter></term>
127 <listitem>
128 <para>
129 The node specified by PNN should be queried for the
130 requested information. Default is to query the daemon
131 running on the local host.
132 </para>
133 </listitem>
134 </varlistentry>
136 <varlistentry><term>-Y</term>
137 <listitem>
138 <para>
139 Produce output in machine readable form for easier parsing
140 by scripts. This uses a field delimiter of ':'. Not all
141 commands support this option.
142 </para>
143 </listitem>
144 </varlistentry>
146 <varlistentry><term>-x <parameter>SEPARATOR</parameter></term>
147 <listitem>
148 <para>
149 Use SEPARATOR to delimit fields in machine readable output.
150 This implies -Y.
151 </para>
152 </listitem>
153 </varlistentry>
155 <varlistentry><term>-X</term>
156 <listitem>
157 <para>
158 Produce output in machine readable form for easier parsing
159 by scripts. This uses a field delimiter of '|'. Not all
160 commands support this option.
161 </para>
162 <para>
163 This is equivalent to "-x|" and avoids some shell quoting
164 issues.
165 </para>
166 </listitem>
167 </varlistentry>
169 <varlistentry><term>-t <parameter>TIMEOUT</parameter></term>
170 <listitem>
171 <para>
172 Indicates that ctdb should wait up to TIMEOUT seconds for
173 a response to most commands sent to the CTDB daemon. The
174 default is 10 seconds.
175 </para>
176 </listitem>
177 </varlistentry>
179 <varlistentry><term>-T <parameter>TIMELIMIT</parameter></term>
180 <listitem>
181 <para>
182 Indicates that TIMELIMIT is the maximum run time (in
183 seconds) for the ctdb command. When TIMELIMIT is exceeded
184 the ctdb command will terminate with an error. The default
185 is 120 seconds.
186 </para>
187 </listitem>
188 </varlistentry>
190 <varlistentry><term>-? --help</term>
191 <listitem>
192 <para>
193 Print some help text to the screen.
194 </para>
195 </listitem>
196 </varlistentry>
198 <varlistentry><term>--usage</term>
199 <listitem>
200 <para>
201 Print usage information to the screen.
202 </para>
203 </listitem>
204 </varlistentry>
206 <varlistentry><term>-d --debug=<parameter>DEBUGLEVEL</parameter></term>
207 <listitem>
208 <para>
209 Change the debug level for the command. Default is NOTICE.
210 </para>
211 </listitem>
212 </varlistentry>
213 </variablelist>
214 </refsect1>
217 <refsect1>
218 <title>ADMINISTRATIVE COMMANDS</title>
219 <para>
220 These are commands used to monitor and administer a CTDB cluster.
221 </para>
223 <refsect2>
224 <title>pnn</title>
225 <para>
226 This command displays the PNN of the current node.
227 </para>
228 </refsect2>
230 <refsect2>
231 <title>status</title>
232 <para>
233 This command shows the current status of all CTDB nodes based
234 on information from the queried node.
235 </para>
237 <para>
238 Note: If the queried node is INACTIVE then the status
239 might not be current.
240 </para>
242 <refsect3>
243 <title>Node status</title>
244 <para>
245 This includes the number of physical nodes and the status of
246 each node. See <citerefentry><refentrytitle>ctdb</refentrytitle>
247 <manvolnum>7</manvolnum></citerefentry> for information
248 about node states.
249 </para>
250 </refsect3>
252 <refsect3>
253 <title>Generation</title>
254 <para>
255 The generation id is a number that indicates the current generation
256 of a cluster instance. Each time a cluster goes through a
257 reconfiguration or a recovery its generation id will be changed.
258 </para>
259 <para>
260 This number does not have any particular meaning other than
261 to keep track of when a cluster has gone through a
262 recovery. It is a random number that represents the current
263 instance of a ctdb cluster and its databases. The CTDB
264 daemon uses this number internally to be able to tell when
265 commands to operate on the cluster and the databases was
266 issued in a different generation of the cluster, to ensure
267 that commands that operate on the databases will not survive
268 across a cluster database recovery. After a recovery, all
269 old outstanding commands will automatically become invalid.
270 </para>
271 <para>
272 Sometimes this number will be shown as "INVALID". This only means that
273 the ctdbd daemon has started but it has not yet merged with the cluster through a recovery.
274 All nodes start with generation "INVALID" and are not assigned a real
275 generation id until they have successfully been merged with a cluster
276 through a recovery.
277 </para>
278 </refsect3>
280 <refsect3>
281 <title>Virtual Node Number (VNN) map</title>
282 <para>
283 Consists of the number of virtual nodes and mapping from
284 virtual node numbers to physical node numbers. Only nodes
285 that are participating in the VNN map can become lmaster for
286 database records.
287 </para>
288 </refsect3>
290 <refsect3>
291 <title>Recovery mode</title>
292 <para>
293 This is the current recovery mode of the cluster. There are two possible modes:
294 </para>
295 <para>
296 NORMAL - The cluster is fully operational.
297 </para>
298 <para>
299 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.
300 </para>
301 <para>
302 Once the recovery master detects an inconsistency, for example a node
303 becomes disconnected/connected, the recovery daemon will trigger a
304 cluster recovery process, where all databases are remerged across the
305 cluster. When this process starts, the recovery master will first
306 "freeze" all databases to prevent applications such as samba from
307 accessing the databases and it will also mark the recovery mode as
308 RECOVERY.
309 </para>
310 <para>
311 When the CTDB daemon starts up, it will start in RECOVERY
312 mode. Once the node has been merged into a cluster and all
313 databases have been recovered, the node mode will change into
314 NORMAL mode and the databases will be "thawed", allowing samba
315 to access the databases again.
316 </para>
317 </refsect3>
318 <refsect3>
319 <title>Recovery master</title>
320 <para>
321 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.
322 </para>
323 <para>
324 Only one node at a time can be the designated recovery master. Which
325 node is designated the recovery master is decided by an election
326 process in the recovery daemons running on each node.
327 </para>
328 </refsect3>
330 <refsect3>
331 <title>Example</title>
332 <screen>
333 # ctdb status
334 Number of nodes:4
335 pnn:0 192.168.2.200 OK (THIS NODE)
336 pnn:1 192.168.2.201 OK
337 pnn:2 192.168.2.202 OK
338 pnn:3 192.168.2.203 OK
339 Generation:1362079228
340 Size:4
341 hash:0 lmaster:0
342 hash:1 lmaster:1
343 hash:2 lmaster:2
344 hash:3 lmaster:3
345 Recovery mode:NORMAL (0)
346 Recovery master:0
347 </screen>
348 </refsect3>
349 </refsect2>
351 <refsect2>
352 <title>nodestatus <optional><parameter>PNN-LIST</parameter></optional></title>
353 <para>
354 This command is similar to the <command>status</command>
355 command. It displays the "node status" subset of output. The
356 main differences are:
357 </para>
359 <itemizedlist>
360 <listitem>
361 <para>
362 The exit code is the bitwise-OR of the flags for each
363 specified node, while <command>ctdb status</command> exits
364 with 0 if it was able to retrieve status for all nodes.
365 </para>
366 </listitem>
368 <listitem>
369 <para>
370 <command>ctdb status</command> provides status information
371 for all nodes. <command>ctdb nodestatus</command>
372 defaults to providing status for only the current node.
373 If PNN-LIST is provided then status is given for
374 the indicated node(s).
375 </para>
376 </listitem>
377 </itemizedlist>
379 <para>
380 A common invocation in scripts is <command>ctdb nodestatus
381 all</command> to check whether all nodes in a cluster are
382 healthy.
383 </para>
385 <refsect3>
386 <title>Example</title>
387 <screen>
388 # ctdb nodestatus
389 pnn:0 10.0.0.30 OK (THIS NODE)
391 # ctdb nodestatus all
392 Number of nodes:2
393 pnn:0 10.0.0.30 OK (THIS NODE)
394 pnn:1 10.0.0.31 OK
395 </screen>
396 </refsect3>
397 </refsect2>
399 <refsect2>
400 <title>recmaster</title>
401 <para>
402 This command shows the pnn of the node which is currently the recmaster.
403 </para>
405 <para>
406 Note: If the queried node is INACTIVE then the status
407 might not be current.
408 </para>
409 </refsect2>
411 <refsect2>
412 <title>uptime</title>
413 <para>
414 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.
415 </para>
417 <refsect3>
418 <title>Example</title>
419 <screen>
420 # ctdb uptime
421 Current time of node : Thu Oct 29 10:38:54 2009
422 Ctdbd start time : (000 16:54:28) Wed Oct 28 17:44:26 2009
423 Time of last recovery/failover: (000 16:53:31) Wed Oct 28 17:45:23 2009
424 Duration of last recovery/failover: 2.248552 seconds
425 </screen>
426 </refsect3>
427 </refsect2>
429 <refsect2>
430 <title>listnodes</title>
431 <para>
432 This command shows lists the ip addresses of all the nodes in the cluster.
433 </para>
435 <refsect3>
436 <title>Example</title>
437 <screen>
438 # ctdb listnodes
439 192.168.2.200
440 192.168.2.201
441 192.168.2.202
442 192.168.2.203
443 </screen>
444 </refsect3>
445 </refsect2>
447 <refsect2>
448 <title>natgw {master|list|status}</title>
449 <para>
450 This command shows different aspects of NAT gateway status.
451 For an overview of CTDB's NAT gateway functionality please see
452 the <citetitle>NAT GATEWAY</citetitle> section in
453 <citerefentry><refentrytitle>ctdb</refentrytitle>
454 <manvolnum>7</manvolnum></citerefentry>.
455 </para>
457 <variablelist>
458 <varlistentry>
459 <term>master</term>
460 <listitem>
461 <para>
462 Show the PNN and private IP address of the current NAT
463 gateway master node.
464 </para>
465 <para>
466 Example output:
467 </para>
468 <screen>
469 1 192.168.2.201
470 </screen>
471 </listitem>
472 </varlistentry>
473 <varlistentry>
474 <term>list</term>
475 <listitem>
476 <para>
477 List the private IP addresses of nodes in the current
478 NAT gateway group, annotating the master node.
479 </para>
480 <para>
481 Example output:
482 </para>
483 <screen>
484 192.168.2.200
485 192.168.2.201 MASTER
486 192.168.2.202
487 192.168.2.203
488 </screen>
489 </listitem>
490 </varlistentry>
491 <varlistentry>
492 <term>status</term>
493 <listitem>
494 <para>
495 List the nodes in the current NAT gateway group and
496 their status.
497 </para>
498 <para>
499 Example output:
500 </para>
501 <screen>
502 pnn:0 192.168.2.200 UNHEALTHY (THIS NODE)
503 pnn:1 192.168.2.201 OK
504 pnn:2 192.168.2.202 OK
505 pnn:3 192.168.2.203 OK
506 </screen>
507 </listitem>
508 </varlistentry>
509 </variablelist>
510 </refsect2>
512 <refsect2>
513 <title>ping</title>
514 <para>
515 This command will "ping" specified CTDB nodes in the cluster
516 to verify that they are running.
517 </para>
518 <refsect3>
519 <title>Example</title>
520 <screen>
521 # ctdb ping
522 response from 0 time=0.000054 sec (3 clients)
523 </screen>
524 </refsect3>
525 </refsect2>
527 <refsect2>
528 <title>ifaces</title>
529 <para>
530 This command will display the list of network interfaces, which could
531 host public addresses, along with their status.
532 </para>
533 <refsect3>
534 <title>Example</title>
535 <screen>
536 # ctdb ifaces
537 Interfaces on node 0
538 name:eth5 link:up references:2
539 name:eth4 link:down references:0
540 name:eth3 link:up references:1
541 name:eth2 link:up references:1
543 # ctdb -X ifaces
544 |Name|LinkStatus|References|
545 |eth5|1|2|
546 |eth4|0|0|
547 |eth3|1|1|
548 |eth2|1|1|
549 </screen>
550 </refsect3>
551 </refsect2>
553 <refsect2>
554 <title>ip</title>
555 <para>
556 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 all".
557 </para>
558 <refsect3>
559 <title>Example</title>
560 <screen>
561 # ctdb ip -v
562 Public IPs on node 0
563 172.31.91.82 node[1] active[] available[eth2,eth3] configured[eth2,eth3]
564 172.31.91.83 node[0] active[eth3] available[eth2,eth3] configured[eth2,eth3]
565 172.31.91.84 node[1] active[] available[eth2,eth3] configured[eth2,eth3]
566 172.31.91.85 node[0] active[eth2] available[eth2,eth3] configured[eth2,eth3]
567 172.31.92.82 node[1] active[] available[eth5] configured[eth4,eth5]
568 172.31.92.83 node[0] active[eth5] available[eth5] configured[eth4,eth5]
569 172.31.92.84 node[1] active[] available[eth5] configured[eth4,eth5]
570 172.31.92.85 node[0] active[eth5] available[eth5] configured[eth4,eth5]
572 # ctdb -X ip -v
573 |Public IP|Node|ActiveInterface|AvailableInterfaces|ConfiguredInterfaces|
574 |172.31.91.82|1||eth2,eth3|eth2,eth3|
575 |172.31.91.83|0|eth3|eth2,eth3|eth2,eth3|
576 |172.31.91.84|1||eth2,eth3|eth2,eth3|
577 |172.31.91.85|0|eth2|eth2,eth3|eth2,eth3|
578 |172.31.92.82|1||eth5|eth4,eth5|
579 |172.31.92.83|0|eth5|eth5|eth4,eth5|
580 |172.31.92.84|1||eth5|eth4,eth5|
581 |172.31.92.85|0|eth5|eth5|eth4,eth5|
582 </screen>
583 </refsect3>
584 </refsect2>
586 <refsect2>
587 <title>ipinfo <parameter>IP</parameter></title>
588 <para>
589 This command will display details about the specified public addresses.
590 </para>
591 <refsect3>
592 <title>Example</title>
593 <screen>
594 # ctdb ipinfo 172.31.92.85
595 Public IP[172.31.92.85] info on node 0
596 IP:172.31.92.85
597 CurrentNode:0
598 NumInterfaces:2
599 Interface[1]: Name:eth4 Link:down References:0
600 Interface[2]: Name:eth5 Link:up References:2 (active)
601 </screen>
602 </refsect3>
603 </refsect2>
605 <refsect2>
606 <title>event run|status|script list|script enable|script disable</title>
607 <para>
608 This command is used to control event daemon and to inspect
609 status of various events.
610 </para>
612 <para>
613 The commands below require a component to be specified. In
614 the current version the only valid component is
615 <literal>legacy</literal>.
616 </para>
618 <variablelist>
619 <varlistentry>
620 <term>run <parameter>TIMEOUT</parameter> <parameter>COMPONENT</parameter> <parameter>EVENT</parameter> <optional><parameter>ARGUMENTS</parameter></optional> </term>
621 <listitem>
622 <para>
623 This command can be used to manually run specified EVENT
624 in COMPONENT with optional ARGUMENTS. The event will be
625 allowed to run a maximum of TIMEOUT seconds. If TIMEOUT
626 is 0, then there is no time limit for running the event.
627 </para>
628 </listitem>
629 </varlistentry>
631 <varlistentry>
632 <term>status <parameter>COMPONENT</parameter> <parameter>EVENT</parameter></term>
633 <listitem>
634 <para>
635 This command displays the last execution status of the
636 specified EVENT in COMPONENT.
637 </para>
638 <para>
639 The command will terminate with the exit status
640 corresponding to the overall status of event that is
641 displayed.
642 </para>
643 <para>
644 The output is the list of event scripts executed.
645 Each line shows the name, status, duration and start time
646 for each script.
647 </para>
648 <para>
649 Example output:
650 </para>
651 <screen>
652 00.ctdb OK 0.014 Sat Dec 17 19:39:11 2016
653 01.reclock OK 0.013 Sat Dec 17 19:39:11 2016
654 05.system OK 0.029 Sat Dec 17 19:39:11 2016
655 06.nfs OK 0.014 Sat Dec 17 19:39:11 2016
656 10.interface OK 0.037 Sat Dec 17 19:39:11 2016
657 11.natgw OK 0.011 Sat Dec 17 19:39:11 2016
658 11.routing OK 0.007 Sat Dec 17 19:39:11 2016
659 13.per_ip_routing OK 0.007 Sat Dec 17 19:39:11 2016
660 20.multipathd OK 0.007 Sat Dec 17 19:39:11 2016
661 31.clamd OK 0.007 Sat Dec 17 19:39:11 2016
662 40.vsftpd OK 0.013 Sat Dec 17 19:39:11 2016
663 41.httpd OK 0.018 Sat Dec 17 19:39:11 2016
664 49.winbind OK 0.023 Sat Dec 17 19:39:11 2016
665 50.samba OK 0.100 Sat Dec 17 19:39:12 2016
666 60.nfs OK 0.376 Sat Dec 17 19:39:12 2016
667 70.iscsi OK 0.009 Sat Dec 17 19:39:12 2016
668 91.lvs OK 0.007 Sat Dec 17 19:39:12 2016
669 </screen>
670 </listitem>
671 </varlistentry>
673 <varlistentry>
674 <term>script list <parameter>COMPONENT</parameter></term>
675 <listitem>
676 <para>
677 List the available event scripts in COMPONENT. Enabled
678 scripts are flagged with a '*'.
679 </para>
680 <para>
681 Generally, event scripts are provided by CTDB. However,
682 local or 3rd party event scripts may also be available.
683 These are shown in a separate section after those
684 provided by CTDB.
685 </para>
686 <para>
687 Example output:
688 </para>
689 <screen>
690 * 00.ctdb
691 * 01.reclock
692 * 05.system
693 * 06.nfs
694 * 10.interface
695 11.natgw
696 11.routing
697 13.per_ip_routing
698 20.multipathd
699 31.clamd
700 40.vsftpd
701 41.httpd
702 * 49.winbind
703 * 50.samba
704 * 60.nfs
705 70.iscsi
706 91.lvs
708 * 02.local
709 </screen>
710 </listitem>
711 </varlistentry>
713 <varlistentry>
714 <term>script enable <parameter>COMPONENT</parameter> <parameter>SCRIPT</parameter></term>
715 <listitem>
716 <para>
717 Enable the specified event SCRIPT in COMPONENT. Only
718 enabled scripts will be executed when running any event.
719 </para>
720 </listitem>
721 </varlistentry>
723 <varlistentry>
724 <term>script disable <parameter>COMPONENT</parameter> <parameter>SCRIPT</parameter></term>
725 <listitem>
726 <para>
727 Disable the specified event SCRIPT in COMPONENT. This
728 will prevent the script from executing when running any
729 event.
730 </para>
731 </listitem>
732 </varlistentry>
733 </variablelist>
734 </refsect2>
736 <refsect2>
737 <title>scriptstatus</title>
738 <para>
739 This command displays which event scripts where run in the previous
740 monitoring cycle and the result of each script. If a script
741 failed with an error, causing the node to become unhealthy,
742 the output from that script is also shown.
743 </para>
744 <para>
745 This command is deprecated. It's provided for backward
746 compatibility. In place of <command>ctdb scriptstatus</command>,
747 use <command>ctdb event status</command>.
748 </para>
749 <refsect3>
750 <title>Example</title>
751 <screen>
752 # ctdb scriptstatus
753 00.ctdb OK 0.011 Sat Dec 17 19:40:46 2016
754 01.reclock OK 0.010 Sat Dec 17 19:40:46 2016
755 05.system OK 0.030 Sat Dec 17 19:40:46 2016
756 06.nfs OK 0.014 Sat Dec 17 19:40:46 2016
757 10.interface OK 0.041 Sat Dec 17 19:40:46 2016
758 11.natgw OK 0.008 Sat Dec 17 19:40:46 2016
759 11.routing OK 0.007 Sat Dec 17 19:40:46 2016
760 13.per_ip_routing OK 0.007 Sat Dec 17 19:40:46 2016
761 20.multipathd OK 0.007 Sat Dec 17 19:40:46 2016
762 31.clamd OK 0.007 Sat Dec 17 19:40:46 2016
763 40.vsftpd OK 0.013 Sat Dec 17 19:40:46 2016
764 41.httpd OK 0.015 Sat Dec 17 19:40:46 2016
765 49.winbind OK 0.022 Sat Dec 17 19:40:46 2016
766 50.samba ERROR 0.077 Sat Dec 17 19:40:46 2016
767 OUTPUT: ERROR: samba tcp port 445 is not responding
768 </screen>
769 </refsect3>
770 </refsect2>
772 <refsect2>
773 <title>listvars</title>
774 <para>
775 List all tuneable variables, except the values of the obsolete tunables
776 like VacuumMinInterval. The obsolete tunables can be retrieved only
777 explicitly with the "ctdb getvar" command.
778 </para>
779 <refsect3>
780 <title>Example</title>
781 <screen>
782 # ctdb listvars
783 SeqnumInterval = 1000
784 ControlTimeout = 60
785 TraverseTimeout = 20
786 KeepaliveInterval = 5
787 KeepaliveLimit = 5
788 RecoverTimeout = 120
789 RecoverInterval = 1
790 ElectionTimeout = 3
791 TakeoverTimeout = 9
792 MonitorInterval = 15
793 TickleUpdateInterval = 20
794 EventScriptTimeout = 30
795 MonitorTimeoutCount = 20
796 RecoveryGracePeriod = 120
797 RecoveryBanPeriod = 300
798 DatabaseHashSize = 100001
799 DatabaseMaxDead = 5
800 RerecoveryTimeout = 10
801 EnableBans = 1
802 NoIPFailback = 0
803 VerboseMemoryNames = 0
804 RecdPingTimeout = 60
805 RecdFailCount = 10
806 LogLatencyMs = 0
807 RecLockLatencyMs = 1000
808 RecoveryDropAllIPs = 120
809 VacuumInterval = 10
810 VacuumMaxRunTime = 120
811 RepackLimit = 10000
812 VacuumFastPathCount = 60
813 MaxQueueDropMsg = 1000000
814 AllowUnhealthyDBRead = 0
815 StatHistoryInterval = 1
816 DeferredAttachTO = 120
817 AllowClientDBAttach = 1
818 RecoverPDBBySeqNum = 1
819 DeferredRebalanceOnNodeAdd = 300
820 FetchCollapse = 1
821 HopcountMakeSticky = 50
822 StickyDuration = 600
823 StickyPindown = 200
824 NoIPTakeover = 0
825 DBRecordCountWarn = 100000
826 DBRecordSizeWarn = 10000000
827 DBSizeWarn = 100000000
828 PullDBPreallocation = 10485760
829 LockProcessesPerDB = 200
830 RecBufferSizeLimit = 1000000
831 QueueBufferSize = 1024
832 IPAllocAlgorithm = 2
833 </screen>
834 </refsect3>
835 </refsect2>
837 <refsect2>
838 <title>getvar <parameter>NAME</parameter></title>
839 <para>
840 Get the runtime value of a tuneable variable.
841 </para>
842 <refsect3>
843 <title>Example</title>
844 <screen>
845 # ctdb getvar MonitorInterval
846 MonitorInterval = 15
847 </screen>
848 </refsect3>
849 </refsect2>
851 <refsect2>
852 <title>setvar <parameter>NAME</parameter> <parameter>VALUE</parameter></title>
853 <para>
854 Set the runtime value of a tuneable variable.
855 </para>
856 <refsect3>
857 <title>Example</title>
858 <screen>
859 # ctdb setvar MonitorInterval 20
860 </screen>
861 </refsect3>
862 </refsect2>
864 <refsect2>
865 <title>lvs {master|list|status}</title>
866 <para>
867 This command shows different aspects of LVS status. For an
868 overview of CTDB's LVS functionality please see the
869 <citetitle>LVS</citetitle> section in
870 <citerefentry><refentrytitle>ctdb</refentrytitle>
871 <manvolnum>7</manvolnum></citerefentry>.
872 </para>
874 <variablelist>
875 <varlistentry>
876 <term>master</term>
877 <listitem>
878 <para>
879 Shows the PNN of the current LVS master node.
880 </para>
881 <para>
882 Example output:
883 </para>
884 <screen>
885 2
886 </screen>
887 </listitem>
888 </varlistentry>
889 <varlistentry>
890 <term>list</term>
891 <listitem>
892 <para>
893 Lists the currently usable LVS nodes.
894 </para>
895 <para>
896 Example output:
897 </para>
898 <screen>
899 2 10.0.0.13
900 3 10.0.0.14
901 </screen>
902 </listitem>
903 </varlistentry>
904 <varlistentry>
905 <term>status</term>
906 <listitem>
907 <para>
908 List the nodes in the current LVS group and their status.
909 </para>
910 <para>
911 Example output:
912 </para>
913 <screen>
914 pnn:0 10.0.0.11 UNHEALTHY (THIS NODE)
915 pnn:1 10.0.0.12 UNHEALTHY
916 pnn:2 10.0.0.13 OK
917 pnn:3 10.0.0.14 OK
918 </screen>
919 </listitem>
920 </varlistentry>
921 </variablelist>
923 </refsect2>
926 <refsect2>
927 <title>getcapabilities</title>
929 <para>
930 This command shows the capabilities of the current node. See
931 the <citetitle>CAPABILITIES</citetitle> section in
932 <citerefentry><refentrytitle>ctdb</refentrytitle>
933 <manvolnum>7</manvolnum></citerefentry> for more details.
934 </para>
936 <para>
937 Example output:
938 </para>
939 <screen>
940 RECMASTER: YES
941 LMASTER: YES
942 </screen>
944 </refsect2>
946 <refsect2>
947 <title>statistics</title>
948 <para>
949 Collect statistics from the CTDB daemon about
950 how many calls it has served. Information about
951 various fields in statistics can be found in
952 <citerefentry><refentrytitle>ctdb-statistics</refentrytitle>
953 <manvolnum>7</manvolnum></citerefentry>.
954 </para>
955 <refsect3>
956 <title>Example</title>
957 <screen>
958 # ctdb statistics
959 CTDB version 1
960 Current time of statistics : Tue Mar 8 15:18:51 2016
961 Statistics collected since : (003 21:31:32) Fri Mar 4 17:47:19 2016
962 num_clients 9
963 frozen 0
964 recovering 0
965 num_recoveries 2
966 client_packets_sent 8170534
967 client_packets_recv 7166132
968 node_packets_sent 16549998
969 node_packets_recv 5244418
970 keepalive_packets_sent 201969
971 keepalive_packets_recv 201969
972 node
973 req_call 26
974 reply_call 0
975 req_dmaster 9
976 reply_dmaster 12
977 reply_error 0
978 req_message 1339231
979 req_control 8177506
980 reply_control 6831284
981 client
982 req_call 15
983 req_message 334809
984 req_control 6831308
985 timeouts
986 call 0
987 control 0
988 traverse 0
989 locks
990 num_calls 8
991 num_current 0
992 num_pending 0
993 num_failed 0
994 total_calls 15
995 pending_calls 0
996 childwrite_calls 0
997 pending_childwrite_calls 0
998 memory_used 394879
999 max_hop_count 1
1000 total_ro_delegations 0
1001 total_ro_revokes 0
1002 hop_count_buckets: 8 5 0 0 0 0 0 0 0 0 0 0 0 0 0 0
1003 lock_buckets: 0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0
1004 locks_latency MIN/AVG/MAX 0.010005/0.010418/0.011010 sec out of 8
1005 reclock_ctdbd MIN/AVG/MAX 0.002538/0.002538/0.002538 sec out of 1
1006 reclock_recd MIN/AVG/MAX 0.000000/0.000000/0.000000 sec out of 0
1007 call_latency MIN/AVG/MAX 0.000044/0.002142/0.011702 sec out of 15
1008 childwrite_latency MIN/AVG/MAX 0.000000/0.000000/0.000000 sec out of 0
1009 </screen>
1010 </refsect3>
1011 </refsect2>
1013 <refsect2>
1014 <title>statisticsreset</title>
1015 <para>
1016 This command is used to clear all statistics counters in a node.
1017 </para>
1018 <para>
1019 Example: ctdb statisticsreset
1020 </para>
1021 </refsect2>
1023 <refsect2>
1024 <title>dbstatistics <parameter>DB</parameter></title>
1025 <para>
1026 Display statistics about the database DB. Information
1027 about various fields in dbstatistics can be found in
1028 <citerefentry><refentrytitle>ctdb-statistics</refentrytitle>
1029 <manvolnum>7</manvolnum></citerefentry>.
1030 </para>
1031 <refsect3>
1032 <title>Example</title>
1033 <screen>
1034 # ctdb dbstatistics locking.tdb
1035 DB Statistics: locking.tdb
1036 ro_delegations 0
1037 ro_revokes 0
1038 locks
1039 total 14356
1040 failed 0
1041 current 0
1042 pending 0
1043 hop_count_buckets: 28087 2 1 0 0 0 0 0 0 0 0 0 0 0 0 0
1044 lock_buckets: 0 14188 38 76 32 19 3 0 0 0 0 0 0 0 0 0
1045 locks_latency MIN/AVG/MAX 0.001066/0.012686/4.202292 sec out of 14356
1046 vacuum_latency MIN/AVG/MAX 0.000472/0.002207/15.243570 sec out of 224530
1047 Num Hot Keys: 1
1048 Count:8 Key:ff5bd7cb3ee3822edc1f0000000000000000000000000000
1049 </screen>
1050 </refsect3>
1051 </refsect2>
1053 <refsect2>
1054 <title>getreclock</title>
1055 <para>
1056 Show details of the recovery lock, if any.
1057 </para>
1059 <para>
1060 Example output:
1061 </para>
1062 <screen>
1063 /clusterfs/.ctdb/recovery.lock
1064 </screen>
1066 </refsect2>
1068 <refsect2>
1069 <title>getdebug</title>
1070 <para>
1071 Get the current debug level for the node. the debug level controls what information is written to the log file.
1072 </para>
1073 <para>
1074 The debug levels are mapped to the corresponding syslog levels.
1075 When a debug level is set, only those messages at that level and higher
1076 levels will be printed.
1077 </para>
1078 <para>
1079 The list of debug levels from highest to lowest are :
1080 </para>
1081 <para>
1082 ERROR WARNING NOTICE INFO DEBUG
1083 </para>
1084 </refsect2>
1086 <refsect2>
1087 <title>setdebug <parameter>DEBUGLEVEL</parameter></title>
1088 <para>
1089 Set the debug level of a node. This controls what information will be logged.
1090 </para>
1091 <para>
1092 The debuglevel is one of ERROR WARNING NOTICE INFO DEBUG
1093 </para>
1094 </refsect2>
1096 <refsect2>
1097 <title>getpid</title>
1098 <para>
1099 This command will return the process id of the ctdb daemon.
1100 </para>
1101 </refsect2>
1103 <refsect2>
1104 <title>disable</title>
1105 <para>
1106 This command is used to administratively disable a node in the cluster.
1107 A disabled node will still participate in the cluster and host
1108 clustered TDB records but its public ip address has been taken over by
1109 a different node and it no longer hosts any services.
1110 </para>
1111 </refsect2>
1113 <refsect2>
1114 <title>enable</title>
1115 <para>
1116 Re-enable a node that has been administratively disabled.
1117 </para>
1118 </refsect2>
1120 <refsect2>
1121 <title>stop</title>
1122 <para>
1123 This command is used to administratively STOP a node in the cluster.
1124 A STOPPED node is connected to the cluster but will not host any
1125 public ip addresse, nor does it participate in the VNNMAP.
1126 The difference between a DISABLED node and a STOPPED node is that
1127 a STOPPED node does not host any parts of the database which means
1128 that a recovery is required to stop/continue nodes.
1129 </para>
1130 </refsect2>
1132 <refsect2>
1133 <title>continue</title>
1134 <para>
1135 Re-start a node that has been administratively stopped.
1136 </para>
1137 </refsect2>
1139 <refsect2>
1140 <title>addip <parameter>IPADDR</parameter>/<parameter>mask</parameter> <parameter>IFACE</parameter></title>
1141 <para>
1142 This command is used to add a new public ip to a node
1143 during runtime. It should be followed by a <command>ctdb
1144 ipreallocate</command>. This allows public addresses to be
1145 added to a cluster without having to restart the ctdb daemons.
1146 </para>
1147 <para>
1148 Note that this only updates the runtime instance of ctdb. Any
1149 changes will be lost next time ctdb is restarted and the public
1150 addresses file is re-read. If you want this change to be
1151 permanent you must also update the public addresses file manually.
1152 </para>
1153 </refsect2>
1155 <refsect2>
1156 <title>delip <parameter>IPADDR</parameter></title>
1157 <para>
1158 This command flags IPADDR for deletion from a node at runtime.
1159 It should be followed by a <command>ctdb
1160 ipreallocate</command>. If IPADDR is currently hosted by the
1161 node it is being removed from, this ensures that the IP will
1162 first be failed over to another node, if possible, and that it
1163 is then actually removed.
1164 </para>
1165 <para>
1166 Note that this only updates the runtime instance of CTDB. Any
1167 changes will be lost next time CTDB is restarted and the
1168 public addresses file is re-read. If you want this change to
1169 be permanent you must also update the public addresses file
1170 manually.
1171 </para>
1172 </refsect2>
1174 <refsect2>
1175 <title>moveip <parameter>IPADDR</parameter> <parameter>PNN</parameter></title>
1176 <para>
1177 This command can be used to manually fail a public ip address to a
1178 specific node.
1179 </para>
1180 <para>
1181 In order to manually override the "automatic" distribution of public
1182 ip addresses that ctdb normally provides, this command only works
1183 when you have changed the tunables for the daemon to:
1184 </para>
1185 <para>
1186 IPAllocAlgorithm != 0
1187 </para>
1188 <para>
1189 NoIPFailback = 1
1190 </para>
1191 </refsect2>
1193 <refsect2>
1194 <title>shutdown</title>
1195 <para>
1196 This command will shutdown a specific CTDB daemon.
1197 </para>
1198 </refsect2>
1200 <refsect2>
1201 <title>setlmasterrole on|off</title>
1202 <para>
1203 This command is used to 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.
1204 </para>
1206 <para>
1207 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.
1208 </para>
1209 <para>
1210 Once this setting has been enabled/disabled, you need to perform a recovery for it to take effect.
1211 </para>
1212 <para>
1213 See also "ctdb getcapabilities"
1214 </para>
1215 </refsect2>
1217 <refsect2>
1218 <title>setrecmasterrole on|off</title>
1219 <para>
1220 This command is used to 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.
1221 </para>
1223 <para>
1224 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.
1225 </para>
1226 <para>
1227 See also "ctdb getcapabilities"
1228 </para>
1229 </refsect2>
1231 <refsect2>
1232 <title>reloadnodes</title>
1233 <para>
1234 This command is used when adding new nodes, or removing
1235 existing nodes from an existing cluster.
1236 </para>
1237 <para>
1238 Procedure to add nodes:
1239 </para>
1240 <orderedlist>
1241 <listitem>
1242 <para>
1243 To expand an existing cluster, first ensure with
1244 <command>ctdb status</command> that all nodes are up and
1245 running and that they are all healthy. Do not try to
1246 expand a cluster unless it is completely healthy!
1247 </para>
1248 </listitem>
1249 <listitem>
1250 <para>
1251 On all nodes, edit <filename>/usr/local/etc/ctdb/nodes</filename>
1252 and <emphasis>add the new nodes at the end of this
1253 file</emphasis>.
1254 </para>
1255 </listitem>
1256 <listitem>
1257 <para>
1258 Verify that all the nodes have identical
1259 <filename>/usr/local/etc/ctdb/nodes</filename> files after adding
1260 the new nodes.
1261 </para>
1262 </listitem>
1263 <listitem>
1264 <para>
1265 Run <command>ctdb reloadnodes</command> to force all nodes
1266 to reload the nodes file.
1267 </para>
1268 </listitem>
1269 <listitem>
1270 <para>
1271 Use <command>ctdb status</command> on all nodes and verify
1272 that they now show the additional nodes.
1273 </para>
1274 </listitem>
1275 <listitem>
1276 <para>
1277 Install and configure the new node and bring it online.
1278 </para>
1279 </listitem>
1280 </orderedlist>
1281 <para>
1282 Procedure to remove nodes:
1283 </para>
1284 <orderedlist>
1285 <listitem>
1286 <para>
1287 To remove nodes from an existing cluster, first ensure
1288 with <command>ctdb status</command> that all nodes, except
1289 the node to be deleted, are up and running and that they
1290 are all healthy. Do not try to remove nodes from a
1291 cluster unless the cluster is completely healthy!
1292 </para>
1293 </listitem>
1294 <listitem>
1295 <para>
1296 Shutdown and power off the node to be removed.
1297 </para>
1298 </listitem>
1299 <listitem>
1300 <para>
1301 On all other nodes, edit the
1302 <filename>/usr/local/etc/ctdb/nodes</filename> file and
1303 <emphasis>comment out</emphasis> the nodes to be removed.
1304 <emphasis>Do not delete the lines for the deleted
1305 nodes</emphasis>, just comment them out by adding a '#' at
1306 the beginning of the lines.
1307 </para>
1308 </listitem>
1309 <listitem>
1310 <para>
1311 Run <command>ctdb reloadnodes</command> to force all nodes
1312 to reload the nodes file.
1313 </para>
1314 </listitem>
1315 <listitem>
1316 <para>
1317 Use <command>ctdb status</command> on all nodes and verify
1318 that the deleted nodes are no longer listed.
1319 </para>
1320 </listitem>
1321 </orderedlist>
1323 </refsect2>
1325 <refsect2>
1326 <title>
1327 reloadips
1328 <optional><parameter>PNN-LIST</parameter></optional>
1329 </title>
1330 <para>
1331 This command reloads the public addresses configuration file
1332 on the specified nodes. When it completes addresses will be
1333 reconfigured and reassigned across the cluster as necessary.
1334 </para>
1336 <para>
1337 This command is currently unable to make changes to the
1338 netmask or interfaces associated with existing addresses.
1339 Such changes must be made in 2 steps by deleting addresses in
1340 question and re-adding then. Unfortunately this will disrupt
1341 connections to the changed addresses.
1342 </para>
1343 </refsect2>
1345 <refsect2>
1346 <title>getdbmap</title>
1347 <para>
1348 This command lists all clustered TDB databases that the CTDB
1349 daemon has attached to. Some databases are flagged as PERSISTENT,
1350 this means that the database stores data persistently and the
1351 data will remain across reboots. One example of such a database
1352 is secrets.tdb where information about how the cluster was joined
1353 to the domain is stored. Some database are flagged as REPLICATED,
1354 this means that the data in that database is replicated across all
1355 the nodes. But the data will not remain across reboots. This
1356 type of database is used by CTDB to store it's internal state.
1357 </para>
1358 <para>
1359 If a PERSISTENT database is not in a healthy state the database
1360 is flagged as UNHEALTHY. If there's at least one completely
1361 healthy node running in the cluster, it's possible that the
1362 content is restored by a recovery run automatically. Otherwise an
1363 administrator needs to analyze the problem.
1364 </para>
1365 <para>
1366 See also "ctdb getdbstatus", "ctdb backupdb", "ctdb restoredb",
1367 "ctdb dumpbackup", "ctdb wipedb", "ctdb setvar AllowUnhealthyDBRead 1"
1368 and (if samba or tdb-utils are installed) "tdbtool check".
1369 </para>
1370 <para>
1371 Most databases are not persistent and only store the state
1372 information that the currently running samba daemons need. These
1373 databases are always wiped when ctdb/samba starts and when a
1374 node is rebooted.
1375 </para>
1377 <refsect3>
1378 <title>Example</title>
1379 <screen>
1380 # ctdb getdbmap
1381 Number of databases:10
1382 dbid:0x435d3410 name:notify.tdb path:/usr/local/var/lib/ctdb/notify.tdb.0
1383 dbid:0x42fe72c5 name:locking.tdb path:/usr/local/var/lib/ctdb/locking.tdb.0
1384 dbid:0x1421fb78 name:brlock.tdb path:/usr/local/var/lib/ctdb/brlock.tdb.0
1385 dbid:0x17055d90 name:connections.tdb path:/usr/local/var/lib/ctdb/connections.tdb.0
1386 dbid:0xc0bdde6a name:sessionid.tdb path:/usr/local/var/lib/ctdb/sessionid.tdb.0
1387 dbid:0x122224da name:test.tdb path:/usr/local/var/lib/ctdb/test.tdb.0
1388 dbid:0x2672a57f name:idmap2.tdb path:/usr/local/var/lib/ctdb/persistent/idmap2.tdb.0 PERSISTENT
1389 dbid:0xb775fff6 name:secrets.tdb path:/usr/local/var/lib/ctdb/persistent/secrets.tdb.0 PERSISTENT
1390 dbid:0xe98e08b6 name:group_mapping.tdb path:/usr/local/var/lib/ctdb/persistent/group_mapping.tdb.0 PERSISTENT
1391 dbid:0x7bbbd26c name:passdb.tdb path:/usr/local/var/lib/ctdb/persistent/passdb.tdb.0 PERSISTENT
1393 # ctdb getdbmap # example for unhealthy database
1394 Number of databases:1
1395 dbid:0xb775fff6 name:secrets.tdb path:/usr/local/var/lib/ctdb/persistent/secrets.tdb.0 PERSISTENT UNHEALTHY
1397 # ctdb -X getdbmap
1398 |ID|Name|Path|Persistent|Unhealthy|
1399 |0x7bbbd26c|passdb.tdb|/usr/local/var/lib/ctdb/persistent/passdb.tdb.0|1|0|
1400 </screen>
1401 </refsect3>
1402 </refsect2>
1404 <refsect2>
1405 <title>
1406 backupdb
1407 <parameter>DB</parameter>
1408 <parameter>FILE</parameter>
1409 </title>
1410 <para>
1411 Copy the contents of database DB to FILE. FILE can later be
1412 read back using <command>restoredb</command>. This is mainly
1413 useful for backing up persistent databases such as
1414 <filename>secrets.tdb</filename> and similar.
1415 </para>
1416 </refsect2>
1418 <refsect2>
1419 <title>
1420 restoredb
1421 <parameter>FILE</parameter>
1422 <optional><parameter>DB</parameter></optional>
1423 </title>
1424 <para>
1425 This command restores a persistent database that was
1426 previously backed up using backupdb. By default the data will
1427 be restored back into the same database as it was created
1428 from. By specifying dbname you can restore the data into a
1429 different database.
1430 </para>
1431 </refsect2>
1433 <refsect2>
1434 <title>setdbreadonly <parameter>DB</parameter></title>
1435 <para>
1436 This command will enable the read-only record support for a
1437 database. This is an experimental feature to improve
1438 performance for contended records primarily in locking.tdb and
1439 brlock.tdb. When enabling this feature you must set it on all
1440 nodes in the cluster.
1441 </para>
1442 </refsect2>
1444 <refsect2>
1445 <title>setdbsticky <parameter>DB</parameter></title>
1446 <para>
1447 This command will enable the sticky record support for the
1448 specified database. This is an experimental feature to
1449 improve performance for contended records primarily in
1450 locking.tdb and brlock.tdb. When enabling this feature you
1451 must set it on all nodes in the cluster.
1452 </para>
1453 </refsect2>
1455 </refsect1>
1457 <refsect1>
1458 <title>INTERNAL COMMANDS</title>
1460 <para>
1461 Internal commands are used by CTDB's scripts and are not
1462 required for managing a CTDB cluster. Their parameters and
1463 behaviour are subject to change.
1464 </para>
1466 <refsect2>
1467 <title>gettickles <parameter>IPADDR</parameter></title>
1468 <para>
1469 Show TCP connections that are registered with CTDB to be
1470 "tickled" if there is a failover.
1471 </para>
1472 </refsect2>
1474 <refsect2>
1475 <title>gratarp <parameter>IPADDR</parameter> <parameter>INTERFACE</parameter></title>
1476 <para>
1477 Send out a gratuitous ARP for the specified interface through
1478 the specified interface. This command is mainly used by the
1479 ctdb eventscripts.
1480 </para>
1481 </refsect2>
1483 <refsect2>
1484 <title>
1485 pdelete <parameter>DB</parameter> <parameter>KEY</parameter>
1486 </title>
1487 <para>
1488 Delete KEY from DB.
1489 </para>
1490 </refsect2>
1492 <refsect2>
1493 <title>
1494 pfetch <parameter>DB</parameter> <parameter>KEY</parameter>
1495 </title>
1496 <para>
1497 Print the value associated with KEY in DB.
1498 </para>
1499 </refsect2>
1501 <refsect2>
1502 <title>
1503 pstore
1504 <parameter>DB</parameter>
1505 <parameter>KEY</parameter>
1506 <parameter>FILE</parameter>
1507 </title>
1508 <para>
1509 Store KEY in DB with contents of FILE as the associated value.
1510 </para>
1511 </refsect2>
1513 <refsect2>
1514 <title>
1515 ptrans
1516 <parameter>DB</parameter>
1517 <optional><parameter>FILE</parameter></optional>
1518 </title>
1519 <para>
1520 Read a list of key-value pairs, one per line from FILE, and
1521 store them in DB using a single transaction. An empty value
1522 is equivalent to deleting the given key.
1523 </para>
1524 <para>
1525 The key and value should be separated by spaces or tabs. Each
1526 key/value should be a printable string enclosed in
1527 double-quotes.
1528 </para>
1529 </refsect2>
1531 <refsect2>
1532 <title>runstate [setup|first_recovery|startup|running]</title>
1533 <para>
1534 Print the runstate of the specified node. Runstates are used
1535 to serialise important state transitions in CTDB, particularly
1536 during startup.
1537 </para>
1538 <para>
1539 If one or more optional runstate arguments are specified then
1540 the node must be in one of these runstates for the command to
1541 succeed.
1542 </para>
1543 <refsect3>
1544 <title>Example</title>
1545 <screen>
1546 # ctdb runstate
1547 RUNNING
1548 </screen>
1549 </refsect3>
1550 </refsect2>
1552 <refsect2>
1553 <title>setifacelink <parameter>IFACE</parameter> up|down</title>
1554 <para>
1555 Set the internal state of network interface IFACE. This is
1556 typically used in the <filename>10.interface</filename> script
1557 in the "monitor" event.
1558 </para>
1559 <para>
1560 Example: ctdb setifacelink eth0 up
1561 </para>
1562 </refsect2>
1564 <refsect2>
1565 <title>tickle</title>
1566 <para>
1567 Read a list of TCP connections, one per line, from standard
1568 input and send a TCP tickle to the source host for each
1569 connection. A connection is specified as:
1570 </para>
1571 <synopsis>
1572 <parameter>SRC-IPADDR</parameter>:<parameter>SRC-PORT</parameter> <parameter>DST-IPADDR</parameter>:<parameter>DST-PORT</parameter>
1573 </synopsis>
1574 <para>
1575 A single connection can be specified on the command-line
1576 rather than on standard input.
1577 </para>
1578 <para>
1579 A TCP tickle is a TCP ACK packet with an invalid sequence and
1580 acknowledge number and will when received by the source host
1581 result in it sending an immediate correct ACK back to the
1582 other end.
1583 </para>
1584 <para>
1585 TCP tickles are useful to "tickle" clients after a IP failover has
1586 occurred since this will make the client immediately recognize the
1587 TCP connection has been disrupted and that the client will need
1588 to reestablish. This greatly speeds up the time it takes for a client
1589 to detect and reestablish after an IP failover in the ctdb cluster.
1590 </para>
1591 </refsect2>
1593 <refsect2>
1594 <title>version</title>
1595 <para>
1596 Display the CTDB version.
1597 </para>
1598 </refsect2>
1600 </refsect1>
1602 <refsect1>
1603 <title>DEBUGGING COMMANDS</title>
1604 <para>
1605 These commands are primarily used for CTDB development and testing and
1606 should not be used for normal administration.
1607 </para>
1610 <refsect2>
1611 <title>OPTIONS</title>
1613 <variablelist>
1614 <varlistentry><term>--print-emptyrecords</term>
1615 <listitem>
1616 <para>
1617 This enables printing of empty records when dumping databases
1618 with the catdb, cattbd and dumpdbbackup commands. Records with
1619 empty data segment are considered deleted by ctdb and cleaned
1620 by the vacuuming mechanism, so this switch can come in handy for
1621 debugging the vacuuming behaviour.
1622 </para>
1623 </listitem>
1624 </varlistentry>
1626 <varlistentry><term>--print-datasize</term>
1627 <listitem>
1628 <para>
1629 This lets database dumps (catdb, cattdb, dumpdbbackup) print the
1630 size of the record data instead of dumping the data contents.
1631 </para>
1632 </listitem>
1633 </varlistentry>
1635 <varlistentry><term>--print-lmaster</term>
1636 <listitem>
1637 <para>
1638 This lets catdb print the lmaster for each record.
1639 </para>
1640 </listitem>
1641 </varlistentry>
1643 <varlistentry><term>--print-hash</term>
1644 <listitem>
1645 <para>
1646 This lets database dumps (catdb, cattdb, dumpdbbackup) print the
1647 hash for each record.
1648 </para>
1649 </listitem>
1650 </varlistentry>
1652 <varlistentry><term>--print-recordflags</term>
1653 <listitem>
1654 <para>
1655 This lets catdb and dumpdbbackup print the
1656 record flags for each record. Note that cattdb always
1657 prints the flags.
1658 </para>
1659 </listitem>
1660 </varlistentry>
1662 </variablelist>
1663 </refsect2>
1665 <refsect2>
1666 <title>process-exists <parameter>PID</parameter> <parameter>[SRVID]</parameter></title>
1667 <para>
1668 This command checks if a specific process exists on the CTDB
1669 host. This is mainly used by Samba to check if remote instances
1670 of samba are still running or not. When the optional SRVID
1671 argument is specified, the command check if a specific process
1672 exists on the CTDB host and has registered for specified SRVID.
1673 </para>
1674 </refsect2>
1676 <refsect2>
1677 <title>getdbstatus <parameter>DB</parameter></title>
1678 <para>
1679 This command displays more details about a database.
1680 </para>
1681 <refsect3>
1682 <title>Example</title>
1683 <screen>
1684 # ctdb getdbstatus test.tdb.0
1685 dbid: 0x122224da
1686 name: test.tdb
1687 path: /usr/local/var/lib/ctdb/test.tdb.0
1688 PERSISTENT: no
1689 HEALTH: OK
1691 # ctdb getdbstatus registry.tdb # with a corrupted TDB
1692 dbid: 0xf2a58948
1693 name: registry.tdb
1694 path: /usr/local/var/lib/ctdb/persistent/registry.tdb.0
1695 PERSISTENT: yes
1696 HEALTH: NO-HEALTHY-NODES - ERROR - Backup of corrupted TDB in '/usr/local/var/lib/ctdb/persistent/registry.tdb.0.corrupted.20091208091949.0Z'
1697 </screen>
1698 </refsect3>
1699 </refsect2>
1701 <refsect2>
1702 <title>catdb <parameter>DB</parameter></title>
1703 <para>
1704 Print a dump of the clustered TDB database DB.
1705 </para>
1706 </refsect2>
1708 <refsect2>
1709 <title>cattdb <parameter>DB</parameter></title>
1710 <para>
1711 Print a dump of the contents of the local TDB database DB.
1712 </para>
1713 </refsect2>
1715 <refsect2>
1716 <title>dumpdbbackup <parameter>FILE</parameter></title>
1717 <para>
1718 Print a dump of the contents from database backup FILE,
1719 similar to <command>catdb</command>.
1720 </para>
1721 </refsect2>
1723 <refsect2>
1724 <title>wipedb <parameter>DB</parameter></title>
1725 <para>
1726 Remove all contents of database DB.
1727 </para>
1728 </refsect2>
1730 <refsect2>
1731 <title>recover</title>
1732 <para>
1733 This command will trigger the recovery daemon to do a cluster
1734 recovery.
1735 </para>
1736 </refsect2>
1738 <refsect2>
1739 <title>ipreallocate, sync</title>
1740 <para>
1741 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.
1742 </para>
1743 </refsect2>
1745 <refsect2>
1746 <title>attach <parameter>DBNAME</parameter> [persistent|replicated]</title>
1747 <para>
1748 Create a new CTDB database called DBNAME and attach to it on
1749 all nodes.
1750 </para>
1751 </refsect2>
1753 <refsect2>
1754 <title>detach <parameter>DB-LIST</parameter></title>
1755 <para>
1756 Detach specified non-persistent database(s) from the cluster. This
1757 command will disconnect specified database(s) on all nodes in
1758 the cluster. This command should only be used when none of the
1759 specified database(s) are in use.
1760 </para>
1761 <para>
1762 All nodes should be active and tunable AllowClientDBAccess should
1763 be disabled on all nodes before detaching databases.
1764 </para>
1765 </refsect2>
1767 <refsect2>
1768 <title>dumpmemory</title>
1769 <para>
1770 This is a debugging command. This command will make the ctdb
1771 daemon to write a fill memory allocation map to standard output.
1772 </para>
1773 </refsect2>
1775 <refsect2>
1776 <title>rddumpmemory</title>
1777 <para>
1778 This is a debugging command. This command will dump the talloc memory
1779 allocation tree for the recovery daemon to standard output.
1780 </para>
1781 </refsect2>
1783 <refsect2>
1784 <title>ban <parameter>BANTIME</parameter></title>
1785 <para>
1786 Administratively ban a node for BANTIME seconds. The node
1787 will be unbanned after BANTIME seconds have elapsed.
1788 </para>
1789 <para>
1790 A banned node does not participate in the cluster. It does
1791 not host any records for the clustered TDB and does not host
1792 any public IP addresses.
1793 </para>
1794 <para>
1795 Nodes are automatically banned if they misbehave. For
1796 example, a node may be banned if it causes too many cluster
1797 recoveries.
1798 </para>
1799 <para>
1800 To administratively exclude a node from a cluster use the
1801 <command>stop</command> command.
1802 </para>
1803 </refsect2>
1805 <refsect2>
1806 <title>unban</title>
1807 <para>
1808 This command is used to unban a node that has either been
1809 administratively banned using the ban command or has been
1810 automatically banned.
1811 </para>
1812 </refsect2>
1814 </refsect1>
1816 <!-- UNDOCUMENTED: stats
1817 isnotrecmaster addtickle deltickle
1818 tfetch tstore readkey writekey
1819 checktcpport getdbseqnum
1820 -->
1822 <refsect1>
1823 <title>SEE ALSO</title>
1824 <para>
1825 <citerefentry><refentrytitle>ctdbd</refentrytitle>
1826 <manvolnum>1</manvolnum></citerefentry>,
1828 <citerefentry><refentrytitle>onnode</refentrytitle>
1829 <manvolnum>1</manvolnum></citerefentry>,
1831 <citerefentry><refentrytitle>ctdb</refentrytitle>
1832 <manvolnum>7</manvolnum></citerefentry>,
1834 <citerefentry><refentrytitle>ctdb-statistics</refentrytitle>
1835 <manvolnum>7</manvolnum></citerefentry>,
1837 <citerefentry><refentrytitle>ctdb-tunables</refentrytitle>
1838 <manvolnum>7</manvolnum></citerefentry>,
1840 <ulink url="http://ctdb.samba.org/"/>
1841 </para>
1842 </refsect1>
1845 </refentry>