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