1
0
mirror of https://github.com/samba-team/samba.git synced 2024-12-24 21:34:56 +03:00
samba-mirror/ctdb/doc/onnode.1.html
Martin Schwenke e128e590b3 onnode documentation - update documentation to reflect recent onnode changes.
Signed-off-by: Martin Schwenke <martin@meltin.net>

(This used to be ctdb commit 2fb2eb0fd7396de33474ce43fe95c66a5784d05b)
2010-02-05 15:30:39 +11:00

126 lines
8.1 KiB
HTML
Raw Blame History

<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 &#8212; 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="id2602518"></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>
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.
</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="id2602547"></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>
All nodes.
</p></dd><dt><span class="term">any</span></dt><dd><p>
A node where ctdbd is running. This semi-random but
there is a bias towards choosing a low numbered node.
</p></dd><dt><span class="term">ok | healthy</span></dt><dd><p>
All nodes that are not disconnected, banned, disabled or
unhealthy.
</p></dd><dt><span class="term">con | connected</span></dt><dd><p>
All nodes that are not disconnected.
</p></dd><dt><span class="term">lvs | lvsmaster</span></dt><dd><p>
The current LVS master.
</p></dd><dt><span class="term">natgw | natgwlist</span></dt><dd><p>
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="id2600718"></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 &lt;prefix&gt;</span></dt><dd><p>
Causes standard output from each node to be saved into a
file with name &lt;prefix&gt;.&lt;ip&gt;.
</p></dd><dt><span class="term">-p</span></dt><dd><p>
Run COMMAND in parallel on the specified nodes. The
default is to run COMMAND sequentially on each node.
</p></dd><dt><span class="term">-q</span></dt><dd><p>
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 &lt;file&gt;</span></dt><dd><p>
Specify an alternative nodes file to use instead of the
default. This option overrides the CTDB_NODES_FILE
environment variable. See the discussion of
<code class="filename">/etc/ctdb/nodes</code> in the FILES section
for more details.
</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="id2600855"></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
</pre><p>
The following command would show the last 5 lines of log on each
node, preceded by the node's hostname
</p><pre class="screen">
onnode all "hostname; tail -5 /var/log/log.ctdb"
</pre><p>
The following command would restart the ctdb service on all nodes.
</p><pre class="screen">
onnode all service ctdb restart
</pre><p>
The following command would run ./foo in the current working
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="id2600905"></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 the
default. See the discussion of
<code class="filename">/etc/ctdb/nodes</code> in the FILES section
for more details.
</p></dd></dl></div></div><div class="refsect1" title="FILES"><a name="id2652169"></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><p>
Actually, the default is
<code class="filename">$<code class="envar">CTDB_BASE</code>/nodes</code>,
where <code class="envar">$CTDB_BASE</code> defaults to
<code class="filename">/etc/ctdb</code>. If a relative path is
given (via the -f option or <code class="envar">$CTDB_BASE</code>) and
no corresponding file exists relative to the current
directory then the file is also searched for in the
<code class="filename">$<code class="envar">CTDB_BASE</code></code> directory.
</p></dd><dt><span class="term"><code class="filename">/etc/ctdb/onnode.conf</code></span></dt><dd><p>
If this file exists it is sourced by onnode. The main
purpose is to allow the administrator to set $SSH to
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="id2652258"></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="id2652271"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
Copyright<EFBFBD>(C)<29>Andrew<65>Tridgell<6C>2007<br>
Copyright<EFBFBD>(C)<29>Ronnie<69>sahlberg<72>2007<br>
Copyright<EFBFBD>(C)<29>Martin<69>Schwenke<6B>2008<br>
<br>
This<EFBFBD>program<EFBFBD>is<EFBFBD>free<EFBFBD>software;<3B>you<6F>can<61>redistribute<74>it<69>and/or<6F>modify<br>
it<EFBFBD>under<EFBFBD>the<EFBFBD>terms<EFBFBD>of<EFBFBD>the<EFBFBD>GNU<EFBFBD>General<EFBFBD>Public<EFBFBD>License<EFBFBD>as<EFBFBD>published<EFBFBD>by<br>
the<EFBFBD>Free<EFBFBD>Software<EFBFBD>Foundation;<3B>either<65>version<6F>3<EFBFBD>of<6F>the<68>License,<2C>or<6F>(at<br>
your<EFBFBD>option)<29>any<6E>later<65>version.<br>
<br>
This<EFBFBD>program<EFBFBD>is<EFBFBD>distributed<EFBFBD>in<EFBFBD>the<EFBFBD>hope<EFBFBD>that<EFBFBD>it<EFBFBD>will<EFBFBD>be<EFBFBD>useful,<2C>but<br>
WITHOUT<EFBFBD>ANY<EFBFBD>WARRANTY;<3B>without<75>even<65>the<68>implied<65>warranty<74>of<br>
MERCHANTABILITY<EFBFBD>or<EFBFBD>FITNESS<EFBFBD>FOR<EFBFBD>A<EFBFBD>PARTICULAR<EFBFBD>PURPOSE.<2E><>See<65>the<68>GNU<br>
General<EFBFBD>Public<EFBFBD>License<EFBFBD>for<EFBFBD>more<EFBFBD>details.<br>
<br>
You<EFBFBD>should<EFBFBD>have<EFBFBD>received<EFBFBD>a<EFBFBD>copy<EFBFBD>of<EFBFBD>the<EFBFBD>GNU<EFBFBD>General<EFBFBD>Public<EFBFBD>License<br>
along<EFBFBD>with<EFBFBD>this<EFBFBD>program;<3B>if<69>not,<2C>see<65>http://www.gnu.org/licenses/.<br>
</p></div></div></div></body></html>