stonith_admin man page

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.

Device definition commands

-R, --register=value

Register the named stonith device. Requires: --agent. Optional: any number of --option and/or --env entries.

-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.

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.

-H, --history=value

Show last successful fencing operation for named node (or '*' for all nodes). Optional: --timeout, --quiet (show only the operation's epoch timestamp), --verbose (show all recorded and pending operations).

-h, --last=value

Indicate when the named node was last fenced. Optional: --as-node-id.

Additional Options

-a, --agent=value

The agent to use (for example, fence_xvm; with --register, --metadata).

-o, --option=value

Specify a device configuration parameter as NAME=VALUE (with --register).

-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_ (with --register).

-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

A device to associate with a given host and stonith level (with --register-level).

-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

Info

April 2018 Pacemaker 2.0.0-0.1.rc2.fc29 System Administration Utilities