e-dokumen.com

Metric NAME "Response" TYPE "TABLE" Display Label NLSID "oracle cca resp" Response /Label /Display TableDescriptor ColumnDescriptor NAME "Status" TYPE "NUMBER" Display Label NLSID "cca SNMP resp status" CCA SNMP SubAgentStatus /Label /Display /ColumnDescriptor /TableDescriptor QueryDescriptor FETCHLET ID "Snmp" Property NAME "NAME" SCOPE "INSTANCE" NAME /Property Property NAME "hostname" SCOPE "INSTANCE" AgentHost /Property Property NAME "PINGMODE" SCOPE "GLOBAL" TRUE /Property Property NAME "OIDS"SCOPE "GLOBAL" 1.3.6.1.4.1.10477.1.1.0 /Property Property NAME "COMMUNITY" SCOPE "INSTANCE"OPTIONAL "TRUE" CommunityString /Property Property NAME "TIMEOUT" SCOPE "INSTANCE"OPTIONAL "TRUE" Timeout /Property /QueryDescriptor /Metric The ‘NAME’ property contains the name of the CCA target instance.The ‘hostname’ property contains the location of the SNMP agent.The ‘PINGMODE’ property is typically used with the SNMP fetchlet within aResponse metric. When it is set to TURE, this property tells the fetchlet to returnthe SNMP target’s availability status to a column defined in the Response metric.The ‘OIDS’ property can contain a list OIDs that are defined in the target type’sMIB that correspond to properties that can be obtained. In this case,1.3.6.1.4.1.10477.1.1 corresponds to the releaseVersion property in the MIB. Thefinal 0 in the OID signifies that a scalar object (single value) will be returned. Ifthere isn’t a trailing 0, then a table column (multiple values) will be returned. In theexample with the Response metric above, the OID specified is actuallyinconsequential since PINGMODE is set to TRUE.The ‘COMMUNITY’ property is the SNMP community value. If not specified thedefault value is public.The ‘TIMEOUT’ property corresponds to the SNMP timeout value, which defaultsto 5 seconds.Receiving SNMP traps in Oracle Enterprise Manager Page 9

PushDescriptorAn OEM agent can also listen for data through the use of a receivelet. The OEMagent supports different types of receivelets. The SNMP receivelet can be used bythe OEM agent to listen for SNMP traps as defined in the target type’s MIB. APushDescriptor is part of the metric definition of a receivelet.A Receivelet is a library thatallows Enterprise Manager toreceive notifications sent bythird-party network elements.A receivelet listens at aparticular port for thenotifications. These arenotifications that areasynchronously sent andwithout any requests fromOracle Management Agent.TELEPHONYATWORK-MIB DEFINITIONS :: BEGINIMPORTSenterprises, gaugeFROM RFC1155-SMIOBJECT-TYPEFROM RFC-1212DisplayStringFROM RFC-1213;.telephonyatwork OBJECT IDENTIFIER :: { enterprises 10477 }serverPart OBJECT IDENTIFIER :: { telephonyatwork 1 } trapInfo OBJECT-TYPESYNTAX DisplayStringACCESS read-onlySTATUS mandatoryDESCRIPTION "Trap Description":: { serverPart 6 } companyDeleted TRAP-TYPEENTERPRISE telephonyatworkVARIABLES { trapInfo }DESCRIPTION "Company has been deleted":: 5:: 5The type of receivelet is identified by the properties that the receivelet needs inorder to listen for a particular SNMP trap. Find below a portion of CCA’s MIBused in this example:generic-trap – generic trap typeINTEGER iseSpecific(6)}In addition, there are standard SNMP MIB definitions that will be referenced aswell. Below is the definition for generic-trap (RFC1157): The example belowdefines a metric, companyDeleted, which will listen for SNMP trap of the samename:Receiving SNMP traps in Oracle Enterprise Manager Page 10

