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
31              always 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
45              machine 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       -C, --separator=[char]
92              Separator for CSV created by 'list' operation (Default Value: ,)
93
94
95       --delay=[seconds]
96              Wait X seconds before fencing  is  started  (Default  Value:  0)
97
98
99       --disable-timeout=[true/false]
100              Disable  timeout (true/false) (default: true when run from Pace‐
101              maker 2.0+)
102
103       --login-timeout=[seconds]
104              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
105
106
107       --power-timeout=[seconds]
108              Test  X  seconds  for status change after ON/OFF (Default Value:
109              20)
110
111       --power-wait=[seconds]
112              Wait X seconds after issuing ON/OFF (Default Value: 0)
113
114       --shell-timeout=[seconds]
115              Wait X seconds for cmd prompt  after  issuing  command  (Default
116              Value: 3)
117
118       --retry-on=[attempts]
119              Count of attempts to retry power on (Default Value: 1)
120
121       --snmpget-path=[path]
122              Path to snmpget binary (Default Value: /usr/bin/snmpget)
123
124       --snmpset-path=[path]
125              Path to snmpset binary (Default Value: /usr/bin/snmpset)
126
127       --snmpwalk-path=[path]
128              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
129
130

ACTIONS

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

STDIN PARAMETERS

162
163
164       action Fencing action (Default Value: off)
165
166       community
167              Set the community string
168
169       ip     IP address or hostname  of  fencing  device  This  parameter  is
170              always required. Obsoletes: ipaddr
171
172       ipport TCP/UDP  port  to use for connection with device (Default Value:
173              161)
174
175       password
176              Login password or passphrase Obsoletes: passwd
177
178       password_script
179              Script to run  to  retrieve  password  Obsoletes:  passwd_script
180
181
182       plug   Physical  plug  number  on  device,  UUID  or  identification of
183              machine This parameter is always required. Obsoletes: port
184
185
186       snmp_auth_prot
187              Set authentication protocol (MD5|SHA)
188
189       snmp_priv_passwd
190              Set privacy protocol password
191
192       snmp_priv_passwd_script
193              Script to run to retrieve privacy password
194
195       snmp_priv_prot
196              Set privacy protocol (DES|AES)
197
198       snmp_sec_level
199              Set security level (noAuthNoPriv|authNoPriv|authPriv)
200
201       snmp_version
202              Specifies SNMP version to use (1|2c|3)
203
204       username
205              Login name Obsoletes: login
206
207       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
208              file or logging to syslog.
209
210       verbose
211              Verbose mode. Multiple -v flags can be stacked  on  the  command
212              line (e.g., -vvv) to increase verbosity.
213
214       verbose_level
215              Level  of  debugging detail in output. Defaults to the number of
216              --verbose flags specified on the command line, or to 1  if  ver‐
217              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
218
219
220       debug_file
221              Write debug information to given file Obsoletes: debug
222
223       version
224              Display version information and exit
225
226       help   Display help and exit
227
228       separator
229              Separator for CSV created by 'list' operation (Default Value: ,)
230
231
232       delay  Wait  X  seconds  before  fencing  is started (Default Value: 0)
233
234
235       disable_timeout
236              Disable timeout (true/false) (default: true when run from  Pace‐
237              maker 2.0+)
238
239       login_timeout
240              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
241
242
243       power_timeout
244              Test X seconds for status change after  ON/OFF  (Default  Value:
245              20)
246
247       power_wait
248              Wait X seconds after issuing ON/OFF (Default Value: 0)
249
250       shell_timeout
251              Wait  X  seconds  for  cmd prompt after issuing command (Default
252              Value: 3)
253
254       retry_on
255              Count of attempts to retry power on (Default Value: 1)
256
257       snmpget_path
258              Path to snmpget binary (Default Value: /usr/bin/snmpget)
259
260       snmpset_path
261              Path to snmpset binary (Default Value: /usr/bin/snmpset)
262
263       snmpwalk_path
264              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
265
266
267
268fence_cisco_mds (Fence Agent)     2009-10-20                    FENCE_AGENT(8)