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

version 1.7, 2004/10/18 18:20:06

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

Line 1

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

<html>

<head>

Line 9

Line 39

</head>

<body>

Pegasus Enhancement Proposal (PEP)

PEP #: 175

PEP #: 235

Title: OpenPegasus

Version 2.4 Release Readme file

Version 2.5 Release Readme file

Version: <span

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

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

Created: 24 June

2004

Created: 6 Sept

2005

Authors: Warren

Grunbok, Mike Harris

Grunbok

Status:  draft

Version History:

Line 32

Line 64

</tr>

<tr>

<td align="center">Warren Grunbok

</td>

<td>Initial draft

</td>

</tr>

<tr>

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

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

</td>

<td align="center">Warren Grunbok

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

Sept 2005

</td>

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

<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;">31, August 2004

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

</td>

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

</td>

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

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

review.  Removed /Directory structure section and placed

1.1

into  seperate document.

</td>

</tr>

<tr>

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

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

</td>

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

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

</td>

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

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

Grunbok

</td>

<td style="vertical-align: top;">Removed Pegasus Directory

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

structure and placed in PEP 191, Added Copyright and End of Doc marker.

to -

</td>

</tr>

<tr>

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

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

</td>

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

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

Sept 2004

</td>

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

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

Grunbok

</td>

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

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

Security changes as per Sterling.

</td>

</tr>

</tbody>

</table>

<hr>

Abstract:  Installation, build, operation information on

the Pegasus Platform Version 2.4.0 Release. Note that if this readme

the OpenPegasus Version 2.5.0 Release. Note that if this readme

conflicts with the documentation in the release notes or interface

definition documents for a particular release, those documents should

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

introduction to Pegasus.

introduction to OpenPegasus.

<hr>

OpenPegasus - A Manageability

Services Broker for the DMTF CIM/WBEM Standards

Tagline: OpenPegasus is an object manager for

DMTF CIM objects written in C++

and supported by The Open Group

and hosted by The Open Group

STATUS: Revised Sept 2004 for  Pegasus release version

STATUS: Revised Sept 2005 for  Pegasus release version

2.4.0 

2.5.0 

- Approved

- Draft

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

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

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

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

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

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

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

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

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

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

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

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

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

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

</blockquote>

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

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

Line 128

Line 156

and repository</a>

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

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

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

<a href="#note_bld_peg_lnx">Notes

about Building Pegasus on Linux</a>

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

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

href="#crt_ssl_cert">Creating SSL

certifications</a>

</blockquote>

<a href="#bld_peg_win">Building

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

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

Line 144

Line 167

</blockquote>

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

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

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

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

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

</blockquote>

<hr>

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

OpenPegasus (also referred to as Pegasus):

OpenPegasus (also referred to as Pegasus):

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

written

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

interfaces, an implemenation of the CIMOperations over HTTP operations

interfaces, an implementation of the CIMOperations over HTTP operations

and their cimxml HTTP encodings, and Interface libraries

for both client and providers. It is maintained

consistent with the DMTF CIM and WBEM specifications except for 

exceptions

noted in the documentation.

noted in the documentation.

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

OpenPegasus includes components for:

license.

<ol>

Pegasus is being developed and maintained under the auspices of The

<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. Pegasus is maintained under the license defined in the doc

Group.  OpenPegasus is maintained under the license defined in the

more complete documentation.

NOTE: A set of the required

tools for windows platforms is available on the openpegasus web

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

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

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

directory (on CVS)

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

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

Here is a list of useful

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

commands:

</blockquote>

<span

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

class="norm">Some of

the basic commands:

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

for

more information about administering the Pegasus CIMServer.

<ul>

<li>cimserver daemon=true  (Start the server

cimserver)</li>

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

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

with

config flags)</li>

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

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

OperatingSystem provider)</li>

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

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

</li>

<li>cimuser -l  (Lists the users )

</li>

</ul>

Note:  there are some differences between windows and other

platforms in

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

platforms use

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

windows it

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

and then

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

explains the

exact format of the start and stop options.<br

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

<br

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

Makefile commands

Pegasus includes several make files that enable

