Class CIM_RegisteredProfile
extends CIM_RegisteredSpecification

A RegisteredProfile describes a set of CIM Schema classes with required properties and/or methods, necessary to manage a real-world entity or to support a usage scenario, in an interoperable fashion. RegisteredProfiles can be defined by the DMTF or other standards organizations. Note that this class should not be confused with CIM_Profile, which collects SettingData instances, to be applied as a 'configuration profile' for an element. A RegisteredProfile is a named 'standard' for CIM-based management of a particular System, subsystem, Service or other entity, for a specified set of uses. It is a complete, standalone definition, as opposed to the subclass RegisteredSubProfile, which requires a scoping profile for context. The uses for a RegisteredProfile or SubProfile MUST be specified in the document that defines the profile. Examples of Profiles are to manage various aspects of an Operating System, Storage Array, or Database. The name of the profile is defined and scoped by its authoring organization.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_RegisteredSpecification
   |
   +--CIM_RegisteredProfile

Direct Known Subclasses

CIM_RegisteredSubProfile

Class Qualifiers

NameData TypeValue
DescriptionstringA RegisteredProfile describes a set of CIM Schema classes with required properties and/or methods, necessary to manage a real-world entity or to support a usage scenario, in an interoperable fashion. RegisteredProfiles can be defined by the DMTF or other standards organizations. Note that this class should not be confused with CIM_Profile, which collects SettingData instances, to be applied as a 'configuration profile' for an element. A RegisteredProfile is a named 'standard' for CIM-based management of a particular System, subsystem, Service or other entity, for a specified set of uses. It is a complete, standalone definition, as opposed to the subclass RegisteredSubProfile, which requires a scoping profile for context. The uses for a RegisteredProfile or SubProfile MUST be specified in the document that defines the profile. Examples of Profiles are to manage various aspects of an Operating System, Storage Array, or Database. The name of the profile is defined and scoped by its authoring organization.
UMLPackagePathstringCIM::Interop
Versionstring2.27.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
SpecificationTypeuint16
DescriptionstringIf this property has a value other than null, the value shall be 2
ModelCorrespondencestringCIM_RegisteredSpecification.OtherSpecificationType
OverridestringSpecificationType
ValueMapstring2
ValuesstringProfile
ImplementedFeaturesstring[]
DescriptionstringProfiles may gather a set of provisions together that are implemented, (or not implemented), as a whole by a conformant implementation. Such sets are known as profile features. If a profile does not define features, then this property shall be null. If not null, an implementation shall put the profile defined feature name of each implemented feature in a separate entry of this array.

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
DescriptionstringCIM_ManagedElement
ElementNamestringCIM_ManagedElement
Generationuint64CIM_ManagedElement
InstanceIDstringCIM_RegisteredSpecification
OtherRegisteredOrganizationstringCIM_RegisteredSpecification
OtherSpecificationTypestringCIM_RegisteredSpecification
RegisteredNamestringCIM_RegisteredSpecification
RegisteredOrganizationuint16CIM_RegisteredSpecification
RegisteredVersionstringCIM_RegisteredSpecification
AdvertiseTypeDescriptionsstring[]CIM_RegisteredSpecification
AdvertiseTypesuint16[]CIM_RegisteredSpecification

Class Methods

Local Class Methods

CloseConformantInstances (uint32)

Method Qualifiers (CloseConformantInstances)

NameData TypeValue
DescriptionstringThis operation is used to close a session to enumerate central and scoping class instances.
VALUEMAPstring0, 1, ..
VALUESstringCompleted with No Error, Not Supported, DMTF Reserved

Method Parameters (CloseConformantInstances)

NameTypeQualifiers
NameData TypeValue
EnumerationContextstring
DescriptionstringThe EnumerationContext parameter is the enumeration context value representing the enumeration session to be used.
INbooleantrue

OpenConformantInstances (uint32)

Method Qualifiers (OpenConformantInstances)

