CIM29 Class Declaration
CIM_FilterList

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_FilterList --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_LogicalElement
NAMECIM_FilterList

Class Qualifiers

Class CIM_FilterList Qualifiers
NameTypeValueFrom Class
Versionstring2.7.0 CIM_FilterList
DescriptionstringA FilterList is used by network devices to identify routes by aggregating a set of FilterEntries into a unit, called a FilterList. FilterLists can also be used to accept or deny routing updates. A FilterList is weak to the network device (i.e., the ComputerSystem) that contains it. Hence, the ComputerSystem keys are propagated to this class. CIM_FilterList
DescriptionstringCIM_LogicalElement is a base class for all the components of a System that represent abstract system components, such as Files, Processes, or LogicalDevices. CIM_LogicalElement
DescriptionstringCIM_ManagedSystemElement is the base class for the System Element hierarchy. Any distinguishable component of a System is a candidate for inclusion in this class. Examples of system components include: - software components such as application servers, databases, and applications - operating system components such as files, processes, and threads - device components such as disk drives, controllers, processors, and printers - physical components such as chips and cards. CIM_ManagedSystemElement
DescriptionstringManagedElement 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

Properties
NameTypeValueQualifiersClassOrigin
SystemCreationClassNamestring Key
Propagated
Description
MaxLen
CIM_FilterList
SystemNamestring Key
Propagated
Description
MaxLen
CIM_FilterList
CreationClassNamestring Key
Description
CIM_FilterList
Namestring Key
Override
Description
MaxLen
CIM_FilterList
Directionuint16 Description
ValueMap
Values
CIM_FilterList
InstallDatedatetime Description
MappingStrings
CIM_ManagedSystemElement
OperationalStatusuint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
StatusDescriptionsstring[] Description
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
Statusstring Deprecated
Description
ValueMap
MaxLen
CIM_ManagedSystemElement
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement
ElementNamestring Description CIM_ManagedElement

Property Qualifiers

Property SystemCreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_FilterList
PropagatedstringCIM_ComputerSystem.CreationClassName CIM_FilterList
DescriptionstringThe scoping ComputerSystem ’ s CreationClassName. CIM_FilterList
MaxLenuint32256 CIM_FilterList

Property SystemName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_FilterList
PropagatedstringCIM_ComputerSystem.Name CIM_FilterList
DescriptionstringThe scoping ComputerSystem ’ s Name. CIM_FilterList
MaxLenuint32256 CIM_FilterList

Property CreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_FilterList
DescriptionstringThe type of class that this instance is. CIM_FilterList

Property Name Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_FilterList
OverridestringName CIM_FilterList
DescriptionstringThis is the name of the FilterList. CIM_FilterList
MaxLenuint32256 CIM_FilterList

Property Direction Qualifiers
NameTypeValueFrom Class
DescriptionstringThis defines whether the FilterList is used for input, output, or both input and output filtering. All values are used with respect to the interface for which the FilterList applies. " Not Applicable " (0) is used when there is no direction applicable to the FilterList. " Input " (1) is used when the FilterList applies to packets that are inbound on the related interface. " Output " (2) is used when the FilterList applies to packets that are outbound on the related interface. " Both " (3) is used to indicate that the direction is immaterial, e.g., to filter on a source subnet regardless of whether the flow is inbound or outbound. " Mirrored " (4) is also applicable to both inbound and outbound flow processing, but indicates that the filter criteria are applied asymmetrically to traffic in both directions and, thus, specifies the reversal of source and destination criteria (as opposed to the equality of these criteria as indicated by " Both " ). The match conditions in the aggregated FilterEntryBase subclass instances are defined from the perspective of outbound flows and applied to inbound flows as well by reversing the source and destination criteria. So, for example, consider a FilterList with 3 FilterEntries indicating destination port = 80, and source and destination addresses of a and b, respectively. Then, for the outbound direction, the filter entries match as specified and the ’ mirror ’ (for the inbound direction) matches on source port = 80 and source and destination addresses of b and a, respectively. CIM_FilterList
ValueMapstring
[See below.]
CIM_FilterList
ValuesstringNot Applicable
Input
Output
Both
Mirrored
CIM_FilterList

NameValue
0Not Applicable
1Input
2Output
3Both
4Mirrored
Property InstallDate Qualifiers
NameTypeValueFrom Class
DescriptionstringA datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. CIM_ManagedSystemElement
MappingStringsstringMIF.DMTF|ComponentID|001.5 CIM_ManagedSystemElement

Property Name Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property. CIM_ManagedSystemElement
MaxLenuint321024 CIM_ManagedSystemElement

