-- extracted from draft-ietf-disman-conditionmib-03.txt -- at Tue Jul 30 06:10:17 2002 ARC-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-TYPE, Unsigned32 FROM SNMPv2-SMI TEXTUAL-CONVENTION, RowStatus FROM SNMPv2-TC MODULE-COMPLIANCE, OBJECT-GROUP FROM SNMPv2-CONF arcMIB MODULE-IDENTITY LAST-UPDATED "200207160000Z" ORGANIZATION "IETF Distributed Management Working Group" CONTACT-INFO "WG EMail: disman@dorothy.bmc.com Subscribe: disman-request@dorothy.bmc.com Chair: Randy Presuhn BMC Software, Inc. Office 1-3141 2141 North First Street San Jose, California 95131 USA Tel: +1 408 546-1006 E-mail: rpresuhn@bmc.com Editor: Kam Lam Lucent Technologies, 4C-616 101 Crawfords Corner Road Holmdel, NJ 07733 USA Tel: +1 732 949 8338 E-mail: hklam@lucent.com" DESCRIPTION "The MIB module describes the objects for controlling a resource in reporting alarm conditions that it detects." REVISION "200207160000Z" DESCRIPTION "Initial version, published as RFC xxxx." -- RFC Ed.: replace xxxx with actual RFC number & remove this notice ::={ mib-2 yy } -- RFC Ed.: replace yy with IANA-assigned number & remove this notice ------------------ -- TEXTUAL-CONVENTION ------------------ IANAItuProbableCauseOrZero ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "This TC can take any value of IANAItuProbableCause or 0. IANAItuProbableCause is defined in the IANA-ITU-ALARM-TC module in the Alarm MIB document." SYNTAX Unsigned32 ------------------ -- MIB Objects ------------------ arcMIBTimeIntervals OBJECT IDENTIFIER ::= { arcMIB 1 } arcMIBObjects OBJECT IDENTIFIER ::= { arcMIB 2 } arcMIBTITimeInterval OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS read-write STATUS current DESCRIPTION "This variable indicates the time interval used for the nalmTI state, in units of second. It is a pre-defined length of time in which the resource will stay in the NALM-TI state before transition into the ALM state. Instances of this object SHOULD persist across agent restarts." ::= { arcMIBTimeIntervals 1 } arcMIBCDTimeInterval OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS read-write STATUS current DESCRIPTION "This variable indicates the time interval used for the nalmQICD state, in units of second. It is a pre-defined length of time in which the resource will stay in the NALM-QI-CD state before transition into the ALM state after it is problem-free. Instances of this object SHOULD persist across agent restarts." ::= { arcMIBTimeIntervals 2 } arcTable OBJECT-TYPE SYNTAX SEQUENCE OF ArcEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A table of Alarm Report Control (ARC) settings on the system. Alarm Report Control is a feature that provides an automatic in-service provisioning capability. Alarm reporting is turned off on a per-resource basis for a selective set of potential alarm conditions to allow sufficient time for customer testing and other maintenance activities in an "alarm free" state. Once a resource is ready for service, alarm reporting is automatically or manually turned on. There are five ARC states: ALM, NALM, NALM-QI, NALM-QI-CD and NALM-TI. ALM: Alarm reporting is turned on (i.e., is allowed). NALM: Alarm reporting is turned off (i.e., not allowed). NALM-QI: NALM - Qualified Inhibit. Alarm reporting is turned off until the managed entity is qualified problem-free for a specified persistence interval. NALM-QI-CD: NALM-QI - Count down. This is a substate of NALM-QI and performs the persistence timing countdown function when the managed entity is qualified problem-free. NALM-TI: NALM - Timed Inhibit. Alarm reporting is turned off for a specified time interval. ALM may transition to NALM, NALM-QI, or NAML-TI by management request. NALM may transition to ALM, NALM-QI, or NAML-TI by management request. NALM-QI may transition to NALM or ALM by management request. NALM-QI may transition to ALM automatically if qualified problem-free (if NALM-QI-CD is not supported) or if the CD timer expired (if NALM-QI-CD is supported) NALM-TI may transition to ALM or NALM by management request. NALM-TI may transition to ALM automatically if the TI timer expired. Further details of ARC state transitions are defined in Figure 3 of M.3100 Amd3." ::= { arcMIBObjects 1 } arcEntry OBJECT-TYPE SYNTAX ArcEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A conceptual row that contains information about the ARC setting of a resource in the system. Instances of this conceptual row SHOULD persist across agent restarts." INDEX { arcIndex, arcAlarmType, arcNotificationId } ::= { arcTable 1 } ArcEntry ::= SEQUENCE { arcIndex OBJECT IDENTIFIER, arcAlarmType IANAItuProbableCause, arcNotificationId OBJECT IDENTIFIER, arcState INTEGER, arcNalmTimeRemaining Unsigned32, arcRowStatus RowStatus } arcIndex OBJECT-TYPE SYNTAX OBJECT IDENTIFIER MAX-ACCESS not-accessible STATUS current DESCRIPTION "This object uniquely identifies a resource, which is under the arcState's control for the associated arcAlarmType." ::= { arcEntry 1 } arcAlarmType OBJECT-TYPE SYNTAX IANAItuProbableCauseOrZero MAX-ACCESS not-accessible STATUS current DESCRIPTION "This object identifies the alarm condition types controlled by the arcState. It specifies the value 0 or a value of IANAItuProbableCause that is applicable to the resource. IANAItuProbableCause is defined in the IANA-ITU-ALARM-TC module in the Alarm MIB document. The value of zero (0) implies any probable causes that are applicable to the resource. Usually, the applicable probable causes of a resource are specified in the resource-specific mib." ::= { arcEntry 2 } arcNotificationId OBJECT-TYPE SYNTAX OBJECT IDENTIFIER MAX-ACCESS not-accessible STATUS current DESCRIPTION "This object identify the type of notification to be suppressed. The notification type identified should be the one normally used by the resource for reporting its alarms. When the value of 0.0 is specified for this object, it implies all applicable notification types." ::= { arcEntry 3 } arcState OBJECT-TYPE SYNTAX INTEGER { alm (1), nalm (2), nalmQI (3), nalmTI (4), nalmQICD (5) } MAX-ACCESS read-create STATUS current DESCRIPTION "The object controls the alarm report of a resource. A manager can set the arcState to either alm, nalm, nalmQI, or nalmTI. ALM: Alarm reporting is turned on (i.e., is allowed). NALM: Alarm reporting is turned off. NALM-TI: Alarm reporting is turned off for a time interval. (TI - Time Inhibit). NALM-QI: Alarm reporting is turned off for a specified alarm type until the resource is qualified problem-free for an optional time interval. Problem-free means that the condition corresponding to the specified alarm type does not exist. (QI - Qualified Inhibit). NALM-QI-CD: This is a substate of NALM-QI and performs the persistence timing count down function after the resource is qualified problem-free. (CD - Count Down). According to the requirements in M.3100 Amendment 3, a resource supporting the ARC feature shall support the ALM state and at least one of the NALM, NALM-TI, and NALM-QI states. NALM-QI-CD is an optional substate of NALM-QI. Once the resource enters the normal reporting mode (ie., in the alm state) for the specified alarm type, the corresponding entry will be automatically deleted from the arc table. The manual setting of the arcState to alm has the effect of removing the entry from the arc table. The value of nalamQICD is a transitional state from nalmQI to alm. It is optional depending on the type and the implementation of the resource. If it is supported, before the state transitions from nalmQI to alm, a count down period is activated for a duration set by the object arcNalmCDTimeInterval. When the time is up, the arcState is set to alm." ::= { arcEntry 4 } arcNalmTimeRemaining OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS read-write STATUS current DESCRIPTION "This variable indicates the time remaining in the NALM-TI interval or the NALM-QI-CD interval, in units of second. At the moment the resource enters the NALM-TI state, this variable will have the initial value equal to the value of arcNalmTITimeInterval and then starts decrementing as time goes by. Similarly at the moment the resource enters the NALM-QI-CD state, this variable will have the initial value equal to the value of arcNalmCDTimeInterval and then starts decrementing as time goes by. This variable is read-write and thus will allow the manager to extend or shorten, as needed, the remaining time when the resource is in the NALM-TI or NALM-QI-CD state. If this variable is supported and the resource is currently not in the NALM-TI nor NAML-QI-CD state, the value of this variable shall equal to zero." ::= { arcEntry 5 } arcRowStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "This columnar object is used for creating and deleting a conceptual row of the arcTable. It is used to create and delete a arc setting. Setting RowStatus to createAndGo or createAndWait implies creating a new ARC setting for the specified resource and alarm type. Setting RowStatus to destroy implies removing the ARC setting and thus has the effect of resuming normal reporting behaviour of the resource for the alarm type." ::= { arcEntry 6 } -------------------------- -- conformance information -------------------------- arcConformance OBJECT IDENTIFIER ::= { arcMIB 3 } arcCompliances OBJECT IDENTIFIER ::= { arcConformance 1 } arcCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for systems supporting the ARC MIB." MODULE -- this module MANDATORY-GROUPS { arcSettingGroup } ::= { arcCompliances 1 } arcGroups OBJECT IDENTIFIER ::= { arcConformance 2 } arcSettingGroup OBJECT-GROUP OBJECTS { arcState, arcRowStatus } STATUS current DESCRIPTION "ARC Setting group." ::= { arcGroups 1} arcTIGroup OBJECT-GROUP OBJECTS { arcMIBTITimeInterval, arcNalmTimeRemaining } STATUS current DESCRIPTION "ARC Time Inhibit group." ::= { arcGroups 2} arcQICDGroup OBJECT-GROUP OBJECTS { arcMIBCDTimeInterval, arcNalmTimeRemaining } STATUS current DESCRIPTION "ARC Quality Inhibit (QI) Count Down (CD) group." ::= { arcGroups 3} END -- -- Copyright (C) The Internet Society (2002). 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 in 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. -- -- Expires January 25, 2003 [Page xx]