pegasus/doc/BuildAndReleaseOptions.html - annotate

Return to BuildAndReleaseOptions.html CVS log

Up to [Pegasus] / pegasus / doc

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

No CVS admin address has been configured