1-- *****************************************************************
2-- CISCO CLUSTER MIB
3--
4-- December 1998, Lucern Ma
5--
6-- Copyright (c) 1999, 2005 by cisco Systems, Inc.
7-- All rights reserved.
8-- *****************************************************************
9
10
11CISCO-CLUSTER-MIB DEFINITIONS ::= BEGIN
12
13IMPORTS
14    MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE,
15    Integer32, Unsigned32
16        FROM SNMPv2-SMI
17    MODULE-COMPLIANCE, OBJECT-GROUP,
18    NOTIFICATION-GROUP
19        FROM SNMPv2-CONF
20    TAddress, TDomain,
21    MacAddress, TimeStamp,
22    RowStatus
23        FROM SNMPv2-TC
24    SnmpAdminString
25        FROM SNMP-FRAMEWORK-MIB
26    ciscoMgmt
27        FROM CISCO-SMI
28    ;
29
30ciscoClusterMIB MODULE-IDENTITY
31    LAST-UPDATED "200511180000Z"
32    ORGANIZATION "Cisco Systems Inc."
33    CONTACT-INFO
34            "       Cisco Systems
35                    Customer Service
36
37            Postal: 170 West Tasman Drive,
38                    San Jose CA 95134-1706.
39                    USA
40
41               Tel: +1 800 553-NETS
42
43            E-mail: cs-sibu@cisco.com"
44    DESCRIPTION
45            "The MIB module for the management of a group of
46            devices called a 'cluster'.  A cluster comprises:
47
48            1. A command switch, which is a device that can provide
49               a single point of management (including SNMP, Web
50               Console and CLI/Telnet Console) for the devices
51               in the cluster;
52
53            2. Zero or more expansion switches, or called the
54               cluster members throughout the context of this MIB,
55               which are devices that can be managed via a command
56               switch.  The command switch is also considered as a
57               cluster member.  Thus it has an entry in the MIB tables
58               defined below for cluster members.
59
60            Only the command switch IP address, passwords, and SNMP
61            community strings need to be configured in order to
62            provide management access to members of the cluster.
63
64            The Entity MIB is cross-referenced from this MIB for
65            some of its table entries, which contain useful
66            information about a cluster.  For example, in the
67            Entity MIB, there is the logical table which contains
68            the community string.  This information is used to
69            access detailed management information for some logical
70            entity (the cluster, in this case).
71
72            To determine if a particular device can be a command switch
73            or a member switch please refer to the device's
74            user's guide."
75    REVISION  "200511180000Z"
76    DESCRIPTION
77            "Updated the imports such that Unsigned32 is imported from
78            SNMPv2-SMI instead of CISCO-TC. Re-ordered the imports such
79            that the SNMPv2 imports are imported first. Added a new
80            NOTIFICATION GROUP ciscoClusterNotificationGroup to include
81            the notification ccStatusMemberStatusChange. Also deprecated the
82            old MODULE-COMPLIANCE ciscoClusterCompliance, and added a new
83            MODULE-COMPLIANCE ciscoClusterComplianceRev1 such that its
84            MANDATORY-GROUPS include this new NOTIFICATION GROUP and all the
85            MANDATORY-GROUPS of ciscoClusterCompliance."
86    REVISION  "9907280000Z"
87    DESCRIPTION
88            "Initial version of this mib."
89    ::= { ciscoMgmt 134 }
90
91ciscoClusterMIBObjects OBJECT IDENTIFIER ::= { ciscoClusterMIB 1 }
92
93-- MIB contains 3 groups
94
95ccStatus          OBJECT IDENTIFIER ::= { ciscoClusterMIBObjects 1 }
96ccMember          OBJECT IDENTIFIER ::= { ciscoClusterMIBObjects 2 }
97ccCandidate       OBJECT IDENTIFIER ::= { ciscoClusterMIBObjects 3 }
98
99-- The Cluster Status Group
100
101ccStatusClusterName OBJECT-TYPE
102    SYNTAX        SnmpAdminString (SIZE (0..31))
103    MAX-ACCESS    read-write
104    STATUS        current
105    DESCRIPTION
106            "The name of the cluster.  Cluster command switch
107             functionality is only enabled if this object is
108             a non-NULL string.  Strings containing all blanks
109             or a NULL string will disable the cluster.
110             This object and ccStatusClusterMode in this MIB are
111             the only objects that will be instantiated if the
112             command switch functionality is not enabled."
113    DEFVAL        { "" }
114    ::= { ccStatus 1 }
115
116ccStatusClusterMode OBJECT-TYPE
117    SYNTAX       INTEGER {
118                           commandDevice(1),
119                           memberDevice(2),
120                           none(3)
121                          }
122    MAX-ACCESS    read-only
123    STATUS        current
124    DESCRIPTION
125            "The mode of the device.  A device can become a member
126             switch only when it is added to the cluster at the command
127             switch.  For devices that do not belong to any cluster,
128             the ccStatusClusterMode is set to 'none'."
129    ::= { ccStatus 2 }
130
131ccStatusCommanderTDomain OBJECT-TYPE
132    SYNTAX        TDomain
133    MAX-ACCESS    read-only
134    STATUS        current
135    DESCRIPTION
136            "Indicates the kind of transport service used by the command
137             switch of the cluster.  Possible values for this object, such
138             as snmpUDPDomain, are defined in the Transport Mappings for
139             SNMPv2 document (RFC 1906)."
140    ::= { ccStatus 3 }
141
142ccStatusCommanderTAddress OBJECT-TYPE
143    SYNTAX        TAddress
144    MAX-ACCESS    read-only
145    STATUS        current
146    DESCRIPTION
147            "The transport service address of the command switch
148             of the cluster.  The address is formatted according to the
149             corresponding value of ccStatusCommanderTDomain.
150
151             For snmpUDPDomain, a TAddress is 6 octets long, the
152             initial 4 octets containing the IP-address in network-byte
153             order and the last 2 containing the UDP port in network-byte
154             order. Consult 'Transport Mappings for Version 2 of the
155             Simple Network Management Protocol' (RFC 1906) for further
156             information on snmpUDPDomain."
157    ::= { ccStatus 4 }
158
159ccStatusCommanderMacAddress OBJECT-TYPE
160    SYNTAX      MacAddress
161    MAX-ACCESS  read-only
162    STATUS      current
163    DESCRIPTION
164            "The management MAC address of the command switch of the
165             cluster."
166    ::= { ccStatus 5 }
167
168ccStatusTimeOfLastChange OBJECT-TYPE
169    SYNTAX        TimeStamp
170    MAX-ACCESS    read-only
171    STATUS        current
172    DESCRIPTION
173            "The value of sysUpTime on the command switch when
174             the last time the value of an instance of ccMemberOperStatus
175             changed.  The value 0 indicates that no member's status
176             has ever changed since commander system initialization."
177    DEFVAL   { 0 }
178    ::= { ccStatus 6 }
179
180ccStatusLastNMSAddMemberTDomain OBJECT-TYPE
181    SYNTAX      TDomain
182    MAX-ACCESS  read-only
183    STATUS      current
184    DESCRIPTION
185            "Indicates the kind of transport service used by the
186             the last NMS tried to add a member to the cluster."
187    ::= { ccStatus 7 }
188
189ccStatusLastNMSAddMemberTAddress OBJECT-TYPE
190    SYNTAX      TAddress
191    MAX-ACCESS  read-only
192    STATUS      current
193    DESCRIPTION
194            "The transport service address of the last NMS which
195             tried to add a member to the cluster.  The address is
196             formatted according to the corresponding value of
197             ccStatusLastNMSAddMemberTDomain."
198    ::= { ccStatus 8 }
199
200ccStatusLastFailureAddMember OBJECT-TYPE
201    SYNTAX      INTEGER {
202                           none(1),
203                           password(2),
204                           overmax(3),
205                           noncandidate(4),
206                           memberNumberInUse(5),
207                           unreachable(6)
208                        }
209    MAX-ACCESS    read-only
210    STATUS        current
211    DESCRIPTION
212            "The reason why the last NMS was unable to add a switch
213             to be a member of the cluster.
214
215             password:  The member has an enable password configured.
216
217             overmax:   Adding the member exceeds the maximum number of
218                        cluster members supported by the command switch.
219                        See ccStatusMaxNumberOfMembers.
220
221             noncandidate:  The member is not a candidate switch, or it
222                            does not show up in the candidate table.
223
224             memberNumberInUse:  The member number is used by an existing
225                                 member in the cluster.
226
227             unreachable:   The member is a candidate but is unreachable or
228                            has no connectivity."
229    ::= { ccStatus 9 }
230
231ccStatusMaxNumberOfMembers OBJECT-TYPE
232    SYNTAX        Unsigned32
233    MAX-ACCESS    read-only
234    STATUS        current
235    DESCRIPTION
236            "The maximum number of cluster members allowed in the
237             cluster.  The command switch is considered as a cluster
238             member also."
239    ::= { ccStatus 10 }
240
241ccStatusMemberOrder OBJECT-TYPE
242    SYNTAX        SnmpAdminString
243    MAX-ACCESS    read-write
244    STATUS        current
245    DESCRIPTION
246            "The suggested order in which the cluster members are
247             displayed in network management applications.  The
248             format of the string is n1,n2,n3,n4, ..., where
249              is any valid member number in the cluster.  The
250             member numbers are separated by commas with no spaces
251             in between.  An example of the object's value is
252             '3,8,14,0,2' for a cluster containing member numbers
253             0, 2, 3, 8, and 14."
254    DEFVAL       { "" }
255    ::= { ccStatus 11 }
256
257--           The Cluster Member Table
258
259ccMemberTable OBJECT-TYPE
260    SYNTAX      SEQUENCE OF CcMemberEntry
261    MAX-ACCESS  not-accessible
262    STATUS      current
263    DESCRIPTION
264            "This table contains one row per cluster member,
265            including the command switch."
266    ::= { ccMember 1 }
267
268ccMemberEntry OBJECT-TYPE
269    SYNTAX      CcMemberEntry
270    MAX-ACCESS  not-accessible
271    STATUS      current
272    DESCRIPTION
273            "An entry containing cluster management information
274            applicable to a particular cluster member."
275    INDEX { ccMemberMacAddress }
276    ::= { ccMemberTable 1 }
277
278CcMemberEntry ::=
279      SEQUENCE {
280               ccMemberMacAddress                MacAddress,
281               ccMemberNumber                    Unsigned32,
282               ccMemberOperStatus                INTEGER,
283               ccMemberEntityLogicalIndex        Integer32,
284               ccMemberRowStatus                 RowStatus
285      }
286
287ccMemberMacAddress OBJECT-TYPE
288    SYNTAX      MacAddress
289    MAX-ACCESS  not-accessible
290    STATUS      current
291    DESCRIPTION
292            "The management MAC address of the member device."
293    ::= { ccMemberEntry 1 }
294
295ccMemberNumber OBJECT-TYPE
296    SYNTAX      Unsigned32
297    MAX-ACCESS  read-create
298    STATUS      current
299    DESCRIPTION
300            "An arbitrary value which uniquely identifies the
301             cluster member switch number. It ranges from 1 to
302             ccStatusMaxNumberOfMembers."
303    ::= { ccMemberEntry 2 }
304
305ccMemberOperStatus OBJECT-TYPE
306    SYNTAX      INTEGER {
307                           active(1),
308                           inactive(2)
309                        }
310    MAX-ACCESS  read-only
311    STATUS      current
312    DESCRIPTION
313            "The status of cluster management connectivity between
314             the command switch and a cluster member. Cluster management
315             connectivity is determined by the exchange of cluster
316             management messages between the command switch and a
317             cluster member. A member that has failed to exchange
318             cluster management messages with the command switch is
319             deemed to be inactive. Otherwise, it is deemed to be active."
320    ::= { ccMemberEntry 3 }
321
322ccMemberEntityLogicalIndex OBJECT-TYPE
323    SYNTAX      Integer32 (1..2147483647)
324    MAX-ACCESS  read-only
325    STATUS      current
326    DESCRIPTION
327            "The value of entLogicalIndex in the ENTITY-MIB
328             corresponding to this cluster member. Creating an
329             entry in this table creates a corresponding entry
330             in the entLogicalTable in the ENTITY-MIB."
331    ::= { ccMemberEntry 4 }
332
333ccMemberRowStatus OBJECT-TYPE
334    SYNTAX      RowStatus
335    MAX-ACCESS  read-create
336    STATUS      current
337    DESCRIPTION
338        "The status of this conceptual row. A device
339         is added to the cluster of a command switch by
340         creating an entry in this table for the device. The
341         devices currently eligible to be added into the
342         cluster are listed in the ccCandidateTable.
343         An attempt to add a new member may fail.  See
344         ccStatusLastFailureAddMember for possible reasons
345         for that failure."
346    ::= { ccMemberEntry 5 }
347
348--           The Cluster Candidate Table
349
350ccCandidateTable OBJECT-TYPE
351    SYNTAX      SEQUENCE OF CcCandidateEntry
352    MAX-ACCESS  not-accessible
353    STATUS      current
354    DESCRIPTION
355            "This table contains one row per cluster candidate,
356             A cluster candidate is a device that is currently
357             eligible to be added to the cluster of a command
358             switch.  A device is eligible if it satisfies the
359             following conditions:
360             1. It supports the cluster management protocol.
361             2. It is directly connected to an existing cluster
362                member.
363
364             The entries in this table and the entries in
365             ccMemberTable are mutually exclusive at all
366             times.  That is, any device that is a cluster
367             member never shows up in the ccCandidateTable
368             or is never a candidate at the same time .  Also, any
369             candidate that shows up in ccCandidateTable should not
370             appear in ccMemberTable."
371    ::= { ccCandidate 1 }
372
373ccCandidateEntry       OBJECT-TYPE
374    SYNTAX      CcCandidateEntry
375    MAX-ACCESS  not-accessible
376    STATUS      current
377    DESCRIPTION
378            "An entry pertaining to a single candidate device."
379    INDEX { ccCandidateMacAddress }
380    ::= { ccCandidateTable 1 }
381
382CcCandidateEntry ::= SEQUENCE {
383      ccCandidateMacAddress    MacAddress
384}
385
386ccCandidateMacAddress OBJECT-TYPE
387    SYNTAX      MacAddress
388    MAX-ACCESS  read-only
389    STATUS      current
390    DESCRIPTION
391            "The MAC address of a device qualified to
392             to be a cluster member of the command switch
393             cluster."
394    ::= { ccCandidateEntry 1 }
395
396-- Notifications
397
398ciscoClusterMIBNotificationsPrefix OBJECT IDENTIFIER
399            ::= { ciscoClusterMIB 2 }
400ciscoClusterMIBNotifications OBJECT IDENTIFIER
401            ::= { ciscoClusterMIBNotificationsPrefix 0 }
402
403ccStatusMemberStatusChange NOTIFICATION-TYPE
404    OBJECTS     { ccMemberOperStatus }
405    STATUS      current
406    DESCRIPTION
407          " A cluster member status change notification
408            is generated whenever the value of any instance
409            of ccClusterMemberOperStatus changes after the
410            member is completely added to the cluster."
411    ::= { ciscoClusterMIBNotifications 1 }
412
413-- Conformance Information
414
415ciscoClusterMIBConformance OBJECT IDENTIFIER ::= { ciscoClusterMIB 3 }
416ciscoClusterMIBCompliances OBJECT IDENTIFIER
417            ::= { ciscoClusterMIBConformance 1 }
418ciscoClusterMIBGroups      OBJECT IDENTIFIER
419            ::= { ciscoClusterMIBConformance 2 }
420
421-- Compliance statements
422
423ciscoClusterCompliance MODULE-COMPLIANCE
424    STATUS  deprecated
425    DESCRIPTION
426            "The compliance statement for the CLUSTER MIB."
427    MODULE  -- this module
428    MANDATORY-GROUPS { ciscoClusterStatusGroup,
429                       ciscoClusterMemberStatusGroup,
430                       ciscoClusterMemberGroup,
431                       ciscoClusterCandidateGroup }
432    ::= { ciscoClusterMIBCompliances 1 }
433
434ciscoClusterComplianceRev1 MODULE-COMPLIANCE
435    STATUS  current
436    DESCRIPTION
437            "The compliance statement for the CLUSTER MIB."
438    MODULE  -- this module
439    MANDATORY-GROUPS { ciscoClusterStatusGroup,
440                       ciscoClusterMemberStatusGroup,
441                       ciscoClusterMemberGroup,
442                       ciscoClusterCandidateGroup,
443                       ciscoClusterNotificationGroup }
444    ::= { ciscoClusterMIBCompliances 2 }
445
446-- MIB groupings
447
448ciscoClusterStatusGroup  OBJECT-GROUP
449    OBJECTS {
450             ccStatusTimeOfLastChange,
451             ccStatusLastNMSAddMemberTAddress,
452             ccStatusLastNMSAddMemberTDomain,
453             ccStatusLastFailureAddMember,
454             ccStatusMaxNumberOfMembers,
455             ccStatusMemberOrder
456            }
457    STATUS  current
458    DESCRIPTION
459            "The collection of objects which are used to represent
460             the status of the cluster.  These objects are accessible
461             on the command switch."
462    ::= { ciscoClusterMIBGroups 1 }
463
464ciscoClusterMemberStatusGroup OBJECT-GROUP
465    OBJECTS {
466             ccStatusClusterName,
467             ccStatusClusterMode,
468             ccStatusCommanderTDomain,
469             ccStatusCommanderTAddress,
470             ccStatusCommanderMacAddress
471            }
472    STATUS  current
473    DESCRIPTION
474            "The collection of objects which are used to represent
475             the status of the cluster.  These objects are accessible
476             on the cluster members and the command switch."
477    ::= { ciscoClusterMIBGroups 2 }
478
479ciscoClusterMemberGroup    OBJECT-GROUP
480    OBJECTS {
481             ccMemberOperStatus,
482             ccMemberNumber,
483             ccMemberEntityLogicalIndex,
484             ccMemberRowStatus
485            }
486    STATUS  current
487    DESCRIPTION
488            "The collection of objects which are used to represent
489             the members of a cluster.  These objects are accessible
490             on the command switch only."
491    ::= { ciscoClusterMIBGroups 3 }
492
493ciscoClusterCandidateGroup    OBJECT-GROUP
494    OBJECTS {
495             ccCandidateMacAddress
496            }
497    STATUS  current
498    DESCRIPTION
499            "The collection of objects which are used to represent
500             cluster candidates.  These objects are accessible
501             on the command switch only."
502    ::= { ciscoClusterMIBGroups 4 }
503
504ciscoClusterNotificationGroup    NOTIFICATION-GROUP
505    NOTIFICATIONS {
506                   ccStatusMemberStatusChange
507                  }
508    STATUS  current
509    DESCRIPTION
510            "The collection of notifications defined for the cluster
511            candidates."
512    ::= { ciscoClusterMIBGroups 5 }
513
514END
515
516
517