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

Diff for /pegasus/doc/BuildAndReleaseOptions.html between version 1.13.2.2 and 1.26.2.2

version 1.13.2.2, 2010/07/15 09:36:52 version 1.26.2.2, 2013/04/06 04:38:14
Line 518 
Line 518 
      platforms.<br>      platforms.<br>
 </ul> </ul>
  
   <h5>PEGASUS_EXTRA_PROVIDER_LIB_DIR</h5>
   <ul>
     <b>Description:&nbsp;</b>Specifies the location of the extra provider
        libraries which are part of the release builds.<br>
     <b>Default Value:&nbsp;</b>Not Set<br>
     <b>Recommended Value (Development Build):&nbsp;</b>
        No Specific Recommendation<br>
     <b>Recommended Value (Release Build):&nbsp;</b>
        No Specific Recommendation<br>
     <b>Required:&nbsp;</b> No.<br>
     <b>Considerations:&nbsp;</b> Since providerDir config property is fixed
        and hidden in release builds, this build time option provides facilty
        to include the extra provider directories without any security problems.
        This build time option is useful only when PEGASUS_OVERRIDE_DEFAULT_RELEASE_DIRS
        is set.
   </ul>
   
 <h5>PEGASUS_EMANATE_INCLUDE_DIR</h5> <h5>PEGASUS_EMANATE_INCLUDE_DIR</h5>
 <ul> <ul>
   <b>Description:&nbsp;</b>Specifies the location of the EMANATE   <b>Description:&nbsp;</b>Specifies the location of the EMANATE
Line 730 
Line 747 
      indication provider.<br>      indication provider.<br>
 </ul> </ul>
  
 <h5>PEGASUS_ENABLE_PROTOCOL_INTERNAL_BINARY</h5>  
 <ul>  
   <b>Description: </b>If true, OpenPegasus uses a faster binary  
      protocol between the CIM server and provider manager. If false,  
      OpenPegasus uses the older XML-based protocol instead.  
      <br>  
   <b>Default Value: </b>true<br>  
   <b>Recommended Value (Development Build): </b>true<br>  
   <b>Recommended Value (Release Build): </b>true<br>  
   <b>Required: </b>No<br>  
   <b>Considerations: </b>This option improves performance by optimizing the  
      serialization and deserialization of messages between the server and  
      out-of-process providers.  
      <br>  
 </ul>  
   
 <h5>PEGASUS_ENABLE_PROTOCOL_BINARY</h5> <h5>PEGASUS_ENABLE_PROTOCOL_BINARY</h5>
 <ul> <ul>
   <b>Description: </b>If true, OpenPegasus uses a faster binary   <b>Description: </b>If true, OpenPegasus uses a faster binary
      protocol between local clients (including the provider agent) and the       protocol between local clients and the CIM server. If false, OpenPegasus
      CIM server. If false, OpenPegasus uses the conventional XML-based protocol       uses the conventional XML-based protocol instead.
      instead. See PEP#340 for more details.       See PEP#340 for more details.
      <br>      <br>
   <b>Default Value: </b>false<br>   <b>Default Value: </b>false<br>
   <b>Recommended Value (Development Build): </b>false<br>   <b>Recommended Value (Development Build): </b>false<br>
Line 1610 
Line 1611 
      Handler to be supported.<br>      Handler to be supported.<br>
 </ul> </ul>
  
   <h5>PEGASUS_ENABLE_NET_SNMPV3</h5>
   <ul>
     <b>Description:&nbsp;</b>If this variable is defined,
        then OpenPegasus SNMP Handler will build the SNMPV3
        features. This should be set to false if NET-SNMP 5.2 and lower
        libraries are used.<br>
     <b>Default Value:&nbsp;</b>true<br>
     <b>Recommended Value (Development Build):&nbsp;</b>true<br>
     <b>Recommended Value (Release Build):&nbsp;</b>true<br>
     <b>Required:&nbsp;</b>No<p>
     <b>Considerations:&nbsp;</b>PEGASUS_USE_NET_SNMP variable must
        be set.<br>
   </ul>
   
   
 <h5>PEGASUS_USE_OPENSLP</h5> <h5>PEGASUS_USE_OPENSLP</h5>
 <ul> <ul>
   <b>Description:&nbsp;</b>OpenSLP, <a href="http://www.openslp.org">   <b>Description:&nbsp;</b>OpenSLP, <a href="http://www.openslp.org">
Line 1690 
Line 1706 
      titled "Configuration Properties" for additional detail.<br>      titled "Configuration Properties" for additional detail.<br>
 </ul> </ul>
  
   <h5>PEGASUS_FLAVOR</h5>
   <ul>
     <b>Description:&nbsp;</b> This variable is used for configuring Multi CIMOM
        on same OS by eliminating single point for storage of PID's and configuration
        files. Flavor is used in structuring the release dirs,configuration file names,
        log identity and PAM config file.
        If set, OpenPegasus is built using the flavor value. By default OpenPegasus is
        built using "tog" as the flavor. RPMs are named using the flavor value.
     <br>
     <b>Default Value:&nbsp;</b>tog<br>
     <b>Recommended Value (Development Build):&nbsp;</b>tog<br>
     <b>Recommended Value (Release Build):&nbsp;</b>tog<br>
     <b>Required:&nbsp;</b>No<br>
     <b>Considerations:&nbsp;</b>
        To build RPM using flavor, RPM spec file needs to be regenerated after setting the flavor value.
        This can be done using the create_OpenPegasusRPMSpecFile target in the Makefile.Release.
        Platforms have to define their own release dir structure using the flavor for release builds.
        An error will be reported if both PEGASUS_FLAVOR and PEGASUS_USE_RELEASE_DIRS are set and
        PEGASUS_OVERRIDE_DEFAULT_RELEASE_DIRS is not set.
        RPM build on linux defines PEGASUS_OVERRIDE_DEFAULT_RELEASE_DIRS by default.
     <br>
   </ul>
   
   <h5>PEGASUS_PLATFORM_FOR_32BIT_PROVIDER_SUPPORT</h5>
   <ul>
     <b>Description:&nbsp;</b> Builds the Pegasus with 32-bit provider support for the specified platform.
       If this option is set, the value MUST be one of the 32-bit supported platforms by Pegasus.
     <br>
     <b>Default Value:&nbsp;</b>Not set<br>
     <b>Recommended Value (Development Build):&nbsp;</b>Not set<br>
     <b>Recommended Value (Release Build):&nbsp;</b>Not set<br>
     <b>Required:&nbsp;</b>No<br>
     <b>Considerations:&nbsp;</b>
        This option is used to run the 32-bit providers under 64-bit CIMserver.
        To register the 32-bit providers, register the provider module by setting the
        Bitness property value to "2". 32-bit Providers are always loaded out of process
        irrespective of forceProviderProcesses config option.
     <br>
   </ul>
   
 <h5>PEGASUS_USE_SQLITE_REPOSITORY</h5> <h5>PEGASUS_USE_SQLITE_REPOSITORY</h5>
 <ul> <ul>
   <b>Description:&nbsp;</b>If true, new repository stores are created   <b>Description:&nbsp;</b>If true, new repository stores are created
