1 martin 1.15 //%LICENSE////////////////////////////////////////////////////////////////

  2 martin 1.16 //

  3 martin 1.15 // Licensed to The Open Group (TOG) under one or more contributor license
  4             // agreements.  Refer to the OpenPegasusNOTICE.txt file distributed with
  5             // this work for additional information regarding copyright ownership.
  6             // Each contributor licenses this file to you under the OpenPegasus Open
  7             // Source License; you may not use this file except in compliance with the
  8             // License.

  9 martin 1.16 //

 10 martin 1.15 // Permission is hereby granted, free of charge, to any person obtaining a
 11             // copy of this software and associated documentation files (the "Software"),
 12             // to deal in the Software without restriction, including without limitation
 13             // the rights to use, copy, modify, merge, publish, distribute, sublicense,
 14             // and/or sell copies of the Software, and to permit persons to whom the
 15             // Software is furnished to do so, subject to the following conditions:

 16 martin 1.16 //

 17 martin 1.15 // The above copyright notice and this permission notice shall be included
 18             // in all copies or substantial portions of the Software.

 19 martin 1.16 //

 20 martin 1.15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS

 21 martin 1.16 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

 22 martin 1.15 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 23             // IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 24             // CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 25             // TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 26             // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

 27 martin 1.16 //

 28 martin 1.15 //////////////////////////////////////////////////////////////////////////

 29 kumpf  1.1  //
 30             //
 31             //%/////////////////////////////////////////////////////////////////////////////
 32             
 33             #ifndef Pegasus_IndicationConstants_h
 34             #define Pegasus_IndicationConstants_h
 35             
 36             #include <Pegasus/Common/Config.h>
 37             #include <Pegasus/Common/CIMName.h>

 38 venkat.puvvada 1.14 #include <Pegasus/Server/Linkage.h>

 39 kumpf          1.1  
 40                     PEGASUS_NAMESPACE_BEGIN
 41                     
 42                     /**

 43 kumpf          1.13     Values for the Repeat Notification Policy property of the Subscription

 44 kumpf          1.1      class, as defined in the CIM Events MOF
 45                      */
 46                     enum RepeatNotificationPolicy {_POLICY_UNKNOWN = 0, _POLICY_OTHER = 1,
 47                          _POLICY_NONE = 2, _POLICY_SUPPRESS = 3, _POLICY_DELAY = 4};
 48                     
 49                     /**

 50 kumpf          1.13     Values for the On Fatal Error Policy property of the Subscription

 51 kumpf          1.1      class, as defined in the CIM Events MOF
 52                      */

 53 kumpf          1.13 enum OnFatalErrorPolicy {_ERRORPOLICY_OTHER = 1, _ERRORPOLICY_IGNORE = 2,

 54 kumpf          1.1      _ERRORPOLICY_DISABLE = 3, _ERRORPOLICY_REMOVE = 4};
 55                     
 56                     /**

 57 kumpf          1.13     Values for the Probable Cause property of the Alert Indication

 58 kumpf          1.1      class, as defined in the CIM Events MOF
 59                         Note: not all possible values have been included
 60                      */
 61                     enum ProbableCause {_CAUSE_UNKNOWN = 0, _CAUSE_OTHER = 1};
 62                     
 63                     /**

 64 kumpf          1.13     Values for the Alert Type property of the Alert Indication class,

 65 kumpf          1.1      as defined in the CIM Events MOF
 66                      */
 67                     enum AlertType {_TYPE_OTHER = 1, _TYPE_COMMUNICATIONS = 2, _TYPE_QOS = 3,
 68                          _TYPE_PROCESSING = 4, _TYPE_DEVICE = 5, _TYPE_ENVIRONMENTAL = 6,
 69                          _TYPE_MODELCHANGE = 7, _TYPE_SECURITY = 8};
 70                     

 71 yi.zhou        1.8  

 72 kumpf          1.1  //
 73                     //  Class names
 74                     //
 75                     
 76                     /**
 77                         The name of the CIMOM Shutdown alert indication class
 78                      */
 79                     //
 80                     //  ATTN: Update once CimomShutdownAlertIndication has been defined
 81                     //

 82 kumpf          1.13 extern const CIMName _CLASS_CIMOM_SHUTDOWN_ALERT;

 83 kumpf          1.1  
 84                     /**
 85                         The name of the No Provider alert indication class
 86                      */
 87                     //
 88                     //  ATTN: Update once NoProviderAlertIndication has been defined
 89                     //

 90 kumpf          1.13 extern const CIMName _CLASS_NO_PROVIDER_ALERT;

 91 kumpf          1.1  
 92                     /**
 93                         The name of the CIMOM shutdown alert indication class
 94                      */
 95                     //
 96                     //  ATTN: Update once ProviderTerminatedAlertIndication has been defined
 97                     //

 98 kumpf          1.13 extern const CIMName _CLASS_PROVIDER_TERMINATED_ALERT;

 99 kumpf          1.1  
100                     
101                     //
102                     //  Property names
103                     //
104                     
105                     /**

106 kumpf          1.13     The name of the Other Subscription State property for Indication

107 kumpf          1.1      Subscription class
108                      */

109 kumpf          1.13 extern const CIMName _PROPERTY_OTHERSTATE;

110 kumpf          1.1  
111                     /**

112 kumpf          1.2      The name of the Repeat Notification Policy property for indication

113 kumpf          1.1      subscription class
114                      */

115 kumpf          1.13 extern const CIMName _PROPERTY_REPEATNOTIFICATIONPOLICY;

116 kumpf          1.1  
117                     /**

118 kumpf          1.2      The name of the Other Repeat Notification Policy property for

119 kumpf          1.1      indication subscription class
120                      */

121 kumpf          1.13 extern const CIMName _PROPERTY_OTHERREPEATNOTIFICATIONPOLICY;

122 kumpf          1.1  
123                     /**

124 kumpf          1.13     The name of the On Fatal Error Policy property for Indication Subscription

125 kumpf          1.1      class
126                      */

127 kumpf          1.13 extern const CIMName _PROPERTY_ONFATALERRORPOLICY;

128 kumpf          1.1  
129                     /**

130 kumpf          1.13     The name of the Other On Fatal Error Policy property for Indication

131 kumpf          1.1      Subscription class
132                      */

133 kumpf          1.13 extern const CIMName _PROPERTY_OTHERONFATALERRORPOLICY;

134 kumpf          1.1  
135                     /**

136 kumpf          1.13     The name of the Failure Trigger Time Interval property for Indication

137 kumpf          1.2      Subscription class
138                      */

139 kumpf          1.13 extern const CIMName _PROPERTY_FAILURETRIGGERTIMEINTERVAL;

140 kumpf          1.2  
141                     /**

142 kumpf          1.13     The name of the Time Of Last State Change property for Indication

143 kumpf          1.1      Subscription class
144                      */

145 kumpf          1.13 extern const CIMName _PROPERTY_LASTCHANGE;

146 kumpf          1.1  
147                     /**

148 kumpf          1.13     The name of the Subscription Start Time property for Indication

149 kumpf          1.1      Subscription class
150                      */

151 kumpf          1.13 extern const CIMName _PROPERTY_STARTTIME;

152 kumpf          1.1  
153                     /**

154 kumpf          1.13     The name of the Subscription Duration property for Indication

155 kumpf          1.1      Subscription class
156                      */

157 kumpf          1.13 extern const CIMName _PROPERTY_DURATION;

158 kumpf          1.1  
159                     /**

160 kumpf          1.13     The name of the Subscription Time Remaining property for Indication

161 kumpf          1.1      Subscription class
162                      */

163 kumpf          1.13 extern const CIMName _PROPERTY_TIMEREMAINING;

164 kumpf          1.1  
165                     /**

166 kumpf          1.2      The name of the Repeat Notification Interval property for indication
167                         subscription class
168                      */

