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
81
82       -D, --debug-file=[debugfile]
83              Write debug information to given file
84
85       -V, --version
86              Display version information and exit
87
88       -h, --help
89              Display help and exit
90
91       -C, --separator=[char]
92              Separator for CSV created by 'list' operation (Default Value: ,)
93
94
95       --delay=[seconds]
96              Wait X seconds before fencing  is  started  (Default  Value:  0)
97
98
99       --login-timeout=[seconds]
100              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
101
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       list   List available plugs with aliases/virtual machines if  there  is
133              support for more then one device. Returns N/A otherwise.
134
135       list-status
136              List  available  plugs  with  aliases/virtual machines and their
137              power state if it can be obtained without  additional  commands.
138
139
140       monitor
141              Check the health of fence device
142
143       metadata
144              Display the XML metadata describing this resource.
145
146       manpage
147               The operational behavior of this is not known.
148
149       validate-all
150              Validate if all required parameters are entered.
151
152

STDIN PARAMETERS

154
155
156       action Fencing action (Default Value: reboot)
157
158       command_prompt
159              Force  Python  regex for command prompt (Default Value: ['\ $'])
160              Obsoletes: cmd_prompt
161
162       identity_file
163              Identity file (private key) for SSH
164
165       inet4_only
166              Forces agent to use IPv4 addresses only
167
168       inet6_only
169              Forces agent to use IPv6 addresses only
170
171       ip     IP address or hostname  of  fencing  device  This  parameter  is
172              always required. Obsoletes: ipaddr
173
174       ipport TCP/UDP  port  to use for connection with device (Default Value:
175              22)
176
177       password
178              Login password or passphrase Obsoletes: passwd
179
180       password_script
181              Script to run  to  retrieve  password  Obsoletes:  passwd_script
182
183
184       plug   Physical  plug  number  on  device,  UUID  or  identification of
185              machine This parameter is always required. Obsoletes: port
186
187
188       ssh    Use SSH connection (Default Value: 1) Obsoletes: secure
189
190       ssh_options
191              SSH options to use
192
193       username
194              Login  name  This parameter is always required. Obsoletes: login
195
196
197       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
198              file or logging to syslog.
199
200       verbose
201              Verbose mode
202
203       debug_file
204              Write debug information to given file Obsoletes: debug
205
206       version
207              Display version information and exit
208
209       help   Display help and exit
210
211       separator
212              Separator for CSV created by 'list' operation (Default Value: ,)
213
214
215       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
216
217
218       login_timeout
219              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
220
221
222       power_timeout
223              Test X seconds for status change after  ON/OFF  (Default  Value:
224              20)
225
226       power_wait
227              Wait X seconds after issuing ON/OFF (Default Value: 0)
228
229       shell_timeout
230              Wait  X  seconds  for  cmd prompt after issuing command (Default
231              Value: 3)
232
233       retry_on
234              Count of attempts to retry power on (Default Value: 1)
235
236       ssh_path
237              Path to ssh binary (Default Value: /usr/bin/ssh)
238
239
240
241fence_ldom (Fence Agent)          2009-10-20                    FENCE_AGENT(8)