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
42              always 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
56              machine 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       --retry-on=[attempts]
121              Count of attempts to retry power on (Default Value: 1)
122
123       --ssh-path=[path]
124              Path to ssh binary (Default Value: /usr/bin/ssh)
125
126       --telnet-path=[path]
127              Path to telnet binary (Default Value: /usr/bin/telnet)
128
129

ACTIONS

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

STDIN PARAMETERS

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