tmf854.v1 > Alarm_T LOCATION: file:/xsd/networkResources/Notifications.xsd
SECTIONS: Basic | XML Instance | Attributes | XML | Reference Overview | TOC | No TOC | Help
tmf854.v1
The Alarm_T Complex Type
The structure of the Alarm notification.

Local elements (21)
  eventInfo isClearable aliasNameList layerRate probableCause nativeProbableCause additionalText perceivedSeverity affectedTPList serviceAffecting rcaiIndicator acknowledgeIndication X733_EventType X733_SpecificProblems X733_BackedUpStatus X733_BackUpObject X733_TrendIndication X733_CorrelatedNotifications X733_MonitoredAttributes X733_ProposedRepairActions vendorExtensions

Complex Type Alarm_T
The Alarm_T type does not allow mixed content. There is no restriction on type derivation.

XML Instance
<...> -Begin All [1...1] The set of event information attributes. <eventInfo>EventInformation_T</eventInfo> [1..1] Indicates if the event is clearable (or is itself a clear). <isClearable>xsd:boolean</isClearable> [1..1] Identifies all the object list of aliases to describe the network entity as portrayed on the OS user interface. <aliasNameList extVersion="xsd:string" extAuthor="xsd:string" tmf854Version="TMF854_Version_T">AliasNameList_T</aliasNameList> [0..1] The layer which this alarm is relevant to. <layerRate>LayerRate_T</layerRate> [1..1] No other string than the ones defined by the TM Forum should be used for this field. <probableCause overlap="xsd:string" qualifier="xsd:string">ProbableCause_T</probableCause> [1..1] Identifies the probableCause as portrayed on the OS user interface. <nativeProbableCause>xsd:string</nativeProbableCause> [0..1] More information about the alarm. such as, "Unit is mismounted". <additionalText>xsd:string</additionalText> [0..1] Indicates the severity of the alarm. <perceivedSeverity>PerceivedSeverity_T</perceivedSeverity> [1..1] A list of affected TPs. Contained CTPs are not listed. This field is optional for all alarms except for alarms on equipment. This is used to indicate a list of TPs affected by an equipment failure for example. If the alarm is an alarm on an equipment that supports PTPs, then the ports (PTPs) supported by this equipment will be listed in this field (irrespective of whether the alarm is Service Affecting or not). The list should be ordered by PTP names (ASCII order). <affectedTPList extVersion="xsd:string" extAuthor="xsd:string" tmf854Version="TMF854_Version_T">NamingAttributesList_T</affectedTPList> [0..1] Indicates whether the alarm has affected service <serviceAffecting>ServiceAffecting_T</serviceAffecting> [1..1] The RCAI indicator has two values, i.e., TRUE (meaning that the alarm is a Root Cause Alarm Indication) or FALSE (meaning the alarm is a raw alarm). <rcaiIndicator>xsd:boolean</rcaiIndicator> [1..1] The acknowledge indication state. <acknowledgeIndication>AcknowledgeIndication_T</acknowledgeIndication> [0..1] Classifies the alarm into one of the five basic categories specified in ITU-T X.733. Value is one of the following: "communicationsAlarm", "environmentalAlarm", "equipmentAlarm", "processingErrorAlarm", "qualityofServiceAlarm" This field is optional. <X733_EventType>xsd:string</X733_EventType> [0..1] Identifies further refinements to the Probable cause of the alarm. (Similar to ProbableCauseQualifier, but this parameter is designed to be human readable and compatible with ITU usage.) This field is optional. <X733_SpecificProblems>SpecificProblemList_T</X733_SpecificProblems> [0..1] Specifies whether or not the object emitting the alarm has been backed-up, and services provided to the user have, therefore, not been disrupted. Value is one of the following: "BACKED_UP", "NOT_BACKED_UP" This field is optional. <X733_BackedUpStatus>xsd:string</X733_BackedUpStatus> [0..1] Specifies the object that is providing back-up services for the object about which the notification pertains. This parameter shall be present when the X733::BackedupStatus parameter is present and has the value "BACKED_UP". This field is optional otherwise. <X733_BackUpObject extVersion="xsd:string" extAuthor="xsd:string" tmf854Version="TMF854_Version_T">NamingAttributes_T</X733_BackUpObject> [0..1] Specifies the current severity trend of the object. If present it indicates that there are one or more alarms ("outstanding alarms") which have not been cleared, and pertain to the same object as that to which this alarm ("current alarm") pertains. Value is one of the following: "MORE_SEVERE", "NO_CHANGE", "LESS_SEVERE" This field is optional. <X733_TrendIndication>xsd:string</X733_TrendIndication> [0..1] Contains a set of Notification identifiers and, if necessary, their associated object names. This set is defined to be the set of all notifications to which this notification is considered to be correlated. This field is optional. <X733_CorrelatedNotifications>CorrelatedNotificationList_T</X733_CorrelatedNotifications> [0..1] Defines one or more attributes of the managed object and their corresponding values at the time of the alarm. This field is optional. <X733_MonitoredAttributes>AnyList_T</X733_MonitoredAttributes> [0..1] Used if the cause is known and the system being managed can suggest one or more solutions (such as switch in standby equipment, retry, replace media). This field is optional. <X733_ProposedRepairActions>ProposedRepairActionList_T</X733_ProposedRepairActions> [0..1] The specific containment for vendor extensions of the Alarm notification object. <vendorExtensions extAuthor="xsd:string" extVersion="xsd:string" tmf854Version="TMF854_Version_T">AlarmExt_T</vendorExtensions> [0..1] End All </...>

