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

ACTIONS

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

STDIN PARAMETERS

154
155
156       action Fencing action (Default Value: reboot)
157
158       command_prompt
159              Force  Python  regex  for  command  prompt (Default Value: ['0',
160              '0pc>']) Obsoletes: cmd_prompt
161
162       identity_file
163              Identity file (private key) for SSH
164
165       inet4_only
166              Forces agent to use IPv4 addresses only
167
168       inet6_only
169              Forces agent to use IPv6 addresses only
170
171       ip     IP address or hostname  of  fencing  device  This  parameter  is
172              always required. Obsoletes: ipaddr
173
174       ipport TCP/UDP  port  to use for connection with device (Default Value:
175              23)
176
177       password
178              Login password or passphrase Obsoletes: passwd
179
180       password_script
181              Script to run  to  retrieve  password  Obsoletes:  passwd_script
182
183
184       plug   Physical  plug  number  on  device,  UUID  or  identification of
185              machine This parameter is always required. Obsoletes: port
186
187
188       ssh    Use SSH connection Obsoletes: secure
189
190       ssh_options
191              SSH options to use (Default Value: -1 -c blowfish)
192
193       switch Physical switch number on device
194
195       username
196              Login  name  This parameter is always required. Obsoletes: login
197
198
199       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
200              file or logging to syslog.
201
202       verbose
203              Verbose mode
204
205       debug_file
206              Write debug information to given file Obsoletes: debug
207
208       version
209              Display version information and exit
210
211       help   Display help and exit
212
213       separator
214              Separator for CSV created by 'list' operation (Default Value: ,)
215
216
217       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
218
219
220       login_timeout
221              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
222
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_apc (Fence Agent)           2009-10-20                    FENCE_AGENT(8)