1INET-ADDRESS-MIB(7) MIB INET-ADDRESS-MIB(7)
2INET-ADDRESS-MIB DEFINITIONS ::= BEGIN
6IMPORTS
8 MODULE-IDENTITY, mib-2, Unsigned32 FROM SNMPv2-SMI
9 TEXTUAL-CONVENTION FROM SNMPv2-TC;
10inetAddressMIB MODULE-IDENTITY
12 LAST-UPDATED "200502040000Z"
13 ORGANIZATION
14 "IETF Operations and Management Area"
15 CONTACT-INFO
16 "Juergen Schoenwaelder (Editor)
17 International University Bremen
18 P.O. Box 750 561
19 28725 Bremen, Germany
20 Phone: +49 421 200-3587
22 EMail: j.schoenwaelder@iu-bremen.de
23 Send comments to <ietfmibs@ops.ietf.org>."
25 DESCRIPTION
26 "This MIB module defines textual conventions for
27 representing Internet addresses. An Internet
28 address can be an IPv4 address, an IPv6 address,
29 or a DNS domain name. This module also defines
30 textual conventions for Internet port numbers,
31 autonomous system numbers, and the length of an
32 Internet address prefix.
33 Copyright (C) The Internet Society (2005). This version
35 of this MIB module is part of RFC 4001, see the RFC
36 itself for full legal notices."
37 REVISION "200502040000Z"
38 DESCRIPTION
39 "Third version, published as RFC 4001. This revision
40 introduces the InetZoneIndex, InetScopeType, and
41 InetVersion textual conventions."
42 REVISION "200205090000Z"
43 DESCRIPTION
44 "Second version, published as RFC 3291. This
45 revision contains several clarifications and
46 introduces several new textual conventions:
47 InetAddressPrefixLength, InetPortNumber,
48 InetAutonomousSystemNumber, InetAddressIPv4z,
49 and InetAddressIPv6z."
50 REVISION "200006080000Z"
51 DESCRIPTION
52 "Initial version, published as RFC 2851."
53 ::= { mib-2 76 }
54InetAddressType ::= TEXTUAL-CONVENTION
56 STATUS current
57 DESCRIPTION
58 "A value that represents a type of Internet address.
59 unknown(0) An unknown address type. This value MUST
61 be used if the value of the corresponding
62 InetAddress object is a zero-length string.
63 It may also be used to indicate an IP address
64 that is not in one of the formats defined
65 below.
66 ipv4(1) An IPv4 address as defined by the
68 InetAddressIPv4 textual convention.
69 ipv6(2) An IPv6 address as defined by the
71 InetAddressIPv6 textual convention.
72 ipv4z(3) A non-global IPv4 address including a zone
74 index as defined by the InetAddressIPv4z
75 textual convention.
76 ipv6z(4) A non-global IPv6 address including a zone
78 index as defined by the InetAddressIPv6z
79 textual convention.
80 dns(16) A DNS domain name as defined by the
82 InetAddressDNS textual convention.
83 Each definition of a concrete InetAddressType value must be
85 accompanied by a definition of a textual convention for use
86 with that InetAddressType.
87 To support future extensions, the InetAddressType textual
89 convention SHOULD NOT be sub-typed in object type definitions.
90 It MAY be sub-typed in compliance statements in order to
91 require only a subset of these address types for a compliant
92 implementation.
93 Implementations must ensure that InetAddressType objects
95 and any dependent objects (e.g., InetAddress objects) are
96 consistent. An inconsistentValue error must be generated
97 if an attempt to change an InetAddressType object would,
98 for example, lead to an undefined InetAddress value. In
99 particular, InetAddressType/InetAddress pairs must be
101 changed together if the address type changes (e.g., from
102 ipv6(2) to ipv4(1))."
103 SYNTAX INTEGER {
104 unknown(0),
105 ipv4(1),
106 ipv6(2),
107 ipv4z(3),
108 ipv6z(4),
109 dns(16)
110 }
111InetAddress ::= TEXTUAL-CONVENTION
113 STATUS current
114 DESCRIPTION
115 "Denotes a generic Internet address.
116 An InetAddress value is always interpreted within the context
118 of an InetAddressType value. Every usage of the InetAddress
119 textual convention is required to specify the InetAddressType
120 object that provides the context. It is suggested that the
121 InetAddressType object be logically registered before the
122 object(s) that use the InetAddress textual convention, if
123 they appear in the same logical row.
124 The value of an InetAddress object must always be
126 consistent with the value of the associated InetAddressType
127 object. Attempts to set an InetAddress object to a value
128 inconsistent with the associated InetAddressType
129 must fail with an inconsistentValue error.
130 When this textual convention is used as the syntax of an
132 index object, there may be issues with the limit of 128
133 sub-identifiers specified in SMIv2, STD 58. In this case,
134 the object definition MUST include a 'SIZE' clause to
135 limit the number of potential instance sub-identifiers;
136 otherwise the applicable constraints MUST be stated in
137 the appropriate conceptual row DESCRIPTION clauses, or
138 in the surrounding documentation if there is no single
139 DESCRIPTION clause that is appropriate."
140 SYNTAX OCTET STRING (SIZE (0..255))
141InetAddressIPv4 ::= TEXTUAL-CONVENTION
143 DISPLAY-HINT "1d.1d.1d.1d"
144 STATUS current
145 DESCRIPTION
146 "Represents an IPv4 network address:
147 Octets Contents Encoding
149 1-4 IPv4 address network-byte order
150 The corresponding InetAddressType value is ipv4(1).
152 This textual convention SHOULD NOT be used directly in object
154 definitions, as 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 (4))
158InetAddressIPv6 ::= TEXTUAL-CONVENTION
160 DISPLAY-HINT "2x:2x:2x:2x:2x:2x:2x:2x"
161 STATUS current
162 DESCRIPTION
163 "Represents an IPv6 network address:
164 Octets Contents Encoding
166 1-16 IPv6 address network-byte order
167 The corresponding InetAddressType value is ipv6(2).
169 This textual convention SHOULD NOT be used directly in object
171 definitions, as it restricts addresses to a specific format.
172 However, if it is used, it MAY be used either on its own or in
173 conjunction with InetAddressType, as a pair."
174 SYNTAX OCTET STRING (SIZE (16))
175InetAddressIPv4z ::= TEXTUAL-CONVENTION
177 DISPLAY-HINT "1d.1d.1d.1d%4d"
178 STATUS current
179 DESCRIPTION
180 "Represents a non-global IPv4 network address, together
181 with its zone index:
182 Octets Contents Encoding
184 1-4 IPv4 address network-byte order
185 5-8 zone index network-byte order
186 The corresponding InetAddressType value is ipv4z(3).
188 The zone index (bytes 5-8) is used to disambiguate identical
190 address values on nodes that have interfaces attached to
191 different zones of the same scope. The zone index may contain
192 the special value 0, which refers to the default zone for each
193 scope.
194 This textual convention SHOULD NOT be used directly in object
196 definitions, as it restricts addresses to a specific format.
198 However, if it is used, it MAY be used either on its own or in
199 conjunction with InetAddressType, as a pair."
200 SYNTAX OCTET STRING (SIZE (8))
201InetAddressIPv6z ::= TEXTUAL-CONVENTION
203 DISPLAY-HINT "2x:2x:2x:2x:2x:2x:2x:2x%4d"
204 STATUS current
205 DESCRIPTION
206 "Represents a non-global IPv6 network address, together
207 with its zone index:
208 Octets Contents Encoding
210 1-16 IPv6 address network-byte order
211 17-20 zone index network-byte order
212 The corresponding InetAddressType value is ipv6z(4).
214 The zone index (bytes 17-20) is used to disambiguate
216 identical address values on nodes that have interfaces
217 attached to different zones of the same scope. The zone index
218 may contain the special value 0, which refers to the default
219 zone for each scope.
220 This textual convention SHOULD NOT be used directly in object
222 definitions, as it restricts addresses to a specific format.
223 However, if it is used, it MAY be used either on its own or in
224 conjunction with InetAddressType, as a pair."
225 SYNTAX OCTET STRING (SIZE (20))
226InetAddressDNS ::= TEXTUAL-CONVENTION
228 DISPLAY-HINT "255a"
229 STATUS current
230 DESCRIPTION
231 "Represents a DNS domain name. The name SHOULD be fully
232 qualified whenever possible.
233 The corresponding InetAddressType is dns(16).
235 The DESCRIPTION clause of InetAddress objects that may have
237 InetAddressDNS values MUST fully describe how (and when)
238 these names are to be resolved to IP addresses.
239 The resolution of an InetAddressDNS value may require to
241 query multiple DNS records (e.g., A for IPv4 and AAAA for
242 IPv6). The order of the resolution process and which DNS
243 record takes precedence depends on the configuration of the
244 resolver.
245 This textual convention SHOULD NOT be used directly in object
247 definitions, as it restricts addresses to a specific format.
248 However, if it is used, it MAY be used either on its own or in
249 conjunction with InetAddressType, as a pair."
250 SYNTAX OCTET STRING (SIZE (1..255))
251InetAddressPrefixLength ::= TEXTUAL-CONVENTION
253 DISPLAY-HINT "d"
254 STATUS current
255 DESCRIPTION
256 "Denotes the length of a generic Internet network address
257 prefix. A value of n corresponds to an IP address mask
258 that has n contiguous 1-bits from the most significant
259 bit (MSB), with all other bits set to 0.
260 An InetAddressPrefixLength value is always interpreted within
262 the context of an InetAddressType value. Every usage of the
263 InetAddressPrefixLength textual convention is required to
264 specify the InetAddressType object that provides the
265 context. It is suggested that the InetAddressType object be
266 logically registered before the object(s) that use the
267 InetAddressPrefixLength textual convention, if they appear
268 in the same logical row.
269 InetAddressPrefixLength values larger than
271 the maximum length of an IP address for a specific
272 InetAddressType are treated as the maximum significant
273 value applicable for the InetAddressType. The maximum
274 significant value is 32 for the InetAddressType
275 'ipv4(1)' and 'ipv4z(3)' and 128 for the InetAddressType
276 'ipv6(2)' and 'ipv6z(4)'. The maximum significant value
277 for the InetAddressType 'dns(16)' is 0.
278 The value zero is object-specific and must be defined as
280 part of the description of any object that uses this
281 syntax. Examples of the usage of zero might include
282 situations where the Internet network address prefix
283 is unknown or does not apply.
284 The upper bound of the prefix length has been chosen to
286 be consistent with the maximum size of an InetAddress."
287 SYNTAX Unsigned32 (0..2040)
288InetPortNumber ::= TEXTUAL-CONVENTION
290 DISPLAY-HINT "d"
291 STATUS current
292 DESCRIPTION
293 "Represents a 16 bit port number of an Internet transport
294 layer protocol. Port numbers are assigned by IANA. A
296 current list of all assignments is available from
297 <http://www.iana.org/>.
298 The value zero is object-specific and must be defined as
300 part of the description of any object that uses this
301 syntax. Examples of the usage of zero might include
302 situations where a port number is unknown, or when the
303 value zero is used as a wildcard in a filter."
304 REFERENCE "STD 6 (RFC 768), STD 7 (RFC 793) and RFC 2960"
305 SYNTAX Unsigned32 (0..65535)
306InetAutonomousSystemNumber ::= TEXTUAL-CONVENTION
308 DISPLAY-HINT "d"
309 STATUS current
310 DESCRIPTION
311 "Represents an autonomous system number that identifies an
312 Autonomous System (AS). An AS is a set of routers under a
313 single technical administration, using an interior gateway
314 protocol and common metrics to route packets within the AS,
315 and using an exterior gateway protocol to route packets to
316 other ASes'. IANA maintains the AS number space and has
317 delegated large parts to the regional registries.
318 Autonomous system numbers are currently limited to 16 bits
320 (0..65535). There is, however, work in progress to enlarge the
321 autonomous system number space to 32 bits. Therefore, this
322 textual convention uses an Unsigned32 value without a
323 range restriction in order to support a larger autonomous
324 system number space."
325 REFERENCE "RFC 1771, RFC 1930"
326 SYNTAX Unsigned32
327InetScopeType ::= TEXTUAL-CONVENTION
329 STATUS current
330 DESCRIPTION
331 "Represents a scope type. This textual convention can be used
332 in cases where a MIB has to represent different scope types
333 and there is no context information, such as an InetAddress
334 object, that implicitly defines the scope type.
335 Note that not all possible values have been assigned yet, but
337 they may be assigned in future revisions of this specification.
338 Applications should therefore be able to deal with values
339 not yet assigned."
340 REFERENCE "RFC 3513"
341 SYNTAX INTEGER {
342 -- reserved(0),
343 interfaceLocal(1),
344 linkLocal(2),
345 subnetLocal(3),
346 adminLocal(4),
347 siteLocal(5), -- site-local unicast addresses
348 -- have been deprecated by RFC 3879
349 -- unassigned(6),
350 -- unassigned(7),
351 organizationLocal(8),
352 -- unassigned(9),
353 -- unassigned(10),
354 -- unassigned(11),
355 -- unassigned(12),
356 -- unassigned(13),
357 global(14)
358 -- reserved(15)
359 }
360InetZoneIndex ::= TEXTUAL-CONVENTION
362 DISPLAY-HINT "d"
363 STATUS current
364 DESCRIPTION
365 "A zone index identifies an instance of a zone of a
366 specific scope.
367 The zone index MUST disambiguate identical address
369 values. For link-local addresses, the zone index will
370 typically be the interface index (ifIndex as defined in the
371 IF-MIB) of the interface on which the address is configured.
372 The zone index may contain the special value 0, which refers
374 to the default zone. The default zone may be used in cases
375 where the valid zone index is not known (e.g., when a
376 management application has to write a link-local IPv6
377 address without knowing the interface index value). The
378 default zone SHOULD NOT be used as an easy way out in
379 cases where the zone index for a non-global IPv6 address
380 is known."
381 REFERENCE "RFC4007"
382 SYNTAX Unsigned32
383InetVersion ::= TEXTUAL-CONVENTION
385 STATUS current
386 DESCRIPTION
387 "A value representing a version of the IP protocol.
388 unknown(0) An unknown or unspecified version of the IP
390 protocol.
391 ipv4(1) The IPv4 protocol as defined in RFC 791 (STD 5).
393 ipv6(2) The IPv6 protocol as defined in RFC 2460.
395 Note that this textual convention SHOULD NOT be used to
397 distinguish different address types associated with IP
398 protocols. The InetAddressType has been designed for this
399 purpose."
400 REFERENCE "RFC 791, RFC 2460"
401 SYNTAX INTEGER {
402 unknown(0),
403 ipv4(1),
404 ipv6(2)
405 }
406END
407Erlang/OTP SNMP INET-ADDRESS-MIB(7)