IPPM-MIB: View SNMP OID List / Download MIB

This memo defines a portion of the Management Information Base (MIB) for use with network management protocols in TCP/IP-based internets. In particular, It defines a registry of the IPPM working group metrics and specifies the objects used for managing IPPM metrics measures, pushing alarms and reporting the measures results.

The compliance statement for SNMP entities which implement the IPPM MIB

A NMS entity wishing to create and activate remote Ippm measurements in an agent must previously be registered in the ippmOwnersControlTable using the conceptual row mechanism described in the RMON2. The control of the access to the results of the measures is managed in the table ippmResultSharing.

The description of the resources the agent granted to a SNMP application. For example, an instance of ippmOwnersControlOwner with an OwnerString 'acme', which represents the 14th owner created in ippmOwnersControlTable would be named ippmOwnersControlEntryOwner.14. Notes: The ippmOwnersControlIndex value is a local index managed directly by the agent. It is not used in anyway in the other IPPM tables.

An arbitrary index that only identify an entry in this table

The owner described by this entry.

Defines the metrics granted to an owner.

Defines the rules this owner may act as in the current IPPM MIB instance. all(0): The owner is granted with all the rules. readonly(1): The measures (not only the metrics) allowed to this owner are setup by the manager of the point of measure. The owner can not add new measures for these metrics. The creation and the configuration of the measures corresponding to these metrics are managed by the manager of the point of measure. permanent(2): The measures (not only the metrics) allowed to this owner are determined by the manager of the point of measure. The owner can not add new measures for these metrics. The creation and the first configuration of the measures corresponding to these metrics are managed by the manager of the point of measure. The owner may modify the measures parameters of the entries of the corresponding ippmMeasureEntry which access is read-write. Typically that permits the owner to suspend the measures, to change the begin and end of the measures. sender(3): The owner may only activate measures for theses metrics that send packets from the current point of measure. This flag is only suitable for network measures. It shall be ignored for derived metrics. receiver(2): The owner may only activate measures for theses metrics that receive packets on the current point of measure. This flag is only suitable for network measures. It shall be ignored for derived metrics. Such control increases the security. The owner may not generate packets from the probe. report(4): The owner may setup aggregated metrics on the measures corresponding to these metrics. alarm(5): The owner may setup alarms on the results of the measures metrics. e.g.: if the owner Acme is granted with the metric Instantaneous- Unidirectional-Connectivity as a Receiver in the current point of measure, then Acme can not setup a Instantaneous-Unidirectional- Connectivity to another point of measure. Bits: 'all': 0, 'sender': 2, 'receive': 3, 'alarm': 5, 'readonly': 1, 'permanent': 2, 'report': 4.

The IP address of the NMS corresponding to this owner. The address is human readable and is represented using the dot format.

The email address of the NMS corresponding to this owner.

The SMS phone number of the NMS corresponding to this owner.

The status of this table entry.

ippmResultSharingTable controls finely the access of an owner to the measure results of other owners. An owner may grant another to read the result of its measure. Entries may exist in ippmResultSharingTable even is the measures to be shared are not yet defined. Deleting a measure entry in the ippmMeasureTable does not delete the entries corresponding to this measure in the ippmResultSharingTable. IppmResultSharingTable is optional. If this table is not implemented then the owner has only access to its measure results.

An entry allows an owner to read the results of a measure owned by another owner. It permits 2 typical usages: creating derived measurements on these results; reading the results from a remote NMS. Example: if acme.12 is a One-way-Delay(6) measure Acme may allows Peter to make derived metrics On the results of this measure.

The owner of this result control entry. Typically the owner which created this conceptual row.

The index of this result control entry. The value is managed by the owner. On creation a SNMP error 'inconsistentValue' is returned if this value is already in use by this owner.

The owner of the measure to be shared. The couple ippmResultSharingMeasureOwner, ippmResultSharingMeasureIndex identifies absolutely a measure

The index of the measure to be shared.

The owner which is granted to access to the result of the measure described by the couple ippmResultSharingMeasureOwner, ippmResultSharingMeasureIndex.

The status of this table entry. Once the entry status is set to active.

The current time of the system.

ippmSystemSynchonizationType describes the mechanism used to synchronise the system. other The synchronisation process must be defined extensively in the ippmSystemSynchonizationDescription. ntp The system is synchronised using the network time protocol. The NTP synchronisation must be described finely in the ippmSystemSynchonizationDescription. gps The system is synchronised using the GPS clocks. cdma The system is synchronised using the CDMA clocks. Enumeration: 'ntp': 1, 'cdma': 4, 'other': 0, 'gps': 2.

The description of the synchronization process.

ippmSystemClockResolution provides the precision of the clock used for the measures. The unit is 1/10 of millisecond. For example, the clock on an old Unix host might advance only once every 10 msec, and thus have a resolution of only 10 msec.

