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