1
2FENCE_AGENT(8)              System Manager's Manual             FENCE_AGENT(8)
3
4
5

NAME

7       fence_redfish - I/O Fencing agent for Redfish
8

DESCRIPTION

10       fence_redfish  is  an  I/O Fencing agent which can be used with Out-of-
11       Band controllers that support Redfish APIs. These  controllers  provide
12       remote access to control power on a server.
13
14       fence_redfish  accepts  options  on  the  command  line as well as from
15       stdin. Fenced sends parameters through stdin when it execs  the  agent.
16       fence_redfish  can be run by itself with command line options.  This is
17       useful for testing and for turning outlets on or off from scripts.
18
19       Vendor URL: http://www.dmtf.org
20

PARAMETERS

22
23
24       -o, --action=[action]
25              Fencing action (Default Value: reboot)
26
27       -a, --ip=[ip]
28              IP address or hostname of fencing device
29
30       -u, --ipport=[port]
31              TCP/UDP port to use for connection with device  (Default  Value:
32              443)
33
34       -p, --password=[password]
35              Login password or passphrase
36
37       -S, --password-script=[script]
38              Script to run to retrieve password
39
40       -n, --plug=[ip]
41              IP  address or hostname of fencing device (together with --port-
42              as-ip)
43
44       --redfish-uri=[uri]
45              Base or starting Redfish URI (Default Value: /redfish/v1)
46
47       -z, --ssl
48              Use SSL connection with verifying certificate (Default Value: 1)
49
50
51       --ssl-insecure
52              Use SSL connection without verifying certificate
53
54       --ssl-secure
55              Use SSL connection with verifying certificate
56
57       --systems-uri=[uri]
58              Redfish  Systems  resource  URI,  i.e.  /redfish/v1/Systems/Sys‐
59              tem.Embedded.1
60
61       -l, --username=[name]
62              Login name This parameter is always required.
63
64       -q, --quiet
65              Disable logging to stderr. Does not affect --verbose or --debug-
66              file or logging to syslog.
67
68       -v, --verbose
69              Verbose  mode.  Multiple  -v flags can be stacked on the command
70              line (e.g., -vvv) to increase verbosity.
71
72       --verbose-level
73              Level of debugging detail in output. Defaults to the  number  of
74              --verbose  flags  specified on the command line, or to 1 if ver‐
75              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
76
77
78       -D, --debug-file=[debugfile]
79              Write debug information to given file
80
81       -V, --version
82              Display version information and exit
83
84       -h, --help
85              Display help and exit
86
87       --delay=[seconds]
88              Wait  X  seconds  before  fencing  is started (Default Value: 0)
89
90
91       --disable-timeout=[true/false]
92              Disable timeout (true/false) (default: true when run from  Pace‐
93              maker 2.0+)
94
95       --login-timeout=[seconds]
96              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
97
98
99       --port-as-ip
100              Make "port/plug" to be an alias to IP address
101
102       --power-timeout=[seconds]
103              Test X seconds for status change after  ON/OFF  (Default  Value:
104              20)
105
106       --power-wait=[seconds]
107              Wait X seconds after issuing ON/OFF (Default Value: 0)
108
109       --shell-timeout=[seconds]
110              Wait  X  seconds  for  cmd prompt after issuing command (Default
111              Value: 3)
112
113       --stonith-status-sleep=[seconds]
114              Sleep X seconds between status calls  during  a  STONITH  action
115              (Default Value: 1)
116
117       --retry-on=[attempts]
118              Count of attempts to retry power on (Default Value: 1)
119
120       --gnutlscli-path=[path]
121              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
122
123

ACTIONS

125
126
127       on     Power on machine.
128
129       off    Power off machine.
130
131       reboot Reboot machine.
132
133       status This returns the status of the plug/virtual machine.
134
135       monitor
136              Check the health of fence device
137
138       metadata
139              Display the XML metadata describing this resource.
140
141       manpage
142               The operational behavior of this is not known.
143
144       validate-all
145              Validate if all required parameters are entered.
146
147       diag   Pulse a diagnostic interrupt to the processor(s).
148
149

STDIN PARAMETERS

151
152
153       action Fencing action (Default Value: reboot)
154
155       ip     IP address or hostname of fencing device Obsoletes: ipaddr
156
157
158       ipport TCP/UDP port to use for connection with device  (Default  Value:
159              443)
160
161       password
162              Login password or passphrase Obsoletes: passwd
163
164       password_script
165              Script  to  run  to  retrieve  password Obsoletes: passwd_script
166
167
168       plug   IP address or hostname of fencing device (together with  --port-
169              as-ip) Obsoletes: port
170
171       redfish_uri
172              Base  or starting Redfish URI (Default Value: /redfish/v1) Obso‐
173              letes: redfish-uri
174
175       ssl    Use SSL connection with verifying certificate (Default Value: 1)
176
177
178       ssl_insecure
179              Use SSL connection without verifying certificate
180
181       ssl_secure
182              Use SSL connection with verifying certificate
183
184       systems_uri
185              Redfish  Systems  resource  URI,  i.e.  /redfish/v1/Systems/Sys‐
186              tem.Embedded.1 Obsoletes: systems-uri
187
188       username
189              Login name This parameter is always required.  Obsoletes:  login
190
191
192       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
193              file or logging to syslog.
194
195       verbose
196              Verbose mode. Multiple -v flags can be stacked  on  the  command
197              line (e.g., -vvv) to increase verbosity.
198
199       verbose_level
200              Level  of  debugging detail in output. Defaults to the number of
201              --verbose flags specified on the command line, or to 1  if  ver‐
202              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
203
204
205       debug_file
206              Write debug information to given file Obsoletes: debug
207
208       version
209              Display version information and exit
210
211       help   Display help and exit
212
213       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
214
215
216       disable_timeout
217              Disable  timeout (true/false) (default: true when run from Pace‐
218              maker 2.0+)
219
220       login_timeout
221              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
222
223
224       port_as_ip
225              Make "port/plug" to be an alias to IP address
226
227       power_timeout
228              Test  X  seconds  for status change after ON/OFF (Default Value:
229              20)
230
231       power_wait
232              Wait X seconds after issuing ON/OFF (Default Value: 0)
233
234       shell_timeout
235              Wait X seconds for cmd prompt  after  issuing  command  (Default
236              Value: 3)
237
238       stonith_status_sleep
239              Sleep  X  seconds  between  status calls during a STONITH action
240              (Default Value: 1)
241
242       retry_on
243              Count of attempts to retry power on (Default Value: 1)
244
245       gnutlscli_path
246              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
247
248
249
250fence_redfish (Fence Agent)       2009-10-20                    FENCE_AGENT(8)