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

version 1.6, 2004/05/13 14:39:29

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

Line 1

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

<!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 #: 103

Title: OpenPegasus

PEP #: 175

Version 2.3 Release Readme file

Version: 1.1

Title: OpenPegasus Version 2.4

Created: 12

Release Readme file

November 2003

Authors: Karl

Version: <span

Schopmeyer, Konrad Rzeszutek

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

Status: draft

Created: 24 June 2004

Authors: Warren Grunbok, Mike

Harris

Status:  draft

Version History:

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

bordercolorlight="#CCCCCC" width="100%" style="font-family: Arial;">

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

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

<tbody>

<tr>

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

Line 30

Line 41

</tr>

<tr>

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

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

<td align="center">Warren Grunbok

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

</td>

</tr>

<td>Initial draft

<tr>

</td>

</tr>

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

<tr>

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

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

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

</tr>

</td>

<tr>

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

Abstract: Installation, build, operation information on the

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

Abstract:  Installation, build, operation information on the Pegasus

with the documentation in the release notes or interface definition

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

documents for a particular release, those documents should be

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

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

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

introduction to Pegasus.

<hr>

OpenPegasus - A Manageability

Services Broker for the DMTF CIM/WBEM Standards

OpenPegasus - A Manageability Services Broker for the

Tagline: OpenPegasus is an object manager for

DMTF CIM/WBEM Standards

DMTF CIM objects written in C++ and supported by The Open Group

STATUS: Revised November 2003 for Pegasus

Tagline: OpenPegasus is an object manager for DMTF CIM objects

release version 2.3.0

written in C++ and supported by The Open Group

Table of Contents

<a

STATUS: Revised Sept 2004 for  Pegasus release version

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

2.4.0  - Approved

<a

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

<a

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

Overview</a>

<a

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

<a

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

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

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

<a

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

href="#The%20Pegasus%20Directory%20Structure">The Pegasus Directory

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

Structure</a>

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

<a

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

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

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

<a

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

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

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

<a

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

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

<a

</blockquote>

href="#Registering%20Providers%20in%20the%20Pegasus%20Environment">Registering

Providers</a>

<a

Install Pegasus</a>

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

<a

href="#Notes%20about%20Building%20Pegasus%20on%20Linux">Notes about

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

Building Pegasus on Linux</a>

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

<a

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

href="#Notes%20about%20Building%20Pegasus%20on%20Mac%20OS%20X/Darwin">Notes

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

about Building Pegasus on Mac OS X/Darwin</a>

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

<a

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

href="#Notes%20about%20Building%20Pegasus%20with%20SSL">Notes on

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

building Pegasus with SSL</a>

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

<a

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

href="#Building%20Pegasus%20on%20Windows%202000%20or%20Windows%20XP%20With%20Microsoft%20Visual%20C++">Building

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

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

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

<a

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

href="#Installing%20the%20Pegasus%20HTML%20Test%20Client">Installing

Visual C++</a>

the Pegasus HTML Test Client </a>

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

<a

href="#Development%20with%20Pegasus%20and%20Pegasus%20Tools">Development

</blockquote>

with Pegasus and Pegasus Tools</a>

<a

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

Test the Pegasus installation</a>

<a

href="#Creating%20SSL%20certifications">Creating SSL certifications</a>

<a

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

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

<a

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

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

<a

</blockquote>

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

<a

<hr>

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

<a

href="#Participate%21">Participate</a>

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

OpenPegasus (also referred to as Pegasus): Pegasus is an

open-source CIM Server for DMTF CIM objects. It is written in C++ and

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

includes the Object manager (CIMOM), a set of defined interfaces, an

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

implemenation of the CIMOperations over HTTP operations and their cimxml

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

HTTP encodings, and Interface libraries for both client and providers.

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

It is maintained consistent with the DMTF CIM and WBEM specifications

maintained consistent with the DMTF CIM and WBEM specifications except for 

except for exceptions noted in the documentation.

exceptions noted in the documentation.

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

license.

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

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

directory (LICENSE) of this release. This licensing is intended to

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

support as wide a distribution as possible with minimal demands on the

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

users.

demands on the users.

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

documentation on Pegasus are available from the OpenGroup WEB site.

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

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

available from the OpenGroup WEB site.

There are a number of separate documents representing the status and

each release of Pegasus

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

<ul>

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

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

