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 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 This parameter is always required.
44
45       -u, --ipport=[port]
46              TCP/UDP  port  to use for connection with device (Default Value:
47              23)
48
49       -l, --username=[name]
50              Login Name This parameter is always required.
51
52       -p, --password=[password]
53              Login password or passphrase
54
55       -S, --password-script=[script]
56              Script to retrieve password
57
58       -n, --plug=[id]
59              Physical plug number, name  of  virtual  machine  or  UUID  This
60              parameter is always required.
61
62       -x, --ssh
63              SSH connection
64
65       --ssh-options=[options]
66              SSH options to use (Default Value: -1 -c blowfish)
67
68       -s, --switch=[id]
69              Physical switch number on device
70
71       -v, --verbose
72              Verbose mode
73
74       -D, --debug-file=[debugfile]
75              Write debug information to given file
76
77       -V, --version
78              Display version information and exit
79
80       -h, --help
81              Display help and exit
82
83       -C, --separator=[char]
84              Separator  for  CSV created by operation list (Default Value: ,)
85
86
87       --delay=[seconds]
88              Wait X seconds before fencing  is  started  (Default  Value:  0)
89
90
91       --login-timeout=[seconds]
92              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
93
94
95       --power-timeout=[seconds]
96              Test X seconds for status change after  ON/OFF  (Default  Value:
97              20)
98
99       --power-wait=[seconds]
100              Wait X seconds after issuing ON/OFF (Default Value: 0)
101
102       --shell-timeout=[seconds]
103              Wait  X  seconds  for  cmd prompt after issuing command (Default
104              Value: 3)
105
106       --retry-on=[attempts]
107              Count of attempts to retry power on (Default Value: 1)
108
109       --ssh-path=[path]
110              Path to ssh binary (Default Value: /usr/bin/ssh)
111
112       --telnet-path=[path]
113              Path to telnet binary (Default Value: /usr/bin/telnet)
114
115

ACTIONS

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

STDIN PARAMETERS

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