pegasus/doc/BuildAndReleaseOptions.html - annotate

Return to BuildAndReleaseOptions.html CVS log

Up to [Pegasus] / pegasus / doc

1 karl 1.29 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2 <html><head>
3 denise.eckstein 1.1
4 karl 1.29 <link rel="stylesheet" href="http://www.opengroup.org/stylesheets/info1.css"></head><body>
5 denise.eckstein 1.1 <hr> 6 7 <p align="center"> 8 <b><font size="4">Recommended OpenPegasus Build and Configuration Options for Selected Platforms</font></b> 9 </p> 10 11 <hr> 12 13 <p><b>Abstract: </b> 14 This document defines a set of recommended options for building,
15 kumpf 1.12 testing and running OpenPegasus on a selected set of
16 denise.eckstein 1.1 platforms. In this version of the document, platform-specific configuration 17 information have been documented for the platforms described in the
18 karl 1.29 "Documented Platforms" section of this document.
19 denise.eckstein 1.1 </p> 20 21 <p><b>Note 1: </b> 22 The recommendations defined in this document are not intended to document 23 the feature set included in any vendor's OpenPegasus-based product. 24 Rather, the purpose of this document is to provide input to vendors when
25 karl 1.29 making product decisions.<br>
26 denise.eckstein 1.1 </p> 27 28 <hr> 29 30 <h2>Definition of the Problem</h2> 31 32 <p>OpenPegasus supports a large number of build and runtime options. 33 Determining which options to use can be challenging. The purpose of this 34 document is to simplify the build, testing and administration of OpenPegasus 35 by providing a recommended, tested set of options.</p> 36 37 <h2>Documented Platforms</h2> 38 39 <p>Support for the OpenPegasus build and runtime options described in
40 kumpf 1.12 this document varies by platform.   In this version of the 41 document, platform-specific configuration information has been included
42 denise.eckstein 1.1 for the platforms described in the following table.  For all other
43 kumpf 1.12 platforms, please consult the OpenPegasus Platform Advocate for
44 denise.eckstein 1.1 additional information.</p> 45 46 <ul>
47 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" border="1" cellspacing="1" width="20%"> 48 <tbody><tr> 49 <th align="center" bgcolor="#cae6ca">Platform</th> 50 <th align="center" bgcolor="#cae6ca">Status</th>
51 denise.eckstein 1.1 </tr> 52 <tr align="left"> 53 <td>HPUX_IA64_ACC</td> 54 <td> </td> 55 </tr> 56 <tr align="left"> 57 <td>HPUX_PARISC_ACC</td> 58 <td> </td> 59 </tr> 60 <tr align="left"> 61 <td>LINUX_IA64_GNU</td> 62 <td> </td> 63 </tr> 64 <tr align="left"> 65 <td>LINUX_IX86_GNU</td> 66 <td> </td> 67 </tr> 68 <tr align="left"> 69 <td>LINUX_PPC64_GNU</td> 70 <td> </td> 71 </tr> 72 denise.eckstein 1.1 <tr align="left"> 73 <td>LINUX_PPC_GNU</td> 74 <td> </td> 75 </tr> 76 <tr align="left">
77 marek 1.31 <td>LINUX_PPC_E500_GNU</td> 78 <td> </td> 79 </tr> 80 <tr align="left">
81 denise.eckstein 1.1 <td>LINUX_XSCALE_GNU</td> 82 <td> </td> 83 </tr> 84 <tr align="left"> 85 <td>LINUX_ZSERIES64_GNU</td> 86 <td> </td> 87 </tr> 88 <tr align="left"> 89 <td>LINUX_ZSERIES_GNU</td> 90 <td> </td> 91 </tr> 92 <tr align="left"> 93 <td>VMS_ALPHA_DECCXX</td> 94 <td> </td> 95 </tr> 96 <tr align="left"> 97 <td>VMS_IA64_DECCXX</td> 98 <td> </td> 99 </tr>
100 karl 1.29 </tbody></table>
101 denise.eckstein 1.1 </ul> 102 103 <h2>Proposed Solution</h2> 104 105 <h3>Security Considerations</h3> 106 <ol> 107 <li> 108 To avoid introducing security vulnerabilities, vendors must never 109 ship providers incompatible with the security assumptions used in
110 kumpf 1.12 their deployment. 111 For example, providers designed for a single-user deployment that 112 don't perform authorization must not be shipped with a CIM Server 113 that expects the providers to perform authorization. Note that
114 denise.eckstein 1.1 this authorization burden is considerably lighter if the provider 115 is registered as 'run as requestor' and if the CIM Server enables
116 karl 1.29 that feature. See <a href="http://www.openpegasus.org/pp/uploads/40/7197/SecurityGuidePEP.htm">
117 denise.eckstein 1.1 PEP#223 - Security Coding Guidelines</a> for additional 118 details. 119 </li> 120 <li> 121 Vendors should ensure they configure the CIM Server consistently 122 with the security requirements of their deployment. 123 </li> 124 </ol> 125 126 <h3>Terminology Notes</h3> 127 <ol> 128 <li>
129 karl 1.29 In this document, the term "Not Set" is used to indicate
130 denise.eckstein 1.1 that the a value for the environment variable has not been defined.
131 karl 1.29 "Set" is used to indicate that the value must be defined,
132 denise.eckstein 1.1 but the actual value of the variable is not checked. 133 </li> 134 </ol> 135 136 <h3>General Notes</h3> 137 138 <ol> 139 <li>
140 kumpf 1.12 Not all functionality described in this document has achieved
141 karl 1.29 "Green"status, please refer to the 142 <a href="http://www.openpegasus.org/page.tpl?CALLER=index.tpl&ggid=799">
143 denise.eckstein 1.1 OpenPegasus Project Feature Status </a>page for information on 144 the maturity level of OpenPegasus features. 145 </li> 146 <li> 147 To encourage testing of new functionality, recommendations for the 148 Development Build may include features that are not yet recommended 149 for Release Builds. 150 </li> 151 </ol> 152 153 <h3>Environment Variable Settings for <u>Building</u> OpenPegasus</h3> 154 155 <h4>Definitions</h4> 156 157 <h5>ICU_INSTALL</h5> 158 <ul> 159 <b>Description: </b>When set, points to the directory containing 160 the <a href="%20http:/oss.software.ibm.com/icu"> ICU(International
161 kumpf 1.12 Components for Unicode)</a> installation. The 'include'
162 denise.eckstein 1.1 subdirectory is used to locate ICU header files at build time. The 163 'lib' subdirectory is used to locate ICU libraries at link 164 time.<br> 165 <b>Default Value: </b>Not Set<br> 166 <b>Recommended Value (Development Build): </b>Not Set<br> 167 <b>Recommended Value (Release Build): </b>Not Set<br> 168 <b>Required: </b>No.  However, if PEGASUS_HAS_ICU is 169 set and ICU_INSTALL is not defined, the ICU libraries and header 170 files are expected to be installed in directories (e.g.,/usr/lib, 171 /usr/include)  that are searched by default.<br> 172 <b>Considerations: </b>This environment variable is only used 173 if PEGASUS_HAS_MESSAGES is set. Refer to PEGASUS_HAS_MESSAGES for 174 additional details. 175 </ul> 176 177 <h5>ICU_ROOT_BUNDLE_LANG</h5> 178 <ul> 179 <b>Description: </b>If set, specifies the language 180 to be used to generate the root resource bundle. The 181 default value for ICU_ROOT_BUNDLE_LANG is _en.<br> 182 <b>Default Value: </b>_en<br> 183 denise.eckstein 1.1 <b>Recommended Value (Development Build): </b>No 184 Recommendation<br> 185 <b>Recommended Value (Release Build): </b>No Recommendation<br> 186 <b>Required: </b>No<br> 187 <b>Considerations: </b>This environment variable is 188 only used if PEGASUS_HAS_MESSAGES is set. Refer to 189 PEGASUS_HAS_MESSAGES for additional details.<br> 190 If set, resource bundles for the designated language must 191 exist for the following files: 192 <ul> 193 <li>pegasus/src/Pegasus/msg/Server/pegasusServer_en.txt</li> 194 <li>pegasus/src/Pegasus/msg/Listener/pegasusListener_en.txt</li> 195 </ul> 196 </ul> 197 198 199 <h5>OPENSSL_BIN</h5> 200 <ul> 201 <b>Description: </b>Specifies the location of the 202 OpenSSL <i>binary</i> directory. <br> 203 <b>Default Value: </b>Not Set<br> 204 denise.eckstein 1.1 <b>Recommended Value (Development Build): </b> 205 No Specific Recommendation<br> 206 <b>Recommended Value (Release Build): </b> 207 No Specific Recommendation<br> 208 <b>Required: </b>No. By default, the openssl binary is 209 expected to be installed in a directory that is searched by default 210 (e.g., /usr/bin). For platforms where this isn't true, the 211 OPENSSL_BIN environment variable may be used to define an
212 kumpf 1.12 alternative path. This environment variable is only used if
213 denise.eckstein 1.1 PEGASUS_HAS_SSL is set. 214 </ul> 215 216 <h5>OPENSSL_HOME</h5> 217 <ul> 218 <b>Description: </b>Specifies the location of the OpenSSL 219 SDK directory. This directory must contain the OpenSSL 220 <i>include</i> directory, $(OPENSSL_HOME)/include, and the OpenSSL 221 <i>library</i> directory, $(OPENSSL_HOME)/lib.<br> 222 <b>Default Value: </b>Not Set<br> 223 <b>Recommended Value (Development Build): </b> 224 No Specific Recommendation<br> 225 <b>Recommended Value (Release Build): </b> 226 No Specific Recommendation<br> 227 <b>Required: </b>Yes for Windows, if PEGASUS_HAS_SSL 228 is set. No for all other platforms. For AIX, the default
229 kumpf 1.12 value for OPENSSL_HOME is /usr/linux.  For all other
230 denise.eckstein 1.1 platforms, the OpenSSL include files and libraries are expected 231 to be installed in directories that are searched by default (e.g.,
232 kumpf 1.12 /usr/bin, /usr/lib(64), and /usr/include).
233 denise.eckstein 1.1 For platforms where the default value is not correct, the 234 OPENSSL_HOME environment variable may be used to define an 235 alternative path (i.e., $(OPENSSL_HOME)/lib and 236 $(OPENSSL_HOME)/include). This environment variable 237 is only used if PEGASUS_HAS_SSL is set. 238 </ul> 239 240 <h5>PEGASUS_ALLOW_ABSOLUTEPATH_IN_PROVIDERMODULE</h5> 241 <ul> 242 <b>Description: </b>If set to true, a version of OpenPegasus 243 will be built that allows an absolute path to be specified as the 244 value of the Location property of PG_ProviderModule class.  245 Otherwise it does not allow the absolute path to be specified.<br> 246 <b>Default Value: </b>Not Set<br>
247 kumpf 1.12 <b>Recommended Value (Development Build): </b>Not Set<br>
248 denise.eckstein 1.1 <b>Recommended Value (Release Build): </b>Not Set<br> 249 <b>Required: </b>No<p> 250 <b>Considerations: </b>To avoid introducing security 251 vulnerabilities, vendors should analyze their deployment 252 environments to understand the security implications of allowing 253 providers to be loaded from a dynamically changing set of 254 directories.<br>
255 karl 1.29 </p></ul>
256 denise.eckstein 1.1 257 <h5>PEGASUS_CCOVER</h5> 258 <ul> 259 <b>Description: </b>This flag is currently only supported on
260 kumpf 1.12 HP-UX. It is enabled on the Nightly Build & Test system,
261 denise.eckstein 1.1 HP-UX_11iv3_Integrity_C-Cover.  This system is
262 kumpf 1.12 used to generate the nightly BullseyeCoverage code coverage
263 denise.eckstein 1.1 metrics.<br> 264 <b>Default Value: </b>Not Set<br>
265 kumpf 1.12 <b>Recommended Value (Development Build): </b>Not Set<br>
266 denise.eckstein 1.1 <b>Recommended Value (Release Build): </b>Not Set<br> 267 <b>Required: </b>No<br>
268 kumpf 1.12 <b>Considerations: </b>This flag is only supported on HP-UX to enable
269 karl 1.29 CCOVER for the NB&T system.<br>
270 denise.eckstein 1.1 </ul> 271 272 <h5>PEGASUS_CIM_SCHEMA</h5> 273 <ul>
274 karl 1.29
275 denise.eckstein 1.1 <b>Description: </b>This variable is used internally by the
276 karl 1.29 OpenPegasus development team when testing OpenPegasus in the integrated 277 build/test environment. It defines the version of the CIM Schema (which 278 must exist in the $(PEGASUS_ROOT)/Schemas directory) that will be used 279 to build the class repository for testing the pegasus environment 280 ("make repository", etc.).<br>
281 dl.meetei 1.40 <b>Default Value: </b>CIM236 (Note that this may change as newer versions of the CIM Schema are used as the default.<br>
282 denise.eckstein 1.1 <b>Recommended Value (Development Build): </b> 283 No Specific Recommendation<br> 284 <b>Recommended Value (Release Build): </b> 285 No Specific Recommendation<br> 286 <b>Required: </b>No <br>
287 karl 1.29 <b>Considerations:</b> 288 Additional code changes may be required when upgrading or downgrading 289 the CIM Schema version from the default.  The default CIM Schema 290 is defined in the file $(PEGASUS_ROOT)/mak/config.mak.<br> 291 <br> 292 <p></p>
293 denise.eckstein 1.1 </ul> 294
295 karl 1.29
296 denise.eckstein 1.1 <h5>PEGASUS_CLASS_CACHE_SIZE</h5> 297 <ul> 298 <b>Description: </b>This environment variable gives the size of 299 the class cache used by CIM repository. This variable defines the 300 size of the class cache (i.e., the maximum number of classes that
301 kumpf 1.12 may be included). If this variable is set to 0, class caching is
302 denise.eckstein 1.1 disabled.<br> 303 <b>Default Value: </b>8<br> 304 <b>Recommended Value (Development Build): </b>8<br> 305 <b>Recommended Value (Release Build): </b>8<br>
306 karl 1.29 <b>Required: </b>No <p></p>
307 denise.eckstein 1.1 </ul> 308 309 <h5>PEGASUS_DEBUG</h5> 310 <ul>
311 kumpf 1.12 <b>Description: </b>Builds a debug version of OpenPegasus. 312 Concurrently, this flag controls a) enabling compiler specific 313 debug flags and b) the inclusion of debug-specific
314 denise.eckstein 1.1 functionality.<br> 315 <b>Default Value: </b>Not Set<br> 316 <b>Recommended Value (Development Build): </b>Set<br> 317 <b>Recommended Value (Release Build): </b>Not Set<br> 318 <b>Required: </b>No 319 </ul> 320 321 <h5>PEGASUS_DEFAULT_USERCTXT_REQUESTOR</h5> 322 <ul> 323 <b>Description: </b> If set to true, the <i>Requestor</i> user 324 context is used for providers that do not specify a UserContext 325 value in their registration. Otherwise, the <i>Privileged</i> user 326 context value is used by default. <br> 327 <b>Default Value: </b>false<br> 328 <b>Recommended Value (Development Build): </b>false<br> 329 <b>Recommended Value (Release Build): </b>false<br> 330 <b>Required: </b>No 331 <b>Considerations:</b> Use of the <i>Requestor</i> default has 332 improved provider security characteristics. However, some providers 333 may not operate correctly when run in the <i>Requestor</i> user 334 context and setting this value to true may cause those providers to 335 denise.eckstein 1.1 fail.  Providers that can run in the <i>Requestor</i> 336 user context are encouraged to explicitly set the UserContext value 337 in their registration rather than rely on the default setting
338 kumpf 1.12 default by this variable. Please refer to
339 denise.eckstein 1.1 SecurityGuidelinesForDevelopers.html. PEP 223 for a discussion
340 kumpf 1.12 of the rationale/advantages of running providers in the
341 denise.eckstein 1.1 <i>Requestor </i> user context. <b>Note:</b> This build
342 kumpf 1.12 variable is not meaningful if the Provider User Context feature is 343 disabled with the PEGASUS_DISABLE_PROV_USERCTXT
344 denise.eckstein 1.1 setting.  345 </ul> 346 347 348 <h5>PEGASUS_DEFAULT_ENABLE_OOP</h5> 349 <ul> 350 <b>Description: </b>When this variable is set to false, by 351 default, Providers are run in the cimserver process
352 kumpf 1.12 (forceProviderProcesses=false). If this value is set true,
353 denise.eckstein 1.1 Providers are run out-of-process by default.<br> 354 <b>Default Value: </b>true for HP-UX and Linux, false for 355 other platforms<br> 356 <b>Recommended Value (Development Build): </b>true (HP-UX, 357 Linux)<br> 358 <b>Recommended Value (Release Build): </b>true (HP-UX, 359 Linux)<br> 360 <b>Required: </b>No<br>
361 kumpf 1.12 <b>Considerations: </b>This environment variable can be used to
362 karl 1.29 change the "hard-coded" default setting for the
363 denise.eckstein 1.1 forceProviderProcesses configuration value.  364 Refer to the definition of <b>forceProviderProcesses</b> for 365 additional information. 366 </ul> 367 368 <h5>PEGASUS_DEST_LIB_DIR</h5> 369 <ul> 370 <b>Description: </b>Specifies the location of OpenPegasus 371 shared libraries.<br> 372 <b>Default Value: </b>$(PEGASUS_HOME)/lib<br> 373 <b>Recommended Value (Development Build): </b> 374 $(PEGASUS_HOME)/lib<br> 375 <b>Recommended Value (Release Build): </b> 376 No Specific Recommendation <br> 377 <b>Required: </b>No<br> 378 <b>Considerations: </b>This variable is NOT is used to define
379 kumpf 1.12 the location of the Provider library directories.
380 denise.eckstein 1.1 Please refer to the providerDir configuration option for details 381 on defining the directories for the Provider libraries. 382 </ul> 383 384 385 <h5>PEGASUS_DISABLE_DEPRECATED_INTERFACES</h5> 386 <ul>
387 kumpf 1.12 <b>Description: </b>Removes deprecated symbol definitions
388 denise.eckstein 1.1 from OpenPegasus runtime libraries.<br> 389 <b>Default Value:</b> Not Set<br> 390 <b>Recommended Value (Development Build):</b> Not Set<br> 391 <b>Recommended Value (Release Build): </b>Not Set<br> 392 <b>Required: </b>No<br> 393 <b>Considerations: </b>If this option is set, the resulting
394 kumpf 1.12 OpenPegasus libraries will not be binary compatible with 395 clients and providers built using interface definitions from
396 denise.eckstein 1.1 prior releases. This option may be used to slightly reduce binary 397 footprint in an environment where compatibility is not required.<br> 398 </ul> 399 400 <h5>PEGASUS_DISABLE_INSTANCE_QUALIFIERS</h5> 401 <ul> 402 <b>Description: </b>In the CIM Infrastructure Specification, 403 version 2.3, the DMTF clarified that instance-level qualifiers are 404 not allowed.  In Version 1.2 of the Specification CIM 405 Operations over HTTP, use of the IncludeQualifiers parameter has 406 been DEPRECATED.<br> 407 <b>Default Value:</b> Not Set<br> 408 <b>Recommended Value (Development Build):</b> Not Set<br> 409 <b>Recommended Value (Release Build): </b>Not Set<br> 410 <b>Required: </b>No<br> 411 <b>Considerations: </b>Existing CIM Clients may depend on
412 kumpf 1.12 qualifiers being returned in the response. In this case, the 413 PEGASUS_DISABLE_INSTANCE_QUALIFIERS should not be set.
414 denise.eckstein 1.1 If this flag is set, the value of the IncludeQualifiers parameter 415 passed on the GetInstance and EnumerateInstance operations is
416 kumpf 1.12 ignored and qualifiers are not returned.
417 denise.eckstein 1.1 Disabling the return of qualifiers as part of a CIM Instance will 418 improve performance.<br> 419 </ul> 420 421 <h5>PEGASUS_DISABLE_LOCAL_DOMAIN_SOCKET</h5> 422 <ul> 423 <b>Description: </b>Disables support for local (same-system) 424 connections over a Unix domain socket. If this option is NOT set,
425 kumpf 1.12 the CIM Server is built to allow connections to be established
426 denise.eckstein 1.1 using a domain socket rather than a TCP port.<br> 427 <b>Default Value: </b>Not Set  <br> 428 <b>Recommended Value (Development Build): </b>Not Set<br> 429 <b>Recommended Value (Release Build): </b>Not Set<br> 430 <b>Required: </b>No<br> 431 <b>Considerations: </b>(1) In high-threat environments, a 432 customer may want to disable all ports or reduce the number of
433 kumpf 1.12 exposed network ports. Supporting a local connection mechanism
434 denise.eckstein 1.1 using Unix domain socket allows the CIM Server to continue to 435 receive and process requests from local CIM Clients. (2) 436 Enabling this option may result in lose of functionality when 437 sslClientVerificationMode = required. (3)The
438 karl 1.29 "LOCAL_DOMAIN_SOCKET" functionality has not been
439 denise.eckstein 1.1 implemented for  Windows or OpenVMS.  Therefore, by
440 karl 1.29 default, this option is "Set" for Windows and OpenVMS
441 denise.eckstein 1.1 platforms. 442 </ul> 443 444 <h5>PEGASUS_DISABLE_PERFINST</h5> 445 <ul> 446 <b>Description: </b>Builds a version of OpenPegasus that 447 disables support for gathering performance data.<br> 448 <b>Default Value: </b>Not Set<br> 449 <b>Recommended Value (Development Build): </b>Not Set<br> 450 <b>Recommended Value (Release Build): </b>Set<br> 451 <b>Required: </b>No<br> 452 <b>Considerations: </b>The CIM_ObjectManager.GatherStatisticalData 453 property is used to control statistic gathering.  Once enabled, 454 statistical data can be viewed by retrieving instances of the 455 CIM_StatisticalData class. Support for gathering performance 456 data requires PEGASUS_ENABLE_INTEROP_PROVIDER to be enabled. If 457 PEGASUS_ENABLE_INTEROP_PROVIDER is explicitly disabled (i.e., set 458 to false),  then PEGASUS_DISABLE_PERFINST must be set to 459 true.  If PEGASUS_DISABLE_PERFINST is not defined or set to 460 false and PEGASUS_ENABLE_INTEROP_PROVIDER is not set, 461 PEGASUS_ENABLE_INTEROP_PROVIDER will be automatically enabled. 462 denise.eckstein 1.1 </ul>
463 kumpf 1.12
464 denise.eckstein 1.1 <h5>PEGASUS_DISABLE_PRIVILEGED_TESTS</h5> 465 <ul> 466 <b>Description: </b>This variable is used only in the development
467 kumpf 1.12 environment to restrict the level of testing performed by default. 468 If set, tests that require the CIM Server to run in a privileged 469 mode will not be run.  Setting this variable allows
470 denise.eckstein 1.1 developers, without privileged access, to successfully run a 471 subset of the OpenPegasus test suit.  This variable does 472 not affect CIM Server functionality.  It merely controls 473 the level of testing.<br> 474 <b>Default Value: </b>Not Set<br> 475 <b>Recommended Value (Development Build): </b>Not Set<br> 476 <b>Recommended Value (Release Build): </b>Not Used<br> 477 <b>Required: </b>No<br> 478 <b>Considerations: </b>Enabling this variable will significantly
479 kumpf 1.12 reduce the testing of security related features (e.g.,
480 denise.eckstein 1.1 authentication and authorization) and can affect testing in other 481 areas. 482 </ul> 483 484 <h5>PEGASUS_DISABLE_PROV_USERCTXT</h5> 485 <ul> 486 <b>Description: </b>Builds a version of OpenPegasus that 487 disables supports for the Provider User Context feature.  488 This feature allows a Provider to choose the user context in 489 which it is invoked, including the ability to run in the context of 490 the user requesting an operation.<br> 491 <b>Default Value: </b>Set for Windows and OpenVMS, Not Set 492 for all other platforms<br> 493 <b>Recommended Value (Development Build): </b>Set for Windows and 494 OpenVMS, Not Set for all other platforms<br> 495 <b>Recommended Value (Release Build): </b>Set for Windows and 496 OpenVMS, Not Set for all other platforms<br> 497 <b>Required: </b>No<br> 498 <b>Considerations: </b>The Provider User Context feature may be 499 disabled by compiling with the PEGASUS_DISABLE_PROV_USERCTXT flag 500 defined. In this case, the Provider Registration Manager rejects 501 denise.eckstein 1.1 provider registration requests that specify a UserContext property 502 value. The user context in which providers run is then unchanged by
503 kumpf 1.12 this enhancement. Some platforms, such as OS/400 and z/OS may
504 denise.eckstein 1.1 define the PEGASUS_DISABLE_PROV_USERCTXT as part of the platform 505 configuration, since these platforms already set the provider user 506 context on a per-thread basis.  When the Provider User Context 507 feature is enabled, support for each of the User Context types may
508 kumpf 1.12 be disabled individually. Provider registration fails when an
509 denise.eckstein 1.1 unsupported UserContext value is specified. Please refer to
510 kumpf 1.12 SecurityGuidelinesForDevelopers.html / PEP 223 for a discussion of 511 the rationale/advantages of user context providers to many
512 denise.eckstein 1.1 platforms.<br> 513 </ul> 514
515 s.kodali 1.20 <h5>PEGASUS_EXTRA_PROVIDER_LIB_DIR</h5> 516 <ul> 517 <b>Description: </b>Specifies the location of the extra provider 518 libraries which are part of the release builds.<br> 519 <b>Default Value: </b>Not Set<br> 520 <b>Recommended Value (Development Build): </b> 521 No Specific Recommendation<br> 522 <b>Recommended Value (Release Build): </b> 523 No Specific Recommendation<br> 524 <b>Required: </b> No.<br> 525 <b>Considerations: </b> Since providerDir config property is fixed 526 and hidden in release builds, this build time option provides facilty 527 to include the extra provider directories without any security problems. 528 This build time option is useful only when PEGASUS_OVERRIDE_DEFAULT_RELEASE_DIRS 529 is set. 530 </ul> 531
532 denise.eckstein 1.1 <h5>PEGASUS_EMANATE_INCLUDE_DIR</h5> 533 <ul> 534 <b>Description: </b>Specifies the location of the EMANATE 535 <i>include</i> directory. <br> 536 <b>Default Value: </b>Not Set<br> 537 <b>Recommended Value (Development Build): </b> 538 No Specific Recommendation<br> 539 <b>Recommended Value (Release Build): </b> 540 No Specific Recommendation<br> 541 <b>Required: </b>No. By default, the EMANATE include files 542 are expected to be installed in directories that are searched by 543 default (e.g., /usr/include). For platforms where this isn't true,
544 kumpf 1.12 the PEGASUS_EMANATE_INCLUDE_DIR environment variable may be used to 545 define an alternative path. This environment variable is only used
546 denise.eckstein 1.1 if PEGASUS_USE_EMANATE is set.<br>
547 kumpf 1.12 <b>Considerations: </b>Refer to the description of PEGASUS_USE_EMANATE
548 denise.eckstein 1.1 for additional details.<br> 549 </ul> 550 551 <h5>PEGASUS_EMANATE_LIB_DIR</h5> 552 <ul> 553 <b>Description: </b>Specifies the location of the EMANATE 554 <i>lib</i> directory. <br> 555 <b>Default Value: </b>Not Set<br> 556 <b>Recommended Value (Development Build): </b> 557 No Specific Recommendation<br> 558 <b>Recommended Value (Release Build): </b> 559 No Specific Recommendation<br>
560 kumpf 1.12 <b>Required: </b>No. By default, the EMANATE libraries are 561 expected to be installed in directories that are searched by 562 default (e.g., /usr/lib, /usr/lib64). For platforms where this
563 denise.eckstein 1.1 isn't true, the PEGASUS_EMANATE_LIB_DIR environment variable may 564 be used to define an alternative path. This environment variable 565 is only used if PEGASUS_USE_EMANATE is set.<br> 566 <b>Considerations: </b>Refer to the description of PEGASUS_USE_EMANATE 567 for additional details.<br> 568 </ul> 569 570 <h5>PEGASUS_ENABLE_AUDIT_LOGGER</h5> 571 <ul> 572 <b>Description: </b>When this variable is set to false, support 573 for audit logging will NOT be built into OpenPegasus. If this 574 variable is set to true, or not set, support for audit logging 575 will be included in the build. All other values are invalid.<br> 576 <b>Default Value: </b>true<br> 577 <b>Recommended Value (Development Build): </b>true<br> 578 <b>Recommended Value (Release Build): </b>true<br> 579 <b>Required: </b>No<br> 580 </ul> 581 582 583 <h5>PEGASUS_ENABLE_CMPI_PROVIDER_MANAGER</h5> 584 denise.eckstein 1.1 <ul> 585 <b>Description: </b>If set to true, a version of OpenPegasus 586 that supports CMPI providers and their dependent components is 587 built.  If this variable is not set or set to false, support 588 for CMPI providers will not be included. <br> 589 <b>Default Value: </b>true for Linux and OpenVMS, false for 590 other platforms<br>
591 kumpf 1.12 <b>Recommended Value (Development Build): </b>true (Linux
592 denise.eckstein 1.1 Platform Only)<br> 593 <b>Recommended Value (Release Build): </b>true (Linux Platform 594 Only)<br>
595 karl 1.29 <b>Required: </b>No<p></p>
596 denise.eckstein 1.1 </ul> 597 598 <h5>PEGASUS_ENABLE_COMPRESSED_REPOSITORY</h5> 599 <ul> 600 <b>Description: </b>If set the Repository Compression logic is 601 built and enabled and compressed and non compressed repositories 602 are supported. If not set then compressed repositories are not 603 supported.<br> 604 <b>Default Value: </b>Not Set<br> 605 <b>Recommended Value (Development Build): </b>Not Set<br> 606 <b>Recommended Value (Release Build): </b>Not Set<br> 607 <b>Required: </b>No<p>
608 kumpf 1.12 <b>Considerations: </b>See
609 denise.eckstein 1.1 pegasus/readme.compressed_repository</p> 610 </ul> 611 612 613 <h5>PEGASUS_ENABLE_CQL</h5> 614 <ul> 615 <b>Description: </b>When this variable is set to false, support 616 for Indication Subscription filters that have CQL as the language 617 is disabled. It does not remove CQL from the build.<br> 618 <b>Default Value:</b> Not Set<br> 619 <b>Recommended Value (Development Build):</b> Not Set<br> 620 <b>Recommended Value (Release Build):</b> false<br> 621 <b>Required: </b>No<br>
622 kumpf 1.12 <b>Considerations: </b>The DMTF CIM Query Language 623 Specification is Preliminary and subject to backward incompatible 624 changes.
625 denise.eckstein 1.1 </ul> 626 627 <h5>PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT</h5> 628 <ul> 629 <b>Description: </b>When this variable is set to true, support the 630 DMTF Indications Profile (DSP1054) is included in OpenPegasus.  631 If this variable is not set or set to false, support for the DMTF 632 Indications Profile will not be included.<br> 633 <b>Default Value:</b> Not Set<br> 634 <b>Recommended Value (Development Build):</b> Not Set<br> 635 <b>Recommended Value (Release Build):</b> Not Set<br> 636 <b>Required: </b>No<br> 637 <b>Considerations: </b>The implementation of this feature is 638 based on a preliminary version of the DMTF Indications Profile, 639 DSP1053, and subject to change.  If this variable is enabled,
640 kumpf 1.12 two DMTF experimental class definitions, CIM_IndicationService and 641 CIM_IndicationServiceCapabilities, will be added to the
642 denise.eckstein 1.1 root/PG_InterOp namespace. Experimental class definitions are 643 subject to change.
644 kumpf 1.12 PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT requires
645 denise.eckstein 1.1 PEGASUS_ENABLE_INTEROP_PROVIDER to be enabled. 646 If PEGASUS_ENABLE_INTEROP_PROVIDER is not set, setting 647 PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT to true, will also 648 enable PEGASUS_ENABLE_INTEROP_PROVIDER. If 649 PEGASUS_ENABLE_INTEROP_PROVIDER is explicitly disabled (i.e., set 650 to false), a build error will be generated. 651 </ul> 652 653 <h5>PEGASUS_ENABLE_EXECQUERY</h5> 654 <ul> 655 <b>Description: </b>When this environment variable is set,
656 kumpf 1.12 processing of ExecQuery operations is enabled. When not set,
657 denise.eckstein 1.1 ExecQuery operation requests get a NotSupported response. (Note: 658 The PEGASUS_ENABLE_EXECQUERY environment variable controls 659 the definition of the PEGASUS_DISABLE_EXECQUERY compile macro.) <br> 660 <b>Default Value: </b>Not Set<br> 661 <b>Recommended Value (Development Build): </b>Not Set<br> 662 <b>Recommended Value (Release Build): </b>Not Set<br> 663 <b>Required: </b>No 664 </ul> 665 666 <h5>PEGASUS_ENABLE_EMAIL_HANDLER</h5> 667 <ul> 668 <b>Description: </b> When this environment variable is set, an
669 kumpf 1.12 E-Mail Indication Handler is built as part of the OpenPegasus 670 build.  The E-Mail Indication Handler can be used to
671 denise.eckstein 1.1 delivered CIM Indications to a designated e-mail address.<br> 672 <b>Default Value: </b>Not Set<br> 673 <b>Recommended Value (Development Build): </b>Not Set<br> 674 <b>Recommended Value (Release Build): </b>Not Set<br> 675 <b>Required: </b>No<br> 676 <b>Considerations: </b>If PEGASUS_ENABLE_EMAIL_HANDLER is 677 not set when OpenPegasus is built, a request to create an Email 678 Indication Handler instance will be rejected will the error 679 CIM_ERR_NOT_SUPPORTED. 680 </ul> 681 682 <h5>PEGASUS_ENABLE_GCOV</h5> 683 <ul> 684 <b>Description: </b>GCOV, 685 <a href="http://gcc.gnu.org/onlinedocs/gcc/index.html#toc_Gcov"> 686 http://gcc.gnu.org/onlinedocs/gcc/index.html#toc_Gcov</a>, is a 687 code coverage utility.  If PEGASUS_ENABLE_GCOV is set,  688 GCC will instrument the code to support analysis by GCOV.<br> 689 <b>Default Value: </b>Not Set<br> 690 <b>Recommended Value (Development Build): </b> 691 Not Set<br> 692 denise.eckstein 1.1 <b>Recommended Value (Release Build): </b>Not Set<br> 693 <b>Required: </b>No<br><b>Considerations: </b> 694 This flag is currently only supported with GCC on Linux. 695 <ul>
696 karl 1.29 Note: LCOV, <a href="http://ltp.sourceforge.net/coverage/lcov.php">
697 kumpf 1.12 http://ltp.sourceforge.net/coverage/lcov.php</a>, is a
698 denise.eckstein 1.1 graphical front-end extension for GCOV. It collects GCOV data 699 for multiple source files and creates HTML pages with coverage
700 kumpf 1.12 information. You can use the following steps to use LCOV to
701 denise.eckstein 1.1 analyze OpenPegasus GCOV data. 702 <ol> 703 <li>Set PEGASUS_ENABLE_GCOV = true.</li>
704 kumpf 1.12 <li>Build and test OpenPegasus (e.g., 705 <i>make -f pegasus/TestMakefile  build
706 denise.eckstein 1.1 alltests</i>).</li> 707 <li>For each source directory, 708 <ul> 709 <li>copy the .gcda and .gcno files from the object
710 kumpf 1.12 directory to the source directory (e.g., 711 <i>cp build/obj/Pegasus/Common/*.gcda
712 denise.eckstein 1.1 src/Pegasus/Common/</i>);</li>
713 kumpf 1.12 <li>execute the <b>lcov</b> command 714 (e.g.,
715 denise.eckstein 1.1 <i>lcov --directory src/Pegasus/Common/ --capture 716 --output-file result.info</i>) to build the result.info 717 file; and finally,</li> 718 <li>use the <b>genhtml</b> command to generate the .html 719 output (e.g., <i>genhtml result.info</i>).  The 720 top .html file is named index.html.</li> 721 </ul>
722 karl 1.29 </li></ol>
723 denise.eckstein 1.1 </ul> 724 </ul>
725 kumpf 1.12
726 denise.eckstein 1.1 <h5>PEGASUS_ENABLE_INDICATION_COUNT</h5> 727 <ul>
728 kumpf 1.12 <b>Description: </b>If true, the CIM
729 denise.eckstein 1.1 Server will be built to count the number of CIM indications 730 generated by providers and matched with subscriptions. If false 731 or not set, indication statistic support will not be included. 732 <b>Default Value: </b>true<br> 733 <b>Recommended Value (Development Build): </b>true <br> 734 <b>Recommended Value (Release Build): </b>true <br> 735 <b>Required: </b>No <br> 736 <b>Considerations: </b>The number of CIM indications generated by 737 providers and matched with subscriptions is stored in hash tables 738 which causes memory usage to increase by 4 bytes for each 739 active subscription and by about 400 bytes for each active 740 indication provider.<br> 741 </ul> 742
743 mike 1.10 <h5>PEGASUS_ENABLE_PROTOCOL_BINARY</h5> 744 <ul> 745 <b>Description: </b>If true, OpenPegasus uses a faster binary
746 marek 1.26 protocol between local clients and the CIM server. If false, OpenPegasus 747 uses the conventional XML-based protocol instead. 748 See PEP#340 for more details.
749 mike 1.10 <br> 750 <b>Default Value: </b>false<br> 751 <b>Recommended Value (Development Build): </b>false<br> 752 <b>Recommended Value (Release Build): </b>false<br> 753 <b>Required: </b>No<br> 754 <b>Considerations: </b>This option improves performance by using a faster 755 binary protocol between local clients and the CIM server.
756 mike 1.8 <br> 757 </ul> 758
759 denise.eckstein 1.1 <h5>PEGASUS_ENABLE_INTEROP_PROVIDER</h5> 760 <ul> 761 <b>Description: </b>If true, the OpenPegasus Interop Provider 762 will be build. If false or not set, the OpenPegasus Interop 763 Provider will not be built.<br> 764 <b>Default Value: </b>Not Set<br> 765 <b>Recommended Value (Development Build): </b>Not Set<br> 766 <b>Recommended Value (Release Build): </b>false<br> 767 <b>Required: </b>No <br> 768 <b>Considerations: </b> A number of features controlled by 769 OpenPegasus build options are dependent on the Interop
770 kumpf 1.12 Provider.  Please refer to PEGASUS_ENABLE_SLP, 771 PEGASUS_DISABLE_PERFINST, and
772 denise.eckstein 1.1 PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT for additional 773 details.<br> 774 </ul> 775
776 anusha.kandepu 1.32 <h5>PEGASUS_INTEROP_NAMESPACE</h5> 777 <ul> 778 <b>Description: </b>This variable is used for configuring the Interop 779 namespace name. This option helps to establish a consistent Interop 780 Namespace as mentioned in DMTF specification.(DSP1033)<br> 781 <b>Default Value: </b>root/PG_InterOp<br> 782 <b>Recommended Value (Development Build): </b>Not Set<br> 783 <b>Recommended Value (Release Build): </b>Not Set<br> 784 <b>Required: </b>No <br> 785 <b>Considerations: </b>The accepted values for this environment 786 variable are "root/PG_InterOp" or "interop" or "root/interop". For 787 any other value, the default value will be used.With the usage of 788 this build option, we have to start using pegasus with fresh repository. 789 </ul> 790
791 denise.eckstein 1.1 <h5>PEGASUS_ENABLE_IPV6</h5> 792 <ul> 793 <b>Description: </b>This variable can be used to specify 794 whether IPv6 support should be included in OpenPegasus.<br> 795 <b>Default Value: </b>true<br> 796 <b>Recommended Value (Development Build): </b>true<br> 797 <b>Recommended Value (Release Build): </b>true<br> 798 <b>Required: </b>No<br> 799 <b>Considerations: </b>When this variable is set to 800 'false', support for IPv6 socket APIs and structures is disabled,
801 kumpf 1.12 and the CIM Server will not accept connections to or from IPv6
802 denise.eckstein 1.1 network interfaces. When this variable is set to 'true', the
803 kumpf 1.12 newer IPv6 socket APIs and structures will be included when 804 OpenPegasus is built, so they must be supported on the build 805 platform. However, if IPv6 is not supported on the platform on
806 denise.eckstein 1.1 which an IPv6-enabled version of OpenPegasus is run, then the IPv6 807 feature will be disabled at run-time and only IPv4 connections 808 will be supported. 809 </ul> 810 811 <h5>PEGASUS_ENABLE_JMPI_PROVIDER_MANAGER</h5> 812 <ul> 813 <b>Description: </b>If true, a version of OpenPegasus that 814 supports JMPI providers and their dependent components is built. 815 If false or not set, support for JMPI Providers is not included 816 in OpenPegasus.  All other values are invalid.<br> 817 <b>Default Value: </b>false<br> 818 <b>Recommended Value (Development Build): </b>false<br> 819 <b>Recommended Value (Release Build): </b>false<br>
820 karl 1.29 <b>Required: </b>No<p></p>
821 denise.eckstein 1.1 </ul> 822 823 <h5>PEGASUS_ENABLE_OBJECT_NORMALIZATION</h5> 824 <ul>
825 kumpf 1.12 <b>Description: </b>If set, builds in support so that objects 826 returned from provider instance operations can be validated.
827 denise.eckstein 1.1 The enableNormalization must also be set to 'true' (default)<br> 828 <b>Default Value: </b>Not Set<br> 829 <b>Recommended Value (Development Build): </b>Not Set<br> 830 <b>Recommended Value (Release Build): </b>Not Set<br> 831 <b>Required: </b>No    <br> 832 <b>Considerations: </b>If PEGASUS_ENABLE_OBJECT_NORMALIZATION is 833 set, two new configuration options are defined: enableNormalization 834 and excludeModulesFromNormalization. 835 </ul> 836 837 <h5>PEGASUS_ENABLE_PRIVILEGE_SEPARATION</h5> 838 <ul> 839 <b>Description: </b>If true, a version of OpenPegasus that 840 enables the Privilege Separation feature is built. This feature 841 allows the CIM Server to run in a non-privileged user context and
842 kumpf 1.12 use a small executor process to perform privileged operations. If 843 false or not set, the Privilege Separate feature will not be
844 denise.eckstein 1.1 included.<br> 845 <b>Default Value: </b>false<br>
846 kumpf 1.12 <b>Recommended Value (Development Build): </b>true (HP-UX,
847 denise.eckstein 1.1 Linux)<br> 848 <b>Recommended Value (Release Build): </b>true (HP-UX, 849 Linux)<br> 850 <b>Required: </b>No<br> 851 <b>Considerations: </b> The Privilege Separation feature is 852 only supported on HP-UX and Linux platforms. The 'cimsrvr' user 853 must be defined on the system. If the umask setting in the 854 environment is not 0, PEGASUS_TMP must be set to a directory that
855 kumpf 1.12 is writable by the 'cimsrvr' user for the tests to run
856 denise.eckstein 1.1 successfully. 857 </ul> 858 859 <h5>PEGASUS_ENABLE_PROTOCOL_WSMAN</h5> 860 <ul> 861 <b>Description: </b>If true, a version of OpenPegasus is 862 built that accepts and processes WS-Management requests. This
863 kumpf 1.5 feature is initially limited to WS-Transfer and WS-Enumeration 864 operations. If false or not set, WS-Management support is not 865 built or included in any way.<br>
866 denise.eckstein 1.1 <b>Default Value: </b>false<br> 867 <b>Recommended Value (Development Build): </b>true<br> 868 <b>Recommended Value (Release Build): </b>false<br> 869 <b>Required: </b>No<br> 870 <b>Considerations: </b> The WS-Management standards are not 871 mature, and interoperability problems may arise. The WS-Management
872 kumpf 1.12 functionality may change in incompatible ways in subsequent
873 denise.eckstein 1.1 releases. Also note the known limitations specified in PEP 311.<br> 874 </ul> 875 876 <h5>PEGASUS_ENABLE_REMOTE_CMPI</h5> 877 <ul> 878 <b>Description: </b>If set, a version of OpenPegasus that 879 support Remote CMPI providers and their dependent components 880 is built.<br> 881 <b>Default Value: </b>Not Set<br> 882 <b>Recommended Value (Development Build): </b>Not Set<br> 883 <b>Recommended Value (Release Build): </b>Not Set<br>
884 karl 1.29 <b>Required: </b>No<p></p>
885 denise.eckstein 1.1 </ul> 886 887 <h5>PEGASUS_ENABLE_SLP</h5> 888 <ul> 889 <b>Description: </b>This variable controls of the inclusion 890 of SLP functionality in the OpenPegasus build. When this 891 environment variable is set to 'true', SLP functionality will be
892 kumpf 1.12 included as part of the OpenPegasus build.  If
893 denise.eckstein 1.1 this variable is set to 'false' or not set, the SLP functionality 894 will not be included.  All other values are considered 895 invalid and will result in a build error
896 karl 1.29 (e.g., "PEGASUS_ENABLE_SLP ($(PEGASUS_ENABLE_SLP)) invalid, 897 must be true or false").<br>
898 denise.eckstein 1.1 <b>Default Value: </b>'true' for Windows; 'false' for all other 899 Platforms<br> 900 <b>Recommended Value (Development Build): </b>'true' for 901 Windows; 'false' for all other Platforms<br> 902 <b>Recommended Value (Release Build): </b><br> 903 <b>Required: </b>No<br> 904 <b>Considerations: </b>PEGASUS_ENABLE_SLP requires 905 PEGASUS_ENABLE_INTEROP_PROVIDER to be enabled. If
906 kumpf 1.12 PEGASUS_ENABLE_INTEROP_PROVIDER is not set, setting
907 denise.eckstein 1.1 PEGASUS_ENABLE_SLP to true, will also enable
908 kumpf 1.12 PEGASUS_ENABLE_INTEROP_PROVIDER. If
909 denise.eckstein 1.1 PEGASUS_ENABLE_INTEROP_PROVIDER is explicitly disabled 910 (i.e., set to false), a build error will be generated.<br> 911 </ul> 912 913 914 <h5>PEGASUS_ENABLE_SORTED_DIFF</h5> 915 <ul>
916 kumpf 1.12 <b>Description: </b>This controls if the DIFFSORT function 917 is used rather than a simple DIFF of the test results files 918 to the static results file. Set to 'true' enables the sorted 919 diffs of results to static results files. Otherwise results 920 in regular diffs of results to static results files. 921 See OpenPegasus bug 2283 for background information concerning
922 denise.eckstein 1.1 this config variable. <br> 923 <b>Default Value: </b>true<br> 924 <b>Recommended Value (Development Build): </b>true<br> 925 <b>Recommended Value (Release Build): </b>true<br> 926 <b>Required: </b>No<p> </p> 927 </ul> 928 929 <h5>PEGASUS_ENABLE_SYSTEM_LOG_HANDER</h5> 930 <ul> 931 <b>Description: </b>When this environment variable is set, a
932 kumpf 1.12 SysLog Indication Handler is built as part of the OpenPegasus 933 build.  The SysLog Indication Handler can be used to
934 denise.eckstein 1.1 delivered CIM Indications to the system log file.<br> 935 <b>Default Value: </b>Not Set<br> 936 <b>Recommended Value (Development Build): </b>Not Set<br> 937 <b>Recommended Value (Release Build): </b>Not Set<br> 938 <b>Required: </b>No<br>
939 kumpf 1.12 <b>Considerations: </b>If PEGASUS_ENABLE_SYSTEM_LOG_HANDLER
940 denise.eckstein 1.1 is not set when OpenPegasus is built, a request to create a SysLog
941 kumpf 1.12 Indication Handler instance will be rejected with the error
942 denise.eckstein 1.1 CIM_ERR_NOT_SUPPORTED.<br> 943 </ul> 944 945 <h5>PEGASUS_ENABLE_SSLV2</h5> 946 <ul> 947 <b>Description: </b>By default, support for the SSLV2 protocol
948 kumpf 1.12 is disabled in OpenPegasus. The option can be used to build a
949 denise.eckstein 1.1 version of OpenPegasus that supports SSLV2. This variable affects 950 how SSL contexts are constructed for both the CIM Server and CIM 951 Clients.<br> 952 <b>Default Value: </b>Not Set<br> 953 <b>Recommended Value (Development Build): </b>Not Set<br> 954 <b>Recommended Value (Release Build): </b>Not Set<br> 955 <b>Required: </b>No<br> 956 <b>Considerations:</b> Unless SSLV2 is required for backward 957 compatibility, enabling this protocol is not recommended (SSLV3 958 or later is preferred). 959 </ul> 960 961 <h5>PEGASUS_ENABLE_USERGROUP_AUTHORIZATION</h5> 962 <ul>
963 kumpf 1.12 <b>Description: </b>Builds a version of OpenPegasus that
964 denise.eckstein 1.1 allows an administrator to restrict access to CIM operations 965 to members of a designated set of groups.  Refer to the 966 <b>authorizedUserGroups</b>configuration option for additional 967 details.<br> 968 <b>Default Value: </b>Not Set<br> 969 <b>Recommended Value (Development Build): </b>Not Set<br> 970 <b>Recommended Value (Release Build): </b>Set<br> 971 <b>Required: </b>No<br> 972 </ul> 973 974 <h5>PEGASUS_EXTRA_C_FLAGS</h5> 975 <ul>
976 kumpf 1.12 <b>Description:  </b>This environment variable allows a 977 developer to specify an additional set of flags to be included
978 denise.eckstein 1.1 on  the C compile command line.<br> 979 <b>Default Value: </b>Not Set<br> 980 <b>Recommended Value (Development Build): </b>No Set<br> 981 <b>Recommended Value (Release Build): </b>Not Set<br> 982 <b>Required: </b>No 983 </ul> 984 985 <h5>PEGASUS_EXTRA_CXX_FLAGS</h5> 986 <ul>
987 kumpf 1.12 <b>Description:  </b>This environment variable allows a
988 denise.eckstein 1.1 developer to specify an additional set of flags to be included 989 on the C++ compile command line.<br> 990 <b>Default Value: </b>Not Set<br> 991 <b>Recommended Value (Development Build): </b>Not Set<br> 992 <b>Recommended Value (Release Build): </b>Not Set<br> 993 <b>Required: </b>No 994 </ul> 995 996 <h5>PEGASUS_EXTRA_LIBRARY_LINK_FLAGS</h5> 997 <ul> 998 <b>Description:  </b>This environment variable allows a
999 kumpf 1.12 developer to specify an additional set of flags to include on
1000 denise.eckstein 1.1 the link command line used to build a library.<br> 1001 <b>Default Value: </b>Not Set<br> 1002 <b>Recommended Value (Development Build): </b>Not Set<br> 1003 <b>Recommended Value (Release Build): </b>Not Set<br> 1004 <b>Required: </b>No 1005 </ul> 1006 1007 <h5>PEGASUS_EXTRA_LINK_FLAGS</h5> 1008 <ul> 1009 <b>Description:  </b>This environment variable allows a 1010 developer to specify an additional set of flags to be included 1011 on the link command line.  These flags will be included on 1012 both library and program executable link command lines.<br> 1013 <b>Default Value: </b>Not Set<br> 1014 <b>Recommended Value (Development Build): </b>Not Set<br> 1015 <b>Recommended Value (Release Build): </b>Not Set<br> 1016 <b>Required: </b>No
1017 kumpf 1.12 <b>Considerations: </b>Refer to PEGASUS_EXTRA_LIBRARY_LINK_FLAGS and
1018 denise.eckstein 1.1 PEGASUS_EXTRA_PROGRAM_FLAGS to add flags specific to either a 1019 library or program link command line.<br> 1020 </ul> 1021 1022 <h5>PEGASUS_EXTRA_PROGRAM_LINK_FLAGS</h5> 1023 <ul> 1024 <b>Description:  </b>This environment variable allows a 1025 developer to specify an additional set of flags to include on 1026 the link command line used to build an executable program.<br> 1027 <b>Recommended Value (Development Build): </b>Not Set<br> 1028 <b>Recommended Value (Release Build): </b>Not Set<br> 1029 <b>Required: </b>No 1030 </ul> 1031 1032 <h5>PEGASUS_HAS_MESSAGES</h5> 1033 <ul>
1034 kumpf 1.12 <b>Description: </b>When set (to anything) during the build, 1035 OpenPegasus compiles with localization support. The 1036 ICU (International Components for Unicode) variables, 1037 ICU_ROOT and ICU_INSTALL, indicate that the 1038 localization support is based on ICU. Only ICU is supported
1039 denise.eckstein 1.1 at this time.<br> 1040 <b>Default Value: </b>Not Set<br> 1041 <b>Recommended Value (Development Build): </b>Not Set<br> 1042 <b>Recommended Value (Release Build): </b>Not Set<br> 1043 <b>Required: </b>No<br> 1044 <b>Considerations: </b>If the PEGASUS_HAS_MESSAGES is not 1045 set, OpenPegasus is built without localization support. This 1046 means that all messages sent by the CIM Server and the CLIs are in 1047 English. ICU is an open source project at 1048 <a href="http://oss.software.ibm.com/icu">
1049 kumpf 1.12 http://oss.software.ibm.com/icu</a>.
1050 denise.eckstein 1.1 Only English translations are included with the OpenPegasus 1051 distribution. The OpenPegasus distribution does not provide 1052 translated messages. But, enabling for ICU would allow vendor to 1053 provide the translations. Refer to the OpenPegasus Release README 1054 for additional information regarding the use of ICU. Although, in
1055 kumpf 1.12 OpenPegasus 2.3.2, experience with localization support 1056 has been limited to a select set of platforms, wider platform
1057 denise.eckstein 1.1 adoption of this technology is planned for 2.5.<br> 1058 </ul> 1059 1060 <h5>PEGASUS_HAS_SSL</h5> 1061 <ul> 1062 <b>Description: </b>If set, a version of OpenPegasus that 1063 supports SSL (i.e., https) is built.<br> 1064 <b>Default Value: </b>Not Set<br> 1065 <b>Recommended Value (Development Build): </b>Set<br> 1066 <b>Recommended Value (Release Build): </b>Set<br> 1067 <b>Required: </b>No<br>
1068 kumpf 1.12 <b>Considerations: </b>Support for SSL in OpenPegasus is 1069 dependent on the OpenSSL software developed by the
1070 denise.eckstein 1.1 <a href="http://www.openssl.org/">
1071 kumpf 1.12 OpenSSL Project (http://www.openssl.org/)</a>.
1072 denise.eckstein 1.1 1073 If the PEGASUS_HAS_SSL variable is set, the variable OPENSSL_HOME 1074 must also be defined. The OPENSSL_HOME variable is used, by the
1075 kumpf 1.12 OpenPegasus build, to determine the location of the OpenSSL
1076 denise.eckstein 1.1 include files, libraries and binaries. 1077 </ul> 1078 1079 <h5>PEGASUS_HOME</h5> 1080 <ul> 1081 <b>Description: </b>Specifies the location of the 1082 OpenPegasus working directory. The OpenPegasus
1083 kumpf 1.12 build will use this directory as the default location
1084 denise.eckstein 1.1 for files generated during the build (e.g., binaries, 1085 libraries, objects).<br> 1086 <b>Default Value: </b>None<br> 1087 <b>Recommended Value (Development Build): </b> 1088 No Specific Recommendation<br> 1089 <b>Recommended Value (Release Build): </b> 1090 No Specific Recommendation<br> 1091 <b>Required: </b>Yes<br>
1092 karl 1.29 <b>Considerations: </b>The error "PEGASUS_HOME 1093 environment variable undefined" is returned if the
1094 kumpf 1.12 PEGASUS_HOME environment variable is not set.
1095 denise.eckstein 1.1 This variable is also used during runtime. Refer to the section
1096 karl 1.29 titled "Environment Variable Settings for Running OpenPegasus 1097 2.3.2 on Linux" for additional details.<br>
1098 denise.eckstein 1.1 </ul> 1099 1100 <h5>PEGASUS_MAX_THREADS_PER_SVC_QUEUE</h5> 1101 <ul> 1102 <b>Description: </b>Controls the maximum number of threads 1103 allowed per message service queue. It is allowed to range 1104 between 1 and MAX_THREADS_PER_SVC_QUEUE_LIMIT (currently 5000)
1105 kumpf 1.12 as set in pegasus/src/Pegasus/Common/MessageQueueService.cpp.
1106 denise.eckstein 1.1 If set to 0 (zero) the max threads per service queue is then 1107 set to MAX_THREADS_PER_SVC_QUEUE_LIMIT. If set larger than the
1108 kumpf 1.12 MAX_THREADS_PER_SVC_QUEUE_LIMIT it is set equal to
1109 denise.eckstein 1.1 MAX_THREADS_PER_SVC_QUEUE_LIMIT. There are no other limits on the 1110 total number of threads that can exist within the system at this
1111 kumpf 1.12 time. When the server starts there on the order of 10 to 20 1112 message service queues created dependent upon
1113 denise.eckstein 1.1 build options.  <br> 1114 <b>Default Value: </b>5<br> 1115 <b>Recommended Value (Development Build): </b>5<br> 1116 <b>Recommended Value (Release Build): </b>5<br> 1117 <b>Required: </b>No<br> 1118 <b>Considerations: </b>This flag affects consumption of 1119 system resources. Not setting, or inappropriately setting 1120 this value, may cause the cimserver to hang or crash.<br> 1121 </ul> 1122 1123 <h5>PEGASUS_ROOT</h5> 1124 <ul> 1125 <b>Description: </b>Specifies the location of the directory 1126 that corresponds to "pegasus" source directory defined in the
1127 kumpf 1.12 OpenPegasus CVS source tree. This environment variable is 1128 used by the OpenPegasus build to locate the required build 1129 and source files (e.g., $(PEGASUS_ROOT)/mak and 1130 $(PEGASUS_ROOT)/src).<br>
1131 denise.eckstein 1.1 <b>Default Value: </b>None<br> 1132 <b>Recommended Value (Development Build): </b> 1133 No Specific Recommendation<br> 1134 <b>Recommended Value (Release Build): </b> 1135 No Specific Recommendation<br> 1136 <b>Required: </b>Yes<br> 1137 <b>Considerations: </b>The error "PEGASUS_ROOT environment 1138 variable undefined" is returned if the PEGASUS_ROOT 1139 environment variable is not set. 1140 </ul> 1141 1142 1143 <h5>PEGASUS_NET_SNMP_INCLUDE_DIR</h5> 1144 <ul> 1145 <b>Description: </b>Specifies the location of the NET-SNMP 1146 <i>include</i> directory. <br> 1147 <b>Default Value: </b>Not Set<br> 1148 <b>Recommended Value (Development Build): </b> 1149 No Specific Recommendation<br> 1150 <b>Recommended Value (Release Build): </b> 1151 No Specific Recommendation<br> 1152 denise.eckstein 1.1 <b>Required: </b>No. By default, the NET-SNMP include 1153 files are expected to be installed in directories that 1154 are searched by default (e.g., /usr/include). For platforms
1155 kumpf 1.12 where this isn't true, the PEGASUS_NET_SNMP_INCLUDE_DIR
1156 denise.eckstein 1.1 environment variable may be used to define an alternative path. 1157 This environment variable is only used if PEGASUS_USE_NET_SNMP 1158 is set.<br> 1159 </ul> 1160 1161 <h5>PEGASUS_NET_SNMP_LIB_DIR</h5> 1162 <ul> 1163 <b>Description: </b>Specifies the location of the NET-SNMP 1164 <i>lib </i>directory. <br> 1165 <b>Default Value: </b>Not Set<br> 1166 <b>Recommended Value (Development Build): </b> 1167 No Specific Recommendation<br> 1168 <b>Recommended Value (Release Build): </b> 1169 No Specific Recommendation<br> 1170 <b>Required: </b>No. By default, the NET-SNMP library is
1171 kumpf 1.12 expected to be installed in a directory that is searched by 1172 default (e.g., /usr/lib, /usr/lib64). For platforms where
1173 denise.eckstein 1.1 this isn't true, the PEGASUS_NET_SNMP_LIB_DIR environment 1174 variable may be used to define an alternative path. This 1175 environment variable is only used if PEGASUS_USE_NET_SNMP is set. 1176 </ul> 1177 1178 1179 <h5>PEGASUS_NOASSERTS</h5> 1180 <ul> 1181 <b>Description: </b>Defines the NDEBUG compilation macro, which
1182 marek 1.37 causes the preprocessor to remove PEGASUS_ASSERT() and disables assertion 1183 on PEGASUS_FCT_EXECUTE_AND_ASSERT statements.<br>
1184 denise.eckstein 1.1 <b>Default Value: </b>Not Set<br> 1185 <b>Recommended Value (Development Build): </b>Not Set<br> 1186 <b>Recommended Value (Release Build): </b>Set<br> 1187 <b>Required: </b>No<br> 1188 </ul> 1189 1190 <h5>PEGASUS_OPENSLP_HOME</h5> 1191 <ul>
1192 kumpf 1.12 <b>Description: </b>Specifies the location of the OpenSLP
1193 denise.eckstein 1.1 SDK directory. This directory must contain the OpenSLP 1194 <i>include</i> directory, $(PEGASUS_OPENSLP_HOME)/include, 1195 and the OpenSLP <i>library</i> directory, 1196 $(PEGASUS_OPENSLP_HOME)/lib.<br> 1197 <b>Default Value: </b>Not Set<br> 1198 <b>Recommended Value (Development Build): </b> 1199 No Specific Recommendation<br> 1200 <b>Recommended Value (Release Build): </b> 1201 No Specific Recommendation<br> 1202 <b>Required: </b>No. If not set, no additional include or 1203 library search paths will be included. 1204 <b>Considerations: </b>This value is not used if PEGASUS_USE_OPENSLP 1205 is not defined. <br> 1206 </ul> 1207 1208 <h5>PEGASUS_PAM_AUTHENTICATION</h5> 1209 <ul>
1210 kumpf 1.12 <b>Description: </b>Enables support for PAM-(Pluggable
1211 denise.eckstein 1.1 Authentication Modules) based authentication.<br> 1212 <b>Default Value: </b>Not Set<br> 1213 <b>Recommended Value (Development Build): </b>Set<br> 1214 <b>Recommended Value (Release Build): </b>Set<br> 1215 <b>Required: </b>No<br> 1216 <b>Considerations: </b>Support for PAM in OpenPegasus is 1217 dependent on platform support for PAM.<br> 1218 </ul> 1219 1220 <h5>PEGASUS_PLATFORM</h5> 1221 <ul> 1222 <b>Description: </b>Describes the target platform for the
1223 kumpf 1.12 build. The list of supported values for this variable 1224 is defined in pegasus/mak/config.mak.  Please refer to
1225 denise.eckstein 1.1 that file for a complete list of valid PEGASUS_PLATFORM 1226 values.  This document includes platform-specific configuration
1227 kumpf 1.12 data for only a subset of the supported platforms.  The
1228 denise.eckstein 1.1 following table describes the platforms documented in 1229 this version of the document. <br> 1230 <b>Default Value: </b>None<p> </p>
1231 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="542"> 1232 <tbody><tr> 1233 <th bgcolor="#cae6ca" width="190">Platform</th> 1234 <th bgcolor="#cae6ca" width="351">Recommended Value <br>
1235 denise.eckstein 1.1 Development Build</th>
1236 karl 1.29 <th bgcolor="#cae6ca" width="338">Recommended Value <br>
1237 denise.eckstein 1.1 Release Build</th> 1238 </tr> 1239 <tr align="center">
1240 karl 1.29 <td align="left" width="190">Linux IA32</td>
1241 denise.eckstein 1.1 <td width="351">LINUX_IX86_GNU</td> 1242 <td width="338">LINUX_IX86_GNU</td> 1243 </tr> 1244 <tr align="center">
1245 karl 1.29 <td align="left" width="190">Linux IA64</td>
1246 denise.eckstein 1.1 <td width="351">LINUX_IA64_GNU</td> 1247 <td width="338">LINUX_IA64_GNU</td> 1248 </tr> 1249 <tr align="center">
1250 karl 1.29 <td align="left" width="190">Linux X86_64</td>
1251 denise.eckstein 1.1 <td width="351">LINUX_X86_64_GNU</td> 1252 <td width="338">LINUX_X86_64_GNU</td> 1253 </tr> 1254 <tr align="center">
1255 karl 1.29 <td align="left" width="190">HP-UX PA-RISC</td>
1256 denise.eckstein 1.1 <td width="351">HPUX_PARISC_ACC</td> 1257 <td width="338">HPUX_PARISC_ACC</td> 1258 </tr> 1259 <tr align="center">
1260 karl 1.29 <td align="left" width="190">HP-UX IPF</td>
1261 denise.eckstein 1.1 <td width="351">HPUX_IA64_ACC</td> 1262 <td width="338">HPUX_IA64_ACC</td> 1263 </tr> 1264 <tr align="center">
1265 karl 1.29 <td align="left" width="190">OpenVMS Alpha</td>
1266 denise.eckstein 1.1 <td width="351">VMS_ALPHA_DECCXX</td> 1267 <td width="338">VMS_ALPHA_DECCXX</td> 1268 </tr> 1269 <tr align="center">
1270 karl 1.29 <td align="left" width="190">OpenVMS IA64</td>
1271 denise.eckstein 1.1 <td width="351">VMS_IA64_DECCXX</td> 1272 <td width="338"> VMS_IA64_DECCXX</td> 1273 </tr>
1274 karl 1.29 </tbody></table>
1275 denise.eckstein 1.1 <br><br> 1276 <b>Required: </b>Yes<br>
1277 kumpf 1.12 <b>Considerations: </b>The error "PEGASUS_PLATFORM 1278 environment variable undefined." is returned if the
1279 denise.eckstein 1.1 PEGASUS_PLATFORM environment variable is not set. 1280 </ul> 1281 1282 <h5>PEGASUS_REMOVE_METHODTRACE</h5> 1283 <ul> 1284 <b>Description: </b>If true, the CIM Server is compiled without 1285 method enter and exit trace statements.  Trace Level 5 will 1286 continue to be accepted as a valid trace level but, without the 1287 method enter and exit trace statements, it will be equivalent to
1288 kumpf 1.12 Trace Level 4. If PEGASUS_REMOVE_METHODTRACE is false or not set,
1289 denise.eckstein 1.1 method enter and exit trace statements are included.  All 1290 other values are considered invalid and will result in a build 1291 error.<br> 1292 <b>Default Value: </b>Not Set<br> 1293 <b>Recommended Value (Development Build): </b>Not Set (The 1294 Considerations section gives guidance on when a different 1295 decision would be made.)<br> 1296 <b>Recommended Value (Release Build): </b>Not Set (The 1297 Considerations section gives guidance on when a different 1298 decision would be made.)<br> 1299 <b>Required: </b>No<br> 1300 <b>Considerations: </b>This option completely removes the
1301 kumpf 1.12 method enter/exit trace statements from the generated object code. 1302 It defines the PEG_METHOD_ENTER and PEG_METHOD_EXIT macros
1303 denise.eckstein 1.1 to null statements. This helps to keep static code size small 1304 but reduces the serviceability of the CIM server.<br> 1305 </ul> 1306 1307 1308 <h5>PEGASUS_REPOSITORY_MODE</h5> 1309 <ul> 1310 <b>Description: </b>This variable defines the default mode 1311 used to create repositories that are constructed as part of the 1312 automated build tests.  It does not affect the runtime 1313 environment. Valid values include: XML (causes 1314 the repository to be built in XML mode); BIN (causes
1315 kumpf 1.12 the repository to be built in binary mode). Use cimconfig to
1316 denise.eckstein 1.1 modify the runtime environment.<br> 1317 <b>Default Value: </b>XML<br> 1318 <b>Recommended Value (Development Build): </b>XML<br> 1319 <b>Recommended Value (Release Build): </b>XML<br> 1320 <b>Required: </b>No<p> </p> 1321 </ul> 1322
1323 kumpf 1.2 <h5>PEGASUS_REPOSITORY_STORE_COMPLETE_CLASSES</h5> 1324 <ul> 1325 <b>Description: </b>This variable defines the default contents of a 1326 class definition in the repository store when a new repository is created. 1327 Specifically, when set to true, propagated elements are included in a 1328 class definition in the persistent store. The contents of a class 1329 definition returned from the repository interface is not affected by this 1330 option.<br> 1331 <b>Default Value: </b>false<br> 1332 <b>Recommended Value (Development Build): </b>false<br> 1333 <b>Recommended Value (Release Build): </b>false<br> 1334 <b>Required: </b>No<p> </p> 1335 <b>Considerations: </b>A repository which stores complete class 1336 definitions does not allow modifications to non-leaf classes or changes 1337 to a superclass designation. Complete classes use more storage space, 1338 often twice as much as local (incomplete) classes. Class retrieval may 1339 be more expensive when local classes are stored. No specific mechanism 1340 is available to change this setting in an existing repository.<br> 1341 </ul> 1342
1343 denise.eckstein 1.1 <h5>PEGASUS_SLP_REG_TIMEOUT</h5> 1344 <ul> 1345 <b>Description: </b>Most SLP implementations allow a lifetime 1346 value to be specified in the registration sent to the SLP SA or 1347 DA. The PEGASUS_SLP_REG_TIMEOUT build variable allows a lifetime 1348 (ie. timeout) value to be specified on the SLP registration, with 1349 a 're-registration' being sent to SLP at the same specified 1350 timeout interval. The purpose of this lifetime or timeout value
1351 kumpf 1.12 is to avoid the accumulation of stale service information
1352 denise.eckstein 1.1 in the SA or DA.<br> 1353 <b>Default Value: </b>Undefined<br> 1354 <b>Recommended Value (Development Build): </b>Undefined<br> 1355 <b>Recommended Value (Release Build): </b>Undefined<br> 1356 <b>Required: </b>No<p><b>Example: </b> 1357 PEGASUS_SLP_REG_TIME=1440 (ie. 24 hours or 1 day)<br> 1358 <b>Considerations: </b>(1) The OpenPegasus internal SLP 1359 implementation does not support timeout registrations. This 1360 build option is useful, for example, if PEGASUS_USE_OPENSLP is
1361 kumpf 1.12 defined. (2) Some SLP implementations may impose a
1362 denise.eckstein 1.1 maximum value for the lifetime parameter. For example, OpenSLP
1363 kumpf 1.12 limits this value to SLP_LIFETIME_MAXIMUM (or 0xFFFF), and
1364 denise.eckstein 1.1 if this maximum value is passed to OpenSLP, then the timeout 1365 feature is disabled. Refer to the documentation of your SLP 1366 implementation for more information. (3) OpenPegasus will not
1367 kumpf 1.12 do any validity checking on the specified value, either
1368 denise.eckstein 1.1 to determine if it is a valid positive integer or if it 1369 exceeds some maximum value.<br>
1370 karl 1.29 </p></ul>
1371 denise.eckstein 1.1 1372 <h5>PEGASUS_SNIA_EXTENSIONS</h5> 1373 <ul> 1374 <b>Description: </b> This variable is used to enable a 1375 set of workarounds that support the use of OpenPegasus 1376 in the SNIA Test Environment.<br> 1377 <b>Default Value: </b>Not Set<br> 1378 <b>Recommended Value (Development Build): </b>Not Set<br> 1379 <b>Recommended Value (Release Build): </b>Not Set<br> 1380 <b>Required: </b>No<br> 1381 <b>Considerations: </b>The functionality enabled with this 1382 variable is experimental and subject to change. 1383 </ul> 1384 1385 <h5>PEGASUS_SKIP_MOST_TEST_DIRS</h5> 1386 <ul> 1387 <b>Description: </b>If set to true, this variable can be used 1388 to reduce the time required to build OpenPegasus by significantly 1389 reducing the number of tests that are built.<br> 1390 <b>Default Value: </b>Not Set<br> 1391 <b>Recommended Value (Development Build): </b>Not Set<br> 1392 denise.eckstein 1.1 <b>Recommended Value (Release Build): </b>Not Set<br> 1393 <b>Required: </b>No<br> 1394 <b>Considerations: </b>Setting this variable to true 1395 affects the behavior of all recursive make targets (e.g., 1396 clean, depend, all, unittests, alltests, and slptests). 1397 Use of this variable with test-related targets (e.g., unittests,
1398 kumpf 1.12 alltests and slptests) can produce unexpected results.
1399 denise.eckstein 1.1 To avoid creating an inconsistent PEGASUS_HOME directory, 1400 the PEGASUS_HOME directory (i.e., the OpenPegasus build 1401 directory) should be removed prior to enabling or disabling 1402 this variable. This variable should not be used to characterize
1403 kumpf 1.12 the set of files to be packaged in a release build. Please
1404 denise.eckstein 1.1 refer to the Runtime Packaging Definition PEP for the release
1405 kumpf 1.12 for a recommended list of files to be included in a release.
1406 denise.eckstein 1.1 </ul> 1407 1408 <h5>PEGASUS_TEST_ENABLE_DEBUG_TRACE</h5> 1409 <ul> 1410 <b>Description: </b> 1411 This variable is only used for testing. If set to true,
1412 kumpf 1.12 Discarded data trace will be enabled by the install_run 1413 target of the src/Server/Makefile before running the
1414 denise.eckstein 1.1 OpenPegasus TestMakefile test suite. <br> 1415 <b>Default Value: </b>Not Set<br> 1416 <b>Recommended Value (Development Build): </b>Set<br> 1417 <b>Recommended Value (Release Build): </b>Not Set<br> 1418 <b>Required: </b>No<br> 1419 <b>Considerations: </b>
1420 kumpf 1.12 This variable is useful in certain test environments to 1421 explicitly enable tracing to aid in better troubleshooting and
1422 denise.eckstein 1.1 detection of test failures (E.g. Test systems are experiencing
1423 kumpf 1.12 test failures due to connection timeouts, lost indications
1424 denise.eckstein 1.1 etc).<br> 1425 </ul> 1426 1427 <h5>PEGASUS_TEST_ISGROUP_GROUP/PEGASUS_TEST_ISGROUP_USER_SUCCESS/PEGASUS_TEST_ISGROUP_USER_FAILURE</h5> 1428 <ul>
1429 kumpf 1.12 <b>Description: </b>These variables are only used for testing.
1430 denise.eckstein 1.1 These variables allow the developer to define a valid group name, 1431 PEGASUS_TEST_ISGROUP_GROUP, a valid user name that is in the 1432 group, PEGASUS_TEST_ISGROUP_USER_SUCCESS, and an a valid user 1433 name that is not in the group, PEGASUS_TEST_ISGROUP_USER_FAILURE.
1434 kumpf 1.12 These variables are only used for testing and NOT part of the
1435 denise.eckstein 1.1 release.<br>
1436 kumpf 1.12 <b>Default Value(Windows):</b>
1437 denise.eckstein 1.1 Administrator/Administrators/Guest<br> 1438 <b>Default Value(Non-Windows): </b>root/root/guest<br> 1439 <b>Recommended Value (Development Build): </b> 1440 No Recommendation<br> 1441 <b>Recommended Value (Release Build): </b>Not Used<br> 1442 <b>Required: </b>No 1443 </ul> 1444 1445 <h5>PEGASUS_TEST_IPV6</h5> 1446 <ul> 1447 <b>Description: </b>This variable is only used for 1448 testing.  If set to true, the IPv6-specific tests will
1449 karl 1.29 be run as part of the "alltests" OpenPegasus
1450 denise.eckstein 1.1 TestMakefile test suite. If this variable is not set or set to 1451 false,  the IPv6-specific tests will not be run.  All 1452 other values are invalid.<br>
1453 kumpf 1.12 <b>Default Value:  </b>If PEGASUS_TEST_IPV6 is not defined,
1454 denise.eckstein 1.1 PEGASUS_TEST_IPV6 is set to the value of PEGASUS_ENABLE_IPV6.<br> 1455 <b>Recommended Value (Development Build): </b>Set to the value 1456 of PEGASUS_ENABLE_IPV6<br> 1457 <b>Recommended Value (Release Build): </b>Not Used<br> 1458 <b>Required: </b>No<br>
1459 kumpf 1.12 <b>Considerations: </b>This variable is useful in certain
1460 denise.eckstein 1.1 test environments to explicitly disable running the IPv6
1461 kumpf 1.12 tests (e.g., when running an IPv6-enabled version of
1462 denise.eckstein 1.1 OpenPegasus on an an IPv4 system).<br> 1463 </ul> 1464 1465 <h5>PEGASUS_TEST_SDK</h5> 1466 <ul>
1467 kumpf 1.12 <b>Description: </b>This variable is only used for
1468 denise.eckstein 1.1 testing.  It is used to control testing of the SDK 1469 sample providers and clients. If set, the setup, building and
1470 kumpf 1.12 testing of the SDK samples is enabled as part of the
1471 denise.eckstein 1.1 OpenPegasus automated build and test.<br> 1472 <b>Default Value: </b>Not Set<br> 1473 <b>Recommended Value (Development Build): </b>Set<br> 1474 <b>Recommended Value (Release Build): </b>Not Used<br> 1475 <b>Required: </b>No 1476 </ul> 1477 1478 <h5>PEGASUS_TEST_USER_DEFINED</h5> 1479 <ul> 1480 <b>Description: </b>This variable is only used for testing. 1481 If this variable is set, the tests will assume that the 1482 PEGASUS_TEST_USER_ID and PEGASUS_TEST_USER_PASS variables
1483 kumpf 1.12 defines a valid user/password pair and can be used for
1484 denise.eckstein 1.1 certificate-based authentication testing.  These tests
1485 karl 1.29 also assumes that "invalidUser" is not a valid
1486 denise.eckstein 1.1 user.<br> 1487 <b>Default Value: </b>Not Set<br> 1488 <b>Recommended Value (Development Build): </b>Set<br> 1489 <b>Recommended Value (Release Build): </b>Not Used<br> 1490 <b>Required: </b>No 1491 </ul> 1492 1493 <h5>PEGASUS_TEST_USER_ID/PEGASUS_TEST_USER_PASS</h5> 1494 <ul> 1495 <b>Description: </b>These variables are only used for 1496 testing. These variables allow the developer to define a 1497 valid, non-privileged  user name and password 1498 on the test system that can be used as part of the OpenPegasus 1499 automated test scripts to perform authentication and 1500 authorization testing.  These variables are only used for 1501 testing and NOT part of the release.<br> 1502 <b>Default Value: </b>guest/guest<br> 1503 <b>Recommended Value (Development Build): </b> 1504 No Recommendation<br> 1505 <b>Recommended Value (Release Build): </b>Not Used<br> 1506 <b>Required: </b>No<br> 1507 denise.eckstein 1.1 </ul> 1508 1509 <h5>PEGASUS_TEST_VALGRIND_LOG_DIR</h5> 1510 <ul> 1511 <b>Description: </b> 1512 This variable is currently only supported on Linux. It may be
1513 kumpf 1.12 set to run regression tests under the
1514 denise.eckstein 1.1 <a href="http://www.valgrind.org/">Valgrind</a> memory 1515 checking tool. It must specify a directory for writing 1516 Valgrind log files. The file name format for a particular 1517 log is PEGASUS_TEST_VALGRIND_LOG_DIR/PROGRAM_NAME.pid.<br> 1518 <b>Default Value: </b>Not Set<br> 1519 <b>Recommended Value (Development Build): </b>Not Set<br> 1520 <b>Recommended Value (Release Build): </b>Not Set<br> 1521 <b>Required: </b>No<br> 1522 <b>Considerations: </b>This flag is only supported on Linux to 1523 enable running tests under Valgrind.<br> 1524 </ul> 1525 1526 <h5>PEGASUS_TMP</h5> 1527 <ul> 1528 <b>Description: </b>This variable is only used in a test 1529 environment. It can be used to define the directory that 1530 OpenPegasus test programs should use to store temporary files.<br> 1531 <b>Default Value: </b>"."<br> 1532 <b>Recommended Value (Development Build): </b> 1533 No Specific Recommendation<br> 1534 <b>Recommended Value (Release Build): </b>Not Used<br> 1535 denise.eckstein 1.1 <b>Required: </b>No<br> 1536 </ul> 1537 1538 <h5>PEGASUS_USE_DEBUG_BUILD_OPTIONS</h5> 1539 <ul> 1540 <b>Description: </b>The PEGASUS_DEBUG flag is used to control 1541 a variety of settings, including compile options, assertion
1542 kumpf 1.12 enablement, method definitions for testing, and diagnostic
1543 denise.eckstein 1.1 output.  The PEGASUS_USE_DEBUG_BUILD_OPTIONS variable
1544 kumpf 1.12 can be used to enable just the compiler specific debug options
1545 denise.eckstein 1.1 (e.g., -g in g++) .<br> 1546 <b>Default Value: </b>Not Set<br> 1547 <b>Recommended Value (Development Build): </b>Set<br> 1548 <b>Recommended Value (Release Build): </b>Not Set<br> 1549 <b>Required: </b>No<br> 1550 <b>Considerations: </b>This variable is automatically set 1551 if PEGASUS_DEBUG is set.<br> 1552 </ul> 1553 1554 <h5>PEGASUS_USE_EMANATE</h5> 1555 <ul> 1556 <b>Description: </b>EMANATE, 1557 <a href="http://www.snmp.com/products/emanate.html">
1558 kumpf 1.12 http://www.snmp.com/products/emanate.html</a>, is an SNMP Research 1559 International product that supports SNMPv1, SNMPv2c, and
1560 denise.eckstein 1.1 SNMPv3.  If the PEGASUS_USE_EMANATE variable is defined, 1561 the OpenPegasus SNMP Handler will use the EMANATE libraries
1562 kumpf 1.12 to send traps to the SNMP Management application.
1563 denise.eckstein 1.1 The EMANATE libraries are NOT included as part of OpenPegasus.<br> 1564 <b>Default Value: </b>Not Set<br> 1565 <b>Recommended Value (Development Build): </b>Not Set<br> 1566 <b>Recommended Value (Release Build): </b>Not Set<br> 1567 <b>Required: </b>No<p> 1568 <b>Considerations: </b>Either the PEGASUS_USE_NET_SNMP or
1569 kumpf 1.12 PEGASUS_USE_EMANATE variable must be set for the SNMP
1570 denise.eckstein 1.1 Handler to be supported.<br>
1571 karl 1.29 </p></ul>
1572 denise.eckstein 1.1 1573 1574 <h5>PEGASUS_USE_NET_SNMP</h5> 1575 <ul>
1576 kumpf 1.12 <b>Description: </b>NET-SNMP,
1577 denise.eckstein 1.1 <a href="http://net-snmp.sourceforge.net"> 1578 http://net-snmp.sourceforge.net</a>,  is an OSS 1579 implementation of a suite of applications used to implement 1580 <a href="http://www.ietf.org/rfc/rfc1157.txt">SNMP v1</a>, 1581 <a href="http://www.ietf.org/rfc/rfc1901.txt">SNMP v2c</a> and 1582 <a href="http://www.ietf.org/rfc/rfc2571.txt">SNMP v3</a> using
1583 kumpf 1.12 both IPv4 and IPv6.   If the PEGASUS_USE_NET_SNMP
1584 denise.eckstein 1.1 variable is defined, the OpenPegasus SNMP Handler will use 1585 the NET-SNMP libraries to send traps to the SNMP Management 1586 application.  The NET-SNMP libraries are NOT included 1587 as part of OpenPegasus.<br> 1588 <b>Default Value: </b>Not Set<br> 1589 <b>Recommended Value (Development Build): </b>Not Set<br>
1590 kumpf 1.12 <b>Recommended Value (Release Build): </b>true for Linux,
1591 denise.eckstein 1.1 false for all other platforms<br> 1592 <b>Required: </b>No<p>
1593 kumpf 1.12 <b>Considerations: </b>Either the PEGASUS_USE_NET_SNMP or 1594 PEGASUS_USE_EMANATE variable must be set for the SNMP
1595 denise.eckstein 1.1 Handler to be supported.<br>
1596 karl 1.29 </p></ul>
1597 denise.eckstein 1.1
1598 sahana.prabhakar 1.23 <h5>PEGASUS_ENABLE_NET_SNMPV3</h5> 1599 <ul> 1600 <b>Description: </b>If this variable is defined, 1601 then OpenPegasus SNMP Handler will build the SNMPV3 1602 features. This should be set to false if NET-SNMP 5.2 and lower 1603 libraries are used.<br> 1604 <b>Default Value: </b>true<br> 1605 <b>Recommended Value (Development Build): </b>true<br> 1606 <b>Recommended Value (Release Build): </b>true<br> 1607 <b>Required: </b>No<p> 1608 <b>Considerations: </b>PEGASUS_USE_NET_SNMP variable must 1609 be set.<br>
1610 karl 1.29 </p></ul>
1611 sahana.prabhakar 1.23 1612
1613 denise.eckstein 1.1 <h5>PEGASUS_USE_OPENSLP</h5> 1614 <ul> 1615 <b>Description: </b>OpenSLP, <a href="http://www.openslp.org">
1616 kumpf 1.12 http://openslp.org</a>, is an open-source implementation of
1617 denise.eckstein 1.1 Service Location Protocol. If the PEGASUS_USE_OPENSLP variable 1618 is defined, OpenPegasus will be built to use the OpenSLP 1619 implementation of SLP instead of the internal OpenPegasus 1620 implementation of SLP. The OpenSLP libaries are NOT included 1621 as part of OpenPegasus. 1622 <b>Default Value: </b>Not Set<br> 1623 <b>Recommended Value (Development Build): </b>Not Set<br> 1624 <b>Recommended Value (Release Build): </b>Not Set<br> 1625 <b>Required: </b>No<br> 1626 <b>Considerations: </b>PEGASUS_ENABLE_SLP must be defined 1627 if this variable is set. 1628 </ul> 1629 1630 <h5>PEGASUS_USE_PAM_STANDALONE_PROC</h5> 1631 <ul> 1632 <b>Description: </b>Moves the processing of PAM requests from 1633 the CIM Server process to a separate process managed by the 1634 CIM Server.<br> 1635 <b>Default Value: </b>Not Set<br> 1636 <b>Recommended Value (Development Build): </b>Set<br> 1637 <b>Recommended Value (Release Build): </b>Set<br> 1638 denise.eckstein 1.1 <b>Required: </b>No<br> 1639 <b>Considerations: </b>If PAM Authentication is enabled, 1640 the PAM API is used, during the processing of each request, to 1641 authenticate the client. This level of use makes the CIM Server 1642 extremely sensitive to memory leaks in the PAM library. In 1643 addition, certain PAM modules are not thread-safe. If your
1644 kumpf 1.12 platform is experiencing problems with PAM Authentication,
1645 denise.eckstein 1.1 use of option may provide a work-around. 1646 PEGASUS_USE_PAM_STANDALONE_PROC requires 1647 PEGASUS_PAM_AUTHENTICATION to be set.<br> 1648 </ul> 1649 1650 <h5>PEGASUS_USE_RELEASE_CONFIG_OPTIONS</h5> 1651 <ul> 1652 <b>Description: </b>If set, OpenPegasus is built using 1653 the "Release Build" configuration options. By default,
1654 karl 1.29 OpenPegasus is built using the "Development Build"
1655 denise.eckstein 1.1 configuration options.<br>
1656 s.kodali 1.19 <b>Default Value: </b>false<br> 1657 <b>Recommended Value (Development Build): </b>false<br> 1658 <b>Recommended Value (Release Build): </b>true<br>
1659 denise.eckstein 1.1 <b>Required: </b>No<br>
1660 kumpf 1.12 <b>Considerations: </b>(1)The 1661 PEGASUS_USE_RELEASE_CONFIG_OPTIONS variable allows a platform
1662 denise.eckstein 1.1 vendor to easily toggle between two sets of configurations 1663 options, a set of options tuned for the development/debug
1664 karl 1.29 ("Development Build") environment and a set of options
1665 denise.eckstein 1.1 tuned for the production environment ("Release Build").
1666 kumpf 1.12 Refer the section titled "Configuration Properties" for 1667 additional detail.  (2) For each configuration
1668 karl 1.29 variable,  the "Recommended Value (Release Build)"
1669 kumpf 1.12 value defines the recommended settings to use for a
1670 karl 1.29 "Release Build".  Please refer to the
1671 denise.eckstein 1.1 description of each variable for additional information. 1672 </ul> 1673 1674 <h5>PEGASUS_USE_RELEASE_DIRS</h5> 1675 <ul>
1676 kumpf 1.12 <b>Description: </b>If set, OpenPegasus is built using 1677 the "Release Build" directory definitions. By default,
1678 karl 1.29 OpenPegasus is built using the "Development Build"
1679 denise.eckstein 1.1 directory definitions.<br> 1680 <b>Default Value: </b>Not Set<br> 1681 <b>Recommended Value (Development Build): </b>Not Set<br> 1682 <b>Recommended Value (Release Build): </b>Set<br> 1683 <b>Required: </b>No<br>
1684 kumpf 1.12 <b>Considerations: </b>
1685 denise.eckstein 1.1 The PEGASUS_USE_RELEASE_DIRS variable allows a platform
1686 kumpf 1.12 vendor to easily toggle between two sets of directory 1687 definitions, a set tuned for the development/debug
1688 karl 1.29 ("Development Build") environment and a set tuned for the
1689 kumpf 1.12 production environment ("Release Build"). Refer the section
1690 denise.eckstein 1.1 titled "Configuration Properties" for additional detail.<br> 1691 </ul> 1692
1693 s.kodali 1.18 <h5>PEGASUS_FLAVOR</h5> 1694 <ul> 1695 <b>Description: </b> This variable is used for configuring Multi CIMOM 1696 on same OS by eliminating single point for storage of PID's and configuration 1697 files. Flavor is used in structuring the release dirs,configuration file names, 1698 log identity and PAM config file. 1699 If set, OpenPegasus is built using the flavor value. By default OpenPegasus is 1700 built using "tog" as the flavor. RPMs are named using the flavor value. 1701 <br> 1702 <b>Default Value: </b>tog<br> 1703 <b>Recommended Value (Development Build): </b>tog<br> 1704 <b>Recommended Value (Release Build): </b>tog<br> 1705 <b>Required: </b>No<br> 1706 <b>Considerations: </b> 1707 To build RPM using flavor, RPM spec file needs to be regenerated after setting the flavor value. 1708 This can be done using the create_OpenPegasusRPMSpecFile target in the Makefile.Release. 1709 Platforms have to define their own release dir structure using the flavor for release builds. 1710 An error will be reported if both PEGASUS_FLAVOR and PEGASUS_USE_RELEASE_DIRS are set and 1711 PEGASUS_OVERRIDE_DEFAULT_RELEASE_DIRS is not set. 1712 RPM build on linux defines PEGASUS_OVERRIDE_DEFAULT_RELEASE_DIRS by default. 1713 <br> 1714 s.kodali 1.18 </ul> 1715
1716 s.kodali 1.22 <h5>PEGASUS_PLATFORM_FOR_32BIT_PROVIDER_SUPPORT</h5> 1717 <ul> 1718 <b>Description: </b> Builds the Pegasus with 32-bit provider support for the specified platform. 1719 If this option is set, the value MUST be one of the 32-bit supported platforms by Pegasus. 1720 <br> 1721 <b>Default Value: </b>Not set<br> 1722 <b>Recommended Value (Development Build): </b>Not set<br> 1723 <b>Recommended Value (Release Build): </b>Not set<br> 1724 <b>Required: </b>No<br> 1725 <b>Considerations: </b> 1726 This option is used to run the 32-bit providers under 64-bit CIMserver. 1727 To register the 32-bit providers, register the provider module by setting the 1728 Bitness property value to "2". 32-bit Providers are always loaded out of process 1729 irrespective of forceProviderProcesses config option. 1730 <br> 1731 </ul> 1732
1733 kumpf 1.6 <h5>PEGASUS_USE_SQLITE_REPOSITORY</h5> 1734 <ul> 1735 <b>Description: </b>If true, new repository stores are created 1736 using a SQLite database. Existing file-based stores will continue 1737 to be recognized and operate seamlessly.<br> 1738 <b>Default Value: </b>false<br> 1739 <b>Recommended Value (Development Build): </b>true<br> 1740 <b>Recommended Value (Release Build): </b>true<br> 1741 <b>Required: </b>No<br> 1742 <b>Considerations: </b>If PEGASUS_USE_SQLITE_REPOSITORY is set to true 1743 and SQLite files are not installed in default search locations, 1744 SQLITE_HOME must also be configured. 1745 PEGASUS_REPOSITORY_STORE_COMPLETE_CLASSES may not be set to true when 1746 PEGASUS_USE_SQLITE_REPOSITORY is set to true. 1747 </ul> 1748
1749 denise.eckstein 1.1 <h5>PEGASUS_USE_SYSLOGS</h5> 1750 <ul> 1751 <b>Description: </b>If set, OpenPegasus will be built 1752 to send log messages to the system logger (syslog). 1753 Otherwise, log messages will be sent to OpenPegasus 1754 specific log files.<br> 1755 <b>Recommended Value (Development Build): </b>Set<br> 1756 <b>Recommended Value (Release Build): </b>Set<br> 1757 <b>Required: </b>No<br> 1758 <b>Considerations: </b>This variable is currently 1759 not implemented as an environment variable. To use 1760 the option -DPEGASUS_USE_SYSLOGS must 1761 be explicitly included in the appropriate platform 1762 makefile (pegasus/mak/platform_*.mak).</ul> 1763 1764 <h5>PEGASUS_WINDOWS_SDK_HOME</h5> 1765 <ul>
1766 kumpf 1.12 <b>Description: </b>This variable should be set to point 1767 to the Microsoft Platform SDK on Windows if using a compiler
1768 denise.eckstein 1.1 version < 1300 (i.e. VC6). If using VC7 or VC8, this flag 1769 does not need to be set, as the necessary libraries are already 1770 included.<br> 1771 <b>Recommended Value (Development Build): </b> 1772 No Specific Recommendation<br> 1773 <b>Recommended Value (Release Build): </b> 1774 No Specific Recommendation<br> 1775 <b>Required: </b>Yes, if building on Windows with a 1776 compiler version < 1300.<br> 1777 </ul> 1778
1779 kumpf 1.6 <h5>SQLITE_HOME</h5> 1780 <ul> 1781 <b>Description: </b>Specifies the location of the SQLite SDK directory. 1782 This directory must contain sqlite3.h in the $(SQLITE_HOME)/include 1783 directory, and libsqlite3 in the $(SQLITE_HOME)/lib directory.<br> 1784 <b>Default Value: </b>Not Set<br> 1785 <b>Recommended Value (Development Build): </b> 1786 No Specific Recommendation<br> 1787 <b>Recommended Value (Release Build): </b> 1788 No Specific Recommendation<br> 1789 <b>Required: </b>Yes, if PEGASUS_USE_SQLITE_REPOSITORY is set to true 1790 and the SQLite files are not installed in locations that are searched by 1791 default.<br> 1792 <b>Considerations: </b>This environment variable is only used if 1793 PEGASUS_USE_SQLITE_REPOSITORY is set to true. 1794 </ul> 1795
1796 marek 1.24 <h5>PEGASUS_INITIAL_THREADSTACK_SIZE</h5> 1797 <ul> 1798 <b>Description: </b>This environment variable sets the initial size 1799 of the stack on new threads. Value is specified in number of bytes.<br> 1800 <b>Default Value: </b>262144<br> 1801 <b>Recommended Value (Development Build): </b>262144<br> 1802 <b>Recommended Value (Release Build): </b>262144<br>
1803 karl 1.29 <b>Required: </b>No <p></p>
1804 marek 1.24 </ul> 1805
1806 denise.eckstein 1.1 <h4>Examples Building a Linux IA32 (#IA64) Development/Debug Version</h4> 1807 <ul> 1808 export PEGASUS_ROOT=/home/pegasusbld/pegasus<br>
1809 kumpf 1.12 export PEGASUS_HOME=/home/pegasusbld/pegasus/build<br>
1810 denise.eckstein 1.1 export PEGASUS_PLATFORM=LINUX_IX86_GNU<br>
1811 kumpf 1.12 #export PEGASUS_PLATFORM=LINUX_IA64_GNU<br> 1812 export PEGASUS_PAM_AUTHENTICATION=true<br>
1813 denise.eckstein 1.1 export PEGASUS_USE_PAM_STANDALONE_PROC=true<br>
1814 kumpf 1.12 export PEGASUS_HAS_SSL=yes<br>
1815 denise.eckstein 1.1 export PEGASUS_DEBUG=TRUE<br> 1816 export ENABLE_CMPI_PROVIDER_MANAGER=true<br>
1817 kumpf 1.12 export PEGASUS_USE_SYSLOGS=true<br>
1818 denise.eckstein 1.1 export PATH=/home/pegasusbld:/home/pegasusbld/pegasus/build/bin:/usr/local/bin:$PATH<br> 1819 </ul> 1820 1821 <h4>Building a Linux IA32 (#IA64) Production Release Version</h4> 1822 <ul> 1823 export PEGASUS_ROOT=/home/pegasusbld/pegasus<br> 1824 export PEGASUS_HOME=/home/pegasusbld/pegasus/build<br> 1825 export PEGASUS_PLATFORM=LINUX_IX86_GNU<br> 1826 #export PEGASUS_PLATFORM=LINUX_IA64_GNU<br>
1827 kumpf 1.16 export PEGASUS_ENABLE_CQL=false<br> 1828 export PEGASUS_PAM_AUTHENTICATION=true<br>
1829 denise.eckstein 1.1 export PEGASUS_USE_PAM_STANDALONE_PROC=true<br> 1830 export PEGASUS_HAS_SSL=yes<br> 1831 export PEGASUS_USE_RELEASE_CONFIG_OPTIONS=true<br>
1832 kumpf 1.12 export PEGASUS_USE_RELEASE_DIRS=true<br>
1833 denise.eckstein 1.1 export PEGASUS_NOASSERTS=true<br> 1834 export ENABLE_CMPI_PROVIDER_MANAGER=true<br> 1835 export PEGASUS_ENABLE_USERGROUP_AUTHORIZATION=true<br> 1836 export PEGASUS_USE_SYSLOGS=true<br> 1837 export PATH=/home/pegasusbld:/home/pegasusbld/pegasus/build/bin:/usr/local/bin:$PATH<br> 1838 </ul> 1839 1840 <h3>Environment Variable Settings for <u>Running</u> OpenPegasus</h3> 1841 1842 <h4>Definitions</h4> 1843 1844 <h5>PEGASUS_HOME</h5> 1845 <ul>
1846 kumpf 1.12 <b>Description: </b>There are multiple options for
1847 denise.eckstein 1.1 configuring the location of OpenPegasus runtime
1848 kumpf 1.12 files (e.g., configuration files, libraries,
1849 denise.eckstein 1.1 repository, executables). If no other option is 1850 specified, OpenPegasus will attempt to use the value 1851 PEGASUS_HOME.<br> 1852 <b>Default Value: </b>"."<br> 1853 <b>Recommended Value (Development Build): </b> 1854 The same value defined at build time.<br> 1855 <b>Recommended Value (Release Build): </b>Not Set<br> 1856 <b>Required: </b>No<br> 1857 <b>Considerations: </b>Although this variable can be 1858 useful in a development environment use of this environment 1859 variable is not recommended in a production environment. 1860 Instead, the use of configuration properties to explicitly 1861 set the location of runtime files and directories is recommended. 1862 </ul> 1863 1864 <h5>PEGASUS_MSG_HOME</h5> 1865 <ul> 1866 <b>Description: </b>This value is not used by the CIM 1867 Server.  The CIM Server uses the messageDir configuration 1868 parameter to locate the directory where the ICU resource bundles. 1869 However, CIM Client applications must rely on an alternative 1870 denise.eckstein 1.1 mechanism to locate this directory.<br>
1871 kumpf 1.12 <b>Default Value: </b>if $PEGASUS_HOME is set then
1872 karl 1.29 "$PEGASUS_HOME/msg" else "."<br>
1873 denise.eckstein 1.1 <b>Recommended Value (Development Build): </b>$PEGASUS_HOME/msg<br> 1874 <b>Recommended Value (Release Build): </b>Not Set <br> 1875 <b>Required: </b>No<br> 1876 </ul> 1877 1878 <h3>Configuration Properties</h3> 1879 1880 <h4>Notation</h4> 1881
1882 kumpf 1.12 <p>This section describes the notation used to define the
1883 denise.eckstein 1.1 configuration properties.</p> 1884 1885 <ul> 1886 1887 <h5>Default Value</h5> 1888 The value of <i>Default Value</i> is the OpenPegasus 1889 default setting for this configuration option. This 1890 value is used if a platform-specific setting is not
1891 kumpf 1.12 defined.
1892 denise.eckstein 1.1 1893 <h5>Recommended Default Value</h5>
1894 kumpf 1.12 The PEGASUS_USE_RELEASE_CONFIG_OPTIONS variable allows a 1895 platform vendor to easily toggle between two sets of
1896 denise.eckstein 1.1 configurations options, a set of options tuned for the
1897 karl 1.29 development/debug ("Development Build") environment
1898 denise.eckstein 1.1 and a set of options tuned for the production environment
1899 kumpf 1.12 ("Release Build"). The value of 1900 <i>Recommended Value (Development Build)</i>
1901 denise.eckstein 1.1 is the recommended default value for use in a development/
1902 kumpf 1.12 debug environment. The value of
1903 denise.eckstein 1.1 <i>Recommended Value (Release Build)</i> is the recommended
1904 kumpf 1.12 default value for use in a production environment. 1905
1906 denise.eckstein 1.1 <h5>Recommend To Be Fixed/Hidden</h5> 1907 Configuration options can be defined as fixed or hidden. 1908 A "fix" configuration option is set at build time
1909 kumpf 1.12 and cannot be changed without rebuilding. "Fixed"
1910 denise.eckstein 1.1 configuration options are not displayed using the cimconfig
1911 kumpf 1.12 command. This feature can be used by vendors to limit
1912 denise.eckstein 1.1 OpenPegasus functionality and configurability.
1913 kumpf 1.12 1914 A "hidden" configuration option is an option that is
1915 denise.eckstein 1.1 configurable (i.e., "not fixed"), but not externally 1916 advertised using the cimconfig command. The "hidden" 1917 feature can be used to define "internal use only" 1918 configuration options.
1919 kumpf 1.12
1920 denise.eckstein 1.1 <h5>Dynamic?</h5> 1921 If yes, the value of the configuration option can be 1922 changed without stopping and restarting the CIM Server. 1923 1924 <h5>Directory Specifications</h5> 1925 <p>Note that the variables included in the following table
1926 kumpf 1.12 (e.g., $LOGDIR) are for documentation purposes only and 1927 have been defined to simplify the description of the 1928 configuration options.  In particular,
1929 denise.eckstein 1.1 these variables DO NOT correspond to environment variables
1930 kumpf 1.12 implemented in the OpenPegasus code.  Default values 1931 for the following variables are platform
1932 denise.eckstein 1.1 and vendor dependent and not documented in this document.</p> 1933
1934 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" height="228" width="148"> 1935 <tbody><tr> 1936 <th bgcolor="#cae6ca" height="16" width="1"> </th>
1937 denise.eckstein 1.1 </tr> 1938 <tr align="center">
1939 karl 1.29 <td align="left" height="12" width="1">$LOGDIR</td>
1940 denise.eckstein 1.1 </tr> 1941 <tr align="center">
1942 karl 1.29 <td align="left" height="14" width="1">$PROVIDERDIRS</td>
1943 denise.eckstein 1.1 </tr> 1944 <tr align="center">
1945 karl 1.29 <td align="left" height="14" width="1">
1946 denise.eckstein 1.1 $PROVIDERMANAGERDIRS</td> 1947 </tr> 1948 <tr align="center">
1949 karl 1.29 <td align="left" height="14" width="1">$REPOSITORYDIR </td>
1950 denise.eckstein 1.1 </tr> 1951 <tr align="center">
1952 karl 1.29 <td align="left" height="14" width="1">$CERTIFICATEDIR
1953 denise.eckstein 1.1 </td> 1954 </tr> 1955 <tr align="center">
1956 karl 1.29 <td align="left" height="14" width="1">$LOCALAUTHDIR</td>
1957 denise.eckstein 1.1 </tr> 1958 <tr align="center">
1959 karl 1.29 <td align="left" height="14" width="1">$TRACEDIR</td>
1960 denise.eckstein 1.1 </tr> 1961 <tr align="center">
1962 karl 1.29 <td align="left" height="14" width="1">$CONFIGDIR</td>
1963 denise.eckstein 1.1 </tr> 1964 <tr align="center">
1965 karl 1.29 <td align="left" height="14" width="1">$PIDFILE</td>
1966 denise.eckstein 1.1 </tr> 1967 <tr align="center">
1968 karl 1.29 <td align="left" height="14" width="1">$RANDOMDIR</td>
1969 denise.eckstein 1.1 </tr> 1970 <tr align="center">
1971 karl 1.29 <td align="left" height="14" width="1">$SOCKETDIR</td>
1972 denise.eckstein 1.1 </tr> 1973 <tr align="center">
1974 karl 1.29 <td align="left" height="14" width="1">$MESSAGEDIR</td>
1975 denise.eckstein 1.1 </tr>
1976 karl 1.29 </tbody></table>
1977 kumpf 1.12 </ul>
1978 denise.eckstein 1.1 1979 <h4>Definitions</h4> 1980 1981 <h5>authorizedUserGroups</h5> 1982 <ul>
1983 kumpf 1.12 <b>Description:</b> If the <b>authorizedUserGroups</b>
1984 denise.eckstein 1.1 property is set, the value is interpreted as a list of 1985 comma-separated user groups whose members may issue CIM 1986 requests. A user who is not a member of any of these groups is 1987 restricted from issuing CIM requests, with the exception of 1988 privileged users (root user). If the <b>authorizedUserGroups</b> 1989 property is not set, any user may issue CIM requests.<br> 1990 <b>Default Value: </b>blank<br> 1991 <b>Recommended Default Value (Development Build): </b>blank<br> 1992 <b>Recommended Default Value (Release Build): </b>blank<br> 1993 <b>Recommend To Be Fixed/Hidden (Development Build): </b> 1994 No/No<br> 1995 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 1996 <b>Dynamic?: </b>No<br> 1997 <b>Example: </b> 1998 #cimconfig -s authorizedUserGroups=users,systemusers -p<br> 1999 <b>Considerations: </b>This feature is available only when 2000 the OpenPegasus source is compiled with the flag 2001 PEGASUS_ENABLE_USERGROUP_AUTHORIZATION set. 2002 </ul> 2003 2004 <h5>daemon</h5> 2005 denise.eckstein 1.1 <ul> 2006 <b>Description: </b>This option enables/disables forking of 2007 the code to create a background daemon process.<br> 2008 <b>Default Value: </b>true<br> 2009 <b>Recommended Default Value (Development Build): </b>true<br> 2010 <b>Recommended Default Value (Release Build): </b>true<br> 2011 <b>Recommend To Be Fixed/Hidden (Development Build): </b> 2012 No/No<br> 2013 <b>Recommend To Be Fixed/Hidden (Release Build): </b> 2014 No/Yes<br> 2015 <b>Dynamic?: </b>No<p> <br> 2016 <br>
2017 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2018 <tbody><tr> 2019 <th bgcolor="#cae6ca" width="168">Platform</th> 2020 <th bgcolor="#cae6ca" width="350">Source Configuration File</th>
2021 denise.eckstein 1.1 </tr> 2022 <tr align="center"> 2023 <td width="168">Linux</td> 2024 <td align="left" width="350"> 2025 Pegasus/Config/DefaultPropertyTableLinux.h</td> 2026 </tr> 2027 <tr align="center"> 2028 <td width="168">HP-UX</td> 2029 <td align="left" width="350"> 2030 Pegasus/Config/DefaultPropertyTableHpux.h</td> 2031 </tr> 2032 <tr align="center"> 2033 <td width="168">OpenVMS</td> 2034 <td align="left" width="350"> 2035 Pegasus/Config/DefaultPropertyTableVms.h</td> 2036 </tr>
2037 karl 1.29 </tbody></table> 2038 </p></ul>
2039 denise.eckstein 1.1 2040 <h5>enableAssociationTraversal</h5> 2041 <ul> 2042 <b>Description: </b>If true, the CIM Server will support
2043 kumpf 1.12 the four association traversal operators: Associators,
2044 denise.eckstein 1.1 AssociatorNames,References, and ReferenceNames.<br> 2045 <b>Default Value: </b>true<br> 2046 <b>Recommended Default Value (Development Build): </b>true<br> 2047 <b>Recommended Default Value (Release Build): </b>true<br> 2048 <b>Recommend To Be Fixed/Hidden (Development Build): </b> 2049 No/No<br> 2050 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2051 <b>Dynamic?: </b>No<br>
2052 kumpf 1.12 <b>Considerations: </b>There is still an outstanding
2053 denise.eckstein 1.1 Provider Registration issue that restricts the degree to 2054 which separate Providers can register for Associations.<br> 2055 <br>
2056 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2057 <tbody><tr> 2058 <th bgcolor="#cae6ca" width="168">Platform</th> 2059 <th bgcolor="#cae6ca" width="350">Source Configuration File</th>
2060 denise.eckstein 1.1 </tr> 2061 <tr align="center"> 2062 <td width="168">Linux</td> 2063 <td align="left" width="350"> 2064 Pegasus/Config/DefaultPropertyTableLinux.h</td> 2065 </tr> 2066 <tr align="center"> 2067 <td width="168">HP-UX</td> 2068 <td align="left" width="350"> 2069 Pegasus/Config/DefaultPropertyTableHpux.h</td> 2070 </tr> 2071 <tr align="center"> 2072 <td width="168">OpenVMS</td> 2073 <td align="left" width="350"> 2074 Pegasus/Config/DefaultPropertyTableVms.h</td> 2075 </tr>
2076 karl 1.29 </tbody></table>
2077 denise.eckstein 1.1 </ul> 2078 2079 <h5>enableAuditLog</h5> 2080 <ul>
2081 kumpf 1.12 <b>Description: </b>Used to enable or disable audit
2082 denise.eckstein 1.1 logging at run time. If true, audit logging will be enabled.<br> 2083 <b>Recommended Default Value (Development Build): </b>false<br> 2084 <b>Recommended Default Value (Release Build): </b>false<br> 2085 <b>Recommend To Be Fixed/Hidden (Development Build): </b> 2086 No/No<br> 2087 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2088 <b>Dynamic?: </b>Yes<br> 2089 <b>Source Configuration File: </b> 2090 Pegasus/Config/DefaultPropertyTable.h<br> 2091 </ul> 2092 2093 <h5>enableAuthentication</h5> 2094 <ul> 2095 <b>Description: </b>If true, a Client must be authenticated 2096 to access the CIM Server.<br> 2097 <b>Recommended Default Value (Development Build): </b>false<br> 2098 <b>Recommended Default Value (Release Build): </b>true<br> 2099 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2100 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 2101 <b>Dynamic?: </b>No<br> 2102 <b>Source Configuration File: </b> 2103 denise.eckstein 1.1 Pegasus/Config/SecurityPropertyOwner.cpp<br> 2104 </ul> 2105 2106 <h5>enableBinaryRepository</h5> 2107 <ul> 2108 <b>Description: </b>Setting this to true will activate the 2109 binary repository support on the next restart of cimserver.<br> 2110 <b>Recommended Default Value (Development Build): </b>false<br> 2111 <b>Recommended Default Value (Release Build): </b>false<br> 2112 <b>Recommend To Be Fixed/Hidden (Development Build): </b>Yes<br> 2113 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 2114 <b>Dynamic?: </b>No<br> 2115 <b>Considerations: </b>Repositories containing a mixture 2116 of binary and XML objects are supported.<br> 2117 <b>Source Configuration File: </b>
2118 karl 1.29 Pegasus/Config/RepositoryPropertyOwner.cpp<p></p>
2119 denise.eckstein 1.1 </ul> 2120 2121 2122 <h5>enableHttpConnection</h5> 2123 <ul> 2124 <b>Description: </b>If true, allows connections to 2125 the CIM Server using the HTTP protocol<br> 2126 <b>Default Value: </b>true<br> 2127 <b>Recommended Default Value (Development Build): </b>true<br> 2128 <b>Recommended Default Value (Release Build): </b>false<br> 2129 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2130 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2131 <b>Dynamic?: </b>No<br> 2132 <b>Considerations: </b>
2133 kumpf 1.12 Enabling HTTP will allow clients to connect with security 2134 properties different than those associated with encrypted SSL
2135 denise.eckstein 1.1 traffic, and its configured SSL authentication or other security 2136 behavior. This option should only be enabled in environments 2137 where sending the HTTP Request and HTTP Response as 2138 clear text messages does not introduce a security risk.
2139 kumpf 1.12 Note that if authentication is enabled (enableAuthentication), 2140 user names and passwords will be included in the text of the
2141 denise.eckstein 1.1 HTTP message.<br> 2142 <br>
2143 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2144 <tbody><tr> 2145 <th bgcolor="#cae6ca" width="168">Platform</th> 2146 <th bgcolor="#cae6ca" width="350">Source Configuration File</th>
2147 denise.eckstein 1.1 </tr> 2148 <tr align="center"> 2149 <td width="168">Linux</td> 2150 <td align="left" width="350"> 2151 Pegasus/Config/DefaultPropertyTableLinux.h</td> 2152 </tr> 2153 <tr align="center"> 2154 <td width="168">HP-UX</td> 2155 <td align="left" width="350"> 2156 Pegasus/Config/DefaultPropertyTableHpux.h</td> 2157 </tr> 2158 <tr align="center"> 2159 <td width="168">OpenVMS</td> 2160 <td align="left" width="350"> 2161 Pegasus/Config/DefaultPropertyTableVms.h</td> 2162 </tr>
2163 karl 1.29 </tbody></table>
2164 denise.eckstein 1.1 </ul> 2165 2166 <h5>enableHttpsConnection</h5> 2167 <ul>
2168 kumpf 1.12 <b>Description: </b>If true, allows connections to 2169 the CIM Server using the HTTPS protocol (HTTP using
2170 denise.eckstein 1.1 Secure Socket Layer encryption)<br> 2171 <b>Default Value: </b>false<br> 2172 <b>Recommended Default Value (Development Build): </b>true<br> 2173 <b>Recommended Default Value (Release Build): </b>true<br> 2174 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2175 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2176 <b>Dynamic?: </b>No<br> 2177 <b>Considerations: </b>For this option to work, 2178 the environment variable PEGASUS_HAS_SSL must have 2179 been set when CIM Server was built.<br> 2180 <br>
2181 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2182 <tbody><tr> 2183 <th bgcolor="#cae6ca" width="168">Platform</th> 2184 <th bgcolor="#cae6ca" width="350">Source Configuration File</th>
2185 denise.eckstein 1.1 </tr> 2186 <tr align="center"> 2187 <td width="168">Linux</td> 2188 <td align="left" width="350"> 2189 Pegasus/Config/DefaultPropertyTableLinux.h</td> 2190 </tr> 2191 <tr align="center"> 2192 <td width="168">HP-UX</td> 2193 <td align="left" width="350"> 2194 Pegasus/Config/DefaultPropertyTableHpux.h</td> 2195 </tr> 2196 <tr align="center"> 2197 <td width="168">OpenVMS</td> 2198 <td align="left" width="350"> 2199 Pegasus/Config/DefaultPropertyTableVms.h</td> 2200 </tr>
2201 karl 1.29 </tbody></table>
2202 denise.eckstein 1.1 </ul> 2203 2204 <h5>enableIndicationService</h5> 2205 <ul> 2206 <b>Description: </b>If true, the CIM Server will support 2207 CIM Indications.<br> 2208 <b>Default Value: </b>true<br> 2209 <b>Recommended Default Value (Development Build): </b>true<br> 2210 <b>Recommended Default Value (Release Build): </b>true<br> 2211 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2212 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2213 venkat.puvvada 1.15 <b>Dynamic?: </b>Yes/No<br> 2214 <b>Considerations: </b>When enableIndicationService is set to 2215 false dynamically, delete subscription requests are sent to all 2216 indication providers and indication related operations are 2217 not supported until indication service is re-enabled. Dynamic 2218 configuration facility is available only when Pegasus is compiled 2219 with PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT=true. Clients 2220 who wants to utilize the IndicationService services MUST check for 2221 CIM_IndicationService EnabledState and HealthState properties to know 2222 the current indication service state. For example, User can enumerate 2223 instances of CIM_IndicationService and there is exactly one instance 2224 of CIM_IndicationService returned. (Ex. using cimcli command 2225 'cimcli ei -n root/PG_InterOp CIM_IndicationService'). When requested state 2226 change(Enabled/Disabled) cannot be made because of timeout or some 2227 other exception IndicationService HealthState is set to "Degraded/Warning". 2228 For example, if user requested for indication service disable (by setting 2229 enableIndicationService=false), disable failed because of timeout or some 2230 other exception. Now service health state is set to "Degraded/Warning" 2231 and service EnabledState will remain enabled. User can now identify the 2232 faulty provider causing the timeout or any other problem and can take 2233 appropriate action. User can again request for service disable to recover 2234 venkat.puvvada 1.15 from degraded state. Similar sequence applies while enabling the indication 2235 service. Only difference is that service EnabledState is set to Enabled 2236 if exception or timeout happens. There is no automatic recovery from 2237 degraded state is available at present.<br>
2238 denise.eckstein 1.1 <br>
2239 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2240 <tbody><tr> 2241 <th bgcolor="#cae6ca" width="168">Platform</th> 2242 <th bgcolor="#cae6ca" width="350">Source Configuration File</th>
2243 denise.eckstein 1.1 </tr> 2244 <tr align="center"> 2245 <td width="168">Linux</td> 2246 <td align="left" width="350"> 2247 Pegasus/Config/DefaultPropertyTableLinux.h</td> 2248 </tr> 2249 <tr align="center"> 2250 <td width="168">HP-UX</td> 2251 <td align="left" width="350"> 2252 Pegasus/Config/DefaultPropertyTableHpux.h</td> 2253 </tr> 2254 <tr align="center"> 2255 <td width="168">OpenVMS</td> 2256 <td align="left" width="350"> 2257 Pegasus/Config/DefaultPropertyTableVms.h</td> 2258 </tr>
2259 karl 1.29 </tbody></table>
2260 denise.eckstein 1.1 </ul> 2261 2262 <h5>enableNamespaceAuthorization</h5> 2263 <ul> 2264 <b>Description: </b>If true, the CIM Server restricts
2265 kumpf 1.12 access to namespaces based on configured user authorizations 2266 [user authorizations may be configured using the cimauth
2267 denise.eckstein 1.1 command]<br> 2268 <b>Default Value: </b>false<br> 2269 <b>Recommended Default Value (Development Build): </b>false<br> 2270 <b>Recommended Default Value (Release Build): </b>false<br> 2271 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2272 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2273 <b>Dynamic?: </b>No<br> 2274 <b>Considerations: </b> 2275 This option offers limited functionality and, in most 2276 environments, expensive to administer. It's use is not 2277 recommended.<br> 2278 <b>Source Configuration File: </b> 2279 Pegasus/Config/SecurityPropertyOwner.cpp</ul> 2280 2281 <h5>enableNormalization</h5> 2282 <ul>
2283 kumpf 1.12 <b>Description: </b>If true, objects returned from instance
2284 denise.eckstein 1.1 providers are validated and normalized. <br> 2285 <b>Default Value: </b>true<br> 2286 <b>Recommended Default Value (Development Build): </b>true<br> 2287 <b>Recommended Default Value (Release Build): </b>false<br> 2288 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2289 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2290 kavita.gupta 1.7 <b>Dynamic?: </b>Yes<br>
2291 denise.eckstein 1.1 <b>Considerations: </b> 2292 <ul> 2293 <li>Any errors encountered during normalization result in a
2294 kumpf 1.12 CIMException with the status code set to CIM_ERR_FAILED 2295 and a meaningful, context specific error description
2296 denise.eckstein 1.1 (messages will be localized). Providers that catch the
2297 kumpf 1.12 exception have an opportunity to handle the error.
2298 denise.eckstein 1.1 Otherwise, the exception is passed to the Provider Manager
2299 kumpf 1.12 and becomes the response for that Provider.
2300 karl 1.29 </li><li>Provider Modules that are listed on the
2301 kumpf 1.12 excludeModulesFromNormalization 2302 configuration option are excluded from normalization.
2303 karl 1.29 </li><li>Since the concept of normalization is relatively new to
2304 denise.eckstein 1.1 OpenPegasus and it establishes and enforces rules for
2305 kumpf 1.12 objects returned by providers, it should only 2306 apply to providers written against the SDK in which it was
2307 denise.eckstein 1.1 introduced (or later). Therefore only Provider Modules that
2308 kumpf 1.12 have the following InterfaceType and InterfaceVersion 2309 combination will be subject to normalization:
2310 denise.eckstein 1.1 <ul>
2311 kumpf 1.12 <li>'C++Default' / 2.5.0 or greater
2312 karl 1.29 </li><li>'CMPI' / 2.0.0 or greater 2313 </li><li>'JMPI' / 1.0.0 or greater 2314 </li></ul> 2315 </li></ul>
2316 denise.eckstein 1.1 <b>Source Configuration File: </b> 2317 Pegasus/Config/NormalizationPropertyOwner.cpp<br> 2318 </ul> 2319 2320 2321 <h5>enableRemotePrivilegedUserAccess</h5> 2322 <ul>
2323 kumpf 1.12 <b>Description: </b>If true, the CIM Server allows
2324 denise.eckstein 1.1 access by a privileged user from a remote system<br> 2325 <b>Default Value: </b>true<br> 2326 <b>Recommended Default Value (Development Build): </b>true<br> 2327 <b>Recommended Default Value (Release Build): </b>true<br> 2328 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2329 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2330 <b>Dynamic?: </b>No<br> 2331 <b>Considerations: </b>Many management operations require 2332 privileged user access. Disabling remote access by
2333 kumpf 1.12 privileged user could significantly affect
2334 denise.eckstein 1.1 functionality.<br> 2335 <b>Source Configuration File: </b> 2336 Pegasus/Config/SecurityPropertyOwner.cpp<p> </p> 2337 </ul> 2338 2339 <h5>enableSubscriptionsForNonprivilegedUsers</h5> 2340 <ul> 2341 <b>Description: </b>If true, operations (create instance,
2342 kumpf 1.12 modify instance, delete instance, get instance, enumerate 2343 instances, enumerate instance names) on indication 2344 filter, listener destination, and subscription instances
2345 denise.eckstein 1.1 may be performed by non-privileged users. Otherwise, these 2346 operations may only be performed on these instances by 2347 privileged users.<br> 2348 <b>Default Value: </b>true<br> 2349 <b>Recommended Default Value (Development Build): </b>true<br> 2350 <b>Recommended Default Value (Release Build): </b>false<br> 2351 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2352 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2353 <b>Dynamic?: </b>No<br>
2354 kumpf 1.12 <b>Considerations: </b>This option has meaning only if
2355 denise.eckstein 1.1 enableIndicationService=true.<br> 2356 <b>Source Configuration File: </b> 2357 Pegasus/Config/SecurityPropertyOwner.cpp<p> </p> 2358 </ul> 2359 2360 <h5>excludeModulesFromNormalization</h5> 2361 <ul>
2362 kumpf 1.12 <b>Description: </b>If the excludeModulesfromNormalization 2363 property is set, the value is interpreted as a list of 2364 comma-separated Provider Module names (as specified in 2365 PG_ProviderModule.Name) to exclude from validation and
2366 denise.eckstein 1.1 normalization.<br>
2367 karl 1.29 <b>Default Value: </b>""<br>
2368 denise.eckstein 1.1 <b>Recommended Default Value (Development Build):</b>
2369 karl 1.29 ""<br>
2370 denise.eckstein 1.1 <b>Recommended Default Value (Release Build): </b>
2371 karl 1.29 ""<br>
2372 denise.eckstein 1.1 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2373 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2374 <b>Dynamic?: </b>No<br> 2375 <b>Considerations: </b>All objects managed by all 2376 providers will be excluded from validation and normalization 2377 if its module name appears in this list.<br> 2378 <b>Source Configuration File: </b> 2379 Pegasus/Config/NormalizationPropertyOwner.cpp 2380 </ul> 2381 2382 <h5>forceProviderProcesses</h5> 2383 <ul> 2384 <b>Description: </b>If true, the CIM Server runs Providers 2385 in separate processes rather than loading and calling Provider 2386 libraries directly within the CIM Server process.<br>
2387 kumpf 1.12 <b>Default Value: </b>Dependent on the value of
2388 denise.eckstein 1.1 PEGASUS_DEFAULT_ENABLE_OOP<br> 2389 <b>Recommended Default Value (Development Build):</b>true (HP-UX, 2390 Linux)<br> 2391 <b>Recommended Default Value (Release Build): </b>true (HP-UX, 2392 Linux)<br> 2393 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2394 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2395 <b>Dynamic?: </b>No<br> 2396 <b>Considerations: </b>In a dynamic, potentially multi-vendor,
2397 kumpf 1.12 environment, the ability to run Providers in separate processes 2398 can significantly increase the stability, maintainability and
2399 denise.eckstein 1.1 supportability of the overall solution.  Running Providers 2400 in separate process spaces: (1) helps isolate components (i.e.,
2401 kumpf 1.12 cimserver and Providers) from a catastrophic failure
2402 denise.eckstein 1.1 (segmentation faults, memory leaks) of a single Provider and (2) 2403 reduces the risk of accidental or malicious sharing of sensitive
2404 kumpf 1.12 data among Providers.  This benefit comes at a cost.  2405 Moving Providers out of the cimserver process increases
2406 denise.eckstein 1.1 communication costs and can significantly increase response 2407 time.  Actual results will vary, but it is common for 2408 response times to increase by a factor of 2.<br>
2409 kumpf 1.12 <b>Note 1: </b>When forceProviderProcesses is true, the CIM
2410 denise.eckstein 1.1 Server will load each Provider Module (i.e., library) into a 2411 separate process. Providers in different Provider Modules 2412 cannot depend on a communication mechanism that 2413 requires them to run in the same process space.<br>
2414 kumpf 1.12 <b>Note 2: </b>Although the catastrophic failure of an
2415 denise.eckstein 1.1 Out-Of-Process (OOP) Provider Module will not result in a 2416 failure of the CIM Server process, if the failed OOP Provider
2417 kumpf 1.12 Module included Indication Providers, Indications may be
2418 denise.eckstein 1.1 lost.  If logging is enabled, the CIM Server will log a 2419 message informing administrators of what happened and what 2420 corrective actions can be taken.<br> 2421 <br>
2422 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2423 <tbody><tr> 2424 <th bgcolor="#cae6ca" width="168">Platform</th> 2425 <th bgcolor="#cae6ca" width="350">
2426 denise.eckstein 1.1 Source Configuration File</th> 2427 </tr> 2428 <tr align="center"> 2429 <td width="168">Linux</td> 2430 <td align="left" width="350"> 2431 Pegasus/Config/DefaultPropertyTableLinux.h</td> 2432 </tr> 2433 <tr align="center"> 2434 <td width="168">HP-UX</td> 2435 <td align="left" width="350"> 2436 Pegasus/Config/DefaultPropertyTableHpux.h</td> 2437 </tr> 2438 <tr align="center"> 2439 <td width="168">OpenVMS</td> 2440 <td align="left" width="350"> 2441 Pegasus/Config/DefaultPropertyTableVms.h</td> 2442 </tr>
2443 karl 1.29 </tbody></table>
2444 denise.eckstein 1.1 </ul> 2445 2446 <h5>home</h5> 2447 <ul> 2448 <b>Description: </b>If set, this configuration option defines 2449 the runtime default value for PEGASUS_HOME.<br> 2450 <b>Default Value: </b>"./"<br> 2451 <b>Recommended Default Value (Development Build)</b>"./"<br> 2452 <b>Recommended Default Value (Release Build)""</b><br> 2453 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2454 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 2455 <b>Dynamic?: </b>No<p> <br> 2456 <br>
2457 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2458 <tbody><tr> 2459 <th bgcolor="#cae6ca" width="168">Platform</th> 2460 <th bgcolor="#cae6ca" width="350">Source Configuration File</th>
2461 denise.eckstein 1.1 </tr> 2462 <tr align="center"> 2463 <td width="168">Linux</td> 2464 <td align="left" width="350"> 2465 Pegasus/Config/DefaultPropertyTableLinux.h</td> 2466 </tr> 2467 <tr align="center"> 2468 <td width="168">HP-UX</td> 2469 <td align="left" width="350"> 2470 Pegasus/Config/DefaultPropertyTableHpux.h</td> 2471 </tr> 2472 <tr align="center"> 2473 <td width="168">OpenVMS</td> 2474 <td align="left" width="350"> 2475 Pegasus/Config/DefaultPropertyTableVms.h</td> 2476 </tr>
2477 karl 1.29 </tbody></table> 2478 </p></ul>
2479 denise.eckstein 1.1
2480 marek 1.34 <h5>hostname</h5> 2481 <ul> 2482 <b>Description: </b> Can be used to override the local system supplied 2483 hostname without domain the CIM Server is using to build objects. 2484 If not set, querying this configuration option will report 2485 the system supplied hostname and behavior is not changed.<br> 2486 Setting this value to a valid hostname on CIM Server startup or as 2487 planned value will force the server to assume the configured name as the 2488 local hosts name. Setting this allows the administrator to set the name 2489 that operations such as associator, reference etc. return with 2490 object paths.<br> 2491 In common setups it is not recommended to explicitly set this value. 2492 <br> 2493 <b>Usage scenarios: </b> The following scenarios in which changing the 2494 default value makes sense are known today:<br> 2495 1. The case where what the CIM Server shall return to clients for 2496 host name is NOT the name of the current host but some 2497 administrator defined name 2498 (ex. system behind a firewall or some redirector).<br> 2499 2. Embedded systems that have a system set hostname which is not 2500 valid and needs to be overridden by CIM administrator without 2501 marek 1.34 changing the actual IP configuration. 2502 <br> 2503 <b>Recommended Default Value (Development Build): </b> 2504 blank<br> 2505 <b>Recommended Default Value (Release Build): </b> 2506 blank<br> 2507 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2508 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2509 <b>Dynamic?: </b>No<br> 2510 <b>Considerations: </b> When setting this configuration option the option 2511 fullyQualifiedHostName should be adjusted too.<br> 2512 Providers returning the systems hostname in an 2513 instance property might return a different value then the CIM server is 2514 setting in the object path. hostnames explicitly set into the object 2515 paths by providers will not be overridden by the CIM Server to allow 2516 cross-namespace associations. 2517 <br> 2518 It is necessary to upgrade existing repositories using the repupgrade 2519 utility when upgrading from an OpenPegasus version less than 2.12. 2520 <br> 2521 <b>Source Configuration File: </b> 2522 marek 1.34 Pegasus/Config/DefaultPropertyOwner.cpp 2523 </ul> 2524 2525 <h5>fullyQualifiedHostName</h5> 2526 <ul> 2527 <b>Description: </b> Can be used to override the local system supplied 2528 fully qualified hostname (with domain) the CIM Server is using to build 2529 objects. 2530 If not set, querying this configuration option will report 2531 the system supplied fully qualified hostname and behavior is 2532 not changed.<br> 2533 Setting this value to a valid hostname on CIM Server startup or as 2534 planned value will force the server to assume the configured name as the 2535 local hosts name with domain. Setting this allows the administrator to 2536 set the name that indication operations and the CIM_ObjectManager 2537 assume for SystemName returned as instance and key properties.<br> 2538 In common setups it is not recommended to explicitly set this value. 2539 <br> 2540 <b>Usage scenarios: </b> The following scenarios in which changing the 2541 default value makes sense are known today:<br> 2542 1. The case where what the CIM Server shall return to clients for 2543 marek 1.34 SystemName is NOT the name of the current host but some 2544 administrator defined name 2545 (ex. system behind a firewall or some redirector).<br> 2546 2. Embedded systems that have a system set hostname which is not 2547 valid and needs to be overridden by CIM administrator without 2548 changing the actual IP configuration. 2549 <br> 2550 <b>Recommended Default Value (Development Build): </b> 2551 blank<br> 2552 <b>Recommended Default Value (Release Build): </b> 2553 blank<br> 2554 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2555 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2556 <b>Dynamic?: </b>No<br> 2557 <b>Considerations: </b> When setting this configuration option the option 2558 fullyQualifiedHostName should be adjusted too.<br> 2559 Providers returning the systems hostname in an 2560 instance property might return a different value then the CIM server is 2561 setting in SystemName. 2562 <br> 2563 It is necessary to upgrade existing repositories using the repupgrade 2564 marek 1.34 utility when upgrading from an OpenPegasus version less than 2.12. 2565 <br> 2566 <b>Source Configuration File: </b> 2567 Pegasus/Config/DefaultPropertyOwner.cpp 2568 </ul> 2569
2570 denise.eckstein 1.1 <h5>httpPort</h5> 2571 <ul>
2572 kumpf 1.12 <b>Description: </b>OpenPegasus first attempts to look up the
2573 denise.eckstein 1.1 port number for HTTP using getservbyname for the 'wbem-http'
2574 kumpf 1.12 service. The httpPort configuration setting is used only when the
2575 denise.eckstein 1.1 getservbyname lookup fails.<br> 2576 <b>Default Value: </b>blank<br> 2577 <b>Recommended Default Value (Development Build): </b>blank<br> 2578 <b>Recommended Default Value (Release Build): </b>5988<br> 2579 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2580 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 2581 <b>Dynamic?: </b>No<br>
2582 kumpf 1.12 <b>Considerations: </b>(1)The use of 5988 for WBEM HTTP is
2583 denise.eckstein 1.1 recommended by the DMTF. This port has been registered with 2584 <a href="http://www.iana.org/assignments/port-numbers"> 2585 IANA</a>. In a production environment, the recommendation is 2586 to use /etc/services to configure the value of this port. (2)
2587 kumpf 1.12 With the release of OpenPegasus 2.5, the default values for
2588 karl 1.29 httpPort was changed from 5988 to "". This
2589 denise.eckstein 1.1 change was made to allow the OpenPegasus to differentiate
2590 kumpf 1.12 between a default setting of 5988 and a customer-defined
2591 denise.eckstein 1.1 setting of 5988.  With this change,  if the port
2592 kumpf 1.12 number is explicitly set, the configured port will be used
2593 denise.eckstein 1.1 regardless of the settings in /etc/services. If no port number 2594 is specified, the server will continue to use the value in 2595 /etc/services.<br> 2596 <br>
2597 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2598 <tbody><tr> 2599 <th bgcolor="#cae6ca" width="168">Platform</th> 2600 <th bgcolor="#cae6ca" width="350">Source Configuration File</th>
2601 denise.eckstein 1.1 </tr> 2602 <tr align="center"> 2603 <td width="168">Linux</td> 2604 <td align="left" width="350"> 2605 Pegasus/Config/DefaultPropertyTableLinux.h</td> 2606 </tr> 2607 <tr align="center"> 2608 <td width="168">HP-UX</td> 2609 <td align="left" width="350"> 2610 Pegasus/Config/DefaultPropertyTableHpux.h</td> 2611 </tr> 2612 <tr align="center"> 2613 <td width="168">OpenVMS</td> 2614 <td align="left" width="350"> 2615 Pegasus/Config/DefaultPropertyTableVms.h</td> 2616 </tr>
2617 karl 1.29 </tbody></table>
2618 denise.eckstein 1.1 </ul> 2619 2620 <h5>httpsPort</h5> 2621 <ul> 2622 <b>Description: </b> 2623 OpenPegasus first attempts to look up the port number for HTTPS 2624 using getservbyname for the 'wbem-https' service. The httpsPort
2625 kumpf 1.12 configuration setting is used only when the getservbyname lookup
2626 denise.eckstein 1.1 fails.<br> 2627 <b>Default Value: </b>blank<br> 2628 <b>Recommended Default Value (Development Build): </b>blank<br> 2629 <b>Recommended Default Value (Release Build): </b>5989<br> 2630 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2631 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 2632 <b>Dynamic?: </b>No<br> 2633 <b>Considerations: </b>(1)The use of 5989 for WBEM HTTPS 2634 is recommended by the DMTF. This port has been registered with 2635 <a href="http://www.iana.org/assignments/port-numbers">IANA</a>.
2636 kumpf 1.12 In a production environment, the recommendation is to use
2637 denise.eckstein 1.1 /etc/services to configure the value of this port.(2)
2638 kumpf 1.12 With the release of OpenPegasus 2.5, the default values for
2639 karl 1.29 httpPort was changed from 5989 to "". This
2640 kumpf 1.12 change was made to allow the OpenPegasus to differentiate 2641 between a default setting of 5989 and a customer-defined
2642 denise.eckstein 1.1 setting of 5989.  With this change,  if the port number
2643 kumpf 1.12 is explicitly set, the configured port will be used regardless
2644 denise.eckstein 1.1 of the settings in /etc/services. If no port number is specified, 2645 the server will continue to use the value in /etc/services.<br> 2646 <br> 2647
2648 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2649 <tbody><tr> 2650 <th bgcolor="#cae6ca" width="168">Platform</th> 2651 <th bgcolor="#cae6ca" width="350">Source Configuration File</th>
2652 denise.eckstein 1.1 </tr> 2653 <tr align="center"> 2654 <td width="168">Linux</td> 2655 <td align="left" width="350"> 2656 Pegasus/Config/DefaultPropertyTableLinux.h</td> 2657 </tr> 2658 <tr align="center"> 2659 <td width="168">HP-UX</td> 2660 <td align="left" width="350"> 2661 Pegasus/Config/DefaultPropertyTableHpux.h</td> 2662 </tr> 2663 <tr align="center"> 2664 <td width="168">OpenVMS</td> 2665 <td align="left" width="350"> 2666 Pegasus/Config/DefaultPropertyTableVms.h</td> 2667 </tr>
2668 karl 1.29 </tbody></table>
2669 denise.eckstein 1.1 </ul> 2670 2671 <h5>idleConnectionTimeout</h5> 2672 <ul> 2673 <b>Description: </b>If set to a positive integer, this value 2674 specifies a minimum timeout value for idle client connections. 2675 If set to zero, idle client connections do not time out.<br> 2676 <b>Recommended Default Value (Development Build): </b>0<br> 2677 <b>Recommended Default Value (Release Build): </b>0<br> 2678 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2679 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2680 kavita.gupta 1.11 <b>Dynamic?: </b>Yes<br>
2681 denise.eckstein 1.1 <b>Considerations: </b>A client connection is considered 2682 idle when it is not in the process of sending a request and 2683 the CIM Server is not processing a request from that connection.
2684 kumpf 1.12 An idle connection timeout allows reclamation of the system
2685 denise.eckstein 1.1 resources allocated for idle CIM Server connections. Note that 2686 the CIM Server may allow an idle connection to persist longer
2687 kumpf 1.12 than the configured timeout value based on server activity. 2688 Some client applications may not behave correctly if a
2689 denise.eckstein 1.1 connection timeout is introduced. Client compatibility should be 2690 considered when configuring an idle connection timeout value.
2691 kumpf 1.12 The idle connection time is computed using the system clock.
2692 denise.eckstein 1.1 Thus, resetting the system clock may cause unexpected timeout
2693 kumpf 1.12 behavior.This config property can be changed dynamically. The
2694 kavita.gupta 1.11 changes will apply to all new and existing connections. <br>
2695 denise.eckstein 1.1 </ul> 2696
2697 venkat.puvvada 1.21 <h5>maxFailedProviderModuleRestarts</h5> 2698 <ul> 2699 <b>Description: </b>If set to a positive integer, this value 2700 specifies the number of times the failed provider module with 2701 indications enabled are restarted automatically before being 2702 moved to Degraded state. If set to zero, failed provider module 2703 is not restarted with indications enabled automatically and 2704 will be moved to Degraded state immediately.<br> 2705 <b>Recommended Default Value (Development Build): </b>3<br> 2706 <b>Recommended Default Value (Release Build): </b>3<br> 2707 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2708 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2709 <b>Dynamic?: </b>Yes<br> 2710 <b>Considerations: </b>This option controls the automatic 2711 re-enabling of the failed provider module with indications 2712 enabled. If the provider module with indications enabled fails 2713 very frequently, it affects the CIMServer normal operations because 2714 CIMServer would be busy with reloading the provider module every 2715 time it fails. This option would be helpful if the long running 2716 indication provider crashes and the management application want 2717 to receive the indications from the provider while provider fix 2718 venkat.puvvada 1.21 is being delivered. In case of provider module grouping, if one of 2719 the indication provider crashes, it affects all indication providers 2720 in the provider modules of the group. Note that this is the facility 2721 provided by the CIMServer for temporary recovery of the provider and 2722 the ultimate goal SHALL be fixing the faulty provider. 2723 </ul> 2724
2725 venkat.puvvada 1.27 <h5>maxIndicationDeliveryRetryAttempts</h5> 2726 <ul> 2727 <b>Description: </b> If set to a positive integer, this value 2728 defines the number of times that the indication service will 2729 try to deliver an indication to a particular listener destination. 2730 This does not effect the original delivery attempt, thus if set to 0, 2731 cimserver will only try to deliver the indication once.<br> 2732 <b>Recommended Default Value (Development Build): </b>3<br> 2733 <b>Recommended Default Value (Release Build): </b>3<br> 2734 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2735 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2736 <b>Dynamic?: </b>No<br> 2737 <b>Considerations: </b> This value is used to set the 2738 CIM_IndicationService.DeliveryRetryAttempts property. See 2739 CIM_IndicationService.DeliveryRetryAttempts property for more details. This 2740 option is supported only when PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT 2741 is defined.<br> 2742 <b>Source Configuration File: </b> 2743 Pegasus/Config/IndicationServicePropertyOwner.cpp<br> 2744 </ul> 2745 2746 venkat.puvvada 1.27 <h5>minIndicationDeliveryRetryInterval</h5> 2747 <ul> 2748 <b>Description: </b> If set to a positive integer, this value defines 2749 the minimal time interval in seconds for the indication service to wait 2750 before retrying to deliver an indication to a listener destination that 2751 previously failed. Cimserver may take longer due to QoS or other processing.<br> 2752 <b>Recommended Default Value (Development Build): </b>30<br> 2753 <b>Recommended Default Value (Release Build): </b>30<br> 2754 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2755 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2756 <b>Dynamic?: </b>No<br> 2757 <b>Considerations: </b> This value is used to initialize the property 2758 CIM_IndicationService.DeliveryRetryInterval. See 2759 CIM_IndicationService.DeliveryRetryInterval property for more details. This 2760 option is supported only when PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT 2761 is defined.<br> 2762 <b>Source Configuration File: </b> 2763 Pegasus/Config/IndicationServicePropertyOwner.cpp<br> 2764 </ul> 2765
2766 dev.meetei 1.33 <h5>listenAddress</h5> 2767 <ul> 2768 <b>Description: </b> Network interface where the cimserver 2769 should listen to for connections.For example listenAddress=All or 2770 listenAddress=121.12.33.112 or listenAddress=121.33.21.26,127.0.0.1, 2771 fe80::fe62:9346%eth0<br> 2772 <b>Recommended Default Value (Development Build): </b>All<br> 2773 <b>Recommended Default Value (Release Build): </b>No Specific suggestion<br> 2774 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2775 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2776 <b>Dynamic?: </b>No<br> 2777 <b>Considerations: </b>Default value of "All" will make cimserver to listen on all the network interfaces.<br> 2778 <b>Source Configuration File: </b> 2779 Pegasus/Config/DefaultPropertyOwner.cpp<br> 2780 </ul> 2781
2782 denise.eckstein 1.1 <h5>logdir</h5> 2783 <ul> 2784 <b>Description: </b>Specifies the name of the directory 2785 to be used for the OpenPegasus specific log files.<br> 2786 <b>Recommended Default Value (Development Build): </b>logs<br> 2787 <b>Recommended Default Value (Release Build): </b>$LOGDIR<br> 2788 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2789 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 2790 <b>Dynamic?: </b>Yes<br>
2791 kumpf 1.12 <b>Considerations: </b>This option is not supported if
2792 denise.eckstein 1.1 PEGASUS_USE_SYSLOGS is defined.<br> 2793 <b>Source Configuration File: </b> 2794 Pegasus/Config/LogPropertyOwner.cpp<br> 2795 </ul> 2796 2797 <h5>logLevel</h5> 2798 <ul>
2799 kumpf 1.12 <b>Description: </b>Defines the desired level of logging.
2800 denise.eckstein 1.1 Valid values include: TRACE, INFORMATION, WARNING, SEVERE, 2801 FATAL.<br> 2802 <b>Default Value: </b>"INFORMATION"<br> 2803 <b>Recommended Default Value (Development Build): </b> 2804 "INFORMATION"<br> 2805 <b>Recommended Default Value (Release Build): </b>"SEVERE"<br> 2806 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2807 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2808 <b>Dynamic?: </b>Yes<br> 2809 <b>Considerations: </b><br> 2810 <b>Source Configuration File: </b> 2811 Pegsus/Config/LogPropertyOwner.cpp<p> </p> 2812 </ul> 2813
2814 mreddy 1.3 <h5>maxLogFileSizeKBytes</h5> 2815 <ul>
2816 kumpf 1.12 <b>Description: </b>Specifies the maximum size of the logfile in Kilo
2817 mreddy 1.3 Bytes. If the logfile size exceeds maxLogFileSizeKBytes logfile will be pruned.<br> 2818 <b>Default Value: </b>32768<br> 2819 <b>Recommended Default Value (Development Build): </b> 32768<br> 2820 <b>Recommended Default Value (Release Build): </b>32768<br> 2821 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2822 <b>Recommend To Be Fixed/Hidden (Release Build):</b> No/No<br> 2823 <b>Dynamic?:</b> Yes<br> 2824 <b>Considerations:</b> This option is not supported if PEGASUS_USE_SYSLOGS is defined. Minimum accepted value is 32 KB. <br> 2825 <b>Source Configuration File:</b>  Pegsus/Config/LogPropertyOwner.cpp<p> </p> 2826 </ul>
2827 denise.eckstein 1.1 <h5>maxProviderProcesses</h5> 2828 <ul> 2829 <b>Description:</b> Limits the number of provider
2830 kumpf 1.12 processes (see 'forceProviderProcesses) that may run
2831 denise.eckstein 1.1 concurrently. A 'maxProviderProcesses' value of '0' indicates 2832 that the number of Provider Agent processes is unlimited<br> 2833 <b>Default Value: </b>0<br> 2834 <b>Recommended Default Value (Development Build):</b> 0<br> 2835 <b>Recommended Default Value (Release Build):</b> 0<br> 2836 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2837 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br>
2838 kavita.gupta 1.9 <b>Dynamic?: </b>Yes<br>
2839 kumpf 1.12 <b>Considerations: </b>Consider there are five provider processes 2840 already running and the maxProviderProcesses is dynamically changed to 2841 four. In this case though new provider processes will not be created
2842 kavita.gupta 1.9 but existing five will continue running<br>
2843 denise.eckstein 1.1 <br>
2844 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2845 <tbody><tr> 2846 <th bgcolor="#cae6ca" width="168">Platform</th> 2847 <th bgcolor="#cae6ca" width="350">
2848 denise.eckstein 1.1 Source Configuration File</th> 2849 </tr> 2850 <tr align="center"> 2851 <td width="168">Linux</td> 2852 <td align="left" width="350"> 2853 Pegasus/Config/DefaultPropertyTableLinux.h</td> 2854 </tr> 2855 <tr align="center"> 2856 <td width="168">HP-UX</td> 2857 <td align="left" width="350"> 2858 Pegasus/Config/DefaultPropertyTableHpux.h</td> 2859 </tr> 2860 <tr align="center"> 2861 <td width="168">OpenVMS</td> 2862 <td align="left" width="350"> 2863 Pegasus/Config/DefaultPropertyTableVms.h</td> 2864 </tr>
2865 karl 1.29 </tbody></table>
2866 denise.eckstein 1.1 </ul> 2867 2868 <h5>messageDir</h5> 2869 <ul> 2870 <b>Description: </b>Specifies the name of the directory to 2871 be used for the OpenPegasus translated messages.<br> 2872 <b>Default Value: </b>msg<br> 2873 <b>Recommended Default Value (Development Build): </b>msg<br> 2874 <b>Recommended Default Value (Release Build):</b> 2875 $MESSAGEDIR/msg<br> 2876 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2877 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 2878 <b>Dynamic?: </b>No<br> 2879 <b>Considerations: </b>Only used when message localization 2880 is enabled.  See PEGASUS_HAS_MESSAGES for details.<br> 2881 <b>Source Configuration File: </b> 2882 FileSystemPropertyOwner.cpp<br> 2883 </ul> 2884 2885 <h5>providerDir</h5> 2886 <ul>
2887 kumpf 1.12 <b>Description: </b>Specifies the names of the directories
2888 denise.eckstein 1.1 that contains Provider executables.<br> 2889 <b>Recommended Default Value (Development Build): </b>lib<br> 2890 <b>Recommended Default Value (Release Build): </b> 2891 $PROVIDERDIRS<br> 2892 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2893 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br>
2894 kavita.gupta 1.11 <b>Dynamic?: </b>Yes<br>
2895 denise.eckstein 1.1 <b>Considerations: </b>The CIM Server runs as a privileged 2896 user. And, since Providers run in the same process space as the
2897 kumpf 1.12 CIM Server, Providers also have privileged access to the
2898 karl 1.29 system. Allowing a registered Provider’s executable to be
2899 kumpf 1.12 replaced with malicious code would result in a critical
2900 denise.eckstein 1.1 security defect, giving a malicious user privileged access
2901 marek 1.34 to the system. Administrators are responsible for ensuring
2902 denise.eckstein 1.1 that only trusted Providers are loaded into providerDir. 2903 In order to simplify the management task associated with 2904 securing Provider executable, the value of providerDir can be 2905 fixed at build time (i.e., set to one or more fixed, well-known 2906 locations).<br> 2907 <b>Source Configuration File: </b> 2908 Pegasus/Config/FileSystemPropertyOwner.cpp<br> 2909 </ul>
2910 kumpf 1.12
2911 denise.eckstein 1.1 <h5>providerManagerDir</h5> 2912 <ul> 2913 <b>Description: </b>Specifies the name of the directory that 2914 contains the ProviderManager plugin libraries.<br> 2915 <b>Recommended Default Value (Development Build): </b>lib<br> 2916 <b>Recommended Default Value (Release Build): </b> 2917 $PROVIDERMANAGERDIRS<br> 2918 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2919 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 2920 <b>Dynamic?: </b>No<br> 2921 <b>Considerations: </b>Should be a dedicated directory to 2922 minimize inspection of non-applicable files. Additionally, 2923 since all calls to the providers go through the provider 2924 managers, the same care should be taken with regards to 2925 security for the provider manager directory, as for provider 2926 directories.<br> 2927 <b>Source Configuration File: </b> 2928 Pegasus/Config/FileSystemPropertyOwner.cpp<br>
2929 kumpf 1.12 </ul>
2930 denise.eckstein 1.1 2931 <h5>repositoryDir</h5> 2932 <ul>
2933 kumpf 1.12 <b>Description: </b>Specifies the name of the directory
2934 denise.eckstein 1.1 to be used for the OpenPegasus repository.<br> 2935 <b>Recommended Default Value (Development Build): </b>repository<br> 2936 <b>Recommended Default Value (Release Build): </b> 2937 $REPOSITORYDIR/repository<br> 2938 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2939 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 2940 <b>Dynamic?: </b>No<br> 2941 <b>Considerations: </b><br> 2942 <b>Source Configuration File: </b> 2943 Pegasus/Config/FileSystemPropertyOwner.cpp<p><br>
2944 karl 1.29 </p></ul>
2945 denise.eckstein 1.1 2946 <h5>repositoryIsDefaultInstanceProvider</h5> 2947 <ul>
2948 kumpf 1.12 <b>Description: </b>If true, the Repository functions 2949 as the Instance Provider for all classes for which there 2950 is not an explicitly registered Provider. This flag is 2951 also used to control the behavior of the repository when
2952 denise.eckstein 1.1 processing association operators.<br> 2953 <b>Recommended Default Value (Development Build): </b>true<br>
2954 kumpf 1.12 <b>Recommended Default Value (Release Build): </b>false<br>
2955 denise.eckstein 1.1 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2956 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br> 2957 <b>Dynamic?:  </b>No<br> 2958 <b>Considerations:  </b>This flag can be used to configure 2959 the CIM Server to allow the Repository to be used by CIM Clients 2960 and CIM Providers as a dynamic data store. The setting of this
2961 kumpf 1.12 flag will significantly affect CIM Server behavior as viewed 2962 by the CIM Client.<br> 2963 2964 The following issues should be considered when setting
2965 denise.eckstein 1.1 repositoryIsDefaultInstanceProvider=true: 2966 2967 <ul>
2968 kumpf 1.12 <li><b>Authorization.</b>  The repository has no
2969 denise.eckstein 1.1 concept of which users (or components) are authorized to 2970 perform which operations.</li>
2971 karl 1.29 <li><b>Appearance of instrumentation.</b>  A client application
2972 kumpf 1.12 cannot determine whether instrumentation exists for a 2973 given CIM class. For example,  imagine a client 2974 issues a CreateInstance operation on a Disk class
2975 denise.eckstein 1.1 for    which no provider is registered. 2976  The instance will be stored in the repository, and
2977 karl 1.29 the client gets a "success" response. Does that mean a
2978 denise.eckstein 1.1 disk device has been created on the server? Even worse,
2979 kumpf 1.12 when another client issues an EnumerateInstances
2980 denise.eckstein 1.1 operation, the spurious Disk instance is returned. 2981  With repositoryIsDefaultInstanceProvider=false, the
2982 kumpf 1.12 CreateInstance operation above would have returned a 2983 NOT_SUPPORTED error.</li>
2984 karl 1.29 <li><b>Potential for inconsistent data.</b>  Using the
2985 denise.eckstein 1.1 repository as a data cache increases the probability 2986 that a client will see stale or incorrect data. A
2987 kumpf 1.12 provider can better control the correlation
2988 denise.eckstein 1.1 between the data returned and the current state of the
2989 kumpf 1.12 underlying managed resource (whether or not the provider
2990 denise.eckstein 1.1 caches the data).</li> 2991 </ul> 2992 <br>
2993 kumpf 1.12 2994 The following issues should be considered when setting
2995 denise.eckstein 1.1 repositoryIsDefaultInstanceProvider=false: 2996 2997 <ul> 2998 <li><b>Provider Availability.</b> Certain Providers have been
2999 kumpf 1.12 developed to use the Repository as a dynamic data store. 3000 These Providers are currently not supported on system
3001 denise.eckstein 1.1 where this flag is disabled. E.g., the Common Diagnostics
3002 kumpf 1.12 Model (CDM) Provider
3003 denise.eckstein 1.1 (http://developer.intel.com/design/servers/cdm/)
3004 kumpf 1.12 relies on use of the Repository to store instances 3005 of CIM_DiagnosticSetting.  If this flag set to 3006 false, this Provider will not function correctly. Note 3007 that this feature is supported by other WBEM
3008 denise.eckstein 1.1 implementation.  Therefore, disabling this feature 3009 can increase the cost of migrating existing Providers to 3010 OpenPegasus.</li>
3011 kumpf 1.12 </ul>
3012 denise.eckstein 1.1
3013 kumpf 1.12 <b>Source Configuration File: </b>
3014 denise.eckstein 1.1 Pegasus/Config/RepositoryPropertyOwner.cpp<br> 3015 </ul>
3016 kumpf 1.12
3017 denise.eckstein 1.1 <h5>shutdownTimeout</h5> 3018 <ul> 3019 <b>Description: </b>When a cimserver -s shutdown command is 3020 issued, specifies the maximum time in seconds for the CIM Server 3021 to complete outstanding CIM operation requests before shutting 3022 down; if the specified timeout period expires, the CIM Server
3023 kumpf 1.12 will shut down, even if there are still CIM operations in
3024 denise.eckstein 1.1 progress. Minimum value is 2 seconds.<br> 3025 <b>Recommended Default Value (Development Build): </b>10<br> 3026 <b>Recommended Default Value (Release Build): </b>10<br> 3027 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3028 <b>Recommend To Be Fixed/Hidden (Release Build):</b>No/No<br> 3029 <b>Dynamic?: </b>Yes<br> 3030 <b>Considerations: </b><br> 3031 <b>Source Configuration File: </b> 3032 Pegasus/Config/ShutdownPropertyOwner.cpp<br> 3033 </ul> 3034 3035 <h5>slp</h5> 3036 <ul> 3037 <b>Description: </b>When set to true, OpenPegasus activates 3038 an SLP SA and issues DMTF defined SLP advertisements to this SA 3039 on startup.<br> 3040 <b>Default Value: </b>false<br> 3041 <b>Recommended Default Value (Development Build): </b>false<br> 3042 <b>Recommended Default Value (Release Build): </b>false<br> 3043 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3044 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 3045 denise.eckstein 1.1 <b>Dynamic?: </b>No<p> <br> 3046 <br>
3047 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" height="80" width="531"> 3048 <tbody><tr> 3049 <th bgcolor="#cae6ca" height="16" width="168">Platform</th> 3050 <th bgcolor="#cae6ca" height="16" width="350">
3051 denise.eckstein 1.1 Source Configuration File</th> 3052 </tr> 3053 <tr align="center">
3054 karl 1.29 <td height="14" width="168">Linux</td> 3055 <td align="left" height="14" width="350">
3056 denise.eckstein 1.1 Pegasus/Config/DefaultPropertyTableLinux.h</td> 3057 </tr> 3058 <tr align="center">
3059 karl 1.29 <td height="14" width="168">HP-UX</td> 3060 <td align="left" height="14" width="350">
3061 denise.eckstein 1.1 Pegasus/Config/DefaultPropertyTableHpux.h</td> 3062 </tr> 3063 <tr align="center">
3064 karl 1.29 <td height="16" width="168">OpenVMS</td> 3065 <td align="left" height="16" width="350">
3066 denise.eckstein 1.1 Pegasus/Config/DefaultPropertyTableVms.h</td> 3067 </tr>
3068 karl 1.29 </tbody></table> 3069 </p></ul>
3070 denise.eckstein 1.1
3071 marek 1.36 <h5>slpProviderStartupTimeout</h5> 3072 <ul> 3073 <b>Description: </b>Timeout value in milli seconds used to specify 3074 how long the registration with an SLP SA may take. Registration will be 3075 retried three times. This value only needs to be increased in case that 3076 the loading of a set of providers who reporting their implementation of a 3077 registered profile takes very long.<br> 3078 <b>Default Value: </b>300000<br> 3079 <b>Recommended Default Value (Development Build): </b>300000<br> 3080 <b>Recommended Default Value (Release Build): </b>300000<br> 3081 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3082 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 3083 <b>Dynamic?: </b>No<p> <br> 3084 <br> 3085 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" height="80" width="531"> 3086 <tbody><tr> 3087 <th bgcolor="#cae6ca" height="16" width="168">Platform</th> 3088 <th bgcolor="#cae6ca" height="16" width="350"> 3089 Source Configuration File</th> 3090 </tr> 3091 <tr align="center"> 3092 marek 1.36 <td height="14" width="168">Linux</td> 3093 <td align="left" height="14" width="350"> 3094 Pegasus/Config/DefaultPropertyTable.h</td> 3095 </tr> 3096 <tr align="center"> 3097 <td height="14" width="168">HP-UX</td> 3098 <td align="left" height="14" width="350"> 3099 Pegasus/Config/DefaultPropertyTable.h</td> 3100 </tr> 3101 <tr align="center"> 3102 <td height="16" width="168">OpenVMS</td> 3103 <td align="left" height="16" width="350"> 3104 Pegasus/Config/DefaultPropertyTable.h</td> 3105 </tr> 3106 </tbody></table> 3107 </p></ul> 3108
3109 denise.eckstein 1.1 <h5>socketWriteTimeout</h5> 3110 <ul> 3111 <b>Description: </b>If the CIM Server receives an 3112 EWOULDBLOCK/EAGAIN error on a non-blocking write,
3113 kumpf 1.12 socketWriteTimeout defines the number of seconds the 3114 CIM Server will wait for the socket to get ready and resume
3115 denise.eckstein 1.1 writing data.<br> 3116 <b>Recommended Default Value (Development Build): </b> 3117 20 (seconds)<br> 3118 <b>Recommended Default Value (Release Build): </b> 3119 20 (seconds)<br> 3120 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3121 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
3122 kavita.gupta 1.11 <b>Dynamic?: </b>Yes<br> 3123 <b>Considerations: </b>Any changes made to this config property
3124 kumpf 1.12 dynamically will apply to new CIM Server connections only
3125 kavita.gupta 1.11 keeping old already established connections unchanged.<br>
3126 denise.eckstein 1.1 <b>Source Configuration File: </b> 3127 Pegasus/Config/DefaultPropertyTable.h 3128 </ul> 3129 3130 <h5>sslCertificateFilePath</h5> 3131 <ul>
3132 kumpf 1.12 <b>Description: </b>Contains the CIM Server SSL
3133 denise.eckstein 1.1 Certificate.<br> 3134 <b>Recommended Default Value (Development Build): </b> 3135 server.pem<br> 3136 <b>Recommended Default Value (Release Build): </b> 3137 $CERTIFICATEDIR/server.pem"<br> 3138 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3139 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 3140 <b>Dynamic?: </b>No<br> 3141 <b>Considerations: </b>For a more detailed look at SSL options 3142 and their ramifications, please see the SSL guidelines.<br> 3143 <b>Source Configuration File: </b> 3144 Pegasus/Config/SecurityPropertyOwner.cpp 3145 </ul> 3146
3147 rohini.deshpande 1.28 <h5>sslCipherSuite</h5> 3148 <ul> 3149 <b>Description: </b>String containing OpenSSL cipher 3150 specifications to configure the cipher suite the client is 3151 permitted to negotiate with the server during the SSL 3152 handshake phase.<br> 3153 <b>Recommended Default Value (Development Build): </b> 3154 DEFAULT (the default cipher list of OpenSSL)<br> 3155 <b>Recommended Default Value (Release Build): </b> 3156 DEFAULT (the default cipher list of OpenSSL)<br> 3157 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3158 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 3159 <b>Dynamic?: </b>No<br> 3160 <b>Considerations: </b>The value should be mentioned between 3161 single quotes since it can contain special characters like .+, 3162 !, -.. For more details look at SSL ciphers.<br> 3163 <b>Source Configuration File: </b> 3164 Pegasus/Config/SecurityPropertyOwner.cpp 3165 </ul> 3166
3167 denise.eckstein 1.1 <h5>sslClientVerificationMode</h5> 3168 <ul> 3169 <b>Description: </b>Describes the desired level of support 3170 for certificate-based authentication.
3171 karl 1.29 <ul style="margin-top: 0in;" type="circle"> 3172 <li>“<b>required</b>” – The server requires certificate-based
3173 kumpf 1.12 client authentication.  A client MUST present a
3174 denise.eckstein 1.1 trusted certificate in order to access the CIM Server.
3175 kumpf 1.12 If the client fails to send a certificate or sends an
3176 denise.eckstein 1.1 untrusted certificate, the connection will be rejected.</li>
3177 karl 1.29 <li>“<b>optional</b>” – The server supports, but does not
3178 kumpf 1.12 require, certificate-based client authentication. The 3179 server will request and attempt to validate a client
3180 denise.eckstein 1.1 certificate, however the connection will be accepted even 3181 if no certificate is sent or an untrusted certificate is 3182 sent.  The server will then seek to authenticate the 3183 client via an authentication header.</li>
3184 karl 1.29 <li>“<b>disabled</b>” – The server does not support
3185 denise.eckstein 1.1 certificate-based client authentication.</li> 3186 </ul> 3187 <b>Recommended Default Value (Development Build): </b> 3188 disabled<br> 3189 <b>Recommended Default Value (Release Build): </b> 3190 disabled<br> 3191 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3192 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 3193 <b>Dynamic?: </b>No<br> 3194 <b>Considerations: </b>(1) This property is only used if
3195 karl 1.29 <b>enableHttpsConnection</b> is <b>"true"</b>.
3196 denise.eckstein 1.1 (2) If the platform does not support PEGASUS_LOCAL_DOMAIN_SOCKET, 3197 OpenPegasus attempts to use either HTTPS or
3198 kumpf 1.12 HTTP to establish a local connection (connectLocal).
3199 denise.eckstein 1.1 For platforms that do not support PEGASUS_LOCAL_DOMAIN_SOCKET,
3200 kumpf 1.12 Clients which use connectLocal, such as cimconfig -l -c,
3201 denise.eckstein 1.1 cimprovider -l -s and cimserver -s, will not work if  the
3202 karl 1.29 "sslClientVerificationMode" variable is set to 3203 "required" and HTTP is disabled.  For these
3204 kumpf 1.12 platforms, the recommended course of action is to change the
3205 karl 1.29 property value to "optional."<br>
3206 denise.eckstein 1.1 <b>Source Configuration File: </b> 3207 Pegasus/Config/SecurityPropertyOwner.cpp 3208 </ul> 3209 3210 <h5>sslKeyFilePath</h5> 3211 <ul> 3212 <b>Description: </b>Contains the private key for the CIM 3213 Server SSL Certificate.<br> 3214 <b>Recommended Default Value (Development Build): </b> 3215 file.pem<br> 3216 <b>Recommended Default Value (Release Build): </b> 3217 $CERTIFICATEDIR/file.pem<br> 3218 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3219 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 3220 <b>Dynamic?: </b>No<br> 3221 <b>Considerations: </b>File should be readable only by the 3222 user the cimserver is running as and/or privileged users. The 3223 file should be writeable only by a privileged user.<br> 3224 <b>Source Configuration File: </b> 3225 Pegasus/Config/SecurityPropertyOwner.cpp<br> 3226 </ul> 3227 denise.eckstein 1.1 3228 <h5>sslTrustStore</h5> 3229 <ul> 3230 <b>Description: </b>Specifies the location of the OpenSSL
3231 kumpf 1.12 truststore. Consistent with the OpenSSL implementation, a
3232 denise.eckstein 1.1 truststore can be either a file or directory. If the truststore
3233 kumpf 1.12 is a directory, all the certificates within the directory are
3234 denise.eckstein 1.1 considered trusted.<br> 3235 <b>Recommended Default Value (Development Build): </b> 3236 client.pem<br> 3237 <b>Recommended Default Value (Release Build): </b> 3238 $CERTIFICATEDIR/client.pem<br> 3239 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3240 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 3241 <b>Dynamic?: </b>No<br> 3242 <b>Source Configuration File: </b> 3243 Pegsus/Config/SecurityPropertyOwner.cpp 3244 </ul> 3245 3246 <h5>sslTrustStoreUserName</h5> 3247 <ul> 3248 <b>Description: </b>Specifies the system user name to be 3249 associated with all certificate-based authenticated requests.<br> 3250 <b>Recommended Default Value (Development Build): </b>NONE<br> 3251 <b>Recommended Default Value (Release Build): </b>NONE<br> 3252 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3253 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 3254 <b>Dynamic?: </b>No<br> 3255 denise.eckstein 1.1 <b>Considerations: </b>This property has no default; for
3256 kumpf 1.12 security reasons, the system administrator must explicitly
3257 denise.eckstein 1.1 specify this value.  This feature allows a single user 3258 name to be specified.  This user will be associated 3259 with all certificates in the truststore.  In the future, 3260 OpenPegasus will allow a system administrator to associate a 3261 distinct user name with each certificate.<br> 3262 <b>Source Configuration File: </b> 3263 Pegsus/Config/SecurityPropertyOwner.cpp<br> 3264 </ul> 3265 3266 <h5>traceComponents</h5> 3267 <ul> 3268 <b>Description: </b>Defines the components to be traced.<br> 3269 <b>Default Value: </b>""<br> 3270 <b>Recommended Default Value (Development Build): </b>""<br> 3271 <b>Recommended Default Value (Release Build): </b>""<br> 3272 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3273 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br> 3274 <b>Dynamic?: </b>Yes<br> 3275 <b>Source Configuration File: </b> 3276 Pegasus/Config/TracePropertyOwner.cpp<br> 3277 </ul> 3278 denise.eckstein 1.1 3279 <h5>traceFacility</h5> 3280 <ul>
3281 kumpf 1.12 <b>Description: </b>Defines the desired facility for trace
3282 karl 1.29 messages. Valid values include: "File" 3283 , "Log" and "Memory" .<br>
3284 denise.eckstein 1.1 <b>Default Value: </b>File<br> 3285 <b>Recommended Default Value (Development Build): </b>File<br> 3286 <b>Recommended Default Value (Release Build): </b>File<br> 3287 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3288 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br> 3289 <b>Dynamic?: </b>Yes<br> 3290 <b>Case Sensitive?: </b>No<br>
3291 karl 1.29 <b>Considerations: </b>If you specify "File",
3292 kumpf 1.12 trace messagesare written into the file specified by the
3293 denise.eckstein 1.1 configuration option traceFilePath. If you specify
3294 karl 1.29 "Log", trace messages are written to the
3295 marek 1.14 OpenPegasus Log. If you specify Memory, the trace messages 3296 are collected in a wrap-around memory buffer. 3297 If this memory is part of a dump the trace messages can be
3298 karl 1.29 found by the eye-catcher "PEGASUSMEMTRACE" at
3299 marek 1.14 the top of the memory buffer. The trace is in clear text and
3300 karl 1.29 the last written message has the suffix "EOTRACE".<br>
3301 denise.eckstein 1.1 <b>Source Configuration File: </b> 3302 Pegasus/Config/TracePropertyOwner.cpp<br> 3303 </ul> 3304 3305 <h5>traceFilePath</h5> 3306 <ul> 3307 <b>Description: </b>Specifies the location of the 3308 OpenPegasus trace file.<br> 3309 <b>Default Value: </b>cimserver.trc<br> 3310 <b>Recommended Default Value (Development Build):</b> 3311 cimserver.trc<br> 3312 <b>Recommended Default Value (Release Build): </b> 3313 $TRACEDIR/cimserver.trc<br> 3314 <b>Recommend To Be Fixed/Hidden (Development Build):</b>No/No<br> 3315 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 3316 <b>Dynamic?: </b>Yes<br> 3317 <b>Source Configuration File: </b> 3318 Pegasus/Config/TracePropertyOwner.cpp<br> 3319 </ul> 3320 3321 <h5>traceLevel</h5> 3322 denise.eckstein 1.1 <ul>
3323 karl 1.29 <b>Description: </b>Defines the desired level of
3324 denise.eckstein 1.1 tracing. Valid values include: 0, 1, 2, 3, 4, 5.<br> 3325 <b>Default Value: </b>0<br> 3326 <b>Recommended Default Value (Development Build): </b>0<br>
3327 karl 1.29 <b>Recommended Default Value (Release Build): </b>0<<br>
3328 denise.eckstein 1.1 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3329 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br> 3330 <b>Dynamic?: </b>Yes<br> 3331 <b>Source Configuration File: </b> 3332 Pegasus/Config/TracePropertyOwner.cpp<br> 3333 </ul> 3334
3335 marek 1.14 <h5>traceMemoryBufferKbytes</h5> 3336 <ul> 3337 <b>Description: </b>Defines the size of the buffer for 3338 in memory tracing in kbytes ( 2<sup>10</sup> bytes ). 3339 Smallest value is 16.<br> 3340 <b>Default Value: </b>10240<br> 3341 <b>Recommended Default Value (Development Build): </b>10240<br> 3342 <b>Recommended Default Value (Release Build): </b>10240<br> 3343 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3344 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 3345 <b>Dynamic?: </b>No<br> 3346 <b>Case Sensitive?: </b>No<br> 3347 <b>Considerations: </b>Is ignored if configuration 3348 property traceFacility is not set to Memory.<br> 3349 <b>Source Configuration File: </b> 3350 Pegasus/Config/TracePropertyOwner.cpp<br> 3351 </ul> 3352
3353 amit99shah 1.38 <h5>traceFileSizeKBytes</h5> 3354 <ul> 3355 <b>Description: </b>Defines the size of the tracefile in Kilo bytes. The trace file will be 3356 rolled once its size exceeds the specified size. <br> 3357 <b>Default Value: </b>1048576<br> 3358 <b>Recommended Default Value (Development Build): </b>1048576<br> 3359 <b>Recommended Default Value (Release Build): </b>1048576<br> 3360 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3361 <b>Recommend To Be Fixed/Hidden (Release Build):</b> No/Yes<br> 3362 <b>Dynamic?:</b> Yes<br> 3363 <b>Considerations:</b>Minimum accepted value is 10240 KB,Maximum accepted value is 2097152 KB.  <br> 3364 <b>Source Configuration File:</b>  Pegsus/Config/TracePropertyOwner.cpp<p> </p> 3365 </ul> 3366 3367 <h5>numberOfTraceFiles</h5> 3368 <ul> 3369 <b>Description: </b>Specifies the number of the tracefiles for rolling.<br> 3370 <b>Default Value: </b>3<br> 3371 <b>Recommended Default Value (Development Build): </b>3<br> 3372 <b>Recommended Default Value (Release Build): </b>3<br> 3373 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3374 amit99shah 1.38 <b>Recommend To Be Fixed/Hidden (Release Build):</b> No/Yes<br> 3375 <b>Dynamic?:</b> Yes<br> 3376 <b>Considerations:</b>Minimum accepted value is 3,Maximum accepted value is 20.  <br> 3377 <b>Source Configuration File:</b>  Pegsus/Config/TracePropertyOwner.cpp<p> </p> 3378 </ul> 3379
3380 denise.eckstein 1.1 <h3>Configuration Constants</h3> 3381 3382 <h4>Definitions</h4> 3383 3384 <h5>static char CURRENT_CONFIG_FILE [] = </h5> 3385 <ul> 3386 <b>Description: </b>Default file name for the current 3387 configuration file.<br> 3388 <b>Recommended Default Value (Development Build):</b> 3389 cimserver_current.conf<br> 3390 <b>Recommended Default Value (Release Build): </b> 3391 $CONFIGDIR/cimserver_current.conf<br> 3392 <b>Dynamic?: </b>No <br> 3393 <br>
3394 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 3395 <tbody><tr> 3396 <th bgcolor="#cae6ca" width="168">Platform</th> 3397 <th bgcolor="#cae6ca" width="350">
3398 denise.eckstein 1.1 Source Configuration File</th> 3399 </tr> 3400 <tr align="center"> 3401 <td width="168">Linux</td> 3402 <td align="left" width="350"> 3403 Pegasus/Config/ConfigFileDirLinux.h</td> 3404 </tr> 3405 <tr align="center"> 3406 <td width="168">HP-UX</td> 3407 <td align="left" width="350">ConfigFileDirHpux.h</td> 3408 </tr> 3409 <tr align="center"> 3410 <td width="168">OpenVMS</td> 3411 <td align="left" width="350"> 3412 Pegasus/Config/ConfigFileDirVms.h</td> 3413 </tr>
3414 karl 1.29 </tbody></table>
3415 denise.eckstein 1.1 </ul> 3416 3417 <h5>static char PLANNED_CONFIG_FILE [] = </h5> 3418 <ul>
3419 kumpf 1.12 <b>Description: </b>Default file name for the planned
3420 denise.eckstein 1.1 configuration file.<br> 3421 <b>Recommended Default Value (Development Build): </b> 3422 cimserver_planned.conf<br> 3423 <b>Recommended Default Value (Release Build): </b> 3424 $CONFIGDIR/cimserver_planned.conf<br> 3425 <b>Dynamic?: </b>No<br> 3426 <br>
3427 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 3428 <tbody><tr> 3429 <th bgcolor="#cae6ca" width="168">Platform</th> 3430 <th bgcolor="#cae6ca" width="350">
3431 denise.eckstein 1.1 Source Configuration File</th> 3432 </tr> 3433 <tr align="center"> 3434 <td width="168">Linux</td> 3435 <td align="left" width="350"> 3436 Pegasus/Config/ConfigFileDirLinux.h</td> 3437 </tr> 3438 <tr align="center"> 3439 <td width="168">HP-UX</td> 3440 <td align="left" width="350"> 3441 Pegasus/Config/ConfigFileDirHpux.h</td> 3442 </tr> 3443 <tr align="center"> 3444 <td width="168">OpenVMS</td> 3445 <td align="left" width="350"> 3446 Pegasus/Config/ConfigFileDirVms.h</td> 3447 </tr>
3448 karl 1.29 </tbody></table>
3449 denise.eckstein 1.1 </ul> 3450 3451 <h5>static char CIMSERVER_START_FILE [] = </h5> 3452 <ul> 3453 <b>Description: </b>This is for the default file name 3454 for the cimserver startup file containing the PID.<br> 3455 <b>Default Value: </b>/tmp/cimserver_start.conf<br> 3456 <b>Recommended Default Value (Development Build): </b> 3457 /tmp/cimserver_start.conf<br> 3458 <b>Recommended Default Value (Release Build): </b> 3459 $PIDFILE<br> 3460 <b>Dynamic?: </b>No<br> 3461 <br>
3462 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 3463 <tbody><tr> 3464 <th bgcolor="#cae6ca" width="168">Platform</th> 3465 <th bgcolor="#cae6ca" width="350">
3466 denise.eckstein 1.1 Source Configuration File</th> 3467 </tr> 3468 <tr align="center"> 3469 <td width="168">Linux</td> 3470 <td align="left" width="350"> 3471 Pegasus/Config/ConfigFileDirLinux.h</td> 3472 </tr> 3473 <tr align="center"> 3474 <td width="168">HP-UX</td> 3475 <td align="left" width="350"> 3476 Pegasus/Config/ConfigFileDirHpux.h</td> 3477 </tr> 3478 <tr align="center"> 3479 <td width="168">OpenVMS</td> 3480 <td align="left" width="350"> 3481 Pegasus/Config/ConfigFileDirVms.h</td> 3482 </tr>
3483 karl 1.29 </tbody></table>
3484 denise.eckstein 1.1 </ul> 3485 3486 <h3>Configuration Macros</h3> 3487 3488 <h4>Definitions</h4> 3489 3490 <h5>PEGASUS_SSLCLIENT_CERTIFICATEFILE</h5> 3491 <ul> 3492 <b>Description: </b><br> 3493 <b>Recommended Default Value (Development Build): </b>client.pem<br> 3494 <b>Recommended Default Value (Release Build): </b> 3495 $CERTIFICATEDIR/client.pem<br> 3496 <b>Dynamic?: </b>No<br> 3497 <b>Source Configuration File: </b> 3498 Pegasus/Common/Constants.h<br> 3499 </ul> 3500 3501 <h5>PEGASUS_SSLCLIENT_RANDOMFILE</h5> 3502 <ul> 3503 <b>Description: </b>On platforms that do not support
3504 kumpf 1.12 /dev/random or /dev/urandom, OpenSSL will use this file to 3505 seed the PRNG (Pseudo-Random Number Generator). This 3506 PEGASUS_SSLCLIENT_RANDOMFILE defines the default CIM
3507 denise.eckstein 1.1 Client random file.<br> 3508 <b>Recommended Default Value (Development Build):</b>ssl.rnd<br> 3509 <b>Recommended Default Value (Release Build):</b> 3510 $RANDOMDIR/ssl.rnd<br> 3511 <b>Dynamic?: </b>No<br> 3512 <b>Considerations: </b>Use of this variable requires
3513 kumpf 1.12 PEGASUS_HAS_SSL to be set.  CIM Client use of a
3514 denise.eckstein 1.1 shared random file is not recommended.  On systems where 3515 /dev/random or /dev/urandom are not available, CIM Clients are
3516 kumpf 1.12 encouraged to generate a unique random file which
3517 denise.eckstein 1.1 contains sufficient entropy.<br> 3518 <b>Source Configuration File: </b> 3519 Pegasus/Common/Constants.h<br> 3520 </ul> 3521 3522 <h5>PEGASUS_SSLSERVER_RANDOMFILE</h5> 3523 <ul>
3524 kumpf 1.12 <b>Description: </b>On platforms that do not support 3525 /dev/random or /dev/urandom, OpenSSL will use this file 3526 to seed the PRNG (Pseudo-Random Number Generator). This 3527 PEGASUS_SSLSERVER_RANDOMFILE defines the CIM Server
3528 denise.eckstein 1.1 random file.<br> 3529 <b>Recommended Default Value (Development Build): </b> 3530 cimserver.rnd<br> 3531 <b>Recommended Default Value (Release Build): </b> 3532 $RANDOMDIR/cimserver.rnd<br> 3533 <b>Dynamic?: </b>No<br> 3534 <b>Considerations: </b>1)Use of this variable 3535 requires  PEGASUS_HAS_SSL to be set.(2) On systems where
3536 kumpf 1.12 /dev/random or /dev/urandom are not available, CIM Server 3537 vendors need to be sure that the cimserver.rnd file
3538 denise.eckstein 1.1 contains sufficient entropy and is uniquely generated for 3539 each system.<br> 3540 <b>Source Configuration File: </b> 3541 Pegasus/Common/Constants.h<b><br>
3542 karl 1.29 </b></ul>
3543 denise.eckstein 1.1
3544 karl 1.29 <h5><b>PEGASUS_LOCAL_AUTH_DIR</b></h5>
3545 denise.eckstein 1.1 <ul>
3546 karl 1.29 <b> <b>Description:</b> </b>For local connections (i.e.,
3547 kumpf 1.12 connectLocal), OpenPegasus uses a file-based authentication
3548 denise.eckstein 1.1 mechanism.<br> 3549 <b>Recommended Default Value (Development Build): </b>/tmp<br> 3550 <b>Recommended Default Value (Release Build): </b> 3551 $LOCALAUTHDIR/localauth<br> 3552 <b>Dynamic?: </b>No<br> 3553 <b>Source Configuration File: </b> 3554 Pegasus/Common/Constants.h<br> 3555 </ul> 3556 3557 <h5>PEGASUS_LOCAL_DOMAIN_SOCKET_PATH</h5> 3558 <ul> 3559 <b>Description: </b><br> 3560 <b>Recommended Default Value (Development Build): </b> 3561 /tmp/cimxml.socket<br> 3562 <b>Recommended Default Value (Release Build): </b> 3563 $SOCKETDIR/cimxml.socket<br> 3564 <b>Dynamic?: </b>No<br> 3565 <b>Source Configuration File: </b> 3566 Pegasus/Common/Constants.h<br> 3567 </ul> 3568 3569 denise.eckstein 1.1 <hr>
3570 martin 1.13 <p>Licensed to The Open Group (TOG) under one or more contributor license 3571 agreements. Refer to the OpenPegasusNOTICE.txt file distributed with 3572 this work for additional information regarding copyright ownership. 3573 Each contributor licenses this file to you under the OpenPegasus Open 3574 Source License; you may not use this file except in compliance with the 3575 License.</p> 3576 <p>Permission is hereby granted, free of charge, to any person obtaining a 3577 copy of this software and associated documentation files (the "Software"), 3578 to deal in the Software without restriction, including without limitation 3579 the rights to use, copy, modify, merge, publish, distribute, sublicense, 3580 and/or sell copies of the Software, and to permit persons to whom the 3581 Software is furnished to do so, subject to the following conditions:</p> 3582 <p>The above copyright notice and this permission notice shall be included 3583 in all copies or substantial portions of the Software.</p> 3584 <p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 3585 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 3586 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 3587 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 3588 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 3589 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 3590 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
3591 denise.eckstein 1.1 <hr>
3592 anusha.kandepu 1.32 </body></html>

No CVS admin address has been configured