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

NAME

7       fence_apc - Fence agent for APC over telnet/ssh
8

DESCRIPTION

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

PARAMETERS

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

ACTIONS

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

STDIN PARAMETERS

165
166
167       action Fencing action (Default Value: reboot)
168
169       command_prompt
170              Force Python regex for  command  prompt  (Default  Value:  ['0',
171              '0pc>']) Obsoletes: cmd_prompt
172
173       identity_file
174              Identity file (private key) for SSH
175
176       inet4_only
177              Forces agent to use IPv4 addresses only
178
179       inet6_only
180              Forces agent to use IPv6 addresses only
181
182       ip     IP  address  or  hostname  of  fencing  device This parameter is
183              always required. Obsoletes: ipaddr
184
185       ipport TCP/UDP port to use for connection with device  (Default  Value:
186              23)
187
188       password
189              Login password or passphrase Obsoletes: passwd
190
191       password_script
192              Script  to  run  to  retrieve  password Obsoletes: passwd_script
193
194
195       plug   Physical plug  number  on  device,  UUID  or  identification  of
196              machine This parameter is always required. Obsoletes: port
197
198
199       ssh    Use SSH connection Obsoletes: secure
200
201       ssh_options
202              SSH options to use (Default Value: -1 -c blowfish)
203
204       switch Physical switch number on device
205
206       username
207              Login name This parameter is always required.  Obsoletes:  login
208
209
210       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
211              file or logging to syslog.
212
213       verbose
214              Verbose mode. Multiple -v flags can be stacked  on  the  command
215              line (e.g., -vvv) to increase verbosity.
216
217       verbose_level
218              Level  of  debugging detail in output. Defaults to the number of
219              --verbose flags specified on the command line, or to 1  if  ver‐
220              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
221
222
223       debug_file
224              Write debug information to given file Obsoletes: debug
225
226       version
227              Display version information and exit
228
229       help   Display help and exit
230
231       separator
232              Separator for CSV created by 'list' operation (Default Value: ,)
233
234
235       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
236
237
238       disable_timeout
239              Disable timeout (true/false) (default: true when run from  Pace‐
240              maker 2.0+)
241
242       login_timeout
243              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
244
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_apc (Fence Agent)           2009-10-20                    FENCE_AGENT(8)