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.4 and 1.8

version 1.4, 2004/03/10 17:52:07

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

Line 1

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

<html>

<head>

<title>OpenPegasus</title>

Line 10

Line 11

<body>

Pegasus Enhancement Proposal (PEP)

PEP #: 103

Title: OpenPegasus Version 2.3

PEP #: 175

Title: OpenPegasus Version 2.4

Release Readme file

Version: 1.1

Created: 12 November 2003

Authors: Karl Schopmeyer, Konrad Rzeszutek

Status:  draft

Version History:

<table border="1" cellspacing="1" bordercolordark="#666666"

bordercolorlight="#CCCCCC" width=100%

style='font-size=10.0pt;font-family:Arial'>

<tr>

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

<th bgcolor="#CAE6CA">Author</th>

<th bgcolor="#CAE6CA">Change Description</th>

</tr>

<tr>

<td align="center">12 November 2003</td>

<td align="center">Karl Schopmeyer</td>

<td>Update from 2.2 Release notes. Converted to HTML</td>

</tr>

<tr>

<td align="center">March 10 2004</td>

<td align="center">Konrad Rzeszutek</td>

<td>Added sections describing SSL and PAM configuration</td>

</tr>

<tr>

</tr>

</table>

<hr>

Abstract:  Installation, build, operation information on the

Pegasus Platform Version 2.3 Release. Note that if this readme conflicts with

the documentation in the release notes or interface definition documents for a

particular release, those documents should be considered authorative. This is a

simplified overview to act as an introduction to Pegasus.

<hr>

OpenPegasus - A Manageability Services Broker

Version: <span

for the DMTF CIM/WBEM Standards

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

Created: 24 June 2004

Tagline: OpenPegasus is an object manager for DMTF CIM objects written in C++

and supported by The Open Group

Authors: Warren Grunbok, Mike

Harris

Status:  draft

STATUS: Revised November 2003 for  Pegasus release version 2.3.0

Version History:

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

Table of Contents

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

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

<tbody>

<tr>

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

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

<th bgcolor="#cae6ca">Change Description</th>

</tr>

<tr>

<td align="center">Warren Grunbok

</td>

<td>Initial draft

</td>

</tr>

<tr>

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

</td>

<td align="center">Warren Grunbok

</td>

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

</td>

</tr>

<tr>

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

</td>

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

</td>

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

</td>

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

/Directory structure section and placed into  seperate document.

</td>

</tr>

<tr>

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

</td>

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

</td>

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

</td>

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

191, Added Copyright and End of Doc marker.

</td>

</tr>

<tr>

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

</td>

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

</td>

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

</td>

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

Sterling.

</td>

</tr>

</tbody>

</table>

<hr>

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

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

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

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

Abstract:  Installation, build, operation information on the Pegasus

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

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

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

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

introduction to Pegasus.

<hr>

<a href="#Pegasus Installation">Installation</a>

OpenPegasus - A Manageability Services Broker for the

<a href="#Building Pegasus">Building Pegasus </a>

DMTF CIM/WBEM Standards

Tagline: OpenPegasus is an object manager for DMTF CIM objects

<a href="#Populate the Repository">Populate the Repository</a>

written in C++ and supported by The Open Group

STATUS: Revised Sept 2004 for  Pegasus release version

<a href="#Registering Providers in the Pegasus Environment">Registering

2.4.0  - Approved

Providers</a>

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

Overview</a>

<a href="#Notes about Building Pegasus on Linux">Notes about Building Pegasus on Linux</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="#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>

</blockquote>

Install Pegasus</a>

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

<a href="#Building Pegasus on Windows 2000 or Windows XP With Microsoft Visual C++">Building Pegasus on Windows 2000 or Windows XP With Microsoft Visual C++</a>

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

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

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

</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="#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 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 Pegasus on Windows 2000 or Windows XP With Microsoft

Visual C++</a>

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

