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 5, DRAC CMC, DRAC MC)
35
36       -k, --identity-file=[filename]
37              Identity file 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 This parameter is always required.
47
48       -u, --ipport=[port]
49              TCP/UDP  port  to use for connection with device (Default Value:
50              23)
51
52       -l, --username=[name]
53              Login Name This parameter is always required.
54
55       -m, --module-name=<module>
56              DRAC/MC module name
57
58       -p, --password=[password]
59              Login password or passphrase
60
61       -S, --password-script=[script]
62              Script to retrieve password
63
64       -n, --plug=[id]
65              Physical plug number, name  of  virtual  machine  or  UUID  This
66              parameter is always required.
67
68       -x, --ssh
69              SSH connection
70
71       --ssh-options=[options]
72              SSH options to use
73
74       -v, --verbose
75              Verbose mode
76
77       -D, --debug-file=[debugfile]
78              Write debug information to given file
79
80       -V, --version
81              Display version information and exit
82
83       -h, --help
84              Display help and exit
85
86       -C, --separator=[char]
87              Separator  for  CSV created by operation list (Default Value: ,)
88
89
90       --delay=[seconds]
91              Wait X seconds before fencing  is  started  (Default  Value:  0)
92
93
94       --login-timeout=[seconds]
95              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
96
97
98       --power-timeout=[seconds]
99              Test X seconds for status change after  ON/OFF  (Default  Value:
100              20)
101
102       --power-wait=[seconds]
103              Wait X seconds after issuing ON/OFF (Default Value: 0)
104
105       --shell-timeout=[seconds]
106              Wait  X  seconds  for  cmd prompt after issuing command (Default
107              Value: 3)
108
109       --retry-on=[attempts]
110              Count of attempts to retry power on (Default Value: 1)
111
112       --ssh-path=[path]
113              Path to ssh binary (Default Value: /usr/bin/ssh)
114
115       --telnet-path=[path]
116              Path to telnet binary (Default Value: /usr/bin/telnet)
117
118

ACTIONS

120
121
122       on     Power on machine.
123
124       off    Power off machine.
125
126       reboot Reboot machine.
127
128       status This returns the status of the plug/virtual machine.
129
130       list   List available plugs with aliases/virtual machines if  there  is
131              support for more then one device. Returns N/A otherwise.
132
133       list-status
134              List  available  plugs  with  aliases/virtual machines and their
135              power state if it can be obtained without  additional  commands.
136
137
138       monitor
139              Check the health of fence device
140
141       metadata
142              Display the XML metadata describing this resource.
143
144

STDIN PARAMETERS

146
147
148       action Fencing Action (Default Value: reboot)
149
150       cmd_prompt
151              Force  Python  regex  for  command prompt (Default Value: ['\$',
152              'DRAC\/MC:'])
153
154       drac_version
155              Force DRAC version to use (DRAC 5, DRAC CMC, DRAC MC)
156
157       identity_file
158              Identity file for ssh
159
160       inet4_only
161              Forces agent to use IPv4 addresses only
162
163       inet6_only
164              Forces agent to use IPv6 addresses only
165
166       ipaddr IP Address or Hostname This parameter is always required.
167
168       ipport TCP/UDP port to use for connection with device  (Default  Value:
169              23)
170
171       login  Login Name This parameter is always required.
172
173       module_name
174              DRAC/MC module name
175
176       passwd Login password or passphrase
177
178       passwd_script
179              Script to retrieve password
180
181       port   Physical  plug  number,  name  of  virtual  machine or UUID This
182              parameter is always required.
183
184       secure SSH connection
185
186       ssh_options
187              SSH options to use
188
189       verbose
190              Verbose mode
191
192       debug  Write debug information to given file
193
194       version
195              Display version information and exit
196
197       help   Display help and exit
198
199       separator
200              Separator for CSV created by operation list (Default  Value:  ,)
201
202
203       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
204
205
206       login_timeout
207              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
208
209
210       power_timeout
211              Test  X  seconds  for status change after ON/OFF (Default Value:
212              20)
213
214       power_wait
215              Wait X seconds after issuing ON/OFF (Default Value: 0)
216
217       shell_timeout
218              Wait X seconds for cmd prompt  after  issuing  command  (Default
219              Value: 3)
220
221       retry_on
222              Count of attempts to retry power on (Default Value: 1)
223
224       ssh_path
225              Path to ssh binary (Default Value: /usr/bin/ssh)
226
227       telnet_path
228              Path to telnet binary (Default Value: /usr/bin/telnet)
229
230
231
232fence_drac5 (Fence Agent)         2009-10-20                    FENCE_AGENT(8)