summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Schwenke <martin@meltin.net>2008-09-12 18:20:52 +1000
committerMartin Schwenke <martin@meltin.net>2008-09-12 18:22:41 +1000
commit0edd5abb19339e0df4497b36be1b1213e57930e3 (patch)
tree4482f5281b80871be3433287b1f5dcedf4847b43
parent8b19b743258af16042c1723e6b44580d5b747804 (diff)
downloadsamba-0edd5abb19339e0df4497b36be1b1213e57930e3.tar.gz
samba-0edd5abb19339e0df4497b36be1b1213e57930e3.tar.xz
samba-0edd5abb19339e0df4497b36be1b1213e57930e3.zip
Document the new descriptive node specifications.
Signed-off-by: Martin Schwenke <martin@meltin.net> (This used to be ctdb commit 2583d0c8f9932e023b7377582f62c840e264be80)
-rw-r--r--ctdb/doc/onnode.1.xml57
1 files changed, 49 insertions, 8 deletions
diff --git a/ctdb/doc/onnode.1.xml b/ctdb/doc/onnode.1.xml
index 24c7fa84a7..0bf4d82cac 100644
--- a/ctdb/doc/onnode.1.xml
+++ b/ctdb/doc/onnode.1.xml
@@ -25,18 +25,59 @@
cluster, or on all nodes.
</para>
<para>
- The NODES option specifies which node to run a command on. You
- can specify a numeric node number (from 0 to N-1) or the special
- node 'all'. You can also specify lists of nodes, separated by
- commas, and ranges of numeric node numbers, separated by dashes.
- If nodes are specified multiple times then the command will be
- executed multiple times on those nodes. The order of nodes is
- significant.
+ The NODES option specifies which node to run a command on. You
+ can specify a numeric node number (from 0 to N-1) or a
+ descriptive node specification (see DESCRIPTIVE NODE
+ SPECIFICATIONS below). You can also specify lists of nodes,
+ separated by commas, and ranges of numeric node numbers,
+ separated by dashes. If nodes are specified multiple times then
+ the command will be executed multiple times on those nodes. The
+ order of nodes is significant.
</para>
<para>
The COMMAND can be any shell command. The onnode utility uses
ssh or rsh to connect to the remote nodes and run the command.
- </para>
+ </para>
+ </refsect1>
+
+ <refsect1><title>DESCRIPTIVE NODE SPECIFICATIONS</title>
+
+ <para>
+ The following descriptive node specification can be used in
+ place of numeric node numbers:
+ </para>
+
+ <variablelist>
+ <varlistentry><term>all</term>
+ <listitem>
+ <para>
+ All nodes.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry><term>ok | healthy</term>
+ <listitem>
+ <para>
+ All nodes that are not disconnected, banned, disabled or
+ unhealthy.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry><term>con | connected</term>
+ <listitem>
+ <para>
+ All nodes that are not disconnected.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry><term>rm | recmaster</term>
+ <listitem>
+ <para>
+ The current recovery master.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1><title>OPTIONS</title>