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

NAME

7       fence_drac5 - Fence agent for Dell DRAC CMC/5
8

DESCRIPTION

10       fence_drac5 is an I/O Fencing agent which can be used with the Dell Re‐
11       mote Access Card v5 or CMC (DRAC). This device provides  remote  access
12       to  controlling   power  to a server. It logs into the DRAC through the
13       telnet/ssh interface of the card. By default, the telnet  interface  is
14       not  enabled.
15
16       fence_drac5  accepts options on the command line as well as from stdin.
17       Fenced  sends  parameters  through  stdin  when  it  execs  the  agent.
18       fence_drac5  can  be  run by itself with command line options.  This is
19       useful for testing and for turning outlets on or off from scripts.
20
21       Vendor URL: http://www.dell.com
22

PARAMETERS

24
25
26       -o, --action=[action]
27              Fencing action (Default Value: reboot)
28
29       -c, --command-prompt=[prompt]
30              Force Python regex for command  prompt  (Default  Value:  ['\$',
31              'DRAC\/MC:'])
32
33       -d, --drac-version=[version]
34              Force DRAC version to use (DRAC CMC|DRAC MC|DRAC 5)
35
36       -k, --identity-file=[filename]
37              Identity file (private key) for SSH
38
39       -4, --inet4-only
40              Forces agent to use IPv4 addresses only
41
42       -6, --inet6-only
43              Forces agent to use IPv6 addresses only
44
45       -a, --ip=[ip]
46              IP  address  or hostname of fencing device This parameter is al‐
47              ways required.
48
49       -u, --ipport=[port]
50              TCP/UDP port to use for connection with device  (Default  Value:
51              23)
52
53       -p, --password=[password]
54              Login password or passphrase
55
56       -S, --password-script=[script]
57              Script to run to retrieve password
58
59       -n, --plug=[id]
60              Physical  plug  number  on device, UUID or identification of ma‐
61              chine This parameter is always required.
62
63       -x, --ssh
64              Use SSH connection
65
66       --ssh-options=[options]
67              SSH options to use
68
69       -l, --username=[name]
70              Login name This parameter is always required.
71
72       -q, --quiet
73              Disable logging to stderr. Does not affect --verbose or --debug-
74              file or logging to syslog.
75
76       -v, --verbose
77              Verbose  mode.  Multiple  -v flags can be stacked on the command
78              line (e.g., -vvv) to increase verbosity.
79
80       --verbose-level
81              Level of debugging detail in output. Defaults to the  number  of
82              --verbose  flags  specified on the command line, or to 1 if ver‐
83              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
84
85
86       -D, --debug-file=[debugfile]
87              Write debug information to given file
88
89       -V, --version
90              Display version information and exit
91
92       -h, --help
93              Display help and exit
94
95       --plug-separator=[char]
96              Separator  for  plug  parameter when specifying more than 1 plug
97              (Default Value: ,)
98
99       -C, --separator=[char]
100              Separator for CSV created by 'list' operation (Default Value: ,)
101
102
103       --delay=[seconds]
104              Wait  X  seconds  before  fencing  is started (Default Value: 0)
105
106
107       --disable-timeout=[true/false]
108              Disable timeout (true/false) (default: true when run from  Pace‐
109              maker 2.0+)
110
111       --login-timeout=[seconds]
112              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
113
114
115       --power-timeout=[seconds]
116              Test X seconds for status change after  ON/OFF  (Default  Value:
117              20)
118
119       --power-wait=[seconds]
120              Wait X seconds after issuing ON/OFF (Default Value: 0)
121
122       --shell-timeout=[seconds]
123              Wait  X  seconds  for  cmd prompt after issuing command (Default
124              Value: 3)
125
126       --stonith-status-sleep=[seconds]
127              Sleep X seconds between status calls  during  a  STONITH  action
128              (Default Value: 1)
129
130       --retry-on=[attempts]
131              Count of attempts to retry power on (Default Value: 1)
132
133       --ssh-path=[path]
134              Path to ssh binary (Default Value: /usr/bin/ssh)
135
136       --telnet-path=[path]
137              Path to telnet binary (Default Value: /usr/bin/telnet)
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              'DRAC\/MC:']) Obsoletes: cmd_prompt
180
181       drac_version
182              Force DRAC version to use (DRAC CMC|DRAC MC|DRAC 5)
183
184       identity_file
185              Identity file (private key) for SSH
186
187       inet4_only
188              Forces agent to use IPv4 addresses only
189
190       inet6_only
191              Forces agent to use IPv6 addresses only
192
193       ip     IP  address  or hostname of fencing device This parameter is al‐
194              ways required. Obsoletes: ipaddr
195
196       ipport TCP/UDP port to use for connection with device  (Default  Value:
197              23)
198
199       password
200              Login password or passphrase Obsoletes: passwd
201
202       password_script
203              Script  to  run  to  retrieve  password Obsoletes: passwd_script
204
205
206       plug   Physical plug number on device, UUID or  identification  of  ma‐
207              chine  This  parameter is always required. Obsoletes: port
208
209
210       ssh    Use SSH connection Obsoletes: secure
211
212       ssh_options
213              SSH options to use
214
215       username
216              Login name This parameter is always required.  Obsoletes:  login
217
218
219       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
220              file or logging to syslog.
221
222       verbose
223              Verbose mode. Multiple -v flags can be stacked  on  the  command
224              line (e.g., -vvv) to increase verbosity.
225
226       verbose_level
227              Level  of  debugging detail in output. Defaults to the number of
228              --verbose flags specified on the command line, or to 1  if  ver‐
229              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
230
231
232       debug_file
233              Write debug information to given file Obsoletes: debug
234
235       version
236              Display version information and exit
237
238       help   Display help and exit
239
240       plug_separator
241              Separator for plug parameter when specifying more  than  1  plug
242              (Default Value: ,)
243
244       separator
245              Separator for CSV created by 'list' operation (Default Value: ,)
246
247
248       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
249
250
251       disable_timeout
252              Disable  timeout (true/false) (default: true when run from Pace‐
253              maker 2.0+)
254
255       login_timeout
256              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
257
258
259       power_timeout
260              Test  X  seconds  for status change after ON/OFF (Default Value:
261              20)
262
263       power_wait
264              Wait X seconds after issuing ON/OFF (Default Value: 0)
265
266       shell_timeout
267              Wait X seconds for cmd prompt  after  issuing  command  (Default
268              Value: 3)
269
270       stonith_status_sleep
271              Sleep  X  seconds  between  status calls during a STONITH action
272              (Default Value: 1)
273
274       retry_on
275              Count of attempts to retry power on (Default Value: 1)
276
277       ssh_path
278              Path to ssh binary (Default Value: /usr/bin/ssh)
279
280       telnet_path
281              Path to telnet binary (Default Value: /usr/bin/telnet)
282
283
284
285fence_drac5 (Fence Agent)         2009-10-20                    FENCE_AGENT(8)