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