SUMMARY: NESTED | FIELD | | METHOD
DETAIL: FIELD | METHOD

Class CIM_PolicyAction

CIM_ManagedElement
   extended by CIM_Policy
      extended by CIM_PolicyAction
Known Subclasses:
AMT_AgentPresenceWatchdogAction 
Abstract class CIM_PolicyAction
 extends CIM_Policy


General Information:
A 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.

Qualifiers:
-------------
Abstract
Version=2.8.0
UMLPackagePath=CIM::Policy









  
  

    Supported Fields 
      Summary

  

     string[] 
      
    PolicyKeywords 
      
An array of keywords for characterizing / categorizing policy 
      objects . . .

  

     string 
      
    CommonName 
A 
      user-friendly name of this policy-related object.

  

     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.

  

     string 
      
    ElementName 
A 
      user-friendly name for the object . . .

  

     string 
      
    SystemCreationClassName Key  
The name of the class or the subclass 
      used in the creation of the System object in whose scope this PolicyAction 
      is defined . . .

  

     string 
      
    SystemName Key  
The name of the System object in whose scope 
      this PolicyAction is defined . . .

  

     string 
      
    PolicyRuleCreationClassName 
      Key  
For a rule-specific 
      PolicyAction, the CreationClassName of the PolicyRule object with which 
      this Action is associated . . .

  

     string 
      
    PolicyRuleName Key  
For a rule-specific PolicyAction, the 
      name of the PolicyRule object with which this Action is associated . . 
      .

  

     string 
      
    CreationClassName Key  
CreationClassName indicates the name 
      of the class or the subclass used in the creation of an instance . . 
    .

  

     string 
      
    PolicyActionName Key  
A user-friendly name of this 
      PolicyAction.

  

     boolean 
      
    DoActionLogging 
      
DoActionLogging causes a log message to be generated when the 
      action is performed.




  
  

    Methods Summary

  

     
    Create(Instance, 
      ResourceCreated) 
Creates a new instance of this class

  

     
    Put(Instance) 
Changes 
      properties of the selected instance

  

     
    Get(Instance) 
Gets the 
      representation of the instance

  

     
    Delete() 
Deletes an 
      instance

  

     
    Pull(EnumerationContext, 
      MaxElements) 
Pulls instances of this class, following an 
      Enumerate operation

  

     
    Enumerate() 
      
Enumerates the instances of this class

  

     
    Release(EnumerationContext) 
      
Releases an enumeration context

  

     
    Subscribe() 
      
Subscribes to this resource (WS-Eventing)

  

     
    Unsubscribe() 
      
Remove subscription to this resource 
  (WS-Eventing)




  
  

    Field 
Detail


PolicyKeywords 
public string[] PolicyKeywords



  
General Information:
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.

Qualifiers:
-------------
MaxLen=256


  

  





CommonName 
public string CommonName



  
General Information:
A user-friendly name of this policy-related 
  object.

Qualifiers:
-------------
MaxLen=256


  

  





Caption 
public string Caption



  
General Information:
The Caption property is a short textual 
  description (one- line string) of the 
  object.

Qualifiers:
-------------
MaxLen=64


  

  





Description 
public string Description



  
General Information:
The Description property provides a textual 
  description of the 
  object.

Qualifiers:
-------------
MaxLen=256


  

  





ElementName 
public string ElementName



  
General Information:
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.

Qualifiers:
-------------
MaxLen=256


  

  





SystemCreationClassName Key 
public string SystemCreationClassName



  
General Information:
The 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.

Qualifiers:
-------------
Key
MaxLen=256


  

  





SystemName Key 
public string SystemName



  
General Information:
The 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.

Qualifiers:
-------------
Key
MaxLen=256


  

  





PolicyRuleCreationClassName Key 
public string PolicyRuleCreationClassName



  
General Information:
For 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.

Qualifiers:
-------------
Key
MaxLen=256


  

  





PolicyRuleName Key 
public string PolicyRuleName



  
General Information:
For 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.

Qualifiers:
-------------
Key
MaxLen=256


  

  





CreationClassName Key 
public string CreationClassName



  
General Information:
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.

Qualifiers:
-------------
Key
MaxLen=256


  

  





PolicyActionName Key 
public string PolicyActionName



  
General Information:
A user-friendly name of this 
  PolicyAction.

Qualifiers:
-------------
Key
MaxLen=256


  

  





DoActionLogging 
public boolean DoActionLogging



  
General Information:
DoActionLogging causes a log message to be 
  generated when the action is performed.

  

  






  
  

    Method 
Detail


Create
public  Create([IN]CIM_PolicyAction Instance, [OUT] REF CIM_PolicyAction ResourceCreated)



  
Permission Information:
No permissions defined

General 
  Information:
Creates a new instance of this class

Product 
  Specific Usage:
The following properties must be included in any 
  representation of CIM_PolicyAction: 

SystemCreationClassName 
  
SystemName 
PolicyRuleCreationClassName 
PolicyRuleName 
  
CreationClassName 
PolicyActionName 






Put
public  Put([IN]CIM_PolicyAction Instance)



  
Permission Information:
No permissions defined

General 
  Information:
Changes properties of the selected 
  instance

Product Specific Usage:
The following properties 
  must be included in any representation of CIM_PolicyAction: 
  

SystemCreationClassName 
SystemName 
PolicyRuleCreationClassName 
  
PolicyRuleName 
CreationClassName 
PolicyActionName 






Get
public  Get([OUT]CIM_PolicyAction Instance)



  
Permission Information:
No permissions defined

General 
  Information:
Gets the representation of the instance





Delete
public  Delete()



  
Permission Information:
No permissions defined

General 
  Information:
Deletes an instance





Pull
public  Pull([IN]String EnumerationContext, [IN]String MaxElements)



  
Permission Information:
All users permitted to use method, only 
  instances to whom the user has permissions will be returned

General 
  Information:
Pulls instances of this class, following an Enumerate 
  operation





Enumerate
public  Enumerate()



  
Permission Information:
All users permitted to use 
  method

General Information:
Enumerates the instances of this 
  class





Release
public  Release([IN]String EnumerationContext)



  
Permission Information:
All users permitted to use 
  method

General Information:
Releases an enumeration 
  context





Subscribe
public  Subscribe()



  
Permission Information:
No permissions defined

General 
  Information:
Subscribes to this resource (WS-Eventing)





Unsubscribe
public  Unsubscribe()



  
Permission Information:
No permissions defined

General 
  Information:
Remove subscription to this resource 
(WS-Eventing)






  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

    
      
Copyright © 2006-2022, Intel 
      Corporation. All rights 
reserved.