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

NAME

7       fence_cisco_mds - Fence agent for Cisco MDS
8

DESCRIPTION

10       fence_cisco_mds  is  an  I/O  Fencing  agent which can be used with any
11       Cisco MDS 9000 series with SNMP enabled device.
12
13       fence_cisco_mds accepts options on the command line  as  well  as  from
14       stdin.  Fenced  sends parameters through stdin when it execs the agent.
15       fence_cisco_mds can be run by itself with command line  options.   This
16       is useful for testing and for turning outlets on or off from scripts.
17
18       Vendor URL: http://www.cisco.com
19

PARAMETERS

21
22
23       -o, --action=[action]
24              Fencing action (Default Value: off)
25
26       -c, --community=[community]
27              Set the community string
28
29       -a, --ip=[ip]
30              IP  address  or hostname of fencing device This parameter is al‐
31              ways required.
32
33       -u, --ipport=[port]
34              TCP/UDP port to use for connection with device  (Default  Value:
35              161)
36
37       -p, --password=[password]
38              Login password or passphrase
39
40       -S, --password-script=[script]
41              Script to run to retrieve password
42
43       -n, --plug=[id]
44              Physical  plug  number  on device, UUID or identification of ma‐
45              chine This parameter is always required.
46
47       -b, --snmp-auth-prot=[prot]
48              Set authentication protocol (MD5|SHA)
49
50       -P, --snmp-priv-passwd=[pass]
51              Set privacy protocol password
52
53       -R, --snmp-priv-passwd-script
54              Script to run to retrieve privacy password
55
56       -B, --snmp-priv-prot=[prot]
57              Set privacy protocol (DES|AES)
58
59       -E, --snmp-sec-level=[level]
60              Set security level (noAuthNoPriv|authNoPriv|authPriv)
61
62       -d, --snmp-version=[version]
63              Specifies SNMP version to use (1|2c|3)
64
65       -l, --username=[name]
66              Login name
67
68       -q, --quiet
69              Disable logging to stderr. Does not affect --verbose or --debug-
70              file or logging to syslog.
71
72       -v, --verbose
73              Verbose  mode.  Multiple  -v flags can be stacked on the command
74              line (e.g., -vvv) to increase verbosity.
75
76       --verbose-level
77              Level of debugging detail in output. Defaults to the  number  of
78              --verbose  flags  specified on the command line, or to 1 if ver‐
79              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
80
81
82       -D, --debug-file=[debugfile]
83              Write debug information to given file
84
85       -V, --version
86              Display version information and exit
87
88       -h, --help
89              Display help and exit
90
91       --plug-separator=[char]
92              Separator  for  plug  parameter when specifying more than 1 plug
93              (Default Value: ,)
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       --snmpget-path=[path]
130              Path to snmpget binary (Default Value: /usr/bin/snmpget)
131
132       --snmpset-path=[path]
133              Path to snmpset binary (Default Value: /usr/bin/snmpset)
134
135       --snmpwalk-path=[path]
136              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
137
138

ACTIONS

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

STDIN PARAMETERS

170
171
172       action Fencing action (Default Value: off)
173
174       community
175              Set the community string
176
177       ip     IP address or hostname of fencing device This parameter  is  al‐
178              ways required. Obsoletes: ipaddr
179
180       ipport TCP/UDP  port  to use for connection with device (Default Value:
181              161)
182
183       password
184              Login password or passphrase Obsoletes: passwd
185
186       password_script
187              Script to run  to  retrieve  password  Obsoletes:  passwd_script
188
189
190       plug   Physical  plug  number  on device, UUID or identification of ma‐
191              chine This parameter is always required. Obsoletes:  port
192
193
194       snmp_auth_prot
195              Set authentication protocol (MD5|SHA)
196
197       snmp_priv_passwd
198              Set privacy protocol password
199
200       snmp_priv_passwd_script
201              Script to run to retrieve privacy password
202
203       snmp_priv_prot
204              Set privacy protocol (DES|AES)
205
206       snmp_sec_level
207              Set security level (noAuthNoPriv|authNoPriv|authPriv)
208
209       snmp_version
210              Specifies SNMP version to use (1|2c|3)
211
212       username
213              Login name Obsoletes: login
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       plug_separator
237              Separator for plug parameter when specifying more  than  1  plug
238              (Default Value: ,)
239
240       separator
241              Separator for CSV created by 'list' operation (Default Value: ,)
242
243
244       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
245
246
247       disable_timeout
248              Disable  timeout (true/false) (default: true when run from Pace‐
249              maker 2.0+)
250
251       login_timeout
252              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
253
254
255       power_timeout
256              Test  X  seconds  for status change after ON/OFF (Default Value:
257              20)
258
259       power_wait
260              Wait X seconds after issuing ON/OFF (Default Value: 0)
261
262       shell_timeout
263              Wait X seconds for cmd prompt  after  issuing  command  (Default
264              Value: 3)
265
266       stonith_status_sleep
267              Sleep  X  seconds  between  status calls during a STONITH action
268              (Default Value: 1)
269
270       retry_on
271              Count of attempts to retry power on (Default Value: 1)
272
273       snmpget_path
274              Path to snmpget binary (Default Value: /usr/bin/snmpget)
275
276       snmpset_path
277              Path to snmpset binary (Default Value: /usr/bin/snmpset)
278
279       snmpwalk_path
280              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
281
282
283
284fence_cisco_mds (Fence Agent)     2009-10-20                    FENCE_AGENT(8)