CIM211 Class Declaration
CIM_PreconfiguredTransportAction

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

Class Hierarchy

CIM_PreconfiguredTransportAction --> CIM_PreconfiguredSAAction --> CIM_SAStaticAction --> CIM_SAAction --> CIM_PolicyAction --> CIM_Policy --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_PreconfiguredSAAction
NAMECIM_PreconfiguredTransportAction

Class Qualifiers

Class CIM_PreconfiguredTransportAction Qualifiers
NameTypeValueFrom Class
Versionstring2.8.0 CIM_PreconfiguredTransportAction
DescriptionstringPreconfiguredTransportAction is used to create transport-mode SAs using preconfigured, hard-wired algorithms and keys. Note that the SPI for a preconfigured SA action is contained in the association, TransformOfPreconfiguredAction. CIM_PreconfiguredTransportAction
MappingStringsstringIPSP Policy Model.IETF|PreconfiguredTransportAction CIM_PreconfiguredTransportAction
DescriptionstringSubclasses of PreconfiguredSAAction are used to create SAs using preconfigured, hard-wired algorithms and keys. No negotiation is necessary. Note that this class is defined as concrete, since its superclass is also concrete. However, it should not be directly instantiated, but one of its subclasses used instead. Also note that: - The SPI for a preconfigured SA action is contained in the association, TransformOfPreconfiguredAction. - The session key (if applicable) is contained in an instance of SharedSecret. For an instance of the SharedSecret class: The session key is stored in the Secret property; the property protocol contains one of the values, " ESP-encrypt " , " ESP-auth " or " AH " ; and, the class ’ property algorithm contains the algorithm used to protect the secret. (The latter can be " PLAINTEXT " if the IPsec entity has no secret storage.) The value of the class ’ RemoteID property is the concatenation of the remote IPsec peer IP address in dotted decimal, of the character " / " , of " IN " (or respectively " OUT " ) for inbound/outbound SAs, of the character " / " and of the hexadecimal representation of the SPI. CIM_PreconfiguredSAAction
MappingStringsstringIPSP Policy Model.IETF|PreconfiguredSAAction CIM_PreconfiguredSAAction
DescriptionstringSAStaticAction is the base class for both key exchange as well as IPsec actions that require no negotiation. It is a concrete class that can be aggregated with other subclasses of PolicyAction (such as NetworkPacketAction) into a PolicyRule, to describe how packets are handled throughout the lifetime of the Security Association. CIM_SAStaticAction
MappingStringsstringIPSP Policy Model.IETF|SAStaticAction CIM_SAStaticAction
DescriptionstringSAAction is the base class for the various types of key exchange or IPsec actions. It is abstract and used to categorize the different types of actions of SARules. CIM_SAAction
MappingStringsstringIPSP Policy Model.IETF|SAAction CIM_SAAction
DescriptionstringA class representing a rule-specific or reusable policy action to be performed if the PolicyConditions for a Policy Rule evaluate to TRUE. Since all operational details of a PolicyAction are provided in subclasses of this object, this class is abstract. CIM_PolicyAction
DescriptionstringAn abstract class defining the common properties of the policy managed elements derived from CIM_Policy. The subclasses are used to create rules and groups of rules that work together to form a coherent set of policies within an administrative domain or set of domains. CIM_Policy
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
LifetimeKilobytesuint64 Description
Units
MappingStrings
ModelCorrespondence
CIM_PreconfiguredSAAction
LifetimeSecondsuint64 Description
Units
MappingStrings
ModelCorrespondence
CIM_SAStaticAction
DoPacketLoggingboolean Description
MappingStrings
ModelCorrespondence
CIM_SAAction
SystemCreationClassNamestring Key
Description
MaxLen
CIM_PolicyAction
SystemNamestring Key
Description
MaxLen
CIM_PolicyAction
PolicyRuleCreationClassNamestring Key
Description
MaxLen
CIM_PolicyAction
PolicyRuleNamestring Key
Description
MaxLen
CIM_PolicyAction
CreationClassNamestring Key
Description
MaxLen
CIM_PolicyAction
PolicyActionNamestring Key
Description
MaxLen
CIM_PolicyAction
DoActionLoggingboolean Description CIM_PolicyAction
CommonNamestring Description CIM_Policy
PolicyKeywordsstring[] Description CIM_Policy
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement
ElementNamestring Description CIM_ManagedElement

