From 4f5791ebd03eaec1c7da0865a383175b05102712 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 5 May 2024 19:47:29 +0200 Subject: Adding upstream version 2:4.17.12+dfsg. Signed-off-by: Daniel Baumann --- ctdb/doc/onnode.1.xml | 315 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 315 insertions(+) create mode 100644 ctdb/doc/onnode.1.xml (limited to 'ctdb/doc/onnode.1.xml') diff --git a/ctdb/doc/onnode.1.xml b/ctdb/doc/onnode.1.xml new file mode 100644 index 0000000..f7da04a --- /dev/null +++ b/ctdb/doc/onnode.1.xml @@ -0,0 +1,315 @@ + + + + + + onnode + 1 + ctdb + CTDB - clustered TDB database + + + + onnode + run commands on CTDB cluster nodes + + + + + onnode + OPTION + NODES + COMMAND + + + + + DESCRIPTION + + onnode is a utility to run commands on a specific node of a CTDB + cluster, or on all nodes. + + + NODES specifies which node(s) to run + a command on. See section NODES + SPECIFICATION for details. + + + COMMAND can be any shell command. The + onnode utility uses ssh or rsh to connect to the remote nodes + and run the command. + + + + + OPTIONS + + + -c + + + Execute COMMAND in the current working directory on the + specified nodes. + + + + + -f FILENAME + + + Specify an alternative nodes FILENAME to use instead of + the default. See the discussion of + /usr/local/etc/ctdb/nodes in the + FILES section for more details. + + + + + -i + + + Keep standard input open, allowing data to be piped to + onnode. Normally onnode closes stdin to avoid surprises + when scripting. Note that this option is ignored when + using or if ONNODE_SSH + is set to anything other than "ssh". + + + + + -n + + + 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. + + + + + -p + + + Run COMMAND in parallel on the specified nodes. The + default is to run COMMAND sequentially on each node. + + + + + -P + + + Push files to nodes. Names of files to push are specified + rather than the usual command. Quoting is fragile/broken + - filenames with whitespace in them are not supported. + + + + + -q + + + Do not print node addresses. Normally, onnode prints + informational node addresses if more than one node is + specified. This overrides -v. + + + + + -v + + + Print node addresses even if only one node is specified. + Normally, onnode prints informational node addresses when + more than one node is specified. + + + + + -h, --help + + + Show a short usage guide. + + + + + + + + NODES SPECIFICATION + + + Nodes can be specified via numeric node numbers (from 0 to N-1) + or mnemonics. Multiple nodes are specified using 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 following mnemonics are available: + + + + all + + + All nodes. + + + + any + + + A node where ctdbd is running. This semi-random but + there is a bias towards choosing a low numbered node. + + + + ok | healthy + + + All nodes that are not disconnected, banned, disabled or + unhealthy. + + + + con | connected + + + All nodes that are not disconnected. + + + + + + + + EXAMPLES + + + The following command would show the process ID of ctdbd on all nodes + + + onnode all ctdb getpid + + + + The following command would show the last 5 lines of log on each + node, preceded by the node's hostname + + + onnode all "hostname; tail -5 /usr/local/var/log/log.ctdb" + + + + The following command would restart the ctdb service on all + nodes, in parallel. + + + onnode -p all service ctdb restart + + + + The following command would run ./foo in the current working + directory, in parallel, on nodes 0, 2, 3 and 4. + + + onnode -c -p 0,2-4 ./foo + + + + + FILES + + + /usr/local/etc/ctdb/nodes + + + Default file containing a list of each node's IP address + or hostname. + + + As above, a file specified via the + is given precedence. If a + relative path is specified and no corresponding file + exists relative to the current directory then the file is + also searched for in the CTDB configuration directory. + + + Otherwise the default is + /usr/local/etc/ctdb/nodes. + + + + + + /usr/local/etc/ctdb/onnode.conf + + + If this file exists it is sourced by onnode. The main + purpose is to allow the administrator to set + ONNODE_SSH to something other than "ssh". + In this case the -t option is ignored. + + + + + + + + SEE ALSO + + + ctdb + 7, + + + + + + + + + This documentation was written by + Andrew Tridgell, + Martin Schwenke + + + + + 2007 + Andrew Tridgell + Ronnie Sahlberg + + + 2008 + Martin Schwenke + + + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License as + published by the Free Software Foundation; either version 3 of + the License, or (at your option) any later version. + + + This program is distributed in the hope that it will be + useful, but WITHOUT ANY WARRANTY; without even the implied + warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR + PURPOSE. See the GNU General Public License for more details. + + + You should have received a copy of the GNU General Public + License along with this program; if not, see + . + + + + + -- cgit v1.2.3