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       --delay=[seconds]
89              Wait  X  seconds  before  fencing  is started (Default Value: 0)
90
91
92       --disable-timeout=[true/false]
93              Disable timeout (true/false) (default: true when run from  Pace‐
94              maker 2.0+)
95
96       --login-timeout=[seconds]
97              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
98
99
100       --port-as-ip
101              Make "port/plug" to be an alias to IP address
102
103       --power-timeout=[seconds]
104              Test X seconds for status change after  ON/OFF  (Default  Value:
105              20)
106
107       --power-wait=[seconds]
108              Wait X seconds after issuing ON/OFF (Default Value: 0)
109
110       --shell-timeout=[seconds]
111              Wait  X  seconds  for  cmd prompt after issuing command (Default
112              Value: 3)
113
114       --stonith-status-sleep=[seconds]
115              Sleep X seconds between status calls  during  a  STONITH  action
116              (Default Value: 1)
117
118       --retry-on=[attempts]
119              Count of attempts to retry power on (Default Value: 1)
120
121       --ssh-path=[path]
122              Path to ssh binary (Default Value: /usr/bin/ssh)
123
124

ACTIONS

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

STDIN PARAMETERS

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