OpenPegasus Enhancement Proposal (PEP)

PEP #: 364

Title: Release Notes for OpenPegasus version 2.12.0

Created: 10 September 2012

Authors: Karl Schopmeyer

Status:  draft

Version History:

1.0	10 September 2012	Karl Schopmeyer	Initial Submission
1.01	10 September 2012	Karl Schopmeyer	Minor fixes and complete links to PEPs
1.1	11 September 2012	Karl Schopmeyer	Incorporate all comments from first review
1.2	18 September 2012	Karl Schopmeyer	Fix comments on bug 8830 (compatibility considerations) and bug 9172(repupgrade)

Abstract: This document defines the release notes for the 2.12.0 release of the OpenPegasus CIM Server. The purpose of this PEP is to summarize the characteristics of this release, point to other documentation that defines the release in more detail, and provide additional information about this release that is not available in the other Pegasus documentation.

 Contents

1. Availability of this Release
2. OpenPegasus Functionality of This Release
3. Compatibility Considerations
4. Relationship to CIM/WBEM Standards
5. OpenPegasus Supported Platforms
6. Conformance with DMTF Specifications
7. OpenPegasus Bugs
8. OpenPegasus Release Control and Version Definition Documentation
9. General Documentation

Availability of this Release

This release is available in a number of forms including:

• Source release in both ZIP (and ZIP EXE) and TAR formats. These can be downloaded from the OpenPegasus Web site at www.openpegasus.org. 
• OpenPegasus source RPMs on the OpenPegasus web site.. A source RPM is  available on the OpenPegasus web site that can be used to build binaries for most LSB-compliant RPM-based Linux distributions and versions.
• TheOpenPegasus CVS repository. The CVS tags representing this release and subsequent snapshots that are made available in the Pegasus CVS are defined on the OpenPegasus CVS repository web page (see the OpenPegasus CVS page for information) using the tags defined on the release snapshots page.

The instructions for acquiring the released code are on the Pegasus WEB site. Installation instructions are part of the README in the root of the Pegasus source tree.

OpenPegasus Functionality for This Release

OpenPegasus overall status by release is defined by  a Feature Status WEB Page that is available on the OpenPegasus web site .  That web page shows the Pegasus users and developers the status of the various features found in OpenPegasus using a simple color coded key (white, red, yellow, green) and a description of each feature.

OpenPegasus 2.12.0 is a major release, extending the previous Pegasus release in selected areas as described in the Pegasus  PEP defining this release .

NOTE: OpenPegasus releases are categorized as follows:

• First number of version changes (ex. 2.x.x to 3.0.0) -  Major release includes major functionality change and  incompatible behavior changes and/or incompatible public API changes,
  
• Second number changes (ex 2.11.0 2.12.0) -  Minor Release and includes new functionality but maintains behavior and public API compatibility,
  
• 3rd number changes (2.12.0 to 2.12.1) - Revision(also called point release) release and only includes bug fixes.

ALL changes for each release are documented in the OpenPegasus bug data base by tagging each bug(keyword field of bug).  No change to Pegasus is committed with out this tag on the bug. Changes for this minor release are  tagged 2.12.0_APPROVED. All changes for this minor release can be viewed through  this link to the OpenPegasus bugzilla  Pegasus 2.12.0_APPROVED bug list. Bugs.  Bugs marked as enhancements can be reviewed through the this link to OpenPegasus bugzilla 2.12.0 enhancement bugs .  Bugs fixed for subsequent revision releases (ex. 2.12.1) would also be viewed through corresponding Bugzilla tags for each revisions (ex 2.12.1_APPROVED).

The major areas of development including both enhancements and bug fixes for this release  were as follows. Note that the bugs listed represent only those features incorporated in bugs without PEPS that are considered enhancements, not all bugs incorporated in the release. For more information access the PEP/BUG for each change defined below:

                      Table of Major Changes for this Release