Property Qualifiers

Property LifetimeKilobytes Qualifiers
NameTypeValueFrom Class
DescriptionstringLifetimeKilobytes defines a traffic limit in kilobytes that can be consumed before the SA is deleted. A value of zero (the default) indicates that there is no lifetime associated with this action (i.e., infinite lifetime). A non-zero value is used to indicate that after this number of kilobytes has been consumed the SA must be deleted. Note that the actual lifetime of the preconfigured SA will be the lesser of the value of this LifetimeKilobytes property and the value of the MaxLifetimeKilobytes property of the associated SATransform. Also note that some SA negotiation protocols (such as IKE) can negotiate the lifetime as an arbitrary length field, it is assumed that a 64-bit integer will be sufficient. CIM_PreconfiguredSAAction
UnitsstringKiloBytes CIM_PreconfiguredSAAction
MappingStringsstringIPSP Policy Model.IETF|PreconfiguredSAAction.LifetimeKilobytes CIM_PreconfiguredSAAction
ModelCorrespondencestringCIM_SecurityAssociationEndpoint.LifetimeKilobytes CIM_PreconfiguredSAAction

Property LifetimeSeconds Qualifiers
NameTypeValueFrom Class
DescriptionstringLifetimeSeconds specifies how long the SA created from this action should be used/exist. A value of 0 means an infinite lifetime. A non-zero value is typically used in conjunction with alternate SAActions performed when there is a negotiation failure of some sort. Note: If the referenced SAStaticAction object IS-A PreconfiguredSAAction (that is associated to several SATransforms), then the actual lifetime of the Security Association will be the lesser of the value of this LifetimeSeconds property and of the value of the MaxLifetimeSeconds property of the associated SATransform. CIM_SAStaticAction
UnitsstringSeconds CIM_SAStaticAction
MappingStringsstringIPSP Policy Model.IETF|SAStaticAction.LifetimeSeconds CIM_SAStaticAction
ModelCorrespondencestringCIM_SecurityAssociationEndpoint.LifetimeSeconds CIM_SAStaticAction

Property DoPacketLogging Qualifiers
NameTypeValueFrom Class
DescriptionstringDoPacketLogging causes a log message to be generated when the action is applied to a packet. CIM_SAAction
MappingStringsstringIPSP Policy Model.IETF|SAAction.DoPacketLogging CIM_SAAction
ModelCorrespondencestringCIM_SecurityAssociationEndpoint.PacketLoggingActive CIM_SAAction

Property SystemCreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_PolicyAction
DescriptionstringThe name of the class or the subclass used in the creation of the System object in whose scope this PolicyAction is defined. This property helps to identify the System object in whose scope this instance of PolicyAction exists. For a rule-specific PolicyAction, this is the System in whose context the PolicyRule is defined. For a reusable PolicyAction, this is the instance of PolicyRepository (which is a subclass of System) that holds the Action. Note that this property, and the analogous property SystemName, do not represent propagated keys from an instance of the class System. Instead, they are properties defined in the context of this class, which repeat the values from the instance of System to which this PolicyAction is related, either directly via the PolicyActionInPolicyRepository association or indirectly via the PolicyActionInPolicyRule aggregation. CIM_PolicyAction
MaxLenuint32256 CIM_PolicyAction

Property SystemName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_PolicyAction
DescriptionstringThe name of the System object in whose scope this PolicyAction is defined. This property completes the identification of the System object in whose scope this instance of PolicyAction exists. For a rule-specific PolicyAction, this is the System in whose context the PolicyRule is defined. For a reusable PolicyAction, this is the instance of PolicyRepository (which is a subclass of System) that holds the Action. CIM_PolicyAction
MaxLenuint32256 CIM_PolicyAction