you to quickly build or

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

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

supplied targets.

The following list contains some of the make targets that are

supported:

<ul>

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

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

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

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

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

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

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

</ul>

<span

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

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

make targets, refer to the make files.

TestMakefile

commands

<font

color="RED"> TestMakefile is a

make file

that in the top level Pegasus source directory that defines

functionality to

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

the

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

Pegasus

source package.

Example:

From the $PEGASUS_ROOT directory.

make -f TestMakefile [testoption]

## rebuild -

Rebuild

## build - Build

## prestarttests - Execute

functional tests

## poststarttests - Execute

poststarttests (No security, No SSL)

## tests - Execute prestarttests and

poststarttests

## standardtests - Execute

poststarttests and a series of

## posstarttests using multiple

options.

##

Some examples:

make -f TestMakefile prestarttests

- runs the unit tests, builds

the repositories.

make -f TestMakefile poststarttests

- starts the server, runs

the poststarttest suites

(make poststarttests plus

more)

make -f TestMakefile tests -

combines prestarttests and

poststarttests

make -f TestMakefile standardtests -

runs the basic poststarttests (make

poststarttests) multiple

times with various options.

BuildMakefile

commands

Some examples:<br

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

make -f pegasus/mak/BuildMakefile

cleanbuild - Remove the existing pegasus <span

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

checkout of the pegasus

source,

build, and run tests.

make -f pegasus/mak/BuildMakefile

removeall

- Remove the existing pegasus

directory.

<span

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

-f pegasus/mak/BuildMakefile

recheckout - Remove the existing pegasus

directory and perform a CVS

checkout of the pegasus

source.

The following sequence builds the

tree, the repository, the testrepository,

starts the server and runs

the server tests suites.

make world

make testrepository

make -f TestMakefile poststarttests

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

The documentation is currently in preparation.  Much of Pegasus

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

Line 419

Line 500

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

and

design documentation.

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

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

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

Contributors

and

are welcome to participate in the OpenPegasus development effort. Join

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

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

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

Mailing Lists.

Mailing Lists.

<h1>

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

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

RPM installation instructions can be found here: <a

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

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

installation process includes the following steps:

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.

<ol>

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

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

<li>Set environment variables. </li>

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

repository. </li>

</ol>

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

Pegasus is freely available from the open group's Pegasus home page: <a

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

obtain Pegasus, you can either check it out using CVS or download a

snapshot image of the soruce distribution. For more information about

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

of Pegasus</a>.

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

using a script included with the source distribution. See <a

href="#bld_rpms">Building RPMs for Pegasus</a> for more information.

<a name="vfy_req_sw">Step 2: Verify that you have

the required software</a>

Refer to the section <a href="#peg_dep">Pegasus

Dependencies</a> and verify that you have the software required for

your Operating System and planned usage of Pegasus.

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

variables</a>

Before installing or running Pegasus, ensure that the following

environment variables have been defined or updated:

<dl>

<dt>PEGASUS_ROOT </dt>

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

CVS, for example: <tt>/opt/pegasus/pegasus-2.3.2</tt>

</dd>

<dt>PEGASUS_HOME </dt>

<dd>Defines the directory that will contain the output binary files.

For example, if you set this to <tt>$HOME/pegasus_home</tt>, then the

output will go into <tt>$HOME/pegasus_home/bin</tt> and <tt>$HOME/pegasus_home/lib.</tt>

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

PEGASUS_HOME value for each build you need, that way the output of each

build will be placed in its own directory, for example: <tt>$HOME/pegasus_home_LINUX_IX86_GNU.</tt>

</dd>

<dt>PEGASUS_PLATFORM </dt>

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

a unique identifier with the following form:

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>

</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>Enter <tt>make repository</tt>

This creates the repository, which is needed to serve data.

To create the additional namespaces that represent the test support you

can also execute "make testrepository".

</li>

<li> Enter <tt>make tests</tt>

This executes all the tests included with the Pegasus

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

are executed separately from the above because

they require the initiation of separate process for the Pegasus server

and

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

pegasus/mak/BuildMakefile. Refer to the prestarttests and

poststarttests in this file.