﻿

Attributes |
﻿
Name | Type | Summary
--- | --- | ---
No Attributes
﻿
Name | Type | Summary
--- | --- | ---
No Attributes
﻿
Name | Type | Summary
--- | --- | ---
No Attributes
﻿
Name | Type | Summary
--- | --- | ---
extAuthor | string | This attribute is optional. Its form is unqualified. Show details.
Base type of extAuthor is string. There are several restrictions on the value. The schema processor preserves value's whitespace.
extVersion | string | This attribute is optional. Its form is unqualified. Show details.
Base type of extVersion is string. There are several restrictions on the value. The schema processor preserves value's whitespace.
tmf854Version | TMF854_Version_T | This attribute is optional. Its form is unqualified. Show details.
Base type of tmf854Version is string. There are several restrictions on the value. The schema processor preserves value's whitespace. The value must match "`1\.([0-9]|[A-Z]|[a-z])*`".
﻿
Name | Type | Summary
--- | --- | ---
No Attributes
﻿
Name | Type | Summary
--- | --- | ---
overlap | string | This attribute is optional. Its form is unqualified. Show details.
Base type of overlap is string. There are several restrictions on the value. The schema processor preserves value's whitespace.
qualifier | string | This attribute is optional. Its form is unqualified. Show details.
Base type of qualifier is string. There are several restrictions on the value. The schema processor preserves value's whitespace.
﻿
Name | Type | Summary
--- | --- | ---
No Attributes
﻿
Name | Type | Summary
--- | --- | ---
No Attributes
﻿
Name | Type | Summary
--- | --- | ---
No Attributes
﻿
Name | Type | Summary
--- | --- | ---
extAuthor | string | This attribute is optional. Its form is unqualified. Show details.
Base type of extAuthor is string. There are several restrictions on the value. The schema processor preserves value's whitespace.
extVersion | string | This attribute is optional. Its form is unqualified. Show details.
Base type of extVersion is string. There are several restrictions on the value. The schema processor preserves value's whitespace.
tmf854Version | TMF854_Version_T | This attribute is optional. Its form is unqualified. Show details.
Base type of tmf854Version is string. There are several restrictions on the value. The schema processor preserves value's whitespace. The value must match "`1\.([0-9]|[A-Z]|[a-z])*`".
﻿
Name | Type | Summary
--- | --- | ---
No Attributes
﻿
Name | Type | Summary
--- | --- | ---
No Attributes
﻿
Name | Type | Summary
--- | --- | ---
No Attributes
﻿
Name | Type | Summary
--- | --- | ---
No Attributes
﻿
Name | Type | Summary
--- | --- | ---
No Attributes
﻿
Name | Type | Summary
--- | --- | ---
No Attributes
﻿
Name | Type | Summary
--- | --- | ---
extAuthor | string | This attribute is optional. Its form is unqualified. Show details.
Base type of extAuthor is string. There are several restrictions on the value. The schema processor preserves value's whitespace.
extVersion | string | This attribute is optional. Its form is unqualified. Show details.
Base type of extVersion is string. There are several restrictions on the value. The schema processor preserves value's whitespace.
tmf854Version | TMF854_Version_T | This attribute is optional. Its form is unqualified. Show details.
Base type of tmf854Version is string. There are several restrictions on the value. The schema processor preserves value's whitespace. The value must match "`1\.([0-9]|[A-Z]|[a-z])*`".
﻿
Name | Type | Summary
--- | --- | ---
No Attributes
﻿
Name | Type | Summary
--- | --- | ---
No Attributes
﻿
Name | Type | Summary
--- | --- | ---
No Attributes
﻿
Name | Type | Summary
--- | --- | ---
No Attributes
﻿
Name | Type | Summary
--- | --- | ---
extAuthor | string | This attribute is optional. Its form is unqualified. Show details.
Base type of extAuthor is string. There are several restrictions on the value. The schema processor preserves value's whitespace.
extVersion | string | This attribute is optional. Its form is unqualified. Show details.
Base type of extVersion is string. There are several restrictions on the value. The schema processor preserves value's whitespace.
tmf854Version | TMF854_Version_T | This attribute is optional. Its form is unqualified. Show details.
Base type of tmf854Version is string. There are several restrictions on the value. The schema processor preserves value's whitespace. The value must match "`1\.([0-9]|[A-Z]|[a-z])*`".

