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       --amttool-path=[path]
76              Path to amttool binary (Default Value: /usr/bin/amttool)
77
78       --delay=[seconds]
79              Wait  X  seconds  before  fencing  is started (Default Value: 0)
80
81
82       --disable-timeout=[true/false]
83              Disable timeout (true/false) (default: true when run from  Pace‐
84              maker 2.0+)
85
86       --login-timeout=[seconds]
87              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
88
89
90       --port-as-ip
91              Make "port/plug" to be an alias to IP address
92
93       --power-timeout=[seconds]
94              Test X seconds for status change after  ON/OFF  (Default  Value:
95              20)
96
97       --power-wait=[seconds]
98              Wait X seconds after issuing ON/OFF (Default Value: 0)
99
100       --shell-timeout=[seconds]
101              Wait  X  seconds  for  cmd prompt after issuing command (Default
102              Value: 3)
103
104       --stonith-status-sleep=[seconds]
105              Sleep X seconds between status calls  during  a  STONITH  action
106              (Default Value: 1)
107
108       --retry-on=[attempts]
109              Count  of  attempts  to  retry power on (Default Value: 1)
110
111
112       --use-sudo
113              Use sudo (without password)  when  calling  3rd  party  software
114
115
116       --sudo-path=[path]
117              Path to sudo binary (Default Value: /usr/bin/sudo)
118
119

ACTIONS

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

STDIN PARAMETERS

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