Geneos Control-M Plug-in Technical Reference v1.0

Control-M Plug-in User GuideFunctional Area: Control-M Plug-in

Geneos Release: v4.5Document Version: v1.0.0

Date Published: 05 March 2018

Table of Contents

Control-M Monitoring Plug-In 3

Introduction 3

Architecture 3

Prerequisites 3

Installation 4

Ctmemapi.properties 8

Jacorb.properties 11

Agent Monitoring 17

Server Monitoring 17

Control-M Monitoring Plug-In

IntroductionBatches in Control-M are defined as a series of jobs. These jobs have relationships and predefined rules toensure that the jobs run within a specific time window and only after all of the prerequisites (in conditions)aremet. Each job has a job name, and each day, a set of jobs is ordered in to run for that current batch. Aninstance of any given job on a particular day will be allocated a unique order ID. If the job is runmultipletimes for the same batch, it has a separate instance count.

ArchitectureThe Control-M solution is divided into three separate parts:

l Job Views

l ServiceMonitoring

l InfrastructureMonitoring

PrerequisitesThe following are required to set up the Control-M Monitoring plug-in:

l Geneos core components: Active Console, Gateway 2 and Netprobe

l Instrumentation XML-RPC API

l Java 1.7+

l Control-M plug-in with dependent libs (these are included in the lib subdirectory)

l Control-M plug-in licence: ControlMMonitor.lic. Please contact [email protected] for a triallicence.

GeneosRelease v4.5 Control-M Plug-in v1.0.0 - User Guide Published Date 05/03/2018

mailto:support%40itrsgroup.com

Installation

SamplerSet up a sampler. This is set up as an API plug-in.

l Set the name to “Jobs”. If you wish to change the name, make sure that it matches thename in the ctmemapi.properties file.

l Set the plugin type to API.

<sampler name="Jobs"><plugin><api></api></plugin></sampler>

NetprobeSelect a netprobe, preferably on themachine where you will be running the plug-in code. In this example,it’s called “Control-M”.


of 17

Managed EntitySet up amanaged entity that joins the probe and the sampler.

l Set the name to “Control-M”. If you wish to change the name, make sure that this value isused in the ctmemapi.properties file.

l Set Options to probe, and select the probe you set up in Netprobe.

l Reference the sampler you set up in Sampler.

<managedEntity name="Control-M"><probe ref="Control-M"></probe><sampler ref="Jobs"></sampler></managedEntity>


Control-M PermissionsUsing the Control-M client, ensure that the user has permissions to view the jobs that you want to see.The easiest way to do this is to add the User to the BrowseGroup.

If you wish to see all the BIM reports, make sure this is set in the Privileges tab:

And double-check the Services tab:

JavaThe plug-in requires Java 1.7 (min 1.7.0_15). Make sure Java is correctly configured on the server onwhich the plug-in will run.


of 17

Control-M Plug-In with Dependent LibsCreate a directory on the server where you are running the netprobe you want to use tomonitor Control-M.Copy the contents of the tar file to this location. The following is displayed:

ControlmMonitor/ControlmMonitor.jarctmemapi.properties (You can rename the default.properties file to get you started)BMC_JNI.dlljacorb.propertieslog4j.propertieslib/antlr-2.7.2.jaravalon-framework-4.1.5.jarbdIT.jarclasses.jarcommons-codec-1.3.jarconcurrent-1.3.2.jaremapi.jarjacorb.jarjbcl.jarlog4j-1.2.16.jarlog4j-1.2.8.jarlogkit-1.2.jarNamingViewer.jarws-commons-util-1.0.2.jarxercesImpl.jarxml-apis.jarxmlrpc-client-3.1.3.jarxmlrpc-common-3.1.3.jarxmlrpc-server-3.1.3.jarxmldata/EMAPI_700EMAPI_800EMAPI_registerEMAPI_unregisterList_Servicesretrieve_jobsSOAP_envjobview/All_jobsFailed_JobsRunning_JobsWaiting_Jobs


Plug-In Configuration

ctmemapi.propertiesThe plug-in uses the same config file as the Control-M API called ctmemapi.properties. In it, set theconnection details for the server. Confirm that the ctmemapi.properties file has the correct settingsespecially:

netprobeServer=localhost *netprobePort=7036ManagedEntity=Control-MSampler=Jobs

#Instance name of the Control-M server (default is the Hostname of the server on which itresides)com.bmc.ctmem.emapi.GSR.hostname= **

#Location of the xml request filescom.bmc.ctmem.emapi.XMLDATAPATH=xmldata

username= ***password= ***

Each plug-in will monitor only one Control-M server.

Note: It is possible to have the netprobe run on a different server than the Control-M monitor process. Ifthe probe is going to run on a different server, then you would have to change localhost to some otherhostname.


of 17

This setting corresponds to the Control-M server to connect to, which can be found out from the Control-Mclient as pictured below.

In version 8, you can get these details from the Control-M client that is used to connect to the server:

In version 7, you can get these details from the Control-M client once you are logged in:

The Control-M server is highlighted in red.

Note: It is possible to store passwords in an encrypted format by adding the suffix .encrypted to thesetting name in the config file.


Therefore:

password=cleartext

would become:

password.encrypted= f1wSYimqEj5Xa0n6HZ4PCg==

Note: It is possible to encrypt the password using a utility that comes with the plug-in, which is thebdIT.jar library, located in the lib folder of the plug-in.

Run it and pass in the password on the command line to encrypt the password:

