pegasus/doc/BuildAndReleaseOptions.html - diff

Return to BuildAndReleaseOptions.html CVS log

Up to [Pegasus] / pegasus / doc

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

version 1.13.2.2, 2010/07/15 09:36:52

version 1.51, 2014/10/30 12:52:17

Line 1

<html>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<head>

"http://www.opengroup.org/stylesheets/info1.css">

</head>

<body>

<hr>

</head><body>

Recommended OpenPegasus Build and Configuration Options for Selected Platforms

<hr>

Recommended OpenPegasus Build and

Configuration Options for Selected Platforms

<hr>

Abstract: This document defines a set of recommended

Abstract:

options for building, testing and running OpenPegasus on a selected set

This document defines a set of recommended options for building,

of platforms. In this version of the document, platform-specific

testing and running OpenPegasus on a selected set of

configuration information have been documented for the platforms

platforms. In this version of the document, platform-specific configuration

described in the "Documented Platforms" section of this document.

information have been documented for the platforms described in the

"Documented Platforms" section of this document.

Note 1:

Note 1: The recommendations defined in this document are

The recommendations defined in this document are not intended to document

not intended to document the feature set included in any vendor's

the feature set included in any vendor's OpenPegasus-based product.

OpenPegasus-based product. Rather, the purpose of this document is to

Rather, the purpose of this document is to provide input to vendors when

provide input to vendors when making product decisions.

making product decisions.

<hr>

<h2>Definition of the Problem</h2>

OpenPegasus supports a large number of build and runtime options.

Determining which options to use can be challenging. The purpose of this

Determining which options to use can be challenging. The purpose of

document is to simplify the build, testing and administration of OpenPegasus

this

document is to simplify the build, testing and administration of

OpenPegasus

by providing a recommended, tested set of options.

<h2>Documented Platforms</h2>

Line 47

Line 43

additional information.

<ul>

<table border="1" cellspacing="1" bordercolordark="#666666"

bordercolorlight="#CCCCCC" width=20%>

<tbody>

<tr>

<th bgcolor="#CAE6CA" align=center>Platform</th>

<th align="center" bgcolor="#cae6ca">Platform</th>

<th bgcolor="#CAE6CA" align=center>Status</th>

<th align="center" bgcolor="#cae6ca">Status</th>

</tr>

Line 78

Line 75

</tr>

<td>LINUX_PPC_E500_GNU</td>

</tr>

<td>LINUX_SH4_GNU</td>

</tr>

<td>LINUX_XSCALE_GNU</td>

</tr>

Line 97

Line 102

<td>VMS_IA64_DECCXX</td>

</tr>

</tbody>

</table>

</ul>

<h2>Proposed Solution</h2>

<h3>Security Considerations</h3>

<ol>

<li>

To avoid introducing security vulnerabilities, vendors must never

<li> To avoid introducing security vulnerabilities, vendors must

ship providers incompatible with the security assumptions used in

never ship providers incompatible with the security assumptions used in

their deployment.

their deployment. For example, providers designed for a single-user

For example, providers designed for a single-user deployment that

deployment that don't perform authorization must not be shipped with a

don't perform authorization must not be shipped with a CIM Server

CIM Server that expects the providers to perform authorization. Note

that expects the providers to perform authorization. Note that

that this authorization burden is considerably lighter if the provider

this authorization burden is considerably lighter if the provider

is registered as 'run as requestor' and if the CIM Server enables that

is registered as 'run as requestor' and if the CIM Server enables

feature. See <a href="http://www.openpegasus.org/pp/uploads/40/7197/SecurityGuidePEP.htm">

that feature. See <a href=

PEP#223 - Security Coding Guidelines</a> for additional details. </li>

"http://www.openpegasus.org/pp/uploads/40/7197/SecurityGuidePEP.htm">

<li> Vendors should ensure they configure the CIM Server consistently

PEP#223 - Security Coding Guidelines</a> for additional

with the security requirements of their deployment. </li>

details.

</li>

<li>

Vendors should ensure they configure the CIM Server consistently

with the security requirements of their deployment.

</li>

</ol>

<h3>Terminology Notes</h3>

<ol>

<li>

In this document, the term "Not Set" is used to indicate

<li> In this document, the term "Not Set" is used to indicate that

that the a value for the environment variable has not been defined.

the a value for the environment variable has not been defined. "Set" is

"Set" is used to indicate that the value must be defined,

used to indicate that the value must be defined, but the actual value

but the actual value of the variable is not checked.

of the variable is not checked. </li>

</li>

</ol>

<h3>General Notes</h3>

<ol>

<li>

Not all functionality described in this document has achieved

<li> Not all functionality described in this document has achieved

"Green"status, please refer to the

"Green"status, please refer to the <a href="http://www.openpegasus.org/page.tpl?CALLER=index.tpl&ggid=799">

OpenPegasus Project Feature Status </a>page for information on the

OpenPegasus Project Feature Status </a>page for information on

maturity level of OpenPegasus features. </li>

the maturity level of OpenPegasus features.

<li> To encourage testing of new functionality, recommendations for

</li>

the Development Build may include features that are not yet recommended

<li>

for Release Builds. </li>

To encourage testing of new functionality, recommendations for the

Development Build may include features that are not yet recommended

for Release Builds.

</li>

</ol>

<h3>Environment Variable Settings for Building OpenPegasus</h3>

Line 156

Line 153

<h4>Definitions</h4>

<h5>ICU_INSTALL</h5>

<ul>

Description: 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'

Components for Unicode)</a> installation. The 'include' subdirectory is

subdirectory is used to locate ICU header files at build time. The

used to locate ICU header files at build time. The 'lib' subdirectory

'lib' subdirectory is used to locate ICU libraries at link

is used to locate ICU libraries at link time.

time.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Required: No.  However, if PEGASUS_HAS_ICU is

Required: No.  However, if PEGASUS_HAS_ICU is set

set and ICU_INSTALL is not defined, the ICU libraries and header

and ICU_INSTALL is not defined, the ICU libraries and header files are

