pegasus/Attic/readme.html - diff

Return to readme.html CVS log

Up to [Pegasus] / pegasus / Attic

Diff for /pegasus/Attic/readme.html between version 1.8 and 1.10.8.1

version 1.8, 2004/12/01 09:51:58

version 1.10.8.1, 2006/03/07 18:45:36

Line 1

//%2006////////////////////////////////////////////////////////////////////////

// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.

// IBM Corp.; EMC Corporation, The Open Group.

// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.

// EMC Corporation; VERITAS Software Corporation; The Open Group.

// EMC Corporation; Symantec Corporation; The Open Group.

// 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.

//==============================================================================

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>

<head>

content="text/html; charset=windows-1252">

<title>OpenPegasus</title>

</head>

<body>

Pegasus Enhancement Proposal (PEP)

PEP #: 235

PEP #: 175

Title: OpenPegasus

Title: OpenPegasus Version 2.4

Version 2.5 Release Readme file

Release Readme file

Version: <span

style="color: rgb(0, 0, 0);">1.4

style="color: rgb(0, 0, 0);">1.4

Created: 24 June 2004

Created: 6 Sept

2005

Authors: Warren Grunbok, Mike

Authors: Warren

Harris

Grunbok

Status:  draft

Version History:

<table bordercolordark="#666666" bordercolorlight="#cccccc"

<table bordercolordark="#666666" bordercolorlight="#cccccc" style="font-family: Arial;"

style="font-family: Arial;" border="1" cellspacing="1" width="100%">

border="1" cellspacing="1" width="100%">

<tbody>

<tr>

<th bgcolor="#cae6ca">Version</th>

Line 41

Line 64

</tr>

<tr>

<td align="center">Warren Grunbok

</td>

<td>Initial draft

</td>

</tr>

<tr>

<td style="vertical-align: top; text-align: center;">1.1

<td align="center">24,August 2004

</td>

<td align="center">Warren Grunbok

<td style="vertical-align: top; text-align: center;"> 13,

Sept 2005

</td>

<td style="vertical-align: top; text-align: center;">Warren

Grunbok/Roger Kumpf

</td>

<td>Mostly spelling changes, adds to very last paragraph

<td style="vertical-align: top; text-align: center;">Updates

based on Architecture team review

</td>

</tr>

<tr>

<td style="vertical-align: top;">1.2

</td>

<td style="vertical-align: top;">31, August 2004

<td style="vertical-align: top;">22, Sept 2005

</td>

<td style="vertical-align: top;">Warren Grunbok

</td>

<td style="vertical-align: top;">Changes based on architecture review.  Removed

<td style="vertical-align: top;">Updates from posted comments to

/Directory structure section and placed into  seperate document.

1.1

</td>

</tr>

<tr>

<td style="vertical-align: top;">1.3

<td style="vertical-align: top; color: rgb(0, 0, 0);">1.3

</td>

<td style="vertical-align: top;">???

<td style="vertical-align: top; color: rgb(0, 0, 0);">22,Sept 2005

</td>

<td style="vertical-align: top;">Warren Grunbok

<td style="vertical-align: top; color: rgb(0, 0, 0);">Warren

Grunbok

</td>

<td style="vertical-align: top;">Removed Pegasus Directory structure and placed in PEP

<td style="vertical-align: top; color: rgb(0, 0, 0);">changed _

191, Added Copyright and End of Doc marker.

to -

</td>

</tr>

<tr>

<td style="vertical-align: top; color: rgb(0, 0, 0);">1.4

<td style="vertical-align: top;">1.4

</td>

<td style="vertical-align: top; color: rgb(0, 0, 0);">27, Sept 2004

<td style="vertical-align: top;">26, Sept 2005

</td>

<td style="vertical-align: top; color: rgb(0, 0, 0);">Warren Grunbok

<td style="vertical-align: top;">Warren Grunbok/Dave Sudlik

</td>

<td style="vertical-align: top; color: rgb(0, 0, 0);">Corrected Security changes as per

<td style="vertical-align: top;">Cleanup on example lists

Sterling.

</td>

</tr>

</tbody>

</table>

<hr>

Abstract:  Installation, build, operation information on

Abstract:  Installation, build, operation information on the Pegasus

the OpenPegasus Version 2.5.0 Release. Note that if this readme

Platform Version 2.4.0 Release. Note that if this readme conflicts with the documentation

conflicts with the documentation in the release notes or interface

in the release notes or interface definition documents for a particular release, those

definition documents for a particular release, those documents should

documents should be considered authorative. This is a simplified overview to act as an

be considered authorative. This is a simplified overview to act as an

introduction to Pegasus.

introduction to OpenPegasus.

<hr>

OpenPegasus - A Manageability

OpenPegasus - A Manageability Services Broker for the

Services Broker for the DMTF CIM/WBEM Standards

DMTF CIM/WBEM Standards

Tagline: OpenPegasus is an object manager for

Tagline: OpenPegasus is an object manager for DMTF CIM objects

DMTF CIM objects written in C++

written in C++ and supported by The Open Group

and hosted by The Open Group

STATUS: Revised Sept 2004 for  Pegasus release version

STATUS: Revised Sept 2005 for  Pegasus release version

2.4.0  - Approved

2.5.0 

- Draft

<a href="#Overview">Overview</a>

Overview</a>

<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"> <a

href="#avail_of_peg">Availability of Pegasus</a>

<a href="#avail_of_peg">Availability of Pegasus</a>

<a href="#peg_maj_comp">Pegasus Major Components</a>

<a href="#avail_of_peg">Availability of Pegasus</a>

<a href="#peg_sup_plat">Pegasus Supported Platforms</a>

<a href="#peg_dep">Pegasus Dependencies</a>

<a href="#peg_dir_struc">The Pegasus Directory Structure</a>

<a href="#peg_dir_struc"></a><a href="#cmnd">Commands</a>

<a href="#dev_with_peg">Development with Pegasus and Pegasus Tools</a>

<a href="#cmnd">Commands</a>

<a href="#docs">Documentation</a>

<a href="#part">Participate</a>

<a href="#part">How to Participate</a>

</blockquote>

<a href="#inst_peg">Install Pegasus</a>

<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"><a

Install Pegasus</a>

href="#download">Download or checkout Pegasus</a>

<a href="#vfy_req_sw">Verify that you have the required

software</a>

<a href="#download">Download or checkout Pegasus</a>

<a href="#vfy_req_sw">Verify that you have the required software</a>

<a href="#set_envt_var">Set the environment variables</a>

<a href="#bld">Build the Pegasus runtime, test files, test clients, and repository</a>

<a href="#bld">Build the Pegasus runtime, test files, test clients,

and repository</a>

<a href="#pop_peg_rep">Populate the Pegasus repository</a>

<a href="#reg_prov">Register providers in the Pegasus environment</a>

<a href="#bld_rpms">Build an RPM for Pegasus</a>

