1
UDP-MIB DEFINITIONS ::= BEGIN
4
MODULE-IDENTITY, OBJECT-TYPE, Integer32, Counter32, Counter64,
5
Unsigned32, IpAddress, mib-2 FROM SNMPv2-SMI
6
MODULE-COMPLIANCE, OBJECT-GROUP FROM SNMPv2-CONF
7
InetAddress, InetAddressType,
8
InetPortNumber FROM INET-ADDRESS-MIB;
10
udpMIB MODULE-IDENTITY
11
LAST-UPDATED "200505200000Z" -- May 20, 2005
13
"IETF IPv6 Working Group
14
http://www.ietf.org/html.charters/ipv6-charter.html"
22
Phone: +1 650 330-7893
23
Email: <fenner@research.att.com>
27
Hewlett-Packard Company
28
8000 Foothills Blvd. M/S 5557
31
Phone: +1 916 785 4018
32
Email: <john.flick@hp.com>
34
Send comments to <ipv6@ietf.org>"
36
"The MIB module for managing UDP implementations.
37
Copyright (C) The Internet Society (2005). This
38
version of this MIB module is part of RFC 4113;
39
see the RFC itself for full legal notices."
40
REVISION "200505200000Z" -- May 20, 2005
42
"IP version neutral revision, incorporating the
45
- Added udpHCInDatagrams and udpHCOutDatagrams in order
46
to provide high-capacity counters for fast networks.
47
- Added text to the descriptions of all counter objects
48
to indicate how discontinuities are detected.
49
- Deprecated the IPv4-specific udpTable and replaced it
50
with the version neutral udpEndpointTable. This
51
table includes support for connected UDP endpoints
52
and support for identification of the operating
53
system process associated with a UDP endpoint.
54
- Deprecated the udpGroup and replaced it with object
55
groups representing the current set of objects.
56
- Deprecated udpMIBCompliance and replaced it with
57
udpMIBCompliance2, which includes the compliance
58
information for the new object groups.
60
This version published as RFC 4113."
61
REVISION "199411010000Z" -- November 1, 1994
63
"Initial SMIv2 version, published as RFC 2013."
64
REVISION "199103310000Z" -- March 31, 1991
66
"The initial revision of this MIB module was part of
67
MIB-II, published as RFC 1213."
71
udp OBJECT IDENTIFIER ::= { mib-2 7 }
73
udpInDatagrams OBJECT-TYPE
78
"The total number of UDP datagrams delivered to UDP
81
Discontinuities in the value of this counter can occur
82
at re-initialization of the management system, and at
83
other times as indicated by discontinuities in the
87
udpNoPorts OBJECT-TYPE
92
"The total number of received UDP datagrams for which
93
there was no application at the destination port.
95
Discontinuities in the value of this counter can occur
96
at re-initialization of the management system, and at
97
other times as indicated by discontinuities in the
101
udpInErrors OBJECT-TYPE
106
"The number of received UDP datagrams that could not be
107
delivered for reasons other than the lack of an
108
application at the destination port.
110
Discontinuities in the value of this counter can occur
111
at re-initialization of the management system, and at
112
other times as indicated by discontinuities in the
116
udpOutDatagrams OBJECT-TYPE
121
"The total number of UDP datagrams sent from this
124
Discontinuities in the value of this counter can occur
125
at re-initialization of the management system, and at
126
other times as indicated by discontinuities in the
130
udpHCInDatagrams OBJECT-TYPE
135
"The total number of UDP datagrams delivered to UDP
136
users, for devices that can receive more than 1
137
million UDP datagrams per second.
139
Discontinuities in the value of this counter can occur
140
at re-initialization of the management system, and at
141
other times as indicated by discontinuities in the
145
udpHCOutDatagrams OBJECT-TYPE
150
"The total number of UDP datagrams sent from this
151
entity, for devices that can transmit more than 1
152
million UDP datagrams per second.
154
Discontinuities in the value of this counter can occur
155
at re-initialization of the management system, and at
156
other times as indicated by discontinuities in the
164
udpEndpointTable OBJECT-TYPE
165
SYNTAX SEQUENCE OF UdpEndpointEntry
166
MAX-ACCESS not-accessible
169
"A table containing information about this entity's UDP
170
endpoints on which a local application is currently
171
accepting or sending datagrams.
173
The address type in this table represents the address
174
type used for the communication, irrespective of the
175
higher-layer abstraction. For example, an application
176
using IPv6 'sockets' to communicate via IPv4 between
177
::ffff:10.0.0.1 and ::ffff:10.0.0.2 would use
178
InetAddressType ipv4(1).
180
Unlike the udpTable in RFC 2013, this table also allows
181
the representation of an application that completely
182
specifies both local and remote addresses and ports. A
183
listening application is represented in three possible
186
1) An application that is willing to accept both IPv4
187
and IPv6 datagrams is represented by a
188
udpEndpointLocalAddressType of unknown(0) and a
189
udpEndpointLocalAddress of ''h (a zero-length
192
2) An application that is willing to accept only IPv4
193
or only IPv6 datagrams is represented by a
194
udpEndpointLocalAddressType of the appropriate
195
address type and a udpEndpointLocalAddress of
196
'0.0.0.0' or '::' respectively.
198
3) An application that is listening for datagrams only
199
for a specific IP address but from any remote
200
system is represented by a
201
udpEndpointLocalAddressType of the appropriate
202
address type, with udpEndpointLocalAddress
203
specifying the local address.
205
In all cases where the remote is a wildcard, the
206
udpEndpointRemoteAddressType is unknown(0), the
207
udpEndpointRemoteAddress is ''h (a zero-length
208
octet-string), and the udpEndpointRemotePort is 0.
210
If the operating system is demultiplexing UDP packets
211
by remote address and port, or if the application has
212
'connected' the socket specifying a default remote
213
address and port, the udpEndpointRemote* values should
214
be used to reflect this."
217
udpEndpointEntry OBJECT-TYPE
218
SYNTAX UdpEndpointEntry
219
MAX-ACCESS not-accessible
222
"Information about a particular current UDP endpoint.
224
Implementers need to be aware that if the total number
225
of elements (octets or sub-identifiers) in
226
udpEndpointLocalAddress and udpEndpointRemoteAddress
227
exceeds 111, then OIDs of column instances in this table
228
will have more than 128 sub-identifiers and cannot be
229
accessed using SNMPv1, SNMPv2c, or SNMPv3."
230
INDEX { udpEndpointLocalAddressType,
231
udpEndpointLocalAddress,
232
udpEndpointLocalPort,
233
udpEndpointRemoteAddressType,
234
udpEndpointRemoteAddress,
235
udpEndpointRemotePort,
236
udpEndpointInstance }
237
::= { udpEndpointTable 1 }
239
UdpEndpointEntry ::= SEQUENCE {
240
udpEndpointLocalAddressType InetAddressType,
241
udpEndpointLocalAddress InetAddress,
242
udpEndpointLocalPort InetPortNumber,
243
udpEndpointRemoteAddressType InetAddressType,
244
udpEndpointRemoteAddress InetAddress,
245
udpEndpointRemotePort InetPortNumber,
246
udpEndpointInstance Unsigned32,
247
udpEndpointProcess Unsigned32
250
udpEndpointLocalAddressType OBJECT-TYPE
251
SYNTAX InetAddressType
252
MAX-ACCESS not-accessible
255
"The address type of udpEndpointLocalAddress. Only
256
IPv4, IPv4z, IPv6, and IPv6z addresses are expected, or
257
unknown(0) if datagrams for all local IP addresses are
259
::= { udpEndpointEntry 1 }
261
udpEndpointLocalAddress OBJECT-TYPE
263
MAX-ACCESS not-accessible
266
"The local IP address for this UDP endpoint.
268
The value of this object can be represented in three
270
possible ways, depending on the characteristics of the
271
listening application:
273
1. For an application that is willing to accept both
274
IPv4 and IPv6 datagrams, the value of this object
275
must be ''h (a zero-length octet-string), with
276
the value of the corresponding instance of the
277
udpEndpointLocalAddressType object being unknown(0).
279
2. For an application that is willing to accept only IPv4
280
or only IPv6 datagrams, the value of this object
281
must be '0.0.0.0' or '::', respectively, while the
282
corresponding instance of the
283
udpEndpointLocalAddressType object represents the
284
appropriate address type.
286
3. For an application that is listening for data
287
destined only to a specific IP address, the value
288
of this object is the specific IP address for which
289
this node is receiving packets, with the
290
corresponding instance of the
291
udpEndpointLocalAddressType object representing the
292
appropriate address type.
294
As this object is used in the index for the
295
udpEndpointTable, implementors of this table should be
296
careful not to create entries that would result in OIDs
297
with more than 128 subidentifiers; else the information
298
cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3."
299
::= { udpEndpointEntry 2 }
301
udpEndpointLocalPort OBJECT-TYPE
302
SYNTAX InetPortNumber
303
MAX-ACCESS not-accessible
306
"The local port number for this UDP endpoint."
307
::= { udpEndpointEntry 3 }
309
udpEndpointRemoteAddressType OBJECT-TYPE
310
SYNTAX InetAddressType
311
MAX-ACCESS not-accessible
314
"The address type of udpEndpointRemoteAddress. Only
315
IPv4, IPv4z, IPv6, and IPv6z addresses are expected, or
316
unknown(0) if datagrams for all remote IP addresses are
317
accepted. Also, note that some combinations of
319
udpEndpointLocalAdressType and
320
udpEndpointRemoteAddressType are not supported. In
321
particular, if the value of this object is not
322
unknown(0), it is expected to always refer to the
323
same IP version as udpEndpointLocalAddressType."
324
::= { udpEndpointEntry 4 }
326
udpEndpointRemoteAddress OBJECT-TYPE
328
MAX-ACCESS not-accessible
331
"The remote IP address for this UDP endpoint. If
332
datagrams from any remote system are to be accepted,
333
this value is ''h (a zero-length octet-string).
334
Otherwise, it has the type described by
335
udpEndpointRemoteAddressType and is the address of the
336
remote system from which datagrams are to be accepted
337
(or to which all datagrams will be sent).
339
As this object is used in the index for the
340
udpEndpointTable, implementors of this table should be
341
careful not to create entries that would result in OIDs
342
with more than 128 subidentifiers; else the information
343
cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3."
344
::= { udpEndpointEntry 5 }
346
udpEndpointRemotePort OBJECT-TYPE
347
SYNTAX InetPortNumber
348
MAX-ACCESS not-accessible
351
"The remote port number for this UDP endpoint. If
352
datagrams from any remote system are to be accepted,
354
::= { udpEndpointEntry 6 }
356
udpEndpointInstance OBJECT-TYPE
357
SYNTAX Unsigned32 (1..'ffffffff'h)
358
MAX-ACCESS not-accessible
361
"The instance of this tuple. This object is used to
362
distinguish among multiple processes 'connected' to
363
the same UDP endpoint. For example, on a system
364
implementing the BSD sockets interface, this would be
365
used to support the SO_REUSEADDR and SO_REUSEPORT
367
::= { udpEndpointEntry 7 }
369
udpEndpointProcess OBJECT-TYPE
374
"The system's process ID for the process associated with
375
this endpoint, or zero if there is no such process.
376
This value is expected to be the same as
377
HOST-RESOURCES-MIB::hrSWRunIndex or SYSAPPL-MIB::
378
sysApplElmtRunIndex for some row in the appropriate
380
::= { udpEndpointEntry 8 }
385
SYNTAX SEQUENCE OF UdpEntry
386
MAX-ACCESS not-accessible
389
"A table containing IPv4-specific UDP listener
390
information. It contains information about all local
391
IPv4 UDP end-points on which an application is
392
currently accepting datagrams. This table has been
393
deprecated in favor of the version neutral
399
MAX-ACCESS not-accessible
402
"Information about a particular current UDP listener."
403
INDEX { udpLocalAddress, udpLocalPort }
406
UdpEntry ::= SEQUENCE {
407
udpLocalAddress IpAddress,
408
udpLocalPort Integer32
412
udpLocalAddress OBJECT-TYPE
417
"The local IP address for this UDP listener. In the
418
case of a UDP listener that is willing to accept
419
datagrams for any IP interface associated with the
420
node, the value 0.0.0.0 is used."
423
udpLocalPort OBJECT-TYPE
424
SYNTAX Integer32 (0..65535)
428
"The local port number for this UDP listener."
432
udpMIBConformance OBJECT IDENTIFIER ::= { udpMIB 2 }
433
udpMIBCompliances OBJECT IDENTIFIER ::= { udpMIBConformance 1 }
434
udpMIBGroups OBJECT IDENTIFIER ::= { udpMIBConformance 2 }
437
udpMIBCompliance2 MODULE-COMPLIANCE
440
"The compliance statement for systems that implement
443
There are a number of INDEX objects that cannot be
444
represented in the form of OBJECT clauses in SMIv2, but
445
for which we have the following compliance
446
requirements, expressed in OBJECT clause form in this
449
-- OBJECT udpEndpointLocalAddressType
450
-- SYNTAX InetAddressType { unknown(0), ipv4(1),
451
-- ipv6(2), ipv4z(3),
454
-- Support for dns(5) is not required.
455
-- OBJECT udpEndpointLocalAddress
457
-- SYNTAX InetAddress (SIZE(0|4|8|16|20))
459
-- Support is only required for zero-length
460
-- octet-strings, and for scoped and unscoped
461
-- IPv4 and IPv6 addresses.
462
-- OBJECT udpEndpointRemoteAddressType
463
-- SYNTAX InetAddressType { unknown(0), ipv4(1),
464
-- ipv6(2), ipv4z(3),
467
-- Support for dns(5) is not required.
468
-- OBJECT udpEndpointRemoteAddress
469
-- SYNTAX InetAddress (SIZE(0|4|8|16|20))
471
-- Support is only required for zero-length
472
-- octet-strings, and for scoped and unscoped
473
-- IPv4 and IPv6 addresses.
475
MODULE -- this module
476
MANDATORY-GROUPS { udpBaseGroup, udpEndpointGroup }
479
"This group is mandatory for systems that
480
are capable of receiving or transmitting more than
481
1 million UDP datagrams per second. 1 million
482
datagrams per second will cause a Counter32 to
483
wrap in just over an hour."
484
::= { udpMIBCompliances 2 }
486
udpMIBCompliance MODULE-COMPLIANCE
489
"The compliance statement for IPv4-only systems that
490
implement UDP. For IP version independence, this
491
compliance statement is deprecated in favor of
492
udpMIBCompliance2. However, agents are still
493
encouraged to implement these objects in order to
494
interoperate with the deployed base of managers."
495
MODULE -- this module
496
MANDATORY-GROUPS { udpGroup }
497
::= { udpMIBCompliances 1 }
500
udpGroup OBJECT-GROUP
501
OBJECTS { udpInDatagrams, udpNoPorts,
502
udpInErrors, udpOutDatagrams,
503
udpLocalAddress, udpLocalPort }
506
"The deprecated group of objects providing for
507
management of UDP over IPv4."
508
::= { udpMIBGroups 1 }
510
udpBaseGroup OBJECT-GROUP
511
OBJECTS { udpInDatagrams, udpNoPorts, udpInErrors,
515
"The group of objects providing for counters of UDP
517
::= { udpMIBGroups 2 }
519
udpHCGroup OBJECT-GROUP
520
OBJECTS { udpHCInDatagrams, udpHCOutDatagrams }
523
"The group of objects providing for counters of high
524
speed UDP implementations."
525
::= { udpMIBGroups 3 }
527
udpEndpointGroup OBJECT-GROUP
528
OBJECTS { udpEndpointProcess }
531
"The group of objects providing for the IP version
532
independent management of UDP 'endpoints'."
533
::= { udpMIBGroups 4 }
added
removed
mibs/UDP-MIB.txt
