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
Display this text and exit.
-$, --version
Display version information and exit.
-V, --verbose
Increase debug output (may be specified multiple times).
-q, --quiet
Be less descriptive in output.
-c, --cleanup
Cleanup wherever appropriate.
-b, --broadcast
Broadcast wherever appropriate.

Device definition commands:

-R, --register=value
Register the named stonith device. Requires: --agent. Optional: --option, --env-option.

-D, --deregister=value De-register the named stonith device.

-r, --register-level=value
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.
-d, --deregister-level=value
Unregister a stonith level for the named target, specified as for --register-level. Requires: --index.

Queries:

-l, --list=value
List devices that can terminate the specified host. Optional: --timeout.
-L, --list-registered
List all registered devices. Optional: --timeout.
-I, --list-installed
List all installed devices. Optional: --timeout.
-s, --list-targets=value
List the targets that can be fenced by the named device. Optional: --timeout.
-M, --metadata
Show agent metadata. Requires: --agent. Optional: --timeout.
-Q, --query=value
Check the named device's status. Optional: --timeout.
-H, --history=value
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).
-h, --last=value
Indicate when the named node was last fenced. Optional: --as-node-id.
-K, --validate
Validate a fence device configuration. Requires: --agent. Optional: --option, --env-option, --quiet (print no output, only return status).

Fencing Commands:

-F, --fence=value
Fence named host. Optional: --timeout, --tolerance.
-U, --unfence=value
Unfence named host. Optional: --timeout, --tolerance.
-B, --reboot=value
Reboot named host. Optional: --timeout, --tolerance.
-C, --confirm=value
Tell cluster that named host is now safely down.

Additional Options:

-a, --agent=value
The agent to use (for example, fence_xvm; with --register, --metadata, --validate).
-o, --option=value
Specify a device configuration parameter as NAME=VALUE (may be specified multiple times; with --register, --validate).
-e, --env-option=value 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).
-T, --tag=value
Identify fencing operations in logs with the specified tag; useful when multiple entities might invoke stonith_admin (used with most commands).
-v, --device=value
Device ID (with --register-level, device to associate with a given host and level; may be specified multiple times).
-i, --index=value
The stonith level (1-9) (with --register-level, --deregister-level).
-t, --timeout=value
Operation timeout in seconds (default 120; used with most commands).
-n, --as-node-id
(Advanced) The supplied node is the corosync node ID (with --last).
--tolerance=value
(Advanced) Do nothing if an equivalent --fence request succeeded less than this many seconds earlier (with --fence, --unfence, --reboot).

AUTHOR

Written by Andrew Beekhof

REPORTING BUGS

Report bugs to users@clusterlabs.org
June 2019 Pacemaker 2.0.1