CIM2.17.1 Class Declaration
CIM_CLPSettingData

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_CLPSettingData --> CIM_SettingData --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_SettingData
NAMECIM_CLPSettingData

Class Qualifiers

Class CIM_CLPSettingData Qualifiers
NameTypeValueFrom Class
ExperimentalbooleantrueCIM_CLPSettingData
Versionstring2.11.0CIM_CLPSettingData
UMLPackagePathstringCIM::Network::ProtocolEndpointsCIM_CLPSettingData
DescriptionstringA representation of the SettingData of a CLProtocol. The relationship between the SettingData and the CLP Service is described by instantiating the ProvidesEndpoint association, with an association to the transport (TelnetProtocolEndpoint or SSHProtocolEndpoint) with a BindsTo association.CIM_CLPSettingData
UMLPackagePathstringCIM::Core::SettingsCIM_SettingData
DescriptionstringCIM_SettingData is used to represent configuration and and operational parameters for CIM_ManagedElement instances. There are a number of different uses of CIM_SettingData supported in the model today. Additional uses may be defined in the future.Instances of CIM_SettingData may represent Aspects of a CIM_ManagedElement instance. This is modeled using the CIM_SettingsDefineState association. CIM_SettingData may be used to define capabilities when associated to an instance of CIM_Capabilities through the CIM_SettingsDefineCapabilities association. Instances of CIM_SettingData may represent different types of configurations for a CIM_ManagedElement, including persistent configurations, in progress configuration changes, or requested configurations. The CIM_ElementSettingData association is used to model the relationship between a CIM_SettingData instance and the CIM_ManagedElement for which it is a configuration. When an instance of CIM_SettingData represents a configuration, the current operational values for the parameters of the element are reflected by properties in the Element itself or by properties in its associations. These properties do not have to be the same values that are present in the SettingData object. For example, a modem might have a SettingData baud rate of 56Kb/sec but be operating at 19.2Kb/sec. Note: The CIM_SettingData class is very similar to CIM_Setting, yet both classes are present in the model because many implementations have successfully used CIM_Setting. However, issues have arisen that could not be resolved without defining a new class. Therefore, until a new major release occurs, both classes will exist in the model. Refer to the Core White Paper for additional information. SettingData instances can be aggregated together into higher- level SettingData objects using ConcreteComponent associations.CIM_SettingData
UMLPackagePathstringCIM::Core::CoreElementsCIM_ManagedElement
DescriptionstringManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema.CIM_ManagedElement

Properties

Properties
NameTypeValueQualifiersClassOrigin
CurrentDefaultTargetstring Description
ModelCorrespondence
CIM_CLPSettingData
KeepTimeuint16 Write
Description
Units
ModelCorrespondence
PUnit
CIM_CLPSettingData
WaitBehaviorboolean Write
Description
ModelCorrespondence
CIM_CLPSettingData
OutputFormatuint16 Write
Description
ValueMap
Values
ModelCorrespondence
CIM_CLPSettingData
OutputVerbosityuint16 Write
Description
ValueMap
Values
ModelCorrespondence
CIM_CLPSettingData
OutputLanguagestring Write
Description
CIM_CLPSettingData
OutputPositionuint16 Write
Description
ValueMap
Values
ModelCorrespondence
CIM_CLPSettingData
OutputOrderuint16 Write
Description
ValueMap
Values
ModelCorrespondence
CIM_CLPSettingData
OutputCountuint32 Write
Description
ModelCorrespondence
CIM_CLPSettingData
DisplayOptionstring Write
Description
ModelCorrespondence
CIM_CLPSettingData
InstanceIDstring Key
Description
CIM_SettingData
ElementNamestring Required
Override
Description
CIM_SettingData
ConfigurationNamestring Experimental
Description
CIM_SettingData
ChangeableTypeuint16 Experimental
Description
ValueMap
Values
CIM_SettingData
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement

Property Qualifiers

Property CurrentDefaultTarget Qualifiers
NameTypeValueFrom Class
DescriptionstringIdentifies the initial Current Default Target when a CLP Session is established. The Current Default Target is the CLP session environment setting that establishes a default base address for all command targets that are expressed as a relative target address and is used as the command target if no command target is specified in a command. The CLP specification requires this value to be fixed at the root of the address space being managed. Therefore this value does not have a write qualifier.CIM_CLPSettingData
ModelCorrespondencestringCIM_CLPProtocolEndpoint.CurrentDefaultTargetCIM_CLPSettingData