Metric NAME "companyDeleted" TYPE "TABLE" Display Label NLSID "companyDeleted" Company Deleted /Label /Display TableDescriptor ColumnDescriptor NAME "trapInfoCompDel" STATELESS ALERTS "TRUE"TYPE "STRING" IS KEY "TRUE" Display Label NLSID "TrapInfo5" Company Deleted Trap(Stateless) /Label /Display /ColumnDescriptor /TableDescriptor PushDescriptor RECVLET ID "SNMPTrap" Property NAME "MatchEnterprise"SCOPE "GLOBAL" 1.3.6.1.4.1.10477 /Property Property NAME "MatchGenericTrap" SCOPE "GLOBAL" 6 /Property Property NAME "MatchSpecificTrap" SCOPE "GLOBAL" 5 /Property Property NAME "MatchAgentAddr"SCOPE "INSTANCE" AgentAddr /Property Property NAME "EventtrapInfoCompDelOID"SCOPE "GLOBAL" 1.3.6.1.4.1.10477.1.6 /Property Property NAME "SeverityCode"SCOPE "GLOBAL" CRITICAL /Property /PushDescriptor /Metric Since the companyDeleted SNMP trap does not have a corresponding clearingSNMP trap, STATELESS ALERTS is set to TRUE. In the case, the OEM UIallows the user to manually clear the alert. When an SNMP trap has acorresponding clearing SNMP trap (i.e. systemOverflow and systemLicenseOKfrom Table 1), STATELESS ALERTS is set to FALSE.The properties that can be used by the SNMP receivelet are defined in thefollowing ringOID used to define the trap being sent.RequiredMatchGenericTrapStringCode for a generic SNMP StringEvent metric-column StringTrap defined in a MIB (not one of the generictraps), the ID assigned to that MIB.IP address of the generating SNMP agent, assent in the trap.RequiredRequiredSpecifies that, on receiving this trap, theRequired, if eventsreceivelet should generate a severity on thishave to be generated.metric column. The value of the metricHowever, ifcolumn should be the value of this parameter.Event metric-(This case is useful where the expectedcolumn OID isReceiving SNMP traps in Oracle Enterprise Manager Page 11

ParameterTypeDescriptionUsevalues of the EM metric are not the same asprovided, then this isthe triggering SNMP variable.)not required.Specifies that, on receiving this trap, thereceivelet should generate a severity on thisEvent metriccolumn OIDStringmetric column. The value of the metriccolumn should be taken from the varbind inthe trap with OID equal to the value of thisparameter.SeverityCodeStringRequired, if eventshave to be generated.However, ifEvent metriccolumn is provided,then this is notrequired.Specifies the level at which the severityRequired. However, ifshould be generated. The value of thisSeverityCodeOID isparameter should be one of ‘CRITICAL’,provided, then this is‘WARNING’ or ‘CLEAR’.not required.Specifies the level at which the severityshould be generated. If the varbind in thetrap with OID equal to the value of thisparameter is one of the strings ‘CRITICAL’,‘WARNING’ or ‘CLEAR’, the severity shouldSeverityCodeOIDStringbe generated at that level; otherwise, noseverity should be generated. (Thisparameter would only be used if theRequired. However, ifSeverityCode isprovided, then this isnot required.integrator were designing a trap exclusivelyfor use with EM, but may be useful in thiscase.Specifies that, on receiving this trap, thereceivelet should generate a datapoint on themetric, for which the value of this metriccolumn should be taken from the varbind inthe trap with OID equal to the value of thisData metriccolumn OIDparameter. (An SNMP PushDescriptor mayStringhave many Data* parameters, in which casea single row will be returned, with all specifiedRequired, if datapointshave to be generated.columns populated from the appropriatevarbind in the trap. An SNMPPushDescriptor may not have both a Data*parameter and a Severity* parameter, normay it have multiple Severity* parameters.)Severity or datapoint generated by thisPushDescriptor should contain a key valuefor this metric column. The key value shouldKey metriccolumn OIDStringbe taken from the varbind in the trap with OIDequal to the value of this parameter. ForOptionalevery key column in the metric definition,there must be a Key* parameter in thePushDescriptor.Context metriccolumn OIDStringIf the PushDescriptor generates a severity,Optional. This can bethe severity should contain a value for thisused only formetric column in its event context. The valueseverities.should be taken from the varbind in the trapwith OID equal to the value of this parameter.Receiving SNMP traps in Oracle Enterprise Manager Page 12

ParameterTypeDescriptionUseIf the PushDescriptor generated a datapoint,this parameter is ignored.Table 5.SNMP Receivelet PropertiesIn the companyDeleted metric example above, MatchEnterprise is set totelephonyatwork (1.3.6.1.4.1.10477), which is the highest-level object identifierbased off of the standard enterprises value (1.3.6.1.4.1).MatchGenericTrap is set to 6, which is the enterpriseSpecific value for generic-trapfound in RFC1157. This implies that a specific trap value will also be supplied.MatchSpecificTrap is set to 5, which is the value of the companyDeleted TRAPTYPE in the MIB.MatchAgentAddr is set to the AgentAddr instance property value for the targetinstance.Event metric-column OID turns into EventrapInfoCompDelOID and has thevalue 1.3.6.1.4.1.10477.1.6, which is the OID of trapInfo. The alert generated willbe for the trapInfoCompDel metric column.Finally, SeverityCode is set to ‘CRITICAL’ so when this SNMP trap is caught, thena critical level alert will be generated.NOTE: In the current 8.1.2 CCA build, the trapInfo variable is not sent with thegenerated traps. Instead, the trap contains a single variable with the OID set to1.3.1.4.1.10477.6. In addition, the Trap Enterprise value from the trap is1.3.1.4.1.10477.6. This value 1.3.1.4.1.10477.6 does not exist in the CCA MIB.This means for 8.1.2 CCA, the definition of the companyDeleted metric as shownabove should be modified so that both MatchEnterprise andEventtrapInfoCompDelOID properties have the value 1.3.1.4.10477.6. Instance PropertiesThese properties are those that uniquely identify a particular instance of a targettype. The oracle cca target type will have four target instance properties asillustrated below. The Labels that are specified are used in the EM UI on the pagewhere a target instance can be manually added. InstanceProperties InstanceProperty NAME "AgentHost" CREDENTIAL "FALSE"OPTIONAL "FALSE" Display Label NLSID "oracle cca SNMP agent host" Hostname (SNMP Agent ) /Label /Display /InstanceProperty InstanceProperty NAME "AgentAddr" CREDENTIAL "FALSE"OPTIONAL "FALSE" Display Label NLSID "oracle cca SNMP agent addr" IP Address (SNMP Agent) /Label /Display Receiving SNMP traps in Oracle Enterprise Manager Page 13

/InstanceProperty InstanceProperty NAME "CommunityString" CREDENTIAL "TRUE"OPTIONAL "TRUE" Display Label NLSID "oracle cca SNMP community string" SNMP ReadCommunity String (Default: public) /Label /Display public /InstanceProperty InstanceProperty NAME "Timeout" CREDENTIAL "FALSE"OPTIONAL "TRUE" Display Label NLSID "oracle cca SNMP timeout" SNMP Timeout (Default: 30seconds) /Label /Display 30 /InstanceProperty /InstanceProperties Setting CREDENTIAL to TRUE results in the instance property gettingobfuscated while you type it in OEM’s Add Target page.When an instance property is set to be OPTIONAL, you need not specify it on theAdd Target page. A default value can be specified as can be seen for the instanceproperties CommunityString and Timeout above.The second metadata file, the target default collection (or dc) XML file, defines theschedule and collection interval for each metric added to the metadata typedefinition. It’s made up of the following Document Type Definition (DTD) locationThe DTD referenced here is the document describing the content of the XML fileand setting constraints and restrictions on its structure. e.g. !DOCTYPE TargetMetadata SYSTEM "./dtds/TargetCollection.dtd" Target Type referenceThe Target Type reference matches the TYPE set in the target type metadata file. TargetCollection TYPE "oracle cca" Collection ItemA collection for each metric that is defined in the target type metadata file. This caneither be obtained on a given schedule with a specific interval or simply bylistening. When dealing with SNMP, the collection definition largely depends onwhether the metrics are obtained through a fetchlet or a receivelet.Note: A collection item must be defined for the Response metric so that theavailability of the target instance is known to OEM.Receiving SNMP traps in Oracle Enterprise Manager Page 14

In the example below, a CollectionItem is set up for the Response metric. TheOEM agent collects it every 5 minutes. A Condition is defined for theStatus metric column so that when the value is 0, a critical alert will begenerated. For the Response metric there is no need to define awarning level alert. However, for other metric columns, it is likely thatwhen a critical alert threshold is set, a warning level threshold would beset as well. In addition, messages can be defined for display when thealert occurs or is cleared. CollectionItem NAME "Response" Schedule IntervalSchedule INTERVAL "5" TIME UNIT "Min"/ /Schedule Condition COLUMN NAME "Status"CRITICAL "0"WARNING "NotDefined"OPERATOR "EQ"OCCURRENCES "1"MESSAGE "%target% is unreachable or is down."MESSAGE NLSID "oracle cca response status"CLEAR MESSAGE "%target% is up."CLEAR MESSAGE NLSID "oracle cca response status clear"/ /CollectionItem Unlike the CollectionItem for a metric that is obtained by a fetchlet, no schedule orinterval is needed for a metric that gets its data from a receivelet. However, thePUSH property for the Condition must be set to “TRUE”. This indicates that theSNMP traps are being pushed by the SNMP agent rather than being pulled by theOEM agent on a given schedule. See the example shown below: CollectionItem NAME "companyDeleted" Condition PUSH "TRUE"COLUMN ”trapInfoCompDel”COLUMN NAME "trapInfo1"CRITICAL "1"MESSAGE " companyDeleted trap received for target %target%: %value%"MESSAGE NLSID "oracle cca tranInfoCompDel” /CollectionItem Messages can contain placeholders, which will be filled in when the alert message iscreated. Some of these placeholders include: %value% - value of the metric (or column of metric) %target% - name of the target %column name% - can include value columns as well as key columns%critical threshold%: the critical threshold of the conditionReceiving SNMP traps in Oracle Enterprise Manager Page 15

The next two sections cover detailed steps for building and deploying theManagement Plug-in.Validate the metadata files Download the EM PDK (empdk.jar)5 to validate the XML files to a workstationthat has a 10.1.x or 10.2.x OEM agent installed on it. Set the ORACLE HOME environment variable to the OEM agent’sORACLE HOME. Set the JAVA HOME environment variable to the proper location. Add JAVA HOME/bin to your PATH environment variable. Install the PDK as follows:java –jar emPDK.jar client -install dir pdk installation directory Add pdk installation directory /pdk/bin to your PATH environmentvariable and then run the following for command usage and summary:emcli help check mp Check the syntax of the metric metadata and the default collection files:emcli check mp –metadata file oracle cca ttd.xml –collection file .oracle cca dc.xml –err level errorIf the files are well constructed, the program will return with no error message.Next you need to package all the metadata files into a portable management plug-inarchive.Create the Management Plug-in Archive Assuming that you have the same environment set up as when the metadata fileswere validated, use EMCLI to package the plug-in:emcli add mp to mpa -mpa "oracle cca.jar" -mp version "1.0"-ttd "oracle cca ttd.xml" -dc "oracle cca dc.xml" -func desc "CCA ManagementPlug-in to receive SNMP Traps" Tip: Deploy the plug-in toseveral agents in one go toreduce plug-in roll out time inyour datacenter.Copy the generated JAR to your local desktop.Deploy the Management Plug-inOracle Enterprise Manager 10g Grid Control Management Plug-in Development xtensions/management plugin sdk.html5.Receiving SNMP traps in Oracle Enterprise Manager Page 16

Import the Archive into OEM Go to: Setup Management Plug-ins. Click the Import button. Browse to the JAR location and select the file. Click the List Archive button. Select the listed CCA plug-in. Click the OK button to import.Push the plug-in to Agent(s) Identify the row for the Management Plug-in you just imported. Click the Deploy icon for the CCA Management Plug-in. Click the Add Agents button. In the Search and Select popup window, set Target Type to Agent in the LOV. Select the agent(s) where you would like the plug-in deployed. Click the Select button to dismiss the popup window. Hit the Next button and then the Finish button.Add a New Target in OEMEven though the CCA Management Plug-in has been deployed in OEM, it is notyet ready to accept and display the SNMP traps. You have to create a targetinstance within OEM that can display alerts.Follow the steps below to add the target: Go to Setup Agents. Select the agent the Management Plug-in has been deployed to by clicking on itslink. Select the target type (Oracle CCA Application) from the Add dropdown andclick Go. On the target configuration page, fill in the target instance name (a suggestedformat could be target-type hostname ).e.g. oracle cca myhost Fill in the Hostname, which is the location of where the SNMP daemon for CCAis running.e.g. myhost.domain.com Fill in the AgentAddr as the IP address of Hostname. Optionally fill in CommunityString, which defaults to public. Optionally fill in Timeout as the value for the SNMP timeout, which defaults to30 seconds. Click the OK button to add the target.Receiving SNMP traps in Oracle Enterprise Manager Page 17

Now that OEM is ready to receive the SNMP alerts, you must point the SNMPtrap originator to the OEM agent where the Management Plug-in is deployed.Update the Trap DestinationIn order to successfully receive traps from CCA, the trap d

Construct OIDs from CCA MIB Process the CCA MIB either by reading the file or with the help of any available MIB browser tool (there are several freeware versions available on the Internet). The table below lists some of the OIDs constructed from the CCA MIB. Name OID