fence_drac5(8)

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       -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       --stonith-status-sleep=[seconds]
123              Sleep  X  seconds  between  status calls during a STONITH action
124              (Default Value: 1)
125
126       --retry-on=[attempts]
127              Count of attempts to retry power on (Default Value: 1)
128
129       --ssh-path=[path]
130              Path to ssh binary (Default Value: /usr/bin/ssh)
131
132       --telnet-path=[path]
133              Path to telnet binary (Default Value: /usr/bin/telnet)
134
135

ACTIONS

137
138
139       on     Power on machine.
140
141       off    Power off machine.
142
143       reboot Reboot machine.
144
145       status This returns the status of the plug/virtual machine.
146
147       list   List available plugs with aliases/virtual machines if  there  is
148              support for more then one device. Returns N/A otherwise.
149
150       list-status
151              List  available  plugs  with  aliases/virtual machines and their
152              power state if it can be obtained without  additional  commands.
153
154
155       monitor
156              Check the health of fence device
157
158       metadata
159              Display the XML metadata describing this resource.
160
161       manpage
162               The operational behavior of this is not known.
163
164       validate-all
165              Validate if all required parameters are entered.
166
167

STDIN PARAMETERS

169
170
171       action Fencing action (Default Value: reboot)
172
173       command_prompt
174              Force  Python  regex  for  command prompt (Default Value: ['\$',
175              'DRAC\/MC:']) Obsoletes: cmd_prompt
176
177       drac_version
178              Force DRAC version to use (DRAC CMC|DRAC MC|DRAC 5)
179
180       identity_file
181              Identity file (private key) for SSH
182
183       inet4_only
184              Forces agent to use IPv4 addresses only
185
186       inet6_only
187              Forces agent to use IPv6 addresses only
188
189       ip     IP address or hostname of fencing device This parameter  is  al‐
190              ways required. Obsoletes: ipaddr
191
192       ipport TCP/UDP  port  to use for connection with device (Default Value:
193              23)
194
195       password
196              Login password or passphrase Obsoletes: passwd
197
198       password_script
199              Script to run  to  retrieve  password  Obsoletes:  passwd_script
200
201
202       plug   Physical  plug  number  on device, UUID or identification of ma‐
203              chine This parameter is always required. Obsoletes:  port
204
205
206       ssh    Use SSH connection Obsoletes: secure
207
208       ssh_options
209              SSH options to use
210
211       username
212              Login  name  This parameter is always required. Obsoletes: login
213
214
215       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
216              file or logging to syslog.
217
218       verbose
219              Verbose  mode.  Multiple  -v flags can be stacked on the command
220              line (e.g., -vvv) to increase verbosity.
221
222       verbose_level
223              Level of debugging detail in output. Defaults to the  number  of
224              --verbose  flags  specified on the command line, or to 1 if ver‐
225              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
226
227
228       debug_file
229              Write debug information to given file Obsoletes: debug
230
231       version
232              Display version information and exit
233
234       help   Display help and exit
235
236       separator
237              Separator for CSV created by 'list' operation (Default Value: ,)
238
239
240       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
241
242
243       disable_timeout
244              Disable  timeout (true/false) (default: true when run from Pace‐
245              maker 2.0+)
246
247       login_timeout
248              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
249
250
251       power_timeout
252              Test  X  seconds  for status change after ON/OFF (Default Value:
253              20)
254
255       power_wait
256              Wait X seconds after issuing ON/OFF (Default Value: 0)
257
258       shell_timeout
259              Wait X seconds for cmd prompt  after  issuing  command  (Default
260              Value: 3)
261
262       stonith_status_sleep
263              Sleep  X  seconds  between  status calls during a STONITH action
264              (Default Value: 1)
265
266       retry_on
267              Count of attempts to retry power on (Default Value: 1)
268
269       ssh_path
270              Path to ssh binary (Default Value: /usr/bin/ssh)
271
272       telnet_path
273              Path to telnet binary (Default Value: /usr/bin/telnet)
274
275
276
277fence_drac5 (Fence Agent)         2009-10-20                    FENCE_AGENT(8)