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       --plug-separator=[char]
94              Separator for plug parameter when specifying more  than  1  plug
95              (Default Value: ,)
96
97       -C, --separator=[char]
98              Separator for CSV created by 'list' operation (Default Value: ,)
99
100
101       --delay=[seconds]
102              Wait X seconds before fencing  is  started  (Default  Value:  0)
103
104
105       --disable-timeout=[true/false]
106              Disable  timeout (true/false) (default: true when run from Pace‐
107              maker 2.0+)
108
109       --login-timeout=[seconds]
110              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
111
112
113       --power-timeout=[seconds]
114              Test  X  seconds  for status change after ON/OFF (Default Value:
115              20)
116
117       --power-wait=[seconds]
118              Wait X seconds after issuing ON/OFF (Default Value: 0)
119
120       --shell-timeout=[seconds]
121              Wait X seconds for cmd prompt  after  issuing  command  (Default
122              Value: 3)
123
124       --stonith-status-sleep=[seconds]
125              Sleep  X  seconds  between  status calls during a STONITH action
126              (Default Value: 1)
127
128       --retry-on=[attempts]
129              Count of attempts to retry power on (Default Value: 1)
130
131       --ssh-path=[path]
132              Path to ssh binary (Default Value: /usr/bin/ssh)
133
134

ACTIONS

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

STDIN PARAMETERS

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