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.2.2.1 and 1.13

version 1.2.2.1, 2003/11/19 23:46:46

version 1.13, 2006/03/28 20:23:03

Line 1

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

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

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

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

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

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

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

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

// deal in the Software without restriction, including without limitation the

// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or

// sell copies of the Software, and to permit persons to whom the Software is

// furnished to do so, subject to the following conditions:

// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN

// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED

// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT

// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR

// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN

// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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

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

<html>

<head>

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

<title>OpenPegasus</title>

</head>

<body>

Pegasus Enhancement Proposal (PEP)

PEP #: 103

PEP #: 235

Title: OpenPegasus Version 2.3

Release Readme file

Title: OpenPegasus

Version: 1.0

Version 2.5 Release Readme file

Created: 12 November 2003

Version: <span

Authors: Karl Schopmeyer

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

Status:  draft

Version History:

Created: 6 Sept

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

2005

bordercolorlight="#CCCCCC" width=100%

Authors: Warren

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

Grunbok

<tr>

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

Status:  draft

Version History:

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

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

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

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

<tbody>

<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 align="center">Warren Grunbok

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

</td>

</tr>

<td>Initial draft

<tr>

</td>

</tr>

<tr>

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

</td>

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

Sept 2005

</td>

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

Grunbok/Roger Kumpf

</td>

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

based on Architecture team review

</td>

</tr>

<tr>

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

</td>

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

</td>

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

</td>

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

1.1

</td>

</tr>

<tr>

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

</td>

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

</td>

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

Grunbok

</td>

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

to -

</td>

</tr>

<tr>

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

</td>

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

</td>

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

</td>

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

</td>

</tr>

</tbody>

</table>

<hr>

Abstract:  Installation, build, operation information on the

Abstract:  Installation, build, operation information on

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

the OpenPegasus Version 2.5.0 Release. Note that if this readme

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

conflicts with the documentation in the release notes or interface

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

definition documents for a particular release, those documents should

simplified overview to act as an introduction to Pegasus.

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

introduction to OpenPegasus.

<hr>

OpenPegasus - A Manageability

OpenPegasus - A Manageability Services Broker

Services Broker for the DMTF CIM/WBEM Standards

for the DMTF CIM/WBEM Standards

Tagline: OpenPegasus is an object manager for

DMTF CIM objects written in C++

and hosted by The Open Group

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

and supported by The Open Group

STATUS: Revised Sept 2005 for  Pegasus release version

STATUS: Revised November 2003 for  Pegasus release version 2.3.0

2.5.0 

- Draft

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

Table of Contents

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

<a href="#Overview"> Overview</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="#Availability of Pegasus">Availability of Pegasus</a>

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

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

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

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

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

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

</blockquote>

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

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

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

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

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

software</a>

<a href="#Pegasus Installation">Installation</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="#Building Pegasus">Building Pegasus </a>

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

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

<a href="#note_bld_peg_lnx">Notes

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

about Building Pegasus on Linux</a>

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

<a href="#bld_peg_win">Building

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

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

Providers</a>

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

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

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

</blockquote>

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

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

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

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

</blockquote>

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

<hr>

<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="#Installing the Pegasus HTML Test Client">Installing the Pegasus HTML Test Client

</a>

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

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

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

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

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

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

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

OpenPegasus (also referred to as Pegasus):

OpenPegasus (also referred to as Pegasus):

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

written

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

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

interfaces, an implementation of the CIMOperations over HTTP operations

implemenation of the CIMOperations over HTTP operations and their cimxml HTTP

and their cimxml HTTP encodings, and Interface libraries

encodings, and

Interface libraries

for both client and providers. It is maintained

consistent with the DMTF CIM and WBEM specifications except for  exceptions

consistent with the DMTF CIM and WBEM specifications except for 

noted in the documentation.

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

OpenPegasus includes components for:

Group. Pegasus is maintained under the license defined in the doc directory

<ol>

(LICENSE) of this release. This licensing is intended to support as wide a

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

