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

DESCRIPTION

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

PARAMETERS

23
24
25       -o, --action=[action]
26              Fencing Action (Default Value: reboot)
27
28       -c, --community=[community]
29              Set the community string (Default Value: private)
30
31       -4, --inet4-only
32              Forces agent to use IPv4 addresses only
33
34       -6, --inet6-only
35              Forces agent to use IPv6 addresses only
36
37       -a, --ip=[ip]
38              IP Address or Hostname This parameter is always required.
39
40       -l, --username=[name]
41              Login Name
42
43       -p, --password=[password]
44              Login password or passphrase
45
46       -S, --password-script=[script]
47              Script to retrieve password
48
49       -n, --plug=[id]
50              Physical  plug  number,  name  of  virtual  machine or UUID This
51              parameter is always required.
52
53       -b, --snmp-auth-prot=[prot]
54              Set authentication protocol (MD5|SHA)
55
56       -P, --snmp-priv-passwd=[pass]
57              Set privacy protocol password
58
59       -R, --snmp-priv-passwd-script
60              Script to run to retrieve privacy password
61
62       -B, --snmp-priv-prot=[prot]
63              Set privacy protocol (DES|AES)
64
65       -E, --snmp-sec-level=[level]
66              Set security level (noAuthNoPriv|authNoPriv|authPriv)
67
68       -d, --snmp-version=[version]
69              Specifies SNMP version to use (1,2c,3) (Default Value: 1)
70
71       -u, --udpport
72              UDP/TCP port to use for connection with device
73
74       -v, --verbose
75              Verbose mode
76
77       -D, --debug-file=[debugfile]
78              Write debug information to given file
79
80       -V, --version
81              Display version information and exit
82
83       -h, --help
84              Display help and exit
85
86       -C, --separator=[char]
87              Separator for CSV created by operation list (Default  Value:  ,)
88
89
90       --delay=[seconds]
91              Wait  X  seconds  before  fencing  is started (Default Value: 0)
92
93
94       --login-timeout=[seconds]
95              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
96
97
98       --power-timeout=[seconds]
99              Test  X  seconds  for status change after ON/OFF (Default Value:
100              20)
101
102       --power-wait=[seconds]
103              Wait X seconds after issuing ON/OFF (Default Value: 0)
104
105       --shell-timeout=[seconds]
106              Wait X seconds for cmd prompt  after  issuing  command  (Default
107              Value: 3)
108
109       --retry-on=[attempts]
110              Count of attempts to retry power on (Default Value: 1)
111
112

ACTIONS

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

STDIN PARAMETERS

140
141
142       action Fencing Action (Default Value: reboot)
143
144       community
145              Set the community string (Default Value: private)
146
147       inet4_only
148              Forces agent to use IPv4 addresses only
149
150       inet6_only
151              Forces agent to use IPv6 addresses only
152
153       ipaddr IP Address or Hostname This parameter is always required.
154
155       login  Login Name
156
157       passwd Login password or passphrase
158
159       passwd_script
160              Script to retrieve password
161
162       port   Physical plug number, name  of  virtual  machine  or  UUID  This
163              parameter is always required.
164
165       snmp_auth_prot
166              Set authentication protocol (MD5|SHA)
167
168       snmp_priv_passwd
169              Set privacy protocol password
170
171       snmp_priv_passwd_script
172              Script to run to retrieve privacy password
173
174       snmp_priv_prot
175              Set privacy protocol (DES|AES)
176
177       snmp_sec_level
178              Set security level (noAuthNoPriv|authNoPriv|authPriv)
179
180       snmp_version
181              Specifies SNMP version to use (1,2c,3) (Default Value: 1)
182
183       udpport
184              UDP/TCP port to use for connection with device
185
186       verbose
187              Verbose mode
188
189       debug  Write debug information to given file
190
191       version
192              Display version information and exit
193
194       help   Display help and exit
195
196       separator
197              Separator  for  CSV created by operation list (Default Value: ,)
198
199
200       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
201
202
203       login_timeout
204              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
205
206
207       power_timeout
208              Test X seconds for status change after  ON/OFF  (Default  Value:
209              20)
210
211       power_wait
212              Wait X seconds after issuing ON/OFF (Default Value: 0)
213
214       shell_timeout
215              Wait  X  seconds  for  cmd prompt after issuing command (Default
216              Value: 3)
217
218       retry_on
219              Count of attempts to retry power on (Default Value: 1)
220
221
222
223fence_apc_snmp (Fence Agent)      2009-10-20                    FENCE_AGENT(8)