-'\" t
.\" Title: ctdb
-.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
-.\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/>
-.\" Date: 12/09/2009
+.\" Author:
+.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
+.\" Date: 01/15/2010
.\" Manual:
.\" Source:
-.\" Language: English
.\"
-.TH "CTDB" "1" "12/09/2009" "" ""
-.\" -----------------------------------------------------------------
-.\" * set default formatting
-.\" -----------------------------------------------------------------
+.TH "CTDB" "1" "01/15/2010" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
-.\" -----------------------------------------------------------------
-.\" * MAIN CONTENT STARTS HERE *
-.\" -----------------------------------------------------------------
.SH "NAME"
-ctdb \- clustered tdb database management utility
+ctdb - clustered tdb database management utility
.SH "SYNOPSIS"
-.HP \w'\fBctdb\ [\ OPTIONS\ ]\ COMMAND\ \&.\&.\&.\fR\ 'u
-\fBctdb [ OPTIONS ] COMMAND \&.\&.\&.\fR
-.HP \w'\fBctdb\fR\ 'u
+.HP 29
+\fBctdb [ OPTIONS ] COMMAND \.\.\.\fR
+.HP 5
\fBctdb\fR [\-n\ <node>] [\-Y] [\-t\ <timeout>] [\-T\ <timelimit>] [\-?\ \-\-help] [\-\-usage] [\-d\ \-\-debug=<INTEGER>] [\-\-socket=<filename>]
.SH "DESCRIPTION"
.PP
-ctdb is a utility to view and manage a ctdb cluster\&.
+ctdb is a utility to view and manage a ctdb cluster\.
.SH "OPTIONS"
.PP
\-n <pnn>
.RS 4
-This specifies the physical node number on which to execute the command\&. Default is to run the command on the deamon running on the local host\&.
+This specifies the physical node number on which to execute the command\. Default is to run the command on the deamon running on the local host\.
.sp
-The physical node number is an integer that describes the node in the cluster\&. The first node has physical node number 0\&.
+The physical node number is an integer that describes the node in the cluster\. The first node has physical node number 0\.
.RE
.PP
\-Y
.RS 4
-Produce output in machine readable form for easier parsing by scripts\&. Not all commands support this option\&.
+Produce output in machine readable form for easier parsing by scripts\. Not all commands support this option\.
.RE
.PP
\-t <timeout>
.RS 4
-How long should ctdb wait for the local ctdb daemon to respond to a command before timing out\&. Default is 3 seconds\&.
+How long should ctdb wait for the local ctdb daemon to respond to a command before timing out\. Default is 3 seconds\.
.RE
.PP
\-T <timelimit>
.RS 4
-A limit on how long the ctdb command will run for before it will be aborted\&. When this timelimit has been exceeded the ctdb command will terminate\&.
+A limit on how long the ctdb command will run for before it will be aborted\. When this timelimit has been exceeded the ctdb command will terminate\.
.RE
.PP
\-? \-\-help
.RS 4
-Print some help text to the screen\&.
+Print some help text to the screen\.
.RE
.PP
\-\-usage
.RS 4
-Print useage information to the screen\&.
+Print useage information to the screen\.
.RE
.PP
\-d \-\-debug=<debuglevel>
.RS 4
-Change the debug level for the command\&. Default is 0\&.
+Change the debug level for the command\. Default is 0\.
.RE
.PP
\-\-socket=<filename>
.RS 4
-Specify the socketname to use when connecting to the local ctdb daemon\&. The default is /tmp/ctdb\&.socket \&.
+Specify the socketname to use when connecting to the local ctdb daemon\. The default is /tmp/ctdb\.socket \.
.sp
-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\&.
+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\.
.RE
.SH "ADMINISTRATIVE COMMANDS"
.PP
-These are commands used to monitor and administrate a CTDB cluster\&.
+These are commands used to monitor and administrate a CTDB cluster\.
.SS "pnn"
.PP
-This command displays the pnn of the current node\&.
+This command displays the pnn of the current node\.
.SS "status"
.PP
-This command shows the current status of the ctdb node\&.
+This command shows the current status of the ctdb node\.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-.ps +1
-\fBnode status\fR
-.RS 4
+node status
+.RS
.PP
-Node status reflects the current status of the node\&. There are five possible states:
+Node status reflects the current status of the node\. There are five possible states:
.PP
-OK \- This node is fully functional\&.
+OK \- This node is fully functional\.
.PP
-DISCONNECTED \- This node could not be connected through the network and is currently not participating in the cluster\&. If there is a public IP address associated with this node it should have been taken over by a different node\&. No services are running on this node\&.
+DISCONNECTED \- This node could not be connected through the network and is currently not participating in the cluster\. If there is a public IP address associated with this node it should have been taken over by a different node\. No services are running on this node\.
.PP
-DISABLED \- This node has been administratively disabled\&. This node is still functional and participates in the CTDB cluster but its IP addresses have been taken over by a different node and no services are currently being hosted\&.
+DISABLED \- This node has been administratively disabled\. This node is still functional and participates in the CTDB cluster but its IP addresses have been taken over by a different node and no services are currently being hosted\.
.PP
-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\&.
+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\.
.PP
-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\&.
+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\.
.PP
-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\&.
+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\.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-.ps +1
-\fBgeneration\fR
-.RS 4
+generation
+.RS
.PP
-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\&.
+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\.
.PP
-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\&. CTDBD 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\&.
+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\. CTDBD 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\.
.PP
-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\&.
+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\.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-.ps +1
-\fBVNNMAP\fR
-.RS 4
+VNNMAP
+.RS
.PP
-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\&.
+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\.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-.ps +1
-\fBRecovery mode\fR
-.RS 4
+Recovery mode
+.RS
.PP
-This is the current recovery mode of the cluster\&. There are two possible modes:
+This is the current recovery mode of the cluster\. There are two possible modes:
.PP
-NORMAL \- The cluster is fully operational\&.
+NORMAL \- The cluster is fully operational\.
.PP
-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\&.
+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\.
.PP
-Once the recovery master 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 recovery master 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\&.
+Once the recovery master 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 recovery master 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\.
.PP
-When CTDBD 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\&.
+When CTDBD 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\.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-.ps +1
-\fBRecovery master\fR
-.RS 4
+Recovery master
+.RS
.PP
-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\&.
+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\.
.PP
-Only one node at a time can be the designated recovery master\&. Which node is designated the recovery master is decided by an election process in the recovery daemons running on each node\&.
+Only one node at a time can be the designated recovery master\. Which node is designated the recovery master is decided by an election process in the recovery daemons running on each node\.
.RE
.PP
Example: ctdb status
.PP
Example output:
.sp
-.if n \{\
.RS 4
-.\}
.nf
Number of nodes:4
-pnn:0 11\&.1\&.2\&.200 OK (THIS NODE)
-pnn:1 11\&.1\&.2\&.201 OK
-pnn:2 11\&.1\&.2\&.202 OK
-pnn:3 11\&.1\&.2\&.203 OK
+pnn:0 11\.1\.2\.200 OK (THIS NODE)
+pnn:1 11\.1\.2\.201 OK
+pnn:2 11\.1\.2\.202 OK
+pnn:3 11\.1\.2\.203 OK
Generation:1362079228
Size:4
hash:0 lmaster:0
Recovery master:0
.fi
-.if n \{\
.RE
-.\}
.SS "recmaster"
.PP
-This command shows the pnn of the node which is currently the recmaster\&.
+This command shows the pnn of the node which is currently the recmaster\.
.SS "uptime"
.PP
-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\&.
+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\.
.PP
Example: ctdb uptime
.PP
Example output:
.sp
-.if n \{\
.RS 4
-.\}
.nf
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
+Duration of last recovery/failover: 2\.248552 seconds
.fi
-.if n \{\
.RE
-.\}
.SS "listnodes"
.PP
-This command shows lists the ip addresses of all the nodes in the cluster\&.
+This command shows lists the ip addresses of all the nodes in the cluster\.
.PP
Example: ctdb listnodes
.PP
Example output:
.sp
-.if n \{\
.RS 4
-.\}
.nf
-10\&.0\&.0\&.71
-10\&.0\&.0\&.72
-10\&.0\&.0\&.73
-10\&.0\&.0\&.74
+10\.0\.0\.71
+10\.0\.0\.72
+10\.0\.0\.73
+10\.0\.0\.74
.fi
-.if n \{\
.RE
-.\}
.SS "ping"
.PP
-This command will "ping" all CTDB daemons in the cluster to verify that they are processing commands correctly\&.
+This command will "ping" all CTDB daemons in the cluster to verify that they are processing commands correctly\.
.PP
Example: ctdb ping
.PP
Example output:
.sp
-.if n \{\
.RS 4
-.\}
.nf
-response from 0 time=0\&.000054 sec (3 clients)
-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)
+response from 0 time=0\.000054 sec (3 clients)
+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)
.fi
-.if n \{\
.RE
-.\}
.SS "ip"
.PP
-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"\&.
+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"\.
.PP
Example: ctdb ip
.PP
Example output:
.sp
-.if n \{\
.RS 4
-.\}
.nf
Number of addresses:4
-12\&.1\&.1\&.1 0
-12\&.1\&.1\&.2 1
-12\&.1\&.1\&.3 2
-12\&.1\&.1\&.4 3
+12\.1\.1\.1 0
+12\.1\.1\.2 1
+12\.1\.1\.3 2
+12\.1\.1\.4 3
.fi
-.if n \{\
.RE
-.\}
.SS "scriptstatus"
.PP
-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\&.
+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\.
.PP
Example: ctdb scriptstatus
.PP
Example output:
.sp
-.if n \{\
.RS 4
-.\}
.nf
7 scripts were executed last monitoring cycle
-00\&.ctdb Status:OK Duration:0\&.056 Tue Mar 24 18:56:57 2009
-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
+00\.ctdb Status:OK Duration:0\.056 Tue Mar 24 18:56:57 2009
+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
.fi
-.if n \{\
.RE
-.\}
.SS "disablescript <script>"
.PP
-This command is used to disable an eventscript\&.
+This command is used to disable an eventscript\.
.PP
-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\'\&.
+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\'\.
.SS "enablescript <script>"
.PP
-This command is used to enable an eventscript\&.
+This command is used to enable an eventscript\.
.PP
-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\'\&.
+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\'\.
.SS "getvar <name>"
.PP
-Get the runtime value of a tuneable variable\&.
+Get the runtime value of a tuneable variable\.
.PP
Example: ctdb getvar MaxRedirectCount
.PP
Example output:
.sp
-.if n \{\
.RS 4
-.\}
.nf
MaxRedirectCount = 3
.fi
-.if n \{\
.RE
-.\}
.SS "setvar <name> <value>"
.PP
-Set the runtime value of a tuneable variable\&.
+Set the runtime value of a tuneable variable\.
.PP
Example: ctdb setvar MaxRedirectCount 5
.SS "listvars"
.PP
-List all tuneable variables\&.
+List all tuneable variables\.
.PP
Example: ctdb listvars
.PP
Example output:
.sp
-.if n \{\
.RS 4
-.\}
.nf
MaxRedirectCount = 3
SeqnumInterval = 1000
AllowUnhealthyDBRead = 0
.fi
-.if n \{\
.RE
-.\}
.SS "lvsmaster"
.PP
-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\&.
+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\.
.PP
-LVS is the mode where the entire CTDB/Samba cluster uses a single ip address for the entire cluster\&. In this mode all clients connect to one specific node which will then multiplex/loadbalance the 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\&.
+LVS is the mode where the entire CTDB/Samba cluster uses a single ip address for the entire cluster\. In this mode all clients connect to one specific node which will then multiplex/loadbalance the 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\.
.SS "lvs"
.PP
-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\&.
+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\.
.PP
-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, STOPPED, BANNED or DISABLED\&.
+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, STOPPED, BANNED or DISABLED\.
.PP
Example output:
.sp
-.if n \{\
.RS 4
-.\}
.nf
-2:10\&.0\&.0\&.13
-3:10\&.0\&.0\&.14
+2:10\.0\.0\.13
+3:10\.0\.0\.14
.fi
-.if n \{\
.RE
-.\}
.SS "getcapabilities"
.PP
-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\&.
+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\.
.PP
-RECMASTER and LMASTER capabilities are primarily used when CTDBD is used to create a cluster spanning across WAN links\&. In which case ctdbd acts as a WAN accelerator\&.
+RECMASTER and LMASTER capabilities are primarily used when CTDBD is used to create a cluster spanning across WAN links\. In which case ctdbd acts as a WAN accelerator\.
.PP
-LVS capabile means that the node is participating in LVS, a mode where the entire CTDB cluster uses one single ip address for the entire cluster instead of using public ip address failover\&. This is an alternative to using a loadbalancing layer\-4 switch\&.
+LVS capabile means that the node is participating in LVS, a mode where the entire CTDB cluster uses one single ip address for the entire cluster instead of using public ip address failover\. This is an alternative to using a loadbalancing layer\-4 switch\.
.PP
Example output:
.sp
-.if n \{\
.RS 4
-.\}
.nf
RECMASTER: YES
LMASTER: YES
LVS: NO
.fi
-.if n \{\
.RE
-.\}
.SS "statistics"
.PP
-Collect statistics from the CTDB daemon about how many calls it has served\&.
+Collect statistics from the CTDB daemon about how many calls it has served\.
.PP
Example: ctdb statistics
.PP
Example output:
.sp
-.if n \{\
.RS 4
-.\}
.nf
CTDB version 1
num_clients 3
pending_lockwait_calls 0
memory_used 5040
max_hop_count 0
- max_call_latency 4\&.948321 sec
- max_lockwait_latency 0\&.000000 sec
+ max_call_latency 4\.948321 sec
+ max_lockwait_latency 0\.000000 sec
.fi
-.if n \{\
.RE
-.\}
.SS "statisticsreset"
.PP
-This command is used to clear all statistics counters in a node\&.
+This command is used to clear all statistics counters in a node\.
.PP
Example: ctdb statisticsreset
.SS "getreclock"
.PP
-This command is used to show the filename of the reclock file that is used\&.
+This command is used to show the filename of the reclock file that is used\.
.PP
Example output:
.sp
-.if n \{\
.RS 4
-.\}
.nf
-Reclock file:/gpfs/\&.ctdb/shared
+Reclock file:/gpfs/\.ctdb/shared
.fi
-.if n \{\
.RE
-.\}
.SS "setreclock [filename]"
.PP
-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"\&.
+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"\.
.PP
-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\&.
+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\.
.PP
-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\&.
+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\.
.SS "getdebug"
.PP
-Get the current debug level for the node\&. the debug level controls what information is written to the log file\&.
+Get the current debug level for the node\. the debug level controls what information is written to the log file\.
.PP
-The debug levels are mapped to the corresponding syslog levels\&. When a debug level is set, only those messages at that level and higher levels will be printed\&.
+The debug levels are mapped to the corresponding syslog levels\. When a debug level is set, only those messages at that level and higher levels will be printed\.
.PP
The list of debug levels from highest to lowest are :
.PP
EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
.SS "setdebug <debuglevel>"
.PP
-Set the debug level of a node\&. This controls what information will be logged\&.
+Set the debug level of a node\. This controls what information will be logged\.
.PP
The debuglevel is one of EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
.SS "getpid"
.PP
-This command will return the process id of the ctdb daemon\&.
+This command will return the process id of the ctdb daemon\.
.SS "disable"
.PP
-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\&.
+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\.
.SS "enable"
.PP
-Re\-enable a node that has been administratively disabled\&.
+Re\-enable a node that has been administratively disabled\.
.SS "stop"
.PP
-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\&.
+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\.
.SS "continue"
.PP
-Re\-start a node that has been administratively stopped\&.
+Re\-start a node that has been administratively stopped\.
.SS "addip <public_ip/mask> <iface>"
.PP
-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\&.
+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\.
.PP
-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\&.
+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\.
.SS "delip <public_ip>"
.PP
-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\&.
+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\.
.PP
-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\&.
+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\.
.SS "moveip <public_ip> <node>"
.PP
-This command can be used to manually fail a public ip address to a specific node\&.
+This command can be used to manually fail a public ip address to a specific node\.
.PP
In order to manually override the "automatic" distribution of public ip addresses that ctdb normally provides, this command only works when you have changed the tunables for the daemon to:
.PP
NoIPFailback = 1
.SS "shutdown"
.PP
-This command will shutdown a specific CTDB daemon\&.
+This command will shutdown a specific CTDB daemon\.
.SS "recover"
.PP
-This command will trigger the recovery daemon to do a cluster recovery\&.
+This command will trigger the recovery daemon to do a cluster recovery\.
.SS "ipreallocate"
.PP
-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\&.
+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\.
.SS "setlmasterrole <on|off>"
.PP
-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\&.
+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\.
.PP
-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\&.
+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\.
.PP
-Once this setting has been enabled/disabled, you need to perform a recovery for it to take effect\&.
+Once this setting has been enabled/disabled, you need to perform a recovery for it to take effect\.
.PP
See also "ctdb getcapabilities"
.SS "setrecmasterrole <on|off>"
.PP
-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\&.
+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\.
.PP
-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\&.
+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\.
.PP
See also "ctdb getcapabilities"
.SS "killtcp <srcip:port> <dstip:port>"
.PP
-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\&.
+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\.
.SS "gratiousarp <ip> <interface>"
.PP
-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\&.
+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\.
.SS "reloadnodes"
.PP
-This command is used when adding new nodes, or removing existing nodes from an existing cluster\&.
+This command is used when adding new nodes, or removing existing nodes from an existing cluster\.
.PP
Procedure to add a node:
.PP
-1, To expand an existing cluster, first ensure with \'ctdb status\' that all nodes are up and running and that they are all healthy\&. Do not try to expand a cluster unless it is completely healthy!
+1, To expand an existing cluster, first ensure with \'ctdb status\' that all nodes are up and running and that they are all healthy\. Do not try to expand a cluster unless it is completely healthy!
.PP
-2, On all nodes, edit /etc/ctdb/nodes and add the new node as the last entry to the file\&. The new node MUST be added to the end of this file!
+2, On all nodes, edit /etc/ctdb/nodes and add the new node as the last entry to the file\. The new node MUST be added to the end of this file!
.PP
3, Verify that all the nodes have identical /etc/ctdb/nodes files after you edited them and added the new node!
.PP
-4, Run \'ctdb reloadnodes\' to force all nodes to reload the nodesfile\&.
+4, Run \'ctdb reloadnodes\' to force all nodes to reload the nodesfile\.
.PP
-5, Use \'ctdb status\' on all nodes and verify that they now show the additional node\&.
+5, Use \'ctdb status\' on all nodes and verify that they now show the additional node\.
.PP
-6, Install and configure the new node and bring it online\&.
+6, Install and configure the new node and bring it online\.
.PP
Procedure to remove a node:
.PP
-1, To remove a node from an existing cluster, first ensure with \'ctdb status\' that all nodes, except the node to be deleted, are up and running and that they are all healthy\&. Do not try to remove a node from a cluster unless the cluster is completely healthy!
+1, To remove a node from an existing cluster, first ensure with \'ctdb status\' that all nodes, except the node to be deleted, are up and running and that they are all healthy\. Do not try to remove a node from a cluster unless the cluster is completely healthy!
.PP
-2, Shutdown and poerwoff the node to be removed\&.
+2, Shutdown and poerwoff the node to be removed\.
.PP
-3, On all other nodes, edit the /etc/ctdb/nodes file and comment out the node to be removed\&. Do not delete the line for that node, just comment it out by adding a \'#\' at the beginning of the line\&.
+3, On all other nodes, edit the /etc/ctdb/nodes file and comment out the node to be removed\. Do not delete the line for that node, just comment it out by adding a \'#\' at the beginning of the line\.
.PP
-4, Run \'ctdb reloadnodes\' to force all nodes to reload the nodesfile\&.
+4, Run \'ctdb reloadnodes\' to force all nodes to reload the nodesfile\.
.PP
-5, Use \'ctdb status\' on all nodes and verify that the deleted node no longer shows up in the list\&.\&.
+5, Use \'ctdb status\' on all nodes and verify that the deleted node no longer shows up in the list\.\.
.PP
.SS "tickle <srcip:port> <dstip:port>"
.PP
-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 acknowledge number and will when received by the source host result in it sending an immediate correct ACK back to the other end\&.
+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 acknowledge number and will when received by the source host result in it sending an immediate correct ACK back to the other end\.
.PP
-TCP tickles are useful to "tickle" clients after a IP failover has occured since this will make the client immediately recognize the 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\&.
+TCP tickles are useful to "tickle" clients after a IP failover has occured since this will make the client immediately recognize the 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\.
.SS "gettickles <ip>"
.PP
-This command is used to show which TCP connections are registered with CTDB to be "tickled" if there is a failover\&.
+This command is used to show which TCP connections are registered with CTDB to be "tickled" if there is a failover\.
.SS "repack [max_freelist]"
.PP
-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\&.
+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\.
.PP
-If [max_freelist] is specified, then a database will only be repacked if it has more than this number of entries in the freelist\&.
+If [max_freelist] is specified, then a database will only be repacked if it has more than this number of entries in the freelist\.
.PP
-During repacking of the database, the entire TDB database will be locked to prevent writes\&. If samba tries to write to a record in the database during a repack operation, samba will block until the repacking has completed\&.
+During repacking of the database, the entire TDB database will be locked to prevent writes\. If samba tries to write to a record in the database during a repack operation, samba will block until the repacking has completed\.
.PP
-This command can be disruptive and can cause samba to block for the duration of the repack operation\&. In general, a repack operation will take less than one second to complete\&.
+This command can be disruptive and can cause samba to block for the duration of the repack operation\. In general, a repack operation will take less than one second to complete\.
.PP
-A repack operation will only defragment the local TDB copy of the CTDB database\&. You need to run this command on all of the nodes to repack a CTDB database completely\&.
+A repack operation will only defragment the local TDB copy of the CTDB database\. You need to run this command on all of the nodes to repack a CTDB database completely\.
.PP
Example: ctdb repack 1000
.PP
-By default, this operation is issued from the 00\&.ctdb event script every 5 minutes\&.
+By default, this operation is issued from the 00\.ctdb event script every 5 minutes\.
.SS "vacuum [max_records]"
.PP
-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\&.
+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\.
.PP
-By default, vacuum will delete all empty records from all databases\&. If [max_records] is specified, the command will only delete the first [max_records] empty records for each database\&.
+By default, vacuum will delete all empty records from all databases\. If [max_records] is specified, the command will only delete the first [max_records] empty records for each database\.
.PP
-Vacuum only deletes records where the local node is the lmaster\&. To delete all records from the entire cluster you need to run a vacuum from each node\&. This command is not disruptive\&. Samba is unaffected and will still be able to read/write records normally while the database is being vacuumed\&.
+Vacuum only deletes records where the local node is the lmaster\. To delete all records from the entire cluster you need to run a vacuum from each node\. This command is not disruptive\. Samba is unaffected and will still be able to read/write records normally while the database is being vacuumed\.
.PP
Example: ctdb vacuum
.PP
-By default, this operation is issued from the 00\&.ctdb event script every 5 minutes\&.
+By default, this operation is issued from the 00\.ctdb event script every 5 minutes\.
.SS "backupdb <dbname> <file>"
.PP
-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\&.
+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\.
.SS "restoredb <file>"
.PP
-This command restores a persistent database that was previously backed up using backupdb\&.
+This command restores a persistent database that was previously backed up using backupdb\.
.SS "wipedb <dbname>"
.PP
-This command can be used to remove all content of a database\&.
+This command can be used to remove all content of a database\.
+.SS "getlog <level>"
+.PP
+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)\.
+.PP
+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\.
+.PP
+This command extracts all messages of level or lower log level from memory and prints it to the screen\.
+.SS "clearlog"
+.PP
+This command clears the in\-memory logging ringbuffer\.
.SH "DEBUGGING COMMANDS"
.PP
-These commands are primarily used for CTDB development and testing and should not be used for normal administration\&.
+These commands are primarily used for CTDB development and testing and should not be used for normal administration\.
.SS "process\-exists <pid>"
.PP
-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\&.
+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\.
.SS "getdbmap"
.PP
-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\&.
+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\.
.PP
-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\&.
+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\.
.PP
-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"\&.
+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"\.
.PP
-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\&.
+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\.
.PP
Example: ctdb getdbmap
.PP
Example output:
.sp
-.if n \{\
.RS 4
-.\}
.nf
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: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:0x2672a57f name:idmap2\&.tdb path:/var/ctdb/persistent/idmap2\&.tdb\&.0 PERSISTENT
-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
+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: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:0x2672a57f name:idmap2\.tdb path:/var/ctdb/persistent/idmap2\.tdb\.0 PERSISTENT
+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
.fi
-.if n \{\
.RE
-.\}
.PP
Example output for an unhealthy database:
.sp
-.if n \{\
.RS 4
-.\}
.nf
Number of databases:1
-dbid:0xb775fff6 name:secrets\&.tdb path:/var/ctdb/persistent/secrets\&.tdb\&.0 PERSISTENT UNHEALTHY
+dbid:0xb775fff6 name:secrets\.tdb path:/var/ctdb/persistent/secrets\.tdb\.0 PERSISTENT UNHEALTHY
.fi
-.if n \{\
.RE
-.\}
.PP
Example output for a healthy database as machinereadable output \-Y:
.sp
-.if n \{\
.RS 4
-.\}
.nf
:ID:Name:Path:Persistent:Unhealthy:
-:0x7bbbd26c:passdb\&.tdb:/var/ctdb/persistent/passdb\&.tdb\&.0:1:0:
+:0x7bbbd26c:passdb\.tdb:/var/ctdb/persistent/passdb\.tdb\.0:1:0:
.fi
-.if n \{\
.RE
-.\}
.SS "getdbstatus <dbname>"
.PP
-This command displays more details about a database\&.
+This command displays more details about a database\.
.PP
-Example: ctdb getdbstatus test\&.tdb\&.0
+Example: ctdb getdbstatus test\.tdb\.0
.PP
Example output:
.sp
-.if n \{\
.RS 4
-.\}
.nf
dbid: 0x122224da
-name: test\&.tdb
-path: /var/ctdb/test\&.tdb\&.0
+name: test\.tdb
+path: /var/ctdb/test\.tdb\.0
PERSISTENT: no
HEALTH: OK
.fi
-.if n \{\
.RE
-.\}
.PP
-Example: ctdb getdbstatus registry\&.tdb (with a corrupted TDB)
+Example: ctdb getdbstatus registry\.tdb (with a corrupted TDB)
.PP
Example output:
.sp
-.if n \{\
.RS 4
-.\}
.nf
dbid: 0xf2a58948
-name: registry\&.tdb
-path: /var/ctdb/persistent/registry\&.tdb\&.0
+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\'
+HEALTH: NO\-HEALTHY\-NODES \- ERROR \- Backup of corrupted TDB in \'/var/ctdb/persistent/registry\.tdb\.0\.corrupted\.20091208091949\.0Z\'
.fi
-.if n \{\
.RE
-.\}
.SS "catdb <dbname>"
.PP
-This command will dump a clustered TDB database to the screen\&. This is a debugging command\&.
+This command will dump a clustered TDB database to the screen\. This is a debugging command\.
.SS "dumpdbbackup <backup\-file>"
.PP
-This command will dump the content of database backup to the screen (similar to ctdb catdb)\&. This is a debugging command\&.
+This command will dump the content of database backup to the screen (similar to ctdb catdb)\. This is a debugging command\.
.SS "getmonmode"
.PP
-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\&.
+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\.
.PP
-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\&.
+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\.
.PP
-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\&.
+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\.
.SS "setmonmode <0|1>"
.PP
-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 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\.
.SS "attach <dbname>"
.PP
-This is a debugging command\&. This command will make the CTDB daemon create a new CTDB database and attach to it\&.
+This is a debugging command\. This command will make the CTDB daemon create a new CTDB database and attach to it\.
.SS "dumpmemory"
.PP
-This is a debugging command\&. This command will make the ctdb daemon to write a fill memory allocation map to standard output\&.
+This is a debugging command\. This command will make the ctdb daemon to write a fill memory allocation map to standard output\.
.SS "rddumpmemory"
.PP
-This is a debugging command\&. This command will dump the talloc memory allocation tree for the recovery daemon to standard output\&.
+This is a debugging command\. This command will dump the talloc memory allocation tree for the recovery daemon to standard output\.
.SS "freeze"
.PP
-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\&.
+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\.
.PP
-This is primarily used by the recovery daemon to stop all samba daemons from accessing any databases while the database is recovered and rebuilt\&.
+This is primarily used by the recovery daemon to stop all samba daemons from accessing any databases while the database is recovered and rebuilt\.
.SS "thaw"
.PP
-Thaw a previously frozen node\&.
+Thaw a previously frozen node\.
.SS "eventscript <arguments>"
.PP
-This is a debugging command\&. This command can be used to manually invoke and run the eventscritps with arbitrary arguments\&.
+This is a debugging command\. This command can be used to manually invoke and run the eventscritps with arbitrary arguments\.
.SS "ban <bantime|0>"
.PP
-Administratively ban a node for bantime seconds\&. A bantime of 0 means that the node should be permanently banned\&.
+Administratively ban a node for bantime seconds\. A bantime of 0 means that the node should be permanently banned\.
.PP
-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\&.
+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\.
.PP
-Nodes are automatically banned if they are the cause of too many cluster recoveries\&.
+Nodes are automatically banned if they are the cause of too many cluster recoveries\.
.SS "unban"
.PP
-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\&.
+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\.
.SH "SEE ALSO"
.PP
ctdbd(1), onnode(1)
-\m[blue]\fB\%http://ctdb.samba.org/\fR\m[]
+\fI\%http://ctdb.samba.org/\fR
.SH "COPYRIGHT/LICENSE"
.sp
-.if n \{\
.RS 4
-.\}
.nf
Copyright (C) Andrew Tridgell 2007
Copyright (C) Ronnie sahlberg 2007
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\&.
+your option) any later version\.
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\&.
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\. See the GNU
+General Public License for more details\.
You should have received a copy of the GNU General Public License
-along with this program; if not, see http://www\&.gnu\&.org/licenses/\&.
+along with this program; if not, see http://www\.gnu\.org/licenses/\.
.fi
-.if n \{\
.RE
-.\}
-<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.1"></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="id401775"></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
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="id2478418"></a><h2>DESCRIPTION</h2><p>
ctdb is a utility to view and manage a ctdb cluster.
- </p></div><div class="refsect1"
title="OPTIONS"><a name="id401785"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-n <pnn></span></dt><dd><p>
+ </p></div><div class="refsect1"
lang="en"><a name="id2478428"></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
the local host.
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"
title="Administrative Commands"><a name="id401909"></a><h2>Administrative Commands</h2><p>
+ </p></dd></dl></div></div><div class="refsect1"
lang="en"><a name="id2479699"></a><h2>Administrative Commands</h2><p>
These are commands used to monitor and administrate a CTDB cluster.
- </p><div class="refsect2"
title="pnn"><a name="id401917"></a><h3>pnn</h3><p>
+ </p><div class="refsect2"
lang="en"><a name="id2479708"></a><h3>pnn</h3><p>
This command displays the pnn of the current node.
- </p></div><div class="refsect2"
title="status"><a name="id401926"></a><h3>status</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2479717"></a><h3>status</h3><p>
This command shows the current status of the ctdb node.
- </p><div class="refsect3"
title="node status"><a name="id401934"></a><h4>node status</h4><p>
+ </p><div class="refsect3"
lang="en"><a name="id2479726"></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.
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></div><div class="refsect3"
title="generation"><a name="id401978"></a><h4>generation</h4><p>
+ </p></div><div class="refsect3"
lang="en"><a name="id2479787"></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"
title="VNNMAP"><a name="id402003"></a><h4>VNNMAP</h4><p>
+ </p></div><div class="refsect3"
lang="en"><a name="id2479822"></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"
title="Recovery mode"><a name="id402015"></a><h4>Recovery mode</h4><p>
+ </p></div><div class="refsect3"
lang="en"><a name="id2479836"></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"
title="Recovery master"><a name="id402046"></a><h4>Recovery master</h4><p>
+ </p></div><div class="refsect3"
lang="en"><a name="id2528526"></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"
title="recmaster"><a name="id402078"></a><h3>recmaster</h3><p>
+ </pre></div><div class="refsect2"
lang="en"><a name="id2528562"></a><h3>recmaster</h3><p>
This command shows the pnn of the node which is currently the recmaster.
- </p></div><div class="refsect2"
title="uptime"><a name="id402088"></a><h3>uptime</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2528573"></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
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="id402114"></a><h3>listnodes</h3><p>
+ </pre></div><div class="refsect2"
lang="en"><a name="id2528604"></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"
title="ping"><a name="id402136"></a><h3>ping</h3><p>
+ </pre></div><div class="refsect2"
lang="en"><a name="id2528627"></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"
title="ip"><a name="id402161"></a><h3>ip</h3><p>
+ </pre></div><div class="refsect2"
lang="en"><a name="id2528654"></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
12.1.1.2 1
12.1.1.3 2
12.1.1.4 3
- </pre></div><div class="refsect2"
title="scriptstatus"><a name="id402186"></a><h3>scriptstatus</h3><p>
+ </pre></div><div class="refsect2"
lang="en"><a name="id2528682"></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
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"
title="disablescript <script>"><a name="id402215"></a><h3>disablescript <script></h3><p>
+ </pre></div><div class="refsect2"
lang="en"><a name="id2528718"></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="id402229"></a><h3>enablescript <script></h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2528734"></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="id402243"></a><h3>getvar <name></h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2528751"></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"
title="setvar <name> <value>"><a name="id402264"></a><h3>setvar <name> <value></h3><p>
+ </pre></div><div class="refsect2"
lang="en"><a name="id2528774"></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"
title="listvars"><a name="id402276"></a><h3>listvars</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2528788"></a><h3>listvars</h3><p>
List all tuneable variables.
</p><p>
Example: ctdb listvars
MaxQueueDropMsg = 1000
UseStatusEvents = 0
AllowUnhealthyDBRead = 0
- </pre></div><div class="refsect2"
title="lvsmaster"><a name="id358916"></a><h3>lvsmaster</h3><p>
+ </pre></div><div class="refsect2"
lang="en"><a name="id2528846"></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"
title="lvs"><a name="id358934"></a><h3>lvs</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2528868"></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.
</p><pre class="screen">
2:10.0.0.13
3:10.0.0.14
- </pre></div><div class="refsect2"
title="getcapabilities"><a name="id358960"></a><h3>getcapabilities</h3><p>
+ </pre></div><div class="refsect2"
lang="en"><a name="id2528898"></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"
title="statistics"><a name="id358990"></a><h3>statistics</h3><p>
+ </pre></div><div class="refsect2"
lang="en"><a name="id2528935"></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"
title="statisticsreset"><a name="id359033"></a><h3>statisticsreset</h3><p>
+ </pre></div><div class="refsect2"
lang="en"><a name="id2528999"></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"
title="getreclock"><a name="id359046"></a><h3>getreclock</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529013"></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="id359064"></a><h3>setreclock [filename]</h3><p>
+ </pre></div><div class="refsect2"
lang="en"><a name="id2529033"></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="id359085"></a><h3>getdebug</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529059"></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"
title="setdebug <debuglevel>"><a name="id359106"></a><h3>setdebug <debuglevel></h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529085"></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"
title="getpid"><a name="id359119"></a><h3>getpid</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529101"></a><h3>getpid</h3><p>
This command will return the process id of the ctdb daemon.
- </p></div><div class="refsect2"
title="disable"><a name="id359128"></a><h3>disable</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529111"></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"
title="enable"><a name="id359140"></a><h3>enable</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529125"></a><h3>enable</h3><p>
Re-enable a node that has been administratively disabled.
- </p></div><div class="refsect2"
title="stop"><a name="id359148"></a><h3>stop</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529135"></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="id359161"></a><h3>continue</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529151"></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="id359169"></a><h3>addip <public_ip/mask> <iface></h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529161"></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"
title="delip <public_ip>"><a name="id359186"></a><h3>delip <public_ip></h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529181"></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"
title="moveip <public_ip> <node>"><a name="id359202"></a><h3>moveip <public_ip> <node></h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529202"></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"
title="shutdown"><a name="id359224"></a><h3>shutdown</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529227"></a><h3>shutdown</h3><p>
This command will shutdown a specific CTDB daemon.
- </p></div><div class="refsect2"
title="recover"><a name="id359233"></a><h3>recover</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529237"></a><h3>recover</h3><p>
This command will trigger the recovery daemon to do a cluster
recovery.
- </p></div><div class="refsect2"
title="ipreallocate"><a name="id359243"></a><h3>ipreallocate</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529247"></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="id359255"></a><h3>setlmasterrole <on|off></h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529263"></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.
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="id359279"></a><h3>setrecmasterrole <on|off></h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529292"></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="id359299"></a><h3>killtcp <srcip:port> <dstip:port></h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529318"></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"
title="gratiousarp <ip> <interface>"><a name="id359310"></a><h3>gratiousarp <ip> <interface></h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529331"></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"
title="reloadnodes"><a name="id359320"></a><h3>reloadnodes</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529343"></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"
title="tickle <srcip:port> <dstip:port>"><a name="id359386"></a><h3>tickle <srcip:port> <dstip:port></h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529427"></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"
title="gettickles <ip>"><a name="id359405"></a><h3>gettickles <ip></h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529452"></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"
title="repack [max_freelist]"><a name="id359415"></a><h3>repack [max_freelist]</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529463"></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"
title="vacuum [max_records]"><a name="id359454"></a><h3>vacuum [max_records]</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529510"></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 class="refsect2"
title="backupdb <dbname> <file>"><a name="id359483"></a><h3>backupdb <dbname> <file></h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529545"></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>"><a name="id359495"></a><h3>restoredb <file></h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2529559"></a><h3>restoredb <file></h3><p>
This command restores a persistent database that was previously backed up using backupdb.
- </p></div><div class="refsect2"
title="wipedb <dbname>"><a name="id403114"></a><h3>wipedb <dbname></h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2476127"></a><h3>wipedb <dbname></h3><p>
This command can be used to remove all content of a database.
- </p></div></div><div class="refsect1" title="Debugging Commands"><a name="id403124"></a><h2>Debugging Commands</h2><p>
+ </p></div></div><div class="refsect2" lang="en"><a name="id2476138"></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" lang="en"><a name="id2476161"></a><h3>clearlog</h3><p>
+ This command clears the in-memory logging ringbuffer.
+ </p></div><div class="refsect1" lang="en"><a name="id2476171"></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"
title="process-exists <pid>"><a name="id403133"></a><h3>process-exists <pid></h3><p>
+ </p><div class="refsect2"
lang="en"><a name="id2476182"></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"
title="getdbmap"><a name="id403143"></a><h3>getdbmap</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2476194"></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
</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="id403208"></a><h3>getdbstatus <dbname></h3><p>
+ </pre></div><div class="refsect2"
lang="en"><a name="id2476279"></a><h3>getdbstatus <dbname></h3><p>
This command displays more details about a database.
</p><p>
Example: ctdb getdbstatus test.tdb.0
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="id403243"></a><h3>catdb <dbname></h3><p>
+ </pre></div><div class="refsect2"
lang="en"><a name="id2476322"></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"
title="dumpdbbackup <backup-file>"><a name="id403252"></a><h3>dumpdbbackup <backup-file></h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2476332"></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="id403262"></a><h3>getmonmode</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2476344"></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"
title="setmonmode <0|1>"><a name="id403285"></a><h3>setmonmode <0|1></h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2476375"></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"
title="attach <dbname>"><a name="id403297"></a><h3>attach <dbname></h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2476390"></a><h3>attach <dbname></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"
title="dumpmemory"><a name="id403307"></a><h3>dumpmemory</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2476402"></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"
title="rddumpmemory"><a name="id403317"></a><h3>rddumpmemory</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2476413"></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"
title="freeze"><a name="id403327"></a><h3>freeze</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2476424"></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.
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"
title="thaw"><a name="id403342"></a><h3>thaw</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2476443"></a><h3>thaw</h3><p>
Thaw a previously frozen node.
- </p></div><div class="refsect2"
title="eventscript <arguments>"><a name="id403350"></a><h3>eventscript <arguments></h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2476452"></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"
title="ban <bantime|0>"><a name="id403360"></a><h3>ban <bantime|0></h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2476464"></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"
title="unban"><a name="id403379"></a><h3>unban</h3><p>
+ </p></div><div class="refsect2"
lang="en"><a name="id2476488"></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="id403390"></a><h2>SEE ALSO</h2><p>
+ </p></div></div><div class="refsect1"
lang="en"><a name="id2476501"></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"
title="COPYRIGHT/LICENSE"><a name="id403403"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
+ </p></div><div class="refsect1"
lang="en"><a name="id2476514"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
Copyright (C) Andrew Tridgell 2007<br>
Copyright (C) Ronnie sahlberg 2007<br>
<br>
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ctdbd</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="ctdbd.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ctdbd — The CTDB cluster daemon</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">ctdbd</code> </p></div><div class="cmdsynopsis"><p><code class="command">ctdbd</code> [-? --help] [-d --debug=<INTEGER>] {--dbdir=<directory>} {--dbdir-persistent=<directory>} [--event-script-dir=<directory>] [-i --interactive] [--listen=<address>] [--logfile=<filename>] [--lvs] {--nlist=<filename>} [--no-lmaster] [--no-recmaster] [--nosetsched] {--notification-script=<filename>} [--public-addresses=<filename>] [--public-interface=<interface>] {--reclock=<filename>} [--single-public-ip=<address>] [--socket=<filename>] [--start-as-disabled] [--start-as-stopped] [--syslog] [--
torture] [--transport=<STRING>] [--usage]</p></div></div><div class="refsect1" lang="en"><a name="id2479664"></a><h2>DESCRIPTION</h2><p>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ctdbd</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="ctdbd.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ctdbd — The CTDB cluster daemon</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">ctdbd</code> </p></div><div class="cmdsynopsis"><p><code class="command">ctdbd</code> [-? --help] [-d --debug=<INTEGER>] {--dbdir=<directory>} {--dbdir-persistent=<directory>} [--event-script-dir=<directory>] [-i --interactive] [--listen=<address>] [--logfile=<filename>] [--lvs] {--nlist=<filename>} [--no-lmaster] [--no-recmaster] [--nosetsched] {--notification-script=<filename>} [--public-addresses=<filename>] [--public-interface=<interface>] {--reclock=<filename>} [--single-public-ip=<address>] [--socket=<filename>] [--start-as-disabled] [--start-as-stopped] [--syslog] [--
log-ringbuf-size=<num-entries>] [--torture] [--transport=<STRING>] [--usage]</p></div></div><div class="refsect1" lang="en"><a name="id2479684"></a><h2>DESCRIPTION</h2><p>
ctdbd is the main ctdb daemon.
</p><p>
ctdbd provides a clustered version of the TDB database with automatic rebuild/recovery of the databases upon nodefailures.
ctdbd provides monitoring of all nodes in the cluster and automatically reconfigures the cluster and recovers upon node failures.
</p><p>
ctdbd is the main component in clustered Samba that provides a high-availability load-sharing CIFS server cluster.
- </p></div><div class="refsect1" lang="en"><a name="id2479
695"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-? --help</span></dt><dd><p>
+ </p></div><div class="refsect1" lang="en"><a name="id2479
715"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-? --help</span></dt><dd><p>
Print some help text to the screen.
</p></dd><dt><span class="term">-d --debug=<DEBUGLEVEL></span></dt><dd><p>
This option sets the debuglevel on the ctdbd daemon which controls what will be written to the logfile. The default is 0 which will only log important events and errors. A larger number will provide additional logging.
reachable/used by any clients.
</p></dd><dt><span class="term">--syslog</span></dt><dd><p>
Send all log messages to syslog instead of to the ctdb logfile.
+ </p></dd><dt><span class="term">--log-ringbuf-size=<num-entries></span></dt><dd><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 in-memory ringbuffer contains a fixed number of the most recent
+ entries. This is settable at startup either through the
+ --log-ringbuf-size argument, or preferably by using
+ CTDB_LOG_RINGBUF_SIZE in the sysconfig file.
+ </p><p>
+ Use the "ctdb getlog" command to access this log.
</p></dd><dt><span class="term">--torture</span></dt><dd><p>
This option is only used for development and testing of ctdbd. It adds artificial errors and failures to the common codepaths in ctdbd to verify that ctdbd can recover correctly for failures.
</p><p>
implemented in the future.
</p></dd><dt><span class="term">--usage</span></dt><dd><p>
Print useage information to the screen.
- </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2528
852"></a><h2>Private vs Public addresses</h2><p>
+ </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2528
910"></a><h2>Private vs Public addresses</h2><p>
When used for ip takeover in a HA environment, each node in a ctdb
cluster has multiple ip addresses assigned to it. One private and one or more public.
- </p><div class="refsect2" lang="en"><a name="id2528
863"></a><h3>Private address</h3><p>
+ </p><div class="refsect2" lang="en"><a name="id2528
921"></a><h3>Private address</h3><p>
This is the physical ip address of the node which is configured in
linux and attached to a physical interface. This address uniquely
identifies a physical node in the cluster and is the ip addresses
10.1.1.2
10.1.1.3
10.1.1.4
- </pre></div><div class="refsect2" lang="en"><a name="id25289
11"></a><h3>Public address</h3><p>
+ </pre></div><div class="refsect2" lang="en"><a name="id25289
69"></a><h3>Public address</h3><p>
A public address on the other hand is not attached to an interface.
This address is managed by ctdbd itself and is attached/detached to
a physical node at runtime.
unavailable. 10.1.1.1 can not be failed over to node 2 or node 3 since
these nodes do not have this ip address listed in their public
addresses file.
- </p></div></div><div class="refsect1" lang="en"><a name="id252
8993"></a><h2>Node status</h2><p>
+ </p></div></div><div class="refsect1" lang="en"><a name="id252
9051"></a><h2>Node status</h2><p>
The current status of each node in the cluster can be viewed by the
'ctdb status' command.
</p><p>
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></div><div class="refsect1" lang="en"><a name="id2529
059"></a><h2>PUBLIC TUNABLES</h2><p>
+ </p></div><div class="refsect1" lang="en"><a name="id2529
117"></a><h2>PUBLIC TUNABLES</h2><p>
These are the public tuneables that can be used to control how ctdb behaves.
- </p><div class="refsect2" lang="en"><a name="id2529
070"></a><h3>KeepaliveInterval</h3><p>Default: 1</p><p>
+ </p><div class="refsect2" lang="en"><a name="id2529
127"></a><h3>KeepaliveInterval</h3><p>Default: 1</p><p>
How often should the nodes send keepalives to eachother.
- </p></div><div class="refsect2" lang="en"><a name="id2529
083"></a><h3>KeepaliveLimit</h3><p>Default: 5</p><p>
+ </p></div><div class="refsect2" lang="en"><a name="id2529
141"></a><h3>KeepaliveLimit</h3><p>Default: 5</p><p>
After how many keepalive intervals without any traffic should a node
wait until marking the peer as DISCONNECTED.
- </p></div><div class="refsect2" lang="en"><a name="id2529
098"></a><h3>MonitorInterval</h3><p>Default: 15</p><p>
+ </p></div><div class="refsect2" lang="en"><a name="id2529
156"></a><h3>MonitorInterval</h3><p>Default: 15</p><p>
How often should ctdb run the event scripts to check for a nodes health.
- </p></div><div class="refsect2" lang="en"><a name="id25291
12"></a><h3>TickleUpdateInterval</h3><p>Default: 20</p><p>
+ </p></div><div class="refsect2" lang="en"><a name="id25291
70"></a><h3>TickleUpdateInterval</h3><p>Default: 20</p><p>
How often will ctdb record and store the "tickle" information used to
kickstart stalled tcp connections after a recovery.
- </p></div><div class="refsect2" lang="en"><a name="id25291
26"></a><h3>EventScriptTimeout</h3><p>Default: 20</p><p>
+ </p></div><div class="refsect2" lang="en"><a name="id25291
84"></a><h3>EventScriptTimeout</h3><p>Default: 20</p><p>
How long should ctdb let an event script run before aborting it and
marking the node unhealthy.
- </p></div><div class="refsect2" lang="en"><a name="id25291
40"></a><h3>RecoveryBanPeriod</h3><p>Default: 300</p><p>
+ </p></div><div class="refsect2" lang="en"><a name="id25291
98"></a><h3>RecoveryBanPeriod</h3><p>Default: 300</p><p>
If a node becomes banned causing repetitive recovery failures. The node will
eventually become banned from the cluster.
This controls how long the culprit node will be banned from the cluster
before it is allowed to try to join the cluster again.
Dont set to small. A node gets banned for a reason and it is usually due
to real problems with the node.
- </p></div><div class="refsect2" lang="en"><a name="id2529
160"></a><h3>DatabaseHashSize</h3><p>Default: 100000</p><p>
+ </p></div><div class="refsect2" lang="en"><a name="id2529
217"></a><h3>DatabaseHashSize</h3><p>Default: 100000</p><p>
Size of the hash chains for the local store of the tdbs that ctdb manages.
- </p></div><div class="refsect2" lang="en"><a name="id2529
174"></a><h3>RerecoveryTimeout</h3><p>Default: 10</p><p>
+ </p></div><div class="refsect2" lang="en"><a name="id2529
232"></a><h3>RerecoveryTimeout</h3><p>Default: 10</p><p>
Once a recovery has completed, no additional recoveries are permitted until this timeout has expired.
- </p></div><div class="refsect2" lang="en"><a name="id2529
188"></a><h3>EnableBans</h3><p>Default: 1</p><p>
+ </p></div><div class="refsect2" lang="en"><a name="id2529
246"></a><h3>EnableBans</h3><p>Default: 1</p><p>
When set to 0, this disables BANNING completely in the cluster and thus nodes can not get banned, even it they break. Dont set to 0.
- </p></div><div class="refsect2" lang="en"><a name="id25292
03"></a><h3>DeterministicIPs</h3><p>Default: 1</p><p>
+ </p></div><div class="refsect2" lang="en"><a name="id25292
61"></a><h3>DeterministicIPs</h3><p>Default: 1</p><p>
When enabled, this tunable makes ctdb try to keep public IP addresses locked to specific nodes as far as possible. This makes it easier for debugging since you can know that as long as all nodes are healthy public IP X will always be hosted by node Y.
</p><p>
The cost of using deterministic IP address assignment is that it disables part of the logic where ctdb tries to reduce the number of public IP assignment changes in the cluster. This tunable may increase the number of IP failover/failbacks that are performed on the cluster by a small margin.
- </p></div><div class="refsect2" lang="en"><a name="id25292
28"></a><h3>DisableWhenUnhealthy</h3><p>Default: 0</p><p>
+ </p></div><div class="refsect2" lang="en"><a name="id25292
86"></a><h3>DisableWhenUnhealthy</h3><p>Default: 0</p><p>
When set, As soon as a node becomes unhealthy, that node will also automatically become permanently DISABLED. Once a node is DISABLED, the only way to make it participate in the cluster again and host services is by manually enabling the node again using 'ctdb enable'.
</p><p>
This disables parts of the resilience and robustness of the cluster and should ONLY be used when the system administrator is actively monitoring the cluster, so that nodes can be enabled again.
- </p></div><div class="refsect2" lang="en"><a name="id2529
252"></a><h3>NoIPFailback</h3><p>Default: 0</p><p>
+ </p></div><div class="refsect2" lang="en"><a name="id2529
310"></a><h3>NoIPFailback</h3><p>Default: 0</p><p>
When set to 1, ctdb will not perform failback of IP addresses when a node becomes healthy. Ctdb WILL perform failover of public IP addresses when a node becomes UNHEALTHY, but when the node becomes HEALTHY again, ctdb will not fail the addresses back.
</p><p>
Use with caution! Normally when a node becomes available to the cluster
ctdb will try to reassign public IP addresses onto the new node as a way to distribute the workload evenly across the clusternode. Ctdb tries to make sure that all running nodes have approximately the same number of public addresses it hosts.
</p><p>
When you enable this tunable, CTDB will no longer attempt to rebalance the cluster by failing IP addresses back to the new nodes. An unbalanced cluster will therefore remain unbalanced until there is manual intervention from the administrator. When this parameter is set, you can manually fail public IP addresses over to the new node(s) using the 'ctdb moveip' command.
- </p></div></div><div class="refsect1" lang="en"><a name="id2529
288"></a><h2>LVS</h2><p>
+ </p></div></div><div class="refsect1" lang="en"><a name="id2529
346"></a><h2>LVS</h2><p>
LVS is a mode where CTDB presents one single IP address for the entire
cluster. This is an alternative to using public IP addresses and round-robin
DNS to loadbalance clients across the cluster.
the processing node back to the clients. For read-intensive i/o patterns you can acheive very high throughput rates in this mode.
</p><p>
Note: you can use LVS and public addresses at the same time.
- </p><div class="refsect2" lang="en"><a name="id2529
360"></a><h3>Configuration</h3><p>
+ </p><div class="refsect2" lang="en"><a name="id2529
426"></a><h3>Configuration</h3><p>
To activate LVS on a CTDB node you must specify CTDB_PUBLIC_INTERFACE and
CTDB_LVS_PUBLIC_ADDRESS in /etc/sysconfig/ctdb.
</p><p>
all of the clients from the node BEFORE you enable LVS. Also make sure
that when you ping these hosts that the traffic is routed out through the
eth0 interface.
- </p></div><div class="refsect1" lang="en"><a name="id25294
08"></a><h2>REMOTE CLUSTER NODES</h2><p>
+ </p></div><div class="refsect1" lang="en"><a name="id25294
74"></a><h2>REMOTE CLUSTER NODES</h2><p>
It is possible to have a CTDB cluster that spans across a WAN link.
For example where you have a CTDB cluster in your datacentre but you also
want to have one additional CTDB node located at a remote branch site.
</p><p>
Verify with the command "ctdb getcapabilities" that that node no longer
has the recmaster or the lmaster capabilities.
- </p></div><div class="refsect1" lang="en"><a name="id2529
459"></a><h2>NAT-GW</h2><p>
+ </p></div><div class="refsect1" lang="en"><a name="id2529
524"></a><h2>NAT-GW</h2><p>
Sometimes it is desireable to run services on the CTDB node which will
need to originate outgoing traffic to external servers. This might
be contacting NIS servers, LDAP servers etc. etc.
if there are no public addresses assigned to the node.
This is the simplest way but it uses up a lot of ip addresses since you
have to assign both static and also public addresses to each node.
- </p><div class="refsect2" lang="en"><a name="id2529
499"></a><h3>NAT-GW</h3><p>
+ </p><div class="refsect2" lang="en"><a name="id2529
565"></a><h3>NAT-GW</h3><p>
A second way is to use the built in NAT-GW feature in CTDB.
With NAT-GW you assign one public NATGW address for each natgw group.
Each NATGW group is a set of nodes in the cluster that shares the same
In each NATGW group, one of the nodes is designated the NAT Gateway
through which all traffic that is originated by nodes in this group
will be routed through if a public addresses are not available.
- </p></div><div class="refsect2" lang="en"><a name="id2
529529"></a><h3>Configuration</h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id2
476149"></a><h3>Configuration</h3><p>
NAT-GW is configured in /etc/sysconfigctdb by setting the following
variables:
</p><pre class="screen">
# CTDB_NATGW_DEFAULT_GATEWAY=10.0.0.1
# CTDB_NATGW_PRIVATE_NETWORK=10.1.1.0/24
# CTDB_NATGW_NODES=/etc/ctdb/natgw_nodes
- </pre></div><div class="refsect2" lang="en"><a name="id2
529545"></a><h3>CTDB_NATGW_PUBLIC_IP</h3><p>
+ </pre></div><div class="refsect2" lang="en"><a name="id2
476220"></a><h3>CTDB_NATGW_PUBLIC_IP</h3><p>
This is an ip address in the public network that is used for all outgoing
traffic when the public addresses are not assigned.
This address will be assigned to one of the nodes in the cluster which
will masquerade all traffic for the other nodes.
</p><p>
Format of this parameter is IPADDRESS/NETMASK
- </p></div><div class="refsect2" lang="en"><a name="id2
529563"></a><h3>CTDB_NATGW_PUBLIC_IFACE</h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id2
476237"></a><h3>CTDB_NATGW_PUBLIC_IFACE</h3><p>
This is the physical interface where the CTDB_NATGW_PUBLIC_IP will be
assigned to. This should be an interface connected to the public network.
</p><p>
Format of this parameter is INTERFACE
- </p></div><div class="refsect2" lang="en"><a name="id247
5745"></a><h3>CTDB_NATGW_DEFAULT_GATEWAY</h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id247
6252"></a><h3>CTDB_NATGW_DEFAULT_GATEWAY</h3><p>
This is the default gateway to use on the node that is elected to host
the CTDB_NATGW_PUBLIC_IP. This is the default gateway on the public network.
</p><p>
Format of this parameter is IPADDRESS
- </p></div><div class="refsect2" lang="en"><a name="id247
5761"></a><h3>CTDB_NATGW_PRIVATE_NETWORK</h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id247
6268"></a><h3>CTDB_NATGW_PRIVATE_NETWORK</h3><p>
This is the network/netmask used for the interal private network.
</p><p>
Format of this parameter is IPADDRESS/NETMASK
- </p></div><div class="refsect2" lang="en"><a name="id247
5775"></a><h3>CTDB_NATGW_NODES</h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id247
6282"></a><h3>CTDB_NATGW_NODES</h3><p>
This is the list of all nodes that belong to the same NATGW group
as this node. The default is /etc/ctdb/natgw_nodes.
- </p></div><div class="refsect2" lang="en"><a name="id247
5786"></a><h3>Operation</h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id247
6294"></a><h3>Operation</h3><p>
When the NAT-GW functionality is used, one of the nodes is elected
to act as a NAT router for all the other nodes in the group when
they need to originate traffic to the external public network.
</p><p>
This is implemented in the 11.natgw eventscript. Please see the
eventscript for further information.
- </p></div><div class="refsect2" lang="en"><a name="id247
5818"></a><h3>Removing/Changing NATGW at runtime</h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id247
6325"></a><h3>Removing/Changing NATGW at runtime</h3><p>
The following are the procedures to change/remove a NATGW configuration
at runtime, without having to restart ctdbd.
</p><p>
1, Run 'CTDB_BASE=/etc/ctdb /etc/ctdb/events.d/11.natgw removenatgw'
2, Then change the configuration in /etc/sysconfig/ctdb
3, Run 'CTDB_BASE=/etc/ctdb /etc/ctdb/events.d/11.natgw updatenatgw'
- </pre></div></div><div class="refsect1" lang="en"><a name="id247
5856"></a><h2>NOTIFICATION SCRIPT</h2><p>
+ </pre></div></div><div class="refsect1" lang="en"><a name="id247
6364"></a><h2>NOTIFICATION SCRIPT</h2><p>
Notification scripts are used with ctdb to have a call-out from ctdb
to a user-specified script when certain state changes occur in ctdb.
This is commonly to set up either sending SNMP traps or emails
See /etc/ctdb/notify.sh for an example script.
</p><p>
CTDB currently generates notifications on these state changes:
- </p><div class="refsect2" lang="en"><a name="id247
5887"></a><h3>unhealthy</h3><p>
+ </p><div class="refsect2" lang="en"><a name="id247
6394"></a><h3>unhealthy</h3><p>
This call-out is triggered when the node changes to UNHEALTHY state.
- </p></div><div class="refsect2" lang="en"><a name="id247
5897"></a><h3>healthy</h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id247
6404"></a><h3>healthy</h3><p>
This call-out is triggered when the node changes to HEALTHY state.
- </p></div><div class="refsect2" lang="en"><a name="id247
5907"></a><h3>startup</h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id247
6415"></a><h3>startup</h3><p>
This call-out is triggered when ctdb has started up and all managed services are up and running.
- </p></div></div><div class="refsect1" lang="en"><a name="id247
5919"></a><h2>ClamAV Daemon</h2><p>
+ </p></div></div><div class="refsect1" lang="en"><a name="id247
6426"></a><h2>ClamAV Daemon</h2><p>
CTDB has support to manage the popular anti-virus daemon ClamAV.
This support is implemented through the
eventscript : /etc/ctdb/events.d/31.clamd.
-</p><div class="refsect2" lang="en"><a name="id247
5930"></a><h3>Configuration</h3><p>
+</p><div class="refsect2" lang="en"><a name="id247
6437"></a><h3>Configuration</h3><p>
Start by configuring CLAMAV normally and test that it works. Once this is
done, copy the configuration files over to all the nodes so that all nodes
share identical CLAMAV configurations.
ctdb scriptstatus
</pre><p>
and verify that the 31.clamd eventscript is listed and that it was executed successfully.
-</p></div></div><div class="refsect1" lang="en"><a name="id247
5990"></a><h2>SEE ALSO</h2><p>
+</p></div></div><div class="refsect1" lang="en"><a name="id247
6497"></a><h2>SEE ALSO</h2><p>
ctdb(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="id2476
003"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
+ </p></div><div class="refsect1" lang="en"><a name="id2476
510"></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 / tridge / ctdb.git / commitdiff