CIM_SARule, ROOT\StandardCimv2\MS_409

Class | Childs (1) | Methods | Properties (20) | Qualifiers (4) | Instances | Namespaces (2)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

SARule is a base class for defining IKE and IPsec Rules. Although concrete (because it subclasses from a concrete class), it is not intended to be instantiated. It defines a common connection point for associating conditions and actions for both types of rules. Note that each valid PolicyGroup containing SARules MUST use a unique priority number for the Rule in the aggregation, PolicySetComponent.Priority.

CIM_SARule - child subclasses in ROOT\StandardCimv2\MS_409

Number of classes:1
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
MSFT_NetSARule2350----

CIM_SARule properties

CIM_SARule has 20 properties (1 Local, 19 Derived)

NameOriginCIMType
CaptionCIM_ManagedElement8 [string]
CommonNameCIM_Policy8 [string]
ConditionListTypeCIM_PolicyRule18 [uint16]
key
CreationClassName
CIM_PolicyRule8 [string]
DescriptionCIM_ManagedElement8 [string]
ElementNameCIM_ManagedElement8 [string]
EnabledCIM_PolicySet18 [uint16]
ExecutionStrategyCIM_PolicyRule18 [uint16]
InstanceIDCIM_ManagedElement8 [string]
LimitNegotiationCIM_SARule18 [uint16]
MandatoryCIM_PolicyRule11 [boolean]
PolicyDecisionStrategyCIM_PolicySet18 [uint16]
PolicyKeywordsCIM_Policy8 [string]
PolicyRolesCIM_PolicySet8 [string]
key
PolicyRuleName
CIM_PolicyRule8 [string]
PriorityCIM_PolicyRule18 [uint16]
RuleUsageCIM_PolicyRule8 [string]
SequencedActionsCIM_PolicyRule18 [uint16]
key
SystemCreationClassName
CIM_PolicyRule8 [string]
key
SystemName
CIM_PolicyRule8 [string]

Detailed description of CIM_SARule properties

Local properties (1) of CIM_SARule class

LimitNegotiation property
CIMTYPE'uint16'
Description'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.'
Values['Initiator-Only', 'Responder-Only', 'Either']
LimitNegotiation property is in 4 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces

Derived properties (19) of CIM_SARule class