Indications, and

includes class and instance repositories and interfaces for creating

CIM

Providers and CIM Clients.</li>

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

languages (i.e.

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

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

<li>A mof compiler.</li>

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

test functions,

and administration functions.</li>

<li>More complete information on the exact functions

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

OpenPegasus release.</li>

</ol>

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

license.

OpenPegasus is being developed and maintained under the auspices of

The

Open

Group.  OpenPegasus is maintained under the license defined in the

doc

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

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

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

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>

<a target="blank"

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

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

release of Pegasus

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

<ul>

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

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

<ol>

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

Pegasus can be obtained via any of the following:

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

<ol>

<li>Released tarballs (see <a

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

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

tarballs link</a>)</li>

in the CVS for each release.

<li>CVS (See <a

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

<tr>

code repository</a> for

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

more information.)</li>

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

<li>Linux RPMs. See

</tr>

(<a

<tr>

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

link</a> for

more information

</tr>

)</li>

<tr>

</ol>

</ol>

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

</tr>

have. We

<tr>

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

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

</tr>

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

<tr>

tar and zip file formats on the web site.

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

server;

</tr>

</table>

CVS

write accounts are managed by Martin Kirk of The Open Group

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

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

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

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

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;

Pegasus is regularly tested against a variety of platforms by the

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

here: <a

cvs.opengroup.org:/cvs/MSB

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

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

using the password authenticating server option (pserve).

regarding the platforms. <a

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

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

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

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

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

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

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

The major components of Pegasus are:

<ul>

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

</li>

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

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

an instance repository. Note that these repository were created for

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

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

</li>

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

C++ interfaces and using the WBEM HTTP/XML protocols or directly

interfacing with Pegasus.

</li>

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

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

its subdirectories

</li>

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

Pegasus that uses a WEB server (ex. Apache) with a set of CGI modules and

HTML to allow the entry of Pegasus operations from a WEB browser as forms

and the receipt of the response as WEB pages. This has proven useful as a

test tool and can be used for a wide variety of demonstrations.

</li>

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

C++ interfaces.

</li>

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

including providers for test and demonstration.

</li>

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

components to extend Pegasus capabilites.

</li>

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

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

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

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

</li>

</ul>

<h1>

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

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

Generally Pegasus is supported on the following Platforms and Compilers.

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

<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

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

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

GNUMAKE 3.79.1 successfully both in Windows and Linux environments.

using GNUMAKE 3.79.1 successfully both in Windows and Linux

environments.

GNUMAKE is available from :

GNUMAKE is available from :

<a target="blank"

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

       NOTE: A set of the required tools for

windows platforms is available on the openpegasus web site.

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

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

MOF

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

compiler and WQL

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

parser.  <font

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

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

and effectively provides the functions of these utilities that GNUMAKE

development of the parsers, not for building Pegasus.

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

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

combination of text files

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

and the Pegasus header files themselves. This documentation is

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

formatted with DOC++ and GAWK.   <font

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

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

before you initiate the Pegausu make.

interface documentation set.

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

4. ICU Internationalization libraries - These libraries are

WEB site.

used as the basis for message catalogs for message

internationalization. See the ICU website

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

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

libraries

5. OpenSSL - If it

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

is intended to use SSL on the

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

communication protocol, the OpenSSL libraries are required.

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

to be made to the files for parsing and compiling.

NOTE: A set of the required

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

tools for windows platforms is available on the openpegasus web

and the Pegasus header files themselves. This documentation is formatted

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

with DOC++ and GAWK. These tools are required if the documentation is to

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

be recreated but we expect that only the core team will be recreating

documentation.

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

directory (on CVS)

5. ICU Internationalization libraries - These libraries are used as

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

the basis for message catalogs for message internationalization. See the ICU

Here is a list of useful

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

commands:

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

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

<span

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

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

class="norm">Some of

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

the basic commands:

installed either from one of the snapshots or from CVS.

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

This structure is generally as follows:

for

Pegasus Source Structure

more information about administering the Pegasus CIMServer.

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

<li>cimserver daemon=true  (Start the server

depends tests </li>

cimserver)</li>

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

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

tests Test programs for the common functions</li>

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

<li>Compiler Pegasus MOF compiler

with

</li>

config flags)</li>

