IBM Support

ITM Agent Insights: A Command Return Code agent using Agent Builder

Technical Blog Post


ITM Agent Insights: A Command Return Code agent using Agent Builder


The following post will help you create a Command Return Code agent using Agent Builder. The following guide will provide you the step-by-step instructions needed to create the agent using the exact options captured using screenshots. The agent created in the example was on a Windows server but the same logic can be used to create an agent on a Unix based platform. 


Creating A Command Return Code Agent in Agent Builder

  1. Run Agent Builder as Administrator
  2. Select create new agent.
  3. Once at the Data source selection screen go to Command or Script and select A command return code

  4. Once on the next screen you will want to have a .bat file ready to use.  For this example, we will be using batchfile.bat. For this case I have created a bat file which just echos a couple of servers and provides the output. The hidden piece includes the IP Addresses for the servers used in this example. 
  5. image
    Once created go back to agent builder put a proper display name. In this example batchfile.bat is used for the display name. Next click add under the commands header. 
  6. image
    From here you want to add the file into the command files and put the name of .bat file in the command line bar. Lastly add the return codes. You can use pretty much any numbers you want but just follow example just in this case. 
  7. image
    Click OK and Finish
  8. Now if you have Agent Test already running then you will not need to do this next part
    1. If its not up then go to the top right corner of your agent builder screen there should a bar that you can type in that says Quick access.  Type agent test in there. 

    2. Select the one that says Views is the correct one. 
    3. Then a screen should pop up on the left hand side.
  9. The screen should be on the left had side and look something like this screen shot.  Click on your Agent you want to start and click the green arrow to start it.

  10. In this example start A Command Return Code Agent. Then click on the cylinder that says Availability. 
  11. At the bottom of the screen you should see Attribute Group Test.  With the attributes filled out like the screen shot below.
    NOTE: If it’s not at the bottom of the screen go to the Agent information tab and click test agent

  12. From here in the Attribute Group Test it should look like the screen shot below

  13. After this step click complete and save.
  14. You can go on and create the agent files along with the application support files and install the agent and application support on the TEMS/TEPS server.


The steps listed above should help you create the required agent.


Additional ITM Agent Insights series of IBM Tivoli Monitoring Agent blogs are indexed under ITM Agent Insights: Introduction.


Tutorials Point

Subscribe and follow us for all the latest information directly on your social feeds:



Check out all our other posts and updates:

Academy Blogs
Academy Videos
Academy Google+
Academy Twitter



[{"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Product":{"code":"","label":""},"Component":"","Platform":[{"code":"","label":""}],"Version":"","Edition":"","Line of Business":{"code":"","label":""}}]