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       -a, --ip=<ip>
30              IP Address or Hostname This parameter is always required.
31
32       -l, --username=<name>
33              Login Name This parameter is always required.
34
35       -p, --password=<password>
36              Login password or passphrase
37
38       -S, --password-script=<script>
39              Script to retrieve password
40
41       -x, --ssh
42              SSH connection
43
44       -n, --plug=<id>
45              Physical plug number or name of virtual machine  This  parameter
46              is always required.
47
48       -k, --identity-file=<filename>
49              Identity file for ssh
50
51       -s, --switch=<id>
52              Physical switch number on device
53
54       -4, --inet4-only
55              Forces agent to use IPv4 addresses only
56
57       -6, --inet6-only
58              Forces agent to use IPv6 addresses only
59
60       -u, --ipport=<port>
61              TCP port to use for connection with device
62
63       -v, --verbose
64              Verbose mode
65
66       -D, --debug-file=<debugfile>
67              Write debug information to given file
68
69       -V, --version
70              Display version information and exit
71
72       -h, --help
73              Display help and exit
74
75       -C, --separator=<char>
76              Separator  for  CSV created by operation list (Default Value: ,)
77
78
79       --power-timeout
80              Test X seconds for status change after  ON/OFF  (Default  Value:
81              20)
82
83       --shell-timeout
84              Wait  X  seconds  for  cmd prompt after issuing command (Default
85              Value: 3)
86
87       --login-timeout
88              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
89
90
91       --power-wait
92              Wait X seconds after issuing ON/OFF (Default Value: 0)
93
94       --delay
95              Wait  X  seconds  before  fencing  is started (Default Value: 0)
96
97
98       --retry-on
99              Count of attempts to retry power on (Default Value: 1)
100
101

ACTIONS

103
104
105       on     Power on machine.
106
107       off    Power off machine.
108
109       reboot Reboot machine.
110
111       status This returns the status of the plug/virtual machine.
112
113       list   List available plugs with aliases/virtual machines if  there  is
114              support for more then one device. Returns N/A otherwise.
115
116       monitor
117              Check if fencing device is running. List available plugs/virtual
118              machines or get status of machine (if it does not support more).
119
120
121       metadata
122               The operational behavior of this is not known.
123
124

STDIN PARAMETERS

126
127
128       action Fencing Action (Default Value: reboot)
129
130       ipaddr IP Address or Hostname This parameter is always required.
131
132       login  Login Name This parameter is always required.
133
134       passwd Login password or passphrase
135
136       passwd_script
137              Script to retrieve password
138
139       secure SSH connection
140
141       port   Physical  plug  number or name of virtual machine This parameter
142              is always required.
143
144       identity_file
145              Identity file for ssh
146
147       switch Physical switch number on device
148
149       inet4_only
150              Forces agent to use IPv4 addresses only
151
152       inet6_only
153              Forces agent to use IPv6 addresses only
154
155       ipport TCP port to use for connection with device
156
157       verbose
158              Verbose mode
159
160       debug  Write debug information to given file
161
162       version
163              Display version information and exit
164
165       help   Display help and exit
166
167       separator
168              Separator for CSV created by operation list (Default  Value:  ,)
169
170
171       power_timeout
172              Test  X  seconds  for status change after ON/OFF (Default Value:
173              20)
174
175       shell_timeout
176              Wait X seconds for cmd prompt  after  issuing  command  (Default
177              Value: 3)
178
179       login_timeout
180              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
181
182
183       power_wait
184              Wait X seconds after issuing ON/OFF (Default Value: 0)
185
186       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
187
188
189       retry_on
190              Count of attempts to retry power on (Default Value: 1)
191
192
193
194fence_apc (Fence Agent)           2009-10-20                    FENCE_AGENT(8)