<li>Config Pegasus Configuration

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

functions</li>

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

<li>Consumer Indication Consumer class

OperatingSystem provider)</li>

header</li>

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

<li>ControlProviders Implementation of Pegasus internal providers

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

</li>

</li>

<li>ExportClient Client connect code

<li>cimuser -l  (Lists the users )

for export of indications</li>

</li>

<li>ExportServer Server code for

</ul>

import of indications</li>

Note:  there are some differences between windows and other

<li>Handler Indication handlers. Today

platforms in

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

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

<li>HandlerService Common code for

platforms use

indication handler service</li>

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

<li>IndicationService Common service

windows it

functions for indication subscription processing</li>

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

<li>Listener Common code that allows

and then

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

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

<li>Protocol Pegasus Client HTTP/XML Protocol Modules

explains the

depends </li>

exact format of the start and stop options.<br

<li>Provider Pegasus Provider interface functions

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

</li>

<br

<li>ProviderManager Provider Manager service that manages providers

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

</li>

Makefile commands

<li>ProviderManager2 Pluggable Provider Manager service.

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

Pegasus includes several make files that enable

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

you to quickly build or

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

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

<li>Repository Pegasus Repository

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

Interfaces and Simple Repository tests

supplied targets.

The following list contains some of the make targets that are

supported:

<ul>

<li>Tests for Repository Functions

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

</li>

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

</ul>

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

</li>

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

<li>Security Authentication and user

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

support functions.</li>

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

<li>Server Pegasus Server Modules

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

</li>

</ul>

<li>WQL the WQL query language

<span

interpreter.</li>

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

</ul>

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

</li>

make targets, refer to the make files.

</ul>

</li>

TestMakefile

<li>Providers Pegasus test and required providers

commands

<ul>

<font

<li>generic A number of

color="RED"> TestMakefile is a

cross-platform providers

make file

</li>

that in the top level Pegasus source directory that defines

<li>IndicationConsumer - Provider that

functionality to

consumes indications</li>

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

<li>Linux - A number of linux

the

providers</li>

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

<li>ManagedSystem Providers

Pegasus

associated with managing the Pegasus System</li>

source package.

<li>slp -  Provider for slp

Example:

service agent support</li>

From the $PEGASUS_ROOT directory.

<li>statistic - Providers for

make -f TestMakefile [testoption]

Pegasus statistics.</li>

<li>sample Sample providers for the

## rebuild -

major provider types.</li>

Rebuild

<li>testproviders </li>

</ul>

## build - Build

</li>

<li>Server Pegasus executable build

## prestarttests - Execute

</li>

functional tests

<li>Standard Includes - </li>

## poststarttests - Execute

<li>test - Directory of end-end

poststarttests (No security, No SSL)

tests that are regularly conducted on Pegasus</li>

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

## tests - Execute prestarttests and

</li>

poststarttests

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

in the normal make. </li>

## standardtests - Execute

<li>WMIMapper Pegasus implementation that

poststarttests and a series of

provides mapping to Microsoft WMI objects.

## posstarttests using multiple

</li>

options.

</ul>

##

