File: onnode.1.html

package info (click to toggle)
ctdb 1.12%2Bgit20120201-5
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 6,656 kB
  • sloc: ansic: 61,736; sh: 18,367; xml: 3,887; python: 1,220; makefile: 554; perl: 319; awk: 118
file content (125 lines) | stat: -rw-r--r-- 8,262 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
<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(C)AndrewTridgell2007<br>
Copyright(C)Ronniesahlberg2007<br>
Copyright(C)MartinSchwenke2008<br>
<br>
Thisprogramisfreesoftware;youcanredistributeitand/ormodify<br>
itunderthetermsoftheGNUGeneralPublicLicenseaspublishedby<br>
theFreeSoftwareFoundation;eitherversion3oftheLicense,or(at<br>
youroption)anylaterversion.<br>
<br>
Thisprogramisdistributedinthehopethatitwillbeuseful,but<br>
WITHOUTANYWARRANTY;withouteventheimpliedwarrantyof<br>
MERCHANTABILITYorFITNESSFORAPARTICULARPURPOSE.SeetheGNU<br>
GeneralPublicLicenseformoredetails.<br>
<br>
YoushouldhavereceivedacopyoftheGNUGeneralPublicLicense<br>
alongwiththisprogram;ifnot,seehttp://www.gnu.org/licenses/.<br>
</p></div></div></div></body></html>