fence_cisco_mds(8)

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       -4, --inet4-only
30              Forces agent to use IPv4 addresses only
31
32       -6, --inet6-only
33              Forces agent to use IPv6 addresses only
34
35       -a, --ip=[ip]
36              IP  address  or  hostname  of  fencing  device This parameter is
37              always required.
38
39       -u, --ipport=[port]
40              TCP/UDP port to use for connection with device  (Default  Value:
41              161)
42
43       -p, --password=[password]
44              Login password or passphrase
45
46       -S, --password-script=[script]
47              Script to run to retrieve password
48
49       -n, --plug=[id]
50              Physical  plug  number  on  device,  UUID  or  identification of
51              machine This parameter is always required.
52
53       -b, --snmp-auth-prot=[prot]
54              Set authentication protocol (MD5|SHA)
55
56       -P, --snmp-priv-passwd=[pass]
57              Set privacy protocol password
58
59       -R, --snmp-priv-passwd-script
60              Script to run to retrieve privacy password
61
62       -B, --snmp-priv-prot=[prot]
63              Set privacy protocol (DES|AES)
64
65       -E, --snmp-sec-level=[level]
66              Set security level (noAuthNoPriv|authNoPriv|authPriv)
67
68       -d, --snmp-version=[version]
69              Specifies SNMP version to use (1|2c|3)
70
71       -l, --username=[name]
72              Login name
73
74       -q, --quiet
75              Disable logging to stderr. Does not affect --verbose or --debug-
76              file or logging to syslog.
77
78       -v, --verbose
79              Verbose mode
80
81       -D, --debug-file=[debugfile]
82              Write debug information to given file
83
84       -V, --version
85              Display version information and exit
86
87       -h, --help
88              Display help and exit
89
90       -C, --separator=[char]
91              Separator for CSV created by 'list' operation (Default Value: ,)
92
93
94       --delay=[seconds]
95              Wait X seconds before fencing  is  started  (Default  Value:  0)
96
97
98       --login-timeout=[seconds]
99              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
100
101
102       --power-timeout=[seconds]
103              Test X seconds for status change after  ON/OFF  (Default  Value:
104              20)
105
106       --power-wait=[seconds]
107              Wait X seconds after issuing ON/OFF (Default Value: 0)
108
109       --shell-timeout=[seconds]
110              Wait  X  seconds  for  cmd prompt after issuing command (Default
111              Value: 3)
112
113       --retry-on=[attempts]
114              Count of attempts to retry power on (Default Value: 1)
115
116       --snmpget-path=[path]
117              Path to snmpget binary (Default Value: /usr/bin/snmpget)
118
119       --snmpset-path=[path]
120              Path to snmpset binary (Default Value: /usr/bin/snmpset)
121
122       --snmpwalk-path=[path]
123              Path to snmpwalk binary (Default Value: /usr/bin/snmpwalk)
124
125

ACTIONS

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

STDIN PARAMETERS

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