169 kumpf          1.13 extern const CIMName _PROPERTY_REPEATNOTIFICATIONINTERVAL;

170 kumpf          1.2  
171                     /**
172                         The name of the Repeat Notification Gap property for indication
173                         subscription class
174                      */

175 kumpf          1.13 extern const CIMName _PROPERTY_REPEATNOTIFICATIONGAP;

176 kumpf          1.2  
177                     /**
178                         The name of the Repeat Notification Count property for indication
179                         subscription class
180                      */

181 kumpf          1.13 extern const CIMName _PROPERTY_REPEATNOTIFICATIONCOUNT;

182 kumpf          1.2  
183                     /**

184 carolann.graves 1.7      The name of the TextFormatOwningEntity property for Formatted Indication
185                          Subscription class
186                      */

187 kumpf           1.13 extern const CIMName _PROPERTY_TEXTFORMATOWNINGENTITY;

188 carolann.graves 1.7  
189                      /**
190                          The name of the TextFormatID property for Formatted Indication
191                          Subscription class
192                      */

193 kumpf           1.13 extern const CIMName _PROPERTY_TEXTFORMATID;

194 carolann.graves 1.7  
195                      /**
196                          The name of the Caption property for Managed Element class
197                       */

198 kumpf           1.13 extern const CIMName _PROPERTY_CAPTION;

199 carolann.graves 1.7  
200                      /**
201                          The name of the Description property for Managed Element class
202                       */

203 kumpf           1.13 extern const CIMName _PROPERTY_DESCRIPTION;

204 carolann.graves 1.7  
205                      /**
206                          The name of the ElementName property for Managed Element class
207                       */

208 kumpf           1.13 extern const CIMName _PROPERTY_ELEMENTNAME;

209 carolann.graves 1.7  
210                      /**

211 kumpf           1.1      The name of the Source Namespace property for indication filter class
212                       */

213 kumpf           1.13 extern const CIMName _PROPERTY_SOURCENAMESPACE;

214 kumpf           1.1  
215                      /**

216 kumpf           1.13     The name of the System Name property for indication filter and indications

217 kumpf           1.1      handler classes
218                       */

219 kumpf           1.13 extern const CIMName _PROPERTY_SYSTEMNAME;

220 kumpf           1.1  
221                      /**

222 kumpf           1.13     The name of the System Creation Class Name property for indication filter

223 kumpf           1.1      and indications handler classes
224                       */

225 kumpf           1.13 extern const CIMName _PROPERTY_SYSTEMCREATIONCLASSNAME;

226 kumpf           1.1  
227                      /**

228 kumpf           1.13     The name of the Other Persistence Type property for Indication Handler

229 kumpf           1.1      class
230                       */

231 kumpf           1.13 extern const CIMName _PROPERTY_OTHERPERSISTENCETYPE;

232 kumpf           1.1  
233                      /**

234 kumpf           1.2      The name of the Owner property for Indication Handler class
235                       */

236 kumpf           1.13 extern const CIMName _PROPERTY_OWNER;

237 kumpf           1.2  
238                      /**

239 kumpf           1.13     The name of the TargetHostFormat property for SNMP Mapper Indication

240 kumpf           1.2      Handler subclass

241 kumpf           1.1   */

242 kumpf           1.13 extern const CIMName _PROPERTY_TARGETHOSTFORMAT;

243 kumpf           1.1  
244                      /**

245 kumpf           1.13     The name of the OtherTargetHostFormat property for SNMP Mapper Indication

246 carolann.graves 1.7      Handler subclass
247                       */

248 kumpf           1.13 extern const CIMName _PROPERTY_OTHERTARGETHOSTFORMAT;

249 carolann.graves 1.7  
250                      /**

251 kumpf           1.13     The name of the Port Number property for SNMP Mapper Indication Handler

252 kumpf           1.2      subclass
253                       */

254 kumpf           1.13 extern const CIMName _PROPERTY_PORTNUMBER;