Pegasus Run Time directory structure (PEGASUS_HOME

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

documentation creation, etc. are put here.

Some examples:

make -f TestMakefile prestarttests

- runs the unit tests, builds

the repositories.

make -f TestMakefile poststarttests

- starts the server, runs

the poststarttest suites

(make poststarttests plus

more)

make -f TestMakefile tests -

combines prestarttests and

poststarttests

make -f TestMakefile standardtests -

runs the basic poststarttests (make

poststarttests) multiple

times with various options.

BuildMakefile

commands

Some examples:<br

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

make -f pegasus/mak/BuildMakefile

cleanbuild - Remove the existing pegasus <span

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

checkout of the pegasus

source,

build, and run tests.

make -f pegasus/mak/BuildMakefile

removeall

- Remove the existing pegasus

directory.

<span

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

-f pegasus/mak/BuildMakefile

recheckout - Remove the existing pegasus

directory and perform a CVS

checkout of the pegasus

source.

The following sequence builds the

tree, the repository, the testrepository,

starts the server and runs

the server tests suites.

make world

make testrepository

make -f TestMakefile poststarttests

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

The documentation is currently in preparation.  Much of Pegasus

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

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

openly available on the PEGASUS web site.  The preliminary

documentation

is not provided with this release. The current documentation is

maintained both as a manual created

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

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

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

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

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

source directory of CVS.

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

of most

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

and

design documentation.

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

Contributors

are welcome to participate in the OpenPegasus development effort. Join

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

Mailing Lists.

<h1>

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

RPM installation instructions can be found here: <a

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

Verify  Dependencies

Before

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

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

section.</a>

<a name="set_envt_var">Set the environment

variables

</a>

Before installing or running OpenPegasus, environment variables may

have to be defined or updated.

<a

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

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

to use OpenPegasus.

<ul>

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

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

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

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

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

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

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

binaies.

you

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

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

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

<ol>

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

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

skeleton of the object. </li>

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

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

building the repository.

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

<h1>

</ol>

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

The providers included with Pegasus are automatically entered into the

repository

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

2. Define the following three environment variables:

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

<ul>

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

<li> Removes the existing repository if one

</li>

exists.</li>

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

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

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

objects).  </li>

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

<li>Loads

</li>

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

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

CIM indications

platform identifier.</li>

(SNMP, Events, Alert, Threshold, etc)

</ul>

internal to the Pegasus. </li>

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

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

src/Providers)  </li>

</ul>

<h2>

<a name="reg_prov">Registering

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

Pegasus registers providers with a set of provider registration

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

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

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

Interop

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

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

status.

Registration

is performed by creating instances of the

registration classes that represent the provider module, providers,

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

registration today is to copy from one of the existing registration

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

several registration instance implementations that do work with

OpenPegasus

today.

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

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

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

variables set (PEGASUS_HOME, PEGASUS_ROOT, PEGASUS_PLATFORM.  For

32 bit linux, the definition of PEGASUS_PLATFORM is normally

LINUX_IX86_GNU).

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

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

Visual

C++ </a></h2>

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

regularly tested on both Windows 2000 and Windows XP using the

Microsoft compilers.

Today we build OpenPegasus 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 OpenPegasus <a

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

before trying to compile OpenPegasus 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 (Note: <span

This identifier has the following form:

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

<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 

pegasus/mak

</blockquote>

<h3>

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

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

In order to provide a consistent build structure across multiple

<ol>

platforms, we

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

developed a small utility to provide a consistent set of small

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

utilities

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

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

the repository with the current CIM Schemas.

contains

</li>

many

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

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

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

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

manually:

<ol>

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

object.

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

when a

specific object is activated.

</ol>

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

make repository.

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

Runs MOF compiler (cimmofl) on:

-Schema v2.7

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

-PG_InterOp

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

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

-PG_ManagedSystem

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

in Pegasus (which are located in src/Providers)

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

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>

<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 Interop schema, experimental versions starting

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

to final status.

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

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

etc. to be registered.  The easiest way to create a new registration today

is to copy from one of the existing registration MOFs.  See the

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

implementations that do work with Pegasus today.

<h1>

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

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

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

The MU utility supports globing (expansion of wildcards) so

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

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

of the distribution of Pegasus.

available as part

of the distribution of OpenPegasus.

<h1>

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

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

Linux </a></h1>

directory.

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

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

distribution

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

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

PEGASUS_PLATFORM is normally LINUX_IX86_GNU.

before you initiate the OpenPegasus make.

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

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

</a></h1>

WEB site.

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

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

distributed with Pegasus. Make sure

Building OpenPegasus with SSL

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

</a></h2>

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

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

OpenSSL

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

standard

directory so OpenPegasus 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

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

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

in Pegasus

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

certificates" for more information of how to use SSL.

SSL

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

<h1>

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

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

using OpenPegasus with SSL.

<h1>

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

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

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

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

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

CVS

supported, Visual Studio 6.0, SP5 is supported) and the GNUMAKE make utility. 

