fence_cyberpower_ssh(8)

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

NAME

7       fence_cyberpower_ssh - Fence agent for CyberPower over ssh
8

DESCRIPTION

10       fence_cyberpower_ssh is an I/O Fencing agent which can be used with the
11       CyberPower network power switch. It logs into device via  ssh  and  re‐
12       boots  a  specified  outlet.  Lengthy ssh connections should be avoided
13       while a GFS cluster is running because the connection  will  block  any
14       necessary fencing actions.
15
16       fence_cyberpower_ssh  accepts  options  on  the command line as well as
17       from stdin. Fenced sends parameters through stdin  when  it  execs  the
18       agent.  fence_cyberpower_ssh can be run by itself with command line op‐
19       tions.  This is useful for testing and for turning outlets  on  or  off
20       from scripts.
21
22       Vendor URL: http://www.cyberpower.com
23

PARAMETERS

25
26
27       -o, --action=[action]
28              Fencing action (Default Value: reboot)
29
30       -c, --command-prompt=[prompt]
31              Force  Python  regex  for  command  prompt (Default Value: ['0',
32              '0yberPower >'])
33
34       -k, --identity-file=[filename]
35              Identity file (private key) for SSH
36
37       -4, --inet4-only
38              Forces agent to use IPv4 addresses only
39
40       -6, --inet6-only
41              Forces agent to use IPv6 addresses only
42
43       -a, --ip=[ip]
44              IP address or hostname of fencing device This parameter  is  al‐
45              ways required.
46
47       -u, --ipport=[port]
48              TCP/UDP port to use for connection with device
49
50
51       -p, --password=[password]
52              Login password or passphrase
53
54       -S, --password-script=[script]
55              Script to run to retrieve password
56
57       -n, --plug=[id]
58              Physical plug number on device, UUID or  identification  of  ma‐
59              chine This parameter is always required.
60
61       -x, --ssh
62              Use SSH connection
63
64       --ssh-options=[options]
65              SSH options to use
66
67       -l, --username=[name]
68              Login name This parameter is always required.
69
70       -q, --quiet
71              Disable logging to stderr. Does not affect --verbose or --debug-
72              file or logging to syslog.
73
74       -v, --verbose
75              Verbose mode. Multiple -v flags can be stacked  on  the  command
76              line (e.g., -vvv) to increase verbosity.
77
78       --verbose-level
79              Level  of  debugging detail in output. Defaults to the number of
80              --verbose flags specified on the command line, or to 1  if  ver‐
81              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
82
83
84       -D, --debug-file=[debugfile]
85              Write debug information to given file
86
87       -V, --version
88              Display version information and exit
89
90       -h, --help
91              Display help and exit
92
93       -C, --separator=[char]
94              Separator for CSV created by 'list' operation (Default Value: ,)
95
96
97       --delay=[seconds]
98              Wait  X  seconds  before  fencing  is started (Default Value: 0)
99
100
101       --disable-timeout=[true/false]
102              Disable timeout (true/false) (default: true when run from  Pace‐
103              maker 2.0+)
104
105       --login-timeout=[seconds]
106              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
107
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: 0)
115
116       --shell-timeout=[seconds]
117              Wait  X  seconds  for  cmd prompt after issuing command (Default
118              Value: 3)
119
120       --stonith-status-sleep=[seconds]
121              Sleep X seconds between status calls  during  a  STONITH  action
122              (Default Value: 1)
123
124       --retry-on=[attempts]
125              Count of attempts to retry power on (Default Value: 1)
126
127       --ssh-path=[path]
128              Path to ssh binary (Default Value: /usr/bin/ssh)
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:  ['0',
170              '0yberPower >']) 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 al‐
182              ways required. Obsoletes: ipaddr
183
184       ipport TCP/UDP port to use for connection with device
185
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  ma‐
195              chine  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: 5)
241
242
243       power_timeout
244              Test X seconds for status change after  ON/OFF  (Default  Value:
245              20)
246
247       power_wait
248              Wait X seconds after issuing ON/OFF (Default Value: 0)
249
250       shell_timeout
251              Wait  X  seconds  for  cmd prompt after issuing command (Default
252              Value: 3)
253
254       stonith_status_sleep
255              Sleep X seconds between status calls  during  a  STONITH  action
256              (Default Value: 1)
257
258       retry_on
259              Count of attempts to retry power on (Default Value: 1)
260
261       ssh_path
262              Path to ssh binary (Default Value: /usr/bin/ssh)
263
264
265
266fence_cyberpower_ssh (Fence Agent)2009-10-20                    FENCE_AGENT(8)