Property OperationalStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates the current status(es) of the element. Various health and operational statuses are defined. Many of the enumeration ’ s values are self- explanatory. However, a few are not and are described in more detail. " Stressed " indicates that the element is functioning, but needs attention. Examples of " Stressed " states are overload, overheated, etc. " Predictive Failure " indicates that an element is functioning nominally but predicting a failure in the near future. " In Service " describes an element being configured, maintained, cleaned, or otherwise administered. " No Contact " indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. " Lost Communication " indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable. " Stopped " and " Aborted " are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the element ’ s state and configuration may need to be updated. " Dormant " indicates that the element is inactive or quiesced. " Supporting Entity in Error " describes that this element may be " OK " but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower layer networking problems. " Completed " indicates the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded would imply the operation finished, but did not complete OK or report an error. " Power Mode " indicates the element has additional power model information contained in the Associated PowerManagementService association. OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today ’ s environment to the future. This change was not made earlier since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly RECOMMENDED that providers/instrumentation provide BOTH the Status and OperationalStatus properties. Further, the first value of OperationalStatus SHOULD contain the primary status for the element. When instrumented, Status (since it is single-valued) SHOULD also provide the primary status of the element. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
Other
OK
Degraded
Stressed
Predictive Failure
Error
Non-Recoverable Error
Starting
Stopping
Stopped
In Service
No Contact
Lost Communication
Aborted
Dormant
Supporting Entity in Error
Completed
Power Mode
DMTF Reserved
Vendor Reserved
CIM_ManagedSystemElement
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptions CIM_ManagedSystemElement

NameValue
0Unknown
1Other
2OK
3Degraded
4Stressed
5Predictive Failure
6Error
7Non-Recoverable Error
8Starting
9Stopping
10Stopped
11In Service
12No Contact
13Lost Communication
14Aborted
15Dormant
16Supporting Entity in Error
17Completed
18Power Mode
..DMTF Reserved
0x8000..Vendor Reserved
Property StatusDescriptions Qualifiers
NameTypeValueFrom Class
DescriptionstringStrings describing the various OperationalStatus array values. For example, if " Stopping " is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus. CIM_ManagedSystemElement
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatus CIM_ManagedSystemElement

Property Status Qualifiers
NameTypeValueFrom Class
DescriptionstringA string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons: 1) Status is more correctly defined as an array. This overcomes the limitation of describing status via a single value, when it is really a multi-valued property (for example, an element may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. And, 3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the Deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
MaxLenuint3210 CIM_ManagedSystemElement

NameValue
OK[none]
Error[none]
Degraded[none]
Unknown[none]
Pred Fail[none]
Starting[none]
Stopping[none]
Service[none]
Stressed[none]
NonRecover[none]
No Contact[none]
Lost Comm[none]
Stopped[none]
Property Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement
MaxLenuint3264 CIM_ManagedElement

Property Description Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Description property provides a textual description of the object. CIM_ManagedElement

Property ElementName Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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 ManagedSystemElement ’ s Name property 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 MAY be present in both the Name and ElementName properties. CIM_ManagedElement

Methods

Method Qualifiers

Parameters

Parameter Qualifiers

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_HostedFilterListCIM_FilterListDependent
CIM_FilterListsInBGPRouteMapCIM_FilterListAntecedent
CIM_ClassifierElementUsesFilterListCIM_FilterListAntecedent
CIM_ClassifierFilterSetCIM_FilterListAntecedent
CIM_FilterOfSecurityAssociationCIM_FilterListAntecedent
CIM_FilterOfPacketConditionCIM_FilterListAntecedent
CIM_FilterListInSystemCIM_FilterListPartComponent
CIM_EntriesInFilterListCIM_FilterListGroupComponent
CIM_ListsInRoutingPolicyCIM_FilterListPartComponent
CIM_ResidesOnExtentCIM_LogicalElementDependent
CIM_OperationLogCIM_LogicalElementDependent
CIM_LogicalElementUnitOfWorkDefCIM_LogicalElementAntecedent
CIM_LogicalElementPerformsUoWCIM_LogicalElementAntecedent
CIM_AllocatedFromStoragePoolCIM_LogicalElementDependent
CIM_AssociatedMemoryCIM_LogicalElementDependent
CIM_DiagnosticTestForMSECIM_ManagedSystemElementDependent
CIM_UseOfLogCIM_ManagedSystemElementDependent
CIM_SystemComponentCIM_ManagedSystemElementPartComponent
CIM_RedundancyComponentCIM_ManagedSystemElementPartComponent
CIM_CollectedMSEsCIM_ManagedSystemElementMember
CIM_ActsAsSpareCIM_ManagedSystemElementSpare
CIM_ElementSettingCIM_ManagedSystemElementElement
CIM_ElementConfigurationCIM_ManagedSystemElementElement
CIM_DiagnosticResultForMSECIM_ManagedSystemElementSystemElement
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_StatisticsCIM_ManagedElementElement
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement