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.
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              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       --retry-on=[attempts]
102              Count of attempts to retry power on (Default Value: 1)
103
104

ACTIONS

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

STDIN PARAMETERS

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