Blame mibs/TRANSPORT-ADDRESS-MIB.txt

Packit fcad23
TRANSPORT-ADDRESS-MIB DEFINITIONS ::= BEGIN
Packit fcad23
Packit fcad23
IMPORTS
Packit fcad23
    MODULE-IDENTITY, OBJECT-IDENTITY, mib-2     FROM SNMPv2-SMI
Packit fcad23
    TEXTUAL-CONVENTION                          FROM SNMPv2-TC;
Packit fcad23
Packit fcad23
transportAddressMIB MODULE-IDENTITY
Packit fcad23
    LAST-UPDATED "200211010000Z"
Packit fcad23
    ORGANIZATION
Packit fcad23
        "IETF Operations and Management Area"
Packit fcad23
    CONTACT-INFO
Packit fcad23
        "Juergen Schoenwaelder (Editor)
Packit fcad23
         TU Braunschweig
Packit fcad23
         Bueltenweg 74/75
Packit fcad23
         38106 Braunschweig, Germany
Packit fcad23
Packit fcad23
         Phone: +49 531 391-3289
Packit fcad23
         EMail: schoenw@ibr.cs.tu-bs.de
Packit fcad23
Packit fcad23
         Send comments to <mibs@ops.ietf.org>."
Packit fcad23
    DESCRIPTION
Packit fcad23
        "This MIB module provides commonly used transport
Packit fcad23
         address definitions.
Packit fcad23
Packit fcad23
         Copyright (C) The Internet Society (2002). This version of
Packit fcad23
         this MIB module is part of RFC 3419; see the RFC itself for
Packit fcad23
         full legal notices."
Packit fcad23
Packit fcad23
    -- Revision log
Packit fcad23
Packit fcad23
    REVISION    "200211010000Z"
Packit fcad23
    DESCRIPTION
Packit fcad23
        "Initial version, published as RFC 3419."
Packit fcad23
    ::= { mib-2 100 }
Packit fcad23
Packit fcad23
transportDomains OBJECT IDENTIFIER ::= { transportAddressMIB 1 }
Packit fcad23
Packit fcad23
transportDomainUdpIpv4 OBJECT-IDENTITY
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The UDP over IPv4 transport domain.  The corresponding
Packit fcad23
         transport address is of type TransportAddressIPv4 for
Packit fcad23
         global IPv4 addresses."
Packit fcad23
    ::= { transportDomains 1 }
Packit fcad23
Packit fcad23
transportDomainUdpIpv6 OBJECT-IDENTITY
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The UDP over IPv6 transport domain.  The corresponding
Packit fcad23
         transport address is of type TransportAddressIPv6 for
Packit fcad23
         global IPv6 addresses."
Packit fcad23
    ::= { transportDomains 2 }
Packit fcad23
Packit fcad23
transportDomainUdpIpv4z OBJECT-IDENTITY
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The UDP over IPv4 transport domain.  The corresponding
Packit fcad23
         transport address is of type TransportAddressIPv4z for
Packit fcad23
         scoped IPv4 addresses with a zone index."
Packit fcad23
    ::= { transportDomains 3 }
Packit fcad23
Packit fcad23
transportDomainUdpIpv6z OBJECT-IDENTITY
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The UDP over IPv6 transport domain.  The corresponding
Packit fcad23
         transport address is of type TransportAddressIPv6z for
Packit fcad23
         scoped IPv6 addresses with a zone index."
Packit fcad23
    ::= { transportDomains 4 }
Packit fcad23
Packit fcad23
transportDomainTcpIpv4 OBJECT-IDENTITY
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The TCP over IPv4 transport domain.  The corresponding
Packit fcad23
         transport address is of type TransportAddressIPv4 for
Packit fcad23
         global IPv4 addresses."
Packit fcad23
    ::= { transportDomains 5 }
Packit fcad23
Packit fcad23
transportDomainTcpIpv6 OBJECT-IDENTITY
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The TCP over IPv6 transport domain.  The corresponding
Packit fcad23
         transport address is of type TransportAddressIPv6 for
Packit fcad23
         global IPv6 addresses."
Packit fcad23
    ::= { transportDomains 6 }
Packit fcad23
Packit fcad23
transportDomainTcpIpv4z OBJECT-IDENTITY
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The TCP over IPv4 transport domain.  The corresponding
Packit fcad23
         transport address is of type TransportAddressIPv4z for
