'\" t
.\"     Title: stonith
.\"    Author: Alan Robertson <alanr@unix.sh>
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: December 7, 2009
.\"    Manual: System administration utilities
.\"    Source: cluster-glue 1.0.12
.\"  Language: English
.\"
.TH "STONITH" "8" "December 7, 2009" "cluster-glue 1.0.12" "System administration utilitie"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
stonith \- extensible interface for remotely powering down a node in the cluster
.SH "SYNOPSIS"
.HP \w'\fBstonith\fR\ 'u
\fBstonith\fR \fB\-h\fR
.HP \w'\fBstonith\fR\ 'u
\fBstonith\fR [\fB\-s\fR] [\fB\-h\fR] \fB\-L\fR
.HP \w'\fBstonith\fR\ 'u
\fBstonith\fR [\fB\-s\fR] [\fB\-h\fR] \fB\-t\fR\ \fIstonith\-device\-type\fR \fB\-n\fR
.HP \w'\fBstonith\fR\ 'u
\fBstonith\fR [\fB\-s\fR] [\fB\-h\fR] \fB\-t\fR\ \fIstonith\-device\-type\fR {\fIname\fR=\fIvalue\fR...  | \fB\-p\fR\ \fIstonith\-device\-parameters\fR | \fB\-F\fR\ \fIstonith\-device\-parameters\-file\fR} [\fB\-c\fR\ \fIcount\fR] [\fB\-l\fR] [\fB\-S\fR]
.HP \w'\fBstonith\fR\ 'u
\fBstonith\fR [\fB\-s\fR] [\fB\-h\fR] \fB\-t\fR\ \fIstonith\-device\-type\fR {\fIname\fR=\fIvalue\fR...  | \fB\-p\fR\ \fIstonith\-device\-parameters\fR | \fB\-F\fR\ \fIstonith\-device\-parameters\-file\fR} [\fB\-c\fR\ \fIcount\fR] [\fB\-T\fR\ {reset\ |\ on\ |\ off}] [\fInodename\fR]
.SH "DESCRIPTION"
.PP
The STONITH module provides an extensible interface for remotely powering down a node in the cluster (STONITH = Shoot The Other Node In The Head)\&. The idea is quite simple: when the software running on one machine wants to make sure another machine in the cluster is not using a resource, pull the plug on the other machine\&. It\*(Aqs simple and reliable, albeit admittedly brutal\&.
.SH "OPTIONS"
.PP
The following options are supported:
.PP
\fB\-c\fR \fIcount\fR
.RS 4
Perform any actions identified by the
\fB\-l\fR,
\fB\-S\fR
and
\fB\-T\fR
options
\fIcount\fR
times\&.
.RE
.PP
\fB\-F\fR \fIstonith\-device\-parameters\-file\fR
.RS 4
Path of file specifying parameters for a stonith device\&. To determine the syntax of the parameters file for a given device type run:
.sp
.if n \{\
.RS 4
.\}
.nf
# \fBstonith \-t stonith\-device\-type \-n\fR
.fi
.if n \{\
.RE
.\}
.sp
All of the listed parameters need to appear in order on a single line in the parameters file and be delimited by whitespace\&.
.RE
.PP
\fB\-h\fR
.RS 4
Display detailed information about a stonith device including description, configuration information, parameters and any other related information\&. When specified without a stonith\-device\-type, detailed information on all stonith devices is displayed\&.
.sp
If you don\*(Aqt yet own a stonith device and want to know more about the ones we support, this information is likely to be helpful\&.
.RE
.PP
\fB\-L\fR
.RS 4
List the valid stonith device types, suitable for passing as an argument to the
\fB\-t\fR
option\&.
.RE
.PP
\fB\-l\fR
.RS 4
List the hosts controlled by the stonith device\&.
.RE
.PP
\fB\-n\fR
.RS 4
Output the parameter names of the stonith device\&.
.RE
.PP
\fIname\fR=\fIvalue\fR
.RS 4
Parameter, in the form of a name/value pair, to pass directly to the stonith device\&. To determine the syntax of the parameters for a given device type run:
.sp
.if n \{\
.RS 4
.\}
.nf
# \fBstonith \-t stonith\-device\-type \-n\fR
.fi
.if n \{\
.RE
.\}
.sp
All of the listed parameter names need to be passed with their corresponding values\&.
.RE
.PP
\fB\-p\fR \fIstonith\-device\-parameters\fR
.RS 4
Parameters to pass directly to the stonith device\&. To determine the syntax of the parameters for a given device type run:
.sp
.if n \{\
.RS 4
.\}
.nf
# \fBstonith \-t stonith\-device\-type \-n\fR
.fi
.if n \{\
.RE
.\}
.sp
All of the listed parameter names need to appear in order and be delimited by whitespace\&.
.RE
.PP
\fB\-S\fR
.RS 4
Show the status of the stonith device\&.
.RE
.PP
\fB\-s\fR
.RS 4
Silent operation\&. Suppress logging of error messages to standard error\&.
.RE
.PP
\fB\-T\fR \fIaction\fR
.RS 4
The stonith action to perform on the node identified by nodename\&. Chosen from
reset,
on, and
off\&.
.if n \{\
.sp
.\}
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNote\fR
.ps -1
.br
If a nodename is specified without the
\fB\-T\fR
option, the stonith action defaults to
reset\&.
.sp .5v
.RE
.RE
.PP
\fB\-t\fR \fIstonith\-device\-type\fR
.RS 4
The type of the stonith device to be used to effect stonith\&. A list of supported devices for an installation may be obtained using the
\fB\-L\fR
option\&.
.RE
.PP
\fB\-v\fR
.RS 4
Ignored\&.
.RE
.SH "EXAMPLES"
.PP
To determine which stonith devices are available on your installation, use the
\fB\-L\fR
option:
.sp
.if n \{\
.RS 4
.\}
.nf
# \fBstonith \-L\fR
.fi
.if n \{\
.RE
.\}
.PP
All of the supported devices will be displayed one per line\&. Choose one from this list that is best for your environment \- let\*(Aqs use
wti_nps
for the rest of this example\&. To get detailed information about this device, use the
\fB\-h\fR
option:
.sp
.if n \{\
.RS 4
.\}
.nf
# \fBstonith \-t wti_nps \-h\fR
.fi
.if n \{\
.RE
.\}
.PP
Included in the output is the list of valid parameter names for
wti_nps\&. To get
\fIjust\fR
the list of valid parameter names, use the
\fB\-n\fR
option instead:
.sp
.if n \{\
.RS 4
.\}
.nf
# \fBstonith \-t wti_nps \-n\fR
.fi
.if n \{\
.RE
.\}
.PP
All of the required parameter names will be displayed one per line\&. For
wti_nps
the output is:
.sp
.if n \{\
.RS 4
.\}
.nf
ipaddr
password
.fi
.if n \{\
.RE
.\}
.PP
There are three ways to pass these parameters to the device\&. The first (and preferred) way is by passing name/value pairs on the
\fBstonith\fR
command line:
.sp
.if n \{\
.RS 4
.\}
.nf
# \fBstonith \-t wti_nps ipaddr=my\-dev\-ip password=my\-dev\-pw \&.\&.\&.\fR
.fi
.if n \{\
.RE
.\}
.PP
The second way, which is maintained only for backward compatibility with legacy clusters, is passing the values
\fIin order\fR
on the
\fBstonith\fR
command line with the
\fB\-p\fR
option:
.sp
.if n \{\
.RS 4
.\}
.nf
# \fBstonith \-t wti_nps \-p "my\-dev\-ip my\-dev\-pw" \&.\&.\&.\fR
.fi
.if n \{\
.RE
.\}
.PP
The third way, which is also maintained only for backward compatibility with legacy clusters, is placing the values
\fIin order\fR
on a single line in a config file:
.sp
.if n \{\
.RS 4
.\}
.nf
my\-dev\-ip my\-dev\-pw
.fi
.if n \{\
.RE
.\}
.PP
\&.\&.\&. and passing the name of the file on the stonith command line with the
\fB\-F\fR
option:
.sp
.if n \{\
.RS 4
.\}
.nf
# \fBstonith \-t wti_nps \-F ~/my\-wtinps\-config \&.\&.\&.\fR
.fi
.if n \{\
.RE
.\}
.PP
To make sure you have the configuration set up correctly and that the device is available for stonith operations, use the
\fB\-S\fR
option:
.sp
.if n \{\
.RS 4
.\}
.nf
# \fBstonith \-t wti_nps ipaddr=my\-dev\-ip password=my\-dev\-pw \-S\fR
.fi
.if n \{\
.RE
.\}
.PP
If all is well at this point, you should see something similar to:
.sp
.if n \{\
.RS 4
.\}
.nf
stonith: wti_nps device OK\&.
.fi
.if n \{\
.RE
.\}
.PP
If you don\*(Aqt, some debugging may be necessary to determine if the config info is correct, the device is powered on, etc\&. The
\fB\-d\fR
option can come in handy here \- you can add it to any
\fBstonith\fR
command to cause it to generate debug output\&.
.PP
To get the list of hosts controlled by the device, use the
\fB\-l\fR
option:
.sp
.if n \{\
.RS 4
.\}
.nf
# \fBstonith \-t wti_nps ipaddr=my\-dev\-ip password=my\-dev\-pw \-l\fR
.fi
.if n \{\
.RE
.\}
.PP
All of the hosts controlled by the device will be displayed one per line\&. For
wti_nps
the output could be:
.sp
.if n \{\
.RS 4
.\}
.nf
node1
    node2
    node3
.fi
.if n \{\
.RE
.\}
.PP
To power off one of these hosts, use the
\fB\-T\fR
option:
.sp
.if n \{\
.RS 4
.\}
.nf
# \fBstonith \-t wti_nps ipaddr=my\-dev\-ip password=my\-dev\-pw \-T off \fR\fB\fInode\fR\fR
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\fBheartbeat\fR(8),
\fBmeatclient\fR(8)
.SH "AUTHORS"
.PP
\fBAlan Robertson\fR <\&alanr@unix\&.sh\&>
.RS 4
stonith
.RE
.PP
\fBSimon Horman\fR <\&horms@vergenet\&.net\&>
.RS 4
man page
.RE
.PP
\fBFlorian Haas\fR <\&florian\&.haas@linbit\&.com\&>
.RS 4
man page
.RE