Return to
ExternalInterface.html
CVS log
Up to [Pegasus] / pegasus / doc
|
Return to
ExternalInterface.html
CVS log
|
Up to [Pegasus] / pegasus / doc
|
|
File: [Pegasus] / pegasus / doc / ExternalInterface.html
(download)
/
(as text)
Revision: 1.4, Tue Sep 7 02:54:37 2010 UTC (13 years, 7 months ago) by venkat.puvvada Branch: MAIN CVS Tags: preBug9676, postBug9676, TASK_PEP317_1JUNE_2013, TASK-TASK_PEP362_RestfulService_branch-root, TASK-TASK_PEP362_RestfulService_branch-merged_out_from_trunk, TASK-TASK_PEP362_RestfulService_branch-merged_in_to_trunk, TASK-TASK_PEP362_RestfulService_branch-merged_in_from_branch, TASK-TASK_PEP362_RestfulService_branch-branch, TASK-PEP362_RestfulService-root, TASK-PEP362_RestfulService-merged_out_to_branch, TASK-PEP362_RestfulService-merged_out_from_trunk, TASK-PEP362_RestfulService-merged_in_to_trunk, TASK-PEP362_RestfulService-merged_in_from_branch, TASK-PEP362_RestfulService-branch, TASK-PEP317_pullop-root, TASK-PEP317_pullop-merged_out_to_branch, TASK-PEP317_pullop-merged_out_from_trunk, TASK-PEP317_pullop-merged_in_to_trunk, TASK-PEP317_pullop-merged_in_from_branch, TASK-PEP317_pullop-branch, RELEASE_2_14_1, RELEASE_2_14_0-RC2, RELEASE_2_14_0-RC1, RELEASE_2_14_0, RELEASE_2_14-root, RELEASE_2_14-branch, RELEASE_2_13_0-RC2, RELEASE_2_13_0-RC1, RELEASE_2_13_0-FC, RELEASE_2_13_0, RELEASE_2_13-root, RELEASE_2_13-branch, RELEASE_2_12_1-RC1, RELEASE_2_12_1, RELEASE_2_12_0-RC1, RELEASE_2_12_0-FC, RELEASE_2_12_0, RELEASE_2_12-root, RELEASE_2_12-branch, RELEASE_2_11_2-RC1, RELEASE_2_11_2, RELEASE_2_11_1-RC1, RELEASE_2_11_1, RELEASE_2_11_0-RC1, RELEASE_2_11_0-FC, RELEASE_2_11_0, RELEASE_2_11-root, RELEASE_2_11-branch, PREAUG25UPDATE, POSTAUG25UPDATE, HEAD, CIMRS_WORK_20130824, BeforeUpdateToHeadOct82011 Changes since 1.3: +4 -0 lines BUG#: 8839 TITLE: OOP provider recovery enhancement DESCRIPTION: Added new config property maxFailedProviderModuleRestarts which specifies the numer of times the failed provider module is restarted with indications enabled automatically before moving to the degraded state. |
<html>
<head>
<link rel="stylesheet" href="http://www.opengroup.org/stylesheets/info1.css">
</head>
<body>
<hr>
<p align="center"><b><font size="4">OpenPegasus External
Interface Definition</font></b>
</p>
<hr>
<p><b>Abstract: </b>This document provides THE list of the OpenPegasus
interfaces that are considered external and therefore "frozen" with
this release. Unless an exception is explicitly approved by
the Steering Committee all subsequent releases of Pegasus MUST
continue to support these interfaces. Interfaces not explicitly listed
in this document, should be considered as internal and
subject to change.</p>
<hr>
<h2><font color="#000000">Definition of the Problem</font></h2>
<p>With each release, as new features mature and gain Community acceptance and
old features age and lose value, the OpenPegasus External Interface
Definition needs to be updated. The purpose of this document is to
document approved changes (i.e., additions, modifications or deprecations) to
the OpenPegasus External Interface Definition.</p>
<p><b>Note: </b>Support for forward-compatibility is a fundamental design
principle for the OpenPegasus project. As a Community, our
goal is for well-behaved OpenPegasus Providers or Clients, using only the
externally defined OpenPegasus interface, to continue to work with a minor
version upgrade of OpenPegasus. EXPERIMENTAL interfaces are not
considered part of the OpenPegasus External Interface Definition.
Applications using either EXPERIMENTAL or internal interfaces should
have no expectation of working in the next release.</p>
<p><b>Note: </b> Although the content of the OpenPegasus SDK is strongly
influenced by the OpenPegasus External Interface Definition, not all
APIs included in the SDK are part of the External Interface Definition.
In addition, not all External Interfaces are included in the SDK.</p>
<h2><font color="#000000">Proposed Solution</font></h2>
<h2>2.0 External Interface Definitions</h2>
<h3>2.1 OpenPegasus C++ Interfaces</h3>
<h4>2.1.1 Common</h4>
<ul>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC"
style='font-size=10.0pt;font-family:Arial' width="603">
<tr>
<th bgcolor="#CAE6CA" width="294">Source File</th>
<th bgcolor="#CAE6CA" width="306">Specification</th>
</tr>
<tr>
<td width="294"> Pegasus/Common/AcceptLanguageList.h</td>
<td width="306"> Pegasus/Common/AcceptLanguageList.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/Array.h</td>
<td width="306"> Pegasus/Common/Array.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/ArrayInter.h</td>
<td width="306"> Pegasus/Common/ArrayInter.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/CIMClass.h</td>
<td width="306"> Pegasus/Common/CIMClass.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/CIMDateTime.h</td>
<td width="306"> Pegasus/Common/CIMDateTime.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/CIMFlavor.h</td>
<td width="306"> Pegasus/Common/CIMFlavor.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/CIMIndication.h</td>
<td width="306"> Pegasus/Common/CIMIndication.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/CIMInstance.h</td>
<td width="306"> Pegasus/Common/CIMInstance.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/CIMMethod.h</td>
<td width="306"> Pegasus/Common/CIMMethod.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/CIMName.h</td>
<td width="306"> Pegasus/Common/CIMName.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/CIMObject.h</td>
<td width="306"> Pegasus/Common/CIMObject.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/CIMObjectPath.h</td>
<td width="306"> Pegasus/Common/CIMObjectPath.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/CIMOperationType.h</td>
<td width="306"> Pegasus/Common/CIMOperationType.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/CIMParamValue.h</td>
<td width="306"> Pegasus/Common/CIMParamValue.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/CIMParameter.h</td>
<td width="306"> Pegasus/Common/CIMParameter.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/CIMProperty.h</td>
<td width="306"> Pegasus/Common/CIMProperty.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/CIMPropertyList.h</td>
<td width="306"> Pegasus/Common/CIMPropertyList.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/CIMQualifier.h</td>
<td width="306"> Pegasus/Common/CIMQualifier.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/CIMQualifierDecl.h</td>
<td width="306"> Pegasus/Common/CIMQualifierDecl.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/CIMScope.h</td>
<td width="306"> Pegasus/Common/CIMScope.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/CIMStatusCode.h</td>
<td width="306"> Pegasus/Common/CIMStatusCode.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/CIMType.h</td>
<td width="306"> Pegasus/Common/CIMType.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/CIMValue.h</td>
<td width="306"> Pegasus/Common/CIMValue.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/Char16.h</td>
<td width="306"> Pegasus/Common/Char16.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/Config.h</td>
<td width="306"> Pegasus/Common/Config.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/ContentLanguageList.h</td>
<td width="306"> Pegasus/Common/ContentLanguageList.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/Exception.h</td>
<td width="306"> Pegasus/Common/Exception.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/LanguageTag.h</td>
<td width="306"> Pegasus/Common/LanguageTag.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/Linkage.h</td>
<td width="306"> Pegasus/Common/Linkage.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/OperationContext.h</td>
<td width="306"> Pegasus/Common/OperationContext.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/ResponseHandler.h</td>
<td width="306"> Pegasus/Common/ResponseHandler.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/SSLContext.h</td>
<td width="306"> Pegasus/Common/SSLContext.h</td>
</tr>
<tr>
<td width="294"> Pegasus/Common/String.h</td>
<td width="306"> Pegasus/Common/String.h</td>
</tr>
</table>
</ul>
<h4>2.1.2 Client</h4>
<ul>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC" width=728
style='font-size=10.0pt;font-family:Arial'>
<tr>
<th bgcolor="#CAE6CA" width="363">Source File</th>
<th bgcolor="#CAE6CA" width="352">Specification</th>
</tr>
<tr>
<td width="363"> Pegasus/Client/CIMClient.h</td>
<td width="352"> Pegasus/Client/CIMClient.h</td>
</tr>
<tr>
<td width="363"> Pegasus/Client/CIMClientException.h</td>
<td width="352"> Pegasus/Client/CIMClientException.h</td>
</tr>
<tr>
<td width="363"> Pegasus/Client/Linkage.h</td>
<td width="352"> Pegasus/Client/Linkage.h</td>
</tr>
<tr>
<td width="363">
Pegasus/Client/ClientOpPerformanceDataHandler.h</td>
<td width="352">
Pegasus/Client/ClientOpPerformanceDataHandler.h</td>
</tr>
</table>
</ul>
<h4>2.1.3 Provider</h4>
<ul>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC"
style='font-size=10.0pt;font-family:Arial' width="759" height="189">
<tr>
<th bgcolor="#CAE6CA" width="377" height="16">Source File</th>
<th bgcolor="#CAE6CA" width="369" height="16">Specification</th>
</tr>
<tr>
<td width="377">
Pegasus/Provider/CIMAssociationProvider.h</td>
<td width="369">
Pegasus/Provider/CIMAssociationProvider.h</td>
</tr>
<tr>
<td width="377">
Pegasus/Provider/CIMIndicationConsumerProvider.h</td>
<td width="369">
Pegasus/Provider/CIMIndicationConsumerProvider.h</td>
</tr>
<tr>
<td width="377">
Pegasus/Provider/CIMIndicationProvider.h</td>
<td width="369">
Pegasus/Provider/CIMIndicationProvider.h</td>
</tr>
<tr>
<td width="377">
Pegasus/Provider/CIMInstanceProvider.h</td>
<td width="369">
Pegasus/Provider/CIMInstanceProvider.h</td>
</tr>
<tr>
<td width="377">
Pegasus/Provider/CIMMethodProvider.h</td>
<td width="369">
Pegasus/Provider/CIMMethodProvider.h</td>
</tr>
<tr>
<td width="377">
Pegasus/Provider/CIMOMHandle.h</td>
<td width="369">
Pegasus/Provider/CIMOMHandle.h</td>
</tr>
<tr>
<td width="377">
Pegasus/Provider/CIMProvider.h</td>
<td width="369">
Pegasus/Provider/CIMProvider.h</td>
</tr>
<tr>
<td width="377">
Pegasus/Provider/Linkage.h</td>
<td width="369">
Pegasus/Provider/Linkage.h</td>
</tr>
<tr>
<td width="377">
Pegasus/Provider/ProviderException.h</td>
<td width="369">
Pegasus/Provider/ProviderException.h</td>
</tr>
</table>
</ul>
<h4>2.1.4 Consumer</h4>
<ul>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC" width=40%
style='font-size=10.0pt;font-family:Arial'>
<tr>
<th bgcolor="#CAE6CA">Source File</th>
<th bgcolor="#CAE6CA">Specification</th>
</tr>
<tr>
<td> Pegasus/Consumer/CIMIndicationConsumer.h</td>
<td> Pegasus/Consumer/CIMIndicationConsumer.h</td>
</tr>
<tr>
<td> Pegasus/Consumer/Linkage.h</td>
<td> Pegasus/Consumer/Linkage.h</td>
</tr>
</table>
</ul>
<h3>2.2 OpenPegasus CMPI C Interfaces</h3>
<h4>2.2.1 Provider</h4>
<ul>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC"
style='font-size=10.0pt;font-family:Arial' width="569">
<tr>
<th bgcolor="#CAE6CA" width="269" height="16">Source File</th>
<th bgcolor="#CAE6CA" width="287" height="16">Specification</th>
</tr>
<tr>
<td width="269"> Pegasus/Provider/CMPI/cmpidt.h</td>
<td width="295"> Pegasus/Provider/CMPI/cmpidt.h</td>
</tr>
<tr>
<td width="269"> Pegasus/Provider/CMPI/cmpift.h</td>
<td width="295"> Pegasus/Provider/CMPI/cmpift.h</td>
</tr>
<tr>
<td width="269">
Pegasus/Provider/CMPI/cmpimacs.h</td>
<td width="295">
Pegasus/Provider/CMPI/cmpimacs.h</td>
</tr>
<tr>
<td width="269"> Pegasus/Provider/CMPI/cmpios.h</td>
<td width="295"> Pegasus/Provider/CMPI/cmpios.h</td>
</tr>
<tr>
<td width="269"> Pegasus/Provider/CMPI/cmpipl.h</td>
<td width="295"> Pegasus/Provider/CMPI/cmpipl.h</td>
</tr>
</table>
</ul>
<h3>2.2 Schema Definitions</h3>
<p>Only schema changes consistent with the DMTF definition of "minor"
version changes are considered "backward compatible".</p>
<h4>2.2.1 CIM Schema (CIM_)</h4>
<p>As a statement of policy, the use of CIM_Schema is strongly encouraged and
any use of CIM_ Schema MUST be DMTF compliant.</p>
<h4>2.2.2 Pegasus Schema (PG_)</h4>
<ul>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC"
style='font-size=10.0pt;font-family:Arial'>
<tr>
<th bgcolor="#CAE6CA">Source File</th>
<th bgcolor="#CAE6CA">Specification</th>
</tr>
<tr>
<td>
Schemas/Pegasus/InterOp/VER20/PG_ProviderModule20.mof</td>
<td> MOF</td>
</tr>
<tr>
<td>
Schemas/Pegasus/ManagedSystem/VER20/PG_OperatingSystem20.mof</td>
<td> MOF</td>
</tr>
<tr>
<td>
Schemas/Pegasus/ManagedSystem/VER20/PG_ComputerSystem20.mof</td>
<td> MOF</td>
</tr>
<tr>
<td>
Schemas/Pegasus/ManagedSystem/VER20/PG_UnixProcess20.mof</td>
<td> MOF</td>
</tr>
<tr>
<td>
Schemas/Pegasus/ManagedSystem/VER20/PG_DNSService20.mof</td>
<td> MOF</td>
</tr>
<tr>
<td>
Schemas/Pegasus/ManagedSystem/VER20/PG_NTPService20.mof</td>
<td> MOF</td>
</tr>
<tr>
<td>
Schemas/Pegasus/ManagedSystem/VER20/PG_IP20.mof</td>
<td> MOF</td>
</tr>
</table>
</ul>
<h3>2.3 Command Line Interfaces</h3>
<p>This section documents the command line interfaces that have been approved
for inclusion in the OpenPegasus External Interface. Commands not
explicitly listed in this section are subject to change.</p>
<ul>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC"
style='font-size=10.0pt;font-family:Arial'>
<tr>
<th bgcolor="#CAE6CA" width="86">CLI</th>
<th bgcolor="#CAE6CA">Specification</th>
</tr>
<tr>
<td width="86"> cimauth</td>
<td> man page</td>
</tr>
<tr>
<td width="86"> cimconfig</td>
<td> man page</td>
</tr>
<tr>
<td width="86"> cimmof</td>
<td> man page</td>
</tr>
<tr>
<td width="86"> cimprovider</td>
<td> man page</td>
</tr>
<tr>
<td width="86"> cimreparchive </td>
<td> man page</td>
</tr>
<tr>
<td width="86"> cimserver</td>
<td> man page</td>
</tr>
<tr>
<td width="86"> cimsub</td>
<td> man page</td>
</tr>
<tr>
<td width="86"> cimtrust</td>
<td> man page</td>
</tr>
<tr>
<td width="86"> cimuser</td>
<td> man page</td>
</tr>
<tr>
<td width="86"> osinfo</td>
<td> man page</td>
</tr>
<tr>
<td width="86"> wbemexec</td>
<td> man page</td>
</tr>
</table>
</ul>
<h3>2.4 Configuration Parameters</h3>
<p>This section documents the configuration parameters that are part of the
external interface. Configuration parameters not explicitly listed
in this section are subject to change.</p>
<ul>
<table border="1" cellspacing="1" bordercolordark="#666666"
bordercolorlight="#CCCCCC"
style='font-size=10.0pt;font-family:Arial' height="188" width="424">
<tr>
<th bgcolor="#CAE6CA" height="16" width="306">Parameter</th>
<th bgcolor="#CAE6CA" height="16" width="105">Specification</th>
</tr>
<tr>
<td height="14" width="306"> authorizedUserGroups</td>
<td height="14" width="105"> PEP 200/277</td>
</tr>
<tr>
<td height="14" width="306"> enableAuditLog</td>
<td height="14" width="105"> PEP 258</td>
</tr>
<tr>
<td height="14" width="306"> enableHttpConnection</td>
<td height="14" width="105"> man page</td>
</tr>
<tr>
<td height="14" width="306"> enableHttpsConnection</td>
<td height="14" width="105"> man page</td>
</tr>
<tr>
<td height="14" width="306">
enableNamespaceAuthorization</td>
<td height="14" width="105"> man page</td>
</tr>
<tr>
<td height="14" width="306">
enableRemotePrivilegedUserAccess</td>
<td height="14" width="105"> man page</td>
</tr>
<tr>
<td height="10" width="306">
enableSubscriptionsForNonprivilegedUsers</td>
<td height="10" width="105"> man page</td>
</tr>
<tr>
<td height="14" width="306"> forceProviderProcesses</td>
<td height="14" width="105"> PEP 200/277</td>
</tr>
<tr>
<td height="14" width="306"> idleConnectionTimeout</td>
<td height="14" width="105"> man page</td>
</tr>
<tr>
<td height="14" width="306"> maxFailedProviderModuleRestarts</td>
<td height="14" width="105"> man page</td>
</tr>
<tr>
<td height="14" width="306"> logLevel</td>
<td height="14" width="105"> PEP 200/277</td>
</tr>
<tr>
<td height="14" width="306"> shutdownTimeout</td>
<td height="14" width="105"> man page</td>
</tr>
<tr>
<td height="14" width="306"> socketWriteTimeout</td>
<td height="14" width="105"> man page</td>
</tr>
<tr>
<td height="14" width="306"> sslClientVerificationMode</td>
<td height="14" width="105"> PEP 165</td>
</tr>
<tr>
<td height="14" width="306"> traceComponents</td>
<td height="14" width="105"> man page</td>
</tr>
<tr>
<td height="14" width="306"> traceLevel</td>
<td height="14" width="105"> man page</td>
</tr>
</table>
</ul>
<hr>
<p>Licensed to The Open Group (TOG) under one or more contributor license
agreements. Refer to the OpenPegasusNOTICE.txt file distributed with
this work for additional information regarding copyright ownership.
Each contributor licenses this file to you under the OpenPegasus Open
Source License; you may not use this file except in compliance with the
License.</p>
<p>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:</p>
<p>The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.</p>
<p>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.</p>
<hr>
</body>
</html>
| No CVS admin address has been configured |
Powered by ViewCVS 0.9.2 |