CIM2.17.1 Class Declaration
CIM_IPCOMPTransform

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

Class Hierarchy

CIM_IPCOMPTransform --> CIM_SATransform --> CIM_ScopedSettingData --> CIM_SettingData --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_SATransform
NAMECIM_IPCOMPTransform

Class Qualifiers

Class CIM_IPCOMPTransform Qualifiers
NameTypeValueFrom Class
Versionstring2.8.0CIM_IPCOMPTransform
UMLPackagePathstringCIM::Network::IPsecCIM_IPCOMPTransform
DescriptionstringThe IPCOMPTransform specifies the IP compression algorithm to use for payload of the Security Association.CIM_IPCOMPTransform
MappingStringsstringIPSP Model.IETF|IPCOMPTransformCIM_IPCOMPTransform
UMLPackagePathstringCIM::Network::IPsecCIM_SATransform
DescriptionstringSATransform is the base class for the various types of transforms that are in effect for an existing IPsecSAEndpoint, or aggregated into phase 2 proposals used during the IPsec negotiation process. This class is defined as a kind of ScopedSettingData, since it describes the set of transform properties that MUST be applied together, if negotiated. This subclassing is different than that defined in IETF's IPSP Policy draft - where it is subclassed from Policy. The definition as SettingData is more consistent with the application of the properties as a set, to the negotiated Security Association. Note that an instance of this class is 'scoped' or contained by a System (either a ComputerSystem or AdminDomain), rather than by a SecurityAssociationEndpoint. This is indicated by instantiating the ScopedSetting association, and is necessary since the transform data is used in IPsec negotiation policies (also scoped by Systems) before ever being associated with a SecurityAssociationEndpoint. The latter semantics (i.e., that 'this' transform is negotiated for 'this' Security Association) is conveyed via a subclass of ElementSettingData, TransformOfSecurityAssociation.CIM_SATransform
MappingStringsstringIPSP Model.IETF|SATransformCIM_SATransform
UMLPackagePathstringCIM::Core::SettingsCIM_ScopedSettingData
DescriptionstringThe ScopedSettingData class represents the general concept of SettingData, which is scoped or contained by a ManagedElement (that is, settings that are specifically defined for a system, device, and so on). ScopedSettingData is tied to a ManagedElement using the ScopedSetting association. Note that the cardinality of the ManagedElement reference is Min(1), Max(1). This cardinality mandates the instantiation of the ScopedSetting association for the referenced instance of ScopedSettingData. ScopedSetting describes the existence requirements and context for the referenced instance of ManagedElement. Specifically, the ManagedElement must exist and it provides the context for the ScopedSettingData.CIM_ScopedSettingData
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
Algorithmuint16 Description
ValueMap
Values
MappingStrings
ModelCorrespondence
CIM_IPCOMPTransform
OtherAlgorithmstring Description
ModelCorrespondence
CIM_IPCOMPTransform
PrivateAlgorithmuint32 Description
MappingStrings
ModelCorrespondence
CIM_IPCOMPTransform
DictionarySizeuint16 Description
MappingStrings
CIM_IPCOMPTransform
ElementNamestring Override
MappingStrings
Required
Description
CIM_SATransform
MaxLifetimeSecondsuint640Description
Units
MappingStrings
PUnit
CIM_SATransform
MaxLifetimeKilobytesuint640Description
Units
MappingStrings
PUnit
CIM_SATransform
VendorIDstringnoneDescription
MappingStrings
CIM_SATransform
InstanceIDstring Key
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 Algorithm Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Algorithm is an enumeration that designates the IPCOMP compression algorithm to use. Its values are generated from RFC2407, Section 4.4.5. Note that the values are modified from the RFC, since 'Other' must be taken into account.CIM_IPCOMPTransform
ValueMapstring
[See below.]
CIM_IPCOMPTransform
ValuesstringOther
Vendor Algorithm/OUI
DEFLATE
LZS
CIM_IPCOMPTransform
MappingStringsstringIPSP Model.IETF|IPCOMPTransform.Algorithm
RFC2407.IETF|Section 4.4.5
CIM_IPCOMPTransform
ModelCorrespondencestringCIM_IPCOMPTransform.PrivateAlgorithm
CIM_IPCOMPTransform.OtherAlgorithm
CIM_IPCOMPTransform

NameValue
1Other
2Vendor Algorithm/OUI
3DEFLATE
4LZS
Property OtherAlgorithm Qualifiers
NameTypeValueFrom Class
DescriptionstringDescription of the compression algorithm when the value 1 ("Other") is specified for the property, Algorithm.CIM_IPCOMPTransform
ModelCorrespondencestringCIM_IPCOMPTransform.AlgorithmCIM_IPCOMPTransform

Property PrivateAlgorithm Qualifiers
NameTypeValueFrom Class
DescriptionstringA private compression algorithm, used when the Algorithm property is set to 2, "Vendor Algorithm/OUI".CIM_IPCOMPTransform
MappingStringsstringIPSP Model.IETF|IPCOMPTransform.PrivateAlgorithmCIM_IPCOMPTransform
ModelCorrespondencestringCIM_IPCOMPTransform.AlgorithmCIM_IPCOMPTransform

Property DictionarySize Qualifiers
NameTypeValueFrom Class
DescriptionstringDictionarySize is an optional field that specifies the log2 maximum size of the dictionary for the compression algorithm. For dictionaries that have a fixed size, this value is ignored.CIM_IPCOMPTransform
MappingStringsstringIPSP Model.IETF|IPCOMPTransform.DictionarySizeCIM_IPCOMPTransform

Property ElementName Qualifiers
NameTypeValueFrom Class
MappingStringsstringIPSP Model.IETF|SATransform.CommonNameCIM_SATransform
RequiredbooleantrueCIM_SATransform
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_SATransform

Property MaxLifetimeSeconds Qualifiers
NameTypeValueFrom Class
DescriptionstringMaxLifetimeSeconds specifies the maximum time that the Security Association should be considered valid after it has been created. A value of 0, the default, indicates that 8 hours should be used. A non-zero value indicates the maximum lifetime in seconds.CIM_SATransform
UnitsstringSecondsCIM_SATransform
MappingStringsstringIPSP Model.IETF|SATransform.MaxLifetimeSecondsCIM_SATransform
PUnitstringsecondCIM_SATransform

Property MaxLifetimeKilobytes Qualifiers
NameTypeValueFrom Class
DescriptionstringMaxLifetimeKilobytes specifies the maximum kilobyte lifetime for a Security Association. Different lifetimes are used, depending on the strength of the encryption algorithm. A value of 0, the default, indicates that no maximum should be defined. A non-zero value specifies the desired kilobyte lifetime.CIM_SATransform
UnitsstringKiloBytesCIM_SATransform
MappingStringsstringIPSP Model.IETF|SATransform.MaxLifetimeKilobytesCIM_SATransform
PUnitstringbyte * 10^3CIM_SATransform

Property VendorID Qualifiers
NameTypeValueFrom Class
DescriptionstringVendorID identifies vendor-defined transforms. If this field is empty (the default), then this is a standard transform.CIM_SATransform
MappingStringsstringIPSP Model.IETF|SATransform.VendorIDCIM_SATransform

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_ContainedTransformCIM_SATransformPartComponent
CIM_TransformOfPreconfiguredActionCIM_SATransformAntecedent
CIM_TransformOfSecurityAssociationCIM_SATransformSettingData
CIM_ScopedSettingCIM_ScopedSettingDataDependent
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