1 karl  1.1.2.2 // Copyright (c) 2009 DMTF.  All rights reserved.
  2                  [Indication, Abstract, Version ( "2.24.0" ), 
  3                   UMLPackagePath ( "CIM::Event" ), 
  4                   Description ( 
  5                      "CIM_Indication is the abstract root class for all "
  6                      "notifications about changes in schema, objects and their data, "
  7                      "and about events detected by providers and instrumentation. "
  8                      "Subclasses represent specific types of notifications. \n"
  9                      "\n"
 10                      "To receive an Indication, a consumer (or subscriber) must "
 11                      "create an instance of CIM_IndicationFilter describing the "
 12                      "criteria of the notification, an instance of "
 13                      "CIM_ListenerDestination describing the delivery of the "
 14                      "notification, and an instance of CIM_IndicationSubscription "
 15                      "associating the Filter and Handler." )]
 16               class CIM_Indication {
 17               
 18                     [Description ( 
 19                         "An identifier for the Indication. This property is "
 20                         "similar to a key value in that it can be used for "
 21                         "identification, when correlating Indications (see the "
 22 karl  1.1.2.2           "CorrelatedIndications array). Its value SHOULD be unique "
 23                         "as long as correlations are reported, but MAY be reused "
 24                         "or left NULL if no future Indications will reference it "
 25                         "in their CorrelatedIndications array.To ensure "
 26                         "uniqueness, the value of IndicationIdentifier should be "
 27                         "constructed using the following \"preferred\" algorithm: \n"
 28                         "<OrgID>:<LocalID> \n"
 29                         "Where <OrgID> and <LocalID> are separated by a colon "
 30                         "(:), and where <OrgID> must include a copyrighted, "
 31                         "trademarked, or otherwise unique name that is owned by "
 32                         "the business entity that is creating or defining the "
 33                         "IndicationIdentifier or that is a recognized ID that is "
 34                         "assigned to the business entity by a recognized global "
 35                         "authority. (This requirement is similar to the <Schema "
 36                         "Name>_<Class Name> structure of Schema class names.) In "
 37                         "addition, to ensure uniqueness <OrgID> must not contain "
 38                         "a colon (:). When using this algorithm, the first colon "
 39                         "to appear in IndicationIdentifier must appear between "
 40                         "<OrgID> and <LocalID>. \n"
 41                         "<LocalID> is chosen by the business entity and should "
 42                         "not be re-used to identify different underlying "
 43 karl  1.1.2.2           "(real-world) elements. \n"
 44                         "If the above \"preferred\" algorithm is not used, the "
 45                         "defining entity should assure that the resulting "
 46                         "IndicationIdentifier is not re-used across any "
 47                         "IndicationIdentifiers that are produced by this or other "
 48                         "providers for the NameSpace of this instance. \n"
 49                         "For DMTF-defined instances, the \"preferred\" algorithm "
 50                         "should be used with the <OrgID> set to CIM." ), 
 51                      MappingStrings { 
 52                         "Recommendation.ITU|X733.Notification identifier" }]
 53                  string IndicationIdentifier;
 54               
 55                     [Description ( 
 56                         "A list of IndicationIdentifiers whose notifications are "
 57                         "correlated with (related to) this one." ), 
 58                      MappingStrings { 
 59                         "Recommendation.ITU|X733.Correlated notifications" }, 
 60                      ModelCorrespondence { "CIM_Indication.IndicationIdentifier" }]
 61                  string CorrelatedIndications[];
 62               
 63                     [Description ( 
 64 karl  1.1.2.2           "The time and date of creation of the Indication. The "
 65                         "property may be set to NULL if the entity creating the "
 66                         "Indication is not capable of determining this "
 67                         "information. Note that IndicationTime may be the same "
 68                         "for two Indications that are generated in rapid "
 69                         "succession." )]
 70                  datetime IndicationTime;
 71               
 72                     [Description ( 
 73                         "An enumerated value that describes the severity of the "
 74                         "Indication from the notifier\'s point of view: \n"
 75                         "1 - Other, by CIM convention, is used to indicate that "
 76                         "the Severity\'s value can be found in the OtherSeverity "
 77                         "property. \n"
 78                         "3 - Degraded/Warning should be used when its appropriate "
 79                         "to let the user decide if action is needed. \n"
 80                         "4 - Minor should be used to indicate action is needed, "
 81                         "but the situation is not serious at this time. \n"
 82                         "5 - Major should be used to indicate action is needed "
 83                         "NOW. \n"
 84                         "6 - Critical should be used to indicate action is needed "
 85 karl  1.1.2.2           "NOW and the scope is broad (perhaps an imminent outage "
 86                         "to a critical resource will result). \n"
 87                         "7 - Fatal/NonRecoverable should be used to indicate an "
 88                         "error occurred, but it\'s too late to take remedial "
 89                         "action. \n"
 90                         "2 and 0 - Information and Unknown (respectively) follow "
 91                         "common usage. Literally, the Indication is purely "
 92                         "informational or its severity is simply unknown." ), 
 93                      ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", ".." }, 
 94                      Values { "Unknown", "Other", "Information", 
 95                         "Degraded/Warning", "Minor", "Major", "Critical", 
 96                         "Fatal/NonRecoverable", "DMTF Reserved" }, 
 97                      MappingStrings { "Recommendation.ITU|X733.Perceived severity" }]
 98                  uint16 PerceivedSeverity;
 99               
100                     [Description ( 
101                         "Holds the value of the user defined severity value when "
102                         "\'PerceivedSeverity\' is 1 (\"Other\")." ), 
103                      ModelCorrespondence { "CIM_AlertIndication.PerceivedSeverity" }]
104                  string OtherSeverity;
105               
106 karl  1.1.2.2       [Description ( 
107                         "An identifier for the indication filter that selects "
108                         "this indication and causes it to be sent. This property "
109                         "is to be filled out by the indication sending service. "
110                         "The value shall be correlatable with the Name property "
111                         "of the instance of CIM_IndicationFilter describing the "
112                         "criteria of the indication. The value of the "
113                         "IndicationFilterName should be formatted using the "
114                         "following algorithm: < OrgID > : < LocalID >, where < "
115                         "OrgID > and < LocalID > are separated by a colon (:) and "
116                         "< OrgID > shall include a copyrighted, trademarked, or "
117                         "otherwise unique name that is owned by the business "
118                         "entity that is creating or defining the value or that is "
119                         "a registered ID assigned to the business entity by a "
120                         "recognized global authority. In addition, to ensure "
121                         "uniqueness, < OrgID > shall not contain a colon (:).When "
122                         "using this algorithm, the first colon to appear in the "
123                         "value shall appear between < OrgID > and < LocalID >. < "
124                         "LocalID > is chosen by the business entity and shall be "
125                         "used uniquely." ), 
126                      ModelCorrespondence { "CIM_IndicationFilter.Name" }]
127 karl  1.1.2.2    string IndicationFilterName;
128               
129                     [Description ( 
130                         "The sequence context portion of a sequence identifier "
131                         "for the indication. The sequence number portion of the "
132                         "sequence identifier is provided by the SequenceNumber "
133                         "property. The combination of both property values "
134                         "represents the sequence identifier for the indication.\n"
135                         "The sequence identifier for the indication enables a CIM "
136                         "listener to identify duplicate indications when the CIM "
137                         "service attempts the delivery retry of indications, to "
138                         "reorder indications that arrive out-of-order, and to "
139                         "detect lost indications.\n"
140                         "If a CIM service does not support sequence identifiers "
141                         "for indications, this property shall be NULL.\n"
142                         "If a CIM service supports sequence identifiers for "
143                         "indications, this property shall be maintained by the "
144                         "CIM service for each registered listener destination, "
145                         "and its value shall uniquely identify the CIM service "
146                         "and the indication service within the CIM service such "
147                         "that restarts of the CIM service and deregistration of "
148 karl  1.1.2.2           "listener destinations to the CIM service cause the value "
149                         "to change, without reusing earlier values for a "
150                         "sufficiently long time.\n"
151                         "When retrying the delivery of an indication, this "
152                         "property shall have the same value as in the original delivery.\n"
153                         "To guarantee this uniqueness, the property value should "
154                         "be constructed using the following format (defined in "
155                         "ABNF): sequence-context = indication-service-name \"#\" "
156                         "cim-service-start-id \"#\" listener-destination-creation-time\n"
157                         "Where: indication-service-name is the value of the Name "
158                         "property of the CIM_IndicationService instance "
159                         "responsible for delivering the indication. "
160                         "cim-service-start-id is an identifier that uniquely "
161                         "identifies the CIM service start, for example via a "
162                         "timestamp of the start time, or via a counter that "
163                         "increases for each start or restart. "
164                         "listener-destination-creation-time is a timestamp of the "
165                         "creation time of the CIM_ListenerDestination instance "
166                         "representing the listener destination.\n"
167                         "Since this format is only a recommendation, CIM clients "
168                         "shall treat the value as an opaque identifier for the "
169 karl  1.1.2.2           "sequence context and shall not rely on this format." ), 
170                      ModelCorrespondence { "CIM_Indication.SequenceNumber" }]
171                  string SequenceContext;
172               
173                     [Description ( 
174                         "The sequence number portion of a sequence identifier for "
175                         "the indication. The sequence context portion of the "
176                         "sequence identifier is provided by the SequenceContext "
177                         "property. The combination of both property values "
178                         "represents the sequence identifier for the indication.\n"
179                         "The sequence identifier for the indication enables a CIM "
180                         "listener to identify duplicate indications when the CIM "
181                         "service attempts the delivery retry of indications, to "
182                         "reorder indications that arrive out-of-order, and to "
183                         "detect lost indications.\n"
184                         "If a CIM service does not support sequence identifiers "
185                         "for indications, this property shall be NULL.\n"
186                         "If a CIM service supports sequence identifiers for "
187                         "indications, this property shall be maintained by the "
188                         "CIM service for each registered listener destination, "
189                         "and its value shall uniquely identify the indication "
190 karl  1.1.2.2           "within the sequence context provided by SequenceContext. "
191                         "It shall start at 0 whenever the sequence context string "
192                         "changes. Otherwise, it shall be increased by 1 for every "
193                         "new indication to that listener destination, and it "
194                         "shall wrap to 0 when the value range is exceeded.\n"
195                         "When retrying the delivery of an indication, this "
196                         "property shall have the same value as in the original "
197                         "delivery." ), 
198                      ModelCorrespondence { "CIM_Indication.SequenceContext" }]
199                  sint64 SequenceNumber;
200               
201               
202               };