alarmirpconstdefs.idl

UCS (Ultra Corba Simulator) is one more powerful corba client/servant simulator tool than other simi

      const short TIMEOUT_EXPIRED = 546;
      const short VARIABLE_OUT_OF_RANGE = 547;
      const short WATCH_DOG_TIMER_EXPIRED = 548;
      const short COOLING_SYSTEM_FAILURE = 549;
      const short EXTERNAL_EQUIPMENT_FAILURE = 550;
      const short EXTERNAL_POWER_SUPPLY_FAILURE = 551;
      const short EXTERNAL_TRANSMISSION_DEVICE_FAILURE = 552;
      // Values 553-560 correspond to duplicated probable causes
      const short REDUCED_ALARM_REPORTING = 561;
      const short REDUCED_EVENT_REPORTING = 562;
      const short RECUCED_LOGGING_CAPABILITY = 563;
      const short SYSTEM_RESOURCES_OVERLOAD = 564;
      const short BROADCAST_CHANNEL_FAILURE = 565;
      const short CONNECTION_ESTABLISHMENT_ERROR = 566;
      const short INVALID_MESSAGE_RECEIVED = 567;
      const short INVALID_MSU_RECEIVED = 568;
      const short LAPD_LINK_PROTOCOL_FAILURE = 569;
      const short LOCAL_ALARM_INDICATION = 570;
      const short REMOTE_ALARM_INDICATION = 571;
      const short ROUTING_FAILURE = 572;
      const short SS7_PROTOCOL_FAILURE = 573;
      const short TRANSMISSION_ERROR = 574;
      // Value 575 corresponds to a duplicated probable cause
      // Values 576-700 are reserved for potential future extensions
      // for 2G & 3G wireless systems
      /*
      Probable causes originating from M.3100 security alarm causes.
      Values below correspond to M.3100 values with an offset of 700.
      */
      const short AUTHENTICATION_FAILURE = 701;
      const short BREACH_OF_CONFIDENTIALITY = 702;
      const short CABLE_TAMPER = 703;
      const short DELAYED_INFORMATION = 704;
      const short DENIAL_OF_SERVICE = 705;
      const short DUPLICATE_INFORMATION = 706;
      const short INFORMATION_MISSING = 707;
      const short INFORMATION_MODIFICATION_DETECTED = 708;
      const short INFORMATION_OUT_OF_SEQUENCE = 709;
      // Value 710 corresponds to a duplicated probable cause
      const short KEY_EXPIRED = 711;
      const short NON_REPUDIATION_FAILURE = 712;
      const short OUT_OF_HOURS_ACTIVITY = 713;
      const short OUT_OF_SERVICE = 714;
      const short PROCEDURAL_ERROR = 715;
      const short UNAUTHORISED_ACCESS_ATTEMPT = 716;
      const short UNEXPECTED_INFORMATION = 717;
      const short UNSPECIFIED_REASON = 718;
      // Values 719-800 are reserved for potential M.3100 future extensions
   };
   /*
   This block identifies the acknowledgement state of a reported alarm.
   */
   interface AckState
   {
      const short ACKNOWLEDGED = 1;
      const short UNACKNOWLEDGED = 2;
   };
   /*
   This block identifies attributes which are included as part of the Alarm IRP
   These attribute values should not clash with those defined for the attributes
   of notification header (see IDL of Notification IRP).
   */
   interface AttributeNameValue
   {
      const string ALARM_ID = "f";
      const string PROBABLE_CAUSE = "g";
      const string PERCEIVED_SEVERITY = "h";
      const string SPECIFIC_PROBLEM = "i";
      const string ADDITIONAL_TEXT = "j";
      const string ACK_TIME = "k";
      const string ACK_USER_ID = "l";
      const string ACK_SYSTEM_ID = "m";
      const string ACK_STATE = "n";
      const string COMMENTS = "o";
      const string BACKED_UP_STATUS = "p";
      const string BACK_UP_OBJECT = "q";
      const string THRESHOLD_INFO = "r";
      const string TREND_INDICATION = "s";
      const string STATE_CHANGE_DEFINITION = "t";
      const string MONITORED_ATTRIBUTES = "u";
      const string PROPOSED_REPAIR_ACTIONS = "v";
      const string CORRELATED_NOTIFICATIONS = "w";
      const string REASON = "x";
      const string CLEAR_USER_ID = "y";
      const string CLEAR_SYSTEM_ID = "z";
      const string ALARM_LIST_ALIGNMENT_REQUIREMENT = "ff";
      const string SERVICE_USER = "gg";
      const string SERVICE_PROVIDER = "hh";
      const string SECURITY_ALARM_DETECTOR = "ii";
      const string VENDOR_SPECIFIC_ALARM_TYPE = "jj";
            const string ALARM_RAISED_TIME = "kk";
      const string ALARM_CLEARED_TIME = "ll";
   };
   /*
      constants for use in populating the additional information
      name field Names
   */
   interface AdditionalInformation
    {
       const string AI_VS_PERCEIVED_SEVERITY = "ai_ps";
       const string AI_VS_ALARM_TYPE         = "ai_at";
    };
   
   /*
   Defines the content of a Comment
   */
   struct Comment
   {
      ManagedGenericIRPConstDefs::IRPTime comment_time;
      string comment_text;
      string user_id;
      string system_id;
   };
   /*
   Defines a set of comments which are placed in the COMMENTS attribute
   of a structured event.
   */
   typedef sequence <Comment> CommentSet;
   /*
   It indicates if an object has a back up.
   True implies backed up. False implies not backed up.
   */
   typedef boolean BackedUpStatus;
   /*
   It indicates if the threshold crossed was in the up or down direction.
   */
   enum ThresholdIndication {UP, DOWN};
   /*
   It indicates if the AlarmList alignment is required.
   */
   enum AlarmListAlignmentRequirement {REQUIRED, NOTREQUIRED};
   /* FloatOpt is an optional type.
   If the discriminator is true the value is present.
   Otherwise the value is null.
   */
   union FloatOpt switch (boolean)
   {
      case TRUE: float value;
   };
   /* ThresholdLevelInd describes multi-level
   threshold crossings.
   Up is the only permitted choice for a counter.
   If indication is "up", low value is optional.
   @member indication: indicates up or down direction
     of crossing.
   @member low: the low observed value.
   @member high: the high observed value.
   */
   struct ThresholdLevelInd
   {
      ThresholdIndication indication;
      FloatOpt low;
      float high;
   };
   /* ThresholdLevelIndOpt is an optional type.
   If the discriminator is true the value is present.
   Otherwise, the value is null.
   */
   union ThresholdLevelIndOpt switch (boolean)
   {
      case TRUE: ThresholdLevelInd value;
   };
   /* ThresholdInfo indicates some gauge or counter
   attribute passed a set threshold.
   @member attribute_id: identifies the attribute that
     crossed the threshold.
   @member observed_value: attributes that are of type
     integer will be converted to floats.
   @member threshold_level: This parameter is for
     multi-level thresholds. Optional.
   @member arm_time: May contain empty string.
   */
   struct ThresholdInfo
   {
      string attribute_id;
      float observed_value;
      ThresholdLevelIndOpt threshold_level;
      string arm_time;
   };
   /*
   It indicates if some observed condition is getting better, worse,
   or not changing.
   */
   enum TrendIndication {LESS_SEVERE, NO_CHANGE, MORE_SEVERE};
   /*
   It is used to report a changed attribute value.
   */
   struct AttributeValueChange
   {
      string attribute_name;
      any old_value;  // type depends on attribute
      any new_value;  // type depends on attribute
   };
   typedef sequence <AttributeValueChange> AttributeChangeSet;
   /*
   It is used to report an attribute and its value.
   */
   struct AttributeValue
   {
      string attribute_name;
      any value;  // type depends on the attribute
   };
   typedef sequence <AttributeValue> AttributeSet;
   typedef sequence <long> NotifIdSet;
   /*
   This holds identifiers of notifications that are correlated.
   */
   struct CorrelatedNotification
   {
      DN source;  // Contains DN of MO that emitted the set of notifications
                  // DN string format in compliance with Name Convention for
                  // Managed Object.
                  // This may be a zero-length string. In this case, the MO
                  // is identified by the value of the MOI attribute
                  // of the Structured Event, i.e., the notification.
      NotifIdSet notif_id_set;  // Set of related notification ids
   };
   /*
   Correlated Notification sets are sets of Correlated Notification
   structures.
   */
   typedef sequence <CorrelatedNotification> CorrelatedNotificationSet;
   /*
   Define the structure of Alarm ID and Perceived Severity used within the
   alarm acknowledgment operation. Note: perceived_severity is an optional
   parameter. If this value is present, it must have one of the defined values
   of Interface PerceivedSeverity.
   */
   struct AlarmInformationIdAndSev
   {
      string alarm_id;
      ManagedGenericIRPConstDefs::ShortOpt perceived_severity;
   };
   /*
   Define set of the above structure of Alarm ID and Perceived Severity.
   */
   typedef sequence <AlarmInformationIdAndSev> AlarmInformationIdAndSevSeq;
   /*
   It indicates the reason for an alarm acknowledgement to have failed:
     - The specified Alarm Information is absent from the Alarm List
     - The Perceived Severity to be acknowledged has changed and/or is different
       within the Alarm List
     - The acknowledgement failed for some other reason
   */
   enum AcknowledgeFailureCategories
   {
      UNKNOWN_ALARM_ID,
      WRONG_PERCEIVED_SEVERITY,
      ACKNOWLEDGMENT_FAILED
   };
   /*
   Define the structure returned when an operation fails for a set of alarm ids.
   A reason is provided in order to indicate why the operation failed.
   */
   struct BadAlarmInformationId
   {
      string alarm_id;
      string reason;
   };
   /*
   Define the structure returned when the acknowledge operation fails for a set
   of alarm ids.
   A failure category and a reason are provided in order to indicate why the
   operation failed.
   */
   struct BadAcknowledgeAlarmInfo
   {
      string alarm_id;
      AcknowledgeFailureCategories failure_category;
      string reason;
   };
   typedef sequence <BadAlarmInformationId> BadAlarmInformationIdSeq;
   typedef sequence <BadAcknowledgeAlarmInfo> BadAcknowledgeAlarmInfoSeq;
   typedef sequence <string> AlarmInformationIdSeq;
   typedef CosNotification::EventBatch AlarmInformationSeq;
   /*
   Define the cause values of notifyPotentialFaultyAlarmList and
   notifyAlarmListRebuilt, which have been defined in 32111-2.
   */
   const string AGENT_NE_COMMUNICATION_ERROR = "Agent-NE communication error";
   const string AGENT_RESTARTS = "Agent restarts";
   const string INDETERMINATE = "Indeterminate";
};
#endif // _ALARM_IRP_CONST_DEFS_IDL_