Class CIM_RegisteredProfile
extends CIM_ManagedElement

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

Name	Data Type	Value
Description	string	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.
UMLPackagePath	string	CIM::Interop
Version	string	2.27.0

Class Properties

Local Class Properties

Name	Data Type	Default Value	Qualifiers
Name	Data Type	Default Value	Name	Data Type	Value
InstanceID	string
			Description	string	Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following 'preferred' algorithm: <OrgID>:<LocalID> Where <OrgID> and <LocalID> are separated by a colon ':', and where <OrgID> MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority. (This is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness, <OrgID> MUST NOT contain a colon (':'). When using this algorithm, the first colon to appear in InstanceID MUST appear between <OrgID> and <LocalID>. <LocalID> is chosen by the organizational entity and SHOULD not be re-used to identify different underlying (real-world) elements. If the above 'preferred' algorithm is not used, the defining entity MUST assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance's NameSpace. For DMTF defined instances, the 'preferred' algorithm MUST be used with the <OrgID> set to 'CIM'.
			Key	boolean	true
			Override	string	InstanceID
OtherRegisteredOrganization	string
			Description	string	A free-form string providing a description of the organization when 1, "Other", is specified for the RegisteredOrganization.
			MaxLen	uint32	256
			ModelCorrespondence	string	CIM_RegisteredProfile.RegisteredOrganization
RegisteredName	string
			Description	string	The name of this registered profile. Since multiple versions can exist for the same RegisteredName, the combination of RegisteredName, RegisteredOrganization, and RegisteredVersion MUST uniquely identify the registered profile within the scope of the organization.
			MaxLen	uint32	256
			Required	boolean	true
RegisteredOrganization	uint16
			Description	string	The organization that defines this profile.
			ModelCorrespondence	string	CIM_RegisteredProfile.OtherRegisteredOrganization
			Required	boolean	true
			ValueMap	string	1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, ..
			Values	string	Other, DMTF, CompTIA, Consortium for Service Innovation, FAST, GGF, INTAP, itSMF, NAC, Northwest Energy Efficiency Alliance, SNIA, TM Forum, The Open Group, ANSI, IEEE, IETF, INCITS, ISO, W3C, OGF, The Green Grid, DMTF Reserved
RegisteredVersion	string
			Description	string	The version of this profile. The string representing the version MUST be in the form: M + "." + N + "." + U Where: M - The major version (in numeric form) describing the profile's creation or last modification. N - The minor version (in numeric form) describing the profile's creation or last modification. U - The update (e.g. errata, patch, ..., in numeric form) describing the profile's creation or last modification.
			Required	boolean	true
AdvertiseTypeDescriptions	string[]
			ArrayType	string	Indexed
			Description	string	A free-form string providing additional information related to the AdvertiseType. A description MUST be provided when the AdvertiseType is 1, "Other". An entry in this array corresponds to the entry in the AdvertiseTypes array at the same index. It is not expected that additional descriptions are needed if the Type is set to "Not Advertised" or "SLP". However, as the SLP template expands, or as other advertisement mechanisms are defined, support for additional descriptions may be needed. This array is defined to support this.
			ModelCorrespondence	string	CIM_RegisteredProfile.AdvertiseTypes
AdvertiseTypes	uint16[]
			ArrayType	string	Indexed
			Description	string	This property signifies the advertisement for the profile information. It is used by the advertising services of the WBEM infrastructure to determine what should be advertised, via what mechanisms. The property is an array so that the profile MAY be advertised using several mechanisms. Note: If this property is null/uninitialized, this is equivalent to specifying the value 2, "Not Advertised".
			ModelCorrespondence	string	CIM_RegisteredProfile.AdvertiseTypeDescriptions
			Required	boolean	true
			ValueMap	string	1, 2, 3
			Values	string	Other, Not Advertised, SLP
ImplementedFeatures	string[]
ImplementedFeatures	string[]		Description	string	Profiles 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

Name	Data Type	Class Origin
Caption	string	CIM_ManagedElement
Description	string	CIM_ManagedElement
ElementName	string	CIM_ManagedElement

Class Methods

Local Class Methods

CloseConformantInstances (uint32)

Method Qualifiers (CloseConformantInstances)

Name	Data Type	Value
Description	string	This operation is used to close a session to enumerate central and scoping class instances.

Method Parameters (CloseConformantInstances)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
EnumerationContext	string
		Description	string	The EnumerationContext parameter is the enumeration context value representing the enumeration session to be used.
		IN	boolean	true

OpenConformantInstances (uint32)

Method Qualifiers (OpenConformantInstances)

Name	Data Type	Value
Description	string	This 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.

Method Parameters (OpenConformantInstances)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
ContinueOnError	boolean
		Description	string	TRUE 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.
		IN	boolean	true
EndOfSequence	boolean
		Description	string	The 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.
		IN	boolean	false
		OUT	boolean	true
EnumerationContext	string
		Description	string	The 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.
		IN	boolean	false
		OUT	boolean	true
MaxObjectCount	uint32
		Description	string	The 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.
		IN	boolean	true
OperationTimeout	uint32
		Description	string	The 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.
		IN	boolean	true
ResultClass	string
		Description	string	NULL, 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.
		IN	boolean	true
IncludedPropertyList	string[]
		Description	string	NULL, 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.
		IN	boolean	true
InstanceType	uint16[]
		ArrayType	string	Indexed
		Description	string	On successful completion, an array corresponding to the InstanceWithPathList that indicates whether the entry is a scoping instance, a central instance, or both.
		IN	boolean	false
		ModelCorrespondence	string	CIM_ProfileRegistration.OpenConformantInstances(InstanceWithPathList)
		OUT	boolean	true
		ValueMap	string	2, 3, 4, ..
		Values	string	Central Instance, Scoping Instance, Central and Scoping Instance, DMTF Reserved
InstanceWithPathList	string[]
		ArrayType	string	Indexed
		Description	string	On 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.
		EmbeddedInstance	string	CIM_ManagedElement
		IN	boolean	false
		ModelCorrespondence	string	CIM_ProfileRegistration.OpenConformantInstances(InstanceType)
		OUT	boolean	true

PullConformantInstances (uint32)

Method Qualifiers (PullConformantInstances)

Name	Data Type	Value
Description	string	This operation is used to continue enumeration central class instances in the context of a session established by OpenConformantInstances.

Method Parameters (PullConformantInstances)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
EndOfSequence	boolean
		Description	string	The 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.
		IN	boolean	false
		OUT	boolean	true
EnumerationContext	string
		Description	string	The 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.
		IN	boolean	true
		OUT	boolean	true
MaxObjectCount	uint32
		Description	string	The 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.
		IN	boolean	true
InstanceType	uint16[]
		ArrayType	string	Indexed
		Description	string	On successful completion, an array corresponding to the InstanceWithPathList that indicates whether the entry is a scoping instance, a central instance, or both.
		IN	boolean	false
		ModelCorrespondence	string	CIM_ProfileRegistration.PullConformantInstances(InstanceWithPathList)
		OUT	boolean	true
		ValueMap	string	2, 3, 4, ..
		Values	string	Central Instance, Scoping Instance, Central and Scoping Instance, DMTF Reserved
InstanceWithPathList	string[]
		ArrayType	string	Indexed
		Description	string	On 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.
		EmbeddedInstance	string	CIM_ManagedElement
		IN	boolean	false
		ModelCorrespondence	string	CIM_ProfileRegistration.PullConformantInstances(InstanceType)
		OUT	boolean	true

Class CIM_RegisteredProfileextends CIM_ManagedElement

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

Class Hierarchy

Direct Known Subclasses

Class Qualifiers