diff options
| author | Martin Schwenke <martin@meltin.net> | 2009-10-22 17:47:10 +1100 |
|---|---|---|
| committer | Martin Schwenke <martin@meltin.net> | 2009-10-22 17:47:10 +1100 |
| commit | a128b7e3bb0e2bdbbd2d5d83d631c5ebc5a20302 (patch) | |
| tree | 072672c891fd63c593e0558b81e9902e3ff480b5 | |
| parent | 8b2101bc61d45984bc464ae792de73ee4a56d34f (diff) | |
| download | samba-a128b7e3bb0e2bdbbd2d5d83d631c5ebc5a20302.tar.gz samba-a128b7e3bb0e2bdbbd2d5d83d631c5ebc5a20302.tar.xz samba-a128b7e3bb0e2bdbbd2d5d83d631c5ebc5a20302.zip | |
Document onnode -n and -f options.
Signed-off-by: Martin Schwenke <martin@meltin.net>
(This used to be ctdb commit 431f79f7c9038ebd95d27c2465207ca40b8f4f23)
| -rw-r--r-- | ctdb/doc/onnode.1 | 16 | ||||
| -rw-r--r-- | ctdb/doc/onnode.1.html | 25 | ||||
| -rw-r--r-- | ctdb/doc/onnode.1.xml | 21 |
3 files changed, 52 insertions, 10 deletions
diff --git a/ctdb/doc/onnode.1 b/ctdb/doc/onnode.1 index fe86a57fd1..54249f6992 100644 --- a/ctdb/doc/onnode.1 +++ b/ctdb/doc/onnode.1 @@ -2,12 +2,12 @@ .\" Title: onnode .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> -.\" Date: 10/06/2009 +.\" Date: 10/22/2009 .\" Manual: [FIXME: manual] .\" Source: [FIXME: source] .\" Language: English .\" -.TH "ONNODE" "1" "10/06/2009" "[FIXME: source]" "[FIXME: manual]" +.TH "ONNODE" "1" "10/22/2009" "[FIXME: source]" "[FIXME: manual]" .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -90,6 +90,18 @@ Run COMMAND in parallel on the specified nodes\&. The default is to run COMMAND Do not print node addresses\&. Normally, onnode prints informational node addresses if more than one node is specified\&. This overrides \-v\&. .RE .PP +\-n +.RS 4 +Allow nodes to be specified by name rather than node numbers\&. These nodes don\'t need to be listed in the nodes file\&. You can avoid the nodes file entirely by combining this with +\-f /dev/null\&. +.RE +.PP +\-f <file> +.RS 4 +Specify an alternative nodes file to use instead of +/etc/ctdb/nodes\&. This overrides the CTDB_NODES_FILE environment variable\&. +.RE +.PP \-v .RS 4 Print a node addresses even if only one node is specified\&. Normally, onnode prints informational node addresses when more than one node is specified\&. diff --git a/ctdb/doc/onnode.1.html b/ctdb/doc/onnode.1.html index c8e3157dff..3ddfa2ffe4 100644 --- a/ctdb/doc/onnode.1.html +++ b/ctdb/doc/onnode.1.html @@ -1,4 +1,4 @@ -<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>onnode</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="onnode"><a name="onnode.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>onnode — run commands on ctdb nodes</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">onnode [OPTION] ... NODES COMMAND ...</code> </p></div></div><div class="refsect1" title="DESCRIPTION"><a name="id2711756"></a><h2>DESCRIPTION</h2><p> +<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>onnode</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" title="onnode"><a name="onnode.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>onnode — run commands on ctdb nodes</p></div><div class="refsynopsisdiv" title="Synopsis"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">onnode [OPTION] ... NODES COMMAND ...</code> </p></div></div><div class="refsect1" title="DESCRIPTION"><a name="id2777487"></a><h2>DESCRIPTION</h2><p> onnode is a utility to run commands on a specific node of a CTDB cluster, or on all nodes. </p><p> @@ -13,7 +13,7 @@ </p><p> The COMMAND can be any shell command. The onnode utility uses ssh or rsh to connect to the remote nodes and run the command. - </p></div><div class="refsect1" title="DESCRIPTIVE NODE SPECIFICATIONS"><a name="id2711784"></a><h2>DESCRIPTIVE NODE SPECIFICATIONS</h2><p> + </p></div><div class="refsect1" title="DESCRIPTIVE NODE SPECIFICATIONS"><a name="id2739103"></a><h2>DESCRIPTIVE NODE SPECIFICATIONS</h2><p> The following descriptive node specification can be used in place of numeric node numbers: </p><div class="variablelist"><dl><dt><span class="term">all</span></dt><dd><p> @@ -32,7 +32,7 @@ The current NAT gateway. </p></dd><dt><span class="term">rm | recmaster</span></dt><dd><p> The current recovery master. - </p></dd></dl></div></div><div class="refsect1" title="OPTIONS"><a name="id2711252"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-c</span></dt><dd><p> + </p></dd></dl></div></div><div class="refsect1" title="OPTIONS"><a name="id2742732"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-c</span></dt><dd><p> Execute COMMAND in the current working directory on the specified nodes. </p></dd><dt><span class="term">-o <prefix></span></dt><dd><p> @@ -45,13 +45,22 @@ Do not print node addresses. Normally, onnode prints informational node addresses if more than one node is specified. This overrides -v. + </p></dd><dt><span class="term">-n</span></dt><dd><p> + Allow nodes to be specified by name rather than node + numbers. These nodes don't need to be listed in the nodes + file. You can avoid the nodes file entirely by combining + this with <code class="code">-f /dev/null</code>. + </p></dd><dt><span class="term">-f <file></span></dt><dd><p> + Specify an alternative nodes file to use instead of + <code class="filename">/etc/ctdb/nodes</code>. This overrides the + CTDB_NODES_FILE environment variable. </p></dd><dt><span class="term">-v</span></dt><dd><p> Print a node addresses even if only one node is specified. Normally, onnode prints informational node addresses when more than one node is specified. </p></dd><dt><span class="term">-h, --help</span></dt><dd><p> Show a short usage guide. - </p></dd></dl></div></div><div class="refsect1" title="EXAMPLES"><a name="id2711346"></a><h2>EXAMPLES</h2><p> + </p></dd></dl></div></div><div class="refsect1" title="EXAMPLES"><a name="id2742865"></a><h2>EXAMPLES</h2><p> The following command would show the process ID of ctdb on all nodes </p><pre class="screen"> onnode all pidof ctdbd @@ -69,10 +78,10 @@ directory, in parallel, on nodes 0, 2, 3 and 4. </p><pre class="screen"> onnode -c -p 0,2-4 ./foo - </pre></div><div class="refsect1" title="ENVIRONMENT"><a name="id2711396"></a><h2>ENVIRONMENT</h2><div class="variablelist"><dl><dt><span class="term"><code class="envar">CTDB_NODES_FILE</code></span></dt><dd><p> + </pre></div><div class="refsect1" title="ENVIRONMENT"><a name="id2742916"></a><h2>ENVIRONMENT</h2><div class="variablelist"><dl><dt><span class="term"><code class="envar">CTDB_NODES_FILE</code></span></dt><dd><p> Name of alternative nodes file to use instead of <code class="filename">/etc/ctdb/nodes</code>. - </p></dd></dl></div></div><div class="refsect1" title="FILES"><a name="id2711425"></a><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term"><code class="filename">/etc/ctdb/nodes</code></span></dt><dd><p> + </p></dd></dl></div></div><div class="refsect1" title="FILES"><a name="id2742944"></a><h2>FILES</h2><div class="variablelist"><dl><dt><span class="term"><code class="filename">/etc/ctdb/nodes</code></span></dt><dd><p> Default file containing a list of each node's IP address or hostname. </p></dd><dt><span class="term"><code class="filename">/etc/ctdb/onnode.conf</code></span></dt><dd><p> @@ -81,9 +90,9 @@ something other than "ssh". In this case the -t option is ignored. For example, the administrator may choose to use use rsh instead of ssh. - </p></dd></dl></div></div><div class="refsect1" title="SEE ALSO"><a name="id2711471"></a><h2>SEE ALSO</h2><p> + </p></dd></dl></div></div><div class="refsect1" title="SEE ALSO"><a name="id2791501"></a><h2>SEE ALSO</h2><p> ctdbd(1), ctdb(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="id2711483"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br> + </p></div><div class="refsect1" title="COPYRIGHT/LICENSE"><a name="id2791514"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br> Copyright (C) Andrew Tridgell 2007<br> Copyright (C) Ronnie sahlberg 2007<br> Copyright (C) Martin Schwenke 2008<br> diff --git a/ctdb/doc/onnode.1.xml b/ctdb/doc/onnode.1.xml index 578baf9e69..36a569ec7f 100644 --- a/ctdb/doc/onnode.1.xml +++ b/ctdb/doc/onnode.1.xml @@ -142,6 +142,27 @@ </listitem> </varlistentry> + <varlistentry><term>-n</term> + <listitem> + <para> + Allow nodes to be specified by name rather than node + numbers. These nodes don't need to be listed in the nodes + file. You can avoid the nodes file entirely by combining + this with <code>-f /dev/null</code>. + </para> + </listitem> + </varlistentry> + + <varlistentry><term>-f <file></term> + <listitem> + <para> + Specify an alternative nodes file to use instead of + <filename>/etc/ctdb/nodes</filename>. This overrides the + CTDB_NODES_FILE environment variable. + </para> + </listitem> + </varlistentry> + <varlistentry><term>-v</term> <listitem> <para> |