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

No CVS admin address has been configured