Transcription
Event Filter ProfileDocument Number: DCIM1009Document Type: SpecificationDocument Status: PublishedDocument Language: EDate: 2012-07-09Version: 1.0.2
THIS PROFILE IS FOR INFORMATIONAL PURPOSES ONLY, AND MAY CONTAIN TYPOGRAPHICALERRORS AND TECHNICAL INACCURACIES. THE CONTENT IS PROVIDED AS IS, WITHOUTEXPRESS OR IMPLIED WARRANTIES OF ANY KIND. ABSENT A SEPARATE AGREEMENTBETWEEN YOU AND DELL WITH REGARD TO FEEDBACK TO DELL ON THIS PROFILESPECIFICATION, YOU AGREE ANY FEEDBACK YOU PROVIDE TO DELL REGARDING THISPROFILE SPECIFICATION WILL BE OWNED AND CAN BE FREELY USED BY DELL. 2008 – 2012 Dell Inc. All rights reserved. Reproduction in any manner whatsoever without the expresswritten permission of Dell, Inc. is strictly forbidden. For more information, contact Dell.Dell and the DELL logo are trademarks of Dell Inc. Other trademarks and trade names may be used inthis document to refer to either the entities claiming the marks and names or their products. Delldisclaims proprietary interest in the marks and names of others.2Version 1.0.2
CONTENTS1234567Scope . 5Normative References . 5Terms and Definitions . 5Symbols and Abbreviated Terms . 6Synopsis . 7Description . 7Implementation Description . 97.1Event Filter (EF) Configuration Service . 97.2Event Filter . 107.3Event Filter Profile Registration . 128Methods . 138.1DCIM EFConfigurationService.SetEventFilterByCategory() . 138.2DCIM () . 159Use Cases . 1610 CIM Elements . 1611 Privilege and License Requirement . 16ANNEX A (informative) Change Log . 17Version 1.0.23
FiguresFigure 1 – Event Filter Profile Implementation . 8TablesTable 1 – Related Profiles . 7Table 2 – Class Requirements: Event Filter Profile . 9Table 3 – DCIM EFConfigurationService - Operations . 9Table 4 – DCIM EFConfigurationService – Properties . 10Table 5 – DCIM EventFilter – Operations . 10Table 6 – DCIM EventFilter – Properties . 11Table 5 – DCIM LCRegisteredProfile - Operations . 12Table 6 – Class: DCIM LCRegisteredProfile . 12Table 7 – DCIM EFConfigurationService.SetEventFilterByCategory() Method: Return Code Values . 14Table 8 – DCIM EFConfigurationService.SetEventFilterByCategory() Method: Parameters . 14Table 9 – DCIM EFConfigurationService.SetEventFilterByCategory() Method: Standard Messages . 14Table 10 – DCIM () Method: Return Code Values 15Table 11 – DCIM () Method: Parameters . 15Table 12 – DCIM () Method: Standard Messages 16Table 13 – Privilege and License Requirements . 164Version 1.0.2
Event Filter Profile12134The Dell Event Filter Profile provides the management capabilities to view the event filters and set actionsand notifications for the events.Scope562789The following referenced documents are indispensable for the application of this document. For datedreferences, only the edition cited applies. For undated references, the latest edition of the referenceddocument (including any amendments) applies.Normative References10DMTF DSP1033, Profile Registration Profile 1.0.01112Dell Lifecycle Controller Best Practices Guide /m/white papers/20066173.aspx13Dell WSMAN Licenses and Privileges 1.014DMTF DSP0226, Web Services for Management (WS-Management) Specification 1.1.015DMTF DSP0227, WS-Management CIM Binding Specification 1.0.016Dell Event Message Registry, link TBD 17Dell Tech Center MOF Library, F 18192021DCIM EFConfigurationService.mofDCIM EventFilter.mofDCIM LCElementConformsToProfile.mofDCIM LCRegisteredProfile.mof2223324For the purposes of this document, the following terms and definitions apply.252627283.1293031323.2Terms and Definitionsconditionalindicates requirements to be followed strictly in order to conform to the document when the specifiedconditions are metmandatoryindicates requirements to be followed strictly in order to conform to the document and from which nodeviation is permittedVersion 1.0.25
dicates a course of action permissible within the limits of the documentoptionalindicates a course of action permissible within the limits of the documentreferencing profileindicates a profile that owns the definition of this class and can include a reference to this profile in its“Related Profiles” tableshallindicates requirements to be followed strictly in order to conform to the document and from which nodeviation is permittedFQDDFully Qualified Device Descriptor is used to identify a particular component in a system.Interop NamespaceInterop Namespace is where instrumentation instantiates classes to advertise its capabilities for clientdiscovery.Implementation NamespaceImplementation Namespace is where instrumentation instantiates classes relevant to executing coremanagement tasks.ENUMERATERefers to WS-MAN ENUMERATE operation as described in Section 8.2 of DSP0226 V1.1 and Section9.1 of DSP0227 V1.0GETRefers to WS-MAN GET operation as defined in Section 7.3 of DSP00226 V1.1 and Section 7.1 ofDSP0227 V1.066676869704Symbols and Abbreviated Terms4.1CIMCommon Information Model6Version 1.0.2
ted Dell Remote Access Controller – management controller for blades and monolithic serversCMCChassis Manager Controller – management controller for the modular chassisLIFOLast In, First OutEFEvent Filter84585Profile Name: Event Filter86Version: 1.0.087Organization: Dell88CIM Schema Version: 2.26 Experimental89Dell Schema Version: 1.0.090Interop Namespace: root/interop91Implementation Namespace: root/dcim92Central Class: DCIM EFConfigurationService93Scoping Class: DCIM SPComputerSystem9495The Dell Event Filter Profile is an autonomous profile that provides the management capabilities to filterthe events of a managed system element.96DCIM EFConfigurationService shall be the Central Class.97Table 1 identifies profiles that are related to this profile.SynopsisTable 1 – Related Profiles98991001011021036Profile NameOrganizationVersionRelationshipProfile RegistrationDCIM1.0ReferenceDescriptionThe Event Filter Profile describes the properties and methods of the Event Filter in the managed systemelement or component. This profile describes the association between the managed system element andthe event filters as well as the individual event filters. It also provides a way to set actions andnotifications for individual event filters based on category, severity or InstanceID of the event filter.Version 1.0.27
104105Figure 1 represents the class schema for Event Filter Profile. For simplicity, the prefix DCIM has beenremoved from the names of the classes.106107108The DCIM EFConfigurationService class represents the configuration service that allows the user to setthe actions and notifications of event filters based on category and severity or purely based oninstanceIDs of the event filter instances.109110111The DCIM EventFilter class represents the individual event filters. Each instance of the class has manyattribute including the category, severity, action to be taken and notification to be sent out on case ofevents according to these filters.DCIM EFConfigurationServiceDCIM EventFilterImplementationNamespaceDCIM le : LCRegisteredProfileRegisteredOrganization : 1 (Other)RegisteredName : Event FilterRegisteredVersion : 1.0.0OtherRegisteredOrganization : “DCIM”112113 Figure 1 – Event Filter Profile Implementation1148Version 1.0.2
1157116117This section describes the requirements and guidelines for implementing Dell Event FilterEvent FilterProfile.Implementation DescriptionTable 2 – Class Requirements: Event Filter Profile118Element NameRequirementDescriptionDCIM EFConfigurationServiceMandatoryThe class shall be implemented in the ImplementationNamespace. It represents the EF configuration serviceand the methods available.DCIM EventFilterMandatoryThe class shall be implemented in the ImplementationNamespace. It captures the Event Filter itself.DCIM LCElementConformsToProfileMandatoryThe class shall be implemented in both the Interop andImplementation Namespaces.DCIM LCElementConformsToProfileMandatoryThe class shall be implemented in both the Interop andInterop Namespaces.DCIM LCRegisteredProfileMandatoryThe class shall be implemented in the InteropNamespace.ClassesIndicationsNone defined in this profile1191207.1121This section describes the implementation for the DCIM EFConfigurationService class.122This class shall be instantiated in the Implementation Namespace.1237.1.1 Resource URIs for WinRM 124125The class Resource URI shall be 2/DCIM EFConfigurationService? cimnamespace root/dcim”126The key properties shall be the SystemCreationClassName, CreationClassName, SystemName, Name.127128129130131The instance Resource URI for DCIM EFConfigurationService instance shall ma/2/DCIM EFConfigurationService? cimnamespace root/dcim SystemCreationClassName DCIM SPComputerSystem CreationClassName DCIM EFConfigurationService SystemName systemmc Name DCIM:EFConfigurationService”1327.1.2 Operations133The following table details the implemented operations on DCIM EFConfigurationService.Event Filter (EF) Configuration ServiceTable 3 – DCIM EFConfigurationService - Operations134Operation rsion 1.0.2RequirementsMandatoryMandatoryRequired InputInstance URIClass URIMandatoryInstance URI, parameter name-value pairs9
Operation sRequired InputMandatoryInstance URI, parameter name-value pairs1357.1.3 Properties136137138139140141The following table details the implemented properties for DCIM EFConfigurationService instancerepresenting the configuration service for event filters in a system. The “Requirements” column shalldenote the implementation requirement for the corresponding property. If the column “Property Name”matches the property name, the property either shall have the value denoted in the corresponding column“Additional Requirement”, or shall be implemented according to the requirements in the correspondingcolumn “Additional Requirement”.142Table 4 – DCIM EFConfigurationService – PropertiesProperty NameTypeRequirementsAdditional The property shall have value of“DCIM ryThe property shall have value of“DCIM The property shall have value of “systemmc”ElementNamestringMandatoryThe property shall have value of “Event Filters”NamestringMandatoryThe property shall have value of“DCIM:EFConfigurationService”1437.2144This section describes the implementation for the DCIM EventFilter class.145For the full list of the Dell event filters, please refer to the Dell Event Message Registry.146This class shall be instantiated in the Implementation Namespace.1477.2.1 Resource URIs for WinRM 148149The class Resource URI shall be 2/DCIM EventFilter? cimnamespace root/dcim”150The key property shall be the InstanceID.151152153The instance Resource URI for DCIM EventFilter instance shall ma/2/DCIM EventFilter? cimnamespace root/dcim InstanceID InstanceID ”1547.2.2 Operations155The following table details the implemented operations on DCIM EventFilter.Event FilterTable 5 – DCIM EventFilter – Operations156Operation quired InputInstance URIClass URIVersion 1.0.2
1571587.2.3 Properties159160161162163The following table details the implemented properties for DCIM EventFilter instance representing theevent filters in a system. The “Requirements” column shall denote the implementation requirement for thecorresponding property. If the column “Property Name” matches the property name, the property eithershall have the value denoted in the corresponding column “Additional Requirement”, or shall beimplemented according to the requirements in the corresponding column “Additional Requirement”.164Table 6 – DCIM EventFilter – PropertiesProperty NameTypeRequirementsAdditional onuint16MandatoryThe property shall have a format of“DCIM: UID ” where UID is a uniqueidentifier.The property shall represent the event filtercategory and may have one of the followingvalues: “Audit”, “Configuration”, “Storage”,“System Health”, and “Update”.The property shall represent the event filtersub-category.The property shall represent description of thesub-category.The property shall describe the event severityand may have one of the following values:“Critical”, “Warning”, “Informational”The property shall have a value from one ofthe values in the PossibleActions propertyarray.MandatoryThe property array shall have values from oneor more of the the PossibleNotificationsproperty array values.Notification[]uint16The property array shall have the riptions[]uint16StringMandatoryMandatory 0 (None), 1 (Reboot), 2 (Power Off) , 3 (Power Cycle).The property array shall have the followingvalue: "Reboot","Power Off", "Power Cycle",“None”The property array shall have the followingvalue:PossibleNotifications[]Version 1.0.2uint16Mandatory 0(None), 1(IPMI Alert), 2(SNMP Trap), 3(Email Alert), 4(LC Log), 5(LCD), 6 (OS Log).11
Property NameTypeRequirementsAdditional ngMandatoryThe property array shall have the followingvalue: “None”, "IPMI Alert", "SNMP Trap","Email Alert", "LC Log", "LCD", "OS Log".MessageIDstringMandatoryFor the full list of messages, please refer tothe Dell Event Message Registry.1651667.3167This section describes the implementation for the DCIM LCRegisteredProfile class.168This class shall be instantiated in the Interop Namespace.169170The DCIM ElementConformsToProfile association(s)’ ConformantStandard property shall reference theDCIM LCRegisteredProfile instance.1717.3.1 Resource URIs for WinRM 172173The class Resource URI shall be CIM RegisteredProfile? cimnamespace root/interop"174The key property shall be the InstanceID property.175176177The instance Resource URI shall be: 2/DCIM LCRegisteredProfile? cimnamespace root/interop InstanceID DCIM:EventFilter:1.0.0”1787.3.2 Operations179The following table details the implemented operations on DCIM SystemView.Event Filter Profile RegistrationTable 5 – DCIM LCRegisteredProfile - Operations180Operation ired InputInstance URIClass URI1811827.3.3 Properties183184185186187188The following table details the implemented properties for DCIM LCRegisteredProfile instancerepresenting Event Filter Profile implementation. The “Requirements” column shall denote theimplementation requirement for the corresponding property. If the column “Name” matches the propertyname, the property either shall have the value denoted in the corresponding column “AdditionalRequirements”, or shall be implemented according to the requirements in the corresponding column“Additional Requirements”.Table 6 – Class: DCIM criptionInstanceIDMandatoryStringThis property shall have a value tringThis property shall have a value of “Event Filter”.12Version 1.0.2
RegisteredVersionMandatoryStringThis property shall have a value of his property shall have a value of 1 This property shall match cense[]MandatoryStringThis property array shall contain [1(Other), 1(Other)].This property array shall contain ["WS-Identify","Interop Namespace"].This property array shall describe the requiredlicenses for this profile.If no license is required for the profile, theproperty shall have value NULL.This property array shall contain the status forthe corresponding license in the same elementindex of the ProfileRequireLicense arrayproperty. Each array element shall contain: ENSED”“NOT LICENSED”If no license is required for the profile, theproperty shall have value NULL.1901911928193194This section details the requirements for supporting intrinsic operations and extrinsic methods for the CIMelements defined by this profile.1958.1196197198199A method used to set the action and notifications for all the event filters that belong to a particularcategory, subcategory and severity. If category, subcategory and severity are not provided as input to themethod then it sets the action and notifications on ALL categories, ALL subcategories and ALLseverities.MethodsDCIM ersion 1.0.213
200Table 7 – DCIM EFConfigurationService.SetEventFilterByCategory() Method: Return Code ValuesDescription0Request was successfully executed.2Error occurredTable 8 – DCIM EFConfigurationService.SetEventFilterByCategory() Method: /ValuesIN, REQCategorystringCategory of event filter.IN, REQSubCategorystringSubCategory of event filter.IN, REQSeveritystringSeverity of event filter.IN, REQRequestedActionuint16Action requested to be set for the eventfilter. Refer mof for values.IN, REQRequestedNotification[]uint16Notifications requested to be set for theevent filter. Refer mof for values.OUTMessageIDstringError Message ID- can be used to index intoDell Message registry filesOUTMessagestringError Message in English corresponding toMessageID is returned if the method fails toexecuteOUTMessageArguments[]stringSubstitution variables for dynamic errormessagesTable 9 – DCIM EFConfigurationService.SetEventFilterByCategory() Method: Standard MessagesMessageID (OUT parameter)MessageRAC038The command failedMessageArguments[]Invalid parameter value for %sRequestedNotification, Category,Severity, SubCategoryRequestedActionRAC040Missing parameter(s) %sRequestedNotification, Category,Severity, SubCategoryRequestedActionRAC041The Set operation on the eventfilter(s) failedRAC042Invalid number of input parametersRAC043Method failed to update some ofthe event filter settings.RAC044Method failed to update all theevent filter settings.RAC045Event filter does not exist for inputparameter combinationRAC03920320414Version 1.0.2
2058.2206207A method used to set the action and notifications for all the event filters that belong to a particular set ofInstanceIDs.208209The method shall return 2 (Error Occurred), if a DCIM EventFilter instance referenced by theEFInstanceID parameter has PossibleActions property value equal to 0 (None).DCIM ()210211212Table 10 – DCIM () Method: Return CodeValuesValueDescription0Request was successfully executed.2Error occurred213214Table 11 – DCIM () Method: ParametersQualifiersNameTypeDescription/ValuesIN, REQEFInstanceIDs[]stringInstanceIDs of the event filter instances.IN, REQRequestedActionuint16Action requested to be set for the eventfilter. Refer mof for values.If the RequestedNotification is NULL orblank, this parameter shall not be NULL orblank.IN, REQRequestedNotification[]uint16Notifications requested to be set for theevent filter. Refer mof for values.If the RequestedAction is NULL or blank,this parameter shall not be NULL or blank.OUTMessageIDstringError Message ID- can be used to index intoDell Message registry filesOUTMessagestringError Message in English corresponding toMessageID is returned if the method fails toexecuteOUTMessageArguments[]stringSubstitution variables for dynamic errormessages215Version 1.0.215
Table 12 – DCIM () Method: StandardMessages216217MessageID (OUT parameter)MessageRAC038The command failedRAC039Invalid parameter value for %sRequestedNotification,RequestedAction, EFInstanceIDsRAC040Missing parameter(s) %sRequestedNotification,RequestedAction, EFInstanceIDsRAC041The Set operation on the eventfilter(s) failedRAC042Invalid number of input parametersRAC046Unsupported notification on the filter%sEFInstanceIDsRAC047Unsupported action on the filter %sEFInstanceIDs2182199220See Lifecycle Controller (LC) Integration Best Practices Guide.22110222223Use CasesCIM ElementsNo additional details specified.22411225226227The following table describes the privilege and license requirements for the listed operations . For thedetailed explanation of the privileges and licenses, refer to the Dell WSMAN Licenses and Privilegesspecification.Privilege and License RequirementTable 13 – Privilege and License Requirements228Class and MethodOperationUser PrivilegeRequiredLicense RequiredDCIM EventFilterENUMERATE,GETLoginNone.DCIM EFConfigurationServiceENUMERATE,GETLoginNone.DCIM NVOKELogin, ConfigureLM REMOTE CONFIGURATIONDCIM ()INVOKELogin, ConfigureLM REMOTE CONFIGURATIONDCIM LCRegisteredProfileENUMERATE,GETLoginNone.DCIM 6Version 1.0.2
ANNEX A(informative)229230231232Change Log233VersionDateDescription1.0.003/08/2012Initial Version.1.0.104/19/2012Corrected the DCIM EventFilter.PossibleActionStrings propertyname to PossibleActionDescriptions.Corrected the value None for the DCIM EventFilter.PossibleActionsproperty.Corrected the DCIM EventFilter.PossibleNotificationStrings propertyname to PossibleNotificationDescriptions.Corrected DCIM EventFilter.Action property constraint requirement.1.0.206/13/2012Corrected required parameters for SetEventFilterByCategory234235Version 1.0.217
6 Version 1.0.2 33 3.3 34 may 35 indicates a course of action permissible within the limits of the document 36 3.4 37 optional 38 indicates a course of action permissible within the limits of the document
