pegasus/doc/BuildAndReleaseOptions.html - annotate

Return to BuildAndReleaseOptions.html CVS log

Up to [Pegasus] / pegasus / doc

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

No CVS admin address has been configured