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.
29              (pxe|hd|hdsafe|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       --retry-on=[attempts]
105              Count of attempts to retry power on  (Default  Value:  1)
106
107
108       --use-sudo
109              Use  sudo  (without  password)  when  calling 3rd party software
110
111
112       --sudo-path=[path]
113              Path to sudo binary (Default Value: /usr/bin/sudo)
114
115

ACTIONS

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

STDIN PARAMETERS

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