</li>

</ol>

The following make targets are supported:

<ul>

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

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

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

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

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

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

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

</ul>

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

Generally the build commands are as follows:

<ol>

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

executing make in the Pegasus root directory will make everything.

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

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

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

"make world".  This will build

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

Client/Server tests. </li>

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

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

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

enter/leave directory messages. </li>

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

structure. </li>

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

checkout is done,

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

cleanbuild" </li>

</ol>

<h2>

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

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

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

is done during the build 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

Line 599

Line 553

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

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

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

<ul>

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

<li> Removes the existing repository if one

objects). To do this, it runs the MOF compiler on the CIM schema: <tt>cimmofl

exists.</li>

-Schema v2.8</tt> </li>

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

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

objects).  </li>

<li>Loads

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

CIM indications

(SNMP, Events, Alert, Threshold, etc)

internal to the Pegasus schema by running the following command: <tt>cimmofl

internal to the Pegasus. </li>

-PG_InterOp</tt> </li>

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

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

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

by running: <tt>cimmofl -PG_ManagedSystem</tt> </li>

src/Providers)  </li>

</ul>

<h2>

<a name="reg_prov">Registering

Line 620

Line 576

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

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

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

is performed by creating instances of the

registration classes that represent the porvider module, providers,

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 Pegasus

several registration instance implementations that do work with

OpenPegasus

today.

<h2>

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

</h2>

The source distribution includes a script you can use to create an RPM

for Pegasus. To do this, your environment must meet the following

requirements:

<ul>

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

<li>Your environment variables must be set, as described in <a

href="#set_envt_var">Set evironment variables</a>. </li>

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

</ul>

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

directory of the source distribution. For example: <tt>.

/usr/source/pegasus-1.0/rpmBuild</tt>

This will result in and RPM file names <tt>pegasus<version

number>.rpm</tt>.

Note: After you install using the install using the

PRM, you must crate and populate teh repository manually.

Question: I'm still working on this procedure (I haven't gotten

it to work yet).

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

Building

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

Pegasus on Linux </a></h2>

Pegasus supports many distributions of Linux. Refer to <a

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

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

for more information.

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

variables set (PEGASUS_HOME, PEGASUS_ROOT, PEGASUS_PLATFORM.  For

32 bit linux, the definition of PEGASUS_PLATFORM is normally

LINUX_IX86_GNU.

LINUX_IX86_GNU).

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

on building Pegasus on Windows 2k or Windows XP with Microsoft Visual

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

Visual

C++ </a></h2>

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

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 Pegasus on Windows using a set of make files

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

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

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

before trying to compile Pegasus on the normal windows platform. The

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

Line 702

Line 627

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

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

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>

</blockquote>

<h3>

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

Line 711

Line 636

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

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

contains

many

commands. For example:

Line 732

Line 658

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

available as part

of the distribution of Pegasus.

of the distribution of OpenPegasus.

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

directory.

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

distribution

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

before you initiate the OpenPegasus make.

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

WEB site.

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

Building Pegasus with SSL

Building OpenPegasus with SSL

</a></h2>

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

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

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

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

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

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

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

SSL

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

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

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

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

using OpenPegasus with SSL.

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>

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

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

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

enviroment, including:

CVS

environment, including:

<ul>

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

built specifically to test Pegasus, or parts of Pegasus, including

built specifically to test OpenPegasus, or parts of OpenPegasus,

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>

the providers/sample and providers/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

<li>Unit Tests - Most OpenPegasus 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

Line 800

Line 730

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

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

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

libraries are used

load messages in different languages, format currency and numbers

according to

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

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

Pegasus

OpenPegasus

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

Line 825

Line 747

directory for details.

When users run "make poststarttests"

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

to verify the integrity of a OpenPegasus 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

hardcoded default messages within OpenPegasus. 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

Line 846

Line 769

"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

PEGASUS_USE_DEFAULT_MESSAGES. If this variable is left defined,

OpenPegasus

will not be able to load messages

using ICU resource bundles.

Line 859

Line 783

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

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

VERITAS Software Corporation

Legend:

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

No CVS admin address has been configured