Fixed bugzilla 1044
[tpot/pegasus/.git] / readme.cmpi
1 CMPI Providers in a nutshell
2 ============================
3
4 Viktor Mihajlovski <mihajlov@de.ibm.com>
5 Nov 14th 2003
6
7 The Common Manageability Programming Interface (CMPI) has been integrated into
8 Pegasus as a pluggable provider manager.
9
10 CMPI must be enabled during Pegasus build.
11 For CMPI enablement, set the following environment variables prior to make:
12
13    ENABLE_PROVIDER_MANAGER2=1
14    ENABLE_CMPI_PROVIDER_MANAGER=1
15
16 If you plan to write your own CMPI providers you are kindly referred to the
17 WBEMSource homepage where the draft specification document for CMPI resides.
18 You can find at http://www.wbemsource.org/doc.tpl?CALLER=index.tpl&gdid=3712 .
19 If you are looking for samples you should have a look at the SBLIM project.
20 The packages prefixed by the string sblim-cmpi contain CMPI providers for
21 various classes. See http://www-124.ibm.com/developerworks/projects/sblim .
22
23 Once you have a CMPI provider library you want to register it with Pegasus.
24 How? Well it's almost the same as for C++ providers. The only difference is
25 that the Provider.Interface property must be set to "CMPI".
26
27 Here's an excerpt from the SBLIM Linux Computer System provider registration
28
29 // ===================================================================
30 //      Linux_ComputerSystem
31 // ===================================================================
32
33
34 instance of PG_ProviderModule
35 {
36    Name = "OSBase_ComputerSystemProviderModule";
37    //The library name on disk
38    Location = "cmpiOSBase_ComputerSystemProvider";
39    Vendor = "SBLIM";
40    Version = "1.2.2";
41    InterfaceType = "CMPI";
42    InterfaceVersion = "0.86.0";
43 };
44
45 instance of PG_Provider
46 {
47    //The provider module as defined in PG_ProviderModule
48    ProviderModuleName = "OSBase_ComputerSystemProviderModule";
49    // The provider name as referenced in the code
50    Name = "OSBase_ComputerSystemProvider";
51 };
52
53 instance of PG_ProviderCapabilities
54 {
55    //The provider module as defined in PG_ProviderModule
56    ProviderModuleName = "OSBase_ComputerSystemProviderModule";
57    //The provider name as defined in PG_Provider
58    ProviderName = "OSBase_ComputerSystemProvider";
59    CapabilityID = "1";
60    //Name of the CIM class as defined in the mof
61    ClassName = "Linux_ComputerSystem";
62    Namespaces = {"root/cimv2"};
63    ProviderType = { 2,5 }; // Instance, Method
64    SupportedProperties = NULL; // All properties
65    SupportedMethods = NULL; // All methods
66 };
67