Packit fcad23
         scoped IPv4 addresses with a zone index."
Packit fcad23
    ::= { transportDomains 7 }
Packit fcad23
Packit fcad23
transportDomainTcpIpv6z OBJECT-IDENTITY
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The TCP over IPv6 transport domain.  The corresponding
Packit fcad23
         transport address is of type TransportAddressIPv6z for
Packit fcad23
         scoped IPv6 addresses with a zone index."
Packit fcad23
    ::= { transportDomains 8 }
Packit fcad23
Packit fcad23
transportDomainSctpIpv4 OBJECT-IDENTITY
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The SCTP over IPv4 transport domain.  The corresponding
Packit fcad23
         transport address is of type TransportAddressIPv4 for
Packit fcad23
         global IPv4 addresses. This transport domain usually
Packit fcad23
         represents the primary address on multihomed SCTP
Packit fcad23
         endpoints."
Packit fcad23
    ::= { transportDomains 9 }
Packit fcad23
Packit fcad23
transportDomainSctpIpv6 OBJECT-IDENTITY
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The SCTP over IPv6 transport domain.  The corresponding
Packit fcad23
         transport address is of type TransportAddressIPv6 for
Packit fcad23
         global IPv6 addresses. This transport domain usually
Packit fcad23
         represents the primary address on multihomed SCTP
Packit fcad23
         endpoints."
Packit fcad23
    ::= { transportDomains 10 }
Packit fcad23
Packit fcad23
transportDomainSctpIpv4z OBJECT-IDENTITY
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The SCTP over IPv4 transport domain.  The corresponding
Packit fcad23
         transport address is of type TransportAddressIPv4z for
Packit fcad23
         scoped IPv4 addresses with a zone index. This transport
Packit fcad23
         domain usually represents the primary address on
Packit fcad23
         multihomed SCTP endpoints."
Packit fcad23
    ::= { transportDomains 11 }
Packit fcad23
Packit fcad23
transportDomainSctpIpv6z OBJECT-IDENTITY
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The SCTP over IPv6 transport domain.  The corresponding
Packit fcad23
         transport address is of type TransportAddressIPv6z for
Packit fcad23
         scoped IPv6 addresses with a zone index. This transport
Packit fcad23
         domain usually represents the primary address on
Packit fcad23
         multihomed SCTP endpoints."
Packit fcad23
    ::= { transportDomains 12 }
Packit fcad23
Packit fcad23
transportDomainLocal OBJECT-IDENTITY
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The Posix Local IPC transport domain. The corresponding
Packit fcad23
         transport address is of type TransportAddressLocal.
Packit fcad23
Packit fcad23
         The Posix Local IPC transport domain incorporates the
Packit fcad23
         well-known UNIX domain sockets."
Packit fcad23
    ::= { transportDomains 13 }
Packit fcad23
Packit fcad23
transportDomainUdpDns OBJECT-IDENTITY
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The UDP transport domain using fully qualified domain
Packit fcad23
         names. The corresponding transport address is of type
Packit fcad23
         TransportAddressDns."
Packit fcad23
    ::= { transportDomains 14 }
Packit fcad23
Packit fcad23
transportDomainTcpDns OBJECT-IDENTITY
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The TCP transport domain using fully qualified domain
Packit fcad23
         names. The corresponding transport address is of type
Packit fcad23
         TransportAddressDns."
Packit fcad23
    ::= { transportDomains 15 }
Packit fcad23
Packit fcad23
transportDomainSctpDns OBJECT-IDENTITY
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "The SCTP transport domain using fully qualified domain
Packit fcad23
         names. The corresponding transport address is of type
Packit fcad23
         TransportAddressDns."
Packit fcad23
    ::= { transportDomains 16 }
Packit fcad23
Packit fcad23
TransportDomain ::= TEXTUAL-CONVENTION
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A value that represents a transport domain.
Packit fcad23
Packit fcad23
         Some possible values, such as transportDomainUdpIpv4, are
Packit fcad23
         defined in this module.  Other possible values can be
Packit fcad23
         defined in other MIB modules."
Packit fcad23
    SYNTAX      OBJECT IDENTIFIER
