Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_PolicyRoleCollection --> CIM_SystemSpecificCollection --> CIM_Collection --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_SystemSpecificCollection NAME CIM_PolicyRoleCollection
Class CIM_PolicyRoleCollection Qualifiers Name Type Value From Class Version string 2.8.0 CIM_PolicyRoleCollection Description string PolicyRoleCollection is used to represent a collection of ManagedElements that share a common policy role, and the PolicySets that CAN BE applied to those elements. (Note that the PolicySets that are CURRENTLY applied are indicated via instances of the association, PolicySetAppliesToElement.) The PolicyRoleCollection always exists in the context of a System, specified using the PolicyRoleCollectionInSystem aggregation. The value of the PolicyRole property in this class specifies the role. It is defined as a free-form string. ManagedElements that share the role defined in this collection are aggregated into the Collection via the ElementInPolicyRoleCollection association. CIM_PolicyRoleCollection Description string SystemSpecificCollection represents the general concept of a collection that is scoped (or contained) by a System. It represents a Collection that has meaning only in the context of a System, a Collection whose elements are restricted by the definition of the System, or both of these types of Collections. This meaning is explicitly described by the (required) association, HostedCollection. An example of a SystemSpecificCollection is a Fibre Channel zone that collects network ports, port groupings, and aliases (as required by a customer) in the context of an AdminDomain. The Collection is not a part of the domain, but merely an arbitrary grouping of the devices and other Collections in the domain. In other words, the context of the Collection is restricted to the domain, and its members are also limited by the domain. CIM_SystemSpecificCollection Description string Collection is an abstract class that provides a common superclass for data elements that represent collections of ManagedElements and its subclasses. CIM_Collection Description string ManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema. CIM_ManagedElement
Properties Name Type Value Qualifiers ClassOrigin PolicyRole string Required
DescriptionCIM_PolicyRoleCollection InstanceID string Key
DescriptionCIM_SystemSpecificCollection Caption string Description
MaxLenCIM_ManagedElement Description string Description CIM_ManagedElement ElementName string Description CIM_ManagedElement Property Qualifiers
Property PolicyRole Qualifiers Name Type Value From Class Required boolean true CIM_PolicyRoleCollection Description string The PolicyRole name for the PolicySets and other ManagedElements that are identified and aggregated by the Collection. Note that the aggregated PolicySets define the rules and groups of rules that may be applied to the associated ManagedElements. 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 PolicyRole values that are specified as ’ role combinations ’ as simple strings. CIM_PolicyRoleCollection
Property InstanceID Qualifiers Name Type Value From Class Key boolean true CIM_SystemSpecificCollection Description string Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following ’ preferred ’ algorithm: < OrgID > : < LocalID > Where < OrgID > and < LocalID > are separated by a colon ’ : ’ , and where < OrgID > must include a unique name. It can be a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID. Or, it could be a registered ID that is assigned to the business entity by a recognized global authority. (This requirement is similar to the < Schema Name > _ < Class Name > structure of Schema class names.) In addition, to ensure uniqueness < OrgID > must not contain a colon ( ’ : ’ ). When using this algorithm, the first colon to appear in InstanceID must appear between < OrgID > and < LocalID > . < LocalID > is chosen by the business entity and should not be re-used to identify different underlying (real-world) elements. If the above ’ preferred ’ algorithm is not used, the defining entity must ensure that the resulting InstanceID is not re-used as any of InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF-defined instances, the ’ preferred ’ algorithm must be used with the < OrgID > set to ’ CIM ’ . CIM_SystemSpecificCollection
Property Caption Qualifiers Name Type Value From Class Description string The Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement MaxLen uint32 64 CIM_ManagedElement
Property Description Qualifiers Name Type Value From Class Description string The Description property provides a textual description of the object. CIM_ManagedElement
Property ElementName Qualifiers Name Type Value From Class Description string 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. CIM_ManagedElement
Name Type Value Qualifiers Parameters ClassOrigin ActivatePolicySet uint32 Description
ValueMap
ValuesCIM_PolicyRoleCollection DeactivatePolicySet uint32 Description
ValueMap
ValuesCIM_PolicyRoleCollection Method Qualifiers
Method ActivatePolicySet Qualifiers Name Type Value From Class Description string Activates/applies the PolicySets aggregated into this Collection to the specified ManagedElement. The ManagedElement MUST be a member of the Collection, associated via ElementInPolicyRoleCollection. The result of this method, if it is successfully executed, is that the aggregated PolicySets are deployed and enforced for the Element. This is reflected by the instantiation of the PolicySetAppliesToElement association between the named Element and each PolicySet. CIM_PolicyRoleCollection ValueMap string [See below.] CIM_PolicyRoleCollection Values string Success
Not Supported
Unknown
Timeout
Failed
DMTF Reserved
Vendor SpecificCIM_PolicyRoleCollection
Method DeactivatePolicySet Qualifiers Name Type Value From Class Description string Deactivates the aggregated PolicySets for the specified ManagedElement. The result of this method, if it is successfully executed, is that the aggregated PolicySets are NOT enforced for the Element. This is reflected by the removal of the PolicySetAppliesToElement association between the named Element and each PolicySet. If a PolicySet is not currently enforced for the ManagedElement, then this method has no effect for that Set. CIM_PolicyRoleCollection ValueMap string [See below.] CIM_PolicyRoleCollection Values string Success
Not Supported
Unknown
Timeout
Failed
DMTF Reserved
Vendor SpecificCIM_PolicyRoleCollection Parameters
Parameter Qualifiers