Caption property
CIMTYPE'string'
Description'The Caption property is a short textual description (one- line string) of the object.'
Caption property is in 153 classes of ROOT\StandardCimv2\MS_409 and in 37 namespaces
CommonName property
CIMTYPE'string'
Description'A user-friendly name of this policy-related object.'
CommonName property is in 20 classes of ROOT\StandardCimv2\MS_409 and in 5 namespaces
ConditionListType property
CIMTYPE'uint16'
Description'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").'
Values['Unconditional Rule', 'DNF', 'CNF']
ConditionListType property is in 6 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
CreationClassName property
CIMTYPE'string'
Description'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.'
keyTrue
CreationClassName property is in 47 classes of ROOT\StandardCimv2\MS_409 and in 20 namespaces
Description property
CIMTYPE'string'
Description'The Description property provides a textual description of the object.'
Description property is in 154 classes of ROOT\StandardCimv2\MS_409 and in 142 namespaces
ElementName property
CIMTYPE'string'
Description'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. Note that if there is an associated instance of CIM_EnabledLogicalElementCapabilities, restrictions on this properties may exist as defined in ElementNameMask and MaxElementNameLen properties defined in that class.'
ElementName property is in 153 classes of ROOT\StandardCimv2\MS_409 and in 21 namespaces
Enabled property
CIMTYPE'uint16'
Description'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").'
Values['Enabled', 'Disabled', 'Enabled For Debug']
Enabled property is in 15 classes of ROOT\StandardCimv2\MS_409 and in 142 namespaces
ExecutionStrategy property
CIMTYPE'uint16'
Description'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.'
Values['Do Until Success', 'Do All', 'Do Until Failure']
ExecutionStrategy property is in 6 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
InstanceID property
CIMTYPE'string'
Description'InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below.
To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm:
:
Where and are separated by a colon (:), and where 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 _ structure of Schema class names.) In addition, to ensure uniqueness, must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between and .
is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If not null and 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.
If not set to null for DMTF-defined instances, the "preferred" algorithm must be used with the set to CIM.'
InstanceID property is in 153 classes of ROOT\StandardCimv2\MS_409 and in 21 namespaces
Mandatory property
CIMTYPE'boolean'
Description'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.'
Mandatory property is in 6 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
PolicyDecisionStrategy property
CIMTYPE'uint16'
Description'PolicyDecisionStrategy defines the evaluation method used for policies contained in the PolicySet. There are two values currently defined:
- \'First Matching\' (1) executes the actions of the first rule whose conditions evaluate to TRUE. The concept of \'first\' is determined by examining the priority of the rule within the policy set (i.e., by examining the property, PolicySetComponent.Priority). Note that this ordering property MUST be maintained when processing the PolicyDecisionStrategy.
- \'All\' (2) executes the actions of ALL rules whose conditions evaluate to TRUE, in the set. As noted above, the order of processing of the rules is defined by the property, PolicySetComponent.Priority (and within a rule, the ordering of the actions is defined by the property, PolicyActionStructure.ActionOrder). Note that when this strategy is defined, processing MUST be completed of ALL rules whose conditions evaluate to TRUE, regardless of errors in the execution of the rule actions.'
Values['First Matching', 'All']
PolicyDecisionStrategy property is in 7 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
PolicyKeywords property
CIMTYPE'string'
Description'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.'
PolicyKeywords property is in 20 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
PolicyRoles property
CIMTYPE'string'
Description'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:
[&&]*
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.'
PolicyRoles property is in 7 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
PolicyRuleName property
CIMTYPE'string'
Description'A user-friendly name of this PolicyRule.'
keyTrue
PolicyRuleName property is in 18 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
Priority property
CIMTYPE'uint16'
Description'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.'
Priority property is in 28 classes of ROOT\StandardCimv2\MS_409 and in 31 namespaces
RuleUsage property
CIMTYPE'string'
Description'A free-form string that can be used to provide guidelines on how this PolicyRule should be used.'
RuleUsage property is in 6 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
SequencedActions property
CIMTYPE'uint16'
Description'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").'
Values['Mandatory', 'Recommended', 'Dont Care']
SequencedActions property is in 6 classes of ROOT\StandardCimv2\MS_409 and in 2 namespaces
SystemCreationClassName property
CIMTYPE'string'
Description'The scoping System\'s CreationClassName.'
keyTrue
SystemCreationClassName property is in 47 classes of ROOT\StandardCimv2\MS_409 and in 20 namespaces
SystemName property
CIMTYPE'string'
Description'The scoping System\'s Name.'
keyTrue
SystemName property is in 66 classes of ROOT\StandardCimv2\MS_409 and in 22 namespaces

CIM_SARule Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AMENDMENTTrue
Description'SARule is a base class for defining IKE and IPsec Rules. Although concrete (because it subclasses from a concrete class), it is not intended to be instantiated. It defines a common connection point for associating conditions and actions for both types of rules. Note that each valid PolicyGroup containing SARules MUST use a unique priority number for the Rule in the aggregation, PolicySetComponent.Priority.'
LOCALE'MS_409'
Version'2.8.0'

CIM_SARule System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\StandardCimv2\MS_409:CIM_SARule'___SYSTEM8
__NAMESPACE'ROOT\StandardCimv2\MS_409'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_PolicyRule', 'CIM_PolicySet', 'CIM_Policy', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT20___SYSTEM3
__RELPATH'CIM_SARule'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_PolicyRule'___SYSTEM8
__CLASS'CIM_SARule'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to CIM_SARule

Number of classes:6
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
MSFT_NetSAActionInSARule430----
MSFT_NetSARule2350----
MSFT_NetSARuleEMAuth130----
MSFT_NetSARuleMMAuth230----
MSFT_NetSARuleMMCrypto130----
MSFT_NetSARuleQMCrypto130----
comments powered by Disqus
WUtils.com