This is a summary of information regarding objects below the notificationLogMIB MIB object, which is defined within the NOTIFICATION-LOG-MIB MIB document as .1.3.6.1.2.1.92.
Name | Type | Access | Description |
---|---|---|---|
1
nlmLogName |
OCTETSTR
Legal Lengths: 0 .. 32 SnmpAdminString | NoAccess |
Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. The name of the log. An implementation may allow multiple named logs, up to some implementation-specific limit (which may be none). A zero-length log name is reserved for creation and deletion by the managed system, and MUST be used as the default log name by systems that do not support named logs. |
Name | Type | Access | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
2
nlmConfigLogFilterName |
OCTETSTR
Legal Lengths: 0 .. 32 SnmpAdminString | Create |
Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. A value of snmpNotifyFilterProfileName as used as an index into the snmpNotifyFilterTable in the SNMP Notification MIB, specifying the locally or remotely originated Notifications to be filtered out and not logged in this log. A zero-length value or a name that does not identify an existing entry in snmpNotifyFilterTable indicate no Notifications are to be logged in this log. |
||||||||
3
nlmConfigLogEntryLimit | UNSIGNED32 | Create |
The maximum number of notification entries that can be held in nlmLogTable for this named log. A particular setting does not guarantee that that much data can be held. If an application changes the limit while there are Notifications in the log, the oldest Notifications are discarded to bring the log down to the new limit. A value of 0 indicates no limit. Please be aware that contention between multiple managers trying to set this object to different values MAY affect the reliability and completeness of data seen by each manager. |
||||||||
4
nlmConfigLogAdminStatus |
INTEGER
| Create |
Control to enable or disable the log without otherwise disturbing the log's entry. Please be aware that contention between multiple managers trying to set this object to different values MAY affect the reliability and completeness of data seen by each manager. |
||||||||
5
nlmConfigLogOperStatus |
INTEGER
| ReadOnly |
The operational status of this log: disabled administratively disabled operational administratively enabled and working noFilter administratively enabled but either nlmConfigLogFilterName is zero length or does not name an existing entry in snmpNotifyFilterTable |
||||||||
6
nlmConfigLogStorageType |
INTEGER
StorageType (ENUM list below) | Create |
Note: this object is based on the StorageType TEXTUAL-CONVENTION. The storage type of this conceptual row. |
||||||||
7
nlmConfigLogEntryStatus |
INTEGER
RowStatus (ENUM list below) | Create |
Note: this object is based on the RowStatus TEXTUAL-CONVENTION. Control for creating and deleting entries. Entries may be modified while active. For non-null-named logs, the managed system records the security credentials from the request that sets nlmConfigLogStatus to 'active' and uses that identity to apply access control to the objects in the Notification to decide if that Notification may be logged. |
Name | Type | Access | Description |
---|---|---|---|
1
nlmLogName |
OCTETSTR
Legal Lengths: 0 .. 32 SnmpAdminString | NoAccess |
Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. The name of the log. An implementation may allow multiple named logs, up to some implementation-specific limit (which may be none). A zero-length log name is reserved for creation and deletion by the managed system, and MUST be used as the default log name by systems that do not support named logs. |
Name | Type | Access | Description |
---|---|---|---|
1
nlmLogName |
OCTETSTR
Legal Lengths: 0 .. 32 SnmpAdminString | NoAccess |
Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. The name of the log. An implementation may allow multiple named logs, up to some implementation-specific limit (which may be none). A zero-length log name is reserved for creation and deletion by the managed system, and MUST be used as the default log name by systems that do not support named logs. |
1
nlmLogIndex |
UNSIGNED32
Legal values: 1 .. -1 | NoAccess |
A monotonically increasing integer for the sole purpose of indexing entries within the named log. When it reaches the maximum value, an extremely unlikely event, the agent wraps the value back to 1. |
Name | Type | Access | Description |
---|---|---|---|
2
nlmLogTime |
TICKS
TimeStamp | ReadOnly |
Note: this object is based on the TimeStamp TEXTUAL-CONVENTION. The value of sysUpTime when the entry was placed in the log. If the entry occurred before the most recent management system initialization this object value MUST be set to zero. |
3
nlmLogDateAndTime |
OCTETSTR
Legal Lengths: 8 , 11 DateAndTime | ReadOnly |
Note: this object is based on the DateAndTime TEXTUAL-CONVENTION. The local date and time when the entry was logged, instantiated only by systems that have date and time capability. |
4
nlmLogEngineID |
OCTETSTR
Legal Lengths: 5 .. 32 SnmpEngineID | ReadOnly |
Note: this object is based on the SnmpEngineID TEXTUAL-CONVENTION. The identification of the SNMP engine at which the Notification originated. If the log can contain Notifications from only one engine or the Trap is in SNMPv1 format, this object is a zero-length string. |
5
nlmLogEngineTAddress |
OCTETSTR
Legal Lengths: 1 .. 255 TAddress | ReadOnly |
Note: this object is based on the TAddress TEXTUAL-CONVENTION. The transport service address of the SNMP engine from which the Notification was received, formatted according to the corresponding value of nlmLogEngineTDomain. This is used to identify the source of an SNMPv1 trap, since an nlmLogEngineId cannot be extracted from the SNMPv1 trap pdu. This object MUST always be instantiated, even if the log can contain Notifications from only one engine. Please be aware that the nlmLogEngineTAddress may not uniquely identify the SNMP engine from which the Notification was received. For example, if an SNMP engine uses DHCP or NAT to obtain ip addresses, the address it uses may be shared with other network devices, and hence will not uniquely identify the SNMP engine. |
6
nlmLogEngineTDomain |
OBJECTID
TDomain | ReadOnly |
Note: this object is based on the TDomain TEXTUAL-CONVENTION. Indicates the kind of transport service by which a Notification was received from an SNMP engine. nlmLogEngineTAddress contains the transport service address of the SNMP engine from which this Notification was received. Possible values for this object are presently found in the Transport Mappings for SNMPv2 document (RFC 1906 [8]). |
7
nlmLogContextEngineID |
OCTETSTR
Legal Lengths: 5 .. 32 SnmpEngineID | ReadOnly |
Note: this object is based on the SnmpEngineID TEXTUAL-CONVENTION. If the Notification was received in a protocol which has a contextEngineID element like SNMPv3, this object has that value. Otherwise its value is a zero-length string. |
8
nlmLogContextName |
OCTETSTR
Legal Lengths: 0 .. 255 SnmpAdminString | ReadOnly |
Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. The name of the SNMP MIB context from which the Notification came. For SNMPv1 Traps this is the community string from the Trap. |
9
nlmLogNotificationID | OBJECTID | ReadOnly |
The NOTIFICATION-TYPE object identifier of the Notification that occurred. |
Name | Type | Access | Description |
---|---|---|---|
1
nlmLogName |
OCTETSTR
Legal Lengths: 0 .. 32 SnmpAdminString | NoAccess |
Note: this object is based on the SnmpAdminString TEXTUAL-CONVENTION. The name of the log. An implementation may allow multiple named logs, up to some implementation-specific limit (which may be none). A zero-length log name is reserved for creation and deletion by the managed system, and MUST be used as the default log name by systems that do not support named logs. |
1
nlmLogIndex |
UNSIGNED32
Legal values: 1 .. -1 | NoAccess |
A monotonically increasing integer for the sole purpose of indexing entries within the named log. When it reaches the maximum value, an extremely unlikely event, the agent wraps the value back to 1. |
1
nlmLogVariableIndex |
UNSIGNED32
Legal values: 1 .. -1 | NoAccess |
A monotonically increasing integer, starting at 1 for a given nlmLogIndex, for indexing variables within the logged Notification. |
SCALAR OBJECTS
TABLE OBJECTS |
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 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TimeStamp | TICKS | The value of the sysUpTime object at which a specific occurrence happened. The specific occurrence must be defined in the description of any object defined using this type. If sysUpTime is reset to zero as a result of a re- initialization of the network management (sub)system, then the values of all TimeStamp objects are also reset. However, after approximately 497 days without a re- initialization, the sysUpTime object will reach 2^^32-1 and then increment around to zero; in this case, existing values of TimeStamp objects do not change. This can lead to ambiguities in the value of TimeStamp objects. | ||||||||||||||
TAddress | OCTETSTR | Denotes a transport service address. A TAddress value is always interpreted within the context of a TDomain value. Thus, each definition of a TDomain value must be accompanied by a definition of a textual convention for use with that TDomain. Some possible textual conventions, such as SnmpUDPAddress for snmpUDPDomain, are defined in the SNMPv2-TM MIB module. Other possible textual conventions are defined in other MIB modules. | ||||||||||||||
StorageType | INTEGER
| Describes the memory realization of a conceptual row. A row which is volatile(2) is lost upon reboot. A row which is either nonVolatile(3), permanent(4) or readOnly(5), is backed up by stable storage. A row which is permanent(4) can be changed but not deleted. A row which is readOnly(5) cannot be changed nor deleted. If the value of an object with this syntax is either permanent(4) or readOnly(5), it cannot be written. Conversely, if the value is either other(1), volatile(2) or nonVolatile(3), it cannot be modified to be permanent(4) or readOnly(5). (All illegal modifications result in a 'wrongValue' error.) Every usage of this textual convention is required to specify the columnar objects which a permanent(4) row must at a minimum allow to be writable. | ||||||||||||||
SnmpEngineID | OCTETSTR | An SNMP engine's administratively-unique identifier. Objects of this type are for identification, not for addressing, even though it is possible that an address may have been used in the generation of a specific value. The value for this object may not be all zeros or all 'ff'H or the empty (zero length) string. The initial value for this object may be configured via an operator console entry or via an algorithmic function. In the latter case, the following example algorithm is recommended. In cases where there are multiple engines on the same system, the use of this algorithm is NOT appropriate, as it would result in all of those engines ending up with the same ID value. 1) The very first bit is used to indicate how the rest of the data is composed. 0 - as defined by enterprise using former methods that existed before SNMPv3. See item 2 below. 1 - as defined by this architecture, see item 3 below. Note that this allows existing uses of the engineID (also known as AgentID [RFC1910]) to co-exist with any new uses. 2) The snmpEngineID has a length of 12 octets. The first four octets are set to the binary equivalent of the agent's SNMP management private enterprise number as assigned by the Internet Assigned Numbers Authority (IANA). For example, if Acme Networks has been assigned { enterprises 696 }, the first four octets would be assigned '000002b8'H. The remaining eight octets are determined via one or more enterprise-specific methods. Such methods must be designed so as to maximize the possibility that the value of this object will be unique in the agent's administrative domain. For example, it may be the IP address of the SNMP entity, or the MAC address of one of the interfaces, with each address suitably padded with random octets. If multiple methods are defined, then it is recommended that the first octet indicate the method being used and the remaining octets be a function of the method. 3) The length of the octet string varies. The first four octets are set to the binary equivalent of the agent's SNMP management private enterprise number as assigned by the Internet Assigned Numbers Authority (IANA). For example, if Acme Networks has been assigned { enterprises 696 }, the first four octets would be assigned '000002b8'H. The very first bit is set to 1. For example, the above value for Acme Networks now changes to be '800002b8'H. The fifth octet indicates how the rest (6th and following octets) are formatted. The values for the fifth octet are: 0 - reserved, unused. 1 - IPv4 address (4 octets) lowest non-special IP address 2 - IPv6 address (16 octets) lowest non-special IP address 3 - MAC address (6 octets) lowest IEEE MAC address, canonical order 4 - Text, administratively a | ||||||||||||||
DateAndTime | OCTETSTR | A date-time specification. field octets contents range ----- ------ -------- ----- 1 1-2 year* 0..65536 2 3 month 1..12 3 4 day 1..31 4 5 hour 0..23 5 6 minutes 0..59 6 7 seconds 0..60 (use 60 for leap-second) 7 8 deci-seconds 0..9 8 9 direction from UTC '+' / '-' 9 10 hours from UTC* 0..13 10 11 minutes from UTC 0..59 * Notes: - the value of year is in network-byte order - daylight saving time in New Zealand is +13 For example, Tuesday May 26, 1992 at 1:30:15 PM EDT would be displayed as: 1992-5-26,13:30:15.0,-4:0 Note that if only local time is known, then timezone information (fields 8-10) is not present. | ||||||||||||||
TDomain | OBJECTID | Denotes a kind of transport service. Some possible values, such as snmpUDPDomain, are defined in the SNMPv2-TM MIB module. Other possible values are defined in other MIB modules. | ||||||||||||||
RowStatus | INTEGER
| The RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of [2].) The status column has six defined values: - `active', which indicates that the conceptual row is available for use by the managed device; - `notInService', which indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device (see NOTE below); 'notInService' has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device; - `notReady', which indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instanciated); - `createAndGo', which is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device; - `createAndWait', which is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device); and, - `destroy', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row. Whereas five of the six values (all except `notReady') may be specified in a management protocol set operation, only three values will be returned in response to a management protocol retrieval operation: `notReady', `notInService' or `active'. That is, when queried, an existing conceptual row has only three states: it is either available for use by the managed device (the status column has value `active'); it is not available for use by the managed device, though the agent has sufficient information to attempt to make it so (the status column has value `notInService'); or, it is not available for use by the managed device, and an attempt to make it so would fail because the agent has insufficient information (the state column has value `notReady'). NOTE WELL This textual convention may be used for a MIB table, irrespective of whether the values of that table's conceptual rows are able to be modified while it is active, or whether its conceptual rows must be taken out of service in order to be modified. That is, it is the responsibility of the DESCRIPTION clause of the status column to specify whether the status column must not be `active' in order for the value of some other column of the same conceptual row to be modified. If such a specification is made, affected columns may be changed by an SNMP set PDU if the RowStatus would not be equal to `active' either immediately before or after processing the PDU. In other words, if the PDU also contained a varbind that would change the RowStatus value, the column in question may be changed if the RowStatus was not equal to `active' as the PDU was received, or if the varbind sets the status | ||||||||||||||
SnmpAdminString | OCTETSTR | An octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. |
Tree view generated by running: snmptranslate -Tp NOTIFICATION-LOG-MIB::notificationLogMIB
+--notificationLogMIB(92) | +--notificationLogMIBObjects(1) | | | +--nlmConfig(1) | | | | | +-- -RW- Unsigned nlmConfigGlobalEntryLimit(1) | | +-- -RW- Unsigned nlmConfigGlobalAgeOut(2) | | | | | +--nlmConfigLogTable(3) | | | | | +--nlmConfigLogEntry(1) | | | Index: nlmLogName | | | | | +-- ---- String nlmLogName(1) | | | Textual Convention: SnmpAdminString | | | Size: 0..32 | | +-- CR-- String nlmConfigLogFilterName(2) | | | Textual Convention: SnmpAdminString | | | Size: 0..32 | | +-- CR-- Unsigned nlmConfigLogEntryLimit(3) | | +-- CR-- EnumVal nlmConfigLogAdminStatus(4) | | | Values: enabled(1), disabled(2) | | +-- -R-- EnumVal nlmConfigLogOperStatus(5) | | | Values: disabled(1), operational(2), noFilter(3) | | +-- CR-- EnumVal nlmConfigLogStorageType(6) | | | Textual Convention: StorageType | | | Values: other(1), volatile(2), nonVolatile(3), permanent(4), readOnly(5) | | +-- CR-- EnumVal nlmConfigLogEntryStatus(7) | | Textual Convention: RowStatus | | Values: active(1), notInService(2), notReady(3), createAndGo(4), createAndWait(5), destroy(6) | | | +--nlmStats(2) | | | | | +-- -R-- Counter nlmStatsGlobalNotificationsLogged(1) | | +-- -R-- Counter nlmStatsGlobalNotificationsBumped(2) | | | | | +--nlmStatsLogTable(3) | | | | | +--nlmStatsLogEntry(1) | | | | | +-- -R-- Counter nlmStatsLogNotificationsLogged(1) | | +-- -R-- Counter nlmStatsLogNotificationsBumped(2) | | | +--nlmLog(3) | | | +--nlmLogTable(1) | | | | | +--nlmLogEntry(1) | | | Index: nlmLogName, nlmLogIndex | | | | | +-- ---- Unsigned nlmLogIndex(1) | | | Range: 1..4294967295 | | +-- -R-- TimeTicks nlmLogTime(2) | | | Textual Convention: TimeStamp | | +-- -R-- String nlmLogDateAndTime(3) | | | Textual Convention: DateAndTime | | | Size: 8 | 11 | | +-- -R-- String nlmLogEngineID(4) | | | Textual Convention: SnmpEngineID | | | Size: 5..32 | | +-- -R-- String nlmLogEngineTAddress(5) | | | Textual Convention: TAddress | | | Size: 1..255 | | +-- -R-- ObjID nlmLogEngineTDomain(6) | | | Textual Convention: TDomain | | +-- -R-- String nlmLogContextEngineID(7) | | | Textual Convention: SnmpEngineID | | | Size: 5..32 | | +-- -R-- String nlmLogContextName(8) | | | Textual Convention: SnmpAdminString | | | Size: 0..255 | | +-- -R-- ObjID nlmLogNotificationID(9) | | | +--nlmLogVariableTable(2) | | | +--nlmLogVariableEntry(1) | | Index: nlmLogName, nlmLogIndex, nlmLogVariableIndex | | | +-- ---- Unsigned nlmLogVariableIndex(1) | | Range: 1..4294967295 | +-- -R-- ObjID nlmLogVariableID(2) | +-- -R-- EnumVal nlmLogVariableValueType(3) | | Values: counter32(1), unsigned32(2), timeTicks(3), integer32(4), ipAddress(5), octetString(6), objectId(7), counter64(8), opaque(9) | +-- -R-- Counter nlmLogVariableCounter32Val(4) | +-- -R-- Unsigned nlmLogVariableUnsigned32Val(5) | +-- -R-- TimeTicks nlmLogVariableTimeTicksVal(6) | +-- -R-- Integer32 nlmLogVariableInteger32Val(7) | +-- -R-- String nlmLogVariableOctetStringVal(8) | +-- -R-- IpAddr nlmLogVariableIpAddressVal(9) | +-- -R-- ObjID nlmLogVariableOidVal(10) | +-- -R-- Counter64 nlmLogVariableCounter64Val(11) | +-- -R-- Opaque nlmLogVariableOpaqueVal(12) | +--notificationLogMIBConformance(3) | +--notificationLogMIBCompliances(1) | | | +--notificationLogMIBCompliance(1) | +--notificationLogMIBGroups(2) | +--notificationLogConfigGroup(1) +--notificationLogStatsGroup(2) +--notificationLogLogGroup(3) +--notificationLogDateGroup(4)
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.