update the documentatio n with all the new commands we supprot in the
[sahlberg/ctdb.git] / doc / ctdb.1.html
index 3e9aef61c047b987110dd9df8ff36df9bb06301f..f75d28ca72e35ee6d47e0d0b461a6420ad41fe23 100644 (file)
@@ -112,7 +112,27 @@ hash:2 lmaster:2
 hash:3 lmaster:3
 Recovery mode:NORMAL (0)
 Recovery master:0
-      </pre></div><div class="refsect2" lang="en"><a name="id2528540"></a><h3>ping</h3><p>
+      </pre></div><div class="refsect2" lang="en"><a name="id2528540"></a><h3>recmaster</h3><p>
+        This command shows the pnn of the node which is currently the recmaster.
+      </p></div><div class="refsect2" lang="en"><a name="id2528550"></a><h3>uptime</h3><p>
+        This command shows the uptime for the ctdb daemon. When the last recovery completed and how long the last recovery took. If the "duration" is shown as a negative number, this indicates that there is a recovery in progress and it started that many seconds ago.
+      </p><p>
+       Example: ctdb uptime
+      </p><p>Example output:</p><pre class="screen">
+Current time of node  : Tue Mar 24 18:27:54 2009
+Ctdbd start time      : (000 00:00:05) Tue Mar 24 18:27:49 2009
+Time of last recovery : (000 00:00:05) Tue Mar 24 18:27:49 2009
+Duration of last recovery : 0.000000 seconds
+      </pre></div><div class="refsect2" lang="en"><a name="id2528580"></a><h3>listnodes</h3><p>
+        This command shows lists the ip addresses of all the nodes in the cluster.
+      </p><p>
+       Example: ctdb listnodes
+      </p><p>Example output:</p><pre class="screen">
+10.0.0.71
+10.0.0.72
+10.0.0.73
+10.0.0.74
+      </pre></div><div class="refsect2" lang="en"><a name="id2528604"></a><h3>ping</h3><p>
         This command will "ping" all CTDB daemons in the cluster to verify that they are processing commands correctly.
       </p><p>
        Example: ctdb ping
@@ -123,8 +143,8 @@ 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)
-      </pre></div><div class="refsect2" lang="en"><a name="id2528566"></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.
+      </pre></div><div class="refsect2" lang="en"><a name="id2528630"></a><h3>ip</h3><p>
+        This command will display the list of public addresses that are provided by the cluster and which physical node is currently serving this ip. By default this command will ONLY show those public addresses that are known to the node itself. To see the full list of all public ips across the cluster you must use "ctdb ip -n all".
       </p><p>
        Example: ctdb ip
       </p><p>
@@ -135,7 +155,23 @@ Number of addresses:4
 12.1.1.2         1
 12.1.1.3         2
 12.1.1.4         3
-      </pre></div><div class="refsect2" lang="en"><a name="id2528591"></a><h3>getvar &lt;name&gt;</h3><p>
+      </pre></div><div class="refsect2" lang="en"><a name="id2528658"></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
+      </p><p>
+       Example output:
+      </p><pre class="screen">
+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
+40.vsftpd            Status:OK    Duration:0.045 Tue Mar 24 18:56:57 2009
+41.httpd             Status:OK    Duration:0.039 Tue Mar 24 18:56:57 2009
+50.samba             Status:ERROR    Duration:0.082 Tue Mar 24 18:56:57 2009
+   OUTPUT:ERROR: Samba tcp port 445 is not responding
+      </pre></div><div class="refsect2" lang="en"><a name="id2479836"></a><h3>getvar &lt;name&gt;</h3><p>
         Get the runtime value of a tuneable variable.
       </p><p>
        Example: ctdb getvar MaxRedirectCount
@@ -143,11 +179,11 @@ Number of addresses:4
        Example output:
       </p><pre class="screen">
 MaxRedirectCount    = 3
