CIM_PolicySet

WS-Management > WS-Management Class Reference > CIM Classes > CIM_PolicySet

SUMMARY: NESTED | FIELD | | METHOD

Class CIM_PolicySet

CIM_ManagedElement
   CIM_Policy
      CIM_PolicySet

Known Subclasses:: CIM_PolicyRule AMT_RemoteAccessPolicyRule AMT_AuditPolicyRule


extends CIM_Policy

General Information:
PolicySet is an abstract class that represents a set of policies that form a coherent set. The set of contained policies has a common decision strategy and a common set of policy roles (defined via the PolicySetInRole Collection association). Subclasses include PolicyGroup and PolicyRule.

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 . . .
`uint16`	`PolicyDecisionStrategy` PolicyDecisionStrategy defines the evaluation method used for policies contained in the PolicySet . . .
`string[]`	`PolicyRoles` The PolicyRoles property represents the roles associated with a PolicySet . . .
`uint16`	`Enabled` Indicates whether this PolicySet is administratively enabled, administratively disabled, or enabled for debug . . .

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

PolicyDecisionStrategy

public uint16 PolicyDecisionStrategy

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

Qualifiers:
-------------
ValueMap={1, 2}
Values={First Matching, All}

PolicyRoles

public string[] PolicyRoles

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

Qualifiers:
-------------
Deprecated={CIM_PolicySetInRoleCollection}
MaxLen=256

Enabled

public uint16 Enabled

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

Qualifiers:
-------------
ValueMap={1, 2, 3}
Values={Enabled, Disabled, Enabled For Debug}

Method Detail

Create

public  Create([IN]CIM_PolicySet Instance, [OUT] REF CIM_PolicySet 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_PolicySet:

Put

public  Put([IN]CIM_PolicySet 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_PolicySet:

Get

public  Get([OUT]CIM_PolicySet 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

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