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

NAME

7       fence_ecloud - Fence Agent for ANS eCloud
8

DESCRIPTION

10       fence_ecloud  is  a  fence  agent  for use with the ANS eCloud platform
11       which is compatible with eCloud VPC and eCloud v1.
12
13       fence_ecloud accepts options on the command line as well as from stdin.
14       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
15       fence_ecloud 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: https://www.ans.co.uk
19

PARAMETERS

21
22
23       --apikey=[key]
24              API Key This parameter is always required.
25
26       -o, --action=[action]
27              Fencing action (Default Value: reboot)
28
29       -n, --plug=[instance]
30              Instance ID (VPC) or server ID (v1) This parameter is always re‐
31              quired.
32
33       -q, --quiet
34              Disable logging to stderr. Does not affect --verbose or --debug-
35              file or logging to syslog.
36
37       -v, --verbose
38              Verbose  mode.  Multiple  -v flags can be stacked on the command
39              line (e.g., -vvv) to increase verbosity.
40
41       --verbose-level
42              Level of debugging detail in output. Defaults to the  number  of
43              --verbose  flags  specified on the command line, or to 1 if ver‐
44              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
45
46
47       -D, --debug-file=[debugfile]
48              Write debug information to given file
49
50       -V, --version
51              Display version information and exit
52
53       -h, --help
54              Display help and exit
55
56       --plug-separator=[char]
57              Separator  for  plug  parameter when specifying more than 1 plug
58              (Default Value: ,)
59
60       -C, --separator=[char]
61              Separator for CSV created by 'list' operation (Default Value: ,)
62
63
64       --delay=[seconds]
65              Wait  X  seconds  before  fencing  is started (Default Value: 0)
66
67
68       --disable-timeout=[true/false]
69              Disable timeout (true/false) (default: true when run from  Pace‐
70              maker 2.0+)
71
72       --login-timeout=[seconds]
73              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
74
75
76       --power-timeout=[seconds]
77              Test X seconds for status change after  ON/OFF  (Default  Value:
78              20)
79
80       --power-wait=[seconds]
81              Wait X seconds after issuing ON/OFF (Default Value: 0)
82
83       --shell-timeout=[seconds]
84              Wait  X  seconds  for  cmd prompt after issuing command (Default
85              Value: 3)
86
87       --stonith-status-sleep=[seconds]
88              Sleep X seconds between status calls  during  a  STONITH  action
89              (Default Value: 1)
90
91       --retry-on=[attempts]
92              Count of attempts to retry power on (Default Value: 1)
93
94

ACTIONS

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

STDIN PARAMETERS

128
129
130       apikey API Key This parameter is always required.
131
132       action Fencing action (Default Value: reboot)
133
134       plug   Instance ID (VPC) or server ID (v1) This parameter is always re‐
135              quired. Obsoletes: port
136
137       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
138              file or logging to syslog.
139
140       verbose
141              Verbose mode. Multiple -v flags can be stacked  on  the  command
142              line (e.g., -vvv) to increase verbosity.
143
144       verbose_level
145              Level  of  debugging detail in output. Defaults to the number of
146              --verbose flags specified on the command line, or to 1  if  ver‐
147              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
148
149
150       debug_file
151              Write debug information to given file Obsoletes: debug
152
153       version
154              Display version information and exit
155
156       help   Display help and exit
157
158       plug_separator
159              Separator for plug parameter when specifying more  than  1  plug
160              (Default Value: ,)
161
162       separator
163              Separator for CSV created by 'list' operation (Default Value: ,)
164
165
166       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
167
168
169       disable_timeout
170              Disable  timeout (true/false) (default: true when run from Pace‐
171              maker 2.0+)
172
173       login_timeout
174              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
175
176
177       power_timeout
178              Test  X  seconds  for status change after ON/OFF (Default Value:
179              20)
180
181       power_wait
182              Wait X seconds after issuing ON/OFF (Default Value: 0)
183
184       shell_timeout
185              Wait X seconds for cmd prompt  after  issuing  command  (Default
186              Value: 3)
187
188       stonith_status_sleep
189              Sleep  X  seconds  between  status calls during a STONITH action
190              (Default Value: 1)
191
192       retry_on
193              Count of attempts to retry power on (Default Value: 1)
194
195
196
197fence_ecloud (Fence Agent)        2009-10-20                    FENCE_AGENT(8)