OpenPegasus External Interface Definition

Abstract: 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.

## Definition of the Problem

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.

Note: 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.

Note: 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.

## Proposed Solution

## 2.0 External Interface Definitions

### 2.1 OpenPegasus C++ Interfaces

#### 2.1.1 Common

Source File | Specification
--- | ---
Pegasus/Common/AcceptLanguageList.h | Pegasus/Common/AcceptLanguageList.h
Pegasus/Common/Array.h | Pegasus/Common/Array.h
Pegasus/Common/ArrayInter.h | Pegasus/Common/ArrayInter.h
Pegasus/Common/CIMClass.h | Pegasus/Common/CIMClass.h
Pegasus/Common/CIMDateTime.h | Pegasus/Common/CIMDateTime.h
Pegasus/Common/CIMFlavor.h | Pegasus/Common/CIMFlavor.h
Pegasus/Common/CIMIndication.h | Pegasus/Common/CIMIndication.h
Pegasus/Common/CIMInstance.h | Pegasus/Common/CIMInstance.h
Pegasus/Common/CIMMethod.h | Pegasus/Common/CIMMethod.h
Pegasus/Common/CIMName.h | Pegasus/Common/CIMName.h
Pegasus/Common/CIMObject.h | Pegasus/Common/CIMObject.h
Pegasus/Common/CIMObjectPath.h | Pegasus/Common/CIMObjectPath.h
Pegasus/Common/CIMOperationType.h | Pegasus/Common/CIMOperationType.h
Pegasus/Common/CIMParamValue.h | Pegasus/Common/CIMParamValue.h
Pegasus/Common/CIMParameter.h | Pegasus/Common/CIMParameter.h
Pegasus/Common/CIMProperty.h | Pegasus/Common/CIMProperty.h
Pegasus/Common/CIMPropertyList.h | Pegasus/Common/CIMPropertyList.h
Pegasus/Common/CIMQualifier.h | Pegasus/Common/CIMQualifier.h
Pegasus/Common/CIMQualifierDecl.h | Pegasus/Common/CIMQualifierDecl.h
Pegasus/Common/CIMScope.h | Pegasus/Common/CIMScope.h
Pegasus/Common/CIMStatusCode.h | Pegasus/Common/CIMStatusCode.h
Pegasus/Common/CIMType.h | Pegasus/Common/CIMType.h
Pegasus/Common/CIMValue.h | Pegasus/Common/CIMValue.h
Pegasus/Common/Char16.h | Pegasus/Common/Char16.h
Pegasus/Common/Config.h | Pegasus/Common/Config.h
Pegasus/Common/ContentLanguageList.h | Pegasus/Common/ContentLanguageList.h
Pegasus/Common/Exception.h | Pegasus/Common/Exception.h
Pegasus/Common/LanguageTag.h | Pegasus/Common/LanguageTag.h
Pegasus/Common/Linkage.h | Pegasus/Common/Linkage.h
Pegasus/Common/OperationContext.h | Pegasus/Common/OperationContext.h
Pegasus/Common/ResponseHandler.h | Pegasus/Common/ResponseHandler.h
Pegasus/Common/SSLContext.h | Pegasus/Common/SSLContext.h
Pegasus/Common/String.h | Pegasus/Common/String.h

#### 2.1.2 Client

Source File | Specification
--- | ---
Pegasus/Client/CIMClient.h | Pegasus/Client/CIMClient.h
Pegasus/Client/CIMClientException.h | Pegasus/Client/CIMClientException.h
Pegasus/Client/Linkage.h | Pegasus/Client/Linkage.h
Pegasus/Client/ClientOpPerformanceDataHandler.h | Pegasus/Client/ClientOpPerformanceDataHandler.h

#### 2.1.3 Provider

