This data sheet provides information about
the < Specific Provider Name > provider (implemented using the <Indicate
implementation specifics such as "Pegasus C++ provider API”>).
The provider supports the < Specific
classes supported by the provider > classes. This data sheet is not intended to replace manuals or man
pages. <Cite specific manuals/man pages or remove previous
sentence. > The intended audience of this document is software
professionals who will design, implement, enhance, and/or support client
applications that will use this provider.
This data sheet is maintained in open source
and is updated frequently. This version
was last updated: <DD-MMM-YYYY>.
See the < Specific open source site, such as Pegasus > open
source site < (http://xxxxx) >,
location < directory >, for the most recent version.
< Template Version 1.1 - last updated
17-May-2002> < The following information is meant only for provider
owners - delete this paragraph when creating data sheets > This data sheet
is meant to be used as a template to reduce effort needed for creating provider
documentation and also to provide consistent documentation format across WBEM
programs and infrastructures so client/provider developers and sophisticated
end-users have an easier time coming up to speed. This data sheet should be
short and concise. Any place that is surrounded by <> is meant to
either be removed or replaced by relevant information for this specific
provider. WBEMsource will be creating a web page containing provider data
sheets. To submit this page to the program....< instructions will be added
later >. It is assumed that the owners of the providers will maintain
these data sheets. If you have suggestions or would like help creating a
data sheet for your provider, contact Debbie_Hamilton@hp.com.
Keywords: (<API
supported (for example NPI)>, <Managed Resources Supported (for example
hardware, disks, OS)>, < basic category/purpose of provider (for example,
Managed System Identity) >, <Platform and OS Compatibility (for example
HP-UX 11.11, Solaris 9, AIX 5L)>, <Solution Stack (for example Fault
management)>, <CIM classes supported>, <additional classes
supported> )
<Modify the HTML meta-keywords for this page to
include those listed above>
Table Of Contents
1. Provider Overview (Description, Requirements, Release History, Supported Managed Resources, Special Requirements & Dependencies)
2. Setting
Up This Provider (Installing, Configuring)
3. Using This Provider (Schema Supported, Indications Generated, Associations Provided)
4. Links To
More Information (Additional
Provider Documentation, WBEM Information, Managed Resource Information, Client Information, Support
Contacts, Migration and
Co-existence Information, Possible
Provider Enhancements)
5. Limitations, Known Defects, and
Performance Considerations
·
Description
< Description of what this
provider does and what value others can get from it. Cover the purpose, advantages, and details.>
·
Requirements
< Description of which OSs, which
version of WBEM infrastructure, which version of the schema, which platforms,
and configurations this provider will run. List configurations that have been
tested and are supported. >
·
Release History
< Description of
the release history of this provider with the most recent release listed first.
Specify release date, release number and brief description. >
·
Supported
Managed Resources
< List of
managed resources this provider exposes (information, operations, indications),
specifically which devices, system resources or applications. Include pointers
to information and sources for the managed resource if available and
appropriate. >
·
Special
Requirements & Dependencies
< Description of
what is required in addition to the provider for it to work properly
(specifically the managed resource, the OS and the hardware, the API, the
dependencies.>
·
Installing This
Provider
< Description of how to install this
provider including where to get the files, manuals, and other components.
Include executable name, and product and number. Also, list any tools or
clients that might help validate setup and operation of this provider. >
·
Configuring This
Provider
< Description of how to configure
this provider including the default values. Include information needed to
run the provider such as whether it requires being run as root. This includes
indication requests. Note that detailed
information on how to change these default values, is in the provider manual
(otherwise include this information in this document). >
·
Schema supported by
this provider
< Use UML and/or a table format
to list both inherited and local properties and methods. Include types and
units of all properties, and note information sources. Tables should be numbered and include a text
description or their format for accessibility.
Include information on intrinsic and extrinsic methods, limitations or
restrictions of values and how keys are determined. Put keys in bold
font. >
This provider
supports the < list of classes > classes. Tables 1 through <n> describe
the properties and methods supported by the provider. Specific details of the schema supported by this provider (including
property descriptions and value maps) are available in the MOF files.
Table 1 describes
the properties of the < class > class. It has three columns. The
first is the property name (including type and units), the second is the
property inheritance (indicating which class or superclass defines the
property), and the third is the property’s value or data source. Each row describes a property. <other
special considerations>
Table 1 <could be multiple tables, one per class supported
>: < Class > Properties
Property Name |
Property Inheritance |
Property Value |
< type > < Property > <[Key] if applicable,
and bold the entry > |
< “Inherited from” or “Local to” > < class > |
< Description of property’s value, including source of data.
Format should begin OS-specific information with “OS:”. > |
Table 2 describes the intrinsic methods supported by this provider. It has three columns. The first is the method name, the second is a
description of the provider’s actions based on invoking that method, and the
third is a list of any exceptions that could result from invoking the
method. Each row describes a method. <
If there are no extrinsic methods, include the statement: “Note that this
provider supports no extrinsic methods.” > <other special
considerations>
Table 2<renumber as appropriate>: Intrinsic Methods for < class or classes >
Method Name |
Description |
Exceptions thrown |
< method name > |
< description of what
the method does/returns > |
< exceptions that can be thrown > |
<optional – only include if extrinsic methods are supported. >
Table 3 describes the extrinsic methods supported by this provider. It has three columns. The first is the method name, the second is
a description of the provider’s actions based on invoking that method, and the
third is a list of any exceptions that could result from invoking the
method. Each row describes a method.
Table 3 <renumber as appropriate>: Extrinsic Methods for < class or classes >
Method Name |
Description |
Exceptions thrown |
< method name > |
< description of what
the method does/returns > |
< exceptions that can be thrown > |
Indications generated and Queries supported by this
provider
< Use UML and/or a table format
to list indications and queries generated by this provider along with a brief
description of each and limitations/restrictions of values. >
Table 4 describes the indications supported by this provider. It has four columns. The first is the name of Indication class,
the second lists attributes (properties) of the indication (including type and
units), the third is a description of circumstances under which the indication
will occur (indication triggers), and the fourth describes the meaning of the
most useful properties returned with the indication. Each row describes an
indication class.
Table 4 <renumber as appropriate>: Supported Indications
Indication |
Attributes |
Indication Triggers |
Values and Meaning |
|
|
|
|
Table 5 describes the queries supported
by this provider. It has three
columns. The first is a query string, the
second is a description of the result of that query, and the third lists
limitations or restrictions associated with making that query (including
performance considerations). Each row describes a query.
Table 5 <renumber
as appropriate>: Queries
Supported for < class or
classes >
Query String |
Query/Result |
Limitations/Restrictions of Queries |
|
<note if the provider
uses filters passed to it by the CIMOM> |
|
Associations
provided by this provider
< Insert a list of which associations are provided by this provider
along with description.>
Table 6 describes the associations supported by this
provider. It has four columns. The first is the name of the association
class, the second lists the classes referenced by the associations, the third
is a brief description of the associations, and the fourth describes possible
applications for this association. Each row describes an association. < Note that each of these associations
is also covered in a properties table above. >
Table 6 <renumber
as appropriate>: Associations
Name |
References |
Description |
How association is used |
|
|
|
|
·
Additional Provider
Documentation
< Replace with pointer
to provider manual and/or web page. >
< May want a “see also” pointing to man pages, manuals, or other
documentation for data sources referenced in section 3. >
·
WBEM information
For a CIM tutorial, go to http://www.dmtf.org/education/cimtutorial.php.
For information about the Pegasus WBEM infrastructure, see http://www.opengroup.org/pegasus. <OR For information about WBEMsource,
see http://www.wbemsource.org. >
For information about WBEM and a list of providers/clients available, see
the Pegasus Home Page.
For information about the WBEM infrastructure and administration information,
see the WBEM manual (link and part number - or web page) or the
man pages.
For information about providers and clients available from other companies, see
??.
For information about WBEM marketing plans and material, see ??
·
Managed Resource
Documentation
< Replace this,
if relevant, with links to documentation on the managed resource - both web and
manuals.> < May want a
“see also” pointing to man pages, manuals, or other documentation for data
sources referenced in section 3. >
·
Client Information
< Replace this, if
relevant, with links to clients and solutions that use this provider.
>
·
Support Contacts
< Replace this, if relevant, with email, web locations
or phone numbers to support contacts. >
·
Migration and
Co-existence Information
< Replace this, if relevant, with information on
migration issues from previous solutions and information on whether previous
solutions can co-exist with this provider. >
·
Possible Provider
Enhancements
< Note areas of enhancement to be considered (but
not necessarily committed). This
section is particularly valuable so client developers can know what MAY be
coming, and so open source provider developers can know where the community may
implement enhancements. >
<Replace this, if relevant,
with information about known defects and performance considerations or links to
that information. List any issues/concerns related to using this provider (in general or specific to a certain mission
critical or real-time environment). >
Top of
Page /
WBEM HOME <This link will be updated to point to high level
information about WBEM>