java -jar bdIT.jar <password>


of 17

jacorb.propertiesIn the jacorb.properties file, it is required to set the naming server and port on line 21 with the followingsyntax:

ORBInitRef.NameService=corbaloc:iiop:1.2@NAMINGSERVICE:PORTNameService

You can get these details from the Control-M client that is used to connect to the server:

The naming server and port are highlighted in yellow.


Logging ConfigurationThe logging is configured using log4j. By default, it is configured to log to the console and a log file(ControlMMonitor.log) that will roll twice a day (AM and PM).

The config files are available in the logConfig directory. Move the file that you wish to use into themaindirectory andmake sure it is called log4j2.xml. There are three logging configurations provided:

l log4j2.xml - logs INFO and above to logs/ControlMMonitor.log and archives the file if it gets largerthan 10MB.

l log4j2.verbose.xml - logs INFO and above to logs/ControlMMonitor.log and archives the file if itgets larger than 10MB. Also logs everything to controlmmonitor_debug.log.

l log4j2-test.xml - sends everything to the console.

LicencePlace the licence file (ControlMMonitor.lic) into themain directory where the ControlmMonitor.jarfile is located.

InitialisationTo run the ControlMMonitor.jar file:

java -Dlog4j.configurationFile=log4j2.xml -jar ControlMMonitor.jar


of 17

ConfigurationThe job views are configured in the xml files in the jobview folder. Each xml document in this folder createsa separate view based on the query defined in the ctmem:search_criterion node.

Failed Jobs:

<Failed_jobs name="Failed jobs" group="Control-M"><ctmem:retrieve_jobs_criterion><ctmem:include><ctmem:search_criterion><ctmem:param><ctmem:name>STATUS</ctmem:name><ctmem:operator>EQ</ctmem:operator><ctmem:value>Ended Not OK</ctmem:value></ctmem:param><ctmem:param><ctmem:name>ODATE</ctmem:name><ctmem:operator>EQ</ctmem:operator><ctmem:value>%%ODATE</ctmem:value></ctmem:param></ctmem:search_criterion></ctmem:include></ctmem:retrieve_jobs_criterion></Failed_jobs>


View Details

Job ViewsThe job view is themain feature of the plug-in. It displays a selection of jobs that are currently ordered intoyour Control-M schedule. There are several job views that are defined out of the box with the plug-in:

l All Jobs - a list of all the jobs that are currently loaded into the environment.

l Failed Jobs - a list of all the jobs that have failed in the environment.

l Running jobs - jobs that have not yet completed.

l Waiting jobs - jobs that have been held for some reason.

All the job views have the same column structure. Their contents are defined by the XML soapmessagesin the jobview folder.

You will be able to use these views to filter the jobs be a series of criteria. For example:

Criteria Description

DATA_CENTER The data centre to which the job belongs.

APPLICATION The name of the application to which the job’s groupbelongs.

APPL_TYPE The external application on which the job runs.

GROUP_NAME The name of the group to which the job belongs.

MEMNAME The name of the file that contains the job script.

JOB_NAME The name of the job.

TASK_TYPE Type of the job (task) to be performed by Control-M.


of 17

Criteria Description

CRITICAL When selected, resources for the job are reservedexclusively for that job as they become available.When all necessary resources are available, the jobis executed.

CYCLIC When selected, indicates that the current job is cyclic(it should be rerun at specified intervals).

Part_of_BIM_service Indicates if the job is included in a Business Service.

STATUS The job execution status.

DELETE_FLAG Job was deleted.

Run As User The user (user ID) on whose behalf the job isexecuted. This parameter is used by the Control-Msecurity mechanism.

HOSTGROUP The name of the host or host group on whichfollowing iterations of a job is run.

START_TIME The start time of the job.

END_TIME The end time of the job.

Incond Name The name of the in-condition.

Incond Date The date of the in-condition.

Outcond Name The name of the out-condition.

Outcond Date The date of the out-condition.


Service MonitoringThe plug-in integrates with Batch Impact Manager (BIM) to view active services that are currently running.This allows you to:

l View the detail of services currently running in BIM.

l View the summary of jobs in each running service and their status including:

l Maximum / minimum runtimes

l SLA breaches

l Display jobs that are related to a BIM service in a jobmonitoring view.

Note: This functionality is only available if you have purchased the optional add-on, Batch ImpactManager (http://www.bmc.com/products/control-m-batch-scheduling/batch-impact-manager.html).


of 17

http://www.bmc.com/products/control-m-batch-scheduling/batch-impact-manager.html

http://www.bmc.com/products/control-m-batch-scheduling/batch-impact-manager.html

Infrastructure Monitoring

Agent MonitoringTomonitor the Control-M agents, an instance of the plug-in needs to run on each server where the Agentruns. All of these plug-ins can communicate with an individual netprobe. The plug-in uses information fromthe Control-M configuration to display information about the Agents, and it uses the command line tool ag_ping to confirm that the agent can correctly communicate with the Control-M server.

Note: To reduce the load on the agent servers and the Control-M API, it is best to remove the job viewsfrom all the agent servers except one.

Server MonitoringWith the features available in the standard Geneos product, you are able tomonitor the whole schedulinginfrastructure and use themenu commands to go from a selected job to display metrics of the server onwhich the instance of that job is running.

We also provide a template to enablemonitoring of the Control-M database.


Geneos Control-M Plug-in Technical Reference v1.0

Documents

Transcript of Geneos Control-M Plug-in Technical Reference v1.0