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       -C, --separator=[char]
99              Separator for CSV created by 'list' operation (Default Value: ,)
100
101
102       --delay=[seconds]
103              Wait X seconds before fencing  is  started  (Default  Value:  0)
104
105
106       --disable-timeout=[true/false]
107              Disable  timeout (true/false) (default: true when run from Pace‐
108              maker 2.0+)
109
110       --login-timeout=[seconds]
111              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
112
113
114       --power-timeout=[seconds]
115              Test  X  seconds  for status change after ON/OFF (Default Value:
116              20)
117
118       --power-wait=[seconds]
119              Wait X seconds after issuing ON/OFF (Default Value: 0)
120
121       --shell-timeout=[seconds]
122              Wait X seconds for cmd prompt  after  issuing  command  (Default
123              Value: 3)
124
125       --stonith-status-sleep=[seconds]
126              Sleep  X  seconds  between  status calls during a STONITH action
127              (Default Value: 1)
128
129       --retry-on=[attempts]
130              Count of attempts to retry power on (Default Value: 1)
131
132       --ssh-path=[path]
133              Path to ssh binary (Default Value: /usr/bin/ssh)
134
135

ACTIONS

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

STDIN PARAMETERS

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