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.11 and 1.11.2.3

version 1.11, 2006/02/18 03:27:11

version 1.11.2.3, 2006/07/12 19:53:48

Line 1

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

<html>

<head>

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

<title>OpenPegasus</title>

</head>

<body>

Pegasus Enhancement Proposal (PEP)

PEP #: 235

Title: OpenPegasus

Version 2.5 Release Readme file

Release 2.5.1 and subsequent 2.5 minor releases Readme file

Version: <span

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

Version:

1.3

Created: 6 Sept

Created: 20th March 2006

2005

Authors: Warren

Authors: Martin Kirk

Grunbok

Status:  draft

Status:  Draft

Version History:

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

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

<tbody>

<tr>

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

Line 64

Line 39

</tr>

<tr>

<td align="center">March 20th 2006</td>

<td align="center">Warren Grunbok

<td align="center">Martin Kirk</td>

</td>

<td>First draft, basically unchanged from 2.5 ReadMe except for version

<td>Initial draft

numbers and typos</td>

</td>

</tr>

<tr>

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

</td>

<td style="vertical-align: top; text-align: center;">March 23rd 2006</td>

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

<td style="vertical-align: top; text-align: center;">Martin Kirk</td>

Sept 2005

</td>

Draft for ballot incorporating draft 1.0

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

comments.</td>

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;" align="center">March 26th 2006</td>

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

<td style="vertical-align: top;" align="center">Martin Kirk</td>

</td>

<td style="vertical-align: top;">Draft for Steering Committee approval.

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

Approved</td>

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

July 12th 2006</td>

</td>

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

Karl Schopmeyer</td>

Grunbok

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

</td>

that it applies to subsequent 2.5 minor releases.

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

(Note Approved)</td>

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 OpenPegasus Version 2.5.0 Release. Note that if this readme

the OpenPegasus Version 2.5.1 Release and subsequent minor releases. 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

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

introduction to OpenPegasus.

<hr>

OpenPegasus - A Manageability

Line 133

Line 92

DMTF CIM objects written in C++

and hosted by The Open Group

STATUS: Revised Sept 2005 for  Pegasus release version

STATUS: Revised July 2006 for  Pegasus release version 2.5.1 and

2.5.0 

subsequent releases  - Draft (Change to Architecture

- Draft

Team Approved)

<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_sup_plat">Pegasus Supported Platforms</a>

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

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

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

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

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

</blockquote>

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

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

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

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

Obtain Pegasus in Source Code or Binary Executable Format</a>

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

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

software</a>

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

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

<a href="#build_peg">Building Pegasus</a><blockquote style="margin-top: 0pt; margin-bottom: 0pt;">

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

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

and repository</a>

<a href="#note_bld_peg_ssl">Building Pegasus with SSL</a>

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

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

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

<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"> <a href="#mu_utility">The MU Utility</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>

<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

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

</blockquote>

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

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

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

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

<blockquote style="margin-top: 0pt; margin-bottom: 0pt;"> <a href="#test_icu">Testing with ICU enabled</a></blockquote>

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

<a href="#sec0">Security Considerations</a>

</blockquote>

<hr>

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

OpenPegasus (also referred to as Pegasus):

Line 189

Line 140

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

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