environment, including:

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

<ul>

platform. The

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

built specifically to test OpenPegasus, or parts of OpenPegasus,

following is the basic setup steps for the environment.

including

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

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

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

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

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

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

"make testrepository" functions including test namespaces and extra

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

classes and instances in those namespaces and additional providers from

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

For Windows, try the following for an example environment:

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

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

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

providers/testProviders directory </li>

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

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

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

for

set PEGASUS_DEBUG=true

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

REM set PEGASUS_ROOT to top of source tree

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

set PEGASUS_ROOT=C:/cimom/pegasus

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

REM set PEGASUS_HOME to where you want repository and executables

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

set PEGASUS_HOME=%PEGASUS_ROOT%

directories immediately below their corresponding source code

REM setup the path to the runtime files.

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

set path=%path%;%PEGASUS_HOME%/bin

directory). Unit tests are executed without the server being

</pre>

operational and normally do not require the existence of a Class

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

repository. </li>

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

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

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

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

the formatting and connections. It requires a WEB server, etc. The

the make file TestMakefile in the PEGASUS_ROOT directory to execute

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>

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

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

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

documentation.<h1><a name="Commands">Commands</a></h1>

</ul>

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:

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

bin/cimserver �s (Shuts it down)

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

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

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

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

libraries are used

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

bin/cimuser �a �u guest �w ThePassword

load messages in different languages, format currency and numbers

bin/cimuser �l (lists the users)

according to

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

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

</pre>

OpenPegasus

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

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

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

must be

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

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

EMAIL="test@email.address"

docs

HOSTNAME=`uname -n`

directory for details.

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

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

When users run "make poststarttests"

> $PEGASUS_HOME/ssl.cnf

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

chmod 644 $PEGASUS_HOME/ssl.cnf

are

chown bin $PEGASUS_HOME/ssl.cnf

run that

chgrp bin $PEGASUS_HOME/ssl.cnf

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

specific

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

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

-nodes -config $PEGASUS_HOME/ssl.cnf \

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

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

hardcoded default messages within OpenPegasus. These hardcoded default

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

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

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

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

fail.

environment variable called PEGASUS_USE_DEFAULT_MESSAGES must exist prior to

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

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

environment variable called PEGASUS_USE_DEFAULT_MESSAGES must exist

messages generated will be the default hardcoded messages. This will enable

prior to

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

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

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

all

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

messages generated will be the default hardcoded messages. This will

using ICU resource bundles. <h1><a name="Pegasus Documentation">Pegasus Documentation</a></h1>

enable

The documentation is currently in preparation.  Much of Pegasus is

"make poststarttests" to complete successfully. Once "make

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

poststarttests" is

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

complete, you should stop the cimserver and then undefine

on the PEGASUS web site.  The preliminary documentation

PEGASUS_USE_DEFAULT_MESSAGES. If this variable is left defined,

is not provided with this release. The current documentation is maintained both as a manual created

OpenPegasus

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

will not be able to load messages

to create), as an api document also creatable from the source tree (see doc/apidoc)

using ICU resource bundles.

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

When

available in the root source directory of CVS.

running the make tests command with ICU enabled, the PEGASUS_MSG_HOME

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

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

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

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

design documentation. <h1><a name="Participate!">Participate!</a></h1>

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

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

for PEGASUS_MSG_HOME.

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.

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

Hewlett-Packard Development 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

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

</big></big>

</body>

</html>

Legend:

Removed from v.1.2.2.1
changed lines
	Added in v.1.13

No CVS admin address has been configured