</blockquote>

Test the Pegasus installation</a>

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

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

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

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

</blockquote>

<hr>

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

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

<a href="#Configuring SSL">Configuring Pegasus to use SSL</a>.

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

<a href="#Configuring PAM">Configuring Pegasus to use PAM</a>.

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

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

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

maintained consistent with the DMTF CIM and WBEM specifications except for 

exceptions noted in the documentation.

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

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

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

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

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

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

demands on the users.

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

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

available from the OpenGroup WEB site.

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

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

OpenPegasus (also referred to as Pegasus):

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

Pegasus

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

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

implemenation of the CIMOperations over HTTP operations and their cimxml HTTP

encodings, and

Interface libraries

for both client and providers. It is maintained

consistent with the DMTF CIM and WBEM specifications except for  exceptions

noted in the documentation.

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

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. This licensing is intended to support as wide a

distribution as possible with minimal demands on the users.

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

Pegasus are available from the OpenGroup WEB site.

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

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

release of Pegasus

<ul>

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

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

release notes on the Pegasus web site and duplicated in the source top level

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

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

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

the web site as a Pegasus PEP.</ul>

as a Pegasus PEP.</li>

</ul>

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

for each release.

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

in the CVS for each release.

<tbody>

<tr>

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

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

Line 186

Line 219

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

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

cvs.opengroup.org:/cvs/MSB

<h1><a name="Availability of Pegasus">Availability of Pegasus</a></h1>

using the password authenticating server option (pserve).

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

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 web site.

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

cvs.opengroup.org:/cvs/MSB

using the password authenticating server option (pserve).

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

%export

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

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

%cvs login

%cvs login

</blockquote>

When requested, enter the password "anon".

The source tree is in the directory pegasus. To check out the complete Pegasus

source tree just type:

cvs co pegasus

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

with the complete source tree and documentation. To get the latest updates

after a checkout just type this from Pegasus root:

cvs update -d

Active contributors to Pegasus have write access to the CVS repository.

If you are interested in contributing back to the Pegasus project,

(i.e. write (checkin) access to CVS) please request access from either

Martin Kirk (m.kirk@opengroup.org) or Karl Schopmeyer

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

<h1>

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

<a name="Pegasus Major Components">Pegasus Major Components</a></h1>

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

cvs co pegasus

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

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

type this from Pegasus root:

cvs update -d

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

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

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

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

href="mailto:(k.schopmeyer@opengroup.org">k.schopmeyer@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>Pegasus Server - WBEM/CIM Server with interfaces for providers and clients </li>

</li>

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

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

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

an instance repository. Note that these repository were created for

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

functionality, not efficieny. It is expected that they will be replaced

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

with other implementations of the respository function as the need arises.

function as the need arises. </li>

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

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

interfacing with Pegasus.

</li>

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

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

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

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

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

C++ interfaces. </li>

</li>

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

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

providers for test and demonstration. </li>

including providers for test and demonstration.

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

</li>

to extend Pegasus capabilites. </li>

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

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

components to extend Pegasus capabilites.

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

</li>

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

<li>Pegasus MOF Compiler - There  standalone compiler (cimmofl) for MOF files that can be used

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

to install MOF into the Pegasus schema repository and also to check syntax.

</ul>

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

There is also a tool to extract the MOF from the repository.

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

</li>

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

</ul>

found in the release notes associated with this release.

<h1>

<a name="Pegasus Supported Platforms">Pegasus Supported Platforms</a></h1>

<h2><a name="peg_dep">Pegasus Dependencies</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).

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

Generally Pegasus is supported on the following Platforms and Compilers.

tools. Currently Pegasus has the following dependencies:

<tr>

<td width="169" bgcolor="#99FF99">Platform and OS</td>

<td width="556" bgcolor="#99FF99">Compilers</td>

</tr>

<tr>

<td width="556">VisualAge C++ Version</td>

