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