PEP/BUG #	Description of Change	Posted PEP Version
PEP 360	Provider Lifecycle Indications	Ver 1.2
PEP 361	cimcli support for embedded instances	Ver 1.1
PEP 304	Allow modification of name of interop namespace	Ver 1.5
PEP 358	WSMan indication handling and subscription support	Ver 1.1
Bug 8891	Enhance cimsub to add operations to create filters, destinations and subscriptions
Bug 5667	Remove experimental form buildInstance and filter functions in CIMInstance class
Bug 8952	Support Configurable cipher suites in OpenPegasus
Bug 8984	Add support for indication deliver connection pooling
Bug 9008	Add new Indication runtime configuration variables: maxIndicaitonDeliveryRetry Attempts  and minIndicationdeliveryRetryInterval
Bug 9013	Enable ordered indication delivery from provider through CIMServer when PEGASUS_ENABLE_DMTF_INDICATION_PROFILE compile flag is set
Bug 9080	Guaranteed provider lifecycle indication delivery during CIMServer shutdonw
Bug 9112	Advertise IndicationService conformance to Indications Profileby imlementing CIM_ElementConformsToProfile when PEGASUS_ENABLE_DMTF_INDICATION_PROFILE_SUPPORT defined
Bug 9114	Advertise DMTF Indications Profile (DSP1054) 1.1.0 conformance
Bug 9118	Add support for CIM_IndicationFilter.SourceNamespaces[] property
Bug 9136	Runtime configuration option to restrict cimserver to listen on selected network interfaces
Bug 9155	Update to include CIM 2.31 Schema and set this as default schema
Bug 9159	Add SSL Support to Dynamic Listener
Bug 9172	Add capability for administrator to override hostname used by providers. This adds  new runtime configuration variable hostname and fullyQualifiedHostName. It is necessary to upgrade existing repositories using repupgrade utility when upgrading from OpenPegasus less that 2.12.0 and reusing an existing repository.
Bug 9215	Add support of CQL query language to ExecQuery operation in general. When the server receives  ExecQuery it executes enumerate instance for providers that do not support ExecQuery and filters result.
Bug 9209	Add operations for display class tree and counting instances to cimcli
Bug 9227	Enhance cimsub for batches of subscription oriented operations
Bug 9229	Add gcc build support on hp-ux for the Common, Client and General libraries.
Bug 9236	Support for clang/clang++ compiler on Linux. This version supports only X86 and X86_64 and requires clang version 3 or greater.

The status of several components of Pegasus functionality change status between Pegasus versions. Features that have changed status can be identified by a change in color from the previous release to this release on the Feature Status WEB Page.

Information on Interop namespace name (root/PG_InterOp) for OpenPegasus 2.12

Prior to version 2.12 OpenPegasus used an OpenPegasus internal variable to define "root/PG_InterOp" as the name for the OpenPegasus namespace with no defined way to change this variable.  Note that an unsupported method involving editing one file and rebuilding OpenPegasus was defined as a workaround in the OpenPegasus wiki faqs. 

However, since the definition of a standard name for this namespace in DMTF and SNIA specifications ("interop" or "root/interop" with "interop" being the preferred alternative) the use of  "root/PG_InterOp" has become an issue.

Effective OpenPegasus 2.12.0 a new build variable has been defined  (PEGASUS_INTEROP_NAMESPACE) which allows an OpenPegasus builder to define an alternate name for the Interop namespace to either "interop" or "root/interop" (ex. PEGASUS_INTEROP_NAMESPACE = interop).  Once this build variable is defined and OpenPegasus compiled, the actual name of the interop namespace is what was defined in this varaible and all components of OpenPegasus use this as the interop namespace name include the complete OpenPegasus test suite.  The only name for the interop namespace will be the name defined through this build variable.

However, today OpenPegasus is committed to the single namespace defined at build "(root/PG_InterOp", "interop", or "root/interop"). However, a number of OpenPegasus  installations are committed to the "root/PG_InterOp" name and must maintain their repositories through updates of OpenPegasus. While we are working on this issue today (which means that a running version of OpenPegasus must accept both the and new names and not confuse clients, listeners or providers that would use either name) the OpenPegasus team did not complete that work for this release. See bug 9250 for more information about possible solutions and our progress on a solution.