The time when occurs the last synchronisation of the clock. The last synchronisation must be set even if the synchronisation is not automatic.

The most recent accuracy of the clock computed. The accuracy must be compute even if the synchronisation is not automatic.

The most recent skew of the clock computed. The ippmSystemSkew must be compute even if the synchronisation is not automatic.

The previous accuracy of the clock measured. The ippmSystemPrevClockAccuracy must be computed even if the synchronisation is not automatic.

The previous skew of the clock measured. The ippmSystemPrevClockSkew must be computed even if the synchronisation is not automatic.

This table describes the current implementation. This table is mandatory. Each IPPM standardized metric must be described in the table. In reporting mode the entries of this table may be not accessible. It means that the table is handle internally by the measure software.

An entry describes the static capabilities of a metric implementation.

ippmMetricIndex defines an unambiguous index for each standardized metric. Its value is the value of the node of the metric in the IPPM-MIB metrics registry ippmMib.metrics.rfc. Each metric registered in the standard registry must be present in this table. This index is used to identify the metric performed among the IPPM-MIB entities involved in the measure. Example: The index of the metric onewayPacketLossAverage which is registered as ippmMib.metrics.rfc.onewayPacketLossAverage will always have the value 14.

notImplemented the metric is not implemented. implemented the metric is implemented. Enumeration: 'implemented': 1, 'notImplemented': 0.

The unit used in the current entity for the results of the measure of this metric. Enumeration: 'noUnit': 0, 'kbyte': 7, 'packets': 6, 'us': 3, 'second': 1, 'ms': 2, 'percentage': 5, 'ns': 4, 'byte': 6, 'megabyte': 8.

A textual description of the metric implementation.

Specifies the maximal number of results that a metric measure can save in the ippmHistoryTable.

The table of all the IPPM measures which are running in the device. They may not be active. a measure consists in a subset of metrics to compute. The results of the measure may be saved in the ippmHistoryTable. The configuration of the measure sets the size of the history requested in ippmMeasureHystorySize. The maximal number of MIB objects to be collected in the portion of ippmHistoryTable associated with this metric depends the value of the ippmMetricMaxHistorySize. The value of each metric ippmMeasureHystorySize must not be over the value of ippmMetricMaxHistorySize corresponding to this metric in ippmMetricTable. In reporting mode the entries of this table may be not accessible. It means that the table is handle internally by the measure software.

A SNMP entity wishing to create and activate a measurement adds a new entry in the ippmMeasureTable. Typically the configuration operation set the values of the conceptual row parameters using an unused owner index and sets the status of the row to createAndGo. An SNMP error 'inconsistentValue' is returned if the owner index is out of range.

The owner who has configured this entry.

The owner index of the measure. The value is managed by the owner. An SNMP error 'inconsistentValue' is returned if this value is already in use by this owner.

The name of the instance of the metric. It illustrates the specificity of the metric and includes the metric and the typeP. example: IP-port-HTTP-connectivity

Defines the metrics to compute within this measure. A measure may be configured for the result of different metrics singletons to be archive in the ippmHistoryTable. The ippmMetricIndex of the created result has the value of the bit index of the corresponding ippmMeasureMetrics as explained above in the ippmMetricIndex definition. Example: A measure asking for One-way-Delay(6) and One-way- Packet-Loss(12) generated a flow of singletons which are logged in the ippmHistoryTable. The singletons created for the One-way-Delay measure have a value of ippmMetricIndex of 6 while the created singletons for the One-way-Packet-Loss measure have a value of ippmMetricIndex of 12.

Specifies the time at which the measure starts.

Specifies the unit of the measure period.

Specifies the among of time between 2 sampling intervals. Notes: This interval generates a flow of periodical instants which may be transformed as a flow of unpredictable instants of measure by the ippmNetworkMeasureClockPattern.

Specifies the unit of the measure duration.

Specifies the duration of the measure.

Specifies the maximum number of results saved for each metric of this measure. The history of each metric is managed as a circular table. The newest result overwrite the oldest one when the history granted to this metric measure is full. The management of the results may be optimized if synchronized with the reports steps of this measure.

This object defines whether this row and the measure controlled by this row are kept in volatile storage and lost upon reboot or if this row is backed up by non-volatile or permanent storage. Possible values are: other(1), volatile(2), nonVolatile(3), permanent(4), readOnly(5)

The status of this table entry. Once the entry status is set to active, the associate entry cannot be modified.

The table of the results of the measures.

