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       --retry-on=[attempts]
114              Count of attempts to retry power on (Default Value: 1)
115
116       --gnutlscli-path=[path]
117              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
118
119

ACTIONS

121
122
123       on     Power on machine.
124
125       off    Power off machine.
126
127       reboot Reboot machine.
128
129       status This returns the status of the plug/virtual machine.
130
131       monitor
132              Check the health of fence device
133
134       metadata
135              Display the XML metadata describing this resource.
136
137       manpage
138               The operational behavior of this is not known.
139
140       validate-all
141              Validate if all required parameters are entered.
142
143

STDIN PARAMETERS

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