</tr>

<tr>

</tr>

<tr>

<td width="169">Linux Itanium</td>

</tr>

<tr>

<td width="169">Linux IA-32</td>

<td width="556">gcc (versions 2.9x and 3.xx)</td>

</tr>

<tr>

<td width="169">Windows 2000</td>

<td width="556">Microsoft Visual C++ Ver 6 and Microsoft .Net compiler

Version 7</td>

</tr>

<tr>

<td width="169">Windows XP</td>

<td width="556">Microsoft Visual C++ Ver. 6 and Microsoft .Net compiler

Version 7</td>

</tr>

</table>

<h1>

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

<a name="Pegasus Dependencies">Pegasus Dependencies </a></h1>

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 :

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

packages and tools. Currently Pegasus has the following dependencies:

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

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 :

       NOTE: A set of the required tools for

windows platforms is available on the openpegasus web site.

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

we have created a utility called MU.exe. This utility is required for

Pegasus make with ONLY Windows environment. It is provided as an alternative to

requiring a number of UNIX utilities (SH, RM, etc.) on the windows platform

and effectively provides the functions of these utilities that GNUMAKE

needs. MU is not required on UNIX or LINUX platforms.

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

You must 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 make.

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

WEB site.

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

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

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 files for parsing and compiling.

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

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

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

communication protocol, the OpenSSL libraries are required.<h1>

<a name="The Pegasus Directory Structure">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.

This structure is generally as follows:

Pegasus Source Structure

Pegasus Root directory (PEGASUS_ROOT environment

variable)<ul>

<li>cgi Source for the Pegasus WEB Based Test client

<ul>

<li>cgi-bin CGI Directories for WEB demonstration.

This directory is normally empty but can

be populated from the runtime with the make

from cgi.

</li>

<li>htdocs HTML Pages for Pegasus WEB demonstration

</li>

</ul>

</li>

<li>doc Miscellaneous Pegasus Documents.

<ul>

<li>apidoc - Source for the public api

documentation.</li>

<li>DevManual Source and build files for developers' manual

mak General make files (used by other makes)</li>

</ul>

</li>

<li>mak - Common make files for Pegasus

compilation</li>

<li>Dummy -</li>

<li>InterfaceArchive -</li>

<li>rpm - files for rpm installation for Linux</li>

<li>Schemas - Schemas used in the installation

of Pegasus. This includes currently released versions of the DMTF schemas in

