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