NOTE: If you redefine the interop namespace name with PEGASUS_INTEROP_NAMESPACE clients using the "root/PG_InterOp" namespace will not connect with the updated version of OpenPegasus.

Information on  IPv6 Support (PEP 291)

NOTE: This functionality was incorporated in OpenPegasus 2.7.0 but it was felt that the information below was worth repeating in subsequent Release Notes

IPv6 is short for "Internet Protocol Version 6". IPv6 is the "next generation" protocol designed by the IETF to replace the current version Internet Protocol, IP Version 4 ("IPv4"). IPv6 Support for OpenPegasus is documented in PEP 291.

The IPv6 support in OpenPegasus is controlled by the PEGASUS_ENABLE_IPV6 build variable. The default for this variable is "true"; setting this to 'false' before building OpenPegasus will disable the IPv6 support.

The following subsections provide some information on IPv6 support for the Linux and Windows platforms. Note that in the 2.6.1 release there is no automatic run-time detection of IPv6 support on a platform by OpenPegasus. If you build with PEGASUS_ENABLE_IPV6=true, your platform must support IPv6 or you will get a build failure (missing header files), a run-time bind() failure, or possibly some other failure. This applies to both the CIM Server and Listener components. For more information on IPv6 support for your specific platform, refer to the documentation for that platform.

All OpenPegasus externals that support either a hostname or an IP address as input have been updated to allow an IPv6 address to be specified. If the required input is just an IP address (eg. no optional or required port number), then the IPv6 address must be specified without brackets. For example, the OpenPegasus osinfo client (which returns information about the OS running on a host system) takes separate host and port options. In this case a host with an IPv6-configured network interface would be specified as:

But the cimcli command, which takes an optional "location" option including an optional port number, requires the IPv6 address to be delimited with brackets, for example:

or

For more information on specifying IPv6 addresses, refer to IETF RFC 2373 - IP Version 6 Addressing Architecture and IETF RFC 2732 - Format for Literal IPv6 Addresses in URL's.

IPv6 on Linux

Modern Linux distributions already contain IPv6-ready kernels, the IPv6 capability is generally compiled as a module, but it's possible that this module is not loaded automatically on startup.

Note: you shouldn't use kernel series 2.2.x, because it's not IPv6-up-to-date anymore. Also the IPv6 support in series 2.4.x is no longer improved according to definitions in latest RFCs. It's recommend to use series 2.6.x now.

To check whether your current running kernel supports IPv6, take a look into your /proc filesystem. The entry /proc/net/if_inet6 must exist. A short automated test looks like:

For more information on enabling IPv6 in the Linux kernel and configuring network interfaces, refer to The Linux Documentation Project's IPv6 HOWTO.

Warning: There is currently an open issue with RedHat to address a problem that is seen intermittently on RHEL5 and SLES10 systems. This problem is described in Pegasus bug 6586 and RedHat bug 248052, and manifests itself as an intermittent IPv6 socket failure. You should be aware that OpenPegasus with IPv6 enabled may be significantly impacted in these environments.

IPv6 on Windows

Microsoft provides supported IPv6 implementations for Windows Server 2003, Windows XP with Service Pack 1 (SP1), Windows XP with Service Pack 2 (SP2), and Windows CE .NET 4.1 and later.

On Windows XP, you can use the ipv6.exe tool to install, uninstall, and query your IPv6 configuration. For example:

Windows Vista and Windows Server 2008 support an integrated IPv4 and IPv6 implementation known as the Next Generation TCP/IP stack. Note that the OpenPegasus IPv6 support has not yet been tested on Windows Vista or Windows Server 2008.

For more information on installing, configuring, and using IPv6 on Windows platforms, refer to the document IPv6 for Microsoft Windows: Frequently Asked Questions.

Testing  OpenPegasus IPv6 support

As part of the OpenPegasus automated tests, the TestClient, g11ntest, and IndicationStressTest test clients were modified to run tests using the IPv6 loopback address (::1) if PEGASUS_ENABLE_IPV6=true.

