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