UDP-MIB
Functions Overview
UDP-MIB, defined in RFC 4113, is used to query information about UDP statistics, UDP listeners, and UDP connections. UDP-MIB contains six simple variables and two table variables. The simple variables contain protocol statistics such as the number of received packets and the number of sent packets. The two tables contain the information about UDP listeners and connections. All the objects of UDP-MIB support only the Read operation, but not the Set operation. By querying information in the table, you can obtain complete UDP information.
Root directory:
iso(1).org(3).dod(6).internet(1).mgmt(2).mib-2(1).udp(7)
Relationships Between Tables
udpEndpointTable is an extension to udpTable. udpTable contains only two leaf objects: udpLocalAddress and udpLocalPort. udpLocalAddress in udpTable is the same as udpEndpointLocalPort in udpEndpointTable, and udpLocalAddress in udpTable is the same as udpEndpointLocalAddress in udpEndpointTable.
Description of Single Objects
udpInDatagrams
OID |
Object Name |
Syntax |
Max Access |
Description |
Implemented Specifications |
|---|---|---|---|---|---|
1.3.6.1.2.1.7.1 |
udpInDatagrams |
INTEGER (0..4294967295) |
Read-only |
The total number of UDP datagrams delivered to UDP users. |
This object is implemented as defined in the corresponding MIB files. |
udpNoPorts
OID |
Object Name |
Syntax |
Max Access |
Description |
Implemented Specifications |
|---|---|---|---|---|---|
1.3.6.1.2.1.7.2 |
udpNoPorts |
INTEGER (0..4294967295) |
Read-only |
The total number of received UDP datagrams for which there was no application at the destination port. |
This object is implemented as defined in the corresponding MIB files. |
udpInErrors
OID |
Object Name |
Syntax |
Max Access |
Description |
Implemented Specifications |
|---|---|---|---|---|---|
1.3.6.1.2.1.7.3 |
udpInErrors |
INTEGER (0..4294967295) |
Read-only |
The number of received UDP datagrams that cannot be delivered for reasons other than the lack of an application at the destination port. |
This object is implemented as defined in the corresponding MIB files. |
udpOutDatagrams
OID |
Object Name |
Syntax |
Max Access |
Description |
Implemented Specifications |
|---|---|---|---|---|---|
1.3.6.1.2.1.7.4 |
udpOutDatagrams |
INTEGER (0..4294967295) |
Read-only |
The total number of UDP datagrams sent from this entity. |
This object is implemented as defined in the corresponding MIB files. |
udpHCInDatagrams
OID |
Object Name |
Syntax |
Max Access |
Description |
Implemented Specifications |
|---|---|---|---|---|---|
1.3.6.1.2.1.7.8 |
udpHCInDatagrams |
INTEGER (0..18446744073709551615) |
Read-only |
The value of this object identifies the total number of UDP datagrams delivered to UDP users, for devices that can receive more than 1 million UDP datagrams per second. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by discontinuities in the value of sysUpTime. |
This object is implemented as defined in the corresponding MIB file. |
udpHCOutDatagrams
OID |
Object Name |
Syntax |
Max Access |
Description |
Implemented Specifications |
|---|---|---|---|---|---|
1.3.6.1.2.1.7.9 |
udpHCOutDatagrams |
INTEGER (0..18446744073709551615) |
Read-only |
The value of this object identifies the total number of UDP datagrams sent from this entity, for devices that can transmit more than one million UDP datagrams per second. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by discontinuities in the value of sysUpTime. |
This object is implemented as defined in the corresponding MIB file. |
Description of MIB Tables
udpTable
udpTable stores the information about all IPv4 UDP listeners and existing endpoints that receive data packets. This table contains two objects: udpLocalAddress and udpLocalPort.
The index of this table is udpLocalAddress and udpLocalPort.
OID |
Object Name |
Syntax |
Max Access |
Description |
Implemented Specifications |
|---|---|---|---|---|---|
1.3.6.1.2.1.7.5.1.1 |
udpLocalAddress |
OCTET STRING (SIZE (4)) |
Read-only |
This object indicates the local IP address for this UDP listener. In the case of a UDP listener which is willing to accept datagrams for any IP interface associated with the object, the value 0.0.0.0 is used. |
This object is implemented as defined in the corresponding MIB file. |
1.3.6.1.2.1.7.5.1.2 |
udpLocalPort |
INTEGER (0..65535) |
Read-only |
The value of this object identifies the local port number for this UDP listener. |
This object is implemented as defined in the corresponding MIB file. |
Creation Restriction
The entries in this table cannot be created.
Modification Restriction
The entries in this table cannot be modified.
Deletion Restriction
The entries in this table cannot be deleted.
Access Restriction
The table can be accessed only when there is the UDP socket that is bound to the interface number.
udpEndpointTable
A table containing information about this entity's UDP endpoints on which a local application is currently accepting or sending datagrams.
The address type in this table represents the address type used for the communication, irrespective of the higher-layer abstraction. For example, an application using IPv6 'sockets' to communicate via IPv4 between ::ffff:10.0.0.1 and ::ffff:10.0.0.2 would use InetAddressType ipv4(1).
Unlike the udpTable in RFC 2013, this table also allows the representation of an application that completely specifies both local and remote addresses and ports. A single application is represented in three possible ways:
- An application that is willing to accept both IPv4 and IPv6 datagrams is represented by udpEndpointLocalAddressType of unknown(0) and udpEndpointLocalAddress of ''h (a zero-length octet-string).
- An application that is willing to accept only IPv4 or only IPv6 datagrams is represented by udpEndpointLocalAddressType of the appropriate address type and udpEndpointLocalAddress of '0.0.0.0' or '::' respectively.
- An application that is listening for datagrams only for a specific IP address but from any remote system is represented by udpEndpointLocalAddressType of the appropriate address type, with udpEndpointLocalAddress specifying the local address.
In all cases where the remote is a wildcard, the udpEndpointRemoteAddressType is unknown(0), the udpEndpointRemoteAddress is ''h (a zero-length octet-string), and the udpEndpointRemotePort is 0.
If the operating system is demultiplexing UDP packets by remote address and port, or if the application has 'connected' the socket specifying a default remote address and port, the udpEndpointRemote* values should be used to reflect this.
This table contains the following leaf objects:
udpEndpointLocalAddressType
udpEndpointLocalAddress
udpEndpointLocalPort
udpEndpointRemoteAddressType
udpEndpointRemoteAddress
udpEndpointRemotePort
udpEndpointInstance
udpEndpointProcess
The indexes of this object are udpEndpointLocalAddressType, udpEndpointLocalAddress, udpEndpointLocalPort, udpEndpointRemoteAddressType, udpEndpointRemoteAddress, udpEndpointRemotePort, and udpEndpointInstance.
OID |
Object Name |
Syntax |
Max Access |
Description |
Implemented Specifications |
|---|---|---|---|---|---|
1.3.6.1.2.1.7.7.1.1 |
udpEndpointLocalAddressType |
INTEGER{unknown(0),ipv4(1),ipv6(2),ipv4z(3),ipv6z(4),dns(16)} |
Not-accessible |
This object indicates the address type of udpEndpointLocalAddress. Only IPv4, IPv4z, IPv6, and IPv6z addresses are expected, or unknown(0) if datagrams for all local IP addresses are accepted. |
Currently, the UDP module of the switches supports only IPv4(1) and IPv6(3). |
1.3.6.1.2.1.7.7.1.2 |
udpEndpointLocalAddress |
OCTET STRING (SIZE (0..255)) |
Not-accessible |
This object indicates the local IP address for this UDP endpoint. The value of this object can be represented in three possible ways, depending on the characteristics of the application: 1. For an application that is willing to accept both IPv4 and IPv6 datagrams, the value of this object must be ''h (a zero-length octet-string), with the value of the corresponding instance of the udpEndpointLocalAddressType object being unknown(0). 2. For an application that is willing to accept only IPv4 or only IPv6 datagrams, the value of this object must be '0.0.0.0' or '::', respectively, while the corresponding instance of the udpEndpointLocalAddressType object represents the appropriate address type. 3. For an application that is listening for data destined only to a specific IP address, the value of this object is the specific IP address for which this node is receiving packets, with the corresponding instance of the udpEndpointLocalAddressType object representing the appropriate address type. As this object is used in the index for the udpEndpointTable, implementers of this table should be careful not to create entries that would result in OIDs with more than 128 subidentifiers; else the information cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3. |
This object is implemented as defined in the corresponding MIB file. |
1.3.6.1.2.1.7.7.1.3 |
udpEndpointLocalPort |
Unsigned32 (0..65535) |
Not-accessible |
This object indicates the local port number for this UDP endpoint. |
This object is implemented as defined in the corresponding MIB file. |
1.3.6.1.2.1.7.7.1.4 |
udpEndpointRemoteAddressType |
INTEGER{unknown(0),ipv4(1),ipv6(2),ipv4z(3),ipv6z(4),dns(16)} |
Not-accessible |
This object indicates the address type of udpEndpointRemoteAddress. Only IPv4, IPv4z, IPv6, and IPv6z addresses are expected, or unknown(0) if datagrams for all remote IP addresses are accepted. Also, note that some combinations of udpEndpointLocalAdressType and udpEndpointRemoteAddressType are not supported. In particular, if the value of this object is not unknown(0), it is expected to always refer to the same IP version as udpEndpointLocalAddressType. |
Currently, the UDP module of the switches support only IPv4(1) and IPv6(3). |
1.3.6.1.2.1.7.7.1.5 |
udpEndpointRemoteAddress |
OCTET STRING (SIZE (0..255)) |
Not-accessible |
This object indicates the remote IP address for this UDP endpoint. If datagrams from any remote system are to be accepted, this value is ''h (a zero-length octet-string). Otherwise, it has the type described by udpEndpointRemoteAddressType and is the address of the remote system from which datagrams are to be accepted or to which all datagrams will be sent. As this object is used in the index for the udpEndpointTable, implementers of this table should be careful not to create entries that would result in OIDs with more than 128 subidentifiers; else the information cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3. |
This object is implemented as defined in the corresponding MIB file. |
1.3.6.1.2.1.7.7.1.6 |
udpEndpointRemotePort |
Unsigned32 (0..65535) |
Not-accessible |
This object indicates the remote port number for this UDP endpoint. If datagrams from any remote system are to be accepted, this value is zero. |
This object is implemented as defined in the corresponding MIB file. |
1.3.6.1.2.1.7.7.1.7 |
udpEndpointInstance |
Unsigned32 (1..'ffffffff'h) |
Not-accessible |
This object indicates the instance of this tuple. This object is used to distinguish among multiple processes 'connected' to the same UDP endpoint. For example, on a system implementing the BSD sockets interface, this would be used to support the SO_REUSEADDR and SO_REUSEPORT socket options. |
This object is implemented as defined in the corresponding MIB file. |
1.3.6.1.2.1.7.7.1.8 |
udpEndpointProcess |
INTEGER (0..4294967295) |
Read-only |
This object indicates the system's process ID for the process associated with this endpoint, or zero if there is no such process. This value is expected to be the same as HOST-RESOURCES-MIB::hrSWRunIndex or SYSAPPL-MIB:: sysApplElmtRunIndex for some row in the appropriate tables. |
This object is implemented as defined in the corresponding MIB file. |
Creation Restriction
This table cannot be created.
Modification Restriction
This table cannot be modified.
Deletion Restriction
This table cannot be deleted.
Access Restriction
The entries in this table can be read only when there is a UDP endpoint bound to an interface number. If a UDP endpoint establishes a connection with its remote end, the value of udpEndpointLocalAddress is the address of the remote end and the value of udpEndpointRemotePort is the interface number of the remote end. Otherwise, the values of udpEndpointLocalAddress and udpEndpointRemotePort are 0.