255 kumpf           1.2  
256                      /**

257 kumpf           1.13     The name of the SNMP Security Name property for SNMP Mapper Indication

258 kumpf           1.2      Handler subclass
259                       */

260 kumpf           1.13 extern const CIMName _PROPERTY_SNMPSECURITYNAME;

261 kumpf           1.2  
262                      /**

263 kumpf           1.13     The name of the SNMP Engine ID property for SNMP Mapper Indication Handler

264 kumpf           1.2      subclass
265                       */

266 kumpf           1.13 extern const CIMName _PROPERTY_SNMPENGINEID;

267 kumpf           1.1  
268                      /**

269 sahana.prabhakar 1.21     The SNMP Security Level for SNMP Mapper Indication Handle subclass.
270                       */
271                       extern const CIMName _PROPERTY_SNMPSECURITYLEVEL;
272                       
273                       /**
274                           The SNMP Security Authentication protocol for SNMP Mapper Indication Handle 
275                           subclass
276                        */
277                       extern const CIMName _PROPERTY_SNMPSECURITYAUTHPROTOCOL;
278                       
279                       /**
280                           The SNMP Security Authentication key for SNMP Mapper Indication Handle
281                           subclass
282                        */
283                       extern const CIMName _PROPERTY_SNMPSECURITYAUTHKEY;
284                       
285                       /**
286                           The SNMP Security privacy protocol for SNMP Mapper Indication Handle
287                           subclass
288                        */
289                       extern const CIMName _PROPERTY_SNMPSECURITYPRIVPROTO;
290 sahana.prabhakar 1.21 
291                       /**
292                           The SNMP Security privacy key for SNMP Mapper Indication Handle
293                           subclass
294                        */
295                       extern const CIMName _PROPERTY_SNMPSECURITYPRIVKEY;
296                       
297                       /**

298 kumpf            1.1      The name of the Alert Type property for Alert Indication class
299                        */

300 kumpf            1.13 extern const CIMName _PROPERTY_ALERTTYPE;

301 kumpf            1.1  
302                       /**
303                           The name of the Other Alert Type property for Alert Indication class
304                        */

305 kumpf            1.13 extern const CIMName _PROPERTY_OTHERALERTTYPE;

306 kumpf            1.1  
307                       /**
308                           The name of the Perceived Severity property for Alert Indication class
309                        */

310 kumpf            1.13 extern const CIMName _PROPERTY_PERCEIVEDSEVERITY;

311 kumpf            1.1  
312                       /**
313                           The name of the Probable Cause property for Alert Indication class
314                        */

315 kumpf            1.13 extern const CIMName _PROPERTY_PROBABLECAUSE;

316 kumpf            1.1  

317 venkat.puvvada   1.14 /**
318                           The name of the CreationClassName property of CIM_Service class.
319                       */
320                       extern const CIMName _PROPERTY_CREATIONCLASSNAME;
321                       
322                       /**
323                           The name of the Name property of CIM_Service class.
324                       */
325                       extern const CIMName _PROPERTY_NAME;
326                       
327                       /**
328                           The name of the ElementName property of CIM_MangedElement class.
329                       */
330                       extern const CIMName _PROPERTY_ELEMENTNAME;
331                       
332                       /**
333                           The name of the Started property of CIM_Service class.
334                       */
335                       extern const CIMName _PROPERTY_STARTED;
336                       
337                       /**
338 venkat.puvvada   1.14     The name of the InstanceID property of CIM_Capabilities
339                           class.
340                       */
341                       extern const CIMName _PROPERTY_INSTANCEID;
342                       
343                       #ifdef PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT
344                       /**
345                           The name of the FilterCreationEnabled property of IndicationService class.
346                       */
347                       PEGASUS_SERVER_LINKAGE extern const CIMName _PROPERTY_FILTERCREATIONENABLED;
348                       
349                       /**
350                           The name of the SubscriptionRemovalAction property of IndicationService
351                           class.
352                       */
353                       PEGASUS_SERVER_LINKAGE extern const CIMName _PROPERTY_SUBSCRIPTIONREMOVALACTION;
354                       
355                       /**
356                           The name of the SubscriptionRemovalTimeInterval property of
357                           IndicationService class.
358                       */

