This is a summary of information regarding objects below the udp MIB object, which is defined within the UDP-MIB MIB document as .1.3.6.1.2.1.7.
| Name | Type | Access | Description |
|---|---|---|---|
|
1
udpEndpointLocalAddressType |
INTEGER
InetAddressType (ENUM list below) | NoAccess |
Note: this object is based on the InetAddressType TEXTUAL-CONVENTION. 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. |
|
2
udpEndpointLocalAddress |
OCTETSTR
Legal Lengths: 0 .. 255 InetAddress | NoAccess |
Note: this object is based on the InetAddress TEXTUAL-CONVENTION.
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
listening 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, implementors 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.
|
|
3
udpEndpointLocalPort |
UNSIGNED32
Legal values: 0 .. 65535 InetPortNumber | NoAccess |
Note: this object is based on the InetPortNumber TEXTUAL-CONVENTION. The local port number for this UDP endpoint. |
|
4
udpEndpointRemoteAddressType |
INTEGER
InetAddressType (ENUM list below) | NoAccess |
Note: this object is based on the InetAddressType TEXTUAL-CONVENTION. 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. |
|
5
udpEndpointRemoteAddress |
OCTETSTR
Legal Lengths: 0 .. 255 InetAddress | NoAccess |
Note: this object is based on the InetAddress TEXTUAL-CONVENTION. 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, implementors 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. |
|
6
udpEndpointRemotePort |
UNSIGNED32
Legal values: 0 .. 65535 InetPortNumber | NoAccess |
Note: this object is based on the InetPortNumber TEXTUAL-CONVENTION. The remote port number for this UDP endpoint. If datagrams from any remote system are to be accepted, this value is zero. |
|
7
udpEndpointInstance |
UNSIGNED32
Legal values: 1 .. -1 | NoAccess |
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. |
These TEXTUAL-CONVENTIONS are used in other parts of the document above. They are SNMP's way of defining a datatype that is used repeatedly by other MIB objects. Any implementation implementing objects that use one of these definitions must follow its DESCRIPTION clause as well as the DESCRIPTION clause of the object itself.
| Name | Type | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| InetPortNumber | UNSIGNED32 | Represents a 16 bit port number of an Internet transport
layer protocol. Port numbers are assigned by IANA. A
current list of all assignments is available from
| ||||||||||||||
| InetAddress | OCTETSTR | Denotes a generic Internet address.
An InetAddress value is always interpreted within the context
of an InetAddressType value. Every usage of the InetAddress
textual convention is required to specify the InetAddressType
object that provides the context. It is suggested that the
InetAddressType object be logically registered before the
object(s) that use the InetAddress textual convention, if
they appear in the same logical row.
The value of an InetAddress object must always be
consistent with the value of the associated InetAddressType
object. Attempts to set an InetAddress object to a value
inconsistent with the associated InetAddressType
must fail with an inconsistentValue error.
When this textual convention is used as the syntax of an
index object, there may be issues with the limit of 128
sub-identifiers specified in SMIv2, STD 58. In this case,
the object definition MUST include a 'SIZE' clause to
limit the number of potential instance sub-identifiers;
otherwise the applicable constraints MUST be stated in
the appropriate conceptual row DESCRIPTION clauses, or
in the surrounding documentation if there is no single
DESCRIPTION clause that is appropriate. | ||||||||||||||
| InetAddressType | INTEGER
| A value that represents a type of Internet address.
unknown(0) An unknown address type. This value MUST
be used if the value of the corresponding
InetAddress object is a zero-length string.
It may also be used to indicate an IP address
that is not in one of the formats defined
below.
ipv4(1) An IPv4 address as defined by the
InetAddressIPv4 textual convention.
ipv6(2) An IPv6 address as defined by the
InetAddressIPv6 textual convention.
ipv4z(3) A non-global IPv4 address including a zone
index as defined by the InetAddressIPv4z
textual convention.
ipv6z(4) A non-global IPv6 address including a zone
index as defined by the InetAddressIPv6z
textual convention.
dns(16) A DNS domain name as defined by the
InetAddressDNS textual convention.
Each definition of a concrete InetAddressType value must be
accompanied by a definition of a textual convention for use
with that InetAddressType.
To support future extensions, the InetAddressType textual
convention SHOULD NOT be sub-typed in object type definitions.
It MAY be sub-typed in compliance statements in order to
require only a subset of these address types for a compliant
implementation.
Implementations must ensure that InetAddressType objects
and any dependent objects (e.g., InetAddress objects) are
consistent. An inconsistentValue error must be generated
if an attempt to change an InetAddressType object would,
for example, lead to an undefined InetAddress value. In
particular, InetAddressType/InetAddress pairs must be
changed together if the address type changes (e.g., from
ipv6(2) to ipv4(1)). |
Tree view generated by running: snmptranslate -Tp UDP-MIB::udp
+--udp(7) | +-- -R-- Counter udpInDatagrams(1) +-- -R-- Counter udpNoPorts(2) +-- -R-- Counter udpInErrors(3) +-- -R-- Counter udpOutDatagrams(4) | +--udpTable(5) | | | +--udpEntry(1) | | Index: udpLocalAddress, udpLocalPort | | | +-- -R-- IpAddr udpLocalAddress(1) | +-- -R-- Integer32 udpLocalPort(2) | Range: 0..65535 | +--udpEndpointTable(7) | | | +--udpEndpointEntry(1) | | Index: udpEndpointLocalAddressType, udpEndpointLocalAddress, udpEndpointLocalPort, udpEndpointRemoteAddressType, udpEndpointRemoteAddress, udpEndpointRemotePort, udpEndpointInstance | | | +-- ---- EnumVal udpEndpointLocalAddressType(1) | | Textual Convention: InetAddressType | | Values: unknown(0), ipv4(1), ipv6(2), ipv4z(3), ipv6z(4), dns(16) | +-- ---- String udpEndpointLocalAddress(2) | | Textual Convention: InetAddress | | Size: 0..255 | +-- ---- Unsigned udpEndpointLocalPort(3) | | Textual Convention: InetPortNumber | | Range: 0..65535 | +-- ---- EnumVal udpEndpointRemoteAddressType(4) | | Textual Convention: InetAddressType | | Values: unknown(0), ipv4(1), ipv6(2), ipv4z(3), ipv6z(4), dns(16) | +-- ---- String udpEndpointRemoteAddress(5) | | Textual Convention: InetAddress | | Size: 0..255 | +-- ---- Unsigned udpEndpointRemotePort(6) | | Textual Convention: InetPortNumber | | Range: 0..65535 | +-- ---- Unsigned udpEndpointInstance(7) | | Range: 1..4294967295 | +-- -R-- Unsigned udpEndpointProcess(8) | +-- -R-- Counter64 udpHCInDatagrams(8) +-- -R-- Counter64 udpHCOutDatagrams(9)
Last modified: Wednesday, 01-Aug-2018 04:41:28 UTC
For questions regarding web content and site functionality, please write to the net-snmp-users mail list.