Source File | Specification
--- | ---
Pegasus/Provider/CIMAssociationProvider.h | Pegasus/Provider/CIMAssociationProvider.h
Pegasus/Provider/CIMIndicationConsumerProvider.h | Pegasus/Provider/CIMIndicationConsumerProvider.h
Pegasus/Provider/CIMIndicationProvider.h | Pegasus/Provider/CIMIndicationProvider.h
Pegasus/Provider/CIMInstanceProvider.h | Pegasus/Provider/CIMInstanceProvider.h
Pegasus/Provider/CIMMethodProvider.h | Pegasus/Provider/CIMMethodProvider.h
Pegasus/Provider/CIMOMHandle.h | Pegasus/Provider/CIMOMHandle.h
Pegasus/Provider/CIMProvider.h | Pegasus/Provider/CIMProvider.h
Pegasus/Provider/Linkage.h | Pegasus/Provider/Linkage.h
Pegasus/Provider/ProviderException.h | Pegasus/Provider/ProviderException.h

#### 2.1.4 Consumer

Source File | Specification
--- | ---
Pegasus/Consumer/CIMIndicationConsumer.h | Pegasus/Consumer/CIMIndicationConsumer.h
Pegasus/Consumer/Linkage.h | Pegasus/Consumer/Linkage.h

### 2.2 OpenPegasus CMPI C Interfaces

#### 2.2.1 Provider

Source File | Specification
--- | ---
Pegasus/Provider/CMPI/cmpidt.h | Pegasus/Provider/CMPI/cmpidt.h
Pegasus/Provider/CMPI/cmpift.h | Pegasus/Provider/CMPI/cmpift.h
Pegasus/Provider/CMPI/cmpimacs.h | Pegasus/Provider/CMPI/cmpimacs.h
Pegasus/Provider/CMPI/cmpios.h | Pegasus/Provider/CMPI/cmpios.h
Pegasus/Provider/CMPI/cmpipl.h | Pegasus/Provider/CMPI/cmpipl.h

### 2.2 Schema Definitions

Only schema changes consistent with the DMTF definition of "minor" version changes are considered "backward compatible".

#### 2.2.1 CIM Schema (CIM_)

As a statement of policy, the use of CIM_Schema is strongly encouraged and any use of CIM_ Schema MUST be DMTF compliant.

#### 2.2.2 Pegasus Schema (PG_)

Source File | Specification
--- | ---
Schemas/Pegasus/InterOp/VER20/PG_ProviderModule20.mof | MOF
Schemas/Pegasus/ManagedSystem/VER20/PG_OperatingSystem20.mof | MOF
Schemas/Pegasus/ManagedSystem/VER20/PG_ComputerSystem20.mof | MOF
Schemas/Pegasus/ManagedSystem/VER20/PG_UnixProcess20.mof | MOF
Schemas/Pegasus/ManagedSystem/VER20/PG_DNSService20.mof | MOF
Schemas/Pegasus/ManagedSystem/VER20/PG_NTPService20.mof | MOF
Schemas/Pegasus/ManagedSystem/VER20/PG_IP20.mof | MOF

### 2.3 Command Line Interfaces

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.

CLI | Specification
--- | ---
cimauth | man page
cimconfig | man page
cimmof | man page
cimprovider | man page
cimreparchive | man page
cimserver | man page
cimsub | man page
cimtrust | man page
cimuser | man page
osinfo | man page
wbemexec | man page

### 2.4 Configuration Parameters

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.

Parameter | Specification
--- | ---
authorizedUserGroups | PEP 200/277
enableAuditLog | PEP 258
enableHttpConnection | man page
enableHttpsConnection | man page
enableNamespaceAuthorization | man page
enableRemotePrivilegedUserAccess | man page
enableSubscriptionsForNonprivilegedUsers | man page
forceProviderProcesses | PEP 200/277
idleConnectionTimeout | man page
maxFailedProviderModuleRestarts | man page
logLevel | PEP 200/277
shutdownTimeout | man page
socketWriteTimeout | man page
sslClientVerificationMode | PEP 165
traceComponents | man page
traceLevel | man page

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.

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:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

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.