README.rst

Pywbem - A WBEM client and related utilities, written in pure Python

Contents:

Overview

Pywbem is a WBEM client and WBEM indication listener, written in pure Python. It runs on Python 2 and Python 3.

The major components of pywbem are shown in this diagram:

A WBEM client allows issuing operations to a WBEM server, using the CIM operations over HTTP (CIM-XML) protocol defined in the DMTF standards DSP0200 and DSP0201. The CIM/WBEM infrastructure is used for a wide variety of systems management tasks supported by systems running WBEM servers. See WBEM Standards for more information about WBEM and these standards.

A WBEM indication listener allows receiving indications generated by a WBEM server.

Pywbem also includes higher level classes to support typical WBEM client activities:

• WBEMSubscriptionManager - provides APIs for viewing and managing indication subscriptions on a WBEM server.
• WBEMServer - provides APIs for managing basic characteristics of a WBEM server including:
  • finding CIM namespaces and the Interop namespace,
  • finding WBEM management profiles,
  • finding basic information about the WBEM server.

Installation

• You first need to ensure that prerequisite OS-level packages are installed:
  • Download the 0.11.0 script (for pywbem version 0.11.0)

  • Execute that script:

    $ ./pywbem_os_setup.sh

• Then, install the pywbem Python package using Pip:

  $ pip install pywbem

  This will also install any prerequisite Python packages.

For more details and alternative ways to install, see the Installation section in the pywbem documentation.

Usage

For information on how to use pywbem, or how to contribute to it, go to the pywbem documentation .

Documentation

The lastest pywbem documentation is available on ReadTheDocs:

• Documentation for latest version on Pypi
• Documentation for master branch in the Git repo

The documentation includes API documentation, user documentation, tutorial documentation, developer documentation.

This includes a number of Jupyter notebooks that act as a pywbem tutorial and provide working examples of pywbem API usage.

There are also a number of presentations on the status, concepts, and implementation of pywbem available in readthedocs.

Command line tools

Pywbem includes two command line tools:

• wbemcli - An interactive shell for issuing WBEM operations against a WBEM server. In addition to executing the WBEM operations directly, simple scripts can be created to be executed within wbemcli.
• mof_compiler - A MOF compiler to compile MOF into repositories (e.g. WBEM servers) or to test compile MOF.

QuickStart

The following simple example script lists the namespaces and the Interop namespace in a particular WBEM server:

#!/usr/bin/env python

import pywbem

server_uri = 'http://localhost'
user = 'fred'
password = 'blah'

conn = pywbem.WBEMConnection(server_uri, (user, password),
                             default_namespace=namespace)

server = pywbem.WBEMServer(conn)

print("Interop namespace:\n  %s" % server.interop_ns)

print("All namespaces:")
for ns in server.namespaces:
    print("  %s" % ns)

Project Planning

For each upcoming release, the bugs and feature requests that are planned to be addressed in that release are listed in the issue tracker with an according milestone set that identifies the target release. The due date on the milestone definition is the planned release date. There is usually also an issue that sets out the major goals for an upcoming release.

Planned Next Release

Pywbem 0.12.0 is in development.

Pywbem github Issue 771 defines the basic direction for release 0.12.0

Contributing

For information on how to contribute to pywbem, see the Development section in the documentation.

License

Pywbem is provided under the GNU Lesser General Public License (LGPL) version 2.1, or (at your option) any later version.