(file) Return to BuildAndReleaseOptions.html CVS log (file) (dir) Up to [Pegasus] / pegasus / doc

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

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2