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       -4, --inet4-only
32              Forces agent to use IPv4 addresses only
33
34       -6, --inet6-only
35              Forces agent to use IPv6 addresses only
36
37       -a, --ip=[ip]
38              IP address or hostname of fencing device
39
40       -u, --ipport=[port]
41              TCP/UDP  port  to use for connection with device (Default Value:
42              16994)
43
44       -m, --method=[method]
45              Method to fence (onoff|cycle) (Default Value: onoff)
46
47
48       -p, --password=[password]
49              Login password or passphrase
50
51       -S, --password-script=[script]
52              Script to run to retrieve password
53
54       -n, --plug=[ip]
55              IP  address or hostname of fencing device (together with --port-
56              as-ip)
57
58       -q, --quiet
59              Disable logging to stderr. Does not affect --verbose or --debug-
60              file or logging to syslog.
61
62       -v, --verbose
63              Verbose mode
64
65       -D, --debug-file=[debugfile]
66              Write debug information to given file
67
68       -V, --version
69              Display version information and exit
70
71       -h, --help
72              Display help and exit
73
74       --amttool-path=[path]
75              Path to amttool binary (Default Value: /usr/bin/amttool)
76
77       --delay=[seconds]
78              Wait  X  seconds  before  fencing  is started (Default Value: 0)
79
80
81       --login-timeout=[seconds]
82              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
83
84
85       --port-as-ip
86              Make "port/plug" to be an alias to IP address
87
88       --power-timeout=[seconds]
89              Test  X  seconds  for status change after ON/OFF (Default Value:
90              20)
91
92       --power-wait=[seconds]
93              Wait X seconds after issuing ON/OFF (Default Value: 0)
94
95       --shell-timeout=[seconds]
96              Wait X seconds for cmd prompt  after  issuing  command  (Default
97              Value: 3)
98
99       --retry-on=[attempts]
100              Count  of  attempts  to  retry power on (Default Value: 1)
101
102
103       --use-sudo
104              Use sudo (without password)  when  calling  3rd  party  software
105
106
107       --sudo-path=[path]
108              Path to sudo binary (Default Value: /usr/bin/sudo)
109
110

ACTIONS

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

STDIN PARAMETERS

136
137
138       action Fencing action (Default Value: reboot)
139
140       boot_option
141              Change    the    default   boot   behavior   of   the   machine.
142              (pxe|hd|hdsafe|cd|diag)
143
144       inet4_only
145              Forces agent to use IPv4 addresses only
146
147       inet6_only
148              Forces agent to use IPv6 addresses only
149
150       ip     IP address or hostname of fencing device Obsoletes: ipaddr
151
152
153       ipport TCP/UDP  port  to use for connection with device (Default Value:
154              16994)
155
156       method Method to fence (onoff|cycle) (Default Value: onoff)
157
158
159       password
160              Login password or passphrase Obsoletes: passwd
161
162       password_script
163              Script  to  run  to  retrieve  password Obsoletes: passwd_script
164
165
166       plug   IP address or hostname of fencing device (together with  --port-
167              as-ip) Obsoletes: port
168
169       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
170              file or logging to syslog.
171
172       verbose
173              Verbose mode
174
175       debug_file
176              Write debug information to given file Obsoletes: debug
177
178       version
179              Display version information and exit
180
181       help   Display help and exit
182
183       amttool_path
184              Path to amttool binary (Default Value: /usr/bin/amttool)
185
186       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
187
188
189       login_timeout
190              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
191
192
193       port_as_ip
194              Make "port/plug" to be an alias to IP address
195
196       power_timeout
197              Test X seconds for status change after  ON/OFF  (Default  Value:
198              20)
199
200       power_wait
201              Wait X seconds after issuing ON/OFF (Default Value: 0)
202
203       shell_timeout
204              Wait  X  seconds  for  cmd prompt after issuing command (Default
205              Value: 3)
206
207       retry_on
208              Count of attempts to retry power on  (Default  Value:  1)
209
210
211       use_sudo
212              Use  sudo  (without  password)  when  calling 3rd party software
213              Obsoletes: sudo
214
215       sudo_path
216              Path to sudo binary (Default Value: /usr/bin/sudo)
217
218
219
220fence_amt (Fence Agent)           2009-10-20                    FENCE_AGENT(8)