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       -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  of  fencing  device This parameter is
40              always required.
41
42       -u, --ipport=[port]
43              TCP/UDP port to use for connection with device  (Default  Value:
44              80)
45
46       -c, --page=[page]
47              Name  of  hidden  page  (Default  Value: hidden.htm)
48
49
50       -p, --password=[password]
51              Login password or passphrase
52
53       -S, --password-script=[script]
54              Script to run to retrieve password
55
56       -n, --plug=[id]
57              Physical plug  number  on  device,  UUID  or  identification  of
58              machine This parameter is always required.
59
60       -l, --username=[name]
61              Login name
62
63       -q, --quiet
64              Disable logging to stderr. Does not affect --verbose or --debug-
65              file or logging to syslog.
66
67       -v, --verbose
68              Verbose mode
69
70       -D, --debug-file=[debugfile]
71              Write debug information to given file
72
73       -V, --version
74              Display version information and exit
75
76       -h, --help
77              Display help and exit
78
79       -C, --separator=[char]
80              Separator for CSV created by 'list' operation (Default Value: ,)
81
82
83       --delay=[seconds]
84              Wait  X  seconds  before  fencing  is started (Default Value: 0)
85
86
87       --login-timeout=[seconds]
88              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
89
90
91       --power-timeout=[seconds]
92              Test  X  seconds  for status change after ON/OFF (Default Value:
93              20)
94
95       --power-wait=[seconds]
96              Wait X seconds after issuing ON/OFF (Default Value: 0)
97
98       --shell-timeout=[seconds]
99              Wait X seconds for cmd prompt  after  issuing  command  (Default
100              Value: 3)
101
102       --retry-on=[attempts]
103              Count of attempts to retry power on (Default Value: 1)
104
105

ACTIONS

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

STDIN PARAMETERS

139
140
141       action Fencing action (Default Value: reboot)
142
143       inet4_only
144              Forces agent to use IPv4 addresses only
145
146       inet6_only
147              Forces agent to use IPv6 addresses only
148
149       ip     IP address or hostname  of  fencing  device  This  parameter  is
150              always required. Obsoletes: ipaddr
151
152       ipport TCP/UDP  port  to use for connection with device (Default Value:
153              80)
154
155       page   Name of hidden page (Default Value: hidden.htm) Obsoletes:  hid‐
156              den_page
157
158       password
159              Login password or passphrase Obsoletes: passwd
160
161       password_script
162              Script  to  run  to  retrieve  password Obsoletes: passwd_script
163
164
165       plug   Physical plug  number  on  device,  UUID  or  identification  of
166              machine This parameter is always required. Obsoletes: port
167
168
169       username
170              Login name Obsoletes: login
171
172       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
173              file or logging to syslog.
174
175       verbose
176              Verbose mode
177
178       debug_file
179              Write debug information to given file Obsoletes: debug
180
181       version
182              Display version information and exit
183
184       help   Display help and exit
185
186       separator
187              Separator for CSV created by 'list' operation (Default Value: ,)
188
189
190       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
191
192
193       login_timeout
194              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
195
196
197       power_timeout
198              Test X seconds for status change after  ON/OFF  (Default  Value:
199              20)
200
201       power_wait
202              Wait X seconds after issuing ON/OFF (Default Value: 0)
203
204       shell_timeout
205              Wait  X  seconds  for  cmd prompt after issuing command (Default
206              Value: 3)
207
208       retry_on
209              Count of attempts to retry power on (Default Value: 1)
210
211
212
213fence_eps (Fence Agent)           2009-10-20                    FENCE_AGENT(8)