-      </pre></div><div class="refsect2" lang="en"><a name="id2528610"></a><h3>setvar &lt;name&gt; &lt;value&gt;</h3><p>
+      </pre></div><div class="refsect2" lang="en"><a name="id2528713"></a><h3>setvar &lt;name&gt; &lt;value&gt;</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="id2528625"></a><h3>listvars</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528728"></a><h3>listvars</h3><p>
         List all tuneable variables.
       </p><p>
        Example: ctdb listvars
@@ -169,7 +205,7 @@ MonitorInterval     = 15
 EventScriptTimeout  = 20
 RecoveryGracePeriod = 60
 RecoveryBanPeriod   = 300
-      </pre></div><div class="refsect2" lang="en"><a name="id2528653"></a><h3>lvsmaster</h3><p>
+      </pre></div><div class="refsect2" lang="en"><a name="id2528755"></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.
@@ -180,7 +216,7 @@ RecoveryBanPeriod   = 300
       evenly onto the other nodes in the cluster. This is an alternative to using
       public ip addresses. See the manpage for ctdbd for more information
       about LVS.
-      </p></div><div class="refsect2" lang="en"><a name="id2528675"></a><h3>lvs</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528778"></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.
@@ -194,7 +230,7 @@ RecoveryBanPeriod   = 300
       </p><pre class="screen">
 2:10.0.0.13
 3:10.0.0.14
-      </pre></div><div class="refsect2" lang="en"><a name="id2528705"></a><h3>getcapabilities</h3><p>
+      </pre></div><div class="refsect2" lang="en"><a name="id2528807"></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.
@@ -213,7 +249,7 @@ RecoveryBanPeriod   = 300
 RECMASTER: YES
 LMASTER: YES
 LVS: NO
-      </pre></div><div class="refsect2" lang="en"><a name="id2528741"></a><h3>statistics</h3><p>
+      </pre></div><div class="refsect2" lang="en"><a name="id2528844"></a><h3>statistics</h3><p>
         Collect statistics from the CTDB daemon about how many calls it has served.
       </p><p>
        Example: ctdb statistics
@@ -255,11 +291,11 @@ CTDB version 1
  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="id2528784"></a><h3>statisticsreset</h3><p>
+      </pre></div><div class="refsect2" lang="en"><a name="id2528887"></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="id2528799"></a><h3>getdebug</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528901"></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.
@@ -269,27 +305,40 @@ CTDB version 1
        The list of debug levels from highest to lowest are :
       </p><p>
        EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
-      </p></div><div class="refsect2" lang="en"><a name="id2528825"></a><h3>setdebug &lt;debuglevel&gt;</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528927"></a><h3>setdebug &lt;debuglevel&gt;</h3><p>
         Set the debug level of a node. This controls what information will be logged.
       </p><p>
        The debuglevel is one of EMERG ALERT CRIT ERR WARNING NOTICE INFO DEBUG
-      </p></div><div class="refsect2" lang="en"><a name="id2528840"></a><h3>getpid</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528943"></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="id2528850"></a><h3>disable</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528953"></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="id2528864"></a><h3>enable</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528967"></a><h3>enable</h3><p>
         Re-enable a node that has been administratively disabled.
-      </p></div><div class="refsect2" lang="en"><a name="id2528874"></a><h3>ban &lt;bantime|0&gt;</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528977"></a><h3>ban &lt;bantime|0&gt;</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="id2528898"></a><h3>moveip &lt;public_ip&gt; &lt;node&gt;</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2529000"></a><h3>addip &lt;public_ip/mask&gt; &lt;iface&gt;</h3><p>
+       This command is used to add a new public ip to a node during runtime.
+       This allows public addresses to be added to a cluster without having
+       to restart the ctdb daemons.
+      </p><p>
+       Note that this only updates the runtime instance of ctdb. Any changes will be lost next time ctdb is restarted and the public addresses file is re-read.
+ If you want this change to be permanent you must also update the public addresses file manually.
+      </p></div><div class="refsect2" lang="en"><a name="id2529021"></a><h3>delip &lt;public_ip&gt;</h3><p>
+       This command is used to remove a public ip from a node during runtime.
+       If this public ip is currently hosted by the node it being removed from, the ip will first be failed over to another node, if possible, before it is removed.
+      </p><p>
+       Note that this only updates the runtime instance of ctdb. Any changes will be lost next time ctdb is restarted and the public addresses file is re-read.
+ If you want this change to be permanent you must also update the public addresses file manually.
+      </p></div><div class="refsect2" lang="en"><a name="id2529042"></a><h3>moveip &lt;public_ip&gt; &lt;node&gt;</h3><p>
       This command can be used to manually fail a public ip address to a
       specific node.
       </p><p>
