fence_hpblade(8)

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. It logs into an enclosure via telnet or ssh and  uses  the
12       command line interface to power on and off blades.
13
14       fence_hpblade  accepts  options  on  the  command  line as well as from
15       stdin. Fenced sends parameters through stdin when it execs  the  agent.
16       fence_hpblade  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.hp.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              ['c7000oa>'])
30
31       -k, --identity-file=[filename]
32              Identity file 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 This parameter is always required.
42
43       -u, --ipport=[port]
44              TCP/UDP  port  to use for connection with device (Default Value:
45              23)
46
47       -l, --username=[name]
48              Login Name This parameter is always required.
49
50       -p, --password=[password]
51              Login password or passphrase
52
53       -S, --password-script=[script]
54              Script to retrieve password
55
56       -n, --plug=[id]
57              Physical plug number, name  of  virtual  machine  or  UUID  This
58              parameter is always required.
59
60       -x, --ssh
61              SSH connection
62
63       --ssh-options=[options]
64              SSH options to use
65
66       -v, --verbose
67              Verbose mode
68
69       -D, --debug-file=[debugfile]
70              Write debug information to given file
71
72       -V, --version
73              Display version information and exit
74
75       -h, --help
76              Display help and exit
77
78       -C, --separator=[char]
79              Separator  for  CSV created by operation list (Default Value: ,)
80
81
82       --delay=[seconds]
83              Wait X seconds before fencing  is  started  (Default  Value:  0)
84
85
86       --login-timeout=[seconds]
87              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
88
89
90       --missing-as-off
91              Missing port returns OFF instead of failure
92
93       --power-timeout=[seconds]
94              Test X seconds for status change after  ON/OFF  (Default  Value:
95              20)
96
97       --power-wait=[seconds]
98              Wait X seconds after issuing ON/OFF (Default Value: 0)
99
100       --shell-timeout=[seconds]
101              Wait  X  seconds  for  cmd prompt after issuing command (Default
102              Value: 3)
103
104       --retry-on=[attempts]
105              Count of attempts to retry power on (Default Value: 1)
106
107       --ssh-path=[path]
108              Path to ssh binary (Default Value: /usr/bin/ssh)
109
110       --telnet-path=[path]
111              Path to telnet binary (Default Value: /usr/bin/telnet)
112
113

ACTIONS

115
116
117       on     Power on machine.
118
119       off    Power off machine.
120
121       reboot Reboot machine.
122
123       status This returns the status of the plug/virtual machine.
124
125       list   List available plugs with aliases/virtual machines if  there  is
126              support for more then one device. Returns N/A otherwise.
127
128       list-status
129              List  available  plugs  with  aliases/virtual machines and their
130              power state if it can be obtained without  additional  commands.
131
132
133       monitor
134              Check the health of fence device
135
136       metadata
137              Display the XML metadata describing this resource.
138
139

STDIN PARAMETERS

141
142
143       action Fencing Action (Default Value: reboot)
144
145       cmd_prompt
146              Force   Python   regex   for   command  prompt  (Default  Value:
147              ['c7000oa>'])
148
149       identity_file
150              Identity file for ssh
151
152       inet4_only
153              Forces agent to use IPv4 addresses only
154
155       inet6_only
156              Forces agent to use IPv6 addresses only
157
158       ipaddr IP Address or Hostname This parameter is always required.
159
160       ipport TCP/UDP port to use for connection with device  (Default  Value:
161              23)
162
163       login  Login Name This parameter is always required.
164
165       passwd Login password or passphrase
166
167       passwd_script
168              Script to retrieve password
169
170       port   Physical  plug  number,  name  of  virtual  machine or UUID This
171              parameter is always required.
172
173       secure SSH connection
174
175       ssh_options
176              SSH options to use
177
178       verbose
179              Verbose mode
180
181       debug  Write debug information to given file
182
183       version
184              Display version information and exit
185
186       help   Display help and exit
187
188       separator
189              Separator for CSV created by operation list (Default  Value:  ,)
190
191
192       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
193
194
195       login_timeout
196              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
197
198
199       missing_as_off
200              Missing port returns OFF instead of failure
201
202       power_timeout
203              Test  X  seconds  for status change after ON/OFF (Default Value:
204              20)
205
206       power_wait
207              Wait X seconds after issuing ON/OFF (Default Value: 0)
208
209       shell_timeout
210              Wait X seconds for cmd prompt  after  issuing  command  (Default
211              Value: 3)
212
213       retry_on
214              Count of attempts to retry power on (Default Value: 1)
215
216       ssh_path
217              Path to ssh binary (Default Value: /usr/bin/ssh)
218
219       telnet_path
220              Path to telnet binary (Default Value: /usr/bin/telnet)
221
222
223
224fence_hpblade (Fence Agent)       2009-10-20                    FENCE_AGENT(8)