release/src/router/snmp/mibs/INET-ADDRESS-MIB.txt

   1 INET-ADDRESS-MIB DEFINITIONS ::= BEGIN
   2
   3 IMPORTS
   4     MODULE-IDENTITY, mib-2, Unsigned32 FROM SNMPv2-SMI
   5     TEXTUAL-CONVENTION                 FROM SNMPv2-TC;
   6
   7 inetAddressMIB MODULE-IDENTITY
   8     LAST-UPDATED "200205090000Z"
   9     ORGANIZATION
  10         "IETF Operations and Management Area"
  11     CONTACT-INFO
  12         "Juergen Schoenwaelder (Editor)
  13          TU Braunschweig
  14          Bueltenweg 74/75
  15          38106 Braunschweig, Germany
  16
  17          Phone: +49 531 391-3289
  18          EMail: schoenw@ibr.cs.tu-bs.de
  19
  20          Send comments to <mibs@ops.ietf.org>."
  21     DESCRIPTION
  22         "This MIB module defines textual conventions for
  23          representing Internet addresses. An Internet
  24          address can be an IPv4 address, an IPv6 address
  25          or a DNS domain name. This module also defines
  26          textual conventions for Internet port numbers,
  27          autonomous system numbers and the length of an
  28          Internet address prefix."
  29     REVISION     "200205090000Z"
  30     DESCRIPTION
  31         "Second version, published as RFC 3291. This
  32          revisions contains several clarifications and it
  33
  34          introduces several new textual conventions:
  35          InetAddressPrefixLength, InetPortNumber,
  36          InetAutonomousSystemNumber, InetAddressIPv4z,
  37          and InetAddressIPv6z."
  38     REVISION     "200006080000Z"
  39     DESCRIPTION
  40         "Initial version, published as RFC 2851."
  41     ::= { mib-2 76 }
  42
  43 InetAddressType ::= TEXTUAL-CONVENTION
  44     STATUS      current
  45     DESCRIPTION
  46         "A value that represents a type of Internet address.
  47          unknown(0)  An unknown address type. This value MUST
  48                      be used if the value of the corresponding
  49                      InetAddress object is a zero-length string.
  50                      It may also be used to indicate an IP address
  51                      which is not in one of the formats defined
  52                      below.
  53
  54          ipv4(1)     An IPv4 address as defined by the
  55                      InetAddressIPv4 textual convention.
  56
  57          ipv6(2)     A global IPv6 address as defined by the
  58                      InetAddressIPv6 textual convention.
  59
  60          ipv4z(3)    A non-global IPv4 address including a zone
  61                      index as defined by the InetAddressIPv4z
  62                      textual convention.
  63
  64          ipv6z(4)    A non-global IPv6 address including a zone
  65                      index as defined by the InetAddressIPv6z
  66                      textual convention.
  67
  68          dns(16)     A DNS domain name as defined by the
  69                      InetAddressDNS textual convention.
  70
  71          Each definition of a concrete InetAddressType value must be
  72          accompanied by a definition of a textual convention for use
  73          with that InetAddressType.
  74
  75          To support future extensions, the InetAddressType textual
  76          convention SHOULD NOT be sub-typed in object type definitions.
  77          It MAY be sub-typed in compliance statements in order to
  78          require only a subset of these address types for a compliant
  79          implementation.
  80
  81          Implementations must ensure that InetAddressType objects
  82
  83          and any dependent objects (e.g. InetAddress objects) are
  84          consistent.  An inconsistentValue error must be generated
  85          if an attempt to change an InetAddressType object would,
  86          for example, lead to an undefined InetAddress value.  In
  87          particular, InetAddressType/InetAddress pairs must be
  88          changed together if the address type changes (e.g. from
  89          ipv6(2) to ipv4(1))."
  90     SYNTAX      INTEGER {
  91                     unknown(0),
  92                     ipv4(1),
  93                     ipv6(2),
  94                     ipv4z(3),
  95                     ipv6z(4),
  96                     dns(16)
  97                 }
  98
  99 InetAddress ::= TEXTUAL-CONVENTION
 100     STATUS      current
 101     DESCRIPTION
 102         "Denotes a generic Internet address.
 103
 104          An InetAddress value is always interpreted within the context
 105          of an InetAddressType value. Every usage of the InetAddress
 106          textual convention is required to specify the InetAddressType
 107          object which provides the context.  It is suggested that the
 108          InetAddressType object is logically registered before the
 109          object(s) which use the InetAddress textual convention if
 110          they appear in the same logical row.
 111
 112          The value of an InetAddress object must always be
 113          consistent with the value of the associated InetAddressType
 114          object. Attempts to set an InetAddress object to a value
 115          which is inconsistent with the associated InetAddressType
 116          must fail with an inconsistentValue error.
 117
 118          When this textual convention is used as the syntax of an
 119          index object, there may be issues with the limit of 128
 120          sub-identifiers specified in SMIv2, STD 58. In this case,
 121          the object definition MUST include a 'SIZE' clause to
 122          limit the number of potential instance sub-identifiers."
 123     SYNTAX      OCTET STRING (SIZE (0..255))
 124
 125 InetAddressIPv4 ::= TEXTUAL-CONVENTION
 126     DISPLAY-HINT "1d.1d.1d.1d"
 127     STATUS       current
 128     DESCRIPTION
 129         "Represents an IPv4 network address:
 130
 131            octets   contents         encoding
 132             1-4     IPv4 address     network-byte order
 133
 134          The corresponding InetAddressType value is ipv4(1).
 135
 136          This textual convention SHOULD NOT be used directly in object
 137          definitions since it restricts addresses to a specific format.
 138          However, if it is used, it MAY be used either on its own or in
 139          conjunction with InetAddressType as a pair."
 140     SYNTAX       OCTET STRING (SIZE (4))
 141
 142 InetAddressIPv6 ::= TEXTUAL-CONVENTION
 143     DISPLAY-HINT "2x:2x:2x:2x:2x:2x:2x:2x"
 144     STATUS       current
 145     DESCRIPTION
 146         "Represents an IPv6 network address:
 147
 148            octets   contents         encoding
 149             1-16    IPv6 address     network-byte order
 150
 151          The corresponding InetAddressType value is ipv6(2).
 152
 153          This textual convention SHOULD NOT be used directly in object
 154          definitions since it restricts addresses to a specific format.
 155          However, if it is used, it MAY be used either on its own or in
 156          conjunction with InetAddressType as a pair."
 157     SYNTAX       OCTET STRING (SIZE (16))
 158
 159 InetAddressIPv4z ::= TEXTUAL-CONVENTION
 160     DISPLAY-HINT "1d.1d.1d.1d%4d"
 161     STATUS       current
 162     DESCRIPTION
 163         "Represents a non-global IPv4 network address together
 164          with its zone index:
 165
 166            octets   contents         encoding
 167             1-4     IPv4 address     network-byte order
 168             5-8     zone index       network-byte order
 169
 170          The corresponding InetAddressType value is ipv4z(3).
 171
 172          The zone index (bytes 5-8) is used to disambiguate identical
 173          address values on nodes which have interfaces attached to
 174          different zones of the same scope. The zone index may contain
 175          the special value 0 which refers to the default zone for each
 176          scope.
 177
 178          This textual convention SHOULD NOT be used directly in object
 179
 180          definitions since it restricts addresses to a specific format.
 181          However, if it is used, it MAY be used either on its own or in
 182          conjunction with InetAddressType as a pair."
 183     SYNTAX OCTET STRING (SIZE (8))
 184
 185 InetAddressIPv6z ::= TEXTUAL-CONVENTION
 186     DISPLAY-HINT "2x:2x:2x:2x:2x:2x:2x:2x%4d"
 187     STATUS       current
 188     DESCRIPTION
 189         "Represents a non-global IPv6 network address together
 190          with its zone index:
 191
 192            octets   contents         encoding
 193             1-16    IPv6 address     network-byte order
 194            17-20    zone index       network-byte order
 195
 196          The corresponding InetAddressType value is ipv6z(4).
 197
 198          The zone index (bytes 17-20) is used to disambiguate
 199          identical address values on nodes which have interfaces
 200          attached to different zones of the same scope. The zone index
 201          may contain the special value 0 which refers to the default
 202          zone for each scope.
 203
 204          This textual convention SHOULD NOT be used directly in object
 205          definitions since it restricts addresses to a specific format.
 206          However, if it is used, it MAY be used either on its own or in
 207          conjunction with InetAddressType as a pair."
 208     SYNTAX OCTET STRING (SIZE (20))
 209
 210 InetAddressDNS ::= TEXTUAL-CONVENTION
 211     DISPLAY-HINT "255a"
 212     STATUS       current
 213     DESCRIPTION
 214         "Represents a DNS domain name. The name SHOULD be fully
 215          qualified whenever possible.
 216
 217          The corresponding InetAddressType is dns(16).
 218
 219          The DESCRIPTION clause of InetAddress objects that may have
 220          InetAddressDNS values must fully describe how (and when) such
 221          names are to be resolved to IP addresses.
 222
 223          This textual convention SHOULD NOT be used directly in object
 224          definitions since it restricts addresses to a specific format.
 225          However, if it is used, it MAY be used either on its own or in
 226          conjunction with InetAddressType as a pair."
 227     SYNTAX       OCTET STRING (SIZE (1..255))
 228
 229 InetAddressPrefixLength ::= TEXTUAL-CONVENTION
 230     STATUS      current
 231     DESCRIPTION
 232         "Denotes the length of a generic Internet network address
 233          prefix. A value of n corresponds to an IP address mask
 234          which has n contiguous 1-bits from the most significant
 235          bit (MSB) and all other bits set to 0.
 236
 237          An InetAddressPrefixLength value is always interpreted within
 238          the context of an InetAddressType value. Every usage of the
 239          InetAddressPrefixLength textual convention is required to
 240          specify the InetAddressType object which provides the
 241          context.  It is suggested that the InetAddressType object is
 242          logically registered before the object(s) which use the
 243          InetAddressPrefixLength textual convention if they appear in
 244          the same logical row.
 245
 246          InetAddressPrefixLength values that are larger than
 247          the maximum length of an IP address for a specific
 248          InetAddressType are treated as the maximum significant
 249          value applicable for the InetAddressType. The maximum
 250          significant value is 32 for the InetAddressType
 251          'ipv4(1)' and 'ipv4z(3)' and 128 for the InetAddressType
 252          'ipv6(2)' and 'ipv6z(4)'. The maximum significant value
 253          for the InetAddressType 'dns(16)' is 0.
 254
 255          The value zero is object-specific and must be defined as
 256          part of the description of any object which uses this
 257          syntax. Examples of the usage of zero might include
 258          situations where the Internet network address prefix
 259          is unknown or does not apply."
 260     SYNTAX      Unsigned32
 261
 262 InetPortNumber ::= TEXTUAL-CONVENTION
 263     STATUS      current
 264     DESCRIPTION
 265         "Represents a 16 bit port number of an Internet transport
 266          layer protocol. Port numbers are assigned by IANA. A
 267          current list of all assignments is available from
 268          <http://www.iana.org/>.
 269
 270          The value zero is object-specific and must be defined as
 271          part of the description of any object which uses this
 272          syntax. Examples of the usage of zero might include
 273          situations where a port number is unknown, or when the
 274          value zero is used as a wildcard in a filter."
 275     REFERENCE  "STD 6 (RFC 768), STD 7 (RFC 793) and RFC 2960"
 276     SYNTAX      Unsigned32 (0..65535)
 277
 278 InetAutonomousSystemNumber ::= TEXTUAL-CONVENTION
 279     STATUS      current
 280     DESCRIPTION
 281         "Represents an autonomous system number which identifies an
 282          Autonomous System (AS). An AS is a set of routers under a
 283          single technical administration, using an interior gateway
 284          protocol and common metrics to route packets within the AS,
 285          and using an exterior gateway protocol to route packets to
 286          other ASs'. IANA maintains the AS number space and has
 287          delegated large parts to the regional registries.
 288
 289          Autonomous system numbers are currently limited to 16 bits
 290          (0..65535). There is however work in progress to enlarge the
 291          autonomous system number space to 32 bits. This textual
 292          convention therefore uses an Unsigned32 value without a
 293          range restriction in order to support a larger autonomous
 294          system number space."
 295     REFERENCE  "RFC 1771, RFC 1930"
 296     SYNTAX      Unsigned32
 297
 298 END