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

NAME

7       fence_amt - Fence agent for AMT
8

DESCRIPTION

10       fence_amt  is  an  I/O  Fencing agent which can be used with Intel AMT.
11       This       agent       calls        support        software        amt‐
12       tool(http://www.kraxel.org/cgit/amtterm/).
13
14       fence_amt  accepts  options  on the command line as well as from stdin.
15       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
16       fence_amt can be run by itself with command line options.  This is use‐
17       ful for testing and for turning outlets on or off from scripts.
18
19       Vendor URL: http://www.intel.com/
20

PARAMETERS

22
23
24       -o, --action=[action]
25              Fencing action (Default Value: reboot)
26
27       -b, --boot-option=[option]
28              Change the default boot behavior  of  the  machine.  (pxe|hd|hd‐
29              safe|cd|diag)
30
31       -a, --ip=[ip]
32              IP address or hostname of fencing device
33
34       -u, --ipport=[port]
35              TCP/UDP  port  to use for connection with device (Default Value:
36              16994)
37
38       -m, --method=[method]
39              Method to fence (onoff|cycle) (Default Value: onoff)
40
41
42       -p, --password=[password]
43              Login password or passphrase
44
45       -S, --password-script=[script]
46              Script to run to retrieve password
47
48       -n, --plug=[ip]
49              IP  address or hostname of fencing device (together with --port-
50              as-ip)
51
52       -q, --quiet
53              Disable logging to stderr. Does not affect --verbose or --debug-
54              file or logging to syslog.
55
56       -v, --verbose
57              Verbose  mode.  Multiple  -v flags can be stacked on the command
58              line (e.g., -vvv) to increase verbosity.
59
60       --verbose-level
61              Level of debugging detail in output. Defaults to the  number  of
62              --verbose  flags  specified on the command line, or to 1 if ver‐
63              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
64
65
66       -D, --debug-file=[debugfile]
67              Write debug information to given file
68
69       -V, --version
70              Display version information and exit
71
72       -h, --help
73              Display help and exit
74
75       --plug-separator=[char]
76              Separator  for  plug  parameter when specifying more than 1 plug
77              (Default Value: ,)
78
79       --amttool-path=[path]
80              Path to amttool binary (Default Value: /usr/bin/amttool)
81
82       --delay=[seconds]
83              Wait X seconds before fencing  is  started  (Default  Value:  0)
84
85
86       --disable-timeout=[true/false]
87              Disable  timeout (true/false) (default: true when run from Pace‐
88              maker 2.0+)
89
90       --login-timeout=[seconds]
91              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
92
93
94       --port-as-ip
95              Make "port/plug" to be an alias to IP address
96
97       --power-timeout=[seconds]
98              Test  X  seconds  for status change after ON/OFF (Default Value:
99              20)
100
101       --power-wait=[seconds]
102              Wait X seconds after issuing ON/OFF (Default Value: 0)
103
104       --shell-timeout=[seconds]
105              Wait X seconds for cmd prompt  after  issuing  command  (Default
106              Value: 3)
107
108       --stonith-status-sleep=[seconds]
109              Sleep  X  seconds  between  status calls during a STONITH action
110              (Default Value: 1)
111
112       --retry-on=[attempts]
113              Count of attempts to retry power on  (Default  Value:  1)
114
115
116       --use-sudo
117              Use  sudo  (without  password)  when  calling 3rd party software
118
119
120       --sudo-path=[path]
121              Path to sudo binary (Default Value: /usr/bin/sudo)
122
123

ACTIONS

125
126
127       on     Power on machine.
128
129       off    Power off machine.
130
131       reboot Reboot machine.
132
133       status This returns the status of the plug/virtual machine.
134
135       monitor
136              Check the health of fence device
137
138       metadata
139              Display the XML metadata describing this resource.
140
141       manpage
142               The operational behavior of this is not known.
143
144       validate-all
145              Validate if all required parameters are entered.
146
147

STDIN PARAMETERS

149
150
151       action Fencing action (Default Value: reboot)
152
153       boot_option
154              Change the default boot behavior  of  the  machine.  (pxe|hd|hd‐
155              safe|cd|diag)
156
157       ip     IP address or hostname of fencing device Obsoletes: ipaddr
158
159
160       ipport TCP/UDP port to use for connection with device  (Default  Value:
161              16994)
162
163       method Method to fence (onoff|cycle) (Default Value: onoff)
164
165
166       password
167              Login password or passphrase Obsoletes: passwd
168
169       password_script
170              Script to run  to  retrieve  password  Obsoletes:  passwd_script
171
172
173       plug   IP  address or hostname of fencing device (together with --port-
174              as-ip) Obsoletes: port
175
176       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
177              file or logging to syslog.
178
179       verbose
180              Verbose  mode.  Multiple  -v flags can be stacked on the command
181              line (e.g., -vvv) to increase verbosity.
182
183       verbose_level
184              Level of debugging detail in output. Defaults to the  number  of
185              --verbose  flags  specified on the command line, or to 1 if ver‐
186              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
187
188
189       debug_file
190              Write debug information to given file Obsoletes: debug
191
192       version
193              Display version information and exit
194
195       help   Display help and exit
196
197       plug_separator
198              Separator  for  plug  parameter when specifying more than 1 plug
199              (Default Value: ,)
200
201       amttool_path
202              Path to amttool binary (Default Value: /usr/bin/amttool)
203
204       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
205
206
207       disable_timeout
208              Disable  timeout (true/false) (default: true when run from Pace‐
209              maker 2.0+)
210
211       login_timeout
212              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
213
214
215       port_as_ip
216              Make "port/plug" to be an alias to IP address
217
218       power_timeout
219              Test  X  seconds  for status change after ON/OFF (Default Value:
220              20)
221
222       power_wait
223              Wait X seconds after issuing ON/OFF (Default Value: 0)
224
225       shell_timeout
226              Wait X seconds for cmd prompt  after  issuing  command  (Default
227              Value: 3)
228
229       stonith_status_sleep
230              Sleep  X  seconds  between  status calls during a STONITH action
231              (Default Value: 1)
232
233       retry_on
234              Count of attempts to retry power on  (Default  Value:  1)
235
236
237       use_sudo
238              Use  sudo (without password) when calling 3rd party software Ob‐
239              soletes: sudo
240
241       sudo_path
242              Path to sudo binary (Default Value: /usr/bin/sudo)
243
244
245
246fence_amt (Fence Agent)           2009-10-20                    FENCE_AGENT(8)