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       --plug-separator=[char]
88              Separator  for  plug  parameter when specifying more than 1 plug
89              (Default Value: ,)
90
91       --delay=[seconds]
92              Wait X seconds before fencing  is  started  (Default  Value:  0)
93
94
95       --disable-timeout=[true/false]
96              Disable  timeout (true/false) (default: true when run from Pace‐
97              maker 2.0+)
98
99       --login-timeout=[seconds]
100              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
101
102
103       --port-as-ip
104              Make "port/plug" to be an alias to IP address
105
106       --power-timeout=[seconds]
107              Test  X  seconds  for status change after ON/OFF (Default Value:
108              20)
109
110       --power-wait=[seconds]
111              Wait X seconds after issuing ON/OFF (Default Value: 0)
112
113       --shell-timeout=[seconds]
114              Wait X seconds for cmd prompt  after  issuing  command  (Default
115              Value: 3)
116
117       --stonith-status-sleep=[seconds]
118              Sleep  X  seconds  between  status calls during a STONITH action
119              (Default Value: 1)
120
121       --retry-on=[attempts]
122              Count of attempts to retry power on (Default Value: 1)
123
124       --gnutlscli-path=[path]
125              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
126
127

ACTIONS

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

STDIN PARAMETERS

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