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
11       Remote 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
47              always 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
61              machine 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       -C, --separator=[char]
96              Separator for CSV created by 'list' operation (Default Value: ,)
97
98
99       --delay=[seconds]
100              Wait X seconds before fencing  is  started  (Default  Value:  0)
101
102
103       --disable-timeout=[true/false]
104              Disable  timeout (true/false) (default: true when run from Pace‐
105              maker 2.0+)
106
107       --login-timeout=[seconds]
108              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
109
110
111       --power-timeout=[seconds]
112              Test  X  seconds  for status change after ON/OFF (Default Value:
113              20)
114
115       --power-wait=[seconds]
116              Wait X seconds after issuing ON/OFF (Default Value: 0)
117
118       --shell-timeout=[seconds]
119              Wait X seconds for cmd prompt  after  issuing  command  (Default
120              Value: 3)
121
122       --retry-on=[attempts]
123              Count of attempts to retry power on (Default Value: 1)
124
125       --ssh-path=[path]
126              Path to ssh binary (Default Value: /usr/bin/ssh)
127
128       --telnet-path=[path]
129              Path to telnet binary (Default Value: /usr/bin/telnet)
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              'DRAC\/MC:']) Obsoletes: cmd_prompt
172
173       drac_version
174              Force DRAC version to use (DRAC CMC|DRAC MC|DRAC 5)
175
176       identity_file
177              Identity file (private key) for SSH
178
179       inet4_only
180              Forces agent to use IPv4 addresses only
181
182       inet6_only
183              Forces agent to use IPv6 addresses only
184
185       ip     IP  address  or  hostname  of  fencing  device This parameter is
186              always required. Obsoletes: ipaddr
187
188       ipport TCP/UDP port to use for connection with device  (Default  Value:
189              23)
190
191       password
192              Login password or passphrase Obsoletes: passwd
193
194       password_script
195              Script  to  run  to  retrieve  password Obsoletes: passwd_script
196
197
198       plug   Physical plug  number  on  device,  UUID  or  identification  of
199              machine This parameter is always required. Obsoletes: port
200
201
202       ssh    Use SSH connection Obsoletes: secure
203
204       ssh_options
205              SSH options to use
206
207       username
208              Login name This parameter is always required.  Obsoletes:  login
209
210
211       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
212              file or logging to syslog.
213
214       verbose
215              Verbose mode. Multiple -v flags can be stacked  on  the  command
216              line (e.g., -vvv) to increase verbosity.
217
218       verbose_level
219              Level  of  debugging detail in output. Defaults to the number of
220              --verbose flags specified on the command line, or to 1  if  ver‐
221              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
222
223
224       debug_file
225              Write debug information to given file Obsoletes: debug
226
227       version
228              Display version information and exit
229
230       help   Display help and exit
231
232       separator
233              Separator for CSV created by 'list' operation (Default Value: ,)
234
235
236       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
237
238
239       disable_timeout
240              Disable timeout (true/false) (default: true when run from  Pace‐
241              maker 2.0+)
242
243       login_timeout
244              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
245
246
247       power_timeout
248              Test X seconds for status change after  ON/OFF  (Default  Value:
249              20)
250
251       power_wait
252              Wait X seconds after issuing ON/OFF (Default Value: 0)
253
254       shell_timeout
255              Wait  X  seconds  for  cmd prompt after issuing command (Default
256              Value: 3)
257
258       retry_on
259              Count of attempts to retry power on (Default Value: 1)
260
261       ssh_path
262              Path to ssh binary (Default Value: /usr/bin/ssh)
263
264       telnet_path
265              Path to telnet binary (Default Value: /usr/bin/telnet)
266
267
268
269fence_drac5 (Fence Agent)         2009-10-20                    FENCE_AGENT(8)