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       -4, --inet4-only
28              Forces agent to use IPv4 addresses only
29
30       -6, --inet6-only
31              Forces agent to use IPv6 addresses only
32
33       -a, --ip=[ip]
34              IP address or hostname of fencing device
35
36       -u, --ipport=[port]
37              TCP/UDP port to use for connection with device  (Default  Value:
38              443)
39
40       -p, --password=[password]
41              Login password or passphrase
42
43       -S, --password-script=[script]
44              Script to run to retrieve password
45
46       -n, --plug=[ip]
47              IP  address or hostname of fencing device (together with --port-
48              as-ip)
49
50       --redfish-uri=[uri]
51              Base or starting Redfish URI (Default Value: /redfish/v1)
52
53       -z, --ssl
54              Use SSL connection with verifying certificate (Default Value: 1)
55
56
57       --ssl-insecure
58              Use SSL connection without verifying certificate
59
60       --ssl-secure
61              Use SSL connection with verifying certificate
62
63       --systems-uri=[uri]
64              Redfish  Systems  resource  URI,  i.e.  /redfish/v1/Systems/Sys‐
65              tem.Embedded.1
66
67       -l, --username=[name]
68              Login name This parameter is always required.
69
70       -q, --quiet
71              Disable logging to stderr. Does not affect --verbose or --debug-
72              file or logging to syslog.
73
74       -v, --verbose
75              Verbose mode
76
77       -D, --debug-file=[debugfile]
78              Write debug information to given file
79
80       -V, --version
81              Display version information and exit
82
83       -h, --help
84              Display help and exit
85
86       --delay=[seconds]
87              Wait  X  seconds  before  fencing  is started (Default Value: 0)
88
89
90       --login-timeout=[seconds]
91              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
92
93
94       --port-as-ip
95              Make "port/plug" to be an alias to IP address
96
97       --power-timeout=[seconds]
98              Test  X  seconds  for status change after ON/OFF (Default Value:
99              20)
100
101       --power-wait=[seconds]
102              Wait X seconds after issuing ON/OFF (Default Value: 0)
103
104       --shell-timeout=[seconds]
105              Wait X seconds for cmd prompt  after  issuing  command  (Default
106              Value: 3)
107
108       --retry-on=[attempts]
109              Count of attempts to retry power on (Default Value: 1)
110
111       --gnutlscli-path=[path]
112              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
113
114

ACTIONS

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

STDIN PARAMETERS

140
141
142       action Fencing action (Default Value: reboot)
143
144       inet4_only
145              Forces agent to use IPv4 addresses only
146
147       inet6_only
148              Forces agent to use IPv6 addresses only
149
150       ip     IP address or hostname of fencing device Obsoletes: ipaddr
151
152
153       ipport TCP/UDP port to use for connection with device  (Default  Value:
154              443)
155
156       password
157              Login password or passphrase Obsoletes: passwd
158
159       password_script
160              Script  to  run  to  retrieve  password Obsoletes: passwd_script
161
162
163       plug   IP address or hostname of fencing device (together with  --port-
164              as-ip) Obsoletes: port
165
166       redfish_uri
167              Base  or starting Redfish URI (Default Value: /redfish/v1) Obso‐
168              letes: redfish-uri
169
170       ssl    Use SSL connection with verifying certificate (Default Value: 1)
171
172
173       ssl_insecure
174              Use SSL connection without verifying certificate
175
176       ssl_secure
177              Use SSL connection with verifying certificate
178
179       systems_uri
180              Redfish  Systems  resource  URI,  i.e.  /redfish/v1/Systems/Sys‐
181              tem.Embedded.1 Obsoletes: systems-uri
182
183       username
184              Login name This parameter is always required.  Obsoletes:  login
185
186
187       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
188              file or logging to syslog.
189
190       verbose
191              Verbose mode
192
193       debug_file
194              Write debug information to given file Obsoletes: debug
195
196       version
197              Display version information and exit
198
199       help   Display help and exit
200
201       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
202
203
204       login_timeout
205              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
206
207
208       port_as_ip
209              Make "port/plug" to be an alias to IP address
210
211       power_timeout
212              Test X seconds for status change after  ON/OFF  (Default  Value:
213              20)
214
215       power_wait
216              Wait X seconds after issuing ON/OFF (Default Value: 0)
217
218       shell_timeout
219              Wait  X  seconds  for  cmd prompt after issuing command (Default
220              Value: 3)
221
222       retry_on
223              Count of attempts to retry power on (Default Value: 1)
224
225       gnutlscli_path
226              Path to gnutls-cli binary (Default Value: /usr/bin/gnutls-cli)
227
228
229
230fence_redfish (Fence Agent)       2009-10-20                    FENCE_AGENT(8)