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
73
74       -D, --debug-file=[debugfile]
75              Write debug information to given file
76
77       -V, --version
78              Display version information and exit
79
80       -h, --help
81              Display help and exit
82
83       -C, --separator=[char]
84              Separator for CSV created by 'list' operation (Default Value: ,)
85
86
87       --delay=[seconds]
88              Wait X seconds before fencing  is  started  (Default  Value:  0)
89
90
91       --login-timeout=[seconds]
92              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
93
94
95       --missing-as-off
96              Missing port returns OFF instead of failure
97
98       --power-timeout=[seconds]
99              Test X seconds for status change after  ON/OFF  (Default  Value:
100              20)
101
102       --power-wait=[seconds]
103              Wait X seconds after issuing ON/OFF (Default Value: 5)
104
105       --shell-timeout=[seconds]
106              Wait  X  seconds  for  cmd prompt after issuing command (Default
107              Value: 3)
108
109       --retry-on=[attempts]
110              Count of attempts to retry power on (Default Value: 1)
111
112       --ssh-path=[path]
113              Path to ssh binary (Default Value: /usr/bin/ssh)
114
115       --telnet-path=[path]
116              Path to telnet binary (Default Value: /usr/bin/telnet)
117
118

ACTIONS

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

STDIN PARAMETERS

152
153
154       action Fencing action (Default Value: reboot)
155
156       command_prompt
157              Force  Python regex for command prompt (Default Value: ['\) :'])
158              Obsoletes: cmd_prompt
159
160       identity_file
161              Identity file (private key) for SSH
162
163       inet4_only
164              Forces agent to use IPv4 addresses only
165
166       inet6_only
167              Forces agent to use IPv6 addresses only
168
169       ip     IP address or hostname  of  fencing  device  This  parameter  is
170              always required. Obsoletes: ipaddr
171
172       ipport TCP/UDP  port  to use for connection with device (Default Value:
173              23)
174
175       password
176              Login password or passphrase Obsoletes: passwd
177
178       password_script
179              Script to run  to  retrieve  password  Obsoletes:  passwd_script
180
181
182       plug   Physical  plug  number  on  device,  UUID  or  identification of
183              machine This parameter is always required. Obsoletes: port
184
185
186       ssh    Use SSH connection Obsoletes: secure
187
188       ssh_options
189              SSH options to use
190
191       username
192              Login  name  This parameter is always required. Obsoletes: login
193
194
195       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
196              file or logging to syslog.
197
198       verbose
199              Verbose mode
200
201       debug_file
202              Write debug information to given file Obsoletes: debug
203
204       version
205              Display version information and exit
206
207       help   Display help and exit
208
209       separator
210              Separator for CSV created by 'list' operation (Default Value: ,)
211
212
213       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
214
215
216       login_timeout
217              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
218
219
220       missing_as_off
221              Missing port returns OFF instead of failure
222
223       power_timeout
224              Test X seconds for status change after  ON/OFF  (Default  Value:
225              20)
226
227       power_wait
228              Wait X seconds after issuing ON/OFF (Default Value: 5)
229
230       shell_timeout
231              Wait  X  seconds  for  cmd prompt after issuing command (Default
232              Value: 3)
233
234       retry_on
235              Count of attempts to retry power on (Default Value: 1)
236
237       ssh_path
238              Path to ssh binary (Default Value: /usr/bin/ssh)
239
240       telnet_path
241              Path to telnet binary (Default Value: /usr/bin/telnet)
242
243
244
245fence_hds_cb (Fence Agent)        2009-10-20                    FENCE_AGENT(8)