pegasus/doc/BuildAndReleaseOptions.html - annotate

Return to BuildAndReleaseOptions.html CVS log

Up to [Pegasus] / pegasus / doc

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

No CVS admin address has been configured