Property KeepTime Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_CLPSettingData
DescriptionstringEstablishes the amount of time in seconds that the CLP Session should retain a CLP command job status. A KeepTime value of zero shall be interpreted to mean keep forever.CIM_CLPSettingData
UnitsstringSecondsCIM_CLPSettingData
ModelCorrespondencestringCIM_CLPProtocolEndpoint.KeepTimeCIM_CLPSettingData
PUnitstringsecondCIM_CLPSettingData

Property WaitBehavior Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_CLPSettingData
DescriptionstringWhen TRUE the CLP Session will not return a command response until all spawned jobs have completed, otherwise it may.CIM_CLPSettingData
ModelCorrespondencestringCIM_CLPProtocolEndpoint.WaitBehaviorCIM_CLPSettingData

Property OutputFormat Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_CLPSettingData
DescriptionstringOutputFormat establishes the default CLP Session command output format, as described in SM CLP Specification, DMTF document DSP0214.CIM_CLPSettingData
ValueMapstring
[See below.]
CIM_CLPSettingData
ValuesstringDMTF Reserved
DMTF Reserved
Text
clpcsv
Keyword
clpxml
DMTF Reserved
Vendor Reserved
CIM_CLPSettingData
ModelCorrespondencestringCIM_CLPProtocolEndpoint.OutputFormatCIM_CLPSettingData

NameValue
0DMTF Reserved
1DMTF Reserved
2Text
3clpcsv
4Keyword
5clpxml
..DMTF Reserved
0x8000..0xFFFFVendor Reserved
Property OutputVerbosity Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_CLPSettingData
DescriptionstringOutputVerbosity establishes the default CLP Session output level of detail, as described in SM CLP Specification, DMTF document DSP0214.CIM_CLPSettingData
ValueMapstring
[See below.]
CIM_CLPSettingData
ValuesstringDMTF Reserved
DMTF Reserved
Error
Terse
Verbose
DMTF Reserved
Vendor Reserved
CIM_CLPSettingData
ModelCorrespondencestringCIM_CLPProtocolEndpoint.OutputVerbosityCIM_CLPSettingData

NameValue
0DMTF Reserved
1DMTF Reserved
2Error
3Terse
4Verbose
..DMTF Reserved
0x8000..0xFFFFVendor Reserved
Property OutputLanguage Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_CLPSettingData
DescriptionstringEstablishes the default CLP Session command output language. As described in SM CLP Specification, DMTF document DSP0214, the language value is a 3-character string identifier of language as specified in ISO 639.2; "eng" is the default.CIM_CLPSettingData

Property OutputPosition Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_CLPSettingData
DescriptionstringOutputPosition establishes the default CLP Session command output beginning position when multiple items are returned in the command output, as described in SM CLP Specification, DMTF document DSP0214.CIM_CLPSettingData
ValueMapstring
[See below.]
CIM_CLPSettingData
ValuesstringDMTF Reserved
DMTF Reserved
Begin
End
DMTF Reserved
Vendor Reserved
CIM_CLPSettingData
ModelCorrespondencestringCIM_CLPProtocolEndpoint.OutputPositionCIM_CLPSettingData

NameValue
0DMTF Reserved
1DMTF Reserved
2Begin
3End
..DMTF Reserved
0x8000..0xFFFFVendor Reserved
Property OutputOrder Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_CLPSettingData
DescriptionstringOutputOrder establishes the default CLP Session command output order when multiple items are returned in the command output as described in SM CLP Specification, DMTF document DSP0214.CIM_CLPSettingData
ValueMapstring
[See below.]
CIM_CLPSettingData
ValuesstringDMTF Reserved
DMTF Reserved
Default
Reverse
DMTF Reserved
Vendor Reserved
CIM_CLPSettingData
ModelCorrespondencestringCIM_CLPProtocolEndpoint.OutputOrderCIM_CLPSettingData

NameValue
0DMTF Reserved
1DMTF Reserved
2Default
3Reverse
..DMTF Reserved
0x8000..0xFFFFVendor Reserved
Property OutputCount Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_CLPSettingData
DescriptionstringEstablishes the default CLP Session command output count number when multiple items are returned in the output as described in SM CLP Specification, DMTF document DSP0214. The value 0xFFFFFFFF shall be interpreted to mean that all items are to be returned. The maximum value for the count number is determined by the class of the target.CIM_CLPSettingData
ModelCorrespondencestringCIM_CLPProtocolEndpoint.OutputCountCIM_CLPSettingData

Property DisplayOption Qualifiers
NameTypeValueFrom Class
WritebooleantrueCIM_CLPSettingData
DescriptionstringEstablishes the default value for the display option. The argument string is stored "as-is" without normalization beyond capitalization. The argument string is compliant with the SM CLP command line grammar.CIM_CLPSettingData
ModelCorrespondencestringCIM_CLPProtocolEndpoint.DisplayOptionCIM_CLPSettingData