<a href="#note_bld_peg_lnx">Notes

<a href="#note_bld_peg_lnx">Notes about Building Pegasus on Linux</a>

about Building Pegasus on Linux</a>

<a href="#note_bld_peg_mac">Notes about Building Pegasus on Mac OS X</a>

<a href="#note_bld_peg_ssl">Notes on building Pegasus with SSL</a>

<a href="#crt_ssl_cert">Creating SSL certifications</a>

<a href="#bld_peg_win">Building

<a href="#bld_peg_win">Building Pegasus on Windows 2000 or Windows XP With Microsoft

Pegasus on Windows 2000 or Windows XP With Microsoft Visual C++</a>

Visual C++</a>

<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"> <a

<a href="#mu_utility">The MU Utility</a>

href="#mu_utility">The MU Utility</a>

</blockquote>

Test the Pegasus installation</a>

<a href="#inst_peg_html">Installing the Pegasus HTML Test Client</a>

<a href="#test_icu">Testing with ICU enabled</a>

</blockquote>

<a href="#test">Test the Pegasus installation</a>

<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"> <a

href="#test_icu">Testing with ICU enabled</a>

</blockquote>

<hr>

<h1><a name="Overview">Overview</a> </h1>

OpenPegasus (also referred to as Pegasus):

OpenPegasus (also referred to as Pegasus): Pegasus is an open-source CIM Server

Pegasus is an open-source CIM Server for DMTF CIM objects. It is

for DMTF CIM objects. It is written in C++ and includes the Object manager (CIMOM), a set

written

of defined interfaces, an implemenation of the CIMOperations over HTTP operations and

in C++ and includes the Object manager (CIMOM), a set of defined

their cimxml HTTP encodings, and Interface libraries for both client and providers. It is

interfaces, an implementation of the CIMOperations over HTTP operations

maintained consistent with the DMTF CIM and WBEM specifications except for 

and their cimxml HTTP encodings, and Interface libraries

exceptions noted in the documentation.

for both client and providers. It is maintained

consistent with the DMTF CIM and WBEM specifications except for 

Pegasus is open source and is covered under the MIT open-source license.

exceptions

noted in the documentation.

Pegasus is being developed and maintained under the auspices of The Open Group. Pegasus

is maintained under the license defined in the doc directory (LICENSE) of this release.

OpenPegasus includes components for:

This licensing is intended to support as wide a distribution as possible with minimal

<ol>

demands on the users.

<li>DMTF compliant CIMServer that processes CIM operations, CIM

Indications, and

More information on this project, access to the CVS, and documentation on Pegasus are

includes class and instance repositories and interfaces for creating

available from the OpenGroup WEB site.

CIM

Providers and CIM Clients.</li>

<a target="blank" href="http://www.openpegasus.org">http://www.openpegasus.org</a>

<li>Provider interfaces so that providers may be build in multiple

languages (i.e.

There are a number of separate documents representing the status and each release of

C++, C, Java).</li>

Pegasus

<li>A number of CIM providers.</li>

<li>A mof compiler.</li>

<ul>

<li>A number of CIM CLients to provide usage examples, CIMServer

<li>What's new for this release - See the PEPs (Pegasus Enhancement Procedures) release

test functions,

notes on the Pegasus web site and duplicated in the source top level directory </li>

and administration functions.</li>

<li>What's Broken - BUGS - See the ReleaseNotes for this release in the CVS and the web site

<li>More complete information on the exact functions

as a Pegasus PEP.</li>

and their functional state is available from the release notes for each

</ul>

OpenPegasus release.</li>

</ol>

The release notes are available on the WEB site as Pegasus PEP documents and in the CVS

OpenPegasus is open source and is covered under the MIT open-source

for each release.

license.

OpenPegasus is being developed and maintained under the auspices of

The

<tbody>

Open

<tr>

Group.  OpenPegasus is maintained under the license defined in the

<td width="42%">Release</td>

doc

<td width="58%">Release Notes PEP</td>

directory of this release.  The specific file is: <font

</tr>

style="color: rgb(0, 0, 0);">pegasus/doc/license.txt.

<tr>

This licensing is intended to support as

wide a

distribution as possible with minimal demands on the users.

</tr>

<tr>

More information on this project, access to the CVS, and

documentation on

Pegasus are available from the OpenGroup WEB site.

</tr>

<tr>

<a target="blank"

href="http://www.openpegasus.org/">http://www.openpegasus.org</a>

</tr>

<tr>

</tr>

<tr>

<td style="vertical-align: top;">2.4

</td>

<td style="vertical-align: top;">PEP 185

</td>

</tr>

</tbody>

</table>

<h2><a name="avail_of_peg">Availability of Pegasus</a></h2>

Pegasus is distributed as open source under the MIT open-source license. The

distribution is available via CVS and snapshot images in tar and zip file formats on the

<ol>

web site. The source code from CVS can be found at the following Open Group CVS server;

Pegasus can be obtained via any of the following:

<ol>

cvs.opengroup.org:/cvs/MSB

<li>Released tarballs (see <a

href="http://www.openpegasus.org/protected/page.tpl?CALLER=index.tpl&ggid=392">Relase

using the password authenticating server option (pserve).

tarballs link</a>)</li>

<li>CVS (See <a

Anonymous access for read is with the name and password "anon" as follows:

href="http://www.openpegasus.org/protected/page.tpl?CALLER=index.tpl&ggid=667">CVS

code repository</a> for

more information.)</li>

%export

<li>Linux RPMs. See

CVSROOT=:pserver:anon@cvs.opengroup.org:/cvs/MSB

(<a

%cvs login

href="http://www.openpegasus.org/protected/page.tpl?CALLER=index.tpl&ggid=667">RPM

</blockquote>

link</a> for

more information

When requested, enter the password "anon". The source tree is in the

)</li>

directory pegasus. To check out the complete Pegasus source tree just type:

</ol>

cvs co pegasus

NOTE: The Linux RPM reference is for 2.4.1 because that is all we

have. We

A Pegasus directory will be created under the current directory and populated with the

need a general page to get to the RPMs, not one per release.

complete source tree and documentation. To get the latest updates after a checkout just

type this from Pegasus root:

Pegasus is distributed as open source under the MIT open-source

license. The distribution is available via CVS and snapshot images in

cvs update -d

tar and zip file formats on the web site.

The source code from CVS can be found at the following Open Group CVS

Active contributors to Pegasus have write access to the CVS repository. If you are

server;

interested in contributing back to the Pegasus project, (i.e. write (checkin) access to

CVS) please request access from either Martin Kirk (<a

CVS

href="mailto:(k.m.kirk@opengroup.org">m.kirk@opengroup.org</a>) or Karl Schopmeyer <a

write accounts are managed by Martin Kirk of The Open Group

href="mailto:(k.schopmeyer@opengroup.org">k.schopmeyer@opengroup.org</a>.

