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

NAME

7       fence_hpblade - Fence agent for HP BladeSystem
8

DESCRIPTION

10       fence_hpblade  is  an  I/O  Fencing  agent  which  can  be used with HP
11       BladeSystem and HP Integrity Superdome X.  It  logs  into  the  onboard
12       administrator  of  an  enclosure via telnet or ssh and uses the command
13       line interface to power blades or partitions on or off.
14
15       fence_hpblade accepts options on the  command  line  as  well  as  from
16       stdin.  Fenced  sends parameters through stdin when it execs the agent.
17       fence_hpblade can be run by itself with command line options.  This  is
18       useful for testing and for turning outlets on or off from scripts.
19
20       Vendor URL: http://www.hp.com
21

PARAMETERS

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

ACTIONS

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

STDIN PARAMETERS

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