Return to
BuildAndReleaseOptions.html
CVS log
Up to [Pegasus] / pegasus / doc
|
Return to
BuildAndReleaseOptions.html
CVS log
|
Up to [Pegasus] / pegasus / doc
|
|
File: [Pegasus] / pegasus / doc / BuildAndReleaseOptions.html
(download)
/
(as text)
Revision: 1.1.2.1, Tue Sep 9 17:45:03 2008 UTC (15 years, 7 months ago) by kumpf Changes since 1.1: +3 -3 lines PEP#: 311 TITLE: WS-Management Support in CIM Server DESCRIPTION: Update build option documentation. |
<html>
<head>
<link rel="stylesheet" href=
"http://www.opengroup.org/stylesheets/info1.css">
</head>
<body>
<hr>
<p align="center">
<b><font size="4">Recommended OpenPegasus Build and Configuration Options for Selected Platforms</font></b>
</p>
<hr>
<p><b>Abstract: </b>
This document defines a set of recommended options for building,
testing and running OpenPegasus on a selected set of
platforms. In this version of the document, platform-specific configuration
information have been documented for the platforms described in the
"Documented Platforms" section of this document.
</p>
<p><b>Note 1: </b>
The recommendations defined in this document are not intended to document
the feature set included in any vendor's OpenPegasus-based product.
Rather, the purpose of this document is to provide input to vendors when
making product decisions.<BR>
</p>
<hr>
<h2>Definition of the Problem</h2>
<p>OpenPegasus supports a large number of build and runtime options.
Determining which options to use can be challenging. The purpose of this
document is to simplify the build, testing and administration of OpenPegasus
by providing a recommended, tested set of options.</p>
<h2>Documented Platforms</h2>
<p>Support for the OpenPegasus build and runtime options described in
this document varies by platform. In this version of the
document, platform-specific configuration information has been included
for the platforms described in the following table. For all other
platforms, please consult the OpenPegasus Platform Advocate for
additional information.</p>
<ul>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC" width=20%>
<tr>
<th bgcolor="#CAE6CA" align=center>Platform</th>
<th bgcolor="#CAE6CA" align=center>Status</th>
</tr>
<tr align="left">
<td>HPUX_IA64_ACC</td>
<td> </td>
</tr>
<tr align="left">
<td>HPUX_PARISC_ACC</td>
<td> </td>
</tr>
<tr align="left">
<td>LINUX_IA64_GNU</td>
<td> </td>
</tr>
<tr align="left">
<td>LINUX_IX86_GNU</td>
<td> </td>
</tr>
<tr align="left">
<td>LINUX_PPC64_GNU</td>
<td> </td>
</tr>
<tr align="left">
<td>LINUX_PPC_GNU</td>
<td> </td>
</tr>
<tr align="left">
<td>LINUX_XSCALE_GNU</td>
<td> </td>
</tr>
<tr align="left">
<td>LINUX_ZSERIES64_GNU</td>
<td> </td>
</tr>
<tr align="left">
<td>LINUX_ZSERIES_GNU</td>
<td> </td>
</tr>
<tr align="left">
<td>VMS_ALPHA_DECCXX</td>
<td> </td>
</tr>
<tr align="left">
<td>VMS_IA64_DECCXX</td>
<td> </td>
</tr>
</table>
</ul>
<h2>Proposed Solution</h2>
<h3>Security Considerations</h3>
<ol>
<li>
To avoid introducing security vulnerabilities, vendors must never
ship providers incompatible with the security assumptions used in
their deployment.
For example, providers designed for a single-user deployment that
don't perform authorization must not be shipped with a CIM Server
that expects the providers to perform authorization. Note that
this authorization burden is considerably lighter if the provider
is registered as 'run as requestor' and if the CIM Server enables
that feature. See <a href=
"http://www.openpegasus.org/pp/uploads/40/7197/SecurityGuidePEP.htm">
PEP#223 - Security Coding Guidelines</a> for additional
details.
</li>
<li>
Vendors should ensure they configure the CIM Server consistently
with the security requirements of their deployment.
</li>
</ol>
<h3>Terminology Notes</h3>
<ol>
<li>
In this document, the term "Not Set" is used to indicate
that the a value for the environment variable has not been defined.
"Set" is used to indicate that the value must be defined,
but the actual value of the variable is not checked.
</li>
</ol>
<h3>General Notes</h3>
<ol>
<li>
Not all functionality described in this document has achieved
"Green"status, please refer to the
<a href="http://www.openpegasus.org/page.tpl?CALLER=index.tpl&ggid=799">
OpenPegasus Project Feature Status </a>page for information on
the maturity level of OpenPegasus features.
</li>
<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>
<h3>Environment Variable Settings for <u>Building</u> OpenPegasus</h3>
<h4>Definitions</h4>
<h5>ICU_INSTALL</h5>
<ul>
<b>Description: </b>When set, points to the directory containing
the <a href="%20http:/oss.software.ibm.com/icu"> ICU(International
Components for Unicode)</a> installation. The 'include'
subdirectory is used to locate ICU header files at build time. The
'lib' subdirectory is used to locate ICU libraries at link
time.<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. However, if PEGASUS_HAS_ICU is
set and ICU_INSTALL is not defined, the ICU libraries and header
files are expected to be installed in directories (e.g.,/usr/lib,
/usr/include) that are searched by default.<br>
<b>Considerations: </b>This environment variable is only used
if 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.
</ul>
<h5>ICU_ROOT_BUNDLE_LANG</h5>
<ul>
<b>Description: </b>If set, specifies the language
to be used to generate the root resource bundle. The
default value for ICU_ROOT_BUNDLE_LANG is _en.<br>
<b>Default Value: </b>_en<br>
<b>Recommended Value (Development Build): </b>No
Recommendation<br>
<b>Recommended Value (Release Build): </b>No Recommendation<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.<br>
If set, resource bundles for the designated language must
exist for the following files:
<ul>
<li>pegasus/src/Pegasus/msg/Server/pegasusServer_en.txt</li>
<li>pegasus/src/Pegasus/msg/Listener/pegasusListener_en.txt</li>
</ul>
</ul>
<h5>OPENSSL_BIN</h5>
<ul>
<b>Description: </b>Specifies the location of the
OpenSSL <i>binary</i> directory. <br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>
No Specific Recommendation<br>
<b>Recommended Value (Release Build): </b>
No Specific Recommendation<br>
<b>Required: </b>No. By default, the openssl binary is
expected to be installed in a directory that is searched by default
(e.g., /usr/bin). For platforms where this isn't true, the
OPENSSL_BIN environment variable may be used to define an
alternative path. This environment variable is only used if
PEGASUS_HAS_SSL is set.
</ul>
<h5>OPENSSL_HOME</h5>
<ul>
<b>Description: </b>Specifies the location of the OpenSSL
SDK directory. This directory must contain the OpenSSL
<i>include</i> directory, $(OPENSSL_HOME)/include, and the OpenSSL
<i>library</i> directory, $(OPENSSL_HOME)/lib.<br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>
No Specific Recommendation<br>
<b>Recommended Value (Release Build): </b>
No Specific Recommendation<br>
<b>Required: </b>Yes for Windows, if PEGASUS_HAS_SSL
is set. No for all other platforms. For AIX, the default
value for OPENSSL_HOME is /usr/linux. For all other
platforms, the OpenSSL include files and libraries are expected
to be installed in directories that are searched by default (e.g.,
/usr/bin, /usr/lib(64), and /usr/include).
For platforms where the default value is not correct, the
OPENSSL_HOME environment variable may be used to define an
alternative path (i.e., $(OPENSSL_HOME)/lib and
$(OPENSSL_HOME)/include). This environment variable
is only used if PEGASUS_HAS_SSL is set.
</ul>
<h5>PEGASUS_ALLOW_ABSOLUTEPATH_IN_PROVIDERMODULE</h5>
<ul>
<b>Description: </b>If set to true, a version of OpenPegasus
will be built that allows an absolute path to be specified as the
value of the Location property of PG_ProviderModule class.
Otherwise it does not allow the absolute path to be specified.<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<p>
<b>Considerations: </b>To avoid introducing security
vulnerabilities, vendors should analyze their deployment
environments to understand the security implications of allowing
providers to be loaded from a dynamically changing set of
directories.<br>
</ul>
<h5>PEGASUS_CCOVER</h5>
<ul>
<b>Description: </b>This flag is currently only supported on
HP-UX. It is enabled on the Nightly Build & Test system,
HP-UX_11iv3_Integrity_C-Cover. This system is
used to generate the nightly BullseyeCoverage code coverage
metrics.<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 flag is only supported on HP-UX to enable
CCOVER for the NB&T system.<br>
</ul>
<h5>PEGASUS_CIM_SCHEMA</h5>
<ul>
<b>Description: </b>This variable is used internally by the
OpenPegasus development team when upgrading the OpenPegasus build
environment to a new version of the CIM Schema.<br>
<b>Default Value: </b>CIM217<br>
<b>Recommended Value (Development Build): </b>
No Specific Recommendation<br>
<b>Recommended Value (Release Build): </b>
No Specific Recommendation<br>
<b>Required: </b>No <br>
<b>Considerations:</b> Additional code changes may be required when
upgrading or downgrading the CIM Schema version.</p>
</ul>
<h5>PEGASUS_CLASS_CACHE_SIZE</h5>
<ul>
<b>Description: </b>This environment variable gives the size of
the class cache used by CIM repository. This variable defines the
size of the class cache (i.e., the maximum number of classes that
may be included). If this variable is set to 0, class caching is
disabled.<br>
<b>Default Value: </b>8<br>
<b>Recommended Value (Development Build): </b>8<br>
<b>Recommended Value (Release Build): </b>8<br>
<b>Required: </b>No </p>
</ul>
<h5>PEGASUS_DEBUG</h5>
<ul>
<b>Description: </b>Builds a debug version of OpenPegasus.
Concurrently, this flag controls a) enabling compiler specific
debug flags and b) the inclusion of debug-specific
functionality.<br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>Set<br>
<b>Recommended Value (Release Build): </b>Not Set<br>
<b>Required: </b>No
</ul>
<h5>PEGASUS_DEFAULT_USERCTXT_REQUESTOR</h5>
<ul>
<b>Description: </b> If set to true, the <i>Requestor</i> user
context is used for providers that do not specify a UserContext
value in their registration. Otherwise, the <i>Privileged</i> user
context value is used by default. <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
<b>Considerations:</b> Use of the <i>Requestor</i> default has
improved provider security characteristics. However, some providers
may not operate correctly when run in the <i>Requestor</i> user
context and setting this value to true may cause those providers to
fail. Providers that can run in the <i>Requestor</i>
user context are encouraged to explicitly set the UserContext value
in their registration rather than rely on the default setting
default by this variable. Please refer to
SecurityGuidelinesForDevelopers.html. PEP 223 for a discussion
of the rationale/advantages of running providers in the
<i>Requestor </i> user context. <b>Note:</b> This build
variable is not meaningful if the Provider User Context feature is
disabled with the PEGASUS_DISABLE_PROV_USERCTXT
setting.
</ul>
<h5>PEGASUS_DEFAULT_ENABLE_OOP</h5>
<ul>
<b>Description: </b>When this variable is set to false, by
default, Providers are run in the cimserver process
(forceProviderProcesses=false). If this value is set true,
Providers are run out-of-process by default.<br>
<b>Default Value: </b>true for HP-UX and Linux, false for
other platforms<br>
<b>Recommended Value (Development Build): </b>true (HP-UX,
Linux)<br>
<b>Recommended Value (Release Build): </b>true (HP-UX,
Linux)<br>
<b>Required: </b>No<br>
<b>Considerations: </b>This environment variable can be used to
change the "hard-coded" default setting for the
forceProviderProcesses configuration value.
Refer to the definition of <b>forceProviderProcesses</b> for
additional information.
</ul>
<h5>PEGASUS_DEST_LIB_DIR</h5>
<ul>
<b>Description: </b>Specifies the location of OpenPegasus
shared libraries.<br>
<b>Default Value: </b>$(PEGASUS_HOME)/lib<br>
<b>Recommended Value (Development Build): </b>
$(PEGASUS_HOME)/lib<br>
<b>Recommended Value (Release Build): </b>
No Specific Recommendation <br>
<b>Required: </b>No<br>
<b>Considerations: </b>This variable is NOT is used to define
the location of the Provider library directories.
Please refer to the providerDir configuration option for details
on defining the directories for the Provider libraries.
</ul>
<h5>PEGASUS_DISABLE_DEPRECATED_INTERFACES</h5>
<ul>
<b>Description: </b>Removes deprecated symbol definitions
from OpenPegasus runtime libraries.<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>If this option is set, the resulting
OpenPegasus libraries will not be binary compatible with
clients and providers built using interface definitions from
prior releases. This option may be used to slightly reduce binary
footprint in an environment where compatibility is not required.<br>
</ul>
<h5>PEGASUS_DISABLE_INSTANCE_QUALIFIERS</h5>
<ul>
<b>Description: </b>In the CIM Infrastructure Specification,
version 2.3, the DMTF clarified that instance-level qualifiers are
not allowed. In Version 1.2 of the Specification CIM
Operations over HTTP, use of the IncludeQualifiers parameter has
been DEPRECATED.<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>Existing CIM Clients may depend on
qualifiers being returned in the response. In this case, the
PEGASUS_DISABLE_INSTANCE_QUALIFIERS should not be set.
If this flag is set, the value of the IncludeQualifiers parameter
passed on the GetInstance and EnumerateInstance operations is
ignored and qualifiers are not returned.
Disabling the return of qualifiers as part of a CIM Instance will
improve performance.<br>
</ul>
<h5>PEGASUS_DISABLE_LOCAL_DOMAIN_SOCKET</h5>
<ul>
<b>Description: </b>Disables support for local (same-system)
connections over a Unix domain socket. If this option is NOT set,
the CIM Server is built to allow connections to be established
using a domain socket rather than a TCP port.<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>(1) In high-threat environments, a
customer may want to disable all ports or reduce the number of
exposed network ports. Supporting a local connection mechanism
using Unix domain socket allows the CIM Server to continue to
receive and process requests from local CIM Clients. (2)
Enabling this option may result in lose of functionality when
sslClientVerificationMode = required. (3)The
"LOCAL_DOMAIN_SOCKET" functionality has not been
implemented for Windows or OpenVMS. Therefore, by
default, this option is "Set" for Windows and OpenVMS
platforms.
</ul>
<h5>PEGASUS_DISABLE_PERFINST</h5>
<ul>
<b>Description: </b>Builds a version of OpenPegasus that
disables support for gathering performance data.<br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>Not Set<br>
<b>Recommended Value (Release Build): </b>Set<br>
<b>Required: </b>No<br>
<b>Considerations: </b>The CIM_ObjectManager.GatherStatisticalData
property is used to control statistic gathering. Once enabled,
statistical data can be viewed by retrieving instances of the
CIM_StatisticalData class. Support for gathering performance
data requires PEGASUS_ENABLE_INTEROP_PROVIDER to be enabled. If
PEGASUS_ENABLE_INTEROP_PROVIDER is explicitly disabled (i.e., set
to false), then PEGASUS_DISABLE_PERFINST must be set to
true. If PEGASUS_DISABLE_PERFINST is not defined or set to
false and PEGASUS_ENABLE_INTEROP_PROVIDER is not set,
PEGASUS_ENABLE_INTEROP_PROVIDER will be automatically enabled.
</ul>
<h5>PEGASUS_DISABLE_PRIVILEGED_TESTS</h5>
<ul>
<b>Description: </b>This variable is used only in the development
environment to restrict the level of testing performed by default.
If set, tests that require the CIM Server to run in a privileged
mode will not be run. Setting this variable allows
developers, without privileged access, to successfully run a
subset of the OpenPegasus test suit. This variable does
not affect CIM Server functionality. It merely controls
the level of testing.<br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>Not Set<br>
<b>Recommended Value (Release Build): </b>Not Used<br>
<b>Required: </b>No<br>
<b>Considerations: </b>Enabling this variable will significantly
reduce the testing of security related features (e.g.,
authentication and authorization) and can affect testing in other
areas.
</ul>
<h5>PEGASUS_DISABLE_PROV_USERCTXT</h5>
<ul>
<b>Description: </b>Builds a version of OpenPegasus that
disables supports for the Provider User Context feature.
This feature allows a Provider to choose the user context in
which it is invoked, including the ability to run in the context of
the user requesting an operation.<br>
<b>Default Value: </b>Set for Windows and OpenVMS, Not Set
for all other platforms<br>
<b>Recommended Value (Development Build): </b>Set for Windows and
OpenVMS, Not Set for all other platforms<br>
<b>Recommended Value (Release Build): </b>Set for Windows and
OpenVMS, Not Set for all other platforms<br>
<b>Required: </b>No<br>
<b>Considerations: </b>The Provider User Context feature may be
disabled by compiling with the PEGASUS_DISABLE_PROV_USERCTXT flag
defined. In this case, the Provider Registration Manager rejects
provider registration requests that specify a UserContext property
value. The user context in which providers run is then unchanged by
this enhancement. Some platforms, such as OS/400 and z/OS may
define the PEGASUS_DISABLE_PROV_USERCTXT as part of the platform
configuration, since these platforms already set the provider user
context on a per-thread basis. When the Provider User Context
feature is enabled, support for each of the User Context types may
be disabled individually. Provider registration fails when an
unsupported UserContext value is specified. Please refer to
SecurityGuidelinesForDevelopers.html / PEP 223 for a discussion of
the rationale/advantages of user context providers to many
platforms.<br>
</ul>
<h5>PEGASUS_EMANATE_INCLUDE_DIR</h5>
<ul>
<b>Description: </b>Specifies the location of the EMANATE
<i>include</i> directory. <br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>
No Specific Recommendation<br>
<b>Recommended Value (Release Build): </b>
No Specific Recommendation<br>
<b>Required: </b>No. By default, the EMANATE include files
are expected to be installed in directories that are searched by
default (e.g., /usr/include). For platforms where this isn't true,
the PEGASUS_EMANATE_INCLUDE_DIR environment variable may be used to
define an alternative path. This environment variable is only used
if PEGASUS_USE_EMANATE is set.<br>
<b>Considerations: </b>Refer to the description of PEGASUS_USE_EMANATE
for additional details.<br>
</ul>
<h5>PEGASUS_EMANATE_LIB_DIR</h5>
<ul>
<b>Description: </b>Specifies the location of the EMANATE
<i>lib</i> directory. <br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>
No Specific Recommendation<br>
<b>Recommended Value (Release Build): </b>
No Specific Recommendation<br>
<b>Required: </b>No. By default, the EMANATE libraries are
expected to be installed in directories that are searched by
default (e.g., /usr/lib, /usr/lib64). For platforms where this
isn't true, the PEGASUS_EMANATE_LIB_DIR environment variable may
be used to define an alternative path. This environment variable
is only used if PEGASUS_USE_EMANATE is set.<br>
<b>Considerations: </b>Refer to the description of PEGASUS_USE_EMANATE
for additional details.<br>
</ul>
<h5>PEGASUS_EMBEDDED_INSTANCE_SUPPORT</h5>
<ul>
<b>Description: </b>Controls whether the server is built with
support for the EmbeddedInstance value type for properties and
paramters.<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>Setting this build variable to 'false' may
adversely affect interoperability with WBEM clients/servers that
make use of EmbeddedInstance values.<br>
</ul>
<h5>PEGASUS_ENABLE_AUDIT_LOGGER</h5>
<ul>
<b>Description: </b>When this variable is set to false, support
for audit logging will NOT be built into OpenPegasus. If this
variable is set to true, or not set, support for audit logging
will be included in the build. All other values are invalid.<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>
</ul>
<h5>PEGASUS_ENABLE_CMPI_PROVIDER_MANAGER</h5>
<ul>
<b>Description: </b>If set to true, a version of OpenPegasus
that supports CMPI providers and their dependent components is
built. If this variable is not set or set to false, support
for CMPI providers will not be included. <br>
<b>Default Value: </b>true for Linux and OpenVMS, false for
other platforms<br>
<b>Recommended Value (Development Build): </b>true (Linux
Platform Only)<br>
<b>Recommended Value (Release Build): </b>true (Linux Platform
Only)<br>
<b>Required: </b>No</p>
</ul>
<h5>PEGASUS_ENABLE_COMPRESSED_REPOSITORY</h5>
<ul>
<b>Description: </b>If set the Repository Compression logic is
built and enabled and compressed and non compressed repositories
are supported. If not set then compressed repositories are not
supported.<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<p>
<b>Considerations: </b>See
pegasus/readme.compressed_repository</p>
</ul>
<h5>PEGASUS_ENABLE_CQL</h5>
<ul>
<b>Description: </b>When this variable is set to false, support
for Indication Subscription filters that have CQL as the language
is disabled. It does not remove CQL from the build.<br>
<b>Default Value:</b> Not Set<br>
<b>Recommended Value (Development Build):</b> Not Set<br>
<b>Recommended Value (Release Build):</b> false<br>
<b>Required: </b>No<br>
<b>Considerations: </b>The DMTF CIM Query Language
Specification is Preliminary and subject to backward incompatible
changes.
</ul>
<h5>PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT</h5>
<ul>
<b>Description: </b>When this variable is set to true, support the
DMTF Indications Profile (DSP1054) is included in OpenPegasus.
If this variable is not set or set to false, support for the DMTF
Indications Profile will not be included.<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>The implementation of this feature is
based on a preliminary version of the DMTF Indications Profile,
DSP1053, and subject to change. If this variable is enabled,
two DMTF experimental class definitions, CIM_IndicationService and
CIM_IndicationServiceCapabilities, will be added to the
root/PG_InterOp namespace. Experimental class definitions are
subject to change.
PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT requires
PEGASUS_ENABLE_INTEROP_PROVIDER to be enabled.
If PEGASUS_ENABLE_INTEROP_PROVIDER is not set, setting
PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT to true, will also
enable PEGASUS_ENABLE_INTEROP_PROVIDER. If
PEGASUS_ENABLE_INTEROP_PROVIDER is explicitly disabled (i.e., set
to false), a build error will be generated.
</ul>
<h5>PEGASUS_ENABLE_EXECQUERY</h5>
<ul>
<b>Description: </b>When this environment variable is set,
processing of ExecQuery operations is enabled. When not set,
ExecQuery operation requests get a NotSupported response. (Note:
The PEGASUS_ENABLE_EXECQUERY environment variable controls
the definition of the PEGASUS_DISABLE_EXECQUERY compile macro.) <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
</ul>
<h5>PEGASUS_ENABLE_EMAIL_HANDLER</h5>
<ul>
<b>Description: </b> When this environment variable is set, an
E-Mail Indication Handler is built as part of the OpenPegasus
build. The E-Mail Indication Handler can be used to
delivered CIM Indications to a designated e-mail address.<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>If PEGASUS_ENABLE_EMAIL_HANDLER is
not set when OpenPegasus is built, a request to create an Email
Indication Handler instance will be rejected will the error
CIM_ERR_NOT_SUPPORTED.
</ul>
<h5>PEGASUS_ENABLE_GCOV</h5>
<ul>
<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
code coverage utility. If PEGASUS_ENABLE_GCOV is set,
GCC will instrument the code to support analysis by GCOV.<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 flag is currently only supported with GCC on Linux.
<ul>
Note: LCOV, <a href=
"http://ltp.sourceforge.net/coverage/lcov.php">
http://ltp.sourceforge.net/coverage/lcov.php</a>, is a
graphical front-end extension for GCOV. It collects GCOV data
for multiple source files and creates HTML pages with coverage
information. You can use the following steps to use LCOV to
analyze OpenPegasus GCOV data.
<ol>
<li>Set PEGASUS_ENABLE_GCOV = true.</li>
<li>Build and test OpenPegasus (e.g.,
<i>make -f pegasus/TestMakefile build
alltests</i>).</li>
<li>For each source directory,
<ul>
<li>copy the .gcda and .gcno files from the object
directory to the source directory (e.g.,
<i>cp build/obj/Pegasus/Common/*.gcda
src/Pegasus/Common/</i>);</li>
<li>execute the <b>lcov</b> command
(e.g.,
<i>lcov --directory src/Pegasus/Common/ --capture
--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
output (e.g., <i>genhtml result.info</i>). The
top .html file is named index.html.</li>
</ul>
</ol>
</ul>
</ul>
<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_INTEROP_PROVIDER</h5>
<ul>
<b>Description: </b>If true, the OpenPegasus Interop Provider
will be build. If false or not set, the OpenPegasus Interop
Provider will not be built.<br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>Not Set<br>
<b>Recommended Value (Release Build): </b>false<br>
<b>Required: </b>No <br>
<b>Considerations: </b> A number of features controlled by
OpenPegasus build options are dependent on the Interop
Provider. Please refer to PEGASUS_ENABLE_SLP,
PEGASUS_DISABLE_PERFINST, and
PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT for additional
details.<br>
</ul>
<h5>PEGASUS_ENABLE_IPV6</h5>
<ul>
<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>Recommended Value (Development Build): </b>true<br>
<b>Recommended Value (Release Build): </b>true<br>
<b>Required: </b>No<br>
<b>Considerations: </b>When this variable is set to
'false', support for IPv6 socket APIs and structures is disabled,
and the CIM Server will not accept connections to or from IPv6
network interfaces. When this variable is set to 'true', the
newer IPv6 socket APIs and structures will be included when
OpenPegasus is built, so they must be supported on the build
platform. However, if IPv6 is not supported on the platform on
which an IPv6-enabled version of OpenPegasus is run, then the IPv6
feature will be disabled at run-time and only IPv4 connections
will be supported.
</ul>
<h5>PEGASUS_ENABLE_JMPI_PROVIDER_MANAGER</h5>
<ul>
<b>Description: </b>If true, a version of OpenPegasus that
supports JMPI providers and their dependent components is built.
If false or not set, support for JMPI Providers is not included
in OpenPegasus. All other values are invalid.<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</p>
</ul>
<h5>PEGASUS_ENABLE_OBJECT_NORMALIZATION</h5>
<ul>
<b>Description: </b>If set, builds in support so that objects
returned from provider instance operations can be validated.
The enableNormalization must also be set to 'true' (default)<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>If PEGASUS_ENABLE_OBJECT_NORMALIZATION is
set, two new configuration options are defined: enableNormalization
and excludeModulesFromNormalization.
</ul>
<h5>PEGASUS_ENABLE_PRIVILEGE_SEPARATION</h5>
<ul>
<b>Description: </b>If true, a version of OpenPegasus that
enables the Privilege Separation feature is built. This feature
allows the CIM Server to run in a non-privileged user context and
use a small executor process to perform privileged operations. If
false or not set, the Privilege Separate feature will not be
included.<br>
<b>Default Value: </b>false<br>
<b>Recommended Value (Development Build): </b>true (HP-UX,
Linux)<br>
<b>Recommended Value (Release Build): </b>true (HP-UX,
Linux)<br>
<b>Required: </b>No<br>
<b>Considerations: </b> The Privilege Separation feature is
only supported on HP-UX and Linux platforms. The 'cimsrvr' user
must be defined on the system. If the umask setting in the
environment is not 0, PEGASUS_TMP must be set to a directory that
is writable by the 'cimsrvr' user for the tests to run
successfully.
</ul>
<h5>PEGASUS_ENABLE_PROTOCOL_WSMAN</h5>
<ul>
<b>Description: </b>If true, a version of OpenPegasus is
built that accepts and processes WS-Management requests. This
feature is initially limited to WS-Transfer and WS-Enumeration
operations. If false or not set, WS-Management support is not
built or included in any way.<br>
<b>Default Value: </b>false<br>
<b>Recommended Value (Development Build): </b>true<br>
<b>Recommended Value (Release Build): </b>false<br>
<b>Required: </b>No<br>
<b>Considerations: </b> The WS-Management standards are not
mature, and interoperability problems may arise. The WS-Management
functionality may change in incompatible ways in subsequent
releases. Also note the known limitations specified in PEP 311.<br>
</ul>
<h5>PEGASUS_ENABLE_REMOTE_CMPI</h5>
<ul>
<b>Description: </b>If set, a version of OpenPegasus that
support Remote CMPI providers and their dependent components
is built.<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</p>
</ul>
<h5>PEGASUS_ENABLE_SLP</h5>
<ul>
<b>Description: </b>This variable controls of the inclusion
of SLP functionality in the OpenPegasus build. When this
environment variable is set to 'true', SLP functionality will be
included as part of the OpenPegasus build. If
this variable is set to 'false' or not set, the SLP functionality
will not be included. All other values are considered
invalid and will result in a build error
(e.g., "PEGASUS_ENABLE_SLP ($(PEGASUS_ENABLE_SLP)) invalid,
must be true or false").<br>
<b>Default Value: </b>'true' for Windows; 'false' for all other
Platforms<br>
<b>Recommended Value (Development Build): </b>'true' for
Windows; 'false' for all other Platforms<br>
<b>Recommended Value (Release Build): </b><br>
<b>Required: </b>No<br>
<b>Considerations: </b>PEGASUS_ENABLE_SLP requires
PEGASUS_ENABLE_INTEROP_PROVIDER to be enabled. If
PEGASUS_ENABLE_INTEROP_PROVIDER is not set, setting
PEGASUS_ENABLE_SLP to true, will also enable
PEGASUS_ENABLE_INTEROP_PROVIDER. If
PEGASUS_ENABLE_INTEROP_PROVIDER is explicitly disabled
(i.e., set to false), a build error will be generated.<br>
</ul>
<h5>PEGASUS_ENABLE_SORTED_DIFF</h5>
<ul>
<b>Description: </b>This controls if the DIFFSORT function
is used rather than a simple DIFF of the test results files
to the static results file. Set to 'true' enables the sorted
diffs of results to static results files. Otherwise results
in regular diffs of results to static results files.
See OpenPegasus bug 2283 for background information concerning
this config variable. <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> </p>
</ul>
<h5>PEGASUS_ENABLE_SYSTEM_LOG_HANDER</h5>
<ul>
<b>Description: </b>When this environment variable is set, a
SysLog Indication Handler is built as part of the OpenPegasus
build. The SysLog Indication Handler can be used to
delivered CIM Indications to the system log file.<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>If PEGASUS_ENABLE_SYSTEM_LOG_HANDLER
is not set when OpenPegasus is built, a request to create a SysLog
Indication Handler instance will be rejected with the error
CIM_ERR_NOT_SUPPORTED.<br>
</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>
<ul>
<b>Description: </b>Builds a version of OpenPegasus that
allows an administrator to restrict access to CIM operations
to members of a designated set of groups. Refer to the
<b>authorizedUserGroups</b>configuration option for additional
details.<br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>Not Set<br>
<b>Recommended Value (Release Build): </b>Set<br>
<b>Required: </b>No<br>
</ul>
<h5>PEGASUS_EXTRA_C_FLAGS</h5>
<ul>
<b>Description: </b>This environment variable allows a
developer to specify an additional set of flags to be included
on the C compile command line.<br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>No Set<br>
<b>Recommended Value (Release Build): </b>Not Set<br>
<b>Required: </b>No
</ul>
<h5>PEGASUS_EXTRA_CXX_FLAGS</h5>
<ul>
<b>Description: </b>This environment variable allows a
developer to specify an additional set of flags to be included
on the C++ compile command line.<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
</ul>
<h5>PEGASUS_EXTRA_LIBRARY_LINK_FLAGS</h5>
<ul>
<b>Description: </b>This environment variable allows a
developer to specify an additional set of flags to include on
the link command line used to build a library.<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
</ul>
<h5>PEGASUS_EXTRA_LINK_FLAGS</h5>
<ul>
<b>Description: </b>This environment variable allows a
developer to specify an additional set of flags to be included
on the link command line. These flags will be included on
both library and program executable link command lines.<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
<b>Considerations: </b>Refer to PEGASUS_EXTRA_LIBRARY_LINK_FLAGS and
PEGASUS_EXTRA_PROGRAM_FLAGS to add flags specific to either a
library or program link command line.<br>
</ul>
<h5>PEGASUS_EXTRA_PROGRAM_LINK_FLAGS</h5>
<ul>
<b>Description: </b>This environment variable allows a
developer to specify an additional set of flags to include on
the link command line used to build an executable program.<br>
<b>Recommended Value (Development Build): </b>Not Set<br>
<b>Recommended Value (Release Build): </b>Not Set<br>
<b>Required: </b>No
</ul>
<h5>PEGASUS_HAS_MESSAGES</h5>
<ul>
<b>Description: </b>When set (to anything) during the build,
OpenPegasus compiles with localization support. The
ICU (International Components for Unicode) variables,
ICU_ROOT and ICU_INSTALL, indicate that the
localization support is based on ICU. Only ICU is supported
at this time.<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>If the PEGASUS_HAS_MESSAGES is not
set, OpenPegasus is built without localization support. This
means that all messages sent by the CIM Server and the CLIs are in
English. ICU is an open source project at
<a href="http://oss.software.ibm.com/icu">
http://oss.software.ibm.com/icu</a>.
Only English translations are included with the OpenPegasus
distribution. The OpenPegasus distribution does not provide
translated messages. But, enabling for ICU would allow vendor to
provide the translations. Refer to the OpenPegasus Release README
for additional information regarding the use of ICU. Although, in
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>
</ul>
<h5>PEGASUS_HAS_SSL</h5>
<ul>
<b>Description: </b>If set, a version of OpenPegasus that
supports SSL (i.e., https) is built.<br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>Set<br>
<b>Recommended Value (Release Build): </b>Set<br>
<b>Required: </b>No<br>
<b>Considerations: </b>Support for SSL in OpenPegasus is
dependent on the OpenSSL software developed by the
<a href="http://www.openssl.org/">
OpenSSL Project (http://www.openssl.org/)</a>.
If the PEGASUS_HAS_SSL variable is set, the variable OPENSSL_HOME
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>
<h5>PEGASUS_HOME</h5>
<ul>
<b>Description: </b>Specifies the location of the
OpenPegasus working directory. The OpenPegasus
build will use this directory as the default location
for files generated during the build (e.g., binaries,
libraries, objects).<br>
<b>Default Value: </b>None<br>
<b>Recommended Value (Development Build): </b>
No Specific Recommendation<br>
<b>Recommended Value (Release Build): </b>
No Specific Recommendation<br>
<b>Required: </b>Yes<br>
<b>Considerations: </b>The error "PEGASUS_HOME
environment variable undefined" is returned if the
PEGASUS_HOME environment variable is not set.
This variable is also used during runtime. Refer to the section
titled "Environment Variable Settings for Running OpenPegasus
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>
<h5>PEGASUS_MAX_THREADS_PER_SVC_QUEUE</h5>
<ul>
<b>Description: </b>Controls the maximum number of threads
allowed per message service queue. It is allowed to range
between 1 and MAX_THREADS_PER_SVC_QUEUE_LIMIT (currently 5000)
as set in pegasus/src/Pegasus/Common/MessageQueueService.cpp.
If set to 0 (zero) the max threads per service queue is then
set to 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. There are no other limits on the
total number of threads that can exist within the system at this
time. When the server starts there on the order of 10 to 20
message service queues created dependent upon
build options. <br>
<b>Default Value: </b>5<br>
<b>Recommended Value (Development Build): </b>5<br>
<b>Recommended Value (Release Build): </b>5<br>
<b>Required: </b>No<br>
<b>Considerations: </b>This flag affects consumption of
system resources. Not setting, or inappropriately setting
this value, may cause the cimserver to hang or crash.<br>
</ul>
<h5>PEGASUS_ROOT</h5>
<ul>
<b>Description: </b>Specifies the location of the directory
that corresponds to "pegasus" source directory defined in the
OpenPegasus CVS source tree. This environment variable is
used by the OpenPegasus build to locate the required build
and source files (e.g., $(PEGASUS_ROOT)/mak and
$(PEGASUS_ROOT)/src).<br>
<b>Default Value: </b>None<br>
<b>Recommended Value (Development Build): </b>
No Specific Recommendation<br>
<b>Recommended Value (Release Build): </b>
No Specific Recommendation<br>
<b>Required: </b>Yes<br>
<b>Considerations: </b>The error "PEGASUS_ROOT environment
variable undefined" is returned if the PEGASUS_ROOT
environment variable is not set.
</ul>
<h5>PEGASUS_NET_SNMP_INCLUDE_DIR</h5>
<ul>
<b>Description: </b>Specifies the location of the NET-SNMP
<i>include</i> directory. <br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>
No Specific Recommendation<br>
<b>Recommended Value (Release Build): </b>
No Specific Recommendation<br>
<b>Required: </b>No. By default, the NET-SNMP include
files are expected to be installed in directories that
are searched by default (e.g., /usr/include). For platforms
where this isn't true, the PEGASUS_NET_SNMP_INCLUDE_DIR
environment variable may be used to define an alternative path.
This environment variable is only used if PEGASUS_USE_NET_SNMP
is set.<br>
</ul>
<h5>PEGASUS_NET_SNMP_LIB_DIR</h5>
<ul>
<b>Description: </b>Specifies the location of the NET-SNMP
<i>lib </i>directory. <br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>
No Specific Recommendation<br>
<b>Recommended Value (Release Build): </b>
No Specific Recommendation<br>
<b>Required: </b>No. By default, the NET-SNMP library is
expected to be installed in a directory that is searched by
default (e.g., /usr/lib, /usr/lib64). For platforms where
this isn't true, the PEGASUS_NET_SNMP_LIB_DIR environment
variable may be used to define an alternative path. This
environment variable is only used if PEGASUS_USE_NET_SNMP is set.
</ul>
<h5>PEGASUS_NOASSERTS</h5>
<ul>
<b>Description: </b>Defines the NDEBUG compilation macro, which
causes the preprocessor to remove PEGASUS_ASSERT() statements.<br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>Not Set<br>
<b>Recommended Value (Release Build): </b>Set<br>
<b>Required: </b>No<br>
</ul>
<h5>PEGASUS_OPENSLP_HOME</h5>
<ul>
<b>Description: </b>Specifies the location of the OpenSLP
SDK directory. This directory must contain the OpenSLP
<i>include</i> directory, $(PEGASUS_OPENSLP_HOME)/include,
and the OpenSLP <i>library</i> directory,
$(PEGASUS_OPENSLP_HOME)/lib.<br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>
No Specific Recommendation<br>
<b>Recommended Value (Release Build): </b>
No Specific Recommendation<br>
<b>Required: </b>No. If not set, no additional include or
library search paths will be included.
<b>Considerations: </b>This value is not used if PEGASUS_USE_OPENSLP
is not defined. <br>
</ul>
<h5>PEGASUS_PAM_AUTHENTICATION</h5>
<ul>
<b>Description: </b>Enables support for PAM-(Pluggable
Authentication Modules) based authentication.<br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>Set<br>
<b>Recommended Value (Release Build): </b>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_PLATFORM</h5>
<ul>
<b>Description: </b>Describes the target platform for the
build. The list of supported values for this variable
is defined in pegasus/mak/config.mak. Please refer to
that file for a complete list of valid PEGASUS_PLATFORM
values. This document includes platform-specific configuration
data for only a subset of the supported platforms. The
following table describes the platforms documented in
this version of the document. <br>
<b>Default Value: </b>None<p> </p>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC" width=542
style='font-size=10.0pt;font-family:Arial'>
<tr>
<th bgcolor="#CAE6CA" width="190">Platform</th>
<th bgcolor="#CAE6CA" width=351>Recommended Value <br>
Development Build</th>
<th bgcolor="#CAE6CA" width=338>Recommended Value <br>
Release Build</th>
</tr>
<tr align="center">
<td width="190" align="left">Linux IA32</td>
<td width="351">LINUX_IX86_GNU</td>
<td width="338">LINUX_IX86_GNU</td>
</tr>
<tr align="center">
<td width="190" align="left">Linux IA64</td>
<td width="351">LINUX_IA64_GNU</td>
<td width="338">LINUX_IA64_GNU</td>
</tr>
<tr align="center">
<td width="190" align="left">Linux X86_64</td>
<td width="351">LINUX_X86_64_GNU</td>
<td width="338">LINUX_X86_64_GNU</td>
</tr>
<tr align="center">
<td width="190" align="left">HP-UX PA-RISC</td>
<td width="351">HPUX_PARISC_ACC</td>
<td width="338">HPUX_PARISC_ACC</td>
</tr>
<tr align="center">
<td width="190" align="left">HP-UX IPF</td>
<td width="351">HPUX_IA64_ACC</td>
<td width="338">HPUX_IA64_ACC</td>
</tr>
<tr align="center">
<td width="190" align="left">OpenVMS Alpha</td>
<td width="351">VMS_ALPHA_DECCXX</td>
<td width="338">VMS_ALPHA_DECCXX</td>
</tr>
<tr align="center">
<td width="190" align="left">OpenVMS IA64</td>
<td width="351">VMS_IA64_DECCXX</td>
<td width="338"> VMS_IA64_DECCXX</td>
</tr>
</table>
<br><br>
<b>Required: </b>Yes<br>
<b>Considerations: </b>The error "PEGASUS_PLATFORM
environment variable undefined." is returned if the
PEGASUS_PLATFORM environment variable is not set.
</ul>
<h5>PEGASUS_REMOVE_METHODTRACE</h5>
<ul>
<b>Description: </b>If true, the CIM Server is compiled without
method enter and exit trace statements. Trace Level 5 will
continue to be accepted as a valid trace level but, without the
method enter and exit trace statements, it will be equivalent to
Trace Level 4. If PEGASUS_REMOVE_METHODTRACE is false or not set,
method enter and exit trace statements are included. All
other values are considered invalid and will result in a build
error.<br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>Not Set (The
Considerations section gives guidance on when a different
decision would be made.)<br>
<b>Recommended Value (Release Build): </b>Not Set (The
Considerations section gives guidance on when a different
decision would be made.)<br>
<b>Required: </b>No<br>
<b>Considerations: </b>This option completely removes the
method enter/exit trace statements from the generated object code.
It defines the PEG_METHOD_ENTER and PEG_METHOD_EXIT macros
to null statements. This helps to keep static code size small
but reduces the serviceability of the CIM server.<br>
</ul>
<h5>PEGASUS_REPOSITORY_MODE</h5>
<ul>
<b>Description: </b>This variable defines the default mode
used to create repositories that are constructed as part of the
automated build tests. It does not affect the runtime
environment. Valid values include: XML (causes
the repository to be built in XML mode); BIN (causes
the repository to be built in binary mode). Use cimconfig to
modify the runtime environment.<br>
<b>Default Value: </b>XML<br>
<b>Recommended Value (Development Build): </b>XML<br>
<b>Recommended Value (Release Build): </b>XML<br>
<b>Required: </b>No<p> </p>
</ul>
<h5>PEGASUS_SLP_REG_TIMEOUT</h5>
<ul>
<b>Description: </b>Most SLP implementations allow a lifetime
value to be specified in the registration sent to the SLP SA or
DA. The PEGASUS_SLP_REG_TIMEOUT build variable allows a lifetime
(ie. timeout) value to be specified on the SLP registration, with
a 're-registration' being sent to SLP at the same specified
timeout interval. The purpose of this lifetime or timeout value
is to avoid the accumulation of stale service information
in the SA or DA.<br>
<b>Default Value: </b>Undefined<br>
<b>Recommended Value (Development Build): </b>Undefined<br>
<b>Recommended Value (Release Build): </b>Undefined<br>
<b>Required: </b>No<p><b>Example: </b>
PEGASUS_SLP_REG_TIME=1440 (ie. 24 hours or 1 day)<br>
<b>Considerations: </b>(1) The OpenPegasus internal SLP
implementation does not support timeout registrations. This
build option is useful, for example, if PEGASUS_USE_OPENSLP is
defined. (2) Some SLP implementations may impose a
maximum value for the lifetime parameter. For example, OpenSLP
limits this value to SLP_LIFETIME_MAXIMUM (or 0xFFFF), and
if this maximum value is passed to OpenSLP, then the timeout
feature is disabled. Refer to the documentation of your SLP
implementation for more information. (3) OpenPegasus will not
do any validity checking on the specified value, either
to determine if it is a valid positive integer or if it
exceeds some maximum value.<br>
</ul>
<h5>PEGASUS_SNIA_EXTENSIONS</h5>
<ul>
<b>Description: </b> This variable is used to enable a
set of workarounds that support the use of OpenPegasus
in the SNIA Test Environment.<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>The functionality enabled with this
variable is experimental and subject to change.
</ul>
<h5>PEGASUS_SKIP_MOST_TEST_DIRS</h5>
<ul>
<b>Description: </b>If set to true, this variable can be used
to reduce the time required to build OpenPegasus by significantly
reducing the number of tests that are built.<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>Setting this variable to true
affects the behavior of all recursive make targets (e.g.,
clean, depend, all, unittests, alltests, and slptests).
Use of this variable with test-related targets (e.g., unittests,
alltests and slptests) can produce unexpected results.
To avoid creating an inconsistent PEGASUS_HOME directory,
the PEGASUS_HOME directory (i.e., the OpenPegasus build
directory) should be removed prior to enabling or disabling
this variable. This variable should not be used to characterize
the set of files to be packaged in a release build. Please
refer to the Runtime Packaging Definition PEP for the release
for a recommended list of files to be included in a release.
</ul>
<h5>PEGASUS_TEST_ENABLE_DEBUG_TRACE</h5>
<ul>
<b>Description: </b>
This variable is only used for testing. If set to true,
Discarded data trace will be enabled by the install_run
target of the src/Server/Makefile before running the
OpenPegasus TestMakefile test suite. <br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>Set<br>
<b>Recommended Value (Release Build): </b>Not Set<br>
<b>Required: </b>No<br>
<b>Considerations: </b>
This variable is useful in certain test environments to
explicitly enable tracing to aid in better troubleshooting and
detection of test failures (E.g. Test systems are experiencing
test failures due to connection timeouts, lost indications
etc).<br>
</ul>
<h5>PEGASUS_TEST_ISGROUP_GROUP/PEGASUS_TEST_ISGROUP_USER_SUCCESS/PEGASUS_TEST_ISGROUP_USER_FAILURE</h5>
<ul>
<b>Description: </b>These variables are only used for testing.
These variables allow the developer to define a valid group name,
PEGASUS_TEST_ISGROUP_GROUP, a valid user name that is in the
group, PEGASUS_TEST_ISGROUP_USER_SUCCESS, and an a valid user
name that is not in the group, PEGASUS_TEST_ISGROUP_USER_FAILURE.
These variables are only used for testing and NOT part of the
release.<br>
<b>Default Value(Windows):</b>
Administrator/Administrators/Guest<br>
<b>Default Value(Non-Windows): </b>root/root/guest<br>
<b>Recommended Value (Development Build): </b>
No Recommendation<br>
<b>Recommended Value (Release Build): </b>Not Used<br>
<b>Required: </b>No
</ul>
<h5>PEGASUS_TEST_IPV6</h5>
<ul>
<b>Description: </b>This variable is only used for
testing. If set to true, the IPv6-specific tests will
be run as part of the "alltests" OpenPegasus
TestMakefile test suite. If this variable is not set or set to
false, the IPv6-specific tests will not be run. All
other values are invalid.<br>
<b>Default Value: </b>If PEGASUS_TEST_IPV6 is not defined,
PEGASUS_TEST_IPV6 is set to the value of PEGASUS_ENABLE_IPV6.<br>
<b>Recommended Value (Development Build): </b>Set to the value
of PEGASUS_ENABLE_IPV6<br>
<b>Recommended Value (Release Build): </b>Not Used<br>
<b>Required: </b>No<br>
<b>Considerations: </b>This variable is useful in certain
test environments to explicitly disable running the IPv6
tests (e.g., when running an IPv6-enabled version of
OpenPegasus on an an IPv4 system).<br>
</ul>
<h5>PEGASUS_TEST_SDK</h5>
<ul>
<b>Description: </b>This variable is only used for
testing. It is used to control testing of the SDK
sample providers and clients. If set, the setup, building and
testing of the SDK samples is enabled as part of the
OpenPegasus automated build and test.<br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>Set<br>
<b>Recommended Value (Release Build): </b>Not Used<br>
<b>Required: </b>No
</ul>
<h5>PEGASUS_TEST_USER_DEFINED</h5>
<ul>
<b>Description: </b>This variable is only used for testing.
If this variable is set, the tests will assume that the
PEGASUS_TEST_USER_ID and PEGASUS_TEST_USER_PASS variables
defines a valid user/password pair and can be used for
certificate-based authentication testing. These tests
also assumes that "invalidUser" is not a valid
user.<br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>Set<br>
<b>Recommended Value (Release Build): </b>Not Used<br>
<b>Required: </b>No
</ul>
<h5>PEGASUS_TEST_USER_ID/PEGASUS_TEST_USER_PASS</h5>
<ul>
<b>Description: </b>These variables are only used for
testing. These variables allow the developer to define a
valid, non-privileged user name and password
on the test system that can be used as part of the OpenPegasus
automated test scripts to perform authentication and
authorization testing. These variables are only used for
testing and NOT part of the release.<br>
<b>Default Value: </b>guest/guest<br>
<b>Recommended Value (Development Build): </b>
No Recommendation<br>
<b>Recommended Value (Release Build): </b>Not Used<br>
<b>Required: </b>No<br>
</ul>
<h5>PEGASUS_TEST_VALGRIND_LOG_DIR</h5>
<ul>
<b>Description: </b>
This variable is currently only supported on Linux. It may be
set to run regression tests under the
<a href="http://www.valgrind.org/">Valgrind</a> memory
checking tool. It must specify a directory for writing
Valgrind log files. The file name format for a particular
log is PEGASUS_TEST_VALGRIND_LOG_DIR/PROGRAM_NAME.pid.<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 flag is only supported on Linux to
enable running tests under Valgrind.<br>
</ul>
<h5>PEGASUS_TMP</h5>
<ul>
<b>Description: </b>This variable is only used in a test
environment. It can be used to define the directory that
OpenPegasus test programs should use to store temporary files.<br>
<b>Default Value: </b>"."<br>
<b>Recommended Value (Development Build): </b>
No Specific Recommendation<br>
<b>Recommended Value (Release Build): </b>Not Used<br>
<b>Required: </b>No<br>
</ul>
<h5>PEGASUS_USE_DEBUG_BUILD_OPTIONS</h5>
<ul>
<b>Description: </b>The PEGASUS_DEBUG flag is used to control
a variety of settings, including compile options, assertion
enablement, method definitions for testing, and diagnostic
output. The PEGASUS_USE_DEBUG_BUILD_OPTIONS variable
can be used to enable just the compiler specific debug options
(e.g., -g in g++) .<br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>Set<br>
<b>Recommended Value (Release Build): </b>Not Set<br>
<b>Required: </b>No<br>
<b>Considerations: </b>This variable is automatically set
if PEGASUS_DEBUG is set.<br>
</ul>
<h5>PEGASUS_USE_EMANATE</h5>
<ul>
<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
International product that supports SNMPv1, SNMPv2c, and
SNMPv3. If the PEGASUS_USE_EMANATE variable is defined,
the OpenPegasus SNMP Handler will use the EMANATE libraries
to send traps to the SNMP Management application.
The EMANATE libraries are NOT included as part of OpenPegasus.<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<p>
<b>Considerations: </b>Either the PEGASUS_USE_NET_SNMP or
PEGASUS_USE_EMANATE variable must be set for the SNMP
Handler to be supported.<br>
</ul>
<h5>PEGASUS_USE_NET_SNMP</h5>
<ul>
<b>Description: </b>NET-SNMP,
<a href="http://net-snmp.sourceforge.net">
http://net-snmp.sourceforge.net</a>, 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 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>Recommended Value (Development Build): </b>Not Set<br>
<b>Recommended Value (Release Build): </b>true for Linux,
false for all other platforms<br>
<b>Required: </b>No<p>
<b>Considerations: </b>Either the PEGASUS_USE_NET_SNMP or
PEGASUS_USE_EMANATE variable must be set for the SNMP
Handler to be supported.<br>
</ul>
<h5>PEGASUS_USE_OPENSLP</h5>
<ul>
<b>Description: </b>OpenSLP, <a href="http://www.openslp.org">
http://openslp.org</a>, is an open-source implementation of
Service Location Protocol. If the PEGASUS_USE_OPENSLP variable
is defined, OpenPegasus will be built to use the OpenSLP
implementation of SLP instead of the internal OpenPegasus
implementation of SLP. The OpenSLP libaries are NOT included
as part of OpenPegasus.
<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>PEGASUS_ENABLE_SLP must be defined
if this variable is set.
</ul>
<h5>PEGASUS_USE_PAM_STANDALONE_PROC</h5>
<ul>
<b>Description: </b>Moves the processing of PAM requests from
the CIM Server process to a separate process managed by the
CIM Server.<br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>Set<br>
<b>Recommended Value (Release Build): </b>Set<br>
<b>Required: </b>No<br>
<b>Considerations: </b>If PAM Authentication is enabled,
the PAM API is used, during the processing of each request, to
authenticate the client. This level of use makes the CIM Server
extremely sensitive to memory leaks in the PAM library. In
addition, certain PAM modules are not thread-safe. If your
platform is experiencing problems with PAM Authentication,
use of option may provide a work-around.
PEGASUS_USE_PAM_STANDALONE_PROC requires
PEGASUS_PAM_AUTHENTICATION to be set.<br>
</ul>
<h5>PEGASUS_USE_RELEASE_CONFIG_OPTIONS</h5>
<ul>
<b>Description: </b>If set, OpenPegasus is built using
the "Release Build" configuration options. By default,
OpenPegasus is built using the "Development Build"
configuration options.<br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>Not Set<br>
<b>Recommended Value (Release Build): </b>Set<br>
<b>Required: </b>No<br>
<b>Considerations: </b>(1)The
PEGASUS_USE_RELEASE_CONFIG_OPTIONS variable allows a platform
vendor to easily toggle between two sets of configurations
options, a set of options tuned for the development/debug
("Development Build") environment and a set of options
tuned for the production environment ("Release Build").
Refer the section titled "Configuration Properties" for
additional detail. (2) For each configuration
variable, the "Recommended Value (Release Build)"
value defines the recommended settings to use for a
"Release Build". Please refer to the
description of each variable for additional information.
</ul>
<h5>PEGASUS_USE_RELEASE_DIRS</h5>
<ul>
<b>Description: </b>If set, OpenPegasus is built using
the "Release Build" directory definitions. By default,
OpenPegasus is built using the "Development Build"
directory definitions.<br>
<b>Default Value: </b>Not Set<br>
<b>Recommended Value (Development Build): </b>Not Set<br>
<b>Recommended Value (Release Build): </b>Set<br>
<b>Required: </b>No<br>
<b>Considerations: </b>
The PEGASUS_USE_RELEASE_DIRS variable allows a platform
vendor to easily toggle between two sets of directory
definitions, a set tuned for the development/debug
("Development Build") environment and a set tuned for the
production environment ("Release Build"). Refer the section
titled "Configuration Properties" for additional detail.<br>
</ul>
<h5>PEGASUS_USE_SYSLOGS</h5>
<ul>
<b>Description: </b>If set, OpenPegasus will be built
to send log messages to the system logger (syslog).
Otherwise, log messages will be sent to OpenPegasus
specific log files.<br>
<b>Recommended Value (Development Build): </b>Set<br>
<b>Recommended Value (Release Build): </b>Set<br>
<b>Required: </b>No<br>
<b>Considerations: </b>This variable is currently
not implemented as an environment variable. To use
the option -DPEGASUS_USE_SYSLOGS must
be explicitly included in the appropriate platform
makefile (pegasus/mak/platform_*.mak).</ul>
<h5>PEGASUS_WINDOWS_SDK_HOME</h5>
<ul>
<b>Description: </b>This variable should be set to point
to the Microsoft Platform SDK on Windows if using a compiler
version < 1300 (i.e. VC6). If using VC7 or VC8, this flag
does not need to be set, as the necessary libraries are already
included.<br>
<b>Recommended Value (Development Build): </b>
No Specific Recommendation<br>
<b>Recommended Value (Release Build): </b>
No Specific Recommendation<br>
<b>Required: </b>Yes, if building on Windows with a
compiler version < 1300.<br>
</ul>
<h4>Examples Building a Linux IA32 (#IA64) Development/Debug Version</h4>
<ul>
export PEGASUS_ROOT=/home/pegasusbld/pegasus<br>
export PEGASUS_HOME=/home/pegasusbld/pegasus/build<br>
export PEGASUS_PLATFORM=LINUX_IX86_GNU<br>
#export PEGASUS_PLATFORM=LINUX_IA64_GNU<br>
export PEGASUS_PAM_AUTHENTICATION=true<br>
export PEGASUS_USE_PAM_STANDALONE_PROC=true<br>
export PEGASUS_HAS_SSL=yes<br>
export PEGASUS_DEBUG=TRUE<br>
export ENABLE_CMPI_PROVIDER_MANAGER=true<br>
export PEGASUS_USE_SYSLOGS=true<br>
export PATH=/home/pegasusbld:/home/pegasusbld/pegasus/build/bin:/usr/local/bin:$PATH<br>
</ul>
<h4>Building a Linux IA32 (#IA64) Production Release Version</h4>
<ul>
export PEGASUS_ROOT=/home/pegasusbld/pegasus<br>
export PEGASUS_HOME=/home/pegasusbld/pegasus/build<br>
export PEGASUS_PLATFORM=LINUX_IX86_GNU<br>
#export PEGASUS_PLATFORM=LINUX_IA64_GNU<br>
export PEGASUS_DISABLE_CQL=true <br>
export PEGASUS_PAM_AUTHENTICATION=true <br>
export PEGASUS_USE_PAM_STANDALONE_PROC=true<br>
export PEGASUS_HAS_SSL=yes<br>
export PEGASUS_USE_RELEASE_CONFIG_OPTIONS=true<br>
export PEGASUS_USE_RELEASE_DIRS=true<br>
export PEGASUS_NOASSERTS=true<br>
export ENABLE_CMPI_PROVIDER_MANAGER=true<br>
export PEGASUS_ENABLE_USERGROUP_AUTHORIZATION=true<br>
export PEGASUS_USE_SYSLOGS=true<br>
export PATH=/home/pegasusbld:/home/pegasusbld/pegasus/build/bin:/usr/local/bin:$PATH<br>
</ul>
<h3>Environment Variable Settings for <u>Running</u> OpenPegasus</h3>
<h4>Definitions</h4>
<h5>PEGASUS_HOME</h5>
<ul>
<b>Description: </b>There are multiple options for
configuring the location of OpenPegasus runtime
files (e.g., configuration files, libraries,
repository, executables). If no other option is
specified, OpenPegasus will attempt to use the value
PEGASUS_HOME.<br>
<b>Default Value: </b>"."<br>
<b>Recommended Value (Development Build): </b>
The same value defined at build time.<br>
<b>Recommended Value (Release Build): </b>Not Set<br>
<b>Required: </b>No<br>
<b>Considerations: </b>Although this variable can be
useful in a development environment use of this environment
variable is not recommended in a production environment.
Instead, the use of configuration properties to explicitly
set the location of runtime files and directories is recommended.
</ul>
<h5>PEGASUS_MSG_HOME</h5>
<ul>
<b>Description: </b>This value is not used by the CIM
Server. The CIM Server uses the messageDir configuration
parameter to locate the directory where the ICU resource bundles.
However, CIM Client applications must rely on an alternative
mechanism to locate this directory.<br>
<b>Default Value: </b>if $PEGASUS_HOME is set then
"$PEGASUS_HOME/msg" else "."<br>
<b>Recommended Value (Development Build): </b>$PEGASUS_HOME/msg<br>
<b>Recommended Value (Release Build): </b>Not Set <br>
<b>Required: </b>No<br>
</ul>
<h3>Configuration Properties</h3>
<h4>Notation</h4>
<p>This section describes the notation used to define the
configuration properties.</p>
<ul>
<h5>Default Value</h5>
The value of <i>Default Value</i> is the OpenPegasus
default setting for this configuration option. This
value is used if a platform-specific setting is not
defined.
<h5>Recommended Default Value</h5>
The PEGASUS_USE_RELEASE_CONFIG_OPTIONS variable allows a
platform vendor to easily toggle between two sets of
configurations options, a set of options tuned for the
development/debug ("Development Build") environment
and a set of options tuned for the production environment
("Release Build"). The value of
<i>Recommended Value (Development Build)</i>
is the recommended default value for use in a development/
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>
Configuration options can be defined as fixed or hidden.
A "fix" configuration option is set at build time
and cannot be changed without rebuilding. "Fixed"
configuration options are not displayed using the cimconfig
command. This feature can be used by vendors to limit
OpenPegasus functionality and configurability.
A "hidden" configuration option is an option that is
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>
If yes, the value of the configuration option can be
changed without stopping and restarting the CIM Server.
<h5>Directory Specifications</h5>
<p>Note that the variables included in the following table
(e.g., $LOGDIR) are for documentation purposes only and
have been defined to simplify the description of the
configuration options. In particular,
these variables DO NOT correspond to environment variables
implemented in the OpenPegasus code. Default values
for the following variables are platform
and vendor dependent and not documented in this document.</p>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC" width=148
style='font-size=10.0pt;font-family:Arial' height="228">
<tr>
<th bgcolor="#CAE6CA" width=1 height="16"> </th>
</tr>
<tr align="center">
<td align="left" width="1" height="12">$LOGDIR</td>
</tr>
<tr align="center">
<td align="left" width="1" height="14">$PROVIDERDIRS</td>
</tr>
<tr align="center">
<td align="left" width="1" height="14">
$PROVIDERMANAGERDIRS</td>
</tr>
<tr align="center">
<td align="left" width="1" height="14">$REPOSITORYDIR </td>
</tr>
<tr align="center">
<td align="left" width="1" height="14">$CERTIFICATEDIR
</td>
</tr>
<tr align="center">
<td align="left" width="1" height="14">$LOCALAUTHDIR</td>
</tr>
<tr align="center">
<td align="left" width="1" height="14">$TRACEDIR</td>
</tr>
<tr align="center">
<td align="left" width="1" height="14">$CONFIGDIR</td>
</tr>
<tr align="center">
<td align="left" width="1" height="14">$PIDFILE</td>
</tr>
<tr align="center">
<td align="left" width="1" height="14">$RANDOMDIR</td>
</tr>
<tr align="center">
<td align="left" width="1" height="14">$SOCKETDIR</td>
</tr>
<tr align="center">
<td align="left" width="1" height="14">$MESSAGEDIR</td>
</tr>
</table>
</ul>
<h4>Definitions</h4>
<h5>authorizedUserGroups</h5>
<ul>
<b>Description:</b> If the <b>authorizedUserGroups</b>
property is set, the value is interpreted as a list of
comma-separated user groups whose members may issue CIM
requests. A user who is not a member of any of these groups is
restricted from issuing CIM requests, with the exception of
privileged users (root user). If the <b>authorizedUserGroups</b>
property is not set, any user may issue CIM requests.<br>
<b>Default Value: </b>blank<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>Example: </b>
#cimconfig -s authorizedUserGroups=users,systemusers -p<br>
<b>Considerations: </b>This feature is available only when
the OpenPegasus source is compiled with the flag
PEGASUS_ENABLE_USERGROUP_AUTHORIZATION set.
</ul>
<h5>daemon</h5>
<ul>
<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>Recommended Default Value (Development 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 (Release Build): </b>
No/Yes<br>
<b>Dynamic?: </b>No<p> <br>
<br>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC" width=531
style='font-size=10.0pt;font-family:Arial'>
<tr>
<th bgcolor="#CAE6CA" width="168">Platform</th>
<th bgcolor="#CAE6CA" width=350>Source Configuration File</th>
</tr>
<tr align="center">
<td width="168">Linux</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableLinux.h</td>
</tr>
<tr align="center">
<td width="168">HP-UX</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableHpux.h</td>
</tr>
<tr align="center">
<td width="168">OpenVMS</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableVms.h</td>
</tr>
</table>
</ul>
<h5>enableAssociationTraversal</h5>
<ul>
<b>Description: </b>If true, the CIM Server will support
the four association traversal operators: Associators,
AssociatorNames,References, and ReferenceNames.<br>
<b>Default Value: </b>true<br>
<b>Recommended Default Value (Development 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 (Release Build): </b>No/No<br>
<b>Dynamic?: </b>No<br>
<b>Considerations: </b>There is still an outstanding
Provider Registration issue that restricts the degree to
which separate Providers can register for Associations.<br>
<br>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC" width=531
style='font-size=10.0pt;font-family:Arial'>
<tr>
<th bgcolor="#CAE6CA" width="168">Platform</th>
<th bgcolor="#CAE6CA" width=350>Source Configuration File</th>
</tr>
<tr align="center">
<td width="168">Linux</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableLinux.h</td>
</tr>
<tr align="center">
<td width="168">HP-UX</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableHpux.h</td>
</tr>
<tr align="center">
<td width="168">OpenVMS</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableVms.h</td>
</tr>
</table>
</ul>
<h5>enableAuditLog</h5>
<ul>
<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 (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>Yes<br>
<b>Source Configuration File: </b>
Pegasus/Config/DefaultPropertyTable.h<br>
</ul>
<h5>enableAuthentication</h5>
<ul>
<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 (Release Build): </b>true<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>Dynamic?: </b>No<br>
<b>Source Configuration File: </b>
Pegasus/Config/SecurityPropertyOwner.cpp<br>
</ul>
<h5>enableBinaryRepository</h5>
<ul>
<b>Description: </b>Setting this to true will activate the
binary repository support on the next restart of cimserver.<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>Yes<br>
<b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br>
<b>Dynamic?: </b>No<br>
<b>Considerations: </b>Repositories containing a mixture
of binary and XML objects are supported.<br>
<b>Source Configuration File: </b>
Pegasus/Config/RepositoryPropertyOwner.cpp</p>
</ul>
<h5>enableHttpConnection</h5>
<ul>
<b>Description: </b>If true, allows connections to
the CIM Server using the HTTP protocol<br>
<b>Default Value: </b>true<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>Considerations: </b>
Enabling HTTP will allow clients to connect with security
properties different than those associated with encrypted SSL
traffic, and its configured SSL authentication or other security
behavior. This option should only be enabled in environments
where sending the HTTP Request and HTTP Response as
clear text messages does not introduce a security risk.
Note that if authentication is enabled (enableAuthentication),
user names and passwords will be included in the text of the
HTTP message.<br>
<br>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC" width=531
style='font-size=10.0pt;font-family:Arial'>
<tr>
<th bgcolor="#CAE6CA" width="168">Platform</th>
<th bgcolor="#CAE6CA" width=350>Source Configuration File</th>
</tr>
<tr align="center">
<td width="168">Linux</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableLinux.h</td>
</tr>
<tr align="center">
<td width="168">HP-UX</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableHpux.h</td>
</tr>
<tr align="center">
<td width="168">OpenVMS</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableVms.h</td>
</tr>
</table>
</ul>
<h5>enableHttpsConnection</h5>
<ul>
<b>Description: </b>If true, allows connections to
the CIM Server using the HTTPS protocol (HTTP using
Secure Socket Layer encryption)<br>
<b>Default Value: </b>false<br>
<b>Recommended Default Value (Development 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 (Release Build): </b>No/No<br>
<b>Dynamic?: </b>No<br>
<b>Considerations: </b>For this option to work,
the environment variable PEGASUS_HAS_SSL must have
been set when CIM Server was built.<br>
<br>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC" width=531
style='font-size=10.0pt;font-family:Arial'>
<tr>
<th bgcolor="#CAE6CA" width="168">Platform</th>
<th bgcolor="#CAE6CA" width=350>Source Configuration File</th>
</tr>
<tr align="center">
<td width="168">Linux</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableLinux.h</td>
</tr>
<tr align="center">
<td width="168">HP-UX</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableHpux.h</td>
</tr>
<tr align="center">
<td width="168">OpenVMS</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableVms.h</td>
</tr>
</table>
</ul>
<h5>enableIndicationService</h5>
<ul>
<b>Description: </b>If true, the CIM Server will support
CIM Indications.<br>
<b>Default Value: </b>true<br>
<b>Recommended Default Value (Development 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 (Release Build): </b>No/No<br>
<b>Dynamic?: </b>No<p> <br>
<br>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC" width=531
style='font-size=10.0pt;font-family:Arial'>
<tr>
<th bgcolor="#CAE6CA" width="168">Platform</th>
<th bgcolor="#CAE6CA" width=350>Source Configuration File</th>
</tr>
<tr align="center">
<td width="168">Linux</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableLinux.h</td>
</tr>
<tr align="center">
<td width="168">HP-UX</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableHpux.h</td>
</tr>
<tr align="center">
<td width="168">OpenVMS</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableVms.h</td>
</tr>
</table>
</ul>
<h5>enableNamespaceAuthorization</h5>
<ul>
<b>Description: </b>If true, the CIM Server restricts
access to namespaces based on configured user authorizations
[user authorizations may be configured using the cimauth
command]<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 offers limited functionality and, in most
environments, expensive to administer. It's use is not
recommended.<br>
<b>Source Configuration File: </b>
Pegasus/Config/SecurityPropertyOwner.cpp</ul>
<h5>enableNormalization</h5>
<ul>
<b>Description: </b>If true, objects returned from instance
providers are validated and normalized. <br>
<b>Default Value: </b>true<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>Considerations: </b>
<ul>
<li>Any errors encountered during normalization result in a
CIMException with the status code set to CIM_ERR_FAILED
and a meaningful, context specific error description
(messages will be localized). Providers that catch the
exception have an opportunity to handle the error.
Otherwise, the exception is passed to the Provider Manager
and becomes the response for that Provider.
<li>Provider Modules that are listed on the
excludeModulesFromNormalization
configuration option are excluded from normalization.
<li>Since the concept of normalization is relatively new to
OpenPegasus and it establishes and enforces rules for
objects returned by providers, it should only
apply to providers written against the SDK in which it was
introduced (or later). Therefore only Provider Modules that
have the following InterfaceType and InterfaceVersion
combination will be subject to normalization:
<ul>
<li>'C++Default' / 2.5.0 or greater
<li>'CMPI' / 2.0.0 or greater
<li>'JMPI' / 1.0.0 or greater
</ul>
</ul>
<b>Source Configuration File: </b>
Pegasus/Config/NormalizationPropertyOwner.cpp<br>
</ul>
<h5>enableRemotePrivilegedUserAccess</h5>
<ul>
<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>Recommended Default Value (Development 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 (Release Build): </b>No/No<br>
<b>Dynamic?: </b>No<br>
<b>Considerations: </b>Many management operations require
privileged user access. Disabling remote access by
privileged user could significantly affect
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>
Pegasus/Config/SecurityPropertyOwner.cpp</p>
</ul>
<h5>enableSubscriptionsForNonprivilegedUsers</h5>
<ul>
<b>Description: </b>If true, operations (create instance,
modify instance, delete instance, get instance, enumerate
instances, enumerate instance names) on indication
filter, listener destination, and subscription instances
may be performed by non-privileged users. Otherwise, these
operations may only be performed on these instances by
privileged users.<br>
<b>Default Value: </b>true<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>Considerations: </b>This option has meaning only if
enableIndicationService=true.<br>
<b>Source Configuration File: </b>
Pegasus/Config/SecurityPropertyOwner.cpp<p> </p>
</ul>
<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>
<b>Description: </b>Specifies the location of the OpenSSL
truststore for Indications. Consistent with the OpenSSL
implementation, a truststore can be either a file or directory.
If the truststore is a directory, all the certificates within
the directory are considered trusted.<br>
<b>Default Value: </b>indication_trust.pem<br>
<b>Recommended Default Value (Development Build): </b>
indication_trust.pem<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 (Release Build): </b>Yes<br>
<b>Dynamic?: </b>No<br>
<b>Source Configuration File: </b>
Pegasus/Config/SecurityPropertyOwner.cpp</p>
</ul>
<h5>forceProviderProcesses</h5>
<ul>
<b>Description: </b>If true, the CIM Server runs Providers
in 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
PEGASUS_DEFAULT_ENABLE_OOP<br>
<b>Recommended Default Value (Development Build):</b>true (HP-UX,
Linux)<br>
<b>Recommended Default Value (Release Build): </b>true (HP-UX,
Linux)<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>In a dynamic, potentially multi-vendor,
environment, the ability to run Providers in separate processes
can significantly increase the stability, maintainability and
supportability of the overall solution. Running Providers
in separate process spaces: (1) helps isolate components (i.e.,
cimserver and Providers) from a catastrophic failure
(segmentation faults, memory leaks) of a single Provider and (2)
reduces the risk of accidental or malicious sharing of sensitive
data among Providers. This benefit comes at a cost.
Moving Providers out of the cimserver process increases
communication costs and can significantly increase response
time. Actual results will vary, but it is common for
response times to increase by a factor of 2.<br>
<b>Note 1: </b>When forceProviderProcesses is true, the CIM
Server will load each Provider Module (i.e., library) into a
separate process. Providers in different Provider Modules
cannot depend on a communication mechanism that
requires them to run in the same process space.<br>
<b>Note 2: </b>Although the catastrophic failure of an
Out-Of-Process (OOP) Provider Module will not result in a
failure of the CIM Server process, if the failed OOP Provider
Module included Indication Providers, Indications may be
lost. If logging is enabled, the CIM Server will log a
message informing administrators of what happened and what
corrective actions can be taken.<br>
<br>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC" width=531
style='font-size=10.0pt;font-family:Arial'>
<tr>
<th bgcolor="#CAE6CA" width="168">Platform</th>
<th bgcolor="#CAE6CA" width=350>
Source Configuration File</th>
</tr>
<tr align="center">
<td width="168">Linux</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableLinux.h</td>
</tr>
<tr align="center">
<td width="168">HP-UX</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableHpux.h</td>
</tr>
<tr align="center">
<td width="168">OpenVMS</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableVms.h</td>
</tr>
</table>
</ul>
<h5>home</h5>
<ul>
<b>Description: </b>If set, this configuration option defines
the runtime default value for PEGASUS_HOME.<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>Yes<br>
<b>Dynamic?: </b>No<p> <br>
<br>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC" width=531
style='font-size=10.0pt;font-family:Arial'>
<tr>
<th bgcolor="#CAE6CA" width="168">Platform</th>
<th bgcolor="#CAE6CA" width=350>Source Configuration File</th>
</tr>
<tr align="center">
<td width="168">Linux</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableLinux.h</td>
</tr>
<tr align="center">
<td width="168">HP-UX</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableHpux.h</td>
</tr>
<tr align="center">
<td width="168">OpenVMS</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableVms.h</td>
</tr>
</table>
</ul>
<h5>httpPort</h5>
<ul>
<b>Description: </b>OpenPegasus first attempts to look up the
port number for HTTP using getservbyname for the 'wbem-http'
service. The httpPort configuration setting is used only when the
getservbyname lookup fails.<br>
<b>Default Value: </b>blank<br>
<b>Recommended Default Value (Development Build): </b>blank<br>
<b>Recommended Default Value (Release Build): </b>5988<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>Dynamic?: </b>No<br>
<b>Considerations: </b>(1)The use of 5988 for WBEM HTTP is
recommended by the DMTF. This port has been registered with
<a href="http://www.iana.org/assignments/port-numbers">
IANA</a>. In a production environment, the recommendation is
to use /etc/services to configure the value of this port. (2)
With the release of OpenPegasus 2.5, the default values for
httpPort was changed from 5988 to "". This
change was made to allow the OpenPegasus to differentiate
between a default setting of 5988 and a customer-defined
setting of 5988. With this change, if the port
number is explicitly set, the configured port will be used
regardless of the settings in /etc/services. If no port number
is specified, the server will continue to use the value in
/etc/services.<br>
<br>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC" width=531
style='font-size=10.0pt;font-family:Arial'>
<tr>
<th bgcolor="#CAE6CA" width="168">Platform</th>
<th bgcolor="#CAE6CA" width=350>Source Configuration File</th>
</tr>
<tr align="center">
<td width="168">Linux</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableLinux.h</td>
</tr>
<tr align="center">
<td width="168">HP-UX</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableHpux.h</td>
</tr>
<tr align="center">
<td width="168">OpenVMS</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableVms.h</td>
</tr>
</table>
</ul>
<h5>httpsPort</h5>
<ul>
<b>Description: </b>
OpenPegasus first attempts to look up the port number for HTTPS
using getservbyname for the 'wbem-https' service. The httpsPort
configuration setting is used only when the getservbyname lookup
fails.<br>
<b>Default Value: </b>blank<br>
<b>Recommended Default Value (Development Build): </b>blank<br>
<b>Recommended Default Value (Release Build): </b>5989<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>Dynamic?: </b>No<br>
<b>Considerations: </b>(1)The use of 5989 for WBEM HTTPS
is recommended by the DMTF. This port has been registered with
<a href="http://www.iana.org/assignments/port-numbers">IANA</a>.
In a production environment, the recommendation is to use
/etc/services to configure the value of this port.(2)
With the release of OpenPegasus 2.5, the default values for
httpPort was changed from 5989 to "". This
change was made to allow the OpenPegasus to differentiate
between a default setting of 5989 and a customer-defined
setting of 5989. With this change, if the port number
is explicitly set, the configured port will be used regardless
of the settings in /etc/services. If no port number is specified,
the server will continue to use the value in /etc/services.<br>
<br>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC" width=531
style='font-size=10.0pt;font-family:Arial'>
<tr>
<th bgcolor="#CAE6CA" width="168">Platform</th>
<th bgcolor="#CAE6CA" width=350>Source Configuration File</th>
</tr>
<tr align="center">
<td width="168">Linux</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableLinux.h</td>
</tr>
<tr align="center">
<td width="168">HP-UX</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableHpux.h</td>
</tr>
<tr align="center">
<td width="168">OpenVMS</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableVms.h</td>
</tr>
</table>
</ul>
<h5>idleConnectionTimeout</h5>
<ul>
<b>Description: </b>If set to a positive integer, this value
specifies a minimum timeout value for idle client connections.
If set to zero, idle client connections do not time out.<br>
<b>Recommended Default Value (Development 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 (Release Build): </b>No/No<br>
<b>Considerations: </b>A client connection is considered
idle when it is not in the process of sending a request and
the CIM Server is not processing a request from that connection.
An idle connection timeout allows reclamation of the system
resources allocated for idle CIM Server connections. Note that
the CIM Server may allow an idle connection to persist longer
than the configured timeout value based on server activity.
Some client applications may not behave correctly if a
connection timeout is introduced. Client compatibility should be
considered when configuring an idle connection timeout value.
The idle connection time is computed using the system clock.
Thus, resetting the system clock may cause unexpected timeout
behavior.<br>
</ul>
<h5>logdir</h5>
<ul>
<b>Description: </b>Specifies the name of the directory
to be used for the OpenPegasus specific log files.<br>
<b>Recommended Default Value (Development Build): </b>logs<br>
<b>Recommended Default Value (Release Build): </b>$LOGDIR<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>Dynamic?: </b>Yes<br>
<b>Considerations: </b>This option is not supported if
PEGASUS_USE_SYSLOGS is defined.<br>
<b>Source Configuration File: </b>
Pegasus/Config/LogPropertyOwner.cpp<br>
</ul>
<h5>logLevel</h5>
<ul>
<b>Description: </b>Defines the desired level of logging.
Valid values include: TRACE, INFORMATION, WARNING, SEVERE,
FATAL.<br>
<b>Default Value: </b>"INFORMATION"<br>
<b>Recommended Default Value (Development Build): </b>
"INFORMATION"<br>
<b>Recommended Default Value (Release Build): </b>"SEVERE"<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><br>
<b>Source Configuration File: </b>
Pegsus/Config/LogPropertyOwner.cpp<p> </p>
</ul>
<h5>maxProviderProcesses</h5>
<ul>
<b>Description:</b> Limits the number of provider
processes (see 'forceProviderProcesses) that may run
concurrently. A 'maxProviderProcesses' value of '0' indicates
that the number of Provider Agent processes is unlimited<br>
<b>Default Value: </b>0<br>
<b>Recommended Default Value (Development 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 (Release Build): </b>No/Yes<br>
<b>Dynamic?: </b>No<br>
<b>Considerations: </b><br>
<br>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC" width=531
style='font-size=10.0pt;font-family:Arial'>
<tr>
<th bgcolor="#CAE6CA" width="168">Platform</th>
<th bgcolor="#CAE6CA" width=350>
Source Configuration File</th>
</tr>
<tr align="center">
<td width="168">Linux</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableLinux.h</td>
</tr>
<tr align="center">
<td width="168">HP-UX</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableHpux.h</td>
</tr>
<tr align="center">
<td width="168">OpenVMS</td>
<td align="left" width="350">
Pegasus/Config/DefaultPropertyTableVms.h</td>
</tr>
</table>
</ul>
<h5>messageDir</h5>
<ul>
<b>Description: </b>Specifies the name of the directory to
be used for the OpenPegasus translated messages.<br>
<b>Default Value: </b>msg<br>
<b>Recommended Default Value (Development Build): </b>msg<br>
<b>Recommended Default Value (Release Build):</b>
$MESSAGEDIR/msg<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>Dynamic?: </b>No<br>
<b>Considerations: </b>Only used when message localization
is enabled. See PEGASUS_HAS_MESSAGES for details.<br>
<b>Source Configuration File: </b>
FileSystemPropertyOwner.cpp<br>
</ul>
<h5>providerDir</h5>
<ul>
<b>Description: </b>Specifies the names of the directories
that contains Provider executables.<br>
<b>Recommended Default Value (Development Build): </b>lib<br>
<b>Recommended Default Value (Release Build): </b>
$PROVIDERDIRS<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>Dynamic?: </b>No<br>
<b>Considerations: </b>The CIM Server runs as a privileged
user. And, since Providers run in the same process space as the
CIM Server, Providers also have privileged access to the
system. Allowing a registered Provider’s executable to be
replaced with malicious code would result in a critical
security defect, giving a malicious user privileged access
to the system. Adminstrators are responsible for ensuring
that only trusted Providers are loaded into providerDir.
In order to simplify the management task associated with
securing Provider executable, the value of providerDir can be
fixed at build time (i.e., set to one or more fixed, well-known
locations).<br>
<b>Source Configuration File: </b>
Pegasus/Config/FileSystemPropertyOwner.cpp<br>
</ul>
<h5>providerManagerDir</h5>
<ul>
<b>Description: </b>Specifies the name of the directory that
contains the ProviderManager plugin libraries.<br>
<b>Recommended Default Value (Development Build): </b>lib<br>
<b>Recommended Default Value (Release Build): </b>
$PROVIDERMANAGERDIRS<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>Dynamic?: </b>No<br>
<b>Considerations: </b>Should be a dedicated directory to
minimize inspection of non-applicable files. Additionally,
since all calls to the providers go through the provider
managers, the same care should be taken with regards to
security for the provider manager directory, as for provider
directories.<br>
<b>Source Configuration File: </b>
Pegasus/Config/FileSystemPropertyOwner.cpp<br>
</ul>
<h5>repositoryDir</h5>
<ul>
<b>Description: </b>Specifies the name of the directory
to be used for the OpenPegasus repository.<br>
<b>Recommended Default Value (Development Build): </b>repository<br>
<b>Recommended Default Value (Release Build): </b>
$REPOSITORYDIR/repository<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>Dynamic?: </b>No<br>
<b>Considerations: </b><br>
<b>Source Configuration File: </b>
Pegasus/Config/FileSystemPropertyOwner.cpp<p><br>
</ul>
<h5>repositoryIsDefaultInstanceProvider</h5>
<ul>
<b>Description: </b>If true, the Repository functions
as the Instance Provider for all classes for which there
is not an explicitly registered Provider. This flag is
also used to control the behavior of the repository when
processing association operators.<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/Yes<br>
<b>Dynamic?: </b>No<br>
<b>Considerations: </b>This flag can be used to configure
the CIM Server to allow the Repository to be used by CIM Clients
and CIM Providers as a dynamic data store. The setting of this
flag will significantly affect CIM Server behavior as viewed
by the CIM Client.<br>
The following issues should be considered when setting
repositoryIsDefaultInstanceProvider=true:
<ul>
<li><b>Authorization.</b> The repository has no
concept of which users (or components) are authorized to
perform which operations.</li>
<li><b>Appearance of instrumentation.</b> A client application
cannot determine whether instrumentation exists for a
given CIM class. For example, imagine a client
issues a CreateInstance operation on a Disk class
for which no provider is registered.
The instance will be stored in the repository, and
the client gets a "success" response. Does that mean a
disk device has been created on the server? Even worse,
when another client issues an EnumerateInstances
operation, the spurious Disk instance is returned.
With repositoryIsDefaultInstanceProvider=false, the
CreateInstance operation above would have returned a
NOT_SUPPORTED error.</li>
<li><b>Potential for inconsistent data.</b> Using the
repository as a data cache increases the probability
that a client will see stale or incorrect data. A
provider can better control the correlation
between the data returned and the current state of the
underlying managed resource (whether or not the provider
caches the data).</li>
</ul>
<br>
The following issues should be considered when setting
repositoryIsDefaultInstanceProvider=false:
<ul>
<li><b>Provider Availability.</b> Certain Providers have been
developed to use the Repository as a dynamic data store.
These Providers are currently not supported on system
where this flag is disabled. E.g., the Common Diagnostics
Model (CDM) Provider
(http://developer.intel.com/design/servers/cdm/)
relies on use of the Repository to store instances
of CIM_DiagnosticSetting. If this flag set to
false, this Provider will not function correctly. Note
that this feature is supported by other WBEM
implementation. Therefore, disabling this feature
can increase the cost of migrating existing Providers to
OpenPegasus.</li>
</ul>
<b>Source Configuration File: </b>
Pegasus/Config/RepositoryPropertyOwner.cpp<br>
</ul>
<h5>shutdownTimeout</h5>
<ul>
<b>Description: </b>When a cimserver -s shutdown command is
issued, specifies the maximum time in seconds for the CIM Server
to complete outstanding CIM operation requests before shutting
down; if the specified timeout period expires, the CIM Server
will shut down, even if there are still CIM operations in
progress. Minimum value is 2 seconds.<br>
<b>Recommended Default Value (Development 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 (Release Build):</b>No/No<br>
<b>Dynamic?: </b>Yes<br>
<b>Considerations: </b><br>
<b>Source Configuration File: </b>
Pegasus/Config/ShutdownPropertyOwner.cpp<br>
</ul>
<h5>slp</h5>
<ul>
<b>Description: </b>When set to true, OpenPegasus activates
an SLP SA and issues DMTF defined SLP advertisements to this SA
on startup.<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>Yes<br>
<b>Dynamic?: </b>No<p> <br>
<br>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC" width=531
style='font-size=10.0pt;font-family:Arial' height="80">
<tr>
<th bgcolor="#CAE6CA" width="168" height="16">Platform</th>
<th bgcolor="#CAE6CA" width=350 height="16">
Source Configuration File</th>
</tr>
<tr align="center">
<td width="168" height="14">Linux</td>
<td align="left" width="350" height="14">
Pegasus/Config/DefaultPropertyTableLinux.h</td>
</tr>
<tr align="center">
<td width="168" height="14">HP-UX</td>
<td align="left" width="350" height="14">
Pegasus/Config/DefaultPropertyTableHpux.h</td>
</tr>
<tr align="center">
<td width="168" height="16">OpenVMS</td>
<td align="left" width="350" height="16">
Pegasus/Config/DefaultPropertyTableVms.h</td>
</tr>
</table>
</ul>
<h5>socketWriteTimeout</h5>
<ul>
<b>Description: </b>If the CIM Server receives an
EWOULDBLOCK/EAGAIN error on a non-blocking write,
socketWriteTimeout defines the number of seconds the
CIM Server will wait for the socket to get ready and resume
writing data.<br>
<b>Recommended Default Value (Development 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 (Release Build): </b>No/No<br>
<b>Dynamic?: </b>No<br>
<b>Source Configuration File: </b>
Pegasus/Config/DefaultPropertyTable.h
</ul>
<h5>sslCertificateFilePath</h5>
<ul>
<b>Description: </b>Contains the CIM Server SSL
Certificate.<br>
<b>Recommended Default Value (Development Build): </b>
server.pem<br>
<b>Recommended Default Value (Release Build): </b>
$CERTIFICATEDIR/server.pem"<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>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
</ul>
<h5>sslClientVerificationMode</h5>
<ul>
<b>Description: </b>Describes the desired level of support
for certificate-based authentication.
<ul style="MARGIN-TOP: 0in" type="circle">
<li>“<b>required</b>” – The server requires certificate-based
client authentication. A client MUST present a
trusted certificate in order to access the CIM Server.
If the client fails to send a certificate or sends an
untrusted certificate, the connection will be rejected.</li>
<li>“<b>optional</b>” – The server supports, but does not
require, certificate-based client authentication. The
server will request and attempt to validate a client
certificate, however the connection will be accepted even
if no certificate is sent or an untrusted certificate is
sent. The server will then seek to authenticate the
client via an authentication header.</li>
<li>“<b>disabled</b>” – The server does not support
certificate-based client authentication.</li>
</ul>
<b>Recommended Default Value (Development Build): </b>
disabled<br>
<b>Recommended Default Value (Release Build): </b>
disabled<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>(1) This property is only used if
<b>enableHttpsConnection</b> is <b>"true"</b>.
(2) If the platform does not support PEGASUS_LOCAL_DOMAIN_SOCKET,
OpenPegasus attempts to use either HTTPS or
HTTP to establish a local connection (connectLocal).
For platforms that do not support PEGASUS_LOCAL_DOMAIN_SOCKET,
Clients which use connectLocal, such as cimconfig -l -c,
cimprovider -l -s and cimserver -s, will not work if the
"sslClientVerificationMode" variable is set to
"required" and HTTP is disabled. For these
platforms, the recommended course of action is to change the
property value to "optional."<br>
<b>Source Configuration File: </b>
Pegasus/Config/SecurityPropertyOwner.cpp
</ul>
<h5>sslKeyFilePath</h5>
<ul>
<b>Description: </b>Contains the private key for the CIM
Server SSL Certificate.<br>
<b>Recommended Default Value (Development Build): </b>
file.pem<br>
<b>Recommended Default Value (Release Build): </b>
$CERTIFICATEDIR/file.pem<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>Dynamic?: </b>No<br>
<b>Considerations: </b>File should be readable only by the
user the cimserver is running as and/or privileged users. The
file should be writeable only by a privileged user.<br>
<b>Source Configuration File: </b>
Pegasus/Config/SecurityPropertyOwner.cpp<br>
</ul>
<h5>sslTrustStore</h5>
<ul>
<b>Description: </b>Specifies the location of the OpenSSL
truststore. Consistent with the OpenSSL implementation, a
truststore can be either a file or directory. If the truststore
is a directory, all the certificates within the directory are
considered trusted.<br>
<b>Recommended Default Value (Development Build): </b>
client.pem<br>
<b>Recommended Default Value (Release Build): </b>
$CERTIFICATEDIR/client.pem<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>Dynamic?: </b>No<br>
<b>Source Configuration File: </b>
Pegsus/Config/SecurityPropertyOwner.cpp
</ul>
<h5>sslTrustStoreUserName</h5>
<ul>
<b>Description: </b>Specifies the system user name to be
associated with all certificate-based authenticated requests.<br>
<b>Recommended Default Value (Development Build): </b>NONE<br>
<b>Recommended Default Value (Release Build): </b>NONE<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 property has no default; for
security reasons, the system administrator must explicitly
specify this value. This feature allows a single user
name to be specified. This user will be associated
with all certificates in the truststore. In the future,
OpenPegasus will allow a system administrator to associate a
distinct user name with each certificate.<br>
<b>Source Configuration File: </b>
Pegsus/Config/SecurityPropertyOwner.cpp<br>
</ul>
<h5>traceComponents</h5>
<ul>
<b>Description: </b>Defines the components to be traced.<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/Yes<br>
<b>Dynamic?: </b>Yes<br>
<b>Source Configuration File: </b>
Pegasus/Config/TracePropertyOwner.cpp<br>
</ul>
<h5>traceFacility</h5>
<ul>
<b>Description: </b>Defines the desired facility for trace
messages. Valid values include: "File"
and "Log".<br>
<b>Default Value: </b>File<br>
<b>Recommended Default Value (Development Build): </b>File<br>
<b>Recommended Default Value (Release Build): </b>File<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>Case Sensitive?: </b>No<br>
<b>Considerations: </b>If you specify "File",
trace messagesare written into the file specified by the
configuration option traceFilePath. If you specify
"Log", trace messages are written to the
OpenPegasus Log.<br>
<b>Source Configuration File: </b>
Pegasus/Config/TracePropertyOwner.cpp<br>
</ul>
<h5>traceFilePath</h5>
<ul>
<b>Description: </b>Specifies the location of the
OpenPegasus trace file.<br>
<b>Default Value: </b>cimserver.trc<br>
<b>Recommended Default Value (Development Build):</b>
cimserver.trc<br>
<b>Recommended Default Value (Release Build): </b>
$TRACEDIR/cimserver.trc<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>Dynamic?: </b>Yes<br>
<b>Source Configuration File: </b>
Pegasus/Config/TracePropertyOwner.cpp<br>
</ul>
<h5>traceLevel</h5>
<ul>
<b>Description: </b></b>Defines the desired level of
tracing. Valid values include: 0, 1, 2, 3, 4, 5.<br>
<b>Default Value: </b>0<br>
<b>Recommended Default Value (Development 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 (Release Build): </b>No/Yes<br>
<b>Dynamic?: </b>Yes<br>
<b>Source Configuration File: </b>
Pegasus/Config/TracePropertyOwner.cpp<br>
</ul>
<h3>Configuration Constants</h3>
<h4>Definitions</h4>
<h5>static char CURRENT_CONFIG_FILE [] = </h5>
<ul>
<b>Description: </b>Default file name for the current
configuration file.<br>
<b>Recommended Default Value (Development Build):</b>
cimserver_current.conf<br>
<b>Recommended Default Value (Release Build): </b>
$CONFIGDIR/cimserver_current.conf<br>
<b>Dynamic?: </b>No <br>
<br>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC" width=531
style='font-size=10.0pt;font-family:Arial'>
<tr>
<th bgcolor="#CAE6CA" width="168">Platform</th>
<th bgcolor="#CAE6CA" width=350>
Source Configuration File</th>
</tr>
<tr align="center">
<td width="168">Linux</td>
<td align="left" width="350">
Pegasus/Config/ConfigFileDirLinux.h</td>
</tr>
<tr align="center">
<td width="168">HP-UX</td>
<td align="left" width="350">ConfigFileDirHpux.h</td>
</tr>
<tr align="center">
<td width="168">OpenVMS</td>
<td align="left" width="350">
Pegasus/Config/ConfigFileDirVms.h</td>
</tr>
</table>
</ul>
<h5>static char PLANNED_CONFIG_FILE [] = </h5>
<ul>
<b>Description: </b>Default file name for the planned
configuration file.<br>
<b>Recommended Default Value (Development Build): </b>
cimserver_planned.conf<br>
<b>Recommended Default Value (Release Build): </b>
$CONFIGDIR/cimserver_planned.conf<br>
<b>Dynamic?: </b>No<br>
<br>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC" width=531
style='font-size=10.0pt;font-family:Arial'>
<tr>
<th bgcolor="#CAE6CA" width="168">Platform</th>
<th bgcolor="#CAE6CA" width=350>
Source Configuration File</th>
</tr>
<tr align="center">
<td width="168">Linux</td>
<td align="left" width="350">
Pegasus/Config/ConfigFileDirLinux.h</td>
</tr>
<tr align="center">
<td width="168">HP-UX</td>
<td align="left" width="350">
Pegasus/Config/ConfigFileDirHpux.h</td>
</tr>
<tr align="center">
<td width="168">OpenVMS</td>
<td align="left" width="350">
Pegasus/Config/ConfigFileDirVms.h</td>
</tr>
</table>
</ul>
<h5>static char CIMSERVER_START_FILE [] = </h5>
<ul>
<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>Recommended Default Value (Development Build): </b>
/tmp/cimserver_start.conf<br>
<b>Recommended Default Value (Release Build): </b>
$PIDFILE<br>
<b>Dynamic?: </b>No<br>
<br>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC" width=531
style='font-size=10.0pt;font-family:Arial'>
<tr>
<th bgcolor="#CAE6CA" width="168">Platform</th>
<th bgcolor="#CAE6CA" width=350>
Source Configuration File</th>
</tr>
<tr align="center">
<td width="168">Linux</td>
<td align="left" width="350">
Pegasus/Config/ConfigFileDirLinux.h</td>
</tr>
<tr align="center">
<td width="168">HP-UX</td>
<td align="left" width="350">
Pegasus/Config/ConfigFileDirHpux.h</td>
</tr>
<tr align="center">
<td width="168">OpenVMS</td>
<td align="left" width="350">
Pegasus/Config/ConfigFileDirVms.h</td>
</tr>
</table>
</ul>
<h3>Configuration Macros</h3>
<h4>Definitions</h4>
<h5>PEGASUS_SSLCLIENT_CERTIFICATEFILE</h5>
<ul>
<b>Description: </b><br>
<b>Recommended Default Value (Development Build): </b>client.pem<br>
<b>Recommended Default Value (Release Build): </b>
$CERTIFICATEDIR/client.pem<br>
<b>Dynamic?: </b>No<br>
<b>Source Configuration File: </b>
Pegasus/Common/Constants.h<br>
</ul>
<h5>PEGASUS_SSLCLIENT_RANDOMFILE</h5>
<ul>
<b>Description: </b>On platforms that do not support
/dev/random or /dev/urandom, OpenSSL will use this file to
seed the PRNG (Pseudo-Random Number Generator). This
PEGASUS_SSLCLIENT_RANDOMFILE defines the default CIM
Client random file.<br>
<b>Recommended Default Value (Development Build):</b>ssl.rnd<br>
<b>Recommended Default Value (Release Build):</b>
$RANDOMDIR/ssl.rnd<br>
<b>Dynamic?: </b>No<br>
<b>Considerations: </b>Use of this variable requires
PEGASUS_HAS_SSL to be set. CIM Client use of a
shared random file is not recommended. On systems where
/dev/random or /dev/urandom are not available, CIM Clients are
encouraged to generate a unique random file which
contains sufficient entropy.<br>
<b>Source Configuration File: </b>
Pegasus/Common/Constants.h<br>
</ul>
<h5>PEGASUS_SSLSERVER_RANDOMFILE</h5>
<ul>
<b>Description: </b>On platforms that do not support
/dev/random or /dev/urandom, OpenSSL will use this file
to seed the PRNG (Pseudo-Random Number Generator). This
PEGASUS_SSLSERVER_RANDOMFILE defines the CIM Server
random file.<br>
<b>Recommended Default Value (Development Build): </b>
cimserver.rnd<br>
<b>Recommended Default Value (Release Build): </b>
$RANDOMDIR/cimserver.rnd<br>
<b>Dynamic?: </b>No<br>
<b>Considerations: </b>1)Use of this variable
requires PEGASUS_HAS_SSL to be set.(2) On systems where
/dev/random or /dev/urandom are not available, CIM Server
vendors need to be sure that the cimserver.rnd file
contains sufficient entropy and is uniquely generated for
each system.<br>
<b>Source Configuration File: </b>
Pegasus/Common/Constants.h<b><br>
</ul>
<h5>PEGASUS_LOCAL_AUTH_DIR</h5>
<ul>
<b>Description:</b> </b>For local connections (i.e.,
connectLocal), OpenPegasus uses a file-based authentication
mechanism.<br>
<b>Recommended Default Value (Development Build): </b>/tmp<br>
<b>Recommended Default Value (Release Build): </b>
$LOCALAUTHDIR/localauth<br>
<b>Dynamic?: </b>No<br>
<b>Source Configuration File: </b>
Pegasus/Common/Constants.h<br>
</ul>
<h5>PEGASUS_LOCAL_DOMAIN_SOCKET_PATH</h5>
<ul>
<b>Description: </b><br>
<b>Recommended Default Value (Development Build): </b>
/tmp/cimxml.socket<br>
<b>Recommended Default Value (Release Build): </b>
$SOCKETDIR/cimxml.socket<br>
<b>Dynamic?: </b>No<br>
<b>Source Configuration File: </b>
Pegasus/Common/Constants.h<br>
</ul>
<hr>
<p><font size="2">
Copyright (c) 2004 EMC Corporation; Hewlett-Packard Development
Company, L.P.; IBM Corp.; The Open Group; VERITAS Software Corporation<br>
Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
EMC Corporation; Symantec Corporation; The Open Group.<br>
<br>
Permission is hereby granted, free of charge, to any person
obtaining a 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 Software is
furnished to do so, subject to the following conditions:
<br><br>
THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED
IN ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE
SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
</font></p>
<hr>
<p>Template last modified: January 20th 2004 by Martin Kirk<br>Template version: 1.6</p>
</body>
</html>
| No CVS admin address has been configured |
Powered by ViewCVS 0.9.2 |