@@ -300,19 +349,24 @@ CTDB version 1
       DeterministicIPs = 0
       </p><p>
       NoIPFailback = 1
-      </p></div><div class="refsect2" lang="en"><a name="id2528922"></a><h3>unban</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2529066"></a><h3>unban</h3><p>
         This command is used to unban a node that has either been 
         administratively banned using the ban command or has been automatically
         banned by the recovery daemon.
-      </p></div><div class="refsect2" lang="en"><a name="id2528934"></a><h3>shutdown</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2529078"></a><h3>shutdown</h3><p>
         This command will shutdown a specific CTDB daemon.
-      </p></div><div class="refsect2" lang="en"><a name="id2528944"></a><h3>recover</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2529088"></a><h3>recover</h3><p>
         This command will trigger the recovery daemon to do a cluster
         recovery.
-      </p></div><div class="refsect2" lang="en"><a name="id2528955"></a><h3>killtcp &lt;srcip:port&gt; &lt;dstip:port&gt;</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2529099"></a><h3>killtcp &lt;srcip:port&gt; &lt;dstip:port&gt;</h3><p>
         This command will kill the specified TCP connection by issuing a
-        TCP RST to the srcip:port endpoint.
-      </p></div><div class="refsect2" lang="en"><a name="id2528966"></a><h3>reloadnodes</h3><p>
+        TCP RST to the srcip:port endpoint. This is a command used by the 
+       ctdb eventscripts.
+      </p></div><div class="refsect2" lang="en"><a name="id2529111"></a><h3>gratiousarp &lt;ip&gt; &lt;interface&gt;</h3><p>
+       This command will send out a gratious arp for the specified interface
+       through the specified interface. This command is mainly used by the
+       ctdb eventscripts.
+      </p></div><div class="refsect2" lang="en"><a name="id2529124"></a><h3>reloadnodes</h3><p>
       This command is used when adding new nodes to an existing cluster and
       to reduce the disruption of this operation. This command should never
       be used except when expanding an existing cluster.
@@ -336,7 +390,7 @@ CTDB version 1
       5, Use 'ctdb status' on all nodes and verify that they now show the additional node.
       </p><p>
       6, Install and configure the new node and bring it online.
-      </p></div><div class="refsect2" lang="en"><a name="id2529018"></a><h3>tickle &lt;srcip:port&gt; &lt;dstip:port&gt;</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2529176"></a><h3>tickle &lt;srcip:port&gt; &lt;dstip:port&gt;</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 
@@ -348,7 +402,10 @@ CTDB version 1
         TCP connection has been disrupted and that the client will need
         to reestablish. This greatly speeds up the time it takes for a client
         to detect and reestablish after an IP failover in the ctdb cluster.
-      </p></div><div class="refsect2" lang="en"><a name="id2529043"></a><h3>repack [max_freelist]</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2529200"></a><h3>gettickles &lt;ip&gt;</h3><p>
+       This command is used to show which TCP connections are registered with
+       CTDB to be "tickled" if there is a failover.
+      </p></div><div class="refsect2" lang="en"><a name="id2529212"></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>
@@ -363,7 +420,7 @@ CTDB version 1
        Example: ctdb repack 1000
       </p><p>
         By default, this operation is issued from the 00.ctdb event script every 5 minutes.
-      </p></div><div class="refsect2" lang="en"><a name="id2529089"></a><h3>vacuum [max_records]</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2529258"></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>
@@ -379,12 +436,12 @@ CTDB version 1
        Example: ctdb vacuum
       </p><p>
         By default, this operation is issued from the 00.ctdb event script every 5 minutes.
