.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH PACEMAKER "8" "March 2024" "Pacemaker 2.1.7" "System Administration Utilities"
.SH NAME
Pacemaker \- Part of the Pacemaker cluster resource manager
.SH SYNOPSIS
stonith_admin <command> [<options>]
.SH DESCRIPTION
stonith_admin \- Access the Pacemaker fencing API
.SH OPTIONS
.SS "Help Options:"
.TP
\-?, \fB\-\-help\fR
Show help options
.TP
\fB\-\-help\-all\fR
Show all help options
.TP
\fB\-\-help\-output\fR
Show output help
.TP
\fB\-\-help\-definition\fR
Show device definition help
.TP
\fB\-\-help\-queries\fR
Show query help
.TP
\fB\-\-help\-fence\fR
Show fence help
.TP
\fB\-\-help\-additional\fR
Show additional options
.SS "Output Options:"
.TP
\fB\-\-output\-as\fR=\fI\,FORMAT\/\fR
Specify output format as one of: text (default), html, xml
.TP
\fB\-\-output\-to\fR=\fI\,DEST\/\fR
Specify file name for output (or "\-" for stdout)
.TP
\fB\-\-html\-cgi\fR
Add CGI headers (requires \fB\-\-output\-as\fR=\fI\,html\/\fR)
.TP
\fB\-\-html\-stylesheet\fR=\fI\,URI\/\fR
Link to an external stylesheet (requires \fB\-\-output\-as\fR=\fI\,html\/\fR)
.TP
\fB\-\-html\-title\fR=\fI\,TITLE\/\fR
Specify a page title (requires \fB\-\-output\-as\fR=\fI\,html\/\fR)
.TP
\fB\-\-text\-fancy\fR
Use more highly formatted output (requires \fB\-\-output\-as\fR=\fI\,text\/\fR)
.SS "Device Definition Commands:"
.TP
\fB\-R\fR, \fB\-\-register\fR=\fI\,DEVICE\/\fR
Register the named stonith device. Requires: \fB\-\-agent\fR.
Optional: \fB\-\-option\fR, \fB\-\-env\-option\fR.
.TP
\fB\-D\fR, \fB\-\-deregister\fR=\fI\,DEVICE\/\fR
De\-register the named stonith device.
.TP
\fB\-r\fR, \fB\-\-register\-level\fR=\fI\,TARGET\/\fR
Register a stonith level for the named target,
specified as one of NAME, @PATTERN, or ATTR=VALUE.
Requires: \fB\-\-index\fR and one or more \fB\-\-device\fR entries.
.TP
\fB\-d\fR, \fB\-\-deregister\-level\fR=\fI\,TARGET\/\fR
Unregister a stonith level for the named target,
specified as for \fB\-\-register\-level\fR. Requires: \fB\-\-index\fR
.SS "Queries:"
.TP
\fB\-l\fR, \fB\-\-list\fR=\fI\,HOST\/\fR
List devices that can terminate the specified host.
Optional: \fB\-\-timeout\fR
.TP
\fB\-L\fR, \fB\-\-list\-registered\fR
List all registered devices. Optional: \fB\-\-timeout\fR.
.TP
\fB\-I\fR, \fB\-\-list\-installed\fR
List all installed devices. Optional: \fB\-\-timeout\fR.
.TP
\fB\-s\fR, \fB\-\-list\-targets\fR=\fI\,DEVICE\/\fR
List the targets that can be fenced by the
named device. Optional: \fB\-\-timeout\fR.
.TP
\fB\-M\fR, \fB\-\-metadata\fR
Show agent metadata. Requires: \fB\-\-agent\fR.
Optional: \fB\-\-timeout\fR.
.TP
\fB\-Q\fR, \fB\-\-query\fR=\fI\,DEVICE\/\fR
Check the named device's status. Optional: \fB\-\-timeout\fR.
.TP
\fB\-H\fR, \fB\-\-history\fR=\fI\,NODE\/\fR
Show last successful fencing operation for named node
(or '*' for all nodes). Optional: \fB\-\-timeout\fR, \fB\-\-cleanup\fR,
\fB\-\-quiet\fR (show only the operation's epoch timestamp),
\fB\-\-verbose\fR (show all recorded and pending operations),
\fB\-\-broadcast\fR (update history from all nodes available).
.TP
\fB\-h\fR, \fB\-\-last\fR=\fI\,NODE\/\fR
Indicate when the named node was last fenced.
Optional: \fB\-\-as\-node\-id\fR.
.TP
\fB\-K\fR, \fB\-\-validate\fR
Validate a fence device configuration.
Requires: \fB\-\-agent\fR. Optional: \fB\-\-option\fR, \fB\-\-env\-option\fR,
\fB\-\-quiet\fR (print no output, only return status).
.SS "Fencing Commands:"
.TP
\fB\-F\fR, \fB\-\-fence\fR=\fI\,HOST\/\fR
Fence named host. Optional: \fB\-\-timeout\fR, \fB\-\-tolerance\fR, \fB\-\-delay\fR.
.TP
\fB\-U\fR, \fB\-\-unfence\fR=\fI\,HOST\/\fR
Unfence named host. Optional: \fB\-\-timeout\fR, \fB\-\-tolerance\fR, \fB\-\-delay\fR.
.TP
\fB\-B\fR, \fB\-\-reboot\fR=\fI\,HOST\/\fR
Reboot named host. Optional: \fB\-\-timeout\fR, \fB\-\-tolerance\fR, \fB\-\-delay\fR.
.TP
\fB\-C\fR, \fB\-\-confirm\fR=\fI\,HOST\/\fR
Tell cluster that named host is now safely down.
.SS "Additional Options:"
.TP
\fB\-c\fR, \fB\-\-cleanup\fR
Cleanup wherever appropriate. Requires \fB\-\-history\fR.
.TP
\fB\-b\fR, \fB\-\-broadcast\fR
Broadcast wherever appropriate.
.TP
\fB\-a\fR, \fB\-\-agent\fR=\fI\,AGENT\/\fR
The agent to use (for example, fence_xvm;
with \fB\-\-register\fR, \fB\-\-metadata\fR, \fB\-\-validate\fR).
.TP
\fB\-o\fR, \fB\-\-option\fR=\fI\,PARAM\/\fR
Specify a device configuration parameter as NAME=VALUE
(may be specified multiple times; with \fB\-\-register\fR,
\fB\-\-validate\fR).
.TP
\fB\-e\fR, \fB\-\-env\-option\fR=\fI\,PARAM\/\fR
Specify a device configuration parameter with the
specified name, using the value of the
environment variable of the same name prefixed with
OCF_RESKEY_ (may be specified multiple times;
with \fB\-\-register\fR, \fB\-\-validate\fR).
.TP
\fB\-T\fR, \fB\-\-tag\fR=\fI\,TAG\/\fR
Identify fencing operations in logs with the specified
tag; useful when multiple entities might invoke
stonith_admin (used with most commands).
.TP
\fB\-v\fR, \fB\-\-device\fR=\fI\,DEVICE\/\fR
Device ID (with \fB\-\-register\-level\fR, device to associate with
a given host and level; may be specified multiple times)
(with \fB\-\-validate\fR, name to use to load CIB secrets).
.TP
\fB\-i\fR, \fB\-\-index\fR=\fI\,LEVEL\/\fR
The stonith level (1\-9) (with \fB\-\-register\-level\fR,
\fB\-\-deregister\-level\fR).
.TP
\fB\-t\fR, \fB\-\-timeout\fR=\fI\,SECONDS\/\fR
Operation timeout in seconds (default 120;
used with most commands).
.TP
\fB\-y\fR, \fB\-\-delay\fR=\fI\,SECONDS\/\fR
Apply a fencing delay in seconds. Any static/random delays from
pcmk_delay_base/max will be added, otherwise all
disabled with the value \fB\-1\fR
(default 0; with \fB\-\-fence\fR, \fB\-\-reboot\fR, \fB\-\-unfence\fR).
.TP
\fB\-n\fR, \fB\-\-as\-node\-id\fR
(Advanced) The supplied node is the corosync node ID
(with \fB\-\-last\fR).
.TP
\fB\-\-tolerance\fR=\fI\,SECONDS\/\fR
(Advanced) Do nothing if an equivalent \fB\-\-fence\fR request
succeeded less than this many seconds earlier
(with \fB\-\-fence\fR, \fB\-\-unfence\fR, \fB\-\-reboot\fR).
.SS "Application Options:"
.TP
\-$, \fB\-\-version\fR
Display software version and exit
.TP
\fB\-V\fR, \fB\-\-verbose\fR
Increase debug output (may be specified multiple times)
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Be less descriptive in output.
.SH AUTHOR
Written by Andrew Beekhof and the Pacemaker project contributors
.SH "REPORTING BUGS"
Report bugs to https://bugs.clusterlabs.org/enter_bug.cgi?product=Pacemaker