Blame mibs/ietf/TRANSPORT-ADDRESS-MIB

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