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

NAME

7       fence_ldom - Fence agent for Sun LDOM
8

DESCRIPTION

10       fence_ldom is an I/O Fencing agent which can be used with LDoms virtual
11       machines. This agent works so, that run ldm command on host machine. So
12       ldm must be directly runnable.
13
14       Very useful parameter is -c (or cmd_prompt in stdin mode). This must be
15       set to something, what is displayed after successful login to host  ma‐
16       chine.  Default  string  is space on end of string (default for root in
17       bash). But (for example) csh use ], so in that case you must use param‐
18       eter -c with argument ]. Very similar situation is, if you use bash and
19       login to host machine with other user than root. Than prompt is  $,  so
20       again, you must use parameter -c.
21
22       fence_ldom  accepts  options on the command line as well as from stdin.
23       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
24       fence_ldom  can  be  run  by itself with command line options.  This is
25       useful for testing and for turning outlets on or off from scripts.
26
27       Vendor URL: http://www.sun.com
28

PARAMETERS

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

ACTIONS

141
142
143       on     Power on machine.
144
145       off    Power off machine.
146
147       reboot Reboot machine.
148
149       status This returns the status of the plug/virtual machine.
150
151       list   List  available  plugs with aliases/virtual machines if there is
152              support for more then one device. Returns N/A otherwise.
153
154       list-status
155              List available plugs with  aliases/virtual  machines  and  their
156              power  state  if it can be obtained without additional commands.
157
158
159       monitor
160              Check the health of fence device
161
162       metadata
163              Display the XML metadata describing this resource.
164
165       manpage
166               The operational behavior of this is not known.
167
168       validate-all
169              Validate if all required parameters are entered.
170
171

STDIN PARAMETERS

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