1 denise.eckstein 1.1 <html>
2 <head>
3 <link rel="stylesheet" href=
4 "http://www.opengroup.org/stylesheets/info1.css">
5 </head>
6
7 <body>
8 <hr>
9
10 <p align="center">
11 <b><font size="4">Recommended OpenPegasus Build and Configuration Options for Selected Platforms</font></b>
12 </p>
13
14 <hr>
15
16 <p><b>Abstract: </b>
17 This document defines a set of recommended options for building,
18 testing and running OpenPegasus on a selected set of
19 platforms. In this version of the document, platform-specific configuration
20 information have been documented for the platforms described in the
21 "Documented Platforms" section of this document.
22 denise.eckstein 1.1 </p>
23
24 <p><b>Note 1: </b>
25 The recommendations defined in this document are not intended to document
26 the feature set included in any vendor's OpenPegasus-based product.
27 Rather, the purpose of this document is to provide input to vendors when
28 making product decisions.<BR>
29 </p>
30
31 <hr>
32
33 <h2>Definition of the Problem</h2>
34
35 <p>OpenPegasus supports a large number of build and runtime options.
36 Determining which options to use can be challenging. The purpose of this
37 document is to simplify the build, testing and administration of OpenPegasus
38 by providing a recommended, tested set of options.</p>
39
40 <h2>Documented Platforms</h2>
41
42 <p>Support for the OpenPegasus build and runtime options described in
43 denise.eckstein 1.1 this document varies by platform. In this version of the
44 document, platform-specific configuration information has been included
45 for the platforms described in the following table. For all other
46 platforms, please consult the OpenPegasus Platform Advocate for
47 additional information.</p>
48
49 <ul>
50 <table border="1" cellspacing="1" bordercolordark="#666666"
51 bordercolorlight="#CCCCCC" width=20%>
52 <tr>
53 <th bgcolor="#CAE6CA" align=center>Platform</th>
54 <th bgcolor="#CAE6CA" align=center>Status</th>
55 </tr>
56 <tr align="left">
57 <td>HPUX_IA64_ACC</td>
58 <td> </td>
59 </tr>
60 <tr align="left">
61 <td>HPUX_PARISC_ACC</td>
62 <td> </td>
63 </tr>
64 denise.eckstein 1.1 <tr align="left">
65 <td>LINUX_IA64_GNU</td>
66 <td> </td>
67 </tr>
68 <tr align="left">
69 <td>LINUX_IX86_GNU</td>
70 <td> </td>
71 </tr>
72 <tr align="left">
73 <td>LINUX_PPC64_GNU</td>
74 <td> </td>
75 </tr>
76 <tr align="left">
77 <td>LINUX_PPC_GNU</td>
78 <td> </td>
79 </tr>
80 <tr align="left">
81 <td>LINUX_XSCALE_GNU</td>
82 <td> </td>
83 </tr>
84 <tr align="left">
85 denise.eckstein 1.1 <td>LINUX_ZSERIES64_GNU</td>
86 <td> </td>
87 </tr>
88 <tr align="left">
89 <td>LINUX_ZSERIES_GNU</td>
90 <td> </td>
91 </tr>
92 <tr align="left">
93 <td>VMS_ALPHA_DECCXX</td>
94 <td> </td>
95 </tr>
96 <tr align="left">
97 <td>VMS_IA64_DECCXX</td>
98 <td> </td>
99 </tr>
100 </table>
101 </ul>
102
103 <h2>Proposed Solution</h2>
104
105 <h3>Security Considerations</h3>
106 denise.eckstein 1.1 <ol>
107 <li>
108 To avoid introducing security vulnerabilities, vendors must never
109 ship providers incompatible with the security assumptions used in
110 their deployment.
111 For example, providers designed for a single-user deployment that
112 don't perform authorization must not be shipped with a CIM Server
113 that expects the providers to perform authorization. Note that
114 this authorization burden is considerably lighter if the provider
115 is registered as 'run as requestor' and if the CIM Server enables
116 that feature. See <a href=
117 "http://www.openpegasus.org/pp/uploads/40/7197/SecurityGuidePEP.htm">
118 PEP#223 - Security Coding Guidelines</a> for additional
119 details.
120 </li>
121 <li>
122 Vendors should ensure they configure the CIM Server consistently
123 with the security requirements of their deployment.
124 </li>
125 </ol>
126
127 denise.eckstein 1.1 <h3>Terminology Notes</h3>
128 <ol>
129 <li>
130 In this document, the term "Not Set" is used to indicate
131 that the a value for the environment variable has not been defined.
132 "Set" is used to indicate that the value must be defined,
133 but the actual value of the variable is not checked.
134 </li>
135 </ol>
136
137 <h3>General Notes</h3>
138
139 <ol>
140 <li>
141 Not all functionality described in this document has achieved
142 "Green"status, please refer to the
143 <a href="http://www.openpegasus.org/page.tpl?CALLER=index.tpl&ggid=799">
144 OpenPegasus Project Feature Status </a>page for information on
145 the maturity level of OpenPegasus features.
146 </li>
147 <li>
148 denise.eckstein 1.1 To encourage testing of new functionality, recommendations for the
149 Development Build may include features that are not yet recommended
150 for Release Builds.
151 </li>
152 </ol>
153
154 <h3>Environment Variable Settings for <u>Building</u> OpenPegasus</h3>
155
156 <h4>Definitions</h4>
157
158 <h5>ICU_INSTALL</h5>
159 <ul>
160 <b>Description: </b>When set, points to the directory containing
161 the <a href="%20http:/oss.software.ibm.com/icu"> ICU(International
162 Components for Unicode)</a> installation. The 'include'
163 subdirectory is used to locate ICU header files at build time. The
164 'lib' subdirectory is used to locate ICU libraries at link
165 time.<br>
166 <b>Default Value: </b>Not Set<br>
167 <b>Recommended Value (Development Build): </b>Not Set<br>
168 <b>Recommended Value (Release Build): </b>Not Set<br>
169 denise.eckstein 1.1 <b>Required: </b>No. However, if PEGASUS_HAS_ICU is
170 set and ICU_INSTALL is not defined, the ICU libraries and header
171 files are expected to be installed in directories (e.g.,/usr/lib,
172 /usr/include) that are searched by default.<br>
173 <b>Considerations: </b>This environment variable is only used
174 if PEGASUS_HAS_MESSAGES is set. Refer to PEGASUS_HAS_MESSAGES for
175 additional details.
176 </ul>
177
178 <h5>ICU_NO_UPPERCASE_ROOT</h5>
179 <ul>
180 <b>Description: </b>If set, the messages in the root resource
181 bundle will NOT be capitalized. By default, the root resource
182 bundle is capitalized.<br>
183 <b>Default Value: </b>Not Set<br>
184 <b>Recommended Value (Development Build): </b>Not Set<br>
185 <b>Recommended Value (Release Build): </b>Not Set<br>
186 <b>Required: </b>No<br>
187 <b>Considerations: </b>This environment variable is only used
188 if PEGASUS_HAS_MESSAGES is set. Refer to PEGASUS_HAS_MESSAGES for
189 additional details.
190 denise.eckstein 1.1 </ul>
191
192 <h5>ICU_ROOT_BUNDLE_LANG</h5>
193 <ul>
194 <b>Description: </b>If set, specifies the language
195 to be used to generate the root resource bundle. The
196 default value for ICU_ROOT_BUNDLE_LANG is _en.<br>
197 <b>Default Value: </b>_en<br>
198 <b>Recommended Value (Development Build): </b>No
199 Recommendation<br>
200 <b>Recommended Value (Release Build): </b>No Recommendation<br>
201 <b>Required: </b>No<br>
202 <b>Considerations: </b>This environment variable is
203 only used if PEGASUS_HAS_MESSAGES is set. Refer to
204 PEGASUS_HAS_MESSAGES for additional details.<br>
205 If set, resource bundles for the designated language must
206 exist for the following files:
207 <ul>
208 <li>pegasus/src/Pegasus/msg/Server/pegasusServer_en.txt</li>
209 <li>pegasus/src/Pegasus/msg/Listener/pegasusListener_en.txt</li>
210 </ul>
211 denise.eckstein 1.1 </ul>
212
213
214 <h5>OPENSSL_BIN</h5>
215 <ul>
216 <b>Description: </b>Specifies the location of the
217 OpenSSL <i>binary</i> directory. <br>
218 <b>Default Value: </b>Not Set<br>
219 <b>Recommended Value (Development Build): </b>
220 No Specific Recommendation<br>
221 <b>Recommended Value (Release Build): </b>
222 No Specific Recommendation<br>
223 <b>Required: </b>No. By default, the openssl binary is
224 expected to be installed in a directory that is searched by default
225 (e.g., /usr/bin). For platforms where this isn't true, the
226 OPENSSL_BIN environment variable may be used to define an
227 alternative path. This environment variable is only used if
228 PEGASUS_HAS_SSL is set.
229 </ul>
230
231 <h5>OPENSSL_HOME</h5>
232 denise.eckstein 1.1 <ul>
233 <b>Description: </b>Specifies the location of the OpenSSL
234 SDK directory. This directory must contain the OpenSSL
235 <i>include</i> directory, $(OPENSSL_HOME)/include, and the OpenSSL
236 <i>library</i> directory, $(OPENSSL_HOME)/lib.<br>
237 <b>Default Value: </b>Not Set<br>
238 <b>Recommended Value (Development Build): </b>
239 No Specific Recommendation<br>
240 <b>Recommended Value (Release Build): </b>
241 No Specific Recommendation<br>
242 <b>Required: </b>Yes for Windows, if PEGASUS_HAS_SSL
243 is set. No for all other platforms. For AIX, the default
244 value for OPENSSL_HOME is /usr/linux. For all other
245 platforms, the OpenSSL include files and libraries are expected
246 to be installed in directories that are searched by default (e.g.,
247 /usr/bin, /usr/lib(64), and /usr/include).
248 For platforms where the default value is not correct, the
249 OPENSSL_HOME environment variable may be used to define an
250 alternative path (i.e., $(OPENSSL_HOME)/lib and
251 $(OPENSSL_HOME)/include). This environment variable
252 is only used if PEGASUS_HAS_SSL is set.
253 denise.eckstein 1.1 </ul>
254
255 <h5>PEGASUS_ALLOW_ABSOLUTEPATH_IN_PROVIDERMODULE</h5>
256 <ul>
257 <b>Description: </b>If set to true, a version of OpenPegasus
258 will be built that allows an absolute path to be specified as the
259 value of the Location property of PG_ProviderModule class.
260 Otherwise it does not allow the absolute path to be specified.<br>
261 <b>Default Value: </b>Not Set<br>
262 <b>Recommended Value (Development Build): </b>Not Set<br>
263 <b>Recommended Value (Release Build): </b>Not Set<br>
264 <b>Required: </b>No<p>
265 <b>Considerations: </b>To avoid introducing security
266 vulnerabilities, vendors should analyze their deployment
267 environments to understand the security implications of allowing
268 providers to be loaded from a dynamically changing set of
269 directories.<br>
270 </ul>
271
272 <h5>PEGASUS_CCOVER</h5>
273 <ul>
274 denise.eckstein 1.1 <b>Description: </b>This flag is currently only supported on
275 HP-UX. It is enabled on the Nightly Build & Test system,
276 HP-UX_11iv3_Integrity_C-Cover. This system is
277 used to generate the nightly BullseyeCoverage code coverage
278 metrics.<br>
279 <b>Default Value: </b>Not Set<br>
280 <b>Recommended Value (Development Build): </b>Not Set<br>
281 <b>Recommended Value (Release Build): </b>Not Set<br>
282 <b>Required: </b>No<br>
283 <b>Considerations: </b>This flag is only supported on HP-UX to enable
284 CCOVER for the NB&T system.<br>
285 </ul>
286
287 <h5>PEGASUS_CIM_SCHEMA</h5>
288 <ul>
289 <b>Description: </b>This variable is used internally by the
290 OpenPegasus development team when upgrading the OpenPegasus build
291 environment to a new version of the CIM Schema.<br>
292 <b>Default Value: </b>CIM217<br>
293 <b>Recommended Value (Development Build): </b>
294 No Specific Recommendation<br>
295 denise.eckstein 1.1 <b>Recommended Value (Release Build): </b>
296 No Specific Recommendation<br>
297 <b>Required: </b>No <br>
298 <b>Considerations:</b> Additional code changes may be required when
299 upgrading or downgrading the CIM Schema version.</p>
300 </ul>
301
302 <h5>PEGASUS_CLASS_CACHE_SIZE</h5>
303 <ul>
304 <b>Description: </b>This environment variable gives the size of
305 the class cache used by CIM repository. This variable defines the
306 size of the class cache (i.e., the maximum number of classes that
307 may be included). If this variable is set to 0, class caching is
308 disabled.<br>
309 <b>Default Value: </b>8<br>
310 <b>Recommended Value (Development Build): </b>8<br>
311 <b>Recommended Value (Release Build): </b>8<br>
312 <b>Required: </b>No </p>
313 </ul>
314
315 <h5>PEGASUS_DEBUG</h5>
316 denise.eckstein 1.1 <ul>
317 <b>Description: </b>Builds a debug version of OpenPegasus.
318 Concurrently, this flag controls a) enabling compiler specific
319 debug flags and b) the inclusion of debug-specific
320 functionality.<br>
321 <b>Default Value: </b>Not Set<br>
322 <b>Recommended Value (Development Build): </b>Set<br>
323 <b>Recommended Value (Release Build): </b>Not Set<br>
324 <b>Required: </b>No
325 </ul>
326
327 <h5>PEGASUS_DEFAULT_USERCTXT_REQUESTOR</h5>
328 <ul>
329 <b>Description: </b> If set to true, the <i>Requestor</i> user
330 context is used for providers that do not specify a UserContext
331 value in their registration. Otherwise, the <i>Privileged</i> user
332 context value is used by default. <br>
333 <b>Default Value: </b>false<br>
334 <b>Recommended Value (Development Build): </b>false<br>
335 <b>Recommended Value (Release Build): </b>false<br>
336 <b>Required: </b>No
337 denise.eckstein 1.1 <b>Considerations:</b> Use of the <i>Requestor</i> default has
338 improved provider security characteristics. However, some providers
339 may not operate correctly when run in the <i>Requestor</i> user
340 context and setting this value to true may cause those providers to
341 fail. Providers that can run in the <i>Requestor</i>
342 user context are encouraged to explicitly set the UserContext value
343 in their registration rather than rely on the default setting
344 default by this variable. Please refer to
345 SecurityGuidelinesForDevelopers.html. PEP 223 for a discussion
346 of the rationale/advantages of running providers in the
347 <i>Requestor </i> user context. <b>Note:</b> This build
348 variable is not meaningful if the Provider User Context feature is
349 disabled with the PEGASUS_DISABLE_PROV_USERCTXT
350 setting.
351 </ul>
352
353
354 <h5>PEGASUS_DEFAULT_ENABLE_OOP</h5>
355 <ul>
356 <b>Description: </b>When this variable is set to false, by
357 default, Providers are run in the cimserver process
358 denise.eckstein 1.1 (forceProviderProcesses=false). If this value is set true,
359 Providers are run out-of-process by default.<br>
360 <b>Default Value: </b>true for HP-UX and Linux, false for
361 other platforms<br>
362 <b>Recommended Value (Development Build): </b>true (HP-UX,
363 Linux)<br>
364 <b>Recommended Value (Release Build): </b>true (HP-UX,
365 Linux)<br>
366 <b>Required: </b>No<br>
367 <b>Considerations: </b>This environment variable can be used to
368 change the "hard-coded" default setting for the
369 forceProviderProcesses configuration value.
370 Refer to the definition of <b>forceProviderProcesses</b> for
371 additional information.
372 </ul>
373
374 <h5>PEGASUS_DEST_LIB_DIR</h5>
375 <ul>
376 <b>Description: </b>Specifies the location of OpenPegasus
377 shared libraries.<br>
378 <b>Default Value: </b>$(PEGASUS_HOME)/lib<br>
379 denise.eckstein 1.1 <b>Recommended Value (Development Build): </b>
380 $(PEGASUS_HOME)/lib<br>
381 <b>Recommended Value (Release Build): </b>
382 No Specific Recommendation <br>
383 <b>Required: </b>No<br>
384 <b>Considerations: </b>This variable is NOT is used to define
385 the location of the Provider library directories.
386 Please refer to the providerDir configuration option for details
387 on defining the directories for the Provider libraries.
388 </ul>
389
390
391 <h5>PEGASUS_DISABLE_DEPRECATED_INTERFACES</h5>
392 <ul>
393 <b>Description: </b>Removes deprecated symbol definitions
394 from OpenPegasus runtime libraries.<br>
395 <b>Default Value:</b> Not Set<br>
396 <b>Recommended Value (Development Build):</b> Not Set<br>
397 <b>Recommended Value (Release Build): </b>Not Set<br>
398 <b>Required: </b>No<br>
399 <b>Considerations: </b>If this option is set, the resulting
400 denise.eckstein 1.1 OpenPegasus libraries will not be binary compatible with
401 clients and providers built using interface definitions from
402 prior releases. This option may be used to slightly reduce binary
403 footprint in an environment where compatibility is not required.<br>
404 </ul>
405
406 <h5>PEGASUS_DISABLE_INSTANCE_QUALIFIERS</h5>
407 <ul>
408 <b>Description: </b>In the CIM Infrastructure Specification,
409 version 2.3, the DMTF clarified that instance-level qualifiers are
410 not allowed. In Version 1.2 of the Specification CIM
411 Operations over HTTP, use of the IncludeQualifiers parameter has
412 been DEPRECATED.<br>
413 <b>Default Value:</b> Not Set<br>
414 <b>Recommended Value (Development Build):</b> Not Set<br>
415 <b>Recommended Value (Release Build): </b>Not Set<br>
416 <b>Required: </b>No<br>
417 <b>Considerations: </b>Existing CIM Clients may depend on
418 qualifiers being returned in the response. In this case, the
419 PEGASUS_DISABLE_INSTANCE_QUALIFIERS should not be set.
420 If this flag is set, the value of the IncludeQualifiers parameter
421 denise.eckstein 1.1 passed on the GetInstance and EnumerateInstance operations is
422 ignored and qualifiers are not returned.
423 Disabling the return of qualifiers as part of a CIM Instance will
424 improve performance.<br>
425 </ul>
426
427 <h5>PEGASUS_DISABLE_LOCAL_DOMAIN_SOCKET</h5>
428 <ul>
429 <b>Description: </b>Disables support for local (same-system)
430 connections over a Unix domain socket. If this option is NOT set,
431 the CIM Server is built to allow connections to be established
432 using a domain socket rather than a TCP port.<br>
433 <b>Default Value: </b>Not Set <br>
434 <b>Recommended Value (Development Build): </b>Not Set<br>
435 <b>Recommended Value (Release Build): </b>Not Set<br>
436 <b>Required: </b>No<br>
437 <b>Considerations: </b>(1) In high-threat environments, a
438 customer may want to disable all ports or reduce the number of
439 exposed network ports. Supporting a local connection mechanism
440 using Unix domain socket allows the CIM Server to continue to
441 receive and process requests from local CIM Clients. (2)
442 denise.eckstein 1.1 Enabling this option may result in lose of functionality when
443 sslClientVerificationMode = required. (3)The
444 "LOCAL_DOMAIN_SOCKET" functionality has not been
445 implemented for Windows or OpenVMS. Therefore, by
446 default, this option is "Set" for Windows and OpenVMS
447 platforms.
448 </ul>
449
450 <h5>PEGASUS_DISABLE_PERFINST</h5>
451 <ul>
452 <b>Description: </b>Builds a version of OpenPegasus that
453 disables support for gathering performance data.<br>
454 <b>Default Value: </b>Not Set<br>
455 <b>Recommended Value (Development Build): </b>Not Set<br>
456 <b>Recommended Value (Release Build): </b>Set<br>
457 <b>Required: </b>No<br>
458 <b>Considerations: </b>The CIM_ObjectManager.GatherStatisticalData
459 property is used to control statistic gathering. Once enabled,
460 statistical data can be viewed by retrieving instances of the
461 CIM_StatisticalData class. Support for gathering performance
462 data requires PEGASUS_ENABLE_INTEROP_PROVIDER to be enabled. If
463 denise.eckstein 1.1 PEGASUS_ENABLE_INTEROP_PROVIDER is explicitly disabled (i.e., set
464 to false), then PEGASUS_DISABLE_PERFINST must be set to
465 true. If PEGASUS_DISABLE_PERFINST is not defined or set to
466 false and PEGASUS_ENABLE_INTEROP_PROVIDER is not set,
467 PEGASUS_ENABLE_INTEROP_PROVIDER will be automatically enabled.
468 </ul>
469
470 <h5>PEGASUS_DISABLE_PRIVILEGED_TESTS</h5>
471 <ul>
472 <b>Description: </b>This variable is used only in the development
473 environment to restrict the level of testing performed by default.
474 If set, tests that require the CIM Server to run in a privileged
475 mode will not be run. Setting this variable allows
476 developers, without privileged access, to successfully run a
477 subset of the OpenPegasus test suit. This variable does
478 not affect CIM Server functionality. It merely controls
479 the level of testing.<br>
480 <b>Default Value: </b>Not Set<br>
481 <b>Recommended Value (Development Build): </b>Not Set<br>
482 <b>Recommended Value (Release Build): </b>Not Used<br>
483 <b>Required: </b>No<br>
484 denise.eckstein 1.1 <b>Considerations: </b>Enabling this variable will significantly
485 reduce the testing of security related features (e.g.,
486 authentication and authorization) and can affect testing in other
487 areas.
488 </ul>
489
490 <h5>PEGASUS_DISABLE_PROV_USERCTXT</h5>
491 <ul>
492 <b>Description: </b>Builds a version of OpenPegasus that
493 disables supports for the Provider User Context feature.
494 This feature allows a Provider to choose the user context in
495 which it is invoked, including the ability to run in the context of
496 the user requesting an operation.<br>
497 <b>Default Value: </b>Set for Windows and OpenVMS, Not Set
498 for all other platforms<br>
499 <b>Recommended Value (Development Build): </b>Set for Windows and
500 OpenVMS, Not Set for all other platforms<br>
501 <b>Recommended Value (Release Build): </b>Set for Windows and
502 OpenVMS, Not Set for all other platforms<br>
503 <b>Required: </b>No<br>
504 <b>Considerations: </b>The Provider User Context feature may be
505 denise.eckstein 1.1 disabled by compiling with the PEGASUS_DISABLE_PROV_USERCTXT flag
506 defined. In this case, the Provider Registration Manager rejects
507 provider registration requests that specify a UserContext property
508 value. The user context in which providers run is then unchanged by
509 this enhancement. Some platforms, such as OS/400 and z/OS may
510 define the PEGASUS_DISABLE_PROV_USERCTXT as part of the platform
511 configuration, since these platforms already set the provider user
512 context on a per-thread basis. When the Provider User Context
513 feature is enabled, support for each of the User Context types may
514 be disabled individually. Provider registration fails when an
515 unsupported UserContext value is specified. Please refer to
516 SecurityGuidelinesForDevelopers.html / PEP 223 for a discussion of
517 the rationale/advantages of user context providers to many
518 platforms.<br>
519 </ul>
520
521 <h5>PEGASUS_EMANATE_INCLUDE_DIR</h5>
522 <ul>
523 <b>Description: </b>Specifies the location of the EMANATE
524 <i>include</i> directory. <br>
525 <b>Default Value: </b>Not Set<br>
526 denise.eckstein 1.1 <b>Recommended Value (Development Build): </b>
527 No Specific Recommendation<br>
528 <b>Recommended Value (Release Build): </b>
529 No Specific Recommendation<br>
530 <b>Required: </b>No. By default, the EMANATE include files
531 are expected to be installed in directories that are searched by
532 default (e.g., /usr/include). For platforms where this isn't true,
533 the PEGASUS_EMANATE_INCLUDE_DIR environment variable may be used to
534 define an alternative path. This environment variable is only used
535 if PEGASUS_USE_EMANATE is set.<br>
536 <b>Considerations: </b>Refer to the description of PEGASUS_USE_EMANATE
537 for additional details.<br>
538 </ul>
539
540 <h5>PEGASUS_EMANATE_LIB_DIR</h5>
541 <ul>
542 <b>Description: </b>Specifies the location of the EMANATE
543 <i>lib</i> directory. <br>
544 <b>Default Value: </b>Not Set<br>
545 <b>Recommended Value (Development Build): </b>
546 No Specific Recommendation<br>
547 denise.eckstein 1.1 <b>Recommended Value (Release Build): </b>
548 No Specific Recommendation<br>
549 <b>Required: </b>No. By default, the EMANATE libraries are
550 expected to be installed in directories that are searched by
551 default (e.g., /usr/lib, /usr/lib64). For platforms where this
552 isn't true, the PEGASUS_EMANATE_LIB_DIR environment variable may
553 be used to define an alternative path. This environment variable
554 is only used if PEGASUS_USE_EMANATE is set.<br>
555 <b>Considerations: </b>Refer to the description of PEGASUS_USE_EMANATE
556 for additional details.<br>
557 </ul>
558
559 <h5>PEGASUS_EMBEDDED_INSTANCE_SUPPORT</h5>
560 <ul>
561 <b>Description: </b>Controls whether the server is built with
562 support for the EmbeddedInstance value type for properties and
563 paramters.<br>
564 <b>Default Value: </b>true<br>
565 <b>Recommended Value (Development Build): </b>true<br>
566 <b>Recommended Value (Release Build): </b>true<br>
567 <b>Required: </b>No<br>
568 denise.eckstein 1.1 <b>Considerations: </b>Setting this build variable to 'false' may
569 adversely affect interoperability with WBEM clients/servers that
570 make use of EmbeddedInstance values.<br>
571 </ul>
572
573 <h5>PEGASUS_ENABLE_AUDIT_LOGGER</h5>
574 <ul>
575 <b>Description: </b>When this variable is set to false, support
576 for audit logging will NOT be built into OpenPegasus. If this
577 variable is set to true, or not set, support for audit logging
578 will be included in the build. All other values are invalid.<br>
579 <b>Default Value: </b>true<br>
580 <b>Recommended Value (Development Build): </b>true<br>
581 <b>Recommended Value (Release Build): </b>true<br>
582 <b>Required: </b>No<br>
583 </ul>
584
585
586 <h5>PEGASUS_ENABLE_CMPI_PROVIDER_MANAGER</h5>
587 <ul>
588 <b>Description: </b>If set to true, a version of OpenPegasus
589 denise.eckstein 1.1 that supports CMPI providers and their dependent components is
590 built. If this variable is not set or set to false, support
591 for CMPI providers will not be included. <br>
592 <b>Default Value: </b>true for Linux and OpenVMS, false for
593 other platforms<br>
594 <b>Recommended Value (Development Build): </b>true (Linux
595 Platform Only)<br>
596 <b>Recommended Value (Release Build): </b>true (Linux Platform
597 Only)<br>
598 <b>Required: </b>No</p>
599 </ul>
600
601 <h5>PEGASUS_ENABLE_COMPRESSED_REPOSITORY</h5>
602 <ul>
603 <b>Description: </b>If set the Repository Compression logic is
604 built and enabled and compressed and non compressed repositories
605 are supported. If not set then compressed repositories are not
606 supported.<br>
607 <b>Default Value: </b>Not Set<br>
608 <b>Recommended Value (Development Build): </b>Not Set<br>
609 <b>Recommended Value (Release Build): </b>Not Set<br>
610 denise.eckstein 1.1 <b>Required: </b>No<p>
611 <b>Considerations: </b>See
612 pegasus/readme.compressed_repository</p>
613 </ul>
614
615
616 <h5>PEGASUS_ENABLE_CQL</h5>
617 <ul>
618 <b>Description: </b>When this variable is set to false, support
619 for Indication Subscription filters that have CQL as the language
620 is disabled. It does not remove CQL from the build.<br>
621 <b>Default Value:</b> Not Set<br>
622 <b>Recommended Value (Development Build):</b> Not Set<br>
623 <b>Recommended Value (Release Build):</b> false<br>
624 <b>Required: </b>No<br>
625 <b>Considerations: </b>The DMTF CIM Query Language
626 Specification is Preliminary and subject to backward incompatible
627 changes.
628 </ul>
629
630 <h5>PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT</h5>
631 denise.eckstein 1.1 <ul>
632 <b>Description: </b>When this variable is set to true, support the
633 DMTF Indications Profile (DSP1054) is included in OpenPegasus.
634 If this variable is not set or set to false, support for the DMTF
635 Indications Profile will not be included.<br>
636 <b>Default Value:</b> Not Set<br>
637 <b>Recommended Value (Development Build):</b> Not Set<br>
638 <b>Recommended Value (Release Build):</b> Not Set<br>
639 <b>Required: </b>No<br>
640 <b>Considerations: </b>The implementation of this feature is
641 based on a preliminary version of the DMTF Indications Profile,
642 DSP1053, and subject to change. If this variable is enabled,
643 two DMTF experimental class definitions, CIM_IndicationService and
644 CIM_IndicationServiceCapabilities, will be added to the
645 root/PG_InterOp namespace. Experimental class definitions are
646 subject to change.
647 PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT requires
648 PEGASUS_ENABLE_INTEROP_PROVIDER to be enabled.
649 If PEGASUS_ENABLE_INTEROP_PROVIDER is not set, setting
650 PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT to true, will also
651 enable PEGASUS_ENABLE_INTEROP_PROVIDER. If
652 denise.eckstein 1.1 PEGASUS_ENABLE_INTEROP_PROVIDER is explicitly disabled (i.e., set
653 to false), a build error will be generated.
654 </ul>
655
656 <h5>PEGASUS_ENABLE_EXECQUERY</h5>
657 <ul>
658 <b>Description: </b>When this environment variable is set,
659 processing of ExecQuery operations is enabled. When not set,
660 ExecQuery operation requests get a NotSupported response. (Note:
661 The PEGASUS_ENABLE_EXECQUERY environment variable controls
662 the definition of the PEGASUS_DISABLE_EXECQUERY compile macro.) <br>
663 <b>Default Value: </b>Not Set<br>
664 <b>Recommended Value (Development Build): </b>Not Set<br>
665 <b>Recommended Value (Release Build): </b>Not Set<br>
666 <b>Required: </b>No
667 </ul>
668
669 <h5>PEGASUS_ENABLE_EMAIL_HANDLER</h5>
670 <ul>
671 <b>Description: </b> When this environment variable is set, an
672 E-Mail Indication Handler is built as part of the OpenPegasus
673 denise.eckstein 1.1 build. The E-Mail Indication Handler can be used to
674 delivered CIM Indications to a designated e-mail address.<br>
675 <b>Default Value: </b>Not Set<br>
676 <b>Recommended Value (Development Build): </b>Not Set<br>
677 <b>Recommended Value (Release Build): </b>Not Set<br>
678 <b>Required: </b>No<br>
679 <b>Considerations: </b>If PEGASUS_ENABLE_EMAIL_HANDLER is
680 not set when OpenPegasus is built, a request to create an Email
681 Indication Handler instance will be rejected will the error
682 CIM_ERR_NOT_SUPPORTED.
683 </ul>
684
685 <h5>PEGASUS_ENABLE_GCOV</h5>
686 <ul>
687 <b>Description: </b>GCOV,
688 <a href="http://gcc.gnu.org/onlinedocs/gcc/index.html#toc_Gcov">
689 http://gcc.gnu.org/onlinedocs/gcc/index.html#toc_Gcov</a>, is a
690 code coverage utility. If PEGASUS_ENABLE_GCOV is set,
691 GCC will instrument the code to support analysis by GCOV.<br>
692 <b>Default Value: </b>Not Set<br>
693 <b>Recommended Value (Development Build): </b>
694 denise.eckstein 1.1 Not Set<br>
695 <b>Recommended Value (Release Build): </b>Not Set<br>
696 <b>Required: </b>No<br><b>Considerations: </b>
697 This flag is currently only supported with GCC on Linux.
698 <ul>
699 Note: LCOV, <a href=
700 "http://ltp.sourceforge.net/coverage/lcov.php">
701 http://ltp.sourceforge.net/coverage/lcov.php</a>, is a
702 graphical front-end extension for GCOV. It collects GCOV data
703 for multiple source files and creates HTML pages with coverage
704 information. You can use the following steps to use LCOV to
705 analyze OpenPegasus GCOV data.
706 <ol>
707 <li>Set PEGASUS_ENABLE_GCOV = true.</li>
708 <li>Build and test OpenPegasus (e.g.,
709 <i>make -f pegasus/TestMakefile build
710 alltests</i>).</li>
711 <li>For each source directory,
712 <ul>
713 <li>copy the .gcda and .gcno files from the object
714 directory to the source directory (e.g.,
715 denise.eckstein 1.1 <i>cp build/obj/Pegasus/Common/*.gcda
716 src/Pegasus/Common/</i>);</li>
717 <li>execute the <b>lcov</b> command
718 (e.g.,
719 <i>lcov --directory src/Pegasus/Common/ --capture
720 --output-file result.info</i>) to build the result.info
721 file; and finally,</li>
722 <li>use the <b>genhtml</b> command to generate the .html
723 output (e.g., <i>genhtml result.info</i>). The
724 top .html file is named index.html.</li>
725 </ul>
726 </ol>
727 </ul>
728 </ul>
729
730 <h5>PEGASUS_ENABLE_INDICATION_COUNT</h5>
731 <ul>
732 <b>Description: </b>If true, the CIM
733 Server will be built to count the number of CIM indications
734 generated by providers and matched with subscriptions. If false
735 or not set, indication statistic support will not be included.
736 denise.eckstein 1.1 <b>Default Value: </b>true<br>
737 <b>Recommended Value (Development Build): </b>true <br>
738 <b>Recommended Value (Release Build): </b>true <br>
739 <b>Required: </b>No <br>
740 <b>Considerations: </b>The number of CIM indications generated by
741 providers and matched with subscriptions is stored in hash tables
742 which causes memory usage to increase by 4 bytes for each
743 active subscription and by about 400 bytes for each active
744 indication provider.<br>
745 </ul>
746
747 <h5>PEGASUS_ENABLE_INTEROP_PROVIDER</h5>
748 <ul>
749 <b>Description: </b>If true, the OpenPegasus Interop Provider
750 will be build. If false or not set, the OpenPegasus Interop
751 Provider will not be built.<br>
752 <b>Default Value: </b>Not Set<br>
753 <b>Recommended Value (Development Build): </b>Not Set<br>
754 <b>Recommended Value (Release Build): </b>false<br>
755 <b>Required: </b>No <br>
756 <b>Considerations: </b> A number of features controlled by
757 denise.eckstein 1.1 OpenPegasus build options are dependent on the Interop
758 Provider. Please refer to PEGASUS_ENABLE_SLP,
759 PEGASUS_DISABLE_PERFINST, and
760 PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT for additional
761 details.<br>
762 </ul>
763
764 <h5>PEGASUS_ENABLE_IPV6</h5>
765 <ul>
766 <b>Description: </b>This variable can be used to specify
767 whether IPv6 support should be included in OpenPegasus.<br>
768 <b>Default Value: </b>true<br>
769 <b>Recommended Value (Development Build): </b>true<br>
770 <b>Recommended Value (Release Build): </b>true<br>
771 <b>Required: </b>No<br>
772 <b>Considerations: </b>When this variable is set to
773 'false', support for IPv6 socket APIs and structures is disabled,
774 and the CIM Server will not accept connections to or from IPv6
775 network interfaces. When this variable is set to 'true', the
776 newer IPv6 socket APIs and structures will be included when
777 OpenPegasus is built, so they must be supported on the build
778 denise.eckstein 1.1 platform. However, if IPv6 is not supported on the platform on
779 which an IPv6-enabled version of OpenPegasus is run, then the IPv6
780 feature will be disabled at run-time and only IPv4 connections
781 will be supported.
782 </ul>
783
784 <h5>PEGASUS_ENABLE_JMPI_PROVIDER_MANAGER</h5>
785 <ul>
786 <b>Description: </b>If true, a version of OpenPegasus that
787 supports JMPI providers and their dependent components is built.
788 If false or not set, support for JMPI Providers is not included
789 in OpenPegasus. All other values are invalid.<br>
790 <b>Default Value: </b>false<br>
791 <b>Recommended Value (Development Build): </b>false<br>
792 <b>Recommended Value (Release Build): </b>false<br>
793 <b>Required: </b>No</p>
794 </ul>
795
796 <h5>PEGASUS_ENABLE_OBJECT_NORMALIZATION</h5>
797 <ul>
798 <b>Description: </b>If set, builds in support so that objects
799 denise.eckstein 1.1 returned from provider instance operations can be validated.
800 The enableNormalization must also be set to 'true' (default)<br>
801 <b>Default Value: </b>Not Set<br>
802 <b>Recommended Value (Development Build): </b>Not Set<br>
803 <b>Recommended Value (Release Build): </b>Not Set<br>
804 <b>Required: </b>No <br>
805 <b>Considerations: </b>If PEGASUS_ENABLE_OBJECT_NORMALIZATION is
806 set, two new configuration options are defined: enableNormalization
807 and excludeModulesFromNormalization.
808 </ul>
809
810 <h5>PEGASUS_ENABLE_PRIVILEGE_SEPARATION</h5>
811 <ul>
812 <b>Description: </b>If true, a version of OpenPegasus that
813 enables the Privilege Separation feature is built. This feature
814 allows the CIM Server to run in a non-privileged user context and
815 use a small executor process to perform privileged operations. If
816 false or not set, the Privilege Separate feature will not be
817 included.<br>
818 <b>Default Value: </b>false<br>
819 <b>Recommended Value (Development Build): </b>true (HP-UX,
820 denise.eckstein 1.1 Linux)<br>
821 <b>Recommended Value (Release Build): </b>true (HP-UX,
822 Linux)<br>
823 <b>Required: </b>No<br>
824 <b>Considerations: </b> The Privilege Separation feature is
825 only supported on HP-UX and Linux platforms. The 'cimsrvr' user
826 must be defined on the system. If the umask setting in the
827 environment is not 0, PEGASUS_TMP must be set to a directory that
828 is writable by the 'cimsrvr' user for the tests to run
829 successfully.
830 </ul>
831
832 <h5>PEGASUS_ENABLE_PROTOCOL_WSMAN</h5>
833 <ul>
834 <b>Description: </b>If true, a version of OpenPegasus is
835 built that accepts and processes WS-Management requests. This
836 feature is initially limited to WS-Transfer operations. If false
837 or not set, WS-Management support is not built or included in
838 any way.<br>
839 <b>Default Value: </b>false<br>
840 <b>Recommended Value (Development Build): </b>true<br>
841 denise.eckstein 1.1 <b>Recommended Value (Release Build): </b>false<br>
842 <b>Required: </b>No<br>
843 <b>Considerations: </b> The WS-Management standards are not
844 mature, and interoperability problems may arise. The WS-Management
845 functionality may change in incompatible ways in subsequent
846 releases. Also note the known limitations specified in PEP 311.<br>
847 </ul>
848
849 <h5>PEGASUS_ENABLE_REMOTE_CMPI</h5>
850 <ul>
851 <b>Description: </b>If set, a version of OpenPegasus that
852 support Remote CMPI providers and their dependent components
853 is built.<br>
854 <b>Default Value: </b>Not Set<br>
855 <b>Recommended Value (Development Build): </b>Not Set<br>
856 <b>Recommended Value (Release Build): </b>Not Set<br>
857 <b>Required: </b>No</p>
858 </ul>
859
860 <h5>PEGASUS_ENABLE_SLP</h5>
861 <ul>
862 denise.eckstein 1.1 <b>Description: </b>This variable controls of the inclusion
863 of SLP functionality in the OpenPegasus build. When this
864 environment variable is set to 'true', SLP functionality will be
865 included as part of the OpenPegasus build. If
866 this variable is set to 'false' or not set, the SLP functionality
867 will not be included. All other values are considered
868 invalid and will result in a build error
869 (e.g., "PEGASUS_ENABLE_SLP ($(PEGASUS_ENABLE_SLP)) invalid,
870 must be true or false").<br>
871 <b>Default Value: </b>'true' for Windows; 'false' for all other
872 Platforms<br>
873 <b>Recommended Value (Development Build): </b>'true' for
874 Windows; 'false' for all other Platforms<br>
875 <b>Recommended Value (Release Build): </b><br>
876 <b>Required: </b>No<br>
877 <b>Considerations: </b>PEGASUS_ENABLE_SLP requires
878 PEGASUS_ENABLE_INTEROP_PROVIDER to be enabled. If
879 PEGASUS_ENABLE_INTEROP_PROVIDER is not set, setting
880 PEGASUS_ENABLE_SLP to true, will also enable
881 PEGASUS_ENABLE_INTEROP_PROVIDER. If
882 PEGASUS_ENABLE_INTEROP_PROVIDER is explicitly disabled
883 denise.eckstein 1.1 (i.e., set to false), a build error will be generated.<br>
884 </ul>
885
886
887 <h5>PEGASUS_ENABLE_SORTED_DIFF</h5>
888 <ul>
889 <b>Description: </b>This controls if the DIFFSORT function
890 is used rather than a simple DIFF of the test results files
891 to the static results file. Set to 'true' enables the sorted
892 diffs of results to static results files. Otherwise results
893 in regular diffs of results to static results files.
894 See OpenPegasus bug 2283 for background information concerning
895 this config variable. <br>
896 <b>Default Value: </b>true<br>
897 <b>Recommended Value (Development Build): </b>true<br>
898 <b>Recommended Value (Release Build): </b>true<br>
899 <b>Required: </b>No<p> </p>
900 </ul>
901
902 <h5>PEGASUS_ENABLE_SYSTEM_LOG_HANDER</h5>
903 <ul>
904 denise.eckstein 1.1 <b>Description: </b>When this environment variable is set, a
905 SysLog Indication Handler is built as part of the OpenPegasus
906 build. The SysLog Indication Handler can be used to
907 delivered CIM Indications to the system log file.<br>
908 <b>Default Value: </b>Not Set<br>
909 <b>Recommended Value (Development Build): </b>Not Set<br>
910 <b>Recommended Value (Release Build): </b>Not Set<br>
911 <b>Required: </b>No<br>
912 <b>Considerations: </b>If PEGASUS_ENABLE_SYSTEM_LOG_HANDLER
913 is not set when OpenPegasus is built, a request to create a SysLog
914 Indication Handler instance will be rejected with the error
915 CIM_ERR_NOT_SUPPORTED.<br>
916 </ul>
917
918 <h5>PEGASUS_ENABLE_SSLV2</h5>
919 <ul>
920 <b>Description: </b>By default, support for the SSLV2 protocol
921 is disabled in OpenPegasus. The option can be used to build a
922 version of OpenPegasus that supports SSLV2. This variable affects
923 how SSL contexts are constructed for both the CIM Server and CIM
924 Clients.<br>
925 denise.eckstein 1.1 <b>Default Value: </b>Not Set<br>
926 <b>Recommended Value (Development Build): </b>Not Set<br>
927 <b>Recommended Value (Release Build): </b>Not Set<br>
928 <b>Required: </b>No<br>
929 <b>Considerations:</b> Unless SSLV2 is required for backward
930 compatibility, enabling this protocol is not recommended (SSLV3
931 or later is preferred).
932 </ul>
933
934 <h5>PEGASUS_ENABLE_USERGROUP_AUTHORIZATION</h5>
935 <ul>
936 <b>Description: </b>Builds a version of OpenPegasus that
937 allows an administrator to restrict access to CIM operations
938 to members of a designated set of groups. Refer to the
939 <b>authorizedUserGroups</b>configuration option for additional
940 details.<br>
941 <b>Default Value: </b>Not Set<br>
942 <b>Recommended Value (Development Build): </b>Not Set<br>
943 <b>Recommended Value (Release Build): </b>Set<br>
944 <b>Required: </b>No<br>
945 </ul>
946 denise.eckstein 1.1
947 <h5>PEGASUS_EXTRA_C_FLAGS</h5>
948 <ul>
949 <b>Description: </b>This environment variable allows a
950 developer to specify an additional set of flags to be included
951 on the C compile command line.<br>
952 <b>Default Value: </b>Not Set<br>
953 <b>Recommended Value (Development Build): </b>No Set<br>
954 <b>Recommended Value (Release Build): </b>Not Set<br>
955 <b>Required: </b>No
956 </ul>
957
958 <h5>PEGASUS_EXTRA_CXX_FLAGS</h5>
959 <ul>
960 <b>Description: </b>This environment variable allows a
961 developer to specify an additional set of flags to be included
962 on the C++ compile command line.<br>
963 <b>Default Value: </b>Not Set<br>
964 <b>Recommended Value (Development Build): </b>Not Set<br>
965 <b>Recommended Value (Release Build): </b>Not Set<br>
966 <b>Required: </b>No
967 denise.eckstein 1.1 </ul>
968
969 <h5>PEGASUS_EXTRA_LIBRARY_LINK_FLAGS</h5>
970 <ul>
971 <b>Description: </b>This environment variable allows a
972 developer to specify an additional set of flags to include on
973 the link command line used to build a library.<br>
974 <b>Default Value: </b>Not Set<br>
975 <b>Recommended Value (Development Build): </b>Not Set<br>
976 <b>Recommended Value (Release Build): </b>Not Set<br>
977 <b>Required: </b>No
978 </ul>
979
980 <h5>PEGASUS_EXTRA_LINK_FLAGS</h5>
981 <ul>
982 <b>Description: </b>This environment variable allows a
983 developer to specify an additional set of flags to be included
984 on the link command line. These flags will be included on
985 both library and program executable link command lines.<br>
986 <b>Default Value: </b>Not Set<br>
987 <b>Recommended Value (Development Build): </b>Not Set<br>
988 denise.eckstein 1.1 <b>Recommended Value (Release Build): </b>Not Set<br>
989 <b>Required: </b>No
990 <b>Considerations: </b>Refer to PEGASUS_EXTRA_LIBRARY_LINK_FLAGS and
991 PEGASUS_EXTRA_PROGRAM_FLAGS to add flags specific to either a
992 library or program link command line.<br>
993 </ul>
994
995 <h5>PEGASUS_EXTRA_PROGRAM_LINK_FLAGS</h5>
996 <ul>
997 <b>Description: </b>This environment variable allows a
998 developer to specify an additional set of flags to include on
999 the link command line used to build an executable program.<br>
1000 <b>Recommended Value (Development Build): </b>Not Set<br>
1001 <b>Recommended Value (Release Build): </b>Not Set<br>
1002 <b>Required: </b>No
1003 </ul>
1004
1005 <h5>PEGASUS_HAS_MESSAGES</h5>
1006 <ul>
1007 <b>Description: </b>When set (to anything) during the build,
1008 OpenPegasus compiles with localization support. The
1009 denise.eckstein 1.1 ICU (International Components for Unicode) variables,
1010 ICU_ROOT and ICU_INSTALL, indicate that the
1011 localization support is based on ICU. Only ICU is supported
1012 at this time.<br>
1013 <b>Default Value: </b>Not Set<br>
1014 <b>Recommended Value (Development Build): </b>Not Set<br>
1015 <b>Recommended Value (Release Build): </b>Not Set<br>
1016 <b>Required: </b>No<br>
1017 <b>Considerations: </b>If the PEGASUS_HAS_MESSAGES is not
1018 set, OpenPegasus is built without localization support. This
1019 means that all messages sent by the CIM Server and the CLIs are in
1020 English. ICU is an open source project at
1021 <a href="http://oss.software.ibm.com/icu">
1022 http://oss.software.ibm.com/icu</a>.
1023 Only English translations are included with the OpenPegasus
1024 distribution. The OpenPegasus distribution does not provide
1025 translated messages. But, enabling for ICU would allow vendor to
1026 provide the translations. Refer to the OpenPegasus Release README
1027 for additional information regarding the use of ICU. Although, in
1028 OpenPegasus 2.3.2, experience with localization support
1029 has been limited to a select set of platforms, wider platform
1030 denise.eckstein 1.1 adoption of this technology is planned for 2.5.<br>
1031 </ul>
1032
1033 <h5>PEGASUS_HAS_SSL</h5>
1034 <ul>
1035 <b>Description: </b>If set, a version of OpenPegasus that
1036 supports SSL (i.e., https) is built.<br>
1037 <b>Default Value: </b>Not Set<br>
1038 <b>Recommended Value (Development Build): </b>Set<br>
1039 <b>Recommended Value (Release Build): </b>Set<br>
1040 <b>Required: </b>No<br>
1041 <b>Considerations: </b>Support for SSL in OpenPegasus is
1042 dependent on the OpenSSL software developed by the
1043 <a href="http://www.openssl.org/">
1044 OpenSSL Project (http://www.openssl.org/)</a>.
1045
1046 If the PEGASUS_HAS_SSL variable is set, the variable OPENSSL_HOME
1047 must also be defined. The OPENSSL_HOME variable is used, by the
1048 OpenPegasus build, to determine the location of the OpenSSL
1049 include files, libraries and binaries.
1050 </ul>
1051 denise.eckstein 1.1
1052 <h5>PEGASUS_HOME</h5>
1053 <ul>
1054 <b>Description: </b>Specifies the location of the
1055 OpenPegasus working directory. The OpenPegasus
1056 build will use this directory as the default location
1057 for files generated during the build (e.g., binaries,
1058 libraries, objects).<br>
1059 <b>Default Value: </b>None<br>
1060 <b>Recommended Value (Development Build): </b>
1061 No Specific Recommendation<br>
1062 <b>Recommended Value (Release Build): </b>
1063 No Specific Recommendation<br>
1064 <b>Required: </b>Yes<br>
1065 <b>Considerations: </b>The error "PEGASUS_HOME
1066 environment variable undefined" is returned if the
1067 PEGASUS_HOME environment variable is not set.
1068 This variable is also used during runtime. Refer to the section
1069 titled "Environment Variable Settings for Running OpenPegasus
1070 2.3.2 on Linux" for additional details.<br>
1071 </ul>
1072 denise.eckstein 1.1
1073 <h5>PEGASUS_INDICATIONS_Q_THRESHOLD</h5>
1074 <ul>
1075 <b>Description: </b>Controls if indications providers are stalled
1076 if the indications service queue is too large. It can be set
1077 to any positive value. If not set providers are never
1078 stalled. This implies that the indications service
1079 queue may become as large as necessary to hold all the
1080 indications generated. If set to any value then
1081 providers are stalled by forcing them to sleep when they
1082 try to deliver an indication and the indications service
1083 queue exceeds this value. They are resumed when the queue
1084 count falls 10 percent below this value. Stall and resume log
1085 entries are made to inform the administrator the condition has
1086 occurred.<br>
1087 <b>Default Value: </b>Not Set<br>
1088 <b>Recommended Value (Development Build): </b>Not Set<br>
1089 <b>Recommended Value (Release Build): </b>Not Set<br>
1090 <b>Required: </b>No<br>
1091 <b>Considerations: </b>Use of this setting may have
1092 unintended side-effects when using Out-of-Process Providers
1093 denise.eckstein 1.1 including delayed processing of CIM Operation Requests.
1094 </ul>
1095
1096 <h5>PEGASUS_MAX_THREADS_PER_SVC_QUEUE</h5>
1097 <ul>
1098 <b>Description: </b>Controls the maximum number of threads
1099 allowed per message service queue. It is allowed to range
1100 between 1 and MAX_THREADS_PER_SVC_QUEUE_LIMIT (currently 5000)
1101 as set in pegasus/src/Pegasus/Common/MessageQueueService.cpp.
1102 If set to 0 (zero) the max threads per service queue is then
1103 set to MAX_THREADS_PER_SVC_QUEUE_LIMIT. If set larger than the
1104 MAX_THREADS_PER_SVC_QUEUE_LIMIT it is set equal to
1105 MAX_THREADS_PER_SVC_QUEUE_LIMIT. There are no other limits on the
1106 total number of threads that can exist within the system at this
1107 time. When the server starts there on the order of 10 to 20
1108 message service queues created dependent upon
1109 build options. <br>
1110 <b>Default Value: </b>5<br>
1111 <b>Recommended Value (Development Build): </b>5<br>
1112 <b>Recommended Value (Release Build): </b>5<br>
1113 <b>Required: </b>No<br>
1114 denise.eckstein 1.1 <b>Considerations: </b>This flag affects consumption of
1115 system resources. Not setting, or inappropriately setting
1116 this value, may cause the cimserver to hang or crash.<br>
1117 </ul>
1118
1119 <h5>PEGASUS_ROOT</h5>
1120 <ul>
1121 <b>Description: </b>Specifies the location of the directory
1122 that corresponds to "pegasus" source directory defined in the
1123 OpenPegasus CVS source tree. This environment variable is
1124 used by the OpenPegasus build to locate the required build
1125 and source files (e.g., $(PEGASUS_ROOT)/mak and
1126 $(PEGASUS_ROOT)/src).<br>
1127 <b>Default Value: </b>None<br>
1128 <b>Recommended Value (Development Build): </b>
1129 No Specific Recommendation<br>
1130 <b>Recommended Value (Release Build): </b>
1131 No Specific Recommendation<br>
1132 <b>Required: </b>Yes<br>
1133 <b>Considerations: </b>The error "PEGASUS_ROOT environment
1134 variable undefined" is returned if the PEGASUS_ROOT
1135 denise.eckstein 1.1 environment variable is not set.
1136 </ul>
1137
1138
1139 <h5>PEGASUS_NET_SNMP_INCLUDE_DIR</h5>
1140 <ul>
1141 <b>Description: </b>Specifies the location of the NET-SNMP
1142 <i>include</i> directory. <br>
1143 <b>Default Value: </b>Not Set<br>
1144 <b>Recommended Value (Development Build): </b>
1145 No Specific Recommendation<br>
1146 <b>Recommended Value (Release Build): </b>
1147 No Specific Recommendation<br>
1148 <b>Required: </b>No. By default, the NET-SNMP include
1149 files are expected to be installed in directories that
1150 are searched by default (e.g., /usr/include). For platforms
1151 where this isn't true, the PEGASUS_NET_SNMP_INCLUDE_DIR
1152 environment variable may be used to define an alternative path.
1153 This environment variable is only used if PEGASUS_USE_NET_SNMP
1154 is set.<br>
1155 </ul>
1156 denise.eckstein 1.1
1157 <h5>PEGASUS_NET_SNMP_LIB_DIR</h5>
1158 <ul>
1159 <b>Description: </b>Specifies the location of the NET-SNMP
1160 <i>lib </i>directory. <br>
1161 <b>Default Value: </b>Not Set<br>
1162 <b>Recommended Value (Development Build): </b>
1163 No Specific Recommendation<br>
1164 <b>Recommended Value (Release Build): </b>
1165 No Specific Recommendation<br>
1166 <b>Required: </b>No. By default, the NET-SNMP library is
1167 expected to be installed in a directory that is searched by
1168 default (e.g., /usr/lib, /usr/lib64). For platforms where
1169 this isn't true, the PEGASUS_NET_SNMP_LIB_DIR environment
1170 variable may be used to define an alternative path. This
1171 environment variable is only used if PEGASUS_USE_NET_SNMP is set.
1172 </ul>
1173
1174
1175 <h5>PEGASUS_NOASSERTS</h5>
1176 <ul>
1177 denise.eckstein 1.1 <b>Description: </b>Defines the NDEBUG compilation macro, which
1178 causes the preprocessor to remove PEGASUS_ASSERT() statements.<br>
1179 <b>Default Value: </b>Not Set<br>
1180 <b>Recommended Value (Development Build): </b>Not Set<br>
1181 <b>Recommended Value (Release Build): </b>Set<br>
1182 <b>Required: </b>No<br>
1183 </ul>
1184
1185 <h5>PEGASUS_OPENSLP_HOME</h5>
1186 <ul>
1187 <b>Description: </b>Specifies the location of the OpenSLP
1188 SDK directory. This directory must contain the OpenSLP
1189 <i>include</i> directory, $(PEGASUS_OPENSLP_HOME)/include,
1190 and the OpenSLP <i>library</i> directory,
1191 $(PEGASUS_OPENSLP_HOME)/lib.<br>
1192 <b>Default Value: </b>Not Set<br>
1193 <b>Recommended Value (Development Build): </b>
1194 No Specific Recommendation<br>
1195 <b>Recommended Value (Release Build): </b>
1196 No Specific Recommendation<br>
1197 <b>Required: </b>No. If not set, no additional include or
1198 denise.eckstein 1.1 library search paths will be included.
1199 <b>Considerations: </b>This value is not used if PEGASUS_USE_OPENSLP
1200 is not defined. <br>
1201 </ul>
1202
1203 <h5>PEGASUS_PAM_AUTHENTICATION</h5>
1204 <ul>
1205 <b>Description: </b>Enables support for PAM-(Pluggable
1206 Authentication Modules) based authentication.<br>
1207 <b>Default Value: </b>Not Set<br>
1208 <b>Recommended Value (Development Build): </b>Set<br>
1209 <b>Recommended Value (Release Build): </b>Set<br>
1210 <b>Required: </b>No<br>
1211 <b>Considerations: </b>Support for PAM in OpenPegasus is
1212 dependent on platform support for PAM.<br>
1213 </ul>
1214
1215 <h5>PEGASUS_PLATFORM</h5>
1216 <ul>
1217 <b>Description: </b>Describes the target platform for the
1218 build. The list of supported values for this variable
1219 denise.eckstein 1.1 is defined in pegasus/mak/config.mak. Please refer to
1220 that file for a complete list of valid PEGASUS_PLATFORM
1221 values. This document includes platform-specific configuration
1222 data for only a subset of the supported platforms. The
1223 following table describes the platforms documented in
1224 this version of the document. <br>
1225 <b>Default Value: </b>None<p> </p>
1226 <table border="1" cellspacing="1" bordercolordark="#666666"
1227 bordercolorlight="#CCCCCC" width=542
1228 style='font-size=10.0pt;font-family:Arial'>
1229 <tr>
1230 <th bgcolor="#CAE6CA" width="190">Platform</th>
1231 <th bgcolor="#CAE6CA" width=351>Recommended Value <br>
1232 Development Build</th>
1233 <th bgcolor="#CAE6CA" width=338>Recommended Value <br>
1234 Release Build</th>
1235 </tr>
1236 <tr align="center">
1237 <td width="190" align="left">Linux IA32</td>
1238 <td width="351">LINUX_IX86_GNU</td>
1239 <td width="338">LINUX_IX86_GNU</td>
1240 denise.eckstein 1.1 </tr>
1241 <tr align="center">
1242 <td width="190" align="left">Linux IA64</td>
1243 <td width="351">LINUX_IA64_GNU</td>
1244 <td width="338">LINUX_IA64_GNU</td>
1245 </tr>
1246 <tr align="center">
1247 <td width="190" align="left">Linux X86_64</td>
1248 <td width="351">LINUX_X86_64_GNU</td>
1249 <td width="338">LINUX_X86_64_GNU</td>
1250 </tr>
1251 <tr align="center">
1252 <td width="190" align="left">HP-UX PA-RISC</td>
1253 <td width="351">HPUX_PARISC_ACC</td>
1254 <td width="338">HPUX_PARISC_ACC</td>
1255 </tr>
1256 <tr align="center">
1257 <td width="190" align="left">HP-UX IPF</td>
1258 <td width="351">HPUX_IA64_ACC</td>
1259 <td width="338">HPUX_IA64_ACC</td>
1260 </tr>
1261 denise.eckstein 1.1 <tr align="center">
1262 <td width="190" align="left">OpenVMS Alpha</td>
1263 <td width="351">VMS_ALPHA_DECCXX</td>
1264 <td width="338">VMS_ALPHA_DECCXX</td>
1265 </tr>
1266 <tr align="center">
1267 <td width="190" align="left">OpenVMS IA64</td>
1268 <td width="351">VMS_IA64_DECCXX</td>
1269 <td width="338"> VMS_IA64_DECCXX</td>
1270 </tr>
1271 </table>
1272 <br><br>
1273 <b>Required: </b>Yes<br>
1274 <b>Considerations: </b>The error "PEGASUS_PLATFORM
1275 environment variable undefined." is returned if the
1276 PEGASUS_PLATFORM environment variable is not set.
1277 </ul>
1278
1279 <h5>PEGASUS_REMOVE_METHODTRACE</h5>
1280 <ul>
1281 <b>Description: </b>If true, the CIM Server is compiled without
1282 denise.eckstein 1.1 method enter and exit trace statements. Trace Level 5 will
1283 continue to be accepted as a valid trace level but, without the
1284 method enter and exit trace statements, it will be equivalent to
1285 Trace Level 4. If PEGASUS_REMOVE_METHODTRACE is false or not set,
1286 method enter and exit trace statements are included. All
1287 other values are considered invalid and will result in a build
1288 error.<br>
1289 <b>Default Value: </b>Not Set<br>
1290 <b>Recommended Value (Development Build): </b>Not Set (The
1291 Considerations section gives guidance on when a different
1292 decision would be made.)<br>
1293 <b>Recommended Value (Release Build): </b>Not Set (The
1294 Considerations section gives guidance on when a different
1295 decision would be made.)<br>
1296 <b>Required: </b>No<br>
1297 <b>Considerations: </b>This option completely removes the
1298 method enter/exit trace statements from the generated object code.
1299 It defines the PEG_METHOD_ENTER and PEG_METHOD_EXIT macros
1300 to null statements. This helps to keep static code size small
1301 but reduces the serviceability of the CIM server.<br>
1302 </ul>
1303 denise.eckstein 1.1
1304
1305 <h5>PEGASUS_REPOSITORY_MODE</h5>
1306 <ul>
1307 <b>Description: </b>This variable defines the default mode
1308 used to create repositories that are constructed as part of the
1309 automated build tests. It does not affect the runtime
1310 environment. Valid values include: XML (causes
1311 the repository to be built in XML mode); BIN (causes
1312 the repository to be built in binary mode). Use cimconfig to
1313 modify the runtime environment.<br>
1314 <b>Default Value: </b>XML<br>
1315 <b>Recommended Value (Development Build): </b>XML<br>
1316 <b>Recommended Value (Release Build): </b>XML<br>
1317 <b>Required: </b>No<p> </p>
1318 </ul>
1319
1320 <h5>PEGASUS_SLP_REG_TIMEOUT</h5>
1321 <ul>
1322 <b>Description: </b>Most SLP implementations allow a lifetime
1323 value to be specified in the registration sent to the SLP SA or
1324 denise.eckstein 1.1 DA. The PEGASUS_SLP_REG_TIMEOUT build variable allows a lifetime
1325 (ie. timeout) value to be specified on the SLP registration, with
1326 a 're-registration' being sent to SLP at the same specified
1327 timeout interval. The purpose of this lifetime or timeout value
1328 is to avoid the accumulation of stale service information
1329 in the SA or DA.<br>
1330 <b>Default Value: </b>Undefined<br>
1331 <b>Recommended Value (Development Build): </b>Undefined<br>
1332 <b>Recommended Value (Release Build): </b>Undefined<br>
1333 <b>Required: </b>No<p><b>Example: </b>
1334 PEGASUS_SLP_REG_TIME=1440 (ie. 24 hours or 1 day)<br>
1335 <b>Considerations: </b>(1) The OpenPegasus internal SLP
1336 implementation does not support timeout registrations. This
1337 build option is useful, for example, if PEGASUS_USE_OPENSLP is
1338 defined. (2) Some SLP implementations may impose a
1339 maximum value for the lifetime parameter. For example, OpenSLP
1340 limits this value to SLP_LIFETIME_MAXIMUM (or 0xFFFF), and
1341 if this maximum value is passed to OpenSLP, then the timeout
1342 feature is disabled. Refer to the documentation of your SLP
1343 implementation for more information. (3) OpenPegasus will not
1344 do any validity checking on the specified value, either
1345 denise.eckstein 1.1 to determine if it is a valid positive integer or if it
1346 exceeds some maximum value.<br>
1347 </ul>
1348
1349 <h5>PEGASUS_SNIA_EXTENSIONS</h5>
1350 <ul>
1351 <b>Description: </b> This variable is used to enable a
1352 set of workarounds that support the use of OpenPegasus
1353 in the SNIA Test Environment.<br>
1354 <b>Default Value: </b>Not Set<br>
1355 <b>Recommended Value (Development Build): </b>Not Set<br>
1356 <b>Recommended Value (Release Build): </b>Not Set<br>
1357 <b>Required: </b>No<br>
1358 <b>Considerations: </b>The functionality enabled with this
1359 variable is experimental and subject to change.
1360 </ul>
1361
1362 <h5>PEGASUS_SKIP_MOST_TEST_DIRS</h5>
1363 <ul>
1364 <b>Description: </b>If set to true, this variable can be used
1365 to reduce the time required to build OpenPegasus by significantly
1366 denise.eckstein 1.1 reducing the number of tests that are built.<br>
1367 <b>Default Value: </b>Not Set<br>
1368 <b>Recommended Value (Development Build): </b>Not Set<br>
1369 <b>Recommended Value (Release Build): </b>Not Set<br>
1370 <b>Required: </b>No<br>
1371 <b>Considerations: </b>Setting this variable to true
1372 affects the behavior of all recursive make targets (e.g.,
1373 clean, depend, all, unittests, alltests, and slptests).
1374 Use of this variable with test-related targets (e.g., unittests,
1375 alltests and slptests) can produce unexpected results.
1376 To avoid creating an inconsistent PEGASUS_HOME directory,
1377 the PEGASUS_HOME directory (i.e., the OpenPegasus build
1378 directory) should be removed prior to enabling or disabling
1379 this variable. This variable should not be used to characterize
1380 the set of files to be packaged in a release build. Please
1381 refer to the Runtime Packaging Definition PEP for the release
1382 for a recommended list of files to be included in a release.
1383 </ul>
1384
1385 <h5>PEGASUS_TEST_ENABLE_DEBUG_TRACE</h5>
1386 <ul>
1387 denise.eckstein 1.1 <b>Description: </b>
1388 This variable is only used for testing. If set to true,
1389 Discarded data trace will be enabled by the install_run
1390 target of the src/Server/Makefile before running the
1391 OpenPegasus TestMakefile test suite. <br>
1392 <b>Default Value: </b>Not Set<br>
1393 <b>Recommended Value (Development Build): </b>Set<br>
1394 <b>Recommended Value (Release Build): </b>Not Set<br>
1395 <b>Required: </b>No<br>
1396 <b>Considerations: </b>
1397 This variable is useful in certain test environments to
1398 explicitly enable tracing to aid in better troubleshooting and
1399 detection of test failures (E.g. Test systems are experiencing
1400 test failures due to connection timeouts, lost indications
1401 etc).<br>
1402 </ul>
1403
1404 <h5>PEGASUS_TEST_ISGROUP_GROUP/PEGASUS_TEST_ISGROUP_USER_SUCCESS/PEGASUS_TEST_ISGROUP_USER_FAILURE</h5>
1405 <ul>
1406 <b>Description: </b>These variables are only used for testing.
1407 These variables allow the developer to define a valid group name,
1408 denise.eckstein 1.1 PEGASUS_TEST_ISGROUP_GROUP, a valid user name that is in the
1409 group, PEGASUS_TEST_ISGROUP_USER_SUCCESS, and an a valid user
1410 name that is not in the group, PEGASUS_TEST_ISGROUP_USER_FAILURE.
1411 These variables are only used for testing and NOT part of the
1412 release.<br>
1413 <b>Default Value(Windows):</b>
1414 Administrator/Administrators/Guest<br>
1415 <b>Default Value(Non-Windows): </b>root/root/guest<br>
1416 <b>Recommended Value (Development Build): </b>
1417 No Recommendation<br>
1418 <b>Recommended Value (Release Build): </b>Not Used<br>
1419 <b>Required: </b>No
1420 </ul>
1421
1422 <h5>PEGASUS_TEST_IPV6</h5>
1423 <ul>
1424 <b>Description: </b>This variable is only used for
1425 testing. If set to true, the IPv6-specific tests will
1426 be run as part of the "alltests" OpenPegasus
1427 TestMakefile test suite. If this variable is not set or set to
1428 false, the IPv6-specific tests will not be run. All
1429 denise.eckstein 1.1 other values are invalid.<br>
1430 <b>Default Value: </b>If PEGASUS_TEST_IPV6 is not defined,
1431 PEGASUS_TEST_IPV6 is set to the value of PEGASUS_ENABLE_IPV6.<br>
1432 <b>Recommended Value (Development Build): </b>Set to the value
1433 of PEGASUS_ENABLE_IPV6<br>
1434 <b>Recommended Value (Release Build): </b>Not Used<br>
1435 <b>Required: </b>No<br>
1436 <b>Considerations: </b>This variable is useful in certain
1437 test environments to explicitly disable running the IPv6
1438 tests (e.g., when running an IPv6-enabled version of
1439 OpenPegasus on an an IPv4 system).<br>
1440 </ul>
1441
1442 <h5>PEGASUS_TEST_SDK</h5>
1443 <ul>
1444 <b>Description: </b>This variable is only used for
1445 testing. It is used to control testing of the SDK
1446 sample providers and clients. If set, the setup, building and
1447 testing of the SDK samples is enabled as part of the
1448 OpenPegasus automated build and test.<br>
1449 <b>Default Value: </b>Not Set<br>
1450 denise.eckstein 1.1 <b>Recommended Value (Development Build): </b>Set<br>
1451 <b>Recommended Value (Release Build): </b>Not Used<br>
1452 <b>Required: </b>No
1453 </ul>
1454
1455 <h5>PEGASUS_TEST_USER_DEFINED</h5>
1456 <ul>
1457 <b>Description: </b>This variable is only used for testing.
1458 If this variable is set, the tests will assume that the
1459 PEGASUS_TEST_USER_ID and PEGASUS_TEST_USER_PASS variables
1460 defines a valid user/password pair and can be used for
1461 certificate-based authentication testing. These tests
1462 also assumes that "invalidUser" is not a valid
1463 user.<br>
1464 <b>Default Value: </b>Not Set<br>
1465 <b>Recommended Value (Development Build): </b>Set<br>
1466 <b>Recommended Value (Release Build): </b>Not Used<br>
1467 <b>Required: </b>No
1468 </ul>
1469
1470 <h5>PEGASUS_TEST_USER_ID/PEGASUS_TEST_USER_PASS</h5>
1471 denise.eckstein 1.1 <ul>
1472 <b>Description: </b>These variables are only used for
1473 testing. These variables allow the developer to define a
1474 valid, non-privileged user name and password
1475 on the test system that can be used as part of the OpenPegasus
1476 automated test scripts to perform authentication and
1477 authorization testing. These variables are only used for
1478 testing and NOT part of the release.<br>
1479 <b>Default Value: </b>guest/guest<br>
1480 <b>Recommended Value (Development Build): </b>
1481 No Recommendation<br>
1482 <b>Recommended Value (Release Build): </b>Not Used<br>
1483 <b>Required: </b>No<br>
1484 </ul>
1485
1486 <h5>PEGASUS_TEST_VALGRIND_LOG_DIR</h5>
1487 <ul>
1488 <b>Description: </b>
1489 This variable is currently only supported on Linux. It may be
1490 set to run regression tests under the
1491 <a href="http://www.valgrind.org/">Valgrind</a> memory
1492 denise.eckstein 1.1 checking tool. It must specify a directory for writing
1493 Valgrind log files. The file name format for a particular
1494 log is PEGASUS_TEST_VALGRIND_LOG_DIR/PROGRAM_NAME.pid.<br>
1495 <b>Default Value: </b>Not Set<br>
1496 <b>Recommended Value (Development Build): </b>Not Set<br>
1497 <b>Recommended Value (Release Build): </b>Not Set<br>
1498 <b>Required: </b>No<br>
1499 <b>Considerations: </b>This flag is only supported on Linux to
1500 enable running tests under Valgrind.<br>
1501 </ul>
1502
1503 <h5>PEGASUS_TMP</h5>
1504 <ul>
1505 <b>Description: </b>This variable is only used in a test
1506 environment. It can be used to define the directory that
1507 OpenPegasus test programs should use to store temporary files.<br>
1508 <b>Default Value: </b>"."<br>
1509 <b>Recommended Value (Development Build): </b>
1510 No Specific Recommendation<br>
1511 <b>Recommended Value (Release Build): </b>Not Used<br>
1512 <b>Required: </b>No<br>
1513 denise.eckstein 1.1 </ul>
1514
1515 <h5>PEGASUS_USE_DEBUG_BUILD_OPTIONS</h5>
1516 <ul>
1517 <b>Description: </b>The PEGASUS_DEBUG flag is used to control
1518 a variety of settings, including compile options, assertion
1519 enablement, method definitions for testing, and diagnostic
1520 output. The PEGASUS_USE_DEBUG_BUILD_OPTIONS variable
1521 can be used to enable just the compiler specific debug options
1522 (e.g., -g in g++) .<br>
1523 <b>Default Value: </b>Not Set<br>
1524 <b>Recommended Value (Development Build): </b>Set<br>
1525 <b>Recommended Value (Release Build): </b>Not Set<br>
1526 <b>Required: </b>No<br>
1527 <b>Considerations: </b>This variable is automatically set
1528 if PEGASUS_DEBUG is set.<br>
1529 </ul>
1530
1531 <h5>PEGASUS_USE_EMANATE</h5>
1532 <ul>
1533 <b>Description: </b>EMANATE,
1534 denise.eckstein 1.1 <a href="http://www.snmp.com/products/emanate.html">
1535 http://www.snmp.com/products/emanate.html</a>, is an SNMP Research
1536 International product that supports SNMPv1, SNMPv2c, and
1537 SNMPv3. If the PEGASUS_USE_EMANATE variable is defined,
1538 the OpenPegasus SNMP Handler will use the EMANATE libraries
1539 to send traps to the SNMP Management application.
1540 The EMANATE libraries are NOT included as part of OpenPegasus.<br>
1541 <b>Default Value: </b>Not Set<br>
1542 <b>Recommended Value (Development Build): </b>Not Set<br>
1543 <b>Recommended Value (Release Build): </b>Not Set<br>
1544 <b>Required: </b>No<p>
1545 <b>Considerations: </b>Either the PEGASUS_USE_NET_SNMP or
1546 PEGASUS_USE_EMANATE variable must be set for the SNMP
1547 Handler to be supported.<br>
1548 </ul>
1549
1550
1551 <h5>PEGASUS_USE_NET_SNMP</h5>
1552 <ul>
1553 <b>Description: </b>NET-SNMP,
1554 <a href="http://net-snmp.sourceforge.net">
1555 denise.eckstein 1.1 http://net-snmp.sourceforge.net</a>, is an OSS
1556 implementation of a suite of applications used to implement
1557 <a href="http://www.ietf.org/rfc/rfc1157.txt">SNMP v1</a>,
1558 <a href="http://www.ietf.org/rfc/rfc1901.txt">SNMP v2c</a> and
1559 <a href="http://www.ietf.org/rfc/rfc2571.txt">SNMP v3</a> using
1560 both IPv4 and IPv6. If the PEGASUS_USE_NET_SNMP
1561 variable is defined, the OpenPegasus SNMP Handler will use
1562 the NET-SNMP libraries to send traps to the SNMP Management
1563 application. The NET-SNMP libraries are NOT included
1564 as part of OpenPegasus.<br>
1565 <b>Default Value: </b>Not Set<br>
1566 <b>Recommended Value (Development Build): </b>Not Set<br>
1567 <b>Recommended Value (Release Build): </b>true for Linux,
1568 false for all other platforms<br>
1569 <b>Required: </b>No<p>
1570 <b>Considerations: </b>Either the PEGASUS_USE_NET_SNMP or
1571 PEGASUS_USE_EMANATE variable must be set for the SNMP
1572 Handler to be supported.<br>
1573 </ul>
1574
1575 <h5>PEGASUS_USE_OPENSLP</h5>
1576 denise.eckstein 1.1 <ul>
1577 <b>Description: </b>OpenSLP, <a href="http://www.openslp.org">
1578 http://openslp.org</a>, is an open-source implementation of
1579 Service Location Protocol. If the PEGASUS_USE_OPENSLP variable
1580 is defined, OpenPegasus will be built to use the OpenSLP
1581 implementation of SLP instead of the internal OpenPegasus
1582 implementation of SLP. The OpenSLP libaries are NOT included
1583 as part of OpenPegasus.
1584 <b>Default Value: </b>Not Set<br>
1585 <b>Recommended Value (Development Build): </b>Not Set<br>
1586 <b>Recommended Value (Release Build): </b>Not Set<br>
1587 <b>Required: </b>No<br>
1588 <b>Considerations: </b>PEGASUS_ENABLE_SLP must be defined
1589 if this variable is set.
1590 </ul>
1591
1592 <h5>PEGASUS_USE_PAM_STANDALONE_PROC</h5>
1593 <ul>
1594 <b>Description: </b>Moves the processing of PAM requests from
1595 the CIM Server process to a separate process managed by the
1596 CIM Server.<br>
1597 denise.eckstein 1.1 <b>Default Value: </b>Not Set<br>
1598 <b>Recommended Value (Development Build): </b>Set<br>
1599 <b>Recommended Value (Release Build): </b>Set<br>
1600 <b>Required: </b>No<br>
1601 <b>Considerations: </b>If PAM Authentication is enabled,
1602 the PAM API is used, during the processing of each request, to
1603 authenticate the client. This level of use makes the CIM Server
1604 extremely sensitive to memory leaks in the PAM library. In
1605 addition, certain PAM modules are not thread-safe. If your
1606 platform is experiencing problems with PAM Authentication,
1607 use of option may provide a work-around.
1608 PEGASUS_USE_PAM_STANDALONE_PROC requires
1609 PEGASUS_PAM_AUTHENTICATION to be set.<br>
1610 </ul>
1611
1612 <h5>PEGASUS_USE_RELEASE_CONFIG_OPTIONS</h5>
1613 <ul>
1614 <b>Description: </b>If set, OpenPegasus is built using
1615 the "Release Build" configuration options. By default,
1616 OpenPegasus is built using the "Development Build"
1617 configuration options.<br>
1618 denise.eckstein 1.1 <b>Default Value: </b>Not Set<br>
1619 <b>Recommended Value (Development Build): </b>Not Set<br>
1620 <b>Recommended Value (Release Build): </b>Set<br>
1621 <b>Required: </b>No<br>
1622 <b>Considerations: </b>(1)The
1623 PEGASUS_USE_RELEASE_CONFIG_OPTIONS variable allows a platform
1624 vendor to easily toggle between two sets of configurations
1625 options, a set of options tuned for the development/debug
1626 ("Development Build") environment and a set of options
1627 tuned for the production environment ("Release Build").
1628 Refer the section titled "Configuration Properties" for
1629 additional detail. (2) For each configuration
1630 variable, the "Recommended Value (Release Build)"
1631 value defines the recommended settings to use for a
1632 "Release Build". Please refer to the
1633 description of each variable for additional information.
1634 </ul>
1635
1636 <h5>PEGASUS_USE_RELEASE_DIRS</h5>
1637 <ul>
1638 <b>Description: </b>If set, OpenPegasus is built using
1639 denise.eckstein 1.1 the "Release Build" directory definitions. By default,
1640 OpenPegasus is built using the "Development Build"
1641 directory definitions.<br>
1642 <b>Default Value: </b>Not Set<br>
1643 <b>Recommended Value (Development Build): </b>Not Set<br>
1644 <b>Recommended Value (Release Build): </b>Set<br>
1645 <b>Required: </b>No<br>
1646 <b>Considerations: </b>
1647 The PEGASUS_USE_RELEASE_DIRS variable allows a platform
1648 vendor to easily toggle between two sets of directory
1649 definitions, a set tuned for the development/debug
1650 ("Development Build") environment and a set tuned for the
1651 production environment ("Release Build"). Refer the section
1652 titled "Configuration Properties" for additional detail.<br>
1653 </ul>
1654
1655 <h5>PEGASUS_USE_SYSLOGS</h5>
1656 <ul>
1657 <b>Description: </b>If set, OpenPegasus will be built
1658 to send log messages to the system logger (syslog).
1659 Otherwise, log messages will be sent to OpenPegasus
1660 denise.eckstein 1.1 specific log files.<br>
1661 <b>Recommended Value (Development Build): </b>Set<br>
1662 <b>Recommended Value (Release Build): </b>Set<br>
1663 <b>Required: </b>No<br>
1664 <b>Considerations: </b>This variable is currently
1665 not implemented as an environment variable. To use
1666 the option -DPEGASUS_USE_SYSLOGS must
1667 be explicitly included in the appropriate platform
1668 makefile (pegasus/mak/platform_*.mak).</ul>
1669
1670 <h5>PEGASUS_WINDOWS_SDK_HOME</h5>
1671 <ul>
1672 <b>Description: </b>This variable should be set to point
1673 to the Microsoft Platform SDK on Windows if using a compiler
1674 version < 1300 (i.e. VC6). If using VC7 or VC8, this flag
1675 does not need to be set, as the necessary libraries are already
1676 included.<br>
1677 <b>Recommended Value (Development Build): </b>
1678 No Specific Recommendation<br>
1679 <b>Recommended Value (Release Build): </b>
1680 No Specific Recommendation<br>
1681 denise.eckstein 1.1 <b>Required: </b>Yes, if building on Windows with a
1682 compiler version < 1300.<br>
1683 </ul>
1684
1685 <h4>Examples Building a Linux IA32 (#IA64) Development/Debug Version</h4>
1686 <ul>
1687 export PEGASUS_ROOT=/home/pegasusbld/pegasus<br>
1688 export PEGASUS_HOME=/home/pegasusbld/pegasus/build<br>
1689 export PEGASUS_PLATFORM=LINUX_IX86_GNU<br>
1690 #export PEGASUS_PLATFORM=LINUX_IA64_GNU<br>
1691 export PEGASUS_PAM_AUTHENTICATION=true<br>
1692 export PEGASUS_USE_PAM_STANDALONE_PROC=true<br>
1693 export PEGASUS_HAS_SSL=yes<br>
1694 export PEGASUS_DEBUG=TRUE<br>
1695 export ENABLE_CMPI_PROVIDER_MANAGER=true<br>
1696 export PEGASUS_USE_SYSLOGS=true<br>
1697 export PATH=/home/pegasusbld:/home/pegasusbld/pegasus/build/bin:/usr/local/bin:$PATH<br>
1698 </ul>
1699
1700 <h4>Building a Linux IA32 (#IA64) Production Release Version</h4>
1701 <ul>
1702 denise.eckstein 1.1 export PEGASUS_ROOT=/home/pegasusbld/pegasus<br>
1703 export PEGASUS_HOME=/home/pegasusbld/pegasus/build<br>
1704 export PEGASUS_PLATFORM=LINUX_IX86_GNU<br>
1705 #export PEGASUS_PLATFORM=LINUX_IA64_GNU<br>
1706 export PEGASUS_DISABLE_CQL=true <br>
1707 export PEGASUS_PAM_AUTHENTICATION=true <br>
1708 export PEGASUS_USE_PAM_STANDALONE_PROC=true<br>
1709 export PEGASUS_HAS_SSL=yes<br>
1710 export PEGASUS_USE_RELEASE_CONFIG_OPTIONS=true<br>
1711 export PEGASUS_USE_RELEASE_DIRS=true<br>
1712 export PEGASUS_NOASSERTS=true<br>
1713 export ENABLE_CMPI_PROVIDER_MANAGER=true<br>
1714 export PEGASUS_ENABLE_USERGROUP_AUTHORIZATION=true<br>
1715 export PEGASUS_USE_SYSLOGS=true<br>
1716 export PATH=/home/pegasusbld:/home/pegasusbld/pegasus/build/bin:/usr/local/bin:$PATH<br>
1717 </ul>
1718
1719 <h3>Environment Variable Settings for <u>Running</u> OpenPegasus</h3>
1720
1721 <h4>Definitions</h4>
1722
1723 denise.eckstein 1.1 <h5>PEGASUS_HOME</h5>
1724 <ul>
1725 <b>Description: </b>There are multiple options for
1726 configuring the location of OpenPegasus runtime
1727 files (e.g., configuration files, libraries,
1728 repository, executables). If no other option is
1729 specified, OpenPegasus will attempt to use the value
1730 PEGASUS_HOME.<br>
1731 <b>Default Value: </b>"."<br>
1732 <b>Recommended Value (Development Build): </b>
1733 The same value defined at build time.<br>
1734 <b>Recommended Value (Release Build): </b>Not Set<br>
1735 <b>Required: </b>No<br>
1736 <b>Considerations: </b>Although this variable can be
1737 useful in a development environment use of this environment
1738 variable is not recommended in a production environment.
1739 Instead, the use of configuration properties to explicitly
1740 set the location of runtime files and directories is recommended.
1741 </ul>
1742
1743 <h5>PEGASUS_MSG_HOME</h5>
1744 denise.eckstein 1.1 <ul>
1745 <b>Description: </b>This value is not used by the CIM
1746 Server. The CIM Server uses the messageDir configuration
1747 parameter to locate the directory where the ICU resource bundles.
1748 However, CIM Client applications must rely on an alternative
1749 mechanism to locate this directory.<br>
1750 <b>Default Value: </b>if $PEGASUS_HOME is set then
1751 "$PEGASUS_HOME/msg" else "."<br>
1752 <b>Recommended Value (Development Build): </b>$PEGASUS_HOME/msg<br>
1753 <b>Recommended Value (Release Build): </b>Not Set <br>
1754 <b>Required: </b>No<br>
1755 </ul>
1756
1757 <h3>Configuration Properties</h3>
1758
1759 <h4>Notation</h4>
1760
1761 <p>This section describes the notation used to define the
1762 configuration properties.</p>
1763
1764 <ul>
1765 denise.eckstein 1.1
1766 <h5>Default Value</h5>
1767 The value of <i>Default Value</i> is the OpenPegasus
1768 default setting for this configuration option. This
1769 value is used if a platform-specific setting is not
1770 defined.
1771
1772 <h5>Recommended Default Value</h5>
1773 The PEGASUS_USE_RELEASE_CONFIG_OPTIONS variable allows a
1774 platform vendor to easily toggle between two sets of
1775 configurations options, a set of options tuned for the
1776 development/debug ("Development Build") environment
1777 and a set of options tuned for the production environment
1778 ("Release Build"). The value of
1779 <i>Recommended Value (Development Build)</i>
1780 is the recommended default value for use in a development/
1781 debug environment. The value of
1782 <i>Recommended Value (Release Build)</i> is the recommended
1783 default value for use in a production environment.
1784
1785 <h5>Recommend To Be Fixed/Hidden</h5>
1786 denise.eckstein 1.1 Configuration options can be defined as fixed or hidden.
1787 A "fix" configuration option is set at build time
1788 and cannot be changed without rebuilding. "Fixed"
1789 configuration options are not displayed using the cimconfig
1790 command. This feature can be used by vendors to limit
1791 OpenPegasus functionality and configurability.
1792
1793 A "hidden" configuration option is an option that is
1794 configurable (i.e., "not fixed"), but not externally
1795 advertised using the cimconfig command. The "hidden"
1796 feature can be used to define "internal use only"
1797 configuration options.
1798
1799 <h5>Dynamic?</h5>
1800 If yes, the value of the configuration option can be
1801 changed without stopping and restarting the CIM Server.
1802
1803 <h5>Directory Specifications</h5>
1804 <p>Note that the variables included in the following table
1805 (e.g., $LOGDIR) are for documentation purposes only and
1806 have been defined to simplify the description of the
1807 denise.eckstein 1.1 configuration options. In particular,
1808 these variables DO NOT correspond to environment variables
1809 implemented in the OpenPegasus code. Default values
1810 for the following variables are platform
1811 and vendor dependent and not documented in this document.</p>
1812
1813 <table border="1" cellspacing="1" bordercolordark="#666666"
1814 bordercolorlight="#CCCCCC" width=148
1815 style='font-size=10.0pt;font-family:Arial' height="228">
1816 <tr>
1817 <th bgcolor="#CAE6CA" width=1 height="16"> </th>
1818 </tr>
1819 <tr align="center">
1820 <td align="left" width="1" height="12">$LOGDIR</td>
1821 </tr>
1822 <tr align="center">
1823 <td align="left" width="1" height="14">$PROVIDERDIRS</td>
1824 </tr>
1825 <tr align="center">
1826 <td align="left" width="1" height="14">
1827 $PROVIDERMANAGERDIRS</td>
1828 denise.eckstein 1.1 </tr>
1829 <tr align="center">
1830 <td align="left" width="1" height="14">$REPOSITORYDIR </td>
1831 </tr>
1832 <tr align="center">
1833 <td align="left" width="1" height="14">$CERTIFICATEDIR
1834 </td>
1835 </tr>
1836 <tr align="center">
1837 <td align="left" width="1" height="14">$LOCALAUTHDIR</td>
1838 </tr>
1839 <tr align="center">
1840 <td align="left" width="1" height="14">$TRACEDIR</td>
1841 </tr>
1842 <tr align="center">
1843 <td align="left" width="1" height="14">$CONFIGDIR</td>
1844 </tr>
1845 <tr align="center">
1846 <td align="left" width="1" height="14">$PIDFILE</td>
1847 </tr>
1848 <tr align="center">
1849 denise.eckstein 1.1 <td align="left" width="1" height="14">$RANDOMDIR</td>
1850 </tr>
1851 <tr align="center">
1852 <td align="left" width="1" height="14">$SOCKETDIR</td>
1853 </tr>
1854 <tr align="center">
1855 <td align="left" width="1" height="14">$MESSAGEDIR</td>
1856 </tr>
1857 </table>
1858 </ul>
1859
1860 <h4>Definitions</h4>
1861
1862 <h5>authorizedUserGroups</h5>
1863 <ul>
1864 <b>Description:</b> If the <b>authorizedUserGroups</b>
1865 property is set, the value is interpreted as a list of
1866 comma-separated user groups whose members may issue CIM
1867 requests. A user who is not a member of any of these groups is
1868 restricted from issuing CIM requests, with the exception of
1869 privileged users (root user). If the <b>authorizedUserGroups</b>
1870 denise.eckstein 1.1 property is not set, any user may issue CIM requests.<br>
1871 <b>Default Value: </b>blank<br>
1872 <b>Recommended Default Value (Development Build): </b>blank<br>
1873 <b>Recommended Default Value (Release Build): </b>blank<br>
1874 <b>Recommend To Be Fixed/Hidden (Development Build): </b>
1875 No/No<br>
1876 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
1877 <b>Dynamic?: </b>No<br>
1878 <b>Example: </b>
1879 #cimconfig -s authorizedUserGroups=users,systemusers -p<br>
1880 <b>Considerations: </b>This feature is available only when
1881 the OpenPegasus source is compiled with the flag
1882 PEGASUS_ENABLE_USERGROUP_AUTHORIZATION set.
1883 </ul>
1884
1885 <h5>daemon</h5>
1886 <ul>
1887 <b>Description: </b>This option enables/disables forking of
1888 the code to create a background daemon process.<br>
1889 <b>Default Value: </b>true<br>
1890 <b>Recommended Default Value (Development Build): </b>true<br>
1891 denise.eckstein 1.1 <b>Recommended Default Value (Release Build): </b>true<br>
1892 <b>Recommend To Be Fixed/Hidden (Development Build): </b>
1893 No/No<br>
1894 <b>Recommend To Be Fixed/Hidden (Release Build): </b>
1895 No/Yes<br>
1896 <b>Dynamic?: </b>No<p> <br>
1897 <br>
1898 <table border="1" cellspacing="1" bordercolordark="#666666"
1899 bordercolorlight="#CCCCCC" width=531
1900 style='font-size=10.0pt;font-family:Arial'>
1901 <tr>
1902 <th bgcolor="#CAE6CA" width="168">Platform</th>
1903 <th bgcolor="#CAE6CA" width=350>Source Configuration File</th>
1904 </tr>
1905 <tr align="center">
1906 <td width="168">Linux</td>
1907 <td align="left" width="350">
1908 Pegasus/Config/DefaultPropertyTableLinux.h</td>
1909 </tr>
1910 <tr align="center">
1911 <td width="168">HP-UX</td>
1912 denise.eckstein 1.1 <td align="left" width="350">
1913 Pegasus/Config/DefaultPropertyTableHpux.h</td>
1914 </tr>
1915 <tr align="center">
1916 <td width="168">OpenVMS</td>
1917 <td align="left" width="350">
1918 Pegasus/Config/DefaultPropertyTableVms.h</td>
1919 </tr>
1920 </table>
1921 </ul>
1922
1923 <h5>enableAssociationTraversal</h5>
1924 <ul>
1925 <b>Description: </b>If true, the CIM Server will support
1926 the four association traversal operators: Associators,
1927 AssociatorNames,References, and ReferenceNames.<br>
1928 <b>Default Value: </b>true<br>
1929 <b>Recommended Default Value (Development Build): </b>true<br>
1930 <b>Recommended Default Value (Release Build): </b>true<br>
1931 <b>Recommend To Be Fixed/Hidden (Development Build): </b>
1932 No/No<br>
1933 denise.eckstein 1.1 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
1934 <b>Dynamic?: </b>No<br>
1935 <b>Considerations: </b>There is still an outstanding
1936 Provider Registration issue that restricts the degree to
1937 which separate Providers can register for Associations.<br>
1938 <br>
1939 <table border="1" cellspacing="1" bordercolordark="#666666"
1940 bordercolorlight="#CCCCCC" width=531
1941 style='font-size=10.0pt;font-family:Arial'>
1942 <tr>
1943 <th bgcolor="#CAE6CA" width="168">Platform</th>
1944 <th bgcolor="#CAE6CA" width=350>Source Configuration File</th>
1945 </tr>
1946 <tr align="center">
1947 <td width="168">Linux</td>
1948 <td align="left" width="350">
1949 Pegasus/Config/DefaultPropertyTableLinux.h</td>
1950 </tr>
1951 <tr align="center">
1952 <td width="168">HP-UX</td>
1953 <td align="left" width="350">
1954 denise.eckstein 1.1 Pegasus/Config/DefaultPropertyTableHpux.h</td>
1955 </tr>
1956 <tr align="center">
1957 <td width="168">OpenVMS</td>
1958 <td align="left" width="350">
1959 Pegasus/Config/DefaultPropertyTableVms.h</td>
1960 </tr>
1961 </table>
1962 </ul>
1963
1964 <h5>enableAuditLog</h5>
1965 <ul>
1966 <b>Description: </b>Used to enable or disable audit
1967 logging at run time. If true, audit logging will be enabled.<br>
1968 <b>Recommended Default Value (Development Build): </b>false<br>
1969 <b>Recommended Default Value (Release Build): </b>false<br>
1970 <b>Recommend To Be Fixed/Hidden (Development Build): </b>
1971 No/No<br>
1972 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
1973 <b>Dynamic?: </b>Yes<br>
1974 <b>Source Configuration File: </b>
1975 denise.eckstein 1.1 Pegasus/Config/DefaultPropertyTable.h<br>
1976 </ul>
1977
1978 <h5>enableAuthentication</h5>
1979 <ul>
1980 <b>Description: </b>If true, a Client must be authenticated
1981 to access the CIM Server.<br>
1982 <b>Recommended Default Value (Development Build): </b>false<br>
1983 <b>Recommended Default Value (Release Build): </b>true<br>
1984 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
1985 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br>
1986 <b>Dynamic?: </b>No<br>
1987 <b>Source Configuration File: </b>
1988 Pegasus/Config/SecurityPropertyOwner.cpp<br>
1989 </ul>
1990
1991 <h5>enableBinaryRepository</h5>
1992 <ul>
1993 <b>Description: </b>Setting this to true will activate the
1994 binary repository support on the next restart of cimserver.<br>
1995 <b>Recommended Default Value (Development Build): </b>false<br>
1996 denise.eckstein 1.1 <b>Recommended Default Value (Release Build): </b>false<br>
1997 <b>Recommend To Be Fixed/Hidden (Development Build): </b>Yes<br>
1998 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br>
1999 <b>Dynamic?: </b>No<br>
2000 <b>Considerations: </b>Repositories containing a mixture
2001 of binary and XML objects are supported.<br>
2002 <b>Source Configuration File: </b>
2003 Pegasus/Config/RepositoryPropertyOwner.cpp</p>
2004 </ul>
2005
2006
2007 <h5>enableHttpConnection</h5>
2008 <ul>
2009 <b>Description: </b>If true, allows connections to
2010 the CIM Server using the HTTP protocol<br>
2011 <b>Default Value: </b>true<br>
2012 <b>Recommended Default Value (Development Build): </b>true<br>
2013 <b>Recommended Default Value (Release Build): </b>false<br>
2014 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2015 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2016 <b>Dynamic?: </b>No<br>
2017 denise.eckstein 1.1 <b>Considerations: </b>
2018 Enabling HTTP will allow clients to connect with security
2019 properties different than those associated with encrypted SSL
2020 traffic, and its configured SSL authentication or other security
2021 behavior. This option should only be enabled in environments
2022 where sending the HTTP Request and HTTP Response as
2023 clear text messages does not introduce a security risk.
2024 Note that if authentication is enabled (enableAuthentication),
2025 user names and passwords will be included in the text of the
2026 HTTP message.<br>
2027 <br>
2028 <table border="1" cellspacing="1" bordercolordark="#666666"
2029 bordercolorlight="#CCCCCC" width=531
2030 style='font-size=10.0pt;font-family:Arial'>
2031 <tr>
2032 <th bgcolor="#CAE6CA" width="168">Platform</th>
2033 <th bgcolor="#CAE6CA" width=350>Source Configuration File</th>
2034 </tr>
2035 <tr align="center">
2036 <td width="168">Linux</td>
2037 <td align="left" width="350">
2038 denise.eckstein 1.1 Pegasus/Config/DefaultPropertyTableLinux.h</td>
2039 </tr>
2040 <tr align="center">
2041 <td width="168">HP-UX</td>
2042 <td align="left" width="350">
2043 Pegasus/Config/DefaultPropertyTableHpux.h</td>
2044 </tr>
2045 <tr align="center">
2046 <td width="168">OpenVMS</td>
2047 <td align="left" width="350">
2048 Pegasus/Config/DefaultPropertyTableVms.h</td>
2049 </tr>
2050 </table>
2051 </ul>
2052
2053 <h5>enableHttpsConnection</h5>
2054 <ul>
2055 <b>Description: </b>If true, allows connections to
2056 the CIM Server using the HTTPS protocol (HTTP using
2057 Secure Socket Layer encryption)<br>
2058 <b>Default Value: </b>false<br>
2059 denise.eckstein 1.1 <b>Recommended Default Value (Development Build): </b>true<br>
2060 <b>Recommended Default Value (Release Build): </b>true<br>
2061 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2062 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2063 <b>Dynamic?: </b>No<br>
2064 <b>Considerations: </b>For this option to work,
2065 the environment variable PEGASUS_HAS_SSL must have
2066 been set when CIM Server was built.<br>
2067 <br>
2068 <table border="1" cellspacing="1" bordercolordark="#666666"
2069 bordercolorlight="#CCCCCC" width=531
2070 style='font-size=10.0pt;font-family:Arial'>
2071 <tr>
2072 <th bgcolor="#CAE6CA" width="168">Platform</th>
2073 <th bgcolor="#CAE6CA" width=350>Source Configuration File</th>
2074 </tr>
2075 <tr align="center">
2076 <td width="168">Linux</td>
2077 <td align="left" width="350">
2078 Pegasus/Config/DefaultPropertyTableLinux.h</td>
2079 </tr>
2080 denise.eckstein 1.1 <tr align="center">
2081 <td width="168">HP-UX</td>
2082 <td align="left" width="350">
2083 Pegasus/Config/DefaultPropertyTableHpux.h</td>
2084 </tr>
2085 <tr align="center">
2086 <td width="168">OpenVMS</td>
2087 <td align="left" width="350">
2088 Pegasus/Config/DefaultPropertyTableVms.h</td>
2089 </tr>
2090 </table>
2091 </ul>
2092
2093 <h5>enableIndicationService</h5>
2094 <ul>
2095 <b>Description: </b>If true, the CIM Server will support
2096 CIM Indications.<br>
2097 <b>Default Value: </b>true<br>
2098 <b>Recommended Default Value (Development Build): </b>true<br>
2099 <b>Recommended Default Value (Release Build): </b>true<br>
2100 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2101 denise.eckstein 1.1 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2102 <b>Dynamic?: </b>No<p> <br>
2103 <br>
2104 <table border="1" cellspacing="1" bordercolordark="#666666"
2105 bordercolorlight="#CCCCCC" width=531
2106 style='font-size=10.0pt;font-family:Arial'>
2107 <tr>
2108 <th bgcolor="#CAE6CA" width="168">Platform</th>
2109 <th bgcolor="#CAE6CA" width=350>Source Configuration File</th>
2110 </tr>
2111 <tr align="center">
2112 <td width="168">Linux</td>
2113 <td align="left" width="350">
2114 Pegasus/Config/DefaultPropertyTableLinux.h</td>
2115 </tr>
2116 <tr align="center">
2117 <td width="168">HP-UX</td>
2118 <td align="left" width="350">
2119 Pegasus/Config/DefaultPropertyTableHpux.h</td>
2120 </tr>
2121 <tr align="center">
2122 denise.eckstein 1.1 <td width="168">OpenVMS</td>
2123 <td align="left" width="350">
2124 Pegasus/Config/DefaultPropertyTableVms.h</td>
2125 </tr>
2126 </table>
2127 </ul>
2128
2129 <h5>enableNamespaceAuthorization</h5>
2130 <ul>
2131 <b>Description: </b>If true, the CIM Server restricts
2132 access to namespaces based on configured user authorizations
2133 [user authorizations may be configured using the cimauth
2134 command]<br>
2135 <b>Default Value: </b>false<br>
2136 <b>Recommended Default Value (Development Build): </b>false<br>
2137 <b>Recommended Default Value (Release Build): </b>false<br>
2138 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2139 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2140 <b>Dynamic?: </b>No<br>
2141 <b>Considerations: </b>
2142 This option offers limited functionality and, in most
2143 denise.eckstein 1.1 environments, expensive to administer. It's use is not
2144 recommended.<br>
2145 <b>Source Configuration File: </b>
2146 Pegasus/Config/SecurityPropertyOwner.cpp</ul>
2147
2148 <h5>enableNormalization</h5>
2149 <ul>
2150 <b>Description: </b>If true, objects returned from instance
2151 providers are validated and normalized. <br>
2152 <b>Default Value: </b>true<br>
2153 <b>Recommended Default Value (Development Build): </b>true<br>
2154 <b>Recommended Default Value (Release Build): </b>false<br>
2155 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2156 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2157 <b>Dynamic?: </b>No<br>
2158 <b>Considerations: </b>
2159 <ul>
2160 <li>Any errors encountered during normalization result in a
2161 CIMException with the status code set to CIM_ERR_FAILED
2162 and a meaningful, context specific error description
2163 (messages will be localized). Providers that catch the
2164 denise.eckstein 1.1 exception have an opportunity to handle the error.
2165 Otherwise, the exception is passed to the Provider Manager
2166 and becomes the response for that Provider.
2167 <li>Provider Modules that are listed on the
2168 excludeModulesFromNormalization
2169 configuration option are excluded from normalization.
2170 <li>Since the concept of normalization is relatively new to
2171 OpenPegasus and it establishes and enforces rules for
2172 objects returned by providers, it should only
2173 apply to providers written against the SDK in which it was
2174 introduced (or later). Therefore only Provider Modules that
2175 have the following InterfaceType and InterfaceVersion
2176 combination will be subject to normalization:
2177 <ul>
2178 <li>'C++Default' / 2.5.0 or greater
2179 <li>'CMPI' / 2.0.0 or greater
2180 <li>'JMPI' / 1.0.0 or greater
2181 </ul>
2182 </ul>
2183 <b>Source Configuration File: </b>
2184 Pegasus/Config/NormalizationPropertyOwner.cpp<br>
2185 denise.eckstein 1.1 </ul>
2186
2187
2188 <h5>enableRemotePrivilegedUserAccess</h5>
2189 <ul>
2190 <b>Description: </b>If true, the CIM Server allows
2191 access by a privileged user from a remote system<br>
2192 <b>Default Value: </b>true<br>
2193 <b>Recommended Default Value (Development Build): </b>true<br>
2194 <b>Recommended Default Value (Release Build): </b>true<br>
2195 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2196 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2197 <b>Dynamic?: </b>No<br>
2198 <b>Considerations: </b>Many management operations require
2199 privileged user access. Disabling remote access by
2200 privileged user could significantly affect
2201 functionality.<br>
2202 <b>Source Configuration File: </b>
2203 Pegasus/Config/SecurityPropertyOwner.cpp<p> </p>
2204 </ul>
2205
2206 denise.eckstein 1.1 <h5>enableSSLExportClientVerification</h5>
2207 <ul>
2208 <b>Description: </b>If true, the CIM Server allows HTTPS
2209 connection for CIMExport requests on the port specified by the
2210 service name "wbem-exp-https".<br>
2211 <b>Default Value: </b>false<br>
2212 <b>Recommended Default Value (Development Build): </b>true<br>
2213 <b>Recommended Default Value (Release Build): </b>false<br>
2214 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2215 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2216 <b>Dynamic?: </b>No<br>
2217 <b>Source Configuration File: </b>
2218 Pegasus/Config/SecurityPropertyOwner.cpp</p>
2219 </ul>
2220
2221
2222 <h5>enableSubscriptionsForNonprivilegedUsers</h5>
2223 <ul>
2224 <b>Description: </b>If true, operations (create instance,
2225 modify instance, delete instance, get instance, enumerate
2226 instances, enumerate instance names) on indication
2227 denise.eckstein 1.1 filter, listener destination, and subscription instances
2228 may be performed by non-privileged users. Otherwise, these
2229 operations may only be performed on these instances by
2230 privileged users.<br>
2231 <b>Default Value: </b>true<br>
2232 <b>Recommended Default Value (Development Build): </b>true<br>
2233 <b>Recommended Default Value (Release Build): </b>false<br>
2234 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2235 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2236 <b>Dynamic?: </b>No<br>
2237 <b>Considerations: </b>This option has meaning only if
2238 enableIndicationService=true.<br>
2239 <b>Source Configuration File: </b>
2240 Pegasus/Config/SecurityPropertyOwner.cpp<p> </p>
2241 </ul>
2242
2243 <h5>excludeModulesFromNormalization</h5>
2244 <ul>
2245 <b>Description: </b>If the excludeModulesfromNormalization
2246 property is set, the value is interpreted as a list of
2247 comma-separated Provider Module names (as specified in
2248 denise.eckstein 1.1 PG_ProviderModule.Name) to exclude from validation and
2249 normalization.<br>
2250 <b>Default Value: </b>""<br>
2251 <b>Recommended Default Value (Development Build):</b>
2252 ""<br>
2253 <b>Recommended Default Value (Release Build): </b>
2254 ""<br>
2255 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2256 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2257 <b>Dynamic?: </b>No<br>
2258 <b>Considerations: </b>All objects managed by all
2259 providers will be excluded from validation and normalization
2260 if its module name appears in this list.<br>
2261 <b>Source Configuration File: </b>
2262 Pegasus/Config/NormalizationPropertyOwner.cpp
2263 </ul>
2264
2265
2266 <h5><b>exportSSLTrustStore</b></h5>
2267 <ul>
2268 <b>Description: </b>Specifies the location of the OpenSSL
2269 denise.eckstein 1.1 truststore for Indications. Consistent with the OpenSSL
2270 implementation, a truststore can be either a file or directory.
2271 If the truststore is a directory, all the certificates within
2272 the directory are considered trusted.<br>
2273 <b>Default Value: </b>indication_trust.pem<br>
2274 <b>Recommended Default Value (Development Build): </b>
2275 indication_trust.pem<br>
2276 <b>Recommended Default Value (Release Build): </b>
2277 $CERTIFICATEDIR/indication_trust.pem<br>
2278 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2279 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br>
2280 <b>Dynamic?: </b>No<br>
2281 <b>Source Configuration File: </b>
2282 Pegasus/Config/SecurityPropertyOwner.cpp</p>
2283 </ul>
2284
2285 <h5>forceProviderProcesses</h5>
2286 <ul>
2287 <b>Description: </b>If true, the CIM Server runs Providers
2288 in separate processes rather than loading and calling Provider
2289 libraries directly within the CIM Server process.<br>
2290 denise.eckstein 1.1 <b>Default Value: </b>Dependent on the value of
2291 PEGASUS_DEFAULT_ENABLE_OOP<br>
2292 <b>Recommended Default Value (Development Build):</b>true (HP-UX,
2293 Linux)<br>
2294 <b>Recommended Default Value (Release Build): </b>true (HP-UX,
2295 Linux)<br>
2296 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2297 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2298 <b>Dynamic?: </b>No<br>
2299 <b>Considerations: </b>In a dynamic, potentially multi-vendor,
2300 environment, the ability to run Providers in separate processes
2301 can significantly increase the stability, maintainability and
2302 supportability of the overall solution. Running Providers
2303 in separate process spaces: (1) helps isolate components (i.e.,
2304 cimserver and Providers) from a catastrophic failure
2305 (segmentation faults, memory leaks) of a single Provider and (2)
2306 reduces the risk of accidental or malicious sharing of sensitive
2307 data among Providers. This benefit comes at a cost.
2308 Moving Providers out of the cimserver process increases
2309 communication costs and can significantly increase response
2310 time. Actual results will vary, but it is common for
2311 denise.eckstein 1.1 response times to increase by a factor of 2.<br>
2312 <b>Note 1: </b>When forceProviderProcesses is true, the CIM
2313 Server will load each Provider Module (i.e., library) into a
2314 separate process. Providers in different Provider Modules
2315 cannot depend on a communication mechanism that
2316 requires them to run in the same process space.<br>
2317 <b>Note 2: </b>Although the catastrophic failure of an
2318 Out-Of-Process (OOP) Provider Module will not result in a
2319 failure of the CIM Server process, if the failed OOP Provider
2320 Module included Indication Providers, Indications may be
2321 lost. If logging is enabled, the CIM Server will log a
2322 message informing administrators of what happened and what
2323 corrective actions can be taken.<br>
2324 <br>
2325 <table border="1" cellspacing="1" bordercolordark="#666666"
2326 bordercolorlight="#CCCCCC" width=531
2327 style='font-size=10.0pt;font-family:Arial'>
2328 <tr>
2329 <th bgcolor="#CAE6CA" width="168">Platform</th>
2330 <th bgcolor="#CAE6CA" width=350>
2331 Source Configuration File</th>
2332 denise.eckstein 1.1 </tr>
2333 <tr align="center">
2334 <td width="168">Linux</td>
2335 <td align="left" width="350">
2336 Pegasus/Config/DefaultPropertyTableLinux.h</td>
2337 </tr>
2338 <tr align="center">
2339 <td width="168">HP-UX</td>
2340 <td align="left" width="350">
2341 Pegasus/Config/DefaultPropertyTableHpux.h</td>
2342 </tr>
2343 <tr align="center">
2344 <td width="168">OpenVMS</td>
2345 <td align="left" width="350">
2346 Pegasus/Config/DefaultPropertyTableVms.h</td>
2347 </tr>
2348 </table>
2349 </ul>
2350
2351 <h5>home</h5>
2352 <ul>
2353 denise.eckstein 1.1 <b>Description: </b>If set, this configuration option defines
2354 the runtime default value for PEGASUS_HOME.<br>
2355 <b>Default Value: </b>"./"<br>
2356 <b>Recommended Default Value (Development Build)</b>"./"<br>
2357 <b>Recommended Default Value (Release Build)""</b><br>
2358 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2359 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br>
2360 <b>Dynamic?: </b>No<p> <br>
2361 <br>
2362 <table border="1" cellspacing="1" bordercolordark="#666666"
2363 bordercolorlight="#CCCCCC" width=531
2364 style='font-size=10.0pt;font-family:Arial'>
2365 <tr>
2366 <th bgcolor="#CAE6CA" width="168">Platform</th>
2367 <th bgcolor="#CAE6CA" width=350>Source Configuration File</th>
2368 </tr>
2369 <tr align="center">
2370 <td width="168">Linux</td>
2371 <td align="left" width="350">
2372 Pegasus/Config/DefaultPropertyTableLinux.h</td>
2373 </tr>
2374 denise.eckstein 1.1 <tr align="center">
2375 <td width="168">HP-UX</td>
2376 <td align="left" width="350">
2377 Pegasus/Config/DefaultPropertyTableHpux.h</td>
2378 </tr>
2379 <tr align="center">
2380 <td width="168">OpenVMS</td>
2381 <td align="left" width="350">
2382 Pegasus/Config/DefaultPropertyTableVms.h</td>
2383 </tr>
2384 </table>
2385 </ul>
2386
2387 <h5>httpPort</h5>
2388 <ul>
2389 <b>Description: </b>OpenPegasus first attempts to look up the
2390 port number for HTTP using getservbyname for the 'wbem-http'
2391 service. The httpPort configuration setting is used only when the
2392 getservbyname lookup fails.<br>
2393 <b>Default Value: </b>blank<br>
2394 <b>Recommended Default Value (Development Build): </b>blank<br>
2395 denise.eckstein 1.1 <b>Recommended Default Value (Release Build): </b>5988<br>
2396 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2397 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br>
2398 <b>Dynamic?: </b>No<br>
2399 <b>Considerations: </b>(1)The use of 5988 for WBEM HTTP is
2400 recommended by the DMTF. This port has been registered with
2401 <a href="http://www.iana.org/assignments/port-numbers">
2402 IANA</a>. In a production environment, the recommendation is
2403 to use /etc/services to configure the value of this port. (2)
2404 With the release of OpenPegasus 2.5, the default values for
2405 httpPort was changed from 5988 to "". This
2406 change was made to allow the OpenPegasus to differentiate
2407 between a default setting of 5988 and a customer-defined
2408 setting of 5988. With this change, if the port
2409 number is explicitly set, the configured port will be used
2410 regardless of the settings in /etc/services. If no port number
2411 is specified, the server will continue to use the value in
2412 /etc/services.<br>
2413 <br>
2414 <table border="1" cellspacing="1" bordercolordark="#666666"
2415 bordercolorlight="#CCCCCC" width=531
2416 denise.eckstein 1.1 style='font-size=10.0pt;font-family:Arial'>
2417 <tr>
2418 <th bgcolor="#CAE6CA" width="168">Platform</th>
2419 <th bgcolor="#CAE6CA" width=350>Source Configuration File</th>
2420 </tr>
2421 <tr align="center">
2422 <td width="168">Linux</td>
2423 <td align="left" width="350">
2424 Pegasus/Config/DefaultPropertyTableLinux.h</td>
2425 </tr>
2426 <tr align="center">
2427 <td width="168">HP-UX</td>
2428 <td align="left" width="350">
2429 Pegasus/Config/DefaultPropertyTableHpux.h</td>
2430 </tr>
2431 <tr align="center">
2432 <td width="168">OpenVMS</td>
2433 <td align="left" width="350">
2434 Pegasus/Config/DefaultPropertyTableVms.h</td>
2435 </tr>
2436 </table>
2437 denise.eckstein 1.1 </ul>
2438
2439 <h5>httpsPort</h5>
2440 <ul>
2441 <b>Description: </b>
2442 OpenPegasus first attempts to look up the port number for HTTPS
2443 using getservbyname for the 'wbem-https' service. The httpsPort
2444 configuration setting is used only when the getservbyname lookup
2445 fails.<br>
2446 <b>Default Value: </b>blank<br>
2447 <b>Recommended Default Value (Development Build): </b>blank<br>
2448 <b>Recommended Default Value (Release Build): </b>5989<br>
2449 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2450 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br>
2451 <b>Dynamic?: </b>No<br>
2452 <b>Considerations: </b>(1)The use of 5989 for WBEM HTTPS
2453 is recommended by the DMTF. This port has been registered with
2454 <a href="http://www.iana.org/assignments/port-numbers">IANA</a>.
2455 In a production environment, the recommendation is to use
2456 /etc/services to configure the value of this port.(2)
2457 With the release of OpenPegasus 2.5, the default values for
2458 denise.eckstein 1.1 httpPort was changed from 5989 to "". This
2459 change was made to allow the OpenPegasus to differentiate
2460 between a default setting of 5989 and a customer-defined
2461 setting of 5989. With this change, if the port number
2462 is explicitly set, the configured port will be used regardless
2463 of the settings in /etc/services. If no port number is specified,
2464 the server will continue to use the value in /etc/services.<br>
2465 <br>
2466
2467 <table border="1" cellspacing="1" bordercolordark="#666666"
2468 bordercolorlight="#CCCCCC" width=531
2469 style='font-size=10.0pt;font-family:Arial'>
2470 <tr>
2471 <th bgcolor="#CAE6CA" width="168">Platform</th>
2472 <th bgcolor="#CAE6CA" width=350>Source Configuration File</th>
2473 </tr>
2474 <tr align="center">
2475 <td width="168">Linux</td>
2476 <td align="left" width="350">
2477 Pegasus/Config/DefaultPropertyTableLinux.h</td>
2478 </tr>
2479 denise.eckstein 1.1 <tr align="center">
2480 <td width="168">HP-UX</td>
2481 <td align="left" width="350">
2482 Pegasus/Config/DefaultPropertyTableHpux.h</td>
2483 </tr>
2484 <tr align="center">
2485 <td width="168">OpenVMS</td>
2486 <td align="left" width="350">
2487 Pegasus/Config/DefaultPropertyTableVms.h</td>
2488 </tr>
2489 </table>
2490 </ul>
2491
2492 <h5>idleConnectionTimeout</h5>
2493 <ul>
2494 <b>Description: </b>If set to a positive integer, this value
2495 specifies a minimum timeout value for idle client connections.
2496 If set to zero, idle client connections do not time out.<br>
2497 <b>Recommended Default Value (Development Build): </b>0<br>
2498 <b>Recommended Default Value (Release Build): </b>0<br>
2499 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2500 denise.eckstein 1.1 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2501 <b>Considerations: </b>A client connection is considered
2502 idle when it is not in the process of sending a request and
2503 the CIM Server is not processing a request from that connection.
2504 An idle connection timeout allows reclamation of the system
2505 resources allocated for idle CIM Server connections. Note that
2506 the CIM Server may allow an idle connection to persist longer
2507 than the configured timeout value based on server activity.
2508 Some client applications may not behave correctly if a
2509 connection timeout is introduced. Client compatibility should be
2510 considered when configuring an idle connection timeout value.
2511 The idle connection time is computed using the system clock.
2512 Thus, resetting the system clock may cause unexpected timeout
2513 behavior.<br>
2514 </ul>
2515
2516 <h5>logdir</h5>
2517 <ul>
2518 <b>Description: </b>Specifies the name of the directory
2519 to be used for the OpenPegasus specific log files.<br>
2520 <b>Recommended Default Value (Development Build): </b>logs<br>
2521 denise.eckstein 1.1 <b>Recommended Default Value (Release Build): </b>$LOGDIR<br>
2522 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2523 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br>
2524 <b>Dynamic?: </b>Yes<br>
2525 <b>Considerations: </b>This option is not supported if
2526 PEGASUS_USE_SYSLOGS is defined.<br>
2527 <b>Source Configuration File: </b>
2528 Pegasus/Config/LogPropertyOwner.cpp<br>
2529 </ul>
2530
2531 <h5>logLevel</h5>
2532 <ul>
2533 <b>Description: </b>Defines the desired level of logging.
2534 Valid values include: TRACE, INFORMATION, WARNING, SEVERE,
2535 FATAL.<br>
2536 <b>Default Value: </b>"INFORMATION"<br>
2537 <b>Recommended Default Value (Development Build): </b>
2538 "INFORMATION"<br>
2539 <b>Recommended Default Value (Release Build): </b>"SEVERE"<br>
2540 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2541 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2542 denise.eckstein 1.1 <b>Dynamic?: </b>Yes<br>
2543 <b>Considerations: </b><br>
2544 <b>Source Configuration File: </b>
2545 Pegsus/Config/LogPropertyOwner.cpp<p> </p>
2546 </ul>
2547
2548 <h5>maxProviderProcesses</h5>
2549 <ul>
2550 <b>Description:</b> Limits the number of provider
2551 processes (see 'forceProviderProcesses) that may run
2552 concurrently. A 'maxProviderProcesses' value of '0' indicates
2553 that the number of Provider Agent processes is unlimited<br>
2554 <b>Default Value: </b>0<br>
2555 <b>Recommended Default Value (Development Build):</b> 0<br>
2556 <b>Recommended Default Value (Release Build):</b> 0<br>
2557 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2558 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br>
2559 <b>Dynamic?: </b>No<br>
2560 <b>Considerations: </b><br>
2561 <br>
2562 <table border="1" cellspacing="1" bordercolordark="#666666"
2563 denise.eckstein 1.1 bordercolorlight="#CCCCCC" width=531
2564 style='font-size=10.0pt;font-family:Arial'>
2565 <tr>
2566 <th bgcolor="#CAE6CA" width="168">Platform</th>
2567 <th bgcolor="#CAE6CA" width=350>
2568 Source Configuration File</th>
2569 </tr>
2570 <tr align="center">
2571 <td width="168">Linux</td>
2572 <td align="left" width="350">
2573 Pegasus/Config/DefaultPropertyTableLinux.h</td>
2574 </tr>
2575 <tr align="center">
2576 <td width="168">HP-UX</td>
2577 <td align="left" width="350">
2578 Pegasus/Config/DefaultPropertyTableHpux.h</td>
2579 </tr>
2580 <tr align="center">
2581 <td width="168">OpenVMS</td>
2582 <td align="left" width="350">
2583 Pegasus/Config/DefaultPropertyTableVms.h</td>
2584 denise.eckstein 1.1 </tr>
2585 </table>
2586 </ul>
2587
2588 <h5>messageDir</h5>
2589 <ul>
2590 <b>Description: </b>Specifies the name of the directory to
2591 be used for the OpenPegasus translated messages.<br>
2592 <b>Default Value: </b>msg<br>
2593 <b>Recommended Default Value (Development Build): </b>msg<br>
2594 <b>Recommended Default Value (Release Build):</b>
2595 $MESSAGEDIR/msg<br>
2596 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2597 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br>
2598 <b>Dynamic?: </b>No<br>
2599 <b>Considerations: </b>Only used when message localization
2600 is enabled. See PEGASUS_HAS_MESSAGES for details.<br>
2601 <b>Source Configuration File: </b>
2602 FileSystemPropertyOwner.cpp<br>
2603 </ul>
2604
2605 denise.eckstein 1.1 <h5>providerDir</h5>
2606 <ul>
2607 <b>Description: </b>Specifies the names of the directories
2608 that contains Provider executables.<br>
2609 <b>Recommended Default Value (Development Build): </b>lib<br>
2610 <b>Recommended Default Value (Release Build): </b>
2611 $PROVIDERDIRS<br>
2612 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2613 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br>
2614 <b>Dynamic?: </b>No<br>
2615 <b>Considerations: </b>The CIM Server runs as a privileged
2616 user. And, since Providers run in the same process space as the
2617 CIM Server, Providers also have privileged access to the
2618 system. Allowing a registered Provider’s executable to be
2619 replaced with malicious code would result in a critical
2620 security defect, giving a malicious user privileged access
2621 to the system. Adminstrators are responsible for ensuring
2622 that only trusted Providers are loaded into providerDir.
2623 In order to simplify the management task associated with
2624 securing Provider executable, the value of providerDir can be
2625 fixed at build time (i.e., set to one or more fixed, well-known
2626 denise.eckstein 1.1 locations).<br>
2627 <b>Source Configuration File: </b>
2628 Pegasus/Config/FileSystemPropertyOwner.cpp<br>
2629 </ul>
2630
2631 <h5>providerManagerDir</h5>
2632 <ul>
2633 <b>Description: </b>Specifies the name of the directory that
2634 contains the ProviderManager plugin libraries.<br>
2635 <b>Recommended Default Value (Development Build): </b>lib<br>
2636 <b>Recommended Default Value (Release Build): </b>
2637 $PROVIDERMANAGERDIRS<br>
2638 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2639 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br>
2640 <b>Dynamic?: </b>No<br>
2641 <b>Considerations: </b>Should be a dedicated directory to
2642 minimize inspection of non-applicable files. Additionally,
2643 since all calls to the providers go through the provider
2644 managers, the same care should be taken with regards to
2645 security for the provider manager directory, as for provider
2646 directories.<br>
2647 denise.eckstein 1.1 <b>Source Configuration File: </b>
2648 Pegasus/Config/FileSystemPropertyOwner.cpp<br>
2649 </ul>
2650
2651 <h5>repositoryDir</h5>
2652 <ul>
2653 <b>Description: </b>Specifies the name of the directory
2654 to be used for the OpenPegasus repository.<br>
2655 <b>Recommended Default Value (Development Build): </b>repository<br>
2656 <b>Recommended Default Value (Release Build): </b>
2657 $REPOSITORYDIR/repository<br>
2658 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2659 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br>
2660 <b>Dynamic?: </b>No<br>
2661 <b>Considerations: </b><br>
2662 <b>Source Configuration File: </b>
2663 Pegasus/Config/FileSystemPropertyOwner.cpp<p><br>
2664 </ul>
2665
2666 <h5>repositoryIsDefaultInstanceProvider</h5>
2667 <ul>
2668 denise.eckstein 1.1 <b>Description: </b>If true, the Repository functions
2669 as the Instance Provider for all classes for which there
2670 is not an explicitly registered Provider. This flag is
2671 also used to control the behavior of the repository when
2672 processing association operators.<br>
2673 <b>Recommended Default Value (Development Build): </b>true<br>
2674 <b>Recommended Default Value (Release Build): </b>false<br>
2675 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2676 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br>
2677 <b>Dynamic?: </b>No<br>
2678 <b>Considerations: </b>This flag can be used to configure
2679 the CIM Server to allow the Repository to be used by CIM Clients
2680 and CIM Providers as a dynamic data store. The setting of this
2681 flag will significantly affect CIM Server behavior as viewed
2682 by the CIM Client.<br>
2683
2684 The following issues should be considered when setting
2685 repositoryIsDefaultInstanceProvider=true:
2686
2687 <ul>
2688 <li><b>Authorization.</b> The repository has no
2689 denise.eckstein 1.1 concept of which users (or components) are authorized to
2690 perform which operations.</li>
2691 <li><b>Appearance of instrumentation.</b> A client application
2692 cannot determine whether instrumentation exists for a
2693 given CIM class. For example, imagine a client
2694 issues a CreateInstance operation on a Disk class
2695 for which no provider is registered.
2696 The instance will be stored in the repository, and
2697 the client gets a "success" response. Does that mean a
2698 disk device has been created on the server? Even worse,
2699 when another client issues an EnumerateInstances
2700 operation, the spurious Disk instance is returned.
2701 With repositoryIsDefaultInstanceProvider=false, the
2702 CreateInstance operation above would have returned a
2703 NOT_SUPPORTED error.</li>
2704 <li><b>Potential for inconsistent data.</b> Using the
2705 repository as a data cache increases the probability
2706 that a client will see stale or incorrect data. A
2707 provider can better control the correlation
2708 between the data returned and the current state of the
2709 underlying managed resource (whether or not the provider
2710 denise.eckstein 1.1 caches the data).</li>
2711 </ul>
2712 <br>
2713
2714 The following issues should be considered when setting
2715 repositoryIsDefaultInstanceProvider=false:
2716
2717 <ul>
2718 <li><b>Provider Availability.</b> Certain Providers have been
2719 developed to use the Repository as a dynamic data store.
2720 These Providers are currently not supported on system
2721 where this flag is disabled. E.g., the Common Diagnostics
2722 Model (CDM) Provider
2723 (http://developer.intel.com/design/servers/cdm/)
2724 relies on use of the Repository to store instances
2725 of CIM_DiagnosticSetting. If this flag set to
2726 false, this Provider will not function correctly. Note
2727 that this feature is supported by other WBEM
2728 implementation. Therefore, disabling this feature
2729 can increase the cost of migrating existing Providers to
2730 OpenPegasus.</li>
2731 denise.eckstein 1.1 </ul>
2732
2733 <b>Source Configuration File: </b>
2734 Pegasus/Config/RepositoryPropertyOwner.cpp<br>
2735 </ul>
2736
2737 <h5>shutdownTimeout</h5>
2738 <ul>
2739 <b>Description: </b>When a cimserver -s shutdown command is
2740 issued, specifies the maximum time in seconds for the CIM Server
2741 to complete outstanding CIM operation requests before shutting
2742 down; if the specified timeout period expires, the CIM Server
2743 will shut down, even if there are still CIM operations in
2744 progress. Minimum value is 2 seconds.<br>
2745 <b>Recommended Default Value (Development Build): </b>10<br>
2746 <b>Recommended Default Value (Release Build): </b>10<br>
2747 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2748 <b>Recommend To Be Fixed/Hidden (Release Build):</b>No/No<br>
2749 <b>Dynamic?: </b>Yes<br>
2750 <b>Considerations: </b><br>
2751 <b>Source Configuration File: </b>
2752 denise.eckstein 1.1 Pegasus/Config/ShutdownPropertyOwner.cpp<br>
2753 </ul>
2754
2755 <h5>slp</h5>
2756 <ul>
2757 <b>Description: </b>When set to true, OpenPegasus activates
2758 an SLP SA and issues DMTF defined SLP advertisements to this SA
2759 on startup.<br>
2760 <b>Default Value: </b>false<br>
2761 <b>Recommended Default Value (Development Build): </b>false<br>
2762 <b>Recommended Default Value (Release Build): </b>false<br>
2763 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2764 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br>
2765 <b>Dynamic?: </b>No<p> <br>
2766 <br>
2767 <table border="1" cellspacing="1" bordercolordark="#666666"
2768 bordercolorlight="#CCCCCC" width=531
2769 style='font-size=10.0pt;font-family:Arial' height="80">
2770 <tr>
2771 <th bgcolor="#CAE6CA" width="168" height="16">Platform</th>
2772 <th bgcolor="#CAE6CA" width=350 height="16">
2773 denise.eckstein 1.1 Source Configuration File</th>
2774 </tr>
2775 <tr align="center">
2776 <td width="168" height="14">Linux</td>
2777 <td align="left" width="350" height="14">
2778 Pegasus/Config/DefaultPropertyTableLinux.h</td>
2779 </tr>
2780 <tr align="center">
2781 <td width="168" height="14">HP-UX</td>
2782 <td align="left" width="350" height="14">
2783 Pegasus/Config/DefaultPropertyTableHpux.h</td>
2784 </tr>
2785 <tr align="center">
2786 <td width="168" height="16">OpenVMS</td>
2787 <td align="left" width="350" height="16">
2788 Pegasus/Config/DefaultPropertyTableVms.h</td>
2789 </tr>
2790 </table>
2791 </ul>
2792
2793 <h5>socketWriteTimeout</h5>
2794 denise.eckstein 1.1 <ul>
2795 <b>Description: </b>If the CIM Server receives an
2796 EWOULDBLOCK/EAGAIN error on a non-blocking write,
2797 socketWriteTimeout defines the number of seconds the
2798 CIM Server will wait for the socket to get ready and resume
2799 writing data.<br>
2800 <b>Recommended Default Value (Development Build): </b>
2801 20 (seconds)<br>
2802 <b>Recommended Default Value (Release Build): </b>
2803 20 (seconds)<br>
2804 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2805 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2806 <b>Dynamic?: </b>No<br>
2807 <b>Source Configuration File: </b>
2808 Pegasus/Config/DefaultPropertyTable.h
2809 </ul>
2810
2811 <h5>sslCertificateFilePath</h5>
2812 <ul>
2813 <b>Description: </b>Contains the CIM Server SSL
2814 Certificate.<br>
2815 denise.eckstein 1.1 <b>Recommended Default Value (Development Build): </b>
2816 server.pem<br>
2817 <b>Recommended Default Value (Release Build): </b>
2818 $CERTIFICATEDIR/server.pem"<br>
2819 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2820 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br>
2821 <b>Dynamic?: </b>No<br>
2822 <b>Considerations: </b>For a more detailed look at SSL options
2823 and their ramifications, please see the SSL guidelines.<br>
2824 <b>Source Configuration File: </b>
2825 Pegasus/Config/SecurityPropertyOwner.cpp
2826 </ul>
2827
2828 <h5>sslClientVerificationMode</h5>
2829 <ul>
2830 <b>Description: </b>Describes the desired level of support
2831 for certificate-based authentication.
2832 <ul style="MARGIN-TOP: 0in" type="circle">
2833 <li>“<b>required</b>” – The server requires certificate-based
2834 client authentication. A client MUST present a
2835 trusted certificate in order to access the CIM Server.
2836 denise.eckstein 1.1 If the client fails to send a certificate or sends an
2837 untrusted certificate, the connection will be rejected.</li>
2838 <li>“<b>optional</b>” – The server supports, but does not
2839 require, certificate-based client authentication. The
2840 server will request and attempt to validate a client
2841 certificate, however the connection will be accepted even
2842 if no certificate is sent or an untrusted certificate is
2843 sent. The server will then seek to authenticate the
2844 client via an authentication header.</li>
2845 <li>“<b>disabled</b>” – The server does not support
2846 certificate-based client authentication.</li>
2847 </ul>
2848 <b>Recommended Default Value (Development Build): </b>
2849 disabled<br>
2850 <b>Recommended Default Value (Release Build): </b>
2851 disabled<br>
2852 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2853 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2854 <b>Dynamic?: </b>No<br>
2855 <b>Considerations: </b>(1) This property is only used if
2856 <b>enableHttpsConnection</b> is <b>"true"</b>.
2857 denise.eckstein 1.1 (2) If the platform does not support PEGASUS_LOCAL_DOMAIN_SOCKET,
2858 OpenPegasus attempts to use either HTTPS or
2859 HTTP to establish a local connection (connectLocal).
2860 For platforms that do not support PEGASUS_LOCAL_DOMAIN_SOCKET,
2861 Clients which use connectLocal, such as cimconfig -l -c,
2862 cimprovider -l -s and cimserver -s, will not work if the
2863 "sslClientVerificationMode" variable is set to
2864 "required" and HTTP is disabled. For these
2865 platforms, the recommended course of action is to change the
2866 property value to "optional."<br>
2867 <b>Source Configuration File: </b>
2868 Pegasus/Config/SecurityPropertyOwner.cpp
2869 </ul>
2870
2871 <h5>sslKeyFilePath</h5>
2872 <ul>
2873 <b>Description: </b>Contains the private key for the CIM
2874 Server SSL Certificate.<br>
2875 <b>Recommended Default Value (Development Build): </b>
2876 file.pem<br>
2877 <b>Recommended Default Value (Release Build): </b>
2878 denise.eckstein 1.1 $CERTIFICATEDIR/file.pem<br>
2879 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2880 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br>
2881 <b>Dynamic?: </b>No<br>
2882 <b>Considerations: </b>File should be readable only by the
2883 user the cimserver is running as and/or privileged users. The
2884 file should be writeable only by a privileged user.<br>
2885 <b>Source Configuration File: </b>
2886 Pegasus/Config/SecurityPropertyOwner.cpp<br>
2887 </ul>
2888
2889 <h5>sslTrustStore</h5>
2890 <ul>
2891 <b>Description: </b>Specifies the location of the OpenSSL
2892 truststore. Consistent with the OpenSSL implementation, a
2893 truststore can be either a file or directory. If the truststore
2894 is a directory, all the certificates within the directory are
2895 considered trusted.<br>
2896 <b>Recommended Default Value (Development Build): </b>
2897 client.pem<br>
2898 <b>Recommended Default Value (Release Build): </b>
2899 denise.eckstein 1.1 $CERTIFICATEDIR/client.pem<br>
2900 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2901 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br>
2902 <b>Dynamic?: </b>No<br>
2903 <b>Source Configuration File: </b>
2904 Pegsus/Config/SecurityPropertyOwner.cpp
2905 </ul>
2906
2907 <h5>sslTrustStoreUserName</h5>
2908 <ul>
2909 <b>Description: </b>Specifies the system user name to be
2910 associated with all certificate-based authenticated requests.<br>
2911 <b>Recommended Default Value (Development Build): </b>NONE<br>
2912 <b>Recommended Default Value (Release Build): </b>NONE<br>
2913 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2914 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/No<br>
2915 <b>Dynamic?: </b>No<br>
2916 <b>Considerations: </b>This property has no default; for
2917 security reasons, the system administrator must explicitly
2918 specify this value. This feature allows a single user
2919 name to be specified. This user will be associated
2920 denise.eckstein 1.1 with all certificates in the truststore. In the future,
2921 OpenPegasus will allow a system administrator to associate a
2922 distinct user name with each certificate.<br>
2923 <b>Source Configuration File: </b>
2924 Pegsus/Config/SecurityPropertyOwner.cpp<br>
2925 </ul>
2926
2927 <h5>traceComponents</h5>
2928 <ul>
2929 <b>Description: </b>Defines the components to be traced.<br>
2930 <b>Default Value: </b>""<br>
2931 <b>Recommended Default Value (Development Build): </b>""<br>
2932 <b>Recommended Default Value (Release Build): </b>""<br>
2933 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2934 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br>
2935 <b>Dynamic?: </b>Yes<br>
2936 <b>Source Configuration File: </b>
2937 Pegasus/Config/TracePropertyOwner.cpp<br>
2938 </ul>
2939
2940 <h5>traceFacility</h5>
2941 denise.eckstein 1.1 <ul>
2942 <b>Description: </b>Defines the desired facility for trace
2943 messages. Valid values include: "File"
2944 and "Log".<br>
2945 <b>Default Value: </b>File<br>
2946 <b>Recommended Default Value (Development Build): </b>File<br>
2947 <b>Recommended Default Value (Release Build): </b>File<br>
2948 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2949 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br>
2950 <b>Dynamic?: </b>Yes<br>
2951 <b>Case Sensitive?: </b>No<br>
2952 <b>Considerations: </b>If you specify "File",
2953 trace messagesare written into the file specified by the
2954 configuration option traceFilePath. If you specify
2955 "Log", trace messages are written to the
2956 OpenPegasus Log.<br>
2957 <b>Source Configuration File: </b>
2958 Pegasus/Config/TracePropertyOwner.cpp<br>
2959 </ul>
2960
2961 <h5>traceFilePath</h5>
2962 denise.eckstein 1.1 <ul>
2963 <b>Description: </b>Specifies the location of the
2964 OpenPegasus trace file.<br>
2965 <b>Default Value: </b>cimserver.trc<br>
2966 <b>Recommended Default Value (Development Build):</b>
2967 cimserver.trc<br>
2968 <b>Recommended Default Value (Release Build): </b>
2969 $TRACEDIR/cimserver.trc<br>
2970 <b>Recommend To Be Fixed/Hidden (Development Build):</b>No/No<br>
2971 <b>Recommend To Be Fixed/Hidden (Release Build): </b>Yes<br>
2972 <b>Dynamic?: </b>Yes<br>
2973 <b>Source Configuration File: </b>
2974 Pegasus/Config/TracePropertyOwner.cpp<br>
2975 </ul>
2976
2977 <h5>traceLevel</h5>
2978 <ul>
2979 <b>Description: </b></b>Defines the desired level of
2980 tracing. Valid values include: 0, 1, 2, 3, 4, 5.<br>
2981 <b>Default Value: </b>0<br>
2982 <b>Recommended Default Value (Development Build): </b>0<br>
2983 denise.eckstein 1.1 <b>Recommended Default Value (Release Build): </b>0<<br>
2984 <b>Recommend To Be Fixed/Hidden (Development Build): </b>No/No<br>
2985 <b>Recommend To Be Fixed/Hidden (Release Build): </b>No/Yes<br>
2986 <b>Dynamic?: </b>Yes<br>
2987 <b>Source Configuration File: </b>
2988 Pegasus/Config/TracePropertyOwner.cpp<br>
2989 </ul>
2990
2991 <h3>Configuration Constants</h3>
2992
2993 <h4>Definitions</h4>
2994
2995 <h5>static char CURRENT_CONFIG_FILE [] = </h5>
2996 <ul>
2997 <b>Description: </b>Default file name for the current
2998 configuration file.<br>
2999 <b>Recommended Default Value (Development Build):</b>
3000 cimserver_current.conf<br>
3001 <b>Recommended Default Value (Release Build): </b>
3002 $CONFIGDIR/cimserver_current.conf<br>
3003 <b>Dynamic?: </b>No <br>
3004 denise.eckstein 1.1 <br>
3005 <table border="1" cellspacing="1" bordercolordark="#666666"
3006 bordercolorlight="#CCCCCC" width=531
3007 style='font-size=10.0pt;font-family:Arial'>
3008 <tr>
3009 <th bgcolor="#CAE6CA" width="168">Platform</th>
3010 <th bgcolor="#CAE6CA" width=350>
3011 Source Configuration File</th>
3012 </tr>
3013 <tr align="center">
3014 <td width="168">Linux</td>
3015 <td align="left" width="350">
3016 Pegasus/Config/ConfigFileDirLinux.h</td>
3017 </tr>
3018 <tr align="center">
3019 <td width="168">HP-UX</td>
3020 <td align="left" width="350">ConfigFileDirHpux.h</td>
3021 </tr>
3022 <tr align="center">
3023 <td width="168">OpenVMS</td>
3024 <td align="left" width="350">
3025 denise.eckstein 1.1 Pegasus/Config/ConfigFileDirVms.h</td>
3026 </tr>
3027 </table>
3028 </ul>
3029
3030 <h5>static char PLANNED_CONFIG_FILE [] = </h5>
3031 <ul>
3032 <b>Description: </b>Default file name for the planned
3033 configuration file.<br>
3034 <b>Recommended Default Value (Development Build): </b>
3035 cimserver_planned.conf<br>
3036 <b>Recommended Default Value (Release Build): </b>
3037 $CONFIGDIR/cimserver_planned.conf<br>
3038 <b>Dynamic?: </b>No<br>
3039 <br>
3040 <table border="1" cellspacing="1" bordercolordark="#666666"
3041 bordercolorlight="#CCCCCC" width=531
3042 style='font-size=10.0pt;font-family:Arial'>
3043 <tr>
3044 <th bgcolor="#CAE6CA" width="168">Platform</th>
3045 <th bgcolor="#CAE6CA" width=350>
3046 denise.eckstein 1.1 Source Configuration File</th>
3047 </tr>
3048 <tr align="center">
3049 <td width="168">Linux</td>
3050 <td align="left" width="350">
3051 Pegasus/Config/ConfigFileDirLinux.h</td>
3052 </tr>
3053 <tr align="center">
3054 <td width="168">HP-UX</td>
3055 <td align="left" width="350">
3056 Pegasus/Config/ConfigFileDirHpux.h</td>
3057 </tr>
3058 <tr align="center">
3059 <td width="168">OpenVMS</td>
3060 <td align="left" width="350">
3061 Pegasus/Config/ConfigFileDirVms.h</td>
3062 </tr>
3063 </table>
3064 </ul>
3065
3066 <h5>static char CIMSERVER_START_FILE [] = </h5>
3067 denise.eckstein 1.1 <ul>
3068 <b>Description: </b>This is for the default file name
3069 for the cimserver startup file containing the PID.<br>
3070 <b>Default Value: </b>/tmp/cimserver_start.conf<br>
3071 <b>Recommended Default Value (Development Build): </b>
3072 /tmp/cimserver_start.conf<br>
3073 <b>Recommended Default Value (Release Build): </b>
3074 $PIDFILE<br>
3075 <b>Dynamic?: </b>No<br>
3076 <br>
3077 <table border="1" cellspacing="1" bordercolordark="#666666"
3078 bordercolorlight="#CCCCCC" width=531
3079 style='font-size=10.0pt;font-family:Arial'>
3080 <tr>
3081 <th bgcolor="#CAE6CA" width="168">Platform</th>
3082 <th bgcolor="#CAE6CA" width=350>
3083 Source Configuration File</th>
3084 </tr>
3085 <tr align="center">
3086 <td width="168">Linux</td>
3087 <td align="left" width="350">
3088 denise.eckstein 1.1 Pegasus/Config/ConfigFileDirLinux.h</td>
3089 </tr>
3090 <tr align="center">
3091 <td width="168">HP-UX</td>
3092 <td align="left" width="350">
3093 Pegasus/Config/ConfigFileDirHpux.h</td>
3094 </tr>
3095 <tr align="center">
3096 <td width="168">OpenVMS</td>
3097 <td align="left" width="350">
3098 Pegasus/Config/ConfigFileDirVms.h</td>
3099 </tr>
3100 </table>
3101 </ul>
3102
3103 <h3>Configuration Macros</h3>
3104
3105 <h4>Definitions</h4>
3106
3107 <h5>PEGASUS_SSLCLIENT_CERTIFICATEFILE</h5>
3108 <ul>
3109 denise.eckstein 1.1 <b>Description: </b><br>
3110 <b>Recommended Default Value (Development Build): </b>client.pem<br>
3111 <b>Recommended Default Value (Release Build): </b>
3112 $CERTIFICATEDIR/client.pem<br>
3113 <b>Dynamic?: </b>No<br>
3114 <b>Source Configuration File: </b>
3115 Pegasus/Common/Constants.h<br>
3116 </ul>
3117
3118 <h5>PEGASUS_SSLCLIENT_RANDOMFILE</h5>
3119 <ul>
3120 <b>Description: </b>On platforms that do not support
3121 /dev/random or /dev/urandom, OpenSSL will use this file to
3122 seed the PRNG (Pseudo-Random Number Generator). This
3123 PEGASUS_SSLCLIENT_RANDOMFILE defines the default CIM
3124 Client random file.<br>
3125 <b>Recommended Default Value (Development Build):</b>ssl.rnd<br>
3126 <b>Recommended Default Value (Release Build):</b>
3127 $RANDOMDIR/ssl.rnd<br>
3128 <b>Dynamic?: </b>No<br>
3129 <b>Considerations: </b>Use of this variable requires
3130 denise.eckstein 1.1 PEGASUS_HAS_SSL to be set. CIM Client use of a
3131 shared random file is not recommended. On systems where
3132 /dev/random or /dev/urandom are not available, CIM Clients are
3133 encouraged to generate a unique random file which
3134 contains sufficient entropy.<br>
3135 <b>Source Configuration File: </b>
3136 Pegasus/Common/Constants.h<br>
3137 </ul>
3138
3139 <h5>PEGASUS_SSLSERVER_RANDOMFILE</h5>
3140 <ul>
3141 <b>Description: </b>On platforms that do not support
3142 /dev/random or /dev/urandom, OpenSSL will use this file
3143 to seed the PRNG (Pseudo-Random Number Generator). This
3144 PEGASUS_SSLSERVER_RANDOMFILE defines the CIM Server
3145 random file.<br>
3146 <b>Recommended Default Value (Development Build): </b>
3147 cimserver.rnd<br>
3148 <b>Recommended Default Value (Release Build): </b>
3149 $RANDOMDIR/cimserver.rnd<br>
3150 <b>Dynamic?: </b>No<br>
3151 denise.eckstein 1.1 <b>Considerations: </b>1)Use of this variable
3152 requires PEGASUS_HAS_SSL to be set.(2) On systems where
3153 /dev/random or /dev/urandom are not available, CIM Server
3154 vendors need to be sure that the cimserver.rnd file
3155 contains sufficient entropy and is uniquely generated for
3156 each system.<br>
3157 <b>Source Configuration File: </b>
3158 Pegasus/Common/Constants.h<b><br>
3159 </ul>
3160
3161 <h5>PEGASUS_LOCAL_AUTH_DIR</h5>
3162 <ul>
3163 <b>Description:</b> </b>For local connections (i.e.,
3164 connectLocal), OpenPegasus uses a file-based authentication
3165 mechanism.<br>
3166 <b>Recommended Default Value (Development Build): </b>/tmp<br>
3167 <b>Recommended Default Value (Release Build): </b>
3168 $LOCALAUTHDIR/localauth<br>
3169 <b>Dynamic?: </b>No<br>
3170 <b>Source Configuration File: </b>
3171 Pegasus/Common/Constants.h<br>
3172 denise.eckstein 1.1 </ul>
3173
3174 <h5>PEGASUS_LOCAL_DOMAIN_SOCKET_PATH</h5>
3175 <ul>
3176 <b>Description: </b><br>
3177 <b>Recommended Default Value (Development Build): </b>
3178 /tmp/cimxml.socket<br>
3179 <b>Recommended Default Value (Release Build): </b>
3180 $SOCKETDIR/cimxml.socket<br>
3181 <b>Dynamic?: </b>No<br>
3182 <b>Source Configuration File: </b>
3183 Pegasus/Common/Constants.h<br>
3184 </ul>
3185
3186 <hr>
3187 <p><font size="2">
3188 Copyright (c) 2004 EMC Corporation; Hewlett-Packard Development
3189 Company, L.P.; IBM Corp.; The Open Group; VERITAS Software Corporation<br>
3190 Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
3191 EMC Corporation; Symantec Corporation; The Open Group.<br>
3192 <br>
3193 denise.eckstein 1.1 Permission is hereby granted, free of charge, to any person
3194 obtaining a copy of this software and associated documentation files
3195 (the "Software"), to deal in the Software without restriction,
3196 including without limitation the rights to use, copy,
3197 modify, merge, publish, distribute, sublicense, and/or sell copies
3198 of the Software, and to permit persons to whom the Software is
3199 furnished to do so, subject to the following conditions:
3200 <br><br>
3201 THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED
3202 IN ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE
3203 SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
3204 KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
3205 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
3206 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
3207 BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
3208 ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
3209 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
3210 SOFTWARE.
3211 </font></p>
3212
3213 <hr>
3214 denise.eckstein 1.1 <p>Template last modified: January 20th 2004 by Martin Kirk<br>Template version: 1.6</p>
3215
3216 </body>
3217 </html>
|
Return to
BuildAndReleaseOptions.html
CVS log
Up to [Pegasus] / pegasus / doc