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
78
79       -D, --debug-file=[debugfile]
80              Write debug information to given file
81
82       -V, --version
83              Display version information and exit
84
85       -h, --help
86              Display help and exit
87
88       -C, --separator=[char]
89              Separator for CSV created by 'list' operation (Default Value: ,)
90
91
92       --delay=[seconds]
93              Wait X seconds before fencing  is  started  (Default  Value:  0)
94
95
96       --login-timeout=[seconds]
97              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
98
99
100       --power-timeout=[seconds]
101              Test X seconds for status change after  ON/OFF  (Default  Value:
102              20)
103
104       --power-wait=[seconds]
105              Wait X seconds after issuing ON/OFF (Default Value: 0)
106
107       --shell-timeout=[seconds]
108              Wait  X  seconds  for  cmd prompt after issuing command (Default
109              Value: 3)
110
111       --retry-on=[attempts]
112              Count of attempts to retry power on (Default Value: 1)
113
114       --ssh-path=[path]
115              Path to ssh binary (Default Value: /usr/bin/ssh)
116
117       --telnet-path=[path]
118              Path to telnet binary (Default Value: /usr/bin/telnet)
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              'DRAC\/MC:']) Obsoletes: cmd_prompt
161
162       drac_version
163              Force DRAC version to use (DRAC CMC|DRAC MC|DRAC 5)
164
165       identity_file
166              Identity file (private key) for SSH
167
168       inet4_only
169              Forces agent to use IPv4 addresses only
170
171       inet6_only
172              Forces agent to use IPv6 addresses only
173
174       ip     IP address or hostname  of  fencing  device  This  parameter  is
175              always required. Obsoletes: ipaddr
176
177       ipport TCP/UDP  port  to use for connection with device (Default Value:
178              23)
179
180       password
181              Login password or passphrase Obsoletes: passwd
182
183       password_script
184              Script to run  to  retrieve  password  Obsoletes:  passwd_script
185
186
187       plug   Physical  plug  number  on  device,  UUID  or  identification of
188              machine This parameter is always required. Obsoletes: port
189
190
191       ssh    Use SSH connection Obsoletes: secure
192
193       ssh_options
194              SSH options to use
195
196       username
197              Login  name  This parameter is always required. Obsoletes: login
198
199
200       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
201              file or logging to syslog.
202
203       verbose
204              Verbose mode
205
206       debug_file
207              Write debug information to given file Obsoletes: debug
208
209       version
210              Display version information and exit
211
212       help   Display help and exit
213
214       separator
215              Separator for CSV created by 'list' operation (Default Value: ,)
216
217
218       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
219
220
221       login_timeout
222              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
223
224
225       power_timeout
226              Test X seconds for status change after  ON/OFF  (Default  Value:
227              20)
228
229       power_wait
230              Wait X seconds after issuing ON/OFF (Default Value: 0)
231
232       shell_timeout
233              Wait  X  seconds  for  cmd prompt after issuing command (Default
234              Value: 3)
235
236       retry_on
237              Count of attempts to retry power on (Default Value: 1)
238
239       ssh_path
240              Path to ssh binary (Default Value: /usr/bin/ssh)
241
242       telnet_path
243              Path to telnet binary (Default Value: /usr/bin/telnet)
244
245
246
247fence_drac5 (Fence Agent)         2009-10-20                    FENCE_AGENT(8)