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 dl.meetei 1.40 <b>Default Value: </b>CIM236 (Note that this may change as newer versions of the CIM Schema are used as the default.<br>
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 <h5>PEGASUS_ENABLE_REMOTE_CMPI</h5> 881 <ul> 882 <b>Description: </b>If set, a version of OpenPegasus that 883 support Remote CMPI providers and their dependent components 884 is built.<br> 885 <b>Default Value: </b>Not Set<br> 886 <b>Recommended Value (Development Build): </b>Not Set<br> 887 <b>Recommended Value (Release Build): </b>Not Set<br>
888 karl 1.29 <b>Required: </b>No<p></p>
889 denise.eckstein 1.1 </ul> 890 891 <h5>PEGASUS_ENABLE_SLP</h5> 892 <ul> 893 <b>Description: </b>This variable controls of the inclusion 894 of SLP functionality in the OpenPegasus build. When this 895 environment variable is set to 'true', SLP functionality will be
896 kumpf 1.12 included as part of the OpenPegasus build.  If
897 denise.eckstein 1.1 this variable is set to 'false' or not set, the SLP functionality 898 will not be included.  All other values are considered 899 invalid and will result in a build error
900 karl 1.29 (e.g., "PEGASUS_ENABLE_SLP ($(PEGASUS_ENABLE_SLP)) invalid, 901 must be true or false").<br>
902 denise.eckstein 1.1 <b>Default Value: </b>'true' for Windows; 'false' for all other 903 Platforms<br> 904 <b>Recommended Value (Development Build): </b>'true' for 905 Windows; 'false' for all other Platforms<br> 906 <b>Recommended Value (Release Build): </b><br> 907 <b>Required: </b>No<br> 908 <b>Considerations: </b>PEGASUS_ENABLE_SLP requires 909 PEGASUS_ENABLE_INTEROP_PROVIDER to be enabled. If
910 kumpf 1.12 PEGASUS_ENABLE_INTEROP_PROVIDER is not set, setting
911 denise.eckstein 1.1 PEGASUS_ENABLE_SLP to true, will also enable
912 kumpf 1.12 PEGASUS_ENABLE_INTEROP_PROVIDER. If
913 denise.eckstein 1.1 PEGASUS_ENABLE_INTEROP_PROVIDER is explicitly disabled 914 (i.e., set to false), a build error will be generated.<br> 915 </ul> 916 917 918 <h5>PEGASUS_ENABLE_SORTED_DIFF</h5> 919 <ul>
920 kumpf 1.12 <b>Description: </b>This controls if the DIFFSORT function 921 is used rather than a simple DIFF of the test results files 922 to the static results file. Set to 'true' enables the sorted 923 diffs of results to static results files. Otherwise results 924 in regular diffs of results to static results files. 925 See OpenPegasus bug 2283 for background information concerning
926 denise.eckstein 1.1 this config variable. <br> 927 <b>Default Value: </b>true<br> 928 <b>Recommended Value (Development Build): </b>true<br> 929 <b>Recommended Value (Release Build): </b>true<br> 930 <b>Required: </b>No<p> </p> 931 </ul> 932 933 <h5>PEGASUS_ENABLE_SYSTEM_LOG_HANDER</h5> 934 <ul> 935 <b>Description: </b>When this environment variable is set, a
936 kumpf 1.12 SysLog Indication Handler is built as part of the OpenPegasus 937 build.  The SysLog Indication Handler can be used to
938 denise.eckstein 1.1 delivered CIM Indications to the system log file.<br> 939 <b>Default Value: </b>Not Set<br> 940 <b>Recommended Value (Development Build): </b>Not Set<br> 941 <b>Recommended Value (Release Build): </b>Not Set<br> 942 <b>Required: </b>No<br>
943 kumpf 1.12 <b>Considerations: </b>If PEGASUS_ENABLE_SYSTEM_LOG_HANDLER
944 denise.eckstein 1.1 is not set when OpenPegasus is built, a request to create a SysLog
945 kumpf 1.12 Indication Handler instance will be rejected with the error
946 denise.eckstein 1.1 CIM_ERR_NOT_SUPPORTED.<br> 947 </ul> 948 949 <h5>PEGASUS_ENABLE_SSLV2</h5> 950 <ul> 951 <b>Description: </b>By default, support for the SSLV2 protocol
952 kumpf 1.12 is disabled in OpenPegasus. The option can be used to build a
953 denise.eckstein 1.1 version of OpenPegasus that supports SSLV2. This variable affects 954 how SSL contexts are constructed for both the CIM Server and CIM 955 Clients.<br> 956 <b>Default Value: </b>Not Set<br> 957 <b>Recommended Value (Development Build): </b>Not Set<br> 958 <b>Recommended Value (Release Build): </b>Not Set<br> 959 <b>Required: </b>No<br> 960 <b>Considerations:</b> Unless SSLV2 is required for backward 961 compatibility, enabling this protocol is not recommended (SSLV3 962 or later is preferred). 963 </ul> 964 965 <h5>PEGASUS_ENABLE_USERGROUP_AUTHORIZATION</h5> 966 <ul>
967 kumpf 1.12 <b>Description: </b>Builds a version of OpenPegasus that
968 denise.eckstein 1.1 allows an administrator to restrict access to CIM operations 969 to members of a designated set of groups.  Refer to the 970 <b>authorizedUserGroups</b>configuration option for additional 971 details.<br> 972 <b>Default Value: </b>Not Set<br> 973 <b>Recommended Value (Development Build): </b>Not Set<br> 974 <b>Recommended Value (Release Build): </b>Set<br> 975 <b>Required: </b>No<br> 976 </ul> 977 978 <h5>PEGASUS_EXTRA_C_FLAGS</h5> 979 <ul>
980 kumpf 1.12 <b>Description:  </b>This environment variable allows a 981 developer to specify an additional set of flags to be included
982 denise.eckstein 1.1 on  the C compile command line.<br> 983 <b>Default Value: </b>Not Set<br> 984 <b>Recommended Value (Development Build): </b>No Set<br> 985 <b>Recommended Value (Release Build): </b>Not Set<br> 986 <b>Required: </b>No 987 </ul> 988 989 <h5>PEGASUS_EXTRA_CXX_FLAGS</h5> 990 <ul>
991 kumpf 1.12 <b>Description:  </b>This environment variable allows a
992 denise.eckstein 1.1 developer to specify an additional set of flags to be included 993 on the C++ compile command line.<br> 994 <b>Default Value: </b>Not Set<br> 995 <b>Recommended Value (Development Build): </b>Not Set<br> 996 <b>Recommended Value (Release Build): </b>Not Set<br> 997 <b>Required: </b>No 998 </ul> 999 1000 <h5>PEGASUS_EXTRA_LIBRARY_LINK_FLAGS</h5> 1001 <ul> 1002 <b>Description:  </b>This environment variable allows a
1003 kumpf 1.12 developer to specify an additional set of flags to include on
1004 denise.eckstein 1.1 the link command line used to build a library.<br> 1005 <b>Default Value: </b>Not Set<br> 1006 <b>Recommended Value (Development Build): </b>Not Set<br> 1007 <b>Recommended Value (Release Build): </b>Not Set<br> 1008 <b>Required: </b>No 1009 </ul> 1010 1011 <h5>PEGASUS_EXTRA_LINK_FLAGS</h5> 1012 <ul> 1013 <b>Description:  </b>This environment variable allows a 1014 developer to specify an additional set of flags to be included 1015 on the link command line.  These flags will be included on 1016 both library and program executable link command lines.<br> 1017 <b>Default Value: </b>Not Set<br> 1018 <b>Recommended Value (Development Build): </b>Not Set<br> 1019 <b>Recommended Value (Release Build): </b>Not Set<br> 1020 <b>Required: </b>No
1021 kumpf 1.12 <b>Considerations: </b>Refer to PEGASUS_EXTRA_LIBRARY_LINK_FLAGS and
1022 denise.eckstein 1.1 PEGASUS_EXTRA_PROGRAM_FLAGS to add flags specific to either a 1023 library or program link command line.<br> 1024 </ul> 1025 1026 <h5>PEGASUS_EXTRA_PROGRAM_LINK_FLAGS</h5> 1027 <ul> 1028 <b>Description:  </b>This environment variable allows a 1029 developer to specify an additional set of flags to include on 1030 the link command line used to build an executable program.<br> 1031 <b>Recommended Value (Development Build): </b>Not Set<br> 1032 <b>Recommended Value (Release Build): </b>Not Set<br> 1033 <b>Required: </b>No 1034 </ul> 1035 1036 <h5>PEGASUS_HAS_MESSAGES</h5> 1037 <ul>
1038 kumpf 1.12 <b>Description: </b>When set (to anything) during the build, 1039 OpenPegasus compiles with localization support. The 1040 ICU (International Components for Unicode) variables, 1041 ICU_ROOT and ICU_INSTALL, indicate that the 1042 localization support is based on ICU. Only ICU is supported
1043 denise.eckstein 1.1 at this time.<br> 1044 <b>Default Value: </b>Not Set<br> 1045 <b>Recommended Value (Development Build): </b>Not Set<br> 1046 <b>Recommended Value (Release Build): </b>Not Set<br> 1047 <b>Required: </b>No<br> 1048 <b>Considerations: </b>If the PEGASUS_HAS_MESSAGES is not 1049 set, OpenPegasus is built without localization support. This 1050 means that all messages sent by the CIM Server and the CLIs are in 1051 English. ICU is an open source project at 1052 <a href="http://oss.software.ibm.com/icu">
1053 kumpf 1.12 http://oss.software.ibm.com/icu</a>.
1054 denise.eckstein 1.1 Only English translations are included with the OpenPegasus 1055 distribution. The OpenPegasus distribution does not provide 1056 translated messages. But, enabling for ICU would allow vendor to 1057 provide the translations. Refer to the OpenPegasus Release README 1058 for additional information regarding the use of ICU. Although, in
1059 kumpf 1.12 OpenPegasus 2.3.2, experience with localization support 1060 has been limited to a select set of platforms, wider platform
1061 denise.eckstein 1.1 adoption of this technology is planned for 2.5.<br> 1062 </ul> 1063 1064 <h5>PEGASUS_HAS_SSL</h5> 1065 <ul> 1066 <b>Description: </b>If set, a version of OpenPegasus that 1067 supports SSL (i.e., https) is built.<br> 1068 <b>Default Value: </b>Not Set<br> 1069 <b>Recommended Value (Development Build): </b>Set<br> 1070 <b>Recommended Value (Release Build): </b>Set<br> 1071 <b>Required: </b>No<br>
1072 kumpf 1.12 <b>Considerations: </b>Support for SSL in OpenPegasus is 1073 dependent on the OpenSSL software developed by the
1074 denise.eckstein 1.1 <a href="http://www.openssl.org/">
1075 kumpf 1.12 OpenSSL Project (http://www.openssl.org/)</a>.
1076 denise.eckstein 1.1 1077 If the PEGASUS_HAS_SSL variable is set, the variable OPENSSL_HOME 1078 must also be defined. The OPENSSL_HOME variable is used, by the
1079 kumpf 1.12 OpenPegasus build, to determine the location of the OpenSSL
1080 denise.eckstein 1.1 include files, libraries and binaries. 1081 </ul> 1082 1083 <h5>PEGASUS_HOME</h5> 1084 <ul> 1085 <b>Description: </b>Specifies the location of the 1086 OpenPegasus working directory. The OpenPegasus
1087 kumpf 1.12 build will use this directory as the default location
1088 denise.eckstein 1.1 for files generated during the build (e.g., binaries, 1089 libraries, objects).<br> 1090 <b>Default Value: </b>None<br> 1091 <b>Recommended Value (Development Build): </b> 1092 No Specific Recommendation<br> 1093 <b>Recommended Value (Release Build): </b> 1094 No Specific Recommendation<br> 1095 <b>Required: </b>Yes<br>
1096 karl 1.29 <b>Considerations: </b>The error "PEGASUS_HOME 1097 environment variable undefined" is returned if the
1098 kumpf 1.12 PEGASUS_HOME environment variable is not set.
1099 denise.eckstein 1.1 This variable is also used during runtime. Refer to the section
1100 karl 1.29 titled "Environment Variable Settings for Running OpenPegasus 1101 2.3.2 on Linux" for additional details.<br>
1102 denise.eckstein 1.1 </ul> 1103 1104 <h5>PEGASUS_MAX_THREADS_PER_SVC_QUEUE</h5> 1105 <ul> 1106 <b>Description: </b>Controls the maximum number of threads 1107 allowed per message service queue. It is allowed to range 1108 between 1 and MAX_THREADS_PER_SVC_QUEUE_LIMIT (currently 5000)
1109 kumpf 1.12 as set in pegasus/src/Pegasus/Common/MessageQueueService.cpp.
1110 denise.eckstein 1.1 If set to 0 (zero) the max threads per service queue is then 1111 set to MAX_THREADS_PER_SVC_QUEUE_LIMIT. If set larger than the
1112 kumpf 1.12 MAX_THREADS_PER_SVC_QUEUE_LIMIT it is set equal to
1113 denise.eckstein 1.1 MAX_THREADS_PER_SVC_QUEUE_LIMIT. There are no other limits on the 1114 total number of threads that can exist within the system at this
1115 kumpf 1.12 time. When the server starts there on the order of 10 to 20 1116 message service queues created dependent upon
1117 denise.eckstein 1.1 build options.  <br> 1118 <b>Default Value: </b>5<br> 1119 <b>Recommended Value (Development Build): </b>5<br> 1120 <b>Recommended Value (Release Build): </b>5<br> 1121 <b>Required: </b>No<br> 1122 <b>Considerations: </b>This flag affects consumption of 1123 system resources. Not setting, or inappropriately setting 1124 this value, may cause the cimserver to hang or crash.<br> 1125 </ul> 1126 1127 <h5>PEGASUS_ROOT</h5> 1128 <ul> 1129 <b>Description: </b>Specifies the location of the directory 1130 that corresponds to "pegasus" source directory defined in the
1131 kumpf 1.12 OpenPegasus CVS source tree. This environment variable is 1132 used by the OpenPegasus build to locate the required build 1133 and source files (e.g., $(PEGASUS_ROOT)/mak and 1134 $(PEGASUS_ROOT)/src).<br>
1135 denise.eckstein 1.1 <b>Default Value: </b>None<br> 1136 <b>Recommended Value (Development Build): </b> 1137 No Specific Recommendation<br> 1138 <b>Recommended Value (Release Build): </b> 1139 No Specific Recommendation<br> 1140 <b>Required: </b>Yes<br> 1141 <b>Considerations: </b>The error "PEGASUS_ROOT environment 1142 variable undefined" is returned if the PEGASUS_ROOT 1143 environment variable is not set. 1144 </ul> 1145 1146 1147 <h5>PEGASUS_NET_SNMP_INCLUDE_DIR</h5> 1148 <ul> 1149 <b>Description: </b>Specifies the location of the NET-SNMP 1150 <i>include</i> directory. <br> 1151 <b>Default Value: </b>Not Set<br> 1152 <b>Recommended Value (Development Build): </b> 1153 No Specific Recommendation<br> 1154 <b>Recommended Value (Release Build): </b> 1155 No Specific Recommendation<br> 1156 denise.eckstein 1.1 <b>Required: </b>No. By default, the NET-SNMP include 1157 files are expected to be installed in directories that 1158 are searched by default (e.g., /usr/include). For platforms
1159 kumpf 1.12 where this isn't true, the PEGASUS_NET_SNMP_INCLUDE_DIR
1160 denise.eckstein 1.1 environment variable may be used to define an alternative path. 1161 This environment variable is only used if PEGASUS_USE_NET_SNMP 1162 is set.<br> 1163 </ul> 1164 1165 <h5>PEGASUS_NET_SNMP_LIB_DIR</h5> 1166 <ul> 1167 <b>Description: </b>Specifies the location of the NET-SNMP 1168 <i>lib </i>directory. <br> 1169 <b>Default Value: </b>Not Set<br> 1170 <b>Recommended Value (Development Build): </b> 1171 No Specific Recommendation<br> 1172 <b>Recommended Value (Release Build): </b> 1173 No Specific Recommendation<br> 1174 <b>Required: </b>No. By default, the NET-SNMP library is
1175 kumpf 1.12 expected to be installed in a directory that is searched by 1176 default (e.g., /usr/lib, /usr/lib64). For platforms where
1177 denise.eckstein 1.1 this isn't true, the PEGASUS_NET_SNMP_LIB_DIR environment 1178 variable may be used to define an alternative path. This 1179 environment variable is only used if PEGASUS_USE_NET_SNMP is set. 1180 </ul> 1181 1182 1183 <h5>PEGASUS_NOASSERTS</h5> 1184 <ul> 1185 <b>Description: </b>Defines the NDEBUG compilation macro, which
1186 marek 1.37 causes the preprocessor to remove PEGASUS_ASSERT() and disables assertion 1187 on PEGASUS_FCT_EXECUTE_AND_ASSERT statements.<br>
1188 denise.eckstein 1.1 <b>Default Value: </b>Not Set<br> 1189 <b>Recommended Value (Development Build): </b>Not Set<br> 1190 <b>Recommended Value (Release Build): </b>Set<br> 1191 <b>Required: </b>No<br> 1192 </ul> 1193 1194 <h5>PEGASUS_OPENSLP_HOME</h5> 1195 <ul>
1196 kumpf 1.12 <b>Description: </b>Specifies the location of the OpenSLP
1197 denise.eckstein 1.1 SDK directory. This directory must contain the OpenSLP 1198 <i>include</i> directory, $(PEGASUS_OPENSLP_HOME)/include, 1199 and the OpenSLP <i>library</i> directory, 1200 $(PEGASUS_OPENSLP_HOME)/lib.<br> 1201 <b>Default Value: </b>Not Set<br> 1202 <b>Recommended Value (Development Build): </b> 1203 No Specific Recommendation<br> 1204 <b>Recommended Value (Release Build): </b> 1205 No Specific Recommendation<br> 1206 <b>Required: </b>No. If not set, no additional include or 1207 library search paths will be included. 1208 <b>Considerations: </b>This value is not used if PEGASUS_USE_OPENSLP 1209 is not defined. <br> 1210 </ul> 1211 1212 <h5>PEGASUS_PAM_AUTHENTICATION</h5> 1213 <ul>
1214 kumpf 1.12 <b>Description: </b>Enables support for PAM-(Pluggable
1215 denise.eckstein 1.1 Authentication Modules) based authentication.<br> 1216 <b>Default Value: </b>Not Set<br> 1217 <b>Recommended Value (Development Build): </b>Set<br> 1218 <b>Recommended Value (Release Build): </b>Set<br> 1219 <b>Required: </b>No<br> 1220 <b>Considerations: </b>Support for PAM in OpenPegasus is 1221 dependent on platform support for PAM.<br> 1222 </ul> 1223
1224 marek 1.41 <h5>PEGASUS_PAM_SESSION_SECURITY</h5> 1225 <ul> 1226 <b>Description: </b>Enables support for PAM-(Pluggable 1227 Authentication Modules) based authentication and authorization.<br> 1228 When choosing this PAM method the PAM session started through pam_start 1229 is kept open for the complete CIM request. 1230 The PAM item PAM_RHOST will be set to the connection IP address. 1231 This allows PAM modules to restrict number of concurrent connections 1232 from a single host.<br> 1233 If PEGASUS_PAM_SESSION_SECURITY is set, you cannot enable the Privilege 1234 Separation feature (PEGASUS_ENABLE_PRIVILEGE_SEPARATION) or the 1235 authentication-only PAM mechanism (PEGASUS_PAM_AUTHENTICATION).<br> 1236 <b>Default Value: </b>Not Set<br> 1237 <b>Recommended Value (Development Build): </b>Not Set<br> 1238 <b>Recommended Value (Release Build): </b>Not Set<br> 1239 <b>Required: </b>No<br> 1240 <b>Considerations: </b>Support for PAM in OpenPegasus is 1241 dependent on platform support for PAM.<br> 1242 </ul> 1243
1244 denise.eckstein 1.1 <h5>PEGASUS_PLATFORM</h5> 1245 <ul> 1246 <b>Description: </b>Describes the target platform for the
1247 kumpf 1.12 build. The list of supported values for this variable 1248 is defined in pegasus/mak/config.mak.  Please refer to
1249 denise.eckstein 1.1 that file for a complete list of valid PEGASUS_PLATFORM 1250 values.  This document includes platform-specific configuration
1251 kumpf 1.12 data for only a subset of the supported platforms.  The
1252 denise.eckstein 1.1 following table describes the platforms documented in 1253 this version of the document. <br> 1254 <b>Default Value: </b>None<p> </p>
1255 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="542"> 1256 <tbody><tr> 1257 <th bgcolor="#cae6ca" width="190">Platform</th> 1258 <th bgcolor="#cae6ca" width="351">Recommended Value <br>
1259 denise.eckstein 1.1 Development Build</th>
1260 karl 1.29 <th bgcolor="#cae6ca" width="338">Recommended Value <br>
1261 denise.eckstein 1.1 Release Build</th> 1262 </tr> 1263 <tr align="center">
1264 karl 1.29 <td align="left" width="190">Linux IA32</td>
1265 denise.eckstein 1.1 <td width="351">LINUX_IX86_GNU</td> 1266 <td width="338">LINUX_IX86_GNU</td> 1267 </tr> 1268 <tr align="center">
1269 karl 1.29 <td align="left" width="190">Linux IA64</td>
1270 denise.eckstein 1.1 <td width="351">LINUX_IA64_GNU</td> 1271 <td width="338">LINUX_IA64_GNU</td> 1272 </tr> 1273 <tr align="center">
1274 karl 1.29 <td align="left" width="190">Linux X86_64</td>
1275 denise.eckstein 1.1 <td width="351">LINUX_X86_64_GNU</td> 1276 <td width="338">LINUX_X86_64_GNU</td> 1277 </tr> 1278 <tr align="center">
1279 karl 1.29 <td align="left" width="190">HP-UX PA-RISC</td>
1280 denise.eckstein 1.1 <td width="351">HPUX_PARISC_ACC</td> 1281 <td width="338">HPUX_PARISC_ACC</td> 1282 </tr> 1283 <tr align="center">
1284 karl 1.29 <td align="left" width="190">HP-UX IPF</td>
1285 denise.eckstein 1.1 <td width="351">HPUX_IA64_ACC</td> 1286 <td width="338">HPUX_IA64_ACC</td> 1287 </tr> 1288 <tr align="center">
1289 karl 1.29 <td align="left" width="190">OpenVMS Alpha</td>
1290 denise.eckstein 1.1 <td width="351">VMS_ALPHA_DECCXX</td> 1291 <td width="338">VMS_ALPHA_DECCXX</td> 1292 </tr> 1293 <tr align="center">
1294 karl 1.29 <td align="left" width="190">OpenVMS IA64</td>
1295 denise.eckstein 1.1 <td width="351">VMS_IA64_DECCXX</td> 1296 <td width="338"> VMS_IA64_DECCXX</td> 1297 </tr>
1298 karl 1.29 </tbody></table>
1299 denise.eckstein 1.1 <br><br> 1300 <b>Required: </b>Yes<br>
1301 kumpf 1.12 <b>Considerations: </b>The error "PEGASUS_PLATFORM 1302 environment variable undefined." is returned if the
1303 denise.eckstein 1.1 PEGASUS_PLATFORM environment variable is not set. 1304 </ul> 1305 1306 <h5>PEGASUS_REMOVE_METHODTRACE</h5> 1307 <ul> 1308 <b>Description: </b>If true, the CIM Server is compiled without 1309 method enter and exit trace statements.  Trace Level 5 will 1310 continue to be accepted as a valid trace level but, without the 1311 method enter and exit trace statements, it will be equivalent to
1312 kumpf 1.12 Trace Level 4. If PEGASUS_REMOVE_METHODTRACE is false or not set,
1313 denise.eckstein 1.1 method enter and exit trace statements are included.  All 1314 other values are considered invalid and will result in a build 1315 error.<br> 1316 <b>Default Value: </b>Not Set<br> 1317 <b>Recommended Value (Development Build): </b>Not Set (The 1318 Considerations section gives guidance on when a different 1319 decision would be made.)<br> 1320 <b>Recommended Value (Release Build): </b>Not Set (The 1321 Considerations section gives guidance on when a different 1322 decision would be made.)<br> 1323 <b>Required: </b>No<br> 1324 <b>Considerations: </b>This option completely removes the
1325 kumpf 1.12 method enter/exit trace statements from the generated object code. 1326 It defines the PEG_METHOD_ENTER and PEG_METHOD_EXIT macros
1327 denise.eckstein 1.1 to null statements. This helps to keep static code size small 1328 but reduces the serviceability of the CIM server.<br> 1329 </ul> 1330 1331 1332 <h5>PEGASUS_REPOSITORY_MODE</h5> 1333 <ul> 1334 <b>Description: </b>This variable defines the default mode 1335 used to create repositories that are constructed as part of the 1336 automated build tests.  It does not affect the runtime 1337 environment. Valid values include: XML (causes 1338 the repository to be built in XML mode); BIN (causes
1339 kumpf 1.12 the repository to be built in binary mode). Use cimconfig to
1340 denise.eckstein 1.1 modify the runtime environment.<br> 1341 <b>Default Value: </b>XML<br> 1342 <b>Recommended Value (Development Build): </b>XML<br> 1343 <b>Recommended Value (Release Build): </b>XML<br> 1344 <b>Required: </b>No<p> </p> 1345 </ul> 1346
1347 kumpf 1.2 <h5>PEGASUS_REPOSITORY_STORE_COMPLETE_CLASSES</h5> 1348 <ul> 1349 <b>Description: </b>This variable defines the default contents of a 1350 class definition in the repository store when a new repository is created. 1351 Specifically, when set to true, propagated elements are included in a 1352 class definition in the persistent store. The contents of a class 1353 definition returned from the repository interface is not affected by this 1354 option.<br> 1355 <b>Default Value: </b>false<br> 1356 <b>Recommended Value (Development Build): </b>false<br> 1357 <b>Recommended Value (Release Build): </b>false<br> 1358 <b>Required: </b>No<p> </p> 1359 <b>Considerations: </b>A repository which stores complete class 1360 definitions does not allow modifications to non-leaf classes or changes 1361 to a superclass designation. Complete classes use more storage space, 1362 often twice as much as local (incomplete) classes. Class retrieval may 1363 be more expensive when local classes are stored. No specific mechanism 1364 is available to change this setting in an existing repository.<br> 1365 </ul> 1366
1367 denise.eckstein 1.1 <h5>PEGASUS_SLP_REG_TIMEOUT</h5> 1368 <ul> 1369 <b>Description: </b>Most SLP implementations allow a lifetime 1370 value to be specified in the registration sent to the SLP SA or 1371 DA. The PEGASUS_SLP_REG_TIMEOUT build variable allows a lifetime 1372 (ie. timeout) value to be specified on the SLP registration, with 1373 a 're-registration' being sent to SLP at the same specified 1374 timeout interval. The purpose of this lifetime or timeout value
1375 kumpf 1.12 is to avoid the accumulation of stale service information
1376 denise.eckstein 1.1 in the SA or DA.<br> 1377 <b>Default Value: </b>Undefined<br> 1378 <b>Recommended Value (Development Build): </b>Undefined<br> 1379 <b>Recommended Value (Release Build): </b>Undefined<br> 1380 <b>Required: </b>No<p><b>Example: </b> 1381 PEGASUS_SLP_REG_TIME=1440 (ie. 24 hours or 1 day)<br> 1382 <b>Considerations: </b>(1) The OpenPegasus internal SLP 1383 implementation does not support timeout registrations. This 1384 build option is useful, for example, if PEGASUS_USE_OPENSLP is
1385 kumpf 1.12 defined. (2) Some SLP implementations may impose a
1386 denise.eckstein 1.1 maximum value for the lifetime parameter. For example, OpenSLP
1387 kumpf 1.12 limits this value to SLP_LIFETIME_MAXIMUM (or 0xFFFF), and
1388 denise.eckstein 1.1 if this maximum value is passed to OpenSLP, then the timeout 1389 feature is disabled. Refer to the documentation of your SLP 1390 implementation for more information. (3) OpenPegasus will not
1391 kumpf 1.12 do any validity checking on the specified value, either
1392 denise.eckstein 1.1 to determine if it is a valid positive integer or if it 1393 exceeds some maximum value.<br>
1394 karl 1.29 </p></ul>
1395 denise.eckstein 1.1 1396 <h5>PEGASUS_SNIA_EXTENSIONS</h5> 1397 <ul> 1398 <b>Description: </b> This variable is used to enable a 1399 set of workarounds that support the use of OpenPegasus 1400 in the SNIA Test Environment.<br> 1401 <b>Default Value: </b>Not Set<br> 1402 <b>Recommended Value (Development Build): </b>Not Set<br> 1403 <b>Recommended Value (Release Build): </b>Not Set<br> 1404 <b>Required: </b>No<br> 1405 <b>Considerations: </b>The functionality enabled with this 1406 variable is experimental and subject to change. 1407 </ul> 1408 1409 <h5>PEGASUS_SKIP_MOST_TEST_DIRS</h5> 1410 <ul> 1411 <b>Description: </b>If set to true, this variable can be used 1412 to reduce the time required to build OpenPegasus by significantly 1413 reducing the number of tests that are built.<br> 1414 <b>Default Value: </b>Not Set<br> 1415 <b>Recommended Value (Development Build): </b>Not Set<br> 1416 denise.eckstein 1.1 <b>Recommended Value (Release Build): </b>Not Set<br> 1417 <b>Required: </b>No<br> 1418 <b>Considerations: </b>Setting this variable to true 1419 affects the behavior of all recursive make targets (e.g., 1420 clean, depend, all, unittests, alltests, and slptests). 1421 Use of this variable with test-related targets (e.g., unittests,
1422 kumpf 1.12 alltests and slptests) can produce unexpected results.
1423 denise.eckstein 1.1 To avoid creating an inconsistent PEGASUS_HOME directory, 1424 the PEGASUS_HOME directory (i.e., the OpenPegasus build 1425 directory) should be removed prior to enabling or disabling 1426 this variable. This variable should not be used to characterize
1427 kumpf 1.12 the set of files to be packaged in a release build. Please
1428 denise.eckstein 1.1 refer to the Runtime Packaging Definition PEP for the release
1429 kumpf 1.12 for a recommended list of files to be included in a release.
1430 denise.eckstein 1.1 </ul> 1431 1432 <h5>PEGASUS_TEST_ENABLE_DEBUG_TRACE</h5> 1433 <ul> 1434 <b>Description: </b> 1435 This variable is only used for testing. If set to true,
1436 kumpf 1.12 Discarded data trace will be enabled by the install_run 1437 target of the src/Server/Makefile before running the
1438 denise.eckstein 1.1 OpenPegasus TestMakefile test suite. <br> 1439 <b>Default Value: </b>Not Set<br> 1440 <b>Recommended Value (Development Build): </b>Set<br> 1441 <b>Recommended Value (Release Build): </b>Not Set<br> 1442 <b>Required: </b>No<br> 1443 <b>Considerations: </b>
1444 kumpf 1.12 This variable is useful in certain test environments to 1445 explicitly enable tracing to aid in better troubleshooting and
1446 denise.eckstein 1.1 detection of test failures (E.g. Test systems are experiencing
1447 kumpf 1.12 test failures due to connection timeouts, lost indications
1448 denise.eckstein 1.1 etc).<br> 1449 </ul> 1450 1451 <h5>PEGASUS_TEST_ISGROUP_GROUP/PEGASUS_TEST_ISGROUP_USER_SUCCESS/PEGASUS_TEST_ISGROUP_USER_FAILURE</h5> 1452 <ul>
1453 kumpf 1.12 <b>Description: </b>These variables are only used for testing.
1454 denise.eckstein 1.1 These variables allow the developer to define a valid group name, 1455 PEGASUS_TEST_ISGROUP_GROUP, a valid user name that is in the 1456 group, PEGASUS_TEST_ISGROUP_USER_SUCCESS, and an a valid user 1457 name that is not in the group, PEGASUS_TEST_ISGROUP_USER_FAILURE.
1458 kumpf 1.12 These variables are only used for testing and NOT part of the
1459 denise.eckstein 1.1 release.<br>
1460 kumpf 1.12 <b>Default Value(Windows):</b>
1461 denise.eckstein 1.1 Administrator/Administrators/Guest<br> 1462 <b>Default Value(Non-Windows): </b>root/root/guest<br> 1463 <b>Recommended Value (Development Build): </b> 1464 No Recommendation<br> 1465 <b>Recommended Value (Release Build): </b>Not Used<br> 1466 <b>Required: </b>No 1467 </ul> 1468 1469 <h5>PEGASUS_TEST_IPV6</h5> 1470 <ul> 1471 <b>Description: </b>This variable is only used for 1472 testing.  If set to true, the IPv6-specific tests will
1473 karl 1.29 be run as part of the "alltests" OpenPegasus
1474 denise.eckstein 1.1 TestMakefile test suite. If this variable is not set or set to 1475 false,  the IPv6-specific tests will not be run.  All 1476 other values are invalid.<br>
1477 kumpf 1.12 <b>Default Value:  </b>If PEGASUS_TEST_IPV6 is not defined,
1478 denise.eckstein 1.1 PEGASUS_TEST_IPV6 is set to the value of PEGASUS_ENABLE_IPV6.<br> 1479 <b>Recommended Value (Development Build): </b>Set to the value 1480 of PEGASUS_ENABLE_IPV6<br> 1481 <b>Recommended Value (Release Build): </b>Not Used<br> 1482 <b>Required: </b>No<br>
1483 kumpf 1.12 <b>Considerations: </b>This variable is useful in certain
1484 denise.eckstein 1.1 test environments to explicitly disable running the IPv6
1485 kumpf 1.12 tests (e.g., when running an IPv6-enabled version of
1486 denise.eckstein 1.1 OpenPegasus on an an IPv4 system).<br> 1487 </ul> 1488 1489 <h5>PEGASUS_TEST_SDK</h5> 1490 <ul>
1491 kumpf 1.12 <b>Description: </b>This variable is only used for
1492 denise.eckstein 1.1 testing.  It is used to control testing of the SDK 1493 sample providers and clients. If set, the setup, building and
1494 kumpf 1.12 testing of the SDK samples is enabled as part of the
1495 denise.eckstein 1.1 OpenPegasus automated build and test.<br> 1496 <b>Default Value: </b>Not Set<br> 1497 <b>Recommended Value (Development Build): </b>Set<br> 1498 <b>Recommended Value (Release Build): </b>Not Used<br> 1499 <b>Required: </b>No 1500 </ul> 1501 1502 <h5>PEGASUS_TEST_USER_DEFINED</h5> 1503 <ul> 1504 <b>Description: </b>This variable is only used for testing. 1505 If this variable is set, the tests will assume that the 1506 PEGASUS_TEST_USER_ID and PEGASUS_TEST_USER_PASS variables
1507 kumpf 1.12 defines a valid user/password pair and can be used for
1508 denise.eckstein 1.1 certificate-based authentication testing.  These tests
1509 karl 1.29 also assumes that "invalidUser" is not a valid
1510 denise.eckstein 1.1 user.<br> 1511 <b>Default Value: </b>Not Set<br> 1512 <b>Recommended Value (Development Build): </b>Set<br> 1513 <b>Recommended Value (Release Build): </b>Not Used<br> 1514 <b>Required: </b>No 1515 </ul> 1516 1517 <h5>PEGASUS_TEST_USER_ID/PEGASUS_TEST_USER_PASS</h5> 1518 <ul> 1519 <b>Description: </b>These variables are only used for 1520 testing. These variables allow the developer to define a 1521 valid, non-privileged  user name and password 1522 on the test system that can be used as part of the OpenPegasus 1523 automated test scripts to perform authentication and 1524 authorization testing.  These variables are only used for 1525 testing and NOT part of the release.<br> 1526 <b>Default Value: </b>guest/guest<br> 1527 <b>Recommended Value (Development Build): </b> 1528 No Recommendation<br> 1529 <b>Recommended Value (Release Build): </b>Not Used<br> 1530 <b>Required: </b>No<br> 1531 denise.eckstein 1.1 </ul> 1532 1533 <h5>PEGASUS_TEST_VALGRIND_LOG_DIR</h5> 1534 <ul> 1535 <b>Description: </b> 1536 This variable is currently only supported on Linux. It may be
1537 kumpf 1.12 set to run regression tests under the
1538 denise.eckstein 1.1 <a href="http://www.valgrind.org/">Valgrind</a> memory 1539 checking tool. It must specify a directory for writing 1540 Valgrind log files. The file name format for a particular 1541 log is PEGASUS_TEST_VALGRIND_LOG_DIR/PROGRAM_NAME.pid.<br> 1542 <b>Default Value: </b>Not Set<br> 1543 <b>Recommended Value (Development Build): </b>Not Set<br> 1544 <b>Recommended Value (Release Build): </b>Not Set<br> 1545 <b>Required: </b>No<br> 1546 <b>Considerations: </b>This flag is only supported on Linux to 1547 enable running tests under Valgrind.<br> 1548 </ul> 1549 1550 <h5>PEGASUS_TMP</h5> 1551 <ul> 1552 <b>Description: </b>This variable is only used in a test 1553 environment. It can be used to define the directory that 1554 OpenPegasus test programs should use to store temporary files.<br> 1555 <b>Default Value: </b>"."<br> 1556 <b>Recommended Value (Development Build): </b> 1557 No Specific Recommendation<br> 1558 <b>Recommended Value (Release Build): </b>Not Used<br> 1559 denise.eckstein 1.1 <b>Required: </b>No<br> 1560 </ul> 1561 1562 <h5>PEGASUS_USE_DEBUG_BUILD_OPTIONS</h5> 1563 <ul> 1564 <b>Description: </b>The PEGASUS_DEBUG flag is used to control 1565 a variety of settings, including compile options, assertion
1566 kumpf 1.12 enablement, method definitions for testing, and diagnostic
1567 denise.eckstein 1.1 output.  The PEGASUS_USE_DEBUG_BUILD_OPTIONS variable
1568 kumpf 1.12 can be used to enable just the compiler specific debug options
1569 denise.eckstein 1.1 (e.g., -g in g++) .<br> 1570 <b>Default Value: </b>Not Set<br> 1571 <b>Recommended Value (Development Build): </b>Set<br> 1572 <b>Recommended Value (Release Build): </b>Not Set<br> 1573 <b>Required: </b>No<br> 1574 <b>Considerations: </b>This variable is automatically set 1575 if PEGASUS_DEBUG is set.<br> 1576 </ul> 1577 1578 <h5>PEGASUS_USE_EMANATE</h5> 1579 <ul> 1580 <b>Description: </b>EMANATE, 1581 <a href="http://www.snmp.com/products/emanate.html">
1582 kumpf 1.12 http://www.snmp.com/products/emanate.html</a>, is an SNMP Research 1583 International product that supports SNMPv1, SNMPv2c, and
1584 denise.eckstein 1.1 SNMPv3.  If the PEGASUS_USE_EMANATE variable is defined, 1585 the OpenPegasus SNMP Handler will use the EMANATE libraries
1586 kumpf 1.12 to send traps to the SNMP Management application.
1587 denise.eckstein 1.1 The EMANATE libraries are NOT included as part of OpenPegasus.<br> 1588 <b>Default Value: </b>Not Set<br> 1589 <b>Recommended Value (Development Build): </b>Not Set<br> 1590 <b>Recommended Value (Release Build): </b>Not Set<br> 1591 <b>Required: </b>No<p> 1592 <b>Considerations: </b>Either the PEGASUS_USE_NET_SNMP or
1593 kumpf 1.12 PEGASUS_USE_EMANATE variable must be set for the SNMP
1594 denise.eckstein 1.1 Handler to be supported.<br>
1595 karl 1.29 </p></ul>
1596 denise.eckstein 1.1 1597 1598 <h5>PEGASUS_USE_NET_SNMP</h5> 1599 <ul>
1600 kumpf 1.12 <b>Description: </b>NET-SNMP,
1601 denise.eckstein 1.1 <a href="http://net-snmp.sourceforge.net"> 1602 http://net-snmp.sourceforge.net</a>,  is an OSS 1603 implementation of a suite of applications used to implement 1604 <a href="http://www.ietf.org/rfc/rfc1157.txt">SNMP v1</a>, 1605 <a href="http://www.ietf.org/rfc/rfc1901.txt">SNMP v2c</a> and 1606 <a href="http://www.ietf.org/rfc/rfc2571.txt">SNMP v3</a> using
1607 kumpf 1.12 both IPv4 and IPv6.   If the PEGASUS_USE_NET_SNMP
1608 denise.eckstein 1.1 variable is defined, the OpenPegasus SNMP Handler will use 1609 the NET-SNMP libraries to send traps to the SNMP Management 1610 application.  The NET-SNMP libraries are NOT included 1611 as part of OpenPegasus.<br> 1612 <b>Default Value: </b>Not Set<br> 1613 <b>Recommended Value (Development Build): </b>Not Set<br>
1614 kumpf 1.12 <b>Recommended Value (Release Build): </b>true for Linux,
1615 denise.eckstein 1.1 false for all other platforms<br> 1616 <b>Required: </b>No<p>
1617 kumpf 1.12 <b>Considerations: </b>Either the PEGASUS_USE_NET_SNMP or 1618 PEGASUS_USE_EMANATE variable must be set for the SNMP
1619 denise.eckstein 1.1 Handler to be supported.<br>
1620 karl 1.29 </p></ul>
1621 denise.eckstein 1.1
1622 sahana.prabhakar 1.23 <h5>PEGASUS_ENABLE_NET_SNMPV3</h5> 1623 <ul> 1624 <b>Description: </b>If this variable is defined, 1625 then OpenPegasus SNMP Handler will build the SNMPV3 1626 features. This should be set to false if NET-SNMP 5.2 and lower 1627 libraries are used.<br> 1628 <b>Default Value: </b>true<br> 1629 <b>Recommended Value (Development Build): </b>true<br> 1630 <b>Recommended Value (Release Build): </b>true<br> 1631 <b>Required: </b>No<p> 1632 <b>Considerations: </b>PEGASUS_USE_NET_SNMP variable must 1633 be set.<br>
1634 karl 1.29 </p></ul>
1635 sahana.prabhakar 1.23 1636
1637 denise.eckstein 1.1 <h5>PEGASUS_USE_OPENSLP</h5> 1638 <ul> 1639 <b>Description: </b>OpenSLP, <a href="http://www.openslp.org">
1640 kumpf 1.12 http://openslp.org</a>, is an open-source implementation of
1641 denise.eckstein 1.1 Service Location Protocol. If the PEGASUS_USE_OPENSLP variable 1642 is defined, OpenPegasus will be built to use the OpenSLP 1643 implementation of SLP instead of the internal OpenPegasus 1644 implementation of SLP. The OpenSLP libaries are NOT included 1645 as part of OpenPegasus. 1646 <b>Default Value: </b>Not Set<br> 1647 <b>Recommended Value (Development Build): </b>Not Set<br> 1648 <b>Recommended Value (Release Build): </b>Not Set<br> 1649 <b>Required: </b>No<br> 1650 <b>Considerations: </b>PEGASUS_ENABLE_SLP must be defined 1651 if this variable is set. 1652 </ul> 1653 1654 <h5>PEGASUS_USE_PAM_STANDALONE_PROC</h5> 1655 <ul> 1656 <b>Description: </b>Moves the processing of PAM requests from 1657 the CIM Server process to a separate process managed by the 1658 CIM Server.<br> 1659 <b>Default Value: </b>Not Set<br> 1660 <b>Recommended Value (Development Build): </b>Set<br> 1661 <b>Recommended Value (Release Build): </b>Set<br> 1662 denise.eckstein 1.1 <b>Required: </b>No<br> 1663 <b>Considerations: </b>If PAM Authentication is enabled, 1664 the PAM API is used, during the processing of each request, to 1665 authenticate the client. This level of use makes the CIM Server 1666 extremely sensitive to memory leaks in the PAM library. In 1667 addition, certain PAM modules are not thread-safe. If your
1668 kumpf 1.12 platform is experiencing problems with PAM Authentication,
1669 denise.eckstein 1.1 use of option may provide a work-around. 1670 PEGASUS_USE_PAM_STANDALONE_PROC requires 1671 PEGASUS_PAM_AUTHENTICATION to be set.<br> 1672 </ul> 1673 1674 <h5>PEGASUS_USE_RELEASE_CONFIG_OPTIONS</h5> 1675 <ul> 1676 <b>Description: </b>If set, OpenPegasus is built using 1677 the "Release Build" configuration options. By default,
1678 karl 1.29 OpenPegasus is built using the "Development Build"
1679 denise.eckstein 1.1 configuration options.<br>
1680 s.kodali 1.19 <b>Default Value: </b>false<br> 1681 <b>Recommended Value (Development Build): </b>false<br> 1682 <b>Recommended Value (Release Build): </b>true<br>
1683 denise.eckstein 1.1 <b>Required: </b>No<br>
1684 kumpf 1.12 <b>Considerations: </b>(1)The 1685 PEGASUS_USE_RELEASE_CONFIG_OPTIONS variable allows a platform
1686 denise.eckstein 1.1 vendor to easily toggle between two sets of configurations 1687 options, a set of options tuned for the development/debug
1688 karl 1.29 ("Development Build") environment and a set of options
1689 denise.eckstein 1.1 tuned for the production environment ("Release Build").
1690 kumpf 1.12 Refer the section titled "Configuration Properties" for 1691 additional detail.  (2) For each configuration
1692 karl 1.29 variable,  the "Recommended Value (Release Build)"
1693 kumpf 1.12 value defines the recommended settings to use for a
1694 karl 1.29 "Release Build".  Please refer to the
1695 denise.eckstein 1.1 description of each variable for additional information. 1696 </ul> 1697 1698 <h5>PEGASUS_USE_RELEASE_DIRS</h5> 1699 <ul>
1700 kumpf 1.12 <b>Description: </b>If set, OpenPegasus is built using 1701 the "Release Build" directory definitions. By default,
1702 karl 1.29 OpenPegasus is built using the "Development Build"
1703 denise.eckstein 1.1 directory definitions.<br> 1704 <b>Default Value: </b>Not Set<br> 1705 <b>Recommended Value (Development Build): </b>Not Set<br> 1706 <b>Recommended Value (Release Build): </b>Set<br> 1707 <b>Required: </b>No<br>
1708 kumpf 1.12 <b>Considerations: </b>
1709 denise.eckstein 1.1 The PEGASUS_USE_RELEASE_DIRS variable allows a platform
1710 kumpf 1.12 vendor to easily toggle between two sets of directory 1711 definitions, a set tuned for the development/debug
1712 karl 1.29 ("Development Build") environment and a set tuned for the
1713 kumpf 1.12 production environment ("Release Build"). Refer the section
1714 denise.eckstein 1.1 titled "Configuration Properties" for additional detail.<br> 1715 </ul> 1716
1717 s.kodali 1.18 <h5>PEGASUS_FLAVOR</h5> 1718 <ul> 1719 <b>Description: </b> This variable is used for configuring Multi CIMOM 1720 on same OS by eliminating single point for storage of PID's and configuration 1721 files. Flavor is used in structuring the release dirs,configuration file names, 1722 log identity and PAM config file. 1723 If set, OpenPegasus is built using the flavor value. By default OpenPegasus is 1724 built using "tog" as the flavor. RPMs are named using the flavor value. 1725 <br> 1726 <b>Default Value: </b>tog<br> 1727 <b>Recommended Value (Development Build): </b>tog<br> 1728 <b>Recommended Value (Release Build): </b>tog<br> 1729 <b>Required: </b>No<br> 1730 <b>Considerations: </b> 1731 To build RPM using flavor, RPM spec file needs to be regenerated after setting the flavor value. 1732 This can be done using the create_OpenPegasusRPMSpecFile target in the Makefile.Release. 1733 Platforms have to define their own release dir structure using the flavor for release builds. 1734 An error will be reported if both PEGASUS_FLAVOR and PEGASUS_USE_RELEASE_DIRS are set and 1735 PEGASUS_OVERRIDE_DEFAULT_RELEASE_DIRS is not set. 1736 RPM build on linux defines PEGASUS_OVERRIDE_DEFAULT_RELEASE_DIRS by default. 1737 <br> 1738 s.kodali 1.18 </ul> 1739
1740 s.kodali 1.22 <h5>PEGASUS_PLATFORM_FOR_32BIT_PROVIDER_SUPPORT</h5> 1741 <ul> 1742 <b>Description: </b> Builds the Pegasus with 32-bit provider support for the specified platform. 1743 If this option is set, the value MUST be one of the 32-bit supported platforms by Pegasus. 1744 <br> 1745 <b>Default Value: </b>Not set<br> 1746 <b>Recommended Value (Development Build): </b>Not set<br> 1747 <b>Recommended Value (Release Build): </b>Not set<br> 1748 <b>Required: </b>No<br> 1749 <b>Considerations: </b> 1750 This option is used to run the 32-bit providers under 64-bit CIMserver. 1751 To register the 32-bit providers, register the provider module by setting the 1752 Bitness property value to "2". 32-bit Providers are always loaded out of process 1753 irrespective of forceProviderProcesses config option. 1754 <br> 1755 </ul> 1756
1757 kumpf 1.6 <h5>PEGASUS_USE_SQLITE_REPOSITORY</h5> 1758 <ul> 1759 <b>Description: </b>If true, new repository stores are created 1760 using a SQLite database. Existing file-based stores will continue 1761 to be recognized and operate seamlessly.<br> 1762 <b>Default Value: </b>false<br> 1763 <b>Recommended Value (Development Build): </b>true<br> 1764 <b>Recommended Value (Release Build): </b>true<br> 1765 <b>Required: </b>No<br> 1766 <b>Considerations: </b>If PEGASUS_USE_SQLITE_REPOSITORY is set to true 1767 and SQLite files are not installed in default search locations, 1768 SQLITE_HOME must also be configured. 1769 PEGASUS_REPOSITORY_STORE_COMPLETE_CLASSES may not be set to true when 1770 PEGASUS_USE_SQLITE_REPOSITORY is set to true. 1771 </ul> 1772
1773 denise.eckstein 1.1 <h5>PEGASUS_USE_SYSLOGS</h5> 1774 <ul> 1775 <b>Description: </b>If set, OpenPegasus will be built 1776 to send log messages to the system logger (syslog). 1777 Otherwise, log messages will be sent to OpenPegasus 1778 specific log files.<br> 1779 <b>Recommended Value (Development Build): </b>Set<br> 1780 <b>Recommended Value (Release Build): </b>Set<br> 1781 <b>Required: </b>No<br> 1782 <b>Considerations: </b>This variable is currently 1783 not implemented as an environment variable. To use 1784 the option -DPEGASUS_USE_SYSLOGS must 1785 be explicitly included in the appropriate platform 1786 makefile (pegasus/mak/platform_*.mak).</ul> 1787 1788 <h5>PEGASUS_WINDOWS_SDK_HOME</h5> 1789 <ul>
1790 kumpf 1.12 <b>Description: </b>This variable should be set to point 1791 to the Microsoft Platform SDK on Windows if using a compiler
1792 denise.eckstein 1.1 version < 1300 (i.e. VC6). If using VC7 or VC8, this flag 1793 does not need to be set, as the necessary libraries are already 1794 included.<br> 1795 <b>Recommended Value (Development Build): </b> 1796 No Specific Recommendation<br> 1797 <b>Recommended Value (Release Build): </b> 1798 No Specific Recommendation<br> 1799 <b>Required: </b>Yes, if building on Windows with a 1800 compiler version < 1300.<br> 1801 </ul> 1802
1803 kumpf 1.6 <h5>SQLITE_HOME</h5> 1804 <ul> 1805 <b>Description: </b>Specifies the location of the SQLite SDK directory. 1806 This directory must contain sqlite3.h in the $(SQLITE_HOME)/include 1807 directory, and libsqlite3 in the $(SQLITE_HOME)/lib directory.<br> 1808 <b>Default Value: </b>Not Set<br> 1809 <b>Recommended Value (Development Build): </b> 1810 No Specific Recommendation<br> 1811 <b>Recommended Value (Release Build): </b> 1812 No Specific Recommendation<br> 1813 <b>Required: </b>Yes, if PEGASUS_USE_SQLITE_REPOSITORY is set to true 1814 and the SQLite files are not installed in locations that are searched by 1815 default.<br> 1816 <b>Considerations: </b>This environment variable is only used if 1817 PEGASUS_USE_SQLITE_REPOSITORY is set to true. 1818 </ul> 1819
1820 marek 1.24 <h5>PEGASUS_INITIAL_THREADSTACK_SIZE</h5> 1821 <ul> 1822 <b>Description: </b>This environment variable sets the initial size 1823 of the stack on new threads. Value is specified in number of bytes.<br> 1824 <b>Default Value: </b>262144<br> 1825 <b>Recommended Value (Development Build): </b>262144<br> 1826 <b>Recommended Value (Release Build): </b>262144<br>
1827 karl 1.29 <b>Required: </b>No <p></p>
1828 marek 1.24 </ul> 1829
1830 denise.eckstein 1.1 <h4>Examples Building a Linux IA32 (#IA64) Development/Debug Version</h4> 1831 <ul> 1832 export PEGASUS_ROOT=/home/pegasusbld/pegasus<br>
1833 kumpf 1.12 export PEGASUS_HOME=/home/pegasusbld/pegasus/build<br>
1834 denise.eckstein 1.1 export PEGASUS_PLATFORM=LINUX_IX86_GNU<br>
1835 kumpf 1.12 #export PEGASUS_PLATFORM=LINUX_IA64_GNU<br> 1836 export PEGASUS_PAM_AUTHENTICATION=true<br>
1837 denise.eckstein 1.1 export PEGASUS_USE_PAM_STANDALONE_PROC=true<br>
1838 kumpf 1.12 export PEGASUS_HAS_SSL=yes<br>
1839 denise.eckstein 1.1 export PEGASUS_DEBUG=TRUE<br> 1840 export ENABLE_CMPI_PROVIDER_MANAGER=true<br>
1841 kumpf 1.12 export PEGASUS_USE_SYSLOGS=true<br>
1842 denise.eckstein 1.1 export PATH=/home/pegasusbld:/home/pegasusbld/pegasus/build/bin:/usr/local/bin:$PATH<br> 1843 </ul> 1844 1845 <h4>Building a Linux IA32 (#IA64) Production Release Version</h4> 1846 <ul> 1847 export PEGASUS_ROOT=/home/pegasusbld/pegasus<br> 1848 export PEGASUS_HOME=/home/pegasusbld/pegasus/build<br> 1849 export PEGASUS_PLATFORM=LINUX_IX86_GNU<br> 1850 #export PEGASUS_PLATFORM=LINUX_IA64_GNU<br>
1851 kumpf 1.16 export PEGASUS_ENABLE_CQL=false<br> 1852 export PEGASUS_PAM_AUTHENTICATION=true<br>
1853 denise.eckstein 1.1 export PEGASUS_USE_PAM_STANDALONE_PROC=true<br> 1854 export PEGASUS_HAS_SSL=yes<br> 1855 export PEGASUS_USE_RELEASE_CONFIG_OPTIONS=true<br>
1856 kumpf 1.12 export PEGASUS_USE_RELEASE_DIRS=true<br>
1857 denise.eckstein 1.1 export PEGASUS_NOASSERTS=true<br> 1858 export ENABLE_CMPI_PROVIDER_MANAGER=true<br> 1859 export PEGASUS_ENABLE_USERGROUP_AUTHORIZATION=true<br> 1860 export PEGASUS_USE_SYSLOGS=true<br> 1861 export PATH=/home/pegasusbld:/home/pegasusbld/pegasus/build/bin:/usr/local/bin:$PATH<br> 1862 </ul> 1863 1864 <h3>Environment Variable Settings for <u>Running</u> OpenPegasus</h3> 1865 1866 <h4>Definitions</h4> 1867 1868 <h5>PEGASUS_HOME</h5> 1869 <ul>
1870 kumpf 1.12 <b>Description: </b>There are multiple options for
1871 denise.eckstein 1.1 configuring the location of OpenPegasus runtime
1872 kumpf 1.12 files (e.g., configuration files, libraries,
1873 denise.eckstein 1.1 repository, executables). If no other option is 1874 specified, OpenPegasus will attempt to use the value 1875 PEGASUS_HOME.<br> 1876 <b>Default Value: </b>"."<br> 1877 <b>Recommended Value (Development Build): </b> 1878 The same value defined at build time.<br> 1879 <b>Recommended Value (Release Build): </b>Not Set<br> 1880 <b>Required: </b>No<br> 1881 <b>Considerations: </b>Although this variable can be 1882 useful in a development environment use of this environment 1883 variable is not recommended in a production environment. 1884 Instead, the use of configuration properties to explicitly 1885 set the location of runtime files and directories is recommended. 1886 </ul> 1887 1888 <h5>PEGASUS_MSG_HOME</h5> 1889 <ul> 1890 <b>Description: </b>This value is not used by the CIM 1891 Server.  The CIM Server uses the messageDir configuration 1892 parameter to locate the directory where the ICU resource bundles. 1893 However, CIM Client applications must rely on an alternative 1894 denise.eckstein 1.1 mechanism to locate this directory.<br>
1895 kumpf 1.12 <b>Default Value: </b>if $PEGASUS_HOME is set then
1896 karl 1.29 "$PEGASUS_HOME/msg" else "."<br>
1897 denise.eckstein 1.1 <b>Recommended Value (Development Build): </b>$PEGASUS_HOME/msg<br> 1898 <b>Recommended Value (Release Build): </b>Not Set <br> 1899 <b>Required: </b>No<br> 1900 </ul> 1901 1902 <h3>Configuration Properties</h3> 1903 1904 <h4>Notation</h4> 1905
1906 kumpf 1.12 <p>This section describes the notation used to define the
1907 denise.eckstein 1.1 configuration properties.</p> 1908 1909 <ul> 1910 1911 <h5>Default Value</h5> 1912 The value of <i>Default Value</i> is the OpenPegasus 1913 default setting for this configuration option. This 1914 value is used if a platform-specific setting is not
1915 kumpf 1.12 defined.
1916 denise.eckstein 1.1 1917 <h5>Recommended Default Value</h5>
1918 kumpf 1.12 The PEGASUS_USE_RELEASE_CONFIG_OPTIONS variable allows a 1919 platform vendor to easily toggle between two sets of
1920 denise.eckstein 1.1 configurations options, a set of options tuned for the
1921 karl 1.29 development/debug ("Development Build") environment
1922 denise.eckstein 1.1 and a set of options tuned for the production environment
1923 kumpf 1.12 ("Release Build"). The value of 1924 <i>Recommended Value (Development Build)</i>
1925 denise.eckstein 1.1 is the recommended default value for use in a development/
1926 kumpf 1.12 debug environment. The value of
1927 denise.eckstein 1.1 <i>Recommended Value (Release Build)</i> is the recommended
1928 kumpf 1.12 default value for use in a production environment. 1929
1930 denise.eckstein 1.1 <h5>Recommend To Be Fixed/Hidden</h5> 1931 Configuration options can be defined as fixed or hidden. 1932 A "fix" configuration option is set at build time
1933 kumpf 1.12 and cannot be changed without rebuilding. "Fixed"
1934 denise.eckstein 1.1 configuration options are not displayed using the cimconfig
1935 kumpf 1.12 command. This feature can be used by vendors to limit
1936 denise.eckstein 1.1 OpenPegasus functionality and configurability.
1937 kumpf 1.12 1938 A "hidden" configuration option is an option that is
1939 denise.eckstein 1.1 configurable (i.e., "not fixed"), but not externally 1940 advertised using the cimconfig command. The "hidden" 1941 feature can be used to define "internal use only" 1942 configuration options.
1943 kumpf 1.12
1944 denise.eckstein 1.1 <h5>Dynamic?</h5> 1945 If yes, the value of the configuration option can be 1946 changed without stopping and restarting the CIM Server. 1947 1948 <h5>Directory Specifications</h5> 1949 <p>Note that the variables included in the following table
1950 kumpf 1.12 (e.g., $LOGDIR) are for documentation purposes only and 1951 have been defined to simplify the description of the 1952 configuration options.  In particular,
1953 denise.eckstein 1.1 these variables DO NOT correspond to environment variables
1954 kumpf 1.12 implemented in the OpenPegasus code.  Default values 1955 for the following variables are platform
1956 denise.eckstein 1.1 and vendor dependent and not documented in this document.</p> 1957
1958 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" height="228" width="148"> 1959 <tbody><tr> 1960 <th bgcolor="#cae6ca" height="16" width="1"> </th>
1961 denise.eckstein 1.1 </tr> 1962 <tr align="center">
1963 karl 1.29 <td align="left" height="12" width="1">$LOGDIR</td>
1964 denise.eckstein 1.1 </tr> 1965 <tr align="center">
1966 karl 1.29 <td align="left" height="14" width="1">$PROVIDERDIRS</td>
1967 denise.eckstein 1.1 </tr> 1968 <tr align="center">
1969 karl 1.29 <td align="left" height="14" width="1">
1970 denise.eckstein 1.1 $PROVIDERMANAGERDIRS</td> 1971 </tr> 1972 <tr align="center">
1973 karl 1.29 <td align="left" height="14" width="1">$REPOSITORYDIR </td>
1974 denise.eckstein 1.1 </tr> 1975 <tr align="center">
1976 karl 1.29 <td align="left" height="14" width="1">$CERTIFICATEDIR
1977 denise.eckstein 1.1 </td> 1978 </tr> 1979 <tr align="center">
1980 karl 1.29 <td align="left" height="14" width="1">$LOCALAUTHDIR</td>
1981 denise.eckstein 1.1 </tr> 1982 <tr align="center">
1983 karl 1.29 <td align="left" height="14" width="1">$TRACEDIR</td>
1984 denise.eckstein 1.1 </tr> 1985 <tr align="center">
1986 karl 1.29 <td align="left" height="14" width="1">$CONFIGDIR</td>
1987 denise.eckstein 1.1 </tr> 1988 <tr align="center">
1989 karl 1.29 <td align="left" height="14" width="1">$PIDFILE</td>
1990 denise.eckstein 1.1 </tr> 1991 <tr align="center">
1992 karl 1.29 <td align="left" height="14" width="1">$RANDOMDIR</td>
1993 denise.eckstein 1.1 </tr> 1994 <tr align="center">
1995 karl 1.29 <td align="left" height="14" width="1">$SOCKETDIR</td>
1996 denise.eckstein 1.1 </tr> 1997 <tr align="center">
1998 karl 1.29 <td align="left" height="14" width="1">$MESSAGEDIR</td>
1999 denise.eckstein 1.1 </tr>
2000 karl 1.29 </tbody></table>
2001 kumpf 1.12 </ul>
2002 denise.eckstein 1.1 2003 <h4>Definitions</h4> 2004 2005 <h5>authorizedUserGroups</h5> 2006 <ul>
2007 kumpf 1.12 <b>Description:</b> If the <b>authorizedUserGroups</b>
2008 denise.eckstein 1.1 property is set, the value is interpreted as a list of 2009 comma-separated user groups whose members may issue CIM 2010 requests. A user who is not a member of any of these groups is 2011 restricted from issuing CIM requests, with the exception of 2012 privileged users (root user). If the <b>authorizedUserGroups</b> 2013 property is not set, any user may issue CIM requests.<br> 2014 <b>Default Value: </b>blank<br> 2015 <b>Recommended Default Value (Development Build): </b>blank<br> 2016 <b>Recommended Default Value (Release Build): </b>blank<br> 2017 <b>Recommend To Be Fixed/Hidden (Development Build): </b> 2018 No/No<br> 2019 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2020 <b>Dynamic?: </b>No<br> 2021 <b>Example: </b> 2022 #cimconfig -s authorizedUserGroups=users,systemusers -p<br> 2023 <b>Considerations: </b>This feature is available only when 2024 the OpenPegasus source is compiled with the flag 2025 PEGASUS_ENABLE_USERGROUP_AUTHORIZATION set. 2026 </ul> 2027 2028 <h5>daemon</h5> 2029 denise.eckstein 1.1 <ul> 2030 <b>Description: </b>This option enables/disables forking of 2031 the code to create a background daemon process.<br> 2032 <b>Default Value: </b>true<br> 2033 <b>Recommended Default Value (Development Build): </b>true<br> 2034 <b>Recommended Default Value (Release Build): </b>true<br> 2035 <b>Recommend To Be Fixed/Hidden (Development Build): </b> 2036 No/No<br> 2037 <b>Recommend To Be Fixed/Hidden (Release Build): </b> 2038 No/Yes<br> 2039 <b>Dynamic?: </b>No<p> <br> 2040 <br>
2041 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2042 <tbody><tr> 2043 <th bgcolor="#cae6ca" width="168">Platform</th> 2044 <th bgcolor="#cae6ca" width="350">Source Configuration File</th>
2045 denise.eckstein 1.1 </tr> 2046 <tr align="center"> 2047 <td width="168">Linux</td> 2048 <td align="left" width="350"> 2049 Pegasus/Config/DefaultPropertyTableLinux.h</td> 2050 </tr> 2051 <tr align="center"> 2052 <td width="168">HP-UX</td> 2053 <td align="left" width="350"> 2054 Pegasus/Config/DefaultPropertyTableHpux.h</td> 2055 </tr> 2056 <tr align="center"> 2057 <td width="168">OpenVMS</td> 2058 <td align="left" width="350"> 2059 Pegasus/Config/DefaultPropertyTableVms.h</td> 2060 </tr>
2061 karl 1.29 </tbody></table> 2062 </p></ul>
2063 denise.eckstein 1.1 2064 <h5>enableAssociationTraversal</h5> 2065 <ul> 2066 <b>Description: </b>If true, the CIM Server will support
2067 kumpf 1.12 the four association traversal operators: Associators,
2068 denise.eckstein 1.1 AssociatorNames,References, and ReferenceNames.<br> 2069 <b>Default Value: </b>true<br> 2070 <b>Recommended Default Value (Development Build): </b>true<br> 2071 <b>Recommended Default Value (Release Build): </b>true<br> 2072 <b>Recommend To Be Fixed/Hidden (Development Build): </b> 2073 No/No<br> 2074 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2075 <b>Dynamic?: </b>No<br>
2076 kumpf 1.12 <b>Considerations: </b>There is still an outstanding
2077 denise.eckstein 1.1 Provider Registration issue that restricts the degree to 2078 which separate Providers can register for Associations.<br> 2079 <br>
2080 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2081 <tbody><tr> 2082 <th bgcolor="#cae6ca" width="168">Platform</th> 2083 <th bgcolor="#cae6ca" width="350">Source Configuration File</th>
2084 denise.eckstein 1.1 </tr> 2085 <tr align="center"> 2086 <td width="168">Linux</td> 2087 <td align="left" width="350"> 2088 Pegasus/Config/DefaultPropertyTableLinux.h</td> 2089 </tr> 2090 <tr align="center"> 2091 <td width="168">HP-UX</td> 2092 <td align="left" width="350"> 2093 Pegasus/Config/DefaultPropertyTableHpux.h</td> 2094 </tr> 2095 <tr align="center"> 2096 <td width="168">OpenVMS</td> 2097 <td align="left" width="350"> 2098 Pegasus/Config/DefaultPropertyTableVms.h</td> 2099 </tr>
2100 karl 1.29 </tbody></table>
2101 denise.eckstein 1.1 </ul> 2102 2103 <h5>enableAuditLog</h5> 2104 <ul>
2105 kumpf 1.12 <b>Description: </b>Used to enable or disable audit
2106 denise.eckstein 1.1 logging at run time. If true, audit logging will be enabled.<br> 2107 <b>Recommended Default Value (Development Build): </b>false<br> 2108 <b>Recommended Default Value (Release Build): </b>false<br> 2109 <b>Recommend To Be Fixed/Hidden (Development Build): </b> 2110 No/No<br> 2111 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2112 <b>Dynamic?: </b>Yes<br> 2113 <b>Source Configuration File: </b> 2114 Pegasus/Config/DefaultPropertyTable.h<br> 2115 </ul> 2116 2117 <h5>enableAuthentication</h5> 2118 <ul> 2119 <b>Description: </b>If true, a Client must be authenticated 2120 to access the CIM Server.<br> 2121 <b>Recommended Default Value (Development Build): </b>false<br> 2122 <b>Recommended Default Value (Release Build): </b>true<br> 2123 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2124 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 2125 <b>Dynamic?: </b>No<br> 2126 <b>Source Configuration File: </b> 2127 denise.eckstein 1.1 Pegasus/Config/SecurityPropertyOwner.cpp<br> 2128 </ul> 2129 2130 <h5>enableBinaryRepository</h5> 2131 <ul> 2132 <b>Description: </b>Setting this to true will activate the 2133 binary repository support on the next restart of cimserver.<br> 2134 <b>Recommended Default Value (Development Build): </b>false<br> 2135 <b>Recommended Default Value (Release Build): </b>false<br> 2136 <b>Recommend To Be Fixed/Hidden (Development Build): </b>Yes<br> 2137 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 2138 <b>Dynamic?: </b>No<br> 2139 <b>Considerations: </b>Repositories containing a mixture 2140 of binary and XML objects are supported.<br> 2141 <b>Source Configuration File: </b>
2142 karl 1.29 Pegasus/Config/RepositoryPropertyOwner.cpp<p></p>
2143 denise.eckstein 1.1 </ul> 2144 2145 2146 <h5>enableHttpConnection</h5> 2147 <ul> 2148 <b>Description: </b>If true, allows connections to 2149 the CIM Server using the HTTP protocol<br> 2150 <b>Default Value: </b>true<br> 2151 <b>Recommended Default Value (Development Build): </b>true<br> 2152 <b>Recommended Default Value (Release Build): </b>false<br> 2153 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2154 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2155 <b>Dynamic?: </b>No<br> 2156 <b>Considerations: </b>
2157 kumpf 1.12 Enabling HTTP will allow clients to connect with security 2158 properties different than those associated with encrypted SSL
2159 denise.eckstein 1.1 traffic, and its configured SSL authentication or other security 2160 behavior. This option should only be enabled in environments 2161 where sending the HTTP Request and HTTP Response as 2162 clear text messages does not introduce a security risk.
2163 kumpf 1.12 Note that if authentication is enabled (enableAuthentication), 2164 user names and passwords will be included in the text of the
2165 denise.eckstein 1.1 HTTP message.<br> 2166 <br>
2167 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2168 <tbody><tr> 2169 <th bgcolor="#cae6ca" width="168">Platform</th> 2170 <th bgcolor="#cae6ca" width="350">Source Configuration File</th>
2171 denise.eckstein 1.1 </tr> 2172 <tr align="center"> 2173 <td width="168">Linux</td> 2174 <td align="left" width="350"> 2175 Pegasus/Config/DefaultPropertyTableLinux.h</td> 2176 </tr> 2177 <tr align="center"> 2178 <td width="168">HP-UX</td> 2179 <td align="left" width="350"> 2180 Pegasus/Config/DefaultPropertyTableHpux.h</td> 2181 </tr> 2182 <tr align="center"> 2183 <td width="168">OpenVMS</td> 2184 <td align="left" width="350"> 2185 Pegasus/Config/DefaultPropertyTableVms.h</td> 2186 </tr>
2187 karl 1.29 </tbody></table>
2188 denise.eckstein 1.1 </ul> 2189 2190 <h5>enableHttpsConnection</h5> 2191 <ul>
2192 kumpf 1.12 <b>Description: </b>If true, allows connections to 2193 the CIM Server using the HTTPS protocol (HTTP using
2194 denise.eckstein 1.1 Secure Socket Layer encryption)<br> 2195 <b>Default Value: </b>false<br> 2196 <b>Recommended Default Value (Development Build): </b>true<br> 2197 <b>Recommended Default Value (Release Build): </b>true<br> 2198 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2199 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2200 <b>Dynamic?: </b>No<br> 2201 <b>Considerations: </b>For this option to work, 2202 the environment variable PEGASUS_HAS_SSL must have 2203 been set when CIM Server was built.<br> 2204 <br>
2205 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2206 <tbody><tr> 2207 <th bgcolor="#cae6ca" width="168">Platform</th> 2208 <th bgcolor="#cae6ca" width="350">Source Configuration File</th>
2209 denise.eckstein 1.1 </tr> 2210 <tr align="center"> 2211 <td width="168">Linux</td> 2212 <td align="left" width="350"> 2213 Pegasus/Config/DefaultPropertyTableLinux.h</td> 2214 </tr> 2215 <tr align="center"> 2216 <td width="168">HP-UX</td> 2217 <td align="left" width="350"> 2218 Pegasus/Config/DefaultPropertyTableHpux.h</td> 2219 </tr> 2220 <tr align="center"> 2221 <td width="168">OpenVMS</td> 2222 <td align="left" width="350"> 2223 Pegasus/Config/DefaultPropertyTableVms.h</td> 2224 </tr>
2225 karl 1.29 </tbody></table>
2226 denise.eckstein 1.1 </ul> 2227 2228 <h5>enableIndicationService</h5> 2229 <ul> 2230 <b>Description: </b>If true, the CIM Server will support 2231 CIM Indications.<br> 2232 <b>Default Value: </b>true<br> 2233 <b>Recommended Default Value (Development Build): </b>true<br> 2234 <b>Recommended Default Value (Release Build): </b>true<br> 2235 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2236 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2237 venkat.puvvada 1.15 <b>Dynamic?: </b>Yes/No<br> 2238 <b>Considerations: </b>When enableIndicationService is set to 2239 false dynamically, delete subscription requests are sent to all 2240 indication providers and indication related operations are 2241 not supported until indication service is re-enabled. Dynamic 2242 configuration facility is available only when Pegasus is compiled 2243 with PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT=true. Clients 2244 who wants to utilize the IndicationService services MUST check for 2245 CIM_IndicationService EnabledState and HealthState properties to know 2246 the current indication service state. For example, User can enumerate 2247 instances of CIM_IndicationService and there is exactly one instance 2248 of CIM_IndicationService returned. (Ex. using cimcli command 2249 'cimcli ei -n root/PG_InterOp CIM_IndicationService'). When requested state 2250 change(Enabled/Disabled) cannot be made because of timeout or some 2251 other exception IndicationService HealthState is set to "Degraded/Warning". 2252 For example, if user requested for indication service disable (by setting 2253 enableIndicationService=false), disable failed because of timeout or some 2254 other exception. Now service health state is set to "Degraded/Warning" 2255 and service EnabledState will remain enabled. User can now identify the 2256 faulty provider causing the timeout or any other problem and can take 2257 appropriate action. User can again request for service disable to recover 2258 venkat.puvvada 1.15 from degraded state. Similar sequence applies while enabling the indication 2259 service. Only difference is that service EnabledState is set to Enabled 2260 if exception or timeout happens. There is no automatic recovery from 2261 degraded state is available at present.<br>
2262 denise.eckstein 1.1 <br>
2263 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2264 <tbody><tr> 2265 <th bgcolor="#cae6ca" width="168">Platform</th> 2266 <th bgcolor="#cae6ca" width="350">Source Configuration File</th>
2267 denise.eckstein 1.1 </tr> 2268 <tr align="center"> 2269 <td width="168">Linux</td> 2270 <td align="left" width="350"> 2271 Pegasus/Config/DefaultPropertyTableLinux.h</td> 2272 </tr> 2273 <tr align="center"> 2274 <td width="168">HP-UX</td> 2275 <td align="left" width="350"> 2276 Pegasus/Config/DefaultPropertyTableHpux.h</td> 2277 </tr> 2278 <tr align="center"> 2279 <td width="168">OpenVMS</td> 2280 <td align="left" width="350"> 2281 Pegasus/Config/DefaultPropertyTableVms.h</td> 2282 </tr>
2283 karl 1.29 </tbody></table>
2284 denise.eckstein 1.1 </ul> 2285 2286 <h5>enableNamespaceAuthorization</h5> 2287 <ul> 2288 <b>Description: </b>If true, the CIM Server restricts
2289 kumpf 1.12 access to namespaces based on configured user authorizations 2290 [user authorizations may be configured using the cimauth
2291 denise.eckstein 1.1 command]<br> 2292 <b>Default Value: </b>false<br> 2293 <b>Recommended Default Value (Development Build): </b>false<br> 2294 <b>Recommended Default Value (Release Build): </b>false<br> 2295 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2296 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2297 <b>Dynamic?: </b>No<br> 2298 <b>Considerations: </b> 2299 This option offers limited functionality and, in most 2300 environments, expensive to administer. It's use is not 2301 recommended.<br> 2302 <b>Source Configuration File: </b> 2303 Pegasus/Config/SecurityPropertyOwner.cpp</ul> 2304 2305 <h5>enableNormalization</h5> 2306 <ul>
2307 kumpf 1.12 <b>Description: </b>If true, objects returned from instance
2308 denise.eckstein 1.1 providers are validated and normalized. <br> 2309 <b>Default Value: </b>true<br> 2310 <b>Recommended Default Value (Development Build): </b>true<br> 2311 <b>Recommended Default Value (Release Build): </b>false<br> 2312 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2313 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2314 kavita.gupta 1.7 <b>Dynamic?: </b>Yes<br>
2315 denise.eckstein 1.1 <b>Considerations: </b> 2316 <ul> 2317 <li>Any errors encountered during normalization result in a
2318 kumpf 1.12 CIMException with the status code set to CIM_ERR_FAILED 2319 and a meaningful, context specific error description
2320 denise.eckstein 1.1 (messages will be localized). Providers that catch the
2321 kumpf 1.12 exception have an opportunity to handle the error.
2322 denise.eckstein 1.1 Otherwise, the exception is passed to the Provider Manager
2323 kumpf 1.12 and becomes the response for that Provider.
2324 karl 1.29 </li><li>Provider Modules that are listed on the
2325 kumpf 1.12 excludeModulesFromNormalization 2326 configuration option are excluded from normalization.
2327 karl 1.29 </li><li>Since the concept of normalization is relatively new to
2328 denise.eckstein 1.1 OpenPegasus and it establishes and enforces rules for
2329 kumpf 1.12 objects returned by providers, it should only 2330 apply to providers written against the SDK in which it was
2331 denise.eckstein 1.1 introduced (or later). Therefore only Provider Modules that
2332 kumpf 1.12 have the following InterfaceType and InterfaceVersion 2333 combination will be subject to normalization:
2334 denise.eckstein 1.1 <ul>
2335 kumpf 1.12 <li>'C++Default' / 2.5.0 or greater
2336 karl 1.29 </li><li>'CMPI' / 2.0.0 or greater 2337 </li><li>'JMPI' / 1.0.0 or greater 2338 </li></ul> 2339 </li></ul>
2340 denise.eckstein 1.1 <b>Source Configuration File: </b> 2341 Pegasus/Config/NormalizationPropertyOwner.cpp<br> 2342 </ul> 2343 2344 2345 <h5>enableRemotePrivilegedUserAccess</h5> 2346 <ul>
2347 kumpf 1.12 <b>Description: </b>If true, the CIM Server allows
2348 denise.eckstein 1.1 access by a privileged user from a remote system<br> 2349 <b>Default Value: </b>true<br> 2350 <b>Recommended Default Value (Development Build): </b>true<br> 2351 <b>Recommended Default Value (Release Build): </b>true<br> 2352 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2353 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2354 <b>Dynamic?: </b>No<br> 2355 <b>Considerations: </b>Many management operations require 2356 privileged user access. Disabling remote access by
2357 kumpf 1.12 privileged user could significantly affect
2358 denise.eckstein 1.1 functionality.<br> 2359 <b>Source Configuration File: </b> 2360 Pegasus/Config/SecurityPropertyOwner.cpp<p> </p> 2361 </ul> 2362 2363 <h5>enableSubscriptionsForNonprivilegedUsers</h5> 2364 <ul> 2365 <b>Description: </b>If true, operations (create instance,
2366 kumpf 1.12 modify instance, delete instance, get instance, enumerate 2367 instances, enumerate instance names) on indication 2368 filter, listener destination, and subscription instances
2369 denise.eckstein 1.1 may be performed by non-privileged users. Otherwise, these 2370 operations may only be performed on these instances by 2371 privileged users.<br> 2372 <b>Default Value: </b>true<br> 2373 <b>Recommended Default Value (Development Build): </b>true<br> 2374 <b>Recommended Default Value (Release Build): </b>false<br> 2375 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2376 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2377 <b>Dynamic?: </b>No<br>
2378 kumpf 1.12 <b>Considerations: </b>This option has meaning only if
2379 denise.eckstein 1.1 enableIndicationService=true.<br> 2380 <b>Source Configuration File: </b> 2381 Pegasus/Config/SecurityPropertyOwner.cpp<p> </p> 2382 </ul> 2383 2384 <h5>excludeModulesFromNormalization</h5> 2385 <ul>
2386 kumpf 1.12 <b>Description: </b>If the excludeModulesfromNormalization 2387 property is set, the value is interpreted as a list of 2388 comma-separated Provider Module names (as specified in 2389 PG_ProviderModule.Name) to exclude from validation and
2390 denise.eckstein 1.1 normalization.<br>
2391 karl 1.29 <b>Default Value: </b>""<br>
2392 denise.eckstein 1.1 <b>Recommended Default Value (Development Build):</b>
2393 karl 1.29 ""<br>
2394 denise.eckstein 1.1 <b>Recommended Default Value (Release Build): </b>
2395 karl 1.29 ""<br>
2396 denise.eckstein 1.1 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2397 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2398 <b>Dynamic?: </b>No<br> 2399 <b>Considerations: </b>All objects managed by all 2400 providers will be excluded from validation and normalization 2401 if its module name appears in this list.<br> 2402 <b>Source Configuration File: </b> 2403 Pegasus/Config/NormalizationPropertyOwner.cpp 2404 </ul> 2405 2406 <h5>forceProviderProcesses</h5> 2407 <ul> 2408 <b>Description: </b>If true, the CIM Server runs Providers 2409 in separate processes rather than loading and calling Provider 2410 libraries directly within the CIM Server process.<br>
2411 kumpf 1.12 <b>Default Value: </b>Dependent on the value of
2412 denise.eckstein 1.1 PEGASUS_DEFAULT_ENABLE_OOP<br> 2413 <b>Recommended Default Value (Development Build):</b>true (HP-UX, 2414 Linux)<br> 2415 <b>Recommended Default Value (Release Build): </b>true (HP-UX, 2416 Linux)<br> 2417 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2418 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2419 <b>Dynamic?: </b>No<br> 2420 <b>Considerations: </b>In a dynamic, potentially multi-vendor,
2421 kumpf 1.12 environment, the ability to run Providers in separate processes 2422 can significantly increase the stability, maintainability and
2423 denise.eckstein 1.1 supportability of the overall solution.  Running Providers 2424 in separate process spaces: (1) helps isolate components (i.e.,
2425 kumpf 1.12 cimserver and Providers) from a catastrophic failure
2426 denise.eckstein 1.1 (segmentation faults, memory leaks) of a single Provider and (2) 2427 reduces the risk of accidental or malicious sharing of sensitive
2428 kumpf 1.12 data among Providers.  This benefit comes at a cost.  2429 Moving Providers out of the cimserver process increases
2430 denise.eckstein 1.1 communication costs and can significantly increase response 2431 time.  Actual results will vary, but it is common for 2432 response times to increase by a factor of 2.<br>
2433 kumpf 1.12 <b>Note 1: </b>When forceProviderProcesses is true, the CIM
2434 denise.eckstein 1.1 Server will load each Provider Module (i.e., library) into a 2435 separate process. Providers in different Provider Modules 2436 cannot depend on a communication mechanism that 2437 requires them to run in the same process space.<br>
2438 kumpf 1.12 <b>Note 2: </b>Although the catastrophic failure of an
2439 denise.eckstein 1.1 Out-Of-Process (OOP) Provider Module will not result in a 2440 failure of the CIM Server process, if the failed OOP Provider
2441 kumpf 1.12 Module included Indication Providers, Indications may be
2442 denise.eckstein 1.1 lost.  If logging is enabled, the CIM Server will log a 2443 message informing administrators of what happened and what 2444 corrective actions can be taken.<br> 2445 <br>
2446 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2447 <tbody><tr> 2448 <th bgcolor="#cae6ca" width="168">Platform</th> 2449 <th bgcolor="#cae6ca" width="350">
2450 denise.eckstein 1.1 Source Configuration File</th> 2451 </tr> 2452 <tr align="center"> 2453 <td width="168">Linux</td> 2454 <td align="left" width="350"> 2455 Pegasus/Config/DefaultPropertyTableLinux.h</td> 2456 </tr> 2457 <tr align="center"> 2458 <td width="168">HP-UX</td> 2459 <td align="left" width="350"> 2460 Pegasus/Config/DefaultPropertyTableHpux.h</td> 2461 </tr> 2462 <tr align="center"> 2463 <td width="168">OpenVMS</td> 2464 <td align="left" width="350"> 2465 Pegasus/Config/DefaultPropertyTableVms.h</td> 2466 </tr>
2467 karl 1.29 </tbody></table>
2468 denise.eckstein 1.1 </ul> 2469 2470 <h5>home</h5> 2471 <ul> 2472 <b>Description: </b>If set, this configuration option defines 2473 the runtime default value for PEGASUS_HOME.<br> 2474 <b>Default Value: </b>"./"<br> 2475 <b>Recommended Default Value (Development Build)</b>"./"<br> 2476 <b>Recommended Default Value (Release Build)""</b><br> 2477 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2478 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 2479 <b>Dynamic?: </b>No<p> <br> 2480 <br>
2481 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2482 <tbody><tr> 2483 <th bgcolor="#cae6ca" width="168">Platform</th> 2484 <th bgcolor="#cae6ca" width="350">Source Configuration File</th>
2485 denise.eckstein 1.1 </tr> 2486 <tr align="center"> 2487 <td width="168">Linux</td> 2488 <td align="left" width="350"> 2489 Pegasus/Config/DefaultPropertyTableLinux.h</td> 2490 </tr> 2491 <tr align="center"> 2492 <td width="168">HP-UX</td> 2493 <td align="left" width="350"> 2494 Pegasus/Config/DefaultPropertyTableHpux.h</td> 2495 </tr> 2496 <tr align="center"> 2497 <td width="168">OpenVMS</td> 2498 <td align="left" width="350"> 2499 Pegasus/Config/DefaultPropertyTableVms.h</td> 2500 </tr>
2501 karl 1.29 </tbody></table> 2502 </p></ul>
2503 denise.eckstein 1.1
2504 marek 1.34 <h5>hostname</h5> 2505 <ul> 2506 <b>Description: </b> Can be used to override the local system supplied 2507 hostname without domain the CIM Server is using to build objects. 2508 If not set, querying this configuration option will report 2509 the system supplied hostname and behavior is not changed.<br> 2510 Setting this value to a valid hostname on CIM Server startup or as 2511 planned value will force the server to assume the configured name as the 2512 local hosts name. Setting this allows the administrator to set the name 2513 that operations such as associator, reference etc. return with 2514 object paths.<br> 2515 In common setups it is not recommended to explicitly set this value. 2516 <br> 2517 <b>Usage scenarios: </b> The following scenarios in which changing the 2518 default value makes sense are known today:<br> 2519 1. The case where what the CIM Server shall return to clients for 2520 host name is NOT the name of the current host but some 2521 administrator defined name 2522 (ex. system behind a firewall or some redirector).<br> 2523 2. Embedded systems that have a system set hostname which is not 2524 valid and needs to be overridden by CIM administrator without 2525 marek 1.34 changing the actual IP configuration. 2526 <br> 2527 <b>Recommended Default Value (Development Build): </b> 2528 blank<br> 2529 <b>Recommended Default Value (Release Build): </b> 2530 blank<br> 2531 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2532 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2533 <b>Dynamic?: </b>No<br> 2534 <b>Considerations: </b> When setting this configuration option the option 2535 fullyQualifiedHostName should be adjusted too.<br> 2536 Providers returning the systems hostname in an 2537 instance property might return a different value then the CIM server is 2538 setting in the object path. hostnames explicitly set into the object 2539 paths by providers will not be overridden by the CIM Server to allow 2540 cross-namespace associations. 2541 <br> 2542 It is necessary to upgrade existing repositories using the repupgrade 2543 utility when upgrading from an OpenPegasus version less than 2.12. 2544 <br> 2545 <b>Source Configuration File: </b> 2546 marek 1.34 Pegasus/Config/DefaultPropertyOwner.cpp 2547 </ul> 2548 2549 <h5>fullyQualifiedHostName</h5> 2550 <ul> 2551 <b>Description: </b> Can be used to override the local system supplied 2552 fully qualified hostname (with domain) the CIM Server is using to build 2553 objects. 2554 If not set, querying this configuration option will report 2555 the system supplied fully qualified hostname and behavior is 2556 not changed.<br> 2557 Setting this value to a valid hostname on CIM Server startup or as 2558 planned value will force the server to assume the configured name as the 2559 local hosts name with domain. Setting this allows the administrator to 2560 set the name that indication operations and the CIM_ObjectManager 2561 assume for SystemName returned as instance and key properties.<br> 2562 In common setups it is not recommended to explicitly set this value. 2563 <br> 2564 <b>Usage scenarios: </b> The following scenarios in which changing the 2565 default value makes sense are known today:<br> 2566 1. The case where what the CIM Server shall return to clients for 2567 marek 1.34 SystemName is NOT the name of the current host but some 2568 administrator defined name 2569 (ex. system behind a firewall or some redirector).<br> 2570 2. Embedded systems that have a system set hostname which is not 2571 valid and needs to be overridden by CIM administrator without 2572 changing the actual IP configuration. 2573 <br> 2574 <b>Recommended Default Value (Development Build): </b> 2575 blank<br> 2576 <b>Recommended Default Value (Release Build): </b> 2577 blank<br> 2578 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2579 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2580 <b>Dynamic?: </b>No<br> 2581 <b>Considerations: </b> When setting this configuration option the option 2582 fullyQualifiedHostName should be adjusted too.<br> 2583 Providers returning the systems hostname in an 2584 instance property might return a different value then the CIM server is 2585 setting in SystemName. 2586 <br> 2587 It is necessary to upgrade existing repositories using the repupgrade 2588 marek 1.34 utility when upgrading from an OpenPegasus version less than 2.12. 2589 <br> 2590 <b>Source Configuration File: </b> 2591 Pegasus/Config/DefaultPropertyOwner.cpp 2592 </ul> 2593
2594 denise.eckstein 1.1 <h5>httpPort</h5> 2595 <ul>
2596 kumpf 1.12 <b>Description: </b>OpenPegasus first attempts to look up the
2597 denise.eckstein 1.1 port number for HTTP using getservbyname for the 'wbem-http'
2598 kumpf 1.12 service. The httpPort configuration setting is used only when the
2599 denise.eckstein 1.1 getservbyname lookup fails.<br> 2600 <b>Default Value: </b>blank<br> 2601 <b>Recommended Default Value (Development Build): </b>blank<br> 2602 <b>Recommended Default Value (Release Build): </b>5988<br> 2603 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2604 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 2605 <b>Dynamic?: </b>No<br>
2606 kumpf 1.12 <b>Considerations: </b>(1)The use of 5988 for WBEM HTTP is
2607 denise.eckstein 1.1 recommended by the DMTF. This port has been registered with 2608 <a href="http://www.iana.org/assignments/port-numbers"> 2609 IANA</a>. In a production environment, the recommendation is 2610 to use /etc/services to configure the value of this port. (2)
2611 kumpf 1.12 With the release of OpenPegasus 2.5, the default values for
2612 karl 1.29 httpPort was changed from 5988 to "". This
2613 denise.eckstein 1.1 change was made to allow the OpenPegasus to differentiate
2614 kumpf 1.12 between a default setting of 5988 and a customer-defined
2615 denise.eckstein 1.1 setting of 5988.  With this change,  if the port
2616 kumpf 1.12 number is explicitly set, the configured port will be used
2617 denise.eckstein 1.1 regardless of the settings in /etc/services. If no port number 2618 is specified, the server will continue to use the value in 2619 /etc/services.<br> 2620 <br>
2621 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2622 <tbody><tr> 2623 <th bgcolor="#cae6ca" width="168">Platform</th> 2624 <th bgcolor="#cae6ca" width="350">Source Configuration File</th>
2625 denise.eckstein 1.1 </tr> 2626 <tr align="center"> 2627 <td width="168">Linux</td> 2628 <td align="left" width="350"> 2629 Pegasus/Config/DefaultPropertyTableLinux.h</td> 2630 </tr> 2631 <tr align="center"> 2632 <td width="168">HP-UX</td> 2633 <td align="left" width="350"> 2634 Pegasus/Config/DefaultPropertyTableHpux.h</td> 2635 </tr> 2636 <tr align="center"> 2637 <td width="168">OpenVMS</td> 2638 <td align="left" width="350"> 2639 Pegasus/Config/DefaultPropertyTableVms.h</td> 2640 </tr>
2641 karl 1.29 </tbody></table>
2642 denise.eckstein 1.1 </ul> 2643 2644 <h5>httpsPort</h5> 2645 <ul> 2646 <b>Description: </b> 2647 OpenPegasus first attempts to look up the port number for HTTPS 2648 using getservbyname for the 'wbem-https' service. The httpsPort
2649 kumpf 1.12 configuration setting is used only when the getservbyname lookup
2650 denise.eckstein 1.1 fails.<br> 2651 <b>Default Value: </b>blank<br> 2652 <b>Recommended Default Value (Development Build): </b>blank<br> 2653 <b>Recommended Default Value (Release Build): </b>5989<br> 2654 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2655 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 2656 <b>Dynamic?: </b>No<br> 2657 <b>Considerations: </b>(1)The use of 5989 for WBEM HTTPS 2658 is recommended by the DMTF. This port has been registered with 2659 <a href="http://www.iana.org/assignments/port-numbers">IANA</a>.
2660 kumpf 1.12 In a production environment, the recommendation is to use
2661 denise.eckstein 1.1 /etc/services to configure the value of this port.(2)
2662 kumpf 1.12 With the release of OpenPegasus 2.5, the default values for
2663 karl 1.29 httpPort was changed from 5989 to "". This
2664 kumpf 1.12 change was made to allow the OpenPegasus to differentiate 2665 between a default setting of 5989 and a customer-defined
2666 denise.eckstein 1.1 setting of 5989.  With this change,  if the port number
2667 kumpf 1.12 is explicitly set, the configured port will be used regardless
2668 denise.eckstein 1.1 of the settings in /etc/services. If no port number is specified, 2669 the server will continue to use the value in /etc/services.<br> 2670 <br> 2671
2672 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2673 <tbody><tr> 2674 <th bgcolor="#cae6ca" width="168">Platform</th> 2675 <th bgcolor="#cae6ca" width="350">Source Configuration File</th>
2676 denise.eckstein 1.1 </tr> 2677 <tr align="center"> 2678 <td width="168">Linux</td> 2679 <td align="left" width="350"> 2680 Pegasus/Config/DefaultPropertyTableLinux.h</td> 2681 </tr> 2682 <tr align="center"> 2683 <td width="168">HP-UX</td> 2684 <td align="left" width="350"> 2685 Pegasus/Config/DefaultPropertyTableHpux.h</td> 2686 </tr> 2687 <tr align="center"> 2688 <td width="168">OpenVMS</td> 2689 <td align="left" width="350"> 2690 Pegasus/Config/DefaultPropertyTableVms.h</td> 2691 </tr>
2692 karl 1.29 </tbody></table>
2693 denise.eckstein 1.1 </ul> 2694 2695 <h5>idleConnectionTimeout</h5> 2696 <ul> 2697 <b>Description: </b>If set to a positive integer, this value 2698 specifies a minimum timeout value for idle client connections. 2699 If set to zero, idle client connections do not time out.<br> 2700 <b>Recommended Default Value (Development Build): </b>0<br> 2701 <b>Recommended Default Value (Release Build): </b>0<br> 2702 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2703 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2704 kavita.gupta 1.11 <b>Dynamic?: </b>Yes<br>
2705 denise.eckstein 1.1 <b>Considerations: </b>A client connection is considered 2706 idle when it is not in the process of sending a request and 2707 the CIM Server is not processing a request from that connection.
2708 kumpf 1.12 An idle connection timeout allows reclamation of the system
2709 denise.eckstein 1.1 resources allocated for idle CIM Server connections. Note that 2710 the CIM Server may allow an idle connection to persist longer
2711 kumpf 1.12 than the configured timeout value based on server activity. 2712 Some client applications may not behave correctly if a
2713 denise.eckstein 1.1 connection timeout is introduced. Client compatibility should be 2714 considered when configuring an idle connection timeout value.
2715 kumpf 1.12 The idle connection time is computed using the system clock.
2716 denise.eckstein 1.1 Thus, resetting the system clock may cause unexpected timeout
2717 kumpf 1.12 behavior.This config property can be changed dynamically. The
2718 kavita.gupta 1.11 changes will apply to all new and existing connections. <br>
2719 denise.eckstein 1.1 </ul> 2720
2721 venkat.puvvada 1.21 <h5>maxFailedProviderModuleRestarts</h5> 2722 <ul> 2723 <b>Description: </b>If set to a positive integer, this value 2724 specifies the number of times the failed provider module with 2725 indications enabled are restarted automatically before being 2726 moved to Degraded state. If set to zero, failed provider module 2727 is not restarted with indications enabled automatically and 2728 will be moved to Degraded state immediately.<br> 2729 <b>Recommended Default Value (Development Build): </b>3<br> 2730 <b>Recommended Default Value (Release Build): </b>3<br> 2731 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2732 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2733 <b>Dynamic?: </b>Yes<br> 2734 <b>Considerations: </b>This option controls the automatic 2735 re-enabling of the failed provider module with indications 2736 enabled. If the provider module with indications enabled fails 2737 very frequently, it affects the CIMServer normal operations because 2738 CIMServer would be busy with reloading the provider module every 2739 time it fails. This option would be helpful if the long running 2740 indication provider crashes and the management application want 2741 to receive the indications from the provider while provider fix 2742 venkat.puvvada 1.21 is being delivered. In case of provider module grouping, if one of 2743 the indication provider crashes, it affects all indication providers 2744 in the provider modules of the group. Note that this is the facility 2745 provided by the CIMServer for temporary recovery of the provider and 2746 the ultimate goal SHALL be fixing the faulty provider. 2747 </ul> 2748
2749 venkat.puvvada 1.27 <h5>maxIndicationDeliveryRetryAttempts</h5> 2750 <ul>
2751 ashok.pathak 1.44 <b>Description: </b> If set to a positive integer, value defines the number 2752 of times indication service will enable the reliableIndication feature and try 2753 to deliver an indication to a particular listener destination. 2754 This does not effect the original delivery attempt. A value of disables 2755 reliable indication feature completely, and cimserver will deliver the 2756 indication once.This is in accord with DTMF Specification 1054, 2757 Indication Profile, version 1.2.1.<br>
2758 venkat.puvvada 1.27 <b>Recommended Default Value (Development Build): </b>3<br> 2759 <b>Recommended Default Value (Release Build): </b>3<br> 2760 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2761 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2762 <b>Dynamic?: </b>No<br> 2763 <b>Considerations: </b> This value is used to set the 2764 CIM_IndicationService.DeliveryRetryAttempts property. See 2765 CIM_IndicationService.DeliveryRetryAttempts property for more details. This 2766 option is supported only when PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT 2767 is defined.<br> 2768 <b>Source Configuration File: </b> 2769 Pegasus/Config/IndicationServicePropertyOwner.cpp<br> 2770 </ul> 2771 2772 <h5>minIndicationDeliveryRetryInterval</h5> 2773 <ul> 2774 <b>Description: </b> If set to a positive integer, this value defines 2775 the minimal time interval in seconds for the indication service to wait 2776 before retrying to deliver an indication to a listener destination that 2777 previously failed. Cimserver may take longer due to QoS or other processing.<br> 2778 <b>Recommended Default Value (Development Build): </b>30<br> 2779 venkat.puvvada 1.27 <b>Recommended Default Value (Release Build): </b>30<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 initialize the property 2784 CIM_IndicationService.DeliveryRetryInterval. See 2785 CIM_IndicationService.DeliveryRetryInterval 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 dev.meetei 1.33 <h5>listenAddress</h5> 2793 <ul> 2794 <b>Description: </b> Network interface where the cimserver 2795 should listen to for connections.For example listenAddress=All or 2796 listenAddress=121.12.33.112 or listenAddress=121.33.21.26,127.0.0.1, 2797 fe80::fe62:9346%eth0<br> 2798 <b>Recommended Default Value (Development Build): </b>All<br> 2799 <b>Recommended Default Value (Release Build): </b>No Specific suggestion<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>Default value of "All" will make cimserver to listen on all the network interfaces.<br> 2804 <b>Source Configuration File: </b> 2805 Pegasus/Config/DefaultPropertyOwner.cpp<br> 2806 </ul> 2807
2808 denise.eckstein 1.1 <h5>logdir</h5> 2809 <ul> 2810 <b>Description: </b>Specifies the name of the directory 2811 to be used for the OpenPegasus specific log files.<br> 2812 <b>Recommended Default Value (Development Build): </b>logs<br> 2813 <b>Recommended Default Value (Release Build): </b>$LOGDIR<br> 2814 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2815 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 2816 <b>Dynamic?: </b>Yes<br>
2817 kumpf 1.12 <b>Considerations: </b>This option is not supported if
2818 denise.eckstein 1.1 PEGASUS_USE_SYSLOGS is defined.<br> 2819 <b>Source Configuration File: </b> 2820 Pegasus/Config/LogPropertyOwner.cpp<br> 2821 </ul> 2822 2823 <h5>logLevel</h5> 2824 <ul>
2825 kumpf 1.12 <b>Description: </b>Defines the desired level of logging.
2826 denise.eckstein 1.1 Valid values include: TRACE, INFORMATION, WARNING, SEVERE, 2827 FATAL.<br> 2828 <b>Default Value: </b>"INFORMATION"<br> 2829 <b>Recommended Default Value (Development Build): </b> 2830 "INFORMATION"<br> 2831 <b>Recommended Default Value (Release Build): </b>"SEVERE"<br> 2832 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2833 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2834 <b>Dynamic?: </b>Yes<br> 2835 <b>Considerations: </b><br> 2836 <b>Source Configuration File: </b> 2837 Pegsus/Config/LogPropertyOwner.cpp<p> </p> 2838 </ul> 2839
2840 mreddy 1.3 <h5>maxLogFileSizeKBytes</h5> 2841 <ul>
2842 kumpf 1.12 <b>Description: </b>Specifies the maximum size of the logfile in Kilo
2843 mreddy 1.3 Bytes. If the logfile size exceeds maxLogFileSizeKBytes logfile will be pruned.<br> 2844 <b>Default Value: </b>32768<br> 2845 <b>Recommended Default Value (Development Build): </b> 32768<br> 2846 <b>Recommended Default Value (Release Build): </b>32768<br> 2847 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2848 <b>Recommend To Be Fixed/Hidden (Release Build):</b> No/No<br> 2849 <b>Dynamic?:</b> Yes<br> 2850 <b>Considerations:</b> This option is not supported if PEGASUS_USE_SYSLOGS is defined. Minimum accepted value is 32 KB. <br> 2851 <b>Source Configuration File:</b>  Pegsus/Config/LogPropertyOwner.cpp<p> </p> 2852 </ul>
2853 denise.eckstein 1.1 <h5>maxProviderProcesses</h5> 2854 <ul> 2855 <b>Description:</b> Limits the number of provider
2856 kumpf 1.12 processes (see 'forceProviderProcesses) that may run
2857 denise.eckstein 1.1 concurrently. A 'maxProviderProcesses' value of '0' indicates 2858 that the number of Provider Agent processes is unlimited<br> 2859 <b>Default Value: </b>0<br> 2860 <b>Recommended Default Value (Development Build):</b> 0<br> 2861 <b>Recommended Default Value (Release Build):</b> 0<br> 2862 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2863 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br>
2864 kavita.gupta 1.9 <b>Dynamic?: </b>Yes<br>
2865 kumpf 1.12 <b>Considerations: </b>Consider there are five provider processes 2866 already running and the maxProviderProcesses is dynamically changed to 2867 four. In this case though new provider processes will not be created
2868 kavita.gupta 1.9 but existing five will continue running<br>
2869 denise.eckstein 1.1 <br>
2870 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2871 <tbody><tr> 2872 <th bgcolor="#cae6ca" width="168">Platform</th> 2873 <th bgcolor="#cae6ca" width="350">
2874 denise.eckstein 1.1 Source Configuration File</th> 2875 </tr> 2876 <tr align="center"> 2877 <td width="168">Linux</td> 2878 <td align="left" width="350"> 2879 Pegasus/Config/DefaultPropertyTableLinux.h</td> 2880 </tr> 2881 <tr align="center"> 2882 <td width="168">HP-UX</td> 2883 <td align="left" width="350"> 2884 Pegasus/Config/DefaultPropertyTableHpux.h</td> 2885 </tr> 2886 <tr align="center"> 2887 <td width="168">OpenVMS</td> 2888 <td align="left" width="350"> 2889 Pegasus/Config/DefaultPropertyTableVms.h</td> 2890 </tr>
2891 karl 1.29 </tbody></table>
2892 denise.eckstein 1.1 </ul> 2893 2894 <h5>messageDir</h5> 2895 <ul> 2896 <b>Description: </b>Specifies the name of the directory to 2897 be used for the OpenPegasus translated messages.<br> 2898 <b>Default Value: </b>msg<br> 2899 <b>Recommended Default Value (Development Build): </b>msg<br> 2900 <b>Recommended Default Value (Release Build):</b> 2901 $MESSAGEDIR/msg<br> 2902 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2903 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 2904 <b>Dynamic?: </b>No<br> 2905 <b>Considerations: </b>Only used when message localization 2906 is enabled.  See PEGASUS_HAS_MESSAGES for details.<br> 2907 <b>Source Configuration File: </b> 2908 FileSystemPropertyOwner.cpp<br> 2909 </ul> 2910 2911 <h5>providerDir</h5> 2912 <ul>
2913 kumpf 1.12 <b>Description: </b>Specifies the names of the directories
2914 denise.eckstein 1.1 that contains Provider executables.<br> 2915 <b>Recommended Default Value (Development Build): </b>lib<br> 2916 <b>Recommended Default Value (Release Build): </b> 2917 $PROVIDERDIRS<br> 2918 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2919 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br>
2920 kavita.gupta 1.11 <b>Dynamic?: </b>Yes<br>
2921 denise.eckstein 1.1 <b>Considerations: </b>The CIM Server runs as a privileged 2922 user. And, since Providers run in the same process space as the
2923 kumpf 1.12 CIM Server, Providers also have privileged access to the
2924 karl 1.29 system. Allowing a registered Provider’s executable to be
2925 kumpf 1.12 replaced with malicious code would result in a critical
2926 denise.eckstein 1.1 security defect, giving a malicious user privileged access
2927 marek 1.34 to the system. Administrators are responsible for ensuring
2928 denise.eckstein 1.1 that only trusted Providers are loaded into providerDir. 2929 In order to simplify the management task associated with 2930 securing Provider executable, the value of providerDir can be 2931 fixed at build time (i.e., set to one or more fixed, well-known 2932 locations).<br> 2933 <b>Source Configuration File: </b> 2934 Pegasus/Config/FileSystemPropertyOwner.cpp<br> 2935 </ul>
2936 kumpf 1.12
2937 denise.eckstein 1.1 <h5>providerManagerDir</h5> 2938 <ul> 2939 <b>Description: </b>Specifies the name of the directory that 2940 contains the ProviderManager plugin libraries.<br> 2941 <b>Recommended Default Value (Development Build): </b>lib<br> 2942 <b>Recommended Default Value (Release Build): </b> 2943 $PROVIDERMANAGERDIRS<br> 2944 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2945 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 2946 <b>Dynamic?: </b>No<br> 2947 <b>Considerations: </b>Should be a dedicated directory to 2948 minimize inspection of non-applicable files. Additionally, 2949 since all calls to the providers go through the provider 2950 managers, the same care should be taken with regards to 2951 security for the provider manager directory, as for provider 2952 directories.<br> 2953 <b>Source Configuration File: </b> 2954 Pegasus/Config/FileSystemPropertyOwner.cpp<br>
2955 kumpf 1.12 </ul>
2956 denise.eckstein 1.1 2957 <h5>repositoryDir</h5> 2958 <ul>
2959 kumpf 1.12 <b>Description: </b>Specifies the name of the directory
2960 denise.eckstein 1.1 to be used for the OpenPegasus repository.<br> 2961 <b>Recommended Default Value (Development Build): </b>repository<br> 2962 <b>Recommended Default Value (Release Build): </b> 2963 $REPOSITORYDIR/repository<br> 2964 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2965 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 2966 <b>Dynamic?: </b>No<br> 2967 <b>Considerations: </b><br> 2968 <b>Source Configuration File: </b> 2969 Pegasus/Config/FileSystemPropertyOwner.cpp<p><br>
2970 karl 1.29 </p></ul>
2971 denise.eckstein 1.1 2972 <h5>repositoryIsDefaultInstanceProvider</h5> 2973 <ul>
2974 kumpf 1.12 <b>Description: </b>If true, the Repository functions 2975 as the Instance Provider for all classes for which there 2976 is not an explicitly registered Provider. This flag is 2977 also used to control the behavior of the repository when
2978 denise.eckstein 1.1 processing association operators.<br> 2979 <b>Recommended Default Value (Development Build): </b>true<br>
2980 kumpf 1.12 <b>Recommended Default Value (Release Build): </b>false<br>
2981 denise.eckstein 1.1 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2982 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br> 2983 <b>Dynamic?:  </b>No<br> 2984 <b>Considerations:  </b>This flag can be used to configure 2985 the CIM Server to allow the Repository to be used by CIM Clients 2986 and CIM Providers as a dynamic data store. The setting of this
2987 kumpf 1.12 flag will significantly affect CIM Server behavior as viewed 2988 by the CIM Client.<br> 2989 2990 The following issues should be considered when setting
2991 denise.eckstein 1.1 repositoryIsDefaultInstanceProvider=true: 2992 2993 <ul>
2994 kumpf 1.12 <li><b>Authorization.</b>  The repository has no
2995 denise.eckstein 1.1 concept of which users (or components) are authorized to 2996 perform which operations.</li>
2997 karl 1.29 <li><b>Appearance of instrumentation.</b>  A client application
2998 kumpf 1.12 cannot determine whether instrumentation exists for a 2999 given CIM class. For example,  imagine a client 3000 issues a CreateInstance operation on a Disk class
3001 denise.eckstein 1.1 for    which no provider is registered. 3002  The instance will be stored in the repository, and
3003 karl 1.29 the client gets a "success" response. Does that mean a
3004 denise.eckstein 1.1 disk device has been created on the server? Even worse,
3005 kumpf 1.12 when another client issues an EnumerateInstances
3006 denise.eckstein 1.1 operation, the spurious Disk instance is returned. 3007  With repositoryIsDefaultInstanceProvider=false, the
3008 kumpf 1.12 CreateInstance operation above would have returned a 3009 NOT_SUPPORTED error.</li>
3010 karl 1.29 <li><b>Potential for inconsistent data.</b>  Using the
3011 denise.eckstein 1.1 repository as a data cache increases the probability 3012 that a client will see stale or incorrect data. A
3013 kumpf 1.12 provider can better control the correlation
3014 denise.eckstein 1.1 between the data returned and the current state of the
3015 kumpf 1.12 underlying managed resource (whether or not the provider
3016 denise.eckstein 1.1 caches the data).</li> 3017 </ul> 3018 <br>
3019 kumpf 1.12 3020 The following issues should be considered when setting
3021 denise.eckstein 1.1 repositoryIsDefaultInstanceProvider=false: 3022 3023 <ul> 3024 <li><b>Provider Availability.</b> Certain Providers have been
3025 kumpf 1.12 developed to use the Repository as a dynamic data store. 3026 These Providers are currently not supported on system
3027 denise.eckstein 1.1 where this flag is disabled. E.g., the Common Diagnostics
3028 kumpf 1.12 Model (CDM) Provider
3029 denise.eckstein 1.1 (http://developer.intel.com/design/servers/cdm/)
3030 kumpf 1.12 relies on use of the Repository to store instances 3031 of CIM_DiagnosticSetting.  If this flag set to 3032 false, this Provider will not function correctly. Note 3033 that this feature is supported by other WBEM
3034 denise.eckstein 1.1 implementation.  Therefore, disabling this feature 3035 can increase the cost of migrating existing Providers to 3036 OpenPegasus.</li>
3037 kumpf 1.12 </ul>
3038 denise.eckstein 1.1
3039 kumpf 1.12 <b>Source Configuration File: </b>
3040 denise.eckstein 1.1 Pegasus/Config/RepositoryPropertyOwner.cpp<br> 3041 </ul>
3042 kumpf 1.12
3043 denise.eckstein 1.1 <h5>shutdownTimeout</h5> 3044 <ul> 3045 <b>Description: </b>When a cimserver -s shutdown command is 3046 issued, specifies the maximum time in seconds for the CIM Server 3047 to complete outstanding CIM operation requests before shutting 3048 down; if the specified timeout period expires, the CIM Server
3049 kumpf 1.12 will shut down, even if there are still CIM operations in
3050 denise.eckstein 1.1 progress. Minimum value is 2 seconds.<br> 3051 <b>Recommended Default Value (Development Build): </b>10<br> 3052 <b>Recommended Default Value (Release Build): </b>10<br> 3053 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3054 <b>Recommend To Be Fixed/Hidden (Release Build):</b>No/No<br> 3055 <b>Dynamic?: </b>Yes<br> 3056 <b>Considerations: </b><br> 3057 <b>Source Configuration File: </b> 3058 Pegasus/Config/ShutdownPropertyOwner.cpp<br> 3059 </ul> 3060 3061 <h5>slp</h5> 3062 <ul> 3063 <b>Description: </b>When set to true, OpenPegasus activates 3064 an SLP SA and issues DMTF defined SLP advertisements to this SA 3065 on startup.<br> 3066 <b>Default Value: </b>false<br> 3067 <b>Recommended Default Value (Development Build): </b>false<br> 3068 <b>Recommended Default Value (Release Build): </b>false<br> 3069 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3070 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 3071 denise.eckstein 1.1 <b>Dynamic?: </b>No<p> <br> 3072 <br>
3073 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" height="80" width="531"> 3074 <tbody><tr> 3075 <th bgcolor="#cae6ca" height="16" width="168">Platform</th> 3076 <th bgcolor="#cae6ca" height="16" width="350">
3077 denise.eckstein 1.1 Source Configuration File</th> 3078 </tr> 3079 <tr align="center">
3080 karl 1.29 <td height="14" width="168">Linux</td> 3081 <td align="left" height="14" width="350">
3082 denise.eckstein 1.1 Pegasus/Config/DefaultPropertyTableLinux.h</td> 3083 </tr> 3084 <tr align="center">
3085 karl 1.29 <td height="14" width="168">HP-UX</td> 3086 <td align="left" height="14" width="350">
3087 denise.eckstein 1.1 Pegasus/Config/DefaultPropertyTableHpux.h</td> 3088 </tr> 3089 <tr align="center">
3090 karl 1.29 <td height="16" width="168">OpenVMS</td> 3091 <td align="left" height="16" width="350">
3092 denise.eckstein 1.1 Pegasus/Config/DefaultPropertyTableVms.h</td> 3093 </tr>
3094 karl 1.29 </tbody></table> 3095 </p></ul>
3096 denise.eckstein 1.1
3097 marek 1.36 <h5>slpProviderStartupTimeout</h5> 3098 <ul> 3099 <b>Description: </b>Timeout value in milli seconds used to specify 3100 how long the registration with an SLP SA may take. Registration will be 3101 retried three times. This value only needs to be increased in case that 3102 the loading of a set of providers who reporting their implementation of a 3103 registered profile takes very long.<br> 3104 <b>Default Value: </b>300000<br> 3105 <b>Recommended Default Value (Development Build): </b>300000<br> 3106 <b>Recommended Default Value (Release Build): </b>300000<br> 3107 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3108 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 3109 <b>Dynamic?: </b>No<p> <br> 3110 <br> 3111 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" height="80" width="531"> 3112 <tbody><tr> 3113 <th bgcolor="#cae6ca" height="16" width="168">Platform</th> 3114 <th bgcolor="#cae6ca" height="16" width="350"> 3115 Source Configuration File</th> 3116 </tr> 3117 <tr align="center"> 3118 marek 1.36 <td height="14" width="168">Linux</td> 3119 <td align="left" height="14" width="350"> 3120 Pegasus/Config/DefaultPropertyTable.h</td> 3121 </tr> 3122 <tr align="center"> 3123 <td height="14" width="168">HP-UX</td> 3124 <td align="left" height="14" width="350"> 3125 Pegasus/Config/DefaultPropertyTable.h</td> 3126 </tr> 3127 <tr align="center"> 3128 <td height="16" width="168">OpenVMS</td> 3129 <td align="left" height="16" width="350"> 3130 Pegasus/Config/DefaultPropertyTable.h</td> 3131 </tr> 3132 </tbody></table> 3133 </p></ul> 3134
3135 denise.eckstein 1.1 <h5>socketWriteTimeout</h5> 3136 <ul> 3137 <b>Description: </b>If the CIM Server receives an 3138 EWOULDBLOCK/EAGAIN error on a non-blocking write,
3139 kumpf 1.12 socketWriteTimeout defines the number of seconds the 3140 CIM Server will wait for the socket to get ready and resume
3141 denise.eckstein 1.1 writing data.<br> 3142 <b>Recommended Default Value (Development Build): </b> 3143 20 (seconds)<br> 3144 <b>Recommended Default Value (Release Build): </b> 3145 20 (seconds)<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 kavita.gupta 1.11 <b>Dynamic?: </b>Yes<br> 3149 <b>Considerations: </b>Any changes made to this config property
3150 kumpf 1.12 dynamically will apply to new CIM Server connections only
3151 kavita.gupta 1.11 keeping old already established connections unchanged.<br>
3152 denise.eckstein 1.1 <b>Source Configuration File: </b> 3153 Pegasus/Config/DefaultPropertyTable.h 3154 </ul> 3155 3156 <h5>sslCertificateFilePath</h5> 3157 <ul>
3158 kumpf 1.12 <b>Description: </b>Contains the CIM Server SSL
3159 denise.eckstein 1.1 Certificate.<br> 3160 <b>Recommended Default Value (Development Build): </b> 3161 server.pem<br> 3162 <b>Recommended Default Value (Release Build): </b> 3163 $CERTIFICATEDIR/server.pem"<br> 3164 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3165 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 3166 <b>Dynamic?: </b>No<br> 3167 <b>Considerations: </b>For a more detailed look at SSL options 3168 and their ramifications, please see the SSL guidelines.<br> 3169 <b>Source Configuration File: </b> 3170 Pegasus/Config/SecurityPropertyOwner.cpp 3171 </ul> 3172
3173 rohini.deshpande 1.28 <h5>sslCipherSuite</h5> 3174 <ul> 3175 <b>Description: </b>String containing OpenSSL cipher 3176 specifications to configure the cipher suite the client is 3177 permitted to negotiate with the server during the SSL 3178 handshake phase.<br> 3179 <b>Recommended Default Value (Development Build): </b> 3180 DEFAULT (the default cipher list of OpenSSL)<br> 3181 <b>Recommended Default Value (Release Build): </b> 3182 DEFAULT (the default cipher list of OpenSSL)<br> 3183 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3184 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 3185 <b>Dynamic?: </b>No<br> 3186 <b>Considerations: </b>The value should be mentioned between 3187 single quotes since it can contain special characters like .+, 3188 !, -.. For more details look at SSL ciphers.<br> 3189 <b>Source Configuration File: </b> 3190 Pegasus/Config/SecurityPropertyOwner.cpp 3191 </ul> 3192
3193 ashok.pathak 1.43 <h5>sslBackwardCompatibility</h5> 3194 <ul> 3195 <b>Description: </b> If set to true, OpenPegasus support 3196 SSLv3 and TLSv1 protocol.If set to false OpenPegasus support 3197 only TLS1.2 protocol for openssl 1.0.1+ <br> 3198 <b>Recommended Default Value (Development Build): </b> 3199 false<br> 3200 <b>Recommended Default Value (Release Build): </b> 3201 false<br> 3202 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3203 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 3204 <b>Dynamic?: </b>No<br> 3205 <b>Considerations: </b> For a more detailed look at SSL options 3206 and their ramifications, please see the SSL guidelines.<br> 3207 <b>Source Configuration File: </b> 3208 Pegasus/Config/SecurityPropertyOwner.cpp 3209 </ul> 3210
3211 denise.eckstein 1.1 <h5>sslClientVerificationMode</h5> 3212 <ul> 3213 <b>Description: </b>Describes the desired level of support 3214 for certificate-based authentication.
3215 karl 1.29 <ul style="margin-top: 0in;" type="circle"> 3216 <li>“<b>required</b>” – The server requires certificate-based
3217 kumpf 1.12 client authentication.  A client MUST present a
3218 denise.eckstein 1.1 trusted certificate in order to access the CIM Server.
3219 kumpf 1.12 If the client fails to send a certificate or sends an
3220 denise.eckstein 1.1 untrusted certificate, the connection will be rejected.</li>
3221 karl 1.29 <li>“<b>optional</b>” – The server supports, but does not
3222 kumpf 1.12 require, certificate-based client authentication. The 3223 server will request and attempt to validate a client
3224 denise.eckstein 1.1 certificate, however the connection will be accepted even 3225 if no certificate is sent or an untrusted certificate is 3226 sent.  The server will then seek to authenticate the 3227 client via an authentication header.</li>
3228 karl 1.29 <li>“<b>disabled</b>” – The server does not support
3229 denise.eckstein 1.1 certificate-based client authentication.</li> 3230 </ul> 3231 <b>Recommended Default Value (Development Build): </b> 3232 disabled<br> 3233 <b>Recommended Default Value (Release Build): </b> 3234 disabled<br> 3235 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3236 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 3237 <b>Dynamic?: </b>No<br> 3238 <b>Considerations: </b>(1) This property is only used if
3239 karl 1.29 <b>enableHttpsConnection</b> is <b>"true"</b>.
3240 denise.eckstein 1.1 (2) If the platform does not support PEGASUS_LOCAL_DOMAIN_SOCKET, 3241 OpenPegasus attempts to use either HTTPS or
3242 kumpf 1.12 HTTP to establish a local connection (connectLocal).
3243 denise.eckstein 1.1 For platforms that do not support PEGASUS_LOCAL_DOMAIN_SOCKET,
3244 kumpf 1.12 Clients which use connectLocal, such as cimconfig -l -c,
3245 denise.eckstein 1.1 cimprovider -l -s and cimserver -s, will not work if  the
3246 karl 1.29 "sslClientVerificationMode" variable is set to 3247 "required" and HTTP is disabled.  For these
3248 kumpf 1.12 platforms, the recommended course of action is to change the
3249 karl 1.29 property value to "optional."<br>
3250 denise.eckstein 1.1 <b>Source Configuration File: </b> 3251 Pegasus/Config/SecurityPropertyOwner.cpp 3252 </ul> 3253 3254 <h5>sslKeyFilePath</h5> 3255 <ul> 3256 <b>Description: </b>Contains the private key for the CIM 3257 Server SSL Certificate.<br> 3258 <b>Recommended Default Value (Development Build): </b> 3259 file.pem<br> 3260 <b>Recommended Default Value (Release Build): </b> 3261 $CERTIFICATEDIR/file.pem<br> 3262 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3263 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 3264 <b>Dynamic?: </b>No<br> 3265 <b>Considerations: </b>File should be readable only by the 3266 user the cimserver is running as and/or privileged users. The 3267 file should be writeable only by a privileged user.<br> 3268 <b>Source Configuration File: </b> 3269 Pegasus/Config/SecurityPropertyOwner.cpp<br> 3270 </ul> 3271 denise.eckstein 1.1 3272 <h5>sslTrustStore</h5> 3273 <ul> 3274 <b>Description: </b>Specifies the location of the OpenSSL
3275 kumpf 1.12 truststore. Consistent with the OpenSSL implementation, a
3276 denise.eckstein 1.1 truststore can be either a file or directory. If the truststore
3277 kumpf 1.12 is a directory, all the certificates within the directory are
3278 denise.eckstein 1.1 considered trusted.<br> 3279 <b>Recommended Default Value (Development Build): </b> 3280 client.pem<br> 3281 <b>Recommended Default Value (Release Build): </b> 3282 $CERTIFICATEDIR/client.pem<br> 3283 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3284 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 3285 <b>Dynamic?: </b>No<br> 3286 <b>Source Configuration File: </b> 3287 Pegsus/Config/SecurityPropertyOwner.cpp 3288 </ul> 3289 3290 <h5>sslTrustStoreUserName</h5> 3291 <ul> 3292 <b>Description: </b>Specifies the system user name to be 3293 associated with all certificate-based authenticated requests.<br> 3294 <b>Recommended Default Value (Development Build): </b>NONE<br> 3295 <b>Recommended Default Value (Release Build): </b>NONE<br> 3296 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3297 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 3298 <b>Dynamic?: </b>No<br> 3299 denise.eckstein 1.1 <b>Considerations: </b>This property has no default; for
3300 kumpf 1.12 security reasons, the system administrator must explicitly
3301 denise.eckstein 1.1 specify this value.  This feature allows a single user 3302 name to be specified.  This user will be associated 3303 with all certificates in the truststore.  In the future, 3304 OpenPegasus will allow a system administrator to associate a 3305 distinct user name with each certificate.<br> 3306 <b>Source Configuration File: </b> 3307 Pegsus/Config/SecurityPropertyOwner.cpp<br> 3308 </ul> 3309 3310 <h5>traceComponents</h5> 3311 <ul> 3312 <b>Description: </b>Defines the components to be traced.<br> 3313 <b>Default Value: </b>""<br> 3314 <b>Recommended Default Value (Development Build): </b>""<br> 3315 <b>Recommended Default Value (Release Build): </b>""<br> 3316 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3317 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br> 3318 <b>Dynamic?: </b>Yes<br> 3319 <b>Source Configuration File: </b> 3320 Pegasus/Config/TracePropertyOwner.cpp<br> 3321 </ul> 3322 denise.eckstein 1.1 3323 <h5>traceFacility</h5> 3324 <ul>
3325 kumpf 1.12 <b>Description: </b>Defines the desired facility for trace
3326 karl 1.29 messages. Valid values include: "File" 3327 , "Log" and "Memory" .<br>
3328 denise.eckstein 1.1 <b>Default Value: </b>File<br> 3329 <b>Recommended Default Value (Development Build): </b>File<br> 3330 <b>Recommended Default Value (Release Build): </b>File<br> 3331 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3332 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br> 3333 <b>Dynamic?: </b>Yes<br> 3334 <b>Case Sensitive?: </b>No<br>
3335 karl 1.29 <b>Considerations: </b>If you specify "File",
3336 kumpf 1.12 trace messagesare written into the file specified by the
3337 denise.eckstein 1.1 configuration option traceFilePath. If you specify
3338 karl 1.29 "Log", trace messages are written to the
3339 marek 1.14 OpenPegasus Log. If you specify Memory, the trace messages 3340 are collected in a wrap-around memory buffer. 3341 If this memory is part of a dump the trace messages can be
3342 karl 1.29 found by the eye-catcher "PEGASUSMEMTRACE" at
3343 marek 1.14 the top of the memory buffer. The trace is in clear text and
3344 karl 1.29 the last written message has the suffix "EOTRACE".<br>
3345 denise.eckstein 1.1 <b>Source Configuration File: </b> 3346 Pegasus/Config/TracePropertyOwner.cpp<br> 3347 </ul> 3348 3349 <h5>traceFilePath</h5> 3350 <ul> 3351 <b>Description: </b>Specifies the location of the 3352 OpenPegasus trace file.<br> 3353 <b>Default Value: </b>cimserver.trc<br> 3354 <b>Recommended Default Value (Development Build):</b> 3355 cimserver.trc<br> 3356 <b>Recommended Default Value (Release Build): </b> 3357 $TRACEDIR/cimserver.trc<br> 3358 <b>Recommend To Be Fixed/Hidden (Development Build):</b>No/No<br> 3359 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 3360 <b>Dynamic?: </b>Yes<br> 3361 <b>Source Configuration File: </b> 3362 Pegasus/Config/TracePropertyOwner.cpp<br> 3363 </ul> 3364 3365 <h5>traceLevel</h5> 3366 denise.eckstein 1.1 <ul>
3367 karl 1.29 <b>Description: </b>Defines the desired level of
3368 denise.eckstein 1.1 tracing. Valid values include: 0, 1, 2, 3, 4, 5.<br> 3369 <b>Default Value: </b>0<br> 3370 <b>Recommended Default Value (Development Build): </b>0<br>
3371 karl 1.29 <b>Recommended Default Value (Release Build): </b>0<<br>
3372 denise.eckstein 1.1 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3373 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br> 3374 <b>Dynamic?: </b>Yes<br> 3375 <b>Source Configuration File: </b> 3376 Pegasus/Config/TracePropertyOwner.cpp<br> 3377 </ul> 3378
3379 marek 1.14 <h5>traceMemoryBufferKbytes</h5> 3380 <ul> 3381 <b>Description: </b>Defines the size of the buffer for 3382 in memory tracing in kbytes ( 2<sup>10</sup> bytes ). 3383 Smallest value is 16.<br> 3384 <b>Default Value: </b>10240<br> 3385 <b>Recommended Default Value (Development Build): </b>10240<br> 3386 <b>Recommended Default Value (Release Build): </b>10240<br> 3387 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3388 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 3389 <b>Dynamic?: </b>No<br> 3390 <b>Case Sensitive?: </b>No<br> 3391 <b>Considerations: </b>Is ignored if configuration 3392 property traceFacility is not set to Memory.<br> 3393 <b>Source Configuration File: </b> 3394 Pegasus/Config/TracePropertyOwner.cpp<br> 3395 </ul> 3396
3397 amit99shah 1.38 <h5>traceFileSizeKBytes</h5> 3398 <ul> 3399 <b>Description: </b>Defines the size of the tracefile in Kilo bytes. The trace file will be 3400 rolled once its size exceeds the specified size. <br> 3401 <b>Default Value: </b>1048576<br> 3402 <b>Recommended Default Value (Development Build): </b>1048576<br> 3403 <b>Recommended Default Value (Release Build): </b>1048576<br> 3404 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3405 <b>Recommend To Be Fixed/Hidden (Release Build):</b> No/Yes<br> 3406 <b>Dynamic?:</b> Yes<br> 3407 <b>Considerations:</b>Minimum accepted value is 10240 KB,Maximum accepted value is 2097152 KB.  <br> 3408 <b>Source Configuration File:</b>  Pegsus/Config/TracePropertyOwner.cpp<p> </p> 3409 </ul> 3410 3411 <h5>numberOfTraceFiles</h5> 3412 <ul> 3413 <b>Description: </b>Specifies the number of the tracefiles for rolling.<br> 3414 <b>Default Value: </b>3<br> 3415 <b>Recommended Default Value (Development Build): </b>3<br> 3416 <b>Recommended Default Value (Release Build): </b>3<br> 3417 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3418 amit99shah 1.38 <b>Recommend To Be Fixed/Hidden (Release Build):</b> No/Yes<br> 3419 <b>Dynamic?:</b> Yes<br> 3420 <b>Considerations:</b>Minimum accepted value is 3,Maximum accepted value is 20.  <br> 3421 <b>Source Configuration File:</b>  Pegsus/Config/TracePropertyOwner.cpp<p> </p> 3422 </ul> 3423
3424 denise.eckstein 1.1 <h3>Configuration Constants</h3> 3425 3426 <h4>Definitions</h4> 3427 3428 <h5>static char CURRENT_CONFIG_FILE [] = </h5> 3429 <ul> 3430 <b>Description: </b>Default file name for the current 3431 configuration file.<br> 3432 <b>Recommended Default Value (Development Build):</b> 3433 cimserver_current.conf<br> 3434 <b>Recommended Default Value (Release Build): </b> 3435 $CONFIGDIR/cimserver_current.conf<br> 3436 <b>Dynamic?: </b>No <br> 3437 <br>
3438 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 3439 <tbody><tr> 3440 <th bgcolor="#cae6ca" width="168">Platform</th> 3441 <th bgcolor="#cae6ca" width="350">
3442 denise.eckstein 1.1 Source Configuration File</th> 3443 </tr> 3444 <tr align="center"> 3445 <td width="168">Linux</td> 3446 <td align="left" width="350"> 3447 Pegasus/Config/ConfigFileDirLinux.h</td> 3448 </tr> 3449 <tr align="center"> 3450 <td width="168">HP-UX</td> 3451 <td align="left" width="350">ConfigFileDirHpux.h</td> 3452 </tr> 3453 <tr align="center"> 3454 <td width="168">OpenVMS</td> 3455 <td align="left" width="350"> 3456 Pegasus/Config/ConfigFileDirVms.h</td> 3457 </tr>
3458 karl 1.29 </tbody></table>
3459 denise.eckstein 1.1 </ul> 3460 3461 <h5>static char PLANNED_CONFIG_FILE [] = </h5> 3462 <ul>
3463 kumpf 1.12 <b>Description: </b>Default file name for the planned
3464 denise.eckstein 1.1 configuration file.<br> 3465 <b>Recommended Default Value (Development Build): </b> 3466 cimserver_planned.conf<br> 3467 <b>Recommended Default Value (Release Build): </b> 3468 $CONFIGDIR/cimserver_planned.conf<br> 3469 <b>Dynamic?: </b>No<br> 3470 <br>
3471 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 3472 <tbody><tr> 3473 <th bgcolor="#cae6ca" width="168">Platform</th> 3474 <th bgcolor="#cae6ca" width="350">
3475 denise.eckstein 1.1 Source Configuration File</th> 3476 </tr> 3477 <tr align="center"> 3478 <td width="168">Linux</td> 3479 <td align="left" width="350"> 3480 Pegasus/Config/ConfigFileDirLinux.h</td> 3481 </tr> 3482 <tr align="center"> 3483 <td width="168">HP-UX</td> 3484 <td align="left" width="350"> 3485 Pegasus/Config/ConfigFileDirHpux.h</td> 3486 </tr> 3487 <tr align="center"> 3488 <td width="168">OpenVMS</td> 3489 <td align="left" width="350"> 3490 Pegasus/Config/ConfigFileDirVms.h</td> 3491 </tr>
3492 karl 1.29 </tbody></table>
3493 denise.eckstein 1.1 </ul> 3494 3495 <h5>static char CIMSERVER_START_FILE [] = </h5> 3496 <ul> 3497 <b>Description: </b>This is for the default file name 3498 for the cimserver startup file containing the PID.<br> 3499 <b>Default Value: </b>/tmp/cimserver_start.conf<br> 3500 <b>Recommended Default Value (Development Build): </b> 3501 /tmp/cimserver_start.conf<br> 3502 <b>Recommended Default Value (Release Build): </b> 3503 $PIDFILE<br> 3504 <b>Dynamic?: </b>No<br> 3505 <br>
3506 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 3507 <tbody><tr> 3508 <th bgcolor="#cae6ca" width="168">Platform</th> 3509 <th bgcolor="#cae6ca" width="350">
3510 denise.eckstein 1.1 Source Configuration File</th> 3511 </tr> 3512 <tr align="center"> 3513 <td width="168">Linux</td> 3514 <td align="left" width="350"> 3515 Pegasus/Config/ConfigFileDirLinux.h</td> 3516 </tr> 3517 <tr align="center"> 3518 <td width="168">HP-UX</td> 3519 <td align="left" width="350"> 3520 Pegasus/Config/ConfigFileDirHpux.h</td> 3521 </tr> 3522 <tr align="center"> 3523 <td width="168">OpenVMS</td> 3524 <td align="left" width="350"> 3525 Pegasus/Config/ConfigFileDirVms.h</td> 3526 </tr>
3527 karl 1.29 </tbody></table>
3528 denise.eckstein 1.1 </ul> 3529 3530 <h3>Configuration Macros</h3> 3531 3532 <h4>Definitions</h4> 3533 3534 <h5>PEGASUS_SSLCLIENT_CERTIFICATEFILE</h5> 3535 <ul> 3536 <b>Description: </b><br> 3537 <b>Recommended Default Value (Development Build): </b>client.pem<br> 3538 <b>Recommended Default Value (Release Build): </b> 3539 $CERTIFICATEDIR/client.pem<br> 3540 <b>Dynamic?: </b>No<br> 3541 <b>Source Configuration File: </b> 3542 Pegasus/Common/Constants.h<br> 3543 </ul> 3544 3545 <h5>PEGASUS_SSLCLIENT_RANDOMFILE</h5> 3546 <ul> 3547 <b>Description: </b>On platforms that do not support
3548 kumpf 1.12 /dev/random or /dev/urandom, OpenSSL will use this file to 3549 seed the PRNG (Pseudo-Random Number Generator). This 3550 PEGASUS_SSLCLIENT_RANDOMFILE defines the default CIM
3551 denise.eckstein 1.1 Client random file.<br> 3552 <b>Recommended Default Value (Development Build):</b>ssl.rnd<br> 3553 <b>Recommended Default Value (Release Build):</b> 3554 $RANDOMDIR/ssl.rnd<br> 3555 <b>Dynamic?: </b>No<br> 3556 <b>Considerations: </b>Use of this variable requires
3557 kumpf 1.12 PEGASUS_HAS_SSL to be set.  CIM Client use of a
3558 denise.eckstein 1.1 shared random file is not recommended.  On systems where 3559 /dev/random or /dev/urandom are not available, CIM Clients are
3560 kumpf 1.12 encouraged to generate a unique random file which
3561 denise.eckstein 1.1 contains sufficient entropy.<br> 3562 <b>Source Configuration File: </b> 3563 Pegasus/Common/Constants.h<br> 3564 </ul> 3565 3566 <h5>PEGASUS_SSLSERVER_RANDOMFILE</h5> 3567 <ul>
3568 kumpf 1.12 <b>Description: </b>On platforms that do not support 3569 /dev/random or /dev/urandom, OpenSSL will use this file 3570 to seed the PRNG (Pseudo-Random Number Generator). This 3571 PEGASUS_SSLSERVER_RANDOMFILE defines the CIM Server
3572 denise.eckstein 1.1 random file.<br> 3573 <b>Recommended Default Value (Development Build): </b> 3574 cimserver.rnd<br> 3575 <b>Recommended Default Value (Release Build): </b> 3576 $RANDOMDIR/cimserver.rnd<br> 3577 <b>Dynamic?: </b>No<br> 3578 <b>Considerations: </b>1)Use of this variable 3579 requires  PEGASUS_HAS_SSL to be set.(2) On systems where
3580 kumpf 1.12 /dev/random or /dev/urandom are not available, CIM Server 3581 vendors need to be sure that the cimserver.rnd file
3582 denise.eckstein 1.1 contains sufficient entropy and is uniquely generated for 3583 each system.<br> 3584 <b>Source Configuration File: </b> 3585 Pegasus/Common/Constants.h<b><br>
3586 karl 1.29 </b></ul>
3587 denise.eckstein 1.1
3588 karl 1.29 <h5><b>PEGASUS_LOCAL_AUTH_DIR</b></h5>
3589 denise.eckstein 1.1 <ul>
3590 karl 1.29 <b> <b>Description:</b> </b>For local connections (i.e.,
3591 kumpf 1.12 connectLocal), OpenPegasus uses a file-based authentication
3592 denise.eckstein 1.1 mechanism.<br> 3593 <b>Recommended Default Value (Development Build): </b>/tmp<br> 3594 <b>Recommended Default Value (Release Build): </b> 3595 $LOCALAUTHDIR/localauth<br> 3596 <b>Dynamic?: </b>No<br> 3597 <b>Source Configuration File: </b> 3598 Pegasus/Common/Constants.h<br> 3599 </ul> 3600 3601 <h5>PEGASUS_LOCAL_DOMAIN_SOCKET_PATH</h5> 3602 <ul> 3603 <b>Description: </b><br> 3604 <b>Recommended Default Value (Development Build): </b> 3605 /tmp/cimxml.socket<br> 3606 <b>Recommended Default Value (Release Build): </b> 3607 $SOCKETDIR/cimxml.socket<br> 3608 <b>Dynamic?: </b>No<br> 3609 <b>Source Configuration File: </b> 3610 Pegasus/Common/Constants.h<br> 3611 </ul> 3612 3613 denise.eckstein 1.1 <hr>
3614 martin 1.13 <p>Licensed to The Open Group (TOG) under one or more contributor license 3615 agreements. Refer to the OpenPegasusNOTICE.txt file distributed with 3616 this work for additional information regarding copyright ownership. 3617 Each contributor licenses this file to you under the OpenPegasus Open 3618 Source License; you may not use this file except in compliance with the 3619 License.</p> 3620 <p>Permission is hereby granted, free of charge, to any person obtaining a 3621 copy of this software and associated documentation files (the "Software"), 3622 to deal in the Software without restriction, including without limitation 3623 the rights to use, copy, modify, merge, publish, distribute, sublicense, 3624 and/or sell copies of the Software, and to permit persons to whom the 3625 Software is furnished to do so, subject to the following conditions:</p> 3626 <p>The above copyright notice and this permission notice shall be included 3627 in all copies or substantial portions of the Software.</p> 3628 <p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 3629 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 3630 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 3631 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 3632 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 3633 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 3634 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
3635 denise.eckstein 1.1 <hr>
3636 anusha.kandepu 1.32 </body></html>

No CVS admin address has been configured