pegasus/doc/BuildAndReleaseOptions.html - annotate

Return to BuildAndReleaseOptions.html CVS log

Up to [Pegasus] / pegasus / doc

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

No CVS admin address has been configured