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       -a, --ip=<ip>
36              IP Address or Hostname This parameter is always required.
37
38       -l, --username=<name>
39              Login Name This parameter is always required.
40
41       -p, --password=<password>
42              Login password or passphrase
43
44       -S, --password-script=<script>
45              Script to retrieve password
46
47       -x, --ssh
48              SSH connection (Default Value: true)
49
50       -k, --identity-file=<filename>
51              Identity file for ssh
52
53       -n, --plug=<id>
54              Physical plug number or name of virtual machine  This  parameter
55              is always required.
56
57       -c, --command-prompt=<prompt>
58              Force command prompt (Default Value:  $)
59
60       -4, --inet4-only
61              Forces agent to use IPv4 addresses only
62
63       -6, --inet6-only
64              Forces agent to use IPv6 addresses only
65
66       -u, --ipport=<port>
67              TCP port to use for connection with device
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       -C, --separator=<char>
82              Separator  for  CSV created by operation list (Default Value: ,)
83
84
85       --power-timeout
86              Test X seconds for status change after  ON/OFF  (Default  Value:
87              20)
88
89       --shell-timeout
90              Wait  X  seconds  for  cmd prompt after issuing command (Default
91              Value: 3)
92
93       --login-timeout
94              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
95
96
97       --power-wait
98              Wait X seconds after issuing ON/OFF (Default Value: 0)
99
100       --delay
101              Wait  X  seconds  before  fencing  is started (Default Value: 0)
102
103
104       --retry-on
105              Count of attempts to retry power on (Default Value: 1)
106
107

ACTIONS

109
110
111       on     Power on machine.
112
113       off    Power off machine.
114
115       reboot Reboot machine.
116
117       status This returns the status of the plug/virtual machine.
118
119       list   List available plugs with aliases/virtual machines if  there  is
120              support for more then one device. Returns N/A otherwise.
121
122       monitor
123              Check if fencing device is running. List available plugs/virtual
124              machines or get status of machine (if it does not support more).
125
126
127       metadata
128               The operational behavior of this is not known.
129
130

STDIN PARAMETERS

132
133
134       action Fencing Action (Default Value: reboot)
135
136       ipaddr IP Address or Hostname This parameter is always required.
137
138       login  Login Name This parameter is always required.
139
140       passwd Login password or passphrase
141
142       passwd_script
143              Script to retrieve password
144
145       secure SSH connection (Default Value: true)
146
147       identity_file
148              Identity file for ssh
149
150       port   Physical  plug  number or name of virtual machine This parameter
151              is always required.
152
153       cmd_prompt
154              Force command prompt (Default Value:  $)
155
156       inet4_only
157              Forces agent to use IPv4 addresses only
158
159       inet6_only
160              Forces agent to use IPv6 addresses only
161
162       ipport TCP port to use for connection with device
163
164       verbose
165              Verbose mode
166
167       debug  Write debug information to given file
168
169       version
170              Display version information and exit
171
172       help   Display help and exit
173
174       separator
175              Separator for CSV created by operation list (Default  Value:  ,)
176
177
178       power_timeout
179              Test  X  seconds  for status change after ON/OFF (Default Value:
180              20)
181
182       shell_timeout
183              Wait X seconds for cmd prompt  after  issuing  command  (Default
184              Value: 3)
185
186       login_timeout
187              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
188
189
190       power_wait
191              Wait X seconds after issuing ON/OFF (Default Value: 0)
192
193       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
194
195
196       retry_on
197              Count of attempts to retry power on (Default Value: 1)
198
199
200
201fence_ldom (Fence Agent)          2009-10-20                    FENCE_AGENT(8)