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       --retry-on=[attempts]
115              Count of attempts to retry power on (Default Value: 1)
116
117       --ssh-path=[path]
118              Path to ssh binary (Default Value: /usr/bin/ssh)
119
120

ACTIONS

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

STDIN PARAMETERS

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