languages (i.e.

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

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

<li>A number of CIM clients and providers for basic instrumentation.</li>

<li>A mof compiler.</li>

<li>A number of CIM server administration commands.</li>

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

<li>A MOF compiler.</li>

test functions,

<li>A number of sample CIM clients and providers to provide usage examples,</li>

and administration functions.</li>

<li>CIM server test functions providing both unit tests and end-to-end

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

OpenPegasus is being developed and maintained under the auspices of The Open

The

Group.  OpenPegasus is maintained under the license defined in pegasus/doc/license.txt.

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.

distribution as possible with minimal demands on the users.

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

documentation on

Pegasus are available from the OpenGroup WEB site.

<a target="blank"

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

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

<ol>

Pegasus can be obtained via any of the following:

<ol>

<li>Released tarballs (see <a

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

tarballs link</a>)</li>

<li>CVS (See <a

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

code repository</a> for

more information.)</li>

<li>Linux RPMs. See

(<a

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

link</a> for

more information

)</li>

</ol>

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

have. We

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

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

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

tar and zip file formats on the web site.

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

server;

CVS

write accounts are managed by Martin Kirk of The Open Group

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

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

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

documentation on

Pegasus are available from the OpenGroup WEB site -     <a target="blank" href="http://www.openpegasus.org/">http://www.openpegasus.org</a>

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

Pegasus is regularly tested against a variety of platforms by the

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

here: <a

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

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

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

regarding the platforms. <a

regarding the platforms. 

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

PEP 249 is the Release Notes PEP for 2.5.x.

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

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

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

The manpages for each of the commands can be found in the Pegasus source

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

tree in the pegasus/rpm/manLinux/ directory.

packages and tools. Currently Pegasus has the following dependencies:

To see simple help for a command, invoke it with the "--help" option.

Here is a list of useful

1. GNUMAKE - To simplify the building of Pegasus across

commands:

multiple platforms we

Some of

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

using GNUMAKE 3.79.1 successfully both in Windows and Linux

environments.

GNUMAKE is available from :

<a target="blank"

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

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

MOF

compiler and WQL

parser.  <font

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

development of the parsers, not for building Pegasus.

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

combination of text files

and the Pegasus header files themselves. This documentation is

formatted with DOC++ and GAWK.   <font

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

interface documentation set.

4. ICU Internationalization libraries - These libraries are

used as the basis for message catalogs for message

internationalization. See the ICU website

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

libraries

5. OpenSSL - If it

is intended to use SSL on the

communication protocol, the OpenSSL libraries are required.

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 "--help" flag.

Here is a list of useful

commands:

<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

Line 333

Line 195

<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

<li>cimuser -a -u guest -w <ThePassword> (Adds the user guest with specified password)

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

</li>

<li>cimuser -l  (Lists the users )

</li>

Line 347

Line 208

windows it

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

and then

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

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

explains the

exact format of the start and stop options.<br

exact format of the start and stop options.<h4><a name="docs">Pegasus Documentation</a></h4>

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

Much of Pegasus

<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

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

openly available on the PEGASUS web site.  The preliminary

openly available on the PEGASUS web site. The current documentation is

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

Line 500

Line 227

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

and

design documentation.

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

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

Contributors

are welcome to participate in the OpenPegasus development effort. Join

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

the mailing list by visiting <a href="http://www.openpegasus.org/">http://www.openpegasus.org</a> and clicking on

Mailing Lists.

Mailing Lists. Joining the pegasus-l mailing list will provide a login/password

for the website.

<h1>

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

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

RPM installation instructions can be found here: <a

<h4><a name="download">Obtain Pegasus in Source Code or Binary Executable Format</a></h4>

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

Verify  Dependencies

Before

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

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

section.</a>

<a name="set_envt_var">Set the environment

variables

</a>

Before installing or running OpenPegasus, environment variables may

have to be defined or updated.

<a

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

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

to use OpenPegasus.

<ul>

</ul>

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

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

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

Pegasus can be obtained via any of the following:

skeleton of the object. </li>

<ol>

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

<li>Released tarballs (see

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

<a href="http://www.openpegasus.org/page.tpl?ggid=392">Release

tarballs link</a>)</li>

<li>CVS (See <a href="http://www.openpegasus.org/page.tpl?ggid=667">CVS

code repository</a> for

more information.)</li>

<li>Linux RPMs. See

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

link</a> for

more information

)</li>

</ol>

NOTE: Linux RPMs are only available for a limited set of releases.

The distribution is available via CVS and snapshot images in

tar and zip file formats on the web site.

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

cvs.opengroup.org. The source can be checked out anonymously using the

instructions at <a href="http://www.openpegasus.org/protected/page.tpl?ggid=667">

http://www.openpegasus.org/page.tpl?ggid=667</a>

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

RPM installation instructions can be found here: <a href="http://www.openpegasus.org/pr/">http://www.openpegasus.org/pr</a>

<h4><a name="peg_dep">Verify Dependencies</a></h4>

The providers included with Pegasus are automatically entered into the

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

repository

packages and tools. Currently Pegasus has the following dependencies:

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

1. GNUMAKE - To simplify the building of Pegasus across

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

multiple platforms we

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

using GNUMAKE 3.79.1 successfully both in Windows and Linux

environments.

<ul>

GNUMAKE is available from :

<li> Removes the existing repository if one

exists.</li>

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

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

objects).  </li>

MOF

<li>Loads

compiler and WQL

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

parser.  These tools are required only for

CIM indications

development of the parsers, not for building Pegasus.

(SNMP, Events, Alert, Threshold, etc)

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

internal to the Pegasus. </li>

combination of text files

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

and the Pegasus header files themselves. This documentation is

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

formatted with DOC++ and GAWK.   These tools are required to build the

src/Providers)  </li>

interface documentation set.

</ul>

<h2>

4. ICU Internationalization libraries - These libraries are

<a name="reg_prov">Registering

used as the basis for message catalogs for message

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

internationalization. See the ICU website

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

Pegasus registers providers with a set of provider registration

libraries

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

5. OpenSSL - If it

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

is intended to use SSL on the

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

communication protocol, the OpenSSL libraries are required.

Interop

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

NOTE: A set of the required

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

tools for windows platforms is available on the openpegasus web

status.

site.  <a href="http://www.openpegasus.org/pp/uploads/40/Pegasus24/www.openpegasus.org">www.openpegasus.org</a>

Registration

<h4><a name="set_envt_var">Set the Environment

is performed by creating instances of the

Variables</a></h4>

registration classes that represent the provider module, providers,

Before installing or running OpenPegasus, environment variables may

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

have to be defined or updated.

