fence_tripplite_snmp(8)

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

NAME

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

ACTIONS

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

STDIN PARAMETERS

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