You can also perform manual tests using the IPv6 loopback or a real IPv6-configured network interface. For example, using the IPv6 loopback on a system with OpenPegasus running on the WBEM standard http port of 5988:

Compatibility Considerations

Support for forward-compatibility is a fundamental design principle for the OpenPegasus project. As a community, our goal is for well-behaved OpenPegasus providers or clients, using only the externally defined OpenPegasus interface, to continue to work with a minor version upgrade of OpenPegasus. However, there are certain classes of errors (e.g., non-compliance with a standard that significantly affects interoperability) that may require the community to make potentially incompatible changes. The following table contains a list of defects/fixes that MAY impact, even well-behaved, OpenPegasus providers or clients when upgrading to this OpenPegasus release.

Bugzilla #	Description
Bug 8830	Starting with OpenPegasus 2.11.0 the requirement for providers (CMPI and C++) to filter properties from instances has been relieved. The server will do the filtering at the protocol adapter level. To avoid a negative impact on performance the CIMInstance::filter() and CMPIInstanceFT.setPropertyFilter() functions have been changed to a NOP. This may be a change in behavior for provider relying in some unknown way on the instance being filtered through these functions. To allow users to actually filter properties from an instance, new function CIMInstance::filterInstance() will actually filter properties from an instance exactly as the CIMInstance::filter() did in previous versions of Pegasus.
Bug 9369	Reregistering of an indication provider requires that the  cimserver be restarted to send the enableIndication request to the providers. This issue has existed starting with OpenPegasus 2.10 to the current version. If the cimserver is not restarted the indication will not be enabled for the reregistered provider.

OpenPegasus Relationship to CIM/WBEM Standards

Pegasus was designed and implemented to comply with the DMTF CIM/WBEM specifications The following table defines the level of the DMTF specifications to which this version of Pegasus aims to conform today.

DMTF Specification	Specification Version
DSP 0004 - CIM Infrastructure Specification	Version 2.3 Final, 4 October 2005
DSP 0200 - CIM Operations over HTTP	Version 1.2, Final, January 09, 2007
DSP 0201 - Representation of CIM in XML	Version 2.2 Final, January 09, 2007
DSP 0202 - CIM Query Language Specification	1.0.0, preliminary, 9 December 2004
DSP 0205 - WBEM Discovery using SLP	1.0, preliminary, 27 January 2004
DSP 0206 - WBEM SLP Template	1.0.0, Preliminary, January 2004
CIM Schema	2.31.0 Final ( default)
DSP0226 - Web Services for Management	Version 1.1.1
DSP0227 - WS-Management CIM Binding Specification	Version 1.2.0
DSP0230 - WS-CIM Mapping Specification	Version 1.1.0

DMTF/SNIS SMI Profiles Supported

Today OpenPegasus includes support for several DMTF profiles including the ones defined below:

1. DMTF ProfileRegistration Version 1.0.0
2. DMTF Indications 1.1.0. Since this is effectively the same as the SNIA SMI Indication profile it also supports this profile. This profile is enabled by compiling OpenPegasus with the buld variable PEGASUS_ENABLE_DMTF_INDICATION_SUPPORT.
   
3. SNIA Profile Registration 1.0.0
4. SNIA Server 1.1.0 & 1.2.0
   

Conformance Exceptions to DMTF Specifications

It is a major goal of the OpenPegasus project to both drive and utilize the DMTF CIM/WBEM specifications.  However, today there are a number of known differences.  As of this release, some of the differences include the following:

1. Provider Registration - Pegasus supports registration through a set of Pegasus Provider registration classes rather than support the DMTF defined Provider Qualifier. Pegasus will not support this qualifier in the future. See the readme for more information on provider registration.  This is not a deviation from the specifications but is a different method of registration than many CIM Servers and means that the the provider qualifier is unused in Pegasus.
2. Lifecycle Indications -Today Pegasus supports process indications and lifecycle indications when defined specifically by providers. Pegasus does not support lifecycle indications if they are not defined by the provider or for changes to CIM Classes.  For more information see the Pegasus CVS file:  pegasus/src/Unsupported/LifecycleIndicationProvider/README.LifecycleIndications.htm.

