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

NAME

7       fence_alom - Fence agent for Sun ALOM
8

DESCRIPTION

10       fence_alom  is  an  I/O  Fencing agent which can be used with ALOM con‐
11       nected machines.
12
13       fence_alom accepts options on the command line as well as  from  stdin.
14       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
15       fence_alom can be run by itself with command  line  options.   This  is
16       useful for testing and for turning outlets on or off from scripts.
17
18       Vendor URL: http://www.sun.com
19

PARAMETERS

21
22
23       -o, --action=[action]
24              Fencing action (Default Value: reboot)
25
26       -c, --command-prompt=[prompt]
27              Force  Python  regex  for command prompt (Default Value: ['sc\>\
28              '])
29
30       -k, --identity-file=[filename]
31              Identity file (private key) for SSH
32
33       -4, --inet4-only
34              Forces agent to use IPv4 addresses only
35
36       -6, --inet6-only
37              Forces agent to use IPv6 addresses only
38
39       -a, --ip=[ip]
40              IP address or hostname of fencing device
41
42       -u, --ipport=[port]
43              TCP/UDP port to use for connection with device  (Default  Value:
44              22)
45
46       -p, --password=[password]
47              Login password or passphrase
48
49       -S, --password-script=[script]
50              Script to run to retrieve password
51
52       -n, --plug=[ip]
53              IP  address or hostname of fencing device (together with --port-
54              as-ip)
55
56       -x, --ssh
57              Use SSH connection (Default Value: 1)
58
59       --ssh-options=[options]
60              SSH options to use
61
62       -l, --username=[name]
63              Login name This parameter is always required.
64
65       -q, --quiet
66              Disable logging to stderr. Does not affect --verbose or --debug-
67              file or logging to syslog.
68
69       -v, --verbose
70              Verbose  mode.  Multiple  -v flags can be stacked on the command
71              line (e.g., -vvv) to increase verbosity.
72
73       --verbose-level
74              Level of debugging detail in output. Defaults to the  number  of
75              --verbose  flags  specified on the command line, or to 1 if ver‐
76              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
77
78
79       -D, --debug-file=[debugfile]
80              Write debug information to given file
81
82       -V, --version
83              Display version information and exit
84
85       -h, --help
86              Display help and exit
87
88       --plug-separator=[char]
89              Separator  for  plug  parameter when specifying more than 1 plug
90              (Default Value: ,)
91
92       --delay=[seconds]
93              Wait X seconds before fencing  is  started  (Default  Value:  0)
94
95
96       --disable-timeout=[true/false]
97              Disable  timeout (true/false) (default: true when run from Pace‐
98              maker 2.0+)
99
100       --login-timeout=[seconds]
101              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
102
103
104       --port-as-ip
105              Make "port/plug" to be an alias to IP address
106
107       --power-timeout=[seconds]
108              Test  X  seconds  for status change after ON/OFF (Default Value:
109              20)
110
111       --power-wait=[seconds]
112              Wait X seconds after issuing ON/OFF (Default Value: 0)
113
114       --shell-timeout=[seconds]
115              Wait X seconds for cmd prompt  after  issuing  command  (Default
116              Value: 3)
117
118       --stonith-status-sleep=[seconds]
119              Sleep  X  seconds  between  status calls during a STONITH action
120              (Default Value: 1)
121
122       --retry-on=[attempts]
123              Count of attempts to retry power on (Default Value: 1)
124
125       --ssh-path=[path]
126              Path to ssh binary (Default Value: /usr/bin/ssh)
127
128

ACTIONS

130
131
132       on     Power on machine.
133
134       off    Power off machine.
135
136       reboot Reboot machine.
137
138       status This returns the status of the plug/virtual machine.
139
140       monitor
141              Check the health of fence device
142
143       metadata
144              Display the XML metadata describing this resource.
145
146       manpage
147               The operational behavior of this is not known.
148
149       validate-all
150              Validate if all required parameters are entered.
151
152

STDIN PARAMETERS

154
155
156       action Fencing action (Default Value: reboot)
157
158       command_prompt
159              Force Python regex for command prompt  (Default  Value:  ['sc\>\
160              ']) Obsoletes: cmd_prompt
161
162       identity_file
163              Identity file (private key) for SSH
164
165       inet4_only
166              Forces agent to use IPv4 addresses only
167
168       inet6_only
169              Forces agent to use IPv6 addresses only
170
171       ip     IP address or hostname of fencing device Obsoletes: ipaddr
172
173
174       ipport TCP/UDP port to use for connection with device  (Default  Value:
175              22)
176
177       password
178              Login password or passphrase Obsoletes: passwd
179
180       password_script
181              Script  to  run  to  retrieve  password Obsoletes: passwd_script
182
183
184       plug   IP address or hostname of fencing device (together with  --port-
185              as-ip) Obsoletes: port
186
187       ssh    Use SSH connection (Default Value: 1) Obsoletes: secure
188
189       ssh_options
190              SSH options to use
191
192       username
193              Login  name  This parameter is always required. Obsoletes: login
194
195
196       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
197              file or logging to syslog.
198
199       verbose
200              Verbose  mode.  Multiple  -v flags can be stacked on the command
201              line (e.g., -vvv) to increase verbosity.
202
203       verbose_level
204              Level of debugging detail in output. Defaults to the  number  of
205              --verbose  flags  specified on the command line, or to 1 if ver‐
206              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
207
208
209       debug_file
210              Write debug information to given file Obsoletes: debug
211
212       version
213              Display version information and exit
214
215       help   Display help and exit
216
217       plug_separator
218              Separator  for  plug  parameter when specifying more than 1 plug
219              (Default Value: ,)
220
221       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
222
223
224       disable_timeout
225              Disable  timeout (true/false) (default: true when run from Pace‐
226              maker 2.0+)
227
228       login_timeout
229              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
230
231
232       port_as_ip
233              Make "port/plug" to be an alias to IP address
234
235       power_timeout
236              Test  X  seconds  for status change after ON/OFF (Default Value:
237              20)
238
239       power_wait
240              Wait X seconds after issuing ON/OFF (Default Value: 0)
241
242       shell_timeout
243              Wait X seconds for cmd prompt  after  issuing  command  (Default
244              Value: 3)
245
246       stonith_status_sleep
247              Sleep  X  seconds  between  status calls during a STONITH action
248              (Default Value: 1)
249
250       retry_on
251              Count of attempts to retry power on (Default Value: 1)
252
253       ssh_path
254              Path to ssh binary (Default Value: /usr/bin/ssh)
255
256
257
258fence_alom (Fence Agent)          2009-10-20                    FENCE_AGENT(8)