pegasus/README.html - diff

Return to README.html CVS log

Up to [Pegasus] / pegasus

Diff for /pegasus/README.html between version 1.4 and 1.6.8.2

version 1.4, 2008/12/16 18:55:33

version 1.6.8.2, 2013/11/21 17:59:38

Line 6

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

<title>OpenPegasus 2.6 README</title>

<title>OpenPegasus README</title>

href="http://www.opengroup.org/stylesheets/info1+margins.css">

<style>

Line 20

</head>

<body>

<hr>

Abstract:  Installation, build, and operation

Abstract:  Installation, build,

information on

and operation information on

the OpenPegasus Version 2.8.0

the OpenPegasus . Note that if this readme

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 authoritative. This is a simplified

overview to act as an

introduction to OpenPegasus.

<hr>

OpenPegasus - A Manageability

OpenPegasus

- A Manageability

Services Broker for the DMTF CIM/WBEM Standards

Tagline: OpenPegasus is an object manager for

Tagline: OpenPegasus is

an object manager for

DMTF CIM objects written in C++

and hosted by The Open Group

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

Line 58

about Building on Linux</a>

<a href="#bld_peg_win">Notes about Building

on Windows</a>

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

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

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

</blockquote>

<a href="#note_bld_peg_ssl">Notes about

Building with SSL</a>

Line 69

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

</blockquote>

<hr>

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

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