Packit fcad23
Packit fcad23
--
Packit fcad23
-- The enumerated values of the textual convention below should
Packit fcad23
-- be identical to the last sub-identifier of the OID registered
Packit fcad23
-- for the same domain.
Packit fcad23
--
Packit fcad23
Packit fcad23
TransportAddressType ::= TEXTUAL-CONVENTION
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "A value that represents a transport domain. This is the
Packit fcad23
         enumerated version of the transport domain registrations
Packit fcad23
         in this MIB module. The enumerated values have the
Packit fcad23
         following meaning:
Packit fcad23
Packit fcad23
         unknown(0)     unknown transport address type
Packit fcad23
         udpIpv4(1)     transportDomainUdpIpv4
Packit fcad23
         udpIpv6(2)     transportDomainUdpIpv6
Packit fcad23
         udpIpv4z(3)    transportDomainUdpIpv4z
Packit fcad23
         udpIpv6z(4)    transportDomainUdpIpv6z
Packit fcad23
         tcpIpv4(5)     transportDomainTcpIpv4
Packit fcad23
         tcpIpv6(6)     transportDomainTcpIpv6
Packit fcad23
         tcpIpv4z(7)    transportDomainTcpIpv4z
Packit fcad23
Packit fcad23
         tcpIpv6z(8)    transportDomainTcpIpv6z
Packit fcad23
         sctpIpv4(9)    transportDomainSctpIpv4
Packit fcad23
         sctpIpv6(10)   transportDomainSctpIpv6
Packit fcad23
         sctpIpv4z(11)  transportDomainSctpIpv4z
Packit fcad23
         sctpIpv6z(12)  transportDomainSctpIpv6z
Packit fcad23
         local(13)      transportDomainLocal
Packit fcad23
         udpDns(14)     transportDomainUdpDns
Packit fcad23
         tcpDns(15)     transportDomainTcpDns
Packit fcad23
         sctpDns(16)    transportDomainSctpDns
Packit fcad23
Packit fcad23
         This textual convention can be used to represent transport
Packit fcad23
         domains in situations where a syntax of TransportDomain is
Packit fcad23
         unwieldy (for example, when used as an index).
Packit fcad23
Packit fcad23
         The usage of this textual convention implies that additional
Packit fcad23
         transport domains can only be supported by updating this MIB
Packit fcad23
         module. This extensibility restriction does not apply for the
Packit fcad23
         TransportDomain textual convention which allows MIB authors
Packit fcad23
         to define additional transport domains independently in
Packit fcad23
         other MIB modules."
Packit fcad23
    SYNTAX      INTEGER {
Packit fcad23
                    unknown(0),
Packit fcad23
                    udpIpv4(1),
Packit fcad23
                    udpIpv6(2),
Packit fcad23
                    udpIpv4z(3),
Packit fcad23
                    udpIpv6z(4),
Packit fcad23
                    tcpIpv4(5),
Packit fcad23
                    tcpIpv6(6),
Packit fcad23
                    tcpIpv4z(7),
Packit fcad23
                    tcpIpv6z(8),
Packit fcad23
                    sctpIpv4(9),
Packit fcad23
                    sctpIpv6(10),
Packit fcad23
                    sctpIpv4z(11),
Packit fcad23
                    sctpIpv6z(12),
Packit fcad23
                    local(13),
Packit fcad23
                    udpDns(14),
Packit fcad23
                    tcpDns(15),
Packit fcad23
                    sctpDns(16)
Packit fcad23
                }
Packit fcad23
Packit fcad23
TransportAddress ::= TEXTUAL-CONVENTION
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "Denotes a generic transport address.
Packit fcad23
Packit fcad23
         A TransportAddress value is always interpreted within the
Packit fcad23
         context of a TransportAddressType or TransportDomain value.
Packit fcad23
         Every usage of the TransportAddress textual convention MUST
Packit fcad23
Packit fcad23
         specify the TransportAddressType or TransportDomain object
Packit fcad23
         which provides the context. Furthermore, MIB authors SHOULD
Packit fcad23
         define a separate TransportAddressType or TransportDomain
Packit fcad23
         object for each TransportAddress object. It is suggested that
Packit fcad23
         the TransportAddressType or TransportDomain is logically
Packit fcad23
         registered before the object(s) which use the
Packit fcad23
         TransportAddress textual convention if they appear in the
