Scroll to navigation

PACEMAKER(8) System Administration Utilities PACEMAKER(8)

NAME

Pacemaker - Part of the Pacemaker cluster resource manager

SYNOPSIS

stonith_admin <command> [<options>]

DESCRIPTION

stonith_admin - Access the Pacemaker fencing API

OPTIONS

Help Options:

-?, --help
Show help options
Show all help options
Show output help
Show device definition help
Show query help
Show fence help
Show additional options

Output Options:

Specify output format as one of: text (default), html, xml
Specify file name for output (or "-" for stdout)
Add CGI headers (requires --output-as=html)
Link to an external stylesheet (requires --output-as=html)
Specify a page title (requires --output-as=html)

Device Definition Commands:

Register the named stonith device. Requires: --agent. Optional: --option, --env-option.
De-register the named stonith device.
Register a stonith level for the named target, specified as one of NAME, @PATTERN, or ATTR=VALUE. Requires: --index and one or more --device entries.
Unregister a stonith level for the named target, specified as for --register-level. Requires: --index

Queries:

List devices that can terminate the specified host. Optional: --timeout
List all registered devices. Optional: --timeout.
List all installed devices. Optional: --timeout.
List the targets that can be fenced by the named device. Optional: --timeout.
Show agent metadata. Requires: --agent. Optional: --timeout.
Check the named device's status. Optional: --timeout.
Show last successful fencing operation for named node (or '*' for all nodes). Optional: --timeout, --cleanup, --quiet (show only the operation's epoch timestamp), --verbose (show all recorded and pending operations), --broadcast (update history from all nodes available).
Indicate when the named node was last fenced. Optional: --as-node-id.
Validate a fence device configuration. Requires: --agent. Optional: --option, --env-option, --quiet (print no output, only return status).

Fencing Commands:

Fence named host. Optional: --timeout, --tolerance, --delay.
Unfence named host. Optional: --timeout, --tolerance, --delay.
Reboot named host. Optional: --timeout, --tolerance, --delay.
Tell cluster that named host is now safely down.

Additional Options:

Cleanup wherever appropriate. Requires --history.
Broadcast wherever appropriate.
The agent to use (for example, fence_xvm; with --register, --metadata, --validate).
Specify a device configuration parameter as NAME=VALUE (may be specified multiple times; with --register, --validate).
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 --register, --validate).
Identify fencing operations in logs with the specified tag; useful when multiple entities might invoke stonith_admin (used with most commands).
Device ID (with --register-level, device to associate with a given host and level; may be specified multiple times) (with --validate, name to use to load CIB secrets).
The stonith level (1-9) (with --register-level, --deregister-level).
Operation timeout in seconds (default 120; used with most commands).
Apply a fencing delay in seconds. Any static/random delays from pcmk_delay_base/max will be added, otherwise all disabled with the value -1 (default 0; with --fence, --reboot, --unfence).
(Advanced) The supplied node is the corosync node ID (with --last).
(Advanced) Do nothing if an equivalent --fence request succeeded less than this many seconds earlier (with --fence, --unfence, --reboot).

Application Options:

-$, --version
Display software version and exit
Increase debug output (may be specified multiple times)
Be less descriptive in output.

AUTHOR

Written by Andrew Beekhof and the Pacemaker project contributors

REPORTING BUGS

Report bugs to https://bugs.clusterlabs.org/enter_bug.cgi?product=Pacemaker

August 2024 Pacemaker 2.1.8