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
71
72       -D, --debug-file=[debugfile]
73              Write debug information to given file
74
75       -V, --version
76              Display version information and exit
77
78       -h, --help
79              Display help and exit
80
81       --delay=[seconds]
82              Wait  X  seconds  before  fencing  is started (Default Value: 0)
83
84
85       --login-timeout=[seconds]
86              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
87
88
89       --port-as-ip
90              Make "port/plug" to be an alias to IP address
91
92       --power-timeout=[seconds]
93              Test  X  seconds  for status change after ON/OFF (Default Value:
94              20)
95
96       --power-wait=[seconds]
97              Wait X seconds after issuing ON/OFF (Default Value: 0)
98
99       --shell-timeout=[seconds]
100              Wait X seconds for cmd prompt  after  issuing  command  (Default
101              Value: 3)
102
103       --retry-on=[attempts]
104              Count of attempts to retry power on (Default Value: 1)
105
106       --ssh-path=[path]
107              Path to ssh binary (Default Value: /usr/bin/ssh)
108
109

ACTIONS

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

STDIN PARAMETERS

135
136
137       action Fencing action (Default Value: reboot)
138
139       command_prompt
140              Force  Python  regex  for command prompt (Default Value: ['sc\>\
141              ']) Obsoletes: cmd_prompt
142
143       identity_file
144              Identity file (private key) for SSH
145
146       inet4_only
147              Forces agent to use IPv4 addresses only
148
149       inet6_only
150              Forces agent to use IPv6 addresses only
151
152       ip     IP address or hostname of fencing device Obsoletes: ipaddr
153
154
155       ipport TCP/UDP  port  to use for connection with device (Default Value:
156              22)
157
158       password
159              Login password or passphrase Obsoletes: passwd
160
161       password_script
162              Script to run  to  retrieve  password  Obsoletes:  passwd_script
163
164
165       plug   IP  address or hostname of fencing device (together with --port-
166              as-ip) Obsoletes: port
167
168       ssh    Use SSH connection (Default Value: 1) Obsoletes: secure
169
170       ssh_options
171              SSH options to use
172
173       username
174              Login name This parameter is always required.  Obsoletes:  login
175
176
177       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
178              file or logging to syslog.
179
180       verbose
181              Verbose mode
182
183       debug_file
184              Write debug information to given file Obsoletes: debug
185
186       version
187              Display version information and exit
188
189       help   Display help and exit
190
191       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
192
193
194       login_timeout
195              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
196
197
198       port_as_ip
199              Make "port/plug" to be an alias to IP address
200
201       power_timeout
202              Test X seconds for status change after  ON/OFF  (Default  Value:
203              20)
204
205       power_wait
206              Wait X seconds after issuing ON/OFF (Default Value: 0)
207
208       shell_timeout
209              Wait  X  seconds  for  cmd prompt after issuing command (Default
210              Value: 3)
211
212       retry_on
213              Count of attempts to retry power on (Default Value: 1)
214
215       ssh_path
216              Path to ssh binary (Default Value: /usr/bin/ssh)
217
218
219
220fence_alom (Fence Agent)          2009-10-20                    FENCE_AGENT(8)