1STONITH(8)              System administration utilitie              STONITH(8)
2
3
4

NAME

6       stonith - extensible interface for remotely powering down a node in the
7       cluster
8

SYNOPSIS

10       stonith -h
11
12       stonith [-s] [-h] -L
13
14       stonith [-s] [-h] -t stonith-device-type -n
15
16       stonith [-s] [-h] -t stonith-device-type {name=value...  |
17               -p stonith-device-parameters |
18               -F stonith-device-parameters-file} [-c count] [-l] [-S]
19
20       stonith [-s] [-h] -t stonith-device-type {name=value...  |
21               -p stonith-device-parameters |
22               -F stonith-device-parameters-file} [-c count]
23               [-T {reset | on | off}] [nodename]
24

DESCRIPTION

26       The STONITH module provides an extensible interface for remotely
27       powering down a node in the cluster (STONITH = Shoot The Other Node In
28       The Head). The idea is quite simple: when the software running on one
29       machine wants to make sure another machine in the cluster is not using
30       a resource, pull the plug on the other machine. It´s simple and
31       reliable, albeit admittedly brutal.
32

OPTIONS

34       The following options are supported:
35
36       -c count
37           Perform any actions identified by the -l, -S and -T options count
38           times.
39
40       -F stonith-device-parameters-file
41           Path of file specifying parameters for a stonith device. To
42           determine the syntax of the parameters file for a given device type
43           run:
44
45               # stonith -t stonith-device-type -n
46
47           All of the listed parameters need to appear in order on a single
48           line in the parameters file and be delimited by whitespace.
49
50       -h
51           Display detailed information about a stonith device including
52           description, configuration information, parameters and any other
53           related information. When specified without a stonith-device-type,
54           detailed information on all stonith devices is displayed.
55
56           If you don´t yet own a stonith device and want to know more about
57           the ones we support, this information is likely to be helpful.
58
59       -L
60           List the valid stonith device types, suitable for passing as an
61           argument to the -t option.
62
63       -l
64           List the hosts controlled by the stonith device.
65
66       -n
67           Output the parameter names of the stonith device.
68
69       name=value
70           Parameter, in the form of a name/value pair, to pass directly to
71           the stonith device. To determine the syntax of the parameters for a
72           given device type run:
73
74               # stonith -t stonith-device-type -n
75
76           All of the listed parameter names need to be passed with their
77           corresponding values.
78
79       -p stonith-device-parameters
80           Parameters to pass directly to the stonith device. To determine the
81           syntax of the parameters for a given device type run:
82
83               # stonith -t stonith-device-type -n
84
85           All of the listed parameter names need to appear in order and be
86           delimited by whitespace.
87
88       -S
89           Show the status of the stonith device.
90
91       -s
92           Silent operation. Suppress logging of error messages to standard
93           error.
94
95       -T action
96           The stonith action to perform on the node identified by nodename.
97           Chosen from reset, on, and off.
98
99               Note
100               If a nodename is specified without the -T option, the stonith
101               action defaults to reset.
102
103       -t stonith-device-type
104           The type of the stonith device to be used to effect stonith. A list
105           of supported devices for an installation may be obtained using the
106           -L option.
107
108       -v
109           Ignored.
110

EXAMPLES

112       To determine which stonith devices are available on your installation,
113       use the -L option:
114
115           # stonith -L
116
117       All of the supported devices will be displayed one per line. Choose one
118       from this list that is best for your environment - let´s use wti_nps
119       for the rest of this example. To get detailed information about this
120       device, use the -h option:
121
122           # stonith -t wti_nps -h
123
124       Included in the output is the list of valid parameter names for
125       wti_nps. To get just the list of valid parameter names, use the -n
126       option instead:
127
128           # stonith -t wti_nps -n
129
130       All of the required parameter names will be displayed one per line. For
131       wti_nps the output is:
132
133           ipaddr
134           password
135
136       There are three ways to pass these parameters to the device. The first
137       (and preferred) way is by passing name/value pairs on the stonith
138       command line:
139
140           # stonith -t wti_nps ipaddr=my-dev-ip password=my-dev-pw ...
141
142       The second way, which is maintained only for backward compatibility
143       with legacy clusters, is passing the values in order on the stonith
144       command line with the -p option:
145
146           # stonith -t wti_nps -p "my-dev-ip my-dev-pw" ...
147
148       The third way, which is also maintained only for backward compatibility
149       with legacy clusters, is placing the values in order on a single line
150       in a config file:
151
152           my-dev-ip my-dev-pw
153
154       ... and passing the name of the file on the stonith command line with
155       the -F option:
156
157           # stonith -t wti_nps -F ~/my-wtinps-config ...
158
159       To make sure you have the configuration set up correctly and that the
160       device is available for stonith operations, use the -S option:
161
162           # stonith -t wti_nps ipaddr=my-dev-ip password=my-dev-pw -S
163
164       If all is well at this point, you should see something similar to:
165
166           stonith: wti_nps device OK.
167
168       If you don´t, some debugging may be necessary to determine if the
169       config info is correct, the device is powered on, etc. The -d option
170       can come in handy here - you can add it to any stonith command to cause
171       it to generate debug output.
172
173       To get the list of hosts controlled by the device, use the -l option:
174
175           # stonith -t wti_nps ipaddr=my-dev-ip password=my-dev-pw -l
176
177       All of the hosts controlled by the device will be displayed one per
178       line. For wti_nps the output could be:
179
180           node1
181               node2
182               node3
183
184       To power off one of these hosts, use the -T option:
185
186           # stonith -t wti_nps ipaddr=my-dev-ip password=my-dev-pw -T off node
187

SEE ALSO

189       heartbeat(8), meatclient(8)
190

AUTHORS

192       Alan Robertson <alanr@unix.sh>
193           stonith
194
195       Simon Horman <horms@vergenet.net>
196           man page
197
198       Florian Haas <florian.haas@linbit.com>
199           man page
200
201
202
203cluster-glue 1.0.6             December 7, 2009                     STONITH(8)
Impressum