Packit fcad23
         same logical row.
Packit fcad23
Packit fcad23
         The value of a TransportAddress object must always be
Packit fcad23
         consistent with the value of the associated
Packit fcad23
         TransportAddressType or TransportDomain object. Attempts
Packit fcad23
         to set a TransportAddress object to a value which is
Packit fcad23
         inconsistent with the associated TransportAddressType or
Packit fcad23
         TransportDomain must fail with an inconsistentValue error.
Packit fcad23
Packit fcad23
         When this textual convention is used as a syntax of an
Packit fcad23
         index object, there may be issues with the limit of 128
Packit fcad23
         sub-identifiers specified in SMIv2, STD 58. In this case,
Packit fcad23
         the OBJECT-TYPE declaration MUST include a 'SIZE' clause
Packit fcad23
         to limit the number of potential instance sub-identifiers."
Packit fcad23
    SYNTAX      OCTET STRING (SIZE (0..255))
Packit fcad23
Packit fcad23
TransportAddressIPv4 ::= TEXTUAL-CONVENTION
Packit fcad23
    DISPLAY-HINT "1d.1d.1d.1d:2d"
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "Represents a transport address consisting of an IPv4
Packit fcad23
         address and a port number (as used for example by UDP,
Packit fcad23
         TCP and SCTP):
Packit fcad23
Packit fcad23
          octets       contents         encoding
Packit fcad23
           1-4         IPv4 address     network-byte order
Packit fcad23
           5-6         port number      network-byte order
Packit fcad23
Packit fcad23
         This textual convention SHOULD NOT be used directly in object
Packit fcad23
         definitions since it restricts addresses to a specific format.
Packit fcad23
         However, if it is used, it MAY be used either on its own or
Packit fcad23
         in conjunction with TransportAddressType or TransportDomain
Packit fcad23
         as a pair."
Packit fcad23
    SYNTAX      OCTET STRING (SIZE (6))
Packit fcad23
Packit fcad23
TransportAddressIPv6 ::= TEXTUAL-CONVENTION
Packit fcad23
    DISPLAY-HINT "0a[2x:2x:2x:2x:2x:2x:2x:2x]0a:2d"
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "Represents a transport address consisting of an IPv6
Packit fcad23
         address and a port number (as used for example by UDP,
Packit fcad23
         TCP and SCTP):
Packit fcad23
Packit fcad23
          octets       contents         encoding
Packit fcad23
           1-16        IPv6 address     network-byte order
Packit fcad23
          17-18        port number      network-byte order
Packit fcad23
Packit fcad23
         This textual convention SHOULD NOT be used directly in object
Packit fcad23
         definitions since it restricts addresses to a specific format.
Packit fcad23
         However, if it is used, it MAY be used either on its own or
Packit fcad23
         in conjunction with TransportAddressType or TransportDomain
Packit fcad23
         as a pair."
Packit fcad23
    SYNTAX      OCTET STRING (SIZE (18))
Packit fcad23
Packit fcad23
TransportAddressIPv4z ::= TEXTUAL-CONVENTION
Packit fcad23
    DISPLAY-HINT "1d.1d.1d.1d%4d:2d"
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "Represents a transport address consisting of an IPv4
Packit fcad23
         address, a zone index and a port number (as used for
Packit fcad23
         example by UDP, TCP and SCTP):
Packit fcad23
Packit fcad23
          octets       contents         encoding
Packit fcad23
           1-4         IPv4 address     network-byte order
Packit fcad23
           5-8         zone index       network-byte order
Packit fcad23
           9-10        port number      network-byte order
Packit fcad23
Packit fcad23
         This textual convention SHOULD NOT be used directly in object
Packit fcad23
         definitions since it restricts addresses to a specific format.
Packit fcad23
         However, if it is used, it MAY be used either on its own or
Packit fcad23
         in conjunction with TransportAddressType or TransportDomain
Packit fcad23
         as a pair."
Packit fcad23
    SYNTAX      OCTET STRING (SIZE (10))
Packit fcad23
Packit fcad23
TransportAddressIPv6z ::= TEXTUAL-CONVENTION
Packit fcad23
    DISPLAY-HINT "0a[2x:2x:2x:2x:2x:2x:2x:2x%4d]0a:2d"
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "Represents a transport address consisting of an IPv6
Packit fcad23
         address, a zone index and a port number (as used for
Packit fcad23
         example by UDP, TCP and SCTP):
