version 1.13.2.3, 2010/08/11 11:20:28
|
version 1.50, 2014/10/29 11:07:56
|
|
|
<html> |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
<head> |
<html><head> |
<link rel="stylesheet" href= |
|
"http://www.opengroup.org/stylesheets/info1.css"> |
|
</head> |
|
| |
<body> |
<link rel="stylesheet" href="http://www.opengroup.org/stylesheets/info1.css"> |
<hr> |
|
| |
<p align="center"> |
</head><body> |
<b><font size="4">Recommended OpenPegasus Build and Configuration Options for Selected Platforms</font></b> |
<hr> |
|
<p align="center"> <b><font size="4">Recommended OpenPegasus Build and |
|
Configuration Options for Selected Platforms</font></b> |
</p> | </p> |
| |
<hr> | <hr> |
|
<p><b>Abstract: </b> This document defines a set of recommended |
<p><b>Abstract: </b> |
options for building, testing and running OpenPegasus on a selected set |
This document defines a set of recommended options for building, |
of platforms. In this version of the document, platform-specific |
testing and running OpenPegasus on a selected set of |
configuration information have been documented for the platforms |
platforms. In this version of the document, platform-specific configuration |
described in the "Documented Platforms" section of this document. |
information have been documented for the platforms described in the |
|
"Documented Platforms" section of this document. |
|
</p> | </p> |
| |
<p><b>Note 1: </b> |
<p><b>Note 1: </b> The recommendations defined in this document are |
The recommendations defined in this document are not intended to document |
not intended to document the feature set included in any vendor's |
the feature set included in any vendor's OpenPegasus-based product. |
OpenPegasus-based product. Rather, the purpose of this document is to |
Rather, the purpose of this document is to provide input to vendors when |
provide input to vendors when making product decisions.<br> |
making product decisions.<BR> |
|
</p> | </p> |
| |
<hr> | <hr> |
|
|
<h2>Definition of the Problem</h2> | <h2>Definition of the Problem</h2> |
| |
<p>OpenPegasus supports a large number of build and runtime options. | <p>OpenPegasus supports a large number of build and runtime options. |
Determining which options to use can be challenging. The purpose of this |
Determining which options to use can be challenging. The purpose of |
document is to simplify the build, testing and administration of OpenPegasus |
this |
|
document is to simplify the build, testing and administration of |
|
OpenPegasus |
by providing a recommended, tested set of options.</p> | by providing a recommended, tested set of options.</p> |
| |
<h2>Documented Platforms</h2> | <h2>Documented Platforms</h2> |
|
|
additional information.</p> | additional information.</p> |
| |
<ul> | <ul> |
<table border="1" cellspacing="1" bordercolordark="#666666" |
|
bordercolorlight="#CCCCCC" width=20%> |
<table bordercolordark="#666666" bordercolorlight="#CCCCCC" border="1" cellspacing="1" width="20%"> |
|
<tbody> |
<tr> | <tr> |
<th bgcolor="#CAE6CA" align=center>Platform</th> |
<th align="center" bgcolor="#cae6ca">Platform</th> |
<th bgcolor="#CAE6CA" align=center>Status</th> |
<th align="center" bgcolor="#cae6ca">Status</th> |
</tr> | </tr> |
<tr align="left"> | <tr align="left"> |
<td>HPUX_IA64_ACC</td> | <td>HPUX_IA64_ACC</td> |
|
|
<td> </td> | <td> </td> |
</tr> | </tr> |
<tr align="left"> | <tr align="left"> |
|
<td>LINUX_PPC_E500_GNU</td> |
|
<td> </td> |
|
</tr> |
|
<tr align="left"> |
|
<td>LINUX_SH4_GNU</td> |
|
<td> </td> |
|
</tr> |
|
<tr align="left"> |
<td>LINUX_XSCALE_GNU</td> | <td>LINUX_XSCALE_GNU</td> |
<td> </td> | <td> </td> |
</tr> | </tr> |
|
|
<td>VMS_IA64_DECCXX</td> | <td>VMS_IA64_DECCXX</td> |
<td> </td> | <td> </td> |
</tr> | </tr> |
|
</tbody> |
</table> | </table> |
</ul> | </ul> |
| |
<h2>Proposed Solution</h2> | <h2>Proposed Solution</h2> |
| |
<h3>Security Considerations</h3> | <h3>Security Considerations</h3> |
|
|
<ol> | <ol> |
<li> |
|
To avoid introducing security vulnerabilities, vendors must never |
<li> To avoid introducing security vulnerabilities, vendors must |
ship providers incompatible with the security assumptions used in |
never ship providers incompatible with the security assumptions used in |
their deployment. |
their deployment. For example, providers designed for a single-user |
For example, providers designed for a single-user deployment that |
deployment that don't perform authorization must not be shipped with a |
don't perform authorization must not be shipped with a CIM Server |
CIM Server that expects the providers to perform authorization. Note |
that expects the providers to perform authorization. Note that |
that this authorization burden is considerably lighter if the provider |
this authorization burden is considerably lighter if the provider |
is registered as 'run as requestor' and if the CIM Server enables that |
is registered as 'run as requestor' and if the CIM Server enables |
feature. See <a href="http://www.openpegasus.org/pp/uploads/40/7197/SecurityGuidePEP.htm"> |
that feature. See <a href= |
PEP#223 - Security Coding Guidelines</a> for additional details. </li> |
"http://www.openpegasus.org/pp/uploads/40/7197/SecurityGuidePEP.htm"> |
<li> Vendors should ensure they configure the CIM Server consistently |
PEP#223 - Security Coding Guidelines</a> for additional |
with the security requirements of their deployment. </li> |
details. |
|
</li> |
|
<li> |
|
Vendors should ensure they configure the CIM Server consistently |
|
with the security requirements of their deployment. |
|
</li> |
|
</ol> | </ol> |
| |
<h3>Terminology Notes</h3> | <h3>Terminology Notes</h3> |
|
|
<ol> | <ol> |
<li> |
|
In this document, the term "Not Set" is used to indicate |
<li> In this document, the term "Not Set" is used to indicate that |
that the a value for the environment variable has not been defined. |
the a value for the environment variable has not been defined. "Set" is |
"Set" is used to indicate that the value must be defined, |
used to indicate that the value must be defined, but the actual value |
but the actual value of the variable is not checked. |
of the variable is not checked. </li> |
</li> |
|
</ol> | </ol> |
| |
<h3>General Notes</h3> | <h3>General Notes</h3> |
| |
<ol> | <ol> |
<li> |
|
Not all functionality described in this document has achieved |
<li> Not all functionality described in this document has achieved |
"Green"status, please refer to the |
"Green"status, please refer to the <a href="http://www.openpegasus.org/page.tpl?CALLER=index.tpl&ggid=799"> |
<a href="http://www.openpegasus.org/page.tpl?CALLER=index.tpl&ggid=799"> |
OpenPegasus Project Feature Status </a>page for information on the |
OpenPegasus Project Feature Status </a>page for information on |
maturity level of OpenPegasus features. </li> |
the maturity level of OpenPegasus features. |
<li> To encourage testing of new functionality, recommendations for |
</li> |
the Development Build may include features that are not yet recommended |
<li> |
for Release Builds. </li> |
To encourage testing of new functionality, recommendations for the |
|
Development Build may include features that are not yet recommended |
|
for Release Builds. |
|
</li> |
|
</ol> | </ol> |
| |
<h3>Environment Variable Settings for <u>Building</u> OpenPegasus</h3> | <h3>Environment Variable Settings for <u>Building</u> OpenPegasus</h3> |
|
|
<h4>Definitions</h4> | <h4>Definitions</h4> |
| |
<h5>ICU_INSTALL</h5> | <h5>ICU_INSTALL</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>When set, points to the directory containing | <b>Description: </b>When set, points to the directory containing |
the <a href="%20http:/oss.software.ibm.com/icu"> ICU(International | the <a href="%20http:/oss.software.ibm.com/icu"> ICU(International |
Components for Unicode)</a> installation. The 'include' |
Components for Unicode)</a> installation. The 'include' subdirectory is |
subdirectory is used to locate ICU header files at build time. The |
used to locate ICU header files at build time. The 'lib' subdirectory |
'lib' subdirectory is used to locate ICU libraries at link |
is used to locate ICU libraries at link time.<br> |
time.<br> |
|
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
<b>Required: </b>No. However, if PEGASUS_HAS_ICU is |
<b>Required: </b>No. However, if PEGASUS_HAS_ICU is set |
set and ICU_INSTALL is not defined, the ICU libraries and header |
and ICU_INSTALL is not defined, the ICU libraries and header files are |
files are expected to be installed in directories (e.g.,/usr/lib, |
expected to be installed in directories (e.g.,/usr/lib, |
/usr/include) that are searched by default.<br> | /usr/include) that are searched by default.<br> |
<b>Considerations: </b>This environment variable is only used |
<b>Considerations: </b>This environment variable is only used if |
if PEGASUS_HAS_MESSAGES is set. Refer to PEGASUS_HAS_MESSAGES for |
PEGASUS_HAS_MESSAGES is set. Refer to PEGASUS_HAS_MESSAGES for |
additional details. |
|
</ul> |
|
|
|
<h5>ICU_NO_UPPERCASE_ROOT</h5> |
|
<ul> |
|
<b>Description: </b>If set, the messages in the root resource |
|
bundle will NOT be capitalized. By default, the root resource |
|
bundle is capitalized.<br> |
|
<b>Default Value: </b>Not Set<br> |
|
<b>Recommended Value (Development Build): </b>Not Set<br> |
|
<b>Recommended Value (Release Build): </b>Not Set<br> |
|
<b>Required: </b>No<br> |
|
<b>Considerations: </b>This environment variable is only used |
|
if PEGASUS_HAS_MESSAGES is set. Refer to PEGASUS_HAS_MESSAGES for |
|
additional details. | additional details. |
</ul> | </ul> |
| |
<h5>ICU_ROOT_BUNDLE_LANG</h5> | <h5>ICU_ROOT_BUNDLE_LANG</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>If set, specifies the language |
|
to be used to generate the root resource bundle. The |
<b>Description: </b>If set, specifies the language to be used to |
default value for ICU_ROOT_BUNDLE_LANG is _en.<br> |
generate the root resource bundle. The default value for |
|
ICU_ROOT_BUNDLE_LANG is _en.<br> |
<b>Default Value: </b>_en<br> | <b>Default Value: </b>_en<br> |
<b>Recommended Value (Development Build): </b>No |
<b>Recommended Value (Development Build): </b>No Recommendation<br> |
Recommendation<br> |
|
<b>Recommended Value (Release Build): </b>No Recommendation<br> | <b>Recommended Value (Release Build): </b>No Recommendation<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>This environment variable is |
<b>Considerations: </b>This environment variable is only used if |
only used if PEGASUS_HAS_MESSAGES is set. Refer to |
PEGASUS_HAS_MESSAGES is set. Refer to PEGASUS_HAS_MESSAGES for |
PEGASUS_HAS_MESSAGES for additional details.<br> |
additional details.<br> |
If set, resource bundles for the designated language must |
If set, resource bundles for the designated language must exist for the |
exist for the following files: |
following files: |
<ul> | <ul> |
<li>pegasus/src/Pegasus/msg/Server/pegasusServer_en.txt</li> | <li>pegasus/src/Pegasus/msg/Server/pegasusServer_en.txt</li> |
<li>pegasus/src/Pegasus/msg/Listener/pegasusListener_en.txt</li> | <li>pegasus/src/Pegasus/msg/Listener/pegasusListener_en.txt</li> |
</ul> | </ul> |
</ul> | </ul> |
| |
|
|
<h5>OPENSSL_BIN</h5> | <h5>OPENSSL_BIN</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>Specifies the location of the |
|
OpenSSL <i>binary</i> directory. <br> |
<b>Description: </b>Specifies the location of the OpenSSL <i>binary</i> |
|
directory. <br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b> |
<b>Recommended Value (Development Build): </b> No Specific |
No Specific Recommendation<br> |
Recommendation<br> |
<b>Recommended Value (Release Build): </b> |
<b>Recommended Value (Release Build): </b> No Specific |
No Specific Recommendation<br> |
Recommendation<br> |
<b>Required: </b>No. By default, the openssl binary is |
<b>Required: </b>No. By default, the openssl binary is expected |
expected to be installed in a directory that is searched by default |
to be installed in a directory that is searched by default (e.g., |
(e.g., /usr/bin). For platforms where this isn't true, the |
/usr/bin). For platforms where this isn't true, the OPENSSL_BIN |
OPENSSL_BIN environment variable may be used to define an |
environment variable may be used to define an alternative path. This |
alternative path. This environment variable is only used if |
environment variable is only used if PEGASUS_HAS_SSL is set. |
PEGASUS_HAS_SSL is set. |
|
</ul> | </ul> |
| |
<h5>OPENSSL_HOME</h5> | <h5>OPENSSL_HOME</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>Specifies the location of the OpenSSL |
|
SDK directory. This directory must contain the OpenSSL |
<b>Description: </b>Specifies the location of the OpenSSL SDK |
<i>include</i> directory, $(OPENSSL_HOME)/include, and the OpenSSL |
directory. This directory must contain the OpenSSL <i>include</i> |
<i>library</i> directory, $(OPENSSL_HOME)/lib.<br> |
directory, $(OPENSSL_HOME)/include, and the OpenSSL <i>library</i> |
|
directory, $(OPENSSL_HOME)/lib.<br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b> |
<b>Recommended Value (Development Build): </b> No Specific |
No Specific Recommendation<br> |
Recommendation<br> |
<b>Recommended Value (Release Build): </b> |
<b>Recommended Value (Release Build): </b> No Specific |
No Specific Recommendation<br> |
Recommendation<br> |
<b>Required: </b>Yes for Windows, if PEGASUS_HAS_SSL |
<b>Required: </b>Yes for Windows, if PEGASUS_HAS_SSL is set. No |
is set. No for all other platforms. For AIX, the default |
for all other platforms. For AIX, the default value for OPENSSL_HOME is |
value for OPENSSL_HOME is /usr/linux. For all other |
/usr/linux. For all other platforms, the OpenSSL include files |
platforms, the OpenSSL include files and libraries are expected |
and libraries are expected to be installed in directories that are |
to be installed in directories that are searched by default (e.g., |
searched by default (e.g., /usr/bin, /usr/lib(64), and /usr/include). |
/usr/bin, /usr/lib(64), and /usr/include). |
For platforms where the default value is not correct, the OPENSSL_HOME |
For platforms where the default value is not correct, the |
environment variable may be used to define an alternative path (i.e., |
OPENSSL_HOME environment variable may be used to define an |
$(OPENSSL_HOME)/lib and $(OPENSSL_HOME)/include). This environment |
alternative path (i.e., $(OPENSSL_HOME)/lib and |
variable is only used if PEGASUS_HAS_SSL is set. |
$(OPENSSL_HOME)/include). This environment variable |
|
is only used if PEGASUS_HAS_SSL is set. |
|
</ul> | </ul> |
| |
<h5>PEGASUS_ALLOW_ABSOLUTEPATH_IN_PROVIDERMODULE</h5> | <h5>PEGASUS_ALLOW_ABSOLUTEPATH_IN_PROVIDERMODULE</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>If set to true, a version of OpenPegasus | <b>Description: </b>If set to true, a version of OpenPegasus |
will be built that allows an absolute path to be specified as the |
will be built that allows an absolute path to be specified as the value |
value of the Location property of PG_ProviderModule class. |
of the Location property of PG_ProviderModule class. Otherwise it |
Otherwise it does not allow the absolute path to be specified.<br> |
does not allow the absolute path to be specified.<br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
<b>Required: </b>No<p> |
<b>Required: </b>No |
<b>Considerations: </b>To avoid introducing security |
<p> <b>Considerations: </b>To avoid introducing security |
vulnerabilities, vendors should analyze their deployment |
vulnerabilities, vendors should analyze their deployment environments |
environments to understand the security implications of allowing |
to understand the security implications of allowing providers to be |
providers to be loaded from a dynamically changing set of |
loaded from a dynamically changing set of directories.<br> |
directories.<br> |
</p> |
</ul> | </ul> |
| |
<h5>PEGASUS_CCOVER</h5> | <h5>PEGASUS_CCOVER</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>This flag is currently only supported on | <b>Description: </b>This flag is currently only supported on |
HP-UX. It is enabled on the Nightly Build & Test system, | HP-UX. It is enabled on the Nightly Build & Test system, |
HP-UX_11iv3_Integrity_C-Cover. This system is |
HP-UX_11iv3_Integrity_C-Cover. This system is used to generate |
used to generate the nightly BullseyeCoverage code coverage |
the nightly BullseyeCoverage code coverage metrics.<br> |
metrics.<br> |
|
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>This flag is only supported on HP-UX to enable |
<b>Considerations: </b>This flag is only supported on HP-UX to |
CCOVER for the NB&T system.<br> |
enable CCOVER for the NB&T system.<br> |
</ul> | </ul> |
| |
<h5>PEGASUS_CIM_SCHEMA</h5> | <h5>PEGASUS_CIM_SCHEMA</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>This variable is used internally by the | <b>Description: </b>This variable is used internally by the |
OpenPegasus development team when upgrading the OpenPegasus build |
OpenPegasus development team when testing OpenPegasus in the integrated |
environment to a new version of the CIM Schema.<br> |
build/test environment. It defines the version of the CIM Schema (which |
<b>Default Value: </b>CIM217<br> |
must exist in the $(PEGASUS_ROOT)/Schemas directory) that will be used |
|
to build the class repository for testing the pegasus environment |
|
("make repository", etc.).<br> |
|
<b>Default Value: </b>CIM241 (Note that this may change as newer versions of the CIM Schema are used as the default.<br> |
<b>Recommended Value (Development Build): </b> | <b>Recommended Value (Development Build): </b> |
No Specific Recommendation<br> | No Specific Recommendation<br> |
<b>Recommended Value (Release Build): </b> | <b>Recommended Value (Release Build): </b> |
No Specific Recommendation<br> | No Specific Recommendation<br> |
<b>Required: </b>No <br> | <b>Required: </b>No <br> |
<b>Considerations:</b> Additional code changes may be required when |
<b>Considerations:</b> |
upgrading or downgrading the CIM Schema version.</p> |
Additional code changes may be required when upgrading or downgrading |
|
the CIM Schema version from the default. The default CIM Schema |
|
is defined in the file $(PEGASUS_ROOT)/mak/config.mak.<br> |
|
<br> |
|
<p></p> |
</ul> | </ul> |
| |
|
|
<h5>PEGASUS_CLASS_CACHE_SIZE</h5> | <h5>PEGASUS_CLASS_CACHE_SIZE</h5> |
<ul> | <ul> |
<b>Description: </b>This environment variable gives the size of | <b>Description: </b>This environment variable gives the size of |
|
|
<b>Default Value: </b>8<br> | <b>Default Value: </b>8<br> |
<b>Recommended Value (Development Build): </b>8<br> | <b>Recommended Value (Development Build): </b>8<br> |
<b>Recommended Value (Release Build): </b>8<br> | <b>Recommended Value (Release Build): </b>8<br> |
<b>Required: </b>No </p> |
<b>Required: </b>No <p></p> |
</ul> | </ul> |
| |
<h5>PEGASUS_DEBUG</h5> | <h5>PEGASUS_DEBUG</h5> |
|
|
</ul> | </ul> |
| |
<h5>PEGASUS_DEFAULT_USERCTXT_REQUESTOR</h5> | <h5>PEGASUS_DEFAULT_USERCTXT_REQUESTOR</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b> If set to true, the <i>Requestor</i> user | <b>Description: </b> If set to true, the <i>Requestor</i> user |
context is used for providers that do not specify a UserContext |
context is used for providers that do not specify a UserContext value |
value in their registration. Otherwise, the <i>Privileged</i> user |
in their registration. Otherwise, the <i>Privileged</i> user context |
context value is used by default. <br> |
value is used by default. <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> |
<b>Recommended Value (Release Build): </b>false<br> | <b>Recommended Value (Release Build): </b>false<br> |
<b>Required: </b>No |
<b>Required: </b>No <b>Considerations:</b> Use of the <i>Requestor</i> |
<b>Considerations:</b> Use of the <i>Requestor</i> default has |
default has improved provider security characteristics. However, some |
improved provider security characteristics. However, some providers |
providers may not operate correctly when run in the <i>Requestor</i> |
may not operate correctly when run in the <i>Requestor</i> user |
user context and setting this value to true may cause those providers |
context and setting this value to true may cause those providers to |
to fail. Providers that can run in the <i>Requestor</i> user |
fail. Providers that can run in the <i>Requestor</i> |
context are encouraged to explicitly set the UserContext value in their |
user context are encouraged to explicitly set the UserContext value |
registration rather than rely on the default setting default by this |
in their registration rather than rely on the default setting |
variable. Please refer to SecurityGuidelinesForDevelopers.html. PEP 223 |
default by this variable. Please refer to |
for a discussion of the rationale/advantages of running providers in |
SecurityGuidelinesForDevelopers.html. PEP 223 for a discussion |
the <i>Requestor </i> user context. <b>Note:</b> This build variable |
of the rationale/advantages of running providers in the |
is not meaningful if the Provider User Context feature is disabled with |
<i>Requestor </i> user context. <b>Note:</b> This build |
the PEGASUS_DISABLE_PROV_USERCTXT setting. |
variable is not meaningful if the Provider User Context feature is |
|
disabled with the PEGASUS_DISABLE_PROV_USERCTXT |
|
setting. |
|
</ul> | </ul> |
| |
|
|
<h5>PEGASUS_DEFAULT_ENABLE_OOP</h5> | <h5>PEGASUS_DEFAULT_ENABLE_OOP</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>When this variable is set to false, by | <b>Description: </b>When this variable is set to false, by |
default, Providers are run in the cimserver process | default, Providers are run in the cimserver process |
(forceProviderProcesses=false). If this value is set true, |
(forceProviderProcesses=false). If this value is set true, Providers |
Providers are run out-of-process by default.<br> |
are run out-of-process by default.<br> |
<b>Default Value: </b>true for HP-UX and Linux, false for |
<b>Default Value: </b>true for HP-UX and Linux, false for other |
other platforms<br> |
platforms<br> |
<b>Recommended Value (Development Build): </b>true (HP-UX, |
<b>Recommended Value (Development Build): </b>true (HP-UX, Linux)<br> |
Linux)<br> |
<b>Recommended Value (Release Build): </b>true (HP-UX, Linux)<br> |
<b>Recommended Value (Release Build): </b>true (HP-UX, |
|
Linux)<br> |
|
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>This environment variable can be used to | <b>Considerations: </b>This environment variable can be used to |
change the "hard-coded" default setting for the |
change the "hard-coded" default setting for the forceProviderProcesses |
forceProviderProcesses configuration value. |
configuration value. Refer to the definition of <b>forceProviderProcesses</b> |
Refer to the definition of <b>forceProviderProcesses</b> for |
for additional information. |
additional information. |
|
</ul> | </ul> |
| |
<h5>PEGASUS_DEST_LIB_DIR</h5> | <h5>PEGASUS_DEST_LIB_DIR</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>Specifies the location of OpenPegasus |
|
shared libraries.<br> |
<b>Description: </b>Specifies the location of OpenPegasus shared |
|
libraries.<br> |
<b>Default Value: </b>$(PEGASUS_HOME)/lib<br> | <b>Default Value: </b>$(PEGASUS_HOME)/lib<br> |
<b>Recommended Value (Development Build): </b> | <b>Recommended Value (Development Build): </b> |
$(PEGASUS_HOME)/lib<br> | $(PEGASUS_HOME)/lib<br> |
<b>Recommended Value (Release Build): </b> |
<b>Recommended Value (Release Build): </b> No Specific |
No Specific Recommendation <br> |
Recommendation <br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>This variable is NOT is used to define | <b>Considerations: </b>This variable is NOT is used to define |
the location of the Provider library directories. |
the location of the Provider library directories. Please refer to |
Please refer to the providerDir configuration option for details |
the providerDir configuration option for details on defining the |
on defining the directories for the Provider libraries. |
directories for the Provider libraries. |
</ul> | </ul> |
| |
|
|
<h5>PEGASUS_DISABLE_DEPRECATED_INTERFACES</h5> | <h5>PEGASUS_DISABLE_DEPRECATED_INTERFACES</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>Removes deprecated symbol definitions |
|
from OpenPegasus runtime libraries.<br> |
<b>Description: </b>Removes deprecated symbol definitions from |
|
OpenPegasus runtime libraries.<br> |
<b>Default Value:</b> Not Set<br> | <b>Default Value:</b> Not Set<br> |
<b>Recommended Value (Development Build):</b> Not Set<br> | <b>Recommended Value (Development Build):</b> Not Set<br> |
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>If this option is set, the resulting | <b>Considerations: </b>If this option is set, the resulting |
OpenPegasus libraries will not be binary compatible with |
OpenPegasus libraries will not be binary compatible with clients and |
clients and providers built using interface definitions from |
providers built using interface definitions from prior releases. This |
prior releases. This option may be used to slightly reduce binary |
option may be used to slightly reduce binary footprint in an |
footprint in an environment where compatibility is not required.<br> |
environment where compatibility is not required.<br> |
</ul> | </ul> |
| |
<h5>PEGASUS_DISABLE_INSTANCE_QUALIFIERS</h5> | <h5>PEGASUS_DISABLE_INSTANCE_QUALIFIERS</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>In the CIM Infrastructure Specification, | <b>Description: </b>In the CIM Infrastructure Specification, |
version 2.3, the DMTF clarified that instance-level qualifiers are |
version 2.3, the DMTF clarified that instance-level qualifiers are not |
not allowed. In Version 1.2 of the Specification CIM |
allowed. In Version 1.2 of the Specification CIM Operations over |
Operations over HTTP, use of the IncludeQualifiers parameter has |
HTTP, use of the IncludeQualifiers parameter has been DEPRECATED.<br> |
been DEPRECATED.<br> |
|
<b>Default Value:</b> Not Set<br> | <b>Default Value:</b> Not Set<br> |
<b>Recommended Value (Development Build):</b> Not Set<br> | <b>Recommended Value (Development Build):</b> Not Set<br> |
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>Existing CIM Clients may depend on | <b>Considerations: </b>Existing CIM Clients may depend on |
qualifiers being returned in the response. In this case, the | qualifiers being returned in the response. In this case, the |
PEGASUS_DISABLE_INSTANCE_QUALIFIERS should not be set. |
PEGASUS_DISABLE_INSTANCE_QUALIFIERS should not be set. If this |
If this flag is set, the value of the IncludeQualifiers parameter |
flag is set, the value of the IncludeQualifiers parameter passed on the |
passed on the GetInstance and EnumerateInstance operations is |
GetInstance and EnumerateInstance operations is ignored and qualifiers |
ignored and qualifiers are not returned. |
are not returned. Disabling the return of qualifiers as part of a |
Disabling the return of qualifiers as part of a CIM Instance will |
CIM Instance will improve performance.<br> |
improve performance.<br> |
|
</ul> | </ul> |
| |
<h5>PEGASUS_DISABLE_LOCAL_DOMAIN_SOCKET</h5> | <h5>PEGASUS_DISABLE_LOCAL_DOMAIN_SOCKET</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>Disables support for local (same-system) | <b>Description: </b>Disables support for local (same-system) |
connections over a Unix domain socket. If this option is NOT set, |
connections over a Unix domain socket. If this option is NOT set, the |
the CIM Server is built to allow connections to be established |
CIM Server is built to allow connections to be established using a |
using a domain socket rather than a TCP port.<br> |
domain socket rather than a TCP port.<br> |
<b>Default Value: </b>Not Set <br> | <b>Default Value: </b>Not Set <br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>(1) In high-threat environments, a | <b>Considerations: </b>(1) In high-threat environments, a |
customer may want to disable all ports or reduce the number of |
customer may want to disable all ports or reduce the number of exposed |
exposed network ports. Supporting a local connection mechanism |
network ports. Supporting a local connection mechanism using Unix |
using Unix domain socket allows the CIM Server to continue to |
domain socket allows the CIM Server to continue to receive and process |
receive and process requests from local CIM Clients. (2) |
requests from local CIM Clients. (2) Enabling this option may result in |
Enabling this option may result in lose of functionality when |
lose of functionality when sslClientVerificationMode = required. (3)The |
sslClientVerificationMode = required. (3)The |
"LOCAL_DOMAIN_SOCKET" functionality has not been implemented for |
"LOCAL_DOMAIN_SOCKET" functionality has not been |
Windows or OpenVMS. Therefore, by default, this option is "Set" |
implemented for Windows or OpenVMS. Therefore, by |
for Windows and OpenVMS platforms. |
default, this option is "Set" for Windows and OpenVMS |
|
platforms. |
|
</ul> | </ul> |
| |
<h5>PEGASUS_DISABLE_PERFINST</h5> | <h5>PEGASUS_DISABLE_PERFINST</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>Builds a version of OpenPegasus that | <b>Description: </b>Builds a version of OpenPegasus that |
disables support for gathering performance data.<br> | disables support for gathering performance data.<br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>Set<br> | <b>Recommended Value (Release Build): </b>Set<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>The CIM_ObjectManager.GatherStatisticalData |
<b>Considerations: </b>The |
property is used to control statistic gathering. Once enabled, |
CIM_ObjectManager.GatherStatisticalData property is used to control |
statistical data can be viewed by retrieving instances of the |
statistic gathering. Once enabled, statistical data can be viewed |
CIM_StatisticalData class. Support for gathering performance |
by retrieving instances of the CIM_StatisticalData class. Support for |
data requires PEGASUS_ENABLE_INTEROP_PROVIDER to be enabled. If |
gathering performance data requires PEGASUS_ENABLE_INTEROP_PROVIDER to |
PEGASUS_ENABLE_INTEROP_PROVIDER is explicitly disabled (i.e., set |
be enabled. If PEGASUS_ENABLE_INTEROP_PROVIDER is explicitly disabled |
to false), then PEGASUS_DISABLE_PERFINST must be set to |
(i.e., set to false), then PEGASUS_DISABLE_PERFINST must be set |
true. If PEGASUS_DISABLE_PERFINST is not defined or set to |
to true. If PEGASUS_DISABLE_PERFINST is not defined or set to |
false and PEGASUS_ENABLE_INTEROP_PROVIDER is not set, | false and PEGASUS_ENABLE_INTEROP_PROVIDER is not set, |
PEGASUS_ENABLE_INTEROP_PROVIDER will be automatically enabled. | PEGASUS_ENABLE_INTEROP_PROVIDER will be automatically enabled. |
</ul> | </ul> |
| |
<h5>PEGASUS_DISABLE_PRIVILEGED_TESTS</h5> | <h5>PEGASUS_DISABLE_PRIVILEGED_TESTS</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>This variable is used only in the development |
|
environment to restrict the level of testing performed by default. |
<b>Description: </b>This variable is used only in the |
If set, tests that require the CIM Server to run in a privileged |
development environment to restrict the level of testing performed by |
mode will not be run. Setting this variable allows |
default. If set, tests that require the CIM Server to run in a |
developers, without privileged access, to successfully run a |
privileged mode will not be run. Setting this variable allows |
subset of the OpenPegasus test suit. This variable does |
developers, without privileged access, to successfully run a subset of |
not affect CIM Server functionality. It merely controls |
the OpenPegasus test suit. This variable does not affect CIM |
the level of testing.<br> |
Server functionality. It merely controls the level of testing.<br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>Not Used<br> | <b>Recommended Value (Release Build): </b>Not Used<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>Enabling this variable will significantly | <b>Considerations: </b>Enabling this variable will significantly |
reduce the testing of security related features (e.g., |
reduce the testing of security related features (e.g., authentication |
authentication and authorization) and can affect testing in other |
and authorization) and can affect testing in other areas. |
areas. |
|
</ul> | </ul> |
| |
<h5>PEGASUS_DISABLE_PROV_USERCTXT</h5> | <h5>PEGASUS_DISABLE_PROV_USERCTXT</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>Builds a version of OpenPegasus that | <b>Description: </b>Builds a version of OpenPegasus that |
disables supports for the Provider User Context feature. |
disables supports for the Provider User Context feature. This |
This feature allows a Provider to choose the user context in |
feature allows a Provider to choose the user context in which it is |
which it is invoked, including the ability to run in the context of |
invoked, including the ability to run in the context of the user |
the user requesting an operation.<br> |
requesting an operation.<br> |
<b>Default Value: </b>Set for Windows and OpenVMS, Not Set |
<b>Default Value: </b>Set for Windows and OpenVMS, Not Set for |
for all other platforms<br> |
all other platforms<br> |
<b>Recommended Value (Development Build): </b>Set for Windows and | <b>Recommended Value (Development Build): </b>Set for Windows and |
OpenVMS, Not Set for all other platforms<br> | OpenVMS, Not Set for all other platforms<br> |
<b>Recommended Value (Release Build): </b>Set for Windows and | <b>Recommended Value (Release Build): </b>Set for Windows and |
|
|
defined. In this case, the Provider Registration Manager rejects | defined. In this case, the Provider Registration Manager rejects |
provider registration requests that specify a UserContext property | provider registration requests that specify a UserContext property |
value. The user context in which providers run is then unchanged by | value. The user context in which providers run is then unchanged by |
this enhancement. Some platforms, such as OS/400 and z/OS may |
this enhancement. Some platforms, such as OS/400 and z/OS may define |
define the PEGASUS_DISABLE_PROV_USERCTXT as part of the platform |
the PEGASUS_DISABLE_PROV_USERCTXT as part of the platform |
configuration, since these platforms already set the provider user | configuration, since these platforms already set the provider user |
context on a per-thread basis. When the Provider User Context | context on a per-thread basis. When the Provider User Context |
feature is enabled, support for each of the User Context types may |
feature is enabled, support for each of the User Context types may be |
be disabled individually. Provider registration fails when an |
disabled individually. Provider registration fails when an unsupported |
unsupported UserContext value is specified. Please refer to |
UserContext value is specified. Please refer to |
SecurityGuidelinesForDevelopers.html / PEP 223 for a discussion of |
SecurityGuidelinesForDevelopers.html / PEP 223 for a discussion of the |
the rationale/advantages of user context providers to many |
rationale/advantages of user context providers to many platforms.<br> |
platforms.<br> |
|
</ul> | </ul> |
| |
<h5>PEGASUS_EXTRA_PROVIDER_LIB_DIR</h5> | <h5>PEGASUS_EXTRA_PROVIDER_LIB_DIR</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>Specifies the location of the extra provider | <b>Description: </b>Specifies the location of the extra provider |
libraries which are part of the release builds.<br> | libraries which are part of the release builds.<br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b> |
<b>Recommended Value (Development Build): </b> No Specific |
No Specific Recommendation<br> |
Recommendation<br> |
<b>Recommended Value (Release Build): </b> |
<b>Recommended Value (Release Build): </b> No Specific |
No Specific Recommendation<br> |
Recommendation<br> |
<b>Required: </b> No.<br> | <b>Required: </b> No.<br> |
<b>Considerations: </b> Since providerDir config property is fixed |
<b>Considerations: </b> Since providerDir config property is |
and hidden in release builds, this build time option provides facilty |
fixed and hidden in release builds, this build time option provides |
to include the extra provider directories without any security problems. |
facilty to include the extra provider directories without any security |
This build time option is useful only when PEGASUS_OVERRIDE_DEFAULT_RELEASE_DIRS |
problems. This build time option is useful only when |
is set. |
PEGASUS_OVERRIDE_DEFAULT_RELEASE_DIRS is set. |
</ul> | </ul> |
| |
<h5>PEGASUS_EMANATE_INCLUDE_DIR</h5> | <h5>PEGASUS_EMANATE_INCLUDE_DIR</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>Specifies the location of the EMANATE |
|
<i>include</i> directory. <br> |
<b>Description: </b>Specifies the location of the EMANATE <i>include</i> |
|
directory. <br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b> |
<b>Recommended Value (Development Build): </b> No Specific |
No Specific Recommendation<br> |
Recommendation<br> |
<b>Recommended Value (Release Build): </b> |
<b>Recommended Value (Release Build): </b> No Specific |
No Specific Recommendation<br> |
Recommendation<br> |
<b>Required: </b>No. By default, the EMANATE include files |
<b>Required: </b>No. By default, the EMANATE include files are |
are expected to be installed in directories that are searched by |
expected to be installed in directories that are searched by default |
default (e.g., /usr/include). For platforms where this isn't true, |
(e.g., /usr/include). For platforms where this isn't true, the |
the PEGASUS_EMANATE_INCLUDE_DIR environment variable may be used to |
PEGASUS_EMANATE_INCLUDE_DIR environment variable may be used to define |
define an alternative path. This environment variable is only used |
an alternative path. This environment variable is only used if |
if PEGASUS_USE_EMANATE is set.<br> |
PEGASUS_USE_EMANATE is set.<br> |
<b>Considerations: </b>Refer to the description of PEGASUS_USE_EMANATE |
<b>Considerations: </b>Refer to the description of |
for additional details.<br> |
PEGASUS_USE_EMANATE for additional details.<br> |
</ul> | </ul> |
| |
<h5>PEGASUS_EMANATE_LIB_DIR</h5> | <h5>PEGASUS_EMANATE_LIB_DIR</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>Specifies the location of the EMANATE |
|
<i>lib</i> directory. <br> |
<b>Description: </b>Specifies the location of the EMANATE <i>lib</i> |
|
directory. <br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b> |
<b>Recommended Value (Development Build): </b> No Specific |
No Specific Recommendation<br> |
Recommendation<br> |
<b>Recommended Value (Release Build): </b> |
<b>Recommended Value (Release Build): </b> No Specific |
No Specific Recommendation<br> |
Recommendation<br> |
<b>Required: </b>No. By default, the EMANATE libraries are | <b>Required: </b>No. By default, the EMANATE libraries are |
expected to be installed in directories that are searched by |
expected to be installed in directories that are searched by default |
default (e.g., /usr/lib, /usr/lib64). For platforms where this |
(e.g., /usr/lib, /usr/lib64). For platforms where this isn't true, the |
isn't true, the PEGASUS_EMANATE_LIB_DIR environment variable may |
PEGASUS_EMANATE_LIB_DIR environment variable may be used to define an |
be used to define an alternative path. This environment variable |
alternative path. This environment variable is only used if |
is only used if PEGASUS_USE_EMANATE is set.<br> |
PEGASUS_USE_EMANATE is set.<br> |
<b>Considerations: </b>Refer to the description of PEGASUS_USE_EMANATE |
<b>Considerations: </b>Refer to the description of |
for additional details.<br> |
PEGASUS_USE_EMANATE for additional details.<br> |
</ul> | </ul> |
| |
<h5>PEGASUS_ENABLE_AUDIT_LOGGER</h5> | <h5>PEGASUS_ENABLE_AUDIT_LOGGER</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>When this variable is set to false, support | <b>Description: </b>When this variable is set to false, support |
for audit logging will NOT be built into OpenPegasus. If this |
for audit logging will NOT be built into OpenPegasus. If this variable |
variable is set to true, or not set, support for audit logging |
is set to true, or not set, support for audit logging will be included |
will be included in the build. All other values are invalid.<br> |
in the build. All other values are invalid.<br> |
<b>Default Value: </b>true<br> | <b>Default Value: </b>true<br> |
<b>Recommended Value (Development Build): </b>true<br> | <b>Recommended Value (Development Build): </b>true<br> |
<b>Recommended Value (Release Build): </b>true<br> | <b>Recommended Value (Release Build): </b>true<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
</ul> | </ul> |
| |
|
|
<h5>PEGASUS_ENABLE_CMPI_PROVIDER_MANAGER</h5> | <h5>PEGASUS_ENABLE_CMPI_PROVIDER_MANAGER</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>If set to true, a version of OpenPegasus | <b>Description: </b>If set to true, a version of OpenPegasus |
that supports CMPI providers and their dependent components is | that supports CMPI providers and their dependent components is |
built. If this variable is not set or set to false, support |
built. If this variable is not set or set to false, support for |
for CMPI providers will not be included. <br> |
CMPI providers will not be included. <br> |
<b>Default Value: </b>true for Linux and OpenVMS, false for | <b>Default Value: </b>true for Linux and OpenVMS, false for |
other platforms<br> | other platforms<br> |
<b>Recommended Value (Development Build): </b>true (Linux |
<b>Recommended Value (Development Build): </b>true (Linux Platform |
Platform Only)<br> |
Only)<br> |
<b>Recommended Value (Release Build): </b>true (Linux Platform | <b>Recommended Value (Release Build): </b>true (Linux Platform |
Only)<br> | Only)<br> |
<b>Required: </b>No</p> |
<b>Required: </b>No |
</ul> | </ul> |
| |
<h5>PEGASUS_ENABLE_COMPRESSED_REPOSITORY</h5> | <h5>PEGASUS_ENABLE_COMPRESSED_REPOSITORY</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>If set the Repository Compression logic is | <b>Description: </b>If set the Repository Compression logic is |
built and enabled and compressed and non compressed repositories |
built and enabled and compressed and non compressed repositories are |
are supported. If not set then compressed repositories are not |
supported. If not set then compressed repositories are not supported.<br> |
supported.<br> |
|
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
<b>Required: </b>No<p> |
<b>Required: </b>No |
<b>Considerations: </b>See |
<p> <b>Considerations: </b>See |
pegasus/readme.compressed_repository</p> | pegasus/readme.compressed_repository</p> |
</ul> | </ul> |
| |
|
|
<h5>PEGASUS_ENABLE_CQL</h5> | <h5>PEGASUS_ENABLE_CQL</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>When this variable is set to false, support | <b>Description: </b>When this variable is set to false, support |
for Indication Subscription filters that have CQL as the language |
for Indication Subscription filters that have CQL as the language is |
is disabled. It does not remove CQL from the build.<br> |
disabled. It does not remove CQL from the build.<br> |
<b>Default Value:</b> Not Set<br> | <b>Default Value:</b> Not Set<br> |
<b>Recommended Value (Development Build):</b> Not Set<br> | <b>Recommended Value (Development Build):</b> Not Set<br> |
<b>Recommended Value (Release Build):</b> false<br> | <b>Recommended Value (Release Build):</b> false<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>The DMTF CIM Query Language |
<b>Considerations: </b>The DMTF CIM Query Language Specification |
Specification is Preliminary and subject to backward incompatible |
is Preliminary and subject to backward incompatible changes. |
changes. |
|
</ul> | </ul> |
| |
<h5>PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT</h5> | <h5>PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>When this variable is set to true, support the | <b>Description: </b>When this variable is set to true, support the |
DMTF Indications Profile (DSP1054) is included in OpenPegasus. |
DMTF Indications Profile (DSP1054) is included in OpenPegasus. If |
If this variable is not set or set to false, support for the DMTF |
this variable is not set or set to false, support for the DMTF |
Indications Profile will not be included.<br> | Indications Profile will not be included.<br> |
<b>Default Value:</b> Not Set<br> | <b>Default Value:</b> Not Set<br> |
<b>Recommended Value (Development Build):</b> Not Set<br> | <b>Recommended Value (Development Build):</b> Not Set<br> |
<b>Recommended Value (Release Build):</b> Not Set<br> | <b>Recommended Value (Release Build):</b> Not Set<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>The implementation of this feature is |
<b>Considerations: </b>The implementation of this feature is based |
based on a preliminary version of the DMTF Indications Profile, |
on a preliminary version of the DMTF Indications Profile, DSP1053, and |
DSP1053, and subject to change. If this variable is enabled, |
subject to change. If this variable is enabled, two DMTF |
two DMTF experimental class definitions, CIM_IndicationService and |
experimental class definitions, CIM_IndicationService and |
CIM_IndicationServiceCapabilities, will be added to the |
CIM_IndicationServiceCapabilities, will be added to the root/PG_InterOp |
root/PG_InterOp namespace. Experimental class definitions are |
namespace. Experimental class definitions are subject to change. |
subject to change. |
|
PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT requires | PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT requires |
PEGASUS_ENABLE_INTEROP_PROVIDER to be enabled. |
PEGASUS_ENABLE_INTEROP_PROVIDER to be enabled. If |
If PEGASUS_ENABLE_INTEROP_PROVIDER is not set, setting |
PEGASUS_ENABLE_INTEROP_PROVIDER is not set, setting |
PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT to true, will also | PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT to true, will also |
enable PEGASUS_ENABLE_INTEROP_PROVIDER. If | enable PEGASUS_ENABLE_INTEROP_PROVIDER. If |
PEGASUS_ENABLE_INTEROP_PROVIDER is explicitly disabled (i.e., set |
PEGASUS_ENABLE_INTEROP_PROVIDER is explicitly disabled (i.e., set to |
to false), a build error will be generated. |
false), a build error will be generated. |
</ul> | </ul> |
| |
<h5>PEGASUS_ENABLE_EXECQUERY</h5> | <h5>PEGASUS_ENABLE_EXECQUERY</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>When this environment variable is set, | <b>Description: </b>When this environment variable is set, |
processing of ExecQuery operations is enabled. When not set, |
processing of ExecQuery operations is enabled. When not set, ExecQuery |
ExecQuery operation requests get a NotSupported response. (Note: |
operation requests get a NotSupported response. (Note: The |
The PEGASUS_ENABLE_EXECQUERY environment variable controls |
PEGASUS_ENABLE_EXECQUERY environment variable controls the definition |
the definition of the PEGASUS_DISABLE_EXECQUERY compile macro.) <br> |
of the PEGASUS_DISABLE_EXECQUERY compile macro.) <br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
|
|
</ul> | </ul> |
| |
<h5>PEGASUS_ENABLE_EMAIL_HANDLER</h5> | <h5>PEGASUS_ENABLE_EMAIL_HANDLER</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b> When this environment variable is set, an | <b>Description: </b> When this environment variable is set, an |
E-Mail Indication Handler is built as part of the OpenPegasus | E-Mail Indication Handler is built as part of the OpenPegasus |
build. The E-Mail Indication Handler can be used to |
build. The E-Mail Indication Handler can be used to delivered CIM |
delivered CIM Indications to a designated e-mail address.<br> |
Indications to a designated e-mail address.<br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>If PEGASUS_ENABLE_EMAIL_HANDLER is |
<b>Considerations: </b>If PEGASUS_ENABLE_EMAIL_HANDLER is not |
not set when OpenPegasus is built, a request to create an Email |
set when OpenPegasus is built, a request to create an Email Indication |
Indication Handler instance will be rejected will the error |
Handler instance will be rejected will the error CIM_ERR_NOT_SUPPORTED. |
CIM_ERR_NOT_SUPPORTED. |
|
</ul> | </ul> |
| |
<h5>PEGASUS_ENABLE_GCOV</h5> | <h5>PEGASUS_ENABLE_GCOV</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>GCOV, |
|
<a href="http://gcc.gnu.org/onlinedocs/gcc/index.html#toc_Gcov"> |
<b>Description: </b>GCOV, <a href="http://gcc.gnu.org/onlinedocs/gcc/index.html#toc_Gcov"> |
http://gcc.gnu.org/onlinedocs/gcc/index.html#toc_Gcov</a>, is a |
http://gcc.gnu.org/onlinedocs/gcc/index.html#toc_Gcov</a>, is a code |
code coverage utility. If PEGASUS_ENABLE_GCOV is set, |
coverage utility. If PEGASUS_ENABLE_GCOV is set, GCC will |
GCC will instrument the code to support analysis by GCOV.<br> |
instrument the code to support analysis by GCOV.<br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b> |
<b>Recommended Value (Development Build): </b> Not Set<br> |
Not Set<br> |
|
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
<b>Required: </b>No<br><b>Considerations: </b> |
<b>Required: </b>No<br> |
This flag is currently only supported with GCC on Linux. |
<b>Considerations: </b> This flag is currently only supported |
|
with GCC on Linux. |
<ul> | <ul> |
Note: LCOV, <a href= |
Note: LCOV, <a href="http://ltp.sourceforge.net/coverage/lcov.php"> |
"http://ltp.sourceforge.net/coverage/lcov.php"> |
http://ltp.sourceforge.net/coverage/lcov.php</a>, is a graphical |
http://ltp.sourceforge.net/coverage/lcov.php</a>, is a |
front-end extension for GCOV. It collects GCOV data for multiple source |
graphical front-end extension for GCOV. It collects GCOV data |
files and creates HTML pages with coverage information. You can use the |
for multiple source files and creates HTML pages with coverage |
following steps to use LCOV to analyze OpenPegasus GCOV data. |
information. You can use the following steps to use LCOV to |
|
analyze OpenPegasus GCOV data. |
|
<ol> | <ol> |
<li>Set PEGASUS_ENABLE_GCOV = true.</li> | <li>Set PEGASUS_ENABLE_GCOV = true.</li> |
<li>Build and test OpenPegasus (e.g., |
<li>Build and test OpenPegasus (e.g., <i>make -f |
<i>make -f pegasus/TestMakefile build |
pegasus/TestMakefile build alltests</i>).</li> |
alltests</i>).</li> |
|
<li>For each source directory, | <li>For each source directory, |
<ul> | <ul> |
<li>copy the .gcda and .gcno files from the object |
<li>copy the .gcda and .gcno files from the object directory |
directory to the source directory (e.g., |
to the source directory (e.g., <i>cp build/obj/Pegasus/Common/*.gcda |
<i>cp build/obj/Pegasus/Common/*.gcda |
|
src/Pegasus/Common/</i>);</li> | src/Pegasus/Common/</i>);</li> |
<li>execute the <b>lcov</b> command |
<li>execute the <b>lcov</b> command (e.g., <i>lcov |
(e.g., |
--directory src/Pegasus/Common/ --capture --output-file result.info</i>) |
<i>lcov --directory src/Pegasus/Common/ --capture |
to build the result.info file; and finally,</li> |
--output-file result.info</i>) to build the result.info |
|
file; and finally,</li> |
|
<li>use the <b>genhtml</b> command to generate the .html | <li>use the <b>genhtml</b> command to generate the .html |
output (e.g., <i>genhtml result.info</i>). The |
output (e.g., <i>genhtml result.info</i>). The top .html file is |
top .html file is named index.html.</li> |
named index.html.</li> |
</ul> | </ul> |
|
</li> |
</ol> | </ol> |
</ul> | </ul> |
</ul> | </ul> |
| |
<h5>PEGASUS_ENABLE_INDICATION_COUNT</h5> | <h5>PEGASUS_ENABLE_INDICATION_COUNT</h5> |
<ul> |
|
<b>Description: </b>If true, the CIM |
|
Server will be built to count the number of CIM indications |
|
generated by providers and matched with subscriptions. If false |
|
or not set, indication statistic support will not be included. |
|
<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>The number of CIM indications generated by |
|
providers and matched with subscriptions is stored in hash tables |
|
which causes memory usage to increase by 4 bytes for each |
|
active subscription and by about 400 bytes for each active |
|
indication provider.<br> |
|
</ul> |
|
| |
<h5>PEGASUS_ENABLE_PROTOCOL_INTERNAL_BINARY</h5> |
|
<ul> | <ul> |
<b>Description: </b>If true, OpenPegasus uses a faster binary |
|
protocol between the CIM server and provider manager. If false, |
<b>Description: </b>If true, the CIM Server will be built to count |
OpenPegasus uses the older XML-based protocol instead. |
the number of CIM indications generated by providers and matched with |
<br> |
subscriptions. If false or not set, indication statistic support will |
<b>Default Value: </b>true<br> |
not be included. <b>Default Value: </b>true<br> |
<b>Recommended Value (Development Build): </b>true<br> | <b>Recommended Value (Development Build): </b>true<br> |
<b>Recommended Value (Release Build): </b>true<br> | <b>Recommended Value (Release Build): </b>true<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>This option improves performance by optimizing the |
<b>Considerations: </b>The number of CIM indications generated by |
serialization and deserialization of messages between the server and |
providers and matched with subscriptions is stored in hash tables which |
out-of-process providers. |
causes memory usage to increase by 4 bytes for each active subscription |
<br> |
and by about 400 bytes for each active indication provider.<br> |
</ul> | </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, |
CIM server. If false, OpenPegasus uses the conventional XML-based protocol |
OpenPegasus uses the conventional XML-based protocol instead. See |
instead. See PEP#340 for more details. |
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> |
<b>Recommended Value (Release Build): </b>false<br> | <b>Recommended Value (Release Build): </b>false<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>This option improves performance by using a faster |
<b>Considerations: </b>This option improves performance by using a |
binary protocol between local clients and the CIM server. |
faster binary protocol between local clients and the CIM server. <br> |
<br> |
|
</ul> | </ul> |
| |
<h5>PEGASUS_ENABLE_INTEROP_PROVIDER</h5> | <h5>PEGASUS_ENABLE_INTEROP_PROVIDER</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>If true, the OpenPegasus Interop Provider |
|
will be build. If false or not set, the OpenPegasus Interop |
<b>Description: </b>If true, the OpenPegasus Interop Provider will |
Provider will not be built.<br> |
be build. If false or not set, the OpenPegasus Interop Provider will |
|
not be built.<br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>false<br> | <b>Recommended Value (Release Build): </b>false<br> |
<b>Required: </b>No <br> | <b>Required: </b>No <br> |
<b>Considerations: </b> A number of features controlled by | <b>Considerations: </b> A number of features controlled by |
OpenPegasus build options are dependent on the Interop |
OpenPegasus build options are dependent on the Interop Provider. |
Provider. Please refer to PEGASUS_ENABLE_SLP, |
Please refer to PEGASUS_ENABLE_SLP, PEGASUS_DISABLE_PERFINST, and |
PEGASUS_DISABLE_PERFINST, and |
PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT for additional details.<br> |
PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT for additional |
</ul> |
details.<br> |
|
|
<h5>PEGASUS_INTEROP_NAMESPACE</h5> |
|
|
|
<ul> |
|
|
|
<b>Description: </b>This variable is used for configuring the |
|
Interop namespace name. This option helps to establish a consistent |
|
Interop Namespace as mentioned in DMTF specification.(DSP1033)<br> |
|
<b>Default Value: </b>root/PG_InterOp<br> |
|
<b>Recommended Value (Development Build): </b>Not Set<br> |
|
<b>Recommended Value (Release Build): </b>Not Set<br> |
|
<b>Required: </b>No <br> |
|
<b>Considerations: </b>The accepted values for this environment |
|
variable are "root/PG_InterOp" or "interop" or "root/interop". For any |
|
other value, the default value will be used.With the usage of this |
|
build option, we have to start using pegasus with fresh repository. |
</ul> | </ul> |
| |
<h5>PEGASUS_ENABLE_IPV6</h5> | <h5>PEGASUS_ENABLE_IPV6</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>This variable can be used to specify |
|
whether IPv6 support should be included in OpenPegasus.<br> |
<b>Description: </b>This variable can be used to specify whether |
|
IPv6 support should be included in OpenPegasus.<br> |
<b>Default Value: </b>true<br> | <b>Default Value: </b>true<br> |
<b>Recommended Value (Development Build): </b>true<br> | <b>Recommended Value (Development Build): </b>true<br> |
<b>Recommended Value (Release Build): </b>true<br> | <b>Recommended Value (Release Build): </b>true<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>When this variable is set to |
<b>Considerations: </b>When this variable is set to 'false', |
'false', support for IPv6 socket APIs and structures is disabled, |
support for IPv6 socket APIs and structures is disabled, and the CIM |
and the CIM Server will not accept connections to or from IPv6 |
Server will not accept connections to or from IPv6 network interfaces. |
network interfaces. When this variable is set to 'true', the |
When this variable is set to 'true', the newer IPv6 socket APIs and |
newer IPv6 socket APIs and structures will be included when |
structures will be included when OpenPegasus is built, so they must be |
OpenPegasus is built, so they must be supported on the build |
supported on the build platform. However, if IPv6 is not supported on |
platform. However, if IPv6 is not supported on the platform on |
the platform on which an IPv6-enabled version of OpenPegasus is run, |
which an IPv6-enabled version of OpenPegasus is run, then the IPv6 |
then the IPv6 feature will be disabled at run-time and only IPv4 |
feature will be disabled at run-time and only IPv4 connections |
connections will be supported. |
will be supported. |
|
</ul> | </ul> |
| |
<h5>PEGASUS_ENABLE_JMPI_PROVIDER_MANAGER</h5> | <h5>PEGASUS_ENABLE_JMPI_PROVIDER_MANAGER</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>If true, a version of OpenPegasus that | <b>Description: </b>If true, a version of OpenPegasus that |
supports JMPI providers and their dependent components is built. |
supports JMPI providers and their dependent components is built. If |
If false or not set, support for JMPI Providers is not included |
false or not set, support for JMPI Providers is not included in |
in OpenPegasus. All other values are invalid.<br> |
OpenPegasus. All other values are invalid.<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> |
<b>Recommended Value (Release Build): </b>false<br> | <b>Recommended Value (Release Build): </b>false<br> |
<b>Required: </b>No</p> |
<b>Required: </b>No |
</ul> | </ul> |
| |
<h5>PEGASUS_ENABLE_OBJECT_NORMALIZATION</h5> | <h5>PEGASUS_ENABLE_OBJECT_NORMALIZATION</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>If set, builds in support so that objects | <b>Description: </b>If set, builds in support so that objects |
returned from provider instance operations can be validated. |
returned from provider instance operations can be validated. The |
The enableNormalization must also be set to 'true' (default)<br> |
enableNormalization must also be set to 'true' (default)<br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
<b>Required: </b>No <br> | <b>Required: </b>No <br> |
<b>Considerations: </b>If PEGASUS_ENABLE_OBJECT_NORMALIZATION is | <b>Considerations: </b>If PEGASUS_ENABLE_OBJECT_NORMALIZATION is |
set, two new configuration options are defined: enableNormalization |
set, two new configuration options are defined: enableNormalization and |
and excludeModulesFromNormalization. |
excludeModulesFromNormalization. |
</ul> | </ul> |
| |
<h5>PEGASUS_ENABLE_PRIVILEGE_SEPARATION</h5> | <h5>PEGASUS_ENABLE_PRIVILEGE_SEPARATION</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>If true, a version of OpenPegasus that | <b>Description: </b>If true, a version of OpenPegasus that |
enables the Privilege Separation feature is built. This feature |
enables the Privilege Separation feature is built. This feature allows |
allows the CIM Server to run in a non-privileged user context and |
the CIM Server to run in a non-privileged user context and use a small |
use a small executor process to perform privileged operations. If |
executor process to perform privileged operations. If false or not set, |
false or not set, the Privilege Separate feature will not be |
the Privilege Separate feature will not be included.<br> |
included.<br> |
|
<b>Default Value: </b>false<br> | <b>Default Value: </b>false<br> |
<b>Recommended Value (Development Build): </b>true (HP-UX, |
<b>Recommended Value (Development Build): </b>true (HP-UX, Linux)<br> |
Linux)<br> |
<b>Recommended Value (Release Build): </b>true (HP-UX, Linux)<br> |
<b>Recommended Value (Release Build): </b>true (HP-UX, |
|
Linux)<br> |
|
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b> The Privilege Separation feature is |
<b>Considerations: </b> The Privilege Separation feature is only |
only supported on HP-UX and Linux platforms. The 'cimsrvr' user |
supported on HP-UX and Linux platforms. The 'cimsrvr' user must be |
must be defined on the system. If the umask setting in the |
defined on the system. If the umask setting in the environment is not |
environment is not 0, PEGASUS_TMP must be set to a directory that |
0, PEGASUS_TMP must be set to a directory that is writable by the |
is writable by the 'cimsrvr' user for the tests to run |
'cimsrvr' user for the tests to run successfully. |
successfully. |
|
</ul> | </ul> |
| |
<h5>PEGASUS_ENABLE_PROTOCOL_WSMAN</h5> | <h5>PEGASUS_ENABLE_PROTOCOL_WSMAN</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>If true, a version of OpenPegasus is |
|
built that accepts and processes WS-Management requests. This |
<b>Description: </b>If true, a version of OpenPegasus is built |
feature is initially limited to WS-Transfer and WS-Enumeration |
that accepts and processes WS-Management requests. This feature is |
operations. If false or not set, WS-Management support is not |
initially limited to WS-Transfer and WS-Enumeration operations. If |
built or included in any way.<br> |
false or not set, WS-Management support is not built or included in any |
|
way.<br> |
<b>Default Value: </b>false<br> | <b>Default Value: </b>false<br> |
<b>Recommended Value (Development Build): </b>true<br> | <b>Recommended Value (Development Build): </b>true<br> |
<b>Recommended Value (Release Build): </b>false<br> | <b>Recommended Value (Release Build): </b>false<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b> The WS-Management standards are not | <b>Considerations: </b> The WS-Management standards are not |
mature, and interoperability problems may arise. The WS-Management | mature, and interoperability problems may arise. The WS-Management |
functionality may change in incompatible ways in subsequent |
functionality may change in incompatible ways in subsequent releases. |
releases. Also note the known limitations specified in PEP 311.<br> |
Also note the known limitations specified in PEP 311.<br> |
|
</ul> |
|
|
|
<h5>PEGASUS_ENABLE_PROTOCOL_WEB</h5> |
|
|
|
<ul> |
|
|
|
<b>Description: </b>Enable pegasus to act as webserver capable |
|
of serving webpages by comsuming the JSON output from CIM-RS.<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> When authentication is disabled, Anybody |
|
can modify the pegasus cimserver. Please enable authentication when |
|
using webadmin to prevent unauthorized access. <br> |
</ul> | </ul> |
| |
<h5>PEGASUS_ENABLE_REMOTE_CMPI</h5> | <h5>PEGASUS_ENABLE_REMOTE_CMPI</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>If set, a version of OpenPegasus that | <b>Description: </b>If set, a version of OpenPegasus that |
support Remote CMPI providers and their dependent components |
support Remote CMPI providers and their dependent components is built.<br> |
is built.<br> |
|
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
<b>Required: </b>No</p> |
<b>Required: </b>No |
</ul> | </ul> |
| |
<h5>PEGASUS_ENABLE_SLP</h5> | <h5>PEGASUS_ENABLE_SLP</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>This variable controls of the inclusion |
|
of SLP functionality in the OpenPegasus build. When this |
<b>Description: </b>This variable controls of the inclusion of |
environment variable is set to 'true', SLP functionality will be |
SLP functionality in the OpenPegasus build. When this environment |
included as part of the OpenPegasus build. If |
variable is set to 'true', SLP functionality will be included as part |
this variable is set to 'false' or not set, the SLP functionality |
of the OpenPegasus build. If this variable is set to 'false' or |
will not be included. All other values are considered |
not set, the SLP functionality will not be included. All other |
invalid and will result in a build error |
values are considered invalid and will result in a build error (e.g., |
(e.g., "PEGASUS_ENABLE_SLP ($(PEGASUS_ENABLE_SLP)) invalid, |
"PEGASUS_ENABLE_SLP ($(PEGASUS_ENABLE_SLP)) invalid, must be true or |
must be true or false").<br> |
false").<br> |
<b>Default Value: </b>'true' for Windows; 'false' for all other | <b>Default Value: </b>'true' for Windows; 'false' for all other |
Platforms<br> | Platforms<br> |
<b>Recommended Value (Development Build): </b>'true' for | <b>Recommended Value (Development Build): </b>'true' for |
|
|
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>PEGASUS_ENABLE_SLP requires | <b>Considerations: </b>PEGASUS_ENABLE_SLP requires |
PEGASUS_ENABLE_INTEROP_PROVIDER to be enabled. If | PEGASUS_ENABLE_INTEROP_PROVIDER to be enabled. If |
PEGASUS_ENABLE_INTEROP_PROVIDER is not set, setting |
PEGASUS_ENABLE_INTEROP_PROVIDER is not set, setting PEGASUS_ENABLE_SLP |
PEGASUS_ENABLE_SLP to true, will also enable |
to true, will also enable PEGASUS_ENABLE_INTEROP_PROVIDER. If |
PEGASUS_ENABLE_INTEROP_PROVIDER. If |
PEGASUS_ENABLE_INTEROP_PROVIDER is explicitly disabled (i.e., set to |
PEGASUS_ENABLE_INTEROP_PROVIDER is explicitly disabled |
false), a build error will be generated.<br> |
(i.e., set to false), a build error will be generated.<br> |
|
</ul> | </ul> |
| |
|
|
<h5>PEGASUS_ENABLE_SORTED_DIFF</h5> | <h5>PEGASUS_ENABLE_SORTED_DIFF</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>This controls if the DIFFSORT function |
|
is used rather than a simple DIFF of the test results files |
<b>Description: </b>This controls if the DIFFSORT function is |
to the static results file. Set to 'true' enables the sorted |
used rather than a simple DIFF of the test results files to the static |
diffs of results to static results files. Otherwise results |
results file. Set to 'true' enables the sorted diffs of results to |
in regular diffs of results to static results files. |
static results files. Otherwise results in regular diffs of results to |
See OpenPegasus bug 2283 for background information concerning |
static results files. See OpenPegasus bug 2283 for background |
this config variable. <br> |
information concerning this config variable. <br> |
<b>Default Value: </b>true<br> | <b>Default Value: </b>true<br> |
<b>Recommended Value (Development Build): </b>true<br> | <b>Recommended Value (Development Build): </b>true<br> |
<b>Recommended Value (Release Build): </b>true<br> | <b>Recommended Value (Release Build): </b>true<br> |
<b>Required: </b>No<p> </p> |
<b>Required: </b>No |
|
<p> </p> |
</ul> | </ul> |
| |
<h5>PEGASUS_ENABLE_SYSTEM_LOG_HANDER</h5> | <h5>PEGASUS_ENABLE_SYSTEM_LOG_HANDER</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>When this environment variable is set, a | <b>Description: </b>When this environment variable is set, a |
SysLog Indication Handler is built as part of the OpenPegasus | SysLog Indication Handler is built as part of the OpenPegasus |
build. The SysLog Indication Handler can be used to |
build. The SysLog Indication Handler can be used to delivered CIM |
delivered CIM Indications to the system log file.<br> |
Indications to the system log file.<br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>If PEGASUS_ENABLE_SYSTEM_LOG_HANDLER |
<b>Considerations: </b>If PEGASUS_ENABLE_SYSTEM_LOG_HANDLER is |
is not set when OpenPegasus is built, a request to create a SysLog |
not set when OpenPegasus is built, a request to create a SysLog |
Indication Handler instance will be rejected with the error | Indication Handler instance will be rejected with the error |
CIM_ERR_NOT_SUPPORTED.<br> | CIM_ERR_NOT_SUPPORTED.<br> |
</ul> | </ul> |
| |
<h5>PEGASUS_ENABLE_SSLV2</h5> |
|
<ul> |
|
<b>Description: </b>By default, support for the SSLV2 protocol |
|
is disabled in OpenPegasus. The option can be used to build a |
|
version of OpenPegasus that supports SSLV2. This variable affects |
|
how SSL contexts are constructed for both the CIM Server and CIM |
|
Clients.<br> |
|
<b>Default Value: </b>Not Set<br> |
|
<b>Recommended Value (Development Build): </b>Not Set<br> |
|
<b>Recommended Value (Release Build): </b>Not Set<br> |
|
<b>Required: </b>No<br> |
|
<b>Considerations:</b> Unless SSLV2 is required for backward |
|
compatibility, enabling this protocol is not recommended (SSLV3 |
|
or later is preferred). |
|
</ul> |
|
|
|
<h5>PEGASUS_ENABLE_USERGROUP_AUTHORIZATION</h5> | <h5>PEGASUS_ENABLE_USERGROUP_AUTHORIZATION</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>Builds a version of OpenPegasus that |
|
allows an administrator to restrict access to CIM operations |
<b>Description: </b>Builds a version of OpenPegasus that allows |
to members of a designated set of groups. Refer to the |
an administrator to restrict access to CIM operations to members of a |
<b>authorizedUserGroups</b>configuration option for additional |
designated set of groups. Refer to the <b>authorizedUserGroups</b>configuration |
details.<br> |
option for additional details.<br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>Set<br> | <b>Recommended Value (Release Build): </b>Set<br> |
|
|
</ul> | </ul> |
| |
<h5>PEGASUS_EXTRA_C_FLAGS</h5> | <h5>PEGASUS_EXTRA_C_FLAGS</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>This environment variable allows a | <b>Description: </b>This environment variable allows a |
developer to specify an additional set of flags to be included |
developer to specify an additional set of flags to be included on |
on the C compile command line.<br> |
the C compile command line.<br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>No Set<br> | <b>Recommended Value (Development Build): </b>No Set<br> |
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
|
|
</ul> | </ul> |
| |
<h5>PEGASUS_EXTRA_CXX_FLAGS</h5> | <h5>PEGASUS_EXTRA_CXX_FLAGS</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>This environment variable allows a | <b>Description: </b>This environment variable allows a |
developer to specify an additional set of flags to be included |
developer to specify an additional set of flags to be included on the |
on the C++ compile command line.<br> |
C++ compile command line.<br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
|
|
</ul> | </ul> |
| |
<h5>PEGASUS_EXTRA_LIBRARY_LINK_FLAGS</h5> | <h5>PEGASUS_EXTRA_LIBRARY_LINK_FLAGS</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>This environment variable allows a | <b>Description: </b>This environment variable allows a |
developer to specify an additional set of flags to include on |
developer to specify an additional set of flags to include on the link |
the link command line used to build a library.<br> |
command line used to build a library.<br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
|
|
</ul> | </ul> |
| |
<h5>PEGASUS_EXTRA_LINK_FLAGS</h5> | <h5>PEGASUS_EXTRA_LINK_FLAGS</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>This environment variable allows a | <b>Description: </b>This environment variable allows a |
developer to specify an additional set of flags to be included |
developer to specify an additional set of flags to be included on the |
on the link command line. These flags will be included on |
link command line. These flags will be included on both library |
both library and program executable link command lines.<br> |
and program executable link command lines.<br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
<b>Required: </b>No |
<b>Required: </b>No <b>Considerations: </b>Refer to |
<b>Considerations: </b>Refer to PEGASUS_EXTRA_LIBRARY_LINK_FLAGS and |
PEGASUS_EXTRA_LIBRARY_LINK_FLAGS and PEGASUS_EXTRA_PROGRAM_FLAGS to add |
PEGASUS_EXTRA_PROGRAM_FLAGS to add flags specific to either a |
flags specific to either a library or program link command line.<br> |
library or program link command line.<br> |
|
</ul> | </ul> |
| |
<h5>PEGASUS_EXTRA_PROGRAM_LINK_FLAGS</h5> | <h5>PEGASUS_EXTRA_PROGRAM_LINK_FLAGS</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>This environment variable allows a | <b>Description: </b>This environment variable allows a |
developer to specify an additional set of flags to include on |
developer to specify an additional set of flags to include on the link |
the link command line used to build an executable program.<br> |
command line used to build an executable program.<br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
<b>Required: </b>No | <b>Required: </b>No |
</ul> | </ul> |
| |
<h5>PEGASUS_HAS_MESSAGES</h5> | <h5>PEGASUS_HAS_MESSAGES</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>When set (to anything) during the build, | <b>Description: </b>When set (to anything) during the build, |
OpenPegasus compiles with localization support. The |
OpenPegasus compiles with localization support. The ICU (International |
ICU (International Components for Unicode) variables, |
Components for Unicode) variables, ICU_ROOT and ICU_INSTALL, indicate |
ICU_ROOT and ICU_INSTALL, indicate that the |
that the localization support is based on ICU. Only ICU is supported at |
localization support is based on ICU. Only ICU is supported |
this time.<br> |
at this time.<br> |
|
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>If the PEGASUS_HAS_MESSAGES is not |
<b>Considerations: </b>If the PEGASUS_HAS_MESSAGES is not set, |
set, OpenPegasus is built without localization support. This |
OpenPegasus is built without localization support. This means that all |
means that all messages sent by the CIM Server and the CLIs are in |
messages sent by the CIM Server and the CLIs are in English. ICU is an |
English. ICU is an open source project at |
open source project at <a href="http://oss.software.ibm.com/icu"> |
<a href="http://oss.software.ibm.com/icu"> |
http://oss.software.ibm.com/icu</a>. Only English translations are |
http://oss.software.ibm.com/icu</a>. |
included with the OpenPegasus distribution. The OpenPegasus |
Only English translations are included with the OpenPegasus |
distribution does not provide translated messages. But, enabling for |
distribution. The OpenPegasus distribution does not provide |
ICU would allow vendor to provide the translations. Refer to the |
translated messages. But, enabling for ICU would allow vendor to |
OpenPegasus Release README for additional information regarding the use |
provide the translations. Refer to the OpenPegasus Release README |
of ICU. Although, in OpenPegasus 2.3.2, experience with localization |
for additional information regarding the use of ICU. Although, in |
support has been limited to a select set of platforms, wider platform |
OpenPegasus 2.3.2, experience with localization support |
|
has been limited to a select set of platforms, wider platform |
|
adoption of this technology is planned for 2.5.<br> | adoption of this technology is planned for 2.5.<br> |
</ul> | </ul> |
| |
<h5>PEGASUS_HAS_SSL</h5> | <h5>PEGASUS_HAS_SSL</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>If set, a version of OpenPegasus that | <b>Description: </b>If set, a version of OpenPegasus that |
supports SSL (i.e., https) is built.<br> | supports SSL (i.e., https) is built.<br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
|
|
<b>Recommended Value (Release Build): </b>Set<br> | <b>Recommended Value (Release Build): </b>Set<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>Support for SSL in OpenPegasus is | <b>Considerations: </b>Support for SSL in OpenPegasus is |
dependent on the OpenSSL software developed by the |
dependent on the OpenSSL software developed by the <a href="http://www.openssl.org/"> OpenSSL Project |
<a href="http://www.openssl.org/"> |
(http://www.openssl.org/)</a>. If the PEGASUS_HAS_SSL variable is set, |
OpenSSL Project (http://www.openssl.org/)</a>. |
the variable OPENSSL_HOME must also be defined. The OPENSSL_HOME |
|
variable is used, by the OpenPegasus build, to determine the location |
If the PEGASUS_HAS_SSL variable is set, the variable OPENSSL_HOME |
of the OpenSSL include files, libraries and binaries. |
must also be defined. The OPENSSL_HOME variable is used, by the |
|
OpenPegasus build, to determine the location of the OpenSSL |
|
include files, libraries and binaries. |
|
</ul> | </ul> |
| |
<h5>PEGASUS_HOME</h5> | <h5>PEGASUS_HOME</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>Specifies the location of the |
|
OpenPegasus working directory. The OpenPegasus |
<b>Description: </b>Specifies the location of the OpenPegasus |
build will use this directory as the default location |
working directory. The OpenPegasus build will use this directory as the |
for files generated during the build (e.g., binaries, |
default location for files generated during the build (e.g., binaries, |
libraries, objects).<br> | libraries, objects).<br> |
<b>Default Value: </b>None<br> | <b>Default Value: </b>None<br> |
<b>Recommended Value (Development Build): </b> |
<b>Recommended Value (Development Build): </b> No Specific |
No Specific Recommendation<br> |
Recommendation<br> |
<b>Recommended Value (Release Build): </b> |
<b>Recommended Value (Release Build): </b> No Specific |
No Specific Recommendation<br> |
Recommendation<br> |
<b>Required: </b>Yes<br> | <b>Required: </b>Yes<br> |
<b>Considerations: </b>The error "PEGASUS_HOME |
<b>Considerations: </b>The error "PEGASUS_HOME environment |
environment variable undefined" is returned if the |
variable undefined" is returned if the PEGASUS_HOME environment |
PEGASUS_HOME environment variable is not set. |
variable is not set. This variable is also used during runtime. Refer |
This variable is also used during runtime. Refer to the section |
to the section titled "Environment Variable Settings for Running |
titled "Environment Variable Settings for Running OpenPegasus |
OpenPegasus 2.3.2 on Linux" for additional details.<br> |
2.3.2 on Linux" for additional details.<br> |
|
</ul> |
|
|
|
<h5>PEGASUS_INDICATIONS_Q_THRESHOLD</h5> |
|
<ul> |
|
<b>Description: </b>Controls if indications providers are stalled |
|
if the indications service queue is too large. It can be set |
|
to any positive value. If not set providers are never |
|
stalled. This implies that the indications service |
|
queue may become as large as necessary to hold all the |
|
indications generated. If set to any value then |
|
providers are stalled by forcing them to sleep when they |
|
try to deliver an indication and the indications service |
|
queue exceeds this value. They are resumed when the queue |
|
count falls 10 percent below this value. Stall and resume log |
|
entries are made to inform the administrator the condition has |
|
occurred.<br> |
|
<b>Default Value: </b>Not Set<br> |
|
<b>Recommended Value (Development Build): </b>Not Set<br> |
|
<b>Recommended Value (Release Build): </b>Not Set<br> |
|
<b>Required: </b>No<br> |
|
<b>Considerations: </b>Use of this setting may have |
|
unintended side-effects when using Out-of-Process Providers |
|
including delayed processing of CIM Operation Requests. |
|
</ul> | </ul> |
| |
<h5>PEGASUS_MAX_THREADS_PER_SVC_QUEUE</h5> | <h5>PEGASUS_MAX_THREADS_PER_SVC_QUEUE</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>Controls the maximum number of threads | <b>Description: </b>Controls the maximum number of threads |
allowed per message service queue. It is allowed to range |
allowed per message service queue. It is allowed to range between 1 and |
between 1 and MAX_THREADS_PER_SVC_QUEUE_LIMIT (currently 5000) |
MAX_THREADS_PER_SVC_QUEUE_LIMIT (currently 5000) as set in |
as set in pegasus/src/Pegasus/Common/MessageQueueService.cpp. |
pegasus/src/Pegasus/Common/MessageQueueService.cpp. If set to 0 (zero) |
If set to 0 (zero) the max threads per service queue is then |
the max threads per service queue is then set to |
set to MAX_THREADS_PER_SVC_QUEUE_LIMIT. If set larger than the |
MAX_THREADS_PER_SVC_QUEUE_LIMIT. If set larger than the |
MAX_THREADS_PER_SVC_QUEUE_LIMIT it is set equal to | MAX_THREADS_PER_SVC_QUEUE_LIMIT it is set equal to |
MAX_THREADS_PER_SVC_QUEUE_LIMIT. There are no other limits on the |
MAX_THREADS_PER_SVC_QUEUE_LIMIT. There are no other limits on the total |
total number of threads that can exist within the system at this |
number of threads that can exist within the system at this time. When |
time. When the server starts there on the order of 10 to 20 |
the server starts there on the order of 10 to 20 message service queues |
message service queues created dependent upon |
created dependent upon build options. <br> |
build options. <br> |
|
<b>Default Value: </b>5<br> | <b>Default Value: </b>5<br> |
<b>Recommended Value (Development Build): </b>5<br> | <b>Recommended Value (Development Build): </b>5<br> |
<b>Recommended Value (Release Build): </b>5<br> | <b>Recommended Value (Release Build): </b>5<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>This flag affects consumption of |
<b>Considerations: </b>This flag affects consumption of system |
system resources. Not setting, or inappropriately setting |
resources. Not setting, or inappropriately setting this value, may |
this value, may cause the cimserver to hang or crash.<br> |
cause the cimserver to hang or crash.<br> |
</ul> | </ul> |
| |
<h5>PEGASUS_ROOT</h5> | <h5>PEGASUS_ROOT</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>Specifies the location of the directory |
|
that corresponds to "pegasus" source directory defined in the |
<b>Description: </b>Specifies the location of the directory that |
OpenPegasus CVS source tree. This environment variable is |
corresponds to "pegasus" source directory defined in the OpenPegasus |
used by the OpenPegasus build to locate the required build |
CVS source tree. This environment variable is used by the OpenPegasus |
and source files (e.g., $(PEGASUS_ROOT)/mak and |
build to locate the required build and source files (e.g., |
$(PEGASUS_ROOT)/src).<br> |
$(PEGASUS_ROOT)/mak and $(PEGASUS_ROOT)/src).<br> |
<b>Default Value: </b>None<br> | <b>Default Value: </b>None<br> |
<b>Recommended Value (Development Build): </b> |
<b>Recommended Value (Development Build): </b> No Specific |
No Specific Recommendation<br> |
Recommendation<br> |
<b>Recommended Value (Release Build): </b> |
<b>Recommended Value (Release Build): </b> No Specific |
No Specific Recommendation<br> |
Recommendation<br> |
<b>Required: </b>Yes<br> | <b>Required: </b>Yes<br> |
<b>Considerations: </b>The error "PEGASUS_ROOT environment | <b>Considerations: </b>The error "PEGASUS_ROOT environment |
variable undefined" is returned if the PEGASUS_ROOT |
variable undefined" is returned if the PEGASUS_ROOT environment |
environment variable is not set. |
variable is not set. |
</ul> | </ul> |
| |
|
|
<h5>PEGASUS_NET_SNMP_INCLUDE_DIR</h5> | <h5>PEGASUS_NET_SNMP_INCLUDE_DIR</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>Specifies the location of the NET-SNMP |
|
<i>include</i> directory. <br> |
<b>Description: </b>Specifies the location of the NET-SNMP <i>include</i> |
|
directory. <br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b> |
<b>Recommended Value (Development Build): </b> No Specific |
No Specific Recommendation<br> |
Recommendation<br> |
<b>Recommended Value (Release Build): </b> |
<b>Recommended Value (Release Build): </b> No Specific |
No Specific Recommendation<br> |
Recommendation<br> |
<b>Required: </b>No. By default, the NET-SNMP include |
<b>Required: </b>No. By default, the NET-SNMP include files are |
files are expected to be installed in directories that |
expected to be installed in directories that are searched by default |
are searched by default (e.g., /usr/include). For platforms |
(e.g., /usr/include). For platforms where this isn't true, the |
where this isn't true, the PEGASUS_NET_SNMP_INCLUDE_DIR |
PEGASUS_NET_SNMP_INCLUDE_DIR environment variable may be used to define |
environment variable may be used to define an alternative path. |
an alternative path. This environment variable is only used if |
This environment variable is only used if PEGASUS_USE_NET_SNMP |
PEGASUS_USE_NET_SNMP is set.<br> |
is set.<br> |
|
</ul> | </ul> |
| |
<h5>PEGASUS_NET_SNMP_LIB_DIR</h5> | <h5>PEGASUS_NET_SNMP_LIB_DIR</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>Specifies the location of the NET-SNMP |
|
<i>lib </i>directory. <br> |
<b>Description: </b>Specifies the location of the NET-SNMP <i>lib |
|
</i>directory. <br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b> |
<b>Recommended Value (Development Build): </b> No Specific |
No Specific Recommendation<br> |
Recommendation<br> |
<b>Recommended Value (Release Build): </b> |
<b>Recommended Value (Release Build): </b> No Specific |
No Specific Recommendation<br> |
Recommendation<br> |
<b>Required: </b>No. By default, the NET-SNMP library is | <b>Required: </b>No. By default, the NET-SNMP library is |
expected to be installed in a directory that is searched by |
expected to be installed in a directory that is searched by default |
default (e.g., /usr/lib, /usr/lib64). For platforms where |
(e.g., /usr/lib, /usr/lib64). For platforms where this isn't true, the |
this isn't true, the PEGASUS_NET_SNMP_LIB_DIR environment |
PEGASUS_NET_SNMP_LIB_DIR environment variable may be used to define an |
variable may be used to define an alternative path. This |
alternative path. This environment variable is only used if |
environment variable is only used if PEGASUS_USE_NET_SNMP is set. |
PEGASUS_USE_NET_SNMP is set. |
</ul> | </ul> |
| |
|
|
<h5>PEGASUS_NOASSERTS</h5> | <h5>PEGASUS_NOASSERTS</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>Defines the NDEBUG compilation macro, which | <b>Description: </b>Defines the NDEBUG compilation macro, which |
causes the preprocessor to remove PEGASUS_ASSERT() statements.<br> |
causes the preprocessor to remove PEGASUS_ASSERT() and disables |
|
assertion on PEGASUS_FCT_EXECUTE_AND_ASSERT statements.<br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>Set<br> | <b>Recommended Value (Release Build): </b>Set<br> |
|
|
dependent on platform support for PAM.<br> | dependent on platform support for PAM.<br> |
</ul> | </ul> |
| |
|
<h5>PEGASUS_PAM_SESSION_SECURITY</h5> |
|
<ul> |
|
<b>Description: </b>Enables support for PAM-(Pluggable |
|
Authentication Modules) based authentication and authorization.<br> |
|
When choosing this PAM method the PAM session started through pam_start |
|
is kept open for the complete CIM request. |
|
The PAM item PAM_RHOST will be set to the connection IP address. |
|
This allows PAM modules to restrict number of concurrent connections |
|
from a single host.<br> |
|
If PEGASUS_PAM_SESSION_SECURITY is set, you cannot enable the Privilege |
|
Separation feature (PEGASUS_ENABLE_PRIVILEGE_SEPARATION) or the |
|
authentication-only PAM mechanism (PEGASUS_PAM_AUTHENTICATION).<br> |
|
<b>Default Value: </b>Not Set<br> |
|
<b>Recommended Value (Development Build): </b>Not Set<br> |
|
<b>Recommended Value (Release Build): </b>Not Set<br> |
|
<b>Required: </b>No<br> |
|
<b>Considerations: </b>Support for PAM in OpenPegasus is |
|
dependent on platform support for PAM.<br> |
|
</ul> |
|
|
|
<h5>PEGASUS_NEGOTIATE_AUTHENTICATION</h5> |
|
<ul> |
|
<b>Description: </b>If set to true enables the HTTP Negotiate |
|
authentication method, as described by RFC 4559, both to Pegasus server |
|
and client. |
|
|
|
Enabling this option also adds 1) a new option to the runtime |
|
configuration variable "httpAuthType" and 2) a new runtime variable |
|
"mapToLocalName". <br> |
|
<b>Default Value: </b>false<br> |
|
<b>Recommended Value (Development Build): </b>false<br> |
|
<b>Recommended Value (Release Build): </b>false<br> |
|
<b>Required: </b>No<br> |
|
<b>Considerations: </b>HTTP Negotiate support requires the GSSAPI |
|
development headers and libraries to build OpenPegasus, such as |
|
libgssapi_krb5 from MIT Kerberos5 implementation.<br> |
|
</ul> |
|
|
<h5>PEGASUS_PLATFORM</h5> | <h5>PEGASUS_PLATFORM</h5> |
<ul> | <ul> |
<b>Description: </b>Describes the target platform for the | <b>Description: </b>Describes the target platform for the |
|
|
following table describes the platforms documented in | following table describes the platforms documented in |
this version of the document. <br> | this version of the document. <br> |
<b>Default Value: </b>None<p> </p> | <b>Default Value: </b>None<p> </p> |
<table border="1" cellspacing="1" bordercolordark="#666666" |
<table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="542"> |
bordercolorlight="#CCCCCC" width=542 |
<tbody><tr> |
style='font-size=10.0pt;font-family:Arial'> |
<th bgcolor="#cae6ca" width="190">Platform</th> |
<tr> |
<th bgcolor="#cae6ca" width="351">Recommended Value <br> |
<th bgcolor="#CAE6CA" width="190">Platform</th> |
|
<th bgcolor="#CAE6CA" width=351>Recommended Value <br> |
|
Development Build</th> | Development Build</th> |
<th bgcolor="#CAE6CA" width=338>Recommended Value <br> |
<th bgcolor="#cae6ca" width="338">Recommended Value <br> |
Release Build</th> | Release Build</th> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="190" align="left">Linux IA32</td> |
<td align="left" width="190">Linux IA32</td> |
<td width="351">LINUX_IX86_GNU</td> | <td width="351">LINUX_IX86_GNU</td> |
<td width="338">LINUX_IX86_GNU</td> | <td width="338">LINUX_IX86_GNU</td> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="190" align="left">Linux IA64</td> |
<td align="left" width="190">Linux IA64</td> |
<td width="351">LINUX_IA64_GNU</td> | <td width="351">LINUX_IA64_GNU</td> |
<td width="338">LINUX_IA64_GNU</td> | <td width="338">LINUX_IA64_GNU</td> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="190" align="left">Linux X86_64</td> |
<td align="left" width="190">Linux X86_64</td> |
<td width="351">LINUX_X86_64_GNU</td> | <td width="351">LINUX_X86_64_GNU</td> |
<td width="338">LINUX_X86_64_GNU</td> | <td width="338">LINUX_X86_64_GNU</td> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="190" align="left">HP-UX PA-RISC</td> |
<td align="left" width="190">HP-UX PA-RISC</td> |
<td width="351">HPUX_PARISC_ACC</td> | <td width="351">HPUX_PARISC_ACC</td> |
<td width="338">HPUX_PARISC_ACC</td> | <td width="338">HPUX_PARISC_ACC</td> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="190" align="left">HP-UX IPF</td> |
<td align="left" width="190">HP-UX IPF</td> |
<td width="351">HPUX_IA64_ACC</td> | <td width="351">HPUX_IA64_ACC</td> |
<td width="338">HPUX_IA64_ACC</td> | <td width="338">HPUX_IA64_ACC</td> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="190" align="left">OpenVMS Alpha</td> |
<td align="left" width="190">OpenVMS Alpha</td> |
<td width="351">VMS_ALPHA_DECCXX</td> | <td width="351">VMS_ALPHA_DECCXX</td> |
<td width="338">VMS_ALPHA_DECCXX</td> | <td width="338">VMS_ALPHA_DECCXX</td> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="190" align="left">OpenVMS IA64</td> |
<td align="left" width="190">OpenVMS IA64</td> |
<td width="351">VMS_IA64_DECCXX</td> | <td width="351">VMS_IA64_DECCXX</td> |
<td width="338"> VMS_IA64_DECCXX</td> | <td width="338"> VMS_IA64_DECCXX</td> |
</tr> | </tr> |
</table> |
</tbody></table> |
<br><br> | <br><br> |
<b>Required: </b>Yes<br> | <b>Required: </b>Yes<br> |
<b>Considerations: </b>The error "PEGASUS_PLATFORM | <b>Considerations: </b>The error "PEGASUS_PLATFORM |
|
|
do any validity checking on the specified value, either | do any validity checking on the specified value, either |
to determine if it is a valid positive integer or if it | to determine if it is a valid positive integer or if it |
exceeds some maximum value.<br> | exceeds some maximum value.<br> |
</ul> |
</p></ul> |
| |
<h5>PEGASUS_SNIA_EXTENSIONS</h5> | <h5>PEGASUS_SNIA_EXTENSIONS</h5> |
<ul> | <ul> |
|
|
<ul> | <ul> |
<b>Description: </b>This variable is only used for | <b>Description: </b>This variable is only used for |
testing. If set to true, the IPv6-specific tests will | testing. If set to true, the IPv6-specific tests will |
be run as part of the "alltests" OpenPegasus |
be run as part of the "alltests" OpenPegasus |
TestMakefile test suite. If this variable is not set or set to | TestMakefile test suite. If this variable is not set or set to |
false, the IPv6-specific tests will not be run. All | false, the IPv6-specific tests will not be run. All |
other values are invalid.<br> | other values are invalid.<br> |
|
|
PEGASUS_TEST_USER_ID and PEGASUS_TEST_USER_PASS variables | PEGASUS_TEST_USER_ID and PEGASUS_TEST_USER_PASS variables |
defines a valid user/password pair and can be used for | defines a valid user/password pair and can be used for |
certificate-based authentication testing. These tests | certificate-based authentication testing. These tests |
also assumes that "invalidUser" is not a valid |
also assumes that "invalidUser" is not a valid |
user.<br> | user.<br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Set<br> | <b>Recommended Value (Development Build): </b>Set<br> |
|
|
</ul> | </ul> |
| |
<h5>PEGASUS_TEST_USER_ID/PEGASUS_TEST_USER_PASS</h5> | <h5>PEGASUS_TEST_USER_ID/PEGASUS_TEST_USER_PASS</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>These variables are only used for |
|
testing. These variables allow the developer to define a |
<b>Description: </b>These variables are only used for testing. |
valid, non-privileged user name and password |
These variables allow the developer to define a valid, |
on the test system that can be used as part of the OpenPegasus |
non-privileged user name and password on the test system that can |
automated test scripts to perform authentication and |
be used as part of the OpenPegasus automated test scripts to perform |
authorization testing. These variables are only used for |
authentication and authorization testing. These variables are |
testing and NOT part of the release.<br> |
only used for testing and NOT part of the release.<br> |
<b>Default Value: </b>guest/guest<br> | <b>Default Value: </b>guest/guest<br> |
<b>Recommended Value (Development Build): </b> |
<b>Recommended Value (Development Build): </b> No Recommendation<br> |
No Recommendation<br> |
|
<b>Recommended Value (Release Build): </b>Not Used<br> | <b>Recommended Value (Release Build): </b>Not Used<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
</ul> | </ul> |
| |
<h5>PEGASUS_TEST_VALGRIND_LOG_DIR</h5> | <h5>PEGASUS_TEST_VALGRIND_LOG_DIR</h5> |
|
|
<ul> | <ul> |
<b>Description: </b> |
|
This variable is currently only supported on Linux. It may be |
<b>Description: </b> This variable is currently only supported |
set to run regression tests under the |
on Linux. It may be set to run regression tests under the <a href="http://www.valgrind.org/">Valgrind</a> memory checking tool. It |
<a href="http://www.valgrind.org/">Valgrind</a> memory |
must specify a directory for writing Valgrind log files. The file name |
checking tool. It must specify a directory for writing |
format for a particular log is |
Valgrind log files. The file name format for a particular |
PEGASUS_TEST_VALGRIND_LOG_DIR/PROGRAM_NAME.pid.<br> |
log is PEGASUS_TEST_VALGRIND_LOG_DIR/PROGRAM_NAME.pid.<br> |
|
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
|
|
</ul> | </ul> |
| |
<h5>PEGASUS_TMP</h5> | <h5>PEGASUS_TMP</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>This variable is only used in a test | <b>Description: </b>This variable is only used in a test |
environment. It can be used to define the directory that |
environment. It can be used to define the directory that OpenPegasus |
OpenPegasus test programs should use to store temporary files.<br> |
test programs should use to store temporary files.<br> |
<b>Default Value: </b>"."<br> | <b>Default Value: </b>"."<br> |
<b>Recommended Value (Development Build): </b> |
<b>Recommended Value (Development Build): </b> No Specific |
No Specific Recommendation<br> |
Recommendation<br> |
<b>Recommended Value (Release Build): </b>Not Used<br> | <b>Recommended Value (Release Build): </b>Not Used<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
</ul> | </ul> |
| |
<h5>PEGASUS_USE_DEBUG_BUILD_OPTIONS</h5> | <h5>PEGASUS_USE_DEBUG_BUILD_OPTIONS</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>The PEGASUS_DEBUG flag is used to control |
|
a variety of settings, including compile options, assertion |
<b>Description: </b>The PEGASUS_DEBUG flag is used to control a |
enablement, method definitions for testing, and diagnostic |
variety of settings, including compile options, assertion enablement, |
output. The PEGASUS_USE_DEBUG_BUILD_OPTIONS variable |
method definitions for testing, and diagnostic output. The |
can be used to enable just the compiler specific debug options |
PEGASUS_USE_DEBUG_BUILD_OPTIONS variable can be used to enable just the |
(e.g., -g in g++) .<br> |
compiler specific debug options (e.g., -g in g++) .<br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Set<br> | <b>Recommended Value (Development Build): </b>Set<br> |
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>This variable is automatically set |
<b>Considerations: </b>This variable is automatically set if |
if PEGASUS_DEBUG is set.<br> |
PEGASUS_DEBUG is set.<br> |
</ul> | </ul> |
| |
<h5>PEGASUS_USE_EMANATE</h5> | <h5>PEGASUS_USE_EMANATE</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>EMANATE, |
|
<a href="http://www.snmp.com/products/emanate.html"> |
<b>Description: </b>EMANATE, <a href="http://www.snmp.com/products/emanate.html"> |
http://www.snmp.com/products/emanate.html</a>, is an SNMP Research | http://www.snmp.com/products/emanate.html</a>, is an SNMP Research |
International product that supports SNMPv1, SNMPv2c, and |
International product that supports SNMPv1, SNMPv2c, and SNMPv3. |
SNMPv3. If the PEGASUS_USE_EMANATE variable is defined, |
If the PEGASUS_USE_EMANATE variable is defined, the OpenPegasus SNMP |
the OpenPegasus SNMP Handler will use the EMANATE libraries |
Handler will use the EMANATE libraries to send traps to the SNMP |
to send traps to the SNMP Management application. |
Management application. The EMANATE libraries are NOT included as |
The EMANATE libraries are NOT included as part of OpenPegasus.<br> |
part of OpenPegasus.<br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
<b>Required: </b>No<p> |
<b>Required: </b>No |
<b>Considerations: </b>Either the PEGASUS_USE_NET_SNMP or |
<p> <b>Considerations: </b>Either the PEGASUS_USE_NET_SNMP or |
PEGASUS_USE_EMANATE variable must be set for the SNMP |
PEGASUS_USE_EMANATE variable must be set for the SNMP Handler to be |
Handler to be supported.<br> |
supported.<br> |
|
</p> |
</ul> | </ul> |
| |
|
|
<h5>PEGASUS_USE_NET_SNMP</h5> | <h5>PEGASUS_USE_NET_SNMP</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>NET-SNMP, |
|
<a href="http://net-snmp.sourceforge.net"> |
<b>Description: </b>NET-SNMP, <a href="http://net-snmp.sourceforge.net"> http://net-snmp.sourceforge.net</a>, |
http://net-snmp.sourceforge.net</a>, is an OSS |
is an OSS implementation of a suite of applications used to implement <a href="http://www.ietf.org/rfc/rfc1157.txt">SNMP v1</a>, <a href="http://www.ietf.org/rfc/rfc1901.txt">SNMP v2c</a> and <a href="http://www.ietf.org/rfc/rfc2571.txt">SNMP v3</a> using both IPv4 |
implementation of a suite of applications used to implement |
and IPv6. If the PEGASUS_USE_NET_SNMP variable is defined, |
<a href="http://www.ietf.org/rfc/rfc1157.txt">SNMP v1</a>, |
the OpenPegasus SNMP Handler will use the NET-SNMP libraries to send |
<a href="http://www.ietf.org/rfc/rfc1901.txt">SNMP v2c</a> and |
traps to the SNMP Management application. The NET-SNMP libraries |
<a href="http://www.ietf.org/rfc/rfc2571.txt">SNMP v3</a> using |
are NOT included as part of OpenPegasus.<br> |
both IPv4 and IPv6. If the PEGASUS_USE_NET_SNMP |
|
variable is defined, the OpenPegasus SNMP Handler will use |
|
the NET-SNMP libraries to send traps to the SNMP Management |
|
application. The NET-SNMP libraries are NOT included |
|
as part of OpenPegasus.<br> |
|
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>true for Linux, |
<b>Recommended Value (Release Build): </b>true for Linux, false |
false for all other platforms<br> |
for all other platforms<br> |
<b>Required: </b>No<p> |
<b>Required: </b>No |
<b>Considerations: </b>Either the PEGASUS_USE_NET_SNMP or |
<p> <b>Considerations: </b>Either the PEGASUS_USE_NET_SNMP or |
PEGASUS_USE_EMANATE variable must be set for the SNMP |
PEGASUS_USE_EMANATE variable must be set for the SNMP Handler to be |
Handler to be supported.<br> |
supported.<br> |
|
</p> |
|
</ul> |
|
|
|
<h5>PEGASUS_ENABLE_NET_SNMPV3</h5> |
|
|
|
<ul> |
|
|
|
<b>Description: </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: </b>true<br> |
|
<b>Recommended Value (Development Build): </b>true<br> |
|
<b>Recommended Value (Release Build): </b>true<br> |
|
<b>Required: </b>No |
|
<p> <b>Considerations: </b>PEGASUS_USE_NET_SNMP variable must |
|
be set.<br> |
|
</p> |
</ul> | </ul> |
| |
<h5>PEGASUS_USE_OPENSLP</h5> | <h5>PEGASUS_USE_OPENSLP</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>OpenSLP, <a href="http://www.openslp.org"> | <b>Description: </b>OpenSLP, <a href="http://www.openslp.org"> |
http://openslp.org</a>, is an open-source implementation of |
http://openslp.org</a>, is an open-source implementation of Service |
Service Location Protocol. If the PEGASUS_USE_OPENSLP variable |
Location Protocol. If the PEGASUS_USE_OPENSLP variable is defined, |
is defined, OpenPegasus will be built to use the OpenSLP |
OpenPegasus will be built to use the OpenSLP implementation of SLP |
implementation of SLP instead of the internal OpenPegasus |
instead of the internal OpenPegasus implementation of SLP. The OpenSLP |
implementation of SLP. The OpenSLP libaries are NOT included |
libaries are NOT included as part of OpenPegasus. <b>Default |
as part of OpenPegasus. |
Value: </b>Not Set<br> |
<b>Default Value: </b>Not Set<br> |
|
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>PEGASUS_ENABLE_SLP must be defined |
<b>Considerations: </b>PEGASUS_ENABLE_SLP must be defined if |
if this variable is set. |
this variable is set. |
</ul> | </ul> |
| |
<h5>PEGASUS_USE_PAM_STANDALONE_PROC</h5> | <h5>PEGASUS_USE_PAM_STANDALONE_PROC</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>Moves the processing of PAM requests from | <b>Description: </b>Moves the processing of PAM requests from |
the CIM Server process to a separate process managed by the |
the CIM Server process to a separate process managed by the CIM Server.<br> |
CIM Server.<br> |
|
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Set<br> | <b>Recommended Value (Development Build): </b>Set<br> |
<b>Recommended Value (Release Build): </b>Set<br> | <b>Recommended Value (Release Build): </b>Set<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>If PAM Authentication is enabled, |
<b>Considerations: </b>If PAM Authentication is enabled, the PAM |
the PAM API is used, during the processing of each request, to |
API is used, during the processing of each request, to authenticate the |
authenticate the client. This level of use makes the CIM Server |
client. This level of use makes the CIM Server extremely sensitive to |
extremely sensitive to memory leaks in the PAM library. In |
memory leaks in the PAM library. In addition, certain PAM modules are |
addition, certain PAM modules are not thread-safe. If your |
not thread-safe. If your platform is experiencing problems with PAM |
platform is experiencing problems with PAM Authentication, |
Authentication, use of option may provide a work-around. |
use of option may provide a work-around. |
PEGASUS_USE_PAM_STANDALONE_PROC requires PEGASUS_PAM_AUTHENTICATION to |
PEGASUS_USE_PAM_STANDALONE_PROC requires |
be set.<br> |
PEGASUS_PAM_AUTHENTICATION to be set.<br> |
|
</ul> | </ul> |
| |
<h5>PEGASUS_USE_RELEASE_CONFIG_OPTIONS</h5> | <h5>PEGASUS_USE_RELEASE_CONFIG_OPTIONS</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>If set, OpenPegasus is built using |
|
the "Release Build" configuration options. By default, |
<b>Description: </b>If set, OpenPegasus is built using the |
OpenPegasus is built using the "Development Build" |
"Release Build" configuration options. By default, OpenPegasus is built |
configuration options.<br> |
using the "Development Build" configuration options.<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> |
<b>Recommended Value (Release Build): </b>true<br> | <b>Recommended Value (Release Build): </b>true<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>(1)The |
<b>Considerations: </b>(1)The PEGASUS_USE_RELEASE_CONFIG_OPTIONS |
PEGASUS_USE_RELEASE_CONFIG_OPTIONS variable allows a platform |
variable allows a platform vendor to easily toggle between two sets of |
vendor to easily toggle between two sets of configurations |
configurations options, a set of options tuned for the |
options, a set of options tuned for the development/debug |
development/debug ("Development Build") environment and a set of |
("Development Build") environment and a set of options |
options tuned for the production environment ("Release Build"). Refer |
tuned for the production environment ("Release Build"). |
the section titled "Configuration Properties" for additional |
Refer the section titled "Configuration Properties" for |
detail. (2) For each configuration variable, the |
additional detail. (2) For each configuration |
"Recommended Value (Release Build)" value defines the recommended |
variable, the "Recommended Value (Release Build)" |
settings to use for a "Release Build". Please refer to the |
value defines the recommended settings to use for a |
|
"Release Build". Please refer to the |
|
description of each variable for additional information. | description of each variable for additional information. |
</ul> | </ul> |
| |
<h5>PEGASUS_USE_RELEASE_DIRS</h5> | <h5>PEGASUS_USE_RELEASE_DIRS</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>If set, OpenPegasus is built using |
|
the "Release Build" directory definitions. By default, |
<b>Description: </b>If set, OpenPegasus is built using the |
OpenPegasus is built using the "Development Build" |
"Release Build" directory definitions. By default, OpenPegasus is built |
directory definitions.<br> |
using the "Development Build" directory definitions.<br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b>Not Set<br> | <b>Recommended Value (Development Build): </b>Not Set<br> |
<b>Recommended Value (Release Build): </b>Set<br> | <b>Recommended Value (Release Build): </b>Set<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b> |
<b>Considerations: </b> The PEGASUS_USE_RELEASE_DIRS variable |
The PEGASUS_USE_RELEASE_DIRS variable allows a platform |
allows a platform vendor to easily toggle between two sets of directory |
vendor to easily toggle between two sets of directory |
definitions, a set tuned for the development/debug ("Development |
definitions, a set tuned for the development/debug |
Build") environment and a set tuned for the production environment |
("Development Build") environment and a set tuned for the |
("Release Build"). Refer the section titled "Configuration Properties" |
production environment ("Release Build"). Refer the section |
for additional detail.<br> |
titled "Configuration Properties" for additional detail.<br> |
</ul> |
|
|
|
<h5>PEGASUS_FLAVOR</h5> |
|
|
|
<ul> |
|
|
|
<b>Description: </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: </b>tog<br> |
|
<b>Recommended Value (Development Build): </b>tog<br> |
|
<b>Recommended Value (Release Build): </b>tog<br> |
|
<b>Required: </b>No<br> |
|
<b>Considerations: </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: </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: </b>Not set<br> |
|
<b>Recommended Value (Development Build): </b>Not set<br> |
|
<b>Recommended Value (Release Build): </b>Not set<br> |
|
<b>Required: </b>No<br> |
|
<b>Considerations: </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> | </ul> |
| |
<h5>PEGASUS_USE_SQLITE_REPOSITORY</h5> | <h5>PEGASUS_USE_SQLITE_REPOSITORY</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>If true, new repository stores are created | <b>Description: </b>If true, new repository stores are created |
using a SQLite database. Existing file-based stores will continue |
using a SQLite database. Existing file-based stores will continue to be |
to be recognized and operate seamlessly.<br> |
recognized and operate seamlessly.<br> |
<b>Default Value: </b>false<br> | <b>Default Value: </b>false<br> |
<b>Recommended Value (Development Build): </b>true<br> | <b>Recommended Value (Development Build): </b>true<br> |
<b>Recommended Value (Release Build): </b>true<br> | <b>Recommended Value (Release Build): </b>true<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>If PEGASUS_USE_SQLITE_REPOSITORY is set to true |
<b>Considerations: </b>If PEGASUS_USE_SQLITE_REPOSITORY is set |
and SQLite files are not installed in default search locations, |
to true and SQLite files are not installed in default search locations, |
SQLITE_HOME must also be configured. | SQLITE_HOME must also be configured. |
PEGASUS_REPOSITORY_STORE_COMPLETE_CLASSES may not be set to true when | PEGASUS_REPOSITORY_STORE_COMPLETE_CLASSES may not be set to true when |
PEGASUS_USE_SQLITE_REPOSITORY is set to true. | PEGASUS_USE_SQLITE_REPOSITORY is set to true. |
</ul> | </ul> |
| |
<h5>PEGASUS_USE_SYSLOGS</h5> | <h5>PEGASUS_USE_SYSLOGS</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>If set, OpenPegasus will be built |
|
to send log messages to the system logger (syslog). |
<b>Description: </b>If set, OpenPegasus will be built to send |
Otherwise, log messages will be sent to OpenPegasus |
log messages to the system logger (syslog). Otherwise, log messages |
specific log files.<br> |
will be sent to OpenPegasus specific log files.<br> |
<b>Recommended Value (Development Build): </b>Set<br> | <b>Recommended Value (Development Build): </b>Set<br> |
<b>Recommended Value (Release Build): </b>Set<br> | <b>Recommended Value (Release Build): </b>Set<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>This variable is currently |
<b>Considerations: </b>This variable is currently not |
not implemented as an environment variable. To use |
implemented as an environment variable. To use the option |
the option -DPEGASUS_USE_SYSLOGS must |
-DPEGASUS_USE_SYSLOGS must be explicitly included in the appropriate |
be explicitly included in the appropriate platform |
platform makefile (pegasus/mak/platform_*.mak). |
makefile (pegasus/mak/platform_*.mak).</ul> |
</ul> |
| |
<h5>PEGASUS_WINDOWS_SDK_HOME</h5> | <h5>PEGASUS_WINDOWS_SDK_HOME</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>This variable should be set to point |
|
to the Microsoft Platform SDK on Windows if using a compiler |
<b>Description: </b>This variable should be set to point to the |
version < 1300 (i.e. VC6). If using VC7 or VC8, this flag |
Microsoft Platform SDK on Windows if using a compiler version < 1300 |
does not need to be set, as the necessary libraries are already |
(i.e. VC6). If using VC7 or VC8, this flag does not need to be set, as |
included.<br> |
the necessary libraries are already included.<br> |
<b>Recommended Value (Development Build): </b> |
<b>Recommended Value (Development Build): </b> No Specific |
No Specific Recommendation<br> |
Recommendation<br> |
<b>Recommended Value (Release Build): </b> |
<b>Recommended Value (Release Build): </b> No Specific |
No Specific Recommendation<br> |
Recommendation<br> |
<b>Required: </b>Yes, if building on Windows with a |
<b>Required: </b>Yes, if building on Windows with a compiler |
compiler version < 1300.<br> |
version < 1300.<br> |
</ul> | </ul> |
| |
<h5>SQLITE_HOME</h5> | <h5>SQLITE_HOME</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>Specifies the location of the SQLite SDK directory. |
|
This directory must contain sqlite3.h in the $(SQLITE_HOME)/include |
<b>Description: </b>Specifies the location of the SQLite SDK |
directory, and libsqlite3 in the $(SQLITE_HOME)/lib directory.<br> |
directory. This directory must contain sqlite3.h in the |
|
$(SQLITE_HOME)/include directory, and libsqlite3 in the |
|
$(SQLITE_HOME)/lib directory.<br> |
<b>Default Value: </b>Not Set<br> | <b>Default Value: </b>Not Set<br> |
<b>Recommended Value (Development Build): </b> |
<b>Recommended Value (Development Build): </b> No Specific |
No Specific Recommendation<br> |
Recommendation<br> |
<b>Recommended Value (Release Build): </b> |
<b>Recommended Value (Release Build): </b> No Specific |
No Specific Recommendation<br> |
Recommendation<br> |
<b>Required: </b>Yes, if PEGASUS_USE_SQLITE_REPOSITORY is set to true |
<b>Required: </b>Yes, if PEGASUS_USE_SQLITE_REPOSITORY is set to |
and the SQLite files are not installed in locations that are searched by |
true and the SQLite files are not installed in locations that are |
default.<br> |
searched by default.<br> |
<b>Considerations: </b>This environment variable is only used if | <b>Considerations: </b>This environment variable is only used if |
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: </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: </b>262144<br> |
|
<b>Recommended Value (Development Build): </b>262144<br> |
|
<b>Recommended Value (Release Build): </b>262144<br> |
|
<b>Required: </b>No |
|
</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> |
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_DEBUG=TRUE<br> | export PEGASUS_DEBUG=TRUE<br> |
export ENABLE_CMPI_PROVIDER_MANAGER=true<br> | export ENABLE_CMPI_PROVIDER_MANAGER=true<br> |
export PEGASUS_USE_SYSLOGS=true<br> | export PEGASUS_USE_SYSLOGS=true<br> |
export PATH=/home/pegasusbld:/home/pegasusbld/pegasus/build/bin:/usr/local/bin:$PATH<br> |
export |
|
PATH=/home/pegasusbld:/home/pegasusbld/pegasus/build/bin:/usr/local/bin:$PATH<br> |
</ul> | </ul> |
| |
<h4>Building a Linux IA32 (#IA64) Production Release Version</h4> | <h4>Building a Linux IA32 (#IA64) Production Release Version</h4> |
|
|
<ul> | <ul> |
|
|
export PEGASUS_ROOT=/home/pegasusbld/pegasus<br> | export PEGASUS_ROOT=/home/pegasusbld/pegasus<br> |
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> |
|
|
export ENABLE_CMPI_PROVIDER_MANAGER=true<br> | export ENABLE_CMPI_PROVIDER_MANAGER=true<br> |
export PEGASUS_ENABLE_USERGROUP_AUTHORIZATION=true<br> | export PEGASUS_ENABLE_USERGROUP_AUTHORIZATION=true<br> |
export PEGASUS_USE_SYSLOGS=true<br> | export PEGASUS_USE_SYSLOGS=true<br> |
export PATH=/home/pegasusbld:/home/pegasusbld/pegasus/build/bin:/usr/local/bin:$PATH<br> |
export |
|
PATH=/home/pegasusbld:/home/pegasusbld/pegasus/build/bin:/usr/local/bin:$PATH<br> |
</ul> | </ul> |
| |
<h3>Environment Variable Settings for <u>Running</u> OpenPegasus</h3> | <h3>Environment Variable Settings for <u>Running</u> OpenPegasus</h3> |
|
|
<h4>Definitions</h4> | <h4>Definitions</h4> |
| |
<h5>PEGASUS_HOME</h5> | <h5>PEGASUS_HOME</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>There are multiple options for |
|
configuring the location of OpenPegasus runtime |
<b>Description: </b>There are multiple options for configuring |
files (e.g., configuration files, libraries, |
the location of OpenPegasus runtime files (e.g., configuration files, |
repository, executables). If no other option is |
libraries, repository, executables). If no other option is specified, |
specified, OpenPegasus will attempt to use the value |
OpenPegasus will attempt to use the value PEGASUS_HOME.<br> |
PEGASUS_HOME.<br> |
|
<b>Default Value: </b>"."<br> | <b>Default Value: </b>"."<br> |
<b>Recommended Value (Development Build): </b> |
<b>Recommended Value (Development Build): </b> The same value |
The same value defined at build time.<br> |
defined at build time.<br> |
<b>Recommended Value (Release Build): </b>Not Set<br> | <b>Recommended Value (Release Build): </b>Not Set<br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
<b>Considerations: </b>Although this variable can be |
<b>Considerations: </b>Although this variable can be useful in a |
useful in a development environment use of this environment |
development environment use of this environment variable is not |
variable is not recommended in a production environment. |
recommended in a production environment. Instead, the use of |
Instead, the use of configuration properties to explicitly |
configuration properties to explicitly set the location of runtime |
set the location of runtime files and directories is recommended. |
files and directories is recommended. |
</ul> | </ul> |
| |
<h5>PEGASUS_MSG_HOME</h5> | <h5>PEGASUS_MSG_HOME</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>This value is not used by the CIM | <b>Description: </b>This value is not used by the CIM |
Server. The CIM Server uses the messageDir configuration | Server. The CIM Server uses the messageDir configuration |
parameter to locate the directory where the ICU resource bundles. | parameter to locate the directory where the ICU resource bundles. |
However, CIM Client applications must rely on an alternative |
However, CIM Client applications must rely on an alternative mechanism |
mechanism to locate this directory.<br> |
to locate this directory.<br> |
<b>Default Value: </b>if $PEGASUS_HOME is set then | <b>Default Value: </b>if $PEGASUS_HOME is set then |
"$PEGASUS_HOME/msg" else "."<br> |
"$PEGASUS_HOME/msg" else "."<br> |
<b>Recommended Value (Development Build): </b>$PEGASUS_HOME/msg<br> | <b>Recommended Value (Development Build): </b>$PEGASUS_HOME/msg<br> |
<b>Recommended Value (Release Build): </b>Not Set <br> | <b>Recommended Value (Release Build): </b>Not Set <br> |
<b>Required: </b>No<br> | <b>Required: </b>No<br> |
|
|
<ul> | <ul> |
| |
<h5>Default Value</h5> | <h5>Default Value</h5> |
The value of <i>Default Value</i> is the OpenPegasus |
The value of <i>Default Value</i> is the OpenPegasus default setting |
default setting for this configuration option. This |
for this configuration option. This value is used if a |
value is used if a platform-specific setting is not |
platform-specific setting is not defined. |
defined. |
|
|
|
<h5>Recommended Default Value</h5> | <h5>Recommended Default Value</h5> |
The PEGASUS_USE_RELEASE_CONFIG_OPTIONS variable allows a |
The PEGASUS_USE_RELEASE_CONFIG_OPTIONS variable allows a platform |
platform vendor to easily toggle between two sets of |
vendor to easily toggle between two sets of configurations options, a |
configurations options, a set of options tuned for the |
set of options tuned for the development/debug ("Development Build") |
development/debug ("Development Build") environment |
environment and a set of options tuned for the production environment |
and a set of options tuned for the production environment |
("Release Build"). The value of <i>Recommended Value (Development |
("Release Build"). The value of |
Build)</i> is the recommended default value for use in a development/ |
<i>Recommended Value (Development Build)</i> |
debug environment. The value of <i>Recommended Value (Release Build)</i> |
is the recommended default value for use in a development/ |
is the recommended default value for use in a production environment. |
debug environment. The value of |
|
<i>Recommended Value (Release Build)</i> is the recommended |
|
default value for use in a production environment. |
|
|
|
<h5>Recommend To Be Fixed/Hidden</h5> | <h5>Recommend To Be Fixed/Hidden</h5> |
Configuration options can be defined as fixed or hidden. |
Configuration options can be defined as fixed or hidden. A "fix" |
A "fix" configuration option is set at build time |
configuration option is set at build time and cannot be changed without |
and cannot be changed without rebuilding. "Fixed" |
rebuilding. "Fixed" configuration options are not displayed using the |
configuration options are not displayed using the cimconfig |
cimconfig command. This feature can be used by vendors to limit |
command. This feature can be used by vendors to limit |
OpenPegasus functionality and configurability. A "hidden" configuration |
OpenPegasus functionality and configurability. |
option is an option that is configurable (i.e., "not fixed"), but not |
|
externally advertised using the cimconfig command. The "hidden" feature |
A "hidden" configuration option is an option that is |
can be used to define "internal use only" configuration options. |
configurable (i.e., "not fixed"), but not externally |
|
advertised using the cimconfig command. The "hidden" |
|
feature can be used to define "internal use only" |
|
configuration options. |
|
|
|
<h5>Dynamic?</h5> | <h5>Dynamic?</h5> |
If yes, the value of the configuration option can be |
If yes, the value of the configuration option can be changed without |
changed without stopping and restarting the CIM Server. |
stopping and restarting the CIM Server. |
|
|
<h5>Directory Specifications</h5> | <h5>Directory Specifications</h5> |
<p>Note that the variables included in the following table |
<p>Note that the variables included in the following table (e.g., |
(e.g., $LOGDIR) are for documentation purposes only and |
$LOGDIR) are for documentation purposes only and have been defined to |
have been defined to simplify the description of the |
simplify the description of the configuration options. In |
configuration options. In particular, |
particular, these variables DO NOT correspond to environment variables |
these variables DO NOT correspond to environment variables |
implemented in the OpenPegasus code. Default values for the |
implemented in the OpenPegasus code. Default values |
following variables are platform and vendor dependent and not |
for the following variables are platform |
documented in this document.</p> |
and vendor dependent and not documented in this document.</p> |
<table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" height="228" width="148"> |
|
<tbody> |
<table border="1" cellspacing="1" bordercolordark="#666666" |
|
bordercolorlight="#CCCCCC" width=148 |
|
style='font-size=10.0pt;font-family:Arial' height="228"> |
|
<tr> | <tr> |
<th bgcolor="#CAE6CA" width=1 height="16"> </th> |
<th bgcolor="#cae6ca" height="16" width="1"> </th> |
|
</tr> |
|
<tr align="center"> |
|
<td align="left" height="12" width="1">$LOGDIR</td> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td align="left" width="1" height="12">$LOGDIR</td> |
<td align="left" height="14" width="1">$PROVIDERDIRS</td> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td align="left" width="1" height="14">$PROVIDERDIRS</td> |
<td align="left" height="14" width="1"> $PROVIDERMANAGERDIRS</td> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td align="left" width="1" height="14"> |
<td align="left" height="14" width="1">$REPOSITORYDIR </td> |
$PROVIDERMANAGERDIRS</td> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td align="left" width="1" height="14">$REPOSITORYDIR </td> |
<td align="left" height="14" width="1">$CERTIFICATEDIR </td> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td align="left" width="1" height="14">$CERTIFICATEDIR |
<td align="left" height="14" width="1">$LOCALAUTHDIR</td> |
</td> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td align="left" width="1" height="14">$LOCALAUTHDIR</td> |
<td align="left" height="14" width="1">$TRACEDIR</td> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td align="left" width="1" height="14">$TRACEDIR</td> |
<td align="left" height="14" width="1">$CONFIGDIR</td> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td align="left" width="1" height="14">$CONFIGDIR</td> |
<td align="left" height="14" width="1">$PIDFILE</td> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td align="left" width="1" height="14">$PIDFILE</td> |
<td align="left" height="14" width="1">$RANDOMDIR</td> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td align="left" width="1" height="14">$RANDOMDIR</td> |
<td align="left" height="14" width="1">$SOCKETDIR</td> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td align="left" width="1" height="14">$SOCKETDIR</td> |
<td align="left" height="14" width="1">$MESSAGEDIR</td> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td align="left" width="1" height="14">$MESSAGEDIR</td> |
<td align="left" height="14" width="1">$WEBCONFDIR</td> |
</tr> | </tr> |
|
</tbody> |
</table> | </table> |
</ul> | </ul> |
| |
<h4>Definitions</h4> | <h4>Definitions</h4> |
| |
<h5>authorizedUserGroups</h5> | <h5>authorizedUserGroups</h5> |
|
|
<ul> | <ul> |
<b>Description:</b> If the <b>authorizedUserGroups</b> |
|
property is set, the value is interpreted as a list of |
<b>Description:</b> If the <b>authorizedUserGroups</b> property |
comma-separated user groups whose members may issue CIM |
is set, the value is interpreted as a list of comma-separated user |
requests. A user who is not a member of any of these groups is |
groups whose members may issue CIM requests. A user who is not a member |
restricted from issuing CIM requests, with the exception of |
of any of these groups is restricted from issuing CIM requests, with |
privileged users (root user). If the <b>authorizedUserGroups</b> |
the exception of privileged users (root user). If the <b>authorizedUserGroups</b> |
property is not set, any user may issue CIM requests.<br> | property is not set, any user may issue CIM requests.<br> |
<b>Default Value: </b>blank<br> | <b>Default Value: </b>blank<br> |
<b>Recommended Default Value (Development Build): </b>blank<br> | <b>Recommended Default Value (Development Build): </b>blank<br> |
<b>Recommended Default Value (Release Build): </b>blank<br> | <b>Recommended Default Value (Release Build): </b>blank<br> |
<b>Recommend To Be Fixed/Hidden (Development Build): </b> |
<b>Recommend To Be Fixed/Hidden (Development Build): </b> No/No<br> |
No/No<br> |
|
<b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> | <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
<b>Dynamic?: </b>No<br> | <b>Dynamic?: </b>No<br> |
<b>Example: </b> |
<b>Example: </b> #cimconfig -s |
#cimconfig -s authorizedUserGroups=users,systemusers -p<br> |
authorizedUserGroups=users,systemusers -p<br> |
<b>Considerations: </b>This feature is available only when |
<b>Considerations: </b>This feature is available only when the |
the OpenPegasus source is compiled with the flag |
OpenPegasus source is compiled with the flag |
PEGASUS_ENABLE_USERGROUP_AUTHORIZATION set. | PEGASUS_ENABLE_USERGROUP_AUTHORIZATION set. |
</ul> | </ul> |
| |
<h5>daemon</h5> | <h5>daemon</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>This option enables/disables forking of |
|
the code to create a background daemon process.<br> |
<b>Description: </b>This option enables/disables forking of the |
|
code to create a background daemon process.<br> |
<b>Default Value: </b>true<br> | <b>Default Value: </b>true<br> |
<b>Recommended Default Value (Development Build): </b>true<br> | <b>Recommended Default Value (Development Build): </b>true<br> |
<b>Recommended Default Value (Release Build): </b>true<br> | <b>Recommended Default Value (Release Build): </b>true<br> |
<b>Recommend To Be Fixed/Hidden (Development Build): </b> |
<b>Recommend To Be Fixed/Hidden (Development Build): </b> No/No<br> |
No/No<br> |
<b>Recommend To Be Fixed/Hidden (Release Build): </b> No/Yes<br> |
<b>Recommend To Be Fixed/Hidden (Release Build): </b> |
<b>Dynamic?: </b>No |
No/Yes<br> |
<p> <br> |
<b>Dynamic?: </b>No<p> <br> |
|
<br> | <br> |
<table border="1" cellspacing="1" bordercolordark="#666666" |
<table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> |
bordercolorlight="#CCCCCC" width=531 |
<tbody> |
style='font-size=10.0pt;font-family:Arial'> |
|
<tr> | <tr> |
<th bgcolor="#CAE6CA" width="168">Platform</th> |
<th bgcolor="#cae6ca" width="168">Platform</th> |
<th bgcolor="#CAE6CA" width=350>Source Configuration File</th> |
<th bgcolor="#cae6ca" width="350">Source Configuration File</th> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">Linux</td> | <td width="168">Linux</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td> |
Pegasus/Config/DefaultPropertyTableLinux.h</td> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">HP-UX</td> | <td width="168">HP-UX</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td> |
Pegasus/Config/DefaultPropertyTableHpux.h</td> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">OpenVMS</td> | <td width="168">OpenVMS</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td> |
Pegasus/Config/DefaultPropertyTableVms.h</td> |
|
</tr> | </tr> |
|
</tbody> |
</table> | </table> |
|
</p> |
</ul> | </ul> |
| |
<h5>enableAssociationTraversal</h5> | <h5>enableAssociationTraversal</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>If true, the CIM Server will support |
|
the four association traversal operators: Associators, |
<b>Description: </b>If true, the CIM Server will support the |
|
four association traversal operators: Associators, |
AssociatorNames,References, and ReferenceNames.<br> | AssociatorNames,References, and ReferenceNames.<br> |
<b>Default Value: </b>true<br> | <b>Default Value: </b>true<br> |
<b>Recommended Default Value (Development Build): </b>true<br> | <b>Recommended Default Value (Development Build): </b>true<br> |
<b>Recommended Default Value (Release Build): </b>true<br> | <b>Recommended Default Value (Release Build): </b>true<br> |
<b>Recommend To Be Fixed/Hidden (Development Build): </b> |
<b>Recommend To Be Fixed/Hidden (Development Build): </b> No/No<br> |
No/No<br> |
|
<b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> | <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
<b>Dynamic?: </b>No<br> | <b>Dynamic?: </b>No<br> |
<b>Considerations: </b>There is still an outstanding |
<b>Considerations: </b>There is still an outstanding Provider |
Provider Registration issue that restricts the degree to |
Registration issue that restricts the degree to which separate |
which separate Providers can register for Associations.<br> |
Providers can register for Associations.<br> |
<br> | <br> |
<table border="1" cellspacing="1" bordercolordark="#666666" |
<table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> |
bordercolorlight="#CCCCCC" width=531 |
<tbody> |
style='font-size=10.0pt;font-family:Arial'> |
|
<tr> | <tr> |
<th bgcolor="#CAE6CA" width="168">Platform</th> |
<th bgcolor="#cae6ca" width="168">Platform</th> |
<th bgcolor="#CAE6CA" width=350>Source Configuration File</th> |
<th bgcolor="#cae6ca" width="350">Source Configuration File</th> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">Linux</td> | <td width="168">Linux</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td> |
Pegasus/Config/DefaultPropertyTableLinux.h</td> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">HP-UX</td> | <td width="168">HP-UX</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td> |
Pegasus/Config/DefaultPropertyTableHpux.h</td> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">OpenVMS</td> | <td width="168">OpenVMS</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td> |
Pegasus/Config/DefaultPropertyTableVms.h</td> |
|
</tr> | </tr> |
|
</tbody> |
</table> | </table> |
</ul> | </ul> |
| |
<h5>enableAuditLog</h5> | <h5>enableAuditLog</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>Used to enable or disable audit |
|
logging at run time. If true, audit logging will be enabled.<br> |
<b>Description: </b>Used to enable or disable audit logging at |
|
run time. If true, audit logging will be enabled.<br> |
<b>Recommended Default Value (Development Build): </b>false<br> | <b>Recommended Default Value (Development Build): </b>false<br> |
<b>Recommended Default Value (Release Build): </b>false<br> | <b>Recommended Default Value (Release Build): </b>false<br> |
<b>Recommend To Be Fixed/Hidden (Development Build): </b> |
<b>Recommend To Be Fixed/Hidden (Development Build): </b> No/No<br> |
No/No<br> |
|
<b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> | <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
<b>Dynamic?: </b>Yes<br> | <b>Dynamic?: </b>Yes<br> |
<b>Source Configuration File: </b> | <b>Source Configuration File: </b> |
|
|
</ul> | </ul> |
| |
<h5>enableAuthentication</h5> | <h5>enableAuthentication</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>If true, a Client must be authenticated |
|
to access the CIM Server.<br> |
<b>Description: </b>If true, a Client must be authenticated to |
|
access the CIM Server.<br> |
<b>Recommended Default Value (Development Build): </b>false<br> | <b>Recommended Default Value (Development Build): </b>false<br> |
<b>Recommended Default Value (Release Build): </b>true<br> | <b>Recommended Default Value (Release Build): </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> |
|
|
</ul> | </ul> |
| |
<h5>enableBinaryRepository</h5> | <h5>enableBinaryRepository</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>Setting this to true will activate the | <b>Description: </b>Setting this to true will activate the |
binary repository support on the next restart of cimserver.<br> | binary repository support on the next restart of cimserver.<br> |
<b>Recommended Default Value (Development Build): </b>false<br> | <b>Recommended Default Value (Development Build): </b>false<br> |
|
|
<b>Recommend To Be Fixed/Hidden (Development Build): </b>Yes<br> | <b>Recommend To Be Fixed/Hidden (Development Build): </b>Yes<br> |
<b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> | <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> |
<b>Dynamic?: </b>No<br> | <b>Dynamic?: </b>No<br> |
<b>Considerations: </b>Repositories containing a mixture |
<b>Considerations: </b>Repositories containing a mixture of |
of binary and XML objects are supported.<br> |
binary and XML objects are supported.<br> |
<b>Source Configuration File: </b> | <b>Source Configuration File: </b> |
Pegasus/Config/RepositoryPropertyOwner.cpp</p> |
Pegasus/Config/RepositoryPropertyOwner.cpp |
</ul> | </ul> |
| |
|
|
<h5>enableHttpConnection</h5> | <h5>enableHttpConnection</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>If true, allows connections to |
|
the CIM Server using the HTTP protocol<br> |
<b>Description: </b>If true, allows connections to the CIM |
|
Server using the HTTP protocol<br> |
<b>Default Value: </b>true<br> | <b>Default Value: </b>true<br> |
<b>Recommended Default Value (Development Build): </b>true<br> | <b>Recommended Default Value (Development Build): </b>true<br> |
<b>Recommended Default Value (Release Build): </b>false<br> | <b>Recommended Default Value (Release Build): </b>false<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): </b>No/No<br> | <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
<b>Dynamic?: </b>No<br> | <b>Dynamic?: </b>No<br> |
<b>Considerations: </b> |
<b>Considerations: </b> Enabling HTTP will allow clients to |
Enabling HTTP will allow clients to connect with security |
connect with security properties different than those associated with |
properties different than those associated with encrypted SSL |
encrypted SSL traffic, and its configured SSL authentication or other |
traffic, and its configured SSL authentication or other security |
security behavior. This option should only be enabled in environments |
behavior. This option should only be enabled in environments |
where sending the HTTP Request and HTTP Response as clear text messages |
where sending the HTTP Request and HTTP Response as |
does not introduce a security risk. Note that if authentication |
clear text messages does not introduce a security risk. |
is enabled (enableAuthentication), user names and passwords will be |
Note that if authentication is enabled (enableAuthentication), |
included in the text of the HTTP message.<br> |
user names and passwords will be included in the text of the |
|
HTTP message.<br> |
|
<br> | <br> |
<table border="1" cellspacing="1" bordercolordark="#666666" |
<table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> |
bordercolorlight="#CCCCCC" width=531 |
<tbody> |
style='font-size=10.0pt;font-family:Arial'> |
|
<tr> | <tr> |
<th bgcolor="#CAE6CA" width="168">Platform</th> |
<th bgcolor="#cae6ca" width="168">Platform</th> |
<th bgcolor="#CAE6CA" width=350>Source Configuration File</th> |
<th bgcolor="#cae6ca" width="350">Source Configuration File</th> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">Linux</td> | <td width="168">Linux</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td> |
Pegasus/Config/DefaultPropertyTableLinux.h</td> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">HP-UX</td> | <td width="168">HP-UX</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td> |
Pegasus/Config/DefaultPropertyTableHpux.h</td> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">OpenVMS</td> | <td width="168">OpenVMS</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td> |
Pegasus/Config/DefaultPropertyTableVms.h</td> |
|
</tr> | </tr> |
|
</tbody> |
</table> | </table> |
</ul> | </ul> |
| |
<h5>enableHttpsConnection</h5> | <h5>enableHttpsConnection</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>If true, allows connections to |
|
the CIM Server using the HTTPS protocol (HTTP using |
<b>Description: </b>If true, allows connections to the CIM |
Secure Socket Layer encryption)<br> |
Server using the HTTPS protocol (HTTP using Secure Socket Layer |
|
encryption)<br> |
<b>Default Value: </b>false<br> | <b>Default Value: </b>false<br> |
<b>Recommended Default Value (Development Build): </b>true<br> | <b>Recommended Default Value (Development Build): </b>true<br> |
<b>Recommended Default Value (Release Build): </b>true<br> | <b>Recommended Default Value (Release Build): </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): </b>No/No<br> | <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
<b>Dynamic?: </b>No<br> | <b>Dynamic?: </b>No<br> |
<b>Considerations: </b>For this option to work, |
<b>Considerations: </b>For this option to work, the environment |
the environment variable PEGASUS_HAS_SSL must have |
variable PEGASUS_HAS_SSL must have been set when CIM Server was built.<br> |
been set when CIM Server was built.<br> |
|
<br> | <br> |
<table border="1" cellspacing="1" bordercolordark="#666666" |
<table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> |
bordercolorlight="#CCCCCC" width=531 |
<tbody> |
style='font-size=10.0pt;font-family:Arial'> |
|
<tr> | <tr> |
<th bgcolor="#CAE6CA" width="168">Platform</th> |
<th bgcolor="#cae6ca" width="168">Platform</th> |
<th bgcolor="#CAE6CA" width=350>Source Configuration File</th> |
<th bgcolor="#cae6ca" width="350">Source Configuration File</th> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">Linux</td> | <td width="168">Linux</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td> |
Pegasus/Config/DefaultPropertyTableLinux.h</td> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">HP-UX</td> | <td width="168">HP-UX</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td> |
Pegasus/Config/DefaultPropertyTableHpux.h</td> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">OpenVMS</td> | <td width="168">OpenVMS</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td> |
Pegasus/Config/DefaultPropertyTableVms.h</td> |
|
</tr> | </tr> |
|
</tbody> |
</table> | </table> |
</ul> | </ul> |
| |
<h5>enableIndicationService</h5> | <h5>enableIndicationService</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>If true, the CIM Server will support |
|
CIM Indications.<br> |
<b>Description: </b>If true, the CIM Server will support CIM |
|
Indications.<br> |
<b>Default Value: </b>true<br> | <b>Default Value: </b>true<br> |
<b>Recommended Default Value (Development Build): </b>true<br> | <b>Recommended Default Value (Development Build): </b>true<br> |
<b>Recommended Default Value (Release Build): </b>true<br> | <b>Recommended Default Value (Release Build): </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): </b>No/No<br> | <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
<b>Dynamic?: </b>No<p> <br> |
<b>Dynamic?: </b>Yes/No<br> |
|
<b>Considerations: </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 bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> |
bordercolorlight="#CCCCCC" width=531 |
<tbody> |
style='font-size=10.0pt;font-family:Arial'> |
|
<tr> | <tr> |
<th bgcolor="#CAE6CA" width="168">Platform</th> |
<th bgcolor="#cae6ca" width="168">Platform</th> |
<th bgcolor="#CAE6CA" width=350>Source Configuration File</th> |
<th bgcolor="#cae6ca" width="350">Source Configuration File</th> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">Linux</td> | <td width="168">Linux</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td> |
Pegasus/Config/DefaultPropertyTableLinux.h</td> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">HP-UX</td> | <td width="168">HP-UX</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td> |
Pegasus/Config/DefaultPropertyTableHpux.h</td> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">OpenVMS</td> | <td width="168">OpenVMS</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td> |
Pegasus/Config/DefaultPropertyTableVms.h</td> |
|
</tr> | </tr> |
|
</tbody> |
</table> | </table> |
</ul> | </ul> |
| |
<h5>enableNamespaceAuthorization</h5> | <h5>enableNamespaceAuthorization</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>If true, the CIM Server restricts |
|
access to namespaces based on configured user authorizations |
<b>Description: </b>If true, the CIM Server restricts access to |
[user authorizations may be configured using the cimauth |
namespaces based on configured user authorizations [user authorizations |
command]<br> |
may be configured using the cimauth command]<br> |
<b>Default Value: </b>false<br> | <b>Default Value: </b>false<br> |
<b>Recommended Default Value (Development Build): </b>false<br> | <b>Recommended Default Value (Development Build): </b>false<br> |
<b>Recommended Default Value (Release Build): </b>false<br> | <b>Recommended Default Value (Release Build): </b>false<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): </b>No/No<br> | <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
<b>Dynamic?: </b>No<br> | <b>Dynamic?: </b>No<br> |
<b>Considerations: </b> |
<b>Considerations: </b> This option offers limited functionality |
This option offers limited functionality and, in most |
and, in most environments, expensive to administer. It's use is not |
environments, expensive to administer. It's use is not |
|
recommended.<br> | recommended.<br> |
<b>Source Configuration File: </b> | <b>Source Configuration File: </b> |
Pegasus/Config/SecurityPropertyOwner.cpp</ul> |
Pegasus/Config/SecurityPropertyOwner.cpp |
|
</ul> |
| |
<h5>enableNormalization</h5> | <h5>enableNormalization</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>If true, objects returned from instance | <b>Description: </b>If true, objects returned from instance |
providers are validated and normalized. <br> | providers are validated and normalized. <br> |
<b>Default Value: </b>true<br> | <b>Default Value: </b>true<br> |
|
|
<b>Considerations: </b> | <b>Considerations: </b> |
<ul> | <ul> |
<li>Any errors encountered during normalization result in a | <li>Any errors encountered during normalization result in a |
CIMException with the status code set to CIM_ERR_FAILED |
CIMException with the status code set to CIM_ERR_FAILED and a |
and a meaningful, context specific error description |
meaningful, context specific error description (messages will be |
(messages will be localized). Providers that catch the |
localized). Providers that catch the exception have an opportunity to |
exception have an opportunity to handle the error. |
handle the error. Otherwise, the exception is passed to the Provider |
Otherwise, the exception is passed to the Provider Manager |
Manager and becomes the response for that Provider. </li> |
and becomes the response for that Provider. |
|
<li>Provider Modules that are listed on the | <li>Provider Modules that are listed on the |
excludeModulesFromNormalization |
excludeModulesFromNormalization configuration option are excluded from |
configuration option are excluded from normalization. |
normalization. </li> |
<li>Since the concept of normalization is relatively new to | <li>Since the concept of normalization is relatively new to |
OpenPegasus and it establishes and enforces rules for |
OpenPegasus and it establishes and enforces rules for objects returned |
objects returned by providers, it should only |
by providers, it should only apply to providers written against the SDK |
apply to providers written against the SDK in which it was |
in which it was introduced (or later). Therefore only Provider Modules |
introduced (or later). Therefore only Provider Modules that |
that have the following InterfaceType and InterfaceVersion combination |
have the following InterfaceType and InterfaceVersion |
will be subject to normalization: |
combination will be subject to normalization: |
<ul> |
<ul> |
<li>'C++Default' / 2.5.0 or greater </li> |
<li>'C++Default' / 2.5.0 or greater |
<li>'CMPI' / 2.0.0 or greater </li> |
<li>'CMPI' / 2.0.0 or greater |
<li>'JMPI' / 1.0.0 or greater </li> |
<li>'JMPI' / 1.0.0 or greater |
|
</ul> | </ul> |
|
</li> |
</ul> | </ul> |
<b>Source Configuration File: </b> | <b>Source Configuration File: </b> |
Pegasus/Config/NormalizationPropertyOwner.cpp<br> | Pegasus/Config/NormalizationPropertyOwner.cpp<br> |
</ul> | </ul> |
| |
|
|
<h5>enableRemotePrivilegedUserAccess</h5> | <h5>enableRemotePrivilegedUserAccess</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>If true, the CIM Server allows |
|
access by a privileged user from a remote system<br> |
<b>Description: </b>If true, the CIM Server allows access by a |
|
privileged user from a remote system<br> |
<b>Default Value: </b>true<br> | <b>Default Value: </b>true<br> |
<b>Recommended Default Value (Development Build): </b>true<br> | <b>Recommended Default Value (Development Build): </b>true<br> |
<b>Recommended Default Value (Release Build): </b>true<br> | <b>Recommended Default Value (Release Build): </b>true<br> |
|
|
<b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> | <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
<b>Dynamic?: </b>No<br> | <b>Dynamic?: </b>No<br> |
<b>Considerations: </b>Many management operations require | <b>Considerations: </b>Many management operations require |
privileged user access. Disabling remote access by |
privileged user access. Disabling remote access by privileged user |
privileged user could significantly affect |
could significantly affect functionality.<br> |
functionality.<br> |
|
<b>Source Configuration File: </b> |
|
Pegasus/Config/SecurityPropertyOwner.cpp<p> </p> |
|
</ul> |
|
|
|
<h5>enableSSLExportClientVerification</h5> |
|
<ul> |
|
<b>Description: </b>If true, the CIM Server allows HTTPS |
|
connection for CIMExport requests on the port specified by the |
|
service name "wbem-exp-https".<br> |
|
<b>Default Value: </b>false<br> |
|
<b>Recommended Default Value (Development Build): </b>true<br> |
|
<b>Recommended Default Value (Release Build): </b>false<br> |
|
<b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> |
|
<b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
|
<b>Dynamic?: </b>No<br> |
|
<b>Source Configuration File: </b> | <b>Source Configuration File: </b> |
Pegasus/Config/SecurityPropertyOwner.cpp</p> |
Pegasus/Config/SecurityPropertyOwner.cpp |
|
<p> </p> |
</ul> | </ul> |
| |
|
|
<h5>enableSubscriptionsForNonprivilegedUsers</h5> | <h5>enableSubscriptionsForNonprivilegedUsers</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>If true, operations (create instance, |
|
modify instance, delete instance, get instance, enumerate |
<b>Description: </b>If true, operations (create instance, modify |
instances, enumerate instance names) on indication |
instance, delete instance, get instance, enumerate instances, enumerate |
filter, listener destination, and subscription instances |
instance names) on indication filter, listener destination, and |
may be performed by non-privileged users. Otherwise, these |
subscription instances may be performed by non-privileged users. |
operations may only be performed on these instances by |
Otherwise, these operations may only be performed on these instances by |
privileged users.<br> | privileged users.<br> |
<b>Default Value: </b>true<br> | <b>Default Value: </b>true<br> |
<b>Recommended Default Value (Development Build): </b>true<br> | <b>Recommended Default Value (Development Build): </b>true<br> |
|
|
<b>Considerations: </b>This option has meaning only if | <b>Considerations: </b>This option has meaning only if |
enableIndicationService=true.<br> | enableIndicationService=true.<br> |
<b>Source Configuration File: </b> | <b>Source Configuration File: </b> |
Pegasus/Config/SecurityPropertyOwner.cpp<p> </p> |
Pegasus/Config/SecurityPropertyOwner.cpp |
|
<p> </p> |
</ul> | </ul> |
| |
<h5>excludeModulesFromNormalization</h5> | <h5>excludeModulesFromNormalization</h5> |
<ul> |
|
<b>Description: </b>If the excludeModulesfromNormalization |
|
property is set, the value is interpreted as a list of |
|
comma-separated Provider Module names (as specified in |
|
PG_ProviderModule.Name) to exclude from validation and |
|
normalization.<br> |
|
<b>Default Value: </b>""<br> |
|
<b>Recommended Default Value (Development Build):</b> |
|
""<br> |
|
<b>Recommended Default Value (Release Build): </b> |
|
""<br> |
|
<b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> |
|
<b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
|
<b>Dynamic?: </b>No<br> |
|
<b>Considerations: </b>All objects managed by all |
|
providers will be excluded from validation and normalization |
|
if its module name appears in this list.<br> |
|
<b>Source Configuration File: </b> |
|
Pegasus/Config/NormalizationPropertyOwner.cpp |
|
</ul> |
|
| |
|
|
<h5><b>exportSSLTrustStore</b></h5> |
|
<ul> | <ul> |
<b>Description: </b>Specifies the location of the OpenSSL |
|
truststore for Indications. Consistent with the OpenSSL |
<b>Description: </b>If the excludeModulesfromNormalization |
implementation, a truststore can be either a file or directory. |
property is set, the value is interpreted as a list of comma-separated |
If the truststore is a directory, all the certificates within |
Provider Module names (as specified in PG_ProviderModule.Name) to |
the directory are considered trusted.<br> |
exclude from validation and normalization.<br> |
<b>Default Value: </b>indication_trust.pem<br> |
<b>Default Value: </b>""<br> |
<b>Recommended Default Value (Development Build): </b> |
<b>Recommended Default Value (Development Build):</b> ""<br> |
indication_trust.pem<br> |
<b>Recommended Default Value (Release Build): </b> ""<br> |
<b>Recommended Default Value (Release Build): </b> |
|
$CERTIFICATEDIR/indication_trust.pem<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): </b>Yes<br> |
<b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
<b>Dynamic?: </b>No<br> | <b>Dynamic?: </b>No<br> |
|
<b>Considerations: </b>All objects managed by all providers will |
|
be excluded from validation and normalization if its module name |
|
appears in this list.<br> |
<b>Source Configuration File: </b> | <b>Source Configuration File: </b> |
Pegasus/Config/SecurityPropertyOwner.cpp</p> |
Pegasus/Config/NormalizationPropertyOwner.cpp |
</ul> | </ul> |
| |
<h5>forceProviderProcesses</h5> | <h5>forceProviderProcesses</h5> |
|
|
<ul> | <ul> |
<b>Description: </b>If true, the CIM Server runs Providers |
|
in separate processes rather than loading and calling Provider |
<b>Description: </b>If true, the CIM Server runs Providers in |
libraries directly within the CIM Server process.<br> |
separate processes rather than loading and calling Provider libraries |
|
directly within the CIM Server process.<br> |
<b>Default Value: </b>Dependent on the value of | <b>Default Value: </b>Dependent on the value of |
PEGASUS_DEFAULT_ENABLE_OOP<br> | PEGASUS_DEFAULT_ENABLE_OOP<br> |
<b>Recommended Default Value (Development Build):</b>true (HP-UX, | <b>Recommended Default Value (Development Build):</b>true (HP-UX, |
|
|
<b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> | <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
<b>Dynamic?: </b>No<br> | <b>Dynamic?: </b>No<br> |
<b>Considerations: </b>In a dynamic, potentially multi-vendor, | <b>Considerations: </b>In a dynamic, potentially multi-vendor, |
environment, the ability to run Providers in separate processes |
environment, the ability to run Providers in separate processes can |
can significantly increase the stability, maintainability and |
significantly increase the stability, maintainability and |
supportability of the overall solution. Running Providers |
supportability of the overall solution. Running Providers in |
in separate process spaces: (1) helps isolate components (i.e., |
separate process spaces: (1) helps isolate components (i.e., cimserver |
cimserver and Providers) from a catastrophic failure |
and Providers) from a catastrophic failure (segmentation faults, memory |
(segmentation faults, memory leaks) of a single Provider and (2) |
leaks) of a single Provider and (2) reduces the risk of accidental or |
reduces the risk of accidental or malicious sharing of sensitive |
malicious sharing of sensitive data among Providers. This benefit |
data among Providers. This benefit comes at a cost. |
comes at a cost. Moving Providers out of the cimserver process |
Moving Providers out of the cimserver process increases |
increases communication costs and can significantly increase response |
communication costs and can significantly increase response |
time. Actual results will vary, but it is common for response |
time. Actual results will vary, but it is common for |
times to increase by a factor of 2.<br> |
response times to increase by a factor of 2.<br> |
<b>Note 1: </b>When forceProviderProcesses is true, the CIM Server |
<b>Note 1: </b>When forceProviderProcesses is true, the CIM |
will load each Provider Module (i.e., library) into a separate process. |
Server will load each Provider Module (i.e., library) into a |
Providers in different Provider Modules cannot depend on a |
separate process. Providers in different Provider Modules |
communication mechanism that requires them to run in the same process |
cannot depend on a communication mechanism that |
space.<br> |
requires them to run in the same process space.<br> |
|
<b>Note 2: </b>Although the catastrophic failure of an | <b>Note 2: </b>Although the catastrophic failure of an |
Out-Of-Process (OOP) Provider Module will not result in a |
Out-Of-Process (OOP) Provider Module will not result in a failure of |
failure of the CIM Server process, if the failed OOP Provider |
the CIM Server process, if the failed OOP Provider Module included |
Module included Indication Providers, Indications may be |
Indication Providers, Indications may be lost. If logging is |
lost. If logging is enabled, the CIM Server will log a |
enabled, the CIM Server will log a message informing administrators of |
message informing administrators of what happened and what |
what happened and what corrective actions can be taken.<br> |
corrective actions can be taken.<br> |
|
<br> | <br> |
<table border="1" cellspacing="1" bordercolordark="#666666" |
<table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> |
bordercolorlight="#CCCCCC" width=531 |
<tbody> |
style='font-size=10.0pt;font-family:Arial'> |
|
<tr> | <tr> |
<th bgcolor="#CAE6CA" width="168">Platform</th> |
<th bgcolor="#cae6ca" width="168">Platform</th> |
<th bgcolor="#CAE6CA" width=350> |
<th bgcolor="#cae6ca" width="350"> Source Configuration File</th> |
Source Configuration File</th> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">Linux</td> | <td width="168">Linux</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td> |
Pegasus/Config/DefaultPropertyTableLinux.h</td> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">HP-UX</td> | <td width="168">HP-UX</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td> |
Pegasus/Config/DefaultPropertyTableHpux.h</td> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">OpenVMS</td> | <td width="168">OpenVMS</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td> |
Pegasus/Config/DefaultPropertyTableVms.h</td> |
|
</tr> | </tr> |
|
</tbody> |
</table> | </table> |
</ul> | </ul> |
| |
<h5>home</h5> | <h5>home</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>If set, this configuration option defines | <b>Description: </b>If set, this configuration option defines |
the runtime default value for PEGASUS_HOME.<br> | the runtime default value for PEGASUS_HOME.<br> |
<b>Default Value: </b>"./"<br> | <b>Default Value: </b>"./"<br> |
|
|
<b>Recommended Default Value (Release Build)""</b><br> | <b>Recommended Default Value (Release Build)""</b><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): </b>Yes<br> | <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> |
<b>Dynamic?: </b>No<p> <br> |
<b>Dynamic?: </b>No |
|
<p> <br> |
<br> | <br> |
<table border="1" cellspacing="1" bordercolordark="#666666" |
<table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> |
bordercolorlight="#CCCCCC" width=531 |
<tbody> |
style='font-size=10.0pt;font-family:Arial'> |
|
<tr> | <tr> |
<th bgcolor="#CAE6CA" width="168">Platform</th> |
<th bgcolor="#cae6ca" width="168">Platform</th> |
<th bgcolor="#CAE6CA" width=350>Source Configuration File</th> |
<th bgcolor="#cae6ca" width="350">Source Configuration File</th> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">Linux</td> | <td width="168">Linux</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td> |
Pegasus/Config/DefaultPropertyTableLinux.h</td> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">HP-UX</td> | <td width="168">HP-UX</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td> |
Pegasus/Config/DefaultPropertyTableHpux.h</td> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">OpenVMS</td> | <td width="168">OpenVMS</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td> |
Pegasus/Config/DefaultPropertyTableVms.h</td> |
|
</tr> | </tr> |
|
</tbody> |
</table> | </table> |
|
</p> |
|
</ul> |
|
|
|
<h5>hostname</h5> |
|
|
|
<ul> |
|
|
|
<b>Description: </b> Can be used to override the local system |
|
supplied hostname without domain the CIM Server is using to build |
|
objects. If not set, querying this configuration option will report the |
|
system supplied hostname and behavior is not changed.<br> |
|
Setting this value to a valid hostname on CIM Server startup or as |
|
planned value will force the server to assume the configured name as |
|
the local hosts name. Setting this allows the administrator to set the |
|
name that operations such as associator, reference etc. return with |
|
object paths.<br> |
|
In common setups it is not recommended to explicitly set this value. <br> |
|
<b>Usage scenarios: </b> The following scenarios in which |
|
changing the default value makes sense are known today:<br> |
|
1. The case where what the CIM Server shall return to clients for host |
|
name is NOT the name of the current host but some administrator defined |
|
name (ex. system behind a firewall or some redirector).<br> |
|
2. Embedded systems that have a system set hostname which is not valid |
|
and needs to be overridden by CIM administrator without changing the |
|
actual IP configuration. <br> |
|
<b>Recommended Default Value (Development Build): </b> blank<br> |
|
<b>Recommended Default Value (Release Build): </b> blank<br> |
|
<b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> |
|
<b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
|
<b>Dynamic?: </b>No<br> |
|
<b>Considerations: </b> When setting this configuration option the |
|
option fullyQualifiedHostName should be adjusted too.<br> |
|
Providers returning the systems hostname in an instance property might |
|
return a different value then the CIM server is setting in the object |
|
path. hostnames explicitly set into the object paths by providers will |
|
not be overridden by the CIM Server to allow cross-namespace |
|
associations. <br> |
|
It is necessary to upgrade existing repositories using the repupgrade |
|
utility when upgrading from an OpenPegasus version less than 2.12. <br> |
|
<b>Source Configuration File: </b> |
|
Pegasus/Config/DefaultPropertyOwner.cpp |
|
</ul> |
|
|
|
<h5>fullyQualifiedHostName</h5> |
|
|
|
<ul> |
|
|
|
<b>Description: </b> Can be used to override the local system |
|
supplied fully qualified hostname (with domain) the CIM Server is using |
|
to build objects. If not set, querying this configuration option will |
|
report the system supplied fully qualified hostname and behavior is not |
|
changed.<br> |
|
Setting this value to a valid hostname on CIM Server startup or as |
|
planned value will force the server to assume the configured name as |
|
the local hosts name with domain. Setting this allows the administrator |
|
to set the name that indication operations and the CIM_ObjectManager |
|
assume for SystemName returned as instance and key properties.<br> |
|
In common setups it is not recommended to explicitly set this value. <br> |
|
<b>Usage scenarios: </b> The following scenarios in which |
|
changing the default value makes sense are known today:<br> |
|
1. The case where what the CIM Server shall return to clients for |
|
SystemName is NOT the name of the current host but some administrator |
|
defined name (ex. system behind a firewall or some redirector).<br> |
|
2. Embedded systems that have a system set hostname which is not valid |
|
and needs to be overridden by CIM administrator without changing the |
|
actual IP configuration. <br> |
|
<b>Recommended Default Value (Development Build): </b> blank<br> |
|
<b>Recommended Default Value (Release Build): </b> blank<br> |
|
<b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> |
|
<b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
|
<b>Dynamic?: </b>No<br> |
|
<b>Considerations: </b> When setting this configuration option the |
|
option fullyQualifiedHostName should be adjusted too.<br> |
|
Providers returning the systems hostname in an instance property might |
|
return a different value then the CIM server is setting in SystemName. <br> |
|
It is necessary to upgrade existing repositories using the repupgrade |
|
utility when upgrading from an OpenPegasus version less than 2.12. <br> |
|
<b>Source Configuration File: </b> |
|
Pegasus/Config/DefaultPropertyOwner.cpp |
|
</ul> |
|
|
|
<h5>httpAuthType</h5> |
|
<ul> |
|
<b>Description: </b>Type of HTTP authentication. Allowed values are |
|
'basic', indicating basic authentication or 'negotiate' indicating use of |
|
HTPP Negotiate authentication method. This variable is effective only when |
|
'enableAuthentication' variable is set to 'true'.<br> |
|
<b>Default Value: </b>basic<br> |
|
<b>Recommended Default Value (Development Build): </b>basic<br> |
|
<b>Recommended Default Value (Release Build): </b>basic<br> |
|
<b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> |
|
<b>Recommend To Be Fixed/Hidden (Release Build): </b>No<br> |
|
<b>Dynamic?: </b>No<br> |
|
<b>Considerations: </b>Value 'negotiate' is available only when Pegasus |
|
is compiled with PEGASUS_NEGOTIATE_AUTHENTICATION=true.<br> |
|
<b>Source Configuration File: </b> |
|
Pegasus/Config/SecurityPropertyOwner.cpp |
</ul> | </ul> |
| |
<h5>httpPort</h5> | <h5>httpPort</h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>OpenPegasus first attempts to look up the | <b>Description: </b>OpenPegasus first attempts to look up the |
port number for HTTP using getservbyname for the 'wbem-http' |
port number for HTTP using getservbyname for the 'wbem-http' service. |
service. The httpPort configuration setting is used only when the |
The httpPort configuration setting is used only when the getservbyname |
getservbyname lookup fails.<br> |
lookup fails.<br> |
<b>Default Value: </b>blank<br> | <b>Default Value: </b>blank<br> |
<b>Recommended Default Value (Development Build): </b>blank<br> | <b>Recommended Default Value (Development Build): </b>blank<br> |
<b>Recommended Default Value (Release Build): </b>5988<br> | <b>Recommended Default Value (Release Build): </b>5988<br> |
|
|
IANA</a>. In a production environment, the recommendation is | IANA</a>. In a production environment, the recommendation is |
to use /etc/services to configure the value of this port. (2) | to use /etc/services to configure the value of this port. (2) |
With the release of OpenPegasus 2.5, the default values for | With the release of OpenPegasus 2.5, the default values for |
httpPort was changed from 5988 to "". This |
httpPort was changed from 5988 to "". This |
change was made to allow the OpenPegasus to differentiate | change was made to allow the OpenPegasus to differentiate |
between a default setting of 5988 and a customer-defined | between a default setting of 5988 and a customer-defined |
setting of 5988. With this change, if the port | setting of 5988. With this change, if the port |
|
|
is specified, the server will continue to use the value in | is specified, the server will continue to use the value in |
/etc/services.<br> | /etc/services.<br> |
<br> | <br> |
<table border="1" cellspacing="1" bordercolordark="#666666" |
<table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> |
bordercolorlight="#CCCCCC" width=531 |
<tbody><tr> |
style='font-size=10.0pt;font-family:Arial'> |
<th bgcolor="#cae6ca" width="168">Platform</th> |
<tr> |
<th bgcolor="#cae6ca" width="350">Source Configuration File</th> |
<th bgcolor="#CAE6CA" width="168">Platform</th> |
|
<th bgcolor="#CAE6CA" width=350>Source Configuration File</th> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">Linux</td> | <td width="168">Linux</td> |
|
|
<td align="left" width="350"> | <td align="left" width="350"> |
Pegasus/Config/DefaultPropertyTableVms.h</td> | Pegasus/Config/DefaultPropertyTableVms.h</td> |
</tr> | </tr> |
</table> |
</tbody></table> |
</ul> | </ul> |
| |
<h5>httpsPort</h5> | <h5>httpsPort</h5> |
|
|
In a production environment, the recommendation is to use | In a production environment, the recommendation is to use |
/etc/services to configure the value of this port.(2) | /etc/services to configure the value of this port.(2) |
With the release of OpenPegasus 2.5, the default values for | With the release of OpenPegasus 2.5, the default values for |
httpPort was changed from 5989 to "". This |
httpPort was changed from 5989 to "". This |
change was made to allow the OpenPegasus to differentiate | change was made to allow the OpenPegasus to differentiate |
between a default setting of 5989 and a customer-defined | between a default setting of 5989 and a customer-defined |
setting of 5989. With this change, if the port number | setting of 5989. With this change, if the port number |
|
|
the server will continue to use the value in /etc/services.<br> | the server will continue to use the value in /etc/services.<br> |
<br> | <br> |
| |
<table border="1" cellspacing="1" bordercolordark="#666666" |
<table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> |
bordercolorlight="#CCCCCC" width=531 |
<tbody><tr> |
style='font-size=10.0pt;font-family:Arial'> |
<th bgcolor="#cae6ca" width="168">Platform</th> |
<tr> |
<th bgcolor="#cae6ca" width="350">Source Configuration File</th> |
<th bgcolor="#CAE6CA" width="168">Platform</th> |
|
<th bgcolor="#CAE6CA" width=350>Source Configuration File</th> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">Linux</td> | <td width="168">Linux</td> |
|
|
<td align="left" width="350"> | <td align="left" width="350"> |
Pegasus/Config/DefaultPropertyTableVms.h</td> | Pegasus/Config/DefaultPropertyTableVms.h</td> |
</tr> | </tr> |
</table> |
</tbody></table> |
</ul> | </ul> |
| |
<h5>idleConnectionTimeout</h5> | <h5>idleConnectionTimeout</h5> |
|
|
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: </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): </b>3<br> |
|
<b>Recommended Default Value (Release Build): </b>3<br> |
|
<b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> |
|
<b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
|
<b>Dynamic?: </b>Yes<br> |
|
<b>Considerations: </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: </b> If set to a positive integer, value defines the number |
|
of times indication service will enable the reliableIndication feature and try |
|
to deliver an indication to a particular listener destination. |
|
This does not effect the original delivery attempt. A value of disables |
|
reliable indication feature completely, and cimserver will deliver the |
|
indication once.This is in accord with DTMF Specification 1054, |
|
Indication Profile, version 1.2.1.<br> |
|
<b>Recommended Default Value (Development Build): </b>3<br> |
|
<b>Recommended Default Value (Release Build): </b>3<br> |
|
<b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> |
|
<b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
|
<b>Dynamic?: </b>No<br> |
|
<b>Considerations: </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: </b> |
|
Pegasus/Config/IndicationServicePropertyOwner.cpp<br> |
|
</ul> |
|
|
|
<h5>minIndicationDeliveryRetryInterval</h5> |
|
<ul> |
|
<b>Description: </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): </b>30<br> |
|
<b>Recommended Default Value (Release Build): </b>30<br> |
|
<b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> |
|
<b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
|
<b>Dynamic?: </b>No<br> |
|
<b>Considerations: </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: </b> |
|
Pegasus/Config/IndicationServicePropertyOwner.cpp<br> |
|
</ul> |
|
|
|
<h5>listenAddress</h5> |
|
<ul> |
|
<b>Description: </b> Network interface where the cimserver |
|
should listen to for connections.For example listenAddress=All or |
|
listenAddress=121.12.33.112 or listenAddress=121.33.21.26,127.0.0.1, |
|
fe80::fe62:9346%eth0<br> |
|
<b>Recommended Default Value (Development Build): </b>All<br> |
|
<b>Recommended Default Value (Release Build): </b>No Specific suggestion<br> |
|
<b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> |
|
<b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
|
<b>Dynamic?: </b>No<br> |
|
<b>Considerations: </b>Default value of "All" will make cimserver to listen on all the network interfaces.<br> |
|
<b>Source Configuration File: </b> |
|
Pegasus/Config/DefaultPropertyOwner.cpp<br> |
|
</ul> |
|
|
<h5>logdir</h5> | <h5>logdir</h5> |
<ul> | <ul> |
<b>Description: </b>Specifies the name of the directory | <b>Description: </b>Specifies the name of the directory |
|
|
Pegsus/Config/LogPropertyOwner.cpp<p> </p> | Pegsus/Config/LogPropertyOwner.cpp<p> </p> |
</ul> | </ul> |
| |
|
<h5>mapToLocalName</h5> |
|
<ul> |
|
<b>Description: </b> If 'true', all remote client names are translated |
|
to local ones using GSSAPI. This applies only to clients using Negotiate |
|
authentication method, i.e. when "httpAuthType" runtime variable is set to |
|
"negotiate".<br> |
|
<b>Default Value: </b>false<br> |
|
<b>Recommended Default Value (Development Build): </b> |
|
false<br> |
|
<b>Recommended Default Value (Release Build): </b>false<br> |
|
<b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> |
|
<b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
|
<b>Dynamic?: </b>No<br> |
|
<b>Considerations: </b>This option is available only when Pegasus is |
|
compiled with PEGASUS_NEGOTIATE_AUTHENTICATION=true.<br> |
|
<b>Source Configuration File: </b> |
|
Pegasus/Config/SecurityPropertyOwner.cpp<p> </p> |
|
</ul> |
|
|
<h5>maxLogFileSizeKBytes</h5> | <h5>maxLogFileSizeKBytes</h5> |
<ul> | <ul> |
<b>Description: </b>Specifies the maximum size of the logfile in Kilo | <b>Description: </b>Specifies the maximum size of the logfile in Kilo |
|
|
four. In this case though new provider processes will not be created | four. In this case though new provider processes will not be created |
but existing five will continue running<br> | but existing five will continue running<br> |
<br> | <br> |
<table border="1" cellspacing="1" bordercolordark="#666666" |
<table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> |
bordercolorlight="#CCCCCC" width=531 |
<tbody><tr> |
style='font-size=10.0pt;font-family:Arial'> |
<th bgcolor="#cae6ca" width="168">Platform</th> |
<tr> |
<th bgcolor="#cae6ca" width="350"> |
<th bgcolor="#CAE6CA" width="168">Platform</th> |
|
<th bgcolor="#CAE6CA" width=350> |
|
Source Configuration File</th> | Source Configuration File</th> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
|
|
<td align="left" width="350"> | <td align="left" width="350"> |
Pegasus/Config/DefaultPropertyTableVms.h</td> | Pegasus/Config/DefaultPropertyTableVms.h</td> |
</tr> | </tr> |
</table> |
</tbody></table> |
</ul> | </ul> |
| |
<h5>messageDir</h5> | <h5>messageDir</h5> |
|
|
<b>Considerations: </b>The CIM Server runs as a privileged | <b>Considerations: </b>The CIM Server runs as a privileged |
user. And, since Providers run in the same process space as the | user. And, since Providers run in the same process space as the |
CIM Server, Providers also have privileged access to the | CIM Server, Providers also have privileged access to the |
system. Allowing a registered Provider’s executable to be |
system. Allowing a registered Provider’s executable to be |
replaced with malicious code would result in a critical | replaced with malicious code would result in a critical |
security defect, giving a malicious user privileged access | security defect, giving a malicious user privileged access |
to the system. Adminstrators are responsible for ensuring |
to the system. Administrators are responsible for ensuring |
that only trusted Providers are loaded into providerDir. | that only trusted Providers are loaded into providerDir. |
In order to simplify the management task associated with | In order to simplify the management task associated with |
securing Provider executable, the value of providerDir can be | securing Provider executable, the value of providerDir can be |
|
|
<b>Considerations: </b><br> | <b>Considerations: </b><br> |
<b>Source Configuration File: </b> | <b>Source Configuration File: </b> |
Pegasus/Config/FileSystemPropertyOwner.cpp<p><br> | Pegasus/Config/FileSystemPropertyOwner.cpp<p><br> |
</ul> |
</p></ul> |
|
|
|
<h5><b>repositoryIsDefaultInstanceProvider</b></h5> |
| |
<h5>repositoryIsDefaultInstanceProvider</h5> |
|
<ul> | <ul> |
<b>Description: </b>If true, the Repository functions |
|
as the Instance Provider for all classes for which there |
<b>Description: </b>If true, the Repository functions as |
is not an explicitly registered Provider. This flag is |
the Instance Provider for all classes for which there is not an explicitly |
also used to control the behavior of the repository when |
registered Provider. This flag is also used to control the behavior of |
processing association operators.<br> |
the repository when processing association operators.<br> |
<b>Recommended Default Value (Development Build): </b>true<br> | <b>Recommended Default Value (Development Build): </b>true<br> |
<b>Recommended Default Value (Release Build): </b>false<br> | <b>Recommended Default Value (Release Build): </b>false<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): </b>No/Yes<br> | <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br> |
<b>Dynamic?: </b>No<br> | <b>Dynamic?: </b>No<br> |
<b>Considerations: </b>This flag can be used to configure |
<b>Considerations: </b>This flag can be used to configure the |
the CIM Server to allow the Repository to be used by CIM Clients |
CIM Server to allow the Repository to be used by CIM Clients and CIM |
and CIM Providers as a dynamic data store. The setting of this |
Providers as a dynamic data store. The setting of this flag will |
flag will significantly affect CIM Server behavior as viewed |
significantly affect CIM Server behavior as viewed by the CIM Client.<br> |
by the CIM Client.<br> |
|
|
|
The following issues should be considered when setting | The following issues should be considered when setting |
repositoryIsDefaultInstanceProvider=true: | repositoryIsDefaultInstanceProvider=true: |
|
|
<ul> | <ul> |
<li><b>Authorization.</b> The repository has no |
<li><b>Authorization.</b> The repository has no concept of |
concept of which users (or components) are authorized to |
which users (or components) are authorized to perform which operations.</b></li> |
perform which operations.</li> |
<li><b>Appearance of instrumentation.</b> A client |
<li><b>Appearance of instrumentation.</b> A client application |
application cannot determine whether instrumentation exists for a given |
cannot determine whether instrumentation exists for a |
CIM class. For example, imagine a client issues a CreateInstance |
given CIM class. For example, imagine a client |
operation on a Disk class for which no provider is |
issues a CreateInstance operation on a Disk class |
registered. The instance will be stored in the repository, and |
for which no provider is registered. |
the client gets a "success" response. Does that mean a disk device |
The instance will be stored in the repository, and |
has been created on the server? Even worse, when another client issues |
the client gets a "success" response. Does that mean a |
an EnumerateInstances operation, the spurious Disk instance is |
disk device has been created on the server? Even worse, |
returned. With repositoryIsDefaultInstanceProvider=false, the |
when another client issues an EnumerateInstances |
CreateInstance operation above would have returned a NOT_SUPPORTED |
operation, the spurious Disk instance is returned. |
error.</b></li> |
With repositoryIsDefaultInstanceProvider=false, the |
|
CreateInstance operation above would have returned a |
<li><b>Potential for inconsistent data.</b> Using the |
NOT_SUPPORTED error.</li> |
repository as a data cache increases the probability that a client will |
<li><b>Potential for inconsistent data.</b> Using the |
see stale or incorrect data. A provider can better control the |
repository as a data cache increases the probability |
correlation between the data returned and the current state of the |
that a client will see stale or incorrect data. A |
underlying managed resource (whether or not the provider caches the |
provider can better control the correlation |
data).</b></li> |
between the data returned and the current state of the |
|
underlying managed resource (whether or not the provider |
|
caches the data).</li> |
|
</ul> | </ul> |
<br> | <br> |
|
|
The following issues should be considered when setting | The following issues should be considered when setting |
repositoryIsDefaultInstanceProvider=false: | repositoryIsDefaultInstanceProvider=false: |
|
|
<ul> | <ul> |
<li><b>Provider Availability.</b> Certain Providers have been | <li><b>Provider Availability.</b> Certain Providers have been |
developed to use the Repository as a dynamic data store. |
developed to use the Repository as a dynamic data store. These |
These Providers are currently not supported on system |
Providers are currently not supported on system where this flag is |
where this flag is disabled. E.g., the Common Diagnostics |
disabled. E.g., the Common Diagnostics Model (CDM) Provider |
Model (CDM) Provider |
(http://developer.intel.com/design/servers/cdm/) relies on use of the |
(http://developer.intel.com/design/servers/cdm/) |
Repository to store instances of CIM_DiagnosticSetting. If this |
relies on use of the Repository to store instances |
flag set to false, this Provider will not function correctly. Note that |
of CIM_DiagnosticSetting. If this flag set to |
this feature is supported by other WBEM implementation. |
false, this Provider will not function correctly. Note |
Therefore, disabling this feature can increase the cost of migrating |
that this feature is supported by other WBEM |
existing Providers to OpenPegasus.</b></li> |
implementation. Therefore, disabling this feature |
|
can increase the cost of migrating existing Providers to |
|
OpenPegasus.</li> |
|
</ul> |
|
| |
|
</ul> |
<b>Source Configuration File: </b> | <b>Source Configuration File: </b> |
Pegasus/Config/RepositoryPropertyOwner.cpp<br> | Pegasus/Config/RepositoryPropertyOwner.cpp<br> |
|
</b> |
</ul> | </ul> |
| |
<h5>shutdownTimeout</h5> |
<h5><b>shutdownTimeout</b></h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>When a cimserver -s shutdown command is | <b>Description: </b>When a cimserver -s shutdown command is |
issued, specifies the maximum time in seconds for the CIM Server |
issued, specifies the maximum time in seconds for the CIM Server to |
to complete outstanding CIM operation requests before shutting |
complete outstanding CIM operation requests before shutting down; if |
down; if the specified timeout period expires, the CIM Server |
the specified timeout period expires, the CIM Server will shut down, |
will shut down, even if there are still CIM operations in |
even if there are still CIM operations in progress. Minimum value is 2 |
progress. Minimum value is 2 seconds.<br> |
seconds.<br> |
<b>Recommended Default Value (Development Build): </b>10<br> | <b>Recommended Default Value (Development Build): </b>10<br> |
<b>Recommended Default Value (Release Build): </b>10<br> | <b>Recommended Default Value (Release Build): </b>10<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>Considerations: </b><br> | <b>Considerations: </b><br> |
<b>Source Configuration File: </b> | <b>Source Configuration File: </b> |
Pegasus/Config/ShutdownPropertyOwner.cpp<br> | Pegasus/Config/ShutdownPropertyOwner.cpp<br> |
|
|
</ul> | </ul> |
| |
<h5>slp</h5> |
<h5><b>slp</b></h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>When set to true, OpenPegasus activates | <b>Description: </b>When set to true, OpenPegasus activates |
an SLP SA and issues DMTF defined SLP advertisements to this SA |
an SLP SA and issues DMTF defined SLP advertisements to this SA on startup.<br> |
on startup.<br> |
|
<b>Default Value: </b>false<br> | <b>Default Value: </b>false<br> |
<b>Recommended Default Value (Development Build): </b>false<br> | <b>Recommended Default Value (Development Build): </b>false<br> |
<b>Recommended Default Value (Release Build): </b>false<br> | <b>Recommended Default Value (Release Build): </b>false<br> |
|
|
<b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> | <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> |
<b>Dynamic?: </b>No<p> <br> | <b>Dynamic?: </b>No<p> <br> |
<br> | <br> |
<table border="1" cellspacing="1" bordercolordark="#666666" |
<table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" height="80" width="531"> |
bordercolorlight="#CCCCCC" width=531 |
<tbody> |
style='font-size=10.0pt;font-family:Arial' height="80"> |
|
<tr> | <tr> |
<th bgcolor="#CAE6CA" width="168" height="16">Platform</th> |
<th bgcolor="#cae6ca" height="16" width="168">Platform</th> |
<th bgcolor="#CAE6CA" width=350 height="16"> |
<th bgcolor="#cae6ca" height="16" width="350"> Source |
Source Configuration File</th> |
Configuration File</th> |
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168" height="14">Linux</td> |
<td height="14" width="168">Linux</td> |
<td align="left" width="350" height="14"> |
<td align="left" height="14" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td> |
Pegasus/Config/DefaultPropertyTableLinux.h</td> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168" height="14">HP-UX</td> |
<td height="14" width="168">HP-UX</td> |
<td align="left" width="350" height="14"> |
<td align="left" height="14" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td> |
Pegasus/Config/DefaultPropertyTableHpux.h</td> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168" height="16">OpenVMS</td> |
<td height="16" width="168">OpenVMS</td> |
<td align="left" width="350" height="16"> |
<td align="left" height="16" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td> |
Pegasus/Config/DefaultPropertyTableVms.h</td> |
</tr> |
|
</tbody> |
|
</table> |
|
<b> </b></p> |
|
</ul> |
|
|
|
<h5><b>slpProviderStartupTimeout</b></h5> |
|
|
|
<ul> |
|
|
|
<b>Description: </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: </b>300000<br> |
|
<b>Recommended Default Value (Development Build): </b>300000<br> |
|
<b>Recommended Default Value (Release Build): </b>300000<br> |
|
<b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> |
|
<b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
|
<b>Dynamic?: </b>No |
|
<p><b> <br> |
|
<br> |
|
</b> |
|
<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> | </tr> |
|
</tbody> |
</table> | </table> |
|
<b> </b></p> |
</ul> | </ul> |
| |
<h5>socketWriteTimeout</h5> |
<h5><b>socketWriteTimeout</b></h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>If the CIM Server receives an | <b>Description: </b>If the CIM Server receives an |
EWOULDBLOCK/EAGAIN error on a non-blocking write, |
EWOULDBLOCK/EAGAIN error on a non-blocking write, socketWriteTimeout |
socketWriteTimeout defines the number of seconds the |
defines the number of seconds the CIM Server will wait for the socket |
CIM Server will wait for the socket to get ready and resume |
to get ready and resume writing data.<br> |
writing data.<br> |
<b>Recommended Default Value (Development Build): </b> 20 |
<b>Recommended Default Value (Development Build): </b> |
(seconds)<br> |
20 (seconds)<br> |
<b>Recommended Default Value (Release Build): </b> 20 (seconds)<br> |
<b>Recommended Default Value (Release Build): </b> |
|
20 (seconds)<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): </b>No/No<br> | <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
<b>Dynamic?: </b>Yes<br> | <b>Dynamic?: </b>Yes<br> |
<b>Considerations: </b>Any changes made to this config property | <b>Considerations: </b>Any changes made to this config property |
dynamically will apply to new CIM Server connections only |
dynamically will apply to new CIM Server connections only keeping old |
keeping old already established connections unchanged.<br> |
already established connections unchanged.<br> |
<b>Source Configuration File: </b> | <b>Source Configuration File: </b> |
Pegasus/Config/DefaultPropertyTable.h | Pegasus/Config/DefaultPropertyTable.h |
</ul> | </ul> |
| |
<h5>sslCertificateFilePath</h5> |
<h5><b>sslCertificateFilePath</b></h5> |
|
|
<ul> | <ul> |
<b>Description: </b>Contains the CIM Server SSL |
|
Certificate.<br> |
<b>Description: </b>Contains the CIM Server SSL Certificate.<br> |
<b>Recommended Default Value (Development Build): </b> |
<b>Recommended Default Value (Development Build): </b> server.pem<br> |
server.pem<br> |
|
<b>Recommended Default Value (Release Build): </b> | <b>Recommended Default Value (Release Build): </b> |
$CERTIFICATEDIR/server.pem"<br> | $CERTIFICATEDIR/server.pem"<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): </b>Yes<br> | <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> |
<b>Dynamic?: </b>No<br> | <b>Dynamic?: </b>No<br> |
<b>Considerations: </b>For a more detailed look at SSL options |
<b>Considerations: </b>For a more detailed look at SSL options and |
and their ramifications, please see the SSL guidelines.<br> |
their ramifications, please see the SSL guidelines.<br> |
|
<b>Source Configuration File: </b> |
|
Pegasus/Config/SecurityPropertyOwner.cpp </b> |
|
</ul> |
|
|
|
<h5><b>sslCipherSuite</b></h5> |
|
|
|
<ul> |
|
|
|
<b>Description: </b>String containing OpenSSL cipher |
|
specifications to configure the cipher suite the client is permitted to |
|
negotiate with the server during the SSL handshake phase.<br> |
|
<b>Recommended Default Value (Development Build): </b> DEFAULT |
|
(the default cipher list of OpenSSL)<br> |
|
<b>Recommended Default Value (Release Build): </b> DEFAULT (the |
|
default cipher list of OpenSSL)<br> |
|
<b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> |
|
<b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
|
<b>Dynamic?: </b>No<br> |
|
<b>Considerations: </b>The value should be mentioned between |
|
single quotes since it can contain special characters like .+, !, -.. |
|
For more details look at SSL ciphers.<br> |
<b>Source Configuration File: </b> | <b>Source Configuration File: </b> |
Pegasus/Config/SecurityPropertyOwner.cpp | Pegasus/Config/SecurityPropertyOwner.cpp |
</ul> | </ul> |
| |
<h5>sslClientVerificationMode</h5> |
<h5><b>sslBackwardCompatibility</b></h5> |
|
|
|
<ul> |
|
|
|
<b>Description: </b> If set to true, OpenPegasus support |
|
SSLv3 |
|
and TLSv1 protocol.If set to false OpenPegasus support only TLS1.2 |
|
protocol for openssl 1.0.1+ <br> |
|
<b>Recommended Default Value (Development Build): </b> false<br> |
|
<b>Recommended Default Value (Release Build): </b> false<br> |
|
<b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> |
|
<b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
|
<b>Dynamic?: </b>No<br> |
|
<b>Considerations: </b> For a more detailed look at SSL options |
|
and their ramifications, please see the SSL guidelines.<br> |
|
<b>Source Configuration File: </b> |
|
Pegasus/Config/SecurityPropertyOwner.cpp </b> |
|
</ul> |
|
|
|
<h5><b>sslClientVerificationMode</b></h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>Describes the desired level of support | <b>Description: </b>Describes the desired level of support |
for certificate-based authentication. |
for |
<ul style="MARGIN-TOP: 0in" type="circle"> |
certificate-based authentication. |
<li>“<b>required</b>” – The server requires certificate-based |
<ul style="margin-top: 0in;" type="circle"> |
client authentication. A client MUST present a |
<li>“<b>required</b>” – The server requires certificate-based |
trusted certificate in order to access the CIM Server. |
client authentication. A client MUST present a trusted |
If the client fails to send a certificate or sends an |
certificate in order to access the CIM Server. If the client |
untrusted certificate, the connection will be rejected.</li> |
fails to send a certificate or sends an untrusted certificate, the |
<li>“<b>optional</b>” – The server supports, but does not |
connection will be rejected.</li> |
require, certificate-based client authentication. The |
<li>“<b>optional</b>” – The server supports, but does not |
server will request and attempt to validate a client |
require, |
certificate, however the connection will be accepted even |
certificate-based client authentication. The server will request and |
if no certificate is sent or an untrusted certificate is |
attempt to validate a client certificate, however the connection will |
sent. The server will then seek to authenticate the |
be accepted even if no certificate is sent or an untrusted certificate |
client via an authentication header.</li> |
is sent. The server will then seek to authenticate the client via |
<li>“<b>disabled</b>” – The server does not support |
an authentication header.</li> |
|
|
|
<li>“<b>disabled</b>” – The server does not support |
certificate-based client authentication.</li> | certificate-based client authentication.</li> |
</ul> | </ul> |
<b>Recommended Default Value (Development Build): </b> | <b>Recommended Default Value (Development Build): </b> |
disabled<br> | disabled<br> |
<b>Recommended Default Value (Release Build): </b> |
<b>Recommended Default Value (Release Build): </b> disabled<br> |
disabled<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): </b>No/No<br> | <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
<b>Dynamic?: </b>No<br> | <b>Dynamic?: </b>No<br> |
<b>Considerations: </b>(1) This property is only used if |
<b>Considerations: </b>(1) This property is only used if <b>enableHttpsConnection</b> |
<b>enableHttpsConnection</b> is <b>"true"</b>. |
is <b>"true"</b>. (2) If the platform does not support |
(2) If the platform does not support PEGASUS_LOCAL_DOMAIN_SOCKET, |
PEGASUS_LOCAL_DOMAIN_SOCKET, OpenPegasus attempts to use either HTTPS |
OpenPegasus attempts to use either HTTPS or |
or HTTP to establish a local connection (connectLocal). For |
HTTP to establish a local connection (connectLocal). |
platforms that do not support PEGASUS_LOCAL_DOMAIN_SOCKET, Clients |
For platforms that do not support PEGASUS_LOCAL_DOMAIN_SOCKET, |
which use connectLocal, such as cimconfig -l -c, cimprovider -l -s and |
Clients which use connectLocal, such as cimconfig -l -c, |
cimserver -s, will not work if the "sslClientVerificationMode" |
cimprovider -l -s and cimserver -s, will not work if the |
variable is set to "required" and HTTP is disabled. For these |
"sslClientVerificationMode" variable is set to |
platforms, the recommended course of action is to change the property |
"required" and HTTP is disabled. For these |
value to "optional."<br> |
platforms, the recommended course of action is to change the |
|
property value to "optional."<br> |
|
<b>Source Configuration File: </b> | <b>Source Configuration File: </b> |
Pegasus/Config/SecurityPropertyOwner.cpp | Pegasus/Config/SecurityPropertyOwner.cpp |
</ul> | </ul> |
| |
<h5>sslKeyFilePath</h5> |
<h5><b>sslKeyFilePath</b></h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>Contains the private key for the CIM | <b>Description: </b>Contains the private key for the CIM |
Server SSL Certificate.<br> | Server SSL Certificate.<br> |
<b>Recommended Default Value (Development Build): </b> |
<b>Recommended Default Value (Development Build): </b> file.pem<br> |
file.pem<br> |
|
<b>Recommended Default Value (Release Build): </b> | <b>Recommended Default Value (Release Build): </b> |
$CERTIFICATEDIR/file.pem<br> | $CERTIFICATEDIR/file.pem<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): </b>Yes<br> | <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br> |
<b>Dynamic?: </b>No<br> | <b>Dynamic?: </b>No<br> |
<b>Considerations: </b>File should be readable only by the |
<b>Considerations: </b>File should be readable only by the user the |
user the cimserver is running as and/or privileged users. The |
cimserver is running as and/or privileged users. The file should be |
file should be writeable only by a privileged user.<br> |
writeable only by a privileged user.<br> |
<b>Source Configuration File: </b> | <b>Source Configuration File: </b> |
Pegasus/Config/SecurityPropertyOwner.cpp<br> | Pegasus/Config/SecurityPropertyOwner.cpp<br> |
|
|
</ul> | </ul> |
| |
<h5>sslTrustStore</h5> |
<h5><b>sslTrustStore</b></h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>Specifies the location of the OpenSSL | <b>Description: </b>Specifies the location of the OpenSSL |
truststore. Consistent with the OpenSSL implementation, a |
truststore. Consistent with the OpenSSL implementation, a truststore |
truststore can be either a file or directory. If the truststore |
can be either a file or directory. If the truststore is a directory, |
is a directory, all the certificates within the directory are |
all the certificates within the directory are considered trusted.<br> |
considered trusted.<br> |
<b>Recommended Default Value (Development Build): </b> client.pem<br> |
<b>Recommended Default Value (Development Build): </b> |
|
client.pem<br> |
|
<b>Recommended Default Value (Release Build): </b> | <b>Recommended Default Value (Release Build): </b> |
$CERTIFICATEDIR/client.pem<br> | $CERTIFICATEDIR/client.pem<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> |
|
|
Pegsus/Config/SecurityPropertyOwner.cpp | Pegsus/Config/SecurityPropertyOwner.cpp |
</ul> | </ul> |
| |
<h5>sslTrustStoreUserName</h5> |
<h5><b>sslTrustStoreUserName</b></h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>Specifies the system user name to be | <b>Description: </b>Specifies the system user name to be |
associated with all certificate-based authenticated requests.<br> | associated with all certificate-based authenticated requests.<br> |
<b>Recommended Default Value (Development Build): </b>NONE<br> | <b>Recommended Default Value (Development Build): </b>NONE<br> |
|
|
<b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> | <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
<b>Dynamic?: </b>No<br> | <b>Dynamic?: </b>No<br> |
<b>Considerations: </b>This property has no default; for | <b>Considerations: </b>This property has no default; for |
security reasons, the system administrator must explicitly |
security reasons, the system administrator must explicitly specify this |
specify this value. This feature allows a single user |
value. This feature allows a single user name to be |
name to be specified. This user will be associated |
specified. This user will be associated with all certificates in |
with all certificates in the truststore. In the future, |
the truststore. In the future, OpenPegasus will allow a system |
OpenPegasus will allow a system administrator to associate a |
administrator to associate a distinct user name with each certificate.<br> |
distinct user name with each certificate.<br> |
|
<b>Source Configuration File: </b> | <b>Source Configuration File: </b> |
Pegsus/Config/SecurityPropertyOwner.cpp<br> | Pegsus/Config/SecurityPropertyOwner.cpp<br> |
|
|
</ul> | </ul> |
| |
<h5>traceComponents</h5> |
<h5><b>traceComponents</b></h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>Defines the components to be traced.<br> | <b>Description: </b>Defines the components to be traced.<br> |
<b>Default Value: </b>""<br> | <b>Default Value: </b>""<br> |
<b>Recommended Default Value (Development Build): </b>""<br> | <b>Recommended Default Value (Development Build): </b>""<br> |
|
|
<b>Dynamic?: </b>Yes<br> | <b>Dynamic?: </b>Yes<br> |
<b>Source Configuration File: </b> | <b>Source Configuration File: </b> |
Pegasus/Config/TracePropertyOwner.cpp<br> | Pegasus/Config/TracePropertyOwner.cpp<br> |
|
|
</ul> | </ul> |
| |
<h5>traceFacility</h5> |
<h5><b>traceFacility</b></h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>Defines the desired facility for trace | <b>Description: </b>Defines the desired facility for trace |
messages. Valid values include: "File" |
messages. Valid values include: "File" , "Log" and "Memory" .<br> |
, "Log" and "Memory" .<br> |
|
<b>Default Value: </b>File<br> | <b>Default Value: </b>File<br> |
<b>Recommended Default Value (Development Build): </b>File<br> | <b>Recommended Default Value (Development Build): </b>File<br> |
<b>Recommended Default Value (Release Build): </b>File<br> | <b>Recommended Default Value (Release Build): </b>File<br> |
|
|
<b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br> | <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br> |
<b>Dynamic?: </b>Yes<br> | <b>Dynamic?: </b>Yes<br> |
<b>Case Sensitive?: </b>No<br> | <b>Case Sensitive?: </b>No<br> |
<b>Considerations: </b>If you specify "File", |
<b>Considerations: </b>If you specify "File", trace messagesare |
trace messagesare written into the file specified by the |
written into the file specified by the configuration option |
configuration option traceFilePath. If you specify |
traceFilePath. If you specify "Log", trace messages are written to the |
"Log", trace messages are written to the |
OpenPegasus Log. If you specify Memory, the trace messages are |
OpenPegasus Log. If you specify Memory, the trace messages |
collected in a wrap-around memory buffer. If this memory is part of a |
are collected in a wrap-around memory buffer. |
dump the trace messages can be found by the eye-catcher |
If this memory is part of a dump the trace messages can be |
"PEGASUSMEMTRACE" at the top of the memory buffer. The trace is in |
found by the eye-catcher "PEGASUSMEMTRACE" at |
clear text and the last written message has the suffix "EOTRACE".<br> |
the top of the memory buffer. The trace is in clear text and |
|
the last written message has the suffix "EOTRACE".<br> |
|
<b>Source Configuration File: </b> | <b>Source Configuration File: </b> |
Pegasus/Config/TracePropertyOwner.cpp<br> | Pegasus/Config/TracePropertyOwner.cpp<br> |
|
|
</ul> | </ul> |
| |
<h5>traceFilePath</h5> |
<h5><b>traceFilePath</b></h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>Specifies the location of the | <b>Description: </b>Specifies the location of the |
OpenPegasus trace file.<br> |
OpenPegasus |
|
trace file.<br> |
<b>Default Value: </b>cimserver.trc<br> | <b>Default Value: </b>cimserver.trc<br> |
<b>Recommended Default Value (Development Build):</b> |
<b>Recommended Default Value (Development Build):</b> cimserver.trc<br> |
cimserver.trc<br> |
|
<b>Recommended Default Value (Release Build): </b> | <b>Recommended Default Value (Release Build): </b> |
$TRACEDIR/cimserver.trc<br> | $TRACEDIR/cimserver.trc<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>Dynamic?: </b>Yes<br> | <b>Dynamic?: </b>Yes<br> |
<b>Source Configuration File: </b> | <b>Source Configuration File: </b> |
Pegasus/Config/TracePropertyOwner.cpp<br> | Pegasus/Config/TracePropertyOwner.cpp<br> |
|
|
</ul> | </ul> |
| |
<h5>traceLevel</h5> |
<h5><b>traceLevel</b></h5> |
|
|
<ul> | <ul> |
<b>Description: </b></b>Defines the desired level of |
|
tracing. Valid values include: 0, 1, 2, 3, 4, 5.<br> |
<b>Description: </b>Defines the desired level of tracing. |
|
Valid |
|
values include: 0, 1, 2, 3, 4, 5.<br> |
<b>Default Value: </b>0<br> | <b>Default Value: </b>0<br> |
<b>Recommended Default Value (Development Build): </b>0<br> | <b>Recommended Default Value (Development Build): </b>0<br> |
<b>Recommended Default Value (Release Build): </b>0<<br> |
<b>Recommended Default Value (Release Build): </b>0<<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): </b>No/Yes<br> | <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br> |
<b>Dynamic?: </b>Yes<br> | <b>Dynamic?: </b>Yes<br> |
<b>Source Configuration File: </b> | <b>Source Configuration File: </b> |
Pegasus/Config/TracePropertyOwner.cpp<br> | Pegasus/Config/TracePropertyOwner.cpp<br> |
|
|
</ul> | </ul> |
| |
<h5>traceMemoryBufferKbytes</h5> |
<h5><b>traceMemoryBufferKbytes</b></h5> |
|
|
<ul> | <ul> |
<b>Description: </b>Defines the size of the buffer for |
|
in memory tracing in kbytes ( 2<sup>10</sup> bytes ). |
<b>Description: </b>Defines the size of the buffer for in |
Smallest value is 16.<br> |
memory |
|
tracing in kbytes ( 2<sup>10</sup> bytes ). Smallest value is 16.<br> |
<b>Default Value: </b>10240<br> | <b>Default Value: </b>10240<br> |
<b>Recommended Default Value (Development Build): </b>10240<br> | <b>Recommended Default Value (Development Build): </b>10240<br> |
<b>Recommended Default Value (Release Build): </b>10240<br> | <b>Recommended Default Value (Release Build): </b>10240<br> |
|
|
<b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> | <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br> |
<b>Dynamic?: </b>No<br> | <b>Dynamic?: </b>No<br> |
<b>Case Sensitive?: </b>No<br> | <b>Case Sensitive?: </b>No<br> |
<b>Considerations: </b>Is ignored if configuration |
<b>Considerations: </b>Is ignored if configuration property |
property traceFacility is not set to Memory.<br> |
traceFacility is not set to Memory.<br> |
<b>Source Configuration File: </b> | <b>Source Configuration File: </b> |
Pegasus/Config/TracePropertyOwner.cpp<br> | Pegasus/Config/TracePropertyOwner.cpp<br> |
|
|
</ul> | </ul> |
| |
<h3>Configuration Constants</h3> |
<h5><b>traceFileSizeKBytes</b></h5> |
| |
<h4>Definitions</h4> |
<ul> |
|
|
|
<b>Description: </b>Defines the size of the tracefile in |
|
Kilo |
|
bytes. The trace file will be rolled once its size exceeds the |
|
specified size. <br> |
|
<b>Default Value: </b>1048576<br> |
|
<b>Recommended Default Value (Development Build): </b>1048576<br> |
|
<b>Recommended Default Value (Release Build): </b>1048576<br> |
|
<b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> |
|
<b>Recommend To Be Fixed/Hidden (Release Build):</b> No/Yes<br> |
|
<b>Dynamic?:</b> Yes<br> |
|
<b>Considerations:</b>Minimum accepted value is 10240 KB,Maximum |
|
accepted value is 2097152 KB. <br> |
|
<b>Source Configuration File:</b> |
|
Pegsus/Config/TracePropertyOwner.cpp |
|
<p><b> </b></p> |
|
</ul> |
|
|
|
<h5><b>numberOfTraceFiles</b></h5> |
|
|
|
<ul> |
|
|
|
<b>Description: </b>Specifies the number of the tracefiles |
|
for |
|
rolling.<br> |
|
<b>Default Value: </b>3<br> |
|
<b>Recommended Default Value (Development Build): </b>3<br> |
|
<b>Recommended Default Value (Release Build): </b>3<br> |
|
<b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> |
|
<b>Recommend To Be Fixed/Hidden (Release Build):</b> No/Yes<br> |
|
<b>Dynamic?:</b> Yes<br> |
|
<b>Considerations:</b>Minimum accepted value is 3,Maximum accepted |
|
value is 20. <br> |
|
<b>Source Configuration File:</b> |
|
Pegsus/Config/TracePropertyOwner.cpp |
|
<p><b> </b></p> |
|
</ul> |
|
|
|
<h5><b>webRoot</b></h5> |
|
|
|
<ul> |
|
|
|
<b>Description: </b> Points to a location where the static |
|
web |
|
pages to be served by the pegasus webserver are stored.<br> |
|
<b>Default Value: </b>www<br> |
|
<b>Recommended Default Value (Development Build): </b>www<br> |
|
<b>Recommended Default Value (Release Build): </b>$WEBCONFDIR/www<br> |
|
<b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> |
|
<b>Recommend To Be Fixed/Hidden (Release Build):</b> Yes/Yes<br> |
|
<b>Dynamic?:</b> No<br> |
|
<b>Considerations:</b> When not fixed and hidden, it can be modified |
|
to point to a location having spurious pages. Please consider fixing |
|
this value. <br> |
|
<b>Source Configuration File:</b> |
|
Pegsus/Config/DefaultPropertyOwner.cpp |
|
<p><b> </b></p> |
|
</ul> |
|
|
|
<h5><b>indexFile</b></h5> |
|
|
|
<ul> |
|
|
|
<b>Description: </b> Specifies the name of index file used |
|
by |
|
pegasus webserver, default to index.html. This file should be available |
|
at the webRoot path.<br> |
|
<b>Default Value: </b>index.html<br> |
|
<b>Recommended Default Value (Development Build): </b>index.html<br> |
|
<b>Recommended Default Value (Release Build): </b>index.html<br> |
|
<b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> |
|
<b>Recommend To Be Fixed/Hidden (Release Build):</b> Yes/Yes<br> |
|
<b>Dynamic?:</b> No<br> |
|
<b>Considerations:</b> Hide it and fixed in release build to |
|
prevent using any file as index file<br> |
|
<b>Source Configuration File:</b> |
|
Pegsus/Config/DefaultPropertyOwner.cpp |
|
<p><b> </b></p> |
|
</ul> |
|
|
|
<h5><b>mimeTypesFile</b></h5> |
|
|
|
<ul> |
|
|
|
<b>Description: </b> Refers to the file which holds the |
|
mime |
|
types being served by the pegasus webserver.<br> |
|
<b>Default Value: </b>www/mimeTypes.txt<br> |
|
<b>Recommended Default Value (Development Build): </b>www/mimeTypes.txt<br> |
|
<b>Recommended Default Value (Release Build): </b>$WEBCONFDIR/www/mimeTypes.txt<br> |
|
<b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br> |
|
<b>Recommend To Be Fixed/Hidden (Release Build):</b> Yes/Yes<br> |
|
<b>Dynamic?:</b> No<br> |
|
<b>Considerations:</b> Fix and make it read only when to prevent |
|
modification in deployment<br> |
|
<b>Source Configuration File:</b> |
|
Pegsus/Config/DefaultPropertyOwner.cpp |
|
<p><b> </b></p> |
|
</ul> |
|
|
|
<h3><b>Configuration Constants</b></h3> |
|
|
|
<h4><b>Definitions</b></h4> |
|
|
|
<h5><b>static char CURRENT_CONFIG_FILE [] = </b></h5> |
| |
<h5>static char CURRENT_CONFIG_FILE [] = </h5> |
|
<ul> | <ul> |
|
|
<b>Description: </b>Default file name for the current | <b>Description: </b>Default file name for the current |
configuration file.<br> | configuration file.<br> |
<b>Recommended Default Value (Development Build):</b> | <b>Recommended Default Value (Development Build):</b> |
|
|
$CONFIGDIR/cimserver_current.conf<br> | $CONFIGDIR/cimserver_current.conf<br> |
<b>Dynamic?: </b>No <br> | <b>Dynamic?: </b>No <br> |
<br> | <br> |
<table border="1" cellspacing="1" bordercolordark="#666666" |
|
bordercolorlight="#CCCCCC" width=531 |
<table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> |
style='font-size=10.0pt;font-family:Arial'> |
<tbody> |
<tr> | <tr> |
<th bgcolor="#CAE6CA" width="168">Platform</th> |
<th bgcolor="#cae6ca" width="168">Platform</th> |
<th bgcolor="#CAE6CA" width=350> |
<th bgcolor="#cae6ca" width="350"> Source Configuration File</th> |
Source Configuration File</th> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">Linux</td> | <td width="168">Linux</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/ConfigFileDirLinux.h</td> |
Pegasus/Config/ConfigFileDirLinux.h</td> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">HP-UX</td> | <td width="168">HP-UX</td> |
|
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">OpenVMS</td> | <td width="168">OpenVMS</td> |
<td align="left" width="350"> |
<td align="left" width="350"> Pegasus/Config/ConfigFileDirVms.h</td> |
Pegasus/Config/ConfigFileDirVms.h</td> |
|
</tr> | </tr> |
|
</tbody> |
</table> | </table> |
</ul> | </ul> |
| |
<h5>static char PLANNED_CONFIG_FILE [] = </h5> |
<h5><b>static char PLANNED_CONFIG_FILE [] = </b></h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>Default file name for the planned | <b>Description: </b>Default file name for the planned |
configuration file.<br> | configuration file.<br> |
<b>Recommended Default Value (Development Build): </b> | <b>Recommended Default Value (Development Build): </b> |
|
|
$CONFIGDIR/cimserver_planned.conf<br> | $CONFIGDIR/cimserver_planned.conf<br> |
<b>Dynamic?: </b>No<br> | <b>Dynamic?: </b>No<br> |
<br> | <br> |
<table border="1" cellspacing="1" bordercolordark="#666666" |
|
bordercolorlight="#CCCCCC" width=531 |
<table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> |
style='font-size=10.0pt;font-family:Arial'> |
<tbody> |
<tr> | <tr> |
<th bgcolor="#CAE6CA" width="168">Platform</th> |
<th bgcolor="#cae6ca" width="168">Platform</th> |
<th bgcolor="#CAE6CA" width=350> |
<th bgcolor="#cae6ca" width="350"> Source Configuration File</th> |
Source Configuration File</th> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">Linux</td> | <td width="168">Linux</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/ConfigFileDirLinux.h</td> |
Pegasus/Config/ConfigFileDirLinux.h</td> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">HP-UX</td> | <td width="168">HP-UX</td> |
<td align="left" width="350"> |
<td align="left" width="350"> Pegasus/Config/ConfigFileDirHpux.h</td> |
Pegasus/Config/ConfigFileDirHpux.h</td> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">OpenVMS</td> | <td width="168">OpenVMS</td> |
<td align="left" width="350"> |
<td align="left" width="350"> Pegasus/Config/ConfigFileDirVms.h</td> |
Pegasus/Config/ConfigFileDirVms.h</td> |
|
</tr> | </tr> |
|
</tbody> |
</table> | </table> |
</ul> | </ul> |
| |
<h5>static char CIMSERVER_START_FILE [] = </h5> |
<h5><b>static char CIMSERVER_START_FILE [] = </b></h5> |
|
|
<ul> | <ul> |
<b>Description: </b>This is for the default file name |
|
for the cimserver startup file containing the PID.<br> |
<b>Description: </b>This is for the default file name for |
|
the |
|
cimserver startup file containing the PID.<br> |
<b>Default Value: </b>/tmp/cimserver_start.conf<br> | <b>Default Value: </b>/tmp/cimserver_start.conf<br> |
<b>Recommended Default Value (Development Build): </b> | <b>Recommended Default Value (Development Build): </b> |
/tmp/cimserver_start.conf<br> | /tmp/cimserver_start.conf<br> |
<b>Recommended Default Value (Release Build): </b> |
<b>Recommended Default Value (Release Build): </b> $PIDFILE<br> |
$PIDFILE<br> |
|
<b>Dynamic?: </b>No<br> | <b>Dynamic?: </b>No<br> |
<br> | <br> |
<table border="1" cellspacing="1" bordercolordark="#666666" |
|
bordercolorlight="#CCCCCC" width=531 |
<table bordercolordark="#666666" bordercolorlight="#CCCCCC" style="font-family: Arial;" border="1" cellspacing="1" width="531"> |
style='font-size=10.0pt;font-family:Arial'> |
<tbody> |
<tr> | <tr> |
<th bgcolor="#CAE6CA" width="168">Platform</th> |
<th bgcolor="#cae6ca" width="168">Platform</th> |
<th bgcolor="#CAE6CA" width=350> |
<th bgcolor="#cae6ca" width="350"> Source Configuration File</th> |
Source Configuration File</th> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">Linux</td> | <td width="168">Linux</td> |
<td align="left" width="350"> |
<td align="left" width="350">Pegasus/Config/ConfigFileDirLinux.h</td> |
Pegasus/Config/ConfigFileDirLinux.h</td> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">HP-UX</td> | <td width="168">HP-UX</td> |
<td align="left" width="350"> |
<td align="left" width="350"> Pegasus/Config/ConfigFileDirHpux.h</td> |
Pegasus/Config/ConfigFileDirHpux.h</td> |
|
</tr> | </tr> |
<tr align="center"> | <tr align="center"> |
<td width="168">OpenVMS</td> | <td width="168">OpenVMS</td> |
<td align="left" width="350"> |
<td align="left" width="350"> Pegasus/Config/ConfigFileDirVms.h</td> |
Pegasus/Config/ConfigFileDirVms.h</td> |
|
</tr> | </tr> |
|
</tbody> |
</table> | </table> |
</ul> | </ul> |
| |
<h3>Configuration Macros</h3> |
<h3><b>Configuration Macros</b></h3> |
| |
<h4>Definitions</h4> |
<h4><b>Definitions</b></h4> |
|
|
|
<h5><b>PEGASUS_SSLCLIENT_CERTIFICATEFILE</b></h5> |
| |
<h5>PEGASUS_SSLCLIENT_CERTIFICATEFILE</h5> |
|
<ul> | <ul> |
<b>Description: </b><br> |
|
|
<b> <b>Description: </b><br> |
<b>Recommended Default Value (Development Build): </b>client.pem<br> | <b>Recommended Default Value (Development Build): </b>client.pem<br> |
<b>Recommended Default Value (Release Build): </b> | <b>Recommended Default Value (Release Build): </b> |
$CERTIFICATEDIR/client.pem<br> | $CERTIFICATEDIR/client.pem<br> |
<b>Dynamic?: </b>No<br> | <b>Dynamic?: </b>No<br> |
<b>Source Configuration File: </b> |
<b>Source Configuration File: </b> Pegasus/Common/Constants.h<br> |
Pegasus/Common/Constants.h<br> |
</b> |
</ul> | </ul> |
| |
<h5>PEGASUS_SSLCLIENT_RANDOMFILE</h5> |
<h5><b>PEGASUS_SSLCLIENT_RANDOMFILE</b></h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>On platforms that do not support | <b>Description: </b>On platforms that do not support |
/dev/random or /dev/urandom, OpenSSL will use this file to |
/dev/random |
seed the PRNG (Pseudo-Random Number Generator). This |
or /dev/urandom, OpenSSL will use this file to seed the PRNG |
PEGASUS_SSLCLIENT_RANDOMFILE defines the default CIM |
(Pseudo-Random Number Generator). This PEGASUS_SSLCLIENT_RANDOMFILE |
Client random file.<br> |
defines the default CIM Client random file.<br> |
<b>Recommended Default Value (Development Build):</b>ssl.rnd<br> | <b>Recommended Default Value (Development Build):</b>ssl.rnd<br> |
<b>Recommended Default Value (Release Build):</b> |
<b>Recommended Default Value (Release Build):</b> $RANDOMDIR/ssl.rnd<br> |
$RANDOMDIR/ssl.rnd<br> |
|
<b>Dynamic?: </b>No<br> | <b>Dynamic?: </b>No<br> |
<b>Considerations: </b>Use of this variable requires | <b>Considerations: </b>Use of this variable requires |
PEGASUS_HAS_SSL to be set. CIM Client use of a |
PEGASUS_HAS_SSL to be set. CIM Client use of a shared random file |
shared random file is not recommended. On systems where |
is not recommended. On systems where /dev/random or /dev/urandom |
/dev/random or /dev/urandom are not available, CIM Clients are |
are not available, CIM Clients are encouraged to generate a unique |
encouraged to generate a unique random file which |
random file which contains sufficient entropy.<br> |
contains sufficient entropy.<br> |
<b>Source Configuration File: </b> Pegasus/Common/Constants.h<br> |
<b>Source Configuration File: </b> |
|
Pegasus/Common/Constants.h<br> |
|
</ul> | </ul> |
| |
<h5>PEGASUS_SSLSERVER_RANDOMFILE</h5> |
<h5><b>PEGASUS_SSLSERVER_RANDOMFILE</b></h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b>On platforms that do not support | <b>Description: </b>On platforms that do not support |
/dev/random or /dev/urandom, OpenSSL will use this file |
/dev/random |
to seed the PRNG (Pseudo-Random Number Generator). This |
or /dev/urandom, OpenSSL will use this file to seed the PRNG |
PEGASUS_SSLSERVER_RANDOMFILE defines the CIM Server |
(Pseudo-Random Number Generator). This PEGASUS_SSLSERVER_RANDOMFILE |
random file.<br> |
defines the CIM Server random file.<br> |
<b>Recommended Default Value (Development Build): </b> | <b>Recommended Default Value (Development Build): </b> |
cimserver.rnd<br> | cimserver.rnd<br> |
<b>Recommended Default Value (Release Build): </b> | <b>Recommended Default Value (Release Build): </b> |
$RANDOMDIR/cimserver.rnd<br> | $RANDOMDIR/cimserver.rnd<br> |
<b>Dynamic?: </b>No<br> | <b>Dynamic?: </b>No<br> |
<b>Considerations: </b>1)Use of this variable |
<b>Considerations: </b>1)Use of this variable requires |
requires PEGASUS_HAS_SSL to be set.(2) On systems where |
PEGASUS_HAS_SSL to be set.(2) On systems where /dev/random or |
/dev/random or /dev/urandom are not available, CIM Server |
/dev/urandom are not available, CIM Server vendors need to be sure that |
vendors need to be sure that the cimserver.rnd file |
the cimserver.rnd file contains sufficient entropy and is uniquely |
contains sufficient entropy and is uniquely generated for |
generated for each system.<br> |
each system.<br> |
<b>Source Configuration File: </b> Pegasus/Common/Constants.h<b><br> |
<b>Source Configuration File: </b> |
</b> |
Pegasus/Common/Constants.h<b><br> |
|
</ul> | </ul> |
| |
<h5>PEGASUS_LOCAL_AUTH_DIR</h5> |
<h5><b><b>PEGASUS_LOCAL_AUTH_DIR</b></b></h5> |
|
|
<ul> | <ul> |
<b>Description:</b> </b>For local connections (i.e., |
|
connectLocal), OpenPegasus uses a file-based authentication |
<b>Description:</b> For local connections (i.e., |
mechanism.<br> |
connectLocal), OpenPegasus uses a file-based authentication mechanism.<br> |
<b>Recommended Default Value (Development Build): </b>/tmp<br> | <b>Recommended Default Value (Development Build): </b>/tmp<br> |
<b>Recommended Default Value (Release Build): </b> | <b>Recommended Default Value (Release Build): </b> |
$LOCALAUTHDIR/localauth<br> | $LOCALAUTHDIR/localauth<br> |
<b>Dynamic?: </b>No<br> | <b>Dynamic?: </b>No<br> |
<b>Source Configuration File: </b> |
<b>Source Configuration File: </b> Pegasus/Common/Constants.h<br> |
Pegasus/Common/Constants.h<br> |
|
</ul> | </ul> |
| |
<h5>PEGASUS_LOCAL_DOMAIN_SOCKET_PATH</h5> |
<h5><b>PEGASUS_LOCAL_DOMAIN_SOCKET_PATH</b></h5> |
|
|
<ul> | <ul> |
|
|
<b>Description: </b><br> | <b>Description: </b><br> |
<b>Recommended Default Value (Development Build): </b> | <b>Recommended Default Value (Development Build): </b> |
/tmp/cimxml.socket<br> | /tmp/cimxml.socket<br> |
<b>Recommended Default Value (Release Build): </b> | <b>Recommended Default Value (Release Build): </b> |
$SOCKETDIR/cimxml.socket<br> | $SOCKETDIR/cimxml.socket<br> |
<b>Dynamic?: </b>No<br> | <b>Dynamic?: </b>No<br> |
<b>Source Configuration File: </b> |
<b>Source Configuration File: </b> Pegasus/Common/Constants.h<br> |
Pegasus/Common/Constants.h<br> |
|
</ul> | </ul> |
| |
<hr> | <hr> |
<p>Licensed to The Open Group (TOG) under one or more contributor license |
<p><b>Licensed to The Open Group (TOG) under one or more contributor |
|
license |
agreements. Refer to the OpenPegasusNOTICE.txt file distributed with | agreements. Refer to the OpenPegasusNOTICE.txt file distributed with |
this work for additional information regarding copyright ownership. | this work for additional information regarding copyright ownership. |
Each contributor licenses this file to you under the OpenPegasus Open | Each contributor licenses this file to you under the OpenPegasus Open |
Source License; you may not use this file except in compliance with the | Source License; you may not use this file except in compliance with the |
License.</p> |
License.</b></p> |
<p>Permission is hereby granted, free of charge, to any person obtaining a |
|
copy of this software and associated documentation files (the "Software"), |
<p><b>Permission is hereby granted, free of charge, to any person |
to deal in the Software without restriction, including without limitation |
obtaining a |
the rights to use, copy, modify, merge, publish, distribute, sublicense, |
copy of this software and associated documentation files (the |
|
"Software"), |
|
to deal in the Software without restriction, including without |
|
limitation |
|
the rights to use, copy, modify, merge, publish, distribute, |
|
sublicense, |
and/or sell copies of the Software, and to permit persons to whom the | and/or sell copies of the Software, and to permit persons to whom the |
Software is furnished to do so, subject to the following conditions:</p> |
Software is furnished to do so, subject to the following conditions:</b></p> |
<p>The above copyright notice and this permission notice shall be included |
|
in all copies or substantial portions of the Software.</p> |
<p><b>The above copyright notice and this permission notice shall be |
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
included |
|
in all copies or substantial portions of the Software.</b></p> |
|
|
|
<p><b>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
|
EXPRESS |
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY | IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY |
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, | CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, |
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE | TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p> |
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</b></p> |
|
|
<hr> | <hr> |
</body> |
</body></html> |
</html> |
|