3. IncludeQualifiers option on Instance Operations  - The DMTF specifications have deprecated the use of qualifiers on instance operations with the 1.2 CIM Operations Specification and stated specifically that the client should NOT depend on the includeQualifiers parameter of the CIM/XML instance operations returning qualifiers.  Some CIM Client implementations expect instances returned from the CIM Server to include the qualifiers defined in the class definition (such as KEY qualifiers on properties).   Pegasus today expects the provider to complete the qualifiers on instances in accordance with the specification and generally the interpretation is that Pegasus applies class level qualifiers when the includeInstance parameter is supplied on instance operations.  However, Pegasus today is inconsistent in the return of qualifiers so that the user should NOT depend on Pegasus accurately honoring the includeQualifier parameter for instance operations.  In the future it is expected that Pegasus will deprecate the use of qualifiers on instance operations completely.  When Pegasus uses object normalization, the normalizer does apply qualifiers to returned instances if the includeQualifiers operation parameter is set.

4. LocalOnly option on instance Operations - With the 1.1 version of Specification for CIM Operations over HTTP, the definition of the LocalOnly parameter for the GetInstance and Enumerate Instances operations was modified. This change was incorrect, resulted in reduced functionality and introduced a number of backward compatibility issues. As a result of issues introduced by this change, we strongly recommend that CIM Clients set LocalOnly = false and do not rely on the use of this parameter to filter the set of set of properties returned. See Appendix C of this specification for more information.

5. MultiRequest Operations - Pegasus does not support the DMTF defined MultiRequest Operation option.

6. MOF Compiler namespace pragma - The Pegasus compiler does not support the namespace pragma.

7. CIMOperation Trailer - Pegasus implements chunking based on the DSP0200 1.2.0 preliminary spec. including the operation trailer defined in that specification Refer to bug 6760 for more details. This trailer was completely removed from the DSP0200 1.2 final specification as a non-compatible change so that if chunking is used Pegasus is returning a noncompliant response to enumerate type requests. 
8. Whitespace in XML value Element - Pegasus trims the leading and trailing whitespace from XML value elements that are of the Type String.  This behavior is documented in Pegasus bug 8773 and there is a patch available for users.  However, since the change is considered a change to behavior this will not be patched until pegasus does a major version update. NOTE: There are some documented bugs in Pegasus such as this that the OpenPegasus team feels cannot be incorporated into the code until a major version update.  These bugs are documented with the Bugzilla tag "3.0_TARGET".
9. modifyInstance operation behavior in the Pegasus repository does not match the DMTF specification. Under some conditions (ex. if no propertyList is supplied) it modifies all properties rather than just the properties supplied with the request thereby Nulling out existing values. See bug 8752 for more information.
10. OpenPegasus Interop Namespace - The default interop namespace name in OpenPegasus is "root/PG_Interop".  In versions of OpenPegasus prior to 2.12.0 this could be changed during build by modifying a string definition in the code. Effective version 2.12 this  has become a build option with the build configuraton environment variable PEGASUS_INTEROP_NAMESPACE = <name for this namespace> however, the default if built without this change is still "root/PG_InterOp"
    
11. OpenPegasus WSMAN protocol on windows does not handle NaN, INF, or -INF (bug  8836) - If requests or responses include properties or parameters with floating point property types (Real32 or Real64) with the special states NaN, INF, or -INF on a Windows platform, the input is not accepted because these special strings are not understood by the decoder on Windows.
12. OpenPegasus outputs Nan, INF, -INF special values for Real32 and Real64 property and Parameter types for the CIM/XML protocol - (bug 9392). Today the DMTF Specification DSP0201 allows only numeric information in the format definition for this type and does not all the special strings Nan, etc. However, OpenPegasus actually outputs the special strings if  that is what is defined in the internal values.  OpenPegasus does not allow these special Strings on input however,
13. OpenPegasus does not handle covered properties - (bug 3571) Covered properties (properties which have the same name in a superclass and subclass without overridding the property in the superclass) are not allowed in OpenPegasus. While the requirement for this functionality was added to DSP0004 subsequent to version 2.4, the general agreement is that the requirement itself is not supportable and particularly not with the existing OpenPegasus APIs.  Further, the requirement is expected to be removed in the future (i.e CIM 3.0).
    

