-- extracted from draft-ietf-ippm-reporting-mib-02.txt -- at Thu Mar 6 06:12:28 2003 IPPM-REPORTING-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, NOTIFICATION-TYPE, OBJECT-TYPE, experimental ,Integer32 FROM SNMPv2-SMI -- -- ippm -- FROM IPPM-REGISTRY -- InetAddressType, InetAddress FROM INET-ADDRESS-MIB SnmpAdminString FROM SNMP-FRAMEWORK-MIB RowStatus, StorageType, TEXTUAL-CONVENTION FROM SNMPv2-TC MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP FROM SNMPv2-CONF; ippmReportingMib MODULE-IDENTITY LAST-UPDATED "200203171200Z" -- March 17, 2002 ORGANIZATION "France Telecom - R&D" CONTACT-INFO "Emile Stephan France Telecom - R&D 2, Avenue Pierre Marzin Technopole Anticipa 22307 Lannion Cedex FRANCE Tel: + 33 2 96 05 36 10 E-mail: emile.stephan@francetelecom.com Jessie Jewitt France Telecom - R&D 801 Gateway Blvd. Suit 500 South San Francisco, CA 94080 Tel : 1 650 875-1524 E-mail : jessie.jewitt@rd.francetelecom.com" DESCRIPTION " 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 specifies the objects used for managing the results of the IPPM metrics measurements, alarms and reporting the measures results." REVISION "200210181200Z" -- 18 October 2002 DESCRIPTION "General cleanup Change 5 tables to read write" REVISION "200302141200Z" -- 14 February 2003 DESCRIPTION "Modifications based upon feedback from IETF-55" ::= { experimental 10001 } ippm OBJECT IDENTIFIER ::= { experimental 10000 } -- -- TEXTUAL-CONVENTION -- IppmOwnerString ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "An OwnerString, which length is limited to 32." SYNTAX OCTET STRING (SIZE (0..32)) TimeUnit ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "A list of time units." SYNTAX INTEGER { year(1), month(2), week(3), day(4), hour(5), second(6), millisecond(7), microsecond(8), nanosecond(9) } -- -- IppmStandardMetrics ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION " Each standard metric is identified in the IPPM-METRICS- REGISTRY under the node rfc in a chronological order. To permit several metrics to be performed in a single measure there is an need to describe in a bit string the metrics to be performed, granted... This textual convention defines an octet string that gathered in a bit string a sequence of bits. The bit order corresponds to the order of the metrics identifiers in the registry. The first bit of the string has the index 0. The index 1 corresponds to the first metric of the registry (instantaneousUnidirectionalConnectivity ). Example: One-way-Delay(6) is identified as the leaf number 6 of the node rfc of the registry. One-way-Packet-Loss(12) is identified as the leaf number 12 of the node rfc of the registry. A network measure performing both One-way- Delay(6) and One- way-Packet-Loss(12) will be described as '0001000001000000'b, '1040'B. " SYNTAX OCTET STRING GMTTimeStamp ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "The value of the ippmSystemTime object at which a specific occurrence happened. The specific occurrence must be defined in the description of any object defined using this type. field octets contents range ----- ------ -------- ----- 1 1-4 second since 1 Jan 2000 0H00* 0..2^31 - 1 2 5-8 fractional part of the second* 0..2^32 - 1 * the value is in network-byte order The timestamp format is directly inspired from the NTP timestamp format. It differs because it counts the second since 1 Jan 2000 0H00 instead of 1 Jan 1900 0H00. The most significant bit of the part that represents the second is reserved. It will wrap in year 2068 (The NTP timestamp will wrap in year 2036). This bit is set to indicate if the fractional part of the second contains a precision field and a synchronization field as initially proposed in the OWAMP draft. When this bit is not set the resolution is maximal. The maximal resolution is close to 250 picoseconds. The precision of the timestamp must be provided in another field. " SYNTAX OCTET STRING (SIZE (8)) TypeP ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "This textual convention is a display string used to describe the protocol encapsulation list of a packet, and is used as the value of the SYNTAX clause for the type of the Src and Dst of an IPPM measure. The RFC2895 specifies a macro named PROTOCOL-IDENTIFIER for the definition of protocol identifiers while its companion document, the RFC2896 defines a set of protocol identifiers. TypeP is defined as a display string. It consists in a list of dot separated protocol names. Each protocol name has been previously defined using the macro PROTOCOL-IDENTIFIER of the RFC 2895. Examples: The RFC2896 defines the protocol identifiers 'ether2', 'ip', 'ipip4', 'udp', 'tcp', 'telnet'... The TypeP of the source address corresponding to telnet is the string 'ip.tcp.telnet'. The TypeP of the source address corresponding to UDP packets sent in an IP tunnel is the string 'ip.ipip4.udp'. Notes: An IPPM measure is active, so generally a TypeP value does not describe the link layer (i.e. ether2...). Valid Internet packets are sent from Src to Dst. Then the choice of the link layer relies on the Internet stack." SYNTAX OCTET STRING (SIZE (0..255)) TypePaddress ::= TEXTUAL-CONVENTION DISPLAY-HINT "255a" STATUS current DESCRIPTION "This textual convention is a Display string used to describe the parameters of the protocol encapsulation list of a packet, basically the address. TypePaddress is defined as a display string. It consists in a list of space separated parameter list. Each parameter in the list corresponds a parameter of a PROTOCOL-IDENTIFIER of the TypeP. Example: The TypeP 'ip.ipip4' has 2 parameters. A valid TypePaddress value is '192.168.1.1 128.2.6.7'." SYNTAX OCTET STRING (SIZE (0..255)) IppmReportDefinition ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "IppmReportDefinition is intended to be used for describing the report resulting from a measurement. By default, all the results of a measure belong to the report of this measure. The first step of the report definition sets up triggers on the value of the measure, and on the distribution over time of the events generated by these triggers. The resulting measures corresponding to an event are reported periodically, or sent in alarms as soon as the event occurs. The end of the description describes housekeeping tasks. An action is performed if the corresponding bit is set to 1. onSingleton(1): The actions are performed each time a new result of the measure occurs. onMeasureCycle(2): The actions are performed on the results of the measure at the end of each cycle of measure. onMeasureCompletion(3): The actions are performed on the results of the measure at the end of the measure. reportOnlyUptoDownMetricResults(4): Report the contiguous results that are on opposite sides of the metric threshold. reportOnlyExceededEventsDuration(5): Report the current result of a series of contiguous results that exceed the metric threshold when the duration of the series is over the events duration threshold seconds. inIppmReportTable(6): Store the report in the local ippmReportTable. inSNMPTrapPDU(7): Send the report using a SNMP-Trap-PDU. inSNMPv2TrapPDU(8): Send the report using a SNMPv2-Trap-PDU. inInformRequestPDU(9): Send the report using a SNMP InformRequest-PDU. inEmail(10): Send the report using an email. inSMS(11): Send the report using a SMS. onReportDeliveryClearHistory(12): Remove all the results corresponding to this measure from the ippmHistoryTable when the report has been delivered. onReportDeliveryClearReport(13): Remove all the results corresponding to this measure from the ippmReportTable when the report has been delivered. " SYNTAX BITS { none(0), -- reserved onSingleton(1), onMeasureCycle(2), onMeasureCompletion(3), reportOnlyUptoDownMetricResults(4), reportOnlyExceededEventsDuration(5), inIppmReportTable(6), inSNMPTrapPDU(7), inSNMPv2TrapPDU(8), inInformRequestPDU(9), inEmail(10), inSMS(11), onReportDeliveryClearHistory (12), onReportDeliveryClearReport (13) } -- -- IPPM Notifications -- ippmNotifications OBJECT IDENTIFIER ::= { ippm 0 } -- -- IPPM Conformance -- ippmConformance OBJECT IDENTIFIER ::= { ippm 1 } -- -- IPPM Mib objects definitions -- ippmSystem OBJECT IDENTIFIER ::= { ippmReportingMib 1 } ippmOwners OBJECT IDENTIFIER ::= { ippmReportingMib 2 } ippmMeasure OBJECT IDENTIFIER ::= { ippmReportingMib 3 } ippmHistory OBJECT IDENTIFIER ::= { ippmReportingMib 4 } ippmNetworkMeasure OBJECT IDENTIFIER ::= { ippmReportingMib 5 } ippmAggrMeasure OBJECT IDENTIFIER ::= { ippmReportingMib 6 } ippmReport OBJECT IDENTIFIER ::= { ippmReportingMib 7 } -- -- ippmSystem Group -- -- ippmSystemTime OBJECT-TYPE SYNTAX GMTTimeStamp MAX-ACCESS read-only STATUS current DESCRIPTION "The current time of the measurement system." ::= { ippmSystem 1 } ippmSystemSynchronizationType OBJECT-TYPE SYNTAX INTEGER { other(0), ntp(1), gps(2), cdma(3) } MAX-ACCESS read-only STATUS current DESCRIPTION "ippmSystemSynchronizationType describes the mechanism used to synchronize the system. Other(0) The synchronization process must be defined in the ippmSystemSynchonizationDescription. Ntp(1) The system is synchronized using the network time protocol. The NTP synchronization must be described in the ippmSystemSynchonizationDescription. Gps (2) The system is synchronized using the GPS clocks. Cdma(3) The system is synchronized using the CDMA clocks." ::= { ippmSystem 2 } ippmSystemSynchronizationDesc OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-only STATUS current DESCRIPTION "The description of the synchronization process." ::= { ippmSystem 3 } ippmSystemClockResolution OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-only STATUS current DESCRIPTION "ippmSystemClockResolution provides the precision of the clock used for the measures. The unit is the picosecond. 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. So its resolution is 100000 picosecond and the value of ippmSystemClockResolution is 100000." ::= { ippmSystem 4 } ippmSystemCurrentSynchronization OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-only STATUS current DESCRIPTION "The index on the last synchronization event in the ippmSynchronizationTable." ::= { ippmSystem 5 } ippmSynchronizationTable OBJECT-TYPE SYNTAX SEQUENCE OF IppmSynchronizationEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table registers the event related to the synchronization of the point of measure. Each event is described in an ippmSynchronizationEntry. ippmSynchronizationTable is mandatory. ippmSynchronizationTable content is read only." ::= { ippmSystem 6 } ippmSynchronizationEntry OBJECT-TYPE SYNTAX IppmSynchronizationEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "An entry describes a modification of the synchronization status. " INDEX { ippmSynchronizationIndex } ::= { ippmSynchronizationTable 1 } IppmSynchronizationEntry ::= SEQUENCE { ippmSynchronizationIndex Integer32, ippmSynchronizationTime GMTTimeStamp, ippmSynchronizationStratum Integer32, ippmSynchronizationResolution Integer32 } ippmSynchronizationIndex OBJECT-TYPE SYNTAX Integer32 (1 .. 65535) MAX-ACCESS not-accessible STATUS current DESCRIPTION "An index that identifies the synchronization events in chronological order." ::= { ippmSynchronizationEntry 1 } ippmSynchronizationTime OBJECT-TYPE SYNTAX GMTTimeStamp MAX-ACCESS read-only STATUS current DESCRIPTION "The time when the synchronization event occurs." ::= { ippmSynchronizationEntry 2 } ippmSynchronizationStratum OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-only STATUS current DESCRIPTION "The stratum level of the clock computed when the synchronization event occurs." ::= { ippmSynchronizationEntry 3 } ippmSynchronizationResolution OBJECT-TYPE SYNTAX Integer32 UNITS "NanoSeconds" MAX-ACCESS read-only STATUS current DESCRIPTION "The new time resolution computed after the synchronization event occured." ::= { ippmSynchronizationEntry 4 } ippmPointOfMeasureTable OBJECT-TYPE SYNTAX SEQUENCE OF IppmPointOfMeasureEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION " A lookup table that identifies the management software in charge of the point of measures. ippmPointOfMeasureTable content is read only. It means that the measurement software handles the table internally ippmPointOfMeasureTable is mandatory." ::= { ippmSystem 7 } ippmPointOfMeasureEntry OBJECT-TYPE SYNTAX IppmPointOfMeasureEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION " An entry may be the management address of a middleware in charge of the management of a set of probes. It may the management address of a probe that contains several line cards. An entry describes the capability of a point of measure. The description may make the use of wildcards to define multiple capabilities." INDEX { ippmPointOfMeasureIndex } ::= { ippmPointOfMeasureTable 1 } IppmPointOfMeasureEntry ::= SEQUENCE { ippmPointOfMeasureIndex Integer32, ippmPointOfMeasureMgmtAddrType InetAddressType, ippmPointOfMeasureMgmtAddress InetAddress, ippmPointOfMeasureTypePAddress TypeP, ippmPointOfMeasureAddress InetAddress } ippmPointOfMeasureIndex OBJECT-TYPE SYNTAX Integer32 (1 .. 65535) MAX-ACCESS not-accessible STATUS current DESCRIPTION "The index of the entry." ::= { ippmPointOfMeasureEntry 1 } ippmPointOfMeasureMgmtAddrType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-only STATUS current DESCRIPTION "The type of address associated with management address" ::= { ippmPointOfMeasureEntry 2 } ippmPointOfMeasureMgmtAddress OBJECT-TYPE SYNTAX InetAddress (SIZE (1..128)) MAX-ACCESS read-only STATUS current DESCRIPTION "The management address on the point of measure" ::= { ippmPointOfMeasureEntry 3 } ippmPointOfMeasureTypePAddress OBJECT-TYPE SYNTAX TypeP MAX-ACCESS read-only STATUS current DESCRIPTION "Defines the type P of the address of the point of measure." DEFVAL { "ip" } ::= { ippmPointOfMeasureEntry 4 } ippmPointOfMeasureAddress OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS read-only STATUS current DESCRIPTION "Specifies the address of the point of measure. It is represented as an octet string with specific semantics and length as identified by the ippmPointOfMeasureTypePAddress. For example, if the ippmPointOfMeasureTypePAddress indicates an encapsulation of 'ip', this object length is 4, followed by the 4 octets of the IP address, in network byte order." ::= { ippmPointOfMeasureEntry 5} -- -- ippmOwners Group -- -- The ippmOwners objects are responsible for managing -- the owners access to the measurements. -- -- ippmOwnersTable OBJECT-TYPE SYNTAX SEQUENCE OF IppmOwnersEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A management entity wishing to create and activate remote Ippm measurements in an agent must previously be registered in the ippmOwnersTable. ippmOwnersTable content is read-create. It contains at least the owner 'monitor'. It is mandatory, except if the VACM framework is used." ::= { ippmOwners 1 } ippmOwnersEntry OBJECT-TYPE SYNTAX IppmOwnersEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "The description of the resources granted to an SNMP application. For example, an instance of ippmOwnersOwner with an IppmOwnerString 'acme', which represents the 14th owner created in ippmOwnersTable would be named ippmOwnersEntryOwner.14. Notes: The ippmOwnersIndex value is a local index managed directly by the agent. The management application must poll to get the next available index value. It is not used in anyway in the other IPPM tables." INDEX { ippmOwnersIndex } ::= { ippmOwnersTable 1 } IppmOwnersEntry ::= SEQUENCE { ippmOwnersIndex Integer32, ippmOwnersOwner SnmpAdminString, ippmOwnersGrantedMetrics IppmStandardMetrics, ippmOwnersGrantedRules BITS, ippmOwnersIpAddressType InetAddressType, ippmOwnersIpAddress InetAddress, ippmOwnersEmail SnmpAdminString, ippmOwnersSMS SnmpAdminString, ippmOwnersStatus RowStatus } ippmOwnersIndex OBJECT-TYPE SYNTAX Integer32 (1.. 65535) MAX-ACCESS not-accessible STATUS current DESCRIPTION "An arbitrary index that identifies an entry in this table" ::= { ippmOwnersEntry 1 } ippmOwnersOwner OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-create STATUS current DESCRIPTION "The owner described by this entry." ::= { ippmOwnersEntry 2 } ippmOwnersGrantedMetrics OBJECT-TYPE SYNTAX IppmStandardMetrics MAX-ACCESS read-create STATUS current DESCRIPTION " Defines the metrics granted to an owner." ::= { ippmOwnersEntry 3 } ippmOwnersGrantedRules OBJECT-TYPE SYNTAX BITS { all(0), readonly(1), permanent(2), sender(3), receiver(4), report(5), alarm(6) } MAX-ACCESS read-create STATUS current DESCRIPTION "Defines the rules this owner may act on in the current IPPM MIB instance. all(0): The owner is granted all the rules. readonly(1): The measures (not only the metrics) that this owner may access 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) that this owner may access 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 whose access is read-write. Typically this allows the owner to suspend the measures, to change the beginning and end of the measures. sender(3): The owner may only activate measures for those 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(4): The owner may only activate measures for those 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(5): The owner may setup aggregated metrics on the measures corresponding to these metrics. alarm(6): 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." DEFVAL { 1 } ::= { ippmOwnersEntry 4 } ippmOwnersIpAddressType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-create STATUS current DESCRIPTION "The IP address type of the management entity corresponding to this owner." ::= { ippmOwnersEntry 5 } ippmOwnersIpAddress OBJECT-TYPE SYNTAX InetAddress (SIZE (1..128)) MAX-ACCESS read-create STATUS current DESCRIPTION "The IP address of the management entity corresponding to this owner. The address is human readable and is represented using the dot format." ::= { ippmOwnersEntry 6 } ippmOwnersEmail OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-create STATUS current DESCRIPTION "The email address of the management entity corresponding to this owner." ::= { ippmOwnersEntry 7 } ippmOwnersSMS OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-create STATUS current DESCRIPTION "The SMS phone number of the management entity corresponding to this owner." ::= { ippmOwnersEntry 8 } ippmOwnersStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "The status of this table entry." ::= { ippmOwnersEntry 9 } -- -- ippmResultSharingTable -- ippmResultSharingTable OBJECT-TYPE SYNTAX SEQUENCE OF IppmResultSharingEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION " The ippmResultSharingTable controls the access of an owner to the measure results of other owners. An owner may grant another access to read the result of its measure. Entries may exist in ippmResultSharingTable even if 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. This table is optional. ippmResultSharingTable content is read-create. If this table is not implemented then the owner has only access to its own measurement results." ::= { ippmOwners 2 } ippmResultSharingEntry OBJECT-TYPE SYNTAX IppmResultSharingEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "An entry allows an owner to read the results of a measure owned by another owner. It permits 2 typical usages: 1) Creating derived measurements on these results 2) Reading the results from a remote management station. Example: if acme.12 is a One-way-Delay(6) measure, Acme may allow Peter to make derived metrics on the results of this measure." INDEX { ippmResultSharingOwner, ippmResultSharingIndex} ::= { ippmResultSharingTable 1 } IppmResultSharingEntry ::= SEQUENCE { ippmResultSharingOwner IppmOwnerString, ippmResultSharingIndex Integer32, ippmResultSharingMeasureOwner IppmOwnerString, ippmResultSharingMeasureIndex Integer32, ippmResultSharingGrantedOwner IppmOwnerString, ippmResultSharingStatus RowStatus } ippmResultSharingOwner OBJECT-TYPE SYNTAX IppmOwnerString MAX-ACCESS not-accessible STATUS current DESCRIPTION " The owner of this result control entry. Typically the owner who created this conceptual row." ::= { ippmResultSharingEntry 1 } ippmResultSharingIndex OBJECT-TYPE SYNTAX Integer32 (1.. 65535) MAX-ACCESS not-accessible STATUS current DESCRIPTION " 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." ::= { ippmResultSharingEntry 2 } ippmResultSharingMeasureOwner OBJECT-TYPE SYNTAX IppmOwnerString MAX-ACCESS read-create STATUS current DESCRIPTION "The owner of the measure to be shared. The couple ippmResultSharingMeasureOwner, ippmResultSharingMeasureIndex identifies absolutely a measure" ::= { ippmResultSharingEntry 3 } ippmResultSharingMeasureIndex OBJECT-TYPE SYNTAX Integer32 (1.. 65535) MAX-ACCESS read-create STATUS current DESCRIPTION "The index of the measure to be shared." ::= { ippmResultSharingEntry 4 } ippmResultSharingGrantedOwner OBJECT-TYPE SYNTAX IppmOwnerString MAX-ACCESS read-create STATUS current DESCRIPTION "The owner who is granted access to the result of the measure described by the couple ippmResultSharingMeasureOwner, ippmResultSharingMeasureIndex." ::= { ippmResultSharingEntry 5 } ippmResultSharingStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION " The status of this table entry. Once the entry status is set to active." ::= { ippmResultSharingEntry 6 } -- -- -- -- ippmMeasure Group -- -- -- ippmMetricTable OBJECT-TYPE SYNTAX SEQUENCE OF IppmMetricEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table describes the current implementation and 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 measurement software handles the table internally. ippmMetricTable is mandatory. ippmMetricTable content is read only." ::= { ippmMeasure 1 } ippmMetricEntry OBJECT-TYPE SYNTAX IppmMetricEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "An entry describes the static capabilities of a metric implementation." INDEX { ippmMetricIndex } ::= { ippmMetricTable 1 } IppmMetricEntry ::= SEQUENCE { ippmMetricIndex Integer32, ippmMetricCapabilities INTEGER, ippmMetricUnit INTEGER, ippmMetricDescription SnmpAdminString, ippmMetricMaxHistorySize Integer32 } ippmMetricIndex OBJECT-TYPE SYNTAX Integer32 (1.. 65535) MAX-ACCESS not-accessible STATUS current DESCRIPTION "ippmMetricIndex defines an unambiguous index for each standardized metric. Its value is the value of the node of the metric in the IPPM-REPORTING-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 calculated between the IPPM-REPORTING-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." ::= { ippmMetricEntry 1 } ippmMetricCapabilities OBJECT-TYPE SYNTAX INTEGER { notImplemented(0), implemented(1) } MAX-ACCESS read-only STATUS current DESCRIPTION "A value of notImplemented implies the metric is not implemented. A value of implemented implies the metric is implemented." DEFVAL { implemented } ::= { ippmMetricEntry 2 } ippmMetricUnit OBJECT-TYPE SYNTAX INTEGER { noUnit(0), second(1), ms(2), us(3), ns(4), percentage(5), packets(6), byte(7), kbyte(8), megabyte(9) } MAX-ACCESS read-only STATUS current DESCRIPTION "The unit used in the current entity for the results of the measurement of this metric." ::= { ippmMetricEntry 3 } ippmMetricDescription OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-only STATUS current DESCRIPTION "A textual description of the metric implementation." ::= { ippmMetricEntry 4 } ippmMetricMaxHistorySize OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-only STATUS current DESCRIPTION "Specifies the maximum number of results that a metric measure can save in the ippmHistoryTable." DEFVAL { 200 } ::= { ippmMetricEntry 5 } -- -- ippmMeasureTable -- -- ippmMeasureTable OBJECT-TYPE SYNTAX SEQUENCE OF IppmMeasureEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "The table of all the IPPM measures which are running in the device. They may not all be active. A measure consists of 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 ippmMeasureHistorySize. The maximum number of MIB objects to be collected in the portion of ippmHistoryTable associated with this metric depends on the value of the ippmMetricMaxHistorySize. The value of each metric ippmMeasureHistorySize must not be over the value of ippmMetricMaxHistorySize corresponding to this metric in the ippmMetricTable. The ippmMeasureTable is mandatory. ippmMeasureTable content is read-create. The table is handled internally by the measurement software for network measures. The setup of network is not permitted through the IPPM REPORTING MIB. OWAP provides a setup protocol to enable and teardown networks measures." ::= { ippmMeasure 2 } ippmMeasureEntry OBJECT-TYPE SYNTAX IppmMeasureEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "The measure entries are created/deleted internally by the measurement software." INDEX { ippmMeasureOwner, ippmMeasureIndex } ::= { ippmMeasureTable 1 } IppmMeasureEntry ::= SEQUENCE { ippmMeasureOwner IppmOwnerString, ippmMeasureIndex Integer32, ippmMeasureName SnmpAdminString, ippmMeasureMetrics IppmStandardMetrics, ippmMeasureBeginTime GMTTimeStamp, ippmMeasureClockPeriodUnit TimeUnit, ippmMeasureClockPeriod Integer32, ippmMeasureDurationUnit TimeUnit, ippmMeasureDuration Integer32, ippmMeasureHistorySize Integer32, ippmMeasureStorageType StorageType, ippmMeasureStatus RowStatus } ippmMeasureOwner OBJECT-TYPE SYNTAX IppmOwnerString MAX-ACCESS not-accessible STATUS current DESCRIPTION "The owner who has configured this entry." ::= { ippmMeasureEntry 1 } ippmMeasureIndex OBJECT-TYPE SYNTAX Integer32 (1.. 65535) MAX-ACCESS not-accessible STATUS current DESCRIPTION "The owner index of the measure. The value is managed by the owner." ::= { ippmMeasureEntry 2 } ippmMeasureName OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-create STATUS current DESCRIPTION "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" ::= { ippmMeasureEntry 3 } ippmMeasureMetrics OBJECT-TYPE SYNTAX IppmStandardMetrics MAX-ACCESS read-create STATUS current DESCRIPTION "Defines the metrics to compute within this measure. A measure may be configured for the result of different metric singletons to be archived 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." -- { one-way-Delay, one-way-Packet-Loss } DEFVAL { '0001000001000000'b } ::= { ippmMeasureEntry 4 } ippmMeasureBeginTime OBJECT-TYPE SYNTAX GMTTimeStamp MAX-ACCESS read-create STATUS current DESCRIPTION "Specifies the time at which the measure starts." ::= { ippmMeasureEntry 5 } ippmMeasureClockPeriodUnit OBJECT-TYPE SYNTAX TimeUnit MAX-ACCESS read-create STATUS current DESCRIPTION "Specifies the unit of the measure period." DEFVAL { second } ::= { ippmMeasureEntry 6 } ippmMeasureClockPeriod OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-create STATUS current DESCRIPTION "Specifies the amount of time between 2 measurement action intervals. The action is specific to the semantic of the measure. Network metrics: The ippmNetworkMeasureClockPattern transforms the flow of periodical instants as a flow of unpredictable instants of measurement packet emission. As the source and the sink share the definition of the clock of the measure, as the sending timestamp is part of the measurement packet, the sink have the information to verify that the stream of packets generated by the source respects the clock law. Aggregated metrics: They are performed periodically on a sequence of results of other measures. The period corresponds to the interval between two successive computations of the metric. The value of ippmHistoryTimestamp result of a aggregated metric computed corresponds to the value of the ippmHistoryTimestamp of the last metric result of the sequence used in to compute the aggregated metric." DEFVAL { 60 } ::= { ippmMeasureEntry 7 } ippmMeasureDurationUnit OBJECT-TYPE SYNTAX TimeUnit MAX-ACCESS read-create STATUS current DESCRIPTION "Specifies the unit of the measure duration." DEFVAL { second } ::= { ippmMeasureEntry 8 } ippmMeasureDuration OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-create STATUS current DESCRIPTION "Specifies the duration of the measure." DEFVAL { 120 } ::= { ippmMeasureEntry 9 } ippmMeasureHistorySize OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-create STATUS current DESCRIPTION "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 overwrites 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. " DEFVAL { 120 } ::= { ippmMeasureEntry 10 } ippmMeasureStorageType OBJECT-TYPE SYNTAX StorageType MAX-ACCESS read-create STATUS current DESCRIPTION "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)" DEFVAL { nonVolatile } ::= { ippmMeasureEntry 11 } ippmMeasureStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "The status of this table entry. Once the entry status is set to active, the associate entry cannot be modified." ::= { ippmMeasureEntry 12 } -- -- ippmHistory Group -- -- -- -- ippmHistoryTable -- ippmHistoryTable OBJECT-TYPE SYNTAX SEQUENCE OF IppmHistoryEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "The table of the results of the measures." ::= { ippmHistory 1 } ippmHistoryEntry OBJECT-TYPE SYNTAX IppmHistoryEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "An ippmHistoryEntry entry is one of the results of a measure identified by ippmMeasureOwner, ippmMeasureIndex, ippmMetricIndex and ippmHistoryIndex. In the index : + ippmMeasureOwner identifies the owner of the measure; + ippmMeasureIndex identifies the measure in the owner namespace; + ippmMetricIndex identifies the metric measured in ippmMetricTable; + ippmHistoryIndex is the local index of the result on the history table." INDEX { ippmMeasureOwner, ippmMeasureIndex, ippmMetricIndex, ippmHistoryIndex } ::= { ippmHistoryTable 1 } IppmHistoryEntry ::= SEQUENCE { ippmHistoryIndex Integer32, ippmHistorySequence Integer32, ippmHistoryTimestamp GMTTimeStamp, ippmHistoryValue Integer32 } ippmHistoryIndex OBJECT-TYPE SYNTAX Integer32 (1.. 65535) MAX-ACCESS not-accessible STATUS current DESCRIPTION " A local index that only identifies a result in the history table." ::= { ippmHistoryEntry 1 } ippmHistorySequence OBJECT-TYPE SYNTAX Integer32 (1.. 65535) MAX-ACCESS read-only STATUS current DESCRIPTION "ippmHistorySequence is the sequence index of the measurement results of the measure of a metric. Network metrics: It's the sequence index of a measurement packet. Typically, it identifies the order of the packet in the stream of packets sends by the source. Aggregated metrics: It is the sequence index of the aggregated metric results computed." ::= { ippmHistoryEntry 2 } ippmHistoryTimestamp OBJECT-TYPE SYNTAX GMTTimeStamp MAX-ACCESS read-only STATUS current DESCRIPTION "The instant of the measure of the result." ::= { ippmHistoryEntry 3 } ippmHistoryValue OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-only STATUS current DESCRIPTION "The value of the measure." ::= { ippmHistoryEntry 4 } ippmOnHistoryFullAction OBJECT-TYPE SYNTAX INTEGER { wrap(1), suspend(2), resume(3) } MAX-ACCESS read-write STATUS current DESCRIPTION "Action to take when the history log is full. The user may choose to either wrap, in which case the agent writes over existing records. The user may choose to suspend writing to the log in the event that he wishes to archive the data. The resume action causes the agent to begin to write in the history log, and assumes the data has been cleared." ::= { ippmHistory 2 } -- -- ippmNetworkMeasure Group -- -- -- -- ippmNetworkMeasureTable -- -- ippmNetworkMeasureTable OBJECT-TYPE SYNTAX SEQUENCE OF IppmNetworkMeasureEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A entry is a measure which performs network measures and provides a flow of results. This table extends the ippmMeasureTable. It performs several metric measurements 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." ::= { ippmNetworkMeasure 1 } ippmNetworkMeasureEntry OBJECT-TYPE SYNTAX IppmNetworkMeasureEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION " Typically the configuration operation sets both the values of the new ippmMeasureEntry and of the new IppmNetworkMeasureEntry. IppmNetworkMeasureTable is mandatory. IppmNetworkMeasureTable content is read only. It means that the measurement software handles the table internally. The setup of network is not permitted through the IPPM REPORTING MIB. OWAP provides a setup protocol to enable and teardown networks measures. The ippmMeasureMetrics is set to a list of metrics to be computed from the same raw packet exchange. Each step of measurement delivers a singleton per chosen metric. Results are timestamped and saved in the ippmHistoryTable. The ippmNetworkMeasureTable typical usage consists is providing network measure indexes to permits aggregated measure to perform aggregation on the results of network measures. An obvious usage of the ippmNetworkMeasureTable consists in the verification of the network measures states." INDEX { ippmMeasureOwner, ippmMeasureIndex } ::= { ippmNetworkMeasureTable 1 } IppmNetworkMeasureEntry ::= SEQUENCE { ippmNetworkMeasureSrcTypeP TypeP, ippmNetworkMeasureSrc TypePaddress, ippmNetworkMeasureDstTypeP TypeP, ippmNetworkMeasureDst TypePaddress, ippmNetworkMeasureClockPattern OCTET STRING, ippmNetworkMeasurePoissonRate Integer32, ippmNetworkMeasureTimeoutDelay Integer32, ippmNetworkMeasureL3PacketSize Integer32, ippmNetworkMeasureDataPattern OCTET STRING } ippmNetworkMeasureSrcTypeP OBJECT-TYPE SYNTAX TypeP MAX-ACCESS read-only STATUS current DESCRIPTION "Defines the type P of the source address of the packets sent by the measure." DEFVAL { '04000080001000'H } -- ->ip: 4.0.0.8.0.1.0 ::= { ippmNetworkMeasureEntry 1 } ippmNetworkMeasureSrc OBJECT-TYPE SYNTAX TypePaddress MAX-ACCESS read-only STATUS current DESCRIPTION "Specifies the address of the source of the measure. It is represented as a list of parameters corresponding to those of the PROTOCOL IDENTIFIER sets in ippmNetworkMeasureSrcTypeP." ::= { ippmNetworkMeasureEntry 2} ippmNetworkMeasureDstTypeP OBJECT-TYPE SYNTAX TypeP MAX-ACCESS read-only STATUS current DESCRIPTION "Defines the type P of the destination address of the packets sent by the measure." ::= { ippmNetworkMeasureEntry 3 } ippmNetworkMeasureDst OBJECT-TYPE SYNTAX TypePaddress MAX-ACCESS read-only STATUS current DESCRIPTION "Specifies the address of the source of the measure. It is represented as a list of parameters corresponding to those of the PROTOCOL IDENTIFIER sets in ippmNetworkMeasureSrcTypeP." ::= { ippmNetworkMeasureEntry 4 } ippmNetworkMeasureClockPattern OBJECT-TYPE SYNTAX OCTET STRING MAX-ACCESS read-only STATUS current DESCRIPTION "This cyclic clock shapes the profile of the instants of measurement action provided by ippmMeasureClockPeriod according to an arbitrary distribution law. The clock resolution is ippmMeasureClockPeriod. The bits of the clock pattern set to the value 1 determine the valid instants of measurement action. 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 time sampling law such as periodic, pseudo random or Poisson. The source of the measure sends the stream of measurement packets synchronously with the stream of instants selected by the clock pattern sampling. ippmNetworkMeasureClockPattern can not be used conjointly with ippmNetworkMeasurePoissonRate." DEFVAL { "11111111" } -- 100% periodic ::= { ippmNetworkMeasureEntry 5 } ippmNetworkMeasurePoissonRate OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-only STATUS current DESCRIPTION "Indicates the average number of packets per seconds sent using a poisson law. ippmNetworkMeasurePoissonRate can not be used conjointly with ippmNetworkMeasureClockPattern." DEFVAL { 30 } ::= { ippmNetworkMeasureEntry 6 } ippmNetworkMeasureTimeoutDelay OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-only STATUS current -- UNITS "Milliseconds" DESCRIPTION "Specifies the delay after which the packet is considered lost by the sink." DEFVAL { 1 } ::= { ippmNetworkMeasureEntry 7 } ippmNetworkMeasureL3PacketSize OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-only STATUS current DESCRIPTION "Specifies the size of the packets sent at the last network layer in regards to the TypeP definition." DEFVAL { 64 } ::= { ippmNetworkMeasureEntry 8 } ippmNetworkMeasureDataPattern OBJECT-TYPE SYNTAX OCTET STRING MAX-ACCESS read-only STATUS current DESCRIPTION "The current field defines the round robin pattern used to fill the packet." DEFVAL { 'FF'H } ::= { ippmNetworkMeasureEntry 9 } -- -- -- ippmAggrMeasure Group -- -- -- -- -- ippmAggrMeasureTable -- -- ippmAggrMeasureTable OBJECT-TYPE SYNTAX SEQUENCE OF IppmAggrMeasureEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION " This table extends the ippmMeasureTable. An aggregated measure summarizes the results of previous network or aggregated measures. The results may be saved in the ippmHistoryTable. Each step of the calculation for the measure produces a singleton result per metric." ::= { ippmAggrMeasure 1 } ippmAggrMeasureEntry OBJECT-TYPE SYNTAX IppmAggrMeasureEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Typically the configuration operation sets both the values of the new ippmMeasureEntry and of the new IppmAggrMeasureEntry. ippmAggrMeasureTable is mandatory. ippmAggrMeasureTable content is read only. It means that the measure software handles the table internally. The ippmMeasureMetrics defines the metric to compute. The results of the measure to summarize are identified by: + ippmAggrMeasureHistoryOwner, + ippmAggrMeasureHistoryOwnerIndex and + ippmAggrMeasureHistoryMetric The aggregated task starts at ippmMeasureBeginTime and ends after ippmMeasureDuration. An aggregated result is performed and saved in the ippmHistoryTable for each ippmMeasureClockPeriod tick. " INDEX { ippmMeasureOwner, ippmMeasureIndex } ::= { ippmAggrMeasureTable 1 } IppmAggrMeasureEntry ::= SEQUENCE { ippmAggrMeasureHistoryOwner IppmOwnerString, ippmAggrMeasureHistoryOwnerIndex Integer32, ippmAggrMeasureHistoryMetric Integer32 } ippmAggrMeasureHistoryOwner OBJECT-TYPE SYNTAX IppmOwnerString MAX-ACCESS read-create STATUS current DESCRIPTION "The owner of the measure to summarize. " ::= { ippmAggrMeasureEntry 1 } ippmAggrMeasureHistoryOwnerIndex OBJECT-TYPE SYNTAX Integer32 (1.. 65535) MAX-ACCESS read-create STATUS current DESCRIPTION "The owner index of the measure to summarize. " ::= { ippmAggrMeasureEntry 2 } ippmAggrMeasureHistoryMetric OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-create STATUS current DESCRIPTION "The metric of the measure to summarize. " ::= { ippmAggrMeasureEntry 3 } -- -- ippmReport Group -- -- -- -- ippmReportSetupTable -- -- ippmReportSetupTable OBJECT-TYPE SYNTAX SEQUENCE OF IppmReportSetupEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "The ippmReportSetupTable is a list of definition of reports. It defines the results of a network or aggregated measures that are to be reported. 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 intended to be 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 a measure may include the definition of a report." ::= { ippmReport 1 } ippmReportSetupEntry OBJECT-TYPE SYNTAX IppmReportSetupEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "The report applies to the results of the measure which is extended by the current report definition. Typically the creation of 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. A report is associated to a network measure or to an aggregated measure. Note 1 : To associate a report to an existing measure the manager suspends the measure while setting the ippmMeasureStatus to 'notInService'. Then he setups the report fields and activates the measure while setting the ippmMeasureStatus to 'active'. Note 2 : A report is tied to a measure. The period of the measure " INDEX { ippmMeasureOwner, ippmMeasureIndex } ::= { ippmReportSetupTable 1 } IppmReportSetupEntry ::= SEQUENCE { ippmReportSetupDefinition IppmReportDefinition, ippmReportSetupMetricThreshold Integer32, ippmReportSetupDurationThreshold Integer32, ippmReportSetupNMS SnmpAdminString, ippmReportSetupNotification OBJECT IDENTIFIER, ippmReportSetupStatus RowStatus } ippmReportSetupDefinition OBJECT-TYPE SYNTAX IppmReportDefinition MAX-ACCESS read-create STATUS current DESCRIPTION "The description of the events and actions that are used in the definition of the report. Send the report using the type of message selected by the bits 8 to 12. The report consists of 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 durations 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 report setup of an alarm to be sent to the owner in a SNMP Trap each time the two results are found on each side of 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 two results found on each side of the metric threshold of 5: ippmReportSetupMetricThreshold 5 ippmReportSetupDefinition { onMeasureCycle(2), reportOnlyUptoDownMetricResults(4), inInformRequestPDU(10), onReportDeliveryClearHistory(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 corresponding to this cycle of measure from the ippmHistoryTable on reception of the response to the InformRequestPDU : ippmReportSetupDefinition { onMeasureCycle(2), inInformRequestPDU(10), onReportDeliveryClearHistory(13) } " DEFVAL { { onMeasureCycle, inInformRequestPDU, onReportDeliveryClearHistory} } ::= { ippmReportSetupEntry 1 } ippmReportSetupMetricThreshold OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-create STATUS current DESCRIPTION "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. " ::= { ippmReportSetupEntry 2 } ippmReportSetupDurationThreshold OBJECT-TYPE SYNTAX Integer32 UNITS "Seconds" MAX-ACCESS read-create STATUS current DESCRIPTION "An event is generated when contiguous results of the measure are over the ippmReportSetupMetricThreshold, during ippmReportSetupDurationThreshold seconds. Performance: To improve the performance the ippmReportSetupDurationThreshold may have the same value as the ippmMeasurePeriod. The default value of ippmReportSetupDurationThreshold is ippmMeasurePeriod. That improves the performance because the threshold comparison is synchronized with the ippmMeasurePeriod aggregation cycle. That improves the performance because it synchronized the report exportation with the management of the history and report records of a measure." DEFVAL { 15 } ::= { ippmReportSetupEntry 3 } ippmReportSetupNMS OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-create STATUS current DESCRIPTION "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 type of ippmReportSetupNMS is not InetAddress because the report may be sent using SMS or fax. " ::= { ippmReportSetupEntry 4 } ippmReportSetupNotification OBJECT-TYPE SYNTAX OBJECT IDENTIFIER MAX-ACCESS read-create STATUS current DESCRIPTION " ippmReportSetupNotification identifies the notification used to send the report. The definition of the notification defines the content and the format of the report. " ::= { ippmReportSetupEntry 5 } ippmReportSetupStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "The status of this table entry. " ::= { ippmReportSetupEntry 6 } -- -- ippmReportTable -- ippmReportTable OBJECT-TYPE SYNTAX SEQUENCE OF IppmReportEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "The ippmReportTable logs the results of the reports. The results consist of a subset of the results of a measure as described in the report definition. The activation of an up and down filtering in the report definition limits the results logged to those corresponding to major events. Otherwise, the ippmReportTable is identical to the ippmHistoryTable." ::= { ippmReport 2 } ippmReportEntry OBJECT-TYPE SYNTAX IppmReportEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "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 a measure to report. An ippmReportEntry entry is one of the results of a measure identified by ippmReportOwner, ippmReportIndex, ippmReportIndex and ippmHistoryIndex. In the index: + ippmMeasureOwner identifies the owner of the measure; + ippmMeasureIndex identifies the measure in the owner namespace; + ippmMetricIndex identifies the metric measured in ippmMetricTable; + ippmReportIndex is the local index of the result on the report table." INDEX { ippmMeasureOwner, ippmMeasureIndex, ippmMetricIndex, ippmReportIndex } ::= { ippmReportTable 1 } IppmReportEntry ::= SEQUENCE { ippmReportIndex Integer32, ippmReportSequence Integer32, ippmReportTimestamp GMTTimeStamp, ippmReportValue Integer32 } ippmReportIndex OBJECT-TYPE SYNTAX Integer32 (1.. 65535) MAX-ACCESS not-accessible STATUS current DESCRIPTION "The local index of the result of a metric measure" ::= { ippmReportEntry 1 } ippmReportSequence OBJECT-TYPE SYNTAX Integer32 (1.. 65535) MAX-ACCESS read-only STATUS current DESCRIPTION " ippmReportSequence is the sequence index of the measurement results of the measure of a metric. Network metrics: It's the sequence index of a measurement packet. Typically, it identifies the order of the packet in the stream of packets sends by the source. Aggregated metrics: It is the sequence index of the aggregated metric results computed." ::= { ippmReportEntry 2 } ippmReportTimestamp OBJECT-TYPE SYNTAX GMTTimeStamp MAX-ACCESS read-only STATUS current DESCRIPTION "The instant of the measure of the result." ::= { ippmReportEntry 3 } ippmReportValue OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-only STATUS current DESCRIPTION "The value." ::= { ippmReportEntry 4 } ippmOnReportFullAction OBJECT-TYPE SYNTAX INTEGER { wrap(1), suspend(2), resume(3) } MAX-ACCESS read-write STATUS current DESCRIPTION "Action to take when the report log is full. The user may choose to either wrap, in which case the agent writes over existing records. The user may choose to suspend writing to the log in the event that he wishes to archive the data. The resume action causes the agent to begin to write in the report log, and assumes the data has been cleared." ::= { ippmReport 3 } -- -- IPPM Notifications -- ippmSingletonAlarm NOTIFICATION-TYPE OBJECTS { ippmMetricUnit, ippmReportTimestamp, ippmReportValue } STATUS current DESCRIPTION "A notification sent because 2 contiguous results are on opposite sides of the metric threshold value. The notification contains the instances of the ippmReportValue object that exceeded the threshold. The notification contains the instances of the ippmReportTimestamp identifying the time the event occurred." ::= { ippmNotifications 1 } ippmEventsDurationExceededAlarm NOTIFICATION-TYPE OBJECTS { ippmMetricUnit, ippmReportTimestamp, ippmReportValue } STATUS current DESCRIPTION "A notification sent when the duration of contiguous raising ippmReportSetupMetricThreshold exceeds the ippmReportSetupDurationThreshold value. The notification contains the instances of the ippmReportValue object that exceeded the threshold. The notification contains the instances of the ippmReportTimestamp identifying the time the event occurred." ::= { ippmNotifications 2 } ippmCycleOfMeasureReport NOTIFICATION-TYPE OBJECTS { ippmMetricUnit, ippmHistoryTimestamp, ippmHistoryValue } STATUS current DESCRIPTION "A notification sent when a measure cycle completes. The notification contains the instances of the ippmReportValue objects saved in the ippmReportTable for this measure cycle. The ippmHistoryTimestamp of the index identifies the time the measures where performed." ::= { ippmNotifications 3 } ippmCompletedMeasureReport NOTIFICATION-TYPE OBJECTS { ippmMetricUnit, ippmHistoryTimestamp, ippmHistoryValue } STATUS current DESCRIPTION "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 ippmHistoryTimestamp of the index identifies the time the measures where performed." ::= { ippmNotifications 4 } ippmHistoryLogFull NOTIFICATION-TYPE OBJECTS { ippmOnHistoryFullAction } STATUS current DESCRIPTION "A notification sent when the history log is full. It indicates what action is to be taken. If the action is wrap the agent will write over existing records in the beginning of the log file. If the action is suspend, the agent halts all recording of measures in the history table. If the action is resume, the agent begins writing measures again in the history log" ::= { ippmNotifications 5 } ippmReportLogFull NOTIFICATION-TYPE OBJECTS { ippmOnReportFullAction } STATUS current DESCRIPTION "A notification sent when the report log is full. It indicates what action is to be taken. If the action is wrap the agent will write over existing records in the beginning of the log file. If the action is suspend, the agent halts all recording of measures in the report table. If the action is resume, the agent begins writing measures again in the report log" ::= { ippmNotifications 6 } -- -- IPPM MIB Conformance statements -- ippmCompliances OBJECT IDENTIFIER ::={ ippmConformance 1 } ippmGroups OBJECT IDENTIFIER ::={ ippmConformance 2 } ippmProxyInterDomainCompliances MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for SNMP entities which implement the IPPM MIB as a proxy in interdomain. The implementation of the VACM control is mandatory." MODULE -- this module MANDATORY-GROUPS { ippmSystemGroup, ippmMeasureGroup, ippmNetworkMeasureGroup, ippmHistoryGroup, ippmAggrMeasureGroup, ippmReportGroup, ippmNotificationGroup } ::= { ippmCompliances 1 } ippmProxyCompliances MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for SNMP entities which implement the IPPM MIB as a proxy." MODULE -- this module MANDATORY-GROUPS { ippmSystemGroup, ippmMeasureGroup, ippmNetworkMeasureGroup, ippmHistoryGroup, ippmAggrMeasureGroup, ippmReportGroup, ippmNotificationGroup } GROUP ippmOwnersGroup DESCRIPTION "The ippmOwnersGroup is needed if VACM is not implemented." ::= { ippmCompliances 2 } ippmProbeCompliances MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for SNMP entities which implement the IPPM MIB in a probe." MODULE -- this module MANDATORY-GROUPS { ippmSystemGroup, ippmMeasureGroup, ippmNetworkMeasureGroup, ippmHistoryGroup } ::= { ippmCompliances 3 } ippmSystemGroup OBJECT-GROUP OBJECTS { ippmSystemSynchronizationDesc, ippmSystemTime, ippmSystemSynchronizationType, ippmSystemClockResolution, ippmSystemCurrentSynchronization, ippmSynchronizationTime, ippmSynchronizationStratum, ippmSynchronizationResolution, ippmPointOfMeasureMgmtAddrType, ippmPointOfMeasureMgmtAddress, ippmPointOfMeasureTypePAddress, ippmPointOfMeasureAddress } STATUS current DESCRIPTION "The IPPM System Group" ::= { ippmGroups 1} ippmMeasureGroup OBJECT-GROUP OBJECTS { ippmMetricCapabilities, ippmMetricUnit, ippmMetricDescription, ippmMetricMaxHistorySize, ippmMeasureName, ippmMeasureMetrics, ippmMeasureBeginTime, ippmMeasureClockPeriodUnit, ippmMeasureClockPeriod, ippmMeasureDurationUnit, ippmMeasureDuration, ippmMeasureHistorySize, ippmMeasureStorageType, ippmMeasureStatus } STATUS current DESCRIPTION "The IPPM Measure Group" ::= { ippmGroups 2} ippmNetworkMeasureGroup OBJECT-GROUP OBJECTS { ippmNetworkMeasureSrcTypeP, ippmNetworkMeasureSrc, ippmNetworkMeasureDstTypeP, ippmNetworkMeasureDst, ippmNetworkMeasureClockPattern, ippmNetworkMeasurePoissonRate, ippmNetworkMeasureTimeoutDelay, ippmNetworkMeasureL3PacketSize, ippmNetworkMeasureDataPattern } STATUS current DESCRIPTION "The IPPM Network Measure Group" ::= { ippmGroups 3} ippmHistoryGroup OBJECT-GROUP OBJECTS { ippmHistorySequence, ippmHistoryTimestamp, ippmOnHistoryFullAction, ippmHistoryValue } STATUS current DESCRIPTION "The IPPM History Group" ::= { ippmGroups 4} ippmAggrMeasureGroup OBJECT-GROUP OBJECTS { ippmAggrMeasureHistoryOwner, ippmAggrMeasureHistoryOwnerIndex, ippmAggrMeasureHistoryMetric } STATUS current DESCRIPTION "The IPPM AggregatedMeasure Group" ::= { ippmGroups 5} ippmReportGroup OBJECT-GROUP OBJECTS { ippmReportSetupDefinition, ippmReportSetupMetricThreshold, ippmReportSetupDurationThreshold, ippmReportSetupNMS, ippmReportSetupNotification, ippmReportSetupStatus, ippmReportSequence, ippmReportTimestamp, ippmReportValue, ippmOnReportFullAction } STATUS current DESCRIPTION "The IPPM Report Group" ::= { ippmGroups 6} ippmOwnersGroup OBJECT-GROUP OBJECTS { ippmOwnersOwner, ippmOwnersGrantedMetrics, ippmOwnersGrantedRules, ippmOwnersIpAddress, ippmOwnersEmail, ippmOwnersSMS, ippmOwnersStatus, ippmOwnersIpAddressType, ippmResultSharingMeasureOwner, ippmResultSharingMeasureIndex, ippmResultSharingGrantedOwner, ippmResultSharingStatus } STATUS current DESCRIPTION "The IPPM Owners Group" ::= { ippmGroups 7} ippmNotificationGroup NOTIFICATION-GROUP NOTIFICATIONS { ippmSingletonAlarm, ippmCycleOfMeasureReport, ippmCompletedMeasureReport, ippmEventsDurationExceededAlarm, ippmHistoryLogFull, ippmReportLogFull } STATUS current DESCRIPTION "The IPPM Notification Group" ::= { ippmGroups 8} END -- -- "Copyright (C) The Internet Society (2001). All Rights Reserved. -- -- This document and translations of it may be copied and furnished to -- others, and derivative works that comment on or otherwise explain it -- or assist its implementation may be prepared, copied, published and -- distributed, in whole or in part, without restriction of any kind, -- provided that the above copyright notice and this paragraph are -- included on all such copies and derivative works. However, this -- document itself may not be modified in any way, such as by removing -- the copyright notice or references to the Internet Society or other -- Internet organizations, except as needed for the purpose of -- developing Internet standards in which case the procedures for -- copyrights defined in the Internet Standards process must be -- followed, or as required to translate it into languages other than -- English. -- -- The limited permissions granted above are perpetual and will not be -- revoked by the Internet Society or its successors or assigns. -- -- This document and the information contained herein is provided on an -- "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING -- TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING -- BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION -- HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF -- MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.