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

ACTIONS

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

STDIN PARAMETERS

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