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

NAME

7       fence_emerson - Fence agent for Emerson over SNMP
8

DESCRIPTION

10       fence_emerson  is an I/O Fencing agent   which can be used with MPX and
11       MPH2 managed rack PDU.
12
13       fence_emerson accepts options on the  command  line  as  well  as  from
14       stdin.  Fenced  sends parameters through stdin when it execs the agent.
15       fence_emerson can be run by itself with command line options.  This  is
16       useful for testing and for turning outlets on or off from scripts.
17
18       Vendor URL: http://www.emersonnetworkpower.com
19

PARAMETERS

21
22
23       -o, --action=[action]
24              Fencing action (Default Value: reboot)
25
26       -c, --community=[community]
27              Set the community string
28
29       -4, --inet4-only
30              Forces agent to use IPv4 addresses only
31
32       -6, --inet6-only
33              Forces agent to use IPv6 addresses only
34
35       -a, --ip=[ip]
36              IP  address  or  hostname  of  fencing  device This parameter is
37              always required.
38
39       -u, --ipport=[port]
40              TCP/UDP port to use for connection with device  (Default  Value:
41              161)
42
43       -p, --password=[password]
44              Login password or passphrase
45
46       -S, --password-script=[script]
47              Script to run to retrieve password
48
49       -n, --plug=[id]
50              Physical  plug  number  on  device,  UUID  or  identification of
51              machine This 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)
70
71       -l, --username=[name]
72              Login name
73
74       -q, --quiet
75              Disable logging to stderr. Does not affect --verbose or --debug-
76              file or logging to syslog.
77
78       -v, --verbose
79              Verbose mode
80
81       -D, --debug-file=[debugfile]
82              Write debug information to given file
83
84       -V, --version
85              Display version information and exit
86
87       -h, --help
88              Display help and exit
89
90       -C, --separator=[char]
91              Separator for CSV created by 'list' operation (Default Value: ,)
92
93
94       --delay=[seconds]
95              Wait X seconds before fencing  is  started  (Default  Value:  0)
96
97
98       --login-timeout=[seconds]
99              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
100
101
102       --power-timeout=[seconds]
103              Test X seconds for status change after  ON/OFF  (Default  Value:
104              20)
105
106       --power-wait=[seconds]
107              Wait X seconds after issuing ON/OFF (Default Value: 5)
108
109       --shell-timeout=[seconds]
110              Wait  X  seconds  for  cmd prompt after issuing command (Default
111              Value: 3)
112
113       --retry-on=[attempts]
114              Count of attempts to retry power on (Default Value: 1)
115
116       --snmpget-path=[path]
117              Path to snmpget binary (Default Value: /usr/bin/snmpget)
118
119       --snmpset-path=[path]
120              Path to snmpset binary (Default Value: /usr/bin/snmpset)
121
122       --snmpwalk-path=[path]
123              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
124
125

ACTIONS

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

STDIN PARAMETERS

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