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