<refmeta>
<refentrytitle>ctdb</refentrytitle>
<manvolnum>1</manvolnum>
+ <refmiscinfo class="source">ctdb</refmiscinfo>
+ <refmiscinfo class="manual">CTDB - clustered TDB database</refmiscinfo>
</refmeta>
<listitem>
<para>
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.
</para>
<para>
<para>
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.
</para>
+ <para>
+ 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.
+ </para>
+ <para>
+ 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".
+ </para>
</refsect3>
<refsect3><title>generation</title>
<refsect2><title>uptime</title>
<para>
- 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.
+ 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>
<para>
</para>
<para>Example output:</para>
<screen format="linespecific">
-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
+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>
</refsect2>
</screen>
</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>
+ <para>
+ Example: ctdb ifaces
+ </para>
+ <para>
+ Example output:
+ </para>
+ <screen format="linespecific">
+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
+ </screen>
+ <para>
+ Example: ctdb ifaces -Y
+ </para>
+ <para>
+ Example output:
+ </para>
+ <screen format="linespecific">
+:Name:LinkStatus:References:
+:eth5:1:2
+:eth4:0:0
+:eth3:1:1
+:eth2:1:1
+ </screen>
+ </refsect2>
+
+ <refsect2><title>setifacelink <iface> <status></title>
+ <para>
+ 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.
+ </para>
+ <para>
+ Example: ctdb setifacelink eth0 up
+ </para>
+ </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 -n all".
Example output:
</para>
<screen format="linespecific">
-Number of addresses:4
-12.1.1.1 0
-12.1.1.2 1
-12.1.1.3 2
-12.1.1.4 3
+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]
+ </screen>
+ <para>
+ Example: ctdb ip -Y
+ </para>
+ <para>
+ Example output:
+ </para>
+ <screen format="linespecific">
+: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>
+ </refsect2>
+
+ <refsect2><title>ipinfo <ip></title>
+ <para>
+ This command will display details about the specified public addresses.
+ </para>
+ <para>
+ Example: ctdb ipinfo 172.31.92.85
+ </para>
+ <para>
+ Example output:
+ </para>
+ <screen format="linespecific">
+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>
</refsect2>
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
</screen>
</refsect2>
+ <refsect2><title>disablescript <script></title>
+ <para>
+ This command is used to disable an eventscript.
+ </para>
+ <para>
+ 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'.
+ </para>
+ </refsect2>
+
+ <refsect2><title>enablescript <script></title>
+ <para>
+ This command is used to enable an eventscript.
+ </para>
+ <para>
+ 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'.
+ </para>
+ </refsect2>
+
<refsect2><title>getvar <name></title>
<para>
Get the runtime value of a tuneable variable.
Example output:
</para>
<screen format="linespecific">
-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
+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
</screen>
</refsect2>
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.
</para>
<para>
</para>
</refsect2>
+ <refsect2><title>getreclock</title>
+ <para>
+ This command is used to show the filename of the reclock file that is used.
+ </para>
+
+ <para>
+ Example output:
+ </para>
+ <screen format="linespecific">
+Reclock file:/gpfs/.ctdb/shared
+ </screen>
+
+ </refsect2>
+
+ <refsect2><title>setreclock [filename]</title>
+ <para>
+ 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".
+ </para>
+
+ <para>
+ 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.
+ </para>
+
+ <para>
+ 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.
+ </para>
+ </refsect2>
+
+
+
<refsect2><title>getdebug</title>
<para>
Get the current debug level for the node. the debug level controls what information is written to the log file.
</para>
</refsect2>
- <refsect2><title>ban <bantime|0></title>
+ <refsect2><title>stop</title>
<para>
- Administratively ban a node for bantime seconds. A bantime of 0 means that the node should be permanently banned.
+ 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.
</para>
+ </refsect2>
+
+ <refsect2><title>continue</title>
<para>
- 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.
- </para>
- <para>
- Nodes are automatically banned if they are the cause of too many
- cluster recoveries.
+ Re-start a node that has been administratively stopped.
</para>
</refsect2>
</para>
</refsect2>
- <refsect2><title>unban</title>
- <para>
- 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.
- </para>
- </refsect2>
-
<refsect2><title>shutdown</title>
<para>
This command will shutdown a specific CTDB daemon.
</para>
</refsect2>
+ <refsect2><title>ipreallocate</title>
+ <para>
+ 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.
+ </para>
+ </refsect2>
+
+ <refsect2><title>setlmasterrole <on|off></title>
+ <para>
+ 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.
+ </para>
+
+ <para>
+ 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.
+ </para>
+ <para>
+ Once this setting has been enabled/disabled, you need to perform a recovery for it to take effect.
+ </para>
+ <para>
+ See also "ctdb getcapabilities"
+ </para>
+ </refsect2>
+
+ <refsect2><title>setrecmasterrole <on|off></title>
+ <para>
+ 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.
+ </para>
+
+ <para>
+ 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.
+ </para>
+ <para>
+ See also "ctdb getcapabilities"
+ </para>
+ </refsect2>
+
<refsect2><title>killtcp <srcip:port> <dstip:port></title>
<para>
This command will kill the specified TCP connection by issuing a
</para>
</refsect2>
+ <refsect2><title>backupdb <dbname> <file></title>
+ <para>
+ 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.
+ </para>
+ </refsect2>
+
+ <refsect2><title>restoredb <file> [dbname]</title>
+ <para>
+ 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.
+ </para>
+ </refsect2>
+
+ <refsect2><title>wipedb <dbname></title>
+ <para>
+ This command can be used to remove all content of a database.
+ </para>
+ </refsect2>
</refsect1>
+ <refsect2><title>getlog <level></title>
+ <para>
+ 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).
+ </para><para>
+ 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.
+ </para><para>
+ This command extracts all messages of level or lower log level from
+ memory and prints it to the screen.
+ </para>
+ </refsect2>
+
+ <refsect2><title>clearlog</title>
+ <para>
+ This command clears the in-memory logging ringbuffer.
+ </para>
+ </refsect2>
+
+
<refsect1><title>Debugging Commands</title>
<para>
These commands are primarily used for CTDB development and testing and
<refsect2><title>getdbmap</title>
<para>
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.
+ </para>
+ <para>
+ 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.
+ </para>
+ <para>
+ 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".
</para>
<para>
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.
<screen format="linespecific">
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: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
</screen>
+ <para>
+ Example output for an unhealthy database:
+ </para>
+ <screen format="linespecific">
+Number of databases:1
+dbid:0xb775fff6 name:secrets.tdb path:/var/ctdb/persistent/secrets.tdb.0 PERSISTENT UNHEALTHY
+ </screen>
+
+ <para>
+ Example output for a healthy database as machinereadable output -Y:
+ </para>
+ <screen format="linespecific">
+:ID:Name:Path:Persistent:Unhealthy:
+:0x7bbbd26c:passdb.tdb:/var/ctdb/persistent/passdb.tdb.0:1:0:
+ </screen>
+ </refsect2>
+
+ <refsect2><title>getdbstatus <dbname></title>
+ <para>
+ This command displays more details about a database.
+ </para>
+ <para>
+ Example: ctdb getdbstatus test.tdb.0
+ </para>
+ <para>
+ Example output:
+ </para>
+ <screen format="linespecific">
+dbid: 0x122224da
+name: test.tdb
+path: /var/ctdb/test.tdb.0
+PERSISTENT: no
+HEALTH: OK
+ </screen>
+ <para>
+ Example: ctdb getdbstatus registry.tdb (with a corrupted TDB)
+ </para>
+ <para>
+ Example output:
+ </para>
+ <screen format="linespecific">
+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'
+ </screen>
</refsect2>
<refsect2><title>catdb <dbname></title>
</para>
</refsect2>
+ <refsect2><title>dumpdbbackup <backup-file></title>
+ <para>
+ This command will dump the content of database backup to the screen
+ (similar to ctdb catdb). This is a debugging command.
+ </para>
+ </refsect2>
+
<refsect2><title>getmonmode</title>
<para>
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.
<refsect2><title>setmonmode <0|1></title>
<para>
- 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.
+ 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.
</para>
</refsect2>
</para>
</refsect2>
- <refsect2><title>freeze</title>
- <para>
- 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.
- </para>
- <para>
- This is primarily used by the recovery daemon to stop all samba
- daemons from accessing any databases while the database is recovered
- and rebuilt.
- </para>
- </refsect2>
-
<refsect2><title>thaw</title>
<para>
Thaw a previously frozen node.
</para>
</refsect2>
- <refsect2><title>backupdb <database> <file></title>
+ <refsect2><title>ban <bantime|0></title>
<para>
- 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.
+ Administratively ban a node for bantime seconds. A bantime of 0 means that the node should be permanently banned.
+ </para>
+ <para>
+ 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.
+ </para>
+ <para>
+ Nodes are automatically banned if they are the cause of too many
+ cluster recoveries.
</para>
</refsect2>
- <refsect2><title>restoredb <file></title>
+ <refsect2><title>unban</title>
<para>
- This command restores a persistent database that was previously backed up using backupdb.
+ 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.
</para>
</refsect2>
git.samba.org / sahlberg / ctdb.git / blobdiff