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       -C, --separator=[char]
91              Separator for CSV created by 'list' operation (Default Value: ,)
92
93
94       --delay=[seconds]
95              Wait X seconds before fencing  is  started  (Default  Value:  0)
96
97
98       --disable-timeout=[true/false]
99              Disable  timeout (true/false) (default: true when run from Pace‐
100              maker 2.0+)
101
102       --login-timeout=[seconds]
103              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
104
105
106       --missing-as-off
107              Missing port returns OFF instead of failure
108
109       --power-timeout=[seconds]
110              Test  X  seconds  for status change after ON/OFF (Default Value:
111              20)
112
113       --power-wait=[seconds]
114              Wait X seconds after issuing ON/OFF (Default Value: 5)
115
116       --shell-timeout=[seconds]
117              Wait X seconds for cmd prompt  after  issuing  command  (Default
118              Value: 3)
119
120       --stonith-status-sleep=[seconds]
121              Sleep  X  seconds  between  status calls during a STONITH action
122              (Default Value: 1)
123
124       --retry-on=[attempts]
125              Count of attempts to retry power on (Default Value: 1)
126
127       --ssh-path=[path]
128              Path to ssh binary (Default Value: /usr/bin/ssh)
129
130       --telnet-path=[path]
131              Path to telnet binary (Default Value: /usr/bin/telnet)
132
133

ACTIONS

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

STDIN PARAMETERS

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