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