files are expected to be installed in directories (e.g.,/usr/lib,

expected to be installed in directories (e.g.,/usr/lib,

/usr/include)  that are searched by default.

Considerations: This environment variable is only used

Considerations: This environment variable is only used if

if PEGASUS_HAS_MESSAGES is set. Refer to PEGASUS_HAS_MESSAGES for

PEGASUS_HAS_MESSAGES is set. Refer to PEGASUS_HAS_MESSAGES for

additional details.

</ul>

<h5>ICU_NO_UPPERCASE_ROOT</h5>

<ul>

Description: If set, the messages in the root resource

bundle will NOT be capitalized. By default, the root resource

bundle is capitalized.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Required: No

Considerations: 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>

Description: If set, specifies the language

to be used to generate the root resource bundle. The

Description: If set, specifies the language to be used to

default value for ICU_ROOT_BUNDLE_LANG is _en.

generate the root resource bundle. The default value for

ICU_ROOT_BUNDLE_LANG is _en.

Default Value: _en

Recommended Value (Development Build): No

Recommended Value (Development Build): No Recommendation

Recommendation

Recommended Value (Release Build): No Recommendation

Required: No

Considerations: This environment variable is

Considerations: This environment variable is only used if

only used if PEGASUS_HAS_MESSAGES is set. Refer to

PEGASUS_HAS_MESSAGES is set. Refer to PEGASUS_HAS_MESSAGES for

PEGASUS_HAS_MESSAGES for additional details.

additional details.

If set, resource bundles for the designated language must

If set, resource bundles for the designated language must exist for the

exist for the following files:

following files:

<ul>

<li>pegasus/src/Pegasus/msg/Server/pegasusServer_en.txt</li>

<li>pegasus/src/Pegasus/msg/Listener/pegasusListener_en.txt</li>

</ul>

<h5>OPENSSL_BIN</h5>

<ul>

Description: Specifies the location of the

OpenSSL binary directory.

Description: Specifies the location of the OpenSSL binary

directory.

Default Value: Not Set

Recommended Value (Development Build):

Recommended Value (Development Build):  No Specific

No Specific Recommendation

Recommendation

Recommended Value (Release Build):

Recommended Value (Release Build):  No Specific

No Specific Recommendation

Recommendation

Required: No. By default, the openssl binary is

Required: No. By default, the openssl binary is expected

expected to be installed in a directory that is searched by default

to be installed in a directory that is searched by default (e.g.,

(e.g., /usr/bin). For platforms where this isn't true, the

/usr/bin). For platforms where this isn't true, the OPENSSL_BIN

OPENSSL_BIN environment variable may be used to define an

environment variable may be used to define an alternative path. This

alternative path. This environment variable is only used if

environment variable is only used if PEGASUS_HAS_SSL is set.

PEGASUS_HAS_SSL is set.

</ul>

<h5>OPENSSL_HOME</h5>

<ul>

Description: Specifies the location of the OpenSSL

SDK directory. This directory must contain the OpenSSL

Description: Specifies the location of the OpenSSL SDK

include directory, $(OPENSSL_HOME)/include, and the OpenSSL

directory. This directory must contain the OpenSSL include

library directory, $(OPENSSL_HOME)/lib.

directory, $(OPENSSL_HOME)/include, and the OpenSSL library

directory, $(OPENSSL_HOME)/lib.

Default Value: Not Set

Recommended Value (Development Build):

Recommended Value (Development Build):  No Specific

No Specific Recommendation

Recommendation

Recommended Value (Release Build):

Recommended Value (Release Build):  No Specific

No Specific Recommendation

Recommendation

Required: Yes for Windows, if PEGASUS_HAS_SSL

Required: Yes for Windows, if PEGASUS_HAS_SSL is set. No

is set. No for all other platforms. For AIX, the default

for all other platforms. For AIX, the default value for OPENSSL_HOME is

value for OPENSSL_HOME is /usr/linux.  For all other

/usr/linux.  For all other platforms, the OpenSSL include files

platforms, the OpenSSL include files and libraries are expected

and libraries are expected to be installed in directories that are

to be installed in directories that are searched by default (e.g.,

searched by default (e.g., /usr/bin, /usr/lib(64), and /usr/include).

/usr/bin, /usr/lib(64), and /usr/include).

For platforms where the default value is not correct, the OPENSSL_HOME

For platforms where the default value is not correct, the

environment variable may be used to define an alternative path (i.e.,

OPENSSL_HOME environment variable may be used to define an

$(OPENSSL_HOME)/lib and $(OPENSSL_HOME)/include). This environment

alternative path (i.e., $(OPENSSL_HOME)/lib and

variable is only used if PEGASUS_HAS_SSL is set.

$(OPENSSL_HOME)/include). This environment variable

is only used if PEGASUS_HAS_SSL is set.

</ul>

<h5>PEGASUS_ALLOW_ABSOLUTEPATH_IN_PROVIDERMODULE</h5>

<ul>

Description: If set to true, a version of OpenPegasus

will be built that allows an absolute path to be specified as the

will be built that allows an absolute path to be specified as the value

value of the Location property of PG_ProviderModule class. 

of the Location property of PG_ProviderModule class.  Otherwise it

Otherwise it does not allow the absolute path to be specified.

does not allow the absolute path to be specified.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Required: No

Required: No

Considerations: To avoid introducing security

Considerations: To avoid introducing security

vulnerabilities, vendors should analyze their deployment

vulnerabilities, vendors should analyze their deployment environments

environments to understand the security implications of allowing

to understand the security implications of allowing providers to be

providers to be loaded from a dynamically changing set of

loaded from a dynamically changing set of directories.

directories.

</ul>

<h5>PEGASUS_CCOVER</h5>

<ul>

Description: 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

HP-UX_11iv3_Integrity_C-Cover.  This system is used to generate

used to generate the nightly BullseyeCoverage code coverage

the nightly BullseyeCoverage code coverage metrics.

metrics.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Required: No

Considerations: This flag is only supported on HP-UX to enable

Considerations: This flag is only supported on HP-UX to

CCOVER for the NB&T system.

enable CCOVER for the NB&T system.

</ul>

<h5>PEGASUS_CIM_SCHEMA</h5>

<ul>

Description: This variable is used internally by the

OpenPegasus development team when upgrading the OpenPegasus build

OpenPegasus development team when testing OpenPegasus in the integrated

environment to a new version of the CIM Schema.

build/test environment. It defines the version of the CIM Schema (which

Default Value: CIM217

must exist in the $(PEGASUS_ROOT)/Schemas directory) that will be used

to build the class repository for testing the pegasus environment

("make repository", etc.).

Default Value: CIM241 (Note that this may change as newer versions of the CIM Schema are used as the default.

Recommended Value (Development Build):

No Specific Recommendation

Recommended Value (Release Build):

No Specific Recommendation

Required: No

Considerations: Additional code changes may be required when

Considerations:

upgrading or downgrading the CIM Schema version.

Additional code changes may be required when upgrading or downgrading

the CIM Schema version from the default.  The default CIM Schema

is defined in the file $(PEGASUS_ROOT)/mak/config.mak.

</ul>

<h5>PEGASUS_CLASS_CACHE_SIZE</h5>

<ul>

Description: This environment variable gives the size of

Line 309

Line 307

Default Value: 8

Recommended Value (Development Build): 8

Recommended Value (Release Build): 8

Required: No

Required: No

</ul>

<h5>PEGASUS_DEBUG</h5>

Line 325

Line 323

</ul>

<h5>PEGASUS_DEFAULT_USERCTXT_REQUESTOR</h5>

<ul>

Description:  If set to true, the Requestor user

context is used for providers that do not specify a UserContext

context is used for providers that do not specify a UserContext value

value in their registration. Otherwise, the Privileged user

in their registration. Otherwise, the Privileged user context

context value is used by default.

value is used by default.

Default Value: false

Recommended Value (Development Build): false

Recommended Value (Release Build): false

Required: No

Required: No Considerations: Use of the Requestor

Considerations: Use of the Requestor default has

default has improved provider security characteristics. However, some

improved provider security characteristics. However, some providers

providers may not operate correctly when run in the Requestor

may not operate correctly when run in the Requestor user

user context and setting this value to true may cause those providers

context and setting this value to true may cause those providers to

to fail.  Providers that can run in the Requestor user

fail.  Providers that can run in the Requestor

context are encouraged to explicitly set the UserContext value in their

user context are encouraged to explicitly set the UserContext value

registration rather than rely on the default setting default by this

in their registration rather than rely on the default setting

variable. Please refer to SecurityGuidelinesForDevelopers.html. PEP 223

default by this variable. Please refer to

for a discussion of the rationale/advantages of running providers in

SecurityGuidelinesForDevelopers.html. PEP 223 for a discussion

the Requestor user context. Note: This build variable

of the rationale/advantages of running providers in the

is not meaningful if the Provider User Context feature is disabled with

Requestor user context. Note: This build

the PEGASUS_DISABLE_PROV_USERCTXT setting. 

variable is not meaningful if the Provider User Context feature is

disabled with the PEGASUS_DISABLE_PROV_USERCTXT

setting. 

</ul>

<h5>PEGASUS_DEFAULT_ENABLE_OOP</h5>

<ul>

Description: When this variable is set to false, by

default, Providers are run in the cimserver process

(forceProviderProcesses=false). If this value is set true,

(forceProviderProcesses=false). If this value is set true, Providers

Providers are run out-of-process by default.

are run out-of-process by default.

Default Value: true for HP-UX and Linux, false for

Default Value: true for HP-UX and Linux, false for other

other platforms

platforms

Recommended Value (Development Build): true (HP-UX,

Recommended Value (Development Build): true (HP-UX, Linux)

Linux)

Recommended Value (Release Build): true (HP-UX, Linux)

Recommended Value (Release Build): true (HP-UX,

Linux)

Required: No

Considerations: This environment variable can be used to

change the "hard-coded" default setting for the

change the "hard-coded" default setting for the forceProviderProcesses

forceProviderProcesses configuration value. 

configuration value.  Refer to the definition of forceProviderProcesses

Refer to the definition of forceProviderProcesses for

for additional information.

additional information.

</ul>

<h5>PEGASUS_DEST_LIB_DIR</h5>

<ul>

Description: Specifies the location of OpenPegasus

shared libraries.

Description: Specifies the location of OpenPegasus shared

libraries.

Default Value: $(PEGASUS_HOME)/lib

Recommended Value (Development Build):

$(PEGASUS_HOME)/lib

Recommended Value (Release Build):

Recommended Value (Release Build):  No Specific

No Specific Recommendation

Recommendation

Required: No

Considerations: This variable is NOT is used to define

the location of the Provider library directories. 

the location of the Provider library directories.  Please refer to

Please refer to the providerDir configuration option for details

the providerDir configuration option for details on defining the

on defining the directories for the Provider libraries.

directories for the Provider libraries.

</ul>

<h5>PEGASUS_DISABLE_DEPRECATED_INTERFACES</h5>

<ul>

Description: Removes deprecated symbol definitions

from OpenPegasus runtime libraries.

Description: Removes deprecated symbol definitions from

OpenPegasus runtime libraries.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Required: No

Considerations: If this option is set, the resulting

OpenPegasus libraries will not be binary compatible with

OpenPegasus libraries will not be binary compatible with clients and

clients and providers built using interface definitions from

providers built using interface definitions from prior releases. This

prior releases. This option may be used to slightly reduce binary

option may be used to slightly reduce binary footprint in an

footprint in an environment where compatibility is not required.

environment where compatibility is not required.

</ul>

<h5>PEGASUS_DISABLE_INSTANCE_QUALIFIERS</h5>

<ul>

Description: In the CIM Infrastructure Specification,

version 2.3, the DMTF clarified that instance-level qualifiers are

version 2.3, the DMTF clarified that instance-level qualifiers are not

not allowed.  In Version 1.2 of the Specification CIM

allowed.  In Version 1.2 of the Specification CIM Operations over

Operations over HTTP, use of the IncludeQualifiers parameter has

HTTP, use of the IncludeQualifiers parameter has been DEPRECATED.

been DEPRECATED.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Required: No

Considerations: Existing CIM Clients may depend on

qualifiers being returned in the response. In this case, the

PEGASUS_DISABLE_INSTANCE_QUALIFIERS should not be set. 

PEGASUS_DISABLE_INSTANCE_QUALIFIERS should not be set.  If this

If this flag is set, the value of the IncludeQualifiers parameter

flag is set, the value of the IncludeQualifiers parameter passed on the

passed on the GetInstance and EnumerateInstance operations is

GetInstance and EnumerateInstance operations is ignored and qualifiers

ignored and qualifiers are not returned. 

are not returned.  Disabling the return of qualifiers as part of a

Disabling the return of qualifiers as part of a CIM Instance will

CIM Instance will improve performance.

improve performance.

</ul>

<h5>PEGASUS_DISABLE_LOCAL_DOMAIN_SOCKET</h5>

<ul>

Description: Disables support for local (same-system)

connections over a Unix domain socket. If this option is NOT set,

connections over a Unix domain socket. If this option is NOT set, the

the CIM Server is built to allow connections to be established

CIM Server is built to allow connections to be established using a

using a domain socket rather than a TCP port.

domain socket rather than a TCP port.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Required: No

Considerations: (1) In high-threat environments, a

customer may want to disable all ports or reduce the number of

customer may want to disable all ports or reduce the number of exposed

exposed network ports. Supporting a local connection mechanism

network ports. Supporting a local connection mechanism using Unix

using Unix domain socket allows the CIM Server to continue to

domain socket allows the CIM Server to continue to receive and process

receive and process requests from local CIM Clients. (2)

requests from local CIM Clients. (2) Enabling this option may result in

Enabling this option may result in lose of functionality when

lose of functionality when sslClientVerificationMode = required. (3)The

sslClientVerificationMode = required. (3)The

"LOCAL_DOMAIN_SOCKET" functionality has not been implemented for 

"LOCAL_DOMAIN_SOCKET" functionality has not been

Windows or OpenVMS.  Therefore, by default, this option is "Set"

implemented for  Windows or OpenVMS.  Therefore, by

for Windows and OpenVMS platforms.

default, this option is "Set" for Windows and OpenVMS

platforms.

</ul>

<h5>PEGASUS_DISABLE_PERFINST</h5>

<ul>

Description: Builds a version of OpenPegasus that

disables support for gathering performance data.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Set

Required: No

Considerations: The CIM_ObjectManager.GatherStatisticalData

Considerations: The

property is used to control statistic gathering.  Once enabled,

CIM_ObjectManager.GatherStatisticalData property is used to control

statistical data can be viewed by retrieving instances of the

statistic gathering.  Once enabled, statistical data can be viewed

CIM_StatisticalData class. Support for gathering performance

by retrieving instances of the CIM_StatisticalData class. Support for

data requires PEGASUS_ENABLE_INTEROP_PROVIDER to be enabled. If

gathering performance data requires PEGASUS_ENABLE_INTEROP_PROVIDER to

PEGASUS_ENABLE_INTEROP_PROVIDER is explicitly disabled (i.e., set

be enabled. If PEGASUS_ENABLE_INTEROP_PROVIDER is explicitly disabled

to false),  then PEGASUS_DISABLE_PERFINST must be set to

(i.e., set to false),  then PEGASUS_DISABLE_PERFINST must be set

true.  If PEGASUS_DISABLE_PERFINST is not defined or set to

to true.  If PEGASUS_DISABLE_PERFINST is not defined or set to

false and PEGASUS_ENABLE_INTEROP_PROVIDER is not set,

PEGASUS_ENABLE_INTEROP_PROVIDER will be automatically enabled.

</ul>

<h5>PEGASUS_DISABLE_PRIVILEGED_TESTS</h5>

<ul>

Description: This variable is used only in the development

environment to restrict the level of testing performed by default.

Description: This variable is used only in the

If set, tests that require the CIM Server to run in a privileged

development environment to restrict the level of testing performed by

mode will not be run.  Setting this variable allows

default. If set, tests that require the CIM Server to run in a

developers, without privileged access, to successfully run a

privileged mode will not be run.  Setting this variable allows

subset of the OpenPegasus test suit.  This variable does

developers, without privileged access, to successfully run a subset of

not affect CIM Server functionality.  It merely controls

the OpenPegasus test suit.  This variable does not affect CIM

the level of testing.

Server functionality.  It merely controls the level of testing.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Used

Required: No

Considerations: Enabling this variable will significantly

reduce the testing of security related features (e.g.,

reduce the testing of security related features (e.g., authentication

authentication and authorization) and can affect testing in other

and authorization) and can affect testing in other areas.

areas.

</ul>

<h5>PEGASUS_DISABLE_PROV_USERCTXT</h5>

<ul>

Description: Builds a version of OpenPegasus that

disables supports for the Provider User Context feature. 

disables supports for the Provider User Context feature.  This

This feature allows a Provider to choose the user context in

feature allows a Provider to choose the user context in which it is

which it is invoked, including the ability to run in the context of

invoked, including the ability to run in the context of the user

the user requesting an operation.

requesting an operation.

Default Value: Set for Windows and OpenVMS, Not Set

Default Value: Set for Windows and OpenVMS, Not Set for

for all other platforms

all other platforms

Recommended Value (Development Build): Set for Windows and

OpenVMS, Not Set for all other platforms

Recommended Value (Release Build): Set for Windows and

Line 506

Line 508

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

this enhancement. Some platforms, such as OS/400 and z/OS may define

define the PEGASUS_DISABLE_PROV_USERCTXT as part of the platform

the PEGASUS_DISABLE_PROV_USERCTXT as part of the platform

configuration, since these platforms already set the provider user

context on a per-thread basis.  When the Provider User Context

feature is enabled, support for each of the User Context types may

feature is enabled, support for each of the User Context types may be

be disabled individually. Provider registration fails when an

disabled individually. Provider registration fails when an unsupported

unsupported UserContext value is specified. Please refer to

UserContext value is specified. Please refer to

SecurityGuidelinesForDevelopers.html / PEP 223 for a discussion of

SecurityGuidelinesForDevelopers.html / PEP 223 for a discussion of the

the rationale/advantages of user context providers to many

rationale/advantages of user context providers to many platforms.

platforms.

</ul>

<h5>PEGASUS_EXTRA_PROVIDER_LIB_DIR</h5>

<ul>

Description: Specifies the location of the extra provider

libraries which are part of the release builds.

Default Value: Not Set

Recommended Value (Development Build):  No Specific

Recommendation

Recommended Value (Release Build):  No Specific

Recommendation

Required:  No.

Considerations:  Since providerDir config property is

fixed and hidden in release builds, this build time option provides

facilty to include the extra provider directories without any security

problems. This build time option is useful only when

PEGASUS_OVERRIDE_DEFAULT_RELEASE_DIRS is set.

</ul>

<h5>PEGASUS_EMANATE_INCLUDE_DIR</h5>

<ul>

Description: Specifies the location of the EMANATE

include directory.

Description: Specifies the location of the EMANATE include

directory.

Default Value: Not Set

Recommended Value (Development Build):

Recommended Value (Development Build):  No Specific

No Specific Recommendation

Recommendation

Recommended Value (Release Build):

Recommended Value (Release Build):  No Specific

No Specific Recommendation

Recommendation

Required: No. By default, the EMANATE include files

Required: No. By default, the EMANATE include files are

are expected to be installed in directories that are searched by

expected to be installed in directories that are searched by default

default (e.g., /usr/include). For platforms where this isn't true,

(e.g., /usr/include). For platforms where this isn't true, the

the PEGASUS_EMANATE_INCLUDE_DIR environment variable may be used to

PEGASUS_EMANATE_INCLUDE_DIR environment variable may be used to define

define an alternative path. This environment variable is only used

an alternative path. This environment variable is only used if

if PEGASUS_USE_EMANATE is set.

PEGASUS_USE_EMANATE is set.

Considerations: Refer to the description of PEGASUS_USE_EMANATE

Considerations: Refer to the description of

for additional details.

PEGASUS_USE_EMANATE for additional details.

</ul>

<h5>PEGASUS_EMANATE_LIB_DIR</h5>

<ul>

Description: Specifies the location of the EMANATE

lib directory.

Description: Specifies the location of the EMANATE lib

directory.

Default Value: Not Set

Recommended Value (Development Build):

Recommended Value (Development Build):  No Specific

No Specific Recommendation

Recommendation

Recommended Value (Release Build):

Recommended Value (Release Build):  No Specific

No Specific Recommendation

Recommendation

Required: No. By default, the EMANATE libraries are

expected to be installed in directories that are searched by

expected to be installed in directories that are searched by default

default (e.g., /usr/lib, /usr/lib64). For platforms where this

(e.g., /usr/lib, /usr/lib64). For platforms where this isn't true, the

isn't true, the PEGASUS_EMANATE_LIB_DIR environment variable may

PEGASUS_EMANATE_LIB_DIR environment variable may be used to define an

be used to define an alternative path. This environment variable

alternative path. This environment variable is only used if

is only used if PEGASUS_USE_EMANATE is set.

PEGASUS_USE_EMANATE is set.

Considerations: Refer to the description of PEGASUS_USE_EMANATE

Considerations: Refer to the description of

for additional details.

PEGASUS_USE_EMANATE for additional details.

</ul>

<h5>PEGASUS_ENABLE_AUDIT_LOGGER</h5>

<ul>

Description: When this variable is set to false, support

for audit logging will NOT be built into OpenPegasus. If this

for audit logging will NOT be built into OpenPegasus. If this variable

variable is set to true, or not set, support for audit logging

is set to true, or not set, support for audit logging will be included

will be included in the build. All other values are invalid.

in the build. All other values are invalid.

Default Value: true

Recommended Value (Development Build): true

Recommended Value (Release Build): true

Required: No

</ul>

<h5>PEGASUS_ENABLE_CMPI_PROVIDER_MANAGER</h5>

<ul>

Description: 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

built.  If this variable is not set or set to false, support for

for CMPI providers will not be included.

CMPI providers will not be included.

Default Value: true for Linux and OpenVMS, false for

other platforms

Recommended Value (Development Build): true (Linux

Recommended Value (Development Build): true (Linux Platform

Platform Only)

Only)

Recommended Value (Release Build): true (Linux Platform

Only)

Required: No

Required: No

</ul>

<h5>PEGASUS_ENABLE_COMPRESSED_REPOSITORY</h5>

<ul>

Description: If set the Repository Compression logic is

built and enabled and compressed and non compressed repositories

built and enabled and compressed and non compressed repositories are

are supported. If not set then compressed repositories are not

supported. If not set then compressed repositories are not supported.

supported.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Required: No

Required: No

Considerations: See

Considerations: See

pegasus/readme.compressed_repository

</ul>

<h5>PEGASUS_ENABLE_CQL</h5>

<ul>

Description: When this variable is set to false, support

for Indication Subscription filters that have CQL as the language

for Indication Subscription filters that have CQL as the language is

is disabled. It does not remove CQL from the build.

disabled. It does not remove CQL from the build.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): false

Required: No

Considerations: The DMTF CIM Query Language

Considerations: The DMTF CIM Query Language Specification

Specification is Preliminary and subject to backward incompatible

is Preliminary and subject to backward incompatible changes.

changes.

</ul>

<h5>PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT</h5>

<ul>

Description: When this variable is set to true, support the

DMTF Indications Profile (DSP1054) is included in OpenPegasus. 

DMTF Indications Profile (DSP1054) is included in OpenPegasus.  If

If this variable is not set or set to false, support for the DMTF

this variable is not set or set to false, support for the DMTF

Indications Profile will not be included.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Required: No

Considerations: The implementation of this feature is

Considerations: The implementation of this feature is based

based on a preliminary version of the DMTF Indications Profile,

on a preliminary version of the DMTF Indications Profile, DSP1053, and

DSP1053, and subject to change.  If this variable is enabled,

subject to change.  If this variable is enabled, two DMTF

two DMTF experimental class definitions, CIM_IndicationService and

experimental class definitions, CIM_IndicationService and

CIM_IndicationServiceCapabilities, will be added to the

CIM_IndicationServiceCapabilities, will be added to the root/PG_InterOp

root/PG_InterOp namespace. Experimental class definitions are

namespace. Experimental class definitions are subject to change. 

subject to change. 

PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT requires

PEGASUS_ENABLE_INTEROP_PROVIDER to be enabled.

PEGASUS_ENABLE_INTEROP_PROVIDER to be enabled. If

If PEGASUS_ENABLE_INTEROP_PROVIDER is not set, setting

PEGASUS_ENABLE_INTEROP_PROVIDER is not set, setting

PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT to true, will also

enable PEGASUS_ENABLE_INTEROP_PROVIDER. If

PEGASUS_ENABLE_INTEROP_PROVIDER is explicitly disabled (i.e., set

PEGASUS_ENABLE_INTEROP_PROVIDER is explicitly disabled (i.e., set to

to false), a build error will be generated.

false), a build error will be generated.

</ul>

<h5>PEGASUS_ENABLE_EXECQUERY</h5>

<ul>

Description: When this environment variable is set,

processing of ExecQuery operations is enabled. When not set,

processing of ExecQuery operations is enabled. When not set, ExecQuery

ExecQuery operation requests get a NotSupported response. (Note:

operation requests get a NotSupported response. (Note: The

The PEGASUS_ENABLE_EXECQUERY environment variable controls

PEGASUS_ENABLE_EXECQUERY environment variable controls the definition

the definition of the PEGASUS_DISABLE_EXECQUERY compile macro.)

of the PEGASUS_DISABLE_EXECQUERY compile macro.)

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Line 653

Line 684

</ul>

<h5>PEGASUS_ENABLE_EMAIL_HANDLER</h5>

<ul>

Description:  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

build.  The E-Mail Indication Handler can be used to delivered CIM

delivered CIM Indications to a designated e-mail address.

Indications to a designated e-mail address.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Required: No

Considerations: If PEGASUS_ENABLE_EMAIL_HANDLER is

Considerations: If PEGASUS_ENABLE_EMAIL_HANDLER is not

not set when OpenPegasus is built, a request to create an Email

set when OpenPegasus is built, a request to create an Email Indication

Indication Handler instance will be rejected will the error

Handler instance will be rejected will the error CIM_ERR_NOT_SUPPORTED.

CIM_ERR_NOT_SUPPORTED.

</ul>

<h5>PEGASUS_ENABLE_GCOV</h5>

<ul>

Description: GCOV,

Description: GCOV, <a href="http://gcc.gnu.org/onlinedocs/gcc/index.html#toc_Gcov">

http://gcc.gnu.org/onlinedocs/gcc/index.html#toc_Gcov</a>, is a

http://gcc.gnu.org/onlinedocs/gcc/index.html#toc_Gcov</a>, is a code

code coverage utility.  If PEGASUS_ENABLE_GCOV is set, 

coverage utility.  If PEGASUS_ENABLE_GCOV is set,  GCC will

GCC will instrument the code to support analysis by GCOV.

instrument the code to support analysis by GCOV.

Default Value: Not Set

Recommended Value (Development Build):

Recommended Value (Development Build):  Not Set

Not Set

Recommended Value (Release Build): Not Set

Required: No Considerations:

Required: No

This flag is currently only supported with GCC on Linux.

Considerations:  This flag is currently only supported

with GCC on Linux.

<ul>

Note: LCOV, <a href=

Note: LCOV, <a href="http://ltp.sourceforge.net/coverage/lcov.php">

"http://ltp.sourceforge.net/coverage/lcov.php">

http://ltp.sourceforge.net/coverage/lcov.php</a>, is a graphical

http://ltp.sourceforge.net/coverage/lcov.php</a>, is a

front-end extension for GCOV. It collects GCOV data for multiple source

graphical front-end extension for GCOV. It collects GCOV data

files and creates HTML pages with coverage information. You can use the

for multiple source files and creates HTML pages with coverage

following steps to use LCOV to analyze OpenPegasus GCOV data.

information. You can use the following steps to use LCOV to

analyze OpenPegasus GCOV data.

<ol>

<li>Set PEGASUS_ENABLE_GCOV = true.</li>

<li>Build and test OpenPegasus (e.g.,

<li>Build and test OpenPegasus (e.g., make -f

make -f pegasus/TestMakefile  build

pegasus/TestMakefile  build alltests).</li>

alltests).</li>

<li>For each source directory,

<ul>

<li>copy the .gcda and .gcno files from the object

<li>copy the .gcda and .gcno files from the object directory

directory to the source directory (e.g.,

to the source directory (e.g., cp build/obj/Pegasus/Common/*.gcda

cp build/obj/Pegasus/Common/*.gcda

src/Pegasus/Common/);</li>

<li>execute the lcov command

<li>execute the lcov command (e.g., lcov

(e.g.,

--directory src/Pegasus/Common/ --capture --output-file result.info)

lcov --directory src/Pegasus/Common/ --capture

to build the result.info file; and finally,</li>

--output-file result.info) to build the result.info

file; and finally,</li>

<li>use the genhtml command to generate the .html

output (e.g., genhtml result.info).  The

output (e.g., genhtml result.info).  The top .html file is

top .html file is named index.html.</li>

named index.html.</li>

</ul>

</li>

</ol>

</ul>

<h5>PEGASUS_ENABLE_INDICATION_COUNT</h5>

<ul>

Description: 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.

Default Value: true

Recommended Value (Development Build): true

Recommended Value (Release Build): true

Required: No

Considerations: 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.

</ul>

<h5>PEGASUS_ENABLE_PROTOCOL_INTERNAL_BINARY</h5>

<ul>

Description: If true, OpenPegasus uses a faster binary

protocol between the CIM server and provider manager. If false,

Description: If true, the CIM Server will be built to count

OpenPegasus uses the older XML-based protocol instead.

the number of CIM indications generated by providers and matched with

subscriptions. If false or not set, indication statistic support will

Default Value: true

not be included. Default Value: true

Recommended Value (Development Build): true

Recommended Value (Release Build): true

Required: No

Considerations: This option improves performance by optimizing the

Considerations: The number of CIM indications generated by

serialization and deserialization of messages between the server and

providers and matched with subscriptions is stored in hash tables which

out-of-process providers.

causes memory usage to increase by 4 bytes for each active subscription

and by about 400 bytes for each active indication provider.

</ul>

<h5>PEGASUS_ENABLE_PROTOCOL_BINARY</h5>

<ul>

Description: If true, OpenPegasus uses a faster binary

protocol between local clients (including the provider agent) and the

protocol between local clients and the CIM server. If false,

CIM server. If false, OpenPegasus uses the conventional XML-based protocol

OpenPegasus uses the conventional XML-based protocol instead. See

instead. See PEP#340 for more details.

PEP#340 for more details.

Default Value: false

Recommended Value (Development Build): false

Recommended Value (Release Build): false

Required: No

Considerations: This option improves performance by using a faster

Considerations: This option improves performance by using a

binary protocol between local clients and the CIM server.

faster binary protocol between local clients and the CIM server.

</ul>

<h5>PEGASUS_ENABLE_INTEROP_PROVIDER</h5>

<ul>

Description: If true, the OpenPegasus Interop Provider

will be build. If false or not set, the OpenPegasus Interop

Description: If true, the OpenPegasus Interop Provider will

Provider will not be built.

be build. If false or not set, the OpenPegasus Interop Provider will

not be built.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): false

Required: No

Considerations:  A number of features controlled by

OpenPegasus build options are dependent on the Interop

OpenPegasus build options are dependent on the Interop Provider. 

Provider.  Please refer to PEGASUS_ENABLE_SLP,

Please refer to PEGASUS_ENABLE_SLP, PEGASUS_DISABLE_PERFINST, and

PEGASUS_DISABLE_PERFINST, and

PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT for additional details.

PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT for additional

</ul>

details.

<h5>PEGASUS_INTEROP_NAMESPACE</h5>

<ul>

Description: This variable is used for configuring the

Interop namespace name. This option helps to establish a consistent

Interop Namespace as mentioned in DMTF specification.(DSP1033)

Default Value: root/PG_InterOp

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Required: No

Considerations: The accepted values for this environment

variable are "root/PG_InterOp" or "interop" or "root/interop". For any

other value, the default value will be used.With the usage of this

build option, we have to start using pegasus with fresh repository.

</ul>

<h5>PEGASUS_ENABLE_IPV6</h5>

<ul>

Description: This variable can be used to specify

whether IPv6 support should be included in OpenPegasus.

Description: This variable can be used to specify whether

IPv6 support should be included in OpenPegasus.

Default Value: true

Recommended Value (Development Build): true

Recommended Value (Release Build): true

Required: No

Considerations: When this variable is set to

Considerations: When this variable is set to 'false',

'false', support for IPv6 socket APIs and structures is disabled,

support for IPv6 socket APIs and structures is disabled, and the CIM

and the CIM Server will not accept connections to or from IPv6

Server will not accept connections to or from IPv6 network interfaces.

network interfaces. When this variable is set to 'true', the

When this variable is set to 'true', the newer IPv6 socket APIs and

newer IPv6 socket APIs and structures will be included when

structures will be included when OpenPegasus is built, so they must be

OpenPegasus is built, so they must be supported on the build

supported on the build platform. However, if IPv6 is not supported on

platform. However, if IPv6 is not supported on the platform on

the platform on which an IPv6-enabled version of OpenPegasus is run,

which an IPv6-enabled version of OpenPegasus is run, then the IPv6

then the IPv6 feature will be disabled at run-time and only IPv4

feature will be disabled at run-time and only IPv4 connections

connections will be supported.

will be supported.

</ul>

<h5>PEGASUS_ENABLE_JMPI_PROVIDER_MANAGER</h5>

<ul>

Description: If true, a version of OpenPegasus that

supports JMPI providers and their dependent components is built.

supports JMPI providers and their dependent components is built. If

If false or not set, support for JMPI Providers is not included

false or not set, support for JMPI Providers is not included in

in OpenPegasus.  All other values are invalid.

OpenPegasus.  All other values are invalid.

Default Value: false

Recommended Value (Development Build): false

Recommended Value (Release Build): false

Required: No

Required: No

</ul>

<h5>PEGASUS_ENABLE_OBJECT_NORMALIZATION</h5>

<ul>

Description: If set, builds in support so that objects

returned from provider instance operations can be validated.

returned from provider instance operations can be validated. The

The enableNormalization must also be set to 'true' (default)

enableNormalization must also be set to 'true' (default)

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Required: No

Considerations: If PEGASUS_ENABLE_OBJECT_NORMALIZATION is

set, two new configuration options are defined: enableNormalization

set, two new configuration options are defined: enableNormalization and

and excludeModulesFromNormalization.

excludeModulesFromNormalization.

</ul>

<h5>PEGASUS_ENABLE_PRIVILEGE_SEPARATION</h5>

<ul>

Description: If true, a version of OpenPegasus that

enables the Privilege Separation feature is built. This feature

enables the Privilege Separation feature is built. This feature allows

allows the CIM Server to run in a non-privileged user context and

the CIM Server to run in a non-privileged user context and use a small

use a small executor process to perform privileged operations. If

executor process to perform privileged operations. If false or not set,

false or not set, the Privilege Separate feature will not be

the Privilege Separate feature will not be included.

included.

Default Value: false

Recommended Value (Development Build): true (HP-UX,

Recommended Value (Development Build): true (HP-UX, Linux)

Linux)

Recommended Value (Release Build): true (HP-UX, Linux)

Recommended Value (Release Build): true (HP-UX,

Linux)

Required: No

Considerations:  The Privilege Separation feature is

Considerations:  The Privilege Separation feature is only

only supported on HP-UX and Linux platforms. The 'cimsrvr' user

supported on HP-UX and Linux platforms. The 'cimsrvr' user must be

must be defined on the system. If the umask setting in the

defined on the system. If the umask setting in the environment is not

environment is not 0, PEGASUS_TMP must be set to a directory that

0, PEGASUS_TMP must be set to a directory that is writable by the

is writable by the 'cimsrvr' user for the tests to run

'cimsrvr' user for the tests to run successfully.

successfully.

</ul>

<h5>PEGASUS_ENABLE_PROTOCOL_WSMAN</h5>

<ul>

Description: If true, a version of OpenPegasus is

built that accepts and processes WS-Management requests. This

Description: If true, a version of OpenPegasus is built

feature is initially limited to WS-Transfer and WS-Enumeration

that accepts and processes WS-Management requests. This feature is

operations. If false or not set, WS-Management support is not

initially limited to WS-Transfer and WS-Enumeration operations. If

built or included in any way.

false or not set, WS-Management support is not built or included in any

way.

Default Value: false

Recommended Value (Development Build): true

Recommended Value (Release Build): false

Required: No

Considerations:  The WS-Management standards are not

mature, and interoperability problems may arise. The WS-Management

functionality may change in incompatible ways in subsequent

functionality may change in incompatible ways in subsequent releases.

releases. Also note the known limitations specified in PEP 311.

Also note the known limitations specified in PEP 311.

</ul>

<h5>PEGASUS_ENABLE_PROTOCOL_WEB</h5>

<ul>

Description: Enable pegasus to act as webserver capable

of serving webpages by comsuming the JSON output from CIM-RS.

Default Value: true

Recommended Value (Development Build): true

Recommended Value (Release Build): true

Required: No

Considerations:  When authentication is disabled, Anybody

can modify the pegasus cimserver. Please enable authentication when

using webadmin to prevent unauthorized access.

</ul>

<h5>PEGASUS_ENABLE_REMOTE_CMPI</h5>

<ul>

Description: If set, a version of OpenPegasus that

support Remote CMPI providers and their dependent components

support Remote CMPI providers and their dependent components is built.

is built.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Required: No

Required: No

</ul>

<h5>PEGASUS_ENABLE_SLP</h5>

<ul>

Description: This variable controls of the inclusion

of SLP functionality in the OpenPegasus build. When this

Description: This variable controls of the inclusion of

environment variable is set to 'true', SLP functionality will be

SLP functionality in the OpenPegasus build. When this environment

included as part of the OpenPegasus build.  If

variable is set to 'true', SLP functionality will be included as part

this variable is set to 'false' or not set, the SLP functionality

of the OpenPegasus build.  If this variable is set to 'false' or

will not be included.  All other values are considered

not set, the SLP functionality will not be included.  All other

invalid and will result in a build error

values are considered invalid and will result in a build error (e.g.,

(e.g., "PEGASUS_ENABLE_SLP ($(PEGASUS_ENABLE_SLP)) invalid,

"PEGASUS_ENABLE_SLP ($(PEGASUS_ENABLE_SLP)) invalid, must be true or

must be true or false").

false").

Default Value: 'true' for Windows; 'false' for all other

Platforms

Recommended Value (Development Build): 'true' for

Line 894

Line 945

Required: No

Considerations: PEGASUS_ENABLE_SLP requires

PEGASUS_ENABLE_INTEROP_PROVIDER to be enabled. If

PEGASUS_ENABLE_INTEROP_PROVIDER is not set, setting

PEGASUS_ENABLE_INTEROP_PROVIDER is not set, setting PEGASUS_ENABLE_SLP

PEGASUS_ENABLE_SLP to true, will also enable

to true, will also enable PEGASUS_ENABLE_INTEROP_PROVIDER. If

PEGASUS_ENABLE_INTEROP_PROVIDER. If

PEGASUS_ENABLE_INTEROP_PROVIDER is explicitly disabled (i.e., set to

PEGASUS_ENABLE_INTEROP_PROVIDER is explicitly disabled

false), a build error will be generated.

(i.e., set to false), a build error will be generated.

</ul>

<h5>PEGASUS_ENABLE_SORTED_DIFF</h5>

<ul>

Description: This controls if the DIFFSORT function

is used rather than a simple DIFF of the test results files

Description: This controls if the DIFFSORT function is

to the static results file. Set to 'true' enables the sorted

used rather than a simple DIFF of the test results files to the static

diffs of results to static results files. Otherwise results

results file. Set to 'true' enables the sorted diffs of results to

in regular diffs of results to static results files.

static results files. Otherwise results in regular diffs of results to

See OpenPegasus bug 2283 for background information concerning

static results files. See OpenPegasus bug 2283 for background

this config variable.

information concerning this config variable.

Default Value: true

Recommended Value (Development Build): true

Recommended Value (Release Build): true

Required: No

Required: No

</ul>

<h5>PEGASUS_ENABLE_SYSTEM_LOG_HANDER</h5>

<ul>

Description: 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

build.  The SysLog Indication Handler can be used to delivered CIM

delivered CIM Indications to the system log file.

Indications to the system log file.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Required: No

Considerations: If PEGASUS_ENABLE_SYSTEM_LOG_HANDLER

Considerations: If PEGASUS_ENABLE_SYSTEM_LOG_HANDLER is

is not set when OpenPegasus is built, a request to create a SysLog

not set when OpenPegasus is built, a request to create a SysLog

Indication Handler instance will be rejected with the error

CIM_ERR_NOT_SUPPORTED.

</ul>

<h5>PEGASUS_ENABLE_SSLV2</h5>

<ul>

Description: 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.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Required: No

Considerations: 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>

Description: Builds a version of OpenPegasus that

allows an administrator to restrict access to CIM operations

Description: Builds a version of OpenPegasus that allows

to members of a designated set of groups.  Refer to the

an administrator to restrict access to CIM operations to members of a

authorizedUserGroupsconfiguration option for additional

designated set of groups.  Refer to the authorizedUserGroupsconfiguration

details.

option for additional details.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Set

Line 963

Line 1001

</ul>

<h5>PEGASUS_EXTRA_C_FLAGS</h5>

<ul>

Description:  This environment variable allows a

developer to specify an additional set of flags to be included

developer to specify an additional set of flags to be included on 

on  the C compile command line.

the C compile command line.

Default Value: Not Set

Recommended Value (Development Build): No Set

Recommended Value (Release Build): Not Set

Line 974

Line 1014

</ul>

<h5>PEGASUS_EXTRA_CXX_FLAGS</h5>

<ul>

Description:  This environment variable allows a

developer to specify an additional set of flags to be included

developer to specify an additional set of flags to be included on the

on the C++ compile command line.

C++ compile command line.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Line 985

Line 1027

</ul>

<h5>PEGASUS_EXTRA_LIBRARY_LINK_FLAGS</h5>

<ul>

Description:  This environment variable allows a

developer to specify an additional set of flags to include on

developer to specify an additional set of flags to include on the link

the link command line used to build a library.

command line used to build a library.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Line 996

Line 1040

</ul>

<h5>PEGASUS_EXTRA_LINK_FLAGS</h5>

<ul>

Description:  This environment variable allows a

developer to specify an additional set of flags to be included

developer to specify an additional set of flags to be included on the

on the link command line.  These flags will be included on

link command line.  These flags will be included on both library

both library and program executable link command lines.

and program executable link command lines.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Required: No

Required: No Considerations: Refer to

Considerations: Refer to PEGASUS_EXTRA_LIBRARY_LINK_FLAGS and

PEGASUS_EXTRA_LIBRARY_LINK_FLAGS and PEGASUS_EXTRA_PROGRAM_FLAGS to add

PEGASUS_EXTRA_PROGRAM_FLAGS to add flags specific to either a

flags specific to either a library or program link command line.

library or program link command line.

</ul>

<h5>PEGASUS_EXTRA_PROGRAM_LINK_FLAGS</h5>

<ul>

Description:  This environment variable allows a

developer to specify an additional set of flags to include on

developer to specify an additional set of flags to include on the link

the link command line used to build an executable program.

command line used to build an executable program.

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Required: No

</ul>

<h5>PEGASUS_HAS_MESSAGES</h5>

<ul>

Description: When set (to anything) during the build,

OpenPegasus compiles with localization support. The

OpenPegasus compiles with localization support. The ICU (International

ICU (International Components for Unicode) variables,

Components for Unicode) variables, ICU_ROOT and ICU_INSTALL, indicate

ICU_ROOT and ICU_INSTALL, indicate that the

that the localization support is based on ICU. Only ICU is supported at

localization support is based on ICU. Only ICU is supported

this time.

at this time.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Required: No

Considerations: If the PEGASUS_HAS_MESSAGES is not

Considerations: If the PEGASUS_HAS_MESSAGES is not set,

set, OpenPegasus is built without localization support. This

OpenPegasus is built without localization support. This means that all

means that all messages sent by the CIM Server and the CLIs are in

messages sent by the CIM Server and the CLIs are in English. ICU is an

English. ICU is an open source project at

open source project at <a href="http://oss.software.ibm.com/icu">

http://oss.software.ibm.com/icu</a>. Only English translations are

http://oss.software.ibm.com/icu</a>.

included with the OpenPegasus distribution. The OpenPegasus

Only English translations are included with the OpenPegasus

distribution does not provide translated messages. But, enabling for

distribution. The OpenPegasus distribution does not provide

ICU would allow vendor to provide the translations. Refer to the

translated messages. But, enabling for ICU would allow vendor to

OpenPegasus Release README for additional information regarding the use

provide the translations. Refer to the OpenPegasus Release README

of ICU. Although, in OpenPegasus 2.3.2, experience with localization

for additional information regarding the use of ICU. Although, in

support has been limited to a select set of platforms, wider platform

OpenPegasus 2.3.2, experience with localization support

has been limited to a select set of platforms, wider platform

adoption of this technology is planned for 2.5.

</ul>

<h5>PEGASUS_HAS_SSL</h5>

<ul>

Description: If set, a version of OpenPegasus that

supports SSL (i.e., https) is built.

Default Value: Not Set

Line 1057

Line 1105

Recommended Value (Release Build): Set

Required: No

Considerations: Support for SSL in OpenPegasus is

dependent on the OpenSSL software developed by the

dependent on the OpenSSL software developed by the <a href="http://www.openssl.org/"> OpenSSL Project

(http://www.openssl.org/)</a>. If the PEGASUS_HAS_SSL variable is set,

OpenSSL Project (http://www.openssl.org/)</a>.

the variable OPENSSL_HOME must also be defined. The OPENSSL_HOME

variable is used, by the OpenPegasus build, to determine the location

If the PEGASUS_HAS_SSL variable is set, the variable OPENSSL_HOME

of the OpenSSL include files, libraries and binaries.

must also be defined. The OPENSSL_HOME variable is used, by the

OpenPegasus build, to determine the location of the OpenSSL

include files, libraries and binaries.

</ul>

<h5>PEGASUS_HOME</h5>

<ul>

Description: Specifies the location of the

OpenPegasus working directory. The OpenPegasus

Description: Specifies the location of the OpenPegasus

build will use this directory as the default location

working directory. The OpenPegasus build will use this directory as the

for files generated during the build (e.g., binaries,

default location for files generated during the build (e.g., binaries,

libraries, objects).

Default Value: None

Recommended Value (Development Build):

Recommended Value (Development Build):  No Specific

No Specific Recommendation

Recommendation

Recommended Value (Release Build):

Recommended Value (Release Build):  No Specific

No Specific Recommendation

Recommendation

Required: Yes

Considerations: The error "PEGASUS_HOME

Considerations: The error "PEGASUS_HOME environment

environment variable undefined" is returned if the

variable undefined" is returned if the PEGASUS_HOME environment

PEGASUS_HOME environment variable is not set.

variable is not set. This variable is also used during runtime. Refer

This variable is also used during runtime. Refer to the section

to the section titled "Environment Variable Settings for Running

titled "Environment Variable Settings for Running OpenPegasus

OpenPegasus 2.3.2 on Linux" for additional details.

2.3.2 on Linux" for additional details.

</ul>

<h5>PEGASUS_INDICATIONS_Q_THRESHOLD</h5>

<ul>

Description: 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.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Required: No

Considerations: 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>

Description: Controls the maximum number of threads

allowed per message service queue. It is allowed to range

allowed per message service queue. It is allowed to range between 1 and

between 1 and MAX_THREADS_PER_SVC_QUEUE_LIMIT (currently 5000)

MAX_THREADS_PER_SVC_QUEUE_LIMIT (currently 5000) as set in

as set in pegasus/src/Pegasus/Common/MessageQueueService.cpp.

pegasus/src/Pegasus/Common/MessageQueueService.cpp. If set to 0 (zero)

If set to 0 (zero) the max threads per service queue is then

the max threads per service queue is then set to

set to MAX_THREADS_PER_SVC_QUEUE_LIMIT. If set larger than the

MAX_THREADS_PER_SVC_QUEUE_LIMIT. If set larger than the

MAX_THREADS_PER_SVC_QUEUE_LIMIT it is set equal to

MAX_THREADS_PER_SVC_QUEUE_LIMIT. There are no other limits on the

MAX_THREADS_PER_SVC_QUEUE_LIMIT. There are no other limits on the total

total number of threads that can exist within the system at this

number of threads that can exist within the system at this time. When

time. When the server starts there on the order of 10 to 20

the server starts there on the order of 10 to 20 message service queues

message service queues created dependent upon

created dependent upon build options.

build options.

Default Value: 5

Recommended Value (Development Build): 5

Recommended Value (Release Build): 5

Required: No

Considerations: This flag affects consumption of

Considerations: This flag affects consumption of system

system resources. Not setting, or inappropriately setting

resources. Not setting, or inappropriately setting this value, may

this value, may cause the cimserver to hang or crash.

cause the cimserver to hang or crash.

</ul>

<h5>PEGASUS_ROOT</h5>

<ul>

Description: Specifies the location of the directory

that corresponds to "pegasus" source directory defined in the

Description: Specifies the location of the directory that

OpenPegasus CVS source tree. This environment variable is

corresponds to "pegasus" source directory defined in the OpenPegasus

used by the OpenPegasus build to locate the required build

CVS source tree. This environment variable is used by the OpenPegasus

and source files (e.g., $(PEGASUS_ROOT)/mak and

build to locate the required build and source files (e.g.,

$(PEGASUS_ROOT)/src).

$(PEGASUS_ROOT)/mak and $(PEGASUS_ROOT)/src).

Default Value: None

Recommended Value (Development Build):

Recommended Value (Development Build):  No Specific

No Specific Recommendation

Recommendation

Recommended Value (Release Build):

Recommended Value (Release Build):  No Specific

No Specific Recommendation

Recommendation

Required: Yes

Considerations: The error "PEGASUS_ROOT environment

variable undefined" is returned if the PEGASUS_ROOT

variable undefined" is returned if the PEGASUS_ROOT environment

environment variable is not set.

variable is not set.

</ul>

<h5>PEGASUS_NET_SNMP_INCLUDE_DIR</h5>

<ul>

Description: Specifies the location of the NET-SNMP

include directory.

Description: Specifies the location of the NET-SNMP include

directory.

Default Value: Not Set

Recommended Value (Development Build):

Recommended Value (Development Build):  No Specific

No Specific Recommendation

Recommendation

Recommended Value (Release Build):

Recommended Value (Release Build):  No Specific

No Specific Recommendation

Recommendation

Required: No. By default, the NET-SNMP include

Required: No. By default, the NET-SNMP include files are

files are expected to be installed in directories that

expected to be installed in directories that are searched by default

are searched by default (e.g., /usr/include). For platforms

(e.g., /usr/include). For platforms where this isn't true, the

where this isn't true, the PEGASUS_NET_SNMP_INCLUDE_DIR

PEGASUS_NET_SNMP_INCLUDE_DIR environment variable may be used to define

environment variable may be used to define an alternative path.

an alternative path. This environment variable is only used if

This environment variable is only used if PEGASUS_USE_NET_SNMP

PEGASUS_USE_NET_SNMP is set.

is set.

</ul>

<h5>PEGASUS_NET_SNMP_LIB_DIR</h5>

<ul>

Description: Specifies the location of the NET-SNMP

lib directory.

Description: Specifies the location of the NET-SNMP lib

directory.

Default Value: Not Set

Recommended Value (Development Build):

Recommended Value (Development Build):  No Specific

No Specific Recommendation

Recommendation

Recommended Value (Release Build):

Recommended Value (Release Build):  No Specific

No Specific Recommendation

Recommendation

Required: No. By default, the NET-SNMP library is

expected to be installed in a directory that is searched by

expected to be installed in a directory that is searched by default

default (e.g., /usr/lib, /usr/lib64). For platforms where

(e.g., /usr/lib, /usr/lib64). For platforms where this isn't true, the

this isn't true, the PEGASUS_NET_SNMP_LIB_DIR environment

PEGASUS_NET_SNMP_LIB_DIR environment variable may be used to define an

variable may be used to define an alternative path. This

alternative path. This environment variable is only used if

environment variable is only used if PEGASUS_USE_NET_SNMP is set.

PEGASUS_USE_NET_SNMP is set.

</ul>

<h5>PEGASUS_NOASSERTS</h5>

<ul>

Description: Defines the NDEBUG compilation macro, which

causes the preprocessor to remove PEGASUS_ASSERT() statements.

causes the preprocessor to remove PEGASUS_ASSERT() and disables

assertion on PEGASUS_FCT_EXECUTE_AND_ASSERT statements.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Set

Line 1230

Line 1258

dependent on platform support for PAM.

</ul>

<h5>PEGASUS_PAM_SESSION_SECURITY</h5>

<ul>

Description: Enables support for PAM-(Pluggable

Authentication Modules) based authentication and authorization.

When choosing this PAM method the PAM session started through pam_start

is kept open for the complete CIM request.

The PAM item PAM_RHOST will be set to the connection IP address.

This allows PAM modules to restrict number of concurrent connections

from a single host.

If PEGASUS_PAM_SESSION_SECURITY is set, you cannot enable the Privilege

Separation feature (PEGASUS_ENABLE_PRIVILEGE_SEPARATION) or the

authentication-only PAM mechanism (PEGASUS_PAM_AUTHENTICATION).

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Required: No

Considerations: Support for PAM in OpenPegasus is

dependent on platform support for PAM.

</ul>

<h5>PEGASUS_NEGOTIATE_AUTHENTICATION</h5>

<ul>

Description: If set to true enables the HTTP Negotiate

authentication method, as described by RFC 4559, both to Pegasus server

and client.

Enabling this option also adds 1) a new option to the runtime

configuration variable "httpAuthType" and 2) a new runtime variable

"mapToLocalName".

Default Value: false

Recommended Value (Development Build): false

Recommended Value (Release Build): false

Required: No

Considerations: HTTP Negotiate support requires the GSSAPI

development headers and libraries to build OpenPegasus, such as

libgssapi_krb5 from MIT Kerberos5 implementation.

</ul>

<h5>PEGASUS_PLATFORM</h5>

<ul>

Description: Describes the target platform for the

Line 1241

Line 1307

following table describes the platforms documented in

this version of the document.

Default Value: None

<table border="1" cellspacing="1" bordercolordark="#666666"

bordercolorlight="#CCCCCC" width=542

style='font-size=10.0pt;font-family:Arial'>

<th bgcolor="#cae6ca" width="190">Platform</th>

<tr>

<th bgcolor="#cae6ca" width="351">Recommended Value

<th bgcolor="#CAE6CA" width="190">Platform</th>

<th bgcolor="#CAE6CA" width=351>Recommended Value

Development Build</th>

<th bgcolor="#CAE6CA" width=338>Recommended Value

<th bgcolor="#cae6ca" width="338">Recommended Value

Release Build</th>

</tr>

<td width="190" align="left">Linux IA32</td>

<td align="left" width="190">Linux IA32</td>

<td width="351">LINUX_IX86_GNU</td>

<td width="338">LINUX_IX86_GNU</td>

</tr>

<td width="190" align="left">Linux IA64</td>

<td align="left" width="190">Linux IA64</td>

<td width="351">LINUX_IA64_GNU</td>

<td width="338">LINUX_IA64_GNU</td>

</tr>

<td width="190" align="left">Linux X86_64</td>

<td align="left" width="190">Linux X86_64</td>

<td width="351">LINUX_X86_64_GNU</td>

<td width="338">LINUX_X86_64_GNU</td>

</tr>

<td width="351">HPUX_PARISC_ACC</td>

<td width="338">HPUX_PARISC_ACC</td>

</tr>

</tr>

<td width="190" align="left">OpenVMS Alpha</td>

<td align="left" width="190">OpenVMS Alpha</td>

<td width="351">VMS_ALPHA_DECCXX</td>

<td width="338">VMS_ALPHA_DECCXX</td>

</tr>

<td width="190" align="left">OpenVMS IA64</td>

<td align="left" width="190">OpenVMS IA64</td>

<td width="351">VMS_IA64_DECCXX</td>

<td width="338"> VMS_IA64_DECCXX</td>

</tr>

</table>

</tbody></table>

Required: Yes

Considerations: The error "PEGASUS_PLATFORM

Line 1382

Line 1446

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.

</ul>

</ul>

<h5>PEGASUS_SNIA_EXTENSIONS</h5>

<ul>

Line 1461

Line 1525

<ul>

Description: 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.

Line 1497

Line 1561

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.

Default Value: Not Set

Recommended Value (Development Build): Set

Line 1506

Line 1570

</ul>

<h5>PEGASUS_TEST_USER_ID/PEGASUS_TEST_USER_PASS</h5>

<ul>

Description: These variables are only used for

testing. These variables allow the developer to define a

Description: These variables are only used for testing.

valid, non-privileged  user name and password

These variables allow the developer to define a valid,

on the test system that can be used as part of the OpenPegasus

non-privileged  user name and password on the test system that can

automated test scripts to perform authentication and

be used as part of the OpenPegasus automated test scripts to perform

authorization testing.  These variables are only used for

authentication and authorization testing.  These variables are

testing and NOT part of the release.

only used for testing and NOT part of the release.

Default Value: guest/guest

Recommended Value (Development Build):

Recommended Value (Development Build):  No Recommendation

No Recommendation

Recommended Value (Release Build): Not Used

Required: No

</ul>

<h5>PEGASUS_TEST_VALGRIND_LOG_DIR</h5>

<ul>

Description:

This variable is currently only supported on Linux. It may be

Description:  This variable is currently only supported

set to run regression tests under the

on Linux. It may be set to run regression tests under the <a href="http://www.valgrind.org/">Valgrind</a> memory checking tool. It

<a href="http://www.valgrind.org/">Valgrind</a> memory

must specify a directory for writing Valgrind log files. The file name

checking tool. It must specify a directory for writing

format for a particular log is

Valgrind log files. The file name format for a particular

PEGASUS_TEST_VALGRIND_LOG_DIR/PROGRAM_NAME.pid.

log is PEGASUS_TEST_VALGRIND_LOG_DIR/PROGRAM_NAME.pid.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Line 1539

Line 1603

</ul>

<h5>PEGASUS_TMP</h5>

<ul>

Description: This variable is only used in a test

environment. It can be used to define the directory that

environment. It can be used to define the directory that OpenPegasus

OpenPegasus test programs should use to store temporary files.

test programs should use to store temporary files.

Default Value: "."

Recommended Value (Development Build):

Recommended Value (Development Build):  No Specific

No Specific Recommendation

Recommendation

Recommended Value (Release Build): Not Used

Required: No

</ul>

<h5>PEGASUS_USE_DEBUG_BUILD_OPTIONS</h5>

<ul>

Description: The PEGASUS_DEBUG flag is used to control

a variety of settings, including compile options, assertion

Description: The PEGASUS_DEBUG flag is used to control a

enablement, method definitions for testing, and diagnostic

variety of settings, including compile options, assertion enablement,

output.  The PEGASUS_USE_DEBUG_BUILD_OPTIONS variable

method definitions for testing, and diagnostic output.  The

can be used to enable just the compiler specific debug options

PEGASUS_USE_DEBUG_BUILD_OPTIONS variable can be used to enable just the

(e.g., -g in g++) .

compiler specific debug options (e.g., -g in g++) .

Default Value: Not Set

Recommended Value (Development Build): Set

Recommended Value (Release Build): Not Set

Required: No

Considerations: This variable is automatically set

Considerations: This variable is automatically set if

if PEGASUS_DEBUG is set.

PEGASUS_DEBUG is set.

</ul>

<h5>PEGASUS_USE_EMANATE</h5>

<ul>

Description: EMANATE,

Description: 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

International product that supports SNMPv1, SNMPv2c, and SNMPv3. 

SNMPv3.  If the PEGASUS_USE_EMANATE variable is defined,

If the PEGASUS_USE_EMANATE variable is defined, the OpenPegasus SNMP

the OpenPegasus SNMP Handler will use the EMANATE libraries

Handler will use the EMANATE libraries to send traps to the SNMP

to send traps to the SNMP Management application. 

Management application.  The EMANATE libraries are NOT included as

The EMANATE libraries are NOT included as part of OpenPegasus.

part of OpenPegasus.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Required: No

Required: No

Considerations: Either the PEGASUS_USE_NET_SNMP or

Considerations: Either the PEGASUS_USE_NET_SNMP or

PEGASUS_USE_EMANATE variable must be set for the SNMP

PEGASUS_USE_EMANATE variable must be set for the SNMP Handler to be

Handler to be supported.

supported.

</ul>

<h5>PEGASUS_USE_NET_SNMP</h5>

<ul>

Description: NET-SNMP,

Description: NET-SNMP, <a href="http://net-snmp.sourceforge.net"> http://net-snmp.sourceforge.net</a>,

http://net-snmp.sourceforge.net</a>,  is an OSS

is an OSS implementation of a suite of applications used to implement <a href="http://www.ietf.org/rfc/rfc1157.txt">SNMP v1</a>, <a href="http://www.ietf.org/rfc/rfc1901.txt">SNMP v2c</a> and <a href="http://www.ietf.org/rfc/rfc2571.txt">SNMP v3</a> using both IPv4

implementation of a suite of applications used to implement

and IPv6.   If the PEGASUS_USE_NET_SNMP variable is defined,

<a href="http://www.ietf.org/rfc/rfc1157.txt">SNMP v1</a>,

the OpenPegasus SNMP Handler will use the NET-SNMP libraries to send

<a href="http://www.ietf.org/rfc/rfc1901.txt">SNMP v2c</a> and

traps to the SNMP Management application.  The NET-SNMP libraries

<a href="http://www.ietf.org/rfc/rfc2571.txt">SNMP v3</a> using

are NOT included as part of OpenPegasus.

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.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): true for Linux,

Recommended Value (Release Build): true for Linux, false

false for all other platforms

for all other platforms

Required: No

Required: No

Considerations: Either the PEGASUS_USE_NET_SNMP or

Considerations: Either the PEGASUS_USE_NET_SNMP or

PEGASUS_USE_EMANATE variable must be set for the SNMP

PEGASUS_USE_EMANATE variable must be set for the SNMP Handler to be

Handler to be supported.

supported.

</ul>

<h5>PEGASUS_ENABLE_NET_SNMPV3</h5>

<ul>

Description: If this variable is defined, then

OpenPegasus SNMP Handler will build the SNMPV3 features. This should be

set to false if NET-SNMP 5.2 and lower libraries are used.

Default Value: true

Recommended Value (Development Build): true

Recommended Value (Release Build): true

Required: No

Considerations: PEGASUS_USE_NET_SNMP variable must

be set.

</ul>

<h5>PEGASUS_USE_OPENSLP</h5>

<ul>

Description: OpenSLP, <a href="http://www.openslp.org">

http://openslp.org</a>, is an open-source implementation of

http://openslp.org</a>, is an open-source implementation of Service

Service Location Protocol. If the PEGASUS_USE_OPENSLP variable

Location Protocol. If the PEGASUS_USE_OPENSLP variable is defined,

is defined, OpenPegasus will be built to use the OpenSLP

OpenPegasus will be built to use the OpenSLP implementation of SLP

implementation of SLP instead of the internal OpenPegasus

instead of the internal OpenPegasus implementation of SLP. The OpenSLP

implementation of SLP. The OpenSLP libaries are NOT included

libaries are NOT included as part of OpenPegasus. Default

as part of OpenPegasus.

Value: Not Set

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Not Set

Required: No

Considerations: PEGASUS_ENABLE_SLP must be defined

Considerations: PEGASUS_ENABLE_SLP must be defined if

if this variable is set.

this variable is set.

</ul>

<h5>PEGASUS_USE_PAM_STANDALONE_PROC</h5>

<ul>

Description: Moves the processing of PAM requests from

the CIM Server process to a separate process managed by the

the CIM Server process to a separate process managed by the CIM Server.

CIM Server.

Default Value: Not Set

Recommended Value (Development Build): Set

Recommended Value (Release Build): Set

Required: No

Considerations: If PAM Authentication is enabled,

Considerations: If PAM Authentication is enabled, the PAM

the PAM API is used, during the processing of each request, to

API is used, during the processing of each request, to authenticate the

authenticate the client. This level of use makes the CIM Server

client. This level of use makes the CIM Server extremely sensitive to

extremely sensitive to memory leaks in the PAM library. In

memory leaks in the PAM library. In addition, certain PAM modules are

addition, certain PAM modules are not thread-safe. If your

not thread-safe. If your platform is experiencing problems with PAM

platform is experiencing problems with PAM Authentication,

Authentication, use of option may provide a work-around.

use of option may provide a work-around.

PEGASUS_USE_PAM_STANDALONE_PROC requires PEGASUS_PAM_AUTHENTICATION to

PEGASUS_USE_PAM_STANDALONE_PROC requires

be set.

PEGASUS_PAM_AUTHENTICATION to be set.

</ul>

<h5>PEGASUS_USE_RELEASE_CONFIG_OPTIONS</h5>

<ul>

Description: If set, OpenPegasus is built using

the "Release Build" configuration options. By default,

Description: If set, OpenPegasus is built using the

OpenPegasus is built using the "Development Build"

"Release Build" configuration options. By default, OpenPegasus is built

configuration options.

using the "Development Build" configuration options.

Default Value: false

Recommended Value (Development Build): false

Recommended Value (Release Build): true

Required: No

Considerations: (1)The

Considerations: (1)The PEGASUS_USE_RELEASE_CONFIG_OPTIONS

PEGASUS_USE_RELEASE_CONFIG_OPTIONS variable allows a platform

variable allows a platform vendor to easily toggle between two sets of

vendor to easily toggle between two sets of configurations

configurations options, a set of options tuned for the

options, a set of options tuned for the development/debug

development/debug ("Development Build") environment and a set of

("Development Build") environment and a set of options

options tuned for the production environment ("Release Build"). Refer

tuned for the production environment ("Release Build").

the section titled "Configuration Properties" for additional

Refer the section titled "Configuration Properties" for

detail.  (2) For each configuration variable,  the

additional detail.  (2) For each configuration

"Recommended Value (Release Build)" value defines the recommended

variable,  the "Recommended Value (Release Build)"

settings to use for a "Release Build".  Please refer to the

value defines the recommended settings to use for a

"Release Build".  Please refer to the

description of each variable for additional information.

</ul>

<h5>PEGASUS_USE_RELEASE_DIRS</h5>

<ul>

Description: If set, OpenPegasus is built using

the "Release Build" directory definitions. By default,

Description: If set, OpenPegasus is built using the

OpenPegasus is built using the "Development Build"

"Release Build" directory definitions. By default, OpenPegasus is built

directory definitions.

using the "Development Build" directory definitions.

Default Value: Not Set

Recommended Value (Development Build): Not Set

Recommended Value (Release Build): Set

Required: No

Considerations:

Considerations:  The PEGASUS_USE_RELEASE_DIRS variable

The PEGASUS_USE_RELEASE_DIRS variable allows a platform

allows a platform vendor to easily toggle between two sets of directory

vendor to easily toggle between two sets of directory

definitions, a set tuned for the development/debug ("Development

definitions, a set tuned for the development/debug

Build") environment and a set tuned for the production environment

("Development Build") environment and a set tuned for the

("Release Build"). Refer the section titled "Configuration Properties"

production environment ("Release Build"). Refer the section

for additional detail.

titled "Configuration Properties" for additional detail.

</ul>

<h5>PEGASUS_FLAVOR</h5>

<ul>

Description:  This variable is used for configuring Multi

CIMOM on same OS by eliminating single point for storage of PID's and

configuration files. Flavor is used in structuring the release

dirs,configuration file names, log identity and PAM config file. If

set, OpenPegasus is built using the flavor value. By default

OpenPegasus is built using "tog" as the flavor. RPMs are named using

the flavor value.

Default Value: tog

Recommended Value (Development Build): tog

Recommended Value (Release Build): tog

Required: No

Considerations:  To build RPM using flavor, RPM spec file

needs to be regenerated after setting the flavor value. This can be

done using the create_OpenPegasusRPMSpecFile target in the

Makefile.Release. Platforms have to define their own release dir

structure using the flavor for release builds. An error will be

reported if both PEGASUS_FLAVOR and PEGASUS_USE_RELEASE_DIRS are set

and PEGASUS_OVERRIDE_DEFAULT_RELEASE_DIRS is not set. RPM build on

linux defines PEGASUS_OVERRIDE_DEFAULT_RELEASE_DIRS by default.

</ul>

<h5>PEGASUS_PLATFORM_FOR_32BIT_PROVIDER_SUPPORT</h5>

<ul>

Description:  Builds the Pegasus with 32-bit provider

support for the specified platform. If this option is set, the value

MUST be one of the 32-bit supported platforms by Pegasus.

Default Value: Not set

Recommended Value (Development Build): Not set

Recommended Value (Release Build): Not set

Required: No

Considerations:  This option is used to run the 32-bit

providers under 64-bit CIMserver. To register the 32-bit providers,

"2". 32-bit Providers are always loaded out of process irrespective of

forceProviderProcesses config option.

</ul>

<h5>PEGASUS_USE_SQLITE_REPOSITORY</h5>

<ul>

Description: If true, new repository stores are created

using a SQLite database. Existing file-based stores will continue

using a SQLite database. Existing file-based stores will continue to be

to be recognized and operate seamlessly.

recognized and operate seamlessly.

Default Value: false

Recommended Value (Development Build): true

Recommended Value (Release Build): true

Required: No

Considerations: If PEGASUS_USE_SQLITE_REPOSITORY is set to true

Considerations: If PEGASUS_USE_SQLITE_REPOSITORY is set

and SQLite files are not installed in default search locations,

to true and SQLite files are not installed in default search locations,

SQLITE_HOME must also be configured.

PEGASUS_REPOSITORY_STORE_COMPLETE_CLASSES may not be set to true when

PEGASUS_USE_SQLITE_REPOSITORY is set to true.

</ul>

<h5>PEGASUS_USE_SYSLOGS</h5>

<ul>

Description: If set, OpenPegasus will be built

to send log messages to the system logger (syslog).

Description: If set, OpenPegasus will be built to send

Otherwise, log messages will be sent to OpenPegasus

log messages to the system logger (syslog). Otherwise, log messages

specific log files.

will be sent to OpenPegasus specific log files.

Recommended Value (Development Build): Set

Recommended Value (Release Build): Set

Required: No

Considerations: This variable is currently

Considerations: This variable is currently not

not implemented as an environment variable. To use

implemented as an environment variable. To use the option

the option -DPEGASUS_USE_SYSLOGS must

-DPEGASUS_USE_SYSLOGS must be explicitly included in the appropriate

be explicitly included in the appropriate platform

platform makefile (pegasus/mak/platform_*.mak).

makefile (pegasus/mak/platform_*.mak).</ul>

</ul>

<h5>PEGASUS_WINDOWS_SDK_HOME</h5>

<ul>

Description: This variable should be set to point

to the Microsoft Platform SDK on Windows if using a compiler

Description: This variable should be set to point to the

version < 1300 (i.e. VC6). If using VC7 or VC8, this flag

Microsoft Platform SDK on Windows if using a compiler version < 1300

does not need to be set, as the necessary libraries are already

(i.e. VC6). If using VC7 or VC8, this flag does not need to be set, as

included.

the necessary libraries are already included.

Recommended Value (Development Build):

Recommended Value (Development Build):  No Specific

No Specific Recommendation

Recommendation

Recommended Value (Release Build):

Recommended Value (Release Build):  No Specific

No Specific Recommendation

Recommendation

Required: Yes, if building on Windows with a

Required: Yes, if building on Windows with a compiler

compiler version < 1300.

version < 1300.

</ul>

<h5>SQLITE_HOME</h5>

<ul>

Description: Specifies the location of the SQLite SDK directory.

This directory must contain sqlite3.h in the $(SQLITE_HOME)/include

Description: Specifies the location of the SQLite SDK

directory, and libsqlite3 in the $(SQLITE_HOME)/lib directory.

directory. This directory must contain sqlite3.h in the

$(SQLITE_HOME)/include directory, and libsqlite3 in the

$(SQLITE_HOME)/lib directory.

Default Value: Not Set

Recommended Value (Development Build):

Recommended Value (Development Build):  No Specific

No Specific Recommendation

Recommendation

Recommended Value (Release Build):

Recommended Value (Release Build):  No Specific

No Specific Recommendation

Recommendation

Required: Yes, if PEGASUS_USE_SQLITE_REPOSITORY is set to true

Required: Yes, if PEGASUS_USE_SQLITE_REPOSITORY is set to

and the SQLite files are not installed in locations that are searched by

true and the SQLite files are not installed in locations that are

default.

searched by default.

Considerations: This environment variable is only used if

PEGASUS_USE_SQLITE_REPOSITORY is set to true.

</ul>

<h5>PEGASUS_INITIAL_THREADSTACK_SIZE</h5>

<ul>

Description: This environment variable sets the initial

size of the stack on new threads. Value is specified in number of bytes.

Default Value: 262144

Recommended Value (Development Build): 262144

Recommended Value (Release Build): 262144

Required: No

</ul>

<h4>Examples Building a Linux IA32 (#IA64) Development/Debug Version</h4>

<ul>

export PEGASUS_ROOT=/home/pegasusbld/pegasus

export PEGASUS_HOME=/home/pegasusbld/pegasus/build

export PEGASUS_PLATFORM=LINUX_IX86_GNU

Line 1765

Line 1910

export PEGASUS_DEBUG=TRUE

export ENABLE_CMPI_PROVIDER_MANAGER=true

export PEGASUS_USE_SYSLOGS=true

export PATH=/home/pegasusbld:/home/pegasusbld/pegasus/build/bin:/usr/local/bin:$PATH

export

PATH=/home/pegasusbld:/home/pegasusbld/pegasus/build/bin:/usr/local/bin:$PATH

</ul>

<h4>Building a Linux IA32 (#IA64) Production Release Version</h4>

<ul>

export PEGASUS_ROOT=/home/pegasusbld/pegasus

export PEGASUS_HOME=/home/pegasusbld/pegasus/build

export PEGASUS_PLATFORM=LINUX_IX86_GNU

#export PEGASUS_PLATFORM=LINUX_IA64_GNU

export PEGASUS_DISABLE_CQL=true

export PEGASUS_ENABLE_CQL=false

export PEGASUS_PAM_AUTHENTICATION=true

export PEGASUS_USE_PAM_STANDALONE_PROC=true

export PEGASUS_HAS_SSL=yes

Line 1784

Line 1932

export ENABLE_CMPI_PROVIDER_MANAGER=true

export PEGASUS_ENABLE_USERGROUP_AUTHORIZATION=true

export PEGASUS_USE_SYSLOGS=true

export PATH=/home/pegasusbld:/home/pegasusbld/pegasus/build/bin:/usr/local/bin:$PATH

export

PATH=/home/pegasusbld:/home/pegasusbld/pegasus/build/bin:/usr/local/bin:$PATH

</ul>

<h3>Environment Variable Settings for Running OpenPegasus</h3>

Line 1792

Line 1941

<h4>Definitions</h4>

<h5>PEGASUS_HOME</h5>

<ul>

Description: There are multiple options for

configuring the location of OpenPegasus runtime

Description: There are multiple options for configuring

files (e.g., configuration files, libraries,

the location of OpenPegasus runtime files (e.g., configuration files,

repository, executables). If no other option is

libraries, repository, executables). If no other option is specified,

specified, OpenPegasus will attempt to use the value

OpenPegasus will attempt to use the value PEGASUS_HOME.

PEGASUS_HOME.

Default Value: "."

Recommended Value (Development Build):

Recommended Value (Development Build):  The same value

The same value defined at build time.

defined at build time.

Recommended Value (Release Build): Not Set

Required: No

Considerations: Although this variable can be

Considerations: Although this variable can be useful in a

useful in a development environment use of this environment

development environment use of this environment variable is not

variable is not recommended in a production environment.

recommended in a production environment. Instead, the use of

Instead, the use of configuration properties to explicitly

configuration properties to explicitly set the location of runtime

set the location of runtime files and directories is recommended.

files and directories is recommended.

</ul>

<h5>PEGASUS_MSG_HOME</h5>

<ul>

Description: 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

However, CIM Client applications must rely on an alternative mechanism

mechanism to locate this directory.

to locate this directory.

Default Value: if $PEGASUS_HOME is set then

"$PEGASUS_HOME/msg" else "."

Recommended Value (Development Build): $PEGASUS_HOME/msg

Recommended Value (Release Build): Not Set

Required: No

Line 1835

Line 1986

<ul>

<h5>Default Value</h5>

The value of Default Value is the OpenPegasus

The value of Default Value is the OpenPegasus default setting

default setting for this configuration option. This

for this configuration option. This value is used if a

value is used if a platform-specific setting is not

platform-specific setting is not defined.

defined.

<h5>Recommended Default Value</h5>

The PEGASUS_USE_RELEASE_CONFIG_OPTIONS variable allows a

The PEGASUS_USE_RELEASE_CONFIG_OPTIONS variable allows a platform

platform vendor to easily toggle between two sets of

vendor to easily toggle between two sets of configurations options, a

configurations options, a set of options tuned for the

set of options tuned for the development/debug ("Development Build")

development/debug ("Development Build") environment

environment and a set of options tuned for the production environment

and a set of options tuned for the production environment

("Release Build"). The value of Recommended Value (Development

("Release Build"). The value of

Build) is the recommended default value for use in a development/

Recommended Value (Development Build)

debug environment. The value of Recommended Value (Release Build)

is the recommended default value for use in a development/

is the recommended default value for use in a production environment.

debug environment. The value of

Recommended Value (Release Build) 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.

Configuration options can be defined as fixed or hidden. A "fix"

A "fix" configuration option is set at build time

configuration option is set at build time and cannot be changed without

and cannot be changed without rebuilding. "Fixed"

rebuilding. "Fixed" configuration options are not displayed using the

configuration options are not displayed using the cimconfig

cimconfig command. This feature can be used by vendors to limit

command. This feature can be used by vendors to limit

OpenPegasus functionality and configurability. A "hidden" configuration

OpenPegasus functionality and configurability.

option is an option that is configurable (i.e., "not fixed"), but not

externally advertised using the cimconfig command. The "hidden" feature

A "hidden" configuration option is an option that is

can be used to define "internal use only" configuration options.

configurable (i.e., "not fixed"), but not externally

advertised using the cimconfig command. The "hidden"

feature can be used to define "internal use only"

configuration options.

<h5>Dynamic?</h5>

If yes, the value of the configuration option can be

If yes, the value of the configuration option can be changed without

changed without stopping and restarting the CIM Server.

stopping and restarting the CIM Server.

<h5>Directory Specifications</h5>

Note that the variables included in the following table

Note that the variables included in the following table (e.g.,

(e.g., $LOGDIR) are for documentation purposes only and

$LOGDIR) are for documentation purposes only and have been defined to

have been defined to simplify the description of the

simplify the description of the configuration options.  In

configuration options.  In particular,

particular, these variables DO NOT correspond to environment variables

these variables DO NOT correspond to environment variables

implemented in the OpenPegasus code.  Default values for the

implemented in the OpenPegasus code.  Default values

following variables are platform and vendor dependent and not

for the following variables are platform

documented in this document.

and vendor dependent and not documented in this document.

<tbody>

<table border="1" cellspacing="1" bordercolordark="#666666"

bordercolorlight="#CCCCCC" width=148

style='font-size=10.0pt;font-family:Arial' height="228">

<tr>

</tr>

<td align="left" width="1" height="12">$LOGDIR</td>

<td align="left" height="12" width="1">$LOGDIR</td>

</tr>

<td align="left" width="1" height="14">$PROVIDERDIRS</td>

<td align="left" height="14" width="1">$PROVIDERDIRS</td>

</tr>

<td align="left" height="14" width="1"> $PROVIDERMANAGERDIRS</td>

$PROVIDERMANAGERDIRS</td>

</tr>

<td align="left" width="1" height="14">$REPOSITORYDIR </td>

<td align="left" height="14" width="1">$REPOSITORYDIR </td>

</tr>

<td align="left" width="1" height="14">$CERTIFICATEDIR

<td align="left" height="14" width="1">$CERTIFICATEDIR  </td>

</td>

</tr>

<td align="left" width="1" height="14">$LOCALAUTHDIR</td>

<td align="left" height="14" width="1">$LOCALAUTHDIR</td>

</tr>

<td align="left" width="1" height="14">$TRACEDIR</td>

<td align="left" height="14" width="1">$TRACEDIR</td>

</tr>

<td align="left" width="1" height="14">$CONFIGDIR</td>

<td align="left" height="14" width="1">$CONFIGDIR</td>

</tr>

<td align="left" width="1" height="14">$PIDFILE</td>

<td align="left" height="14" width="1">$PIDFILE</td>

</tr>

<td align="left" width="1" height="14">$RANDOMDIR</td>

<td align="left" height="14" width="1">$RANDOMDIR</td>

</tr>

<td align="left" width="1" height="14">$SOCKETDIR</td>

<td align="left" height="14" width="1">$SOCKETDIR</td>

</tr>

<td align="left" width="1" height="14">$MESSAGEDIR</td>

<td align="left" height="14" width="1">$MESSAGEDIR</td>

</tr>

<td align="left" height="14" width="1">$WEBCONFDIR</td>

</tr>

</tbody>

</table>

</ul>

<h4>Definitions</h4>

<h5>authorizedUserGroups</h5>

<ul>

Description: If the authorizedUserGroups

property is set, the value is interpreted as a list of

Description: If the authorizedUserGroups property

comma-separated user groups whose members may issue CIM

is set, the value is interpreted as a list of comma-separated user

requests. A user who is not a member of any of these groups is

groups whose members may issue CIM requests. A user who is not a member

restricted from issuing CIM requests, with the exception of

of any of these groups is restricted from issuing CIM requests, with

privileged users (root user). If the authorizedUserGroups

the exception of privileged users (root user). If the authorizedUserGroups

property is not set, any user may issue CIM requests.

Default Value: blank

Recommended Default Value (Development Build): blank

Recommended Default Value (Release Build): blank

Recommend To Be Fixed/Hidden (Development Build):

Recommend To Be Fixed/Hidden (Development Build):  No/No

No/No

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: No

Example:

Example: #cimconfig -s

#cimconfig -s authorizedUserGroups=users,systemusers -p

authorizedUserGroups=users,systemusers -p

Considerations: This feature is available only when

Considerations: This feature is available only when the

the OpenPegasus source is compiled with the flag

OpenPegasus source is compiled with the flag

PEGASUS_ENABLE_USERGROUP_AUTHORIZATION set.

</ul>

<h5>daemon</h5>

<ul>

Description: This option enables/disables forking of

the code to create a background daemon process.

Description: This option enables/disables forking of the

code to create a background daemon process.

Default Value: true

Recommended Default Value (Development Build): true

Recommended Default Value (Release Build): true

Recommend To Be Fixed/Hidden (Development Build):

Recommend To Be Fixed/Hidden (Development Build):  No/No

No/No

Recommend To Be Fixed/Hidden (Release Build):  No/Yes

Recommend To Be Fixed/Hidden (Release Build):

Dynamic?: No

No/Yes

Dynamic?: No

<table border="1" cellspacing="1" bordercolordark="#666666"

bordercolorlight="#CCCCCC" width=531

<tbody>

style='font-size=10.0pt;font-family:Arial'>

<tr>

<th bgcolor="#CAE6CA" width="168">Platform</th>

<th bgcolor="#cae6ca" width="168">Platform</th>

<th bgcolor="#CAE6CA" width=350>Source Configuration File</th>

<th bgcolor="#cae6ca" width="350">Source Configuration File</th>

</tr>

<td width="168">Linux</td>

<td align="left" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td>

Pegasus/Config/DefaultPropertyTableLinux.h</td>

</tr>

<td align="left" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td>

Pegasus/Config/DefaultPropertyTableHpux.h</td>

</tr>

<td width="168">OpenVMS</td>

<td align="left" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td>

Pegasus/Config/DefaultPropertyTableVms.h</td>

</tr>

</tbody>

</table>

</ul>

<h5>enableAssociationTraversal</h5>

<ul>

Description: If true, the CIM Server will support

the four association traversal operators: Associators,

Description: If true, the CIM Server will support the

four association traversal operators: Associators,

AssociatorNames,References, and ReferenceNames.

Default Value: true

Recommended Default Value (Development Build): true

Recommended Default Value (Release Build): true

Recommend To Be Fixed/Hidden (Development Build):

Recommend To Be Fixed/Hidden (Development Build):  No/No

No/No

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: No

Considerations: There is still an outstanding

Considerations: There is still an outstanding Provider

Provider Registration issue that restricts the degree to

Registration issue that restricts the degree to which separate

which separate Providers can register for Associations.

Providers can register for Associations.

<table border="1" cellspacing="1" bordercolordark="#666666"

bordercolorlight="#CCCCCC" width=531

<tbody>

style='font-size=10.0pt;font-family:Arial'>

<tr>

<th bgcolor="#CAE6CA" width="168">Platform</th>

<th bgcolor="#cae6ca" width="168">Platform</th>

<th bgcolor="#CAE6CA" width=350>Source Configuration File</th>

<th bgcolor="#cae6ca" width="350">Source Configuration File</th>

</tr>

<td width="168">Linux</td>

<td align="left" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td>

Pegasus/Config/DefaultPropertyTableLinux.h</td>

</tr>

<td align="left" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td>

Pegasus/Config/DefaultPropertyTableHpux.h</td>

</tr>

<td width="168">OpenVMS</td>

<td align="left" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td>

Pegasus/Config/DefaultPropertyTableVms.h</td>

</tr>

</tbody>

</table>

</ul>

<h5>enableAuditLog</h5>

<ul>

Description: Used to enable or disable audit

logging at run time. If true, audit logging will be enabled.

Description: Used to enable or disable audit logging at

run time. If true, audit logging will be enabled.

Recommended Default Value (Development Build): false

Recommended Default Value (Release Build): false

Recommend To Be Fixed/Hidden (Development Build):

Recommend To Be Fixed/Hidden (Development Build):  No/No

No/No

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: Yes

Source Configuration File:

Line 2047

Line 2183

</ul>

<h5>enableAuthentication</h5>

<ul>

Description: If true, a Client must be authenticated

to access the CIM Server.

Description: If true, a Client must be authenticated to

access the CIM Server.

Recommended Default Value (Development Build): false

Recommended Default Value (Release Build): true

Recommend To Be Fixed/Hidden (Development Build): No/No

Line 2060

Line 2198

</ul>

<h5>enableBinaryRepository</h5>

<ul>

Description: Setting this to true will activate the

binary repository support on the next restart of cimserver.

Recommended Default Value (Development Build): false

Line 2068

Line 2208

Recommend To Be Fixed/Hidden (Development Build): Yes

Recommend To Be Fixed/Hidden (Release Build): Yes

Dynamic?: No

Considerations: Repositories containing a mixture

Considerations: Repositories containing a mixture of

of binary and XML objects are supported.

binary and XML objects are supported.

Source Configuration File:

Pegasus/Config/RepositoryPropertyOwner.cpp

Pegasus/Config/RepositoryPropertyOwner.cpp

</ul>

<h5>enableHttpConnection</h5>

<ul>

Description: If true, allows connections to

the CIM Server using the HTTP protocol

Description: If true, allows connections to the CIM

Server using the HTTP protocol

Default Value: true

Recommended Default Value (Development Build): true

Recommended Default Value (Release Build): false

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: No

Considerations:

Considerations:  Enabling HTTP will allow clients to

Enabling HTTP will allow clients to connect with security

connect with security properties different than those associated with

properties different than those associated with encrypted SSL

encrypted SSL traffic, and its configured SSL authentication or other

traffic, and its configured SSL authentication or other security

security behavior. This option should only be enabled in environments

behavior. This option should only be enabled in environments

where sending the HTTP Request and HTTP Response as clear text messages

where sending the HTTP Request and HTTP Response as

does not introduce a security risk.  Note that if authentication

clear text messages does not introduce a security risk. 

is enabled (enableAuthentication), user names and passwords will be

Note that if authentication is enabled (enableAuthentication),

included in the text of the HTTP message.

user names and passwords will be included in the text of the

HTTP message.

<tbody>

<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="168">Platform</th>

<th bgcolor="#CAE6CA" width=350>Source Configuration File</th>

<th bgcolor="#cae6ca" width="350">Source Configuration File</th>

</tr>

<td width="168">Linux</td>

<td align="left" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td>

Pegasus/Config/DefaultPropertyTableLinux.h</td>

</tr>

<td align="left" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td>

Pegasus/Config/DefaultPropertyTableHpux.h</td>

</tr>

<td width="168">OpenVMS</td>

<td align="left" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td>

Pegasus/Config/DefaultPropertyTableVms.h</td>

</tr>

</tbody>

</table>

</ul>

<h5>enableHttpsConnection</h5>

<ul>

Description: If true, allows connections to

the CIM Server using the HTTPS protocol (HTTP using

Description: If true, allows connections to the CIM

Secure Socket Layer encryption)

Server using the HTTPS protocol (HTTP using Secure Socket Layer

encryption)

Default Value: false

Recommended Default Value (Development Build): true

Recommended Default Value (Release Build): true

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: No

Considerations: For this option to work,

Considerations: For this option to work, the environment

the environment variable PEGASUS_HAS_SSL must have

variable PEGASUS_HAS_SSL must have been set when CIM Server was built.

been set when CIM Server was built.

<table border="1" cellspacing="1" bordercolordark="#666666"

<tbody>

bordercolorlight="#CCCCCC" width=531

style='font-size=10.0pt;font-family:Arial'>

<tr>

<th bgcolor="#CAE6CA" width="168">Platform</th>

<th bgcolor="#cae6ca" width="168">Platform</th>

<th bgcolor="#CAE6CA" width=350>Source Configuration File</th>

<th bgcolor="#cae6ca" width="350">Source Configuration File</th>

</tr>

<td width="168">Linux</td>

<td align="left" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td>

Pegasus/Config/DefaultPropertyTableLinux.h</td>

</tr>

<td align="left" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td>

Pegasus/Config/DefaultPropertyTableHpux.h</td>

</tr>

<td width="168">OpenVMS</td>

<td align="left" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td>

Pegasus/Config/DefaultPropertyTableVms.h</td>

</tr>

</tbody>

</table>

</ul>

<h5>enableIndicationService</h5>

<ul>

Description: If true, the CIM Server will support

CIM Indications.

Description: If true, the CIM Server will support CIM

Indications.

Default Value: true

Recommended Default Value (Development Build): true

Recommended Default Value (Release Build): true

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: No

Dynamic?: Yes/No

Considerations: When enableIndicationService is set to

false dynamically, delete subscription requests are sent to all

indication providers and indication related operations are not

supported until indication service is re-enabled. Dynamic configuration

facility is available only when Pegasus is compiled with

PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT=true. Clients who wants

to utilize the IndicationService services MUST check for

CIM_IndicationService EnabledState and HealthState properties to know

the current indication service state. For example, User can enumerate

instances of CIM_IndicationService and there is exactly one instance of

CIM_IndicationService returned. (Ex. using cimcli command 'cimcli ei -n

root/PG_InterOp CIM_IndicationService'). When requested state

change(Enabled/Disabled) cannot be made because of timeout or some

other exception IndicationService HealthState is set to

"Degraded/Warning". For example, if user requested for indication

service disable (by setting enableIndicationService=false), disable

failed because of timeout or some other exception. Now service health

state is set to "Degraded/Warning" and service EnabledState will remain

enabled. User can now identify the faulty provider causing the timeout

or any other problem and can take appropriate action. User can again

request for service disable to recover from degraded state. Similar

sequence applies while enabling the indication service. Only difference

is that service EnabledState is set to Enabled if exception or timeout

happens. There is no automatic recovery from degraded state is

available at present.

<table border="1" cellspacing="1" bordercolordark="#666666"

bordercolorlight="#CCCCCC" width=531

<tbody>

style='font-size=10.0pt;font-family:Arial'>

<tr>

<th bgcolor="#CAE6CA" width="168">Platform</th>

<th bgcolor="#cae6ca" width="168">Platform</th>

<th bgcolor="#CAE6CA" width=350>Source Configuration File</th>

<th bgcolor="#cae6ca" width="350">Source Configuration File</th>

</tr>

<td width="168">Linux</td>

<td align="left" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td>

Pegasus/Config/DefaultPropertyTableLinux.h</td>

</tr>

<td align="left" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td>

Pegasus/Config/DefaultPropertyTableHpux.h</td>

</tr>

<td width="168">OpenVMS</td>

<td align="left" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td>

Pegasus/Config/DefaultPropertyTableVms.h</td>

</tr>

</tbody>

</table>

</ul>

<h5>enableNamespaceAuthorization</h5>

<ul>

Description: If true, the CIM Server restricts

access to namespaces based on configured user authorizations

Description: If true, the CIM Server restricts access to

[user authorizations may be configured using the cimauth

namespaces based on configured user authorizations [user authorizations

command]

may be configured using the cimauth command]

Default Value: false

Recommended Default Value (Development Build): false

Recommended Default Value (Release Build): false

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: No

Considerations:

Considerations:  This option offers limited functionality

This option offers limited functionality and, in most

and, in most environments, expensive to administer. It's use is not

environments, expensive to administer. It's use is not

recommended.

Source Configuration File:

Pegasus/Config/SecurityPropertyOwner.cpp</ul>

Pegasus/Config/SecurityPropertyOwner.cpp

</ul>

<h5>enableNormalization</h5>

<ul>

Description: If true, objects returned from instance

providers are validated and normalized.

Default Value: true

Line 2229

Line 2390

Considerations:

<ul>

<li>Any errors encountered during normalization result in a

CIMException with the status code set to CIM_ERR_FAILED

CIMException with the status code set to CIM_ERR_FAILED and a

and a meaningful, context specific error description

meaningful, context specific error description (messages will be

(messages will be localized). Providers that catch the

localized). Providers that catch the exception have an opportunity to

exception have an opportunity to handle the error.

handle the error. Otherwise, the exception is passed to the Provider

Otherwise, the exception is passed to the Provider Manager

Manager and becomes the response for that Provider. </li>

and becomes the response for that Provider.

<li>Provider Modules that are listed on the

excludeModulesFromNormalization

excludeModulesFromNormalization configuration option are excluded from

configuration option are excluded from normalization.

normalization. </li>

<li>Since the concept of normalization is relatively new to

OpenPegasus and it establishes and enforces rules for

OpenPegasus and it establishes and enforces rules for objects returned

objects returned by providers, it should only

by providers, it should only apply to providers written against the SDK

apply to providers written against the SDK in which it was

in which it was introduced (or later). Therefore only Provider Modules

introduced (or later). Therefore only Provider Modules that

that have the following InterfaceType and InterfaceVersion combination

have the following InterfaceType and InterfaceVersion

will be subject to normalization:

combination will be subject to normalization:

<ul>

<li>'C++Default' / 2.5.0 or greater </li>

<li>'C++Default' / 2.5.0 or greater

<li>'CMPI' / 2.0.0 or greater </li>

<li>'CMPI' / 2.0.0 or greater

<li>'JMPI' / 1.0.0 or greater </li>

<li>'JMPI' / 1.0.0 or greater

</ul>

</li>

</ul>

Source Configuration File:

Pegasus/Config/NormalizationPropertyOwner.cpp

</ul>

<h5>enableRemotePrivilegedUserAccess</h5>

<ul>

Description: If true, the CIM Server allows

access by a privileged user from a remote system

Description: If true, the CIM Server allows access by a

privileged user from a remote system

Default Value: true

Recommended Default Value (Development Build): true

Recommended Default Value (Release Build): true

Line 2267

Line 2428

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: No

Considerations: Many management operations require

privileged user access. Disabling remote access by

privileged user access. Disabling remote access by privileged user

privileged user could significantly affect

could significantly affect functionality.

functionality.

Source Configuration File:

Pegasus/Config/SecurityPropertyOwner.cpp

</ul>

<h5>enableSSLExportClientVerification</h5>

<ul>

Description: If true, the CIM Server allows HTTPS

connection for CIMExport requests on the port specified by the

service name "wbem-exp-https".

Default Value: false

Recommended Default Value (Development Build): true

Recommended Default Value (Release Build): false

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: No

Source Configuration File:

Pegasus/Config/SecurityPropertyOwner.cpp

Pegasus/Config/SecurityPropertyOwner.cpp

</ul>

<h5>enableSubscriptionsForNonprivilegedUsers</h5>

<ul>

Description: If true, operations (create instance,

modify instance, delete instance, get instance, enumerate

Description: If true, operations (create instance, modify

instances, enumerate instance names) on indication

instance, delete instance, get instance, enumerate instances, enumerate

filter, listener destination, and subscription instances

instance names) on indication filter, listener destination, and

may be performed by non-privileged users. Otherwise, these

subscription instances may be performed by non-privileged users.

operations may only be performed on these instances by

Otherwise, these operations may only be performed on these instances by

privileged users.

Default Value: true

Recommended Default Value (Development Build): true

Line 2308

Line 2454

Considerations: This option has meaning only if

enableIndicationService=true.

Source Configuration File:

Pegasus/Config/SecurityPropertyOwner.cpp

Pegasus/Config/SecurityPropertyOwner.cpp

</ul>

<h5>excludeModulesFromNormalization</h5>

<ul>

Description: If the excludeModulesfromNormalization

property is set, the value is interpreted as a list of

property is set, the value is interpreted as a list of comma-separated

comma-separated Provider Module names (as specified in

Provider Module names (as specified in PG_ProviderModule.Name) to

PG_ProviderModule.Name) to exclude from validation and

exclude from validation and normalization.

normalization.

Default Value: ""

Recommended Default Value (Development Build): ""

Recommended Default Value (Development Build):

Recommended Default Value (Release Build):  ""

""

Recommended Default Value (Release Build):

""

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: No

Considerations: All objects managed by all

Considerations: All objects managed by all providers will

providers will be excluded from validation and normalization

be excluded from validation and normalization if its module name

if its module name appears in this list.

appears in this list.

Source Configuration File:

Pegasus/Config/NormalizationPropertyOwner.cpp

</ul>

<h5>forceProviderProcesses</h5>

<h5>exportSSLTrustStore</h5>

<ul>

Description: 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.

Default Value: indication_trust.pem

Recommended Default Value (Development Build):

indication_trust.pem

Recommended Default Value (Release Build):

$CERTIFICATEDIR/indication_trust.pem

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): Yes

Dynamic?: No

Source Configuration File:

Pegasus/Config/SecurityPropertyOwner.cpp

</ul>

<h5>forceProviderProcesses</h5>

Description: If true, the CIM Server runs Providers in

<ul>

separate processes rather than loading and calling Provider libraries

Description: If true, the CIM Server runs Providers

directly within the CIM Server process.

in separate processes rather than loading and calling Provider

libraries directly within the CIM Server process.

Default Value: Dependent on the value of

PEGASUS_DEFAULT_ENABLE_OOP

Recommended Default Value (Development Build):true (HP-UX,

Line 2368

Line 2496

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: No

Considerations: In a dynamic, potentially multi-vendor,

environment, the ability to run Providers in separate processes

environment, the ability to run Providers in separate processes can

can significantly increase the stability, maintainability and

significantly increase the stability, maintainability and

supportability of the overall solution.  Running Providers

supportability of the overall solution.  Running Providers in

in separate process spaces: (1) helps isolate components (i.e.,

separate process spaces: (1) helps isolate components (i.e., cimserver

cimserver and Providers) from a catastrophic failure

and Providers) from a catastrophic failure (segmentation faults, memory

(segmentation faults, memory leaks) of a single Provider and (2)

leaks) of a single Provider and (2) reduces the risk of accidental or

reduces the risk of accidental or malicious sharing of sensitive

malicious sharing of sensitive data among Providers.  This benefit

data among Providers.  This benefit comes at a cost. 

comes at a cost.  Moving Providers out of the cimserver process

Moving Providers out of the cimserver process increases

increases communication costs and can significantly increase response

communication costs and can significantly increase response

time.  Actual results will vary, but it is common for response

time.  Actual results will vary, but it is common for

times to increase by a factor of 2.

response times to increase by a factor of 2.

Note 1: When forceProviderProcesses is true, the CIM Server

Note 1: When forceProviderProcesses is true, the CIM

will load each Provider Module (i.e., library) into a separate process.

Server will load each Provider Module (i.e., library) into a

Providers in different Provider Modules cannot depend on a

separate process. Providers in different Provider Modules

communication mechanism that requires them to run in the same process

cannot depend on a communication mechanism that

space.

requires them to run in the same process space.

Note 2: Although the catastrophic failure of an

Out-Of-Process (OOP) Provider Module will not result in a

Out-Of-Process (OOP) Provider Module will not result in a failure of

failure of the CIM Server process, if the failed OOP Provider

the CIM Server process, if the failed OOP Provider Module included

Module included Indication Providers, Indications may be

Indication Providers, Indications may be lost.  If logging is

lost.  If logging is enabled, the CIM Server will log a

enabled, the CIM Server will log a message informing administrators of

message informing administrators of what happened and what

what happened and what corrective actions can be taken.

corrective actions can be taken.

<table border="1" cellspacing="1" bordercolordark="#666666"

<tbody>

bordercolorlight="#CCCCCC" width=531

style='font-size=10.0pt;font-family:Arial'>

<tr>

<th bgcolor="#CAE6CA" width="168">Platform</th>

<th bgcolor="#cae6ca" width="168">Platform</th>

<th bgcolor="#cae6ca" width="350"> Source Configuration File</th>

Source Configuration File</th>

</tr>

<td width="168">Linux</td>

<td align="left" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td>

Pegasus/Config/DefaultPropertyTableLinux.h</td>

</tr>

<td align="left" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td>

Pegasus/Config/DefaultPropertyTableHpux.h</td>

</tr>

<td width="168">OpenVMS</td>

<td align="left" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td>

Pegasus/Config/DefaultPropertyTableVms.h</td>

</tr>

</tbody>

</table>

</ul>

<ul>

Description: If set, this configuration option defines

the runtime default value for PEGASUS_HOME.

Default Value: "./"

Line 2428

Line 2552

Recommended Default Value (Release Build)""

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): Yes

Dynamic?: No

Dynamic?: No

<table border="1" cellspacing="1" bordercolordark="#666666"

bordercolorlight="#CCCCCC" width=531

<tbody>

style='font-size=10.0pt;font-family:Arial'>

<tr>

<th bgcolor="#CAE6CA" width="168">Platform</th>

<th bgcolor="#cae6ca" width="168">Platform</th>

<th bgcolor="#CAE6CA" width=350>Source Configuration File</th>

<th bgcolor="#cae6ca" width="350">Source Configuration File</th>

</tr>

<td width="168">Linux</td>

<td align="left" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td>

Pegasus/Config/DefaultPropertyTableLinux.h</td>

</tr>

<td align="left" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td>

Pegasus/Config/DefaultPropertyTableHpux.h</td>

</tr>

<td width="168">OpenVMS</td>

<td align="left" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td>

Pegasus/Config/DefaultPropertyTableVms.h</td>

</tr>

</tbody>

</table>

</ul>

<h5>hostname</h5>

<ul>

Description:  Can be used to override the local system

supplied hostname without domain the CIM Server is using to build

objects. If not set, querying this configuration option will report the

system supplied hostname and behavior is not changed.

Setting this value to a valid hostname on CIM Server startup or as

planned value will force the server to assume the configured name as

the local hosts name. Setting this allows the administrator to set the

name that operations such as associator, reference etc. return with

object paths.

In common setups it is not recommended to explicitly set this value.

Usage scenarios:  The following scenarios in which

changing the default value makes sense are known today:

1. The case where what the CIM Server shall return to clients for host

name is NOT the name of the current host but some administrator defined

name (ex. system behind a firewall or some redirector).

2. Embedded systems that have a system set hostname which is not valid

and needs to be overridden by CIM administrator without changing the

actual IP configuration.

Recommended Default Value (Development Build):  blank

Recommended Default Value (Release Build):  blank

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: No

Considerations: When setting this configuration option the

option fullyQualifiedHostName should be adjusted too.

Providers returning the systems hostname in an instance property might

return a different value then the CIM server is setting in the object

path. hostnames explicitly set into the object paths by providers will

not be overridden by the CIM Server to allow cross-namespace

associations.

It is necessary to upgrade existing repositories using the repupgrade

utility when upgrading from an OpenPegasus version less than 2.12.

Source Configuration File:

Pegasus/Config/DefaultPropertyOwner.cpp

</ul>

<h5>fullyQualifiedHostName</h5>

<ul>

Description:  Can be used to override the local system

supplied fully qualified hostname (with domain) the CIM Server is using

to build objects. If not set, querying this configuration option will

report the system supplied fully qualified hostname and behavior is not

changed.

Setting this value to a valid hostname on CIM Server startup or as

planned value will force the server to assume the configured name as

the local hosts name with domain. Setting this allows the administrator

to set the name that indication operations and the CIM_ObjectManager

assume for SystemName returned as instance and key properties.

In common setups it is not recommended to explicitly set this value.

Usage scenarios:  The following scenarios in which

changing the default value makes sense are known today:

1. The case where what the CIM Server shall return to clients for

SystemName is NOT the name of the current host but some administrator

defined name (ex. system behind a firewall or some redirector).

2. Embedded systems that have a system set hostname which is not valid

and needs to be overridden by CIM administrator without changing the

actual IP configuration.

Recommended Default Value (Development Build):  blank

Recommended Default Value (Release Build):  blank

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: No

Considerations: When setting this configuration option the

option fullyQualifiedHostName should be adjusted too.

Providers returning the systems hostname in an instance property might

return a different value then the CIM server is setting in SystemName.

It is necessary to upgrade existing repositories using the repupgrade

utility when upgrading from an OpenPegasus version less than 2.12.

Source Configuration File:

Pegasus/Config/DefaultPropertyOwner.cpp

</ul>

<h5>httpAuthType</h5>

<ul>

Description: Type of HTTP authentication. Allowed values are

'basic', indicating basic authentication or 'negotiate' indicating use of

HTPP Negotiate authentication method. This variable is effective only when

'enableAuthentication' variable is set to 'true'.

Default Value: basic

Recommended Default Value (Development Build): basic

Recommended Default Value (Release Build): basic

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No

Dynamic?: No

Considerations: Value 'negotiate' is available only when Pegasus

is compiled with PEGASUS_NEGOTIATE_AUTHENTICATION=true.

Source Configuration File:

Pegasus/Config/SecurityPropertyOwner.cpp

</ul>

<h5>httpPort</h5>

<ul>

Description: OpenPegasus first attempts to look up the

port number for HTTP using getservbyname for the 'wbem-http'

port number for HTTP using getservbyname for the 'wbem-http' service.

service. The httpPort configuration setting is used only when the

The httpPort configuration setting is used only when the getservbyname

getservbyname lookup fails.

lookup fails.

Default Value: blank

Recommended Default Value (Development Build): blank

Recommended Default Value (Release Build): 5988

Line 2473

Line 2694

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

Line 2482

Line 2703

is specified, the server will continue to use the value in

/etc/services.

<table border="1" cellspacing="1" bordercolordark="#666666"

bordercolorlight="#CCCCCC" width=531

style='font-size=10.0pt;font-family:Arial'>

<th bgcolor="#cae6ca" width="168">Platform</th>

<tr>

<th bgcolor="#cae6ca" width="350">Source Configuration File</th>

<th bgcolor="#CAE6CA" width="168">Platform</th>

<th bgcolor="#CAE6CA" width=350>Source Configuration File</th>

</tr>

<td width="168">Linux</td>

Line 2504

Line 2723

Pegasus/Config/DefaultPropertyTableVms.h</td>

</tr>

</table>

</tbody></table>

</ul>

<h5>httpsPort</h5>

Line 2526

Line 2745

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

Line 2535

Line 2754

the server will continue to use the value in /etc/services.

<table border="1" cellspacing="1" bordercolordark="#666666"

bordercolorlight="#CCCCCC" width=531

style='font-size=10.0pt;font-family:Arial'>

<th bgcolor="#cae6ca" width="168">Platform</th>

<tr>

<th bgcolor="#cae6ca" width="350">Source Configuration File</th>

<th bgcolor="#CAE6CA" width="168">Platform</th>

<th bgcolor="#CAE6CA" width=350>Source Configuration File</th>

</tr>

<td width="168">Linux</td>

Line 2557

Line 2774

Pegasus/Config/DefaultPropertyTableVms.h</td>

</tr>

</table>

</tbody></table>

</ul>

<h5>httpSessionTimeout</h5>

<ul>

Description: If set to a positive integer, this value

specifies a HTTP session lifetime in seconds.

After initial authentication using standard HTTP mechanisms

(HTTP Basic or Negotiate authentication), the server generates a cookie

and sends it back to the client, as described in RFC 6265. The client

can then use the cookie in subsequent requests to skip the usual HTTP

authentication. The cookie is valid only for period of time specified by

this configuration option.

If set to zero, session management is turned off and CIM server will not

issue cookies.

This option is available only when Pegasus was compiled with

PEGASUS_ENABLE_SESSION_COOKIES set to 'true'.

Recommended Default Value (Development Build): 0

Recommended Default Value (Release Build): 0

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: Yes

Considerations:

The session timeout should be set to relatively small number (e.g. 30) to

ensure the window, when the a potentially stolen cookie can be re-used, is

quite small. This means every client will be re-authenticated the usual way

(HTTP Basic or Negotiate) at least every 30 seconds.

</ul>

<h5>idleConnectionTimeout</h5>

<ul>

Description: If set to a positive integer, this value

Line 2586

Line 2835

changes will apply to all new and existing connections.

</ul>

<h5>maxFailedProviderModuleRestarts</h5>

<ul>

Description: If set to a positive integer, this value

specifies the number of times the failed provider module with

indications enabled are restarted automatically before being

moved to Degraded state. If set to zero, failed provider module

is not restarted with indications enabled automatically and

will be moved to Degraded state immediately.

Recommended Default Value (Development Build): 3

Recommended Default Value (Release Build): 3

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: Yes

Considerations: This option controls the automatic

re-enabling of the failed provider module with indications

enabled. If the provider module with indications enabled fails

very frequently, it affects the CIMServer normal operations because

CIMServer would be busy with reloading the provider module every

time it fails. This option would be helpful if the long running

indication provider crashes and the management application want

to receive the indications from the provider while provider fix

is being delivered. In case of provider module grouping, if one of

the indication provider crashes, it affects all indication providers

in the provider modules of the group. Note that this is the facility

provided by the CIMServer for temporary recovery of the provider and

the ultimate goal SHALL be fixing the faulty provider.

</ul>

<h5>maxIndicationDeliveryRetryAttempts</h5>

<ul>

Description:  If set to a positive integer, value defines the number

of times indication service will enable the reliableIndication feature and try

to deliver an indication to a particular listener destination.

This does not effect the original delivery attempt. A value of disables

reliable indication feature completely, and cimserver will deliver the

indication once.This is in accord with DTMF Specification 1054,

Indication Profile, version 1.2.1.

Recommended Default Value (Development Build): 3

Recommended Default Value (Release Build): 3

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: No

Considerations:  This value is used to set the

CIM_IndicationService.DeliveryRetryAttempts property. See

CIM_IndicationService.DeliveryRetryAttempts property for more details. This

option is supported only when PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT

is defined.

Source Configuration File:

Pegasus/Config/IndicationServicePropertyOwner.cpp

</ul>

<h5>minIndicationDeliveryRetryInterval</h5>

<ul>

Description:  If set to a positive integer, this value defines

the minimal time interval in seconds for the indication service to wait

before retrying to deliver an indication to a listener destination that

previously failed. Cimserver may take longer due to QoS or other processing.

Recommended Default Value (Development Build): 30

Recommended Default Value (Release Build): 30

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: No

Considerations:  This value is used to initialize the property

CIM_IndicationService.DeliveryRetryInterval. See

CIM_IndicationService.DeliveryRetryInterval property for more details. This

option is supported only when PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT

is defined.

Source Configuration File:

Pegasus/Config/IndicationServicePropertyOwner.cpp

</ul>

<h5>listenAddress</h5>

<ul>

Description:  Network interface where the cimserver

should listen to for connections.For example listenAddress=All or

listenAddress=121.12.33.112 or listenAddress=121.33.21.26,127.0.0.1,

fe80::fe62:9346%eth0

Recommended Default Value (Development Build): All

Recommended Default Value (Release Build): No Specific suggestion

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: No

Considerations: Default value of "All" will make cimserver to listen on all the network interfaces.

Source Configuration File:

Pegasus/Config/DefaultPropertyOwner.cpp

</ul>

<h5>logdir</h5>

<ul>

Description: Specifies the name of the directory

Line 2618

Line 2954

Pegsus/Config/LogPropertyOwner.cpp

</ul>

<h5>mapToLocalName</h5>

<ul>

Description:  If 'true', all remote client names are translated

to local ones using GSSAPI. This applies only to clients using Negotiate

authentication method, i.e. when "httpAuthType" runtime variable is set to

"negotiate".

Default Value: false

Recommended Default Value (Development Build):

false

Recommended Default Value (Release Build): false

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: No

Considerations: This option is available only when Pegasus is

compiled with PEGASUS_NEGOTIATE_AUTHENTICATION=true.

Source Configuration File:

Pegasus/Config/SecurityPropertyOwner.cpp

</ul>

<h5>maxLogFileSizeKBytes</h5>

<ul>

Description: Specifies the maximum size of the logfile in Kilo

Line 2648

Line 3003

four. In this case though new provider processes will not be created

but existing five will continue running

<table border="1" cellspacing="1" bordercolordark="#666666"

bordercolorlight="#CCCCCC" width=531

style='font-size=10.0pt;font-family:Arial'>

<th bgcolor="#cae6ca" width="168">Platform</th>

<tr>

<th bgcolor="#CAE6CA" width="168">Platform</th>

Source Configuration File</th>

</tr>

Line 2671

Line 3024

Pegasus/Config/DefaultPropertyTableVms.h</td>

</tr>

</table>

</tbody></table>

</ul>

<h5>messageDir</h5>

Line 2704

Line 3057

Considerations: 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

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

to the system. Administrators 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

Line 2750

Line 3103

Considerations:

Source Configuration File:

Pegasus/Config/FileSystemPropertyOwner.cpp

</ul>

</ul>

<h5>repositoryIsDefaultInstanceProvider</h5>

<h5>repositoryIsDefaultInstanceProvider</h5>

<ul>

Description: If true, the Repository functions

as the Instance Provider for all classes for which there

Description: If true, the Repository functions as

is not an explicitly registered Provider. This flag is

the Instance Provider for all classes for which there is not an explicitly

also used to control the behavior of the repository when

registered Provider. This flag is also used to control the behavior of

processing association operators.

the repository when processing association operators.

Recommended Default Value (Development Build): true

Recommended Default Value (Release Build): false

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No/Yes

Dynamic?:  No

Considerations:  This flag can be used to configure

Considerations:  This flag can be used to configure the

the CIM Server to allow the Repository to be used by CIM Clients

CIM Server to allow the Repository to be used by CIM Clients and CIM

and CIM Providers as a dynamic data store. The setting of this

Providers as a dynamic data store. The setting of this flag will

flag will significantly affect CIM Server behavior as viewed

significantly affect CIM Server behavior as viewed by the CIM Client.

by the CIM Client.

The following issues should be considered when setting

repositoryIsDefaultInstanceProvider=true:

<ul>

<li>Authorization.  The repository has no

<li>Authorization.  The repository has no concept of

concept of which users (or components) are authorized to

which users (or components) are authorized to perform which operations.</li>

perform which operations.</li>

<li>Appearance of instrumentation.  A client

<li>Appearance of instrumentation. �A client application

application cannot determine whether instrumentation exists for a given

cannot determine whether instrumentation exists for a

CIM class. For example,  imagine a client issues a CreateInstance

given CIM class. For example,  imagine a client

operation on a Disk class for    which no provider is

issues a CreateInstance operation on a Disk class

registered.  The instance will be stored in the repository, and

for    which no provider is registered.

the client gets a "success" response. Does that mean a disk device

 The instance will be stored in the repository, and

has been created on the server? Even worse, when another client issues

the client gets a "success" response. Does that mean�a

an EnumerateInstances operation, the spurious Disk instance is

disk device has been created on the server? Even worse,

returned.  With repositoryIsDefaultInstanceProvider=false, the

when another client issues an EnumerateInstances

CreateInstance operation above would have returned a NOT_SUPPORTED

operation, the spurious Disk instance is returned.

error.</li>

 With repositoryIsDefaultInstanceProvider=false, the

CreateInstance operation above would have returned a

<li>Potential for inconsistent data.  Using the

NOT_SUPPORTED error.</li>

repository as a data cache increases the probability that a client will

<li>Potential for inconsistent data. �Using the

see stale or incorrect data. A provider can better control the

repository as a data cache increases the probability

correlation between the data returned and the current state of the

that a client will see stale or incorrect data. A

underlying managed resource (whether or not the provider caches the

provider can better control the correlation

data).</li>

between the data returned and the current state of the

underlying managed resource (whether or not the provider

caches the data).</li>

</ul>

The following issues should be considered when setting

repositoryIsDefaultInstanceProvider=false:

<ul>

<li>Provider Availability. Certain Providers have been

developed to use the Repository as a dynamic data store.

developed to use the Repository as a dynamic data store. These

These Providers are currently not supported on system

Providers are currently not supported on system where this flag is

where this flag is disabled. E.g., the Common Diagnostics

disabled. E.g., the Common Diagnostics Model (CDM) Provider

Model (CDM) Provider

(http://developer.intel.com/design/servers/cdm/) relies on use of the

(http://developer.intel.com/design/servers/cdm/)

Repository to store instances of CIM_DiagnosticSetting.  If this

relies on use of the Repository to store instances

flag set to false, this Provider will not function correctly. Note that

of CIM_DiagnosticSetting.  If this flag set to

this feature is supported by other WBEM implementation. 

false, this Provider will not function correctly. Note

Therefore, disabling this feature can increase the cost of migrating

that this feature is supported by other WBEM

existing Providers to OpenPegasus.</li>

implementation.  Therefore, disabling this feature

can increase the cost of migrating existing Providers to

OpenPegasus.</li>

</ul>

Source Configuration File:

Pegasus/Config/RepositoryPropertyOwner.cpp

</ul>

<h5>shutdownTimeout</h5>

<h5>shutdownTimeout</h5>

<ul>

Description: When a cimserver -s shutdown command is

issued, specifies the maximum time in seconds for the CIM Server

issued, specifies the maximum time in seconds for the CIM Server to

to complete outstanding CIM operation requests before shutting

complete outstanding CIM operation requests before shutting down; if

down; if the specified timeout period expires, the CIM Server

the specified timeout period expires, the CIM Server will shut down,

will shut down, even if there are still CIM operations in

even if there are still CIM operations in progress. Minimum value is 2

progress. Minimum value is 2 seconds.

seconds.

Recommended Default Value (Development Build): 10

Recommended Default Value (Release Build): 10

Recommend To Be Fixed/Hidden (Development Build): No/No

Line 2839

Line 3186

Considerations:

Source Configuration File:

Pegasus/Config/ShutdownPropertyOwner.cpp

</ul>

<ul>

Description: When set to true, OpenPegasus activates

an SLP SA and issues DMTF defined SLP advertisements to this SA

an SLP SA and issues DMTF defined SLP advertisements to this SA on startup.

on startup.

Default Value: false

Recommended Default Value (Development Build): false

Recommended Default Value (Release Build): false

Line 2853

Line 3202

Recommend To Be Fixed/Hidden (Release Build): Yes

Dynamic?: No

<table border="1" cellspacing="1" bordercolordark="#666666"

bordercolorlight="#CCCCCC" width=531

<tbody>

style='font-size=10.0pt;font-family:Arial' height="80">

<tr>

<th bgcolor="#CAE6CA" width="168" height="16">Platform</th>

<th bgcolor="#cae6ca" height="16" width="168">Platform</th>

<th bgcolor="#cae6ca" height="16" width="350"> Source

Source Configuration File</th>

Configuration File</th>

</tr>

<td width="168" height="14">Linux</td>

<td height="14" width="168">Linux</td>

<td align="left" height="14" width="350">Pegasus/Config/DefaultPropertyTableLinux.h</td>

Pegasus/Config/DefaultPropertyTableLinux.h</td>

</tr>

<td align="left" height="14" width="350">Pegasus/Config/DefaultPropertyTableHpux.h</td>

Pegasus/Config/DefaultPropertyTableHpux.h</td>

</tr>

<td width="168" height="16">OpenVMS</td>

<td height="16" width="168">OpenVMS</td>

<td align="left" height="16" width="350">Pegasus/Config/DefaultPropertyTableVms.h</td>

Pegasus/Config/DefaultPropertyTableVms.h</td>

</tr>

</tbody>

</table>

</ul>

<h5>slpProviderStartupTimeout</h5>

<ul>

Description: Timeout value in milli seconds used to

specify how long the registration with an SLP SA may take. Registration

will be retried three times. This value only needs to be increased in

case that the loading of a set of providers who reporting their

implementation of a registered profile takes very long.

Default Value: 300000

Recommended Default Value (Development Build): 300000

Recommended Default Value (Release Build): 300000

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: No

<tbody>

<tr>

<th bgcolor="#cae6ca" height="16" width="168">Platform</th>

<th bgcolor="#cae6ca" height="16" width="350"> Source

Configuration File</th>

</tr>

<td height="14" width="168">Linux</td>

<td align="left" height="14" width="350">Pegasus/Config/DefaultPropertyTable.h</td>

</tr>

<td align="left" height="14" width="350">Pegasus/Config/DefaultPropertyTable.h</td>

</tr>

<td height="16" width="168">OpenVMS</td>

<td align="left" height="16" width="350">Pegasus/Config/DefaultPropertyTable.h</td>

</tr>

</tbody>

</table>

</ul>

<h5>socketWriteTimeout</h5>

<h5>socketWriteTimeout</h5>

<ul>

Description: If the CIM Server receives an

EWOULDBLOCK/EAGAIN error on a non-blocking write,

EWOULDBLOCK/EAGAIN error on a non-blocking write, socketWriteTimeout

socketWriteTimeout defines the number of seconds the

defines the number of seconds the CIM Server will wait for the socket

CIM Server will wait for the socket to get ready and resume

to get ready and resume writing data.

writing data.

Recommended Default Value (Development Build):  20

Recommended Default Value (Development Build):

(seconds)

20 (seconds)

Recommended Default Value (Release Build):  20 (seconds)

Recommended Default Value (Release Build):

20 (seconds)

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: Yes

Considerations: Any changes made to this config property

dynamically will apply to new CIM Server connections only

dynamically will apply to new CIM Server connections only keeping old

keeping old already established connections unchanged.

already established connections unchanged.

Source Configuration File:

Pegasus/Config/DefaultPropertyTable.h

</ul>

<h5>sslCertificateFilePath</h5>

<h5>sslCertificateFilePath</h5>

<ul>

Description: Contains the CIM Server SSL

Certificate.

Description: Contains the CIM Server SSL Certificate.

Recommended Default Value (Development Build):

Recommended Default Value (Development Build):  server.pem

server.pem

Recommended Default Value (Release Build):

$CERTIFICATEDIR/server.pem"

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): Yes

Dynamic?: No

Considerations: For a more detailed look at SSL options

Considerations: For a more detailed look at SSL options and

and their ramifications, please see the SSL guidelines.

their ramifications, please see the SSL guidelines.

Source Configuration File:

Pegasus/Config/SecurityPropertyOwner.cpp

</ul>

<h5>sslCipherSuite</h5>

<ul>

Description: String containing OpenSSL cipher

specifications to configure the cipher suite the client is permitted to

negotiate with the server during the SSL handshake phase.

Recommended Default Value (Development Build):  DEFAULT

(the default cipher list of OpenSSL)

Recommended Default Value (Release Build):  DEFAULT (the

default cipher list of OpenSSL)

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: No

Considerations: The value should be mentioned between

single quotes since it can contain special characters like .+, !, -..

For more details look at SSL ciphers.

Source Configuration File:

Pegasus/Config/SecurityPropertyOwner.cpp

</ul>

<h5>sslClientVerificationMode</h5>

<h5>sslBackwardCompatibility</h5>

<ul>

Description:  If set to true, OpenPegasus support

SSLv3

and TLSv1 protocol.If set to false OpenPegasus support only TLS1.2

protocol for openssl 1.0.1+

Recommended Default Value (Development Build):  false

Recommended Default Value (Release Build):  false

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: No

Considerations:  For a more detailed look at SSL options

and their ramifications, please see the SSL guidelines.

Source Configuration File:

Pegasus/Config/SecurityPropertyOwner.cpp

</ul>

<h5>sslClientVerificationMode</h5>

<ul>

Description: Describes the desired level of support

for certificate-based authentication.

for

certificate-based authentication.

<li>�required� � The server requires certificate-based

client authentication.  A client MUST present a

<li>“required” – The server requires certificate-based

trusted certificate in order to access the CIM Server. 

client authentication.  A client MUST present a trusted

If the client fails to send a certificate or sends an

certificate in order to access the CIM Server.  If the client

untrusted certificate, the connection will be rejected.</li>

fails to send a certificate or sends an untrusted certificate, the

<li>�optional� � The server supports, but does not

connection will be rejected.</li>

require, certificate-based client authentication. The

<li>“optional” – The server supports, but does not

server will request and attempt to validate a client

require,

certificate, however the connection will be accepted even

certificate-based client authentication. The server will request and

if no certificate is sent or an untrusted certificate is

attempt to validate a client certificate, however the connection will

sent.  The server will then seek to authenticate the

be accepted even if no certificate is sent or an untrusted certificate

client via an authentication header.</li>

is sent.  The server will then seek to authenticate the client via

<li>�disabled� � The server does not support

an authentication header.</li>

<li>“disabled” – The server does not support

certificate-based client authentication.</li>

</ul>

Recommended Default Value (Development Build):

disabled

Recommended Default Value (Release Build):

Recommended Default Value (Release Build):  disabled

disabled

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: No

Considerations: (1) This property is only used if

Considerations: (1) This property is only used if enableHttpsConnection

enableHttpsConnection is "true".

is "true". (2) If the platform does not support

(2) If the platform does not support PEGASUS_LOCAL_DOMAIN_SOCKET,

PEGASUS_LOCAL_DOMAIN_SOCKET, OpenPegasus attempts to use either HTTPS

OpenPegasus attempts to use either HTTPS or

or HTTP to establish a local connection (connectLocal).  For

HTTP to establish a local connection (connectLocal). 

platforms that do not support PEGASUS_LOCAL_DOMAIN_SOCKET, Clients

For platforms that do not support PEGASUS_LOCAL_DOMAIN_SOCKET,

which use connectLocal, such as cimconfig -l -c, cimprovider -l -s and

Clients which use connectLocal, such as cimconfig -l -c,

cimserver -s, will not work if  the "sslClientVerificationMode"

cimprovider -l -s and cimserver -s, will not work if  the

variable is set to "required" and HTTP is disabled.  For these

"sslClientVerificationMode" variable is set to

platforms, the recommended course of action is to change the property

"required" and HTTP is disabled.  For these

value to "optional."

platforms, the recommended course of action is to change the

property value to "optional."

Source Configuration File:

Pegasus/Config/SecurityPropertyOwner.cpp

</ul>

<h5>sslKeyFilePath</h5>

<h5>sslKeyFilePath</h5>

<ul>

Description: Contains the private key for the CIM

Server SSL Certificate.

Recommended Default Value (Development Build):

Recommended Default Value (Development Build):  file.pem

file.pem

Recommended Default Value (Release Build):

$CERTIFICATEDIR/file.pem

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): Yes

Dynamic?: No

Considerations: File should be readable only by the

Considerations: File should be readable only by the user the

user the cimserver is running as and/or privileged users. The

cimserver is running as and/or privileged users. The file should be

file should be writeable only by a privileged user.

writeable only by a privileged user.

Source Configuration File:

Pegasus/Config/SecurityPropertyOwner.cpp

</ul>

<h5>sslTrustStore</h5>

<h5>sslTrustStore</h5>

<ul>

Description: Specifies the location of the OpenSSL

truststore. Consistent with the OpenSSL implementation, a

truststore. Consistent with the OpenSSL implementation, a truststore

truststore can be either a file or directory. If the truststore

can be either a file or directory. If the truststore is a directory,

is a directory, all the certificates within the directory are

all the certificates within the directory are considered trusted.

considered trusted.

Recommended Default Value (Development Build):  client.pem

Recommended Default Value (Development Build):

client.pem

Recommended Default Value (Release Build):

$CERTIFICATEDIR/client.pem

Recommend To Be Fixed/Hidden (Development Build): No/No

Line 2996

Line 3428

Pegsus/Config/SecurityPropertyOwner.cpp

</ul>

<h5>sslTrustStoreUserName</h5>

<h5>sslTrustStoreUserName</h5>

<ul>

Description: Specifies the system user name to be

associated with all certificate-based authenticated requests.

Recommended Default Value (Development Build): NONE

Line 3006

Line 3440

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: No

Considerations: This property has no default; for

security reasons, the system administrator must explicitly

security reasons, the system administrator must explicitly specify this

specify this value.  This feature allows a single user

value.  This feature allows a single user name to be

name to be specified.  This user will be associated

specified.  This user will be associated with all certificates in

with all certificates in the truststore.  In the future,

the truststore.  In the future, OpenPegasus will allow a system

OpenPegasus will allow a system administrator to associate a

administrator to associate a distinct user name with each certificate.

distinct user name with each certificate.

Source Configuration File:

Pegsus/Config/SecurityPropertyOwner.cpp

</ul>

<h5>traceComponents</h5>

<h5>traceComponents</h5>

<ul>

Description: Defines the components to be traced.

Default Value: ""

Recommended Default Value (Development Build): ""

Line 3027

Line 3463

Dynamic?: Yes

Source Configuration File:

Pegasus/Config/TracePropertyOwner.cpp

</ul>

<h5>traceFacility</h5>

<h5>traceFacility</h5>

<ul>

Description: Defines the desired facility for trace

messages. Valid values include: "File"

messages. Valid values include: "File" , "Log" and "Memory" .

, "Log" and "Memory" .

Default Value: File

Recommended Default Value (Development Build): File

Recommended Default Value (Release Build): File

Line 3041

Line 3479

Recommend To Be Fixed/Hidden (Release Build): No/Yes

Dynamic?: Yes

Case Sensitive?: No

Considerations: If you specify "File",

Considerations: If you specify "File", trace messagesare

trace messagesare written into the file specified by the

written into the file specified by the configuration option

configuration option traceFilePath. If you specify

traceFilePath. If you specify "Log", trace messages are written to the

"Log", trace messages are written to the

OpenPegasus Log. If you specify Memory, the trace messages are

OpenPegasus Log. If you specify Memory, the trace messages

collected in a wrap-around memory buffer. If this memory is part of a

are collected in a wrap-around memory buffer.

dump the trace messages can be found by the eye-catcher

If this memory is part of a dump the trace messages can be

"PEGASUSMEMTRACE" at the top of the memory buffer. The trace is in

found by the eye-catcher "PEGASUSMEMTRACE" at

clear text and the last written message has the suffix "EOTRACE".

the top of the memory buffer. The trace is in clear text and

the last written message has the suffix "EOTRACE".

Source Configuration File:

Pegasus/Config/TracePropertyOwner.cpp

</ul>

<h5>traceFilePath</h5>

<h5>traceFilePath</h5>

<ul>

Description: Specifies the location of the

OpenPegasus trace file.

OpenPegasus

trace file.

Default Value: cimserver.trc

Recommended Default Value (Development Build):

Recommended Default Value (Development Build): cimserver.trc

cimserver.trc

Recommended Default Value (Release Build):

$TRACEDIR/cimserver.trc

Recommend To Be Fixed/Hidden (Development Build):No/No

Line 3069

Line 3508

Dynamic?: Yes

Source Configuration File:

Pegasus/Config/TracePropertyOwner.cpp

</ul>

<h5>traceLevel</h5>

<h5>traceLevel</h5>

<ul>

Description: Defines the desired level of

tracing. Valid values include: 0, 1, 2, 3, 4, 5.

Description: Defines the desired level of tracing.

Valid

values include: 0, 1, 2, 3, 4, 5.

Default Value: 0

Recommended Default Value (Development Build): 0

Recommended Default Value (Release Build): 0<

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No/Yes

Dynamic?: Yes

Source Configuration File:

Pegasus/Config/TracePropertyOwner.cpp

</ul>

<h5>traceMemoryBufferKbytes</h5>

<h5>traceMemoryBufferKbytes</h5>

<ul>

Description: Defines the size of the buffer for

in memory tracing in kbytes ( 210 bytes ).

Description: Defines the size of the buffer for in

Smallest value is 16.

memory

tracing in kbytes ( 210 bytes ). Smallest value is 16.

Default Value: 10240

Recommended Default Value (Development Build): 10240

Recommended Default Value (Release Build): 10240

Line 3097

Line 3543

Recommend To Be Fixed/Hidden (Release Build): No/No

Dynamic?: No

Case Sensitive?: No

Considerations: Is ignored if configuration

Considerations: Is ignored if configuration property

property traceFacility is not set to Memory.

traceFacility is not set to Memory.

Source Configuration File:

Pegasus/Config/TracePropertyOwner.cpp

</ul>

<h3>Configuration Constants</h3>

<h5>traceFileSizeKBytes</h5>

<h4>Definitions</h4>

<ul>

Description: Defines the size of the tracefile in

Kilo

bytes. The trace file will be rolled once its size exceeds the

specified size.

Default Value: 1048576

Recommended Default Value (Development Build): 1048576

Recommended Default Value (Release Build): 1048576

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No/Yes

Dynamic?: Yes

Considerations:Minimum accepted value is 10240 KB,Maximum

accepted value is 2097152 KB.

Source Configuration File:

Pegsus/Config/TracePropertyOwner.cpp

</ul>

<h5>numberOfTraceFiles</h5>

<ul>

Description: Specifies the number of the tracefiles

for

rolling.

Default Value: 3

Recommended Default Value (Development Build): 3

Recommended Default Value (Release Build): 3

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): No/Yes

Dynamic?: Yes

Considerations:Minimum accepted value is 3,Maximum accepted

value is 20.

Source Configuration File:

Pegsus/Config/TracePropertyOwner.cpp

</ul>

<h5>webRoot</h5>

<ul>

Description:  Points to a location where the static

web

pages to be served by the pegasus webserver are stored.

Default Value: www

Recommended Default Value (Development Build): www

Recommended Default Value (Release Build): $WEBCONFDIR/www

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): Yes/Yes

Dynamic?: No

Considerations: When not fixed and hidden, it can be modified

to point to a location having spurious pages. Please consider fixing

this value.

Source Configuration File:

Pegsus/Config/DefaultPropertyOwner.cpp

</ul>

<h5>indexFile</h5>

<ul>

Description:  Specifies the name of index file used

pegasus webserver, default to index.html. This file should be available

at the webRoot path.

Default Value: index.html

Recommended Default Value (Development Build): index.html

Recommended Default Value (Release Build): index.html

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): Yes/Yes

Dynamic?: No

Considerations:   Hide it and fixed in release build to

prevent using any file as index file

Source Configuration File:

Pegsus/Config/DefaultPropertyOwner.cpp

</ul>

<h5>mimeTypesFile</h5>

<ul>

Description:  Refers to the file which holds the

mime

types being served by the pegasus webserver.

Default Value: www/mimeTypes.txt

Recommended Default Value (Development Build): www/mimeTypes.txt

Recommended Default Value (Release Build): $WEBCONFDIR/www/mimeTypes.txt

Recommend To Be Fixed/Hidden (Development Build): No/No

Recommend To Be Fixed/Hidden (Release Build): Yes/Yes

Dynamic?: No

Considerations: Fix and make it read only when to prevent

modification in deployment

Source Configuration File:

Pegsus/Config/DefaultPropertyOwner.cpp

</ul>

<h3>Configuration Constants</h3>

<h4>Definitions</h4>

<h5>static char CURRENT_CONFIG_FILE [] = </h5>

<h5>static char CURRENT_CONFIG_FILE [] = </h5>

<ul>

Description: Default file name for the current

configuration file.

Recommended Default Value (Development Build):

Line 3117

Line 3669

$CONFIGDIR/cimserver_current.conf

Dynamic?: No

<table border="1" cellspacing="1" bordercolordark="#666666"

bordercolorlight="#CCCCCC" width=531

style='font-size=10.0pt;font-family:Arial'>

<tbody>

<tr>

<th bgcolor="#CAE6CA" width="168">Platform</th>

<th bgcolor="#cae6ca" width="168">Platform</th>

<th bgcolor="#cae6ca" width="350"> Source Configuration File</th>

Source Configuration File</th>

</tr>

<td width="168">Linux</td>

<td align="left" width="350">Pegasus/Config/ConfigFileDirLinux.h</td>

Pegasus/Config/ConfigFileDirLinux.h</td>

</tr>

Line 3136

Line 3686

</tr>

<td width="168">OpenVMS</td>

<td align="left" width="350"> Pegasus/Config/ConfigFileDirVms.h</td>

Pegasus/Config/ConfigFileDirVms.h</td>

</tr>

</tbody>

</table>

</ul>

<h5>static char PLANNED_CONFIG_FILE [] = </h5>

<h5>static char PLANNED_CONFIG_FILE [] = </h5>

<ul>

Description: Default file name for the planned

configuration file.

Recommended Default Value (Development Build):

Line 3152

Line 3704

$CONFIGDIR/cimserver_planned.conf

Dynamic?: No

<table border="1" cellspacing="1" bordercolordark="#666666"

bordercolorlight="#CCCCCC" width=531

style='font-size=10.0pt;font-family:Arial'>

<tbody>

<tr>

<th bgcolor="#CAE6CA" width="168">Platform</th>

<th bgcolor="#cae6ca" width="168">Platform</th>

<th bgcolor="#cae6ca" width="350"> Source Configuration File</th>

Source Configuration File</th>

</tr>

<td width="168">Linux</td>

<td align="left" width="350">Pegasus/Config/ConfigFileDirLinux.h</td>

Pegasus/Config/ConfigFileDirLinux.h</td>

</tr>

<td align="left" width="350"> Pegasus/Config/ConfigFileDirHpux.h</td>

Pegasus/Config/ConfigFileDirHpux.h</td>

</tr>

<td width="168">OpenVMS</td>

<td align="left" width="350"> Pegasus/Config/ConfigFileDirVms.h</td>

Pegasus/Config/ConfigFileDirVms.h</td>

</tr>

</tbody>

</table>

</ul>

<h5>static char CIMSERVER_START_FILE [] = </h5>

<h5>static char CIMSERVER_START_FILE [] = </h5>

<ul>

Description: This is for the default file name

for the cimserver startup file containing the PID.

Description: This is for the default file name for

the

cimserver startup file containing the PID.

Default Value: /tmp/cimserver_start.conf

Recommended Default Value (Development Build):

/tmp/cimserver_start.conf

Recommended Default Value (Release Build):

Recommended Default Value (Release Build):  $PIDFILE

$PIDFILE

Dynamic?: No

<table border="1" cellspacing="1" bordercolordark="#666666"

bordercolorlight="#CCCCCC" width=531

style='font-size=10.0pt;font-family:Arial'>

<tbody>

<tr>

<th bgcolor="#CAE6CA" width="168">Platform</th>

<th bgcolor="#cae6ca" width="168">Platform</th>

<th bgcolor="#cae6ca" width="350"> Source Configuration File</th>

Source Configuration File</th>

</tr>

<td width="168">Linux</td>

<td align="left" width="350">Pegasus/Config/ConfigFileDirLinux.h</td>

Pegasus/Config/ConfigFileDirLinux.h</td>

</tr>

<td align="left" width="350"> Pegasus/Config/ConfigFileDirHpux.h</td>

Pegasus/Config/ConfigFileDirHpux.h</td>

</tr>

<td width="168">OpenVMS</td>

<td align="left" width="350"> Pegasus/Config/ConfigFileDirVms.h</td>

Pegasus/Config/ConfigFileDirVms.h</td>

</tr>

</tbody>

</table>

</ul>

<h3>Configuration Macros</h3>

<h3>Configuration Macros</h3>

<h4>Definitions</h4>

<h4>Definitions</h4>

<h5>PEGASUS_SSLCLIENT_CERTIFICATEFILE</h5>

<h5>PEGASUS_SSLCLIENT_CERTIFICATEFILE</h5>

<ul>

Description:

Description:

Recommended Default Value (Development Build): client.pem

Recommended Default Value (Release Build):

$CERTIFICATEDIR/client.pem

Dynamic?: No

Source Configuration File:

Source Configuration File:  Pegasus/Common/Constants.h

Pegasus/Common/Constants.h

</ul>

<h5>PEGASUS_SSLCLIENT_RANDOMFILE</h5>

<h5>PEGASUS_SSLCLIENT_RANDOMFILE</h5>

<ul>

Description: On platforms that do not support

/dev/random or /dev/urandom, OpenSSL will use this file to

/dev/random

seed the PRNG (Pseudo-Random Number Generator). This

or /dev/urandom, OpenSSL will use this file to seed the PRNG

PEGASUS_SSLCLIENT_RANDOMFILE defines the default CIM

(Pseudo-Random Number Generator). This PEGASUS_SSLCLIENT_RANDOMFILE

Client random file.

defines the default CIM Client random file.

Recommended Default Value (Development Build):ssl.rnd

Recommended Default Value (Release Build):

Recommended Default Value (Release Build): $RANDOMDIR/ssl.rnd

$RANDOMDIR/ssl.rnd

Dynamic?: No

Considerations: Use of this variable requires

PEGASUS_HAS_SSL to be set.  CIM Client use of a

PEGASUS_HAS_SSL to be set.  CIM Client use of a shared random file

shared random file is not recommended.  On systems where

is not recommended.  On systems where /dev/random or /dev/urandom

/dev/random or /dev/urandom are not available, CIM Clients are

are not available, CIM Clients are encouraged to generate a unique

encouraged to generate a unique random file which

random file which contains sufficient entropy.

contains sufficient entropy.

Source Configuration File:  Pegasus/Common/Constants.h

Source Configuration File:

Pegasus/Common/Constants.h

</ul>

<h5>PEGASUS_SSLSERVER_RANDOMFILE</h5>

<h5>PEGASUS_SSLSERVER_RANDOMFILE</h5>

<ul>

Description: On platforms that do not support

/dev/random or /dev/urandom, OpenSSL will use this file

/dev/random

to seed the PRNG (Pseudo-Random Number Generator). This

or /dev/urandom, OpenSSL will use this file to seed the PRNG

PEGASUS_SSLSERVER_RANDOMFILE defines the CIM Server

(Pseudo-Random Number Generator). This PEGASUS_SSLSERVER_RANDOMFILE

random file.

defines the CIM Server random file.

Recommended Default Value (Development Build):

cimserver.rnd

Recommended Default Value (Release Build):

$RANDOMDIR/cimserver.rnd

Dynamic?: No

Considerations: 1)Use of this variable

Considerations: 1)Use of this variable requires

requires  PEGASUS_HAS_SSL to be set.(2) On systems where

PEGASUS_HAS_SSL to be set.(2) On systems where /dev/random or

/dev/random or /dev/urandom are not available, CIM Server

/dev/urandom are not available, CIM Server vendors need to be sure that

vendors need to be sure that the cimserver.rnd file

the cimserver.rnd file contains sufficient entropy and is uniquely

contains sufficient entropy and is uniquely generated for

generated for each system.

each system.

Source Configuration File:  Pegasus/Common/Constants.h

Source Configuration File:

Pegasus/Common/Constants.h

</ul>

<h5>PEGASUS_LOCAL_AUTH_DIR</h5>

<h5>PEGASUS_LOCAL_AUTH_DIR</h5>

<ul>

Description: For local connections (i.e.,

connectLocal), OpenPegasus uses a file-based authentication

Description: For local connections (i.e.,

mechanism.

connectLocal), OpenPegasus uses a file-based authentication mechanism.

Recommended Default Value (Development Build): /tmp

Recommended Default Value (Release Build):

$LOCALAUTHDIR/localauth

Dynamic?: No

Source Configuration File:

Source Configuration File:  Pegasus/Common/Constants.h

Pegasus/Common/Constants.h

</ul>

<h5>PEGASUS_LOCAL_DOMAIN_SOCKET_PATH</h5>

<h5>PEGASUS_LOCAL_DOMAIN_SOCKET_PATH</h5>

<ul>

Description:

Recommended Default Value (Development Build):

/tmp/cimxml.socket

Recommended Default Value (Release Build):

$SOCKETDIR/cimxml.socket

Dynamic?: No

Source Configuration File:

Source Configuration File:  Pegasus/Common/Constants.h

Pegasus/Common/Constants.h

</ul>

<hr>

Licensed to The Open Group (TOG) under one or more contributor license

Licensed to The Open Group (TOG) under one or more contributor

license

agreements. Refer to the OpenPegasusNOTICE.txt file distributed with

this work for additional information regarding copyright ownership.

Each contributor licenses this file to you under the OpenPegasus Open

Source License; you may not use this file except in compliance with the

License.

License.

Permission is hereby granted, free of charge, to any person obtaining a

copy of this software and associated documentation files (the "Software"),

Permission is hereby granted, free of charge, to any person

to deal in the Software without restriction, including without limitation

obtaining a

the rights to use, copy, modify, merge, publish, distribute, sublicense,

copy of this software and associated documentation files (the

"Software"),

to deal in the Software without restriction, including without

limitation

the rights to use, copy, modify, merge, publish, distribute,

sublicense,

and/or sell copies of the Software, and to permit persons to whom the

Software is furnished to do so, subject to the following conditions:

Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included

in all copies or substantial portions of the Software.

The above copyright notice and this permission notice shall be

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS

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.

SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

<hr>

</body>

</body></html>

</html>

Legend:

Removed from v.1.13.2.2
changed lines
	Added in v.1.51

No CVS admin address has been configured