359 kumpf            1.17 PEGASUS_SERVER_LINKAGE extern const

360 venkat.puvvada   1.14     CIMName _PROPERTY_SUBSCRIPTIONREMOVALTIMEINTERVAL;
361                       
362                       /**
363                           The name of the DeliveryRetryAttempts property of
364                           IndicationService class.
365                       */
366                       PEGASUS_SERVER_LINKAGE extern const CIMName _PROPERTY_DELIVERYRETRYATTEMPTS;
367                       
368                       /**
369                           The name of the DeliveryRetryInterval property of
370                           IndicationService class.
371                       */
372                       PEGASUS_SERVER_LINKAGE extern const CIMName _PROPERTY_DELIVERYRETRYINTERVAL;
373                       
374                       /**
375                           The name of the FilterCreationEnabledIsSettable property of
376                           IndicationServiceCapabilities class.
377                       */

378 kumpf            1.17 PEGASUS_SERVER_LINKAGE extern const CIMName

379 venkat.puvvada   1.14     _PROPERTY_FILTERCREATIONENABLEDISSETTABLE;
380                       
381                       /**
382                           The name of the DeliveryRetryAttemptsIsSettable property of
383                           IndicationServiceCapabilities class.
384                       */

385 kumpf            1.17 PEGASUS_SERVER_LINKAGE extern const CIMName

386 venkat.puvvada   1.14     _PROPERTY_DELIVERYRETRYATTEMPTSISSETTABLE;
387                       
388                       /**
389                           The name of the DeliveryRetryIntervalIsSettable property of
390                           IndicationServiceCapabilities class.
391                       */

392 kumpf            1.17 PEGASUS_SERVER_LINKAGE extern const CIMName

393 venkat.puvvada   1.14     _PROPERTY_DELIVERYRETRYINTERVALISSETTABLE;
394                       
395                       /**
396                           The name of the SubscriptionRemovalActionIsSettable property of
397                           IndicationServiceCapabilities class.
398                       */

399 kumpf            1.17 PEGASUS_SERVER_LINKAGE extern const CIMName

400 venkat.puvvada   1.14     _PROPERTY_SUBSCRIPTIONREMOVALACTIONISSETTABLE;
401                       
402                       /**
403                           The name of the SubscriptionRemovalTimeIntervalIsSettable property of
404                           IndicationServiceCapabilities class.
405                       */

406 kumpf            1.17 PEGASUS_SERVER_LINKAGE extern const CIMName

407 venkat.puvvada   1.14     _PROPERTY_SUBSCRIPTIONREMOVALTIMEINTERVALISSETTABLE;
408                       
409                       /**
410                           The name of the MaxListenerDestinations property of
411                           IndicationServiceCapabilities class.
412                       */

413 kumpf            1.17 PEGASUS_SERVER_LINKAGE extern const CIMName

414 venkat.puvvada   1.14     _PROPERTY_MAXLISTENERDESTINATIONS;
415                       
416                       /**
417                           The name of the MaxActiveSubscriptions property of
418                           IndicationServiceCapabilities class.
419                       */
420                       PEGASUS_SERVER_LINKAGE extern const CIMName _PROPERTY_MAXACTIVESUBSCRIPTIONS;
421                       
422                       /**
423                           The name of the SubscriptionsPersisted property of
424                           IndicationServiceCapabilities class.
425                       */
426                       PEGASUS_SERVER_LINKAGE extern const CIMName _PROPERTY_SUBSCRIPTIONSPERSISTED;
427                       
428                       /**
429                           CIM_IndicationService instance default values.
430                       */
431                       
432                       const Boolean _PROPERTY_FILTERCREATIONENABLED_VALUE = true;
433                       const Uint16 _PROPERTY_SUBSCRIPTIONREMOVALACTION_VALUE = 4;