Line 1753 
Line 1809 
      PEGASUS_USE_SQLITE_REPOSITORY is set to true.      PEGASUS_USE_SQLITE_REPOSITORY is set to true.
 </ul> </ul>
  
   <h5>PEGASUS_INITIAL_THREADSTACK_SIZE</h5>
   <ul>
     <b>Description:&nbsp;</b>This environment variable sets the initial size
        of the stack on new threads. Value is specified in number of bytes.<br>
     <b>Default Value:&nbsp;</b>262144<br>
     <b>Recommended Value (Development Build):&nbsp;</b>262144<br>
     <b>Recommended Value (Release Build):&nbsp;</b>262144<br>
     <b>Required:&nbsp;</b>No </p>
   </ul>
   
 <h4>Examples Building a Linux IA32 (#IA64) Development/Debug Version</h4> <h4>Examples Building a Linux IA32 (#IA64) Development/Debug Version</h4>
 <ul> <ul>
   export PEGASUS_ROOT=/home/pegasusbld/pegasus<br>   export PEGASUS_ROOT=/home/pegasusbld/pegasus<br>
Line 1774 
Line 1840 
   export PEGASUS_HOME=/home/pegasusbld/pegasus/build<br>   export PEGASUS_HOME=/home/pegasusbld/pegasus/build<br>
   export PEGASUS_PLATFORM=LINUX_IX86_GNU<br>   export PEGASUS_PLATFORM=LINUX_IX86_GNU<br>
   #export PEGASUS_PLATFORM=LINUX_IA64_GNU<br>   #export PEGASUS_PLATFORM=LINUX_IA64_GNU<br>
   export PEGASUS_DISABLE_CQL=true <br>    export PEGASUS_ENABLE_CQL=false<br>
   export PEGASUS_PAM_AUTHENTICATION=true <br>   export PEGASUS_PAM_AUTHENTICATION=true <br>
   export PEGASUS_USE_PAM_STANDALONE_PROC=true<br>   export PEGASUS_USE_PAM_STANDALONE_PROC=true<br>
   export PEGASUS_HAS_SSL=yes<br>   export PEGASUS_HAS_SSL=yes<br>
Line 2170 
Line 2236 
   <b>Recommended Default Value (Release Build):&nbsp;</b>true<br>   <b>Recommended Default Value (Release Build):&nbsp;</b>true<br>
   <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>   <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
   <b>Recommend To Be Fixed/Hidden (Release Build):&nbsp;</b>No/No<br>   <b>Recommend To Be Fixed/Hidden (Release Build):&nbsp;</b>No/No<br>
   <b>Dynamic?:&nbsp;</b>No<p>&nbsp;<br>    <b>Dynamic?:&nbsp;</b>Yes/No<br>
     <b>Considerations:&nbsp;</b>When enableIndicationService is set to
        false dynamically, delete subscription requests are sent to all
        indication providers and indication related operations are
        not supported until indication service is re-enabled. Dynamic
        configuration facility is available only when Pegasus is compiled
        with PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT=true. Clients
        who wants to utilize the IndicationService services MUST check for
        CIM_IndicationService EnabledState and HealthState properties to know
        the current indication service state. For example, User can enumerate
        instances of CIM_IndicationService and there is exactly one instance
        of CIM_IndicationService returned. (Ex. using cimcli command
        'cimcli ei -n root/PG_InterOp CIM_IndicationService'). When requested state
        change(Enabled/Disabled) cannot be made because of timeout or some
        other exception IndicationService HealthState is set to "Degraded/Warning".
        For example, if user requested for indication service disable (by setting
        enableIndicationService=false), disable failed because of timeout or some
        other exception. Now service health state is set to "Degraded/Warning"
        and service EnabledState will remain enabled. User can now identify the
        faulty provider causing the timeout or any other problem and can take
        appropriate action. User can again request for service disable to recover
        from degraded state. Similar sequence applies while enabling the indication
        service. Only difference is that service EnabledState is set to Enabled
        if exception or timeout happens. There is no automatic recovery from
        degraded state is available at present.<br>
   <br>   <br>
      <table border="1" cellspacing="1" bordercolordark="#666666"      <table border="1" cellspacing="1" bordercolordark="#666666"
          bordercolorlight="#CCCCCC" width=531          bordercolorlight="#CCCCCC" width=531
Line 2274 
Line 2364 
      Pegasus/Config/SecurityPropertyOwner.cpp<p>&nbsp;</p>      Pegasus/Config/SecurityPropertyOwner.cpp<p>&nbsp;</p>
 </ul> </ul>
  
 <h5>enableSSLExportClientVerification</h5>  
 <ul>  
   <b>Description:&nbsp;</b>If true, the CIM Server allows HTTPS  
      connection for CIMExport requests on the port specified by the  
      service name &quot;wbem-exp-https&quot;.<br>  
   <b>Default Value:&nbsp;</b>false<br>  
   <b>Recommended Default Value (Development Build):&nbsp;</b>true<br>  
   <b>Recommended Default Value (Release Build):&nbsp;</b>false<br>  
   <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>  
   <b>Recommend To Be Fixed/Hidden (Release Build):&nbsp;</b>No/No<br>  
   <b>Dynamic?:&nbsp;</b>No<br>  
   <b>Source Configuration File:&nbsp;</b>  
      Pegasus/Config/SecurityPropertyOwner.cpp</p>  
 </ul>  
   
   
 <h5>enableSubscriptionsForNonprivilegedUsers</h5> <h5>enableSubscriptionsForNonprivilegedUsers</h5>
 <ul> <ul>
   <b>Description:&nbsp;</b>If true, operations (create instance,   <b>Description:&nbsp;</b>If true, operations (create instance,
Line 2333 
Line 2407 
      Pegasus/Config/NormalizationPropertyOwner.cpp      Pegasus/Config/NormalizationPropertyOwner.cpp
 </ul> </ul>
  
   
 <h5><b>exportSSLTrustStore</b></h5>  
 <ul>  
   <b>Description:&nbsp;</b>Specifies the location of the OpenSSL  
      truststore for Indications. Consistent with the OpenSSL  
      implementation, a truststore can be either a file or directory.  
      If the truststore is a directory, all the certificates within  
      the directory are considered trusted.<br>  
   <b>Default Value:&nbsp;</b>indication_trust.pem<br>  
   <b>Recommended Default Value (Development Build):&nbsp;</b>  
      indication_trust.pem<br>  
   <b>Recommended Default Value (Release Build):&nbsp;</b>  
      $CERTIFICATEDIR/indication_trust.pem<br>  
   <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>  
   <b>Recommend To Be Fixed/Hidden (Release Build):&nbsp;</b>Yes<br>  
   <b>Dynamic?:&nbsp;</b>No<br>  
   <b>Source Configuration File:&nbsp;</b>  
      Pegasus/Config/SecurityPropertyOwner.cpp</p>  
 </ul>  
   
 <h5>forceProviderProcesses</h5> <h5>forceProviderProcesses</h5>
 <ul> <ul>
   <b>Description:&nbsp;</b>If true, the CIM Server runs Providers   <b>Description:&nbsp;</b>If true, the CIM Server runs Providers
Line 2586 
Line 2640 
      changes will apply to all new and existing connections. <br>      changes will apply to all new and existing connections. <br>
 </ul> </ul>
  
   <h5>maxFailedProviderModuleRestarts</h5>
   <ul>
     <b>Description:&nbsp;</b>If set to a positive integer, this value
        specifies the number of times the failed provider module with
        indications enabled are restarted automatically before being
        moved to Degraded state. If set to zero, failed provider module
        is not restarted with indications enabled automatically and
        will be moved to Degraded state immediately.<br>
     <b>Recommended Default Value (Development Build):&nbsp;</b>3<br>
     <b>Recommended Default Value (Release Build):&nbsp;</b>3<br>
     <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
     <b>Recommend To Be Fixed/Hidden (Release Build):&nbsp;</b>No/No<br>
     <b>Dynamic?:&nbsp;</b>Yes<br>
     <b>Considerations:&nbsp;</b>This option controls the automatic
        re-enabling of the failed provider module with indications
        enabled. If the provider module with indications enabled fails
        very frequently, it affects the CIMServer normal operations because
        CIMServer would be busy with reloading the provider module every
        time it fails. This option would be helpful if the long running
        indication provider crashes and the management application want
        to receive the indications from the provider while provider fix
        is being delivered. In case of provider module grouping, if one of
        the indication provider crashes, it affects all indication providers
        in the provider modules of the group. Note that this is the facility
        provided by the CIMServer for temporary recovery of the provider and
        the ultimate goal SHALL be fixing the faulty provider.
   </ul>
   
   <h5>maxIndicationDeliveryRetryAttempts</h5>
   <ul>
     <b>Description:&nbsp;</b> If set to a positive integer, this value
        defines the number of times that the indication service will
        try to deliver an indication to a particular listener destination.
        This does not effect the original delivery attempt, thus if set to 0,
        cimserver will only try to deliver the indication once.<br>
     <b>Recommended Default Value (Development Build):&nbsp;</b>3<br>
     <b>Recommended Default Value (Release Build):&nbsp;</b>3<br>
     <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
     <b>Recommend To Be Fixed/Hidden (Release Build):&nbsp;</b>No/No<br>
     <b>Dynamic?:&nbsp;</b>No<br>
     <b>Considerations:&nbsp;</b> This value is used to set the
        CIM_IndicationService.DeliveryRetryAttempts property. See
        CIM_IndicationService.DeliveryRetryAttempts property for more details. This
        option is supported only when PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT
        is defined.<br>
     <b>Source Configuration File:&nbsp;</b>
        Pegasus/Config/IndicationServicePropertyOwner.cpp<br>
   </ul>
   
   <h5>minIndicationDeliveryRetryInterval</h5>
   <ul>
     <b>Description:&nbsp;</b> If set to a positive integer, this value defines
        the minimal time interval in seconds for the indication service to wait
        before retrying to deliver an indication to a listener destination that
        previously failed. Cimserver may take longer due to QoS or other processing.<br>
     <b>Recommended Default Value (Development Build):&nbsp;</b>30<br>
     <b>Recommended Default Value (Release Build):&nbsp;</b>30<br>
     <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
     <b>Recommend To Be Fixed/Hidden (Release Build):&nbsp;</b>No/No<br>
     <b>Dynamic?:&nbsp;</b>No<br>
     <b>Considerations:&nbsp;</b> This value is used to initialize the property
        CIM_IndicationService.DeliveryRetryInterval. See
        CIM_IndicationService.DeliveryRetryInterval property for more details. This
        option is supported only when PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT
        is defined.<br>
     <b>Source Configuration File:&nbsp;</b>
        Pegasus/Config/IndicationServicePropertyOwner.cpp<br>
   </ul>
   
 <h5>logdir</h5> <h5>logdir</h5>
 <ul> <ul>
   <b>Description:&nbsp;</b>Specifies the name of the directory   <b>Description:&nbsp;</b>Specifies the name of the directory
Line 2879 
Line 3002 
        </table>        </table>
 </ul> </ul>
  
   <h5>slpProviderStartupTimeout</h5>
   <ul>
     <b>Description:&nbsp;</b>Timeout value in milli seconds used to specify
       how long the registration with an SLP SA may take. Registration will be
       retried three times. This value only needs to be increased in case that
       the loading of a set of providers who reporting their implementation of a
       registered profile takes very long.<br>
     <b>Default Value:&nbsp;</b>300000<br>
     <b>Recommended Default Value (Development Build): </b>300000<br>
     <b>Recommended Default Value (Release Build):&nbsp;</b>300000<br>
     <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
     <b>Recommend To Be Fixed/Hidden (Release Build):&nbsp;</b>No/No<br>
     <b>Dynamic?:&nbsp;</b>No<p>&nbsp;<br>
     <br>
        <table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" height="80" width="531">
          <tbody><tr>
            <th bgcolor="#cae6ca" height="16" width="168">Platform</th>
            <th bgcolor="#cae6ca" height="16" width="350">
              Source Configuration File</th>
          </tr>
          <tr align="center">
           <td height="14" width="168">Linux</td>
            <td align="left" height="14" width="350">
              Pegasus/Config/DefaultPropertyTable.h</td>
          </tr>
          <tr align="center">
            <td height="14" width="168">HP-UX</td>
            <td align="left" height="14" width="350">
              Pegasus/Config/DefaultPropertyTable.h</td>
          </tr>
          <tr align="center">
            <td height="16" width="168">OpenVMS</td>
            <td align="left" height="16" width="350">
              Pegasus/Config/DefaultPropertyTable.h</td>
          </tr>
          </tbody></table>
   </p></ul>
   
 <h5>socketWriteTimeout</h5> <h5>socketWriteTimeout</h5>
 <ul> <ul>
   <b>Description:&nbsp;</b>If the CIM Server receives an   <b>Description:&nbsp;</b>If the CIM Server receives an


Legend:
Removed from v.1.13.2.2  
changed lines
  Added in v.1.26.2.2

No CVS admin address has been configured
Powered by
ViewCVS 0.9.2