Procedures) release notes on the Pegasus web site and duplicated in

Pegasus

the source top level directory</li>

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

<ul>

the CVS and the web site as a Pegasus PEP.</li>

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

</ul>

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

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

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

documents and in the CVS for each release.

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.

<tbody>

<tr>

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

Line 170

Line 219

</tr>

<tr>

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

</td>

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

</td>

</tr>

</tbody>

</table>

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

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

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

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

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

be found at the following Open Group CVS server;

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

cvs.opengroup.org:/cvs/MSB

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:

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

<font

%export

face="Courier New">%export

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

<font

%cvs login

face="Courier New">%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

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

type:

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

cvs co pegasus

populated with the complete source tree and documentation. To get the

latest updates after a checkout just type this from Pegasus root:

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

cvs update -d

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

Active contributors to Pegasus have write access to the CVS

type this from Pegasus root:

repository. If you are interested in contributing back to the Pegasus

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

cvs update -d

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

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

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

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

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

The major components of Pegasus are:

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

<ul>

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

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

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

providers and clients </li>

<li>Pegasus Repositories - Today Pegasus provides a defined

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

class repository interface and a simple file based class repository.

It also includes an instance repository. Note that these repository

The major components of Pegasus are:

were created for functionality, not efficieny. It is expected that

they will be replaced with other implementations of the respository

<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

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

based on the Pegasus C++ interfaces and using the WBEM HTTP/XML

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

protocols or directly interfacing with Pegasus. </li>

</li>

<li>Pegasus Test Clients - Simple test clients being developed

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

as part of the Pegasus development process. These can be seen in the

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

src/Clients directory and its subdirectories </li>

</li>

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

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

test client for Pegasus that uses a WEB server (ex. Apache) with a

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

set of CGI modules and HTML to allow the entry of Pegasus operations

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

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

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

demonstrations. </li>

variety of demonstrations. </li>

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

<li>Pegasus Provider Library - Tools for building Pegasus

C++ interfaces. </li>

providers using the Pegasus C++ interfaces. </li>

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

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

providers for test and demonstration. </li>

Pegasus services including providers for test and demonstration. </li>

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

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

to extend Pegasus capabilites. </li>

other Pegasus components to extend Pegasus capabilites. </li>

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

<li>Pegasus MOF Compiler - There standalone compiler

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

(cimmofl) for MOF files that can be used to install MOF into the

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

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>

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

Pegasus is regularly tested against a variety of platforms by the

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

development group. The set of platforms and exact set of compilers for

any given release is documented in the Release notes for that release

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

(see the CVS source tree root directory or the Pegasus PEP defining the

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

ReleaseNotes for any particular release).

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

Generally Pegasus is supported on the following Platforms and

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

Compilers.

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

<tbody>

found in the release notes associated with this release.

<tr>

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

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

</tr>

<tr>

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

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

</tr>

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

<tr>

tools. Currently Pegasus has the following dependencies:

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

</tr>

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

<tr>

successfully both in Windows and Linux environments.

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

<tr>

<td width="169">Mac OS X/Darwin PPC</td>

<td width="556">gcc (version 3.3)</td>

</tr>

</tbody>

</table>

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

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

NOTE: A set of the required tools for windows

utility is required for Pegasus make with ONLY Windows environment. It

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

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

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

UNIX or LINUX platforms.

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

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

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

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

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

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

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

must compile MU before you initiate the Pegausu make.

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

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

Pegasus WEB site.

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

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

parser from scratch will be required to have these tools. They are only

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

required if changes need to be made to the files for parsing and

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

compiling.

files for parsing and compiling.

4. DLCOMPAT - dlcompat is a dlopen(3) et.al. compatibility

library for Mac OS X/Darwin.

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

X/Darwin.

NOTE: The dlcompat is not distributed with pegasus

NOTE:  The dlcompat is not distributed with pegasus source.

source.

dlcomapt is avilable from

dlcomapt is available from :

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

</a>

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

Again, dlcomapt needs to be installed ONLY if you are using Mac OS

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

X/Darwin.

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

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

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

combination of text files and the Pegasus header files themselves. This

only the core team will be recreating documentation.

documentation is formatted with DOC++ and GAWK. These tools are required

if the documentation is to be recreated but we expect that only the

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

core team will be recreating documentation.

for message catalogs for message internationalization. See the ICU website