434 marek            1.19 const Uint32 _PROPERTY_SUBSCRIPTIONREMOVALTIMEINTERVAL_VALUE = 2592000;

435 venkat.puvvada   1.14 const Uint16 _PROPERTY_DELIVERYRETRYATTEMPTS_VALUE = 3;

436 venkat.puvvada   1.21.4.1 const Uint32 _PROPERTY_DELIVERYRETRYINTERVAL_VALUE = 30;

437 venkat.puvvada   1.14     

438 venkat.puvvada   1.18     /**
439                               Return codes for CIM_EnabledLogicalElement.RequestStateChange() method.
440                           */
441                           
442                           const Uint32 _RETURNCODE_COMPLETEDWITHNOERROR = 0;
443                           const Uint32 _RETURNCODE_NOTSUPPORTED = 1;
444                           const Uint32 _RETURNCODE_TIMEOUT = 3;
445                           const Uint32 _RETURNCODE_FAILED = 4;
446                           const Uint32 _RETURNCODE_INVALIDPARAMETER = 5;
447                           
448                           /**
449                               The name of the CIM_EnabledLogicalElement.RequestStateChange() method.
450                           */
451                           PEGASUS_SERVER_LINKAGE extern const CIMName _METHOD_REQUESTSTATECHANGE;
452                           
453                           /**
454                               The name of the RequestedState parameter(input) of
455                               CIM_EnabledLogicalElement.RequestStateChange() method.
456                           */
457                           PEGASUS_SERVER_LINKAGE extern const CIMName _PARAM_REQUESTEDSTATE;
458                           
459 venkat.puvvada   1.18     /**
460                               The name of the TimeoutPeriod parameter(input) of
461                               CIM_EnabledLogicalElement.RequestStateChange() method.
462                           */
463                           PEGASUS_SERVER_LINKAGE extern const CIMName _PARAM_TIMEOUTPERIOD;
464                           
465                           /**
466                               The name of the CIM_EnabledLogicalElement.EnabledState property.
467                           */
468                           PEGASUS_SERVER_LINKAGE extern const CIMName _PROPERTY_ENABLEDSTATE;
469                           
470                           /**
471                               The name of the CIM_ManagedSystemElement.EnabledState property.
472                           */
473                           PEGASUS_SERVER_LINKAGE extern const CIMName _PROPERTY_HEALTHSTATE;
474                           

475 venkat.puvvada   1.14     #endif
476                           

477 venkat.puvvada   1.18     /**
478                               CIM_EnabledLogicalElement.EnabledState values.
479                           */
480                           const Uint16 _ENABLEDSTATE_SHUTTINGDOWN = 4;
481                           const Uint16 _ENABLEDSTATE_STARTING = 10;
482                           const Uint16 _ENABLEDSTATE_ENABLED = 2;
483                           const Uint16 _ENABLEDSTATE_DISABLED = 3;
484                           
485                           /**
486                               Service health States. See CIM_ManagedSystemElement.HealthState
487                           */
488                           
489                           const Uint16 _HEALTHSTATE_OK = 5;
490                           const Uint16 _HEALTHSTATE_DEGRADEDWARNING = 10;
491                           
492                           

493 kumpf            1.1      //
494                           //  Qualifier names
495                           //
496                           
497                           /**
498                               The name of the Indication qualifier for classes
499                            */

500 kumpf            1.13     extern const CIMName _QUALIFIER_INDICATION;

501 kumpf            1.1      
502                           
503                           //
504                           //  Other literal values
505                           //
506                           
507                           /**
508                               The WHERE keyword in WQL
509                            */

510 kumpf            1.13     extern const char _QUERY_WHERE[];

511 kumpf            1.1      
512                           /**
513                               A zero value CIMDateTime interval
514                            */

515 kumpf            1.13     extern const char _ZERO_INTERVAL_STRING[];

516 kumpf            1.1      
517                           PEGASUS_NAMESPACE_END
518                           
519                           #endif  /* Pegasus_IndicationConstants_h */