<div style="margin-left: 40px;">OpenPegasus (also referred to

</h1>

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

<div style="margin-left: 40px;">OpenPegasus (also

referred to

as 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

Line 84

Line 87

exceptions

noted in the documentation.

OpenPegasus includes components for:

OpenPegasus includes

components for:

</div>

<li>A DMTF compliant CIM Server that processes CIM operations, CIM

<li>A DMTF compliant CIM Server 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

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

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

Server

test functions,

and administrative

functions.</li>

<li>More complete information on the exact functions

and their functional state is available from the Release Notes

(pegasus/ReleaseNotes.htm) and the OpenPegasus

(pegasus/ReleaseNotes.htm) and the OpenPegasus <a

href="http://www.openpegasus.org/page.tpl?CALLER=index.tpl&ggid=799">Feature

Status Page</a>.</li>

</ol>

</blockquote>

<div style="margin-left: 40px;">OpenPegasus is open source and is

<div style="margin-left: 40px;">OpenPegasus is open source

and is

covered under the MIT open-source

license.

</div>

OpenPegasus is being developed and

OpenPegasus is being

developed and

maintained under the auspices of

The

Open

Group.  OpenPegasus is maintained under the license defined in the

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.

Line 126

Line 135

wide a

distribution as possible with minimal demands on the users.

More information on this project, access

More information on this

project, access

to the CVS, and

documentation<span

style="text-decoration: line-through;"> is available

style="text-decoration: line-through;">

is available

from the Ope<span

style="text-decoration: line-through;">nPegasus web

style="text-decoration: line-through;">nPegasus

web

site.

<a target="blank"

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

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

Note

that all references in this readme to files in the OpenPegasus source

tree are of the form pegasus/..., where "pegasus" is the top-level

directory and also the name of the OpenPegasus module in the Pegasus CVS

directory and also the name of the OpenPegasus module in the Pegasus

repository. There are also  other CVS modules for the OpenPegasus Java client (pegasus-JavaCIMClient)

CVS

and for unsupported components and utilities for Pegasus that may be checked out

repository. There are also  other CVS modules for the

OpenPegasus Java client (pegasus-JavaCIMClient)

and for unsupported components and utilities for Pegasus that may be

checked out

separately.  You can use

<a href="http://cvs.opengroup.org/cgi-bin/viewcvs.cgi/">viewCVS</a> to view the

<a href="http://cvs.opengroup.org/cgi-bin/viewcvs.cgi/">viewCVS</a>

to view the

Pegasus CVS tree

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

<div style="margin-left: 40px;">OpenPegasus is distributed as open

<div style="margin-left: 40px;">OpenPegasus is distributed

as open

source under the MIT open-source

license. The distribution is available via CVS, and as snapshot images

Line 177

Line 194

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

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

OpenPegasus is regularly tested against a

OpenPegasus is regularly

tested against a

variety of platforms by the

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

development group.  The results of the nightly tests can be

found

here on our <a

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

Build and Test Status</a> page.  The Release Notes

Build and Test Status</a> page.  The Release Notes for each

release 

(pegasus/ReleaseNotes.htm) provide additional details

regarding the platforms for the current release.

regarding the platforms, compilers, etc. for the current release.

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

We have worked to minimize the dependence of OpenPegasus on other

software

packages and tools. Currently OpenPegasus has the following

dependencies:

dependencies. Note that all of the dependencis listed below are

required only if selected options are enabled except for GNUMAKE which

is the required make tool:

<li>GNUMAKE - To simplify the building of OpenPegasus across

<li>GNUMAKE - To simplify the building of

OpenPegasus across

multiple platforms we

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

using GNUMAKE 3.79.1 successfully both in Windows and Linux

environments. It is available from <a href="http://www.gnu.org">http://www.gnu.org</a>.

The windows version  of GNUMAKE is available on the Pegasus web site

The windows version  of GNUMAKE is available on the Pegasus

web site <a

href="http://www.openpegasus.org/pb/protected/index.tpl?CALLER=index.tpl">

tools page</a>.</li>

<li>FLEX and BISON - These tools were used to develop the MOF

<li>FLEX and BISON -

compiler and WQL and CQL parsers.  These tools are required ONLY for

These tools were used to develop the MOF

development of the parsers, not for building OpenPegasus.  Bison

compiler and WQL and CQL parsers.  These tools are required ONLY

for

development of the parsers, not for building OpenPegasus. 

Bison

version 2.3 or later and flex version 2.5.4 or later are required.</li>

<li>Doxygen - The OpenPegasus documentation is taken from a combination

<li>Doxygen - The OpenPegasus documentation

of text files and header files themselves. This documentation is formatted

is taken from a combination of text files and header files themselves.

with Doxygen and GAWK.  This is required ONLY if you want to

This documentation is formatted with Doxygen and GAWK.  This

build documentation from the source tree.  <font

is required ONLY if you want to build documentation

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

from the source tree.  <font

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

build the

interface documentation set. </li>

<li>ICU Internationalization libraries - These libraries are

<li>ICU Internationalization libraries -

These libraries are

used as the basis for message catalogs for message

internationalization. See the ICU website

(<a href="http://icu.sourceforge.net/">http://icu.sourceforge.net</a>)

for more information on these

libraries. These libraries are use ONLY if

libraries. These

you set the requisite environment variable ( PEGASUS_HAS_ICU) to use ICU

libraries are used ONLY if you set the requisite environment variable (

PEGASUS_HAS_ICU) to use ICU

</li>

<li>OpenSSL - If it

<li>OpenSSL

- If it

is intended to use SSL on the

communication protocol, the OpenSSL libraries are required (<a

href="http://www.openssl.org">http://www.openssl.org</a>).</li>

<li>OpenSLP - If you choose

<li>OpenSLP

- If you choose

to use

OpenSLP as your choice of SLP implementations, then it will need to be

installed and available to OpenPegasus. Refer to the

PEGASUS_USE_OPENSLP and PEGASUS_OPENSLP_HOME build variables in PEP

PEGASUS_USE_OPENSLP and PEGASUS_OPENSLP_HOME build variables in the

292, and the OpenSLP web site (<a href="http://www.openslp.org">http://www.openslp.org</a>).</li>

doc/BuildAndReleaseOptions.html file, and the OpenSLP web site (<a

<li>zlib - If you choose to

href="http://www.openslp.org">http://www.openslp.org</a>).</li>

<li>zlib

- If you choose to

enable the compressed repository feature with the

PEGASUS_ENABLE_COMPRESSED_REPOSITORY build variable, you will need to

install the gzip (GNU zip) compression utility. Refer to

readme.compressed_repository in OpenPegasus source tree, and the gzip

web site (<a style="color: rgb(204, 51, 204);"

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

href="http://www.gzip.org">http://www.gzip.org</a>).</li>

</li>

<li>sqlite

- If you choose to enable the use of sqlite for the repository, refer

to the doc/BuildAndReleaseOptions.html file for the defintion of the

build variables and the sqlite implementation which may be obtained

either as part of a standard distribution or from <a

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

</ol>

NOTE:

A set of the required

Line 248

Line 288

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

Pegasus includes the server which can be controlled from the command line and a

Pegasus includes the server which can be controlled from the command

line and a

set of clients that provide adminstrative functions

The manpages for each of the commands are in the pegasus/rpm/manLinux/

directory (from CVS).

To see simple help for each command,

To see simple help for each

command,

invoke it with the "--help" option.

<div style="margin-left: 40px;"><span

<div style="margin-left: 40px;">Some

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

style="font-weight: bold;" class="norm"><span

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

class="norm">Some of

the basic commands:

</div>

<ul>

<li>cimserver (Start the server

<li>cimserver

(Start the server

cimserver)</li>

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

<li>cimserver

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

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

<li>cimserver

traceLevel=4 traceComponents=ALL

(Starts server

with

config flags)</li>

</ul>

<ul>

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

<li>cimprovider

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

-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

<li>cimuser

<span

-a -u guest -w <ThePassword> (Adds

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

the user guest

<li>cimuser -l  (Lists the users )</li>

with specified password)

<li>cimconfig -l -c (Lists the

</li>

current config options and their current values) </li>

<li>cimuser

-l  (Lists the users )</li>

<li>cimconfig

-l -c (Lists the

current config options and their current values)

</li>

</ul>

<div style="margin-left: 40px;">NOTES:

Line 290

Line 342

</div>

<li>Refer to the admin guide in pegasus/doc/Admin_Guide_Release.pdf

<li>Refer to the admin guide in

pegasus/doc/Admin_Guide_Release.pdf

for

more information about administering the OpenPegasus CIM Server.</li>

<li>There are some differences between Windows and other

<li>There are differences between Windows and other

platforms in

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

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

platforms use

the OpenPegasus daemon

configuration option to start the CIM Server as a daemon, on

Line 305

Line 358

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

explains the

exact format of the start and stop options.</li>

<li>The cimuser command is used to manage OpenPegasus users only when

<li>The cimuser command is used to manage OpenPegasus users

the CIM Server is compiled without the PEGASUS_PAM_AUTHENTICATION environment

only when

variable defined. See

the CIM Server is compiled without the PEGASUS_PAM_AUTHENTICATION

environment variable defined. See <a

PEP 308</a> for more information on these configuration options. </li>

href="http://www.openpegasus.org/pp/uploads/40/16781/PEP308_RecommendedReleaseOptions.htm">

PEP 308</a> for more information on these configuration options.

</li>

</ol>

</blockquote>

<span

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

style="font-family: monospace;">

Much

<h2><a name="docs">Documentation</a></h2>

<span

style="color: rgb(255, 0, 0); text-decoration: line-through;">Much

OpenPegasus

is documented in the <a

href="http://www.openpegasus.org/pp/index.tpl?CALLER=index.tpl">Pegasus

Enhancement Process (PEPs)</a> which are the basis for approval of

Enhancement Process (PEPs)</a> which are the basis for approval

OpenPegasus functionality, changes, plans, etc.  The approved PEPs

OpenPegasus functionality, changes, plans, etc.  The approved

PEPs

are publicly available on the OpenPegasus web site.<span

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

Line 332

Line 386

from the

source tree, see pegasus/doc/apidoc) and other miscellaneous

documentation

in the doc directory. Also, there is a set of Release Notes for each

in the CVS doc directory and the pegasus CVS root as readme files.

Also, there is a set of Release Notes for each

release in the OpenPegasus root

source directory of CVS.

source directory of CVS and as a Pegasus PEP.

The <a

href="http://www.openpegasus.org/">OpenPegasus web

site</a> will be the source

of most

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

and

design documentation.

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

<font

Contributors

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

are welcome to participate in the OpenPegasus development effort. Join

the mailing list by going to the <a

href="http://www.openpegasus.org/mailinglists.tpl?CALLER=index.tpl">Mailing

Line 355

Line 402

Refer to the <a href="#avail_of_peg">Availability</a>

section for instructions on obtaining source code.

If you want to install pre-built Pegasus

If you want to install

pre-built Pegasus

executables instead of building from source code, then refer to the <a

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

href="http://www.openpegasus.org/pr/">RPM installation

instructions</a>.

<h2><a name="vfy_req_sw"></a>Verify Dependencies<span

<h2><a name="vfy_req_sw"></a>Verify

Dependencies<span

style="font-weight: normal;"></h2>

<span

style="font-weight: normal;">Before

Line 370

Line 420

the complete list.

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

<h2><a name="set_envt_var">Set the

Environment

Variables</a></h2>

Before building, installing, or running

Before building, installing,

or running

OpenPegasus, some environment variables may

have to be defined or updated.  See PEP 292 for the full list of

have to be defined or updated.  See PEP 292 for the full list

environment variables and configuration options for OpenPegasus. The

minimum set is:

Line 386

Line 439

that will contain all output from building and running OpenPegasus, it

can be the same as PEGASUS_ROOT if desired.</li>

<li>PEGASUS_PLATFORM -- The

platform on which OpenPegasus is being built.

platform on which OpenPegasus is being built.</li>

</li>

</ul>

<div style="margin-left: 40px;">There are a significant number of

environment variables that control the compile and test of features in

the OpenPegasus package in addition to the 3 variables described above.

These variables are documented in the Pegasus documentation in CVS (see

the pegasus/doc directory).</div>

<h2><a name="bld_peg"></a>Build the Executables

</h2>

<div style="margin-left: 40px;">OpenPegasus

is compiled and linked using a make structure that recurses through the 

is compiled and linked using a make structure that recurses through

OpenPegasus source tree.

the  OpenPegasus source tree.

<span

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

Makefile commands

<div style="margin-left: 40px;"><span

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

Open<span

OpenPegasus

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

includes several Makefiles that enable

you to quickly build or

refresh files for the server, clients, providers, test cases, and

Line 426

Line 480

<li>alltests - Builds the

repository entries and other resources required by the tests, and then

executes all automated tests.</li>

<li>world - Builds the complete environment and runs the test suite.</li>

</ul>

<span

For a comprehensive

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

make targets, refer to <big><span

at the top of the OpenPegasus source directory.<span

style="font-family: Courier New,Courier,monospace;">pegasus/Makefile</big>

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

at the top of the OpenPegasus source directory.

style="text-decoration: line-through; color: rgb(204, 51, 204);"><span

style="font-weight: bold;">

</div>

<ul>

</ul>

<h2><a name="pop_peg_rep">Populate the Repository</a> </h2>

<h2><a name="pop_peg_rep">Populate the Repository</a>

</h2>

Before using OpenPegasus you must populate the repository. Typically,

this

is done during the build process by the 'make repository' target<span

is done during the build process by the 'make repository' target.

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

However,

style="text-decoration: line-through;">. However,

you

can also compile MOF (Managed Object Format) code manually with the

cimmof compiler.

The 'make repository' target in pegasus<span

The 'make repository' target

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

in the makefile <big><span

style="text-decoration: line-through;">/Makefile doe<span

style="font-family: Courier New,Courier,monospace;">pegasus/Makefile</big>

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

performs several functions including:

style="text-decoration: line-through;">s several things:

<ul>

<li>Removes

<li>Removes the existing

the existing

repository (if one exists).

</li>

<li>Generates the default

CIM Schema (defined in pegasus/mak/config.mak)

in the repository (skeleton of CIM

objects).  Refer to PEGASUS_CIM_SCHEMA environment variable  in 

objects).  Refer to PEGASUS_CIM_SCHEMA environment

Pegasus PEP 308  to set  alternate schema versions.

variable  in  Pegasus PEP 308  to

set  alternate schema versions.

</li>

<li>Loads

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

Line 473

Line 524

(SNMP, Events, Alert, Threshold, etc)

internal to Pegasus. </li>

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

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

libDNSProvider.so, … ) in OpenPegasus (which are located in

src/Providers)

</li>

</ul>

<h2><a name="reg_prov">Register

Providers</a></h2>

OpenPegasus registers Providers using a

OpenPegasus registers

Providers using a

set of provider registration classes

encoded in MOF. This set of classes is close

encoded in MOF. This classes are proprietary to OpenPegasus

to, but not

today.

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 schema is moved to final

status.

Registration

is performed by creating instances of the

registration classes that represent the provider module, providers,

capabilities, 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 src/Providers/sample/Load directory for examples of

MOFs.  See the <big><span

style="font-family: Courier New,Courier,monospace;">pegasus/src/Providers/sample/Load</big>

directory for examples of

several registration instance implementations that do work with

OpenPegasus

today.

Registration may be performed by creating

compiling the registration mof with either the on-line or off-line

Pegasus mof compiler.  It is recommended that providers be

registered with the on-line compiler because this allows pegasus to

validate the registration information.

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

Building on Linux </a></h2>

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

environment

variables set (eg. PEGASUS_HOME, PEGASUS_ROOT, PEGASUS_PLATFORM). 

variables set (eg. PEGASUS_HOME, PEGASUS_ROOT,

PEGASUS_PLATFORM). 

For

32 bit Linux, the definition of PEGASUS_PLATFORM is normally

LINUX_IX86_GNU.   For 64 bit IX86  Linux the definition of

LINUX_IX86_GNU.   For 64 bit IX86  Linux the

definition

PEGASUS_PLATFORM is normally LINUX_IX86_64_GNU.  Use the g++

compiler to compile and link the executables. All of the supported platform

compiler to compile and link the executables. All of the supported

definitions are defined in pegasus/mak as  make files with the definition

platform

platform_<operatingSystem>_<architecture>_<compiler>. The <operatingSystem>_<architecture>_<compiler>

definitions are defined in <big><span

component is what forms the PEGASUS_PLATFORM environment variable so that the

style="font-family: Courier New,Courier,monospace;">pegasus/mak</big>

as  make files with the

definition:

<span

style="font-family: monospace;">   

platform_<operatingSystem>_<architecture>_<compiler>

The

component is what forms the PEGASUS_PLATFORM environment variable so

that the

appropriate platform make file can be found during the build process.

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

about Building on Windows </a></h2>

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

Use of Windows 2000 SP3 or later is recommended.  OpenPegasus

regularly tested on both Windows 2000 and Windows XP using the

Microsoft Visual C++ compilers.

regularly tested on mulitple windows platforms.

Today we build OpenPegasus on Windows

We build OpenPegasus

on Windows

using a set of Makefiles

contained

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

not supported, Visual Studio 6.0 (SP5) or later 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

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

before trying to compile OpenPegasus on the normal windows platform.

available

before trying to compile OpenPegasus on the normal windows platform

(This utility allows use of unix command line semantics for certain

operations in windows).

The

following is the basic setup steps for the environment.

Setup the environment variables and path

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

For Windows, try the

following for an

example environment:

<pre style="margin-left: 40px;">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 to 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

<pre style="margin-left: 40px;">REM call the standard Microsoft .bat for VC 6 setup. <br

class="norm">The '/' characters are intentional and required by the OpenPegasus build system) REM set PEGASUS_HOME to where you want repository and executables, it can be the same as PEGASUS_ROOT set PEGASUS_HOME=%PEGASUS_ROOT% REM set PEGASUS_PLATFORM for Windows<br

style="font-family: monospace;">call 'C:/Program Files\Microsoft Visual Studio\VC98\Bin\Vcvars32.bat' <br

style="color: rgb(255, 0, 0);">set PEGASUS_PLATFORM=WIN32_IX86_MSVC REM setup the path to the runtime files. set path=%path%;%PEGASUS_HOME%\bin </pre>

style="font-family: monospace;">REM Set debug to something if you want to compile in debug mode <br

style="font-family: monospace;">set PEGASUS_DEBUG=true <br

style="font-family: monospace;">REM set PEGASUS_ROOT to top of source tree <br

style="font-family: monospace;">set PEGASUS_ROOT=C:/cimom/pegasus <br

style="font-family: monospace;">REM (Note: <span

style="font-family: monospace;" class="norm">The '/' characters are intentional and required by the OpenPegasus build system). REM Also the disk designator (C:) is required for at least some newer versions of the Microsoft REM  compilers to avoid confusion between options and paths <span

style="font-family: monospace;">REM set PEGASUS_HOME to where you want repository and executables, it can be the same as PEGASUS_ROOT<br

style="font-family: monospace;">set PEGASUS_HOME=%PEGASUS_ROOT% <br

style="font-family: monospace;">REM set PEGASUS_PLATFORM for Windows<br

style="color: rgb(255, 0, 0); font-family: monospace;"><span

style="font-family: monospace;">set PEGASUS_PLATFORM=WIN32_IX86_MSVC<br

style="font-family: monospace;">REM setup the path to the runtime files. <br

style="font-family: monospace;">set path=%path%;%PEGASUS_HOME%\bin </pre>

</blockquote>

<h3>

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

Line 558

Line 641

commands. For example:

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

C:\>

mu rm myfile.cpp yourfile.cpp

You may type "mu" to get a list of valid

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

The MU utility supports

globing

(expansion of wildcards) so

you can do things like this:

<span

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

style="font-family: monospace;">

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

MU is required to build under the Windows

MU is required to build

under the Windows

environment. MU is

available as part

of the distribution of OpenPegasus.

<div style="margin-left: 40px;">NOTE: The binary for MU.EXE is not

<div style="margin-left: 40px;">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

Line 605

Line 693

for more details on build variables).

You

must also have the PEGASUS_HAS_SSL environment variable defined. Then when you

must also have the PEGASUS_HAS_SSL environment variable defined. Then

when you

build

OpenPegasus, it

will include the SSL support.

<div style="margin-left: 40px;">Refer to the OpenPegasus SSL Guide

<div style="margin-left: 40px;">Refer to the OpenPegasus

SSL Guide

(found in doc/PegasusSSLGuidelines.htm)

for details on

using OpenPegasus with SSL,

Line 623

Line 713

CVS

environment, including:

<ul>

<li>Test Clients - There are several

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

clients that have been

built specifically to test OpenPegasus, or parts of OpenPegasus,

including

TestClient, Client, cimcli, ipinfo,

Line 637

Line 728

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

"make testrepository" target including: test namespaces, extra

classes and instances in those namespaces, and additional sample and

test providers.<span

test providers.</li>

style="color: rgb(255, 0, 0); text-decoration: line-through;"> </li>

</ul>

<li>Sample and Test Providers -  Test providers exist

</div>

<ul>

<li>Sample and Test Providers -

Test providers exist

for

the major provider types in the src/Providers/sample

and src/Providers/TestProviders directories. </li>

<li>Unit Tests - Most OpenPegasus functions include unit

</ul>

</div>

<ul>

</ul>

<ul>

<li>Unit Tests - Most OpenPegasus

functions include unit

tests

for

the functions.  These are normally executed with the "make

Line 658

Line 762

directory). Unit tests are executed with the CIM Server shutdown and

normally do not require the existence of class definitions in the

repository. </li>

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

</ul>

</div>

<li>End-to-end Test Suite - the directory

"test" contains

set of operatio<span

set of operation

style="color: rgb(255, 0, 0); text-decoration: line-through;">n

tests that cover the major CIM Operations.  See

tests that cover the major CIM Operations.  See<span

style="color: rgb(255, 0, 0); text-decoration: line-through;">

TestMakefile in the PEGASUS_ROOT directory to execute

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

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

fixed

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

</ul>

Once OpenPegasus is

Once OpenPegasus is

successfully built, the  tests can be executed through the root Makefile

successfully built, the  tests can be executed through the

root Makefile

with targets such as:

<ul>

<li>make unittests - Execute the unit tests. These do not depend

</ul>

on having a running server or repository installed.  They test

<ul>

components of the OpenPegasus code. These tests run to completion if

<li>make unittests - Execute the unit

successful but normally stop on the first error found by a test

tests. These do not depend on having a running server or repository

program.</li>

installed.  They test components of the OpenPegasus code.

<li>make servertests - Executes the OpenPegasus end-to-end test

These tests run to completion if successful but normally stop on the

suite against a running OpenPegasus server starting and stopping the

first error found by a test program.</li>

server as required to modify configuration parameters. The

<ul>

repository must be installed for these tests to execute and they are

</ul>

tested against the default repository as part of regular OpenPegasus

development and release testing. These tests will run to successful

completion if there are not errors detected but will normally stop

on the first error.  There is a subset of these tests that can

be run in an environment that does not have root privileges but root

privileges are required to run the complete suite.</li>

<li>make alltests - execute both the unit and end-to-end tests.</li>

</ul>

</blockquote>

<ul>

<li>make servertests - Executes the

OpenPegasus end-to-end test suite against a running OpenPegasus server

starting and stopping the server as required to modify configuration

parameters. The repository must be installed for these tests to execute

and they are tested against the default repository as part of regular

OpenPegasus development and release testing. These tests will run to

successful completion if there are not errors detected but will

normally stop on the first error.  There is a subset of these

tests that can be run in an environment that does not have root

privileges but root privileges are required to run the complete suite.</li>

</ul>

</blockquote>

<ul>

</ul>

<li>make alltests - execute both the

unit and end-to-end tests.</li>

</ul>

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

ICU (International Components for

ICU (International

Components for

Unicode) refers to the set of

libraries that OpenPegasus uses to run with globalization support. For

example, these

Line 710

Line 830

pegasus/docs

directory for details.

When users run "make servertests"

When users run "make

servertests"

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

are

run that

Line 755

Line 876

for PEGASUS_MSG_HOME.

<hr>

Licensed to The Open Group (TOG) under one or more contributor

license

EMC Corporation; Symantec Corporation; The Open Group.

agreements. Refer to the OpenPegasusNOTICE.txt file distributed with

this work for additional information regarding copyright ownership.

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

Each contributor licenses this file to you under the OpenPegasus Open

copy

Source License; you may not use this file except in compliance with the

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

License.

deal in the Software without restriction, including without limitation

Permission is hereby granted, free of charge, to any person

the

obtaining a

rights to use, copy, modify, merge, publish, distribute, sublicense,

copy of this software and associated documentation files (the

and/or

"Software"),

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

to deal in the Software without restriction, including without

is

limitation

furnished to do so, subject to the following conditions:

the rights to use, copy, modify, merge, publish, distribute,

sublicense,

THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED

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

IN

Software is furnished to do so, subject to the following conditions:

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

The above copyright notice and this permission notice shall be

PROVIDED

included

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

in all copies or substantial portions of the Software.

BUT NOT

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

LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR

KIND, EXPRESS

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

OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

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

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

AN

IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

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

CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

CONNECTION

TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

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

SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

<hr>

</body>

</html>

Legend:

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

No CVS admin address has been configured