Packit fcad23
Packit fcad23
          octets       contents         encoding
Packit fcad23
           1-16        IPv6 address     network-byte order
Packit fcad23
          17-20        zone index       network-byte order
Packit fcad23
          21-22        port number      network-byte order
Packit fcad23
Packit fcad23
         This textual convention SHOULD NOT be used directly in object
Packit fcad23
         definitions since it restricts addresses to a specific format.
Packit fcad23
Packit fcad23
         However, if it is used, it MAY be used either on its own or
Packit fcad23
         in conjunction with TransportAddressType or TransportDomain
Packit fcad23
         as a pair."
Packit fcad23
    SYNTAX      OCTET STRING (SIZE (22))
Packit fcad23
Packit fcad23
TransportAddressLocal ::= TEXTUAL-CONVENTION
Packit fcad23
    DISPLAY-HINT "1a"
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "Represents a POSIX Local IPC transport address:
Packit fcad23
Packit fcad23
          octets       contents                   encoding
Packit fcad23
           all         POSIX Local IPC address    string
Packit fcad23
Packit fcad23
         The Posix Local IPC transport domain subsumes UNIX domain
Packit fcad23
         sockets.
Packit fcad23
Packit fcad23
         This textual convention SHOULD NOT be used directly in object
Packit fcad23
         definitions since it restricts addresses to a specific format.
Packit fcad23
         However, if it is used, it MAY be used either on its own or
Packit fcad23
         in conjunction with TransportAddressType or TransportDomain
Packit fcad23
         as a pair.
Packit fcad23
Packit fcad23
         When this textual convention is used as a syntax of an
Packit fcad23
         index object, there may be issues with the limit of 128
Packit fcad23
         sub-identifiers specified in SMIv2, STD 58. In this case,
Packit fcad23
         the OBJECT-TYPE declaration MUST include a 'SIZE' clause
Packit fcad23
         to limit the number of potential instance sub-identifiers."
Packit fcad23
    REFERENCE
Packit fcad23
        "Protocol Independent Interfaces (IEEE POSIX 1003.1g)"
Packit fcad23
    SYNTAX      OCTET STRING (SIZE (1..255))
Packit fcad23
Packit fcad23
TransportAddressDns ::= TEXTUAL-CONVENTION
Packit fcad23
    DISPLAY-HINT "1a"
Packit fcad23
    STATUS      current
Packit fcad23
    DESCRIPTION
Packit fcad23
        "Represents a DNS domain name followed by a colon ':'
Packit fcad23
         (ASCII character 0x3A) and a port number in ASCII.
Packit fcad23
         The name SHOULD be fully qualified whenever possible.
Packit fcad23
Packit fcad23
         Values of this textual convention are not directly useable as
Packit fcad23
         transport-layer addressing information, and require runtime
Packit fcad23
         resolution. As such, applications that write them must be
Packit fcad23
         prepared for handling errors if such values are not
Packit fcad23
         supported, or cannot be resolved (if resolution occurs at the
Packit fcad23
         time of the management operation).
Packit fcad23
Packit fcad23
         The DESCRIPTION clause of TransportAddress objects that may
Packit fcad23
Packit fcad23
         have TransportAddressDns values must fully describe how (and
Packit fcad23
         when) such names are to be resolved to IP addresses and vice
Packit fcad23
         versa.
Packit fcad23
Packit fcad23
         This textual convention SHOULD NOT be used directly in object
Packit fcad23
         definitions since it restricts addresses to a specific format.
Packit fcad23
         However, if it is used, it MAY be used either on its own or
Packit fcad23
         in conjunction with TransportAddressType or TransportDomain
Packit fcad23
         as a pair.
Packit fcad23
Packit fcad23
         When this textual convention is used as a syntax of an
Packit fcad23
         index object, there may be issues with the limit of 128
Packit fcad23
         sub-identifiers specified in SMIv2, STD 58. In this case,
Packit fcad23
         the OBJECT-TYPE declaration MUST include a 'SIZE' clause
Packit fcad23
         to limit the number of potential instance sub-identifiers."
Packit fcad23
    SYNTAX      OCTET STRING (SIZE (1..255))
Packit fcad23
Packit fcad23
END