NameData TypeValue
DescriptionstringThis operation is used to establish and open a session to enumerate central and scoping class instances of this registered profile instance and optionally to retrieve a first set of such instances.
VALUEMAPstring0, 1, 22, 26, ..
VALUESstringCompleted with No Error, Not Supported, CIM_ERR_INVALID_OPERATION_TIMEOUT, CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED, DMTF Reserved

Method Parameters (OpenConformantInstances)

NameTypeQualifiers
NameData TypeValue
ContinueOnErrorboolean
DescriptionstringTRUE requests continuation on error. Continuation on error is the ability to resume an enumeration session successfully after an invocation of this method that returned an error. A conformant implementation may support continuation on error. If ContinueOnError is true and the method does not support continuation on error, it shall return failure with return code CIM_ERR_CONTINUATION_ON_ERROR_NOT_SUPPORTED If the implementation supports continuation on error, it shall support it as follows: If ContinueOnErroris true, the enumeration session shall remain open when this or a subsequent PullConformantInstances invocation returns failure, and any subsequent successful PullConformantInstances operations process the set of instances that would have remained if the failing invocation had been successful, subject to the consistency rules defined for pulled enumerations, see DSP0223. If ContinueOnError is false, the enumeration session shall be closed when this method returns failure.
INbooleantrue
EndOfSequenceboolean
DescriptionstringThe EndOfSequence output parameter indicates to the CIM Client whether the enumeration session is exhausted. If EndOfSequence is true upon successful completion of this invocation, no more elements are available and the implmeentation shall close the enumeration session, releasing any possibly allocated resources related to the enumeration session. If EndOfSequence is false, there may be additional elements available and implementation shall not close the enumeration session.
INbooleanfalse
OUTbooleantrue
EnumerationContextstring
DescriptionstringThe EnumerationContext parameter is the enumeration context value representing the enumeration session to be used. If the session is closed as a result of this invocation, the output EnumerationContext shall be NULL. Otherwise, the output EnumerationContext shall provide the information necessary for a subsequent PullConformantInstances call.
INbooleanfalse
OUTbooleantrue
MaxObjectCountuint32
DescriptionstringThe MaxObjectCount input parameter defines the maximum number of elements that may be returned by this Pull operation. Any uint32 number is valid, including 0. The implementation may deliver any number of elements up to MaxObjectCount but shall not deliver more than MaxObjectCount.elements. The CIM Client may use a MaxObjectCount value of 0 as a means of restarting the OperationTimeout for the enumeration session, while it wishes to not retrieve any elements.
INbooleantrue
OperationTimeoutuint32
DescriptionstringThe operation timeout is the minimum time the CIM Server shall maintain the open enumeration session after the last OpenConformantInstances or PullConformantInstances invocation, (unless the enumeration session was closed during that last invocation). If the operation timeout is exceeded, the enumeration session may be closed at any time, releasing any possibly allocated resources related to the enumeration session. An OperationTimeout of 0 means that there is no operation timeout, i.e. the enumeration session is never closed based on time. If OperationTimeout is NULL, the operation timeout is implementation dependent. All other values for OperationTimeout specify the operation timeout in seconds. The implementation may restrict the set of allowable values for OperationTimeout. This specifically includes the possibility to not allow 0 (no timeout). If the specified value is not an allowable value, the method shall return failure with return code CIM_ERR_INVALID_OPERATION_TIMEOUT.
INbooleantrue
ResultClassstring
DescriptionstringNULL, or a class name that acts as a filter to select only those central or scoping instances that a kind of the specified class. This is useful to select particular subclasses or to select a particular instances when more than one is defined for a profile.
INbooleantrue
IncludedPropertyListstring[]
DescriptionstringNULL, or unordered set of property names, acting as a restricting filter on the properties included in the returned instance. An empty list specifies to return no properties. The instance path shall always be returned.
INbooleantrue
InstanceTypeuint16[]
ArrayTypestringIndexed
DescriptionstringOn successful completion, an array corresponding to the InstanceWithPathList that indicates whether the entry is a scoping instance, a central instance, or both.
INbooleanfalse
ModelCorrespondencestringCIM_ProfileRegistration.OpenConformantInstances(InstanceWithPathList)
OUTbooleantrue
ValueMapstring2, 3, 4, ..
ValuesstringCentral Instance, Scoping Instance, Central and Scoping Instance, DMTF Reserved
InstanceWithPathListstring[]
ArrayTypestringIndexed
DescriptionstringOn successful completion, an correlated, but unordered set of the enumerated instances and their addresses, with a number of entries from 0, up to a maximum defined by MaxObjectCount, that meet the criteria defined in the Open operation that established this enumeration session. Note that returning no entries in the array does not imply that the enumeration session has been exhausted. Only the EndOfSequence output parameter indicates whether the enumeration session has been exhausted.
EmbeddedInstancestringCIM_ManagedElement
INbooleanfalse
ModelCorrespondencestringCIM_ProfileRegistration.OpenConformantInstances(InstanceType)
OUTbooleantrue