OpenPegasus Supported Platforms

Each OpenPegasus release lists as 'active' platforms those hardware/software platforms that have recognized ports for the Pegasus code base including a maintainer for the platform that will be willing to regularly document issues and/or fix defects as the Pegasus code base is changed.  Pegasus may be operable on other platforms (ex. Windows 98) but without a group to provide the role of test and maintenance, correct operation of  Pegasus cannot be assured.  In all cases, including the active platforms, it is the responsibility of the entity that packages and/or compiles OpenPegasus for shipment or deployment, to read, and actively monitor the Pegasus Bugzilla database for a list of relevant defects that affect their platform.   The platforms that are considered ported are shown in the two tables below.  The first table represents platform for which testing is done on a regular basis and reported to the Pegasus Nightly Build Test WEB Page. Those platforms which have been ported but do not have test results that are current at the time of the release are reported in the second table.

Actively Supported Platforms (Nightly Tests Reported for this release)

Platform and OS	Compilers
HP-UX PA_RISC and Itanium	HP aC++ B3910B
Linux on Power	gcc
zLinux	gcc
Linux Itanium	gcc
Linux IA-32	gcc (versions 3.xx, 4.xx) clang(The clang compiler usage is considered experimental and is not part of the nightly tests today)
Linux X86_64	gcc (versions 3.xx, 4.xx) clang(The clang compiler usage is considered experimental and is not part of the nightly tests today)
z/OS V1.7 and up	XL C/C++ from z/OS Version 1.7 and up

 

Platforms not Actively supported for this release (No current Nightly Build Test Results

Platform and OS	Compilers
Windows XP, Windows Vista, Windows 7, Windows Server 2008	Microsoft Visual C++ Compilers 2003 - 2010.. Note: Visual C++ Ver. 6 no longer being regular tested.Note that today there are some open issues with the Windows.
MacOS version 10.3 and higher	gcc 4.01
Solaris 8	GNU  2.95.3,  Sun CC compiler V 5.8. Note that the latest thread patch (108993) may be required. (see Pegasus bug 4632)
Solaris 9	GNU  2.95.3, Sun WorkShop 6 update 2 C++ 5.3, patch 111685-22 2005/04/09
HP OpenVMS 8.3 or later Alpha	HP C++ V7.3-009 or later required for OpenVMS Alpha
HP OpenVMS 8.3 or later IA64	HP C++ V7.3-023 or later required on OpenVMS IA64
Windows 2000	Microsoft Visual C++ Ver.  6 and Microsoft .Net compiler version. Works on VC .NET 2003 v7.1). NOTE: Visual C++ Ver. 6 no longer being regularly tested.
Windows 2003	Microsoft Visual C++ Ver. 6 and Microsoft .Net compiler Version 7.1. Note: Visual C++ Ver. 6 no longer being regular tested.
OpenSolaris 11 (Nevada) Community Edition (Sparc and IX86)	CC Compiler Sun Studio 5.11

Platform patches

The following is a list known of platform patches Pegasus requires.

Further information regarding Pegasus support on IBM platforms can be found at: http://publib.boulder.ibm.com/infocenter/eserver/v1r1/en_US/index.htm?info/icmain.htm

Further information regarding Pegasus support on HP platforms can be found at: http://www.hp.com/go/wbem.

Pegasus Defects

