IPsecPolicy\CIM_IPsecRule.mof.mof (HTML version)

Return to index
CIM_IPsecRule Superclass: CIM_SARule
IPsecRule contains the Conditions and Actions for phase 2 negotiations or to specify static actions such as Discard.
Qualifiers:Version ( "2.8.0" ) MappingStrings { "IPSP Policy Model.IETF|IPsecRule" }
Parameters (local in grey)
ValueMap { "1" , "2" , "3" }
Values { "Initiator-Only" , "Responder-Only" , "Either" }
MappingStrings { "IPSP Policy " "Model.IETF|SARule.LimitNegotiation" }
uint16 LimitNegotiation ;
LimitNegotiation is used as part of processing either a key exchange or IPsec Rule. Before proceeding with either a phase 1 or a phase 2 negotiation, this property is checked to determine if the negotiation role of the Rule matches that defined for the negotiation being undertaken (e.g., Initiator, Responder, or Both). If this check fails, then the negotiation is stopped. Note that this only applies to new negotiations and has no effect on either renegotiation or refresh operations with peers for which an established Security Association already exists.
ValueMap { "1" , "2" , "3" }
Values { "Do Until Success" , "Do All" , "Do Until Failure" }
uint16 ExecutionStrategy ;
ExecutionStrategy defines the strategy to be used in executing the sequenced actions aggregated by this PolicyRule. There are three execution strategies:

Do Until Success - execute actions according to predefined order, until successful execution of a single action.
Do All - execute ALL actions which are part of the modeled set, according to their predefined order. Continue doing this, even if one or more of the actions fails.
Do Until Failure - execute actions according to predefined order, until the first failure in execution of an action instance.
MaxLen ( 256 )
Propagated ( "CIM_System.Name" )
Key
string SystemName ;
The scoping System's Name.
MaxLen ( 256 )
Key
string PolicyRuleName ;
A user-friendly name of this PolicyRule.
ValueMap { "1" , "2" , "3" }
Values { "Mandatory" , "Recommended" , "Dont Care" }
uint16 SequencedActions = 3 ;
This property gives a policy administrator a way of specifying how the ordering of the PolicyActions associated with this PolicyRule is to be interpreted. Three values are supported:
o mandatory(1): Do the actions in the indicated order, or don't do them at all.
o recommended(2): Do the actions in the indicated order if you can, but if you can't do them in this order, do them in another order if you can.
o dontCare(3): Do them -- I don't care about the order.
The default value is 3 ('DontCare').
ValueMap { "0" , "1" , "2" }
Values { "Unconditional Rule" , "DNF" , "CNF" }
uint16 ConditionListType = 1 ;
Indicates whether the list of PolicyConditions associated with this PolicyRule is in disjunctive normal form (DNF), conjunctive normal form (CNF), or has no conditions (i.e., is an UnconditionalRule) and is automatically evaluated to 'True.' The default value is 1 ('DNF').
string RuleUsage ;
A free-form string that can be used to provide guidelines on how this PolicyRule should be used.
MaxLen ( 256 )
Propagated ( "CIM_System.CreationClassName" )
Key
string SystemCreationClassName ;
The scoping System's CreationClassName.
Deprecated { "No Value" }
boolean Mandatory ;
A flag indicating that the evaluation of the Policy Conditions and execution of PolicyActions (if the Conditions evaluate to TRUE) is required. The evaluation of a PolicyRule MUST be attempted if the Mandatory property value is TRUE. If the Mandatory property is FALSE, then the evaluation of the Rule is 'best effort' and MAY be ignored.
Deprecated { "CIM_PolicySetComponent.Priority" }
uint16 Priority = 0 ;
PolicyRule.Priority is deprecated and replaced by providing the priority for a rule (and a group) in the context of the aggregating PolicySet instead of the priority being used for all aggregating PolicySet instances. Thus, the assignment of priority values is much simpler.

A non-negative integer for prioritizing this Policy Rule relative to other Rules. A larger value indicates a higher priority. The default value is 0.
MaxLen ( 256 )
Key
string CreationClassName ;
CreationClassName 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.
ValueMap { "1" }
Values { "First Matching" }
uint16 PolicyDecisionStrategy ;
PolicyDecisionStrategy defines the evaluation method used for policies contained in the PolicySet. FirstMatching enforces the actions of the first rule that evaluates to TRUE. It is the only value currently defined.
ValueMap { "1" , "2" , "3" }
Values { "Enabled" , "Disabled" , "Enabled For Debug" }
uint16 Enabled = 1 ;
Indicates whether this PolicySet is administratively enabled, administratively disabled, or enabled for debug. The 'EnabledForDebug' property value is deprecated and, when it or any value not understood by the receiver is specified, the receiving enforcement point treats the PolicySet as 'Disabled'. To determine if a PolicySet is 'Enabled', the containment hierarchy specified by the PolicySetComponent aggregation is examined and the Enabled property values of the hierarchy are ANDed together. Thus, for example, everything aggregated by a PolicyGroup may be disabled by setting the Enabled property in the PolicyGroup instance to 'Disabled' without changing the Enabled property values of any of the aggregated instances. The default value is 1 ('Enabled').
Deprecated { "CIM_PolicySetInRoleCollection" }
string PolicyRoles [ ] ;
The PolicyRoles property represents the roles associated with a PolicySet. All contained PolicySet instances inherit the values of the PolicyRoles of the aggregating PolicySet but the values are not copied. A contained PolicySet instance may, however, add additional PolicyRoles to those it inherits from its aggregating PolicySet(s). Each value in PolicyRoles multi-valued property represents a role for which the PolicySet applies, i.e., the PolicySet should be used by any enforcement point that assumes any of the listed PolicyRoles values.

Although not officially designated as 'role combinations', multiple roles may be specified using the form:
<RoleName>[&&<RoleName>]*
where the individual role names appear in alphabetical order (according to the collating sequence for UCS-2). Implementations may treat PolicyRoles values that are specified as 'role combinations' as simple strings.

This property is deprecated in lieu of the use of an association, CIM_PolicySetInRoleCollection. The latter is a more explicit and less error-prone approach to modeling that a PolicySet has one or more PolicyRoles.
string PolicyKeywords [ ] ;
An 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.
string CommonName ;
A user-friendly name of this policy-related object.
string ElementName ;
A 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.
MaxLen ( 64 )
string Caption ;
The Caption property is a short textual description (one- line string) of the object.
string Description ;
The Description property provides a textual description of the object.