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