1-- *****************************************************************
2-- CISCO-ITP-MONITOR-MIB: MIB for managing information for
3--                        ITP Monitor Probe
4--
5-- October 2003 John Linton, Shekhar Acharya
6--
7-- Copyright (c) 2003, 2004 by Cisco Systems, Inc.
8-- All rights reserved.
9-- *****************************************************************
10CISCO-ITP-MONITOR-MIB DEFINITIONS ::= BEGIN
11
12IMPORTS
13
14        ciscoMgmt
15                FROM CISCO-SMI
16
17        InetPortNumber
18             FROM INET-ADDRESS-MIB
19
20        SnmpAdminString
21                FROM SNMP-FRAMEWORK-MIB
22
23        MODULE-COMPLIANCE,
24        NOTIFICATION-GROUP,
25        OBJECT-GROUP
26                FROM SNMPv2-CONF
27
28        TruthValue
29                FROM SNMPv2-TC
30
31        Counter32,
32        Gauge32,
33        Unsigned32,
34        MODULE-IDENTITY,
35        NOTIFICATION-TYPE,
36        OBJECT-TYPE
37                FROM SNMPv2-SMI;
38
39ciscoItpmMIB MODULE-IDENTITY
40        LAST-UPDATED    "200407200000Z"
41        ORGANIZATION    "Cisco Systems, Inc."
42        CONTACT-INFO
43                "       Cisco Systems, Inc
44                        Customer Service
45
46                Postal: 170 W. Tasman Drive
47                        San Jose, CA  95134
48                        USA
49
50                   Tel: +1 800 553-NETS
51
52                E-mail: cs-ss7@cisco.com"
53        DESCRIPTION
54               "The MIB for providing information related to
55                monitoring SS7 links.
56
57                This information can be used to manage the state
58                of software used to collect all packets transported
59                and received over a SS7 link.
60
61                Abbreviations:
62                  MSU   - Message Signalling Unit
63                  MTP   - Message Transport Protocol
64                  SS7   - System  No. 7 (SS7) Network"
65
66        REVISION        "200407200000Z"
67        DESCRIPTION
68                "Add support for notification when connection
69                 to server changes states."
70
71        REVISION        "200310310000Z"
72        DESCRIPTION
73                "Initial version of this MIB module."
74
75        ::= { ciscoMgmt 379 }  --
76
77-- Top-level structure of the MIB
78ciscoItpmMIBNotifs  OBJECT IDENTIFIER ::= { ciscoItpmMIB 0 }
79ciscoItpmMIBObjects OBJECT IDENTIFIER ::= { ciscoItpmMIB 1 }
80ciscoItpmMIBConform OBJECT IDENTIFIER ::= { ciscoItpmMIB 2 }
81
82cItpmConn        OBJECT IDENTIFIER ::= { ciscoItpmMIBObjects  1 }
83cItpmLink        OBJECT IDENTIFIER ::= { ciscoItpmMIBObjects  2 }
84
85-- *************************************************************
86-- *                                                           *
87-- * Connection Table                                          *
88-- *                                                           *
89-- *************************************************************
90cItpmConnTable           OBJECT-TYPE
91        SYNTAX           SEQUENCE OF CItpmConnTableEntry
92        MAX-ACCESS       not-accessible
93        STATUS           current
94        DESCRIPTION
95           "This table provides information on connections used
96            to collect information on SS7 links.  Information in
97            this table can be used to customize connection
98            parameters.  In addition, this table provides
99            measurements and status information for each
100            connection."
101        ::= { cItpmConn 1 }
102
103cItpmConnTableEntry     OBJECT-TYPE
104        SYNTAX           CItpmConnTableEntry
105        MAX-ACCESS       not-accessible
106        STATUS           current
107        DESCRIPTION
108            "An entry in the cItpmConnTable table."
109        INDEX   { cItpmConnPortNumber }
110        ::= { cItpmConnTable 1 }
111
112CItpmConnTableEntry  ::= SEQUENCE {
113        cItpmConnPortNumber         InetPortNumber,
114        cItpmConnKeepAlive          Unsigned32,
115        cItpmConnMaxQDepth          Unsigned32,
116        cItpmConnCongOnset          Unsigned32,
117        cItpmConnCongAbate          Unsigned32,
118        cItpmConnRcvWindowSize      Unsigned32,
119        cItpmConnFastStart          TruthValue,
120        cItpmConnQueueDepth         Gauge32,
121        cItpmConnMonitorState       INTEGER,
122        cItpmConnCongestion         TruthValue,
123        cItpmConnCongCounts         Counter32
124    }
125
126cItpmConnPortNumber      OBJECT-TYPE
127        SYNTAX           InetPortNumber
128        MAX-ACCESS       not-accessible
129        STATUS           current
130        DESCRIPTION
131           "The port number used to establish TCP connection."
132        ::= { cItpmConnTableEntry 1 }
133
134cItpmConnKeepAlive       OBJECT-TYPE
135        SYNTAX           Unsigned32 (0..60000)
136        UNITS            "milliseconds"
137        MAX-ACCESS       read-write
138        STATUS           current
139        DESCRIPTION
140           "Specifies the keepalive time value in milliseconds.
141            Keepalive packets are sent between the monitor and the
142            remote server as a mechanism to ensure the TCP session
143            is active and detect session failure in a timely manner.
144            During periods of idle monitor traffic, the monitor will
145            send a keepalive packet to the remote server at the
146            specified interval.  The monitor also expects to receive
147            a keepalive packet from the remote server at the same
148            interval.  If the monitor does not receive a
149            keepalive packet from the remote server in two times the
150            keep alive value, the monitor will close the TCP
151            session.  The value of zero disables the keep alive
152            processing."
153        DEFVAL { 5000 }
154        ::= { cItpmConnTableEntry 2 }
155
156cItpmConnMaxQDepth       OBJECT-TYPE
157        SYNTAX           Unsigned32 (10..100000)
158        UNITS            "packets"
159        MAX-ACCESS       read-write
160        STATUS           current
161        DESCRIPTION
162           "The maximum number of packets that can be queued for
163            transmission.  If the monitor cannot send a TCP packet
164            immediately, the packet will be queued for retransmit.
165            This object defines the maximum number of TCP packets
166            that may be queued for retransmit.  Once the number of
167            TCP packets on the queue reaches the value specified by
168            this object, additional TCP packets will be
169            dropped."
170        DEFVAL { 100 }
171        ::= { cItpmConnTableEntry 3 }
172
173cItpmConnCongOnset       OBJECT-TYPE
174        SYNTAX           Unsigned32 (100..100000)
175        UNITS            "packets"
176        MAX-ACCESS       read-write
177        STATUS           current
178        DESCRIPTION
179           "Threshold used to mark onset of congestion.
180            When the cItpmConnQueueDepth object reaches value
181            specified by this object the connection will
182            considered congested. It will remain congested until
183            the cItpmConnQueueDepth object drops below the value
184            specified by the cItpmConnCongAbate object."
185        ::= { cItpmConnTableEntry 4 }
186
187cItpmConnCongAbate       OBJECT-TYPE
188        SYNTAX           Unsigned32 (0..100000)
189        UNITS            "packets"
190        MAX-ACCESS       read-write
191        STATUS           current
192        DESCRIPTION
193           "Threshold used to mark end of congestion.
194            When the cItpmConnQueueDepth object drops below the
195            value specified by this object the connection will
196            exit congestion."
197        ::= { cItpmConnTableEntry 5 }
198
199cItpmConnRcvWindowSize   OBJECT-TYPE
200        SYNTAX           Unsigned32 (100..1000000)
201        UNITS            "bytes"
202        MAX-ACCESS       read-write
203        STATUS           current
204        DESCRIPTION
205           "The size of TCP receive window.  This object
206            defines the number of outstanding (unacknowledged)
207            bytes that the ITP monitor can receive on TCP
208            connection."
209        DEFVAL { 200000 }
210        ::= { cItpmConnTableEntry 6 }
211
212cItpmConnFastStart       OBJECT-TYPE
213        SYNTAX           TruthValue
214        MAX-ACCESS       read-write
215        STATUS           current
216        DESCRIPTION
217           "Defines the fast-start option for establishing TCP
218            connectivity as follows.
219
220            'true'   - FastStart is enabled.
221            'false'  - FastStart is disabled.
222
223            Normally, after the TCP session with the remote server
224            is established, the monitor will not send MSUs from the
225            monitored links to the server until the server responds
226            to the first keepalive.
227
228            This mechanism prevents the ITP from over-running the
229            server until the TCP session and receive window sizes
230            are fully established.
231
232            Configuration of fast-start overrides this mechanism and
233            allows the ITP to start sending MSUs to the server
234            immediately after the TCP session is established.
235
236            Caution should be used with the fast-start configuration
237            as MSUs may be lost until the TCP session server and
238            receive window sizes are fully established. "
239
240        DEFVAL { false }
241        ::= { cItpmConnTableEntry 7 }
242
243cItpmConnQueueDepth      OBJECT-TYPE
244        SYNTAX           Gauge32 (0..100000)
245        UNITS            "packets"
246        MAX-ACCESS       read-only
247        STATUS           current
248        DESCRIPTION
249           "The number of packets queued for transmission. The
250            maximum value is specified by the cItpmConnMaxQDepth
251            object."
252        ::= { cItpmConnTableEntry 8 }
253
254cItpmConnMonitorState    OBJECT-TYPE
255        SYNTAX           INTEGER {
256                                  active(1),
257                                  inactive(2)
258        }
259        MAX-ACCESS       read-only
260        STATUS           current
261        DESCRIPTION
262           "The state of the connection as follows.
263            'active'  - connection is transmitting SS7 link
264                        traffic to server.
265
266            'inactive'  - connection is not transmitting SS7 link
267                        traffic to server."
268        ::= { cItpmConnTableEntry 9 }
269
270cItpmConnCongestion      OBJECT-TYPE
271        SYNTAX           TruthValue
272        MAX-ACCESS       read-only
273        STATUS           current
274        DESCRIPTION
275           "Congestion indicator for connection as follows.
276            'true'   - connection is congested.
277            'false'  - connection not congested.
278
279            Congestion onset occurs when the cItpmConnQueueDepth
280            object reaches the maximum allowed value specified by
281            the cItpmConnMaxQDepth object.
282
283            Congestion abate occurs when the cItpmConnQueueDepth
284            object reaches the maximum allowed value specified by
285            the cItpmConnMaxQDepth object. "
286        ::= { cItpmConnTableEntry 10 }
287
288cItpmConnCongCounts      OBJECT-TYPE
289        SYNTAX           Counter32
290        UNITS            "occurences"
291        MAX-ACCESS       read-only
292        STATUS           current
293        DESCRIPTION
294           "The number of times the connection has entered
295           congestion."
296        ::= { cItpmConnTableEntry 11 }
297
298--  *************************************************************
299--  *                                                           *
300--  * SS7 Links                                                 *
301--  *                                                           *
302--  *************************************************************
303cItpmLinkTable           OBJECT-TYPE
304        SYNTAX           SEQUENCE OF CItpmLinkTableEntry
305        MAX-ACCESS       not-accessible
306        STATUS           current
307        DESCRIPTION
308           "This table provides information and measurements
309            on the monitored SS7 links per connection.  This table
310            shares the cItpmConnPortNumber index with the
311            cItpmConnTable."
312        ::= { cItpmConn 2 }
313
314cItpmLinkTableEntry      OBJECT-TYPE
315        SYNTAX           CItpmLinkTableEntry
316        MAX-ACCESS       not-accessible
317        STATUS           current
318        DESCRIPTION
319            "An entry in the cItpmLinkTable table."
320        INDEX   { cItpmConnPortNumber, -- Shared Index
321                  cItpmLinkNumber
322        }
323        ::= { cItpmLinkTable 1 }
324
325CItpmLinkTableEntry  ::= SEQUENCE {
326        cItpmLinkNumber             Unsigned32,
327        cItpmLinkDescription        SnmpAdminString,
328        cItpmLinkSlotNumber         Unsigned32,
329        cItpmLinkStatus             INTEGER,
330        cItpmLinkRcvdMsus           Counter32,
331        cItpmLinkRcvdMsuDrops       Counter32,
332        cItpmLinkRcvdMsuRate        Gauge32,
333        cItpmLinkRcvdBitsRate       Gauge32,
334        cItpmLinkSentMsus           Counter32,
335        cItpmLinkSentMsuDrops       Counter32,
336        cItpmLinkSentMsuRate        Gauge32,
337        cItpmLinkSentBitsRate       Gauge32
338    }
339
340cItpmLinkNumber          OBJECT-TYPE
341        SYNTAX           Unsigned32 ( 1..65535 )
342        MAX-ACCESS       not-accessible
343        STATUS           current
344        DESCRIPTION
345           "This object specifies the secondary index for
346            objects in the cItpmLinkTable table. A unique
347            number is assigned to each link when it is
348            assigned to a connection."
349        ::= { cItpmLinkTableEntry 1 }
350
351cItpmLinkDescription     OBJECT-TYPE
352        SYNTAX           SnmpAdminString ( SIZE ( 0..128 ) )
353        MAX-ACCESS       read-only
354        STATUS           current
355        DESCRIPTION
356           "Brief customer defined description."
357        ::= { cItpmLinkTableEntry 2 }
358
359cItpmLinkSlotNumber          OBJECT-TYPE
360        SYNTAX               Unsigned32 (0..32767)
361        MAX-ACCESS           read-only
362        STATUS               current
363        DESCRIPTION
364            "The slot number support interface used to collect
365             SS7 link traffic."
366        ::= { cItpmLinkTableEntry 3 }
367
368cItpmLinkStatus          OBJECT-TYPE
369        SYNTAX           INTEGER {
370                                  active(1),
371                                  inactive(2)
372        }
373        MAX-ACCESS       read-only
374        STATUS           current
375        DESCRIPTION
376           "The state of the monitored SS7 Link as follows.
377            'active'    - SS7 link is available for monitoring.
378            'inactive'  - SS7 link is unavailable for monitoring."
379        ::= { cItpmLinkTableEntry 4 }
380
381cItpmLinkRcvdMsus        OBJECT-TYPE
382        SYNTAX           Counter32
383        UNITS            "MSUs"
384        MAX-ACCESS       read-only
385        STATUS           current
386        DESCRIPTION
387           "The number of MSUs received on SS7 Link."
388        ::= { cItpmLinkTableEntry 5 }
389
390cItpmLinkRcvdMsuDrops    OBJECT-TYPE
391        SYNTAX           Counter32
392        UNITS            "MSUs"
393        MAX-ACCESS       read-only
394        STATUS           current
395        DESCRIPTION
396           "The number of MSUs that were received on SS7 Link
397            and were dropped due to congestion."
398        ::= { cItpmLinkTableEntry 6 }
399
400cItpmLinkRcvdMsuRate     OBJECT-TYPE
401        SYNTAX           Gauge32
402        UNITS            "MSUs per second"
403        MAX-ACCESS       read-only
404        STATUS           current
405        DESCRIPTION
406           "The number of MSUs received on SS7 Link per second."
407        ::= { cItpmLinkTableEntry 7 }
408
409cItpmLinkRcvdBitsRate    OBJECT-TYPE
410        SYNTAX           Gauge32
411        UNITS            "bits per second"
412        MAX-ACCESS       read-only
413        STATUS           current
414        DESCRIPTION
415           "The number of bits received on SS7 Link per second."
416        ::= { cItpmLinkTableEntry 8 }
417
418cItpmLinkSentMsus        OBJECT-TYPE
419        SYNTAX           Counter32
420        UNITS            "MSUs"
421        MAX-ACCESS       read-only
422        STATUS           current
423        DESCRIPTION
424           "The number of MSUs sent on SS7 Link."
425        ::= { cItpmLinkTableEntry 9 }
426
427cItpmLinkSentMsuDrops    OBJECT-TYPE
428        SYNTAX           Counter32
429        UNITS            "MSUs"
430        MAX-ACCESS       read-only
431        STATUS           current
432        DESCRIPTION
433           "The number of MSUs that were sent on SS7 Link
434            and were dropped due to congestion."
435        ::= { cItpmLinkTableEntry 10 }
436
437cItpmLinkSentMsuRate     OBJECT-TYPE
438        SYNTAX           Gauge32
439        UNITS            "MSUs per second"
440        MAX-ACCESS       read-only
441        STATUS           current
442        DESCRIPTION
443           "The number of MSUs sent on SS7 Link per second."
444        ::= { cItpmLinkTableEntry 11}
445
446cItpmLinkSentBitsRate    OBJECT-TYPE
447        SYNTAX           Gauge32
448        UNITS            "bits per second"
449        MAX-ACCESS       read-only
450        STATUS           current
451        DESCRIPTION
452           "The number of bits sent on SS7 Link per second."
453        ::= { cItpmLinkTableEntry 12}
454
455-- *************************************************************
456-- *                                                           *
457-- * Notification Enable     Objects                           *
458-- *                                                           *
459-- *************************************************************
460cItpmCongestionNotifEnabled      OBJECT-TYPE
461     SYNTAX                      TruthValue
462     MAX-ACCESS                  read-write
463     STATUS                      current
464     DESCRIPTION
465             "The ITP monitor congestion States notification
466             truth value.
467
468             'true'  Indicates that cItpmCongestionNotifEnabled
469                     notification is to be generated when the state
470                     changes. That is, the notification generation
471                     is enabled.
472             'false' Indicates that cItpmCongestionNotifEnabled
473                     notification generation is disabled."
474     DEFVAL { false }
475     ::= { ciscoItpmMIBObjects  3 }
476
477cItpmMonitorStateNotifEnabled    OBJECT-TYPE
478     SYNTAX                      TruthValue
479     MAX-ACCESS                  read-write
480     STATUS                      current
481     DESCRIPTION
482        "The ITP monitor state notification truth value.
483
484         'true'  - Indicates that ciscoItpMonitorState notification
485                   is to be generated when the state of connection
486                   changes. That is, the notification generation is
487                   enabled.
488
489         'false' - Indicates that ciscoItpMonitorState notification
490                   generation is disabled."
491     DEFVAL { false }
492     ::= { ciscoItpmMIBObjects 4 }
493
494-- *************************************************************
495-- *                                                           *
496-- * Notifications                                             *
497-- *                                                           *
498-- *************************************************************
499ciscoItpMonitorCongestion NOTIFICATION-TYPE
500     OBJECTS { cItpmConnCongestion
501     }
502     STATUS  current
503     DESCRIPTION
504             "The notification generated when a connection
505              enters or exits congestion state.  The value of
506              cItpmConnCongestion indicates new state."
507     ::= { ciscoItpmMIBNotifs 1 }
508
509ciscoItpMonitorState NOTIFICATION-TYPE
510     OBJECTS { cItpmConnMonitorState
511     }
512     STATUS  current
513     DESCRIPTION
514             "The notification generated when a connection
515              changes states.  The value of
516              cItpmConnMonitorState indicates new state."
517     ::= { ciscoItpmMIBNotifs 2 }
518
519
520-- *************************************************************
521-- *                                                           *
522-- * Conformance Information                                   *
523-- *                                                           *
524-- *************************************************************
525ciscoItpmMIBCompliances OBJECT IDENTIFIER ::=
526        { ciscoItpmMIBConform 1 }
527ciscoItpmMIBGroups      OBJECT IDENTIFIER ::=
528        { ciscoItpmMIBConform 2 }
529
530-- ********************************************************************
531-- Compliance Statements
532-- ********************************************************************
533ciscoItpmMIBCompliance MODULE-COMPLIANCE
534        STATUS deprecated -- replaced by ciscoItpmMIBComplianceRev1
535        DESCRIPTION
536            "The compliance statement for entities which implement
537             the CISCO-ITP-MONITOR-MIB.my MIB"
538        MODULE -- this module
539        MANDATORY-GROUPS {
540                           ciscoItpmConnGroup,
541                           ciscoItpmLinkGroup,
542                           ciscoItpmNotificationsGroup
543                         }
544
545        ::= { ciscoItpmMIBCompliances 1 }
546
547ciscoItpmMIBComplianceRev1 MODULE-COMPLIANCE
548        STATUS current
549        DESCRIPTION
550            "The compliance statement for entities which implement
551             the CISCO-ITP-MONITOR-MIB.my MIB"
552        MODULE -- this module
553        MANDATORY-GROUPS {
554                           ciscoItpmConnGroupRev1,
555                           ciscoItpmLinkGroup,
556                           ciscoItpmNotificationsGroupRev1
557                         }
558
559        ::= { ciscoItpmMIBCompliances 2 }
560
561-- ****************************************************************
562-- Units of Conformance
563-- ****************************************************************
564ciscoItpmConnGroup OBJECT-GROUP
565        OBJECTS { cItpmCongestionNotifEnabled,
566                  cItpmConnKeepAlive,
567                  cItpmConnMaxQDepth,
568                  cItpmConnCongOnset,
569                  cItpmConnCongAbate,
570                  cItpmConnRcvWindowSize,
571                  cItpmConnFastStart,
572                  cItpmConnQueueDepth,
573                  cItpmConnMonitorState,
574                  cItpmConnCongestion,
575                  cItpmConnCongCounts
576                 }
577        STATUS deprecated -- replaced by ciscoItpmConnGroupRev1
578        DESCRIPTION
579              "ITP Monitor connection group."
580        ::= { ciscoItpmMIBGroups 1 }
581
582ciscoItpmLinkGroup OBJECT-GROUP
583        OBJECTS { cItpmLinkDescription,
584                  cItpmLinkSlotNumber,
585                  cItpmLinkStatus,
586                  cItpmLinkRcvdMsus,
587                  cItpmLinkRcvdMsuDrops,
588                  cItpmLinkRcvdMsuRate,
589                  cItpmLinkRcvdBitsRate,
590                  cItpmLinkSentMsus,
591                  cItpmLinkSentMsuDrops,
592                  cItpmLinkSentMsuRate,
593                  cItpmLinkSentBitsRate
594                 }
595        STATUS current
596        DESCRIPTION
597              "ITP Monitor SS7 Link group"
598        ::= { ciscoItpmMIBGroups 2 }
599
600ciscoItpmNotificationsGroup NOTIFICATION-GROUP
601        NOTIFICATIONS { ciscoItpMonitorCongestion
602        }
603        STATUS deprecated
604        -- replaced by ciscoItpmNotificationsGroupRev1
605        DESCRIPTION
606                "ITP Monitor notification objects."
607        ::= { ciscoItpmMIBGroups 3 }
608
609ciscoItpmConnGroupRev1 OBJECT-GROUP
610        OBJECTS { cItpmCongestionNotifEnabled,
611                  cItpmMonitorStateNotifEnabled,
612                  cItpmConnKeepAlive,
613                  cItpmConnMaxQDepth,
614                  cItpmConnCongOnset,
615                  cItpmConnCongAbate,
616                  cItpmConnRcvWindowSize,
617                  cItpmConnFastStart,
618                  cItpmConnQueueDepth,
619                  cItpmConnMonitorState,
620                  cItpmConnCongestion,
621                  cItpmConnCongCounts
622                 }
623        STATUS current
624        DESCRIPTION
625              "ITP Monitor connection group"
626        ::= { ciscoItpmMIBGroups 4 }
627
628ciscoItpmNotificationsGroupRev1 NOTIFICATION-GROUP
629        NOTIFICATIONS { ciscoItpMonitorCongestion,
630                        ciscoItpMonitorState
631        }
632        STATUS current
633        DESCRIPTION
634                "ITP Monitor notification objects."
635        ::= { ciscoItpmMIBGroups 5 }
636END
637