subdirectories (ex. CIM27) and Pegasus local Schemas (ex. </li>

<li>src All Pegasus Source Files

<ul>

<li>ACEExample Test directrory with examples of the use of ACE (obsolete).

</li>

<li>Clients Source for various test

clients and demonstration clients.</li>

<li>CGICLIENT Pegasus test client that uses a WEB browser

JAVA Java Client support modules

</li>

<li>Pegasus - Core pegasus modules.

<ul>

<li>Client Pegasus Client API Tests

depends tests </li>

<li>Common Pegasus Common Functions (C++ source and headers

tests Test programs for the common functions</li>

<li>Compiler Pegasus MOF compiler

</li>

<li>Config Pegasus Configuration

functions</li>

<li>Consumer Indication Consumer class

header</li>

<li>ControlProviders Implementation of Pegasus internal providers

</li>

<li>ExportClient Client connect code

for export of indications</li>

<li>ExportServer Server code for

import of indications</li>

<li>Handler Indication handlers. Today

this includes cimxml, SNMP and email handlers</li>

<li>HandlerService Common code for

indication handler service</li>

<li>IndicationService Common service

functions for indication subscription processing</li>

<li>Listener Common code that allows

CIM Listeners to be created and connected.</li>

<li>Protocol Pegasus Client HTTP/XML Protocol Modules

depends </li>

<li>Provider Pegasus Provider interface functions

</li>

<li>ProviderManager Provider Manager service that manages providers

</li>

<li>ProviderManager2 Pluggable Provider Manager service.

Today this is not enabled by default It will become the Pegasus

standard provider manager at some time in the future but for now, see

the release notes if you want to enable it.</li>

<li>Repository Pegasus Repository

Interfaces and Simple Repository tests

<ul>

<li>Tests for Repository Functions

</li>

</ul>

</li>

<li>Security Authentication and user

support functions.</li>

<li>Server Pegasus Server Modules

</li>

<li>WQL the WQL query language

interpreter.</li>

</ul>

</li>

</ul>

</li>

<li>Providers Pegasus test and required providers

<ul>

<li>generic A number of

cross-platform providers

</li>

<li>IndicationConsumer - Provider that

consumes indications</li>

<li>Linux - A number of linux

providers</li>

<li>ManagedSystem Providers

associated with managing the Pegasus System</li>

<li>slp -  Provider for slp

service agent support</li>

<li>statistic - Providers for

Pegasus statistics.</li>

<li>sample Sample providers for the

major provider types.</li>

<li>testproviders </li>

</ul>

</li>

<li>Server Pegasus executable build

</li>

<li>Standard Includes - </li>

<li>test - Directory of end-end

tests that are regularly conducted on Pegasus</li>

<li>tools MU and other utilities written for Pegasus support

</li>

<li>Unsupported Code that is made available but is not supported or included

in the normal make. </li>

<li>WMIMapper Pegasus implementation that

provides mapping to Microsoft WMI objects.

</li>

</ul>

Pegasus Run Time directory structure (PEGASUS_HOME

environment variable). Home directory for runtime. All compiler, linker

documentation creation, etc. are put here.

<ul>

<li>bin - Destination for executable and DLL modules from

Pegasus build. This directory should be make public so that the test functions,

clients, and cimserver can be executed with minimum effort.</li>

<li>DevManualHTML - HTML output of the Pegasus Manual.

This is only created when the make file for this manual is

executed (doc/DevManual) and then contains the html representing

the document.</li>

<li>apidochtml - HTML output of

the creation of the public API document.  This only exists

when the make file for the api document is executed (see doc/apidoc/Makefile)</li>

<li>lib - Destination for Pegasus LIB modules

</li>

<li>log - Standard location for

Pegasus Logs</li>

<li>obj - Destination for object

modules. Note that today, the trace file is located in the

PEGASUS_HOME directory, not in the log directory if Pegasus

internal tracing is enabled.</li>

<li>repository - This Directory

contains the created repository </li>

</ul>

<h1>

NOTE: A set of the required tools for windows

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

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

Pegasus today is provided only as a source distribution.  Note that there

is code for a Linux RPM distribution but the project is not yet releasing

binaies.

To install Pegasus, you must check it out using CVS (Common Version System)

or download a snapshot. You download, compile, and use it.

For the snapshot, the installation of Pegasus involves expanding the snapshot

distribution files, building the runtime, the test files and test clients, and

building the repository.

<h1>

<a name="Building Pegasus">Building Pegasus </a>

</h1>

1. Check that you have requisite programs (listed in Pegasus Dependencies).

These include GNU Make, MU.EXE (if using Windows), Flex, and Bison (Flex

and Bison only required if changes will be made to the MOF compiler or WQL

parser).

Be sure these are on the path.

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

2. Define the following three environment variables:

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

<ul>

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

<li>PEGASUS_ROOT - this should be the "pegasus" directory you've pulled from CVS

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

</li>

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

<li>PEGASUS_HOME - to point to a directory to contain output binary files

(e.g., set it to $HOME/pegasus_home). Then the output will go into

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

$HOME/pegasus_home/bin and $HOME/pegasus_home/lib

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

</li>

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

<li>PEGASUS_PLATFORM - this must be set to a supported

make.

platform identifier.</li>

</ul>

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

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

This identifier has the following form:

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

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

<Operating-System>_<Architecture>_<Compiler>

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

files for parsing and compiling.

For example (Linux on IA32 platform using the GNU Compiler):

LINUX_IX86_GNU

For a complete list of platforms supported and platform support keywords, refer to the platform make files found in directory 

pegasus/mak

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)

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

<pre>Examples:

bin/cimserver s (Shuts it down)

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

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

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

bin/cimuser a u guest w ThePassword

bin/cimuser l (lists the users)

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

</pre>

</blockquote>

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

Note: if you plan on doing parallel builds, you might consider setting

PEGASUS_HOME to something like this:

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

$HOME/pegasus_home_LINUX_IX86_GNU

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

That way, the output of each build will be placed in its own directory.

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

3. Now place $PEGASUS_HOME/bin on your path

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

and

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

Place $PEGASUS_HOME/lib on your LD_LIBRARY_PATH (for Unix only).

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

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

documentation.

4. Change to the root of the Pegasus distribution and type "make"

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

(where make refers to GNU make).

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

5. Then create the repository, which is needed to serve data.

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

"make repository". Note that to create the additional namespaces, etc.

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

that represent the test support you can also execute "make testrepository:

6. To test the build type "make tests".

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

The following make targets are supported:

<UL>

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

<li><default> - Build everything.

process includes the following steps:

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

<li>depend - Create the dependencies.

<li>repository - Create the repository in $PEGASUS_HOME/repository

<li>tests - Execute all tests (except client server tests).

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

<li>world - depend, <default>

</UL>

The Pegasus 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 please refer to the scripts in

pegasus/mak/BuildMakefile - refer to the prestarttests and poststarttests.

For information on particular installation characteristics, tools, etc. for

each platform see the appropriate sections below:

Generally the build commands are as follows:

<ol>

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

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

make in the Pegasus root directory will make everything. "make rebuild"

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

will clean and rebuild everything. The "make rebuild" will also populate

<li>Set environment variables. </li>

the repository with the current CIM Schemas.

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

</li>

</ol>

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

"make world".

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

This will build dependencies, build binaries, and then run all

tests except the Client/Server tests.

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>For RedHat/SuSE/UL, edit /etc/ld.so.conf and add $PEGASUS_HOME/lib.</li>

</ul>

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

repository</a>

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.

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>To execute the basic test suite that is shipped with pegasus type

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

"make tests". This also reinstalls the repository. 

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

Running "make -s tests" suppresses extraneous output such as the

execute "make testrepository".

enter/leave directory messages.

</li>

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

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>

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

</ol>

</li>

The following make targets are supported:

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

done,

built, and tests are run. Do it by: "make -f mak/BuildMakefile cleanbuild"

</li>

<ul>

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

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

<li>depend - Create the dependencies. </li>

<li>repository - Create the repository in $PEGASUS_HOME/repository </li>

<li>tests - Execute all tests (except client server tests). </li>

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

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

</ul>

Generally the build commands are as follows:

<ol>

<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

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

current CIM Schemas. </li>

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

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

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

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

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

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

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

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

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

</ol>

<h1>

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

<a name="Populate the Repository">Populating the Pegasus Repository</a> </h1>

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

Before using Pegasus you must populate the repository.. The makefile

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

does it all for you, but in case you are wondering what it does or how to do it

Pegasus has been built.

manually:

<ol>

<LI>Register the MOF (Managed Object Format) file describing the skeleton of the

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

object.

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

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

specific object is activated. </li>

when a

specific object is activated.

</ol>

This is done automatically for the providers included in Pegasus by doing:

make repository.

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

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

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

Runs MOF compiler (cimmofl) on:

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

-Schema v2.7

Generates the CIM Schema v2.7 in the repository (skeleton of CIM objects)

<ul>

-PG_InterOp

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

Internal to Pegasus schema for operating (shutdown, add users, etc)

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

CIM_Indication�s (SNMP, Events, Alert, Threshold, etc)

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

-PG_ManagedSystem

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

Registers included CIM Providers (libOSProvider.so, libDNSProvider.so, � )

-PG_InterOp</tt> </li>

in Pegasus (which are located in src/Providers)

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

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

For more information about using the MOF compiler, refer to user's manual on the

</li>

openpegasus.org.

<h1>

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

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

enviromentthat can be executed including:<ul>

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

specifically to test Pegasus or parts of Pegasus including TestClient, Client,

CLI, ipinfo, osinfo, WbemEsec, etc. See the src/Clients directory for more

information. These programs require a server complete with repository to be

running.  Note that some of these tests use classes and instances that

are only installed with the "make testrepository" functions including test

namespaces and extra classes and instances in those namespaces and additional

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

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

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

directory</li>

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

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

which can be executed at many different levels of the source tree from the top

level to execute all of the unit tests to individual directories. 

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

below their corresponding source code (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>

<h1>

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

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

in the Pegasus Environment</a></h1>

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

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

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

using the provider qualifier as is done in most DMTF CIM CIMOM implementations

future when the DMTF scheme is moved to final status.

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

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

with 2.6). This will be harmonized in the future when the DMTF scheme is moved

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

to final status.

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.

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

registration classes that represent the porvider module, providers, classes,

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

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

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

providers/sample/load directory for examples of several registration instance

do this, your environment must meet the following requirements:

implementations that do work with Pegasus today.

<ul>

<h1>

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

<a name="The MU Utility">The MU Utility </a></h1>

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

evironment variables</a>. </li>

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

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

</ul>

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

across these platforms. The MU utilityis a simple utility that contains many

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

commands. For example:

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

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

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

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

crate and populate teh repository manually.

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

of them:

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

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

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

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

The MU utility supports globing (expansion of wildcards) so

Supported Platforms</a> for more information.

you can do things like this:

To build Pegasus 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.

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

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

of the distribution of Pegasus.

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

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

<h1>

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

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

Linux </a></h1>

both Windows 2000 and Windows XP using the Microsoft compilers.

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

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

PEGASUS_ROOT, PEGASUS_PLATFORM.  For 32 bit linux, the defintion of

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

PEGASUS_PLATFORM is normally LINUX_IX86_GNU.

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

<h1><a name="Notes about Building Pegasus with SSL">Notes about Building Pegasus with SSL

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

</a></h1>

environment.

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

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

distributed with Pegasus. Make sure

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

you have them in a standard directory so Pegasus can find them. If that's not

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

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

For Windows, try the following for an example environment:

OpenSSL

installation is.

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

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

certificates" for more information of how to use SSL.

<h1>

Building Pegasus on Windows 2k or Windows XP with Microsoft Visual C++ </a></h1>

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

tested on both Windows 2000 and Windows XP using the Microsoft compilers.

Today we build Pegasus on Windows using a set of make files 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 Pegasus <a href="#The 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.

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

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

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

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

</pre>

</blockquote><h1><a name="Installing the Pegasus HTML Test Client">Installing the Pegasus HTML Test Client</a></h1>

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. <h1><a name="Development with Pegasus and Pegasus Tools">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="Commands">Commands</a></h1>

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. <blockquote><pre>Examples:

bin/cimserver �s (Shuts it down)

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

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

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

bin/cimuser �a �u guest �w ThePassword

bin/cimuser �l (lists the users)

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

</pre>

</blockquote><h1><a name="Creating SSL certifications">Creating SSL certifications </a></h1>

</blockquote>

Please follow section <a href="#Notes about Building Pegasus with SSL">Notes on building Pegasus with SSL</a> before embarking on this endeavour.

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

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

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

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

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

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

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

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

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

depend

<blockquote><pre>CN="Common Name"

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

this:

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

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

distribution of Pegasus.

<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,

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

DARWIN_PPC_GNU.

<h2>

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

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

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

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

where your OpenSSL installation is.

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

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

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

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

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

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

Set the sslKeyFilePath to key.pem.  Set the

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

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

<pre

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

EMAIL="test@email.address"

HOSTNAME=`uname -n`

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

Line 873

Line 740

-nodes -config $PEGASUS_HOME/ssl.cnf \

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

cat $PEGASUS_HOME/key.pem $PEGASUS_HOME/cert.pem > $PEGASUS_HOME/server.pem

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

rm $PEGASUS_HOME/key.pem $PEGASUS_HOME/cert.pem

cp $PEGASUS_HOME/cert.pem $PEGASUS_HOME/client.pem

</pre></blockquote>

<h1><a name="Configuring SSL">Configuring Pegasus to use SSL</a></h1>

Please follow section <a href="#Notes about Building Pegasus with SSL">Notes on building Pegasus with SSL</a> and <a href="#Creating SSL certifications">Creating SSL certifications</a>

before embarking on this endeavour.

To configure Pegasus to take advantage of SSL, configure

cimserver_planned.conf to have:

sslTrustFilePath=client.pem

sslCertificateFilePath=server.pem

sslKeyFilePath=file.pem

httpsPort=5989

enableHttpsConnection=true

</pre></blockquote>

(The client.pem and server.pem are the certifications

files created per the steps in the earlier section).

For good riddance you might consider closing down

the cleartext 5988 port. Modify your cimserver_planned.conf

to include:

enableHttpConnection=false

</pre></blockquote>

<h1><a name="Configuring PAM">Configuring Pegasus to use PAM</a></h1>

In order to use PAM Authentication you have to compile Pegasus

with one extra enviroment flags:

PEGASUS_PAM_AUTHENTICATION=1

</blockquote></pre>

You can also set the PEGASUS_ALWAYS_USE_PAM=1 flag to disable

Pegasus password authentication using a flag text-file (recommended).

After compiling (refer to section <a href="#Building Pegasus">Building Pegasus </a>

for details), follow these two important steps:

<ul>

<ul>a). Copy the rpm/wbem file in-to /etc/pam.d directory.

