The Control-M monitoring integration allows you to monitor scheduled jobs that are running on a Control-M server. Batches in Control-M are defined as a series ...
Geneos
Selectversion
Docs▸
["Geneos>Netprobe"]["UserGuide"]
Control-MMonitoringUserGuide
Theendoflife(EOL)dateforControl-M(9.0.00) integrationis30November2021.TocontinuemonitoringyourControl-Mversion9.0.18andnewer,upgradetoControl-Mplugin.
Introduction
TheControl-MmonitoringintegrationallowsyoutomonitorscheduledjobsthatarerunningonaControl-Mserver.
BatchesinControl-Maredefinedasaseriesofjobs.Thesejobshaverelationshipsandpredefinedrulestoensurethatthejobsrun
withinaspecifictimewindowandonlyafteralloftheprerequisites(inconditions)aremet.Eachjobhasajobname,andeachday,
asetofjobsisorderedintorunforthatcurrentbatch.Aninstanceofanygivenjobonaparticulardaywillbeallocatedaunique
orderID.Ifthejobisrunmultipletimesforthesamebatch,ithasaseparateinstancecount.
ThisintegrationsupportsControl-Mversionsbelow9.0.18.IfyouareusingControl-Mversions9.0.18andabove,seetheControl-MPlug-inUserGuide.
Architecture
TheControl-Msolutionisdividedintothreeseparateparts:
JobViews
ServiceMonitoring
InfrastructureMonitoring
Prerequisites
Thefollowingrequirementsmustbemetpriortotheinstallationandsetupofthetemplate:
Control-Mversion9.0.0.
ForControl-Mbeginning9.0.18,usetheControl-Mplugin.Formoreinformation,seeApplicationandplug-inspecificinformation.
RequiresJRE,seeJavasupport.
Control-Mintegrationwithdependentlibs(theseareincludedinthelibsubdirectory)
Control-Mintegrationlicence:ControlmMonitor.lic.PleasecontactITRSSupportforatriallicence,oryourITRSAccountManagerformoreinformation.
YoumusthaveJavainstalledonthemachinerunningtheNetprobe.ForinformationonsupportedJavaversions,seeJavasupportin5.xCompatibilityMatrix.
Installation
Sampler
Setupasampler.ThisissetupasanAPIplug-in.
Setthenameto“Jobs”.Ifyouwishtochangethename,makesurethatitmatchesthenameinthectmemapi.propertiesfile.
SettheplugintypetoAPI.
Netprobe
Selectanetprobe,preferablyonthemachinewhereyouwillberunningtheplug-incode.Inthisexample,it’scalled“Control-M”.
ManagedEntity
Setupamanagedentitythatjoinstheprobeandthesampler.
Setthenameto“Control-M”.Ifyouwishtochangethename,makesurethatthisvalueisusedinthectmemapi.propertiesfile.
SetOptionstoprobe,andselecttheprobeyousetupinNetprobe.
ReferencethesampleryousetupinSampler.
Control-MPermissions
UsingtheControl-Mclient,ensurethattheuserhaspermissionstoviewthejobsthatyouwanttosee.
TheeasiestwaytodothisistoaddtheUsertotheBrowseGroup.
IfyouwishtoseealltheBIMreports,makesurethisissetinthePrivilegestab:
Anddouble-checktheServicestab:
Control-Mintegrationwithdependentlibs
CreateadirectoryontheserverwhereyouarerunningthenetprobeyouwanttousetomonitorControl-M.
Copythecontentsofthetarfiletothislocation.Thefollowingisdisplayed:
ControlmMonitor/
ControlmMonitor.jar
ctmemapi.properties(Youcanrenamethedefault.propertiesfiletogetyoustarted)
BMC_JNI.dll
jacorb.properties
log4j.properties
lib/
antlr-2.7.2.jar
avalon-framework-4.1.5.jar
bdIT.jar
classes.jar
commons-codec-1.3.jar
concurrent-1.3.2.jar
emapi.jar
jacorb.jar
jbcl.jar
log4j-1.2.16.jar
log4j-1.2.8.jar
logkit-1.2.jar
NamingViewer.jar
ws-commons-util-1.0.2.jar
xercesImpl.jar
xml-apis.jar
xmlrpc-client-3.1.3.jar
xmlrpc-common-3.1.3.jar
xmlrpc-server-3.1.3.jar
xmldata/
EMAPI_700
EMAPI_800
EMAPI_register
EMAPI_unregister
List_Services
retrieve_jobs
SOAP_env
jobview/
All_jobs
Failed_Jobs
Running_Jobs
Waiting_Jobs
Plug-inconfiguration
ctmemapi.properties
Theplug-inusesthesameconfigfileastheControl-MAPIcalledctmemapi.properties.
Init,settheconnectiondetailsfortheserver.Confirmthatthectmemapi.propertiesfilehasthecorrectsettingsespecially:
netprobeServer=localhost*
netprobePort=7036
ManagedEntity=Control-M
Sampler=Jobs
#InstancenameoftheControl-Mserver(defaultistheHostnameoftheserveronwhichitresides)
com.bmc.ctmem.emapi.GSR.hostname=**
#Locationofthexmlrequestfiles
com.bmc.ctmem.emapi.XMLDATAPATH=xmldata
username=***
password=***
Eachplug-inwillmonitoronlyoneControl-Mserver.
Note:ItispossibletohavethenetproberunonadifferentserverthantheControl-Mmonitor
process.Iftheprobeisgoingtorunonadifferentserver,thenyouwouldhavetochangelocalhosttosomeotherhostname.
ThissettingcorrespondstotheControl-Mservertoconnectto,whichcanbefoundoutfromtheControl-Mclientaspicturedbelow.
Inversion8,youcangetthesedetailsfromtheControl-Mclientthatisusedtoconnecttotheserver:
Inversion7,youcangetthesedetailsfromtheControl-Mclientonceyouareloggedin:
TheControl-Mserverishighlightedinred.
Note:Itispossibletostorepasswordsinanencryptedformatbyaddingthesuffix.encryptedtothesettingnameintheconfigfile.
Therefore:
password=cleartext
wouldbecome:
password.encrypted=f1wSYimqEj5Xa0n6HZ4PCg==
Note:Itispossibletoencryptthepasswordusingautilitythatcomeswiththeintegration,whichisthebdIT.jarlibrary,locatedinthelibfolderoftheintegration.
Runitandpassinthepasswordonthecommandlinetoencryptthepassword:
java-jarbdIT.jar
jacorb.properties
Inthejacorb.propertiesfile,itisrequiredtosetthenamingserverandportonline21withthefollowingsyntax:
ORBInitRef.NameService=corbaloc:iiop:1.2@NAMINGSERVICE:PORTNameService
YoucangetthesedetailsfromtheControl-Mclientthatisusedtoconnecttotheserver:
Thenamingserverandportarehighlightedinyellow.
LoggingConfiguration
Theloggingisconfiguredusinglog4j.Bydefault,itisconfiguredtologtotheconsoleandalogfile(controlmmonitor.log)
thatwillrolltwiceaday(AMandPM).
TheconfigfilesareavailableinthelogConfigdirectory.Movethefilethatyouwishtouseintothemaindirectory
andmakesureitiscalledlog4j2.xml.Therearethreeloggingconfigurationsprovided:
log4j2.xml-logsINFOandabovetologs/controlmmonitor.logandarchivesthefileifitgetslargerthan10MB.
log4j2.verbose.xml-logsINFOandabovetologs/controlmmonitor.logandarchivesthefileifitgetslargerthan10MB.
Alsologseverythingtocontrolmmonitor_debug.log.
log4j2-test.xml-sendseverythingtotheconsole.
Licence
Placethelicencefile(ControlmMonitor.lic)intothemaindirectorywheretheControlmMonitor.jarfileislocated.
Initialisation
ToruntheControlmMonitor.jarfile:
java-Dlog4j.configurationFile=log4j2.xml-jarControlmMonitor.jar
Configuration
Thejobviewsareconfiguredinthexmlfilesinthejobviewfolder.Eachxmldocumentinthisfoldercreatesa
separateviewbasedonthequerydefinedinthectmem:search_criterionnode.
FailedJobs:
ViewDetails
JobViews
Thejobviewisthemainfeatureoftheintegration.ItdisplaysaselectionofjobsthatarecurrentlyorderedintoyourControl-Mschedule.
Thereareseveraljobviewsthataredefinedoutoftheboxwiththeintegration:
AllJobs-alistofallthejobsthatarecurrentlyloadedintotheenvironment.
FailedJobs-alistofallthejobsthathavefailedintheenvironment.
Runningjobs-jobsthathavenotyetcompleted.
Waitingjobs-jobsthathavebeenheldforsomereason.
Allthejobviewshavethesamecolumnstructure.TheircontentsaredefinedbytheXMLsoapmessagesinthejobviewfolder.
Youwillbeabletousetheseviewstofilterthejobsbeaseriesofcriteria.Forexample:
Criteria
Description
DATA_CENTER
Thedatacentretowhichthejobbelongs.
APPLICATION
Thenameoftheapplicationtowhichthejob’sgroupbelongs.
APPL_TYPE
Theexternalapplicationonwhichthejobruns.
GROUP_NAME
Thenameofthegrouptowhichthejobbelongs.
MEMNAME
Thenameofthefilethatcontainsthejobscript.
JOB_NAME
Thenameofthejob.
TASK_TYPE
Typeofthejob(task)tobeperformedbyControl-M.
CRITICAL
Whenselected,resourcesforthejobarereservedexclusivelyforthatjobastheybecomeavailable.Whenallnecessaryresourcesareavailable,thejobisexecuted.
CYCLIC
Whenselected,indicatesthatthecurrentjobiscyclic(itshouldbererunatspecifiedintervals).
Part_of_BIM_service
IndicatesifthejobisincludedinaBusinessService.
STATUS
Thejobexecutionstatus.
DELETE_FLAG
Jobwasdeleted.
RunAsUser
Theuser(userID)onwhosebehalfthejobisexecuted.ThisparameterisusedbytheControl-Msecuritymechanism.
HOSTGROUP
Thenameofthehostorhostgrouponwhichfollowingiterationsofajobisrun.
START_TIME
Thestarttimeofthejob.
END_TIME
Theendtimeofthejob.
IncondName
Thenameofthein-condition.
IncondDate
Thedateofthein-condition.
OutcondName
Thenameoftheout-condition.
OutcondDate
Thedateoftheout-condition.
ServiceMonitoring
TheintegrationsconnectswithBatchImpactManager(BIM)toviewactiveservicesthatarecurrentlyrunning.Thisallowsyouto:
ViewthedetailofservicescurrentlyrunninginBIM.
Viewthesummaryofjobsineachrunningserviceandtheirstatusincluding:Maximum/minimumruntimesSLAbreaches
DisplayjobsthatarerelatedtoaBIMserviceinajobmonitoringview.
Note:Thisfunctionalityisonlyavailableifyouhavepurchasedtheoptionaladd-on,BatchImpactManager(http://www.bmc.com/products/control-m-batch-scheduling/batch-impact-manager.html).
InfrastructureMonitoring
AgentMonitoring
TomonitortheControl-Magents,aninstanceoftheplug-inneedstorunoneachserverwheretheAgentruns.
Alloftheseplug-inscancommunicatewithanindividualnetprobe.Theplug-inusesinformationfromtheControl-Mconfiguration
todisplayinformationabouttheAgents,anditusesthecommandlinetoolag_pingtoconfirmthattheagentcancorrectlycommunicate
withtheControl-Mserver.
Note:ToreducetheloadontheagentserversandtheControl-MAPI,itisbesttoremovethejobviewsfromalltheagentserversexceptone.
ServerMonitoring
WiththefeaturesavailableinthestandardGeneosproduct,youareabletomonitorthewholeschedulinginfrastructureand
usethemenucommandstogofromaselectedjobtodisplaymetricsoftheserveronwhichtheinstanceofthatjobisrunning.
WealsoprovideatemplatetoenablemonitoringoftheControl-Mdatabase.
PREVIOUSTOPIC
NEXTTOPIC
Wasthistopichelpful?
Yes
No
Yourthoughts...
Cancel
Sendfeedback
Howcanweimprovethistopic?
Itdidnotanswermyquestion(s)
Confusing
Missingscreenshotorgraphics
Missingtechnicaldetails
Informationisoutofdate
Yourthoughts...
Cancel
Sendfeedback
Thankyouforyourfeedback!
