1PACEMAKER(8) System Administration Utilities PACEMAKER(8)
2
6 Pacemaker - Part of the Pacemaker cluster resource manager
7
9 stonith_admin <command> [<options>]
10
12 stonith_admin - Access the Pacemaker fencing API
13
15 Help Options:
16 -?, --help
17 Show help options
18 --help-all
20 Show all help options
21 --help-output
23 Show output help
24 --help-definition
26 Show device definition help
27 --help-queries
29 Show query help
30 --help-fence
32 Show fence help
33 --help-additional
35 Show additional options
36 Output Options:
38 --output-as=FORMAT
39 Specify output format as one of: text (default), html, xml
40 --output-to=DEST
42 Specify file name for output (or "-" for stdout)
43 --html-cgi
45 Add CGI headers (requires --output-as=html)
46 --html-stylesheet=URI
48 Link to an external stylesheet (requires --output-as=html)
49 --html-title=TITLE
51 Specify a page title (requires --output-as=html)
52 --text-fancy
54 Use more highly formatted output (requires --output-as=text)
55 Device Definition Commands:
57 -R, --register=DEVICE
58 Register the named stonith device. Requires: --agent. Optional:
59 --option, --env-option.
60 -D, --deregister=DEVICE
62 De-register the named stonith device.
63 -r, --register-level=TARGET
65 Register a stonith level for the named target, specified as one
66 of NAME, @PATTERN, or ATTR=VALUE. Requires: --index and one or
67 more --device entries.
68 -d, --deregister-level=TARGET
70 Unregister a stonith level for the named target, specified as
71 for --register-level. Requires: --index
72 Queries:
74 -l, --list=HOST
75 List devices that can terminate the specified host. Optional:
76 --timeout
77 -L, --list-registered
79 List all registered devices. Optional: --timeout.
80 -I, --list-installed
82 List all installed devices. Optional: --timeout.
83 -s, --list-targets=DEVICE
85 List the targets that can be fenced by the named device. Op‐
86 tional: --timeout.
87 -M, --metadata
89 Show agent metadata. Requires: --agent. Optional: --timeout.
90 -Q, --query=DEVICE
92 Check the named device's status. Optional: --timeout.
93 -H, --history=NODE
95 Show last successful fencing operation for named node (or '*'
96 for all nodes). Optional: --timeout, --cleanup, --quiet (show
97 only the operation's epoch timestamp), --verbose (show all
98 recorded and pending operations), --broadcast (update history
99 from all nodes available).
100 -h, --last=NODE
102 Indicate when the named node was last fenced. Optional:
103 --as-node-id.
104 -K, --validate
106 Validate a fence device configuration. Requires: --agent. Op‐
107 tional: --option, --env-option, --quiet (print no output, only
108 return status).
109 Fencing Commands:
111 -F, --fence=HOST
112 Fence named host. Optional: --timeout, --tolerance, --delay.
113 -U, --unfence=HOST
115 Unfence named host. Optional: --timeout, --tolerance, --delay.
116 -B, --reboot=HOST
118 Reboot named host. Optional: --timeout, --tolerance, --delay.
119 -C, --confirm=HOST
121 Tell cluster that named host is now safely down.
122 Additional Options:
124 -c, --cleanup
125 Cleanup wherever appropriate. Requires --history.
126 -b, --broadcast
128 Broadcast wherever appropriate.
129 -a, --agent=AGENT
131 The agent to use (for example, fence_xvm; with --register,
132 --metadata, --validate).
133 -o, --option=PARAM
135 Specify a device configuration parameter as NAME=VALUE (may be
136 specified multiple times; with --register, --validate).
137 -e, --env-option=PARAM
139 Specify a device configuration parameter with the specified
140 name, using the value of the environment variable of the same
141 name prefixed with OCF_RESKEY_ (may be specified multiple times;
142 with --register, --validate).
143 -T, --tag=TAG
145 Identify fencing operations in logs with the specified tag; use‐
146 ful when multiple entities might invoke stonith_admin (used with
147 most commands).
148 -v, --device=DEVICE
150 Device ID (with --register-level, device to associate with a
151 given host and level; may be specified multiple times) (with
152 --validate, name to use to load CIB secrets).
153 -i, --index=LEVEL
155 The stonith level (1-9) (with --register-level, --deregis‐
156 ter-level).
157 -t, --timeout=SECONDS
159 Operation timeout in seconds (default 120; used with most com‐
160 mands).
161 -y, --delay=SECONDS
163 Apply a fencing delay in seconds. Any static/random delays from
164 pcmk_delay_base/max will be added, otherwise all disabled with
165 the value -1 (default 0; with --fence, --reboot, --unfence).
166 -n, --as-node-id
168 (Advanced) The supplied node is the corosync node ID (with
169 --last).
170 --tolerance=SECONDS
172 (Advanced) Do nothing if an equivalent --fence request succeeded
173 less than this many seconds earlier (with --fence, --unfence,
174 --reboot).
175 Application Options:
177 -$, --version
178 Display software version and exit
179 -V, --verbose
181 Increase debug output (may be specified multiple times)
182 -q, --quiet
184 Be less descriptive in output.
185
187 Written by Andrew Beekhof and the Pacemaker project contributors
188
190 Report bugs to https://bugz.fedoraproject.org/pacemaker
191Pacemaker 2.1.7-0.3.rc2.fc38 November 2023 PACEMAKER(8)