fence_apc_snmp(8)

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

NAME

7       fence_apc_snmp - Fence agent for APC, Tripplite PDU over SNMP
8
9       fence_tripplite_snmp - Fence agent for Tripplife over SNMP (symlink)
10
11

DESCRIPTION

13       fence_apc_snmp  is  an I/O Fencing agent which can be used with the APC
14       network power switch or Tripplite PDU devices.It logs into a device via
15       SNMP  and reboots a specified outlet. It supports SNMP v1, v2c, v3 with
16       all combinations of  authenticity/privacy settings.
17
18       fence_apc_snmp accepts options on the command  line  as  well  as  from
19       stdin.  Fenced  sends parameters through stdin when it execs the agent.
20       fence_apc_snmp can be run by itself with command line options.  This is
21       useful for testing and for turning outlets on or off from scripts.
22
23       Vendor URL: http://www.apc.com
24

PARAMETERS

26
27
28       -o, --action=[action]
29              Fencing action (Default Value: reboot)
30
31       -c, --community=[community]
32              Set the community string (Default Value: private)
33
34       -4, --inet4-only
35              Forces agent to use IPv4 addresses only
36
37       -6, --inet6-only
38              Forces agent to use IPv6 addresses only
39
40       -a, --ip=[ip]
41              IP  address  or  hostname  of  fencing  device This parameter is
42              always required.
43
44       -u, --ipport=[port]
45              TCP/UDP port to use for connection with device  (Default  Value:
46              161)
47
48       -p, --password=[password]
49              Login password or passphrase
50
51       -S, --password-script=[script]
52              Script to run to retrieve password
53
54       -n, --plug=[id]
55              Physical  plug  number  on  device,  UUID  or  identification of
56              machine This parameter is always required.
57
58       -b, --snmp-auth-prot=[prot]
59              Set authentication protocol (MD5|SHA)
60
61       -P, --snmp-priv-passwd=[pass]
62              Set privacy protocol password
63
64       -R, --snmp-priv-passwd-script
65              Script to run to retrieve privacy password
66
67       -B, --snmp-priv-prot=[prot]
68              Set privacy protocol (DES|AES)
69
70       -E, --snmp-sec-level=[level]
71              Set security level (noAuthNoPriv|authNoPriv|authPriv)
72
73       -d, --snmp-version=[version]
74              Specifies SNMP version to use (1|2c|3) (Default Value: 1)
75
76       -l, --username=[name]
77              Login name
78
79       -q, --quiet
80              Disable logging to stderr. Does not affect --verbose or --debug-
81              file or logging to syslog.
82
83       -v, --verbose
84              Verbose mode
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       --login-timeout=[seconds]
104              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
105
106
107       --power-timeout=[seconds]
108              Test X seconds for status change after  ON/OFF  (Default  Value:
109              20)
110
111       --power-wait=[seconds]
112              Wait X seconds after issuing ON/OFF (Default Value: 0)
113
114       --shell-timeout=[seconds]
115              Wait  X  seconds  for  cmd prompt after issuing command (Default
116              Value: 3)
117
118       --retry-on=[attempts]
119              Count of attempts to retry power on (Default Value: 1)
120
121       --snmpget-path=[path]
122              Path to snmpget binary (Default Value: /usr/bin/snmpget)
123
124       --snmpset-path=[path]
125              Path to snmpset binary (Default Value: /usr/bin/snmpset)
126
127       --snmpwalk-path=[path]
128              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
129
130

ACTIONS

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

STDIN PARAMETERS

164
165
166       action Fencing action (Default Value: reboot)
167
168       community
169              Set the community string (Default Value: private)
170
171       inet4_only
172              Forces agent to use IPv4 addresses only
173
174       inet6_only
175              Forces agent to use IPv6 addresses only
176
177       ip     IP  address  or  hostname  of  fencing  device This parameter is
178              always required. Obsoletes: ipaddr
179
180       ipport TCP/UDP port to use for connection with device  (Default  Value:
181              161)
182
183       password
184              Login password or passphrase Obsoletes: passwd
185
186       password_script
187              Script  to  run  to  retrieve  password Obsoletes: passwd_script
188
189
190       plug   Physical plug  number  on  device,  UUID  or  identification  of
191              machine This parameter is always required. Obsoletes: port
192
193
194       snmp_auth_prot
195              Set authentication protocol (MD5|SHA)
196
197       snmp_priv_passwd
198              Set privacy protocol password
199
200       snmp_priv_passwd_script
201              Script to run to retrieve privacy password
202
203       snmp_priv_prot
204              Set privacy protocol (DES|AES)
205
206       snmp_sec_level
207              Set security level (noAuthNoPriv|authNoPriv|authPriv)
208
209       snmp_version
210              Specifies SNMP version to use (1|2c|3) (Default Value: 1)
211
212       username
213              Login name Obsoletes: login
214
215       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
216              file or logging to syslog.
217
218       verbose
219              Verbose mode
220
221       debug_file
222              Write debug information to given file Obsoletes: debug
223
224       version
225              Display version information and exit
226
227       help   Display help and exit
228
229       separator
230              Separator for CSV created by 'list' operation (Default Value: ,)
231
232
233       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
234
235
236       login_timeout
237              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
238
239
240       power_timeout
241              Test X seconds for status change after  ON/OFF  (Default  Value:
242              20)
243
244       power_wait
245              Wait X seconds after issuing ON/OFF (Default Value: 0)
246
247       shell_timeout
248              Wait  X  seconds  for  cmd prompt after issuing command (Default
249              Value: 3)
250
251       retry_on
252              Count of attempts to retry power on (Default Value: 1)
253
254       snmpget_path
255              Path to snmpget binary (Default Value: /usr/bin/snmpget)
256
257       snmpset_path
258              Path to snmpset binary (Default Value: /usr/bin/snmpset)
259
260       snmpwalk_path
261              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
262
263
264
265fence_apc_snmp (Fence Agent)      2009-10-20                    FENCE_AGENT(8)