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 This parameter is always required.
37
38       -l, --username=[name]
39              Login Name
40
41       -p, --password=[password]
42              Login password or passphrase
43
44       -S, --password-script=[script]
45              Script to retrieve password
46
47       -n, --plug=[id]
48              Physical  plug  number,  name  of  virtual  machine or UUID This
49              parameter is always required.
50
51       -b, --snmp-auth-prot=[prot]
52              Set authentication protocol (MD5|SHA)
53
54       -P, --snmp-priv-passwd=[pass]
55              Set privacy protocol password
56
57       -R, --snmp-priv-passwd-script
58              Script to run to retrieve privacy password
59
60       -B, --snmp-priv-prot=[prot]
61              Set privacy protocol (DES|AES)
62
63       -E, --snmp-sec-level=[level]
64              Set security level (noAuthNoPriv|authNoPriv|authPriv)
65
66       -d, --snmp-version=[version]
67              Specifies SNMP version to use (1,2c,3)
68
69       -u, --udpport
70              UDP/TCP port to use for connection with device
71
72       -v, --verbose
73              Verbose mode
74
75       -D, --debug-file=[debugfile]
76              Write debug information to given file
77
78       -V, --version
79              Display version information and exit
80
81       -h, --help
82              Display help and exit
83
84       -C, --separator=[char]
85              Separator for CSV created by operation list (Default  Value:  ,)
86
87
88       --delay=[seconds]
89              Wait  X  seconds  before  fencing  is started (Default Value: 0)
90
91
92       --login-timeout=[seconds]
93              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
94
95
96       --power-timeout=[seconds]
97              Test  X  seconds  for status change after ON/OFF (Default Value:
98              20)
99
100       --power-wait=[seconds]
101              Wait X seconds after issuing ON/OFF (Default Value: 0)
102
103       --shell-timeout=[seconds]
104              Wait X seconds for cmd prompt  after  issuing  command  (Default
105              Value: 3)
106
107       --retry-on=[attempts]
108              Count of attempts to retry power on (Default Value: 1)
109
110

ACTIONS

112
113
114       on     Power on machine.
115
116       off    Power off machine.
117
118       status This returns the status of the plug/virtual machine.
119
120       list   List  available  plugs with aliases/virtual machines if there is
121              support for more then one device. Returns N/A otherwise.
122
123       list-status
124              List available plugs with  aliases/virtual  machines  and  their
125              power  state  if it can be obtained without additional commands.
126
127
128       monitor
129              Check the health of fence device
130
131       metadata
132              Display the XML metadata describing this resource.
133
134

STDIN PARAMETERS

136
137
138       action Fencing Action (Default Value: off)
139
140       community
141              Set the community string
142
143       inet4_only
144              Forces agent to use IPv4 addresses only
145
146       inet6_only
147              Forces agent to use IPv6 addresses only
148
149       ipaddr IP Address or Hostname This parameter is always required.
150
151       login  Login Name
152
153       passwd Login password or passphrase
154
155       passwd_script
156              Script to retrieve password
157
158       port   Physical plug number, name  of  virtual  machine  or  UUID  This
159              parameter is always required.
160
161       snmp_auth_prot
162              Set authentication protocol (MD5|SHA)
163
164       snmp_priv_passwd
165              Set privacy protocol password
166
167       snmp_priv_passwd_script
168              Script to run to retrieve privacy password
169
170       snmp_priv_prot
171              Set privacy protocol (DES|AES)
172
173       snmp_sec_level
174              Set security level (noAuthNoPriv|authNoPriv|authPriv)
175
176       snmp_version
177              Specifies SNMP version to use (1,2c,3)
178
179       udpport
180              UDP/TCP port to use for connection with device
181
182       verbose
183              Verbose mode
184
185       debug  Write debug information to given file
186
187       version
188              Display version information and exit
189
190       help   Display help and exit
191
192       separator
193              Separator  for  CSV created by operation list (Default Value: ,)
194
195
196       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
197
198
199       login_timeout
200              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
201
202
203       power_timeout
204              Test X seconds for status change after  ON/OFF  (Default  Value:
205              20)
206
207       power_wait
208              Wait X seconds after issuing ON/OFF (Default Value: 0)
209
210       shell_timeout
211              Wait  X  seconds  for  cmd prompt after issuing command (Default
212              Value: 3)
213
214       retry_on
215              Count of attempts to retry power on (Default Value: 1)
216
217
218
219fence_cisco_mds (Fence Agent)     2009-10-20                    FENCE_AGENT(8)