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

ACTIONS

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

STDIN PARAMETERS

134
135
136       action Fencing action (Default Value: reboot)
137
138       boot_option
139              Change  the  default  boot  behavior of the machine. (pxe|hd|hd‐
140              safe|cd|diag)
141
142       ip     IP address or hostname of fencing device Obsoletes: ipaddr
143
144
145       ipport TCP/UDP  port  to use for connection with device (Default Value:
146              16992)
147
148       method Method to fence (onoff|cycle) (Default Value: onoff)
149
150
151       password
152              Login password or passphrase Obsoletes: passwd
153
154       password_script
155              Script  to  run  to  retrieve  password Obsoletes: passwd_script
156
157
158       plug   IP address or hostname of fencing device (together with  --port-
159              as-ip) Obsoletes: port
160
161       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
162              file or logging to syslog.
163
164       verbose
165              Verbose mode. Multiple -v flags can be stacked  on  the  command
166              line (e.g., -vvv) to increase verbosity.
167
168       verbose_level
169              Level  of  debugging detail in output. Defaults to the number of
170              --verbose flags specified on the command line, or to 1  if  ver‐
171              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
172
173
174       debug_file
175              Write debug information to given file Obsoletes: debug
176
177       version
178              Display version information and exit
179
180       help   Display help and exit
181
182       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
183
184
185       disable_timeout
186              Disable  timeout (true/false) (default: true when run from Pace‐
187              maker 2.0+)
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       stonith_status_sleep
208              Sleep  X  seconds  between  status calls during a STONITH action
209              (Default Value: 1)
210
211       retry_on
212              Count of attempts to retry power on (Default Value: 1)
213
214
215
216fence_amt_ws (Fence Agent)        2009-10-20                    FENCE_AGENT(8)