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       -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              16992)
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       --delay=[seconds]
75              Wait  X  seconds  before  fencing  is started (Default Value: 0)
76
77
78       --login-timeout=[seconds]
79              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
80
81
82       --port-as-ip
83              Make "port/plug" to be an alias to IP address
84
85       --power-timeout=[seconds]
86              Test  X  seconds  for status change after ON/OFF (Default Value:
87              20)
88
89       --power-wait=[seconds]
90              Wait X seconds after issuing ON/OFF (Default Value: 0)
91
92       --shell-timeout=[seconds]
93              Wait X seconds for cmd prompt  after  issuing  command  (Default
94              Value: 3)
95
96       --retry-on=[attempts]
97              Count of attempts to retry power on (Default Value: 1)
98
99

ACTIONS

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

STDIN PARAMETERS

125
126
127       action Fencing action (Default Value: reboot)
128
129       boot_option
130              Change    the    default   boot   behavior   of   the   machine.
131              (pxe|hd|hdsafe|cd|diag)
132
133       inet4_only
134              Forces agent to use IPv4 addresses only
135
136       inet6_only
137              Forces agent to use IPv6 addresses only
138
139       ip     IP address or hostname of fencing device Obsoletes: ipaddr
140
141
142       ipport TCP/UDP  port  to use for connection with device (Default Value:
143              16992)
144
145       method Method to fence (onoff|cycle) (Default Value: onoff)
146
147
148       password
149              Login password or passphrase Obsoletes: passwd
150
151       password_script
152              Script  to  run  to  retrieve  password Obsoletes: passwd_script
153
154
155       plug   IP address or hostname of fencing device (together with  --port-
156              as-ip) Obsoletes: port
157
158       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
159              file or logging to syslog.
160
161       verbose
162              Verbose mode
163
164       debug_file
165              Write debug information to given file Obsoletes: debug
166
167       version
168              Display version information and exit
169
170       help   Display help and exit
171
172       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
173
174
175       login_timeout
176              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
177
178
179       port_as_ip
180              Make "port/plug" to be an alias to IP address
181
182       power_timeout
183              Test X seconds for status change after  ON/OFF  (Default  Value:
184              20)
185
186       power_wait
187              Wait X seconds after issuing ON/OFF (Default Value: 0)
188
189       shell_timeout
190              Wait  X  seconds  for  cmd prompt after issuing command (Default
191              Value: 3)
192
193       retry_on
194              Count of attempts to retry power on (Default Value: 1)
195
196
197
198fence_amt_ws (Fence Agent)        2009-10-20                    FENCE_AGENT(8)