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 <h5>PEGASUS_REMOVE_METHODTRACE</h5> 1397 <ul> 1398 <b>Description: </b>If true, the CIM Server is compiled without 1399 method enter and exit trace statements.  Trace Level 5 will 1400 continue to be accepted as a valid trace level but, without the 1401 method enter and exit trace statements, it will be equivalent to
1402 kumpf 1.12 Trace Level 4. If PEGASUS_REMOVE_METHODTRACE is false or not set,
1403 denise.eckstein 1.1 method enter and exit trace statements are included.  All 1404 other values are considered invalid and will result in a build 1405 error.<br> 1406 <b>Default Value: </b>Not Set<br> 1407 <b>Recommended Value (Development Build): </b>Not Set (The 1408 Considerations section gives guidance on when a different 1409 decision would be made.)<br> 1410 <b>Recommended Value (Release Build): </b>Not Set (The 1411 Considerations section gives guidance on when a different 1412 decision would be made.)<br> 1413 <b>Required: </b>No<br> 1414 <b>Considerations: </b>This option completely removes the
1415 kumpf 1.12 method enter/exit trace statements from the generated object code. 1416 It defines the PEG_METHOD_ENTER and PEG_METHOD_EXIT macros
1417 denise.eckstein 1.1 to null statements. This helps to keep static code size small 1418 but reduces the serviceability of the CIM server.<br> 1419 </ul> 1420 1421 1422 <h5>PEGASUS_REPOSITORY_MODE</h5> 1423 <ul> 1424 <b>Description: </b>This variable defines the default mode 1425 used to create repositories that are constructed as part of the 1426 automated build tests.  It does not affect the runtime 1427 environment. Valid values include: XML (causes 1428 the repository to be built in XML mode); BIN (causes
1429 kumpf 1.12 the repository to be built in binary mode). Use cimconfig to
1430 denise.eckstein 1.1 modify the runtime environment.<br> 1431 <b>Default Value: </b>XML<br> 1432 <b>Recommended Value (Development Build): </b>XML<br> 1433 <b>Recommended Value (Release Build): </b>XML<br> 1434 <b>Required: </b>No<p> </p> 1435 </ul> 1436
1437 kumpf 1.2 <h5>PEGASUS_REPOSITORY_STORE_COMPLETE_CLASSES</h5> 1438 <ul> 1439 <b>Description: </b>This variable defines the default contents of a 1440 class definition in the repository store when a new repository is created. 1441 Specifically, when set to true, propagated elements are included in a 1442 class definition in the persistent store. The contents of a class 1443 definition returned from the repository interface is not affected by this 1444 option.<br> 1445 <b>Default Value: </b>false<br> 1446 <b>Recommended Value (Development Build): </b>false<br> 1447 <b>Recommended Value (Release Build): </b>false<br> 1448 <b>Required: </b>No<p> </p> 1449 <b>Considerations: </b>A repository which stores complete class 1450 definitions does not allow modifications to non-leaf classes or changes 1451 to a superclass designation. Complete classes use more storage space, 1452 often twice as much as local (incomplete) classes. Class retrieval may 1453 be more expensive when local classes are stored. No specific mechanism 1454 is available to change this setting in an existing repository.<br> 1455 </ul> 1456
1457 denise.eckstein 1.1 <h5>PEGASUS_SLP_REG_TIMEOUT</h5> 1458 <ul> 1459 <b>Description: </b>Most SLP implementations allow a lifetime 1460 value to be specified in the registration sent to the SLP SA or 1461 DA. The PEGASUS_SLP_REG_TIMEOUT build variable allows a lifetime 1462 (ie. timeout) value to be specified on the SLP registration, with 1463 a 're-registration' being sent to SLP at the same specified 1464 timeout interval. The purpose of this lifetime or timeout value
1465 kumpf 1.12 is to avoid the accumulation of stale service information
1466 denise.eckstein 1.1 in the SA or DA.<br> 1467 <b>Default Value: </b>Undefined<br> 1468 <b>Recommended Value (Development Build): </b>Undefined<br> 1469 <b>Recommended Value (Release Build): </b>Undefined<br> 1470 <b>Required: </b>No<p><b>Example: </b> 1471 PEGASUS_SLP_REG_TIME=1440 (ie. 24 hours or 1 day)<br> 1472 <b>Considerations: </b>(1) The OpenPegasus internal SLP 1473 implementation does not support timeout registrations. This 1474 build option is useful, for example, if PEGASUS_USE_OPENSLP is
1475 kumpf 1.12 defined. (2) Some SLP implementations may impose a
1476 denise.eckstein 1.1 maximum value for the lifetime parameter. For example, OpenSLP
1477 kumpf 1.12 limits this value to SLP_LIFETIME_MAXIMUM (or 0xFFFF), and
1478 denise.eckstein 1.1 if this maximum value is passed to OpenSLP, then the timeout 1479 feature is disabled. Refer to the documentation of your SLP 1480 implementation for more information. (3) OpenPegasus will not
1481 kumpf 1.12 do any validity checking on the specified value, either
1482 denise.eckstein 1.1 to determine if it is a valid positive integer or if it 1483 exceeds some maximum value.<br>
1484 karl 1.29 </p></ul>
1485 denise.eckstein 1.1 1486 <h5>PEGASUS_SNIA_EXTENSIONS</h5> 1487 <ul> 1488 <b>Description: </b> This variable is used to enable a 1489 set of workarounds that support the use of OpenPegasus 1490 in the SNIA Test Environment.<br> 1491 <b>Default Value: </b>Not Set<br> 1492 <b>Recommended Value (Development Build): </b>Not Set<br> 1493 <b>Recommended Value (Release Build): </b>Not Set<br> 1494 <b>Required: </b>No<br> 1495 <b>Considerations: </b>The functionality enabled with this 1496 variable is experimental and subject to change. 1497 </ul> 1498 1499 <h5>PEGASUS_SKIP_MOST_TEST_DIRS</h5> 1500 <ul> 1501 <b>Description: </b>If set to true, this variable can be used 1502 to reduce the time required to build OpenPegasus by significantly 1503 reducing the number of tests that are built.<br> 1504 <b>Default Value: </b>Not Set<br> 1505 <b>Recommended Value (Development Build): </b>Not Set<br> 1506 denise.eckstein 1.1 <b>Recommended Value (Release Build): </b>Not Set<br> 1507 <b>Required: </b>No<br> 1508 <b>Considerations: </b>Setting this variable to true 1509 affects the behavior of all recursive make targets (e.g., 1510 clean, depend, all, unittests, alltests, and slptests). 1511 Use of this variable with test-related targets (e.g., unittests,
1512 kumpf 1.12 alltests and slptests) can produce unexpected results.
1513 denise.eckstein 1.1 To avoid creating an inconsistent PEGASUS_HOME directory, 1514 the PEGASUS_HOME directory (i.e., the OpenPegasus build 1515 directory) should be removed prior to enabling or disabling 1516 this variable. This variable should not be used to characterize
1517 kumpf 1.12 the set of files to be packaged in a release build. Please
1518 denise.eckstein 1.1 refer to the Runtime Packaging Definition PEP for the release
1519 kumpf 1.12 for a recommended list of files to be included in a release.
1520 denise.eckstein 1.1 </ul> 1521 1522 <h5>PEGASUS_TEST_ENABLE_DEBUG_TRACE</h5> 1523 <ul> 1524 <b>Description: </b> 1525 This variable is only used for testing. If set to true,
1526 kumpf 1.12 Discarded data trace will be enabled by the install_run 1527 target of the src/Server/Makefile before running the
1528 denise.eckstein 1.1 OpenPegasus TestMakefile test suite. <br> 1529 <b>Default Value: </b>Not Set<br> 1530 <b>Recommended Value (Development Build): </b>Set<br> 1531 <b>Recommended Value (Release Build): </b>Not Set<br> 1532 <b>Required: </b>No<br> 1533 <b>Considerations: </b>
1534 kumpf 1.12 This variable is useful in certain test environments to 1535 explicitly enable tracing to aid in better troubleshooting and
1536 denise.eckstein 1.1 detection of test failures (E.g. Test systems are experiencing
1537 kumpf 1.12 test failures due to connection timeouts, lost indications
1538 denise.eckstein 1.1 etc).<br> 1539 </ul> 1540 1541 <h5>PEGASUS_TEST_ISGROUP_GROUP/PEGASUS_TEST_ISGROUP_USER_SUCCESS/PEGASUS_TEST_ISGROUP_USER_FAILURE</h5> 1542 <ul>
1543 kumpf 1.12 <b>Description: </b>These variables are only used for testing.
1544 denise.eckstein 1.1 These variables allow the developer to define a valid group name, 1545 PEGASUS_TEST_ISGROUP_GROUP, a valid user name that is in the 1546 group, PEGASUS_TEST_ISGROUP_USER_SUCCESS, and an a valid user 1547 name that is not in the group, PEGASUS_TEST_ISGROUP_USER_FAILURE.
1548 kumpf 1.12 These variables are only used for testing and NOT part of the
1549 denise.eckstein 1.1 release.<br>
1550 kumpf 1.12 <b>Default Value(Windows):</b>
1551 denise.eckstein 1.1 Administrator/Administrators/Guest<br> 1552 <b>Default Value(Non-Windows): </b>root/root/guest<br> 1553 <b>Recommended Value (Development Build): </b> 1554 No Recommendation<br> 1555 <b>Recommended Value (Release Build): </b>Not Used<br> 1556 <b>Required: </b>No 1557 </ul> 1558 1559 <h5>PEGASUS_TEST_IPV6</h5> 1560 <ul> 1561 <b>Description: </b>This variable is only used for 1562 testing.  If set to true, the IPv6-specific tests will
1563 karl 1.29 be run as part of the "alltests" OpenPegasus
1564 denise.eckstein 1.1 TestMakefile test suite. If this variable is not set or set to 1565 false,  the IPv6-specific tests will not be run.  All 1566 other values are invalid.<br>
1567 kumpf 1.12 <b>Default Value:  </b>If PEGASUS_TEST_IPV6 is not defined,
1568 denise.eckstein 1.1 PEGASUS_TEST_IPV6 is set to the value of PEGASUS_ENABLE_IPV6.<br> 1569 <b>Recommended Value (Development Build): </b>Set to the value 1570 of PEGASUS_ENABLE_IPV6<br> 1571 <b>Recommended Value (Release Build): </b>Not Used<br> 1572 <b>Required: </b>No<br>
1573 kumpf 1.12 <b>Considerations: </b>This variable is useful in certain
1574 denise.eckstein 1.1 test environments to explicitly disable running the IPv6
1575 kumpf 1.12 tests (e.g., when running an IPv6-enabled version of
1576 denise.eckstein 1.1 OpenPegasus on an an IPv4 system).<br> 1577 </ul> 1578 1579 <h5>PEGASUS_TEST_SDK</h5> 1580 <ul>
1581 kumpf 1.12 <b>Description: </b>This variable is only used for
1582 denise.eckstein 1.1 testing.  It is used to control testing of the SDK 1583 sample providers and clients. If set, the setup, building and
1584 kumpf 1.12 testing of the SDK samples is enabled as part of the
1585 denise.eckstein 1.1 OpenPegasus automated build and test.<br> 1586 <b>Default Value: </b>Not Set<br> 1587 <b>Recommended Value (Development Build): </b>Set<br> 1588 <b>Recommended Value (Release Build): </b>Not Used<br> 1589 <b>Required: </b>No 1590 </ul> 1591 1592 <h5>PEGASUS_TEST_USER_DEFINED</h5> 1593 <ul> 1594 <b>Description: </b>This variable is only used for testing. 1595 If this variable is set, the tests will assume that the 1596 PEGASUS_TEST_USER_ID and PEGASUS_TEST_USER_PASS variables
1597 kumpf 1.12 defines a valid user/password pair and can be used for
1598 denise.eckstein 1.1 certificate-based authentication testing.  These tests
1599 karl 1.29 also assumes that "invalidUser" is not a valid
1600 denise.eckstein 1.1 user.<br> 1601 <b>Default Value: </b>Not Set<br> 1602 <b>Recommended Value (Development Build): </b>Set<br> 1603 <b>Recommended Value (Release Build): </b>Not Used<br> 1604 <b>Required: </b>No 1605 </ul> 1606 1607 <h5>PEGASUS_TEST_USER_ID/PEGASUS_TEST_USER_PASS</h5>
1608 karl 1.49
1609 denise.eckstein 1.1 <ul>
1610 karl 1.49 1611 <b>Description: </b>These variables are only used for testing. 1612 These variables allow the developer to define a valid, 1613 non-privileged  user name and password on the test system that can 1614 be used as part of the OpenPegasus automated test scripts to perform 1615 authentication and authorization testing.  These variables are 1616 only used for testing and NOT part of the release.<br>
1617 denise.eckstein 1.1 <b>Default Value: </b>guest/guest<br>
1618 karl 1.49 <b>Recommended Value (Development Build): </b> No Recommendation<br>
1619 denise.eckstein 1.1 <b>Recommended Value (Release Build): </b>Not Used<br> 1620 <b>Required: </b>No<br> 1621 </ul> 1622 1623 <h5>PEGASUS_TEST_VALGRIND_LOG_DIR</h5>
1624 karl 1.49
1625 denise.eckstein 1.1 <ul>
1626 karl 1.49 1627 <b>Description: </b> This variable is currently only supported 1628 on Linux. It may be set to run regression tests under the <a href="http://www.valgrind.org/">Valgrind</a> memory checking tool. It 1629 must specify a directory for writing Valgrind log files. The file name 1630 format for a particular log is 1631 PEGASUS_TEST_VALGRIND_LOG_DIR/PROGRAM_NAME.pid.<br>
1632 denise.eckstein 1.1 <b>Default Value: </b>Not Set<br> 1633 <b>Recommended Value (Development Build): </b>Not Set<br> 1634 <b>Recommended Value (Release Build): </b>Not Set<br> 1635 <b>Required: </b>No<br> 1636 <b>Considerations: </b>This flag is only supported on Linux to
1637 karl 1.49 enable running tests under Valgrind.<br>
1638 denise.eckstein 1.1 </ul> 1639 1640 <h5>PEGASUS_TMP</h5>
1641 karl 1.49
1642 denise.eckstein 1.1 <ul>
1643 karl 1.49
1644 denise.eckstein 1.1 <b>Description: </b>This variable is only used in a test
1645 karl 1.49 environment. It can be used to define the directory that OpenPegasus 1646 test programs should use to store temporary files.<br>
1647 denise.eckstein 1.1 <b>Default Value: </b>"."<br>
1648 karl 1.49 <b>Recommended Value (Development Build): </b> No Specific 1649 Recommendation<br>
1650 denise.eckstein 1.1 <b>Recommended Value (Release Build): </b>Not Used<br> 1651 <b>Required: </b>No<br> 1652 </ul>
1653 karl 1.49
1654 denise.eckstein 1.1 <h5>PEGASUS_USE_DEBUG_BUILD_OPTIONS</h5>
1655 karl 1.49
1656 denise.eckstein 1.1 <ul>
1657 karl 1.49 1658 <b>Description: </b>The PEGASUS_DEBUG flag is used to control a 1659 variety of settings, including compile options, assertion enablement, 1660 method definitions for testing, and diagnostic output.  The 1661 PEGASUS_USE_DEBUG_BUILD_OPTIONS variable can be used to enable just the 1662 compiler specific debug options (e.g., -g in g++) .<br>
1663 denise.eckstein 1.1 <b>Default Value: </b>Not Set<br> 1664 <b>Recommended Value (Development Build): </b>Set<br> 1665 <b>Recommended Value (Release Build): </b>Not Set<br> 1666 <b>Required: </b>No<br>
1667 karl 1.49 <b>Considerations: </b>This variable is automatically set if 1668 PEGASUS_DEBUG is set.<br>
1669 denise.eckstein 1.1 </ul> 1670 1671 <h5>PEGASUS_USE_EMANATE</h5>
1672 karl 1.49
1673 denise.eckstein 1.1 <ul>
1674 karl 1.49 1675 <b>Description: </b>EMANATE, <a href="http://www.snmp.com/products/emanate.html"> 1676 http://www.snmp.com/products/emanate.html</a>, is an SNMP Research 1677 International product that supports SNMPv1, SNMPv2c, and SNMPv3.  1678 If the PEGASUS_USE_EMANATE variable is defined, the OpenPegasus SNMP 1679 Handler will use the EMANATE libraries to send traps to the SNMP 1680 Management application.  The EMANATE libraries are NOT included as 1681 part of OpenPegasus.<br>
1682 denise.eckstein 1.1 <b>Default Value: </b>Not Set<br> 1683 <b>Recommended Value (Development Build): </b>Not Set<br> 1684 <b>Recommended Value (Release Build): </b>Not Set<br>
1685 karl 1.49 <b>Required: </b>No 1686 <p> <b>Considerations: </b>Either the PEGASUS_USE_NET_SNMP or 1687 PEGASUS_USE_EMANATE variable must be set for the SNMP Handler to be 1688 supported.<br> 1689 </p> 1690 </ul>
1691 denise.eckstein 1.1
1692 karl 1.49 <h5>PEGASUS_USE_NET_SNMP</h5>
1693 denise.eckstein 1.1 1694 <ul>
1695 karl 1.49 1696 <b>Description: </b>NET-SNMP, <a href="http://net-snmp.sourceforge.net"> http://net-snmp.sourceforge.net</a>,  1697 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 1698 and IPv6.   If the PEGASUS_USE_NET_SNMP variable is defined, 1699 the OpenPegasus SNMP Handler will use the NET-SNMP libraries to send 1700 traps to the SNMP Management application.  The NET-SNMP libraries 1701 are NOT included as part of OpenPegasus.<br>
1702 denise.eckstein 1.1 <b>Default Value: </b>Not Set<br> 1703 <b>Recommended Value (Development Build): </b>Not Set<br>
1704 karl 1.49 <b>Recommended Value (Release Build): </b>true for Linux, false 1705 for all other platforms<br> 1706 <b>Required: </b>No 1707 <p> <b>Considerations: </b>Either the PEGASUS_USE_NET_SNMP or 1708 PEGASUS_USE_EMANATE variable must be set for the SNMP Handler to be 1709 supported.<br> 1710 </p> 1711 </ul>
1712 denise.eckstein 1.1
1713 sahana.prabhakar 1.23 <h5>PEGASUS_ENABLE_NET_SNMPV3</h5>
1714 karl 1.49
1715 sahana.prabhakar 1.23 <ul>
1716 karl 1.49 1717 <b>Description: </b>If this variable is defined, then 1718 OpenPegasus SNMP Handler will build the SNMPV3 features. This should be 1719 set to false if NET-SNMP 5.2 and lower libraries are used.<br>
1720 sahana.prabhakar 1.23 <b>Default Value: </b>true<br> 1721 <b>Recommended Value (Development Build): </b>true<br> 1722 <b>Recommended Value (Release Build): </b>true<br>
1723 karl 1.49 <b>Required: </b>No 1724 <p> <b>Considerations: </b>PEGASUS_USE_NET_SNMP variable must 1725 be set.<br> 1726 </p> 1727 </ul>
1728 sahana.prabhakar 1.23
1729 karl 1.49 <h5>PEGASUS_USE_OPENSLP</h5>
1730 sahana.prabhakar 1.23
1731 denise.eckstein 1.1 <ul>
1732 karl 1.49
1733 denise.eckstein 1.1 <b>Description: </b>OpenSLP, <a href="http://www.openslp.org">
1734 karl 1.49 http://openslp.org</a>, is an open-source implementation of Service 1735 Location Protocol. If the PEGASUS_USE_OPENSLP variable is defined, 1736 OpenPegasus will be built to use the OpenSLP implementation of SLP 1737 instead of the internal OpenPegasus implementation of SLP. The OpenSLP 1738 libaries are NOT included as part of OpenPegasus. <b>Default 1739 Value: </b>Not Set<br>
1740 denise.eckstein 1.1 <b>Recommended Value (Development Build): </b>Not Set<br> 1741 <b>Recommended Value (Release Build): </b>Not Set<br> 1742 <b>Required: </b>No<br>
1743 karl 1.49 <b>Considerations: </b>PEGASUS_ENABLE_SLP must be defined if 1744 this variable is set.
1745 denise.eckstein 1.1 </ul> 1746 1747 <h5>PEGASUS_USE_PAM_STANDALONE_PROC</h5>
1748 karl 1.49
1749 denise.eckstein 1.1 <ul>
1750 karl 1.49
1751 denise.eckstein 1.1 <b>Description: </b>Moves the processing of PAM requests from
1752 karl 1.49 the CIM Server process to a separate process managed by the CIM Server.<br>
1753 denise.eckstein 1.1 <b>Default Value: </b>Not Set<br> 1754 <b>Recommended Value (Development Build): </b>Set<br> 1755 <b>Recommended Value (Release Build): </b>Set<br> 1756 <b>Required: </b>No<br>
1757 karl 1.49 <b>Considerations: </b>If PAM Authentication is enabled, the PAM 1758 API is used, during the processing of each request, to authenticate the 1759 client. This level of use makes the CIM Server extremely sensitive to 1760 memory leaks in the PAM library. In addition, certain PAM modules are 1761 not thread-safe. If your platform is experiencing problems with PAM 1762 Authentication, use of option may provide a work-around. 1763 PEGASUS_USE_PAM_STANDALONE_PROC requires PEGASUS_PAM_AUTHENTICATION to 1764 be set.<br>
1765 denise.eckstein 1.1 </ul> 1766 1767 <h5>PEGASUS_USE_RELEASE_CONFIG_OPTIONS</h5>
1768 karl 1.49
1769 denise.eckstein 1.1 <ul>
1770 karl 1.49 1771 <b>Description: </b>If set, OpenPegasus is built using the 1772 "Release Build" configuration options. By default, OpenPegasus is built 1773 using the "Development Build" configuration options.<br>
1774 s.kodali 1.19 <b>Default Value: </b>false<br> 1775 <b>Recommended Value (Development Build): </b>false<br> 1776 <b>Recommended Value (Release Build): </b>true<br>
1777 denise.eckstein 1.1 <b>Required: </b>No<br>
1778 karl 1.49 <b>Considerations: </b>(1)The PEGASUS_USE_RELEASE_CONFIG_OPTIONS 1779 variable allows a platform vendor to easily toggle between two sets of 1780 configurations options, a set of options tuned for the 1781 development/debug ("Development Build") environment and a set of 1782 options tuned for the production environment ("Release Build"). Refer 1783 the section titled "Configuration Properties" for additional 1784 detail.  (2) For each configuration variable,  the 1785 "Recommended Value (Release Build)" value defines the recommended 1786 settings to use for a "Release Build".  Please refer to the 1787 description of each variable for additional information.
1788 denise.eckstein 1.1 </ul> 1789 1790 <h5>PEGASUS_USE_RELEASE_DIRS</h5>
1791 karl 1.49
1792 denise.eckstein 1.1 <ul>
1793 karl 1.49 1794 <b>Description: </b>If set, OpenPegasus is built using the 1795 "Release Build" directory definitions. By default, OpenPegasus is built 1796 using the "Development Build" directory definitions.<br>
1797 denise.eckstein 1.1 <b>Default Value: </b>Not Set<br> 1798 <b>Recommended Value (Development Build): </b>Not Set<br> 1799 <b>Recommended Value (Release Build): </b>Set<br> 1800 <b>Required: </b>No<br>
1801 karl 1.49 <b>Considerations: </b> The PEGASUS_USE_RELEASE_DIRS variable 1802 allows a platform vendor to easily toggle between two sets of directory 1803 definitions, a set tuned for the development/debug ("Development 1804 Build") environment and a set tuned for the production environment 1805 ("Release Build"). Refer the section titled "Configuration Properties" 1806 for additional detail.<br>
1807 denise.eckstein 1.1 </ul> 1808
1809 s.kodali 1.18 <h5>PEGASUS_FLAVOR</h5>
1810 karl 1.49
1811 s.kodali 1.18 <ul>
1812 karl 1.49 1813 <b>Description: </b> This variable is used for configuring Multi 1814 CIMOM on same OS by eliminating single point for storage of PID's and 1815 configuration files. Flavor is used in structuring the release 1816 dirs,configuration file names, log identity and PAM config file. If 1817 set, OpenPegasus is built using the flavor value. By default 1818 OpenPegasus is built using "tog" as the flavor. RPMs are named using 1819 the flavor value. <br>
1820 s.kodali 1.18 <b>Default Value: </b>tog<br> 1821 <b>Recommended Value (Development Build): </b>tog<br> 1822 <b>Recommended Value (Release Build): </b>tog<br> 1823 <b>Required: </b>No<br>
1824 karl 1.49 <b>Considerations: </b> To build RPM using flavor, RPM spec file 1825 needs to be regenerated after setting the flavor value. This can be 1826 done using the create_OpenPegasusRPMSpecFile target in the 1827 Makefile.Release. Platforms have to define their own release dir 1828 structure using the flavor for release builds. An error will be 1829 reported if both PEGASUS_FLAVOR and PEGASUS_USE_RELEASE_DIRS are set 1830 and PEGASUS_OVERRIDE_DEFAULT_RELEASE_DIRS is not set. RPM build on 1831 linux defines PEGASUS_OVERRIDE_DEFAULT_RELEASE_DIRS by default. <br>
1832 s.kodali 1.18 </ul> 1833
1834 s.kodali 1.22 <h5>PEGASUS_PLATFORM_FOR_32BIT_PROVIDER_SUPPORT</h5>
1835 karl 1.49
1836 s.kodali 1.22 <ul>
1837 karl 1.49 1838 <b>Description: </b> Builds the Pegasus with 32-bit provider 1839 support for the specified platform. If this option is set, the value 1840 MUST be one of the 32-bit supported platforms by Pegasus. <br>
1841 s.kodali 1.22 <b>Default Value: </b>Not set<br> 1842 <b>Recommended Value (Development Build): </b>Not set<br> 1843 <b>Recommended Value (Release Build): </b>Not set<br> 1844 <b>Required: </b>No<br>
1845 karl 1.49 <b>Considerations: </b> This option is used to run the 32-bit 1846 providers under 64-bit CIMserver. To register the 32-bit providers, 1847 register the provider module by setting the Bitness property value to 1848 "2". 32-bit Providers are always loaded out of process irrespective of 1849 forceProviderProcesses config option. <br>
1850 s.kodali 1.22 </ul> 1851
1852 kumpf 1.6 <h5>PEGASUS_USE_SQLITE_REPOSITORY</h5>
1853 karl 1.49
1854 kumpf 1.6 <ul>
1855 karl 1.49
1856 kumpf 1.6 <b>Description: </b>If true, new repository stores are created
1857 karl 1.49 using a SQLite database. Existing file-based stores will continue to be 1858 recognized and operate seamlessly.<br>
1859 kumpf 1.6 <b>Default Value: </b>false<br> 1860 <b>Recommended Value (Development Build): </b>true<br> 1861 <b>Recommended Value (Release Build): </b>true<br> 1862 <b>Required: </b>No<br>
1863 karl 1.49 <b>Considerations: </b>If PEGASUS_USE_SQLITE_REPOSITORY is set 1864 to true and SQLite files are not installed in default search locations, 1865 SQLITE_HOME must also be configured. 1866 PEGASUS_REPOSITORY_STORE_COMPLETE_CLASSES may not be set to true when 1867 PEGASUS_USE_SQLITE_REPOSITORY is set to true.
1868 kumpf 1.6 </ul> 1869
1870 denise.eckstein 1.1 <h5>PEGASUS_USE_SYSLOGS</h5>
1871 karl 1.49
1872 denise.eckstein 1.1 <ul>
1873 karl 1.49 1874 <b>Description: </b>If set, OpenPegasus will be built to send 1875 log messages to the system logger (syslog). Otherwise, log messages 1876 will be sent to OpenPegasus specific log files.<br>
1877 denise.eckstein 1.1 <b>Recommended Value (Development Build): </b>Set<br> 1878 <b>Recommended Value (Release Build): </b>Set<br> 1879 <b>Required: </b>No<br>
1880 karl 1.49 <b>Considerations: </b>This variable is currently not 1881 implemented as an environment variable. To use the option 1882 -DPEGASUS_USE_SYSLOGS must be explicitly included in the appropriate 1883 platform makefile (pegasus/mak/platform_*.mak). 1884 </ul>
1885 denise.eckstein 1.1 1886 <h5>PEGASUS_WINDOWS_SDK_HOME</h5>
1887 karl 1.49
1888 denise.eckstein 1.1 <ul>
1889 karl 1.49 1890 <b>Description: </b>This variable should be set to point to the 1891 Microsoft Platform SDK on Windows if using a compiler version < 1300 1892 (i.e. VC6). If using VC7 or VC8, this flag does not need to be set, as 1893 the necessary libraries are already included.<br> 1894 <b>Recommended Value (Development Build): </b> No Specific 1895 Recommendation<br> 1896 <b>Recommended Value (Release Build): </b> No Specific 1897 Recommendation<br> 1898 <b>Required: </b>Yes, if building on Windows with a compiler 1899 version < 1300.<br>
1900 denise.eckstein 1.1 </ul> 1901
1902 kumpf 1.6 <h5>SQLITE_HOME</h5>
1903 karl 1.49
1904 kumpf 1.6 <ul>
1905 karl 1.49 1906 <b>Description: </b>Specifies the location of the SQLite SDK 1907 directory. This directory must contain sqlite3.h in the 1908 $(SQLITE_HOME)/include directory, and libsqlite3 in the 1909 $(SQLITE_HOME)/lib directory.<br> 1910 <b>Default Value: </b>Not Set<br> 1911 <b>Recommended Value (Development Build): </b> No Specific 1912 Recommendation<br> 1913 <b>Recommended Value (Release Build): </b> No Specific 1914 Recommendation<br> 1915 <b>Required: </b>Yes, if PEGASUS_USE_SQLITE_REPOSITORY is set to 1916 true and the SQLite files are not installed in locations that are 1917 searched by default.<br>
1918 kumpf 1.6 <b>Considerations: </b>This environment variable is only used if
1919 karl 1.49 PEGASUS_USE_SQLITE_REPOSITORY is set to true.
1920 kumpf 1.6 </ul> 1921
1922 marek 1.24 <h5>PEGASUS_INITIAL_THREADSTACK_SIZE</h5>
1923 karl 1.49
1924 marek 1.24 <ul>
1925 karl 1.49 1926 <b>Description: </b>This environment variable sets the initial 1927 size of the stack on new threads. Value is specified in number of bytes.<br>
1928 marek 1.24 <b>Default Value: </b>262144<br> 1929 <b>Recommended Value (Development Build): </b>262144<br> 1930 <b>Recommended Value (Release Build): </b>262144<br>
1931 karl 1.49 <b>Required: </b>No
1932 marek 1.24 </ul> 1933
1934 denise.eckstein 1.1 <h4>Examples Building a Linux IA32 (#IA64) Development/Debug Version</h4>
1935 karl 1.49
1936 denise.eckstein 1.1 <ul>
1937 karl 1.49 1938 export PEGASUS_ROOT=/home/pegasusbld/pegasus<br> 1939 export PEGASUS_HOME=/home/pegasusbld/pegasus/build<br> 1940 export PEGASUS_PLATFORM=LINUX_IX86_GNU<br> 1941 #export PEGASUS_PLATFORM=LINUX_IA64_GNU<br> 1942 export PEGASUS_PAM_AUTHENTICATION=true<br> 1943 export PEGASUS_USE_PAM_STANDALONE_PROC=true<br> 1944 export PEGASUS_HAS_SSL=yes<br> 1945 export PEGASUS_DEBUG=TRUE<br> 1946 export ENABLE_CMPI_PROVIDER_MANAGER=true<br> 1947 export PEGASUS_USE_SYSLOGS=true<br> 1948 export 1949 PATH=/home/pegasusbld:/home/pegasusbld/pegasus/build/bin:/usr/local/bin:$PATH<br>
1950 denise.eckstein 1.1 </ul> 1951 1952 <h4>Building a Linux IA32 (#IA64) Production Release Version</h4>
1953 karl 1.49
1954 denise.eckstein 1.1 <ul>
1955 karl 1.49 1956 export PEGASUS_ROOT=/home/pegasusbld/pegasus<br> 1957 export PEGASUS_HOME=/home/pegasusbld/pegasus/build<br> 1958 export PEGASUS_PLATFORM=LINUX_IX86_GNU<br> 1959 #export PEGASUS_PLATFORM=LINUX_IA64_GNU<br> 1960 export PEGASUS_ENABLE_CQL=false<br> 1961 export PEGASUS_PAM_AUTHENTICATION=true<br> 1962 export PEGASUS_USE_PAM_STANDALONE_PROC=true<br> 1963 export PEGASUS_HAS_SSL=yes<br> 1964 export PEGASUS_USE_RELEASE_CONFIG_OPTIONS=true<br> 1965 export PEGASUS_USE_RELEASE_DIRS=true<br> 1966 export PEGASUS_NOASSERTS=true<br> 1967 export ENABLE_CMPI_PROVIDER_MANAGER=true<br> 1968 export PEGASUS_ENABLE_USERGROUP_AUTHORIZATION=true<br> 1969 export PEGASUS_USE_SYSLOGS=true<br> 1970 export 1971 PATH=/home/pegasusbld:/home/pegasusbld/pegasus/build/bin:/usr/local/bin:$PATH<br>
1972 denise.eckstein 1.1 </ul> 1973 1974 <h3>Environment Variable Settings for <u>Running</u> OpenPegasus</h3> 1975 1976 <h4>Definitions</h4> 1977 1978 <h5>PEGASUS_HOME</h5>
1979 karl 1.49
1980 denise.eckstein 1.1 <ul>
1981 karl 1.49 1982 <b>Description: </b>There are multiple options for configuring 1983 the location of OpenPegasus runtime files (e.g., configuration files, 1984 libraries, repository, executables). If no other option is specified, 1985 OpenPegasus will attempt to use the value PEGASUS_HOME.<br>
1986 denise.eckstein 1.1 <b>Default Value: </b>"."<br>
1987 karl 1.49 <b>Recommended Value (Development Build): </b> The same value 1988 defined at build time.<br>
1989 denise.eckstein 1.1 <b>Recommended Value (Release Build): </b>Not Set<br> 1990 <b>Required: </b>No<br>
1991 karl 1.49 <b>Considerations: </b>Although this variable can be useful in a 1992 development environment use of this environment variable is not 1993 recommended in a production environment. Instead, the use of 1994 configuration properties to explicitly set the location of runtime 1995 files and directories is recommended.
1996 denise.eckstein 1.1 </ul> 1997 1998 <h5>PEGASUS_MSG_HOME</h5>
1999 karl 1.49
2000 denise.eckstein 1.1 <ul>
2001 karl 1.49
2002 denise.eckstein 1.1 <b>Description: </b>This value is not used by the CIM
2003 karl 1.49 Server.  The CIM Server uses the messageDir configuration 2004 parameter to locate the directory where the ICU resource bundles. 2005 However, CIM Client applications must rely on an alternative mechanism 2006 to locate this directory.<br>
2007 kumpf 1.12 <b>Default Value: </b>if $PEGASUS_HOME is set then
2008 karl 1.49 "$PEGASUS_HOME/msg" else "."<br>
2009 denise.eckstein 1.1 <b>Recommended Value (Development Build): </b>$PEGASUS_HOME/msg<br> 2010 <b>Recommended Value (Release Build): </b>Not Set <br> 2011 <b>Required: </b>No<br> 2012 </ul> 2013 2014 <h3>Configuration Properties</h3> 2015 2016 <h4>Notation</h4> 2017
2018 kumpf 1.12 <p>This section describes the notation used to define the
2019 denise.eckstein 1.1 configuration properties.</p> 2020 2021 <ul> 2022
2023 karl 1.49 <h5>Default Value</h5> 2024 The value of <i>Default Value</i> is the OpenPegasus default setting 2025 for this configuration option. This value is used if a 2026 platform-specific setting is not defined. 2027 <h5>Recommended Default Value</h5> 2028 The PEGASUS_USE_RELEASE_CONFIG_OPTIONS variable allows a platform 2029 vendor to easily toggle between two sets of configurations options, a 2030 set of options tuned for the development/debug ("Development Build") 2031 environment and a set of options tuned for the production environment 2032 ("Release Build"). The value of <i>Recommended Value (Development 2033 Build)</i> is the recommended default value for use in a development/ 2034 debug environment. The value of <i>Recommended Value (Release Build)</i> 2035 is the recommended default value for use in a production environment. 2036 <h5>Recommend To Be Fixed/Hidden</h5> 2037 Configuration options can be defined as fixed or hidden. A "fix" 2038 configuration option is set at build time and cannot be changed without 2039 rebuilding. "Fixed" configuration options are not displayed using the 2040 cimconfig command. This feature can be used by vendors to limit 2041 OpenPegasus functionality and configurability. A "hidden" configuration 2042 option is an option that is configurable (i.e., "not fixed"), but not 2043 externally advertised using the cimconfig command. The "hidden" feature 2044 karl 1.49 can be used to define "internal use only" configuration options. 2045 <h5>Dynamic?</h5> 2046 If yes, the value of the configuration option can be changed without 2047 stopping and restarting the CIM Server. 2048 <h5>Directory Specifications</h5> 2049 <p>Note that the variables included in the following table (e.g., 2050 $LOGDIR) are for documentation purposes only and have been defined to 2051 simplify the description of the configuration options.  In 2052 particular, these variables DO NOT correspond to environment variables 2053 implemented in the OpenPegasus code.  Default values for the 2054 following variables are platform and vendor dependent and not 2055 documented in this document.</p> 2056 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" height="228" width="148"> 2057 <tbody> 2058 <tr>
2059 karl 1.29 <th bgcolor="#cae6ca" height="16" width="1"> </th>
2060 denise.eckstein 1.1 </tr>
2061 karl 1.49 <tr align="center">
2062 karl 1.29 <td align="left" height="12" width="1">$LOGDIR</td>
2063 denise.eckstein 1.1 </tr> 2064 <tr align="center">
2065 karl 1.29 <td align="left" height="14" width="1">$PROVIDERDIRS</td>
2066 denise.eckstein 1.1 </tr> 2067 <tr align="center">
2068 karl 1.49 <td align="left" height="14" width="1"> $PROVIDERMANAGERDIRS</td>
2069 denise.eckstein 1.1 </tr> 2070 <tr align="center">
2071 karl 1.29 <td align="left" height="14" width="1">$REPOSITORYDIR </td>
2072 denise.eckstein 1.1 </tr> 2073 <tr align="center">
2074 karl 1.49 <td align="left" height="14" width="1">$CERTIFICATEDIR  </td>
2075 denise.eckstein 1.1 </tr> 2076 <tr align="center">
2077 karl 1.29 <td align="left" height="14" width="1">$LOCALAUTHDIR</td>
2078 denise.eckstein 1.1 </tr> 2079 <tr align="center">
2080 karl 1.29 <td align="left" height="14" width="1">$TRACEDIR</td>
2081 denise.eckstein 1.1 </tr> 2082 <tr align="center">
2083 karl 1.29 <td align="left" height="14" width="1">$CONFIGDIR</td>
2084 denise.eckstein 1.1 </tr> 2085 <tr align="center">
2086 karl 1.29 <td align="left" height="14" width="1">$PIDFILE</td>
2087 denise.eckstein 1.1 </tr> 2088 <tr align="center">
2089 karl 1.29 <td align="left" height="14" width="1">$RANDOMDIR</td>
2090 denise.eckstein 1.1 </tr> 2091 <tr align="center">
2092 karl 1.29 <td align="left" height="14" width="1">$SOCKETDIR</td>
2093 denise.eckstein 1.1 </tr> 2094 <tr align="center">
2095 karl 1.29 <td align="left" height="14" width="1">$MESSAGEDIR</td>
2096 denise.eckstein 1.1 </tr>
2097 lawrence.luo 1.45 <tr align="center"> 2098 <td align="left" height="14" width="1">$WEBCONFDIR</td> 2099 </tr>
2100 karl 1.49 </tbody> 2101 </table>
2102 kumpf 1.12 </ul>
2103 denise.eckstein 1.1 2104 <h4>Definitions</h4> 2105 2106 <h5>authorizedUserGroups</h5>
2107 karl 1.49
2108 denise.eckstein 1.1 <ul>
2109 karl 1.49 2110 <b>Description:</b> If the <b>authorizedUserGroups</b> property 2111 is set, the value is interpreted as a list of comma-separated user 2112 groups whose members may issue CIM requests. A user who is not a member 2113 of any of these groups is restricted from issuing CIM requests, with 2114 the exception of privileged users (root user). If the <b>authorizedUserGroups</b> 2115 property is not set, any user may issue CIM requests.<br>
2116 denise.eckstein 1.1 <b>Default Value: </b>blank<br> 2117 <b>Recommended Default Value (Development Build): </b>blank<br> 2118 <b>Recommended Default Value (Release Build): </b>blank<br>
2119 karl 1.49 <b>Recommend To Be Fixed/Hidden (Development Build): </b> No/No<br>
2120 denise.eckstein 1.1 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2121 <b>Dynamic?: </b>No<br>
2122 karl 1.49 <b>Example: </b> #cimconfig -s 2123 authorizedUserGroups=users,systemusers -p<br> 2124 <b>Considerations: </b>This feature is available only when the 2125 OpenPegasus source is compiled with the flag 2126 PEGASUS_ENABLE_USERGROUP_AUTHORIZATION set.
2127 denise.eckstein 1.1 </ul> 2128 2129 <h5>daemon</h5>
2130 karl 1.49
2131 denise.eckstein 1.1 <ul>
2132 karl 1.49 2133 <b>Description: </b>This option enables/disables forking of the 2134 code to create a background daemon process.<br>
2135 denise.eckstein 1.1 <b>Default Value: </b>true<br> 2136 <b>Recommended Default Value (Development Build): </b>true<br> 2137 <b>Recommended Default Value (Release Build): </b>true<br>
2138 karl 1.49 <b>Recommend To Be Fixed/Hidden (Development Build): </b> No/No<br> 2139 <b>Recommend To Be Fixed/Hidden (Release Build): </b> No/Yes<br> 2140 <b>Dynamic?: </b>No 2141 <p> <br> 2142 <br> 2143 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2144 <tbody> 2145 <tr> 2146 <th bgcolor="#cae6ca" width="168">Platform</th> 2147 <th bgcolor="#cae6ca" width="350">Source Configuration File</th> 2148 </tr> 2149 <tr align="center"> 2150 <td width="168">Linux</td> 2151 <td align="left" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td> 2152 </tr> 2153 <tr align="center"> 2154 <td width="168">HP-UX</td> 2155 <td align="left" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td> 2156 </tr> 2157 <tr align="center"> 2158 <td width="168">OpenVMS</td> 2159 karl 1.49 <td align="left" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td> 2160 </tr> 2161 </tbody> 2162 </table> 2163 </p> 2164 </ul>
2165 denise.eckstein 1.1 2166 <h5>enableAssociationTraversal</h5>
2167 karl 1.49
2168 denise.eckstein 1.1 <ul>
2169 karl 1.49 2170 <b>Description: </b>If true, the CIM Server will support the 2171 four association traversal operators: Associators, 2172 AssociatorNames,References, and ReferenceNames.<br>
2173 denise.eckstein 1.1 <b>Default Value: </b>true<br> 2174 <b>Recommended Default Value (Development Build): </b>true<br> 2175 <b>Recommended Default Value (Release Build): </b>true<br>
2176 karl 1.49 <b>Recommend To Be Fixed/Hidden (Development Build): </b> No/No<br>
2177 denise.eckstein 1.1 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2178 <b>Dynamic?: </b>No<br>
2179 karl 1.49 <b>Considerations: </b>There is still an outstanding Provider 2180 Registration issue that restricts the degree to which separate 2181 Providers can register for Associations.<br> 2182 <br> 2183 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2184 <tbody> 2185 <tr> 2186 <th bgcolor="#cae6ca" width="168">Platform</th> 2187 <th bgcolor="#cae6ca" width="350">Source Configuration File</th> 2188 </tr> 2189 <tr align="center"> 2190 <td width="168">Linux</td> 2191 <td align="left" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td> 2192 </tr> 2193 <tr align="center"> 2194 <td width="168">HP-UX</td> 2195 <td align="left" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td> 2196 </tr> 2197 <tr align="center"> 2198 <td width="168">OpenVMS</td> 2199 <td align="left" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td> 2200 karl 1.49 </tr> 2201 </tbody> 2202 </table>
2203 denise.eckstein 1.1 </ul> 2204 2205 <h5>enableAuditLog</h5>
2206 karl 1.49
2207 denise.eckstein 1.1 <ul>
2208 karl 1.49 2209 <b>Description: </b>Used to enable or disable audit logging at 2210 run time. If true, audit logging will be enabled.<br>
2211 denise.eckstein 1.1 <b>Recommended Default Value (Development Build): </b>false<br> 2212 <b>Recommended Default Value (Release Build): </b>false<br>
2213 karl 1.49 <b>Recommend To Be Fixed/Hidden (Development Build): </b> No/No<br>
2214 denise.eckstein 1.1 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2215 <b>Dynamic?: </b>Yes<br> 2216 <b>Source Configuration File: </b>
2217 karl 1.49 Pegasus/Config/DefaultPropertyTable.h<br>
2218 denise.eckstein 1.1 </ul> 2219 2220 <h5>enableAuthentication</h5>
2221 karl 1.49
2222 denise.eckstein 1.1 <ul>
2223 karl 1.49 2224 <b>Description: </b>If true, a Client must be authenticated to 2225 access the CIM Server.<br>
2226 denise.eckstein 1.1 <b>Recommended Default Value (Development Build): </b>false<br> 2227 <b>Recommended Default Value (Release Build): </b>true<br> 2228 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2229 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 2230 <b>Dynamic?: </b>No<br> 2231 <b>Source Configuration File: </b>
2232 karl 1.49 Pegasus/Config/SecurityPropertyOwner.cpp<br>
2233 denise.eckstein 1.1 </ul> 2234 2235 <h5>enableBinaryRepository</h5>
2236 karl 1.49
2237 denise.eckstein 1.1 <ul>
2238 karl 1.49
2239 denise.eckstein 1.1 <b>Description: </b>Setting this to true will activate the
2240 karl 1.49 binary repository support on the next restart of cimserver.<br>
2241 denise.eckstein 1.1 <b>Recommended Default Value (Development Build): </b>false<br> 2242 <b>Recommended Default Value (Release Build): </b>false<br> 2243 <b>Recommend To Be Fixed/Hidden (Development Build): </b>Yes<br> 2244 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 2245 <b>Dynamic?: </b>No<br>
2246 karl 1.49 <b>Considerations: </b>Repositories containing a mixture of 2247 binary and XML objects are supported.<br>
2248 denise.eckstein 1.1 <b>Source Configuration File: </b>
2249 karl 1.49 Pegasus/Config/RepositoryPropertyOwner.cpp
2250 denise.eckstein 1.1 </ul> 2251
2252 karl 1.49 <h5>enableHttpConnection</h5>
2253 denise.eckstein 1.1 2254 <ul>
2255 karl 1.49 2256 <b>Description: </b>If true, allows connections to the CIM 2257 Server using the HTTP protocol<br>
2258 denise.eckstein 1.1 <b>Default Value: </b>true<br> 2259 <b>Recommended Default Value (Development Build): </b>true<br> 2260 <b>Recommended Default Value (Release Build): </b>false<br> 2261 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2262 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2263 <b>Dynamic?: </b>No<br>
2264 karl 1.49 <b>Considerations: </b> Enabling HTTP will allow clients to 2265 connect with security properties different than those associated with 2266 encrypted SSL traffic, and its configured SSL authentication or other 2267 security behavior. This option should only be enabled in environments 2268 where sending the HTTP Request and HTTP Response as clear text messages 2269 does not introduce a security risk.  Note that if authentication 2270 is enabled (enableAuthentication), user names and passwords will be 2271 included in the text of the HTTP message.<br> 2272 <br> 2273 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2274 <tbody> 2275 <tr> 2276 <th bgcolor="#cae6ca" width="168">Platform</th> 2277 <th bgcolor="#cae6ca" width="350">Source Configuration File</th> 2278 </tr> 2279 <tr align="center"> 2280 <td width="168">Linux</td> 2281 <td align="left" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td> 2282 </tr> 2283 <tr align="center"> 2284 <td width="168">HP-UX</td> 2285 karl 1.49 <td align="left" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td> 2286 </tr> 2287 <tr align="center"> 2288 <td width="168">OpenVMS</td> 2289 <td align="left" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td> 2290 </tr> 2291 </tbody> 2292 </table>
2293 denise.eckstein 1.1 </ul> 2294 2295 <h5>enableHttpsConnection</h5>
2296 karl 1.49
2297 denise.eckstein 1.1 <ul>
2298 karl 1.49 2299 <b>Description: </b>If true, allows connections to the CIM 2300 Server using the HTTPS protocol (HTTP using Secure Socket Layer 2301 encryption)<br>
2302 denise.eckstein 1.1 <b>Default Value: </b>false<br> 2303 <b>Recommended Default Value (Development Build): </b>true<br> 2304 <b>Recommended Default Value (Release Build): </b>true<br> 2305 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2306 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2307 <b>Dynamic?: </b>No<br>
2308 karl 1.49 <b>Considerations: </b>For this option to work, the environment 2309 variable PEGASUS_HAS_SSL must have been set when CIM Server was built.<br> 2310 <br> 2311 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2312 <tbody> 2313 <tr> 2314 <th bgcolor="#cae6ca" width="168">Platform</th> 2315 <th bgcolor="#cae6ca" width="350">Source Configuration File</th> 2316 </tr> 2317 <tr align="center"> 2318 <td width="168">Linux</td> 2319 <td align="left" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td> 2320 </tr> 2321 <tr align="center"> 2322 <td width="168">HP-UX</td> 2323 <td align="left" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td> 2324 </tr> 2325 <tr align="center"> 2326 <td width="168">OpenVMS</td> 2327 <td align="left" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td> 2328 </tr> 2329 karl 1.49 </tbody> 2330 </table>
2331 denise.eckstein 1.1 </ul> 2332 2333 <h5>enableIndicationService</h5>
2334 karl 1.49
2335 denise.eckstein 1.1 <ul>
2336 karl 1.49 2337 <b>Description: </b>If true, the CIM Server will support CIM 2338 Indications.<br>
2339 denise.eckstein 1.1 <b>Default Value: </b>true<br> 2340 <b>Recommended Default Value (Development Build): </b>true<br> 2341 <b>Recommended Default Value (Release Build): </b>true<br> 2342 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2343 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2344 venkat.puvvada 1.15 <b>Dynamic?: </b>Yes/No<br> 2345 <b>Considerations: </b>When enableIndicationService is set to
2346 karl 1.49 false dynamically, delete subscription requests are sent to all 2347 indication providers and indication related operations are not 2348 supported until indication service is re-enabled. Dynamic configuration 2349 facility is available only when Pegasus is compiled with 2350 PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT=true. Clients who wants 2351 to utilize the IndicationService services MUST check for 2352 CIM_IndicationService EnabledState and HealthState properties to know 2353 the current indication service state. For example, User can enumerate 2354 instances of CIM_IndicationService and there is exactly one instance of 2355 CIM_IndicationService returned. (Ex. using cimcli command 'cimcli ei -n 2356 root/PG_InterOp CIM_IndicationService'). When requested state 2357 change(Enabled/Disabled) cannot be made because of timeout or some 2358 other exception IndicationService HealthState is set to 2359 "Degraded/Warning". For example, if user requested for indication 2360 service disable (by setting enableIndicationService=false), disable 2361 failed because of timeout or some other exception. Now service health 2362 state is set to "Degraded/Warning" and service EnabledState will remain 2363 enabled. User can now identify the faulty provider causing the timeout 2364 or any other problem and can take appropriate action. User can again 2365 request for service disable to recover from degraded state. Similar 2366 sequence applies while enabling the indication service. Only difference 2367 karl 1.49 is that service EnabledState is set to Enabled if exception or timeout 2368 happens. There is no automatic recovery from degraded state is 2369 available at present.<br>
2370 denise.eckstein 1.1 <br>
2371 karl 1.49 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2372 <tbody> 2373 <tr> 2374 <th bgcolor="#cae6ca" width="168">Platform</th> 2375 <th bgcolor="#cae6ca" width="350">Source Configuration File</th> 2376 </tr> 2377 <tr align="center"> 2378 <td width="168">Linux</td> 2379 <td align="left" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td> 2380 </tr> 2381 <tr align="center"> 2382 <td width="168">HP-UX</td> 2383 <td align="left" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td> 2384 </tr> 2385 <tr align="center"> 2386 <td width="168">OpenVMS</td> 2387 <td align="left" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td> 2388 </tr> 2389 </tbody> 2390 </table>
2391 denise.eckstein 1.1 </ul> 2392 2393 <h5>enableNamespaceAuthorization</h5>
2394 karl 1.49
2395 denise.eckstein 1.1 <ul>
2396 karl 1.49 2397 <b>Description: </b>If true, the CIM Server restricts access to 2398 namespaces based on configured user authorizations [user authorizations 2399 may be configured using the cimauth command]<br>
2400 denise.eckstein 1.1 <b>Default Value: </b>false<br> 2401 <b>Recommended Default Value (Development Build): </b>false<br> 2402 <b>Recommended Default Value (Release Build): </b>false<br> 2403 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2404 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2405 <b>Dynamic?: </b>No<br>
2406 karl 1.49 <b>Considerations: </b> This option offers limited functionality 2407 and, in most environments, expensive to administer. It's use is not 2408 recommended.<br>
2409 denise.eckstein 1.1 <b>Source Configuration File: </b>
2410 karl 1.49 Pegasus/Config/SecurityPropertyOwner.cpp 2411 </ul>
2412 denise.eckstein 1.1 2413 <h5>enableNormalization</h5>
2414 karl 1.49
2415 denise.eckstein 1.1 <ul>
2416 karl 1.49
2417 kumpf 1.12 <b>Description: </b>If true, objects returned from instance
2418 karl 1.49 providers are validated and normalized. <br>
2419 denise.eckstein 1.1 <b>Default Value: </b>true<br> 2420 <b>Recommended Default Value (Development Build): </b>true<br> 2421 <b>Recommended Default Value (Release Build): </b>false<br> 2422 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2423 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2424 kavita.gupta 1.7 <b>Dynamic?: </b>Yes<br>
2425 denise.eckstein 1.1 <b>Considerations: </b>
2426 karl 1.49 <ul> 2427 <li>Any errors encountered during normalization result in a 2428 CIMException with the status code set to CIM_ERR_FAILED and a 2429 meaningful, context specific error description (messages will be 2430 localized). Providers that catch the exception have an opportunity to 2431 handle the error. Otherwise, the exception is passed to the Provider 2432 Manager and becomes the response for that Provider. </li> 2433 <li>Provider Modules that are listed on the 2434 excludeModulesFromNormalization configuration option are excluded from 2435 normalization. </li> 2436 <li>Since the concept of normalization is relatively new to 2437 OpenPegasus and it establishes and enforces rules for objects returned 2438 by providers, it should only apply to providers written against the SDK 2439 in which it was introduced (or later). Therefore only Provider Modules 2440 that have the following InterfaceType and InterfaceVersion combination 2441 will be subject to normalization: 2442 <ul> 2443 <li>'C++Default' / 2.5.0 or greater </li> 2444 <li>'CMPI' / 2.0.0 or greater </li> 2445 <li>'JMPI' / 1.0.0 or greater </li> 2446 </ul> 2447 karl 1.49 </li> 2448 </ul>
2449 denise.eckstein 1.1 <b>Source Configuration File: </b>
2450 karl 1.49 Pegasus/Config/NormalizationPropertyOwner.cpp<br>
2451 denise.eckstein 1.1 </ul> 2452
2453 karl 1.49 <h5>enableRemotePrivilegedUserAccess</h5>
2454 denise.eckstein 1.1 2455 <ul>
2456 karl 1.49 2457 <b>Description: </b>If true, the CIM Server allows access by a 2458 privileged user from a remote system<br>
2459 denise.eckstein 1.1 <b>Default Value: </b>true<br> 2460 <b>Recommended Default Value (Development Build): </b>true<br> 2461 <b>Recommended Default Value (Release Build): </b>true<br> 2462 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2463 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2464 <b>Dynamic?: </b>No<br> 2465 <b>Considerations: </b>Many management operations require
2466 karl 1.49 privileged user access. Disabling remote access by privileged user 2467 could significantly affect functionality.<br>
2468 denise.eckstein 1.1 <b>Source Configuration File: </b>
2469 karl 1.49 Pegasus/Config/SecurityPropertyOwner.cpp 2470 <p> </p>
2471 denise.eckstein 1.1 </ul> 2472 2473 <h5>enableSubscriptionsForNonprivilegedUsers</h5>
2474 karl 1.49
2475 denise.eckstein 1.1 <ul>
2476 karl 1.49 2477 <b>Description: </b>If true, operations (create instance, modify 2478 instance, delete instance, get instance, enumerate instances, enumerate 2479 instance names) on indication filter, listener destination, and 2480 subscription instances may be performed by non-privileged users. 2481 Otherwise, these operations may only be performed on these instances by 2482 privileged users.<br>
2483 denise.eckstein 1.1 <b>Default Value: </b>true<br> 2484 <b>Recommended Default Value (Development Build): </b>true<br> 2485 <b>Recommended Default Value (Release Build): </b>false<br> 2486 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2487 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2488 <b>Dynamic?: </b>No<br>
2489 kumpf 1.12 <b>Considerations: </b>This option has meaning only if
2490 karl 1.49 enableIndicationService=true.<br>
2491 denise.eckstein 1.1 <b>Source Configuration File: </b>
2492 karl 1.49 Pegasus/Config/SecurityPropertyOwner.cpp 2493 <p> </p>
2494 denise.eckstein 1.1 </ul> 2495 2496 <h5>excludeModulesFromNormalization</h5>
2497 karl 1.49
2498 denise.eckstein 1.1 <ul>
2499 karl 1.49
2500 kumpf 1.12 <b>Description: </b>If the excludeModulesfromNormalization
2501 karl 1.49 property is set, the value is interpreted as a list of comma-separated 2502 Provider Module names (as specified in PG_ProviderModule.Name) to 2503 exclude from validation and normalization.<br>
2504 karl 1.29 <b>Default Value: </b>""<br>
2505 karl 1.49 <b>Recommended Default Value (Development Build):</b> ""<br> 2506 <b>Recommended Default Value (Release Build): </b> ""<br>
2507 denise.eckstein 1.1 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2508 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2509 <b>Dynamic?: </b>No<br>
2510 karl 1.49 <b>Considerations: </b>All objects managed by all providers will 2511 be excluded from validation and normalization if its module name 2512 appears in this list.<br>
2513 denise.eckstein 1.1 <b>Source Configuration File: </b>
2514 karl 1.49 Pegasus/Config/NormalizationPropertyOwner.cpp
2515 denise.eckstein 1.1 </ul> 2516 2517 <h5>forceProviderProcesses</h5>
2518 karl 1.49
2519 denise.eckstein 1.1 <ul>
2520 karl 1.49 2521 <b>Description: </b>If true, the CIM Server runs Providers in 2522 separate processes rather than loading and calling Provider libraries 2523 directly within the CIM Server process.<br>
2524 kumpf 1.12 <b>Default Value: </b>Dependent on the value of
2525 karl 1.49 PEGASUS_DEFAULT_ENABLE_OOP<br>
2526 denise.eckstein 1.1 <b>Recommended Default Value (Development Build):</b>true (HP-UX,
2527 karl 1.49 Linux)<br>
2528 denise.eckstein 1.1 <b>Recommended Default Value (Release Build): </b>true (HP-UX,
2529 karl 1.49 Linux)<br>
2530 denise.eckstein 1.1 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2531 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2532 <b>Dynamic?: </b>No<br> 2533 <b>Considerations: </b>In a dynamic, potentially multi-vendor,
2534 karl 1.49 environment, the ability to run Providers in separate processes can 2535 significantly increase the stability, maintainability and 2536 supportability of the overall solution.  Running Providers in 2537 separate process spaces: (1) helps isolate components (i.e., cimserver 2538 and Providers) from a catastrophic failure (segmentation faults, memory 2539 leaks) of a single Provider and (2) reduces the risk of accidental or 2540 malicious sharing of sensitive data among Providers.  This benefit 2541 comes at a cost.  Moving Providers out of the cimserver process 2542 increases communication costs and can significantly increase response 2543 time.  Actual results will vary, but it is common for response 2544 times to increase by a factor of 2.<br> 2545 <b>Note 1: </b>When forceProviderProcesses is true, the CIM Server 2546 will load each Provider Module (i.e., library) into a separate process. 2547 Providers in different Provider Modules cannot depend on a 2548 communication mechanism that requires them to run in the same process 2549 space.<br> 2550 <b>Note 2: </b>Although the catastrophic failure of an 2551 Out-Of-Process (OOP) Provider Module will not result in a failure of 2552 the CIM Server process, if the failed OOP Provider Module included 2553 Indication Providers, Indications may be lost.  If logging is 2554 enabled, the CIM Server will log a message informing administrators of 2555 karl 1.49 what happened and what corrective actions can be taken.<br> 2556 <br> 2557 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2558 <tbody> 2559 <tr> 2560 <th bgcolor="#cae6ca" width="168">Platform</th> 2561 <th bgcolor="#cae6ca" width="350"> Source Configuration File</th> 2562 </tr> 2563 <tr align="center"> 2564 <td width="168">Linux</td> 2565 <td align="left" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td> 2566 </tr> 2567 <tr align="center"> 2568 <td width="168">HP-UX</td> 2569 <td align="left" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td> 2570 </tr> 2571 <tr align="center"> 2572 <td width="168">OpenVMS</td> 2573 <td align="left" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td> 2574 </tr> 2575 </tbody> 2576 karl 1.49 </table>
2577 denise.eckstein 1.1 </ul> 2578 2579 <h5>home</h5>
2580 karl 1.49
2581 denise.eckstein 1.1 <ul>
2582 karl 1.49
2583 denise.eckstein 1.1 <b>Description: </b>If set, this configuration option defines
2584 karl 1.49 the runtime default value for PEGASUS_HOME.<br>
2585 denise.eckstein 1.1 <b>Default Value: </b>"./"<br> 2586 <b>Recommended Default Value (Development Build)</b>"./"<br> 2587 <b>Recommended Default Value (Release Build)""</b><br> 2588 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2589 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br>
2590 karl 1.49 <b>Dynamic?: </b>No 2591 <p> <br> 2592 <br> 2593 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2594 <tbody> 2595 <tr> 2596 <th bgcolor="#cae6ca" width="168">Platform</th> 2597 <th bgcolor="#cae6ca" width="350">Source Configuration File</th> 2598 </tr> 2599 <tr align="center"> 2600 <td width="168">Linux</td> 2601 <td align="left" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td> 2602 </tr> 2603 <tr align="center"> 2604 <td width="168">HP-UX</td> 2605 <td align="left" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td> 2606 </tr> 2607 <tr align="center"> 2608 <td width="168">OpenVMS</td> 2609 <td align="left" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td> 2610 </tr> 2611 karl 1.49 </tbody> 2612 </table> 2613 </p> 2614 </ul>
2615 denise.eckstein 1.1
2616 marek 1.34 <h5>hostname</h5>
2617 karl 1.49
2618 marek 1.34 <ul>
2619 karl 1.49 2620 <b>Description: </b> Can be used to override the local system 2621 supplied hostname without domain the CIM Server is using to build 2622 objects. If not set, querying this configuration option will report the 2623 system supplied hostname and behavior is not changed.<br> 2624 Setting this value to a valid hostname on CIM Server startup or as 2625 planned value will force the server to assume the configured name as 2626 the local hosts name. Setting this allows the administrator to set the 2627 name that operations such as associator, reference etc. return with 2628 object paths.<br> 2629 In common setups it is not recommended to explicitly set this value. <br> 2630 <b>Usage scenarios: </b> The following scenarios in which 2631 changing the default value makes sense are known today:<br> 2632 1. The case where what the CIM Server shall return to clients for host 2633 name is NOT the name of the current host but some administrator defined 2634 name (ex. system behind a firewall or some redirector).<br> 2635 2. Embedded systems that have a system set hostname which is not valid 2636 and needs to be overridden by CIM administrator without changing the 2637 actual IP configuration. <br> 2638 <b>Recommended Default Value (Development Build): </b> blank<br> 2639 <b>Recommended Default Value (Release Build): </b> blank<br>
2640 marek 1.34 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2641 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2642 <b>Dynamic?: </b>No<br>
2643 karl 1.49 <b>Considerations: </b> When setting this configuration option the 2644 option fullyQualifiedHostName should be adjusted too.<br> 2645 Providers returning the systems hostname in an instance property might 2646 return a different value then the CIM server is setting in the object 2647 path. hostnames explicitly set into the object paths by providers will 2648 not be overridden by the CIM Server to allow cross-namespace 2649 associations. <br> 2650 It is necessary to upgrade existing repositories using the repupgrade 2651 utility when upgrading from an OpenPegasus version less than 2.12. <br>
2652 marek 1.34 <b>Source Configuration File: </b>
2653 karl 1.49 Pegasus/Config/DefaultPropertyOwner.cpp
2654 marek 1.34 </ul> 2655 2656 <h5>fullyQualifiedHostName</h5>
2657 karl 1.49
2658 marek 1.34 <ul>
2659 karl 1.49 2660 <b>Description: </b> Can be used to override the local system 2661 supplied fully qualified hostname (with domain) the CIM Server is using 2662 to build objects. If not set, querying this configuration option will 2663 report the system supplied fully qualified hostname and behavior is not 2664 changed.<br> 2665 Setting this value to a valid hostname on CIM Server startup or as 2666 planned value will force the server to assume the configured name as 2667 the local hosts name with domain. Setting this allows the administrator 2668 to set the name that indication operations and the CIM_ObjectManager 2669 assume for SystemName returned as instance and key properties.<br> 2670 In common setups it is not recommended to explicitly set this value. <br> 2671 <b>Usage scenarios: </b> The following scenarios in which 2672 changing the default value makes sense are known today:<br> 2673 1. The case where what the CIM Server shall return to clients for 2674 SystemName is NOT the name of the current host but some administrator 2675 defined name (ex. system behind a firewall or some redirector).<br> 2676 2. Embedded systems that have a system set hostname which is not valid 2677 and needs to be overridden by CIM administrator without changing the 2678 actual IP configuration. <br> 2679 <b>Recommended Default Value (Development Build): </b> blank<br> 2680 karl 1.49 <b>Recommended Default Value (Release Build): </b> blank<br>
2681 marek 1.34 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2682 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2683 <b>Dynamic?: </b>No<br>
2684 karl 1.49 <b>Considerations: </b> When setting this configuration option the 2685 option fullyQualifiedHostName should be adjusted too.<br> 2686 Providers returning the systems hostname in an instance property might 2687 return a different value then the CIM server is setting in SystemName. <br> 2688 It is necessary to upgrade existing repositories using the repupgrade 2689 utility when upgrading from an OpenPegasus version less than 2.12. <br>
2690 marek 1.34 <b>Source Configuration File: </b>
2691 karl 1.49 Pegasus/Config/DefaultPropertyOwner.cpp
2692 marek 1.34 </ul> 2693
2694 jsafrane 1.50 <h5>httpAuthType</h5> 2695 <ul> 2696 <b>Description: </b>Type of HTTP authentication. Allowed values are 2697 'basic', indicating basic authentication or 'negotiate' indicating use of 2698 HTPP Negotiate authentication method. This variable is effective only when 2699 'enableAuthentication' variable is set to 'true'.<br> 2700 <b>Default Value: </b>basic<br> 2701 <b>Recommended Default Value (Development Build): </b>basic<br> 2702 <b>Recommended Default Value (Release Build): </b>basic<br> 2703 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2704 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No<br> 2705 <b>Dynamic?: </b>No<br> 2706 <b>Considerations: </b>Value 'negotiate' is available only when Pegasus 2707 is compiled with PEGASUS_NEGOTIATE_AUTHENTICATION=true.<br> 2708 <b>Source Configuration File: </b> 2709 Pegasus/Config/SecurityPropertyOwner.cpp 2710 </ul> 2711
2712 denise.eckstein 1.1 <h5>httpPort</h5>
2713 karl 1.49
2714 denise.eckstein 1.1 <ul>
2715 karl 1.49
2716 kumpf 1.12 <b>Description: </b>OpenPegasus first attempts to look up the
2717 karl 1.49 port number for HTTP using getservbyname for the 'wbem-http' service. 2718 The httpPort configuration setting is used only when the getservbyname 2719 lookup fails.<br>
2720 denise.eckstein 1.1 <b>Default Value: </b>blank<br> 2721 <b>Recommended Default Value (Development Build): </b>blank<br> 2722 <b>Recommended Default Value (Release Build): </b>5988<br> 2723 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2724 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 2725 <b>Dynamic?: </b>No<br>
2726 kumpf 1.12 <b>Considerations: </b>(1)The use of 5988 for WBEM HTTP is
2727 denise.eckstein 1.1 recommended by the DMTF. This port has been registered with 2728 <a href="http://www.iana.org/assignments/port-numbers"> 2729 IANA</a>. In a production environment, the recommendation is 2730 to use /etc/services to configure the value of this port. (2)
2731 kumpf 1.12 With the release of OpenPegasus 2.5, the default values for
2732 karl 1.29 httpPort was changed from 5988 to "". This
2733 denise.eckstein 1.1 change was made to allow the OpenPegasus to differentiate
2734 kumpf 1.12 between a default setting of 5988 and a customer-defined
2735 denise.eckstein 1.1 setting of 5988.  With this change,  if the port
2736 kumpf 1.12 number is explicitly set, the configured port will be used
2737 denise.eckstein 1.1 regardless of the settings in /etc/services. If no port number 2738 is specified, the server will continue to use the value in 2739 /etc/services.<br> 2740 <br>
2741 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2742 <tbody><tr> 2743 <th bgcolor="#cae6ca" width="168">Platform</th> 2744 <th bgcolor="#cae6ca" width="350">Source Configuration File</th>
2745 denise.eckstein 1.1 </tr> 2746 <tr align="center"> 2747 <td width="168">Linux</td> 2748 <td align="left" width="350"> 2749 Pegasus/Config/DefaultPropertyTableLinux.h</td> 2750 </tr> 2751 <tr align="center"> 2752 <td width="168">HP-UX</td> 2753 <td align="left" width="350"> 2754 Pegasus/Config/DefaultPropertyTableHpux.h</td> 2755 </tr> 2756 <tr align="center"> 2757 <td width="168">OpenVMS</td> 2758 <td align="left" width="350"> 2759 Pegasus/Config/DefaultPropertyTableVms.h</td> 2760 </tr>
2761 karl 1.29 </tbody></table>
2762 denise.eckstein 1.1 </ul> 2763 2764 <h5>httpsPort</h5> 2765 <ul> 2766 <b>Description: </b> 2767 OpenPegasus first attempts to look up the port number for HTTPS 2768 using getservbyname for the 'wbem-https' service. The httpsPort
2769 kumpf 1.12 configuration setting is used only when the getservbyname lookup
2770 denise.eckstein 1.1 fails.<br> 2771 <b>Default Value: </b>blank<br> 2772 <b>Recommended Default Value (Development Build): </b>blank<br> 2773 <b>Recommended Default Value (Release Build): </b>5989<br> 2774 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2775 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 2776 <b>Dynamic?: </b>No<br> 2777 <b>Considerations: </b>(1)The use of 5989 for WBEM HTTPS 2778 is recommended by the DMTF. This port has been registered with 2779 <a href="http://www.iana.org/assignments/port-numbers">IANA</a>.
2780 kumpf 1.12 In a production environment, the recommendation is to use
2781 denise.eckstein 1.1 /etc/services to configure the value of this port.(2)
2782 kumpf 1.12 With the release of OpenPegasus 2.5, the default values for
2783 karl 1.29 httpPort was changed from 5989 to "". This
2784 kumpf 1.12 change was made to allow the OpenPegasus to differentiate 2785 between a default setting of 5989 and a customer-defined
2786 denise.eckstein 1.1 setting of 5989.  With this change,  if the port number
2787 kumpf 1.12 is explicitly set, the configured port will be used regardless
2788 denise.eckstein 1.1 of the settings in /etc/services. If no port number is specified, 2789 the server will continue to use the value in /etc/services.<br> 2790 <br> 2791
2792 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 2793 <tbody><tr> 2794 <th bgcolor="#cae6ca" width="168">Platform</th> 2795 <th bgcolor="#cae6ca" width="350">Source Configuration File</th>
2796 denise.eckstein 1.1 </tr> 2797 <tr align="center"> 2798 <td width="168">Linux</td> 2799 <td align="left" width="350"> 2800 Pegasus/Config/DefaultPropertyTableLinux.h</td> 2801 </tr> 2802 <tr align="center"> 2803 <td width="168">HP-UX</td> 2804 <td align="left" width="350"> 2805 Pegasus/Config/DefaultPropertyTableHpux.h</td> 2806 </tr> 2807 <tr align="center"> 2808 <td width="168">OpenVMS</td> 2809 <td align="left" width="350"> 2810 Pegasus/Config/DefaultPropertyTableVms.h</td> 2811 </tr>
2812 karl 1.29 </tbody></table>
2813 denise.eckstein 1.1 </ul> 2814
2815 jsafrane 1.51 <h5>httpSessionTimeout</h5> 2816 <ul> 2817 <b>Description: </b>If set to a positive integer, this value 2818 specifies a HTTP session lifetime in seconds. 2819 <br> 2820 After initial authentication using standard HTTP mechanisms 2821 (HTTP Basic or Negotiate authentication), the server generates a cookie 2822 and sends it back to the client, as described in RFC 6265. The client 2823 can then use the cookie in subsequent requests to skip the usual HTTP 2824 authentication. The cookie is valid only for period of time specified by 2825 this configuration option. 2826 <br> 2827 If set to zero, session management is turned off and CIM server will not 2828 issue cookies. 2829 <br> 2830 This option is available only when Pegasus was compiled with 2831 PEGASUS_ENABLE_SESSION_COOKIES set to 'true'. 2832 <br> 2833 <b>Recommended Default Value (Development Build): </b>0<br> 2834 <b>Recommended Default Value (Release Build): </b>0<br> 2835 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2836 jsafrane 1.51 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2837 <b>Dynamic?: </b>Yes<br> 2838 <b>Considerations: </b> 2839 The session timeout should be set to relatively small number (e.g. 30) to 2840 ensure the window, when the a potentially stolen cookie can be re-used, is 2841 quite small. This means every client will be re-authenticated the usual way 2842 (HTTP Basic or Negotiate) at least every 30 seconds. 2843 <br> 2844 </ul> 2845 2846
2847 denise.eckstein 1.1 <h5>idleConnectionTimeout</h5> 2848 <ul> 2849 <b>Description: </b>If set to a positive integer, this value 2850 specifies a minimum timeout value for idle client connections. 2851 If set to zero, idle client connections do not time out.<br> 2852 <b>Recommended Default Value (Development Build): </b>0<br> 2853 <b>Recommended Default Value (Release Build): </b>0<br> 2854 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2855 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2856 kavita.gupta 1.11 <b>Dynamic?: </b>Yes<br>
2857 denise.eckstein 1.1 <b>Considerations: </b>A client connection is considered 2858 idle when it is not in the process of sending a request and 2859 the CIM Server is not processing a request from that connection.
2860 kumpf 1.12 An idle connection timeout allows reclamation of the system
2861 denise.eckstein 1.1 resources allocated for idle CIM Server connections. Note that 2862 the CIM Server may allow an idle connection to persist longer
2863 kumpf 1.12 than the configured timeout value based on server activity. 2864 Some client applications may not behave correctly if a
2865 denise.eckstein 1.1 connection timeout is introduced. Client compatibility should be 2866 considered when configuring an idle connection timeout value.
2867 kumpf 1.12 The idle connection time is computed using the system clock.
2868 denise.eckstein 1.1 Thus, resetting the system clock may cause unexpected timeout
2869 kumpf 1.12 behavior.This config property can be changed dynamically. The
2870 kavita.gupta 1.11 changes will apply to all new and existing connections. <br>
2871 denise.eckstein 1.1 </ul> 2872
2873 venkat.puvvada 1.21 <h5>maxFailedProviderModuleRestarts</h5> 2874 <ul> 2875 <b>Description: </b>If set to a positive integer, this value 2876 specifies the number of times the failed provider module with 2877 indications enabled are restarted automatically before being 2878 moved to Degraded state. If set to zero, failed provider module 2879 is not restarted with indications enabled automatically and 2880 will be moved to Degraded state immediately.<br> 2881 <b>Recommended Default Value (Development Build): </b>3<br> 2882 <b>Recommended Default Value (Release Build): </b>3<br> 2883 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2884 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2885 <b>Dynamic?: </b>Yes<br> 2886 <b>Considerations: </b>This option controls the automatic 2887 re-enabling of the failed provider module with indications 2888 enabled. If the provider module with indications enabled fails 2889 very frequently, it affects the CIMServer normal operations because 2890 CIMServer would be busy with reloading the provider module every 2891 time it fails. This option would be helpful if the long running 2892 indication provider crashes and the management application want 2893 to receive the indications from the provider while provider fix 2894 venkat.puvvada 1.21 is being delivered. In case of provider module grouping, if one of 2895 the indication provider crashes, it affects all indication providers 2896 in the provider modules of the group. Note that this is the facility 2897 provided by the CIMServer for temporary recovery of the provider and 2898 the ultimate goal SHALL be fixing the faulty provider. 2899 </ul> 2900
2901 venkat.puvvada 1.27 <h5>maxIndicationDeliveryRetryAttempts</h5> 2902 <ul>
2903 ashok.pathak 1.44 <b>Description: </b> If set to a positive integer, value defines the number 2904 of times indication service will enable the reliableIndication feature and try 2905 to deliver an indication to a particular listener destination. 2906 This does not effect the original delivery attempt. A value of disables 2907 reliable indication feature completely, and cimserver will deliver the 2908 indication once.This is in accord with DTMF Specification 1054, 2909 Indication Profile, version 1.2.1.<br>
2910 venkat.puvvada 1.27 <b>Recommended Default Value (Development Build): </b>3<br> 2911 <b>Recommended Default Value (Release Build): </b>3<br> 2912 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2913 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2914 <b>Dynamic?: </b>No<br> 2915 <b>Considerations: </b> This value is used to set the 2916 CIM_IndicationService.DeliveryRetryAttempts property. See 2917 CIM_IndicationService.DeliveryRetryAttempts property for more details. This 2918 option is supported only when PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT 2919 is defined.<br> 2920 <b>Source Configuration File: </b> 2921 Pegasus/Config/IndicationServicePropertyOwner.cpp<br> 2922 </ul> 2923 2924 <h5>minIndicationDeliveryRetryInterval</h5> 2925 <ul> 2926 <b>Description: </b> If set to a positive integer, this value defines 2927 the minimal time interval in seconds for the indication service to wait 2928 before retrying to deliver an indication to a listener destination that 2929 previously failed. Cimserver may take longer due to QoS or other processing.<br> 2930 <b>Recommended Default Value (Development Build): </b>30<br> 2931 venkat.puvvada 1.27 <b>Recommended Default Value (Release Build): </b>30<br> 2932 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2933 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2934 <b>Dynamic?: </b>No<br> 2935 <b>Considerations: </b> This value is used to initialize the property 2936 CIM_IndicationService.DeliveryRetryInterval. See 2937 CIM_IndicationService.DeliveryRetryInterval property for more details. This 2938 option is supported only when PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT 2939 is defined.<br> 2940 <b>Source Configuration File: </b> 2941 Pegasus/Config/IndicationServicePropertyOwner.cpp<br> 2942 </ul> 2943
2944 dev.meetei 1.33 <h5>listenAddress</h5> 2945 <ul> 2946 <b>Description: </b> Network interface where the cimserver 2947 should listen to for connections.For example listenAddress=All or 2948 listenAddress=121.12.33.112 or listenAddress=121.33.21.26,127.0.0.1, 2949 fe80::fe62:9346%eth0<br> 2950 <b>Recommended Default Value (Development Build): </b>All<br> 2951 <b>Recommended Default Value (Release Build): </b>No Specific suggestion<br> 2952 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2953 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2954 <b>Dynamic?: </b>No<br> 2955 <b>Considerations: </b>Default value of "All" will make cimserver to listen on all the network interfaces.<br> 2956 <b>Source Configuration File: </b> 2957 Pegasus/Config/DefaultPropertyOwner.cpp<br> 2958 </ul> 2959
2960 denise.eckstein 1.1 <h5>logdir</h5> 2961 <ul> 2962 <b>Description: </b>Specifies the name of the directory 2963 to be used for the OpenPegasus specific log files.<br> 2964 <b>Recommended Default Value (Development Build): </b>logs<br> 2965 <b>Recommended Default Value (Release Build): </b>$LOGDIR<br> 2966 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2967 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 2968 <b>Dynamic?: </b>Yes<br>
2969 kumpf 1.12 <b>Considerations: </b>This option is not supported if
2970 denise.eckstein 1.1 PEGASUS_USE_SYSLOGS is defined.<br> 2971 <b>Source Configuration File: </b> 2972 Pegasus/Config/LogPropertyOwner.cpp<br> 2973 </ul> 2974 2975 <h5>logLevel</h5> 2976 <ul>
2977 kumpf 1.12 <b>Description: </b>Defines the desired level of logging.
2978 denise.eckstein 1.1 Valid values include: TRACE, INFORMATION, WARNING, SEVERE, 2979 FATAL.<br> 2980 <b>Default Value: </b>"INFORMATION"<br> 2981 <b>Recommended Default Value (Development Build): </b> 2982 "INFORMATION"<br> 2983 <b>Recommended Default Value (Release Build): </b>"SEVERE"<br> 2984 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 2985 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 2986 <b>Dynamic?: </b>Yes<br> 2987 <b>Considerations: </b><br> 2988 <b>Source Configuration File: </b> 2989 Pegsus/Config/LogPropertyOwner.cpp<p> </p> 2990 </ul> 2991
2992 jsafrane 1.48 <h5>mapToLocalName</h5> 2993 <ul> 2994 <b>Description: </b> If 'true', all remote client names are translated 2995 to local ones using GSSAPI. This applies only to clients using Negotiate 2996 authentication method, i.e. when "httpAuthType" runtime variable is set to 2997 "negotiate".<br> 2998 <b>Default Value: </b>false<br> 2999 <b>Recommended Default Value (Development Build): </b> 3000 false<br> 3001 <b>Recommended Default Value (Release Build): </b>false<br> 3002 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3003 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 3004 <b>Dynamic?: </b>No<br> 3005 <b>Considerations: </b>This option is available only when Pegasus is 3006 compiled with PEGASUS_NEGOTIATE_AUTHENTICATION=true.<br> 3007 <b>Source Configuration File: </b> 3008 Pegasus/Config/SecurityPropertyOwner.cpp<p> </p> 3009 </ul> 3010
3011 mreddy 1.3 <h5>maxLogFileSizeKBytes</h5> 3012 <ul>
3013 kumpf 1.12 <b>Description: </b>Specifies the maximum size of the logfile in Kilo
3014 mreddy 1.3 Bytes. If the logfile size exceeds maxLogFileSizeKBytes logfile will be pruned.<br> 3015 <b>Default Value: </b>32768<br> 3016 <b>Recommended Default Value (Development Build): </b> 32768<br> 3017 <b>Recommended Default Value (Release Build): </b>32768<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> Yes<br> 3021 <b>Considerations:</b> This option is not supported if PEGASUS_USE_SYSLOGS is defined. Minimum accepted value is 32 KB. <br> 3022 <b>Source Configuration File:</b>  Pegsus/Config/LogPropertyOwner.cpp<p> </p> 3023 </ul>
3024 denise.eckstein 1.1 <h5>maxProviderProcesses</h5> 3025 <ul> 3026 <b>Description:</b> Limits the number of provider
3027 kumpf 1.12 processes (see 'forceProviderProcesses) that may run
3028 denise.eckstein 1.1 concurrently. A 'maxProviderProcesses' value of '0' indicates 3029 that the number of Provider Agent processes is unlimited<br> 3030 <b>Default Value: </b>0<br> 3031 <b>Recommended Default Value (Development Build):</b> 0<br> 3032 <b>Recommended Default Value (Release Build):</b> 0<br> 3033 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3034 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br>
3035 kavita.gupta 1.9 <b>Dynamic?: </b>Yes<br>
3036 kumpf 1.12 <b>Considerations: </b>Consider there are five provider processes 3037 already running and the maxProviderProcesses is dynamically changed to 3038 four. In this case though new provider processes will not be created
3039 kavita.gupta 1.9 but existing five will continue running<br>
3040 denise.eckstein 1.1 <br>
3041 karl 1.29 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 3042 <tbody><tr> 3043 <th bgcolor="#cae6ca" width="168">Platform</th> 3044 <th bgcolor="#cae6ca" width="350">
3045 denise.eckstein 1.1 Source Configuration File</th> 3046 </tr> 3047 <tr align="center"> 3048 <td width="168">Linux</td> 3049 <td align="left" width="350"> 3050 Pegasus/Config/DefaultPropertyTableLinux.h</td> 3051 </tr> 3052 <tr align="center"> 3053 <td width="168">HP-UX</td> 3054 <td align="left" width="350"> 3055 Pegasus/Config/DefaultPropertyTableHpux.h</td> 3056 </tr> 3057 <tr align="center"> 3058 <td width="168">OpenVMS</td> 3059 <td align="left" width="350"> 3060 Pegasus/Config/DefaultPropertyTableVms.h</td> 3061 </tr>
3062 karl 1.29 </tbody></table>
3063 denise.eckstein 1.1 </ul> 3064 3065 <h5>messageDir</h5> 3066 <ul> 3067 <b>Description: </b>Specifies the name of the directory to 3068 be used for the OpenPegasus translated messages.<br> 3069 <b>Default Value: </b>msg<br> 3070 <b>Recommended Default Value (Development Build): </b>msg<br> 3071 <b>Recommended Default Value (Release Build):</b> 3072 $MESSAGEDIR/msg<br> 3073 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3074 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 3075 <b>Dynamic?: </b>No<br> 3076 <b>Considerations: </b>Only used when message localization 3077 is enabled.  See PEGASUS_HAS_MESSAGES for details.<br> 3078 <b>Source Configuration File: </b> 3079 FileSystemPropertyOwner.cpp<br> 3080 </ul> 3081 3082 <h5>providerDir</h5> 3083 <ul>
3084 kumpf 1.12 <b>Description: </b>Specifies the names of the directories
3085 denise.eckstein 1.1 that contains Provider executables.<br> 3086 <b>Recommended Default Value (Development Build): </b>lib<br> 3087 <b>Recommended Default Value (Release Build): </b> 3088 $PROVIDERDIRS<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 kavita.gupta 1.11 <b>Dynamic?: </b>Yes<br>
3092 denise.eckstein 1.1 <b>Considerations: </b>The CIM Server runs as a privileged 3093 user. And, since Providers run in the same process space as the
3094 kumpf 1.12 CIM Server, Providers also have privileged access to the
3095 karl 1.29 system. Allowing a registered Provider’s executable to be
3096 kumpf 1.12 replaced with malicious code would result in a critical
3097 denise.eckstein 1.1 security defect, giving a malicious user privileged access
3098 marek 1.34 to the system. Administrators are responsible for ensuring
3099 denise.eckstein 1.1 that only trusted Providers are loaded into providerDir. 3100 In order to simplify the management task associated with 3101 securing Provider executable, the value of providerDir can be 3102 fixed at build time (i.e., set to one or more fixed, well-known 3103 locations).<br> 3104 <b>Source Configuration File: </b> 3105 Pegasus/Config/FileSystemPropertyOwner.cpp<br> 3106 </ul>
3107 kumpf 1.12
3108 denise.eckstein 1.1 <h5>providerManagerDir</h5> 3109 <ul> 3110 <b>Description: </b>Specifies the name of the directory that 3111 contains the ProviderManager plugin libraries.<br> 3112 <b>Recommended Default Value (Development Build): </b>lib<br> 3113 <b>Recommended Default Value (Release Build): </b> 3114 $PROVIDERMANAGERDIRS<br> 3115 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3116 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 3117 <b>Dynamic?: </b>No<br> 3118 <b>Considerations: </b>Should be a dedicated directory to 3119 minimize inspection of non-applicable files. Additionally, 3120 since all calls to the providers go through the provider 3121 managers, the same care should be taken with regards to 3122 security for the provider manager directory, as for provider 3123 directories.<br> 3124 <b>Source Configuration File: </b> 3125 Pegasus/Config/FileSystemPropertyOwner.cpp<br>
3126 kumpf 1.12 </ul>
3127 denise.eckstein 1.1 3128 <h5>repositoryDir</h5> 3129 <ul>
3130 kumpf 1.12 <b>Description: </b>Specifies the name of the directory
3131 denise.eckstein 1.1 to be used for the OpenPegasus repository.<br> 3132 <b>Recommended Default Value (Development Build): </b>repository<br> 3133 <b>Recommended Default Value (Release Build): </b> 3134 $REPOSITORYDIR/repository<br> 3135 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3136 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 3137 <b>Dynamic?: </b>No<br> 3138 <b>Considerations: </b><br> 3139 <b>Source Configuration File: </b> 3140 Pegasus/Config/FileSystemPropertyOwner.cpp<p><br>
3141 karl 1.29 </p></ul>
3142 denise.eckstein 1.1
3143 karl 1.49 <h5><b>repositoryIsDefaultInstanceProvider</b></h5> 3144
3145 denise.eckstein 1.1 <ul>
3146 karl 1.49 3147 <b>Description: </b>If true, the Repository functions as 3148 the Instance Provider for all classes for which there is not an explicitly 3149 registered Provider. This flag is also used to control the behavior of 3150 the repository when processing association operators.<br>
3151 denise.eckstein 1.1 <b>Recommended Default Value (Development Build): </b>true<br>
3152 kumpf 1.12 <b>Recommended Default Value (Release Build): </b>false<br>
3153 denise.eckstein 1.1 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3154 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br> 3155 <b>Dynamic?:  </b>No<br>
3156 karl 1.49 <b>Considerations:  </b>This flag can be used to configure the 3157 CIM Server to allow the Repository to be used by CIM Clients and CIM 3158 Providers as a dynamic data store. The setting of this flag will 3159 significantly affect CIM Server behavior as viewed by the CIM Client.<br> 3160 The following issues should be considered when setting 3161 repositoryIsDefaultInstanceProvider=true: 3162 <ul> 3163 <li><b>Authorization.</b>  The repository has no concept of 3164 which users (or components) are authorized to perform which operations.</b></li> 3165 <li><b>Appearance of instrumentation.</b>  A client 3166 application cannot determine whether instrumentation exists for a given 3167 CIM class. For example,  imagine a client issues a CreateInstance 3168 operation on a Disk class for    which no provider is 3169 registered.  The instance will be stored in the repository, and 3170 the client gets a "success" response. Does that mean a disk device 3171 has been created on the server? Even worse, when another client issues 3172 an EnumerateInstances operation, the spurious Disk instance is 3173 returned.  With repositoryIsDefaultInstanceProvider=false, the 3174 CreateInstance operation above would have returned a NOT_SUPPORTED 3175 error.</b></li> 3176 3177 karl 1.49 <li><b>Potential for inconsistent data.</b>  Using the 3178 repository as a data cache increases the probability that a client will 3179 see stale or incorrect data. A provider can better control the 3180 correlation between the data returned and the current state of the 3181 underlying managed resource (whether or not the provider caches the 3182 data).</b></li>
3183 kumpf 1.12
3184 karl 1.49 </ul> 3185 <br> 3186 The following issues should be considered when setting 3187 repositoryIsDefaultInstanceProvider=false: 3188 <ul> 3189 <li><b>Provider Availability.</b> Certain Providers have been 3190 developed to use the Repository as a dynamic data store. These 3191 Providers are currently not supported on system where this flag is 3192 disabled. E.g., the Common Diagnostics Model (CDM) Provider 3193 (http://developer.intel.com/design/servers/cdm/) relies on use of the 3194 Repository to store instances of CIM_DiagnosticSetting.  If this 3195 flag set to false, this Provider will not function correctly. Note that 3196 this feature is supported by other WBEM implementation.  3197 Therefore, disabling this feature can increase the cost of migrating 3198 existing Providers to OpenPegasus.</b></li>
3199 denise.eckstein 1.1
3200 karl 1.49 </ul>
3201 kumpf 1.12 <b>Source Configuration File: </b>
3202 karl 1.49 Pegasus/Config/RepositoryPropertyOwner.cpp<br> 3203 </b>
3204 denise.eckstein 1.1 </ul>
3205 kumpf 1.12
3206 karl 1.49 <h5><b>shutdownTimeout</b></h5> 3207
3208 denise.eckstein 1.1 <ul>
3209 karl 1.49
3210 denise.eckstein 1.1 <b>Description: </b>When a cimserver -s shutdown command is
3211 karl 1.49 issued, specifies the maximum time in seconds for the CIM Server to 3212 complete outstanding CIM operation requests before shutting down; if 3213 the specified timeout period expires, the CIM Server will shut down, 3214 even if there are still CIM operations in progress. Minimum value is 2 3215 seconds.<br>
3216 denise.eckstein 1.1 <b>Recommended Default Value (Development Build): </b>10<br> 3217 <b>Recommended Default Value (Release Build): </b>10<br> 3218 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3219 <b>Recommend To Be Fixed/Hidden (Release Build):</b>No/No<br> 3220 <b>Dynamic?: </b>Yes<br> 3221 <b>Considerations: </b><br> 3222 <b>Source Configuration File: </b>
3223 karl 1.49 Pegasus/Config/ShutdownPropertyOwner.cpp<br> 3224
3225 denise.eckstein 1.1 </ul> 3226
3227 karl 1.49 <h5><b>slp</b></h5> 3228
3229 denise.eckstein 1.1 <ul>
3230 karl 1.49
3231 denise.eckstein 1.1 <b>Description: </b>When set to true, OpenPegasus activates
3232 karl 1.49 an SLP SA and issues DMTF defined SLP advertisements to this SA on startup.<br>
3233 denise.eckstein 1.1 <b>Default Value: </b>false<br> 3234 <b>Recommended Default Value (Development Build): </b>false<br> 3235 <b>Recommended Default Value (Release Build): </b>false<br> 3236 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3237 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 3238 <b>Dynamic?: </b>No<p> <br> 3239 <br>
3240 karl 1.49 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" height="80" width="531"> 3241 <tbody> 3242 <tr> 3243 <th bgcolor="#cae6ca" height="16" width="168">Platform</th> 3244 <th bgcolor="#cae6ca" height="16" width="350"> Source 3245 Configuration File</th> 3246 </tr> 3247 <tr align="center">
3248 karl 1.29 <td height="14" width="168">Linux</td>
3249 karl 1.49 <td align="left" height="14" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td> 3250 </tr> 3251 <tr align="center"> 3252 <td height="14" width="168">HP-UX</td> 3253 <td align="left" height="14" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td> 3254 </tr> 3255 <tr align="center"> 3256 <td height="16" width="168">OpenVMS</td> 3257 <td align="left" height="16" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td> 3258 </tr> 3259 </tbody> 3260 </table> 3261 <b> </b></p> 3262 </ul> 3263 3264 <h5><b>slpProviderStartupTimeout</b></h5>
3265 denise.eckstein 1.1
3266 marek 1.36 <ul>
3267 karl 1.49 3268 <b>Description: </b>Timeout value in milli seconds used to 3269 specify how long the registration with an SLP SA may take. Registration 3270 will be retried three times. This value only needs to be increased in 3271 case that the loading of a set of providers who reporting their 3272 implementation of a registered profile takes very long.<br>
3273 marek 1.36 <b>Default Value: </b>300000<br> 3274 <b>Recommended Default Value (Development Build): </b>300000<br> 3275 <b>Recommended Default Value (Release Build): </b>300000<br> 3276 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3277 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
3278 karl 1.49 <b>Dynamic?: </b>No 3279 <p><b> <br>
3280 marek 1.36 <br>
3281 karl 1.49 </b> 3282 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" height="80" width="531"> 3283 <tbody> 3284 <tr> 3285 <th bgcolor="#cae6ca" height="16" width="168">Platform</th> 3286 <th bgcolor="#cae6ca" height="16" width="350"> Source 3287 Configuration File</th> 3288 </tr> 3289 <tr align="center">
3290 marek 1.36 <td height="14" width="168">Linux</td>
3291 karl 1.49 <td align="left" height="14" width="350">Pegasus/Config/DefaultPropertyTable.h</td> 3292 </tr> 3293 <tr align="center"> 3294 <td height="14" width="168">HP-UX</td> 3295 <td align="left" height="14" width="350">Pegasus/Config/DefaultPropertyTable.h</td> 3296 </tr> 3297 <tr align="center"> 3298 <td height="16" width="168">OpenVMS</td> 3299 <td align="left" height="16" width="350">Pegasus/Config/DefaultPropertyTable.h</td> 3300 </tr> 3301 </tbody> 3302 </table> 3303 <b> </b></p> 3304 </ul> 3305 3306 <h5><b>socketWriteTimeout</b></h5>
3307 marek 1.36
3308 denise.eckstein 1.1 <ul>
3309 karl 1.49
3310 denise.eckstein 1.1 <b>Description: </b>If the CIM Server receives an
3311 karl 1.49 EWOULDBLOCK/EAGAIN error on a non-blocking write, socketWriteTimeout 3312 defines the number of seconds the CIM Server will wait for the socket 3313 to get ready and resume writing data.<br> 3314 <b>Recommended Default Value (Development Build): </b> 20 3315 (seconds)<br> 3316 <b>Recommended Default Value (Release Build): </b> 20 (seconds)<br>
3317 denise.eckstein 1.1 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3318 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
3319 kavita.gupta 1.11 <b>Dynamic?: </b>Yes<br> 3320 <b>Considerations: </b>Any changes made to this config property
3321 karl 1.49 dynamically will apply to new CIM Server connections only keeping old 3322 already established connections unchanged.<br>
3323 denise.eckstein 1.1 <b>Source Configuration File: </b>
3324 karl 1.49 Pegasus/Config/DefaultPropertyTable.h
3325 denise.eckstein 1.1 </ul> 3326
3327 karl 1.49 <h5><b>sslCertificateFilePath</b></h5> 3328
3329 denise.eckstein 1.1 <ul>
3330 karl 1.49 3331 <b>Description: </b>Contains the CIM Server SSL Certificate.<br> 3332 <b>Recommended Default Value (Development Build): </b> server.pem<br>
3333 denise.eckstein 1.1 <b>Recommended Default Value (Release Build): </b>
3334 karl 1.49 $CERTIFICATEDIR/server.pem"<br>
3335 denise.eckstein 1.1 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3336 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 3337 <b>Dynamic?: </b>No<br>
3338 karl 1.49 <b>Considerations: </b>For a more detailed look at SSL options and 3339 their ramifications, please see the SSL guidelines.<br>
3340 denise.eckstein 1.1 <b>Source Configuration File: </b>
3341 karl 1.49 Pegasus/Config/SecurityPropertyOwner.cpp </b>
3342 denise.eckstein 1.1 </ul> 3343
3344 karl 1.49 <h5><b>sslCipherSuite</b></h5> 3345
3346 rohini.deshpande 1.28 <ul>
3347 karl 1.49
3348 rohini.deshpande 1.28 <b>Description: </b>String containing OpenSSL cipher
3349 karl 1.49 specifications to configure the cipher suite the client is permitted to 3350 negotiate with the server during the SSL handshake phase.<br> 3351 <b>Recommended Default Value (Development Build): </b> DEFAULT 3352 (the default cipher list of OpenSSL)<br> 3353 <b>Recommended Default Value (Release Build): </b> DEFAULT (the 3354 default cipher list of OpenSSL)<br>
3355 rohini.deshpande 1.28 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3356 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 3357 <b>Dynamic?: </b>No<br> 3358 <b>Considerations: </b>The value should be mentioned between
3359 karl 1.49 single quotes since it can contain special characters like .+, !, -.. 3360 For more details look at SSL ciphers.<br>
3361 rohini.deshpande 1.28 <b>Source Configuration File: </b>
3362 karl 1.49 Pegasus/Config/SecurityPropertyOwner.cpp
3363 rohini.deshpande 1.28 </ul> 3364
3365 karl 1.49 <h5><b>sslBackwardCompatibility</b></h5> 3366
3367 ashok.pathak 1.43 <ul>
3368 karl 1.49
3369 ashok.pathak 1.43 <b>Description: </b> If set to true, OpenPegasus support
3370 karl 1.49 SSLv3 3371 and TLSv1 protocol.If set to false OpenPegasus support only TLS1.2 3372 protocol for openssl 1.0.1+ <br> 3373 <b>Recommended Default Value (Development Build): </b> false<br> 3374 <b>Recommended Default Value (Release Build): </b> false<br>
3375 ashok.pathak 1.43 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3376 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 3377 <b>Dynamic?: </b>No<br> 3378 <b>Considerations: </b> For a more detailed look at SSL options
3379 karl 1.49 and their ramifications, please see the SSL guidelines.<br>
3380 ashok.pathak 1.43 <b>Source Configuration File: </b>
3381 karl 1.49 Pegasus/Config/SecurityPropertyOwner.cpp </b>
3382 ashok.pathak 1.43 </ul> 3383
3384 karl 1.49 <h5><b>sslClientVerificationMode</b></h5> 3385
3386 denise.eckstein 1.1 <ul>
3387 karl 1.49
3388 denise.eckstein 1.1 <b>Description: </b>Describes the desired level of support
3389 karl 1.49 for 3390 certificate-based authentication. 3391 <ul style="margin-top: 0in;" type="circle"> 3392 <li>“<b>required</b>” – The server requires certificate-based 3393 client authentication.  A client MUST present a trusted 3394 certificate in order to access the CIM Server.  If the client 3395 fails to send a certificate or sends an untrusted certificate, the 3396 connection will be rejected.</li> 3397 <li>“<b>optional</b>” – The server supports, but does not 3398 require, 3399 certificate-based client authentication. The server will request and 3400 attempt to validate a client certificate, however the connection will 3401 be accepted even if no certificate is sent or an untrusted certificate 3402 is sent.  The server will then seek to authenticate the client via 3403 an authentication header.</li> 3404 3405 <li>“<b>disabled</b>” – The server does not support 3406 certificate-based client authentication.</li> 3407 </ul>
3408 denise.eckstein 1.1 <b>Recommended Default Value (Development Build): </b>
3409 karl 1.49 disabled<br> 3410 <b>Recommended Default Value (Release Build): </b> disabled<br>
3411 denise.eckstein 1.1 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3412 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 3413 <b>Dynamic?: </b>No<br>
3414 karl 1.49 <b>Considerations: </b>(1) This property is only used if <b>enableHttpsConnection</b> 3415 is <b>"true"</b>. (2) If the platform does not support 3416 PEGASUS_LOCAL_DOMAIN_SOCKET, OpenPegasus attempts to use either HTTPS 3417 or HTTP to establish a local connection (connectLocal).  For 3418 platforms that do not support PEGASUS_LOCAL_DOMAIN_SOCKET, Clients 3419 which use connectLocal, such as cimconfig -l -c, cimprovider -l -s and 3420 cimserver -s, will not work if  the "sslClientVerificationMode" 3421 variable is set to "required" and HTTP is disabled.  For these 3422 platforms, the recommended course of action is to change the property 3423 value to "optional."<br>
3424 denise.eckstein 1.1 <b>Source Configuration File: </b>
3425 karl 1.49 Pegasus/Config/SecurityPropertyOwner.cpp
3426 denise.eckstein 1.1 </ul>
3427 karl 1.49 3428 <h5><b>sslKeyFilePath</b></h5> 3429
3430 denise.eckstein 1.1 <ul>
3431 karl 1.49
3432 denise.eckstein 1.1 <b>Description: </b>Contains the private key for the CIM 3433 Server SSL Certificate.<br>
3434 karl 1.49 <b>Recommended Default Value (Development Build): </b> file.pem<br>
3435 denise.eckstein 1.1 <b>Recommended Default Value (Release Build): </b>
3436 karl 1.49 $CERTIFICATEDIR/file.pem<br>
3437 denise.eckstein 1.1 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3438 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 3439 <b>Dynamic?: </b>No<br>
3440 karl 1.49 <b>Considerations: </b>File should be readable only by the user the 3441 cimserver is running as and/or privileged users. The file should be 3442 writeable only by a privileged user.<br>
3443 denise.eckstein 1.1 <b>Source Configuration File: </b>
3444 karl 1.49 Pegasus/Config/SecurityPropertyOwner.cpp<br> 3445
3446 denise.eckstein 1.1 </ul> 3447
3448 karl 1.49 <h5><b>sslTrustStore</b></h5> 3449
3450 denise.eckstein 1.1 <ul>
3451 karl 1.49
3452 denise.eckstein 1.1 <b>Description: </b>Specifies the location of the OpenSSL
3453 karl 1.49 truststore. Consistent with the OpenSSL implementation, a truststore 3454 can be either a file or directory. If the truststore is a directory, 3455 all the certificates within the directory are considered trusted.<br> 3456 <b>Recommended Default Value (Development Build): </b> client.pem<br>
3457 denise.eckstein 1.1 <b>Recommended Default Value (Release Build): </b>
3458 karl 1.49 $CERTIFICATEDIR/client.pem<br>
3459 denise.eckstein 1.1 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3460 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 3461 <b>Dynamic?: </b>No<br> 3462 <b>Source Configuration File: </b>
3463 karl 1.49 Pegsus/Config/SecurityPropertyOwner.cpp
3464 denise.eckstein 1.1 </ul> 3465
3466 karl 1.49 <h5><b>sslTrustStoreUserName</b></h5> 3467
3468 denise.eckstein 1.1 <ul>
3469 karl 1.49
3470 denise.eckstein 1.1 <b>Description: </b>Specifies the system user name to be
3471 karl 1.49 associated with all certificate-based authenticated requests.<br>
3472 denise.eckstein 1.1 <b>Recommended Default Value (Development Build): </b>NONE<br> 3473 <b>Recommended Default Value (Release Build): </b>NONE<br> 3474 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3475 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 3476 <b>Dynamic?: </b>No<br> 3477 <b>Considerations: </b>This property has no default; for
3478 karl 1.49 security reasons, the system administrator must explicitly specify this 3479 value.  This feature allows a single user name to be 3480 specified.  This user will be associated with all certificates in 3481 the truststore.  In the future, OpenPegasus will allow a system 3482 administrator to associate a distinct user name with each certificate.<br>
3483 denise.eckstein 1.1 <b>Source Configuration File: </b>
3484 karl 1.49 Pegsus/Config/SecurityPropertyOwner.cpp<br> 3485
3486 denise.eckstein 1.1 </ul> 3487
3488 karl 1.49 <h5><b>traceComponents</b></h5> 3489
3490 denise.eckstein 1.1 <ul>
3491 karl 1.49
3492 denise.eckstein 1.1 <b>Description: </b>Defines the components to be traced.<br> 3493 <b>Default Value: </b>""<br> 3494 <b>Recommended Default Value (Development Build): </b>""<br> 3495 <b>Recommended Default Value (Release Build): </b>""<br> 3496 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3497 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br> 3498 <b>Dynamic?: </b>Yes<br> 3499 <b>Source Configuration File: </b>
3500 karl 1.49 Pegasus/Config/TracePropertyOwner.cpp<br> 3501
3502 denise.eckstein 1.1 </ul> 3503
3504 karl 1.49 <h5><b>traceFacility</b></h5> 3505
3506 denise.eckstein 1.1 <ul>
3507 karl 1.49
3508 kumpf 1.12 <b>Description: </b>Defines the desired facility for trace
3509 karl 1.49 messages. Valid values include: "File" , "Log" and "Memory" .<br>
3510 denise.eckstein 1.1 <b>Default Value: </b>File<br> 3511 <b>Recommended Default Value (Development Build): </b>File<br> 3512 <b>Recommended Default Value (Release Build): </b>File<br> 3513 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3514 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br> 3515 <b>Dynamic?: </b>Yes<br> 3516 <b>Case Sensitive?: </b>No<br>
3517 karl 1.49 <b>Considerations: </b>If you specify "File", trace messagesare 3518 written into the file specified by the configuration option 3519 traceFilePath. If you specify "Log", trace messages are written to the 3520 OpenPegasus Log. If you specify Memory, the trace messages are 3521 collected in a wrap-around memory buffer. If this memory is part of a 3522 dump the trace messages can be found by the eye-catcher 3523 "PEGASUSMEMTRACE" at the top of the memory buffer. The trace is in 3524 clear text and the last written message has the suffix "EOTRACE".<br>
3525 denise.eckstein 1.1 <b>Source Configuration File: </b>
3526 karl 1.49 Pegasus/Config/TracePropertyOwner.cpp<br> 3527
3528 denise.eckstein 1.1 </ul> 3529
3530 karl 1.49 <h5><b>traceFilePath</b></h5> 3531
3532 denise.eckstein 1.1 <ul>
3533 karl 1.49
3534 denise.eckstein 1.1 <b>Description: </b>Specifies the location of the
3535 karl 1.49 OpenPegasus 3536 trace file.<br>
3537 denise.eckstein 1.1 <b>Default Value: </b>cimserver.trc<br>
3538 karl 1.49 <b>Recommended Default Value (Development Build):</b> cimserver.trc<br>
3539 denise.eckstein 1.1 <b>Recommended Default Value (Release Build): </b>
3540 karl 1.49 $TRACEDIR/cimserver.trc<br>
3541 denise.eckstein 1.1 <b>Recommend To Be Fixed/Hidden (Development Build):</b>No/No<br> 3542 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> 3543 <b>Dynamic?: </b>Yes<br> 3544 <b>Source Configuration File: </b>
3545 karl 1.49 Pegasus/Config/TracePropertyOwner.cpp<br> 3546
3547 denise.eckstein 1.1 </ul> 3548
3549 karl 1.49 <h5><b>traceLevel</b></h5> 3550
3551 denise.eckstein 1.1 <ul>
3552 karl 1.49 3553 <b>Description: </b>Defines the desired level of tracing. 3554 Valid 3555 values include: 0, 1, 2, 3, 4, 5.<br>
3556 denise.eckstein 1.1 <b>Default Value: </b>0<br> 3557 <b>Recommended Default Value (Development Build): </b>0<br>
3558 karl 1.29 <b>Recommended Default Value (Release Build): </b>0<<br>
3559 denise.eckstein 1.1 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3560 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br> 3561 <b>Dynamic?: </b>Yes<br> 3562 <b>Source Configuration File: </b>
3563 karl 1.49 Pegasus/Config/TracePropertyOwner.cpp<br> 3564
3565 denise.eckstein 1.1 </ul> 3566
3567 karl 1.49 <h5><b>traceMemoryBufferKbytes</b></h5> 3568
3569 marek 1.14 <ul>
3570 karl 1.49 3571 <b>Description: </b>Defines the size of the buffer for in 3572 memory 3573 tracing in kbytes ( 2<sup>10</sup> bytes ). Smallest value is 16.<br>
3574 marek 1.14 <b>Default Value: </b>10240<br> 3575 <b>Recommended Default Value (Development Build): </b>10240<br> 3576 <b>Recommended Default Value (Release Build): </b>10240<br> 3577 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3578 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> 3579 <b>Dynamic?: </b>No<br> 3580 <b>Case Sensitive?: </b>No<br>
3581 karl 1.49 <b>Considerations: </b>Is ignored if configuration property 3582 traceFacility is not set to Memory.<br>
3583 marek 1.14 <b>Source Configuration File: </b>
3584 karl 1.49 Pegasus/Config/TracePropertyOwner.cpp<br> 3585
3586 marek 1.14 </ul> 3587
3588 karl 1.49 <h5><b>traceFileSizeKBytes</b></h5> 3589
3590 amit99shah 1.38 <ul>
3591 karl 1.49 3592 <b>Description: </b>Defines the size of the tracefile in 3593 Kilo 3594 bytes. The trace file will be rolled once its size exceeds the 3595 specified size. <br>
3596 amit99shah 1.38 <b>Default Value: </b>1048576<br> 3597 <b>Recommended Default Value (Development Build): </b>1048576<br> 3598 <b>Recommended Default Value (Release Build): </b>1048576<br> 3599 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3600 <b>Recommend To Be Fixed/Hidden (Release Build):</b> No/Yes<br> 3601 <b>Dynamic?:</b> Yes<br>
3602 karl 1.49 <b>Considerations:</b>Minimum accepted value is 10240 KB,Maximum 3603 accepted value is 2097152 KB.  <br> 3604 <b>Source Configuration File:</b>  3605 Pegsus/Config/TracePropertyOwner.cpp 3606 <p><b> </b></p>
3607 amit99shah 1.38 </ul> 3608
3609 karl 1.49 <h5><b>numberOfTraceFiles</b></h5> 3610
3611 amit99shah 1.38 <ul>
3612 karl 1.49 3613 <b>Description: </b>Specifies the number of the tracefiles 3614 for 3615 rolling.<br>
3616 amit99shah 1.38 <b>Default Value: </b>3<br> 3617 <b>Recommended Default Value (Development Build): </b>3<br> 3618 <b>Recommended Default Value (Release Build): </b>3<br> 3619 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3620 <b>Recommend To Be Fixed/Hidden (Release Build):</b> No/Yes<br> 3621 <b>Dynamic?:</b> Yes<br>
3622 karl 1.49 <b>Considerations:</b>Minimum accepted value is 3,Maximum accepted 3623 value is 20.  <br> 3624 <b>Source Configuration File:</b>  3625 Pegsus/Config/TracePropertyOwner.cpp 3626 <p><b> </b></p>
3627 amit99shah 1.38 </ul> 3628
3629 karl 1.49 <h5><b>webRoot</b></h5> 3630
3631 lawrence.luo 1.45 <ul>
3632 karl 1.49 3633 <b>Description: </b> Points to a location where the static 3634 web 3635 pages to be served by the pegasus webserver are stored.<br>
3636 lawrence.luo 1.45 <b>Default Value: </b>www<br> 3637 <b>Recommended Default Value (Development Build): </b>www<br> 3638 <b>Recommended Default Value (Release Build): </b>$WEBCONFDIR/www<br> 3639 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3640 <b>Recommend To Be Fixed/Hidden (Release Build):</b> Yes/Yes<br> 3641 <b>Dynamic?:</b> No<br>
3642 karl 1.49 <b>Considerations:</b> When not fixed and hidden, it can be modified 3643 to point to a location having spurious pages. Please consider fixing 3644 this value.  <br> 3645 <b>Source Configuration File:</b>  3646 Pegsus/Config/DefaultPropertyOwner.cpp 3647 <p><b> </b></p>
3648 lawrence.luo 1.45 </ul> 3649
3650 karl 1.49 <h5><b>indexFile</b></h5> 3651
3652 lawrence.luo 1.45 <ul>
3653 karl 1.49 3654 <b>Description: </b> Specifies the name of index file used 3655 by 3656 pegasus webserver, default to index.html. This file should be available 3657 at the webRoot path.<br>
3658 lawrence.luo 1.45 <b>Default Value: </b>index.html<br> 3659 <b>Recommended Default Value (Development Build): </b>index.html<br> 3660 <b>Recommended Default Value (Release Build): </b>index.html<br> 3661 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3662 <b>Recommend To Be Fixed/Hidden (Release Build):</b> Yes/Yes<br> 3663 <b>Dynamic?:</b> No<br>
3664 karl 1.49 <b>Considerations:</b>   Hide it and fixed in release build to 3665 prevent using any file as index file<br> 3666 <b>Source Configuration File:</b>  3667 Pegsus/Config/DefaultPropertyOwner.cpp 3668 <p><b> </b></p>
3669 lawrence.luo 1.45 </ul> 3670
3671 karl 1.49 <h5><b>mimeTypesFile</b></h5> 3672
3673 lawrence.luo 1.45 <ul>
3674 karl 1.49 3675 <b>Description: </b> Refers to the file which holds the 3676 mime 3677 types being served by the pegasus webserver.<br>
3678 lawrence.luo 1.45 <b>Default Value: </b>www/mimeTypes.txt<br> 3679 <b>Recommended Default Value (Development Build): </b>www/mimeTypes.txt<br>
3680 karl 1.49 <b>Recommended Default Value (Release Build): </b>$WEBCONFDIR/www/mimeTypes.txt<br>
3681 lawrence.luo 1.45 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> 3682 <b>Recommend To Be Fixed/Hidden (Release Build):</b> Yes/Yes<br> 3683 <b>Dynamic?:</b> No<br> 3684 <b>Considerations:</b> Fix and make it read only when to prevent
3685 karl 1.49 modification in deployment<br> 3686 <b>Source Configuration File:</b>  3687 Pegsus/Config/DefaultPropertyOwner.cpp 3688 <p><b> </b></p>
3689 lawrence.luo 1.45 </ul> 3690
3691 karl 1.49 <h3><b>Configuration Constants</b></h3>
3692 lawrence.luo 1.45
3693 karl 1.49 <h4><b>Definitions</b></h4>
3694 denise.eckstein 1.1
3695 karl 1.49 <h5><b>static char CURRENT_CONFIG_FILE [] = </b></h5>
3696 denise.eckstein 1.1 3697 <ul>
3698 karl 1.49
3699 denise.eckstein 1.1 <b>Description: </b>Default file name for the current
3700 karl 1.49 configuration file.<br>
3701 denise.eckstein 1.1 <b>Recommended Default Value (Development Build):</b>
3702 karl 1.49 cimserver_current.conf<br>
3703 denise.eckstein 1.1 <b>Recommended Default Value (Release Build): </b>
3704 karl 1.49 $CONFIGDIR/cimserver_current.conf<br>
3705 denise.eckstein 1.1 <b>Dynamic?: </b>No <br> 3706 <br>
3707 karl 1.49 3708 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 3709 <tbody> 3710 <tr> 3711 <th bgcolor="#cae6ca" width="168">Platform</th> 3712 <th bgcolor="#cae6ca" width="350"> Source Configuration File</th> 3713 </tr> 3714 <tr align="center"> 3715 <td width="168">Linux</td> 3716 <td align="left" width="350">Pegasus/Config/ConfigFileDirLinux.h</td> 3717 </tr> 3718 <tr align="center"> 3719 <td width="168">HP-UX</td> 3720 <td align="left" width="350">ConfigFileDirHpux.h</td> 3721 </tr> 3722 <tr align="center"> 3723 <td width="168">OpenVMS</td> 3724 <td align="left" width="350"> Pegasus/Config/ConfigFileDirVms.h</td> 3725 </tr> 3726 </tbody> 3727 </table>
3728 denise.eckstein 1.1 </ul> 3729
3730 karl 1.49 <h5><b>static char PLANNED_CONFIG_FILE [] = </b></h5> 3731
3732 denise.eckstein 1.1 <ul>
3733 karl 1.49
3734 kumpf 1.12 <b>Description: </b>Default file name for the planned
3735 karl 1.49 configuration file.<br>
3736 denise.eckstein 1.1 <b>Recommended Default Value (Development Build): </b>
3737 karl 1.49 cimserver_planned.conf<br>
3738 denise.eckstein 1.1 <b>Recommended Default Value (Release Build): </b>
3739 karl 1.49 $CONFIGDIR/cimserver_planned.conf<br>
3740 denise.eckstein 1.1 <b>Dynamic?: </b>No<br>
3741 karl 1.49 <br> 3742 3743 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 3744 <tbody> 3745 <tr> 3746 <th bgcolor="#cae6ca" width="168">Platform</th> 3747 <th bgcolor="#cae6ca" width="350"> Source Configuration File</th> 3748 </tr> 3749 <tr align="center"> 3750 <td width="168">Linux</td> 3751 <td align="left" width="350">Pegasus/Config/ConfigFileDirLinux.h</td> 3752 </tr> 3753 <tr align="center"> 3754 <td width="168">HP-UX</td> 3755 <td align="left" width="350"> Pegasus/Config/ConfigFileDirHpux.h</td> 3756 </tr> 3757 <tr align="center"> 3758 <td width="168">OpenVMS</td> 3759 <td align="left" width="350"> Pegasus/Config/ConfigFileDirVms.h</td> 3760 </tr> 3761 </tbody> 3762 karl 1.49 </table>
3763 denise.eckstein 1.1 </ul> 3764
3765 karl 1.49 <h5><b>static char CIMSERVER_START_FILE [] = </b></h5> 3766
3767 denise.eckstein 1.1 <ul>
3768 karl 1.49 3769 <b>Description: </b>This is for the default file name for 3770 the 3771 cimserver startup file containing the PID.<br>
3772 denise.eckstein 1.1 <b>Default Value: </b>/tmp/cimserver_start.conf<br> 3773 <b>Recommended Default Value (Development Build): </b>
3774 karl 1.49 /tmp/cimserver_start.conf<br> 3775 <b>Recommended Default Value (Release Build): </b> $PIDFILE<br>
3776 denise.eckstein 1.1 <b>Dynamic?: </b>No<br>
3777 karl 1.49 <br> 3778 3779 <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> 3780 <tbody> 3781 <tr> 3782 <th bgcolor="#cae6ca" width="168">Platform</th> 3783 <th bgcolor="#cae6ca" width="350"> Source Configuration File</th> 3784 </tr> 3785 <tr align="center"> 3786 <td width="168">Linux</td> 3787 <td align="left" width="350">Pegasus/Config/ConfigFileDirLinux.h</td> 3788 </tr> 3789 <tr align="center"> 3790 <td width="168">HP-UX</td> 3791 <td align="left" width="350"> Pegasus/Config/ConfigFileDirHpux.h</td> 3792 </tr> 3793 <tr align="center"> 3794 <td width="168">OpenVMS</td> 3795 <td align="left" width="350"> Pegasus/Config/ConfigFileDirVms.h</td> 3796 </tr> 3797 </tbody> 3798 karl 1.49 </table>
3799 denise.eckstein 1.1 </ul> 3800
3801 karl 1.49 <h3><b>Configuration Macros</b></h3>
3802 denise.eckstein 1.1
3803 karl 1.49 <h4><b>Definitions</b></h4> 3804 3805 <h5><b>PEGASUS_SSLCLIENT_CERTIFICATEFILE</b></h5>
3806 denise.eckstein 1.1 3807 <ul>
3808 karl 1.49 3809 <b> <b>Description: </b><br>
3810 denise.eckstein 1.1 <b>Recommended Default Value (Development Build): </b>client.pem<br> 3811 <b>Recommended Default Value (Release Build): </b>
3812 karl 1.49 $CERTIFICATEDIR/client.pem<br>
3813 denise.eckstein 1.1 <b>Dynamic?: </b>No<br>
3814 karl 1.49 <b>Source Configuration File: </b> Pegasus/Common/Constants.h<br> 3815 </b>
3816 denise.eckstein 1.1 </ul> 3817
3818 karl 1.49 <h5><b>PEGASUS_SSLCLIENT_RANDOMFILE</b></h5> 3819
3820 denise.eckstein 1.1 <ul>
3821 karl 1.49
3822 denise.eckstein 1.1 <b>Description: </b>On platforms that do not support
3823 karl 1.49 /dev/random 3824 or /dev/urandom, OpenSSL will use this file to seed the PRNG 3825 (Pseudo-Random Number Generator). This PEGASUS_SSLCLIENT_RANDOMFILE 3826 defines the default CIM Client random file.<br>
3827 denise.eckstein 1.1 <b>Recommended Default Value (Development Build):</b>ssl.rnd<br>
3828 karl 1.49 <b>Recommended Default Value (Release Build):</b> $RANDOMDIR/ssl.rnd<br>
3829 denise.eckstein 1.1 <b>Dynamic?: </b>No<br> 3830 <b>Considerations: </b>Use of this variable requires
3831 karl 1.49 PEGASUS_HAS_SSL to be set.  CIM Client use of a shared random file 3832 is not recommended.  On systems where /dev/random or /dev/urandom 3833 are not available, CIM Clients are encouraged to generate a unique 3834 random file which contains sufficient entropy.<br> 3835 <b>Source Configuration File: </b> Pegasus/Common/Constants.h<br> 3836
3837 denise.eckstein 1.1 </ul> 3838
3839 karl 1.49 <h5><b>PEGASUS_SSLSERVER_RANDOMFILE</b></h5> 3840
3841 denise.eckstein 1.1 <ul>
3842 karl 1.49
3843 kumpf 1.12 <b>Description: </b>On platforms that do not support
3844 karl 1.49 /dev/random 3845 or /dev/urandom, OpenSSL will use this file to seed the PRNG 3846 (Pseudo-Random Number Generator). This PEGASUS_SSLSERVER_RANDOMFILE 3847 defines the CIM Server random file.<br>
3848 denise.eckstein 1.1 <b>Recommended Default Value (Development Build): </b>
3849 karl 1.49 cimserver.rnd<br>
3850 denise.eckstein 1.1 <b>Recommended Default Value (Release Build): </b>
3851 karl 1.49 $RANDOMDIR/cimserver.rnd<br>
3852 denise.eckstein 1.1 <b>Dynamic?: </b>No<br>
3853 karl 1.49 <b>Considerations: </b>1)Use of this variable requires  3854 PEGASUS_HAS_SSL to be set.(2) On systems where /dev/random or 3855 /dev/urandom are not available, CIM Server vendors need to be sure that 3856 the cimserver.rnd file contains sufficient entropy and is uniquely 3857 generated for each system.<br> 3858 <b>Source Configuration File: </b> Pegasus/Common/Constants.h<b><br> 3859 </b> 3860 </ul> 3861 3862 <h5><b><b>PEGASUS_LOCAL_AUTH_DIR</b></b></h5> 3863 3864 <ul> 3865 3866 <b>Description:</b> For local connections (i.e., 3867 connectLocal), OpenPegasus uses a file-based authentication mechanism.<br>
3868 denise.eckstein 1.1 <b>Recommended Default Value (Development Build): </b>/tmp<br> 3869 <b>Recommended Default Value (Release Build): </b>
3870 karl 1.49 $LOCALAUTHDIR/localauth<br>
3871 denise.eckstein 1.1 <b>Dynamic?: </b>No<br>
3872 karl 1.49 <b>Source Configuration File: </b> Pegasus/Common/Constants.h<br> 3873
3874 denise.eckstein 1.1 </ul> 3875
3876 karl 1.49 <h5><b>PEGASUS_LOCAL_DOMAIN_SOCKET_PATH</b></h5> 3877
3878 denise.eckstein 1.1 <ul>
3879 karl 1.49
3880 denise.eckstein 1.1 <b>Description: </b><br> 3881 <b>Recommended Default Value (Development Build): </b>
3882 karl 1.49 /tmp/cimxml.socket<br>
3883 denise.eckstein 1.1 <b>Recommended Default Value (Release Build): </b>
3884 karl 1.49 $SOCKETDIR/cimxml.socket<br>
3885 denise.eckstein 1.1 <b>Dynamic?: </b>No<br>
3886 karl 1.49 <b>Source Configuration File: </b> Pegasus/Common/Constants.h<br> 3887
3888 denise.eckstein 1.1 </ul> 3889 3890 <hr>
3891 karl 1.49 <p><b>Licensed to The Open Group (TOG) under one or more contributor 3892 license 3893 agreements. Refer to the OpenPegasusNOTICE.txt file distributed with
3894 martin 1.13 this work for additional information regarding copyright ownership. 3895 Each contributor licenses this file to you under the OpenPegasus Open 3896 Source License; you may not use this file except in compliance with the
3897 karl 1.49 License.</b></p> 3898 3899 <p><b>Permission is hereby granted, free of charge, to any person 3900 obtaining a 3901 copy of this software and associated documentation files (the 3902 "Software"), 3903 to deal in the Software without restriction, including without 3904 limitation 3905 the rights to use, copy, modify, merge, publish, distribute, 3906 sublicense,
3907 martin 1.13 and/or sell copies of the Software, and to permit persons to whom the
3908 karl 1.49 Software is furnished to do so, subject to the following conditions:</b></p> 3909 3910 <p><b>The above copyright notice and this permission notice shall be 3911 included 3912 in all copies or substantial portions of the Software.</b></p> 3913 3914 <p><b>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 3915 EXPRESS
3916 martin 1.13 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 3917 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 3918 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 3919 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 3920 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
3921 karl 1.49 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</b></p> 3922
3923 denise.eckstein 1.1 <hr>
3924 karl 1.49 </body></html>

No CVS admin address has been configured