PullConformantInstances (uint32)

Method Qualifiers (PullConformantInstances)

NameData TypeValue
DescriptionstringThis operation is used to continue enumeration central class instances in the context of a session established by OpenConformantInstances.
VALUEMAPstring0, 1, 21, ..
VALUESstringCompleted with No Error, Not Supported, CIM_ERR_INVALID_ENUMERATION_CONTEXT, DMTF Reserved

Method Parameters (PullConformantInstances)

NameTypeQualifiers
NameData TypeValue
EndOfSequenceboolean
DescriptionstringThe EndOfSequence output parameter indicates to the CIM Client whether the enumeration session is exhausted. If EndOfSequence is true upon successful completion of this method, no more elements are available and the enumeration session shall be closed, releasing any possibly allocated resources related to the enumeration session. If EndOfSequence is false, there may be additional elements available and enumeration session shall be remain open unless there is an error in which case, ContinueOnError governs whether or not the session is closed or not.
INbooleanfalse
OUTbooleantrue
EnumerationContextstring
DescriptionstringThe EnumerationContext parameter is the enumeration context value representing the enumeration session to be used. On input, it shall be the EnumerationContext ouput value from the previous invocation of OpenConformantInstances or PullConformantInstances within an open enumeration session.If the session is closed as a result of this invocation, the output EnumerationContext shall be NULL. Otherwise, the output EnumerationContext shall provide the information necessary for a subsequent PullConformantInstances call.
INbooleantrue
OUTbooleantrue
MaxObjectCountuint32
DescriptionstringThe MaxObjectCount input parameter defines the maximum number of elements that may be returned by this method. Any uint32 number is valid, including 0. The implementation may deliver any number of elements up to MaxObjectCount but shall not deliver more than MaxObjectCount elements. The CIM Client may use a MaxObjectCount value of 0 as a means of restarting the OperationTimeout for the enumeration session, while it wishes to not retrieve any elements.
INbooleantrue
InstanceTypeuint16[]
ArrayTypestringIndexed
DescriptionstringOn successful completion, an array corresponding to the InstanceWithPathList that indicates whether the entry is a scoping instance, a central instance, or both.
INbooleanfalse
ModelCorrespondencestringCIM_ProfileRegistration.PullConformantInstances(InstanceWithPathList)
OUTbooleantrue
ValueMapstring2, 3, 4, ..
ValuesstringCentral Instance, Scoping Instance, Central and Scoping Instance, DMTF Reserved
InstanceWithPathListstring[]
ArrayTypestringIndexed
DescriptionstringOn successful completion, a correlated, but unordered set of the enumerated instances and their addresses, with a number of entries from 0, up to a maximum defined by MaxObjectCount, that meet the criteria defined in the OpenConformantInstances operation that established this enumeration session. Note that returning no entries in the array does not imply that the enumeration session has been exhausted. Only the EndOfSequence output parameter indicates whether the enumeration session has been exhausted.
EmbeddedInstancestringCIM_ManagedElement
INbooleanfalse
ModelCorrespondencestringCIM_ProfileRegistration.PullConformantInstances(InstanceType)
OUTbooleantrue