registration today is to copy from one of the existing registration

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

PEP 237 contains the list of environment variables and setup necessary

several registration instance implementations that do work with

to use OpenPegasus.

OpenPegasus

At a minimum, the following need to be set:

today.

PEGASUS_ROOT=<location of your pegasus source tree>

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

PEGASUS_HOME=<location for the built executables, repository, etc>

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

PEGASUS_PLATFORM=<your platform>

</blockquote>

For a list of valid

platforms, enter "make listplatforms" from the root of the Pegasus

source tree.

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

<div>

To accept the default build options and get started quickly, use the</div>

<div>

following commands from the root of the Pegasus source tree:</div>

<div>

make build</div>

<div>

      This will build the dependencies, any utilities that are needed,

all</div>

<div>

      the Pegasus and test executable code, and do any necessary setup

to</div>

<div>

run the CIM Server.</div>

<div>

make alltests</div>

<div>

      This will run the unit tests, create the repository by compiling

in</div>

<div>

      the MOF for the default CIM Schema (2.9 for Pegasus 2.5.1

and 2.5.2),

compile</div>

<div>

in the MOF for all Pegasus test cases, do any other configuration</div>

<div>

      necessary to run the tests, and then run a large automated test

suite</div>

<div>

to verify Pegasus CIM Server functionality.` </div>

<div>

There are many variations possible. Refer to PEP 237 for possible build

and</div>

<div>

run-time configuration options. Enter "make usage" for more information

on</div>

<div>

make targets that are available for building and testing Pegasus.</div>

</div>

<h4><a name="note_bld_peg_lnx">Building OpenPegasus on Linux </a></h4>

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

LINUX_IX86_GNU).

<h4><a name="note_bld_peg_ssl">Building OpenPegasus with SSL

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

</a></h4>

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

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

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=true variable set. Then just run 'make'

in Pegasus

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

SSL

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

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

using OpenPegasus with SSL.

<h4><a name="bld_peg_win">Building OpenPegasus on Windows 2k or Windows XP with Microsoft

Visual

C++ </a></h2>

C++ </a></h4>

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

regularly tested on both Windows 2000 and Windows XP using the

Line 613

Line 407

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

make utility.  Note that you MUST have the OpenPegasus <a href="#mu_utility">mu.exe </a>utility compiled and available

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.

Line 626

Line 419

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

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>

<h6>

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

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

In order to provide a consistent build structure across multiple

platforms, we

Line 670

Line 462

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

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

Building OpenPegasus with SSL

</a></h2>

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

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

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

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

standard

you

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

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

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

<ol>

your OpenSSL

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

installation is.

skeleton of the object. </li>

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

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

</ol>

The providers included with Pegasus are automatically entered into the

repository

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

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

in Pegasus

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

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

SSL

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

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

<ul>

using OpenPegasus with SSL.

<li> Removes the existing repository if one

exists.</li>

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

objects).  </li>

<li>Loads

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

CIM indications

(SNMP, Events, Alert, Threshold, etc)

internal to the Pegasus. </li>

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

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

src/Providers)  </li>

</ul>

<h1>

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

<a name="reg_prov">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 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.

<h1>

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

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

CVS

Line 702

Line 529

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

built specifically to test OpenPegasus, or parts of OpenPegasus,

including

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

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

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

pegasus/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 providers/testproviders directories. </li>

the pegasus/Providers/sample and pegasus/Providers/TestProviders directories. </li>

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

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

the major provider types in the pegasus/Providers/sample directories and the

providers/testProviders directory </li>

pegasus/Providers/TestProviders directory </li>

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

for

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

Line 729

Line 556

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

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

</ul>

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

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

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

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

libraries are used

Line 779

Line 604

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

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

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

for PEGASUS_MSG_HOME.

for PEGASUS_MSG_HOME.

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

<h1>

<a name="sec0">Security Considerations</a></h1>

Some of the steps of installing and running Pegasus have

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

security properties that you should be aware of. If you plan to administer a

VERITAS Software Corporation

Pegasus server, see the 'security considerations' section of the administrators

guide <pointer>. If you plan to write clients or providers for integration into

Pegasus, see the developer's security guidance.

</pointer>

<hr>

L.P.; IBM Corp.;

EMC Corporation; Symantec Corporation; The Open Group.

Permission is hereby granted, free of charge, to any

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

person obtaining a copy  of this software and associated

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

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

deal in the Software without restriction, including without limitation the

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

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

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

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

the Software, and to permit persons to whom the Software is furnished

furnished to do so, subject to the following conditions:

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

THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE

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

SHALL BE INCLUDED IN ALL COPIES OR SUBSTANTIAL PORTIONS OF THE

LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR

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

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

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

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

WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

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

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

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

LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION

<hr>

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

<big><big>End of Document

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

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

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

</big></big>

</body>

</html>

</body></html>

Legend:

Removed from v.1.11
changed lines
	Added in v.1.11.2.3

No CVS admin address has been configured