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

ACTIONS

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

STDIN PARAMETERS

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