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       -a, --ip=[ip]
30              IP  address  or hostname of fencing device This parameter is al‐
31              ways required.
32
33       -u, --ipport=[port]
34              TCP/UDP port to use for connection with device  (Default  Value:
35              161)
36
37       -p, --password=[password]
38              Login password or passphrase
39
40       -S, --password-script=[script]
41              Script to run to retrieve password
42
43       -n, --plug=[id]
44              Physical  plug  number  on device, UUID or identification of ma‐
45              chine This parameter is always required.
46
47       -b, --snmp-auth-prot=[prot]
48              Set authentication protocol (MD5|SHA)
49
50       -P, --snmp-priv-passwd=[pass]
51              Set privacy protocol password
52
53       -R, --snmp-priv-passwd-script
54              Script to run to retrieve privacy password
55
56       -B, --snmp-priv-prot=[prot]
57              Set privacy protocol (DES|AES)
58
59       -E, --snmp-sec-level=[level]
60              Set security level (noAuthNoPriv|authNoPriv|authPriv)
61
62       -d, --snmp-version=[version]
63              Specifies SNMP version to use (1|2c|3)
64
65       -l, --username=[name]
66              Login name
67
68       -q, --quiet
69              Disable logging to stderr. Does not affect --verbose or --debug-
70              file or logging to syslog.
71
72       -v, --verbose
73              Verbose  mode.  Multiple  -v flags can be stacked on the command
74              line (e.g., -vvv) to increase verbosity.
75
76       --verbose-level
77              Level of debugging detail in output. Defaults to the  number  of
78              --verbose  flags  specified on the command line, or to 1 if ver‐
79              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
80
81
82       -D, --debug-file=[debugfile]
83              Write debug information to given file
84
85       -V, --version
86              Display version information and exit
87
88       -h, --help
89              Display help and exit
90
91       --plug-separator=[char]
92              Separator  for  plug  parameter when specifying more than 1 plug
93              (Default Value: ,)
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       --disable-timeout=[true/false]
104              Disable timeout (true/false) (default: true when run from  Pace‐
105              maker 2.0+)
106
107       --login-timeout=[seconds]
108              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
109
110
111       --power-timeout=[seconds]
112              Test X seconds for status change after  ON/OFF  (Default  Value:
113              20)
114
115       --power-wait=[seconds]
116              Wait X seconds after issuing ON/OFF (Default Value: 5)
117
118       --shell-timeout=[seconds]
119              Wait  X  seconds  for  cmd prompt after issuing command (Default
120              Value: 3)
121
122       --stonith-status-sleep=[seconds]
123              Sleep X seconds between status calls  during  a  STONITH  action
124              (Default Value: 1)
125
126       --retry-on=[attempts]
127              Count of attempts to retry power on (Default Value: 1)
128
129       --snmpget-path=[path]
130              Path to snmpget binary (Default Value: /usr/bin/snmpget)
131
132       --snmpset-path=[path]
133              Path to snmpset binary (Default Value: /usr/bin/snmpset)
134
135       --snmpwalk-path=[path]
136              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
137
138

ACTIONS

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

STDIN PARAMETERS

172
173
174       action Fencing action (Default Value: reboot)
175
176       community
177              Set the community string
178
179       ip     IP address or hostname of fencing device This parameter  is  al‐
180              ways required. Obsoletes: ipaddr
181
182       ipport TCP/UDP  port  to use for connection with device (Default Value:
183              161)
184
185       password
186              Login password or passphrase Obsoletes: passwd
187
188       password_script
189              Script to run  to  retrieve  password  Obsoletes:  passwd_script
190
191
192       plug   Physical  plug  number  on device, UUID or identification of ma‐
193              chine This parameter is always required. Obsoletes:  port
194
195
196       snmp_auth_prot
197              Set authentication protocol (MD5|SHA)
198
199       snmp_priv_passwd
200              Set privacy protocol password
201
202       snmp_priv_passwd_script
203              Script to run to retrieve privacy password
204
205       snmp_priv_prot
206              Set privacy protocol (DES|AES)
207
208       snmp_sec_level
209              Set security level (noAuthNoPriv|authNoPriv|authPriv)
210
211       snmp_version
212              Specifies SNMP version to use (1|2c|3)
213
214       username
215              Login name Obsoletes: login
216
217       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
218              file or logging to syslog.
219
220       verbose
221              Verbose mode. Multiple -v flags can be stacked  on  the  command
222              line (e.g., -vvv) to increase verbosity.
223
224       verbose_level
225              Level  of  debugging detail in output. Defaults to the number of
226              --verbose flags specified on the command line, or to 1  if  ver‐
227              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
228
229
230       debug_file
231              Write debug information to given file Obsoletes: debug
232
233       version
234              Display version information and exit
235
236       help   Display help and exit
237
238       plug_separator
239              Separator for plug parameter when specifying more  than  1  plug
240              (Default Value: ,)
241
242       separator
243              Separator for CSV created by 'list' operation (Default Value: ,)
244
245
246       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
247
248
249       disable_timeout
250              Disable  timeout (true/false) (default: true when run from Pace‐
251              maker 2.0+)
252
253       login_timeout
254              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
255
256
257       power_timeout
258              Test  X  seconds  for status change after ON/OFF (Default Value:
259              20)
260
261       power_wait
262              Wait X seconds after issuing ON/OFF (Default Value: 5)
263
264       shell_timeout
265              Wait X seconds for cmd prompt  after  issuing  command  (Default
266              Value: 3)
267
268       stonith_status_sleep
269              Sleep  X  seconds  between  status calls during a STONITH action
270              (Default Value: 1)
271
272       retry_on
273              Count of attempts to retry power on (Default Value: 1)
274
275       snmpget_path
276              Path to snmpget binary (Default Value: /usr/bin/snmpget)
277
278       snmpset_path
279              Path to snmpset binary (Default Value: /usr/bin/snmpset)
280
281       snmpwalk_path
282              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
283
284
285
286fence_emerson (Fence Agent)       2009-10-20                    FENCE_AGENT(8)