-<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.71.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="id2478415"></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><pre class="synopsis">ctdb [-n <node>] [ -Y ] [ -t <timelimit> ] COMMAND ...</pre></div><div class="refsect1" lang="en"><a name="id2517044"></a><h2>DESCRIPTION</h2><p>
- Ctdb is a command line tool to view and modify the status of a running
- ctdb cluster.
- </p></div><div class="refsect1" lang="en"><a name="id2517054"></a><h2>Administrative Commands</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.71.0"></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>] [-? --help] [--usage] [-d --debug=<INTEGER>] [--socket=<filename>]</p></div></div><div class="refsect1" lang="en"><a name="id2478591"></a><h2>DESCRIPTION</h2><p>
+ ctdb is the utility to view and manage a ctdb cluster.
+ </p></div><div class="refsect1" lang="en"><a name="id2478600"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-n <node></span></dt><dd><p>
+ This specifies on which node to execute the command. Default is
+ to run the command on the deamon running on the local host.
+ </p></dd><dt><span class="term">-Y</span></dt><dd><p>
+ Produce output in machinereadable form for easier parsing by scripts. Not all commands support this option.
+ </p></dd><dt><span class="term">-t <timeout></span></dt><dd><p>
+ How long should ctdb wait for a command to complete before timing out. Default is 3 seconds.
+ </p></dd><dt><span class="term">-? --help</span></dt><dd><p>
+ Print some help text to the screen.
+ </p></dd><dt><span class="term">--usage</span></dt><dd><p>
+ Print useage information to the screen.
+ </p></dd><dt><span class="term">-d --debug=<debuglevel></span></dt><dd><p>
+ Change the debug level for the command. Default is 0.
+ </p></dd><dt><span class="term">--socket=<filename></span></dt><dd><p>
+ Specify the socketname to use when connecting to the local ctdb
+ daemon. The default is /tmp/ctdb.socket .
+ </p><p>
+ You only need to specify this parameter if you run multiple ctdb
+ daemons on the same physical host and thus can not use the default
+ name for the domain socket.
+ </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2478716"></a><h2>Administrative Commands</h2><p>
These are commands used to monitor and administrate a CTDB cluster.
- </p><div class="refsect2" lang="en"><a name="id2
517063"></a><h3>status</h3><p>
+ </p><div class="refsect2" lang="en"><a name="id2
478726"></a><h3>status</h3><p>
This command shows the current status of the ctdb node.
- </p><div class="refsect3" lang="en"><a name="id2
517072"></a><h4>node status</h4><p>
+ </p><div class="refsect3" lang="en"><a name="id2
478734"></a><h4>node status</h4><p>
Node status reflects the current status of the node. There are four possible states:
</p><p>
OK - This node is fully functional.
UNHEALTHY - A service provided by this node is malfunctioning and should be investigated. The CTDB daemon itself is operational and participates in the cluster. Its public IP address has been taken over by a different node and no services are currnetly being hosted. All unhealthy nodes should be investigated and require an administrative action to rectify.
</p><p>
BANNED - This node failed too many recovery attempts and has been banned from participating in the cluster for a period of RecoveryBanPeriod seconds. Any public IP address has been taken over by other nodes. This node does not provide any services. All banned nodes should be investigated and require an administrative action to rectify. This node does not perticipate in the CTDB cluster but can still be communicated with. I.e. ctdb commands can be sent to it.
- </p></div><div class="refsect3" lang="en"><a name="id2478
458"></a><h4>generation</h4><p>
+ </p></div><div class="refsect3" lang="en"><a name="id2478
786"></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.
- </p></div><div class="refsect3" lang="en"><a name="id2478
471"></a><h4>VNNMAP</h4><p>
+ </p></div><div class="refsect3" lang="en"><a name="id2478
798"></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 parcipitating in the vnnmap can become lmaster or dmaster for a database record.
- </p></div><div class="refsect3" lang="en"><a name="id2478
485"></a><h4>Recovery mode</h4><p>
+ </p></div><div class="refsect3" lang="en"><a name="id2478
812"></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.
</p><p>
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.
- </p></div><div class="refsect3" lang="en"><a name="id2478
508"></a><h4>Recovery master</h4><p>
+ </p></div><div class="refsect3" lang="en"><a name="id2478
836"></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></div><p>
Example: ctdb status
hash:3 lmaster:3
Recovery mode:NORMAL (0)
Recovery master:0
- </pre></div><div class="refsect2" lang="en"><a name="id2478
538"></a><h3>ping</h3><p>
+ </pre></div><div class="refsect2" lang="en"><a name="id2478
868"></a><h3>ping</h3><p>
This command will "ping" all CTDB daemons in the cluster to verify that they are processing commands correctly.
</p><p>
Example: ctdb ping
response from 1 time=0.000144 sec (2 clients)
response from 2 time=0.000105 sec (2 clients)
response from 3 time=0.000114 sec (2 clients)
- </pre></div><div class="refsect2" lang="en"><a name="id2478
564"></a><h3>ip</h3><p>
+ </pre></div><div class="refsect2" lang="en"><a name="id2478
895"></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.
</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" lang="en"><a name="id2478
589"></a><h3>getvar <name></h3><p>
+ </pre></div><div class="refsect2" lang="en"><a name="id2478
922"></a><h3>getvar <name></h3><p>
Get the runtime value of a tuneable variable.
</p><p>
Example: ctdb getvar MaxRedirectCount
Example output:
</p><pre class="screen">
MaxRedirectCount = 3
- </pre></div><div class="refsect2" lang="en"><a name="id2478
612"></a><h3>setvar <name> <value></h3><p>
+ </pre></div><div class="refsect2" lang="en"><a name="id2478
946"></a><h3>setvar <name> <value></h3><p>
Set the runtime value of a tuneable variable.
</p><p>
Example: ctdb setvar MaxRedirectCount 5
- </p></div><div class="refsect2" lang="en"><a name="id2478
627"></a><h3>listvars</h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id2478
961"></a><h3>listvars</h3><p>
List all tuneable variables.
</p><p>
Example: ctdb listvars
EventScriptTimeout = 20
RecoveryGracePeriod = 60
RecoveryBanPeriod = 300
- </pre></div><div class="refsect2" lang="en"><a name="id2478
656"></a><h3>statistics</h3><p>
+ </pre></div><div class="refsect2" lang="en"><a name="id2478
990"></a><h3>statistics</h3><p>
Collect statistics from the CTDB daemon about how many calls it has served.
</p><p>
Example: ctdb statistics
max_hop_count 0
max_call_latency 4.948321 sec
max_lockwait_latency 0.000000 sec
- </pre></div><div class="refsect2" lang="en"><a name="id247
8678"></a><h3>statisticsreset</h3><p>
+ </pre></div><div class="refsect2" lang="en"><a name="id247
9034"></a><h3>statisticsreset</h3><p>
This command is used to clear all statistics counters in a node.
</p><p>
Example: ctdb statisticsreset
- </p></div><div class="refsect2" lang="en"><a name="id247
8693"></a><h3>getdebug</h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id247
9048"></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></div><div class="refsect2" lang="en"><a name="id247
8704"></a><h3>setdebug <debuglevel></h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id247
9059"></a><h3>setdebug <debuglevel></h3><p>
Set the debug level of a node. This is a number between 0 and 9 and controls what information will be written to the logfile.
- </p></div><div class="refsect2" lang="en"><a name="id247
8716"></a><h3>getpid</h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id247
9070"></a><h3>getpid</h3><p>
This command will return the process id of the ctdb daemon.
- </p></div><div class="refsect2" lang="en"><a name="id247
8880"></a><h3>disable</h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id247
9080"></a><h3>disable</h3><p>
This command is used to administratively disable a node in the cluster.
A disabled node will still participate in the cluster and host
clustered TDB records but its public ip address has been taken over by
a different node and it no longer hosts any services.
- </p></div><div class="refsect2" lang="en"><a name="id247
8894"></a><h3>enable</h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id247
9099"></a><h3>enable</h3><p>
Re-enable a node that has been administratively disabled.
- </p></div><div class="refsect2" lang="en"><a name="id247
8904"></a><h3>ban <bantime|0></h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id247
9109"></a><h3>ban <bantime|0></h3><p>
Administratively ban a node for bantime seconds. A bantime of 0 means that the node should be permanently banned.
</p><p>
A banned node does not participate in the cluster and does not host any records for the clustered TDB. Its ip address has been taken over by an other node and no services are hosted.
</p><p>
Nodes are automatically banned if they are the cause of too many
cluster recoveries.
- </p></div><div class="refsect2" lang="en"><a name="id247
8928"></a><h3>unban</h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id247
9132"></a><h3>unban</h3><p>
This command is used to unban a node that has either been
administratively banned using the ban command or has been automatically
banned by the recovery daemon.
- </p></div><div class="refsect2" lang="en"><a name="id247
8940"></a><h3>shutdown</h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id247
9144"></a><h3>shutdown</h3><p>
This command will shutdown a specific CTDB daemon.
- </p></div><div class="refsect2" lang="en"><a name="id247
8950"></a><h3>recover</h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id247
9154"></a><h3>recover</h3><p>
This command will trigger the recovery daemon to do a cluster
recovery.
- </p></div></div><div class="refsect1" lang="en"><a name="id247
8962"></a><h2>Debugging Commands</h2><p>
+ </p></div></div><div class="refsect1" lang="en"><a name="id247
9165"></a><h2>Debugging Commands</h2><p>
These commands are primarily used for CTDB development and testing and
should not be used for normal administration.
- </p><div class="refsect2" lang="en"><a name="id247
8972"></a><h3>process-exists <pid></h3><p>
+ </p><div class="refsect2" lang="en"><a name="id247
9175"></a><h3>process-exists <pid></h3><p>
This command checks if a specific process exists on the CTDB host. This is mainly used by Samba to check if remote instances of samba are still running or not.
- </p></div><div class="refsect2" lang="en"><a name="id247
8984"></a><h3>getdbmap</h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id247
9187"></a><h3>getdbmap</h3><p>
This command lists all clustered TDB databases that the CTDB daemon has attahced to.
</p><p>
Example: ctdb getdbmap
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
- </pre></div><div class="refsect2" lang="en"><a name="id2479
017"></a><h3>catdb <dbname></h3><p>
+ </pre></div><div class="refsect2" lang="en"><a name="id2479
216"></a><h3>catdb <dbname></h3><p>
This command will dump a clustered TDB database to the screen. This is a debugging command.
- </p></div><div class="refsect2" lang="en"><a name="id2479
028"></a><h3>getmonmode</h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id2479
227"></a><h3>getmonmode</h3><p>
This command returns the monutoring mode of a node. The monitoring mode is either ACTIVE or DISABLED. Normally a node will continously monitor that all other nodes that are expected are in fact connected and that they respond to commands.
</p><p>
ACTIVE - This is the normal mode. The node is actively monitoring all other nodes, both that the transport is connected and also that the node responds to commands. If a node becomes unavailable, it will be marked as DISCONNECTED and a recovery is initiated to restore the cluster.
</p><p>
DISABLED - This node is not monitoring that other nodes are available. In this mode a node failure will not be detected and no recovery will be performed. This mode is useful when for debugging purposes one wants to attach GDB to a ctdb process but wants to prevent the rest of the cluster from marking this node as DISCONNECTED and do a recovery.
- </p></div><div class="refsect2" lang="en"><a name="id2479
059"></a><h3>setmonmode <0|1></h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id2479
258"></a><h3>setmonmode <0|1></h3><p>
This command can be used to explicitely disable/enable monitoring mode on a node. The main purpose is if one wants to attach GDB to a running ctdb daemon but wants to prevent the other nodes from marking it as DISCONNECTED and issuing a recovery. To do this, set monitoring mode to 0 on all nodes before attaching with GDB. Remember to set monitoring mode back to 1 afterwards.
- </p></div><div class="refsect2" lang="en"><a name="id2479
074"></a><h3>attach <dbname></h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id2479
280"></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" lang="en"><a name="id2479
086"></a><h3>dumpmemory</h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id2479
291"></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 the log file.
- </p></div><div class="refsect2" lang="en"><a name="id2479
097"></a><h3>freeze</h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id2479
302"></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" lang="en"><a name="id2479
115"></a><h3>thaw</h3><p>
+ </p></div><div class="refsect2" lang="en"><a name="id2479
320"></a><h3>thaw</h3><p>
Thaw a previously frozen node.
- </p></div></div><div class="refsect1" lang="en"><a name="id24793
44"></a><h2>SEE ALSO</h2><p>
+ </p></div></div><div class="refsect1" lang="en"><a name="id24793
31"></a><h2>SEE ALSO</h2><p>
ctdbd(1), onnode(1)
<a href="http://ctdb.samba.org/" target="_top">http://ctdb.samba.org/</a>
- </p></div><div class="refsect1" lang="en"><a name="id24793
57"></a><h2>COPYRIGHT/LICENSE</h2><p>
+ </p></div><div class="refsect1" lang="en"><a name="id24793
44"></a><h2>COPYRIGHT/LICENSE</h2><p>
Copyright (C) Andrew Tridgell 2007
Copyright (C) Ronnie sahlberg 2007
</p><p>
-<?xml version="1.0"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
-
-<refentry>
- <refmeta>
- <refentrytitle>ctdb</refentrytitle>
- <manvolnum>1</manvolnum>
- </refmeta>
- <refnamediv>
- <refname>ctdb</refname>
-<refpurpose>clustered tdb database management utility</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
-<synopsis>ctdb [-n <node>] [ -Y ] [ -t <timelimit> ] COMMAND ...</synopsis>
- </refsynopsisdiv>
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
+<refentry id="ctdb.1">
+
+<refmeta>
+ <refentrytitle>ctdb</refentrytitle>
+ <manvolnum>1</manvolnum>
+</refmeta>
+
+
+<refnamediv>
+ <refname>ctdb</refname>
+ <refpurpose>clustered tdb database management utility</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+ <cmdsynopsis>
+ <command>ctdb [ OPTIONS ] COMMAND ...</command>
+ </cmdsynopsis>
+
+ <cmdsynopsis>
+ <command>ctdb</command>
+ <arg choice="opt">-n <node></arg>
+ <arg choice="opt">-Y</arg>
+ <arg choice="opt">-t <timeout></arg>
+ <arg choice="opt">-? --help</arg>
+ <arg choice="opt">--usage</arg>
+ <arg choice="opt">-d --debug=<INTEGER></arg>
+ <arg choice="opt">--socket=<filename></arg>
+ </cmdsynopsis>
+
+</refsynopsisdiv>
+
<refsect1><title>DESCRIPTION</title>
<para>
- Ctdb is a command line tool to view and modify the status of a running
- ctdb cluster.
+ ctdb is a utility to view and manage a ctdb cluster.
</para>
</refsect1>
+ <refsect1>
+ <title>OPTIONS</title>
+
+ <variablelist>
+ <varlistentry><term>-n <node></term>
+ <listitem>
+ <para>
+ This specifies on which node to execute the command. Default is
+ to run the command on the deamon running on the local host.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry><term>-Y</term>
+ <listitem>
+ <para>
+ Produce output in machinereadable form for easier parsing by scripts. Not all commands support this option.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry><term>-t <timeout></term>
+ <listitem>
+ <para>
+ How long should ctdb wait for a command to complete before timing out. Default is 3 seconds.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry><term>-? --help</term>
+ <listitem>
+ <para>
+ Print some help text to the screen.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry><term>--usage</term>
+ <listitem>
+ <para>
+ Print useage information to the screen.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry><term>-d --debug=<debuglevel></term>
+ <listitem>
+ <para>
+ Change the debug level for the command. Default is 0.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry><term>--socket=<filename></term>
+ <listitem>
+ <para>
+ Specify the socketname to use when connecting to the local ctdb
+ daemon. The default is /tmp/ctdb.socket .
+ </para>
+ <para>
+ 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.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ </variablelist>
+ </refsect1>
+
+
<refsect1><title>Administrative Commands</title>
<para>
These are commands used to monitor and administrate a CTDB cluster.
git.samba.org / metze / ctdb / wip.git / commitdiff