Imported Upstream version 0.4.8
[platform/upstream/libsmi.git] / mibs / ietf / HPR-IP-MIB
1 HPR-IP-MIB DEFINITIONS ::= BEGIN
2
3 IMPORTS
4         MODULE-IDENTITY,OBJECT-TYPE, Counter32
5                     FROM SNMPv2-SMI
6         DisplayString, RowStatus, TEXTUAL-CONVENTION
7                     FROM SNMPv2-TC
8         MODULE-COMPLIANCE, OBJECT-GROUP
9                     FROM SNMPv2-CONF
10         SnaControlPointName
11                     FROM APPN-MIB
12         hprObjects, hprCompliances, hprGroups
13                     FROM HPR-MIB  ;
14
15 hprIp   MODULE-IDENTITY
16    LAST-UPDATED "9809240000Z" -- September 24, 1998
17    ORGANIZATION "IETF SNA NAU MIB WG / AIW APPN MIBs SIG"
18    CONTACT-INFO
19        "
20                Bob Clouston
21                Cisco Systems
22                7025 Kit Creek Road
23                P.O. Box 14987
24                Research Triangle Park, NC 27709, USA
25                Tel:    1 919 472 2333
26                E-mail: clouston@cisco.com
27
28                Bob Moore
29                IBM Corporation
30                4205 S. Miami Boulevard
31                BRQA/501
32                P.O. Box 12195
33                Research Triangle Park, NC 27709, USA
34                Tel:    1 919 254 4436
35                E-mail: remoore@us.ibm.com
36        "
37    DESCRIPTION
38        "The MIB module for HPR over IP.  This module contains two
39        groups:
40
41         -  the HPR over IP Monitoring Group provides a count of the UDP
42            packets sent by a link station for each APPN traffic type.
43
44         -  the HPR over IP Configuration Group provides for reading and
45            setting the mappings between APPN traffic types and TOS
46            Precedence settings in the IP header.  These mappings are
47            configured at the APPN port level, and are inherited by the
48            APPN connection networks and link stations associated with an
49            APPN port.  A port-level mapping can, however, be overridden
50            for a particular connection network or link station."
51    REVISION  "9809240000Z" -- September 24, 1998
52    DESCRIPTION
53        "Initial version, Published as RFC 2584"
54
55    ::= { hprObjects 5 }
56
57 -- *********************************************************************
58 -- Textual Conventions
59 -- *********************************************************************
60 AppnTrafficType ::= TEXTUAL-CONVENTION
61       STATUS current
62       DESCRIPTION
63           "APPN traffic type.  The first four values correspond
64           to APPN transmission priorities (network, high, medium and
65           low), while the fifth is used for both LLC commands (XID,
66           TEST, DISC, and DM) and function-routed NLPs (XID_DONE_RQ
67           and XID_DONE_RSP)."
68
69       SYNTAX INTEGER { low (1),
70                        medium (2),
71                        high (3),
72                        network (4),
73                        llcAndFnRoutedNlp (5) }
74
75 AppnTOSPrecedence ::= TEXTUAL-CONVENTION
76       STATUS current
77       DESCRIPTION
78           "A DisplayString representing the setting of the three TOS
79           Precedence bits in the IP Type of Service field for this APPN
80           traffic type.  The HPR over IP architecture specifies the
81           following default mapping:
82
83                APPN traffic type           IP TOS Precedence bits
84                ------------------          ----------------------
85                 Network                     110
86                 High                        100
87                 Medium                      010
88                 Low                         001
89                 LLC commands, etc.          110
90           "
91
92       SYNTAX DisplayString (SIZE(3))
93
94 -- *******************************************************************
95
96 -- hprObjects              OBJECT IDENTIFIER ::= { hprMIB 1 }
97 -- *******************************************************************
98
99 -- *******************************************************************
100 -- HPR over IP Monitoring Group
101 --
102 -- This group contains a single table, the hprIsActiveLsTable,
103 -- providing a  count of UDP packets sent with each type of
104 -- APPN traffic on each active link supporting HPR over IP.
105 -- *******************************************************************
106 hprIpActiveLsTable OBJECT-TYPE
107       SYNTAX SEQUENCE OF HprIpActiveLsEntry
108       MAX-ACCESS not-accessible
109       STATUS current
110       DESCRIPTION
111           "The HPR/IP active link station table.  This table provides
112           counts of the number of UDP packets sent for each APPN
113           traffic type."
114
115       ::= { hprIp 1 }
116
117 hprIpActiveLsEntry OBJECT-TYPE
118       SYNTAX HprIpActiveLsEntry
119       MAX-ACCESS not-accessible
120       STATUS current
121       DESCRIPTION
122           "Entry of the HPR/IP link station table."
123
124       INDEX { hprIpActiveLsLsName,
125               hprIpActiveLsAppnTrafficType }
126
127       ::= { hprIpActiveLsTable 1 }
128
129 HprIpActiveLsEntry ::= SEQUENCE {
130         hprIpActiveLsLsName              DisplayString,
131         hprIpActiveLsAppnTrafficType     AppnTrafficType,
132         hprIpActiveLsUdpPackets          Counter32 }
133
134 hprIpActiveLsLsName OBJECT-TYPE
135       SYNTAX DisplayString (SIZE (1..10))
136       MAX-ACCESS not-accessible
137       STATUS current
138       DESCRIPTION
139           "Administratively assigned name for the link station.  If this
140           object has the same value as the appnLsName in the APPN MIB,
141           then the two objects are referring to the same APPN link
142           station."
143       ::= { hprIpActiveLsEntry 1 }
144
145 hprIpActiveLsAppnTrafficType OBJECT-TYPE
146       SYNTAX AppnTrafficType
147       MAX-ACCESS not-accessible
148       STATUS current
149       DESCRIPTION
150           "APPN traffic type being sent through the link station."
151
152       ::= { hprIpActiveLsEntry 2 }
153
154 hprIpActiveLsUdpPackets OBJECT-TYPE
155       SYNTAX Counter32
156       MAX-ACCESS read-only
157       STATUS current
158       DESCRIPTION
159           "The count of outgoing UDP packets carrying this type of APPN
160           traffic.  A discontinuity in the counter is indicated by the
161           appnLsCounterDisconTime object in the APPN MIB."
162
163       ::= { hprIpActiveLsEntry 3 }
164
165
166 -- *******************************************************************
167 -- HPR over IP Configuration Group
168 --
169 -- This group contains three tables for reading and setting the
170 -- mapping between APPN traffic types and values for the TOS
171 -- Precedence bits in the IP header.  hprIpAppnPortTOSPrecedence
172 -- represents the APPN port-level mapping.  This mapping can be
173 -- overridden for an individual link station or an individual
174 -- connection network via, respectively, the hprIpLsTOSPrecedence
175 -- and the hprIpCnTOSPrecedence objects.
176 -- *******************************************************************
177
178 hprIpAppnPortTable OBJECT-TYPE
179       SYNTAX SEQUENCE OF HprIpAppnPortEntry
180       MAX-ACCESS not-accessible
181       STATUS current
182       DESCRIPTION
183           "The HPR/IP APPN port table.  This table supports reading and
184           setting the mapping between APPN traffic types and TOS
185           Precedence settings for all the link stations at this APPN
186           port.  This mapping can be overridden for an individual link
187           station or an individual connection network via, respectively,
188           the hprIpLsTOSPrecedence and the hprIpCnTOSPrecedence objects."
189
190       ::= { hprIp 2 }
191
192 hprIpAppnPortEntry OBJECT-TYPE
193       SYNTAX HprIpAppnPortEntry
194       MAX-ACCESS not-accessible
195       STATUS current
196       DESCRIPTION
197           "Entry of the HPR/IP APPN port table.  Entries exist for
198           every APPN port defined to support HPR over IP."
199
200       INDEX { hprIpAppnPortName,
201               hprIpAppnPortAppnTrafficType }
202
203       ::= { hprIpAppnPortTable 1 }
204
205 HprIpAppnPortEntry ::= SEQUENCE {
206         hprIpAppnPortName            DisplayString,
207         hprIpAppnPortAppnTrafficType AppnTrafficType,
208         hprIpAppnPortTOSPrecedence   AppnTOSPrecedence }
209
210 hprIpAppnPortName OBJECT-TYPE
211       SYNTAX DisplayString (SIZE (1..10))
212       MAX-ACCESS not-accessible
213       STATUS current
214       DESCRIPTION
215           "Administratively assigned name for this APPN port.  If this
216           object has the same value as the appnPortName in the APPN MIB,
217           then the two objects are referring to the same APPN port."
218
219       ::= { hprIpAppnPortEntry 1 }
220
221 hprIpAppnPortAppnTrafficType OBJECT-TYPE
222       SYNTAX AppnTrafficType
223       MAX-ACCESS not-accessible
224       STATUS current
225       DESCRIPTION
226           "APPN traffic type sent through the port."
227
228       ::= { hprIpAppnPortEntry 2 }
229
230 hprIpAppnPortTOSPrecedence OBJECT-TYPE
231       SYNTAX AppnTOSPrecedence
232       MAX-ACCESS read-write
233       STATUS current
234       DESCRIPTION
235           "A setting for the three TOS Precedence bits in the IP Type of
236           Service field for this APPN traffic type.
237
238           When this value is changed via a Set operation, the new setting
239           for the TOS Precedence bits takes effect immediately, rather
240           than waiting for some event such as reinitialization of the
241           port or of the APPN node itself."
242
243       ::= { hprIpAppnPortEntry 3 }
244
245
246 -- *******************************************************************
247 hprIpLsTable OBJECT-TYPE
248       SYNTAX SEQUENCE OF HprIpLsEntry
249       MAX-ACCESS not-accessible
250       STATUS current
251       DESCRIPTION
252           "The HPR/IP link station table.  Values for TOS Precedence at
253           the link station level override those at the level of the
254           containing port.  If there is no entry in this table for a
255           given link station, then that link station inherits its TOS
256           Precedence values from its port."
257
258       ::= { hprIp 3 }
259
260 hprIpLsEntry OBJECT-TYPE
261       SYNTAX HprIpLsEntry
262       MAX-ACCESS not-accessible
263       STATUS current
264       DESCRIPTION
265           "Entry of the HPR/IP link station table."
266
267       INDEX { hprIpLsLsName,
268               hprIpLsAppnTrafficType }
269
270       ::= { hprIpLsTable 1 }
271
272 HprIpLsEntry ::= SEQUENCE {
273         hprIpLsLsName            DisplayString,
274         hprIpLsAppnTrafficType   AppnTrafficType,
275         hprIpLsTOSPrecedence     AppnTOSPrecedence,
276         hprIpLsRowStatus         RowStatus }
277
278 hprIpLsLsName OBJECT-TYPE
279       SYNTAX DisplayString (SIZE (1..10))
280       MAX-ACCESS not-accessible
281       STATUS current
282       DESCRIPTION
283           "Administratively assigned name for the link station.  If this
284           object has the same value as the appnLsName in the APPN MIB,
285           then the two objects are referring to the same APPN link
286           station."
287       ::= { hprIpLsEntry 1 }
288
289 hprIpLsAppnTrafficType OBJECT-TYPE
290       SYNTAX AppnTrafficType
291       MAX-ACCESS not-accessible
292       STATUS current
293       DESCRIPTION
294           "APPN traffic type sent through the link station."
295
296       ::= { hprIpLsEntry 2 }
297
298 hprIpLsTOSPrecedence OBJECT-TYPE
299       SYNTAX AppnTOSPrecedence
300       MAX-ACCESS read-create
301       STATUS current
302       DESCRIPTION
303           "A setting for the three TOS Precedence bits in the IP Type of
304           Service field for this APPN traffic type.
305
306           When this value is changed via a Set operation, the new setting
307           for the TOS Precedence bits takes effect immediately, rather
308           than waiting for some event such as reinitialization of the
309           port or of the APPN node itself."
310
311       ::= { hprIpLsEntry 3 }
312
313 hprIpLsRowStatus OBJECT-TYPE
314       SYNTAX RowStatus
315       MAX-ACCESS read-create
316       STATUS current
317       DESCRIPTION
318           "This object allows entries to be created and deleted in the
319           hprIpLsTable.  As soon as an entry becomes active, the mapping
320           between APPN traffic types and TOS Precedence settings that it
321           specifies becomes effective.
322
323           The value of the other accessible object in this entry,
324           hprIpLsTOSPrecedence, can be changed via a Set operation when
325           this object's value is active(1).
326
327           An entry in this table is deleted by setting this object to
328           destroy(6).  Deleting an entry in this table causes the
329           link station to revert to the default TOS Precedence
330           mapping for its port."
331
332       ::= { hprIpLsEntry 4 }
333
334 -- *******************************************************************
335 hprIpCnTable OBJECT-TYPE
336       SYNTAX SEQUENCE OF HprIpCnEntry
337       MAX-ACCESS not-accessible
338       STATUS current
339       DESCRIPTION
340           "The HPR/IP connection network table.  Values for TOS
341           Precedence at the connection network level override those at
342           the level of the containing port.  If there is no entry in
343           this table for a given connection network, then that
344           connection network inherits its TOS Precedence values from
345           its port.
346
347           A node may have connections to a given connection network
348           through multiple ports.  There is no provision in the HPR-IP
349           architecture for variations in TOS Precedence values for
350           a single connection network based on the port through which
351           traffic is flowing to the connection network.  Thus an entry
352           in this table overrides the port-level settings for all the
353           ports through which the node can reach the connection
354           network."
355
356       ::= { hprIp 4 }
357
358 hprIpCnEntry OBJECT-TYPE
359       SYNTAX HprIpCnEntry
360       MAX-ACCESS not-accessible
361       STATUS current
362       DESCRIPTION
363           "Entry of the HPR/IP connection network table."
364
365       INDEX { hprIpCnVrnName,
366               hprIpCnAppnTrafficType }
367
368       ::= { hprIpCnTable 1 }
369
370 HprIpCnEntry ::= SEQUENCE {
371         hprIpCnVrnName           SnaControlPointName,
372         hprIpCnAppnTrafficType   AppnTrafficType,
373         hprIpCnTOSPrecedence     AppnTOSPrecedence,
374         hprIpCnRowStatus         RowStatus }
375
376 hprIpCnVrnName OBJECT-TYPE
377       SYNTAX SnaControlPointName
378       MAX-ACCESS not-accessible
379       STATUS current
380       DESCRIPTION
381           "SNA control point name of the virtual routing node (VRN) that
382           identifies the connection network in the APPN topology
383           database.  If this object has the same value as the appnVrnName
384           in the APPN MIB, then the two objects are referring
385           to the same APPN VRN."
386
387       ::= { hprIpCnEntry 1 }
388
389 hprIpCnAppnTrafficType OBJECT-TYPE
390       SYNTAX AppnTrafficType
391       MAX-ACCESS not-accessible
392       STATUS current
393       DESCRIPTION
394           "APPN traffic type sent to this connection network."
395
396       ::= { hprIpCnEntry 2 }
397
398 hprIpCnTOSPrecedence OBJECT-TYPE
399       SYNTAX AppnTOSPrecedence
400       MAX-ACCESS read-create
401       STATUS current
402       DESCRIPTION
403           "A setting for the three TOS Precedence bits in the IP Type of
404           Service field for this APPN traffic type.  This setting applies
405           to all traffic sent to this connection network by this node,
406           regardless of the port through which the traffic is sent.
407
408           When this value is changed via a Set operation, the new setting
409           for the TOS Precedence bits takes effect immediately, rather
410           than waiting for some event such as reinitialization of a
411           port or of the APPN node itself."
412       ::= { hprIpCnEntry 3 }
413
414 hprIpCnRowStatus OBJECT-TYPE
415       SYNTAX RowStatus
416       MAX-ACCESS read-create
417       STATUS current
418       DESCRIPTION
419           "This object allows entries to be created and deleted in the
420           hprIpCnTable.  As soon as an entry becomes active, the mapping
421           between APPN traffic types and TOS Precedence settings that it
422           specifies becomes effective.
423
424           The value of the other accessible object in this entry,
425           hprIpCnTOSPrecedence, can be changed via a Set operation when
426           this object's value is active(1).
427
428           An entry in this table is deleted by setting this object to
429           destroy(6).  Deleting an entry in this table causes the
430           connection network to revert to the default TOS Precedence
431           mapping for each port through which it is accessed."
432
433       ::= { hprIpCnEntry 4 }
434
435
436 -- *******************************************************************
437 -- Conformance Statement
438 -- *******************************************************************
439 -- Definitions imported from the HPR MIB:
440 --   hprConformance      OBJECT IDENTIFIER ::= { hprMIB 2 }
441 --   hprCompliances      OBJECT IDENTIFIER ::= { hprConformance 1 }
442 --   hprGroups           OBJECT IDENTIFIER ::= { hprConformance 2 }
443
444 -- Compliance statements
445 hprIpCompliance MODULE-COMPLIANCE
446        STATUS current
447        DESCRIPTION
448       "Compliance statement for the HPR over IP MIB module."
449    MODULE   -- this module
450
451    --  Conditionally mandatory groups
452    GROUP hprIpMonitoringGroup
453       DESCRIPTION
454           "The hprIpMonitoringGroup is mandatory for APPN implementations
455           supporting HPR over IP."
456
457    GROUP hprIpConfigurationGroup
458       DESCRIPTION
459           "The hprIpConfigurationGroup is mandatory for APPN
460           implementations supporting HPR over IP.  It may, however,
461           be implemented as a collection of read-only objects."
462
463    OBJECT hprIpAppnPortTOSPrecedence
464    MIN-ACCESS  read-only
465       DESCRIPTION
466           "Write access is not required."
467
468    OBJECT hprIpLsTOSPrecedence
469    MIN-ACCESS  read-only
470       DESCRIPTION
471           "Write access is not required."
472
473    OBJECT hprIpLsRowStatus
474    MIN-ACCESS  read-only
475       DESCRIPTION
476           "Write access is not required."
477    OBJECT hprIpCnTOSPrecedence
478    MIN-ACCESS  read-only
479       DESCRIPTION
480           "Write access is not required."
481
482    OBJECT hprIpCnRowStatus
483    MIN-ACCESS  read-only
484       DESCRIPTION
485           "Write access is not required."
486
487 ::= { hprCompliances 2 }
488
489 -- Group definitions
490
491 hprIpMonitoringGroup OBJECT-GROUP
492       OBJECTS { hprIpActiveLsUdpPackets }
493       STATUS current
494       DESCRIPTION
495           "An object for counting outgoing HPR/IP traffic for each APPN
496           traffic type."
497
498 ::= { hprGroups 5 }
499
500 hprIpConfigurationGroup OBJECT-GROUP
501       OBJECTS { hprIpAppnPortTOSPrecedence,
502                 hprIpLsTOSPrecedence,
503                 hprIpLsRowStatus,
504                 hprIpCnTOSPrecedence,
505                 hprIpCnRowStatus }
506       STATUS current
507       DESCRIPTION
508           "A collection of HPR/IP objects representing the mappings
509           between APPN traffic types and TOS Precedence bits at the APPN
510           port, APPN link station, and APPN connection network levels."
511
512 ::= { hprGroups 6 }
513
514 END