6. ICU Internationalization libraries - These libraries are

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

used as the basis for message catalogs for message internationalization.

See the ICU website (http://oss.software.ibm.com/icu/) for more

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

information on these libraries

protocol, the OpenSSL libraries are required.

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>

<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

Pegasus is distributed as a complete source directory structure that

installed either from one of the snapshots or from CVS.

should be installed either from one of the snapshots or from CVS.

This structure is generally as follows:

The Pegasus Directory is documented in <span

Pegasus Source Structure

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

Pegasus Root directory (PEGASUS_ROOT

directory.

environment variable)

<ul>

<li>cgi Source for the Pegasus WEB

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

Based Test client

<ul>

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

<li>cgi-bin CGI Directories for WEB

documentation.

demonstration. This directory is normally empty but can be

populated from the runtime with the make from cgi. </li>

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

<li>htdocs HTML Pages for Pegasus WEB

demonstration </li>

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

</ul>

</li>

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

<li>doc Miscellaneous Pegasus

Documents.

<ul>

<pre>Examples:

<li>apidoc - Source for the public api

bin/cimserver s (Shuts it down)

documentation.</li>

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

<li>DevManual Source and build files for

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

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

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

</ul>

bin/cimuser a u guest w ThePassword

</li>

bin/cimuser l (lists the users)

<li>mak - Common make files for

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

Pegasus compilation</li>

</pre>

<li>Dummy -</li>

</blockquote>

<li>InterfaceArchive -</li>

<li>rpm - files for rpm installation

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

for Linux</li>

<li>Schemas - Schemas used in the

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

installation of Pegasus. This includes currently released versions

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

of the DMTF schemas in subdirectories (ex. CIM27) and Pegasus local

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

Schemas (ex. </li>

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

<li>src All Pegasus Source Files

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

<ul>

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

<li>ACEExample Test directrory

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

with examples of the use of ACE (obsolete). </li>

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

<li>Clients Source for various

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

test clients and demonstration clients.</li>

<li>CGICLIENT Pegasus test client

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

that uses a WEB browser JAVA Java Client support modules </li>

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

<li>Pegasus - Core pegasus

documentation.

modules.

<ul>

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

<li>Client Pegasus Client API

Tests depends tests </li>

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

<li>Common Pegasus Common

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

Functions (C++ source and headers tests Test programs for

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

the common functions</li>

<li>Compiler Pegasus MOF

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

compiler </li>

<li>Config Pegasus

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

Configuration functions</li>

process includes the following steps:

<li>Consumer Indication

Consumer class header</li>

<ol>

<li>ControlProviders

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

Implementation of Pegasus internal providers </li>

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

<li>ExportClient Client

<li>Set environment variables. </li>

connect code for export of indications</li>

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

<li>ExportServer Server code

</ol>

for import of indications</li>

<li>Handler Indication

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

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

<li>HandlerService Common code

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

for indication handler service</li>

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

<li>IndicationService Common

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

service functions for indication subscription processing</li>

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

<li>Listener Common code that

of Pegasus</a>.

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

<li>Protocol Pegasus Client

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

HTTP/XML Protocol Modules depends </li>

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

<li>Provider Pegasus Provider

for more information.

interface functions </li>

<li>ProviderManager Provider

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

Manager service that manages providers </li>

<li>ProviderManager2 Pluggable

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

Provider Manager service. Today this is not enabled by

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

default It will become the Pegasus standard provider manager

at some time in the future but for now, see the release notes if you

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

want to enable it.</li>

<li>Repository Pegasus

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

Repository Interfaces and Simple Repository tests

have been defined or updated:

<ul>

<li>Tests for Repository

<dl>

Functions </li>

<dt>PEGASUS_ROOT </dt>

</ul>

<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>Security Authentication

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

and user support functions.</li>

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

<li>Server Pegasus Server

execute "make testrepository".

Modules </li>

<li>WQL the WQL query language

interpreter.</li>

</ul>

</li>

</ul>

<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>Providers Pegasus test and

</ol>

required providers

<ul>

The following make targets are supported:

<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><a name="Pegasus Installation">Pegasus Installation</a> </h1>

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. Define the following three environment variables:

<ul>

<li>PEGASUS_ROOT - this should be the "pegasus" directory

you've pulled from CVS </li>

<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 $HOME/pegasus_home/bin and $HOME/pegasus_home/lib </li>

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

identifier.</li>

</ul>

This identifier has the following form:

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

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

face="Courier New">pegasus/mak

</blockquote>

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

setting PEGASUS_HOME to something like this:

$HOME/pegasus_home_LINUX_IX86_GNU

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

directory.

3. Now place $PEGASUS_HOME/bin on your path

and

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

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

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

(where make refers to GNU make).

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

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

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

6. To test the build type "make tests". The following make targets

are supported:

<ul>

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

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

Line 556

Line 544

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

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

</ul>

The Pegasus Client server tests are executed separately from the

above because they require the initiation of separate process for the

Generally the build commands are as follows:

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

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

executing make in the Pegasus root directory will make everything.

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

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

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

will also populate the repository with the current CIM Schemas. </li>

current CIM Schemas. </li>

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

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

face="Courier New">make world". This will build

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

dependencies, build binaries, and then run all tests except the

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

Client/Server tests. </li>

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

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

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

type "make tests". This also reinstalls the repository. Running

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

"make -s tests" suppresses extraneous output such as the enter/leave

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

directory messages. </li>

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

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

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

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><a name="Populate the Repository">Populating the Pegasus Repository</a> </h1>

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

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

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

to do it manually:

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

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

Pegasus has been built.

<ol>

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

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

skeleton of the object. </li>

<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

specific object is activated. </li>

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

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

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

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

compiler (cimmofl) on: -Schema v2.7 Generates the CIM Schema v2.7 in the

repository (skeleton of CIM objects) -PG_InterOp Internal to Pegasus

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

schema for operating (shutdown, add users, etc) CIM_Indication’s (SNMP,

Events, Alert, Threshold, etc) -PG_ManagedSystem Registers included CIM

<ul>

Providers (libOSProvider.so, libDNSProvider.so, … ) in Pegasus (which

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

are located in src/Providers)

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

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

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

manual on the openpegasus.org.

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

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

-PG_InterOp</tt> </li>

Installation</a></h1>

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

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

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

CVS enviromentthat can be executed including:

</li>

<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><a name="Registering Providers in the Pegasus Environment">Registering

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

<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

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

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

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

exactly the same as the current DMTF definition (See the DMTF Interop

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

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

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

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

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,

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

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

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

registration today is to copy from one of the existing registration

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

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

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

registration instance implementations that do work with Pegasus today.

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

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

In order to provide a consistent build structure across multiple

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

platforms, we developed a small utility to provide a consistent set of

small utilities across these platforms. The MU utilityis a simple

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

utility that contains many commands. For example:

do this, your environment must meet the following requirements:

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

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

<ul>

them:

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

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

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

depend

evironment variables</a>. </li>

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

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

do things like this:

</ul>

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

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

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

available as part of the distribution of Pegasus.

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

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

Building Pegasus on Linux </a></h1>

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

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

(PEASUS_HOME, PEGASUS_ROOT, PEGASUS_PLATFORM. For 32 bit linux, the

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

defintion of PEGASUS_PLATFORM is normally LINUX_IX86_GNU.

crate and populate teh repository manually.

<h1><a name="Notes about Building Pegasus on Mac OS X/Darwin">Notes

about Building Pegasus on Mac OS X/Darwin</a><a

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

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

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.

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

Building Pegasus with SSL </a></h1>

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

section "Creating SSL certificates" for more information of how to use

SSL.

<h1><a

name="Building Pegasus on Windows 2000 or Windows XP With Microsoft Visual C++">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%20MU%20Utility">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' 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 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>

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

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

Please follow section <a

href="#Notes%20about%20Building%20Pegasus%20with%20SSL">Notes on

building Pegasus with SSL</a> before embarking on this endeavour.

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.

<pre>CN="Common Name" EMAIL="test@email.address" HOSTNAME=`uname -n` sed -e "s/$CN/$HOSTNAME/" \ -e "s/$EMAIL/root@$HOSTNAME/" $PEGASUS_ROOT/ssl.cnf \ > $PEGASUS_HOME/ssl.cnf chmod 644 $PEGASUS_HOME/ssl.cnf chown bin $PEGASUS_HOME/ssl.cnf chgrp bin $PEGASUS_HOME/ssl.cnf /usr/bin/openssl req -x509 -days 365 -newkey rsa:512 \ -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 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%20about%20Building%20Pegasus%20with%20SSL">Notes on

building Pegasus with SSL</a> and <a

href="#Creating%20SSL%20certifications">Creating SSL certifications</a>

before embarking on this endeavour.

To configure Pegasus to take advantage of SSL, configure CIMServer to

have the following configuration options set to:

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

<pre> sslTrustFilePath=client.pem sslCertificateFilePath=server.pem sslKeyFilePath=file.pem httpsPort=5989 enableHttpsConnection=true </pre>

</blockquote>

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

using the cimconfig utility:

Supported Platforms</a> for more information.

<pre> cimconfig -p -s enableHttpsConnection=true </pre>

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

</blockquote>

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

PEGASUS_PLATFORM is normally LINUX_IX86_GNU.

(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

configuration to include:

<pre> enableHttpConnection=false </pre>

</blockquote>

using cimconfig.

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

<pre> PEGASUS_PAM_AUTHENTICATION=1 </pre>

</blockquote>

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%20Pegasus">Building

Pegasus </a>for details), follow these two important steps:

<ul>

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

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

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

notifies PAM what kind of libraries to use when authenticating

Pegasus.

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

</ul>

both Windows 2000 and Windows XP using the Microsoft compilers.

<ul>

b). Modify CIMServer configuration options:

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,

<pre> usePAMAuthentication=true enableAuthentication=true </pre>

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

</blockquote>

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

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

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

environment.

<pre> enableRemotePrivilegedUserAccess=true </pre>

</blockquote>

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

using the cimconfig utility, such as:

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> cimconfig -p -s usePAMAuthentication=true </pre>

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

</blockquote>

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

</ul>

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

</ul>

set PEGASUS_DEBUG=true

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

REM set PEGASUS_ROOT to top of source tree

strongly suggested you use SSL connection instead of normal HTTP

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

connection. Refer to section <a href="#Configuring%20SSL">Configuring

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

Pegasus to use SSL</a> for more details on creating and using SSL keys.

REM set PEGASUS_HOME to where you want repository and executables

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

set PEGASUS_HOME=%PEGASUS_ROOT%

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

REM setup the path to the runtime files.

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

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

libraries are used to load messages in different languages, format

</pre>

currency and numbers according to a specific locale etc. In order to

</blockquote>

enable globalization in Pegasus, Pegasus must be built with ICU enabled,

ie. the right environment variables must be set prior to running

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

"make". Refer to the GlobalizationHOWTO.htm in the docs directory for

details. That said, when users run "make poststarttests" to verify the

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

integrity of a Pegasus download, a series of tests are run that require

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

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

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

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

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

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

hardcoded default messages within Pegasus. These hardcoded default

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

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

successfully. If the ICU enabled server is started without disabling

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

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

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

depend

environment variable called PEGASUS_USE_DEFAULT_MESSAGES must exist

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

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

starts, all messages generated will be the default hardcoded messages.

this:

This will enable "make poststarttests" to complete successfully. Once

"make poststarttests" is complete, you should stop the cimserver and

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

then undefine PEGASUS_USE_DEFAULT_MESSAGES. If this variable is left

defined, Pegasus will not be able to load messages using ICU resource

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

bundles.

distribution of Pegasus.

<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

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

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

available on the PEGASUS web site. The preliminary documentation is not

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

provided with this release. The current documentation is maintained

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

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

DARWIN_PPC_GNU.

subdirectory manual/html (see doc/devManual to create), as an api

document also creatable from the source tree (see doc/apidoc) and as

<h2>

other miscellaneous documentation in the doc directory. Also there is a

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

set of release notes. Normally the release notes for the current release

are available in the root source directory of CVS.

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

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

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

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

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

discussion and design documentation.

where your OpenSSL installation is.

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

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

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

and contribute to effort of getting this Pegasus off the ground. Please

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

join the mailing list by visiting www.openpegasus.org, and click on

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

Mailing Lists.

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

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

> $PEGASUS_HOME/ssl.cnf

chmod 644 $PEGASUS_HOME/ssl.cnf

chown bin $PEGASUS_HOME/ssl.cnf

chgrp bin $PEGASUS_HOME/ssl.cnf

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

-nodes -config $PEGASUS_HOME/ssl.cnf \

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

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

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.6
changed lines
	Added in v.1.8

No CVS admin address has been configured