-      </p></div></div><div class="refsect1" lang="en"><a name="id2529126"></a><h2>Debugging Commands</h2><p>
+      </p></div></div><div class="refsect1" lang="en"><a name="id2529295"></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="id2529136"></a><h3>process-exists &lt;pid&gt;</h3><p>
+    </p><div class="refsect2" lang="en"><a name="id2529305"></a><h3>process-exists &lt;pid&gt;</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="id2529149"></a><h3>getdbmap</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2529317"></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>
        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.
@@ -403,22 +460,25 @@ dbid:0x2672a57f name:idmap2.tdb path:/var/ctdb/persistent/idmap2.tdb.0 PERSISTEN
 dbid:0xb775fff6 name:secrets.tdb path:/var/ctdb/persistent/secrets.tdb.0 PERSISTENT
 dbid:0xe98e08b6 name:group_mapping.tdb path:/var/ctdb/persistent/group_mapping.tdb.0 PERSISTENT
 dbid:0x7bbbd26c name:passdb.tdb path:/var/ctdb/persistent/passdb.tdb.0 PERSISTENT
-      </pre></div><div class="refsect2" lang="en"><a name="id2529195"></a><h3>catdb &lt;dbname&gt;</h3><p>
+      </pre></div><div class="refsect2" lang="en"><a name="id2529364"></a><h3>catdb &lt;dbname&gt;</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="id2529206"></a><h3>getmonmode</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2529374"></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="id2529236"></a><h3>setmonmode &lt;0|1&gt;</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2529405"></a><h3>setmonmode &lt;0|1&gt;</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="id2529252"></a><h3>attach &lt;dbname&gt;</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2529421"></a><h3>attach &lt;dbname&gt;</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="id2529263"></a><h3>dumpmemory</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2529432"></a><h3>dumpmemory</h3><p>
         This is a debugging command. This command will make the ctdb
         daemon to write a fill memory allocation map to standard output.
-      </p></div><div class="refsect2" lang="en"><a name="id2529275"></a><h3>freeze</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2529444"></a><h3>rddumpmemory</h3><p>
+        This is a debugging command. This command will dump the talloc memory
+       allocation tree for the recovery daemon to standard output.
+      </p></div><div class="refsect2" lang="en"><a name="id2529455"></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.
@@ -426,12 +486,20 @@ dbid:0x7bbbd26c name:passdb.tdb path:/var/ctdb/persistent/passdb.tdb.0 PERSISTEN
         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="id2529293"></a><h3>thaw</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2529473"></a><h3>thaw</h3><p>
         Thaw a previously frozen node.
-      </p></div></div><div class="refsect1" lang="en"><a name="id2529304"></a><h2>SEE ALSO</h2><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2529483"></a><h3>eventscript &lt;arguments&gt;</h3><p>
+        This is a debugging command. This command can be used to manually
+       invoke and run the eventscritps with arbitrary arguments.
+      </p></div><div class="refsect2" lang="en"><a name="id2529495"></a><h3>backupdb &lt;database&gt; &lt;file&gt;</h3><p>
+        This command can be used to copy the entire content of a database out to a file. This file can later be read back into ctdb using the restoredb command.
+This is mainly useful for backing up persistent databases such as secrets.tdb and similar.
+      </p></div><div class="refsect2" lang="en"><a name="id2529509"></a><h3>restoredb &lt;file&gt;</h3><p>
+        This command restores a persistent database that was previously backed up using backupdb.
+      </p></div></div><div class="refsect1" lang="en"><a name="id2529521"></a><h2>SEE ALSO</h2><p>
       ctdbd(1), onnode(1)
       <a class="ulink" href="http://ctdb.samba.org/" target="_top">http://ctdb.samba.org/</a>
-    </p></div><div class="refsect1" lang="en"><a name="id2529317"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
+    </p></div><div class="refsect1" lang="en"><a name="id2529534"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
 Copyright (C) Andrew Tridgell 2007<br>
 Copyright (C) Ronnie sahlberg 2007<br>
 <br>