﻿

XML
-<xsd:complexType name="Alarm_T"> -<xsd:annotation> <xsd:documentation> The structure of the Alarm notification. </xsd:documentation> </xsd:annotation> -<xsd:all> -<xsd:element name="eventInfo" type="EventInformation_T"> -<xsd:annotation> <xsd:documentation> The set of event information attributes. </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element name="isClearable" type="xsd:boolean"> -<xsd:annotation> <xsd:documentation> Indicates if the event is clearable (or is itself a clear). </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element minOccurs="0" name="aliasNameList" type="AliasNameList_T"> -<xsd:annotation> <xsd:documentation> Identifies all the object list of aliases to describe the network entity as portrayed on the OS user interface. </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element name="layerRate" type="LayerRate_T"> -<xsd:annotation> <xsd:documentation> The layer which this alarm is relevant to. </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element name="probableCause" type="ProbableCause_T"> -<xsd:annotation> <xsd:documentation> No other string than the ones defined by the TM Forum should be used for this field. </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element minOccurs="0" name="nativeProbableCause" type="xsd:string"> -<xsd:annotation> <xsd:documentation> Identifies the probableCause as portrayed on the OS user interface. </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element minOccurs="0" name="additionalText" type="xsd:string"> -<xsd:annotation> <xsd:documentation> More information about the alarm. such as, "Unit is mismounted". </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element name="perceivedSeverity" type="PerceivedSeverity_T"> -<xsd:annotation> <xsd:documentation> Indicates the severity of the alarm. </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element minOccurs="0" name="affectedTPList" type="NamingAttributesList_T"> -<xsd:annotation> <xsd:documentation> A list of affected TPs. Contained CTPs are not listed. This field is optional for all alarms except for alarms on equipment. This is used to indicate a list of TPs affected by an equipment failure for example. If the alarm is an alarm on an equipment that supports PTPs, then the ports (PTPs) supported by this equipment will be listed in this field (irrespective of whether the alarm is Service Affecting or not). The list should be ordered by PTP names (ASCII order). </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element name="serviceAffecting" type="ServiceAffecting_T"> -<xsd:annotation> <xsd:documentation> Indicates whether the alarm has affected service </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element name="rcaiIndicator" type="xsd:boolean"> -<xsd:annotation> <xsd:documentation> The RCAI indicator has two values, i.e., TRUE (meaning that the alarm is a Root Cause Alarm Indication) or FALSE (meaning the alarm is a raw alarm). </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element minOccurs="0" name="acknowledgeIndication" type="AcknowledgeIndication_T"> -<xsd:annotation> <xsd:documentation> The acknowledge indication state. </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element minOccurs="0" name="X733_EventType" type="xsd:string"> -<xsd:annotation> <xsd:documentation> Classifies the alarm into one of the five basic categories specified in ITU-T X.733. Value is one of the following: "communicationsAlarm", "environmentalAlarm", "equipmentAlarm", "processingErrorAlarm", "qualityofServiceAlarm" This field is optional. </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element minOccurs="0" name="X733_SpecificProblems" type="SpecificProblemList_T"> -<xsd:annotation> <xsd:documentation> Identifies further refinements to the Probable cause of the alarm. (Similar to ProbableCauseQualifier, but this parameter is designed to be human readable and compatible with ITU usage.) This field is optional. </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element minOccurs="0" name="X733_BackedUpStatus" type="xsd:string"> -<xsd:annotation> <xsd:documentation> Specifies whether or not the object emitting the alarm has been backed-up, and services provided to the user have, therefore, not been disrupted. Value is one of the following: "BACKED_UP", "NOT_BACKED_UP" This field is optional. </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element minOccurs="0" name="X733_BackUpObject" type="NamingAttributes_T"> -<xsd:annotation> <xsd:documentation> Specifies the object that is providing back-up services for the object about which the notification pertains. This parameter shall be present when the X733::BackedupStatus parameter is present and has the value "BACKED_UP". This field is optional otherwise. </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element minOccurs="0" name="X733_TrendIndication" type="xsd:string"> -<xsd:annotation> <xsd:documentation> Specifies the current severity trend of the object. If present it indicates that there are one or more alarms ("outstanding alarms") which have not been cleared, and pertain to the same object as that to which this alarm ("current alarm") pertains. Value is one of the following: "MORE_SEVERE", "NO_CHANGE", "LESS_SEVERE" This field is optional. </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element minOccurs="0" name="X733_CorrelatedNotifications" type="CorrelatedNotificationList_T"> -<xsd:annotation> <xsd:documentation> Contains a set of Notification identifiers and, if necessary, their associated object names. This set is defined to be the set of all notifications to which this notification is considered to be correlated. This field is optional. </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element minOccurs="0" name="X733_MonitoredAttributes" type="AnyList_T"> -<xsd:annotation> <xsd:documentation> Defines one or more attributes of the managed object and their corresponding values at the time of the alarm. This field is optional. </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element minOccurs="0" name="X733_ProposedRepairActions" type="ProposedRepairActionList_T"> -<xsd:annotation> <xsd:documentation> Used if the cause is known and the system being managed can suggest one or more solutions (such as switch in standby equipment, retry, replace media). This field is optional. </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element minOccurs="0" name="vendorExtensions" type="AlarmExt_T"> -<xsd:annotation> <xsd:documentation> The specific containment for vendor extensions of the Alarm notification object. </xsd:documentation> </xsd:annotation> </xsd:element> </xsd:all> </xsd:complexType>

﻿

Uses
Type (16) AcknowledgeIndication_T AlarmExt_T AliasNameList_T AnyList_T boolean CorrelatedNotificationList_T EventInformation_T LayerRate_T NamingAttributes_T NamingAttributesList_T PerceivedSeverity_T ProbableCause_T ProposedRepairActionList_T ServiceAffecting_T SpecificProblemList_T string

Used-By
Element (4) EventGroup_T/Alarm getActiveAlarmsResponse_T/activeAlarmList/activeAlarm getAllActiveAlarmsResponse_T/activeAlarmList/activeAlarm getAllUnacknowledgedActiveAlarmsResponse_T/activeAlarmList/activeAlarm

Generated by WSDLdoc ©