3 .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
10 .TH "ONNODE" "1" "02/05/2010" "" ""
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
16 .\" disable justification (adjust text to left margin only)
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
22 onnode \- run commands on ctdb nodes
24 .HP \w'\fBonnode\ [OPTION]\ \&.\&.\&.\ NODES\ COMMAND\ \&.\&.\&.\fR\ 'u
25 \fBonnode [OPTION] \&.\&.\&. NODES COMMAND \&.\&.\&.\fR
28 onnode is a utility to run commands on a specific node of a CTDB cluster, or on all nodes\&.
30 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\&.
32 The COMMAND can be any shell command\&. The onnode utility uses ssh or rsh to connect to the remote nodes and run the command\&.
33 .SH "DESCRIPTIVE NODE SPECIFICATIONS"
35 The following descriptive node specification can be used in place of numeric node numbers:
44 A node where ctdbd is running\&. This semi\-random but there is a bias towards choosing a low numbered node\&.
49 All nodes that are not disconnected, banned, disabled or unhealthy\&.
54 All nodes that are not disconnected\&.
59 The current LVS master\&.
64 The current NAT gateway\&.
69 The current recovery master\&.
75 Execute COMMAND in the current working directory on the specified nodes\&.
80 Causes standard output from each node to be saved into a file with name <prefix>\&.<ip>\&.
85 Run COMMAND in parallel on the specified nodes\&. The default is to run COMMAND sequentially on each node\&.
90 Do not print node addresses\&. Normally, onnode prints informational node addresses if more than one node is specified\&. This overrides \-v\&.
95 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
101 Specify an alternative nodes file to use instead of the default\&. This option overrides the CTDB_NODES_FILE environment variable\&. See the discussion of
103 in the FILES section for more details\&.
108 Print a node addresses even if only one node is specified\&. Normally, onnode prints informational node addresses when more than one node is specified\&.
113 Show a short usage guide\&.
117 The following command would show the process ID of ctdb on all nodes
123 onnode all pidof ctdbd
130 The following command would show the last 5 lines of log on each node, preceded by the node\'s hostname
136 onnode all "hostname; tail \-5 /var/log/log\&.ctdb"
143 The following command would restart the ctdb service on all nodes\&.
149 onnode all service ctdb restart
156 The following command would run \&./foo in the current working directory, in parallel, on nodes 0, 2, 3 and 4\&.
162 onnode \-c \-p 0,2\-4 \&./foo
170 \fBCTDB_NODES_FILE\fR
172 Name of alternative nodes file to use instead of the default\&. See the discussion of
174 in the FILES section for more details\&.
180 Default file containing a list of each node\'s IP address or hostname\&.
182 Actually, the default is
183 $\fBCTDB_BASE\fR/nodes, where
186 /etc/ctdb\&. If a relative path is given (via the \-f option or
187 \fB$CTDB_BASE\fR) and no corresponding file exists relative to the current directory then the file is also searched for in the
192 /etc/ctdb/onnode\&.conf
194 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\&.
199 \m[blue]\fB\%http://ctdb.samba.org/\fR\m[]
200 .SH "COPYRIGHT/LICENSE"
206 Copyright (C) Andrew Tridgell 2007
207 Copyright (C) Ronnie sahlberg 2007
208 Copyright (C) Martin Schwenke 2008
210 This program is free software; you can redistribute it and/or modify
211 it under the terms of the GNU General Public License as published by
212 the Free Software Foundation; either version 3 of the License, or (at
213 your option) any later version\&.
215 This program is distributed in the hope that it will be useful, but
216 WITHOUT ANY WARRANTY; without even the implied warranty of
217 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\&. See the GNU
218 General Public License for more details\&.
220 You should have received a copy of the GNU General Public License
221 along with this program; if not, see http://www\&.gnu\&.org/licenses/\&.