Annotation of src/share/snmp/TRANSPORT-ADDRESS-MIB.txt, Revision 1.1
1.1 ! martijn 1: TRANSPORT-ADDRESS-MIB DEFINITIONS ::= BEGIN
! 2:
! 3: IMPORTS
! 4: MODULE-IDENTITY, OBJECT-IDENTITY, mib-2 FROM SNMPv2-SMI
! 5: TEXTUAL-CONVENTION FROM SNMPv2-TC;
! 6:
! 7: transportAddressMIB MODULE-IDENTITY
! 8: LAST-UPDATED "200211010000Z"
! 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 provides commonly used transport
! 23: address definitions.
! 24:
! 25: Copyright (C) The Internet Society (2002). This version of
! 26: this MIB module is part of RFC 3419; see the RFC itself for
! 27: full legal notices."
! 28:
! 29: -- Revision log
! 30:
! 31: REVISION "200211010000Z"
! 32: DESCRIPTION
! 33: "Initial version, published as RFC 3419."
! 34: ::= { mib-2 100 }
! 35:
! 36: transportDomains OBJECT IDENTIFIER ::= { transportAddressMIB 1 }
! 37:
! 38: transportDomainUdpIpv4 OBJECT-IDENTITY
! 39: STATUS current
! 40: DESCRIPTION
! 41: "The UDP over IPv4 transport domain. The corresponding
! 42: transport address is of type TransportAddressIPv4 for
! 43: global IPv4 addresses."
! 44: ::= { transportDomains 1 }
! 45:
! 46: transportDomainUdpIpv6 OBJECT-IDENTITY
! 47: STATUS current
! 48: DESCRIPTION
! 49: "The UDP over IPv6 transport domain. The corresponding
! 50: transport address is of type TransportAddressIPv6 for
! 51: global IPv6 addresses."
! 52: ::= { transportDomains 2 }
! 53:
! 54: transportDomainUdpIpv4z OBJECT-IDENTITY
! 55: STATUS current
! 56: DESCRIPTION
! 57: "The UDP over IPv4 transport domain. The corresponding
! 58: transport address is of type TransportAddressIPv4z for
! 59: scoped IPv4 addresses with a zone index."
! 60: ::= { transportDomains 3 }
! 61:
! 62: transportDomainUdpIpv6z OBJECT-IDENTITY
! 63: STATUS current
! 64: DESCRIPTION
! 65: "The UDP over IPv6 transport domain. The corresponding
! 66: transport address is of type TransportAddressIPv6z for
! 67: scoped IPv6 addresses with a zone index."
! 68: ::= { transportDomains 4 }
! 69:
! 70: transportDomainTcpIpv4 OBJECT-IDENTITY
! 71: STATUS current
! 72: DESCRIPTION
! 73: "The TCP over IPv4 transport domain. The corresponding
! 74: transport address is of type TransportAddressIPv4 for
! 75: global IPv4 addresses."
! 76: ::= { transportDomains 5 }
! 77:
! 78: transportDomainTcpIpv6 OBJECT-IDENTITY
! 79: STATUS current
! 80: DESCRIPTION
! 81: "The TCP over IPv6 transport domain. The corresponding
! 82: transport address is of type TransportAddressIPv6 for
! 83: global IPv6 addresses."
! 84: ::= { transportDomains 6 }
! 85:
! 86: transportDomainTcpIpv4z OBJECT-IDENTITY
! 87: STATUS current
! 88: DESCRIPTION
! 89: "The TCP over IPv4 transport domain. The corresponding
! 90: transport address is of type TransportAddressIPv4z for
! 91: scoped IPv4 addresses with a zone index."
! 92: ::= { transportDomains 7 }
! 93:
! 94: transportDomainTcpIpv6z OBJECT-IDENTITY
! 95: STATUS current
! 96: DESCRIPTION
! 97: "The TCP over IPv6 transport domain. The corresponding
! 98: transport address is of type TransportAddressIPv6z for
! 99: scoped IPv6 addresses with a zone index."
! 100: ::= { transportDomains 8 }
! 101:
! 102: transportDomainSctpIpv4 OBJECT-IDENTITY
! 103: STATUS current
! 104: DESCRIPTION
! 105: "The SCTP over IPv4 transport domain. The corresponding
! 106: transport address is of type TransportAddressIPv4 for
! 107: global IPv4 addresses. This transport domain usually
! 108: represents the primary address on multihomed SCTP
! 109: endpoints."
! 110: ::= { transportDomains 9 }
! 111:
! 112: transportDomainSctpIpv6 OBJECT-IDENTITY
! 113: STATUS current
! 114: DESCRIPTION
! 115: "The SCTP over IPv6 transport domain. The corresponding
! 116: transport address is of type TransportAddressIPv6 for
! 117: global IPv6 addresses. This transport domain usually
! 118: represents the primary address on multihomed SCTP
! 119: endpoints."
! 120: ::= { transportDomains 10 }
! 121:
! 122: transportDomainSctpIpv4z OBJECT-IDENTITY
! 123: STATUS current
! 124: DESCRIPTION
! 125: "The SCTP over IPv4 transport domain. The corresponding
! 126: transport address is of type TransportAddressIPv4z for
! 127: scoped IPv4 addresses with a zone index. This transport
! 128: domain usually represents the primary address on
! 129: multihomed SCTP endpoints."
! 130: ::= { transportDomains 11 }
! 131:
! 132: transportDomainSctpIpv6z OBJECT-IDENTITY
! 133: STATUS current
! 134: DESCRIPTION
! 135: "The SCTP over IPv6 transport domain. The corresponding
! 136: transport address is of type TransportAddressIPv6z for
! 137: scoped IPv6 addresses with a zone index. This transport
! 138: domain usually represents the primary address on
! 139: multihomed SCTP endpoints."
! 140: ::= { transportDomains 12 }
! 141:
! 142: transportDomainLocal OBJECT-IDENTITY
! 143: STATUS current
! 144: DESCRIPTION
! 145: "The Posix Local IPC transport domain. The corresponding
! 146: transport address is of type TransportAddressLocal.
! 147:
! 148: The Posix Local IPC transport domain incorporates the
! 149: well-known UNIX domain sockets."
! 150: ::= { transportDomains 13 }
! 151:
! 152: transportDomainUdpDns OBJECT-IDENTITY
! 153: STATUS current
! 154: DESCRIPTION
! 155: "The UDP transport domain using fully qualified domain
! 156: names. The corresponding transport address is of type
! 157: TransportAddressDns."
! 158: ::= { transportDomains 14 }
! 159:
! 160: transportDomainTcpDns OBJECT-IDENTITY
! 161: STATUS current
! 162: DESCRIPTION
! 163: "The TCP transport domain using fully qualified domain
! 164: names. The corresponding transport address is of type
! 165: TransportAddressDns."
! 166: ::= { transportDomains 15 }
! 167:
! 168: transportDomainSctpDns OBJECT-IDENTITY
! 169: STATUS current
! 170: DESCRIPTION
! 171: "The SCTP transport domain using fully qualified domain
! 172: names. The corresponding transport address is of type
! 173: TransportAddressDns."
! 174: ::= { transportDomains 16 }
! 175:
! 176: TransportDomain ::= TEXTUAL-CONVENTION
! 177: STATUS current
! 178: DESCRIPTION
! 179: "A value that represents a transport domain.
! 180:
! 181: Some possible values, such as transportDomainUdpIpv4, are
! 182: defined in this module. Other possible values can be
! 183: defined in other MIB modules."
! 184: SYNTAX OBJECT IDENTIFIER
! 185:
! 186: --
! 187: -- The enumerated values of the textual convention below should
! 188: -- be identical to the last sub-identifier of the OID registered
! 189: -- for the same domain.
! 190: --
! 191:
! 192: TransportAddressType ::= TEXTUAL-CONVENTION
! 193: STATUS current
! 194: DESCRIPTION
! 195: "A value that represents a transport domain. This is the
! 196: enumerated version of the transport domain registrations
! 197: in this MIB module. The enumerated values have the
! 198: following meaning:
! 199:
! 200: unknown(0) unknown transport address type
! 201: udpIpv4(1) transportDomainUdpIpv4
! 202: udpIpv6(2) transportDomainUdpIpv6
! 203: udpIpv4z(3) transportDomainUdpIpv4z
! 204: udpIpv6z(4) transportDomainUdpIpv6z
! 205: tcpIpv4(5) transportDomainTcpIpv4
! 206: tcpIpv6(6) transportDomainTcpIpv6
! 207: tcpIpv4z(7) transportDomainTcpIpv4z
! 208:
! 209: tcpIpv6z(8) transportDomainTcpIpv6z
! 210: sctpIpv4(9) transportDomainSctpIpv4
! 211: sctpIpv6(10) transportDomainSctpIpv6
! 212: sctpIpv4z(11) transportDomainSctpIpv4z
! 213: sctpIpv6z(12) transportDomainSctpIpv6z
! 214: local(13) transportDomainLocal
! 215: udpDns(14) transportDomainUdpDns
! 216: tcpDns(15) transportDomainTcpDns
! 217: sctpDns(16) transportDomainSctpDns
! 218:
! 219: This textual convention can be used to represent transport
! 220: domains in situations where a syntax of TransportDomain is
! 221: unwieldy (for example, when used as an index).
! 222:
! 223: The usage of this textual convention implies that additional
! 224: transport domains can only be supported by updating this MIB
! 225: module. This extensibility restriction does not apply for the
! 226: TransportDomain textual convention which allows MIB authors
! 227: to define additional transport domains independently in
! 228: other MIB modules."
! 229: SYNTAX INTEGER {
! 230: unknown(0),
! 231: udpIpv4(1),
! 232: udpIpv6(2),
! 233: udpIpv4z(3),
! 234: udpIpv6z(4),
! 235: tcpIpv4(5),
! 236: tcpIpv6(6),
! 237: tcpIpv4z(7),
! 238: tcpIpv6z(8),
! 239: sctpIpv4(9),
! 240: sctpIpv6(10),
! 241: sctpIpv4z(11),
! 242: sctpIpv6z(12),
! 243: local(13),
! 244: udpDns(14),
! 245: tcpDns(15),
! 246: sctpDns(16)
! 247: }
! 248:
! 249: TransportAddress ::= TEXTUAL-CONVENTION
! 250: STATUS current
! 251: DESCRIPTION
! 252: "Denotes a generic transport address.
! 253:
! 254: A TransportAddress value is always interpreted within the
! 255: context of a TransportAddressType or TransportDomain value.
! 256: Every usage of the TransportAddress textual convention MUST
! 257:
! 258: specify the TransportAddressType or TransportDomain object
! 259: which provides the context. Furthermore, MIB authors SHOULD
! 260: define a separate TransportAddressType or TransportDomain
! 261: object for each TransportAddress object. It is suggested that
! 262: the TransportAddressType or TransportDomain is logically
! 263: registered before the object(s) which use the
! 264: TransportAddress textual convention if they appear in the
! 265: same logical row.
! 266:
! 267: The value of a TransportAddress object must always be
! 268: consistent with the value of the associated
! 269: TransportAddressType or TransportDomain object. Attempts
! 270: to set a TransportAddress object to a value which is
! 271: inconsistent with the associated TransportAddressType or
! 272: TransportDomain must fail with an inconsistentValue error.
! 273:
! 274: When this textual convention is used as a syntax of an
! 275: index object, there may be issues with the limit of 128
! 276: sub-identifiers specified in SMIv2, STD 58. In this case,
! 277: the OBJECT-TYPE declaration MUST include a 'SIZE' clause
! 278: to limit the number of potential instance sub-identifiers."
! 279: SYNTAX OCTET STRING (SIZE (0..255))
! 280:
! 281: TransportAddressIPv4 ::= TEXTUAL-CONVENTION
! 282: DISPLAY-HINT "1d.1d.1d.1d:2d"
! 283: STATUS current
! 284: DESCRIPTION
! 285: "Represents a transport address consisting of an IPv4
! 286: address and a port number (as used for example by UDP,
! 287: TCP and SCTP):
! 288:
! 289: octets contents encoding
! 290: 1-4 IPv4 address network-byte order
! 291: 5-6 port number network-byte order
! 292:
! 293: This textual convention SHOULD NOT be used directly in object
! 294: definitions since it restricts addresses to a specific format.
! 295: However, if it is used, it MAY be used either on its own or
! 296: in conjunction with TransportAddressType or TransportDomain
! 297: as a pair."
! 298: SYNTAX OCTET STRING (SIZE (6))
! 299:
! 300: TransportAddressIPv6 ::= TEXTUAL-CONVENTION
! 301: DISPLAY-HINT "0a[2x:2x:2x:2x:2x:2x:2x:2x]0a:2d"
! 302: STATUS current
! 303: DESCRIPTION
! 304: "Represents a transport address consisting of an IPv6
! 305: address and a port number (as used for example by UDP,
! 306: TCP and SCTP):
! 307:
! 308: octets contents encoding
! 309: 1-16 IPv6 address network-byte order
! 310: 17-18 port number network-byte order
! 311:
! 312: This textual convention SHOULD NOT be used directly in object
! 313: definitions since it restricts addresses to a specific format.
! 314: However, if it is used, it MAY be used either on its own or
! 315: in conjunction with TransportAddressType or TransportDomain
! 316: as a pair."
! 317: SYNTAX OCTET STRING (SIZE (18))
! 318:
! 319: TransportAddressIPv4z ::= TEXTUAL-CONVENTION
! 320: DISPLAY-HINT "1d.1d.1d.1d%4d:2d"
! 321: STATUS current
! 322: DESCRIPTION
! 323: "Represents a transport address consisting of an IPv4
! 324: address, a zone index and a port number (as used for
! 325: example by UDP, TCP and SCTP):
! 326:
! 327: octets contents encoding
! 328: 1-4 IPv4 address network-byte order
! 329: 5-8 zone index network-byte order
! 330: 9-10 port number network-byte order
! 331:
! 332: This textual convention SHOULD NOT be used directly in object
! 333: definitions since it restricts addresses to a specific format.
! 334: However, if it is used, it MAY be used either on its own or
! 335: in conjunction with TransportAddressType or TransportDomain
! 336: as a pair."
! 337: SYNTAX OCTET STRING (SIZE (10))
! 338:
! 339: TransportAddressIPv6z ::= TEXTUAL-CONVENTION
! 340: DISPLAY-HINT "0a[2x:2x:2x:2x:2x:2x:2x:2x%4d]0a:2d"
! 341: STATUS current
! 342: DESCRIPTION
! 343: "Represents a transport address consisting of an IPv6
! 344: address, a zone index and a port number (as used for
! 345: example by UDP, TCP and SCTP):
! 346:
! 347: octets contents encoding
! 348: 1-16 IPv6 address network-byte order
! 349: 17-20 zone index network-byte order
! 350: 21-22 port number network-byte order
! 351:
! 352: This textual convention SHOULD NOT be used directly in object
! 353: definitions since it restricts addresses to a specific format.
! 354:
! 355: However, if it is used, it MAY be used either on its own or
! 356: in conjunction with TransportAddressType or TransportDomain
! 357: as a pair."
! 358: SYNTAX OCTET STRING (SIZE (22))
! 359:
! 360: TransportAddressLocal ::= TEXTUAL-CONVENTION
! 361: DISPLAY-HINT "1a"
! 362: STATUS current
! 363: DESCRIPTION
! 364: "Represents a POSIX Local IPC transport address:
! 365:
! 366: octets contents encoding
! 367: all POSIX Local IPC address string
! 368:
! 369: The Posix Local IPC transport domain subsumes UNIX domain
! 370: sockets.
! 371:
! 372: This textual convention SHOULD NOT be used directly in object
! 373: definitions since it restricts addresses to a specific format.
! 374: However, if it is used, it MAY be used either on its own or
! 375: in conjunction with TransportAddressType or TransportDomain
! 376: as a pair.
! 377:
! 378: When this textual convention is used as a syntax of an
! 379: index object, there may be issues with the limit of 128
! 380: sub-identifiers specified in SMIv2, STD 58. In this case,
! 381: the OBJECT-TYPE declaration MUST include a 'SIZE' clause
! 382: to limit the number of potential instance sub-identifiers."
! 383: REFERENCE
! 384: "Protocol Independent Interfaces (IEEE POSIX 1003.1g)"
! 385: SYNTAX OCTET STRING (SIZE (1..255))
! 386:
! 387: TransportAddressDns ::= TEXTUAL-CONVENTION
! 388: DISPLAY-HINT "1a"
! 389: STATUS current
! 390: DESCRIPTION
! 391: "Represents a DNS domain name followed by a colon ':'
! 392: (ASCII character 0x3A) and a port number in ASCII.
! 393: The name SHOULD be fully qualified whenever possible.
! 394:
! 395: Values of this textual convention are not directly useable as
! 396: transport-layer addressing information, and require runtime
! 397: resolution. As such, applications that write them must be
! 398: prepared for handling errors if such values are not
! 399: supported, or cannot be resolved (if resolution occurs at the
! 400: time of the management operation).
! 401:
! 402: The DESCRIPTION clause of TransportAddress objects that may
! 403:
! 404: have TransportAddressDns values must fully describe how (and
! 405: when) such names are to be resolved to IP addresses and vice
! 406: versa.
! 407:
! 408: This textual convention SHOULD NOT be used directly in object
! 409: definitions since it restricts addresses to a specific format.
! 410: However, if it is used, it MAY be used either on its own or
! 411: in conjunction with TransportAddressType or TransportDomain
! 412: as a pair.
! 413:
! 414: When this textual convention is used as a syntax of an
! 415: index object, there may be issues with the limit of 128
! 416: sub-identifiers specified in SMIv2, STD 58. In this case,
! 417: the OBJECT-TYPE declaration MUST include a 'SIZE' clause
! 418: to limit the number of potential instance sub-identifiers."
! 419: SYNTAX OCTET STRING (SIZE (1..255))
! 420:
! 421: END