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

NAME

7       fence_eps - Fence agent for ePowerSwitch
8

DESCRIPTION

10       fence_eps   is  an I/O Fencing agent which can be used with the ePower‐
11       Switch 8M+ power switch to fence connected machines. Fence agent  works
12       ONLY  on  8M+  device,  because this is only one, which has support for
13       hidden page feature.
14
15       Agent basically works by connecting to hidden page and pass appropriate
16       arguments  to GET request. This means, that hidden page feature must be
17       enabled and properly configured.
18
19       fence_eps accepts options on the command line as well  as  from  stdin.
20       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
21       fence_eps can be run by itself with command line options.  This is use‐
22       ful for testing and for turning outlets on or off from scripts.
23
24       Vendor URL: http://www.epowerswitch.com
25

PARAMETERS

27
28
29       -o, --action=[action]
30              Fencing action (Default Value: reboot)
31
32       -a, --ip=[ip]
33              IP  address  or hostname of fencing device This parameter is al‐
34              ways required.
35
36       -u, --ipport=[port]
37              TCP/UDP port to use for connection with device  (Default  Value:
38              80)
39
40       -c, --page=[page]
41              Name  of  hidden  page  (Default  Value: hidden.htm)
42
43
44       -p, --password=[password]
45              Login password or passphrase
46
47       -S, --password-script=[script]
48              Script to run to retrieve password
49
50       -n, --plug=[id]
51              Physical plug number on device, UUID or  identification  of  ma‐
52              chine This parameter is always required.
53
54       -l, --username=[name]
55              Login name
56
57       -q, --quiet
58              Disable logging to stderr. Does not affect --verbose or --debug-
59              file or logging to syslog.
60
61       -v, --verbose
62              Verbose mode. Multiple -v flags can be stacked  on  the  command
63              line (e.g., -vvv) to increase verbosity.
64
65       --verbose-level
66              Level  of  debugging detail in output. Defaults to the number of
67              --verbose flags specified on the command line, or to 1  if  ver‐
68              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
69
70
71       -D, --debug-file=[debugfile]
72              Write debug information to given file
73
74       -V, --version
75              Display version information and exit
76
77       -h, --help
78              Display help and exit
79
80       -C, --separator=[char]
81              Separator for CSV created by 'list' operation (Default Value: ,)
82
83
84       --delay=[seconds]
85              Wait  X  seconds  before  fencing  is started (Default Value: 0)
86
87
88       --disable-timeout=[true/false]
89              Disable timeout (true/false) (default: true when run from  Pace‐
90              maker 2.0+)
91
92       --login-timeout=[seconds]
93              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
94
95
96       --power-timeout=[seconds]
97              Test X seconds for status change after  ON/OFF  (Default  Value:
98              20)
99
100       --power-wait=[seconds]
101              Wait X seconds after issuing ON/OFF (Default Value: 0)
102
103       --shell-timeout=[seconds]
104              Wait  X  seconds  for  cmd prompt after issuing command (Default
105              Value: 3)
106
107       --stonith-status-sleep=[seconds]
108              Sleep X seconds between status calls  during  a  STONITH  action
109              (Default Value: 1)
110
111       --retry-on=[attempts]
112              Count of attempts to retry power on (Default Value: 1)
113
114

ACTIONS

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

STDIN PARAMETERS

148
149
150       action Fencing action (Default Value: reboot)
151
152       ip     IP address or hostname of fencing device This parameter  is  al‐
153              ways required. Obsoletes: ipaddr
154
155       ipport TCP/UDP  port  to use for connection with device (Default Value:
156              80)
157
158       page   Name of hidden page (Default Value: hidden.htm) Obsoletes:  hid‐
159              den_page
160
161       password
162              Login password or passphrase Obsoletes: passwd
163
164       password_script
165              Script  to  run  to  retrieve  password Obsoletes: passwd_script
166
167
168       plug   Physical plug number on device, UUID or  identification  of  ma‐
169              chine  This  parameter is always required. Obsoletes: port
170
171
172       username
173              Login name Obsoletes: login
174
175       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
176              file or logging to syslog.
177
178       verbose
179              Verbose  mode.  Multiple  -v flags can be stacked on the command
180              line (e.g., -vvv) to increase verbosity.
181
182       verbose_level
183              Level of debugging detail in output. Defaults to the  number  of
184              --verbose  flags  specified on the command line, or to 1 if ver‐
185              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
186
187
188       debug_file
189              Write debug information to given file Obsoletes: debug
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 'list' operation (Default Value: ,)
198
199
200       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
201
202
203       disable_timeout
204              Disable  timeout (true/false) (default: true when run from Pace‐
205              maker 2.0+)
206
207       login_timeout
208              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
209
210
211       power_timeout
212              Test  X  seconds  for status change after ON/OFF (Default Value:
213              20)
214
215       power_wait
216              Wait X seconds after issuing ON/OFF (Default Value: 0)
217
218       shell_timeout
219              Wait X seconds for cmd prompt  after  issuing  command  (Default
220              Value: 3)
221
222       stonith_status_sleep
223              Sleep  X  seconds  between  status calls during a STONITH action
224              (Default Value: 1)
225
226       retry_on
227              Count of attempts to retry power on (Default Value: 1)
228
229
230
231fence_eps (Fence Agent)           2009-10-20                    FENCE_AGENT(8)
Impressum