Property InstanceID Qualifiers
NameTypeValueFrom Class
KeybooleantrueCIM_SettingData
DescriptionstringWithin the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. 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 that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement 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 business entity and should not be reused to identify different underlying (real-world) elements. If the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM.CIM_SettingData

Property ElementName Qualifiers
NameTypeValueFrom Class
RequiredbooleantrueCIM_SettingData
DescriptionstringThe user-friendly name for this instance of SettingData. In addition, the user-friendly name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.)CIM_SettingData

Property ConfigurationName Qualifiers
NameTypeValueFrom Class
DescriptionstringAn instance of CIM_SettingData may correspond to a well-known configuration that exists for an associated CIM_ManagedElement. If the ConfigurationName property is non-NULL, the instance of CIM_SettingData shall correspond to a well-known configuration for a Managed Element, the value of the ConfigurationName property shall be the name of the configuration, and the ChangeableType property shall have the value 0 or 2. A value of NULL for the ConfigurationName property shall mean that the instance of CIM_SettingData does not correspond to a well-known configuration for a Managed Element or that this information is unknown.CIM_SettingData

Property ChangeableType Qualifiers
NameTypeValueFrom Class
DescriptionstringEnumeration indicating the type of setting. 0 "Not Changeable - Persistent" indicates the instance of SettingData represents primordial settings and shall not be modifiable. 1 "Changeable - Transient" indicates the SettingData represents modifiable settings that are not persisted. Establishing persistent settings from transient settings may be supported. 2 "Changeable - Persistent" indicates the SettingData represents a persistent configuration that may be modified. 3 "Not Changeable - Transient" indicates the SettingData represents a snapshot of the settings of the associated ManagedElement and is not persistent.CIM_SettingData
ValueMapstring
[See below.]
CIM_SettingData
ValuesstringNot Changeable - Persistent
Changeable - Transient
Changeable - Persistent
Not Changeable - Transient
CIM_SettingData

NameValue
0Not Changeable - Persistent
1Changeable - Transient
2Changeable - Persistent
3Not Changeable - Transient
NameValue
0Not Changeable - Persistent
1Changeable - Transient
2Changeable - Persistent
3Not Changeable - Transient
NameValue
0Not Changeable - Persistent
1Changeable - Transient
2Changeable - Persistent
3Not Changeable - Transient
Property Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object.CIM_ManagedElement
MaxLenuint3264CIM_ManagedElement

Property Description Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Description property provides a textual description of the object.CIM_ManagedElement

Property ElementName Qualifiers
NameTypeValueFrom Class
DescriptionstringA user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information. Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties.CIM_ManagedElement

Methods

Method Qualifiers

Parameters

Parameter Qualifiers

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_SettingsDefineStateCIM_SettingDataSettingData
CIM_SettingsDefineCapabilitiesCIM_SettingDataPartComponent
CIM_SettingAssociatedToCapabilitiesCIM_SettingDataDependent
CIM_SettingsAffectSettingsCIM_SettingDataAntecedent
CIM_SettingsAffectSettingsCIM_SettingDataDependent
CIM_ElementSettingDataCIM_SettingDataSettingData
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_SettingsDefineStateCIM_ManagedElementManagedElement
CIM_StatisticsCIM_ManagedElementElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement
CIM_AuthorizationRuleAppliesToTargetCIM_ManagedElementManagedElement
CIM_CredentialContextCIM_ManagedElementElementProvidingContext
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_OrderedComponentCIM_ManagedElementGroupComponent
CIM_OrderedComponentCIM_ManagedElementPartComponent
CIM_ProductElementComponentCIM_ManagedElementPartComponent
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_OrderedDependencyCIM_ManagedElementAntecedent
CIM_OrderedDependencyCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementDependent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_IsSpareCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SWRManageableAspectCIM_ManagedElementSystemElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_OrderedMemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_MemberOfStatusCollectionCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_OwningCollectionElementCIM_ManagedElementOwningElement
CIM_AbstractIndicationSubscriptionCIM_ManagedElementFilter
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_DefaultElementCapabilitiesCIM_ManagedElementManagedElement
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_RoleLimitedToTargetCIM_ManagedElementTargetElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_AvailableDiagnosticServiceCIM_ManagedElementUserOfService
CIM_AssociatedPowerManagementServiceCIM_ManagedElementUserOfService
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ManagementSAPCIM_ManagedElementManagedElement