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
16       machine.  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
50              always 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
64              machine 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       --retry-on=[attempts]
126              Count of attempts to retry power on (Default Value: 1)
127
128       --ssh-path=[path]
129              Path to ssh binary (Default Value: /usr/bin/ssh)
130
131

ACTIONS

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

STDIN PARAMETERS

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