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