forked from smbecker/samba
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ctdb.1.xml
1860 lines (1710 loc) · 53.8 KB
/
ctdb.1.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry
PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<refentry id="ctdb.1">
<refentryinfo>
<author>
<contrib>
This documentation was written by
Ronnie Sahlberg,
Amitay Isaacs,
Martin Schwenke
</contrib>
</author>
<copyright>
<year>2007</year>
<holder>Andrew Tridgell</holder>
<holder>Ronnie Sahlberg</holder>
</copyright>
<legalnotice>
<para>
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 3 of
the License, or (at your option) any later version.
</para>
<para>
This program is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the GNU General Public License for more details.
</para>
<para>
You should have received a copy of the GNU General Public
License along with this program; if not, see
<ulink url="http://www.gnu.org/licenses"/>.
</para>
</legalnotice>
</refentryinfo>
<refmeta>
<refentrytitle>ctdb</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="source">ctdb</refmiscinfo>
<refmiscinfo class="manual">CTDB - clustered TDB database</refmiscinfo>
</refmeta>
<refnamediv>
<refname>ctdb</refname>
<refpurpose>CTDB management utility</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ctdb</command>
<arg rep="repeat"><replaceable>OPTION</replaceable></arg>
<arg choice="req"><replaceable>COMMAND</replaceable></arg>
<arg choice="opt"><replaceable>COMMAND-ARGS</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>
ctdb is a utility to view and manage a CTDB cluster.
</para>
<para>
The following terms are used when referring to nodes in a
cluster:
<variablelist>
<varlistentry>
<term>PNN</term>
<listitem>
<para>
Physical Node Number. The physical node number is an
integer that describes the node in the cluster. The
first node has physical node number 0. in a cluster.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PNN-LIST</term>
<listitem>
<para>
This is either a single PNN, a comma-separate list of PNNs
or "all".
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
Commands that reference a database use the following terms:
<variablelist>
<varlistentry>
<term>DB</term>
<listitem>
<para>
This is either a database name, such as
<filename>locking.tdb</filename> or a database ID such
as "0x42fe72c5".
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>DB-LIST</term>
<listitem>
<para>
A space separated list of at least one
<parameter>DB</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry><term>-n <parameter>PNN</parameter></term>
<listitem>
<para>
The node specified by PNN should be queried for the
requested information. Default is to query the daemon
running on the local host.
</para>
</listitem>
</varlistentry>
<varlistentry><term>-Y</term>
<listitem>
<para>
Produce output in machine readable form for easier parsing
by scripts. This uses a field delimiter of ':'. Not all
commands support this option.
</para>
</listitem>
</varlistentry>
<varlistentry><term>-x <parameter>SEPARATOR</parameter></term>
<listitem>
<para>
Use SEPARATOR to delimit fields in machine readable output.
This implies -Y.
</para>
</listitem>
</varlistentry>
<varlistentry><term>-X</term>
<listitem>
<para>
Produce output in machine readable form for easier parsing
by scripts. This uses a field delimiter of '|'. Not all
commands support this option.
</para>
<para>
This is equivalent to "-x|" and avoids some shell quoting
issues.
</para>
</listitem>
</varlistentry>
<varlistentry><term>-t <parameter>TIMEOUT</parameter></term>
<listitem>
<para>
Indicates that ctdb should wait up to TIMEOUT seconds for
a response to most commands sent to the CTDB daemon. The
default is 10 seconds.
</para>
</listitem>
</varlistentry>
<varlistentry><term>-T <parameter>TIMELIMIT</parameter></term>
<listitem>
<para>
Indicates that TIMELIMIT is the maximum run time (in
seconds) for the ctdb command. When TIMELIMIT is exceeded
the ctdb command will terminate with an error. The default
is 120 seconds.
</para>
</listitem>
</varlistentry>
<varlistentry><term>-? --help</term>
<listitem>
<para>
Print some help text to the screen.
</para>
</listitem>
</varlistentry>
<varlistentry><term>--usage</term>
<listitem>
<para>
Print usage information to the screen.
</para>
</listitem>
</varlistentry>
<varlistentry><term>-d --debug=<parameter>DEBUGLEVEL</parameter></term>
<listitem>
<para>
Change the debug level for the command. Default is NOTICE.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>ADMINISTRATIVE COMMANDS</title>
<para>
These are commands used to monitor and administer a CTDB cluster.
</para>
<refsect2>
<title>pnn</title>
<para>
This command displays the PNN of the current node.
</para>
</refsect2>
<refsect2>
<title>status</title>
<para>
This command shows the current status of all CTDB nodes based
on information from the queried node.
</para>
<para>
Note: If the queried node is INACTIVE then the status
might not be current.
</para>
<refsect3>
<title>Node status</title>
<para>
This includes the number of physical nodes and the status of
each node. See <citerefentry><refentrytitle>ctdb</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> for information
about node states.
</para>
</refsect3>
<refsect3>
<title>Generation</title>
<para>
The generation id is a number that indicates the current generation
of a cluster instance. Each time a cluster goes through a
reconfiguration or a recovery its generation id will be changed.
</para>
<para>
This number does not have any particular meaning other than
to keep track of when a cluster has gone through a
recovery. It is a random number that represents the current
instance of a ctdb cluster and its databases. The CTDB
daemon uses this number internally to be able to tell when
commands to operate on the cluster and the databases was
issued in a different generation of the cluster, to ensure
that commands that operate on the databases will not survive
across a cluster database recovery. After a recovery, all
old outstanding commands will automatically become invalid.
</para>
<para>
Sometimes this number will be shown as "INVALID". This only means that
the ctdbd daemon has started but it has not yet merged with the cluster through a recovery.
All nodes start with generation "INVALID" and are not assigned a real
generation id until they have successfully been merged with a cluster
through a recovery.
</para>
</refsect3>
<refsect3>
<title>Virtual Node Number (VNN) map</title>
<para>
Consists of the number of virtual nodes and mapping from
virtual node numbers to physical node numbers. Only nodes
that are participating in the VNN map can become lmaster for
database records.
</para>
</refsect3>
<refsect3>
<title>Recovery mode</title>
<para>
This is the current recovery mode of the cluster. There are two possible modes:
</para>
<para>
NORMAL - The cluster is fully operational.
</para>
<para>
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.
</para>
<para>
Once the leader detects an inconsistency, for example a node
becomes disconnected/connected, the recovery daemon will trigger a
cluster recovery process, where all databases are remerged across the
cluster. When this process starts, the leader will first
"freeze" all databases to prevent applications such as samba from
accessing the databases and it will also mark the recovery mode as
RECOVERY.
</para>
<para>
When the CTDB daemon starts up, it will start in RECOVERY
mode. Once the node has been merged into a cluster and all
databases have been recovered, the node mode will change into
NORMAL mode and the databases will be "thawed", allowing samba
to access the databases again.
</para>
</refsect3>
<refsect3>
<title>Leader</title>
<para>
This is the cluster node that is currently designated as the
leader. This node is responsible of monitoring the
consistency of the cluster and to perform the actual
recovery process when required.
</para>
<para>
Only one node at a time can be the designated leader. Which
node is designated the leader is decided by an election
process in the recovery daemons running on each node.
</para>
</refsect3>
<refsect3>
<title>Example</title>
<screen>
# ctdb status
Number of nodes:4
pnn:0 192.168.2.200 OK (THIS NODE)
pnn:1 192.168.2.201 OK
pnn:2 192.168.2.202 OK
pnn:3 192.168.2.203 OK
Generation:1362079228
Size:4
hash:0 lmaster:0
hash:1 lmaster:1
hash:2 lmaster:2
hash:3 lmaster:3
Recovery mode:NORMAL (0)
Leader:0
</screen>
</refsect3>
</refsect2>
<refsect2>
<title>nodestatus <optional><parameter>PNN-LIST</parameter></optional></title>
<para>
This command is similar to the <command>status</command>
command. It displays the "node status" subset of output. The
main differences are:
</para>
<itemizedlist>
<listitem>
<para>
The exit code is the bitwise-OR of the flags for each
specified node, while <command>ctdb status</command> exits
with 0 if it was able to retrieve status for all nodes.
</para>
</listitem>
<listitem>
<para>
<command>ctdb status</command> provides status information
for all nodes. <command>ctdb nodestatus</command>
defaults to providing status for only the current node.
If PNN-LIST is provided then status is given for
the indicated node(s).
</para>
</listitem>
</itemizedlist>
<para>
A common invocation in scripts is <command>ctdb nodestatus
all</command> to check whether all nodes in a cluster are
healthy.
</para>
<refsect3>
<title>Example</title>
<screen>
# ctdb nodestatus
pnn:0 10.0.0.30 OK (THIS NODE)
# ctdb nodestatus all
Number of nodes:2
pnn:0 10.0.0.30 OK (THIS NODE)
pnn:1 10.0.0.31 OK
</screen>
</refsect3>
</refsect2>
<refsect2>
<title>leader</title>
<para>
This command shows the pnn of the node which is currently the leader.
</para>
<para>
Note: If the queried node is INACTIVE then the status
might not be current.
</para>
</refsect2>
<refsect2>
<title>uptime</title>
<para>
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.
</para>
<refsect3>
<title>Example</title>
<screen>
# ctdb uptime
Current time of node : Thu Oct 29 10:38:54 2009
Ctdbd start time : (000 16:54:28) Wed Oct 28 17:44:26 2009
Time of last recovery/failover: (000 16:53:31) Wed Oct 28 17:45:23 2009
Duration of last recovery/failover: 2.248552 seconds
</screen>
</refsect3>
</refsect2>
<refsect2>
<title>listnodes</title>
<para>
This command shows lists the ip addresses of all the nodes in the cluster.
</para>
<refsect3>
<title>Example</title>
<screen>
# ctdb listnodes
192.168.2.200
192.168.2.201
192.168.2.202
192.168.2.203
</screen>
</refsect3>
</refsect2>
<refsect2>
<title>natgw {leader|list|status}</title>
<para>
This command shows different aspects of NAT gateway status.
For an overview of CTDB's NAT gateway functionality please see
the <citetitle>NAT GATEWAY</citetitle> section in
<citerefentry><refentrytitle>ctdb</refentrytitle>
<manvolnum>7</manvolnum></citerefentry>.
</para>
<variablelist>
<varlistentry>
<term>leader</term>
<listitem>
<para>
Show the PNN and private IP address of the current NAT
gateway leader node.
</para>
<para>
Example output:
</para>
<screen>
1 192.168.2.201
</screen>
</listitem>
</varlistentry>
<varlistentry>
<term>list</term>
<listitem>
<para>
List the private IP addresses of nodes in the current
NAT gateway group, annotating the leader node.
</para>
<para>
Example output:
</para>
<screen>
192.168.2.200
192.168.2.201 LEADER
192.168.2.202
192.168.2.203
</screen>
</listitem>
</varlistentry>
<varlistentry>
<term>status</term>
<listitem>
<para>
List the nodes in the current NAT gateway group and
their status.
</para>
<para>
Example output:
</para>
<screen>
pnn:0 192.168.2.200 UNHEALTHY (THIS NODE)
pnn:1 192.168.2.201 OK
pnn:2 192.168.2.202 OK
pnn:3 192.168.2.203 OK
</screen>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>ping</title>
<para>
This command will "ping" specified CTDB nodes in the cluster
to verify that they are running.
</para>
<refsect3>
<title>Example</title>
<screen>
# ctdb ping
response from 0 time=0.000054 sec (3 clients)
</screen>
</refsect3>
</refsect2>
<refsect2>
<title>ifaces</title>
<para>
This command will display the list of network interfaces, which could
host public addresses, along with their status.
</para>
<refsect3>
<title>Example</title>
<screen>
# ctdb ifaces
Interfaces on node 0
name:eth5 link:up references:2
name:eth4 link:down references:0
name:eth3 link:up references:1
name:eth2 link:up references:1
# ctdb -X ifaces
|Name|LinkStatus|References|
|eth5|1|2|
|eth4|0|0|
|eth3|1|1|
|eth2|1|1|
</screen>
</refsect3>
</refsect2>
<refsect2>
<title>ip</title>
<para>
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".
</para>
<refsect3>
<title>Example</title>
<screen>
# ctdb ip -v
Public IPs on node 0
172.31.91.82 node[1] active[] available[eth2,eth3] configured[eth2,eth3]
172.31.91.83 node[0] active[eth3] available[eth2,eth3] configured[eth2,eth3]
172.31.91.84 node[1] active[] available[eth2,eth3] configured[eth2,eth3]
172.31.91.85 node[0] active[eth2] available[eth2,eth3] configured[eth2,eth3]
172.31.92.82 node[1] active[] available[eth5] configured[eth4,eth5]
172.31.92.83 node[0] active[eth5] available[eth5] configured[eth4,eth5]
172.31.92.84 node[1] active[] available[eth5] configured[eth4,eth5]
172.31.92.85 node[0] active[eth5] available[eth5] configured[eth4,eth5]
# ctdb -X ip -v
|Public IP|Node|ActiveInterface|AvailableInterfaces|ConfiguredInterfaces|
|172.31.91.82|1||eth2,eth3|eth2,eth3|
|172.31.91.83|0|eth3|eth2,eth3|eth2,eth3|
|172.31.91.84|1||eth2,eth3|eth2,eth3|
|172.31.91.85|0|eth2|eth2,eth3|eth2,eth3|
|172.31.92.82|1||eth5|eth4,eth5|
|172.31.92.83|0|eth5|eth5|eth4,eth5|
|172.31.92.84|1||eth5|eth4,eth5|
|172.31.92.85|0|eth5|eth5|eth4,eth5|
</screen>
</refsect3>
</refsect2>
<refsect2>
<title>ipinfo <parameter>IP</parameter></title>
<para>
This command will display details about the specified public addresses.
</para>
<refsect3>
<title>Example</title>
<screen>
# ctdb ipinfo 172.31.92.85
Public IP[172.31.92.85] info on node 0
IP:172.31.92.85
CurrentNode:0
NumInterfaces:2
Interface[1]: Name:eth4 Link:down References:0
Interface[2]: Name:eth5 Link:up References:2 (active)
</screen>
</refsect3>
</refsect2>
<refsect2>
<title>event run|status|script list|script enable|script disable</title>
<para>
This command is used to control event daemon and to inspect
status of various events.
</para>
<para>
The commands below require a component to be specified. In
the current version the only valid component is
<literal>legacy</literal>.
</para>
<variablelist>
<varlistentry>
<term>run <parameter>TIMEOUT</parameter> <parameter>COMPONENT</parameter> <parameter>EVENT</parameter> <optional><parameter>ARGUMENTS</parameter></optional> </term>
<listitem>
<para>
This command can be used to manually run specified EVENT
in COMPONENT with optional ARGUMENTS. The event will be
allowed to run a maximum of TIMEOUT seconds. If TIMEOUT
is 0, then there is no time limit for running the event.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>status <parameter>COMPONENT</parameter> <parameter>EVENT</parameter></term>
<listitem>
<para>
This command displays the last execution status of the
specified EVENT in COMPONENT.
</para>
<para>
The command will terminate with the exit status
corresponding to the overall status of event that is
displayed.
</para>
<para>
The output is the list of event scripts executed.
Each line shows the name, status, duration and start time
for each script. Output from each script is shown.
</para>
<para>
Example #1
</para>
<screen>
# ctdb event status legacy monitor
00.ctdb OK 0.014 Sat Dec 17 19:39:11 2016
01.reclock OK 0.013 Sat Dec 17 19:39:11 2016
05.system OK 0.029 Sat Dec 17 19:39:11 2016
10.interface OK 0.037 Sat Dec 17 19:39:11 2016
11.natgw OK 0.011 Sat Dec 17 19:39:11 2016
11.routing OK 0.007 Sat Dec 17 19:39:11 2016
13.per_ip_routing OK 0.007 Sat Dec 17 19:39:11 2016
20.multipathd OK 0.007 Sat Dec 17 19:39:11 2016
31.clamd OK 0.007 Sat Dec 17 19:39:11 2016
40.vsftpd OK 0.013 Sat Dec 17 19:39:11 2016
41.httpd OK 0.018 Sat Dec 17 19:39:11 2016
49.winbind OK 0.023 Sat Dec 17 19:39:11 2016
50.samba OK 0.100 Sat Dec 17 19:39:12 2016
60.nfs OK 0.376 Sat Dec 17 19:39:12 2016
70.iscsi OK 0.009 Sat Dec 17 19:39:12 2016
91.lvs OK 0.007 Sat Dec 17 19:39:12 2016
</screen>
<para>
Example #2
</para>
<screen>
# ctdb event status legacy monitor
00.ctdb OK 0.011 Sat Dec 17 19:40:46 2016
01.reclock OK 0.010 Sat Dec 17 19:40:46 2016
05.system OK 0.030 Sat Dec 17 19:40:46 2016
10.interface OK 0.041 Sat Dec 17 19:40:46 2016
11.natgw OK 0.008 Sat Dec 17 19:40:46 2016
11.routing OK 0.007 Sat Dec 17 19:40:46 2016
13.per_ip_routing OK 0.007 Sat Dec 17 19:40:46 2016
20.multipathd OK 0.007 Sat Dec 17 19:40:46 2016
31.clamd OK 0.007 Sat Dec 17 19:40:46 2016
40.vsftpd OK 0.013 Sat Dec 17 19:40:46 2016
41.httpd OK 0.015 Sat Dec 17 19:40:46 2016
49.winbind OK 0.022 Sat Dec 17 19:40:46 2016
50.samba ERROR 0.077 Sat Dec 17 19:40:46 2016
OUTPUT: ERROR: samba tcp port 445 is not responding
</screen>
</listitem>
</varlistentry>
<varlistentry>
<term>script list <parameter>COMPONENT</parameter></term>
<listitem>
<para>
List the available event scripts in COMPONENT. Enabled
scripts are flagged with a '*'.
</para>
<para>
Generally, event scripts are provided by CTDB. However,
local or 3rd party event scripts may also be available.
These are shown in a separate section after those
provided by CTDB.
</para>
<para>
Example
</para>
<screen>
# ctdb event script list legacy
* 00.ctdb
* 01.reclock
* 05.system
* 10.interface
11.natgw
11.routing
13.per_ip_routing
20.multipathd
31.clamd
40.vsftpd
41.httpd
* 49.winbind
* 50.samba
* 60.nfs
70.iscsi
91.lvs
* 02.local
</screen>
</listitem>
</varlistentry>
<varlistentry>
<term>script enable <parameter>COMPONENT</parameter> <parameter>SCRIPT</parameter></term>
<listitem>
<para>
Enable the specified event SCRIPT in COMPONENT. Only
enabled scripts will be executed when running any event.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>script disable <parameter>COMPONENT</parameter> <parameter>SCRIPT</parameter></term>
<listitem>
<para>
Disable the specified event SCRIPT in COMPONENT. This
will prevent the script from executing when running any
event.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>scriptstatus</title>
<para>
This is an alias for <command>ctdb event status legacy
<optional>EVENT</optional></command>, where EVENT defaults to
<command>monitor</command>.
</para>
<para>
This command is deprecated. It's provided for backward
compatibility. Use <command>ctdb event status</command>
instead.
</para>
</refsect2>
<refsect2>
<title>listvars</title>
<para>
List all tuneable variables, except the values of the obsolete tunables
like VacuumMinInterval. The obsolete tunables can be retrieved only
explicitly with the "ctdb getvar" command.
</para>
<refsect3>
<title>Example</title>
<screen>
# ctdb listvars
SeqnumInterval = 1000
ControlTimeout = 60
TraverseTimeout = 20
KeepaliveInterval = 5
KeepaliveLimit = 5
RecoverTimeout = 120
RecoverInterval = 1
ElectionTimeout = 3
TakeoverTimeout = 9
MonitorInterval = 15
TickleUpdateInterval = 20
EventScriptTimeout = 30
MonitorTimeoutCount = 20
RecoveryGracePeriod = 120
RecoveryBanPeriod = 300
DatabaseHashSize = 100001
DatabaseMaxDead = 5
RerecoveryTimeout = 10
EnableBans = 1
NoIPFailback = 0
VerboseMemoryNames = 0
RecdPingTimeout = 60
RecdFailCount = 10
LogLatencyMs = 0
RecLockLatencyMs = 1000
RecoveryDropAllIPs = 120
VacuumInterval = 10
VacuumMaxRunTime = 120
RepackLimit = 10000
VacuumFastPathCount = 60
MaxQueueDropMsg = 1000000
AllowUnhealthyDBRead = 0
StatHistoryInterval = 1
DeferredAttachTO = 120
AllowClientDBAttach = 1
RecoverPDBBySeqNum = 1
DeferredRebalanceOnNodeAdd = 300
FetchCollapse = 1
HopcountMakeSticky = 50
StickyDuration = 600
StickyPindown = 200
NoIPTakeover = 0
DBRecordCountWarn = 100000
DBRecordSizeWarn = 10000000
DBSizeWarn = 100000000
PullDBPreallocation = 10485760
LockProcessesPerDB = 200
RecBufferSizeLimit = 1000000
QueueBufferSize = 1024
IPAllocAlgorithm = 2
</screen>
</refsect3>
</refsect2>
<refsect2>
<title>getvar <parameter>NAME</parameter></title>
<para>
Get the runtime value of a tuneable variable.
</para>
<refsect3>
<title>Example</title>
<screen>
# ctdb getvar MonitorInterval
MonitorInterval = 15
</screen>
</refsect3>
</refsect2>
<refsect2>
<title>setvar <parameter>NAME</parameter> <parameter>VALUE</parameter></title>
<para>
Set the runtime value of a tuneable variable.
</para>
<refsect3>
<title>Example</title>
<screen>
# ctdb setvar MonitorInterval 20
</screen>
</refsect3>
</refsect2>
<refsect2>
<title>lvs {leader|list|status}</title>
<para>
This command shows different aspects of LVS status. For an
overview of CTDB's LVS functionality please see the
<citetitle>LVS</citetitle> section in
<citerefentry><refentrytitle>ctdb</refentrytitle>
<manvolnum>7</manvolnum></citerefentry>.
</para>
<variablelist>
<varlistentry>
<term>leader</term>
<listitem>
<para>
Shows the PNN of the current LVS leader node.
</para>
<para>
Example output:
</para>
<screen>
2
</screen>
</listitem>
</varlistentry>
<varlistentry>
<term>list</term>
<listitem>
<para>
Lists the currently usable LVS nodes.
</para>
<para>
Example output:
</para>
<screen>
2 10.0.0.13
3 10.0.0.14
</screen>
</listitem>
</varlistentry>
<varlistentry>
<term>status</term>
<listitem>
<para>
List the nodes in the current LVS group and their status.
</para>
<para>
Example output:
</para>
<screen>
pnn:0 10.0.0.11 UNHEALTHY (THIS NODE)
pnn:1 10.0.0.12 UNHEALTHY
pnn:2 10.0.0.13 OK
pnn:3 10.0.0.14 OK
</screen>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>getcapabilities</title>
<para>
This command shows the capabilities of the current node. See
the <citetitle>CAPABILITIES</citetitle> section in
<citerefentry><refentrytitle>ctdb</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> for more details.
</para>
<para>
Example output:
</para>
<screen>
LEADER: YES
LMASTER: YES
</screen>
</refsect2>
<refsect2>
<title>statistics</title>
<para>
Collect statistics from the CTDB daemon about
how many calls it has served. Information about
various fields in statistics can be found in
<citerefentry><refentrytitle>ctdb-statistics</refentrytitle>
<manvolnum>7</manvolnum></citerefentry>.
</para>
<refsect3>
<title>Example</title>
<screen>
# ctdb statistics
CTDB version 1
Current time of statistics : Tue Mar 8 15:18:51 2016
Statistics collected since : (003 21:31:32) Fri Mar 4 17:47:19 2016
num_clients 9
frozen 0
recovering 0
num_recoveries 2
client_packets_sent 8170534
client_packets_recv 7166132
node_packets_sent 16549998
node_packets_recv 5244418
keepalive_packets_sent 201969
keepalive_packets_recv 201969
node
req_call 26
reply_call 0
req_dmaster 9
reply_dmaster 12
reply_error 0
req_message 1339231
req_control 8177506
reply_control 6831284
client
req_call 15
req_message 334809
req_control 6831308
timeouts
call 0
control 0
traverse 0
locks
num_calls 8
num_current 0
num_pending 0
num_failed 0
total_calls 15
pending_calls 0
childwrite_calls 0
pending_childwrite_calls 0
memory_used 394879