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

NAME

7       fence_hds_cb - Fence agent for Hitachi Compute Blade systems
8

DESCRIPTION

10       fence_hds_cb  is  an  I/O  Fencing agent which can be used with Hitachi
11       Compute Blades with recent enough firmware that  includes  telnet  sup‐
12       port.
13
14       fence_hds_cb accepts options on the command line as well as from stdin.
15       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
16       fence_hds_cb  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.hds.com
20

PARAMETERS

22
23
24       -o, --action=[action]
25              Fencing action (Default Value: reboot)
26
27       -c, --command-prompt=[prompt]
28              Force Python regex for command prompt (Default Value: ['\)  :'])
29
30
31       -k, --identity-file=[filename]
32              Identity file (private key) for SSH
33
34       -4, --inet4-only
35              Forces agent to use IPv4 addresses only
36
37       -6, --inet6-only
38              Forces agent to use IPv6 addresses only
39
40       -a, --ip=[ip]
41              IP  address  or hostname of fencing device This parameter is al‐
42              ways required.
43
44       -u, --ipport=[port]
45              TCP/UDP port to use for connection with device  (Default  Value:
46              23)
47
48       -p, --password=[password]
49              Login password or passphrase
50
51       -S, --password-script=[script]
52              Script to run to retrieve password
53
54       -n, --plug=[id]
55              Physical  plug  number  on device, UUID or identification of ma‐
56              chine This parameter is always required.
57
58       -x, --ssh
59              Use SSH connection
60
61       --ssh-options=[options]
62              SSH options to use
63
64       -l, --username=[name]
65              Login name This parameter is always required.
66
67       -q, --quiet
68              Disable logging to stderr. Does not affect --verbose or --debug-
69              file or logging to syslog.
70
71       -v, --verbose
72              Verbose  mode.  Multiple  -v flags can be stacked on the command
73              line (e.g., -vvv) to increase verbosity.
74
75       --verbose-level
76              Level of debugging detail in output. Defaults to the  number  of
77              --verbose  flags  specified on the command line, or to 1 if ver‐
78              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
79
80
81       -D, --debug-file=[debugfile]
82              Write debug information to given file
83
84       -V, --version
85              Display version information and exit
86
87       -h, --help
88              Display help and exit
89
90       --plug-separator=[char]
91              Separator  for  plug  parameter when specifying more than 1 plug
92              (Default Value: ,)
93
94       -C, --separator=[char]
95              Separator for CSV created by 'list' operation (Default Value: ,)
96
97
98       --delay=[seconds]
99              Wait  X  seconds  before  fencing  is started (Default Value: 0)
100
101
102       --disable-timeout=[true/false]
103              Disable timeout (true/false) (default: true when run from  Pace‐
104              maker 2.0+)
105
106       --login-timeout=[seconds]
107              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
108
109
110       --missing-as-off
111              Missing port returns OFF instead of failure
112
113       --power-timeout=[seconds]
114              Test X seconds for status change after  ON/OFF  (Default  Value:
115              20)
116
117       --power-wait=[seconds]
118              Wait X seconds after issuing ON/OFF (Default Value: 5)
119
120       --shell-timeout=[seconds]
121              Wait  X  seconds  for  cmd prompt after issuing command (Default
122              Value: 3)
123
124       --stonith-status-sleep=[seconds]
125              Sleep X seconds between status calls  during  a  STONITH  action
126              (Default Value: 1)
127
128       --retry-on=[attempts]
129              Count of attempts to retry power on (Default Value: 1)
130
131       --ssh-path=[path]
132              Path to ssh binary (Default Value: /usr/bin/ssh)
133
134       --telnet-path=[path]
135              Path to telnet binary (Default Value: /usr/bin/telnet)
136
137

ACTIONS

139
140
141       on     Power on machine.
142
143       off    Power off machine.
144
145       reboot Reboot machine.
146
147       status This returns the status of the plug/virtual machine.
148
149       list   List  available  plugs with aliases/virtual machines if there is
150              support for more then one device. Returns N/A otherwise.
151
152       list-status
153              List available plugs with  aliases/virtual  machines  and  their
154              power  state  if it can be obtained without additional commands.
155
156
157       monitor
158              Check the health of fence device
159
160       metadata
161              Display the XML metadata describing this resource.
162
163       manpage
164               The operational behavior of this is not known.
165
166       validate-all
167              Validate if all required parameters are entered.
168
169

STDIN PARAMETERS

171
172
173       action Fencing action (Default Value: reboot)
174
175       command_prompt
176              Force Python regex for command prompt (Default Value: ['\)  :'])
177              Obsoletes: cmd_prompt
178
179       identity_file
180              Identity file (private key) for SSH
181
182       inet4_only
183              Forces agent to use IPv4 addresses only
184
185       inet6_only
186              Forces agent to use IPv6 addresses only
187
188       ip     IP  address  or hostname of fencing device This parameter is al‐
189              ways required. Obsoletes: ipaddr
190
191       ipport TCP/UDP port to use for connection with device  (Default  Value:
192              23)
193
194       password
195              Login password or passphrase Obsoletes: passwd
196
197       password_script
198              Script  to  run  to  retrieve  password Obsoletes: passwd_script
199
200
201       plug   Physical plug number on device, UUID or  identification  of  ma‐
202              chine  This  parameter is always required. Obsoletes: port
203
204
205       ssh    Use SSH connection Obsoletes: secure
206
207       ssh_options
208              SSH options to use
209
210       username
211              Login name This parameter is always required.  Obsoletes:  login
212
213
214       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
215              file or logging to syslog.
216
217       verbose
218              Verbose mode. Multiple -v flags can be stacked  on  the  command
219              line (e.g., -vvv) to increase verbosity.
220
221       verbose_level
222              Level  of  debugging detail in output. Defaults to the number of
223              --verbose flags specified on the command line, or to 1  if  ver‐
224              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
225
226
227       debug_file
228              Write debug information to given file Obsoletes: debug
229
230       version
231              Display version information and exit
232
233       help   Display help and exit
234
235       plug_separator
236              Separator for plug parameter when specifying more  than  1  plug
237              (Default Value: ,)
238
239       separator
240              Separator for CSV created by 'list' operation (Default Value: ,)
241
242
243       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
244
245
246       disable_timeout
247              Disable  timeout (true/false) (default: true when run from Pace‐
248              maker 2.0+)
249
250       login_timeout
251              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
252
253
254       missing_as_off
255              Missing port returns OFF instead of failure
256
257       power_timeout
258              Test  X  seconds  for status change after ON/OFF (Default Value:
259              20)
260
261       power_wait
262              Wait X seconds after issuing ON/OFF (Default Value: 5)
263
264       shell_timeout
265              Wait X seconds for cmd prompt  after  issuing  command  (Default
266              Value: 3)
267
268       stonith_status_sleep
269              Sleep  X  seconds  between  status calls during a STONITH action
270              (Default Value: 1)
271
272       retry_on
273              Count of attempts to retry power on (Default Value: 1)
274
275       ssh_path
276              Path to ssh binary (Default Value: /usr/bin/ssh)
277
278       telnet_path
279              Path to telnet binary (Default Value: /usr/bin/telnet)
280
281
282
283fence_hds_cb (Fence Agent)        2009-10-20                    FENCE_AGENT(8)