(<a href="mailto:%28k.m.kirk@opengroup.org">m.kirk@opengroup.org</a>)

<h2><a name="peg_maj_comp">Pegasus Major Components</a></h2>

The major components of Pegasus are:

<ul>

<li>Pegasus Server - WBEM/CIM Server with interfaces for providers and clients </li>

<li>Pegasus Repositories - Today Pegasus provides a defined class repository

interface and a simple file based class repository. It also includes an instance

repository. Note that these repository were created for functionality, not efficieny. It

is expected that they will be replaced with other implementations of the respository

function as the need arises. </li>

<li>Pegasus Client Library - Tools for building Pegasus clients based on the Pegasus

C++ interfaces and using the WBEM HTTP/XML protocols or directly interfacing with Pegasus.

</li>

<li>Pegasus Test Clients - Simple test clients being developed as part of the Pegasus

development process. These can be seen in the src/Clients directory and its subdirectories

</li>

<li>Pegasus HTML Test Client - To aid in testing we created a test client for Pegasus

that uses a WEB server (ex. Apache) with a set of CGI modules and HTML to allow the entry

of Pegasus operations from a WEB browser as forms and the receipt of the response as WEB

pages. This has proven useful as a test tool and can be used for a wide variety of

demonstrations. </li>

<li>Pegasus Provider Library - Tools for building Pegasus providers using the Pegasus

C++ interfaces. </li>

<li>Pegasus Providers - Providers to illustrate the use of Pegasus services including

providers for test and demonstration. </li>

<li>Pegasus Control Providers - Common services for use by other Pegasus components

to extend Pegasus capabilites. </li>

<li>Pegasus MOF Compiler - There  standalone compiler (cimmofl) for MOF files

that can be used to install MOF into the Pegasus schema repository and also to check

syntax. There is also a compiler that operates as a Pegasus client(cimmof) There is also a

tool to extract the MOF from the repository. </li>

</ul>

<h2><a name="peg_sup_plat">Pegasus Supported Platforms</a></h2>

Pegasus is regularly tested against a variety of platforms by the development

group.  The set of platforms and exact set of compilers for any given release is

documented in the Release notes for that release (see the CVS source tree root directory

or the Pegasus PEP defining the ReleaseNotes for any particular release).

Pegasus is supported on a variety of platforms.  The list of platforms can be

found in the release notes associated with this release.

<h2><a name="peg_sup_plat">Pegasus Supported Platforms</a></h2>

Pegasus is regularly tested against a variety of platforms by the

development group.  The results of the nightly tests can be found

here: <a

href="http://cvs.opengroup.org/cgi-bin/pegasus-build-status.cgi">Nightly

test status</a> .  The Release notes provides additional details

regarding the platforms. <a

href="http://www.openpegasus.org/pp/protected/revdoc.tpl?CALLER=revdocuments.tpl&grid=1692">

PEP 230</a> is the release notes PEP for 2.5.

<h2><a name="peg_dep">Pegasus Dependencies</a></h2>

We have worked to minimize the dependence of Pegasus on other software packages and

We have worked to minimize the dependence of Pegasus on other software

tools. Currently Pegasus has the following dependencies:

packages and tools. Currently Pegasus has the following dependencies:

1. GNUMAKE - To simplify the building of Pegasus across multiple platforms we

1. GNUMAKE - To simplify the building of Pegasus across

have standardized on a set of build tools including: GNUMAKE. We are using GNUMAKE 3.79.1

multiple platforms we

successfully both in Windows and Linux environments.

have standardized on a set of build tools including: GNUMAKE. We are

using GNUMAKE 3.79.1 successfully both in Windows and Linux

environments.

GNUMAKE is available from :

<a target="blank"

href="http://www.gnu.org/">http://www.gnu.org</a>

2. FLEX and BISON - These tools were used to develop the

NOTE: A set of the required tools for windows

MOF

platforms is available on the openpegasus web site.  <a href="www.openpegasus.org">www.openpegasus.org</a>

compiler and WQL

parser.  <font

style="color: rgb(0, 0, 0);">These tools are required only for

2. MU.EXE - To minimize the difference between Linux and Windows for GNUMAKE, we

development of the parsers, not for building Pegasus.

have created a utility called MU.exe. This utility is required for Pegasus make with ONLY

3. DOC++ - The Pegasus documentation is taken from a

Windows environment. It is provided as an alternative to requiring a number of UNIX

combination of text files

utilities (SH, RM, etc.) on the windows platform and effectively provides the functions of

and the Pegasus header files themselves. This documentation is

these utilities that GNUMAKE needs. MU is not required on UNIX or LINUX platforms.

formatted with DOC++ and GAWK.   <font

style="color: rgb(0, 0, 0);">These tools are required to build the

NOTE: The binary for MU.EXE is not distributed in the Pegasus bin directory. You must

interface documentation set.

build it separately. MU source code is part of the distribution in the directory

src/utils/MU with its own make file. You must compile MU before you initiate the Pegausu

4. ICU Internationalization libraries - These libraries are

make.

used as the basis for message catalogs for message

internationalization. See the ICU website

NOTE: A copy of the binary is made available as a zip file on the Pegasus WEB site.

