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.9 and 1.18.2.2

version 1.9, 2008/11/19 06:01:19

version 1.18.2.2, 2010/08/10 12:23:33

Line 518

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

Line 639

Line 656

to false), a build error will be generated.

</ul>

<h5>PEGASUS_ENABLE_ENCAPSULATED_XML</h5>

<ul>

Description:

This option enables the "encapsulated XML" feature. It is used in

conjunction with the "internal binary protocol" feature (see

PEGASUS_ENABLE_INTERNAL_BINARY_PROTOCOL). When enabled, the out-of-process

provider agent serializes CIM instances (contained in get-instance and

enumerate-instances responses) as XML (embedded in a binary message

envelope). This improves performance since the server may pass the

XML instaces through to the requesting client without deserializing them

from binary and then reserializing them as XML.

Default Value: false

Recommended Value (Development Build):

No Specific Recommendation

Recommended Value (Release Build):

No Specific Recommendation

Required: No

Considerations: This feature has no effect unless the "internal

binary protocol" feature is enabled (see

PEGASUS_ENABLE_INTERNAL_BINARY_PROTOCOL). Deciding whether to enable or

disable this feature is left to the user. Every environment is different

and some users may prefer lower bandwidth rather than higher performance.

</ul>

<h5>PEGASUS_ENABLE_EXECQUERY</h5>

<ul>

Description: When this environment variable is set,

Line 755

Line 747

indication provider.

</ul>

<h5>PEGASUS_ENABLE_INTERNAL_BINARY_PROTOCOL</h5>

<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,

Line 767

Line 759

Required: No

Considerations: This option improves performance by optimizing the

serialization and deserialization of messages between the server and

out-of-process providers. The binary protocol also supports an optional

out-of-process providers.

"encapsulated XML" feature (see PEGASUS_ENABLE_ENCAPSULATED_XML) for

details.

</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

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

instead. See 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

binary protocol between local clients and the CIM server.

</ul>

Line 1664

Line 1670

the "Release Build" configuration options. By default,

OpenPegasus is built using the "Development Build"

configuration options.

Default Value: Not Set

Default Value: false

Recommended Value (Development Build): Not Set

Recommended Value (Development Build): false

Recommended Value (Release Build): Set

Recommended Value (Release Build): true

Required: No

Considerations: (1)The

PEGASUS_USE_RELEASE_CONFIG_OPTIONS variable allows a platform

Line 1701

Line 1707

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_USE_SQLITE_REPOSITORY</h5>

<ul>

Description: If true, new repository stores are created

Line 1785

Line 1814

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 2181

Line 2210

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

Line 2285

Line 2338

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

</ul>

<h5>enableSubscriptionsForNonprivilegedUsers</h5>

<ul>

Description: If true, operations (create instance,

Line 2344

Line 2381

Pegasus/Config/NormalizationPropertyOwner.cpp

</ul>

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

<ul>

Description: If true, the CIM Server runs Providers

Line 2580

Line 2597

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: A client connection is considered

idle when it is not in the process of sending a request and

the CIM Server is not processing a request from that connection.

Line 2592

Line 2610

considered when configuring an idle connection timeout value.

The idle connection time is computed using the system clock.

Thus, resetting the system clock may cause unexpected timeout

behavior.

behavior.This config property can be changed dynamically. The

changes will apply to all new and existing connections.

</ul>

<h5>logdir</h5>

Line 2709

Line 2728

$PROVIDERDIRS

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

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

Dynamic?: No

Dynamic?: Yes

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

Line 2901

Line 2920

20 (seconds)

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

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

Dynamic?: No

Dynamic?: Yes

Considerations: Any changes made to this config property

dynamically will apply to new CIM Server connections only

keeping old already established connections unchanged.

Source Configuration File:

Pegasus/Config/DefaultPropertyTable.h

</ul>

Line 3039

Line 3061

<ul>

Description: Defines the desired facility for trace

messages. Valid values include: "File"

and "Log".

, "Log" and "Memory" .

Default Value: File

Recommended Default Value (Development Build): File

Recommended Default Value (Release Build): File

Line 3051

Line 3073

trace messagesare written into the file specified by the

configuration option traceFilePath. If you specify

"Log", trace messages are written to the

OpenPegasus Log.

OpenPegasus Log. If you specify Memory, the trace messages

are collected in a wrap-around memory buffer.

If this memory is part of a dump the trace messages can be

found by the eye-catcher "PEGASUSMEMTRACE" at

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>

Line 3086

Line 3113

Pegasus/Config/TracePropertyOwner.cpp

</ul>

<h5>traceMemoryBufferKbytes</h5>

<ul>

Description: Defines the size of the buffer for

in 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

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

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

Dynamic?: No

Case Sensitive?: No

Considerations: Is ignored if configuration

property traceFacility is not set to Memory.

Source Configuration File:

Pegasus/Config/TracePropertyOwner.cpp

</ul>

<h3>Configuration Constants</h3>

<h4>Definitions</h4>

Line 3282

Line 3327

</ul>

<hr>

Licensed to The Open Group (TOG) under one or more contributor license

agreements. Refer to the OpenPegasusNOTICE.txt file distributed with

Company, L.P.; IBM Corp.; The Open Group; VERITAS Software Corporation

this work for additional information regarding copyright ownership.

Each contributor licenses this file to you under the OpenPegasus Open

EMC Corporation; Symantec Corporation; The Open Group.

Source License; you may not use this file except in compliance with the

License.

Permission is hereby granted, free of charge, to any person

Permission is hereby granted, free of charge, to any person obtaining a

obtaining a copy  of this software and associated documentation files

copy of this software and associated documentation files (the "Software"),

(the "Software"), to deal in the Software without restriction,

to deal in the Software without restriction, including without limitation

including without limitation the rights to use, copy,

the rights to use, copy, modify, merge, publish, distribute, sublicense,

modify, merge, publish, distribute, sublicense, and/or sell copies

and/or sell copies of the Software, and to permit persons to whom the

of the Software, and to permit persons to whom the Software is

Software is furnished to do so, subject to the following conditions:

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 INCLUDED

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS

IN ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE

OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

SOFTWARE IS PROVIDED  "AS IS", WITHOUT WARRANTY OF ANY

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS

TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN

SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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.

<hr>

Template last modified: January 20th 2004 by Martin Kirk Template version: 1.6

</body>

</html>

Legend:

Removed from v.1.9
changed lines
	Added in v.1.18.2.2

No CVS admin address has been configured