1TRANSPORT-ADDRESS-MIB DEFINITIONS ::= BEGIN
2
3IMPORTS
4    MODULE-IDENTITY, OBJECT-IDENTITY, mib-2     FROM SNMPv2-SMI
5    TEXTUAL-CONVENTION                          FROM SNMPv2-TC;
6
7transportAddressMIB 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         Phone: +49 531 391-3289
17         EMail: schoenw@ibr.cs.tu-bs.de
18
19         Send comments to <mibs@ops.ietf.org>."
20    DESCRIPTION
21        "This MIB module provides commonly used transport
22         address definitions.
23
24         Copyright (C) The Internet Society (2002). This version of
25         this MIB module is part of RFC 3419; see the RFC itself for
26         full legal notices."
27
28    -- Revision log
29
30    REVISION    "200211010000Z"
31    DESCRIPTION
32        "Initial version, published as RFC 3419."
33    ::= { mib-2 100 }
34
35
36transportDomains OBJECT IDENTIFIER ::= { transportAddressMIB 1 }
37
38transportDomainUdpIpv4 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
46transportDomainUdpIpv6 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
54transportDomainUdpIpv4z 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
62transportDomainUdpIpv6z 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
70transportDomainTcpIpv4 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
78transportDomainTcpIpv6 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
86transportDomainTcpIpv4z 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
94transportDomainTcpIpv6z 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
102transportDomainSctpIpv4 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
112transportDomainSctpIpv6 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
122transportDomainSctpIpv4z 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
132transportDomainSctpIpv6z 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
142transportDomainLocal 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
152transportDomainUdpDns 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
160transportDomainTcpDns 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
168transportDomainSctpDns 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
176TransportDomain ::= 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
192TransportAddressType ::= 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         tcpIpv6z(8)    transportDomainTcpIpv6z
209         sctpIpv4(9)    transportDomainSctpIpv4
210         sctpIpv6(10)   transportDomainSctpIpv6
211         sctpIpv4z(11)  transportDomainSctpIpv4z
212         sctpIpv6z(12)  transportDomainSctpIpv6z
213         local(13)      transportDomainLocal
214         udpDns(14)     transportDomainUdpDns
215         tcpDns(15)     transportDomainTcpDns
216         sctpDns(16)    transportDomainSctpDns
217
218         This textual convention can be used to represent transport
219         domains in situations where a syntax of TransportDomain is
220         unwieldy (for example, when used as an index).
221
222         The usage of this textual convention implies that additional
223         transport domains can only be supported by updating this MIB
224         module. This extensibility restriction does not apply for the
225         TransportDomain textual convention which allows MIB authors
226         to define additional transport domains independently in
227         other MIB modules."
228    SYNTAX      INTEGER {
229                    unknown(0),
230                    udpIpv4(1),
231                    udpIpv6(2),
232                    udpIpv4z(3),
233                    udpIpv6z(4),
234                    tcpIpv4(5),
235                    tcpIpv6(6),
236                    tcpIpv4z(7),
237                    tcpIpv6z(8),
238                    sctpIpv4(9),
239                    sctpIpv6(10),
240                    sctpIpv4z(11),
241                    sctpIpv6z(12),
242                    local(13),
243                    udpDns(14),
244                    tcpDns(15),
245                    sctpDns(16)
246                }
247
248TransportAddress ::= TEXTUAL-CONVENTION
249    STATUS      current
250    DESCRIPTION
251        "Denotes a generic transport address.
252
253         A TransportAddress value is always interpreted within the
254         context of a TransportAddressType or TransportDomain value.
255         Every usage of the TransportAddress textual convention MUST
256         specify the TransportAddressType or TransportDomain object
257         which provides the context. Furthermore, MIB authors SHOULD
258         define a separate TransportAddressType or TransportDomain
259         object for each TransportAddress object. It is suggested that
260         the TransportAddressType or TransportDomain is logically
261         registered before the object(s) which use the
262         TransportAddress textual convention if they appear in the
263         same logical row.
264
265         The value of a TransportAddress object must always be
266         consistent with the value of the associated
267         TransportAddressType or TransportDomain object. Attempts
268         to set a TransportAddress object to a value which is
269         inconsistent with the associated TransportAddressType or
270         TransportDomain must fail with an inconsistentValue error.
271
272         When this textual convention is used as a syntax of an
273         index object, there may be issues with the limit of 128
274         sub-identifiers specified in SMIv2, STD 58. In this case,
275         the OBJECT-TYPE declaration MUST include a 'SIZE' clause
276         to limit the number of potential instance sub-identifiers."
277    SYNTAX      OCTET STRING (SIZE (0..255))
278
279TransportAddressIPv4 ::= TEXTUAL-CONVENTION
280    DISPLAY-HINT "1d.1d.1d.1d:2d"
281    STATUS      current
282    DESCRIPTION
283        "Represents a transport address consisting of an IPv4
284         address and a port number (as used for example by UDP,
285         TCP and SCTP):
286
287          octets       contents         encoding
288           1-4         IPv4 address     network-byte order
289           5-6         port number      network-byte order
290
291         This textual convention SHOULD NOT be used directly in object
292         definitions since it restricts addresses to a specific format.
293         However, if it is used, it MAY be used either on its own or
294         in conjunction with TransportAddressType or TransportDomain
295         as a pair."
296    SYNTAX      OCTET STRING (SIZE (6))
297
298TransportAddressIPv6 ::= TEXTUAL-CONVENTION
299    DISPLAY-HINT "0a[2x:2x:2x:2x:2x:2x:2x:2x]0a:2d"
300    STATUS      current
301    DESCRIPTION
302        "Represents a transport address consisting of an IPv6
303         address and a port number (as used for example by UDP,
304         TCP and SCTP):
305
306          octets       contents         encoding
307           1-16        IPv6 address     network-byte order
308          17-18        port number      network-byte order
309
310         This textual convention SHOULD NOT be used directly in object
311         definitions since it restricts addresses to a specific format.
312         However, if it is used, it MAY be used either on its own or
313         in conjunction with TransportAddressType or TransportDomain
314         as a pair."
315    SYNTAX      OCTET STRING (SIZE (18))
316
317TransportAddressIPv4z ::= TEXTUAL-CONVENTION
318    DISPLAY-HINT "1d.1d.1d.1d%4d:2d"
319    STATUS      current
320    DESCRIPTION
321        "Represents a transport address consisting of an IPv4
322         address, a zone index and a port number (as used for
323         example by UDP, TCP and SCTP):
324
325          octets       contents         encoding
326           1-4         IPv4 address     network-byte order
327           5-8         zone index       network-byte order
328           9-10        port number      network-byte order
329
330         This textual convention SHOULD NOT be used directly in object
331         definitions since it restricts addresses to a specific format.
332         However, if it is used, it MAY be used either on its own or
333         in conjunction with TransportAddressType or TransportDomain
334         as a pair."
335    SYNTAX      OCTET STRING (SIZE (10))
336
337TransportAddressIPv6z ::= TEXTUAL-CONVENTION
338    DISPLAY-HINT "0a[2x:2x:2x:2x:2x:2x:2x:2x%4d]0a:2d"
339    STATUS      current
340    DESCRIPTION
341        "Represents a transport address consisting of an IPv6
342         address, a zone index and a port number (as used for
343         example by UDP, TCP and SCTP):
344
345          octets       contents         encoding
346           1-16        IPv6 address     network-byte order
347          17-20        zone index       network-byte order
348          21-22        port number      network-byte order
349
350         This textual convention SHOULD NOT be used directly in object
351         definitions since it restricts addresses to a specific format.
352         However, if it is used, it MAY be used either on its own or
353         in conjunction with TransportAddressType or TransportDomain
354         as a pair."
355    SYNTAX      OCTET STRING (SIZE (22))
356
357TransportAddressLocal ::= TEXTUAL-CONVENTION
358    DISPLAY-HINT "1a"
359    STATUS      current
360    DESCRIPTION
361        "Represents a POSIX Local IPC transport address:
362
363          octets       contents                   encoding
364           all         POSIX Local IPC address    string
365
366         The Posix Local IPC transport domain subsumes UNIX domain
367         sockets.
368
369         This textual convention SHOULD NOT be used directly in object
370         definitions since it restricts addresses to a specific format.
371         However, if it is used, it MAY be used either on its own or
372         in conjunction with TransportAddressType or TransportDomain
373         as a pair.
374
375         When this textual convention is used as a syntax of an
376         index object, there may be issues with the limit of 128
377         sub-identifiers specified in SMIv2, STD 58. In this case,
378         the OBJECT-TYPE declaration MUST include a 'SIZE' clause
379         to limit the number of potential instance sub-identifiers."
380    REFERENCE
381        "Protocol Independent Interfaces (IEEE POSIX 1003.1g)"
382    SYNTAX      OCTET STRING (SIZE (1..255))
383
384TransportAddressDns ::= TEXTUAL-CONVENTION
385    DISPLAY-HINT "1a"
386    STATUS      current
387    DESCRIPTION
388        "Represents a DNS domain name followed by a colon ':'
389         (ASCII character 0x3A) and a port number in ASCII.
390         The name SHOULD be fully qualified whenever possible.
391
392         Values of this textual convention are not directly useable as
393         transport-layer addressing information, and require runtime
394         resolution. As such, applications that write them must be
395         prepared for handling errors if such values are not
396         supported, or cannot be resolved (if resolution occurs at the
397         time of the management operation).
398
399         The DESCRIPTION clause of TransportAddress objects that may
400         have TransportAddressDns values must fully describe how (and
401         when) such names are to be resolved to IP addresses and vice
402         versa.
403
404         This textual convention SHOULD NOT be used directly in object
405         definitions since it restricts addresses to a specific format.
406         However, if it is used, it MAY be used either on its own or
407         in conjunction with TransportAddressType or TransportDomain
408         as a pair.
409
410         When this textual convention is used as a syntax of an
411         index object, there may be issues with the limit of 128
412         sub-identifiers specified in SMIv2, STD 58. In this case,
413         the OBJECT-TYPE declaration MUST include a 'SIZE' clause
414         to limit the number of potential instance sub-identifiers."
415    SYNTAX      OCTET STRING (SIZE (1..255))
416
417END
418