1-- ****************************************************************************
2--  COLUBRIS-TOOLS-MIB definitions
3--
4--  Copyright (c) 2004, Colubris Networks, Inc.
5--  All Rights Reserved.
6--
7--  Colubris Networks Tools MIB file.
8--
9-- ****************************************************************************
10
11
12COLUBRIS-TOOLS-MIB DEFINITIONS ::= BEGIN
13
14IMPORTS
15    MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE,
16    Unsigned32
17        FROM    SNMPv2-SMI
18    DisplayString
19        FROM    SNMPv2-TC
20    MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP
21        FROM    SNMPv2-CONF
22    InterfaceIndex
23        FROM    IF-MIB
24    colubrisMgmtV2
25        FROM    COLUBRIS-SMI
26    ColubrisNotificationEnable
27        FROM    COLUBRIS-TC
28;
29
30
31colubrisToolsMIB MODULE-IDENTITY
32    LAST-UPDATED    "200402200000Z"
33    ORGANIZATION    "Colubris Networks, Inc."
34    CONTACT-INFO    "Colubris Networks
35                     Postal: 200 West Street Ste 300
36                             Waltham, Massachusetts 02451-1121
37                             UNITED STATES
38                     Phone:  +1 781 684 0001
39                     Fax:    +1 781 684 0009
40
41                     E-mail: cn-snmp@colubris.com"
42    DESCRIPTION     "Colubris Networks Tools MIB module."
43
44    ::= { colubrisMgmtV2 12 }
45
46
47-- colubrisToolsMIBObjects definition
48colubrisToolsMIBObjects OBJECT IDENTIFIER ::= { colubrisToolsMIB 1 }
49
50-- IP Trace groups
51traceToolConfig OBJECT IDENTIFIER ::=  { colubrisToolsMIBObjects 1 }
52
53
54-- IP Trace configuration
55traceInterface OBJECT-TYPE
56    SYNTAX      InterfaceIndex
57    MAX-ACCESS  read-write
58    STATUS      current
59    DESCRIPTION "Specifies the interface to apply the trace to."
60    ::= { traceToolConfig 1 }
61
62traceCaptureDestination OBJECT-TYPE
63    SYNTAX      INTEGER
64                {
65                    local(1),
66                    remote(2)
67                }
68    MAX-ACCESS  read-write
69    STATUS      current
70    DESCRIPTION "Specifies if the traces shall be stored locally on the device
71                 or remotely on a distant system.
72
73                   'local': Stores the traces locally on the device.
74
75                   'remote': Stores the traces in a remote file specified
76                             by traceCaptureDestinationURL."
77    ::= { traceToolConfig 2 }
78
79traceCaptureDestinationURL OBJECT-TYPE
80    SYNTAX      DisplayString
81    MAX-ACCESS  read-write
82    STATUS      current
83    DESCRIPTION "Specifies the URL of the file that trace data will be sent to.
84                 If a valid URL is not defined, the trace data cannot be sent
85                 and will be discarded."
86    ::= { traceToolConfig 3 }
87
88traceTimeout OBJECT-TYPE
89    SYNTAX      Unsigned32 (0..99999)
90    UNITS       "seconds"
91    MAX-ACCESS  read-write
92    STATUS      current
93    DESCRIPTION "Specifies the amount of time the trace will capture data.
94                 Once this limit is reached, the trace automatically stops."
95    DEFVAL      { 600 }
96    ::= { traceToolConfig 4 }
97
98traceNumberOfPackets OBJECT-TYPE
99    SYNTAX      Unsigned32 (0..99999)
100    UNITS       "packets"
101    MAX-ACCESS  read-write
102    STATUS      current
103    DESCRIPTION "Specifies the maximum number of packets (IP datagrams) the
104                 trace should capture. Once this limit is reached, the trace
105                 automatically stops."
106    DEFVAL      { 100 }
107    ::= { traceToolConfig 5 }
108
109tracePacketSize OBJECT-TYPE
110    SYNTAX      Unsigned32 (68..4096)
111    UNITS       "bytes"
112    MAX-ACCESS  read-write
113    STATUS      current
114    DESCRIPTION "Specifies the maximum number of bytes to capture for each
115                 packet. The remaining data is discarded."
116    DEFVAL      { 128 }
117    ::= { traceToolConfig 6 }
118
119traceCaptureFilter OBJECT-TYPE
120    SYNTAX      DisplayString
121    MAX-ACCESS  read-write
122    STATUS      current
123    DESCRIPTION "Specifies the packet filter to use to capture data.
124                 The filter expression has the same format and behavior
125                 as the expression parameter used by the well-known
126                 TCPDUMP command."
127    ::= { traceToolConfig 7 }
128
129traceCaptureStatus OBJECT-TYPE
130    SYNTAX      INTEGER
131                {
132                    stop(1),
133                    start(2)
134                }
135    MAX-ACCESS  read-write
136    STATUS      current
137    DESCRIPTION "IP Trace tool action trigger.
138
139                   'stop': Stops the trace tool from functioning. If any
140                           capture was previously started it will end up.
141                           if no capture was started, 'stop' has no effect.
142
143                   'start': Starts to capture the packets following the
144                            critera specified in the management tool and
145                            in this MIB."
146    DEFVAL      { stop }
147    ::= { traceToolConfig 8 }
148
149traceNotificationEnabled OBJECT-TYPE
150    SYNTAX      ColubrisNotificationEnable
151    MAX-ACCESS  read-write
152    STATUS      current
153    DESCRIPTION "Specifies if IP trace notifications are generated."
154    DEFVAL      { disable }
155    ::= { traceToolConfig 9 }
156
157
158-- IP trace notifications
159colubrisToolsMIBNotificationPrefix OBJECT IDENTIFIER ::= { colubrisToolsMIB 2 }
160colubrisToolsMIBNotifications OBJECT IDENTIFIER ::= { colubrisToolsMIBNotificationPrefix 0 }
161
162traceStatusNotification NOTIFICATION-TYPE
163    OBJECTS     {
164                    traceCaptureStatus
165                }
166    STATUS      current
167    DESCRIPTION "Sent when the user triggers the IP Trace tool either by starting
168                 a new trace or stopping an existing session."
169  --#SUMMARY "IP Trace status trap: %d"
170  --#ARGUMENTS { 0 }
171  --#SEVERITY INFORMATIONAL
172  --#CATEGORY "Colubris Networks Alarms"
173    ::= { colubrisToolsMIBNotifications 1 }
174
175
176-- conformance information
177colubrisToolsMIBConformance OBJECT IDENTIFIER ::= { colubrisToolsMIB 3 }
178colubrisToolsMIBCompliances OBJECT IDENTIFIER ::= { colubrisToolsMIBConformance 1 }
179colubrisToolsMIBGroups      OBJECT IDENTIFIER ::= { colubrisToolsMIBConformance 2 }
180
181-- compliance statements
182colubrisToolsMIBCompliance MODULE-COMPLIANCE
183    STATUS      current
184    DESCRIPTION "The compliance statement for entities which implement
185                 the Colubris Networks Tools MIB."
186    MODULE      MANDATORY-GROUPS
187                    {
188                        colubrisToolsMIBGroup,
189                        colubrisToolsNotificationGroup
190                    }
191    ::= { colubrisToolsMIBCompliances 1 }
192
193-- units of conformance
194colubrisToolsMIBGroup OBJECT-GROUP
195    OBJECTS     {
196		    traceInterface,
197                    traceCaptureDestination,
198                    traceCaptureDestinationURL,
199		    traceTimeout,
200		    traceNumberOfPackets,
201		    tracePacketSize,
202                    traceCaptureFilter,
203                    traceCaptureStatus,
204                    traceNotificationEnabled
205                }
206    STATUS      current
207    DESCRIPTION "A collection of objects providing the Tools MIB capability."
208    ::= { colubrisToolsMIBGroups 1 }
209
210colubrisToolsNotificationGroup NOTIFICATION-GROUP
211    NOTIFICATIONS   {
212                        traceStatusNotification
213                    }
214    STATUS      current
215    DESCRIPTION "A collection of supported notifications."
216    ::= { colubrisToolsMIBGroups 2 }
217
218END
219