An ippmHistoryEntry entry is one of the result of an measure identified by the index members ippmMeasureOwner and ippmMeasureIndex. In the index : + ippmMeasureOwner and ippmMeasureIndex identify the ippmMeasureEntry on whose behalf this entry was created; + ippmMetricIndex identifies the ippmMetricEntry of the metric to measure; + ippmLogTimeMark value is the absolute time when the result of the metric was measured. The ippmHistoryTimeMark value is the absolute time when the ippmHistoryValue was performed. IppmHistoryValue is the value of the metric measured at the time ippmHistoryTimeMark. Example: A one way delay measure is created by the entity 'acme' using the owner index 1 and setting the 6th bit (corresponding to One-way-Delay) of ippmMeasureMetrics to 1. Consider that the result of the one way delay measured for acme on the day 15 of June at 8h20mn 10s 10ms is 23. The result is identified as the singleton ippmHistoryValue.acme.1.6.0106150820100100 and stored with value 23. Its value may be retrieved using a get- next(ippmHistoryValue.acme.1.6.0106150820100099) which returns (ippmHistoryValue.acme.1.6.0106150820100100 == 23). The ippmMetricIndex value of '6' corresponds to the 6th metric of ippmMetricTable which is Type-P-One-way- Delay.

The instant of the measure of the result.

The value of the measure.

A entry is a measure which performs network measures and provides a flow of results. This table extends the ippmMeasureTable. A network measure is a specific measure. It performs several metrics measure per packet exchange. Each step of a measure produces a singleton result per metric. The time of the measure and the value of the metric are saved in the ippmHistoryTable.

A SNMP entity wishing to create and activate a network measure adds a new entry in the ippmMeasureTable and in IppmNetworkMeasureTable. Typically the configuration operation set both the values of the new ippmMeasureEntry and of the new IppmNetworkMeasureEntry and sets the status of the row to createAndGo. An SNMP error 'inconsistentValue' is returned if the index is out of range. The ippmMeasureMetrics is set to a list of metrics to be computed from the same raw packet exchange. Each step of measure delivers a singleton per chosen metric. Results are timestamped and saved in the ippmHistoryTable.

Defines the type P of the source address of the packets sent by the measure.

Specifies the address of the source of the measure. It is represented as an octet string with specific semantics and length as identified by the ippmNetworkMeasureSrcTypeP. For example, if the ippmNetworkMeasureSrcTypeP indicates an encapsulation of 'ip', this object length is 4, followed by the 4 octets of the IP address, in network byte order.

Defines the type P of the destination address of the packets sent by the measure.

Specifies the address of the destination of the measure. It is represented as an octet string with specific semantics and length as identified by the ippmNetworkMeasureDstTypeP. For example, if the ippmNetworkMeasureDstTypeP indicates an encapsulation of 'ip', this object length is 4, followed by the 4 octets of the IP address, in network byte order.

This cyclic clock shapes the profile of the instants of measurement according to an arbitrary distribution law. The clock resolution is ippmMeasureClockPeriod. The bits of the clock set to the value 1 determine the valid instants of measurement. A measure is to be processed if and only if the current bit value is 1. This pseudo-random clock pattern allows the configuration by the NMS of numerous kind of sampling law such as periodic or Poisson.

Specifies the delay after which the packet is considered lost.

Specifies the size of the packets send at the last network layer in the sense of the TypeP definition.

The current field defines the round robin pattern used to fill the packet.

This table extends the ippmMeasureTable. A aggregated measure summarizes the results of previous network or aggregated measures. The results may saved in the ippmHistoryTable. Each step of the measure computation produces a singleton result per metric.

A SNMP entity wishing to create and activate a statistic measure adds a new entry in the ippmMeasureTable and in ippmAggregatedMeasureTable. Typically the configuration operation sets both the values of the new ippmMeasureEntry and of the new IppmAggregatedMeasureEntry and sets the status of the row to createAndGo. The ippmMeasureMetrics defines the metric to compute. The results of the measure to summarize are identified by ippmAggregatedMeasureHistoryOwner, IppmAggregatedMeasureHistoryOwnerIndex and ippmAggregatedMeasureHistoryMetric The aggregated task starts at ippmMeasureBeginTime and end after ippmMeasureDuration. A aggregated result is performed and saved in the ippmHistoryTable for each ippmMeasureClockPeriod.

The owner of the measure to summarize.

The owner index of the measure to summarize.

The metric of the measure to summarize.

The ippmReportSetupTable is a list of definition of reports. It defines the results of a network or aggregated measures which are to report. A report is saved in the ippmReportTable or sent to an application using a SNMP Trap, a SNMP inform PDU, an email or a SMS. The reporting task is not a batch action processed at the end of the measure. It is coupled with threshold detections and event filtering to deliver application level events and data while preserving scalability. It extends the definition of a measure: the definition of an measure may include the definition of a report.

