Document the procedure to remove/change the NATGW configuration at
[metze/ctdb/wip.git] / doc / onnode.1.html
1 <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="id2777487"></a><h2>DESCRIPTION</h2><p>
2       onnode is a utility to run commands on a specific node of a CTDB
3       cluster, or on all nodes.
4     </p><p>
5       The NODES option specifies which node to run a command on.  You
6       can specify a numeric node number (from 0 to N-1) or a
7       descriptive node specification (see DESCRIPTIVE NODE
8       SPECIFICATIONS below).  You can also specify lists of nodes,
9       separated by commas, and ranges of numeric node numbers,
10       separated by dashes.  If nodes are specified multiple times then
11       the command will be executed multiple times on those nodes.  The
12       order of nodes is significant.
13     </p><p>
14       The COMMAND can be any shell command. The onnode utility uses
15       ssh or rsh to connect to the remote nodes and run the command.
16     </p></div><div class="refsect1" title="DESCRIPTIVE NODE SPECIFICATIONS"><a name="id2739103"></a><h2>DESCRIPTIVE NODE SPECIFICATIONS</h2><p>
17       The following descriptive node specification can be used in
18       place of numeric node numbers:
19     </p><div class="variablelist"><dl><dt><span class="term">all</span></dt><dd><p>
20             All nodes.
21           </p></dd><dt><span class="term">any</span></dt><dd><p>
22              A node where ctdbd is running.  This semi-random but
23              there is a bias towards choosing a low numbered node.
24           </p></dd><dt><span class="term">ok | healthy</span></dt><dd><p>
25             All nodes that are not disconnected, banned, disabled or
26             unhealthy.
27           </p></dd><dt><span class="term">con | connected</span></dt><dd><p>
28             All nodes that are not disconnected.
29           </p></dd><dt><span class="term">lvs | lvsmaster</span></dt><dd><p>
30             The current LVS master.
31           </p></dd><dt><span class="term">natgw | natgwlist</span></dt><dd><p>
32             The current NAT gateway.
33           </p></dd><dt><span class="term">rm | recmaster</span></dt><dd><p>
34             The current recovery master.
35           </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>
36             Execute COMMAND in the current working directory on the
37             specified nodes.
38           </p></dd><dt><span class="term">-o &lt;prefix&gt;</span></dt><dd><p>
39             Causes standard output from each node to be saved into a
40             file with name &lt;prefix&gt;.&lt;ip&gt;.
41           </p></dd><dt><span class="term">-p</span></dt><dd><p>
42             Run COMMAND in parallel on the specified nodes.  The
43             default is to run COMMAND sequentially on each node.
44           </p></dd><dt><span class="term">-q</span></dt><dd><p>
45             Do not print node addresses.  Normally, onnode prints
46             informational node addresses if more than one node is
47             specified.  This overrides -v.
48           </p></dd><dt><span class="term">-n</span></dt><dd><p>
49             Allow nodes to be specified by name rather than node
50             numbers.  These nodes don't need to be listed in the nodes
51             file.  You can avoid the nodes file entirely by combining
52             this with <code class="code">-f /dev/null</code>.
53           </p></dd><dt><span class="term">-f &lt;file&gt;</span></dt><dd><p>
54             Specify an alternative nodes file to use instead of
55             <code class="filename">/etc/ctdb/nodes</code>.  This overrides the
56             CTDB_NODES_FILE environment variable.
57           </p></dd><dt><span class="term">-v</span></dt><dd><p>
58             Print a node addresses even if only one node is specified.
59             Normally, onnode prints informational node addresses when
60             more than one node is specified.
61           </p></dd><dt><span class="term">-h, --help</span></dt><dd><p>
62             Show a short usage guide.
63           </p></dd></dl></div></div><div class="refsect1" title="EXAMPLES"><a name="id2742865"></a><h2>EXAMPLES</h2><p>
64       The following command would show the process ID of ctdb on all nodes
65     </p><pre class="screen">
66       onnode all pidof ctdbd
67     </pre><p>
68       The following command would show the last 5 lines of log on each
69       node, preceded by the node's hostname
70     </p><pre class="screen">
71       onnode all "hostname; tail -5 /var/log/log.ctdb"
72     </pre><p>
73       The following command would restart the ctdb service on all nodes.
74     </p><pre class="screen">
75       onnode all service ctdb restart
76     </pre><p>
77       The following command would run ./foo in the current working
78       directory, in parallel, on nodes 0, 2, 3 and 4.
79     </p><pre class="screen">
80       onnode -c -p 0,2-4 ./foo
81     </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>
82             Name of alternative nodes file to use instead of
83             <code class="filename">/etc/ctdb/nodes</code>.
84           </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>
85             Default file containing a list of each node's IP address
86             or hostname.
87           </p></dd><dt><span class="term"><code class="filename">/etc/ctdb/onnode.conf</code></span></dt><dd><p>
88             If this file exists it is sourced by onnode.  The main
89             purpose is to allow the administrator to set $SSH to
90             something other than "ssh".  In this case the -t option is
91             ignored.  For example, the administrator may choose to use
92             use rsh instead of ssh.
93           </p></dd></dl></div></div><div class="refsect1" title="SEE ALSO"><a name="id2791501"></a><h2>SEE ALSO</h2><p>
94       ctdbd(1), ctdb(1), <a class="ulink" href="http://ctdb.samba.org/" target="_top">http://ctdb.samba.org/</a>
95     </p></div><div class="refsect1" title="COPYRIGHT/LICENSE"><a name="id2791514"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
96 Copyright (C) Andrew Tridgell 2007<br>
97 Copyright (C) Ronnie sahlberg 2007<br>
98 Copyright (C) Martin Schwenke 2008<br>
99 <br>
100 This program is free software; you can redistribute it and/or modify<br>
101 it under the terms of the GNU General Public License as published by<br>
102 the Free Software Foundation; either version 3 of the License, or (at<br>
103 your option) any later version.<br>
104 <br>
105 This program is distributed in the hope that it will be useful, but<br>
106 WITHOUT ANY WARRANTY; without even the implied warranty of<br>
107 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU<br>
108 General Public License for more details.<br>
109 <br>
110 You should have received a copy of the GNU General Public License<br>
111 along with this program; if not, see http://www.gnu.org/licenses/.<br>
112 </p></div></div></div></body></html>