1-- *****************************************************************
2-- CISCO-SNMP-TARGET-EXT-MIB.my
3--
4-- Cisco Extension to SNMP-TARGET-MIB (RFC 3413)
5--
6-- April 2004, Radhika Dharwadkar, Sanjeev C Joshi
7--
8-- Copyright (c) 2004, 2007, 2008 by cisco Systems Inc.
9-- All rights reserved.
10--
11-- ****************************************************************
12
13CISCO-SNMP-TARGET-EXT-MIB DEFINITIONS ::= BEGIN
14
15IMPORTS
16    MODULE-IDENTITY,
17    OBJECT-TYPE
18        FROM SNMPv2-SMI
19    MODULE-COMPLIANCE,
20    OBJECT-GROUP
21        FROM SNMPv2-CONF
22    InterfaceIndexOrZero
23        FROM IF-MIB
24    InetAddressType,
25    InetAddress
26        FROM INET-ADDRESS-MIB
27    RowStatus,
28    StorageType,
29    TruthValue
30        FROM SNMPv2-TC
31    SnmpAdminString
32        FROM SNMP-FRAMEWORK-MIB
33    snmpTargetAddrEntry,
34    snmpTargetAddrName
35        FROM SNMP-TARGET-MIB
36    ciscoMgmt
37        FROM CISCO-SMI;
38
39
40ciscoSnmpTargetExtMIB MODULE-IDENTITY
41    LAST-UPDATED    "200811070000Z"
42    ORGANIZATION    "Cisco Systems, Inc."
43    CONTACT-INFO
44            "Cisco Systems
45            Customer Service
46
47            Postal: 170 W. Tasman Drive
48            San Jose, CA 95134
49            USA
50
51            Tel: +1 800 553-NETS
52
53            E-mail: cs-snmp@cisco.com"
54    DESCRIPTION
55        "This MIB is an extension of the SNMP-TARGET-MIB
56        specified in RFC3413.
57
58        This MIB module contains  Cisco-defined  extension
59        to the snmpTargetAddrTable to represent information
60        required for IPv6 Address.
61
62        When Target has Link local or Multicast IPv6 address,
63        the information of the interface on which the
64        notification has to be sent is required. This
65        additional information is provided by this extension
66        MIB.
67
68        This module also contains definition for set of new
69        variable to hold the address of the host that had
70        sent an unauthentic SNMP message to agent.
71
72        Glossary of the terms used in this MIB:
73        --------------------------------------
74
75        VRF - Virtual Routing and Forwarding. An IP technology  that
76              allows multiple instances of routing table to exist
77              in a system and work simultaneously. A VRF consists of
78              an IP routing table, a forwarding table, a set of
79              interfaces that use the forwarding table, and a set of
80              rules and routing protocol parameters that control
81              the information that is included into the routing
82              table."
83    REVISION        "200811070000Z"
84    DESCRIPTION
85        "-Added 'cExtSnmpNotifGblTrapSrcIfIndex' and
86          'cExtSnmpNotifGblInformSrcIfIndex' for supporting source
87          interface configuration for the SNMP notifications.
88
89         -Added OBJECT-GROUP 'ciscoSnmpTargetNotifSrcIntGroup' and
90          MODULE-COMPLIANCE 'ciscoSnmpTargetExtMIBComplianceRev2'."
91
92    REVISION        "200708200000Z"
93    DESCRIPTION
94        "Added the following to support management of VRF based
95        reachability and filtering for SNMP targets:
96
97         - cExtSnmpTargetVrfTable for VRF related configuration
98           of SNMP targets."
99    REVISION        "200404010000Z"
100    DESCRIPTION
101        "Initial version of this MIB module."
102    ::= { ciscoMgmt 412 }
103
104
105ciscoSnmpTargetExtMIBObjects  OBJECT IDENTIFIER
106    ::= { ciscoSnmpTargetExtMIB 1 }
107
108-- Scalar variables
109
110cExtSnmpTargetAuthAddr  OBJECT IDENTIFIER
111    ::= { ciscoSnmpTargetExtMIBObjects 1 }
112
113
114cExtSnmpTargetAuthInetType OBJECT-TYPE
115    SYNTAX          InetAddressType
116    MAX-ACCESS      read-only
117    STATUS          current
118    DESCRIPTION
119        "This contains the type of address
120        cExtSnmpTargetAuthInetAddr holds when a host sends an
121        unauthentic SNMP message."
122    ::= { cExtSnmpTargetAuthAddr 1 }
123
124cExtSnmpTargetAuthInetAddr OBJECT-TYPE
125    SYNTAX          InetAddress
126    MAX-ACCESS      read-only
127    STATUS          current
128    DESCRIPTION
129        "This contains the address of the host from which
130        snmp-agent has received a SNMP message that is not
131        authentic."
132    ::= { cExtSnmpTargetAuthAddr 2 }
133-- cExtSnmpTargetAddrTable
134
135cExtSnmpTargetAddrTable OBJECT-TYPE
136    SYNTAX          SEQUENCE OF CExtSnmpTargetAddrEntry
137    MAX-ACCESS      not-accessible
138    STATUS          current
139    DESCRIPTION
140        "The cExtSnmpTargetAddrTable extends
141        the SNMP-TARGET-MIB's snmpTargetAddrTable for providing
142        info on the type of interface for Link Local or Multicast
143        IPv6 Target Address."
144    REFERENCE       "RFC2737: Section 4.1"
145    ::= { ciscoSnmpTargetExtMIBObjects 2 }
146
147cExtSnmpTargetAddrEntry OBJECT-TYPE
148    SYNTAX          CExtSnmpTargetAddrEntry
149    MAX-ACCESS      not-accessible
150    STATUS          current
151    DESCRIPTION
152        "A cExtSnmpTargetAddrTable entry extends
153        snmpTargetAddrTable to provide a new variable
154        to hold the value of interface type.
155
156        A target which has a link local or a multicast
157        address the variable of this table is valid.
158        Entries are removed when the corresponding entry in the
159        snmpTargetAddrTable is removed."
160    AUGMENTS           { snmpTargetAddrEntry  }
161
162    ::= { cExtSnmpTargetAddrTable 1 }
163
164CExtSnmpTargetAddrEntry ::= SEQUENCE {
165        cExtSnmpTargetAddrIntIfIndex InterfaceIndexOrZero
166}
167
168cExtSnmpTargetAddrIntIfIndex OBJECT-TYPE
169    SYNTAX          InterfaceIndexOrZero
170    MAX-ACCESS      read-write
171    STATUS          current
172    DESCRIPTION
173        "Holds valid ifIndex value of the interface through
174        which the notifications for the target with
175        Multicast/Link local address specified in the
176        snmpTargetAddrTAddress, is sent.
177
178        If snmpTargetAddrTAddress doesn't hold a Linklocal or
179        a Multicast target address then the value of this
180        object will be zero.
181
182        For the entries with snmpTargetAddrTAddress having
183        Link Local or Multicast address the
184        snmpTargetAddrStatus cannot be set to valid unless the
185        value for this object holds a valid ifIndex value."
186    ::= { cExtSnmpTargetAddrEntry 1 }
187
188
189-- VRF related configuration for SNMP targets
190
191cExtSnmpTargetVrfTable OBJECT-TYPE
192    SYNTAX          SEQUENCE OF CExtSnmpTargetVrfEntry
193    MAX-ACCESS      not-accessible
194    STATUS          current
195    DESCRIPTION
196        "The cExtSnmpTargetVrfTable extends the snmpTargetAddrTable
197        of the SNMP-TARGET-MIB for providing:
198
199           - VRF reachability criterion for the SNMP target
200           - VRF filtering criterion for the SNMP target
201
202        This table is indexed by the target entity
203        snmpTargetAddrName and the associated VRF name
204        cExtSnmpTargetVrfName. Each entry of this table forms a
205        tuple of target and VRF name for which all the VRF related
206        configuration parameters can be specified by corresponding
207        instances of the columnar objects.
208
209        The reachability of the SNMP target is qualified by the
210        routing context by way of associating VRF Name(s) with it.
211        Restricting only those SNMP notifications that are generated
212        within the context of a VRF to a specific SNMP target is
213        VRF based filtering of notifications.
214
215        A row in this table cannot be created prior to the creation
216        of row it extends."
217    REFERENCE
218        "D. Levi, P. Meyer and B. Stewart, Section 4.1 'The
219         Management Target MIB Module', RFC-3413, December 2002."
220    ::= { ciscoSnmpTargetExtMIBObjects 3 }
221
222cExtSnmpTargetVrfEntry OBJECT-TYPE
223    SYNTAX          CExtSnmpTargetVrfEntry
224    MAX-ACCESS      not-accessible
225    STATUS          current
226    DESCRIPTION
227        "An entry (conceptual row) in the cExtSnmpTargetVrfTable.
228
229        When an entry in the snmpTargetAddrTable is deleted the
230        corresponding entries in this table are also deleted.
231
232        A row needs to exist in the cExtSnmpTargetVrfTable for
233        each VRF for which SNMP notifications are to be sent to
234        a particular target address, so that when the same
235        target address is the destination for multiple VRFs,
236        then multiple rows in this table will reference the same
237        target address. However, only one of such multiple rows
238        can be used for routing the SNMP notifications to that
239        target address, i.e., only one of them can have an
240        instance of cExtSnmpTargetVrfRoute with the value 'true'.
241        Thus, any management operation which sets an instance of
242        cExtSnmpTargetVrfRoute to 'true' must also have the
243        effect of setting any other instance of
244        cExtSnmpTargetVrfRoute for the same target address to
245        'false'."
246    INDEX           {
247                        snmpTargetAddrName,
248                        cExtSnmpTargetVrfName
249                    }
250    ::= { cExtSnmpTargetVrfTable 1 }
251
252CExtSnmpTargetVrfEntry ::= SEQUENCE {
253        cExtSnmpTargetVrfName    SnmpAdminString,
254        cExtSnmpTargetVrfRoute   TruthValue,
255        cExtSnmpTargetVrfFilter  TruthValue,
256        cExtSnmpTargetVrfStorage StorageType,
257        cExtSnmpTargetVrfStatus  RowStatus
258}
259
260cExtSnmpTargetVrfName OBJECT-TYPE
261    SYNTAX          SnmpAdminString (SIZE  (1..32))
262    MAX-ACCESS      not-accessible
263    STATUS          current
264    DESCRIPTION
265        "This object identifies a human readable string representing
266        the name of the VRF."
267    ::= { cExtSnmpTargetVrfEntry 1 }
268
269cExtSnmpTargetVrfRoute OBJECT-TYPE
270    SYNTAX          TruthValue
271    MAX-ACCESS      read-create
272    STATUS          current
273    DESCRIPTION
274        "This object specifies whether this VRF (identified by the
275        corresponding instance identifier of cExtSnmpTargetVrfName)
276        should be used for routing the SNMP notifications
277        sent to this target address specified in the value of
278        the corresponding instance of snmpTargetAddrTAddress.
279
280        The value 'true' indicates that this VRF should be used.
281
282        The value 'false' indicates that this VRF should not be
283        used."
284    DEFVAL          { false }
285    ::= { cExtSnmpTargetVrfEntry 2 }
286
287cExtSnmpTargetVrfFilter OBJECT-TYPE
288    SYNTAX          TruthValue
289    MAX-ACCESS      read-create
290    STATUS          current
291    DESCRIPTION
292        "This object specifies whether SNMP notifications generated
293        in this VRF (identified by the corresponding instance
294        identifier of cExtSnmpTargetVrfName) context should be sent
295        to this target address specified in the value of the
296        corresponding instance of snmpTargetAddrTAddress.
297
298        By default, the notifications generated in any of the VRFs
299        are allowed to be sent to the configured targets. Setting
300        the value of this object to 'true' defines 'inclusive'
301        filtering policy to allow notifications of a specific VRF
302        while excluding notifications of all other VRFs.
303
304        The value 'true' indicates that the notifications of this
305        VRF should be sent.
306
307        The value 'false' indicates that the notifications of this
308        VRF should not be sent."
309    DEFVAL          { true }
310    ::= { cExtSnmpTargetVrfEntry 3 }
311
312cExtSnmpTargetVrfStorage OBJECT-TYPE
313    SYNTAX          StorageType
314    MAX-ACCESS      read-create
315    STATUS          current
316    DESCRIPTION
317        "The storage type for this conceptual row.
318
319        When the value of an instance of this object is 'permanent',
320        the value of the corresponding instance of all the other
321        objects of this table except cExtSnmpTargetVrfStatus are
322        read-writable. The 'permanent' rows can not be deleted by
323        setting value of the corresponding instance of
324        cExtSnmpTargetVrfStatus to 'destroy'."
325    DEFVAL          { nonVolatile }
326    ::= { cExtSnmpTargetVrfEntry 4 }
327
328cExtSnmpTargetVrfStatus OBJECT-TYPE
329    SYNTAX          RowStatus
330    MAX-ACCESS      read-create
331    STATUS          current
332    DESCRIPTION
333        "The status of this conceptual row.
334
335        There are no specific restrictions for setting the value
336        of this object to 'active'. Once the value of this object
337        is set to 'active', the value of the corresponding instance
338        of all other objects of this table can still be modified."
339    ::= { cExtSnmpTargetVrfEntry 5 }
340
341cExtSnmpNotifGblTrapSrcIfIndex OBJECT-TYPE
342    SYNTAX      InterfaceIndexOrZero
343    MAX-ACCESS  read-write
344    STATUS      current
345    DESCRIPTION
346        "This object specifies the ifIdex value of the source
347        interface to be used for sending TRAP notifications.
348
349        The value of this object should be a valid 'ifIndex' value.
350
351        This is a global configuration applied for all TRAP
352        notifications sent by this agent to all the targets. If the
353        source interface is configured for a specific target using
354        the value of corresponding instance of
355        'cExtSnmpTargetAddrIntIfIndex', then that value takes
356        precedence and will be used for sending the notification.
357
358        The value of this object being 'zero' implies that there is
359        no source interface configuration for the TRAP
360        notifications at a global level."
361    ::= { ciscoSnmpTargetExtMIBObjects 4}
362
363cExtSnmpNotifGblInformSrcIfIndex OBJECT-TYPE
364    SYNTAX      InterfaceIndexOrZero
365    MAX-ACCESS  read-write
366    STATUS      current
367    DESCRIPTION
368        "This object specifies the ifIdex value of the source
369        interface to be used for sending INFORM notifications.
370
371        The value of this object should be a valid 'ifIndex' value.
372
373        This is a global configuration applied for all INFORM
374        notifications sent by this agent to all the targets. If the
375        source interface is configured for a specific target using
376        the value of corresponding instance of
377        'cExtSnmpTargetAddrIntIfIndex', then that value takes
378        precedence and will be used for sending the notification.
379
380        The value of this object being 'zero' implies that there is
381        no source interface configuration for the INFORM
382        notifications at a global level."
383    ::= { ciscoSnmpTargetExtMIBObjects 5}
384
385-- Conformance information
386
387ciscoSnmpTargetExtMIBConformance  OBJECT IDENTIFIER
388    ::= { ciscoSnmpTargetExtMIB 2 }
389
390ciscoSnmpTargetExtMIBCompliances  OBJECT IDENTIFIER
391    ::= { ciscoSnmpTargetExtMIBConformance 1 }
392
393ciscoSnmpTargetExtMIBGroups  OBJECT IDENTIFIER
394    ::= { ciscoSnmpTargetExtMIBConformance 2 }
395
396
397-- compliance statements
398
399ciscoSnmpTargetExtMIBCompliance MODULE-COMPLIANCE
400    STATUS          deprecated
401    DESCRIPTION
402        "Compliance for IPv6 address supported by
403        snmpTargetAddrTAddress for Link-Local or Multicast and
404        for holding the recent host address that sent an
405        unauthentic SNMP message in cExtSnmpTargetAuthInetAddr
406        and cExtSnmpTargetAuthInetType."
407    MODULE          -- this module
408    MANDATORY-GROUPS { ciscoSnmpTargetExtMIBGroup }
409
410    GROUP           ciscoSnmpTargetAuthFailureGroup
411    DESCRIPTION
412        "The ciscoSnmpTargetAuthFailureGroup is an optional group
413        containing objects that provide information about the
414        host that has sent a packet which is not authentic."
415    ::= { ciscoSnmpTargetExtMIBCompliances 1 }
416
417ciscoSnmpTargetExtMIBComplianceRev1 MODULE-COMPLIANCE
418    STATUS          deprecated  -- superseded by
419                                -- ciscoSnmpTargetExtMIBComplianceRev2
420    DESCRIPTION
421        "The compliance statement for entities which implement
422        the CISCO-SNMP-TARGET-EXT-MIB."
423    MODULE          -- this module
424    MANDATORY-GROUPS { ciscoSnmpTargetExtMIBGroup }
425
426    GROUP           ciscoSnmpTargetAuthFailureGroup
427    DESCRIPTION
428        "The ciscoSnmpTargetAuthFailureGroup is an optional group
429        containing objects that provide information about the
430        host that has sent a packet which is not authentic."
431
432    GROUP           ciscoSnmpTargetExtVrfMIBGroup
433    DESCRIPTION
434        "This group is conditionally mandatory and must be
435        implemented by the agent of the managed entity only
436        if the implementation supports VRF based reachability
437        and filtering for SNMP targets."
438
439    OBJECT          cExtSnmpTargetVrfStatus
440    SYNTAX          INTEGER  {
441                        active(1),
442                        createAndGo(4),
443                        destroy(6)
444                    }
445    DESCRIPTION
446        "Only 'createAndGo', 'destroy' and 'active' need to
447        be supported."
448    ::= { ciscoSnmpTargetExtMIBCompliances 2 }
449
450
451ciscoSnmpTargetExtMIBComplianceRev2 MODULE-COMPLIANCE
452    STATUS          current
453    DESCRIPTION
454        "The compliance statement for entities which implement
455        the CISCO-SNMP-TARGET-EXT-MIB."
456    MODULE          -- this module
457    MANDATORY-GROUPS { ciscoSnmpTargetExtMIBGroup }
458
459    GROUP           ciscoSnmpTargetAuthFailureGroup
460    DESCRIPTION
461        "The ciscoSnmpTargetAuthFailureGroup is an optional group
462        containing objects that provide information about the
463        host that has sent a packet which is not authentic."
464
465
466    GROUP           ciscoSnmpTargetExtVrfMIBGroup
467    DESCRIPTION
468        "This group is conditionally mandatory and must be
469        implemented by the agent of the managed entity only
470        if the implementation supports VRF based reachability
471        and filtering for SNMP targets."
472
473    OBJECT          cExtSnmpTargetVrfStatus
474    SYNTAX          INTEGER  {
475                        active(1),
476                        createAndGo(4),
477                        destroy(6)
478                    }
479    DESCRIPTION
480        "Only 'createAndGo', 'destroy' and 'active' need to
481        be supported."
482
483    GROUP           ciscoSnmpTargetNotifSrcIntGroup
484    DESCRIPTION
485        "This group is conditionally mandatory and must be
486         implemented by the agent of the managed entity only
487         if the implementation supports source interface
488         configuration globally for all the notifications."
489    ::= { ciscoSnmpTargetExtMIBCompliances 3 }
490
491-- units of conformance
492
493ciscoSnmpTargetAuthFailureGroup OBJECT-GROUP
494    OBJECTS         {
495                        cExtSnmpTargetAuthInetType,
496                        cExtSnmpTargetAuthInetAddr
497                    }
498    STATUS          current
499    DESCRIPTION
500        "The collection of objects which gives information about
501        the recent host that has sent a SNMP message to the agent
502        that is not authentic."
503    ::= { ciscoSnmpTargetExtMIBGroups 1 }
504
505ciscoSnmpTargetExtMIBGroup OBJECT-GROUP
506    OBJECTS         { cExtSnmpTargetAddrIntIfIndex }
507    STATUS          current
508    DESCRIPTION
509        "The collection of objects which give information about
510        the interface through which the notifications are sent
511        out for IPv6 Link-local and Multicast Target address."
512    ::= { ciscoSnmpTargetExtMIBGroups 2 }
513
514ciscoSnmpTargetExtVrfMIBGroup OBJECT-GROUP
515    OBJECTS         {
516                        cExtSnmpTargetVrfRoute,
517                        cExtSnmpTargetVrfFilter,
518                        cExtSnmpTargetVrfStorage,
519                        cExtSnmpTargetVrfStatus
520                    }
521    STATUS          current
522    DESCRIPTION
523        "The collection of objects for supporting VRF based
524        configuration for the SNMP targets."
525    ::= { ciscoSnmpTargetExtMIBGroups 3 }
526
527ciscoSnmpTargetNotifSrcIntGroup OBJECT-GROUP
528    OBJECTS         {
529                        cExtSnmpNotifGblTrapSrcIfIndex,
530                        cExtSnmpNotifGblInformSrcIfIndex
531                    }
532    STATUS          current
533    DESCRIPTION
534        "The collection of objects which give information about
535         the interface through which SNMP TRAP and INFORM
536         notifications are sent for all target addresses globally."
537    ::= { ciscoSnmpTargetExtMIBGroups 4}
538END
539
540
541