(http://oss.software.ibm.com/icu/) for more information on these

libraries

Again, MU is used ONLY if you are using Windows.

5. OpenSSL - If it

is intended to use SSL on the

3. FLEX and BISON - These tools were used to develop the MOF compiler and WQL

communication protocol, the OpenSSL libraries are required.

parser. Anybody intending to recompile the compiler or parser from scratch will be

required to have these tools. They are only required if changes need to be made to the

NOTE: A set of the required

files for parsing and compiling.

tools for windows platforms is available on the openpegasus web

site.  <a href="../Pegasus24/www.openpegasus.org">www.openpegasus.org</a>

4. DLCOMPAT - dlcompat is a dlopen(3) et.al. compatibility library for Mac OS

X/Darwin.

NOTE:  The dlcompat is not distributed with pegasus source.

dlcomapt is avilable from

<a href="http://www.opendarwin.org/projects/dlcompat/">http://www.opendarwin.org/projects/dlcompat/

</a>

Again, dlcomapt needs to be installed ONLY if you are using Mac OS X/Darwin.

5. DOC++ - The Pegasus documentation is taken from a combination of text files

and the Pegasus header files themselves. This documentation is formatted with DOC++ and

GAWK. These tools are required if the documentation is to be recreated but we expect that

only the core team will be recreating documentation.

6. ICU Internationalization libraries - These libraries are used as the basis

for message catalogs for message internationalization. See the ICU website

(http://oss.software.ibm.com/icu/) for more information on these libraries

7. OpenSSL - If it is intended to use SSL on the communication

protocol, the OpenSSL libraries are required.

<h1><a name="peg_dir_struc">The Pegasus Directory Structure</a></h1>

Pegasus is distributed as a complete source directory structure that should be

installed either from one of the snapshots or from CVS.

The Pegasus Directory is documented in <span

style="color: rgb(0, 0, 0);">PEP 191 and listed in the Pegasus /doc

directory.

<h1><a name="dev_with_peg">Development with Pegasus and Pegasus Tools</a></h1>

ATTN: This section needs to be completed. It should reference the more complete

documentation.

<h1><a name="cmnd">Commands</a></h1>

The manpages for each of the commands are in rpm/manLinux/man1.Z directory (on CVS)

The manpages for each of the commands are in rpm/manLinux/man1.Z

directory (on CVS)

To see simple help for each of the commands, use the "-h" flag.

To see simple help for each of the commands, use the "--help" flag.

Here is a list of useful

commands:

<pre>Examples:

bin/cimserver s (Shuts it down)

<span

bin/cimserver traceLevel=4 traceComponents=ALL (starts server with config flags)

style="font-family: times new roman; font-weight: bold;"><span

bin/cimprovider l s (lists providers and their status)

class="norm">Some of

bin/cimprovider e m OperatingSystemModule (enables the OperatingSystem provider)

the basic commands:

bin/cimuser a u guest w ThePassword

bin/cimuser l (lists the users)

NOTE: Refer to the admin guide in pegasus/doc/Admin_Guide_Release.pdf

bin/tomof CIM_Config (extract CIM_Config from repository and present it in MOF type)

for

</pre>

more information about administering the Pegasus CIMServer.

</blockquote>

<h1><a name="docs">Pegasus Documentation</a></h1>

The documentation is currently in preparation.  Much of Pegasus is documented in

the PEGASUS PEPs which are the basis for approval of Pegasus functionality, changes,

plans, etc.  These documents are openly available on the PEGASUS web site.  The

preliminary documentation is not provided with this release. The current documentation is

maintained both as a manual created under the tool DOC++ in the runtime subdirectory

manual/html (see doc/devManual to create), as an api document also creatable from the

source tree (see doc/apidoc) and as other miscellaneous documentation in the doc

directory. Also there is a set of release notes. Normally the release notes for the

current release are available in the root source directory of CVS.

Note that the Pegasus WEB site at The Open Group will be the source of most

documentation in the future and today is the source of most discussion and design

documentation.

<h1><a name="part">Participate!</a></h1>

We are looking for people who want to join the Pegasus work group and contribute to

effort of getting this Pegasus off the ground. Please join the mailing list by visiting

www.openpegasus.org, and click on Mailing Lists.

<h1><a name="inst_peg">Install Pegasus</a> </h1>

You can install and run Pegasus on any of the supported platforms. The installation

process includes the following steps:

<ol>

<li>Download or checkout Pegasus. </li>

<li>Verify that you have the required software. </li>

<li>Set environment variables. </li>

<li>Build the Pegasus runtime, test files, test clients and repository. </li>

</ol>

<a name="download">Step 1: Download or checkout Pegasus</a>

Pegasus is freely available from the open group's Pegasus home page: <a target="blank"

href="http://www.openpegasus.org">http://www.openpegasus.org</a>. To obtain Pegasus, you

can either check it out using CVS or download a snapshot image of the soruce distribution.

For more information about checking out Pegasus using CVS, see: <a href="#avail_of_peg">Availability

of Pegasus</a>.

Pegasus is not currently releasing binaries, but you can create RPMs using a script

included with the source distribution. See <a href="#bld_rpms">Building RPMs for Pegasus</a>

for more information.

<a name="vfy_req_sw">Step 2: Verify that you have the required software</a>

Refer to the section <a href="#peg_dep">Pegasus Dependencies</a> and verify that you

have the software required for your Operating System and planned usage of Pegasus.

<a name="set_envt_var">Step 3: Set the environment variables</a>

Before installing or running Pegasus, ensure that the following environment variables

have been defined or updated:

<dl>

<dt>PEGASUS_ROOT </dt>

<dd>Defines the path to the "pegasus" directory you've pulled from CVS, for

example: <tt>/opt/pegasus/pegasus-2.3.2</tt>

</dd>

<dt>PEGASUS_HOME </dt>

<dd>Defines the directory that will contain the output binary files. For example, if you set

this to <tt>$HOME/pegasus_home</tt>, then the output will go into <tt>$HOME/pegasus_home/bin</tt>

and <tt>$HOME/pegasus_home/lib.</tt>

If you plan on doing parallel builds, you may want to define a unique PEGASUS_HOME value

for each build you need, that way the output of each build will be placed in its own

directory, for example: <tt>$HOME/pegasus_home_LINUX_IX86_GNU.</tt>

</dd>

<dt>PEGASUS_PLATFORM </dt>

<dd>Identifies the platform to be built. Each supported platform has a unique identifier

with the following form:

<tt><Operating-System>_<Architecture>_<Compiler></tt> The following

values are tested for the OpenPegasus release:

<ul>

<li>AIX_RS_IBMCXX </li>

<li>HPUX_PARISC_ACC </li>

<li>LINUX_IA64_GNU </li>

<li>LINUX_IX86_GNU </li>

<li>LINUX_PPC_GNU </li>

<li>LINUX_ZSERIES_GNU </li>

<li>NSK_NONSTOP_NMCPLUS </li>

<li>SOLARIS_SPARC_CC </li>

<li>SOLARIS_SPARC_GNU </li>

<li>TRU64_ALPHA_DECCXX </li>

<li>ZOS_ZSERIES_IBM</li>

<li>DARWIN_PPC_GNU </li>

</ul>

</dd>

<dd>Add $PEGASUS_HOME/bin to your path.</dd>

</dl>

Additional configuration:

<ul>

<li>For Unix builds, place $PEGASUS_HOME/lib on your LD_LIBRARY_PATH. </li>

<li>cimserver daemon=true  (Start the server

<li>For RedHat/SuSE/UL, edit /etc/ld.so.conf and add $PEGASUS_HOME/lib.</li>

cimserver)</li>

</ul>

<li>cimserver -s  (Shuts down the cimserver)</li>

<li>cimserver traceLevel=4 traceComponents=ALL  (Starts server

<a name="bld">Step 4: Build the Pegasus runtime, test files, test clients and

with

repository</a>

config flags)</li>

<li>cimprovider -l -s  (Lists providers and their status)</li>

Pegasus includes several make files that enable you to quickly build or refresh the

<li>cimprovider -e -m OperatingSystemModule  (Enables the

Pegasus runtime, test files, test client and the repository. To use these make files, type

OperatingSystem provider)</li>

"make" followed by one of the supplied targets.

<li>cimuser -a -u guest _w <ThePassword> (Adds the user <span

style="font-style: italic;">guest with specified password)

To build Pegasus, run the following commands from the root directory of the Pegasus

distribution:

<ol>

<li>Enter <tt>make</tt> This builds all of Pegasus.

</li>

<li>Enter <tt>make repository</tt> This creates the repository, which is needed to serve

data. To create the additional namespaces that represent the test support you can also

execute "make testrepository".

</li>

<li>Enter <tt>make tests</tt> This executes all the tests included with the Pegasus

<li>cimuser -l  (Lists the users )

distribution, except the client/server tests. The client/server tests are executed

separately from the above because they require the initiation of separate process for the

Pegasus server and Pegasus client. To execute these tests, refer to the scripts in

pegasus/mak/BuildMakefile. Refer to the prestarttests and poststarttests in this file.

</li>

</ol>

</ul>

Note:  there are some differences between windows and other

The following make targets are supported:

platforms in

starting the server as a daemon/service. Whereas most supported

platforms use

the configuration option daemon to start the server as a service, on

windows it

must be specifically installed as a service (ex. cimserver -install)

and then

started as a service (cimserver -start). The cimserver --h option

explains the

exact format of the start and stop options.<br

style="color: rgb(0, 0, 0);">

<br

style="color: rgb(0, 0, 0); font-weight: bold;">

Makefile commands

Pegasus includes several make files that enable

you to quickly build or

refresh the Pegasus runtime, test files, test client and the

repository. To use these make files, type "make" followed by one of the

supplied targets.

The following list contains some of the make targets that are

supported:

<ul>

<li><default> - Build everything. </li>

<li>clean - Clean out all objects, libs, and executables. </li>

Line 544

Line 371

<li>rebuild - clean, depend, <default> </li>

<li>world - depend, <default> </li>

</ul>

<span

Generally the build commands are as follows:

style="color: rgb(0, 0, 0); font-weight: bold;"><span

style="color: rgb(0, 0, 0);">For a comprehensive list of  the

<ol>

make targets, refer to the make files.

<li>There is a Makefile in the Pegasus root directory. Simply executing make in the Pegasus

root directory will make everything. "make rebuild" will clean and rebuild

TestMakefile

everything. The "make rebuild" will also populate the repository with the

commands

current CIM Schemas. </li>

<li>To test a fresh release, go to the pegasus root and type "make

<font

world".  This will build dependencies, build binaries, and then run all

color="RED"> TestMakefile is a

tests except the Client/Server tests. </li>

make file

<li>To execute the basic test suite that is shipped with pegasus type  "make

that in the top level Pegasus source directory that defines

tests". This also reinstalls the repository.  Running "make -s tests"

functionality to

suppresses extraneous output such as the enter/leave directory messages. </li>

initiate the Pegasus tests. The targets defined in this makefile allow

<li>"make clean" removes all object and library files from the structure. </li>

the

<li>A new build system has been added to Pegasus where a new CVS checkout is done, built,

user to run the various tests and test suites that are included in the

and tests are run. Do it by: "make -f mak/BuildMakefile cleanbuild" </li>

Pegasus

</ol>

source package.

Example:

From the $PEGASUS_ROOT directory.

make -f TestMakefile [testoption]

## rebuild -

Rebuild

## build - Build

## prestarttests - Execute

functional tests

## poststarttests - Execute

poststarttests (No security, No SSL)

## tests - Execute prestarttests and

poststarttests

## standardtests - Execute

poststarttests and a series of

## posstarttests using multiple

options.

##

Some examples:

make -f TestMakefile prestarttests

- runs the unit tests, builds

the repositories.

make -f TestMakefile poststarttests

- starts the server, runs

the poststarttest suites

(make poststarttests plus

more)

make -f TestMakefile tests -

combines prestarttests and

poststarttests

make -f TestMakefile standardtests -

runs the basic poststarttests (make

poststarttests) multiple

times with various options.

BuildMakefile

commands

Some examples:<br

style="color: rgb(0, 0, 0);">

make -f pegasus/mak/BuildMakefile

cleanbuild - Remove the existing pegasus <span

style="color: rgb(0, 0, 0);">directory, perform a CVS

checkout of the pegasus

source,

build, and run tests.

make -f pegasus/mak/BuildMakefile

removeall

- Remove the existing pegasus

directory.

<span

style="color: rgb(0, 0, 0);">make

-f pegasus/mak/BuildMakefile

recheckout - Remove the existing pegasus

directory and perform a CVS

checkout of the pegasus

source.

The following sequence builds the

tree, the repository, the testrepository,

starts the server and runs

the server tests suites.

make world

make testrepository

make -f TestMakefile poststarttests

<h1><a name="docs">Pegasus Documentation</a></h1>

The documentation is currently in preparation.  Much of Pegasus

is documented in the PEGASUS PEPs which are the basis for approval of

Pegasus functionality, changes, plans, etc.  These documents are

openly available on the PEGASUS web site.  The preliminary

documentation

is not provided with this release. The current documentation is

maintained both as a manual created

under the tool DOC++ in the runtime subdirectory manual/html (see

doc/devManual to create), as an api document also creatable from the

source tree (see doc/apidoc) and as other miscellaneous documentation

in the doc directory. Also there is a set of release notes. Normally

the release notes for the current release are available in the root

source directory of CVS.

Note that the Pegasus WEB site at The Open Group will be the source

of most

documentation in the future and today is the source of most discussion

and

design documentation.

<h1><a name="part">How to Participate</a></h1>

Contributors

are welcome to participate in the OpenPegasus development effort. Join

the mailing list by visiting www.openpegasus.org and clicking on

Mailing Lists.

<h1>

<a name="inst_peg">Pegasus Install</a> </h1>

RPM installation instructions can be found here: <a

href="http://www.openpegasus.org/pr/">http://www.openpegasus.org/pr</a>

Verify  Dependencies

Before

you install Pegasus be sure you have the proper set of  software

Pegasus is dependent on.  <a href="#peg_dep">See Dependencies

section.</a>

<a name="set_envt_var">Set the environment

variables

</a>

Before installing or running OpenPegasus, environment variables may

have to be defined or updated.

<a

href="http://www.openpegasus.org/pp/uploads/40/8502/PEP200_RecommendedReleaseOptions.htm">PEP

200</a> contains the list of environment variables and setup necessary

to use OpenPegasus.

<ul>

</ul>

<h2><a name="pop_peg_rep">Populate the Pegasus repository</a> </h2>

Before using Pegasus you must populate the repository. Typically, this is done during

Before using Pegasus you must populate the repository. Typically, this

the buld process when you run the makefile. However, you can also do it manually after the

is done during the build process when you run the makefile. However,

Pegasus has been built.

you

can also do it manually after the Pegasus has been built.

<ol>

<li>Register the MOF (Managed Object Format) file describing the skeleton of the object. </li>

<li>Register the MOF (Managed Object Format) file describing the

<li>Register a second MOF which only points out which lib*.so file to be loaded when a

skeleton of the object. </li>

specific object is activated. </li>

<li>Register a second MOF which only points out which lib*.so file to

be loaded when a specific object is activated. </li>

</ol>

The providers included with Pegasus are automatically entered into the repository by

running the following command: <tt>make repository</tt>

The providers included with Pegasus are automatically entered into the

repository

The 'make repository' in pegasus/Schemas does three things:

by running the following command: <tt>make repository</tt>

<ul>

<li>Generates the CIM Schema v2.8 in the repository (skeleton of CIM objects). To do this,

The 'make repository' in the  pegasus directory does three things:

it runs the MOF compiler on the CIM schema: <tt>cimmofl -Schema v2.8</tt> </li>

<li>Sets up operations (shutdown, add users, etc) and CIM indications (SNMP, Events, Alert,

Threshold, etc) internal to the Pegasus schema by running the following command: <tt>cimmofl

-PG_InterOp</tt> </li>

<li>Registers included CIM Providers (libOSProvider.so, libDNSProvider.so, ) in

Pegasus (which are located in src/Providers) by running: <tt>cimmofl -PG_ManagedSystem</tt>

</li>

</ul>

<h2><a name="reg_prov">Registering Providers in the Pegasus Environment</a></h2>

Pegasus registers providers with a set of provider registration classes, not using the

provider qualifier as is done in most DMTF CIM CIMOM implementations today. This set of

classes is close to but not exactly the same as the current DMTF definition (See the DMTF

Interop schema, experimental versions starting with 2.6). This will be harmonized in the

future when the DMTF scheme is moved to final status.

Registration is performed by defining a MOF for the instances of the registration

classes that represent the porvider module, providers, classes, etc. to be

registered.  The easiest way to create a new registration today is to copy from one

of the existing registration MOFs.  See the providers/sample/load directory for

examples of several registration instance implementations that do work with Pegasus today.

<h2><a name="bld_rpms">Building RPMs for Pegasus</a> </h2>

The source distribution includes a script you can use to create an RPM for Pegasus. To

do this, your environment must meet the following requirements:

<ul>

<li>The root directory for Pegasus must be "/Pegasus-1.0" </li>

<li> Removes the existing repository if one

<li>Your environment variables must be set, as described in <a href="#set_envt_var">Set

exists.</li>

evironment variables</a>. </li>

<li>Generates the CIM Schema v2.9 in the repository (skeleton of CIM

<li>You must be logged in as the root user.</li>

objects).  </li>

<li>Loads

schema for CIM Server functions (shutdown, add users, etc) and

CIM indications

(SNMP, Events, Alert, Threshold, etc)

internal to the Pegasus. </li>

<li>Registers included CIM Providers (libOSProvider.so,

libDNSProvider.so, � ) in Pegasus (which are located in

src/Providers)  </li>

</ul>

<h2>

To create the RPMs, run the script <tt>rpmBuild</tt> from the root directory of the

<a name="reg_prov">Registering

source distribution. For example: <tt>. /usr/source/pegasus-1.0/rpmBuild</tt>

Providers in the Pegasus Environment</a></h2>

This will result in and RPM file names <tt>pegasus<version number>.rpm</tt>.

Pegasus registers providers with a set of provider registration

classes, not using the provider qualifier as is done in most DMTF CIM

Note: After you install using the install using the PRM, you must

CIMOM implementations today. This set of classes is close to but not

crate and populate teh repository manually.

exactly the same as the experimental DMTF definition (See the DMTF

Interop

schema, experimental versions starting with 2.6). This will be

Question: I'm still working on this procedure (I haven't gotten it to work yet).

harmonized in the future when the DMTF scheme is moved to final

status.

Registration

is performed by creating instances of the

registration classes that represent the provider module, providers,

classes, etc. to be registered.  The easiest way to create a new

registration today is to copy from one of the existing registration

MOFs.  See the providers/sample/load directory for examples of

several registration instance implementations that do work with

OpenPegasus

today.

<h2><a name="note_bld_peg_lnx">Notes about

Building OpenPegasus on Linux </a></h2>

To build OpenPegasus on Linux, ensure that you you have the environment

variables set (PEGASUS_HOME, PEGASUS_ROOT, PEGASUS_PLATFORM.  For

32 bit linux, the definition of PEGASUS_PLATFORM is normally

LINUX_IX86_GNU).

<h2><a name="bld_peg_win">Notes

on building OpenPegasus on Windows 2k or Windows XP with Microsoft

<h2><a name="note_bld_peg_lnx">Notes about Building Pegasus on Linux </a></h2>

Visual

C++ </a></h2>

Pegasus supports many distributions of Linux. Refer to <a href="#peg_sup_plat">Pegasus

Supported Platforms</a> for more information.

Use of Windows 2000 SP3 or later is recommended.  OpenPegasus is

regularly tested on both Windows 2000 and Windows XP using the

To build Pegasus on Linux, ensure that you you have the environment variables set

Microsoft compilers.

(PEGASUS_HOME, PEGASUS_ROOT, PEGASUS_PLATFORM.  For 32 bit linux, the definition of

Today we build OpenPegasus on Windows using a set of make files

PEGASUS_PLATFORM is normally LINUX_IX86_GNU.

contained

in the source distribution, the Microsoft compilers (DevStudio 5.x is

not supported, Visual Studio 6.0, SP5 is supported) and the GNUMAKE

make utility.  Note that you MUST have the OpenPegasus <a

href="#mu_utility">mu.exe </a>utility compiled and available

<h2><a name="bld_peg_win">Notes on building Pegasus on Windows 2k or Windows XP with

before trying to compile OpenPegasus on the normal windows platform.

Microsoft Visual C++ </a></h2>

The

following is the basic setup steps for the environment.

Use of Windows 2000 SP3 or later is recommended.  Pegasus is regularly tested on

both Windows 2000 and Windows XP using the Microsoft compilers.

Setup the environment variables and path for the Micrososft Visual C

compiler.

Today we build Pegasus on Windows using a set of make files contained in the source

Typically this can be done by running the VCVARS32.BAT file supplied

distribution, the Microsoft compilers (DevStudio 5.x is not supported, Visual Studio 6.0,

with Microsoft Visual C++. (contained in the same directory as cl.exe).

SP5 is supported) and the GNUMAKE make utility.  Note that you MUST have the Pegasus <a

href="#mu_utility">mu.exe </a>utility compiled and available before trying to compile

Pegasus on the normal windows platform. The following is the basic setup steps for the

environment.

Setup the environment variables and path for the Micrososft Visual C compiler.

Typically this can be done by running the VCVARS32.BAT file supplied with Microsoft Visual

C++. (contained in the same directory as cl.exe).

For Windows, try the following for an example environment:

<pre>REM call the standard Microsoft .bat for VC 6 setup.

<pre>REM call the standard Microsoft .bat for VC 6 setup. call 'C:/Program Files\Microsoft Visual Studio\VC98\Bin\Vcvars32.bat' REM Set debug to something if you want compile in debug mode set PEGASUS_DEBUG=true REM set PEGASUS_ROOT to top of source tree set PEGASUS_ROOT=C:/cimom/pegasus (Note: <span

call 'C:/Program Files\Microsoft Visual Studio\VC98\Bin\Vcvars32.bat'

class="norm">The '/' characters are intentional and required by the OpenPegasus build system) REM set PEGASUS_HOME to where you want repository and executables set PEGASUS_HOME=%PEGASUS_ROOT% REM setup the path to the runtime files. set path=%path%;%PEGASUS_HOME%\bin </pre>

REM Set debug to something if you want compile in debug mode

set PEGASUS_DEBUG=true

REM set PEGASUS_ROOT to top of source tree

set PEGASUS_ROOT=C:/cimom/pegasus (Note: <span

class="norm">The '/' characters are intentional and required by the Pegasus build system)

REM set PEGASUS_HOME to where you want repository and executables

set PEGASUS_HOME=%PEGASUS_ROOT%

REM setup the path to the runtime files.

set path=%path%;%PEGASUS_HOME%\bin

</pre>

</blockquote>

<h3>

<h3><a name="mu_utility">The MU Utility </a></h3>

<a name="mu_utility">The MU Utility </a></h3>

In order to provide a consistent build structure across multiple platforms, we

In order to provide a consistent build structure across multiple

developed a small utility to provide a consistent set of small utilities across these

platforms, we

platforms. The MU utilityis a simple utility that contains many commands. For example:

developed a small utility to provide a consistent set of small

utilities

C:\> mu rm myfile.cpp yourfile.cpp

across these platforms. The MU utility is a simple utility that

contains

You may type "mu" to get a list of valid commands. Here are some of them:

many

commands. For example:

rm, rmdirhier, mkdirhier, echo, touch, pwd, copy, move, compare

depend

C:\> mu rm myfile.cpp yourfile.cpp

The MU utility supports globing (expansion of wildcards) so you can do things like

this:

You may type "mu" to get a list of valid commands. Here are some

of them:

C:\> mu rm *.obj *.exe

MU is required to build under the Windows environment. MU is available as part of the

rm, rmdirhier, mkdirhier, echo, touch, pwd, copy, move, compare depend

distribution of Pegasus.

The MU utility supports globing (expansion of wildcards) so

you can do things like this:

<h2><a name="note_bld_peg_mac">Notes about Building Pegasus on Mac OS X </a></h2>

No problem. Just make sure you have the environment variables set (PEASUS_HOME,

C:\> mu rm *.obj *.exe

PEGASUS_ROOT, PEGASUS_PLATFORM. For Mac OS X/Darwin, the defination of PEGASUS_PLATFORM is

DARWIN_PPC_GNU.

MU is required to build under the Windows environment. MU is

available as part

<h2>

of the distribution of OpenPegasus.

<a name="note_bld_peg_ssl">Notes about Building Pegasus with SSL </a></h2>

NOTE: The binary for MU.EXE is not distributed in the OpenPegasus bin

To build with SSL you need the OpenSSL libraries and header files. They are NOT

directory.

distributed with Pegasus. Make sure you have them in a standard directory so Pegasus can

You must build it separately. MU source code is part of the

find them. If that's not the case, set the environment variable OPENSSL_HOME= to point

distribution

where your OpenSSL installation is.

in the directory src/utils/MU with its own make file. You must compile

Also have the PEGASUS_HAS_SSL=yes variable set. Then just run 'make' in Pegasus

before you initiate the OpenPegasus make.

directory and you will have Pegasus with SSL enabled. See "Creating SSL

A copy of the binary is made available as a zip file on the OpenPegasus

certificates" below for more information on how to use SSL.

WEB site.

<h3><a name="crt_ssl_cert">Creating SSL certifications </a></h3>

<h2><a name="note_bld_peg_ssl">Notes about

Building OpenPegasus with SSL

Type these commands in your shell to create the SSL certifications. The PEGASUS_ROOT

</a></h2>

and PEGASUS_HOME have to be set to your respective installation and source directory.

Set the sslKeyFilePath to key.pem.  Set the

To build with SSL you need the OpenSSL libraries and header files. They

sslCertificateFilePath to cert.pem.  To create a client truststore to validate the

are NOT distributed with OpenPegasus. Make sure you have them in a

server against, copy the server's certificate into the client truststore, client.pem.

standard

directory so OpenPegasus can find them. If that's not

the case, set the environment variable OPENSSL_HOME= to point where

<pre

your OpenSSL

style="font-style: italic; font-family: courier new,courier,monospace; margin-left: 40px;">CN="Common Name"

installation is.

EMAIL="test@email.address"

HOSTNAME=`uname -n`

Also have the PEGASUS_HAS_SSL=yes variable set. Then just run 'make'

sed -e "s/$CN/$HOSTNAME/" \

in Pegasus

-e "s/$EMAIL/root@$HOSTNAME/" $PEGASUS_ROOT/ssl.cnf \

directory and you will have OpenPegasus with SSL enabled. See "Creating

> $PEGASUS_HOME/ssl.cnf

SSL

chmod 644 $PEGASUS_HOME/ssl.cnf

certificates" below for more information on how to use SSL.

chown bin $PEGASUS_HOME/ssl.cnf

chgrp bin $PEGASUS_HOME/ssl.cnf

Refer to the SSL Admin guide found in the doc directory for details on

using OpenPegasus with SSL.

/usr/bin/openssl req -x509 -days 365 -newkey rsa:512 \

-nodes -config $PEGASUS_HOME/ssl.cnf \

<h1>

-keyout $PEGASUS_HOME/key.pem -out $PEGASUS_HOME/cert.pem

<a name="test">Testing a OpenPegasus Installation</a></h1>

cp $PEGASUS_HOME/cert.pem $PEGASUS_HOME/client.pem</pre>

OpenPegasus includes an extensive set of test facilities as part of the

CVS

Note:  key.pem is sslKeyFilePath. cert.pem is

environment, including:

sslCertificateFilePath

<h1><a name="test">Testing a Pegasus Installation</a></h1>

Pegasus includes an extensive set of test facilities as part of the CVS enviroment,

including:

<ul>

<li>Test Clients - There are several clients that have been built specifically to

<li>Test Clients - There are several clients that have been

test Pegasus, or parts of Pegasus, including TestClient, Client, CLI, ipinfo, osinfo,

built specifically to test OpenPegasus, or parts of OpenPegasus,

WbemEsec, etc. See the src/Clients directory for more information. These programs require

including

a server complete with repository to be running.  Note that some of these tests use

TestClient, Client, CLI, ipinfo, osinfo, WbemEsec, etc. See the

classes and instances that are only installed with the "make testrepository"

src/Clients directory for more information. These programs require a

functions including test namespaces and extra classes and instances in those namespaces

server complete with repository to be running.  Note that some of

and additional providers from the providers/sample and proviers/testproviders directories.

these tests use classes and instances that are only installed with the

</li>

"make testrepository" functions including test namespaces and extra

<li>Sample and test providers -  Test providers exist for the major provider

classes and instances in those namespaces and additional providers from

types in the providers/sample directories and the providers/testProviders directory </li>

the providers/sample and providers/testproviders directories. </li>

<li>Unit Tests - Most Pegasus functions include unit tests for the functions.

<li>Sample and test providers -  Test providers exist for

These are normally executed with the "make tests" command which can be executed

the major provider types in the providers/sample directories and the

at many different levels of the source tree from the top level to execute all of the unit

providers/testProviders directory </li>

tests to individual directories.  Usually the unit test functions can be found in

<li>Unit Tests - Most OpenPegasus functions include unit tests

test directories immediately below their corresponding source code (i.e  common/tests

for

is the unit test functions for the common directory). Unit tests are executed without the

the functions.  These are normally executed with the "make tests"

server being operational and normally do not require the existence of a Class repository. </li>

command which can be executed at many different levels of the source

<li>An end-to-end Test Suite - the directory "test" contains a set of

tree from the top level to execute all of the unit tests to individual

operations tests that cover the major CIM operations.  See the make file TestMakefile

directories.  Usually the unit test functions can be found in test

in the PEGASUS_ROOT directory to execute these tests.  This set of tests executes an

directories immediately below their corresponding source code

extensive set of fixed tests and compares the results against predefined results.</li>

(i.e  common/tests is the unit test functions for the common

directory). Unit tests are executed without the server being

operational and normally do not require the existence of a Class

repository. </li>

<li>An end-to-end Test Suite - the directory "test" contains a

set of operations tests that cover the major CIM operations.  See

the make file TestMakefile in the PEGASUS_ROOT directory to execute

these tests.  This set of tests executes an extensive set of fixed

tests and compares the results against predefined results.</li>

</ul>

<h2><a name="inst_peg_html">Installing the Pegasus HTML Test Client</a></h2>

This is a separate test tool that allows Pegasus requests to be initiated from any WEB

browser and that uses a WEB browser, CGI scripts and HTML pages for the formatting and

connections. It requires a WEB server, etc. The instructions for setting up this

environment are maintained in a separate readme in the CGI directory.

<h2><a name="test_icu">Testing with ICU enabled</a></h2>

ICU (International Components for Unicode) refers to the set of

ICU (International Components for Unicode) refers to the set of libraries that Pegasus

libraries that OpenPegasus uses to run globalized. For example: these

uses to run globalized. For example: these libraries are used to load messages in

libraries are used

different languages, format currency and numbers according to a specific locale etc. In

order to enable globalization in Pegasus, Pegasus must be built with ICU enabled, ie. the

load messages in different languages, format currency and numbers

right environment variables must be set prior to running "make". Refer to the

according to

GlobalizationHOWTO.htm in the docs directory for details.

a specific locale etc. In order to enable globalization in OpenPegasus,

OpenPegasus

must be built with ICU enabled, ie. the right environment variables

When users run "make poststarttests" to verify the integrity of a

must be

Pegasus download, a series of tests are run that require the cimserver to be running.

set prior to running "make". Refer to the GlobalizationHOWTO.htm in the

These tests currently depend on specific messages returned from the server. When ICU is

docs

enabled, all messages come from the resource bundles and these usually do not match the

directory for details.

hardcoded default messages within Pegasus. These hardcoded default messages are what the

various test programs expect in order to complete successfully. If the ICU enabled server

When users run "make poststarttests"

is started without disabling message loading from the bundles, "make

to verify the integrity of a OpenPegasus download, a series of tests

poststartests" will fail. In order to run "make poststarttests"

are

successfully with ICU enabled, an environment variable called PEGASUS_USE_DEFAULT_MESSAGES

run that

must exist prior to starting the server. Once this is defined, when the cimserver starts,

require the cimserver to be running. These tests currently depend on

all messages generated will be the default hardcoded messages. This will enable "make

specific

poststarttests" to complete successfully. Once "make poststarttests" is

messages returned from the server. When ICU is enabled, all messages

complete, you should stop the cimserver and then undefine PEGASUS_USE_DEFAULT_MESSAGES. If

come from the resource bundles and these usually do not match the

this variable is left defined, Pegasus will not be able to load messages using ICU

hardcoded default messages within OpenPegasus. These hardcoded default

resource bundles.

messages are what the various test programs expect in order to complete

successfully. If the ICU enabled server is started without

disabling message loading from the bundles, "make poststartests" will

When running the make

fail.

tests command with ICU enabled, the PEGASUS_MSG_HOME environment variable must be set to

In order to run "make poststarttests" successfully with ICU enabled, an

the home directory where the ICU resource bundles are built. By default the resource

environment variable called PEGASUS_USE_DEFAULT_MESSAGES must exist

bundles are built into directories below PEGASUS_HOME/msg, so that should be the setting

prior to

starting the server. Once this is defined, when the cimserver starts,

all

messages generated will be the default hardcoded messages. This will

enable

"make poststarttests" to complete successfully. Once "make

poststarttests" is

complete, you should stop the cimserver and then undefine

PEGASUS_USE_DEFAULT_MESSAGES. If this variable is left defined,

OpenPegasus

will not be able to load messages

using ICU resource bundles.

When

running the make tests command with ICU enabled, the PEGASUS_MSG_HOME

environment variable must be set to the home directory where the ICU

resource bundles are built. By default the resource bundles are built

into directories below PEGASUS_HOME/msg, so that should be the setting

for PEGASUS_MSG_HOME.

-------------------------------------------------------------------------------------------------------------------------------------

Hewlett-Packard Development Company, L.P.; IBM Corp.; The Open Group;

Company, L.P.; IBM Corp.; The Open Group; VERITAS Software Corporation

VERITAS Software Corporation

Permission is hereby granted, free of charge, to any person obtaining a

Permission is hereby granted, free of charge, to any

copy  of this software and associated documentation files (the "Software"),

person obtaining a copy  of this software and associated

to deal in the Software without restriction, including without limitation the rights to

documentation files (the "Software"), to deal in the Software without

use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the

restriction, including without limitation the rights to use, copy,

Software, and to permit persons to whom the Software is furnished to do so, subject to the

modify, merge, publish, distribute, sublicense, and/or sell copies of

following conditions:

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

THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE

PROVIDED  "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,

SHALL BE INCLUDED IN ALL COPIES OR SUBSTANTIAL PORTIONS OF THE

INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR

SOFTWARE. THE SOFTWARE IS PROVIDED  "AS IS", WITHOUT WARRANTY OF

PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE

ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE

FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR

WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE

DEALINGS IN THE SOFTWARE.

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.

<big><big>------------------------End of

<big><big>------------------------End

Document-------------------------

</big></big>

</body>

</html>

Legend:

Removed from v.1.8
changed lines
	Added in v.1.10.8.1

No CVS admin address has been configured