| 1 |
<pre>Network Working Group M. Daniele |
| 2 |
Request for Comments: 4001 SyAM Software, Inc. |
| 3 |
Obsoletes: <a href="./rfc3291">3291</a> B. Haberman |
| 4 |
Category: Standards Track Johns Hopkins University |
| 5 |
S. Routhier |
| 6 |
Wind River Systems, Inc. |
| 7 |
J. Schoenwaelder |
| 8 |
International University Bremen |
| 9 |
February 2005 |
| 10 |
|
| 11 |
|
| 12 |
<span class="h1">Textual Conventions for Internet Network Addresses</span> |
| 13 |
|
| 14 |
Status of This Memo |
| 15 |
|
| 16 |
This document specifies an Internet standards track protocol for the |
| 17 |
Internet community, and requests discussion and suggestions for |
| 18 |
improvements. Please refer to the current edition of the "Internet |
| 19 |
Official Protocol Standards" (STD 1) for the standardization state |
| 20 |
and status of this protocol. Distribution of this memo is unlimited. |
| 21 |
|
| 22 |
Copyright Notice |
| 23 |
|
| 24 |
Copyright (C) The Internet Society (2005). |
| 25 |
|
| 26 |
Abstract |
| 27 |
|
| 28 |
This MIB module defines textual conventions to represent commonly |
| 29 |
used Internet network layer addressing information. The intent is |
| 30 |
that these textual conventions will be imported and used in MIB |
| 31 |
modules that would otherwise define their own representations. |
| 32 |
|
| 33 |
|
| 34 |
|
| 35 |
|
| 36 |
|
| 37 |
|
| 38 |
|
| 39 |
|
| 40 |
|
| 41 |
|
| 42 |
|
| 43 |
|
| 44 |
|
| 45 |
|
| 46 |
|
| 47 |
|
| 48 |
|
| 49 |
|
| 50 |
|
| 51 |
|
| 52 |
<span class="grey">Daniele, et al. Standards Track [Page 1]</span></pre> |
| 53 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span> |
| 54 |
<span class="grey"><a href="./rfc4001">RFC 4001</a> Internet Network Address Conventions February 2005</span> |
| 55 |
|
| 56 |
|
| 57 |
Table of Contents |
| 58 |
|
| 59 |
<a href="#section-1">1</a>. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-2">2</a> |
| 60 |
<a href="#section-2">2</a>. The Internet-Standard Management Framework . . . . . . . . . . <a href="#page-4">4</a> |
| 61 |
<a href="#section-3">3</a>. Definitions . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-5">5</a> |
| 62 |
<a href="#section-4">4</a>. Usage Hints . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-13">13</a> |
| 63 |
<a href="#section-4.1">4.1</a>. Table Indexing . . . . . . . . . . . . . . . . . . . . . <a href="#page-14">14</a> |
| 64 |
<a href="#section-4.2">4.2</a>. Uniqueness of Addresses . . . . . . . . . . . . . . . . <a href="#page-14">14</a> |
| 65 |
<a href="#section-4.3">4.3</a>. Multiple Addresses per Host . . . . . . . . . . . . . . <a href="#page-15">15</a> |
| 66 |
<a href="#section-4.4">4.4</a>. Resolving DNS Names . . . . . . . . . . . . . . . . . . <a href="#page-15">15</a> |
| 67 |
<a href="#section-5">5</a>. Table Indexing Example . . . . . . . . . . . . . . . . . . . . <a href="#page-15">15</a> |
| 68 |
<a href="#section-6">6</a>. Security Considerations . . . . . . . . . . . . . . . . . . . <a href="#page-17">17</a> |
| 69 |
<a href="#section-7">7</a>. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-18">18</a> |
| 70 |
<a href="#section-8">8</a>. Changes from <a href="./rfc3291">RFC 3291</a> to <a href="./rfc4001">RFC 4001</a> . . . . . . . . . . . . . . <a href="#page-18">18</a> |
| 71 |
<a href="#section-9">9</a>. Changes from <a href="./rfc2851">RFC 2851</a> to <a href="./rfc3291">RFC 3291</a> . . . . . . . . . . . . . . <a href="#page-18">18</a> |
| 72 |
<a href="#section-10">10</a>. References . . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-19">19</a> |
| 73 |
<a href="#section-10.1">10.1</a>. Normative References . . . . . . . . . . . . . . . . . . <a href="#page-19">19</a> |
| 74 |
<a href="#section-10.2">10.2</a>. Informative References . . . . . . . . . . . . . . . . . <a href="#page-20">20</a> |
| 75 |
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-21">21</a> |
| 76 |
Full Copyright Statement . . . . . . . . . . . . . . . . . . . . . <a href="#page-22">22</a> |
| 77 |
|
| 78 |
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span> |
| 79 |
|
| 80 |
Several standards-track MIB modules use the IpAddress SMIv2 base |
| 81 |
type. This limits the applicability of these MIB modules to IP |
| 82 |
Version 4 (IPv4), as the IpAddress SMIv2 base type can only contain |
| 83 |
4-byte IPv4 addresses. The IpAddress SMIv2 base type has become |
| 84 |
problematic with the introduction of IP Version 6 (IPv6) addresses |
| 85 |
[<a href="./rfc3513" title=""Internet Protocol Version 6 (IPv6) Addressing Architecture"">RFC3513</a>]. |
| 86 |
|
| 87 |
This document defines multiple textual conventions (TCs) as a means |
| 88 |
to express generic Internet network layer addresses within MIB module |
| 89 |
specifications. The solution is compatible with SMIv2 (STD 58) and |
| 90 |
SMIv1 (STD 16). New MIB definitions that have to express network |
| 91 |
layer Internet addresses SHOULD use the textual conventions defined |
| 92 |
in this memo. New MIB modules SHOULD NOT use the SMIv2 IpAddress |
| 93 |
base type anymore. |
| 94 |
|
| 95 |
A generic Internet address consists of two objects: one whose syntax |
| 96 |
is InetAddressType, and another whose syntax is InetAddress. The |
| 97 |
value of the first object determines how the value of the second is |
| 98 |
encoded. The InetAddress textual convention represents an opaque |
| 99 |
Internet address value. The InetAddressType enumeration is used to |
| 100 |
"cast" the InetAddress value into a concrete textual convention for |
| 101 |
the address type. This usage of multiple textual conventions allows |
| 102 |
expression of the display characteristics of each address type and |
| 103 |
makes the set of defined Internet address types extensible. |
| 104 |
|
| 105 |
|
| 106 |
|
| 107 |
|
| 108 |
<span class="grey">Daniele, et al. Standards Track [Page 2]</span></pre> |
| 109 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span> |
| 110 |
<span class="grey"><a href="./rfc4001">RFC 4001</a> Internet Network Address Conventions February 2005</span> |
| 111 |
|
| 112 |
|
| 113 |
The textual conventions for well-known transport domains support |
| 114 |
scoped Internet addresses. The scope of an Internet address is a |
| 115 |
topological span within which the address may be used as a unique |
| 116 |
identifier for an interface or set of interfaces. A scope zone (or, |
| 117 |
simply, a zone) is a concrete connected region of topology of a given |
| 118 |
scope. Note that a zone is a particular instance of a topological |
| 119 |
region, whereas a scope is the size of a topological region |
| 120 |
[<a href="./rfc4007" title=""IPv6 Scoped Address Architecture"">RFC4007</a>]. Since Internet addresses on devices that connect multiple |
| 121 |
zones are not necessarily unique, an additional zone index is needed |
| 122 |
on these devices to select an interface. The textual conventions |
| 123 |
InetAddressIPv4z and InetAddressIPv6z are provided to support |
| 124 |
Internet addresses that include a zone index. To support arbitrary |
| 125 |
combinations of scoped Internet addresses, MIB authors SHOULD use a |
| 126 |
separate InetAddressType object for each InetAddress object. |
| 127 |
|
| 128 |
The textual conventions defined in this document can also be used to |
| 129 |
represent generic Internet subnets and Internet address ranges. A |
| 130 |
generic Internet subnet is represented by three objects: one whose |
| 131 |
syntax is InetAddressType, a second one whose syntax is InetAddress, |
| 132 |
and a third one whose syntax is InetAddressPrefixLength. The |
| 133 |
InetAddressType value again determines the concrete format of the |
| 134 |
InetAddress value, whereas the InetAddressPrefixLength identifies the |
| 135 |
Internet network address prefix. |
| 136 |
|
| 137 |
A generic range of consecutive Internet addresses is represented by |
| 138 |
three objects. The first one has the syntax InetAddressType, and the |
| 139 |
remaining objects have the syntax InetAddress and specify the start |
| 140 |
and end of the address range. Again, the InetAddressType value |
| 141 |
determines the format of the InetAddress values. |
| 142 |
|
| 143 |
The textual conventions defined in this document can be used to |
| 144 |
define Internet addresses by using DNS domain names in addition to |
| 145 |
IPv4 and IPv6 addresses. A MIB designer can write compliance |
| 146 |
statements to express that only a subset of the possible address |
| 147 |
types must be supported by a compliant implementation. |
| 148 |
|
| 149 |
MIB developers who need to represent Internet addresses SHOULD use |
| 150 |
these definitions whenever applicable, as opposed to defining their |
| 151 |
own constructs. Even MIB modules that only need to represent IPv4 or |
| 152 |
IPv6 addresses SHOULD use the InetAddressType/InetAddress textual |
| 153 |
conventions defined in this memo. |
| 154 |
|
| 155 |
There are many widely deployed MIB modules that use IPv4 addresses |
| 156 |
and that have to be revised to support IPv6. These MIB modules can |
| 157 |
be categorized as follows: |
| 158 |
|
| 159 |
|
| 160 |
|
| 161 |
|
| 162 |
|
| 163 |
|
| 164 |
<span class="grey">Daniele, et al. Standards Track [Page 3]</span></pre> |
| 165 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span> |
| 166 |
<span class="grey"><a href="./rfc4001">RFC 4001</a> Internet Network Address Conventions February 2005</span> |
| 167 |
|
| 168 |
|
| 169 |
1. MIB modules that define management information that is, in |
| 170 |
principle, IP version neutral, but the MIB currently uses |
| 171 |
addressing constructs specific to a certain IP version. |
| 172 |
|
| 173 |
2. MIB modules that define management information that is specific |
| 174 |
to a particular IP version (either IPv4 or IPv6) and that is very |
| 175 |
unlikely to ever be applicable to another IP version. |
| 176 |
|
| 177 |
MIB modules of the first type SHOULD provide object definitions |
| 178 |
(e.g., tables) that work with all versions of IP. In particular, |
| 179 |
when revising a MIB module that contains IPv4 specific tables, it is |
| 180 |
suggested to define new tables using the textual conventions defined |
| 181 |
in this memo that support all versions of IP. The status of the new |
| 182 |
tables SHOULD be "current", whereas the status of the old IP version |
| 183 |
specific tables SHOULD be changed to "deprecated". The other |
| 184 |
approach, of having multiple similar tables for different IP |
| 185 |
versions, is strongly discouraged. |
| 186 |
|
| 187 |
MIB modules of the second type, which are inherently IP version |
| 188 |
specific, do not need to be redefined. Note that even in this case, |
| 189 |
any additions to these MIB modules or to new IP version specific MIB |
| 190 |
modules SHOULD use the textual conventions defined in this memo. |
| 191 |
|
| 192 |
MIB developers SHOULD NOT use the textual conventions defined in this |
| 193 |
document to represent generic transport layer addresses. A special |
| 194 |
set of textual conventions for this purpose is defined in <a href="./rfc3419">RFC 3419</a> |
| 195 |
[<a href="./rfc3419" title=""Textual Conventions for Transport Addresses"">RFC3419</a>]. |
| 196 |
|
| 197 |
The key words "MUST", "MUST NOT", "SHOULD", "SHOULD NOT", and "MAY", |
| 198 |
in this document are to be interpreted as described in <a href="./rfc2119">RFC 2119</a> |
| 199 |
[<a href="./rfc2119" title=""Key words for use in RFCs to Indicate Requirement Levels"">RFC2119</a>]. |
| 200 |
|
| 201 |
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. The Internet-Standard Management Framework</span> |
| 202 |
|
| 203 |
For a detailed overview of the documents that describe the current |
| 204 |
Internet-Standard Management Framework, please refer to <a href="./rfc3410#section-7">section 7 of |
| 205 |
RFC 3410</a> [<a href="./rfc3410" title=""Introduction and Applicability Statements for Internet- Standard Management Framework"">RFC3410</a>]. |
| 206 |
|
| 207 |
Managed objects are accessed via a virtual information store, termed |
| 208 |
the Management Information Base or MIB. MIB objects are generally |
| 209 |
accessed through the Simple Network Management Protocol (SNMP). |
| 210 |
Objects in the MIB are defined using the mechanisms defined in the |
| 211 |
Structure of Management Information (SMI). This memo specifies a MIB |
| 212 |
module that is compliant to the SMIv2, which is described in STD 58, |
| 213 |
<a href="./rfc2578">RFC 2578</a> [<a href="./rfc2578" title=""Structure of Management Information Version 2 (SMIv2)"">RFC2578</a>], STD 58, <a href="./rfc2579">RFC 2579</a> [<a href="./rfc2579" title=""Textual Conventions for SMIv2"">RFC2579</a>] and STD 58, <a href="./rfc2580">RFC 2580</a> |
| 214 |
[<a href="./rfc2580" title=""Conformance Statements for SMIv2"">RFC2580</a>]. |
| 215 |
|
| 216 |
|
| 217 |
|
| 218 |
|
| 219 |
|
| 220 |
<span class="grey">Daniele, et al. Standards Track [Page 4]</span></pre> |
| 221 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span> |
| 222 |
<span class="grey"><a href="./rfc4001">RFC 4001</a> Internet Network Address Conventions February 2005</span> |
| 223 |
|
| 224 |
|
| 225 |
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Definitions</span> |
| 226 |
|
| 227 |
INET-ADDRESS-MIB DEFINITIONS ::= BEGIN |
| 228 |
|
| 229 |
IMPORTS |
| 230 |
MODULE-IDENTITY, mib-2, Unsigned32 FROM SNMPv2-SMI |
| 231 |
TEXTUAL-CONVENTION FROM SNMPv2-TC; |
| 232 |
|
| 233 |
inetAddressMIB MODULE-IDENTITY |
| 234 |
LAST-UPDATED "200502040000Z" |
| 235 |
ORGANIZATION |
| 236 |
"IETF Operations and Management Area" |
| 237 |
CONTACT-INFO |
| 238 |
"Juergen Schoenwaelder (Editor) |
| 239 |
International University Bremen |
| 240 |
P.O. Box 750 561 |
| 241 |
28725 Bremen, Germany |
| 242 |
|
| 243 |
Phone: +49 421 200-3587 |
| 244 |
EMail: [email protected] |
| 245 |
|
| 246 |
Send comments to <[email protected]>." |
| 247 |
DESCRIPTION |
| 248 |
"This MIB module defines textual conventions for |
| 249 |
representing Internet addresses. An Internet |
| 250 |
address can be an IPv4 address, an IPv6 address, |
| 251 |
or a DNS domain name. This module also defines |
| 252 |
textual conventions for Internet port numbers, |
| 253 |
autonomous system numbers, and the length of an |
| 254 |
Internet address prefix. |
| 255 |
|
| 256 |
Copyright (C) The Internet Society (2005). This version |
| 257 |
of this MIB module is part of <a href="./rfc4001">RFC 4001</a>, see the RFC |
| 258 |
itself for full legal notices." |
| 259 |
REVISION "200502040000Z" |
| 260 |
DESCRIPTION |
| 261 |
"Third version, published as <a href="./rfc4001">RFC 4001</a>. This revision |
| 262 |
introduces the InetZoneIndex, InetScopeType, and |
| 263 |
InetVersion textual conventions." |
| 264 |
REVISION "200205090000Z" |
| 265 |
DESCRIPTION |
| 266 |
"Second version, published as <a href="./rfc3291">RFC 3291</a>. This |
| 267 |
revision contains several clarifications and |
| 268 |
introduces several new textual conventions: |
| 269 |
InetAddressPrefixLength, InetPortNumber, |
| 270 |
InetAutonomousSystemNumber, InetAddressIPv4z, |
| 271 |
and InetAddressIPv6z." |
| 272 |
REVISION "200006080000Z" |
| 273 |
|
| 274 |
|
| 275 |
|
| 276 |
<span class="grey">Daniele, et al. Standards Track [Page 5]</span></pre> |
| 277 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span> |
| 278 |
<span class="grey"><a href="./rfc4001">RFC 4001</a> Internet Network Address Conventions February 2005</span> |
| 279 |
|
| 280 |
|
| 281 |
DESCRIPTION |
| 282 |
"Initial version, published as <a href="./rfc2851">RFC 2851</a>." |
| 283 |
::= { mib-2 76 } |
| 284 |
|
| 285 |
InetAddressType ::= TEXTUAL-CONVENTION |
| 286 |
STATUS current |
| 287 |
DESCRIPTION |
| 288 |
"A value that represents a type of Internet address. |
| 289 |
|
| 290 |
unknown(0) An unknown address type. This value MUST |
| 291 |
be used if the value of the corresponding |
| 292 |
InetAddress object is a zero-length string. |
| 293 |
It may also be used to indicate an IP address |
| 294 |
that is not in one of the formats defined |
| 295 |
below. |
| 296 |
|
| 297 |
ipv4(1) An IPv4 address as defined by the |
| 298 |
InetAddressIPv4 textual convention. |
| 299 |
|
| 300 |
ipv6(2) An IPv6 address as defined by the |
| 301 |
InetAddressIPv6 textual convention. |
| 302 |
|
| 303 |
ipv4z(3) A non-global IPv4 address including a zone |
| 304 |
index as defined by the InetAddressIPv4z |
| 305 |
textual convention. |
| 306 |
|
| 307 |
ipv6z(4) A non-global IPv6 address including a zone |
| 308 |
index as defined by the InetAddressIPv6z |
| 309 |
textual convention. |
| 310 |
|
| 311 |
dns(16) A DNS domain name as defined by the |
| 312 |
InetAddressDNS textual convention. |
| 313 |
|
| 314 |
Each definition of a concrete InetAddressType value must be |
| 315 |
accompanied by a definition of a textual convention for use |
| 316 |
with that InetAddressType. |
| 317 |
|
| 318 |
To support future extensions, the InetAddressType textual |
| 319 |
convention SHOULD NOT be sub-typed in object type definitions. |
| 320 |
It MAY be sub-typed in compliance statements in order to |
| 321 |
require only a subset of these address types for a compliant |
| 322 |
implementation. |
| 323 |
|
| 324 |
Implementations must ensure that InetAddressType objects |
| 325 |
and any dependent objects (e.g., InetAddress objects) are |
| 326 |
consistent. An inconsistentValue error must be generated |
| 327 |
if an attempt to change an InetAddressType object would, |
| 328 |
for example, lead to an undefined InetAddress value. In |
| 329 |
|
| 330 |
|
| 331 |
|
| 332 |
<span class="grey">Daniele, et al. Standards Track [Page 6]</span></pre> |
| 333 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span> |
| 334 |
<span class="grey"><a href="./rfc4001">RFC 4001</a> Internet Network Address Conventions February 2005</span> |
| 335 |
|
| 336 |
|
| 337 |
particular, InetAddressType/InetAddress pairs must be |
| 338 |
changed together if the address type changes (e.g., from |
| 339 |
ipv6(2) to ipv4(1))." |
| 340 |
SYNTAX INTEGER { |
| 341 |
unknown(0), |
| 342 |
ipv4(1), |
| 343 |
ipv6(2), |
| 344 |
ipv4z(3), |
| 345 |
ipv6z(4), |
| 346 |
dns(16) |
| 347 |
} |
| 348 |
|
| 349 |
InetAddress ::= TEXTUAL-CONVENTION |
| 350 |
STATUS current |
| 351 |
DESCRIPTION |
| 352 |
"Denotes a generic Internet address. |
| 353 |
|
| 354 |
An InetAddress value is always interpreted within the context |
| 355 |
of an InetAddressType value. Every usage of the InetAddress |
| 356 |
textual convention is required to specify the InetAddressType |
| 357 |
object that provides the context. It is suggested that the |
| 358 |
InetAddressType object be logically registered before the |
| 359 |
object(s) that use the InetAddress textual convention, if |
| 360 |
they appear in the same logical row. |
| 361 |
|
| 362 |
The value of an InetAddress object must always be |
| 363 |
consistent with the value of the associated InetAddressType |
| 364 |
object. Attempts to set an InetAddress object to a value |
| 365 |
inconsistent with the associated InetAddressType |
| 366 |
must fail with an inconsistentValue error. |
| 367 |
|
| 368 |
When this textual convention is used as the syntax of an |
| 369 |
index object, there may be issues with the limit of 128 |
| 370 |
sub-identifiers specified in SMIv2, STD 58. In this case, |
| 371 |
the object definition MUST include a 'SIZE' clause to |
| 372 |
limit the number of potential instance sub-identifiers; |
| 373 |
otherwise the applicable constraints MUST be stated in |
| 374 |
the appropriate conceptual row DESCRIPTION clauses, or |
| 375 |
in the surrounding documentation if there is no single |
| 376 |
DESCRIPTION clause that is appropriate." |
| 377 |
SYNTAX OCTET STRING (SIZE (0..255)) |
| 378 |
|
| 379 |
InetAddressIPv4 ::= TEXTUAL-CONVENTION |
| 380 |
DISPLAY-HINT "1d.1d.1d.1d" |
| 381 |
STATUS current |
| 382 |
DESCRIPTION |
| 383 |
"Represents an IPv4 network address: |
| 384 |
|
| 385 |
|
| 386 |
|
| 387 |
|
| 388 |
<span class="grey">Daniele, et al. Standards Track [Page 7]</span></pre> |
| 389 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span> |
| 390 |
<span class="grey"><a href="./rfc4001">RFC 4001</a> Internet Network Address Conventions February 2005</span> |
| 391 |
|
| 392 |
|
| 393 |
Octets Contents Encoding |
| 394 |
1-4 IPv4 address network-byte order |
| 395 |
|
| 396 |
The corresponding InetAddressType value is ipv4(1). |
| 397 |
|
| 398 |
This textual convention SHOULD NOT be used directly in object |
| 399 |
definitions, as it restricts addresses to a specific format. |
| 400 |
However, if it is used, it MAY be used either on its own or in |
| 401 |
conjunction with InetAddressType, as a pair." |
| 402 |
SYNTAX OCTET STRING (SIZE (4)) |
| 403 |
|
| 404 |
InetAddressIPv6 ::= TEXTUAL-CONVENTION |
| 405 |
DISPLAY-HINT "2x:2x:2x:2x:2x:2x:2x:2x" |
| 406 |
STATUS current |
| 407 |
DESCRIPTION |
| 408 |
"Represents an IPv6 network address: |
| 409 |
|
| 410 |
Octets Contents Encoding |
| 411 |
1-16 IPv6 address network-byte order |
| 412 |
|
| 413 |
The corresponding InetAddressType value is ipv6(2). |
| 414 |
|
| 415 |
This textual convention SHOULD NOT be used directly in object |
| 416 |
definitions, as it restricts addresses to a specific format. |
| 417 |
However, if it is used, it MAY be used either on its own or in |
| 418 |
conjunction with InetAddressType, as a pair." |
| 419 |
SYNTAX OCTET STRING (SIZE (16)) |
| 420 |
|
| 421 |
InetAddressIPv4z ::= TEXTUAL-CONVENTION |
| 422 |
DISPLAY-HINT "1d.1d.1d.1d%4d" |
| 423 |
STATUS current |
| 424 |
DESCRIPTION |
| 425 |
"Represents a non-global IPv4 network address, together |
| 426 |
with its zone index: |
| 427 |
|
| 428 |
Octets Contents Encoding |
| 429 |
1-4 IPv4 address network-byte order |
| 430 |
5-8 zone index network-byte order |
| 431 |
|
| 432 |
The corresponding InetAddressType value is ipv4z(3). |
| 433 |
|
| 434 |
The zone index (bytes 5-8) is used to disambiguate identical |
| 435 |
address values on nodes that have interfaces attached to |
| 436 |
different zones of the same scope. The zone index may contain |
| 437 |
the special value 0, which refers to the default zone for each |
| 438 |
scope. |
| 439 |
|
| 440 |
This textual convention SHOULD NOT be used directly in object |
| 441 |
|
| 442 |
|
| 443 |
|
| 444 |
<span class="grey">Daniele, et al. Standards Track [Page 8]</span></pre> |
| 445 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span> |
| 446 |
<span class="grey"><a href="./rfc4001">RFC 4001</a> Internet Network Address Conventions February 2005</span> |
| 447 |
|
| 448 |
|
| 449 |
definitions, as it restricts addresses to a specific format. |
| 450 |
However, if it is used, it MAY be used either on its own or in |
| 451 |
conjunction with InetAddressType, as a pair." |
| 452 |
SYNTAX OCTET STRING (SIZE (8)) |
| 453 |
|
| 454 |
InetAddressIPv6z ::= TEXTUAL-CONVENTION |
| 455 |
DISPLAY-HINT "2x:2x:2x:2x:2x:2x:2x:2x%4d" |
| 456 |
STATUS current |
| 457 |
DESCRIPTION |
| 458 |
"Represents a non-global IPv6 network address, together |
| 459 |
with its zone index: |
| 460 |
|
| 461 |
Octets Contents Encoding |
| 462 |
1-16 IPv6 address network-byte order |
| 463 |
17-20 zone index network-byte order |
| 464 |
|
| 465 |
The corresponding InetAddressType value is ipv6z(4). |
| 466 |
|
| 467 |
The zone index (bytes 17-20) is used to disambiguate |
| 468 |
identical address values on nodes that have interfaces |
| 469 |
attached to different zones of the same scope. The zone index |
| 470 |
may contain the special value 0, which refers to the default |
| 471 |
zone for each scope. |
| 472 |
|
| 473 |
This textual convention SHOULD NOT be used directly in object |
| 474 |
definitions, as it restricts addresses to a specific format. |
| 475 |
However, if it is used, it MAY be used either on its own or in |
| 476 |
conjunction with InetAddressType, as a pair." |
| 477 |
SYNTAX OCTET STRING (SIZE (20)) |
| 478 |
|
| 479 |
InetAddressDNS ::= TEXTUAL-CONVENTION |
| 480 |
DISPLAY-HINT "255a" |
| 481 |
STATUS current |
| 482 |
DESCRIPTION |
| 483 |
"Represents a DNS domain name. The name SHOULD be fully |
| 484 |
qualified whenever possible. |
| 485 |
|
| 486 |
The corresponding InetAddressType is dns(16). |
| 487 |
|
| 488 |
The DESCRIPTION clause of InetAddress objects that may have |
| 489 |
InetAddressDNS values MUST fully describe how (and when) |
| 490 |
these names are to be resolved to IP addresses. |
| 491 |
|
| 492 |
The resolution of an InetAddressDNS value may require to |
| 493 |
query multiple DNS records (e.g., A for IPv4 and AAAA for |
| 494 |
IPv6). The order of the resolution process and which DNS |
| 495 |
record takes precedence depends on the configuration of the |
| 496 |
resolver. |
| 497 |
|
| 498 |
|
| 499 |
|
| 500 |
<span class="grey">Daniele, et al. Standards Track [Page 9]</span></pre> |
| 501 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span> |
| 502 |
<span class="grey"><a href="./rfc4001">RFC 4001</a> Internet Network Address Conventions February 2005</span> |
| 503 |
|
| 504 |
|
| 505 |
This textual convention SHOULD NOT be used directly in object |
| 506 |
definitions, as it restricts addresses to a specific format. |
| 507 |
However, if it is used, it MAY be used either on its own or in |
| 508 |
conjunction with InetAddressType, as a pair." |
| 509 |
SYNTAX OCTET STRING (SIZE (1..255)) |
| 510 |
|
| 511 |
InetAddressPrefixLength ::= TEXTUAL-CONVENTION |
| 512 |
DISPLAY-HINT "d" |
| 513 |
STATUS current |
| 514 |
DESCRIPTION |
| 515 |
"Denotes the length of a generic Internet network address |
| 516 |
prefix. A value of n corresponds to an IP address mask |
| 517 |
that has n contiguous 1-bits from the most significant |
| 518 |
bit (MSB), with all other bits set to 0. |
| 519 |
|
| 520 |
An InetAddressPrefixLength value is always interpreted within |
| 521 |
the context of an InetAddressType value. Every usage of the |
| 522 |
InetAddressPrefixLength textual convention is required to |
| 523 |
specify the InetAddressType object that provides the |
| 524 |
context. It is suggested that the InetAddressType object be |
| 525 |
logically registered before the object(s) that use the |
| 526 |
InetAddressPrefixLength textual convention, if they appear |
| 527 |
in the same logical row. |
| 528 |
|
| 529 |
InetAddressPrefixLength values larger than |
| 530 |
the maximum length of an IP address for a specific |
| 531 |
InetAddressType are treated as the maximum significant |
| 532 |
value applicable for the InetAddressType. The maximum |
| 533 |
significant value is 32 for the InetAddressType |
| 534 |
'ipv4(1)' and 'ipv4z(3)' and 128 for the InetAddressType |
| 535 |
'ipv6(2)' and 'ipv6z(4)'. The maximum significant value |
| 536 |
for the InetAddressType 'dns(16)' is 0. |
| 537 |
|
| 538 |
The value zero is object-specific and must be defined as |
| 539 |
part of the description of any object that uses this |
| 540 |
syntax. Examples of the usage of zero might include |
| 541 |
situations where the Internet network address prefix |
| 542 |
is unknown or does not apply. |
| 543 |
|
| 544 |
The upper bound of the prefix length has been chosen to |
| 545 |
be consistent with the maximum size of an InetAddress." |
| 546 |
SYNTAX Unsigned32 (0..2040) |
| 547 |
|
| 548 |
InetPortNumber ::= TEXTUAL-CONVENTION |
| 549 |
DISPLAY-HINT "d" |
| 550 |
STATUS current |
| 551 |
DESCRIPTION |
| 552 |
"Represents a 16 bit port number of an Internet transport |
| 553 |
|
| 554 |
|
| 555 |
|
| 556 |
<span class="grey">Daniele, et al. Standards Track [Page 10]</span></pre> |
| 557 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span> |
| 558 |
<span class="grey"><a href="./rfc4001">RFC 4001</a> Internet Network Address Conventions February 2005</span> |
| 559 |
|
| 560 |
|
| 561 |
layer protocol. Port numbers are assigned by IANA. A |
| 562 |
current list of all assignments is available from |
| 563 |
<<a href="http://www.iana.org/">http://www.iana.org/</a>>. |
| 564 |
|
| 565 |
The value zero is object-specific and must be defined as |
| 566 |
part of the description of any object that uses this |
| 567 |
syntax. Examples of the usage of zero might include |
| 568 |
situations where a port number is unknown, or when the |
| 569 |
value zero is used as a wildcard in a filter." |
| 570 |
REFERENCE "STD 6 (<a href="./rfc768">RFC 768</a>), STD 7 (<a href="./rfc793">RFC 793</a>) and <a href="./rfc2960">RFC 2960</a>" |
| 571 |
SYNTAX Unsigned32 (0..65535) |
| 572 |
|
| 573 |
InetAutonomousSystemNumber ::= TEXTUAL-CONVENTION |
| 574 |
DISPLAY-HINT "d" |
| 575 |
STATUS current |
| 576 |
DESCRIPTION |
| 577 |
"Represents an autonomous system number that identifies an |
| 578 |
Autonomous System (AS). An AS is a set of routers under a |
| 579 |
single technical administration, using an interior gateway |
| 580 |
protocol and common metrics to route packets within the AS, |
| 581 |
and using an exterior gateway protocol to route packets to |
| 582 |
other ASes'. IANA maintains the AS number space and has |
| 583 |
delegated large parts to the regional registries. |
| 584 |
|
| 585 |
Autonomous system numbers are currently limited to 16 bits |
| 586 |
(0..65535). There is, however, work in progress to enlarge the |
| 587 |
autonomous system number space to 32 bits. Therefore, this |
| 588 |
textual convention uses an Unsigned32 value without a |
| 589 |
range restriction in order to support a larger autonomous |
| 590 |
system number space." |
| 591 |
REFERENCE "<a href="./rfc1771">RFC 1771</a>, <a href="./rfc1930">RFC 1930</a>" |
| 592 |
SYNTAX Unsigned32 |
| 593 |
|
| 594 |
InetScopeType ::= TEXTUAL-CONVENTION |
| 595 |
STATUS current |
| 596 |
DESCRIPTION |
| 597 |
"Represents a scope type. This textual convention can be used |
| 598 |
in cases where a MIB has to represent different scope types |
| 599 |
and there is no context information, such as an InetAddress |
| 600 |
object, that implicitly defines the scope type. |
| 601 |
|
| 602 |
Note that not all possible values have been assigned yet, but |
| 603 |
they may be assigned in future revisions of this specification. |
| 604 |
Applications should therefore be able to deal with values |
| 605 |
not yet assigned." |
| 606 |
REFERENCE "<a href="./rfc3513">RFC 3513</a>" |
| 607 |
SYNTAX INTEGER { |
| 608 |
-- reserved(0), |
| 609 |
|
| 610 |
|
| 611 |
|
| 612 |
<span class="grey">Daniele, et al. Standards Track [Page 11]</span></pre> |
| 613 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span> |
| 614 |
<span class="grey"><a href="./rfc4001">RFC 4001</a> Internet Network Address Conventions February 2005</span> |
| 615 |
|
| 616 |
|
| 617 |
interfaceLocal(1), |
| 618 |
linkLocal(2), |
| 619 |
subnetLocal(3), |
| 620 |
adminLocal(4), |
| 621 |
siteLocal(5), -- site-local unicast addresses |
| 622 |
-- have been deprecated by <a href="./rfc3879">RFC 3879</a> |
| 623 |
-- unassigned(6), |
| 624 |
-- unassigned(7), |
| 625 |
organizationLocal(8), |
| 626 |
-- unassigned(9), |
| 627 |
-- unassigned(10), |
| 628 |
-- unassigned(11), |
| 629 |
-- unassigned(12), |
| 630 |
-- unassigned(13), |
| 631 |
global(14) |
| 632 |
-- reserved(15) |
| 633 |
} |
| 634 |
|
| 635 |
InetZoneIndex ::= TEXTUAL-CONVENTION |
| 636 |
DISPLAY-HINT "d" |
| 637 |
STATUS current |
| 638 |
DESCRIPTION |
| 639 |
"A zone index identifies an instance of a zone of a |
| 640 |
specific scope. |
| 641 |
|
| 642 |
The zone index MUST disambiguate identical address |
| 643 |
values. For link-local addresses, the zone index will |
| 644 |
typically be the interface index (ifIndex as defined in the |
| 645 |
IF-MIB) of the interface on which the address is configured. |
| 646 |
|
| 647 |
The zone index may contain the special value 0, which refers |
| 648 |
to the default zone. The default zone may be used in cases |
| 649 |
where the valid zone index is not known (e.g., when a |
| 650 |
management application has to write a link-local IPv6 |
| 651 |
address without knowing the interface index value). The |
| 652 |
default zone SHOULD NOT be used as an easy way out in |
| 653 |
cases where the zone index for a non-global IPv6 address |
| 654 |
is known." |
| 655 |
REFERENCE "<a href="./rfc4007">RFC4007</a>" |
| 656 |
SYNTAX Unsigned32 |
| 657 |
|
| 658 |
InetVersion ::= TEXTUAL-CONVENTION |
| 659 |
STATUS current |
| 660 |
DESCRIPTION |
| 661 |
"A value representing a version of the IP protocol. |
| 662 |
|
| 663 |
unknown(0) An unknown or unspecified version of the IP |
| 664 |
protocol. |
| 665 |
|
| 666 |
|
| 667 |
|
| 668 |
<span class="grey">Daniele, et al. Standards Track [Page 12]</span></pre> |
| 669 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span> |
| 670 |
<span class="grey"><a href="./rfc4001">RFC 4001</a> Internet Network Address Conventions February 2005</span> |
| 671 |
|
| 672 |
|
| 673 |
ipv4(1) The IPv4 protocol as defined in <a href="./rfc791">RFC 791</a> (STD 5). |
| 674 |
|
| 675 |
ipv6(2) The IPv6 protocol as defined in <a href="./rfc2460">RFC 2460</a>. |
| 676 |
|
| 677 |
Note that this textual convention SHOULD NOT be used to |
| 678 |
distinguish different address types associated with IP |
| 679 |
protocols. The InetAddressType has been designed for this |
| 680 |
purpose." |
| 681 |
REFERENCE "<a href="./rfc791">RFC 791</a>, <a href="./rfc2460">RFC 2460</a>" |
| 682 |
SYNTAX INTEGER { |
| 683 |
unknown(0), |
| 684 |
ipv4(1), |
| 685 |
ipv6(2) |
| 686 |
} |
| 687 |
END |
| 688 |
|
| 689 |
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Usage Hints</span> |
| 690 |
|
| 691 |
The InetAddressType and InetAddress textual conventions have been |
| 692 |
introduced to avoid over-constraining an object definition by the use |
| 693 |
of the IpAddress SMI base type, which is IPv4 specific. An |
| 694 |
InetAddressType/InetAddress pair can represent IP addresses in |
| 695 |
various formats. |
| 696 |
|
| 697 |
The InetAddressType and InetAddress objects SHOULD NOT be sub-typed |
| 698 |
in object definitions. Sub-typing binds the MIB module to specific |
| 699 |
address formats, which may cause serious problems if new address |
| 700 |
formats need to be introduced. Note that it is possible to write |
| 701 |
compliance statements indicating that only a subset of the defined |
| 702 |
address types must be implemented to be compliant. |
| 703 |
|
| 704 |
Every usage of the InetAddress or InetAddressPrefixLength textual |
| 705 |
conventions must specify which InetAddressType object provides the |
| 706 |
context for the interpretation of the InetAddress or |
| 707 |
InetAddressPrefixLength textual convention. |
| 708 |
|
| 709 |
It is suggested that the InetAddressType object is logically |
| 710 |
registered before the object(s) that use(s) the InetAddress or |
| 711 |
InetAddressPrefixLength textual convention. An InetAddressType |
| 712 |
object is logically registered before an InetAddress or |
| 713 |
InetAddressPrefixLength object if it appears before the InetAddress |
| 714 |
or InetAddressPrefixLength object in the conceptual row (which |
| 715 |
includes any index objects). This rule allows programs such as MIB |
| 716 |
compilers to identify the InetAddressType of a given InetAddress or |
| 717 |
InetAddressPrefixLength object by searching for the InetAddressType |
| 718 |
object, which precedes an InetAddress or InetAddressPrefixLength |
| 719 |
object. |
| 720 |
|
| 721 |
|
| 722 |
|
| 723 |
|
| 724 |
<span class="grey">Daniele, et al. Standards Track [Page 13]</span></pre> |
| 725 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span> |
| 726 |
<span class="grey"><a href="./rfc4001">RFC 4001</a> Internet Network Address Conventions February 2005</span> |
| 727 |
|
| 728 |
|
| 729 |
<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>. Table Indexing</span> |
| 730 |
|
| 731 |
When a generic Internet address is used as an index, both the |
| 732 |
InetAddressType and InetAddress objects MUST be used. The |
| 733 |
InetAddressType object MUST be listed before the InetAddress object |
| 734 |
in the INDEX clause. |
| 735 |
|
| 736 |
The IMPLIED keyword MUST NOT be used for an object of type |
| 737 |
InetAddress in an INDEX clause. Instance sub-identifiers are then of |
| 738 |
the form T.N.O1.O2...On, where T is the value of the InetAddressType |
| 739 |
object, O1...On are the octets in the InetAddress object, and N is |
| 740 |
the number of those octets. |
| 741 |
|
| 742 |
There is a meaningful lexicographical ordering to tables indexed in |
| 743 |
this fashion. Command generator applications may look up specific |
| 744 |
addresses of known type and value, issue GetNext requests for |
| 745 |
addresses of a single type, or issue GetNext requests for a specific |
| 746 |
type and address prefix. |
| 747 |
|
| 748 |
<span class="h3"><a class="selflink" id="section-4.2" href="#section-4.2">4.2</a>. Uniqueness of Addresses</span> |
| 749 |
|
| 750 |
IPv4 addresses were intended to be globally unique, current usage |
| 751 |
notwithstanding. IPv6 addresses were architected to have different |
| 752 |
scopes and hence uniqueness [<a href="./rfc3513" title=""Internet Protocol Version 6 (IPv6) Addressing Architecture"">RFC3513</a>]. In particular, IPv6 "link- |
| 753 |
local" unicast addresses are not guaranteed to be unique on any |
| 754 |
particular node. In such cases, the duplicate addresses must be |
| 755 |
configured on different interfaces. So the combination of an IPv6 |
| 756 |
address and a zone index is unique [<a href="./rfc4007" title=""IPv6 Scoped Address Architecture"">RFC4007</a>]. |
| 757 |
|
| 758 |
The InetAddressIPv6 textual convention has been defined to represent |
| 759 |
global IPv6 addresses and non-global IPv6 addresses in cases where no |
| 760 |
zone index is needed (e.g., on end hosts with a single interface). |
| 761 |
The InetAddressIPv6z textual convention has been defined to represent |
| 762 |
non-global IPv6 addresses in cases where a zone index is needed |
| 763 |
(e.g., a router connecting multiple zones). Therefore, MIB designers |
| 764 |
who use InetAddressType/InetAddress pairs do not need to define |
| 765 |
additional objects in order to support non-global addresses on nodes |
| 766 |
that connect multiple zones. |
| 767 |
|
| 768 |
The InetAddressIPv4z is intended for use in MIB modules (such as the |
| 769 |
TCP-MIB) which report addresses in the address family used on the |
| 770 |
wire, but where the entity instrumented obtains these addresses from |
| 771 |
applications or administrators in a form that includes a zone index, |
| 772 |
such as v4-mapped IPv6 addresses. |
| 773 |
|
| 774 |
|
| 775 |
|
| 776 |
|
| 777 |
|
| 778 |
|
| 779 |
|
| 780 |
<span class="grey">Daniele, et al. Standards Track [Page 14]</span></pre> |
| 781 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span> |
| 782 |
<span class="grey"><a href="./rfc4001">RFC 4001</a> Internet Network Address Conventions February 2005</span> |
| 783 |
|
| 784 |
|
| 785 |
The size of the zone index has been chosen so that it is consistent |
| 786 |
with (i) the numerical zone index, defined in [<a href="./rfc4007" title=""IPv6 Scoped Address Architecture"">RFC4007</a>], and (ii) the |
| 787 |
sin6_scope_id field of the sockaddr_in6 structure, defined in <a href="./rfc2553">RFC</a> |
| 788 |
<a href="./rfc2553">2553</a> [<a href="./rfc2553" title=""Basic Socket Interface Extensions for IPv6"">RFC2553</a>]. |
| 789 |
|
| 790 |
<span class="h3"><a class="selflink" id="section-4.3" href="#section-4.3">4.3</a>. Multiple Addresses per Host</span> |
| 791 |
|
| 792 |
A single host system may be configured with multiple addresses (IPv4 |
| 793 |
or IPv6), and possibly with multiple DNS names. Thus it is possible |
| 794 |
for a single host system to be accessible by multiple |
| 795 |
InetAddressType/InetAddress pairs. |
| 796 |
|
| 797 |
If this could be an implementation or usage issue, the DESCRIPTION |
| 798 |
clause of the relevant objects must fully describe which address is |
| 799 |
reported in a given InetAddressType/InetAddress pair. |
| 800 |
|
| 801 |
<span class="h3"><a class="selflink" id="section-4.4" href="#section-4.4">4.4</a>. Resolving DNS Names</span> |
| 802 |
|
| 803 |
DNS names MUST be resolved to IP addresses when communication with |
| 804 |
the named host is required. This raises a temporal aspect to |
| 805 |
defining MIB objects whose value is a DNS name: When is the name |
| 806 |
translated to an address? |
| 807 |
|
| 808 |
For example, consider an object defined to indicate a forwarding |
| 809 |
destination, and whose value is a DNS name. When does the forwarding |
| 810 |
entity resolve the DNS name? Each time forwarding occurs, or just |
| 811 |
once when the object was instantiated? |
| 812 |
|
| 813 |
The DESCRIPTION clause of these objects SHOULD precisely define how |
| 814 |
and when any required name to address resolution is done. |
| 815 |
|
| 816 |
Similarly, the DESCRIPTION clause of these objects SHOULD precisely |
| 817 |
define how and when a reverse lookup is being done, if an agent has |
| 818 |
accessed instrumentation that knows about an IP address, and if the |
| 819 |
MIB module or implementation requires it to map the IP address to a |
| 820 |
DNS name. |
| 821 |
|
| 822 |
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Table Indexing Example</span> |
| 823 |
|
| 824 |
This example shows a table listing communication peers that are |
| 825 |
identified by either an IPv4 address, an IPv6 address, or a DNS name. |
| 826 |
The table definition also prohibits entries with an empty address |
| 827 |
(whose type would be "unknown"). The size of a DNS name is limited |
| 828 |
to 64 characters in order to satisfy OID length constraints. |
| 829 |
|
| 830 |
|
| 831 |
|
| 832 |
|
| 833 |
|
| 834 |
|
| 835 |
|
| 836 |
<span class="grey">Daniele, et al. Standards Track [Page 15]</span></pre> |
| 837 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span> |
| 838 |
<span class="grey"><a href="./rfc4001">RFC 4001</a> Internet Network Address Conventions February 2005</span> |
| 839 |
|
| 840 |
|
| 841 |
peerTable OBJECT-TYPE |
| 842 |
SYNTAX SEQUENCE OF PeerEntry |
| 843 |
MAX-ACCESS not-accessible |
| 844 |
STATUS current |
| 845 |
DESCRIPTION |
| 846 |
"A list of communication peers." |
| 847 |
::= { somewhere 1 } |
| 848 |
|
| 849 |
peerEntry OBJECT-TYPE |
| 850 |
SYNTAX PeerEntry |
| 851 |
MAX-ACCESS not-accessible |
| 852 |
STATUS current |
| 853 |
DESCRIPTION |
| 854 |
"An entry containing information about a particular peer." |
| 855 |
INDEX { peerAddressType, peerAddress } |
| 856 |
::= { peerTable 1 } |
| 857 |
|
| 858 |
PeerEntry ::= SEQUENCE { |
| 859 |
peerAddressType InetAddressType, |
| 860 |
peerAddress InetAddress, |
| 861 |
peerStatus INTEGER |
| 862 |
} |
| 863 |
|
| 864 |
peerAddressType OBJECT-TYPE |
| 865 |
SYNTAX InetAddressType |
| 866 |
MAX-ACCESS not-accessible |
| 867 |
STATUS current |
| 868 |
DESCRIPTION |
| 869 |
"The type of Internet address by which the peer |
| 870 |
is reachable." |
| 871 |
|
| 872 |
::= { peerEntry 1 } |
| 873 |
|
| 874 |
peerAddress OBJECT-TYPE |
| 875 |
SYNTAX InetAddress (SIZE (1..64)) |
| 876 |
MAX-ACCESS not-accessible |
| 877 |
STATUS current |
| 878 |
DESCRIPTION |
| 879 |
"The Internet address for the peer. The type of this |
| 880 |
address is determined by the value of the peerAddressType |
| 881 |
object. Note that implementations must limit themselves |
| 882 |
to a single entry in this table per reachable peer. |
| 883 |
The peerAddress may not be empty due to the SIZE |
| 884 |
restriction. |
| 885 |
|
| 886 |
If a row is created administratively by an SNMP |
| 887 |
operation and the address type value is dns(16), then |
| 888 |
the agent stores the DNS name internally. A DNS name |
| 889 |
|
| 890 |
|
| 891 |
|
| 892 |
<span class="grey">Daniele, et al. Standards Track [Page 16]</span></pre> |
| 893 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span> |
| 894 |
<span class="grey"><a href="./rfc4001">RFC 4001</a> Internet Network Address Conventions February 2005</span> |
| 895 |
|
| 896 |
|
| 897 |
lookup must be performed on the internally stored DNS |
| 898 |
name whenever it is being used to contact the peer. |
| 899 |
|
| 900 |
If a row is created by the managed entity itself and |
| 901 |
the address type value is dns(16), then the agent |
| 902 |
stores the IP address internally. A DNS reverse lookup |
| 903 |
must be performed on the internally stored IP address |
| 904 |
whenever the value is retrieved via SNMP." |
| 905 |
::= { peerEntry 2 } |
| 906 |
|
| 907 |
|
| 908 |
The following compliance statement specifies that compliant |
| 909 |
implementations need only support IPv4/IPv6 addresses without zone |
| 910 |
indices. Support for DNS names or IPv4/IPv6 addresses with zone |
| 911 |
indices is not required. |
| 912 |
|
| 913 |
peerCompliance MODULE-COMPLIANCE |
| 914 |
STATUS current |
| 915 |
DESCRIPTION |
| 916 |
"The compliance statement of the peer MIB." |
| 917 |
|
| 918 |
MODULE -- this module |
| 919 |
MANDATORY-GROUPS { peerGroup } |
| 920 |
|
| 921 |
OBJECT peerAddressType |
| 922 |
SYNTAX InetAddressType { ipv4(1), ipv6(2) } |
| 923 |
DESCRIPTION |
| 924 |
"An implementation is only required to support IPv4 |
| 925 |
and IPv6 addresses without zone indices." |
| 926 |
|
| 927 |
::= { somewhere 2 } |
| 928 |
|
| 929 |
Note that the SMIv2 does not permit inclusion of objects that are not |
| 930 |
accessible in an object group (see <a href="#section-3.1">section 3.1</a> in STD 58, <a href="./rfc2580">RFC 2580</a> |
| 931 |
[<a href="./rfc2580" title=""Conformance Statements for SMIv2"">RFC2580</a>]). It is therefore not possible to refine the syntax of |
| 932 |
auxiliary objects that are not accessible. It is suggested that the |
| 933 |
refinement be expressed informally in the DESCRIPTION clause of the |
| 934 |
MODULE-COMPLIANCE macro invocation. |
| 935 |
|
| 936 |
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. Security Considerations</span> |
| 937 |
|
| 938 |
This module does not define any management objects. Instead, it |
| 939 |
defines a set of textual conventions which may be used by other MIB |
| 940 |
modules to define management objects. |
| 941 |
|
| 942 |
|
| 943 |
|
| 944 |
|
| 945 |
|
| 946 |
|
| 947 |
|
| 948 |
<span class="grey">Daniele, et al. Standards Track [Page 17]</span></pre> |
| 949 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span> |
| 950 |
<span class="grey"><a href="./rfc4001">RFC 4001</a> Internet Network Address Conventions February 2005</span> |
| 951 |
|
| 952 |
|
| 953 |
Meaningful security considerations can only be written in the MIB |
| 954 |
modules that define management objects. This document has therefore |
| 955 |
no impact on the security of the Internet. |
| 956 |
|
| 957 |
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Acknowledgments</span> |
| 958 |
|
| 959 |
This document was produced by the Operations and Management Area |
| 960 |
"IPv6MIB" design team. For their comments and suggestions, the |
| 961 |
authors would like to thank Fred Baker, Randy Bush, Richard Draves, |
| 962 |
Mark Ellison, Bill Fenner, Jun-ichiro Hagino, Mike Heard, Tim |
| 963 |
Jenkins, Allison Mankin, Glenn Mansfield, Keith McCloghrie, Thomas |
| 964 |
Narten, Erik Nordmark, Peder Chr. Norgaard, Randy Presuhn, Andrew |
| 965 |
Smith, Dave Thaler, Kenneth White, Bert Wijnen, and Brian Zill. |
| 966 |
|
| 967 |
<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. Changes from <a href="./rfc3291">RFC 3291</a> to <a href="./rfc4001">RFC 4001</a></span> |
| 968 |
|
| 969 |
The following changes have been made relative to <a href="./rfc3291">RFC 3291</a>: |
| 970 |
|
| 971 |
o Added a range restriction to the InetAddressPrefixLength textual |
| 972 |
convention. |
| 973 |
|
| 974 |
o Added new textual conventions InetZoneIndex, InetScopeType, and |
| 975 |
InetVersion. |
| 976 |
|
| 977 |
o Added explicit "d" DISPLAY-HINTs for textual conventions that did |
| 978 |
not have them. |
| 979 |
|
| 980 |
o Updated boilerplate text and references. |
| 981 |
|
| 982 |
<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. Changes from <a href="./rfc2851">RFC 2851</a> to <a href="./rfc3291">RFC 3291</a></span> |
| 983 |
|
| 984 |
The following changes have been made relative to <a href="./rfc2851">RFC 2851</a>: |
| 985 |
|
| 986 |
o Added new textual conventions InetAddressPrefixLength, |
| 987 |
InetPortNumber, and InetAutonomousSystemNumber. |
| 988 |
|
| 989 |
o Rewrote the introduction to say clearly that, in general, one |
| 990 |
should define MIB tables that work with all versions of IP. The |
| 991 |
other approach of multiple tables for different IP versions is |
| 992 |
strongly discouraged. |
| 993 |
|
| 994 |
o Added text to the InetAddressType and InetAddress descriptions |
| 995 |
requiring that implementations must reject set operations with an |
| 996 |
inconsistentValue error if they lead to inconsistencies. |
| 997 |
|
| 998 |
o Removed the strict ordering constraints. Description clauses now |
| 999 |
must explain which InetAddressType object provides the context for |
| 1000 |
an InetAddress or InetAddressPrefixLength object. |
| 1001 |
|
| 1002 |
|
| 1003 |
|
| 1004 |
<span class="grey">Daniele, et al. Standards Track [Page 18]</span></pre> |
| 1005 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span> |
| 1006 |
<span class="grey"><a href="./rfc4001">RFC 4001</a> Internet Network Address Conventions February 2005</span> |
| 1007 |
|
| 1008 |
|
| 1009 |
o Aligned wordings with the IPv6 scoping architecture document. |
| 1010 |
|
| 1011 |
o Split the InetAddressIPv6 textual convention into the two textual |
| 1012 |
conventions (InetAddressIPv6 and InetAddressIPv6z) and introduced |
| 1013 |
a new textual convention InetAddressIPv4z. Added ipv4z(3) and |
| 1014 |
ipv6z(4) named numbers to the InetAddressType enumeration. |
| 1015 |
Motivations for this change: (i) to enable the introduction of a |
| 1016 |
textual conventions for non-global IPv4 addresses, (ii) alignment |
| 1017 |
with the textual conventions for transport addresses, (iii) |
| 1018 |
simpler compliance statements in cases where support for IPv6 |
| 1019 |
addresses with zone indices is not required, and (iv) to simplify |
| 1020 |
implementations for host systems that will never have to report |
| 1021 |
zone indices. |
| 1022 |
|
| 1023 |
<span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>. References</span> |
| 1024 |
|
| 1025 |
<span class="h3"><a class="selflink" id="section-10.1" href="#section-10.1">10.1</a>. Normative References</span> |
| 1026 |
|
| 1027 |
[<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate |
| 1028 |
Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, March 1997. |
| 1029 |
|
| 1030 |
[<a id="ref-RFC2578">RFC2578</a>] McCloghrie, K., Perkins, D., and J. Schoenwaelder, |
| 1031 |
"Structure of Management Information Version 2 (SMIv2)", |
| 1032 |
STD 58, <a href="./rfc2578">RFC 2578</a>, April 1999. |
| 1033 |
|
| 1034 |
[<a id="ref-RFC2579">RFC2579</a>] McCloghrie, K., Perkins, D., and J. Schoenwaelder, |
| 1035 |
"Textual Conventions for SMIv2", STD 58, <a href="./rfc2579">RFC 2579</a>, April |
| 1036 |
1999. |
| 1037 |
|
| 1038 |
[<a id="ref-RFC2580">RFC2580</a>] McCloghrie, K., Perkins, D., and J. Schoenwaelder, |
| 1039 |
"Conformance Statements for SMIv2", STD 58, <a href="./rfc2580">RFC 2580</a>, |
| 1040 |
April 1999. |
| 1041 |
|
| 1042 |
[<a id="ref-RFC3513">RFC3513</a>] Hinden, R. and S. Deering, "Internet Protocol Version 6 |
| 1043 |
(IPv6) Addressing Architecture", <a href="./rfc3513">RFC 3513</a>, April 2003. |
| 1044 |
|
| 1045 |
[<a id="ref-RFC4007">RFC4007</a>] Deering, S., Haberman, B., Jinmei, T., Nordmark, E., and |
| 1046 |
B. Zill, "IPv6 Scoped Address Architecture", <a href="./rfc4007">RFC 4007</a>, |
| 1047 |
February 2005. |
| 1048 |
|
| 1049 |
|
| 1050 |
|
| 1051 |
|
| 1052 |
|
| 1053 |
|
| 1054 |
|
| 1055 |
|
| 1056 |
|
| 1057 |
|
| 1058 |
|
| 1059 |
|
| 1060 |
<span class="grey">Daniele, et al. Standards Track [Page 19]</span></pre> |
| 1061 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span> |
| 1062 |
<span class="grey"><a href="./rfc4001">RFC 4001</a> Internet Network Address Conventions February 2005</span> |
| 1063 |
|
| 1064 |
|
| 1065 |
<span class="h3"><a class="selflink" id="section-10.2" href="#section-10.2">10.2</a>. Informative References</span> |
| 1066 |
|
| 1067 |
[<a id="ref-RFC2553">RFC2553</a>] Gilligan, R., Thomson, S., Bound, J., and W. Stevens, |
| 1068 |
"Basic Socket Interface Extensions for IPv6", <a href="./rfc2553">RFC 2553</a>, |
| 1069 |
March 1999. |
| 1070 |
|
| 1071 |
[<a id="ref-RFC2863">RFC2863</a>] McCloghrie, K. and F. Kastenholz, "The Interfaces Group |
| 1072 |
MIB", <a href="./rfc2863">RFC 2863</a>, June 2000. |
| 1073 |
|
| 1074 |
[<a id="ref-RFC3410">RFC3410</a>] Case, J., Mundy, R., Partain, D., and B. Stewart, |
| 1075 |
"Introduction and Applicability Statements for Internet- |
| 1076 |
Standard Management Framework", <a href="./rfc3410">RFC 3410</a>, December 2002. |
| 1077 |
|
| 1078 |
[<a id="ref-RFC3419">RFC3419</a>] Daniele, M. and J. Schoenwaelder, "Textual Conventions for |
| 1079 |
Transport Addresses", <a href="./rfc3419">RFC 3419</a>, December 2002. |
| 1080 |
|
| 1081 |
|
| 1082 |
|
| 1083 |
|
| 1084 |
|
| 1085 |
|
| 1086 |
|
| 1087 |
|
| 1088 |
|
| 1089 |
|
| 1090 |
|
| 1091 |
|
| 1092 |
|
| 1093 |
|
| 1094 |
|
| 1095 |
|
| 1096 |
|
| 1097 |
|
| 1098 |
|
| 1099 |
|
| 1100 |
|
| 1101 |
|
| 1102 |
|
| 1103 |
|
| 1104 |
|
| 1105 |
|
| 1106 |
|
| 1107 |
|
| 1108 |
|
| 1109 |
|
| 1110 |
|
| 1111 |
|
| 1112 |
|
| 1113 |
|
| 1114 |
|
| 1115 |
|
| 1116 |
<span class="grey">Daniele, et al. Standards Track [Page 20]</span></pre> |
| 1117 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span> |
| 1118 |
<span class="grey"><a href="./rfc4001">RFC 4001</a> Internet Network Address Conventions February 2005</span> |
| 1119 |
|
| 1120 |
|
| 1121 |
Authors' Addresses |
| 1122 |
|
| 1123 |
Michael Daniele |
| 1124 |
SyAM Software, Inc. |
| 1125 |
1 Chestnut St, Suite 3-I |
| 1126 |
Nashua, NH 03060 |
| 1127 |
USA |
| 1128 |
|
| 1129 |
Phone: +1 603 598-9575 |
| 1130 |
EMail: [email protected] |
| 1131 |
|
| 1132 |
|
| 1133 |
Brian Haberman |
| 1134 |
Johns Hopkins University Applied Physics Laboratory |
| 1135 |
11100 Johns Hopkins Road |
| 1136 |
Laurel, MD 20723-6099 |
| 1137 |
USA |
| 1138 |
|
| 1139 |
Phone: +1-443-778-1319 |
| 1140 |
EMail: [email protected] |
| 1141 |
|
| 1142 |
|
| 1143 |
Shawn A. Routhier |
| 1144 |
Wind River Systems, Inc. |
| 1145 |
500 Wind River Way |
| 1146 |
Alameda, CA 94501 |
| 1147 |
USA |
| 1148 |
|
| 1149 |
Phone: +1 510 749-2095 |
| 1150 |
EMail: [email protected] |
| 1151 |
|
| 1152 |
|
| 1153 |
Juergen Schoenwaelder |
| 1154 |
International University Bremen |
| 1155 |
P.O. Box 750 561 |
| 1156 |
28725 Bremen |
| 1157 |
Germany |
| 1158 |
|
| 1159 |
Phone: +49 421 200-3587 |
| 1160 |
EMail: [email protected] |
| 1161 |
|
| 1162 |
|
| 1163 |
|
| 1164 |
|
| 1165 |
|
| 1166 |
|
| 1167 |
|
| 1168 |
|
| 1169 |
|
| 1170 |
|
| 1171 |
|
| 1172 |
<span class="grey">Daniele, et al. Standards Track [Page 21]</span></pre> |
| 1173 |
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span> |
| 1174 |
<span class="grey"><a href="./rfc4001">RFC 4001</a> Internet Network Address Conventions February 2005</span> |
| 1175 |
|
| 1176 |
|
| 1177 |
Full Copyright Statement |
| 1178 |
|
| 1179 |
Copyright (C) The Internet Society (2005). |
| 1180 |
|
| 1181 |
This document is subject to the rights, licenses and restrictions |
| 1182 |
contained in <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a>, and at www.rfc-editor.org, and except as set |
| 1183 |
forth therein, the authors retain all their rights. |
| 1184 |
|
| 1185 |
This document and the information contained herein are provided on an |
| 1186 |
"AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS |
| 1187 |
OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET |
| 1188 |
ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, |
| 1189 |
INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE |
| 1190 |
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED |
| 1191 |
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. |
| 1192 |
|
| 1193 |
Intellectual Property |
| 1194 |
|
| 1195 |
The IETF takes no position regarding the validity or scope of any |
| 1196 |
Intellectual Property Rights or other rights that might be claimed to |
| 1197 |
pertain to the implementation or use of the technology described in |
| 1198 |
this document or the extent to which any license under such rights |
| 1199 |
might or might not be available; nor does it represent that it has |
| 1200 |
made any independent effort to identify any such rights. Information |
| 1201 |
on the ISOC's procedures with respect to rights in ISOC Documents can |
| 1202 |
be found in <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and <a href="https://www.rfc-editor.org/bcp/bcp79">BCP 79</a>. |
| 1203 |
|
| 1204 |
Copies of IPR disclosures made to the IETF Secretariat and any |
| 1205 |
assurances of licenses to be made available, or the result of an |
| 1206 |
attempt made to obtain a general license or permission for the use of |
| 1207 |
such proprietary rights by implementers or users of this |
| 1208 |
specification can be obtained from the IETF on-line IPR repository at |
| 1209 |
<a href="http://www.ietf.org/ipr">http://www.ietf.org/ipr</a>. |
| 1210 |
|
| 1211 |
The IETF invites any interested party to bring to its attention any |
| 1212 |
copyrights, patents or patent applications, or other proprietary |
| 1213 |
rights that may cover technology that may be required to implement |
| 1214 |
this standard. Please address the information to the IETF at ietf- |
| 1215 |
[email protected]. |
| 1216 |
|
| 1217 |
Acknowledgement |
| 1218 |
|
| 1219 |
Funding for the RFC Editor function is currently provided by the |
| 1220 |
Internet Society. |
| 1221 |
|
| 1222 |
|
| 1223 |
|
| 1224 |
|
| 1225 |
|
| 1226 |
|
| 1227 |
|
| 1228 |
Daniele, et al. Standards Track [Page 22] |
| 1229 |
</pre> |