CIM_PolicyAction class
A class representing a rule-specific or reusable policy action to be performed if the policy conditions for a policy rule evaluate to TRUE. Since all operational details of a policy action are provided in subclasses of this object, this class is abstract.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[UMLPackagePath("CIM::Policy"), Abstract, Version("2.8.0"), AMENDMENT]
class CIM_PolicyAction : CIM_Policy
{
string InstanceID;
string Caption;
string Description;
string ElementName;
string CommonName;
string PolicyKeywords[];
string SystemCreationClassName;
string SystemName;
string PolicyRuleCreationClassName;
string PolicyRuleName;
string CreationClassName;
string PolicyActionName;
boolean DoActionLogging;
};
Members
The CIM_PolicyAction class has these types of members:
Properties
The CIM_PolicyAction class has these properties.
-
Caption
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
Contains a short textual description of the object.
This property is inherited from CIM_ManagedElement.
-
-
CommonName
-
-
Data type: string
-
Access type: Read-only
A user-friendly name of this policy-related object.
This property is inherited from CIM_Policy.
-
-
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.
-
Description
-
-
Data type: string
-
Access type: Read-only
Provides a textual description of the object.
This property is inherited from CIM_ManagedElement.
-
-
DoActionLogging
-
-
Data type: boolean
-
Access type: Read-only
Causes a log message to be generated when the action is performed.
-
-
ElementName
-
-
Data type: string
-
Access type: Read-only
Contains 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.
This property is inherited from CIM_ManagedElement.
-
-
InstanceID
-
-
Data type: string
-
Access type: Read-only
Uniquely and opaquely identifies an instance of this class within the scope of the containing Namespace.
[!Important]In order to ensure uniqueness within the Namespace, the value of InstanceID should be constructed in the following pattern:
OrgID:LocalID
OrgID must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity defining the InstanceID, or be a registered ID that is assigned by a recognized global authority. This is similar to the structure of Schema class names. In addition, to ensure uniqueness the first colon in InstanceID must be between the OrgID andLocalID. Therefor the OrgID must not contain a colon (':').
LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.
If the preceding pattern is not used, the defining entity must assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this Namespace.
For Distributed Management Task Force (DMTF) defined instances, the pattern must be used with the OrgID set to CIM.
This property is inherited from CIM_ManagedElement.
-
-
PolicyActionName
-
A user-friendly name of this policy action.
-
PolicyKeywords
-
-
Data type: string array
-
Access type: Read-only
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.
This property is inherited from CIM_Policy.
-
-
PolicyRuleCreationClassName
-
For a rule-specific policy action, the CreationClassName of the policy rule object with which this Action is associated. For a reusable policy action, a special value, 'NO RULE', should be used to indicate that this Action is reusable and not associated with a single policy rule.
-
PolicyRuleName
-
For a rule-specific policy action, the name of the policy rule object with which this Action is associated. For a reusable policy action, a special value, 'NO RULE', should be used to indicate that this Action is reusable and not associated with a single policy rule.
-
SystemCreationClassName
-
The name of the class or the subclass used in the creation of the System object in whose scope this policy action is defined.
This property helps to identify the System object in whose scope this instance of policy action exists. For a rule-specific policy action, this is the System in whose context the policy rule is defined. For a reusable policy action, 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 policy action is related, either directly via the policy action InPolicyRepository association or indirectly via the PolicyActionInPolicyRule aggregation.
-
SystemName
-
The name of the System object in whose scope this policy action is defined.
This property completes the identification of the System object in whose scope this instance of policy action exists. For a rule-specific policy action, this is the System in whose context the policy rule is defined. For a reusable policy action, this is the instance of PolicyRepository (which is a subclass of System) that holds the Action.
Requirements
| Minimum supported client |
Windows 8 |
| Minimum supported server |
Windows Server 2012 |
| Namespace |
Root\standardcimv2 |
| MOF |
|
| DLL |
|