The report applies on the results of the measure which is extended by the current report definition. Typically the creation or a report sets both the values of the new measure and those of the new IppmReportSetupEntry. The ippmReportSetupDefinition describes the data and the events to include in the report. The definition consists in a list of tasks to perform on the results of the measure.

The description of the events and actions which participate to the elaboration of the report. Send the report using the type of message selected by the bits 8 to 12. The report consists in the results of the measure which have been saved in the ippmReportTable. If the onEventSendReport(7) bit is unset the report is not saved. The message sent is a notification defined in the ippmNotifications node. The notification sent depends on the step of the measure: + Singleton events are sent using the notification ippmSingletonAlarm; + Exceeded events duration are sent using the notification ippmEventsDurationExceededAlarm; + A report of a cycle of measure is sent using the notification ippmCycleOfMeasureReport; + A report of a complete measure is sent using the notification ippmCompletedMeasureReport; Example 1: The setup of an alarm to be sent to the owner in a SNMP Trap each time the staircase crosses the metric threshold value of 5: ippmReportSetupMetricThreshold 5 ippmReportSetupDefinition { onSingleton(1), reportOnlyUptoDownMetricResults(4), inSNMPTrapPDU(8) } Example 2: The setup of a report to be sent to the owner in a SNMP informRequestPDU per measure cycle. It reports the staircase values corresponding to a metric threshold of 5: ippmReportSetupMetricThreshold 5 ippmReportSetupDefinition { onMeasureCycle(2), reportOnlyUptoDownMetricResults(4), inInformRequestPDU(10), clearHistory(13) } Default report: The default report provides the control protocol with an implicit mechanism to forward the result of a cycle of measure to the owner of the measure while deleting the results from the ippmHistoryTable on reception of the response to the InformRequestPDU : ippmReportSetupDefinition { onMeasureCycle(2), inInformRequestPDU(10), clearHistory(13) }

An event is generated when the result of the measure exceeds the value of ippmReportSetupMetricThreshold. The threshold has the same unit as the metric. The metric unit is recorded in the object ippmMetricsUnit of this metric entry in the ippmMetricTable.

An event is generated when the duration of a serie of results which are continuously over the metric threshold cross over the duration of the ippmReportSetupEventsDurationThreshold.

The recipient of the report may be provided in the setup. By default the recipient of the report is the owner of the measure. Its addresses are recorded in the ippmOwnersTable.

The ippmReportTable logs the results of the reports. The results consist in a subset of the results of a measure as described in the report definition. The activation of a up and down filtering in the report definition limits the results logged to those corresponding to major events. Excepted these points the ippmReportTable is identical to the ippmHistoryTable.

A report is a list of results of a measure. This sample is associated with the ippmReportSetupEntry which has set up the report. An ippmReportEntry entry is one of the results of an measure to report. The measure and the report definition are identified by the index members ippmMeasureOwner and ippmMeasureIndex. in the index : + ippmMeasureOwner and ippmMeasureIndex identify the ippmMeasureEntry and the ippmReportSetupEntry on whose behalf this report was created; + ippmMetricIndex identifies the ippmMetricEntry of the metric measured; + ippmReportTimeMark value is the absolute time when the value of the metric was measured. The ippmReportTimeMark value is the absolute time when the ippmHistoryValue was performed. IppmHistoryValue is the value of the metric measured at the time ippmReportTimeMark.

The instant of the measure of the result.

The value.

A notification sent because 2 contiguous results are on opposite sides of the metric threshold value. The index of the included ippmReportSetupMetricThreshold object identifies the ippmMeasureEntry and the ippmResultSetupEntry that specified the threshold. The notification contains the instances of the ippmReportValue object which raised the threshold. The ippmHistoryTimeMark of the index identifies the time the event occurs.

A notification sent when the duration of contiguous raising ippmReportSetupMetricThreshold exceeds the ippmReportSetupEventsDurationThreshold value. The index of the included ippmReportSetupDefinition object identifies the ippmMeasureEntry and the ippmResultSetupEntry that specified the report. The notification contains the instances of the ippmReportValue objects saved in the ippmReportTable for this report. The ippmHistoryTimeMark of the index identifies the time theses measures results where performed.

A notification sent when a measure cycle completes. The index of the included ippmReportSetupDefinition object identifies the ippmMeasureEntry and the ippmResultSetupEntry that specified the report. The notification contains the instances of the ippmReportValue objects saved in the ippmReportTable for this measure cycle. The ippmHistoryTimeMark of the index identifies the time the measures where performed.

A notification sent when a measure completes. The index of the included ippmReportSetupDefinition object identifies the ippmMeasureEntry and the ippmResultSetupEntry that specified the report. The notification contains the instances of the ippmReportValue objects saved in the ippmReportTable for this measure cycle. The ippmHistoryTimeMark of the index identifies the time the measures where performed.