pegasus/doc/BuildAndReleaseOptions.html - annotate

Return to BuildAndReleaseOptions.html CVS log

Up to [Pegasus] / pegasus / doc

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

No CVS admin address has been configured