"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<refentry id="ctdb.1">
+ <refentryinfo>
+ <author>
+ <contrib>
+ This documentation was written by
+ Ronnie Sahlberg,
+ Amitay Isaacs,
+ Martin Schwenke
+ </contrib>
+ </author>
+
+ <copyright>
+ <year>2007</year>
+ <holder>Andrew Tridgell</holder>
+ <holder>Ronnie Sahlberg</holder>
+ </copyright>
+ <legalnotice>
+ <para>
+ 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.
+ </para>
+ <para>
+ 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.
+ </para>
+ <para>
+ You should have received a copy of the GNU General Public
+ License along with this program; if not, see
+ <ulink url="http://www.gnu.org/licenses"/>.
+ </para>
+ </legalnotice>
+ </refentryinfo>
+
<refmeta>
<refentrytitle>ctdb</refentrytitle>
<manvolnum>1</manvolnum>
</varlistentry>
</variablelist>
</para>
+
+ <para>
+ Commands that reference a database have a
+ <parameter>DB</parameter> argument. This is either a database
+ name, such as <filename>locking.tdb</filename> or a database ID
+ such as "0x42fe72c5".
+ </para>
</refsect1>
<refsect1>
<refsect1>
- <title>Administrative Commands</title>
+ <title>ADMINISTRATIVE COMMANDS</title>
<para>
These are commands used to monitor and administer a CTDB cluster.
</para>
<refsect3>
<title>Example</title>
- <screen format="linespecific">
+ <screen>
# ctdb status
Number of nodes:4
pnn:0 192.168.2.200 OK (THIS NODE)
<refsect3>
<title>Example</title>
- <screen format="linespecific">
+ <screen>
# ctdb nodestatus
pnn:0 10.0.0.30 OK (THIS NODE)
<refsect3>
<title>Example</title>
- <screen format="linespecific">
+ <screen>
# ctdb uptime
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
<refsect3>
<title>Example</title>
- <screen format="linespecific">
+ <screen>
# ctdb listnodes
192.168.2.200
192.168.2.201
<refsect3>
<title>Example</title>
- <screen format="linespecific">
+ <screen>
# ctdb natgwlist
0 192.168.2.200
Number of nodes:4
</para>
<refsect3>
<title>Example</title>
- <screen format="linespecific">
+ <screen>
# ctdb ping -n all
response from 0 time=0.000054 sec (3 clients)
response from 1 time=0.000144 sec (2 clients)
</para>
<refsect3>
<title>Example</title>
- <screen format="linespecific">
+ <screen>
# ctdb ifaces
Interfaces on node 0
name:eth5 link:up references:2
</para>
<refsect3>
<title>Example</title>
- <screen format="linespecific">
+ <screen>
# ctdb ip
Public IPs on node 0
172.31.91.82 node[1] active[] available[eth2,eth3] configured[eth2,eth3]
</para>
<refsect3>
<title>Example</title>
- <screen format="linespecific">
+ <screen>
# ctdb ipinfo 172.31.92.85
Public IP[172.31.92.85] info on node 0
IP:172.31.92.85
</para>
<refsect3>
<title>Example</title>
- <screen format="linespecific">
+ <screen>
# ctdb scriptstatus
7 scripts were executed last monitoring cycle
00.ctdb Status:OK Duration:0.056 Tue Mar 24 18:56:57 2009
</para>
<refsect3>
<title>Example</title>
- <screen format="linespecific">
+ <screen>
# ctdb listvars
MaxRedirectCount = 3
SeqnumInterval = 1000
</para>
<refsect3>
<title>Example</title>
- <screen format="linespecific">
+ <screen>
# ctdb getvar MaxRedirectCount
MaxRedirectCount = 3
</screen>
<para>
Example output:
</para>
- <screen format="linespecific">
+ <screen>
2:10.0.0.13
3:10.0.0.14
</screen>
<para>
Example output:
</para>
- <screen format="linespecific">
+ <screen>
RECMASTER: YES
LMASTER: YES
LVS: NO
</para>
<refsect3>
<title>Example</title>
- <screen format="linespecific">
+ <screen>
# ctdb statistics
CTDB version 1
num_clients 3
</refsect2>
<refsect2>
- <title>dbstatistics <parameter>DBNAME</parameter>|<parameter>HASH</parameter></title>
+ <title>dbstatistics <parameter>DB</parameter></title>
<para>
- Display statistics about the specified database.
+ Display statistics about the database DB.
</para>
<refsect3>
<title>Example</title>
- <screen format="linespecific">
+ <screen>
# ctdb dbstatistics locking.tdb
DB Statistics: locking.tdb
ro_delegations 0
<para>
Example output:
</para>
- <screen format="linespecific">
+ <screen>
Reclock file:/gpfs/.ctdb/shared
</screen>
<refsect3>
<title>Example</title>
- <screen format="linespecific">
+ <screen>
# ctdb getdbmap
Number of databases:10
dbid:0x435d3410 name:notify.tdb path:/var/ctdb/notify.tdb.0
</refsect2>
<refsect2>
- <title>backupdb <parameter>DBNAME</parameter> <parameter>FILE</parameter></title>
+ <title>
+ backupdb
+ <parameter>DB</parameter>
+ <parameter>FILE</parameter>
+ </title>
<para>
- This command can be used to copy the entire content of a database out to a file. This file can later be read back into ctdb using the restoredb command.
- This is mainly useful for backing up persistent databases such as secrets.tdb and similar.
+ Copy the contents of database DB to FILE. FILE can later be
+ read back using <command>restoredb</command>. This is mainly
+ useful for backing up persistent databases such as
+ <filename>secrets.tdb</filename> and similar.
</para>
</refsect2>
<refsect2>
- <title>restoredb <parameter>FILE</parameter> [<parameter>DBNAME</parameter>]</title>
+ <title>
+ restoredb
+ <parameter>FILE</parameter>
+ <optional><parameter>DB</parameter></optional>
+ </title>
<para>
- This command restores a persistent database that was previously backed up using backupdb.
- By default the data will be restored back into the same database as
- it was created from. By specifying dbname you can restore the data
- into a different database.
+ This command restores a persistent database that was
+ previously backed up using backupdb. By default the data will
+ be restored back into the same database as it was created
+ from. By specifying dbname you can restore the data into a
+ different database.
</para>
</refsect2>
</refsect2>
<refsect2>
- <title>setdbreadonly <parameter>DBNAME</parameter>|<parameter>HASH</parameter></title>
+ <title>setdbreadonly <parameter>DB</parameter></title>
<para>
This command will enable the read-only record support for a
database. This is an experimental feature to improve
</refsect2>
<refsect2>
- <title>setdbsticky <parameter>DBNAME</parameter>|<parameter>HASH</parameter></title>
+ <title>setdbsticky <parameter>DB</parameter></title>
<para>
This command will enable the sticky record support for the
specified database. This is an experimental feature to
</refsect1>
<refsect1>
- <title>Internal commands</title>
+ <title>INTERNAL COMMANDS</title>
<para>
Internal commands are used by CTDB's scripts and are not
</para>
<refsect2>
- <title>runstate [setup|first_recovery|startup|running]</title>
- <para>
- Print the runstate of the specified node. Runstates are used
- to serialise important state transitions in CTDB, particularly
- during startup.
- </para>
+ <title>gettickles <parameter>IPADDR</parameter></title>
<para>
- If one or more optional runstate arguments are specified then
- the node must be in one of these runstates for the command to
- succeed.
+ Show TCP connections that are registered with CTDB to be
+ "tickled" if there is a failover.
</para>
- <refsect3>
- <title>Example</title>
- <screen format="linespecific">
-# ctdb runstate
-RUNNING
- </screen>
- </refsect3>
</refsect2>
<refsect2>
- <title>setifacelink <parameter>IFACE</parameter> <parameter>STATUS</parameter></title>
- <para>
- This command will set the status of a network interface.
- The status needs to be "up" or "down". This is typically
- used in the 10.interfaces script in the "monitor" event.
- </para>
+ <title>gratiousarp <parameter>IPADDR</parameter> <parameter>INTERFACE</parameter></title>
<para>
- Example: ctdb setifacelink eth0 up
+ Send out a gratious ARP for the specified interface through
+ the specified interface. This command is mainly used by the
+ ctdb eventscripts.
</para>
</refsect2>
<refsect2>
<title>killtcp</title>
<para>
- This command reads a list of TCP connections, one per line,
- from standard input and terminates each connection. A connection
- is specified as:
+ Read a list of TCP connections, one per line, from standard
+ input and terminate each connection. A connection is
+ specified as:
</para>
<synopsis>
<parameter>SRC-IPADDR</parameter>:<parameter>SRC-PORT</parameter> <parameter>DST-IPADDR</parameter>:<parameter>DST-PORT</parameter>
</synopsis>
<para>
- A connection is terminated by issuing a TCP RST to the
+ Each connection is terminated by issuing a TCP RST to the
SRC-IPADDR:SRC-PORT endpoint.
</para>
<para>
</refsect2>
<refsect2>
- <title>gratiousarp <parameter>IPADDR</parameter> <parameter>INTERFACE</parameter></title>
+ <title>
+ pdelete <parameter>DB</parameter> <parameter>KEY</parameter>
+ </title>
<para>
- 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.
+ Delete KEY from DB.
</para>
</refsect2>
<refsect2>
- <title>tickle <parameter>SRC-IPADDR</parameter>:<parameter>SRC-PORT</parameter> <parameter>DST-IPADDR</parameter>:<parameter>DST-PORT</parameter></title>
+ <title>
+ pfetch <parameter>DB</parameter> <parameter>KEY</parameter>
+ </title>
<para>
- 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.
+ Print the value associated with KEY in DB.
</para>
+ </refsect2>
+
+ <refsect2>
+ <title>
+ pstore
+ <parameter>DB</parameter>
+ <parameter>KEY</parameter>
+ <parameter>FILE</parameter>
+ </title>
<para>
- 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.
+ Store KEY in DB with contents of FILE as the associated value.
</para>
</refsect2>
<refsect2>
- <title>gettickles <parameter>IPADDR</parameter></title>
+ <title>
+ ptrans
+ <parameter>DB</parameter>
+ <optional><parameter>FILE</parameter></optional>
+ </title>
+ <para>
+ Read a list of key-value pairs, one per line from FILE, and
+ store them in DB using a single transaction. An empty value
+ is equivalent to deleting the given key.
+ </para>
<para>
- This command is used to show which TCP connections are registered with
- CTDB to be "tickled" if there is a failover.
+ The key and value should be separated by spaces or tabs. Each
+ key/value should be a printable string enclosed in
+ double-quotes.
</para>
</refsect2>
<refsect2>
- <title>version</title>
+ <title>runstate [setup|first_recovery|startup|running]</title>
<para>
- Displays the CTDB version.
+ Print the runstate of the specified node. Runstates are used
+ to serialise important state transitions in CTDB, particularly
+ during startup.
+ </para>
+ <para>
+ If one or more optional runstate arguments are specified then
+ the node must be in one of these runstates for the command to
+ succeed.
+ </para>
+ <refsect3>
+ <title>Example</title>
+ <screen>
+# ctdb runstate
+RUNNING
+ </screen>
+ </refsect3>
+ </refsect2>
+
+ <refsect2>
+ <title>setifacelink <parameter>IFACE</parameter> up|down</title>
+ <para>
+ Set the internal state of network interface IFACE. This is
+ typically used in the <filename>10.interface</filename> script
+ in the "monitor" event.
+ </para>
+ <para>
+ Example: ctdb setifacelink eth0 up
</para>
</refsect2>
</para>
</refsect2>
+ <refsect2>
+ <title>tickle <parameter>SRC-IPADDR</parameter>:<parameter>SRC-PORT</parameter> <parameter>DST-IPADDR</parameter>:<parameter>DST-PORT</parameter></title>
+ <para>
+ 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.
+ </para>
+ <para>
+ 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.
+ </para>
+ </refsect2>
+
+ <refsect2>
+ <title>version</title>
+ <para>
+ Display the CTDB version.
+ </para>
+ </refsect2>
+
</refsect1>
<refsect1>
- <title>Debugging Commands</title>
+ <title>DEBUGGING COMMANDS</title>
<para>
These commands are primarily used for CTDB development and testing and
should not be used for normal administration.
</refsect2>
<refsect2>
- <title>getdbstatus <parameter>DBNAME</parameter></title>
+ <title>getdbstatus <parameter>DB</parameter></title>
<para>
This command displays more details about a database.
</para>
<refsect3>
<title>Example</title>
- <screen format="linespecific">
+ <screen>
# ctdb getdbstatus test.tdb.0
dbid: 0x122224da
name: test.tdb
</refsect2>
<refsect2>
- <title>catdb <parameter>DBNAME</parameter></title>
+ <title>catdb <parameter>DB</parameter></title>
<para>
- This command will dump a clustered TDB database to the screen. This is a debugging command.
+ Print a dump of the clustered TDB database DB.
</para>
</refsect2>
<refsect2>
- <title>cattdb <parameter>DBNAME</parameter></title>
+ <title>cattdb <parameter>DB</parameter></title>
<para>
- This command will dump the content of the local TDB database to the screen. This is a debugging command.
+ Print a dump of the contents of the local TDB database DB.
</para>
</refsect2>
<refsect2>
- <title>dumpdbbackup <parameter>BACKUP-FILE</parameter></title>
+ <title>dumpdbbackup <parameter>FILE</parameter></title>
<para>
- This command will dump the content of database backup to the screen
- (similar to ctdb catdb). This is a debugging command.
+ Print a dump of the contents from database backup FILE,
+ similar to <command>catdb</command>.
</para>
</refsect2>
<refsect2>
- <title>wipedb <parameter>DBNAME</parameter></title>
+ <title>wipedb <parameter>DB</parameter></title>
<para>
- This command can be used to remove all content of a database.
+ Remove all contents of database DB.
</para>
</refsect2>
</para>
<refsect3>
<title>Example</title>
- <screen format="linespecific">
+ <screen>
# ctdb check_srvids 1 2 3 14765
Server id 0:1 does not exist
Server id 0:2 does not exist
<!-- UNDOCUMENTED: showban stats disablemonitor enablemonitor
isnotrecmaster addtickle deltickle regsrvid unregsrvid chksrvid
getsrvids rebalanceip setdbprio getdbprio msglisten msgsend
- pfetch pstore pdelete tfetch tstore readkey writekey
+ tfetch tstore readkey writekey
checktcpport getdbseqnum ipiface
-->
-
<refsect1>
<title>SEE ALSO</title>
<para>
</para>
</refsect1>
- <refentryinfo>
- <author>
- <contrib>
- This documentation was written by
- Ronnie Sahlberg,
- Amitay Isaacs,
- Martin Schwenke
- </contrib>
- </author>
-
- <copyright>
- <year>2007</year>
- <holder>Andrew Tridgell</holder>
- <holder>Ronnie Sahlberg</holder>
- </copyright>
- <legalnotice>
- <para>
- 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.
- </para>
- <para>
- 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.
- </para>
- <para>
- You should have received a copy of the GNU General Public
- License along with this program; if not, see
- <ulink url="http://www.gnu.org/licenses"/>.
- </para>
- </legalnotice>
- </refentryinfo>
</refentry>
git.samba.org / martins / ctdb.git / commitdiff