Imported Upstream version 0.4.8
[platform/upstream/libsmi.git] / mibs / ietf / HCNUM-TC
1 HCNUM-TC DEFINITIONS ::= BEGIN
2
3 IMPORTS
4   MODULE-IDENTITY, mib-2, Counter64
5       FROM SNMPv2-SMI
6   TEXTUAL-CONVENTION
7       FROM SNMPv2-TC;
8
9 hcnumTC MODULE-IDENTITY
10   LAST-UPDATED "200006080000Z"
11
12
13   ORGANIZATION "IETF OPS Area"
14   CONTACT-INFO
15         "        E-mail: mibs@ops.ietf.org
16                  Subscribe: majordomo@psg.com
17                    with msg body: subscribe mibs
18
19                  Andy Bierman
20                  Cisco Systems Inc.
21                  170 West Tasman Drive
22                  San Jose, CA 95134 USA
23                  +1 408-527-3711
24                  abierman@cisco.com
25
26                  Keith McCloghrie
27                  Cisco Systems Inc.
28                  170 West Tasman Drive
29                  San Jose, CA 95134 USA
30                  +1 408-526-5260
31                  kzm@cisco.com
32
33                  Randy Presuhn
34                  BMC Software, Inc.
35                  Office 1-3141
36                  2141 North First Street
37                  San Jose,  California 95131 USA
38                  +1 408 546-1006
39                  rpresuhn@bmc.com"
40   DESCRIPTION
41         "A MIB module containing textual conventions
42          for high capacity data types. This module
43          addresses an immediate need for data types not directly
44          supported in the SMIv2. This short-term solution
45          is meant to be deprecated as a long-term solution
46          is deployed."
47   REVISION        "200006080000Z"
48   DESCRIPTION
49         "Initial Version of the High Capacity Numbers
50          MIB module, published as RFC 2856."
51   ::= { mib-2 78 }
52
53 CounterBasedGauge64 ::= TEXTUAL-CONVENTION
54   STATUS       current
55   DESCRIPTION
56         "The CounterBasedGauge64 type represents a non-negative
57         integer, which may increase or decrease, but shall never
58         exceed a maximum value, nor fall below a minimum value. The
59         maximum value can not be greater than 2^64-1
60         (18446744073709551615 decimal), and the minimum value can
61
62
63         not be smaller than 0.  The value of a CounterBasedGauge64
64         has its maximum value whenever the information being modeled
65         is greater than or equal to its maximum value, and has its
66         minimum value whenever the information being modeled is
67         smaller than or equal to its minimum value.  If the
68         information being modeled subsequently decreases below
69         (increases above) the maximum (minimum) value, the
70         CounterBasedGauge64 also decreases (increases).
71
72         Note that this TC is not strictly supported in SMIv2,
73         because the 'always increasing' and 'counter wrap' semantics
74         associated with the Counter64 base type are not preserved.
75         It is possible that management applications which rely
76         solely upon the (Counter64) ASN.1 tag to determine object
77         semantics will mistakenly operate upon objects of this type
78         as they would for Counter64 objects.
79
80         This textual convention represents a limited and short-term
81         solution, and may be deprecated as a long term solution is
82         defined and deployed to replace it."
83   SYNTAX Counter64
84
85
86 ZeroBasedCounter64 ::= TEXTUAL-CONVENTION
87   STATUS current
88   DESCRIPTION
89         "This TC describes an object which counts events with the
90         following semantics: objects of this type will be set to
91         zero(0) on creation and will thereafter count appropriate
92         events, wrapping back to zero(0) when the value 2^64 is
93         reached.
94
95         Provided that an application discovers the new object within
96         the minimum time to wrap it can use the initial value as a
97         delta since it last polled the table of which this object is
98         part.  It is important for a management station to be aware
99         of this minimum time and the actual time between polls, and
100         to discard data if the actual time is too long or there is
101         no defined minimum time.
102
103         Typically this TC is used in tables where the INDEX space is
104         constantly changing and/or the TimeFilter mechanism is in
105         use.
106
107         Note that this textual convention does not retain all the
108         semantics of the Counter64 base type. Specifically, a
109         Counter64 has an arbitrary initial value, but objects
110         defined with this TC are required to start at the value
111
112
113         zero.  This behavior is not likely to have any adverse
114         effects on management applications which are expecting
115         Counter64 semantics.
116
117         This textual convention represents a limited and short-term
118         solution, and may be deprecated as a long term solution is
119         defined and deployed to replace it."
120   SYNTAX Counter64
121
122 END