userapps/opensource/net-snmp/mibs/NET-SNMP-EXAMPLES-MIB.txt

   1 NET-SNMP-EXAMPLES-MIB DEFINITIONS ::= BEGIN
   2
   3 --
   4 -- Example MIB objects for agent module example implementations
   5 --
   6
   7 IMPORTS
   8     MODULE-IDENTITY, OBJECT-TYPE, Integer32 FROM SNMPv2-SMI
   9     netSnmp                                 FROM NET-SNMP-MIB;
  10
  11 netSnmpExamples MODULE-IDENTITY
  12     LAST-UPDATED "200202060000Z"
  13     ORGANIZATION "www.net-snmp.org"
  14     CONTACT-INFO
  15          "postal:   Wes Hardaker
  16                     P.O. Box 382
  17                     Davis CA  95617
  18
  19           email:    net-snmp-coders@lists.sourceforge.net"
  20     DESCRIPTION
  21         "Example MIB objects for agent module example implementations"
  22     REVISION     "200202060000Z"
  23     DESCRIPTION
  24         "First draft"
  25     ::= { netSnmp 2 }
  26
  27 --
  28 -- top level structure
  29 --
  30 netSnmpExampleScalars       OBJECT IDENTIFIER ::= { netSnmpExamples 1 }
  31 netSnmpExampleTables        OBJECT IDENTIFIER ::= { netSnmpExamples 2 }
  32 netSnmpExampleNotifications OBJECT IDENTIFIER ::= { netSnmpExamples 3 }
  33 -- netSnmpTutorial          OBJECT IDENTIFIER ::= { netSnmpExamples 4 }
  34
  35 --
  36 -- Example scalars
  37 --
  38
  39 netSnmpExampleInteger OBJECT-TYPE
  40     SYNTAX      Integer32
  41     MAX-ACCESS  read-write
  42     STATUS      current
  43     DESCRIPTION
  44         "This is a simple object which merely houses a writable
  45          integer.  It's only purposes is to hold the value of a single
  46          integer.  Writing to it will simply change the value for
  47          subsequent GET/GETNEXT/GETBULK retrievals.
  48
  49          This example object is implemented in the
  50          agent/mibgroup/examples/scalar_int.c file."
  51     DEFVAL { 42 }
  52     ::= { netSnmpExampleScalars 1 }
  53
  54 netSnmpExampleSleeper OBJECT-TYPE
  55     SYNTAX      Integer32
  56     MAX-ACCESS  read-write
  57     STATUS      current
  58     DESCRIPTION
  59         "This is a simple object which is a basic integer.  It's value
  60          indicates the number of seconds that the agent will take in
  61          responding to requests of this object.  This is implemented
  62          in a way which will allow the agent to keep responding to
  63          other requests while access to this object is blocked.  It is
  64          writable, and changing it's value will change the amount of
  65          time the agent will effectively wait for before returning a
  66          response when this object is manipulated.  Note that SET
  67          requests through this object will take longer, since the
  68          delay is applied to each internal transaction phase, which
  69          could result in delays of up to 4 times the value of this
  70          object.
  71
  72          This example object is implemented in the
  73          agent/mibgroup/examples/delayed_instance.c file."
  74     DEFVAL { 1 }
  75     ::= { netSnmpExampleScalars 2 }
  76
  77
  78 --
  79 --  Example Tables
  80 --
  81
  82 netSnmpIETFWGTable OBJECT-TYPE
  83     SYNTAX      SEQUENCE OF NetSnmpIETFWGEntry
  84     MAX-ACCESS  not-accessible
  85     STATUS      current
  86     DESCRIPTION
  87         "This table merely contains a set of data which is otherwise
  88          useless for true network management.  It is a table which
  89          describes properies about a IETF Working Group, such as the
  90          names of the two working group chairs.
  91
  92          This example table is implemented in the
  93          agent/mibgroup/examples/data_set.c file."
  94     ::= { netSnmpExampleTables 1 }
  95
  96 netSnmpIETFWGEntry OBJECT-TYPE
  97     SYNTAX      NetSnmpIETFWGEntry
  98     MAX-ACCESS  not-accessible
  99     STATUS      current
 100     DESCRIPTION
 101         "A rowm describing a given working group"
 102     INDEX   { nsIETFWGName }
 103     ::= {netSnmpIETFWGTable 1 }
 104
 105 NetSnmpIETFWGEntry ::= SEQUENCE {
 106         nsIETFWGName    OCTET STRING,
 107         nsIETFWGChair1  OCTET STRING,
 108         nsIETFWGChair2  OCTET STRING
 109 }
 110
 111 nsIETFWGName OBJECT-TYPE
 112     SYNTAX      OCTET STRING (SIZE(1..32))
 113     MAX-ACCESS  not-accessible
 114     STATUS      current
 115     DESCRIPTION
 116         "The name of the IETF Working Group this table describes."
 117     ::= { netSnmpIETFWGEntry 1 }
 118
 119 nsIETFWGChair1 OBJECT-TYPE
 120     SYNTAX      OCTET STRING
 121     MAX-ACCESS  read-create
 122     STATUS      current
 123     DESCRIPTION
 124         "One of the names of the chairs for the IETF working group."
 125     ::= { netSnmpIETFWGEntry 2 }
 126
 127 nsIETFWGChair2 OBJECT-TYPE
 128     SYNTAX      OCTET STRING
 129     MAX-ACCESS  read-create
 130     STATUS      current
 131     DESCRIPTION
 132         "The other name, if one exists, of the chairs for the IETF
 133         working group."
 134     ::= { netSnmpIETFWGEntry 3 }
 135
 136 --
 137 --  Example Notifications
 138 --
 139
 140 netSnmpExampleNotification OBJECT-TYPE
 141     SYNTAX      SnmpAdminString
 142     MAX-ACCESS  accessible-for-notify
 143     STATUS      current
 144     DESCRIPTION
 145         "This is a boring example that is used in the
 146          agent/mibgroup/examples/notification.c to send out a
 147          notification every 30 seconds.  The actual notification means
 148          nothing other than 30 seconds has elapsed since the last time
 149          one was sent."
 150 ::= { netSnmpExampleNotifications 1 }
 151
 152 END