The OpenPegasus Bugzilla database documents any defects found in Pegasus and  is available through the following link:  OpenPegasus bugzilla database.   Effective with the start of the OpenPegasus 2.6 work, all changes to the CVS tree are documented through bugs.  Bugs reports are filed not only for bugs and their corresponding fixes but also as part of the process of committing new code representing the work on PEPs done for OpenPegasus 2.6 and all subsequent versions.  Therefore, a search of the OpenPegasus Bugzilla base for bugs with the tag for a particular version (ex.  2.6.0_APPROVED, 2.6.1_APPROVED, 2.7.0_APPROVED, etc) will yield all changes to the Pegasus CVS tree for that OpenPegasus release.

     - Changes for this release (bugs Tagged 2.12.0_APPROVED). The link is  Pegasus 2.12.0_APPROVED bug list.

Release Control and Version Definition Documentation

The OpenPegasus project is controlled largely through the CVS repository and a set of documents (PEPs) that serve both as the definition and review mechanism for new and modified Pegasus functionality and for the definition and documentation of releases.

The following documentation defines the characteristics of this Pegasus release. The documents are available in the OpenPegasus CVS repository.

• OpenPegasus Release Definition/Status -No PEP (See Wiki Section OpenPegasus 2.12.x Release Status) - A  section in the Pegasus wiki is used throughout the development of this version as the control point for functionality that will go into the release and points to all of the PEPs that represent the Pegasus  functionality changes for this version of Pegasus. 
OpenPegasus  Build and Configuration Options  for Selected Platforms -  In previous versions of Pegasus this information was  released as a Pegasus PEP. Starting with Pegasus 2.9.0 the information is located in the OpenPegasus CVS repository as pegasus/doc/BuildAndReleaseOptions.html.
• OpenPegasus External Interfaces -The list of the OpenPegasus interfaces that are considered external and therefore "frozen". Unless an exception is explicitly approved by the Steering Committee all subsequent releases of Pegasus MUST continue to support these interfaces. Interfaces not explicitly listed in this document, should be considered as internal and subject to change.In previous Pegasus releases this information was available as a separate PEP. Starting with Pegasus 2.9.0 this information is integrated into the Pegasus repositoryas  pegasus/doc/EnternalInterface.html.
• OpenPegasus  SDK Packaging Definition - Defines the recommended set of files for inclusion in the OpenPegasus SDK. Starting with Pegasus release 2.11.0, this document is available in the Pegasus CVS repository as pegasus/doc/SDKPackaging.html. In previous Pegasus releases this document was made available as s separate Pegasus PEP document rather than in the CVS repository. 
•  Pegasus  Runtime Packaging Definition - Defines the recommended set of files for inclusion in this OpenPegasus release. Starting with Pegasus release 2.11.0, this idocument contained in the CVS repository as pegasus/doc/RuntimePackaging.html. In previous releases this was made available as a seperate Pegasus PEP document rather than in the CVS repository.  
• Pegasus Release Notes -  PEP 364 - (This document is located in the approved PEP repository and the OpenPegasus source tree root directory (pegasus/ReleaseNotes.htm)

General Documentation

The following documentation is available for the this Pegasus release:

• Utilities -
A combination of help generally available with the --help option for each command and HTML documentation for most of the tools.
• API and  usage documentation -
See the header files and the HTML  API documentation that is on the web site. The best API usage documentation is the existing utilities and test programs and the examples in the API documentation.  In particular the Common/tests unit tests contain extensive examples of the use of the Common APIs.
• Building and Debugging Providers -
Readme.html in the Pegasus source tree Root Directory, API documentation, and documentation from the Pegasus Technical Workshop which is available on the Pegasus web site.
• Building and Debugging Clients -
API documentation and the documentation on the Pegasus Technical Workshop which is available on the Pegasus web site.
• PEPs -
The features of Pegasus that have been installed in this and the previous few versions are defined by Pegasus PEPs that are available on the OpenPegasus web site.  While these are the original design documents largely and use in the process of defining and approving the overall characteristics of new functionality, they serve as a guide to the design and implementation of these features.

---

Licensed to The Open Group (TOG) under one or more contributor license agreements. Refer to the OpenPegasusNOTICE.txt file distributed with this work for additional information regarding copyright ownership. Each contributor licenses this file to you under the OpenPegasus Open Source License; you may not use this file except in compliance with the License.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.