Property PolicyRuleCreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_PolicyAction
DescriptionstringFor a rule-specific PolicyAction, the CreationClassName of the PolicyRule object with which this Action is associated. For a reusable PolicyAction, a special value, ’ NO RULE ’ , should be used to indicate that this Action is reusable and not associated with a single PolicyRule. CIM_PolicyAction
MaxLenuint32256 CIM_PolicyAction

Property PolicyRuleName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_PolicyAction
DescriptionstringFor a rule-specific PolicyAction, the name of the PolicyRule object with which this Action is associated. For a reusable PolicyAction, a special value, ’ NO RULE ’ , should be used to indicate that this Action is reusable and not associated with a single PolicyRule. CIM_PolicyAction
MaxLenuint32256 CIM_PolicyAction

Property CreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_PolicyAction
DescriptionstringCreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified. CIM_PolicyAction
MaxLenuint32256 CIM_PolicyAction

Property PolicyActionName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_PolicyAction
DescriptionstringA user-friendly name of this PolicyAction. CIM_PolicyAction
MaxLenuint32256 CIM_PolicyAction

Property DoActionLogging Qualifiers
NameTypeValueFrom Class
DescriptionstringDoActionLogging causes a log message to be generated when the action is performed. CIM_PolicyAction

Property CommonName Qualifiers
NameTypeValueFrom Class
DescriptionstringA user-friendly name of this policy-related object. CIM_Policy

Property PolicyKeywords Qualifiers
NameTypeValueFrom Class
DescriptionstringAn array of keywords for characterizing / categorizing policy objects. Keywords are of one of two types: - Keywords defined in this and other MOFs, or in DMTF white papers. These keywords provide a vendor- independent, installation-independent way of characterizing policy objects. - Installation-dependent keywords for characterizing policy objects. Examples include ’ Engineering ’ , ’ Billing ’ , and ’ Review in December 2000 ’ . This MOF defines the following keywords: ’ UNKNOWN ’ , ’ CONFIGURATION ’ , ’ USAGE ’ , ’ SECURITY ’ , ’ SERVICE ’ , ’ MOTIVATIONAL ’ , ’ INSTALLATION ’ , and ’ EVENT ’ . These concepts are self-explanatory and are further discussed in the SLA/Policy White Paper. One additional keyword is defined: ’ POLICY ’ . The role of this keyword is to identify policy-related instances that may not be otherwise identifiable, in some implementations. The keyword ’ POLICY ’ is NOT mutually exclusive of the other keywords specified above. CIM_Policy

Property Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement
MaxLenuint3264 CIM_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_TransformOfPreconfiguredActionCIM_PreconfiguredSAActionDependent
CIM_PolicyActionStructureCIM_PolicyActionPartComponent
CIM_PolicyActionInPolicyActionCIM_PolicyActionPartComponent
CIM_PolicyActionInPolicyRuleCIM_PolicyActionPartComponent
CIM_PolicyActionInPolicyRepositoryCIM_PolicyActionDependent
CIM_PolicyComponentCIM_PolicyGroupComponent
CIM_PolicyComponentCIM_PolicyPartComponent
CIM_PolicyConditionStructureCIM_PolicyGroupComponent
CIM_PolicyActionStructureCIM_PolicyGroupComponent
CIM_PolicyInSystemCIM_PolicyDependent
CIM_ReusablePolicyCIM_PolicyDependent
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_CredentialContextCIM_ManagedElementElementProvidingContext
CIM_DefaultElementCapabilitiesCIM_ManagedElementManagedElement
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_RelatedElementCausingErrorCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementDependent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_IsSpareCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SWRManageableAspectCIM_ManagedElementSystemElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_OwningCollectionElementCIM_ManagedElementOwningElement
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement
CIM_AuthorizationRuleAppliesToTargetCIM_ManagedElementManagedElement
CIM_RoleLimitedToTargetCIM_ManagedElementTargetElement
CIM_StatisticsCIM_ManagedElementElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ManagementSAPCIM_ManagedElementManagedElement