This notifies PAM what kind of libraries to use when authenticating

Pegasus.</uL>

<ul>

b). Edit cimserver_planned.conf to include:

usePAMAuthentication=true

enableAuthentication=true

</blockquote></pre>

And if you want to allow 'root' to login (*not recommended*)

enableRemotePrivilegedUserAccess=true

</blockquote></pre>

</ul>

The user is authenticated using HTTP Basic method, thererfore it is

strongly suggested you use SSL connection instead of normal HTTP connection.

Refer to section

<a href="#Configuring SSL">Configuring Pegasus to use SSL</a> for more details on creating and using SSL keys.

<h1><a name="Testing with ICU enabled">Testing with ICU enabled</a></h1>

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

Pegasus uses to run globalized. For example: these libraries are used to

load messages in 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 right environment variables must be

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

directory for details. That said, when users run "make poststarttests"

to verify the integrity of a Pegasus download, a series of tests are run that

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

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

from the resource bundles and these usually do not match the 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 is started without

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

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

environment variable called PEGASUS_USE_DEFAULT_MESSAGES must exist 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, Pegasus will not be able to load messages

using ICU resource bundles. <h1><a name="Pegasus Documentation">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="Participate!">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.

</body>

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

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

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

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

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

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

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

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

</li>

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

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

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

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

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

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

test directories immediately below their corresponding source code (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 libraries that Pegasus

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

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

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

GlobalizationHOWTO.htm in the docs directory for details.

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

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

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

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

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

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

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

successfully with ICU enabled, an environment variable called PEGASUS_USE_DEFAULT_MESSAGES

must exist 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, Pegasus 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.

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

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

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.

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

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

</big></big>

</body>

</html>

Legend:

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

No CVS admin address has been configured