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