-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ctdb</title><meta name="generator" content="DocBook XSL Stylesheets V1.7
3.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="ctdb.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ctdb — clustered tdb database management utility</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">ctdb [ OPTIONS ] COMMAND ...</code> </p></div><div class="cmdsynopsis"><p><code class="command">ctdb</code> [-n <node>] [-Y] [-t <timeout>] [-T <timelimit>] [-? --help] [--usage] [-d --debug=<INTEGER>] [--socket=<filename>]</p></div></div><div class="refsect1" lang="en"><a name="id2478395"></a><h2>DESCRIPTION</h2><p>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ctdb</title><meta name="generator" content="DocBook XSL Stylesheets V1.7
5.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="ctdb"><a name="ctdb.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ctdb — clustered tdb database management utility</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">ctdb [ OPTIONS ] COMMAND ...</code> </p></div><div class="cmdsynopsis"><p><code class="command">ctdb</code> [-n <node>] [-Y] [-t <timeout>] [-T <timelimit>] [-? --help] [--usage] [-d --debug=<INTEGER>] [--socket=<filename>]</p></div></div><div class="refsect1" title="DESCRIPTION"><a name="id497338"></a><h2>DESCRIPTION</h2><p>
ctdb is a utility to view and manage a ctdb cluster.
- </p></div><div class="refsect1"
lang="en"><a name="id2478405"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-n <pnn></span></dt><dd><p>
+ </p></div><div class="refsect1"
title="OPTIONS"><a name="id497348"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-n <pnn></span></dt><dd><p>
This specifies the physical node number on which to execute the
- command. Default is to run the command on the deamon running on
+ command. Default is to run the command on the daemon running on
the local host.
</p><p>
The physical node number is an integer that describes the node in the
You only need to specify this parameter if you run multiple ctdb
daemons on the same physical host and thus can not use the default
name for the domain socket.
- </p></dd></dl></div></div><div class="refsect1"
lang="en"><a name="id2479674"></a><h2>Administrative Commands</h2><p>
+ </p></dd></dl></div></div><div class="refsect1"
title="Administrative Commands"><a name="id539721"></a><h2>Administrative Commands</h2><p>
These are commands used to monitor and administrate a CTDB cluster.
- </p><div class="refsect2"
lang="en"><a name="id2479683"></a><h3>pnn</h3><p>
+ </p><div class="refsect2"
title="pnn"><a name="id539729"></a><h3>pnn</h3><p>
This command displays the pnn of the current node.
- </p></div><div class="refsect2"
lang="en"><a name="id2479693"></a><h3>status</h3><p>
+ </p></div><div class="refsect2"
title="status"><a name="id539738"></a><h3>status</h3><p>
This command shows the current status of the ctdb node.
- </p><div class="refsect3"
lang="en"><a name="id2479702"></a><h4>node status</h4><p>
+ </p><div class="refsect3"
title="node status"><a name="id539745"></a><h4>node status</h4><p>
Node status reflects the current status of the node. There are five possible states:
</p><p>
OK - This node is fully functional.
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.
</p><p>
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.
- </p></div><div class="refsect3" lang="en"><a name="id2479754"></a><h4>generation</h4><p>
+ </p><p>
+ STOPPED - A node that is stopped does not host any public ip addresses,
+ nor is it part of the VNNMAP. A stopped node can not become LVSMASTER,
+ RECMASTER or NATGW.
+ This node does not perticipate in the CTDB cluster but can still be
+ communicated with. I.e. ctdb commands can be sent to it.
+ </p><p>
+ PARTIALLYONLINE - A node that is partially online participates
+ in a cluster like a node that is ok. Some interfaces to serve
+ public ip addresses are down, but at least one interface is up.
+ See also "ctdb ifaces".
+ </p></div><div class="refsect3" title="generation"><a name="id539795"></a><h4>generation</h4><p>
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.
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.
- </p></div><div class="refsect3"
lang="en"><a name="id2479789"></a><h4>VNNMAP</h4><p>
+ </p></div><div class="refsect3"
title="VNNMAP"><a name="id539820"></a><h4>VNNMAP</h4><p>
The list of Virtual Node Numbers. This is a list of all nodes that actively participates in the cluster and that share the workload of hosting the Clustered TDB database records.
Only nodes that are participating in the vnnmap can become lmaster or dmaster for a database record.
- </p></div><div class="refsect3"
lang="en"><a name="id2479803"></a><h4>Recovery mode</h4><p>
+ </p></div><div class="refsect3"
title="Recovery mode"><a name="id539832"></a><h4>Recovery mode</h4><p>
This is the current recovery mode of the cluster. There are two possible modes:
</p><p>
NORMAL - The cluster is fully operational.
have been recovered, the node mode will change into NORMAL mode
and the databases will be "thawed", allowing samba to access the
databases again.
- </p></div><div class="refsect3"
lang="en"><a name="id2528502"></a><h4>Recovery master</h4><p>
+ </p></div><div class="refsect3"
title="Recovery master"><a name="id539863"></a><h4>Recovery master</h4><p>
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.
</p><p>
Only one node at a time can be the designated recovery master. Which
hash:3 lmaster:3
Recovery mode:NORMAL (0)
Recovery master:0
- </pre></div><div class="refsect2"
lang="en"><a name="id2528540"></a><h3>recmaster</h3><p>
+ </pre></div><div class="refsect2"
title="recmaster"><a name="id539895"></a><h3>recmaster</h3><p>
This command shows the pnn of the node which is currently the recmaster.
- </p></div><div class="refsect2"
lang="en"><a name="id2528550"></a><h3>uptime</h3><p>
- This command shows the uptime for the ctdb daemon. When the last recovery completed and how long the last recovery took. If the "duration" is shown as a negative number, this indicates that there is a recovery in progress and it started that many seconds ago.
+ </p></div><div class="refsect2"
title="uptime"><a name="id539905"></a><h3>uptime</h3><p>
+ 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.
</p><p>
Example: ctdb uptime
</p><p>Example output:</p><pre class="screen">
-Current time of node : Tue Mar 24 18:27:54 2009
-Ctdbd start time : (000 00:00:05) Tue Mar 24 18:27:49 2009
-Time of last recovery : (000 00:00:05) Tue Mar 24 18:27:49 2009
-Duration of last recovery : 0.000000 seconds
- </pre></div><div class="refsect2"
lang="en"><a name="id2528580"></a><h3>listnodes</h3><p>
+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
+ </pre></div><div class="refsect2"
title="listnodes"><a name="id539931"></a><h3>listnodes</h3><p>
This command shows lists the ip addresses of all the nodes in the cluster.
</p><p>
Example: ctdb listnodes
10.0.0.72
10.0.0.73
10.0.0.74
- </pre></div><div class="refsect2"
lang="en"><a name="id2528604"></a><h3>ping</h3><p>
+ </pre></div><div class="refsect2"
title="ping"><a name="id539953"></a><h3>ping</h3><p>
This command will "ping" all CTDB daemons in the cluster to verify that they are processing commands correctly.
</p><p>
Example: ctdb ping
response from 1 time=0.000144 sec (2 clients)
response from 2 time=0.000105 sec (2 clients)
response from 3 time=0.000114 sec (2 clients)
- </pre></div><div class="refsect2" lang="en"><a name="id2528630"></a><h3>ip</h3><p>
+ </pre></div><div class="refsect2" title="ifaces"><a name="id539978"></a><h3>ifaces</h3><p>
+ This command will display the list of network interfaces, which could
+ host public addresses, along with their status.
+ </p><p>
+ Example: ctdb ifaces
+ </p><p>
+ Example output:
+ </p><pre class="screen">
+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
+ </pre><p>
+ Example: ctdb ifaces -Y
+ </p><p>
+ Example output:
+ </p><pre class="screen">
+:Name:LinkStatus:References:
+:eth5:1:2
+:eth4:0:0
+:eth3:1:1
+:eth2:1:1
+ </pre></div><div class="refsect2" title="setifacelink <iface> <status>"><a name="id540015"></a><h3>setifacelink <iface> <status></h3><p>
+ This command will set the status of a network interface.
+ The status needs to be "up" or "down". This is typically
+ used in the 10.interfaces script in the "monitor" event.
+ </p><p>
+ Example: ctdb setifacelink eth0 up
+ </p></div><div class="refsect2" title="ip"><a name="id540028"></a><h3>ip</h3><p>
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".
</p><p>
Example: ctdb ip
</p><p>
Example output:
</p><pre class="screen">
-Number of addresses:4
-12.1.1.1 0
-12.1.1.2 1
-12.1.1.3 2
-12.1.1.4 3
- </pre></div><div class="refsect2" lang="en"><a name="id2528658"></a><h3>scriptstatus</h3><p>
+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]
+ </pre><p>
+ Example: ctdb ip -Y
+ </p><p>
+ Example output:
+ </p><pre class="screen">
+: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:
+ </pre></div><div class="refsect2" title="ipinfo <ip>"><a name="id540074"></a><h3>ipinfo <ip></h3><p>
+ This command will display details about the specified public addresses.
+ </p><p>
+ Example: ctdb ipinfo 172.31.92.85
+ </p><p>
+ Example output:
+ </p><pre class="screen">
+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)
+ </pre></div><div class="refsect2" title="scriptstatus"><a name="id540096"></a><h3>scriptstatus</h3><p>
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.
</p><p>
Example: ctdb scriptstatus
10.interface Status:OK Duration:0.077 Tue Mar 24 18:56:57 2009
11.natgw Status:OK Duration:0.039 Tue Mar 24 18:56:57 2009
20.multipathd Status:OK Duration:0.038 Tue Mar 24 18:56:57 2009
+31.clamd Status:DISABLED
40.vsftpd Status:OK Duration:0.045 Tue Mar 24 18:56:57 2009
41.httpd Status:OK Duration:0.039 Tue Mar 24 18:56:57 2009
50.samba Status:ERROR Duration:0.082 Tue Mar 24 18:56:57 2009
OUTPUT:ERROR: Samba tcp port 445 is not responding
- </pre></div><div class="refsect2" lang="en"><a name="id2479836"></a><h3>getvar <name></h3><p>
+ </pre></div><div class="refsect2" title="disablescript <script>"><a name="id540126"></a><h3>disablescript <script></h3><p>
+ This command is used to disable an eventscript.
+ </p><p>
+ 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'.
+ </p></div><div class="refsect2" title="enablescript <script>"><a name="id540139"></a><h3>enablescript <script></h3><p>
+ This command is used to enable an eventscript.
+ </p><p>
+ 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'.
+ </p></div><div class="refsect2" title="getvar <name>"><a name="id540153"></a><h3>getvar <name></h3><p>
Get the runtime value of a tuneable variable.
</p><p>
Example: ctdb getvar MaxRedirectCount
Example output:
</p><pre class="screen">
MaxRedirectCount = 3
- </pre></div><div class="refsect2"
lang="en"><a name="id2528713"></a><h3>setvar <name> <value></h3><p>
+ </pre></div><div class="refsect2"
title="setvar <name> <value>"><a name="id496772"></a><h3>setvar <name> <value></h3><p>
Set the runtime value of a tuneable variable.
</p><p>
Example: ctdb setvar MaxRedirectCount 5
- </p></div><div class="refsect2"
lang="en"><a name="id2528728"></a><h3>listvars</h3><p>
+ </p></div><div class="refsect2"
title="listvars"><a name="id496784"></a><h3>listvars</h3><p>
List all tuneable variables.
</p><p>
Example: ctdb listvars
</p><p>
Example output:
</p><pre class="screen">
-MaxRedirectCount = 5
-SeqnumFrequency = 1
+MaxRedirectCount = 3
+SeqnumInterval = 1000
ControlTimeout = 60
TraverseTimeout = 20
-KeepaliveInterval = 2
-KeepaliveLimit = 3
+KeepaliveInterval = 5
+KeepaliveLimit = 5
MaxLACount = 7
-RecoverTimeout = 5
+RecoverTimeout = 20
RecoverInterval = 1
ElectionTimeout = 3
TakeoverTimeout = 5
MonitorInterval = 15
-EventScriptTimeout = 20
-RecoveryGracePeriod = 60
+TickleUpdateInterval = 20
+EventScriptTimeout = 30
+EventScriptBanCount = 10
+EventScriptUnhealthyOnTimeout = 0
+RecoveryGracePeriod = 120
RecoveryBanPeriod = 300
- </pre></div><div class="refsect2" lang="en"><a name="id2528755"></a><h3>lvsmaster</h3><p>
+DatabaseHashSize = 10000
+DatabaseMaxDead = 5
+RerecoveryTimeout = 10
+EnableBans = 1
+DeterministicIPs = 1
+DisableWhenUnhealthy = 0
+ReclockPingPeriod = 60
+NoIPFailback = 0
+VerboseMemoryNames = 0
+RecdPingTimeout = 60
+RecdFailCount = 10
+LogLatencyMs = 0
+RecLockLatencyMs = 1000
+RecoveryDropAllIPs = 60
+VerifyRecoveryLock = 1
+VacuumDefaultInterval = 300
+VacuumMaxRunTime = 30
+RepackLimit = 10000
+VacuumLimit = 5000
+VacuumMinInterval = 60
+VacuumMaxInterval = 600
+MaxQueueDropMsg = 1000
+UseStatusEvents = 0
+AllowUnhealthyDBRead = 0
+ </pre></div><div class="refsect2" title="lvsmaster"><a name="id496815"></a><h3>lvsmaster</h3><p>
This command shows which node is currently the LVSMASTER. The
LVSMASTER is the node in the cluster which drives the LVS system and
which receives all incoming traffic from clients.
evenly onto the other nodes in the cluster. This is an alternative to using
public ip addresses. See the manpage for ctdbd for more information
about LVS.
- </p></div><div class="refsect2"
lang="en"><a name="id2528778"></a><h3>lvs</h3><p>
+ </p></div><div class="refsect2"
title="lvs"><a name="id496832"></a><h3>lvs</h3><p>
This command shows which nodes in the cluster are currently active in the
LVS configuration. I.e. which nodes we are currently loadbalancing
the single ip address across.
LVS will by default only loadbalance across those nodes that are both
LVS capable and also HEALTHY. Except if all nodes are UNHEALTHY in which
case LVS will loadbalance across all UNHEALTHY nodes as well.
- LVS will never use nodes that are DISCONNECTED, BANNED or DISABLED.
+ LVS will never use nodes that are DISCONNECTED, STOPPED, BANNED or
+ DISABLED.
</p><p>
Example output:
</p><pre class="screen">
2:10.0.0.13
3:10.0.0.14
- </pre></div><div class="refsect2"
lang="en"><a name="id2528807"></a><h3>getcapabilities</h3><p>
+ </pre></div><div class="refsect2"
title="getcapabilities"><a name="id496858"></a><h3>getcapabilities</h3><p>
This command shows the capabilities of the current node.
Please see manpage for ctdbd for a full list of all capabilities and
more detailed description.
RECMASTER: YES
LMASTER: YES
LVS: NO
- </pre></div><div class="refsect2"
lang="en"><a name="id2528844"></a><h3>statistics</h3><p>
+ </pre></div><div class="refsect2"
title="statistics"><a name="id496889"></a><h3>statistics</h3><p>
Collect statistics from the CTDB daemon about how many calls it has served.
</p><p>
Example: ctdb statistics
max_hop_count 0
max_call_latency 4.948321 sec
max_lockwait_latency 0.000000 sec
- </pre></div><div class="refsect2"
lang="en"><a name="id2528887"></a><h3>statisticsreset</h3><p>
+ </pre></div><div class="refsect2"
title="statisticsreset"><a name="id496922"></a><h3>statisticsreset</h3><p>
This command is used to clear all statistics counters in a node.
</p><p>
Example: ctdb statisticsreset
- </p></div><div class="refsect2" lang="en"><a name="id2528901"></a><h3>getdebug</h3><p>
+ </p></div><div class="refsect2" title="getreclock"><a name="id496934"></a><h3>getreclock</h3><p>
+ This command is used to show the filename of the reclock file that is used.
+ </p><p>
+ Example output:
+ </p><pre class="screen">
+Reclock file:/gpfs/.ctdb/shared
+ </pre></div><div class="refsect2" title="setreclock [filename]"><a name="id496952"></a><h3>setreclock [filename]</h3><p>
+ 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".
+ </p><p>
+ 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.
+ </p><p>
+ 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.
+ </p></div><div class="refsect2" title="getdebug"><a name="id496973"></a><h3>getdebug</h3><p>
Get the current debug level for the node. the debug level controls what information is written to the log file.
</p><p>
The debug levels are mapped to the corresponding syslog levels.
The list of debug levels from highest to lowest are :
</p><p>
EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
- </p></div><div class="refsect2"
lang="en"><a name="id2528927"></a><h3>setdebug <debuglevel></h3><p>
+ </p></div><div class="refsect2"
title="setdebug <debuglevel>"><a name="id496994"></a><h3>setdebug <debuglevel></h3><p>
Set the debug level of a node. This controls what information will be logged.
</p><p>
The debuglevel is one of EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
- </p></div><div class="refsect2"
lang="en"><a name="id2528943"></a><h3>getpid</h3><p>
+ </p></div><div class="refsect2"
title="getpid"><a name="id497007"></a><h3>getpid</h3><p>
This command will return the process id of the ctdb daemon.
- </p></div><div class="refsect2"
lang="en"><a name="id2528953"></a><h3>disable</h3><p>
+ </p></div><div class="refsect2"
title="disable"><a name="id497016"></a><h3>disable</h3><p>
This command is used to administratively disable a node in the cluster.
A disabled node will still participate in the cluster and host
clustered TDB records but its public ip address has been taken over by
a different node and it no longer hosts any services.
- </p></div><div class="refsect2"
lang="en"><a name="id2528967"></a><h3>enable</h3><p>
+ </p></div><div class="refsect2"
title="enable"><a name="id497028"></a><h3>enable</h3><p>
Re-enable a node that has been administratively disabled.
- </p></div><div class="refsect2" lang="en"><a name="id2528977"></a><h3>ban <bantime|0></h3><p>
- Administratively ban a node for bantime seconds. A bantime of 0 means that the node should be permanently banned.
- </p><p>
- A banned node does not participate in the cluster and does not host any records for the clustered TDB. Its ip address has been taken over by an other node and no services are hosted.
- </p><p>
- Nodes are automatically banned if they are the cause of too many
- cluster recoveries.
- </p></div><div class="refsect2" lang="en"><a name="id2529000"></a><h3>addip <public_ip/mask> <iface></h3><p>
+ </p></div><div class="refsect2" title="stop"><a name="id497036"></a><h3>stop</h3><p>
+ This command is used to administratively STOP a node in the cluster.
+ A STOPPED node is connected to the cluster but will not host any
+ public ip addresse, nor does it participate in the VNNMAP.
+ The difference between a DISABLED node and a STOPPED node is that
+ a STOPPED node does not host any parts of the database which means
+ that a recovery is required to stop/continue nodes.
+ </p></div><div class="refsect2" title="continue"><a name="id497049"></a><h3>continue</h3><p>
+ Re-start a node that has been administratively stopped.
+ </p></div><div class="refsect2" title="addip <public_ip/mask> <iface>"><a name="id497058"></a><h3>addip <public_ip/mask> <iface></h3><p>
This command is used to add a new public ip to a node during runtime.
This allows public addresses to be added to a cluster without having
to restart the ctdb daemons.
</p><p>
Note that this only updates the runtime instance of ctdb. Any changes will be lost next time ctdb is restarted and the public addresses file is re-read.
If you want this change to be permanent you must also update the public addresses file manually.
- </p></div><div class="refsect2"
lang="en"><a name="id2529021"></a><h3>delip <public_ip></h3><p>
+ </p></div><div class="refsect2"
title="delip <public_ip>"><a name="id497074"></a><h3>delip <public_ip></h3><p>
This command is used to remove a public ip from a node during runtime.
If this public ip is currently hosted by the node it being removed from, the ip will first be failed over to another node, if possible, before it is removed.
</p><p>
Note that this only updates the runtime instance of ctdb. Any changes will be lost next time ctdb is restarted and the public addresses file is re-read.
If you want this change to be permanent you must also update the public addresses file manually.
- </p></div><div class="refsect2"
lang="en"><a name="id2529042"></a><h3>moveip <public_ip> <node></h3><p>
+ </p></div><div class="refsect2"
title="moveip <public_ip> <node>"><a name="id497090"></a><h3>moveip <public_ip> <node></h3><p>
This command can be used to manually fail a public ip address to a
specific node.
</p><p>
DeterministicIPs = 0
</p><p>
NoIPFailback = 1
- </p></div><div class="refsect2" lang="en"><a name="id2529066"></a><h3>unban</h3><p>
- This command is used to unban a node that has either been
- administratively banned using the ban command or has been automatically
- banned by the recovery daemon.
- </p></div><div class="refsect2" lang="en"><a name="id2529078"></a><h3>shutdown</h3><p>
+ </p></div><div class="refsect2" title="shutdown"><a name="id497113"></a><h3>shutdown</h3><p>
This command will shutdown a specific CTDB daemon.
- </p></div><div class="refsect2"
lang="en"><a name="id2529088"></a><h3>recover</h3><p>
+ </p></div><div class="refsect2"
title="recover"><a name="id497121"></a><h3>recover</h3><p>
This command will trigger the recovery daemon to do a cluster
recovery.
- </p></div><div class="refsect2" lang="en"><a name="id2529099"></a><h3>killtcp <srcip:port> <dstip:port></h3><p>
+ </p></div><div class="refsect2" title="ipreallocate"><a name="id497131"></a><h3>ipreallocate</h3><p>
+ 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.
+ </p></div><div class="refsect2" title="setlmasterrole <on|off>"><a name="id497143"></a><h3>setlmasterrole <on|off></h3><p>
+ 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.
+ </p><p>
+ 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.
+ </p><p>
+ Once this setting has been enabled/disabled, you need to perform a recovery for it to take effect.
+ </p><p>
+ See also "ctdb getcapabilities"
+ </p></div><div class="refsect2" title="setrecmasterrole <on|off>"><a name="id497167"></a><h3>setrecmasterrole <on|off></h3><p>
+ 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.
+ </p><p>
+ 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.
+ </p><p>
+ See also "ctdb getcapabilities"
+ </p></div><div class="refsect2" title="killtcp <srcip:port> <dstip:port>"><a name="id497187"></a><h3>killtcp <srcip:port> <dstip:port></h3><p>
This command will kill the specified TCP connection by issuing a
TCP RST to the srcip:port endpoint. This is a command used by the
ctdb eventscripts.
- </p></div><div class="refsect2"
lang="en"><a name="id2529111"></a><h3>gratiousarp <ip> <interface></h3><p>
+ </p></div><div class="refsect2"
title="gratiousarp <ip> <interface>"><a name="id497198"></a><h3>gratiousarp <ip> <interface></h3><p>
This command will send out a gratious arp for the specified interface
through the specified interface. This command is mainly used by the
ctdb eventscripts.
- </p></div><div class="refsect2"
lang="en"><a name="id2529124"></a><h3>reloadnodes</h3><p>
+ </p></div><div class="refsect2"
title="reloadnodes"><a name="id497208"></a><h3>reloadnodes</h3><p>
This command is used when adding new nodes, or removing existing nodes from an existing cluster.
</p><p>
Procedure to add a node:
</p><p>
5, Use 'ctdb status' on all nodes and verify that the deleted node no longer shows up in the list..
</p><p>
- </p></div><div class="refsect2"
lang="en"><a name="id2529208"></a><h3>tickle <srcip:port> <dstip:port></h3><p>
+ </p></div><div class="refsect2"
title="tickle <srcip:port> <dstip:port>"><a name="id497275"></a><h3>tickle <srcip:port> <dstip:port></h3><p>
This command will will send a TCP tickle to the source host for the
specified TCP connection.
A TCP tickle is a TCP ACK packet with an invalid sequence and
TCP connection has been disrupted and that the client will need
to reestablish. This greatly speeds up the time it takes for a client
to detect and reestablish after an IP failover in the ctdb cluster.
- </p></div><div class="refsect2"
lang="en"><a name="id2529233"></a><h3>gettickles <ip></h3><p>
+ </p></div><div class="refsect2"
title="gettickles <ip>"><a name="id497294"></a><h3>gettickles <ip></h3><p>
This command is used to show which TCP connections are registered with
CTDB to be "tickled" if there is a failover.
- </p></div><div class="refsect2"
lang="en"><a name="id2529244"></a><h3>repack [max_freelist]</h3><p>
+ </p></div><div class="refsect2"
title="repack [max_freelist]"><a name="id540984"></a><h3>repack [max_freelist]</h3><p>
Over time, when records are created and deleted in a TDB, the TDB list of free space will become fragmented. This can lead to a slowdown in accessing TDB records.
This command is used to defragment a TDB database and pruning the freelist.
</p><p>
Example: ctdb repack 1000
</p><p>
By default, this operation is issued from the 00.ctdb event script every 5 minutes.
- </p></div><div class="refsect2"
lang="en"><a name="id2529290"></a><h3>vacuum [max_records]</h3><p>
+ </p></div><div class="refsect2"
title="vacuum [max_records]"><a name="id541021"></a><h3>vacuum [max_records]</h3><p>
Over time CTDB databases will fill up with empty deleted records which will lead to a progressive slow down of CTDB database access.
This command is used to prune all databases and delete all empty records from the cluster.
</p><p>
Example: ctdb vacuum
</p><p>
By default, this operation is issued from the 00.ctdb event script every 5 minutes.
- </p></div></div><div class="refsect1" lang="en"><a name="id2529327"></a><h2>Debugging Commands</h2><p>
+ </p></div><div class="refsect2" title="backupdb <dbname> <file>"><a name="id541050"></a><h3>backupdb <dbname> <file></h3><p>
+ This command can be used to copy the entire content of a database out to a file. This file can later be read back into ctdb using the restoredb command.
+This is mainly useful for backing up persistent databases such as secrets.tdb and similar.
+ </p></div><div class="refsect2" title="restoredb <file> [<dbname>]"><a name="id541061"></a><h3>restoredb <file> [<dbname>]</h3><p>
+ This command restores a persistent database that was previously backed up using backupdb.
+ By default the data will be restored back into the same database as
+ it was created from. By specifying dbname you can restore the data
+ into a different database.
+ </p></div><div class="refsect2" title="wipedb <dbname>"><a name="id541072"></a><h3>wipedb <dbname></h3><p>
+ This command can be used to remove all content of a database.
+ </p></div></div><div class="refsect2" title="getlog <level>"><a name="id541082"></a><h3>getlog <level></h3><p>
+ In addition to the normal loggign to a log file,
+ CTDBD also keeps a in-memory ringbuffer containing the most recent
+ log entries for all log levels (except DEBUG).
+ </p><p>
+ This is useful since it allows for keeping continous logs to a file
+ at a reasonable non-verbose level, but shortly after an incident has
+ occured, a much more detailed log can be pulled from memory. This
+ can allow you to avoid having to reproduce an issue due to the
+ on-disk logs being of insufficient detail.
+ </p><p>
+ This command extracts all messages of level or lower log level from
+ memory and prints it to the screen.
+ </p></div><div class="refsect2" title="clearlog"><a name="id541100"></a><h3>clearlog</h3><p>
+ This command clears the in-memory logging ringbuffer.
+ </p></div><div class="refsect1" title="Debugging Commands"><a name="id541109"></a><h2>Debugging Commands</h2><p>
These commands are primarily used for CTDB development and testing and
should not be used for normal administration.
- </p><div class="refsect2"
lang="en"><a name="id2529337"></a><h3>process-exists <pid></h3><p>
+ </p><div class="refsect2"
title="process-exists <pid>"><a name="id541118"></a><h3>process-exists <pid></h3><p>
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.
- </p></div><div class="refsect2"
lang="en"><a name="id2529350"></a><h3>getdbmap</h3><p>
+ </p></div><div class="refsect2"
title="getdbmap"><a name="id541128"></a><h3>getdbmap</h3><p>
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.
+ </p><p>
+ If a PERSISTENT database is not in a healthy state the database is
+ flagged as UNHEALTHY. If there's at least one completely healthy node running in
+ the cluster, it's possible that the content is restored by a recovery
+ run automaticly. Otherwise an administrator needs to analyze the
+ problem.
+ </p><p>
+ See also "ctdb getdbstatus", "ctdb backupdb", "ctdb restoredb",
+ "ctdb dumpbackup", "ctdb wipedb", "ctdb setvar AllowUnhealthyDBRead 1"
+ and (if samba or tdb-utils are installed) "tdbtool check".
</p><p>
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.
</p><p>
</p><pre class="screen">
Number of databases:10
dbid:0x435d3410 name:notify.tdb path:/var/ctdb/notify.tdb.0
-dbid:0x42fe72c5 name:locking.tdb path:/var/ctdb/locking.tdb.0 dbid:0x1421fb78 name:brlock.tdb path:/var/ctdb/brlock.tdb.0
+dbid:0x42fe72c5 name:locking.tdb path:/var/ctdb/locking.tdb.0
+dbid:0x1421fb78 name:brlock.tdb path:/var/ctdb/brlock.tdb.0
dbid:0x17055d90 name:connections.tdb path:/var/ctdb/connections.tdb.0
dbid:0xc0bdde6a name:sessionid.tdb path:/var/ctdb/sessionid.tdb.0
dbid:0x122224da name:test.tdb path:/var/ctdb/test.tdb.0
dbid:0xb775fff6 name:secrets.tdb path:/var/ctdb/persistent/secrets.tdb.0 PERSISTENT
dbid:0xe98e08b6 name:group_mapping.tdb path:/var/ctdb/persistent/group_mapping.tdb.0 PERSISTENT
dbid:0x7bbbd26c name:passdb.tdb path:/var/ctdb/persistent/passdb.tdb.0 PERSISTENT
- </pre></div><div class="refsect2" lang="en"><a name="id2529396"></a><h3>catdb <dbname></h3><p>
+ </pre><p>
+ Example output for an unhealthy database:
+ </p><pre class="screen">
+Number of databases:1
+dbid:0xb775fff6 name:secrets.tdb path:/var/ctdb/persistent/secrets.tdb.0 PERSISTENT UNHEALTHY
+ </pre><p>
+ Example output for a healthy database as machinereadable output -Y:
+ </p><pre class="screen">
+:ID:Name:Path:Persistent:Unhealthy:
+:0x7bbbd26c:passdb.tdb:/var/ctdb/persistent/passdb.tdb.0:1:0:
+ </pre></div><div class="refsect2" title="getdbstatus <dbname>"><a name="id541193"></a><h3>getdbstatus <dbname></h3><p>
+ This command displays more details about a database.
+ </p><p>
+ Example: ctdb getdbstatus test.tdb.0
+ </p><p>
+ Example output:
+ </p><pre class="screen">
+dbid: 0x122224da
+name: test.tdb
+path: /var/ctdb/test.tdb.0
+PERSISTENT: no
+HEALTH: OK
+ </pre><p>
+ Example: ctdb getdbstatus registry.tdb (with a corrupted TDB)
+ </p><p>
+ Example output:
+ </p><pre class="screen">
+dbid: 0xf2a58948
+name: registry.tdb
+path: /var/ctdb/persistent/registry.tdb.0
+PERSISTENT: yes
+HEALTH: NO-HEALTHY-NODES - ERROR - Backup of corrupted TDB in '/var/ctdb/persistent/registry.tdb.0.corrupted.20091208091949.0Z'
+ </pre></div><div class="refsect2" title="catdb <dbname>"><a name="id541228"></a><h3>catdb <dbname></h3><p>
This command will dump a clustered TDB database to the screen. This is a debugging command.
- </p></div><div class="refsect2" lang="en"><a name="id2529407"></a><h3>getmonmode</h3><p>
+ </p></div><div class="refsect2" title="dumpdbbackup <backup-file>"><a name="id541237"></a><h3>dumpdbbackup <backup-file></h3><p>
+ This command will dump the content of database backup to the screen
+ (similar to ctdb catdb). This is a debugging command.
+ </p></div><div class="refsect2" title="getmonmode"><a name="id541247"></a><h3>getmonmode</h3><p>
This command returns the monutoring mode of a node. The monitoring mode is either ACTIVE or DISABLED. Normally a node will continously monitor that all other nodes that are expected are in fact connected and that they respond to commands.
</p><p>
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.
</p><p>
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.
- </p></div><div class="refsect2"
lang="en"><a name="id2529438"></a><h3>setmonmode <0|1></h3><p>
- This command can be used to explicitely disable/enable monitoring mode on a node. The main purpose is if one wants to attach GDB to a running ctdb daemon but wants to prevent the other nodes from marking it as DISCONNECTED and issuing a recovery. To do this, set monitoring mode to 0 on all nodes before attaching with GDB. Remember to set monitoring mode back to 1 afterwards.
- </p></div><div class="refsect2"
lang="en"><a name="id2529453"></a><h3>attach <dbname></h3><p>
+ </p></div><div class="refsect2"
title="setmonmode <0|1>"><a name="id541270"></a><h3>setmonmode <0|1></h3><p>
+ 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.
+ </p></div><div class="refsect2"
title="attach <dbname> [persistent]"><a name="id541285"></a><h3>attach <dbname> [persistent]</h3><p>
This is a debugging command. This command will make the CTDB daemon create a new CTDB database and attach to it.
- </p></div><div class="refsect2"
lang="en"><a name="id2529464"></a><h3>dumpmemory</h3><p>
+ </p></div><div class="refsect2"
title="dumpmemory"><a name="id541295"></a><h3>dumpmemory</h3><p>
This is a debugging command. This command will make the ctdb
daemon to write a fill memory allocation map to standard output.
- </p></div><div class="refsect2"
lang="en"><a name="id2529476"></a><h3>rddumpmemory</h3><p>
+ </p></div><div class="refsect2"
title="rddumpmemory"><a name="id541305"></a><h3>rddumpmemory</h3><p>
This is a debugging command. This command will dump the talloc memory
allocation tree for the recovery daemon to standard output.
- </p></div><div class="refsect2" lang="en"><a name="id2529487"></a><h3>freeze</h3><p>
- This command will lock all the local TDB databases causing clients
- that are accessing these TDBs such as samba3 to block until the
- databases are thawed.
- </p><p>
- This is primarily used by the recovery daemon to stop all samba
- daemons from accessing any databases while the database is recovered
- and rebuilt.
- </p></div><div class="refsect2" lang="en"><a name="id2529506"></a><h3>thaw</h3><p>
+ </p></div><div class="refsect2" title="thaw"><a name="id541315"></a><h3>thaw</h3><p>
Thaw a previously frozen node.
- </p></div><div class="refsect2"
lang="en"><a name="id2529515"></a><h3>eventscript <arguments></h3><p>
+ </p></div><div class="refsect2"
title="eventscript <arguments>"><a name="id541323"></a><h3>eventscript <arguments></h3><p>
This is a debugging command. This command can be used to manually
invoke and run the eventscritps with arbitrary arguments.
- </p></div><div class="refsect2" lang="en"><a name="id2529527"></a><h3>backupdb <database> <file></h3><p>
- This command can be used to copy the entire content of a database out to a file. This file can later be read back into ctdb using the restoredb command.
-This is mainly useful for backing up persistent databases such as secrets.tdb and similar.
- </p></div><div class="refsect2" lang="en"><a name="id2529541"></a><h3>restoredb <file></h3><p>
- This command restores a persistent database that was previously backed up using backupdb.
- </p></div></div><div class="refsect1" lang="en"><a name="id2529553"></a><h2>SEE ALSO</h2><p>
+ </p></div><div class="refsect2" title="ban <bantime|0>"><a name="id541333"></a><h3>ban <bantime|0></h3><p>
+ Administratively ban a node for bantime seconds. A bantime of 0 means that the node should be permanently banned.
+ </p><p>
+ 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.
+ </p><p>
+ Nodes are automatically banned if they are the cause of too many
+ cluster recoveries.
+ </p></div><div class="refsect2" title="unban"><a name="id541352"></a><h3>unban</h3><p>
+ This command is used to unban a node that has either been
+ administratively banned using the ban command or has been automatically
+ banned by the recovery daemon.
+ </p></div></div><div class="refsect1" title="SEE ALSO"><a name="id541364"></a><h2>SEE ALSO</h2><p>
ctdbd(1), onnode(1)
<a class="ulink" href="http://ctdb.samba.org/" target="_top">http://ctdb.samba.org/</a>
- </p></div><div class="refsect1"
lang="en"><a name="id2529566"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
+ </p></div><div class="refsect1"
title="COPYRIGHT/LICENSE"><a name="id541376"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
Copyright (C) Andrew Tridgell 2007<br>
Copyright (C) Ronnie sahlberg 2007<br>
<br>
git.samba.org / metze / ctdb / wip.git / blobdiff