pegasus/doc/BuildAndReleaseOptions.html - annotate

Return to BuildAndReleaseOptions.html CVS log

Up to [Pegasus] / pegasus / doc

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

No CVS admin address has been configured