fence_amt_ws(8)

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

NAME

7       fence_amt_ws - Fence agent for AMT (WS)
8

DESCRIPTION

10       fence_amt_ws  is  an I/O Fencing agent which can be used with Intel AMT
11       (WS). This agent requires the pywsman Python library which is  included
12       in OpenWSMAN. (http://openwsman.github.io/).
13
14       fence_amt_ws 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_ws  can  be run by itself with command line options.  This is
17       useful 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              16992)
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       --delay=[seconds]
80              Wait X seconds before fencing  is  started  (Default  Value:  0)
81
82
83       --disable-timeout=[true/false]
84              Disable  timeout (true/false) (default: true when run from Pace‐
85              maker 2.0+)
86
87       --login-timeout=[seconds]
88              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
89
90
91       --port-as-ip
92              Make "port/plug" to be an alias to IP address
93
94       --power-timeout=[seconds]
95              Test  X  seconds  for status change after ON/OFF (Default Value:
96              20)
97
98       --power-wait=[seconds]
99              Wait X seconds after issuing ON/OFF (Default Value: 0)
100
101       --shell-timeout=[seconds]
102              Wait X seconds for cmd prompt  after  issuing  command  (Default
103              Value: 3)
104
105       --stonith-status-sleep=[seconds]
106              Sleep  X  seconds  between  status calls during a STONITH action
107              (Default Value: 1)
108
109       --retry-on=[attempts]
110              Count of attempts to retry power on (Default Value: 1)
111
112

ACTIONS

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

STDIN PARAMETERS

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