Using Self-Monitoring

 

 

Overview

 

Self-Monitoring enables the TL1 Agent to monitor the Agent details, such as the number of requests received, number of responses and autonomous messages sent, etc. The Agent details are automatically updated and monitored by the TL1 Agent and their values can be retrieved, whenever you require, by sending the appropriate input messages.

 

Parameters That Can Be Monitored

 

The Self Monitoring feature allows the TL1 Agent to monitor the following agent parameter details:

These parameters are automatically updated and monitored by the TL1 Agent and their values can be retrieved, whenever you require, by sending the appropriate input command messages.

 

Using Self-Monitoring Commands

 

Following are the commands that are available for Self-Monitoring of the TL1 Agent. These commands are available in the tl1builtincommands.tcs file.

 

Note:

Please note that since the commands in the tl1builtincommands.tcs  file has already been implemented, it should not be loaded in the TL1 Agent Simulator for simulating values.

 

Before testing the examples for Self-Monitoring commands, make sure you do the following:

  1. Run the simulated TL1 Agent at a specified Port.

  2. Connect to the Agent using the TL1CraftInterface.

  3. Load the TCS for which the Agent was created, tl1security.tcs, and tl1builtincommands.tcs in the TL1CraftInterface.

  4. Expand the tl1security.tcs tree and select ACT-USER command.

  5. Authenticate into the TL1 Agent by sending the Input command "ACT-USER::root:1::public;". Here, the user is the "root" ( the administrator) and the password is "public". Please refer to Testing the TL1 Agent for more information on Authentication.

After executing the above command successfully, you can start using the Self-Monitoring commands that are available in the tl1builtincommands.tcs as explained in the following sections.

 

1. Command for Getting Count of Input Requests Received

 

This Self-Monitoring command gets the count of the number of Input Request messages that were received by the Agent from the Clients.

 

The Syntax of the Input Command is as follows:

 

GET-SM-MSGIN:::<CTAG>::;

 

Example Request: GET-SM-MSGIN:::11::;

 

The Response Message for the above input command appears as shown below:

2. Command for Getting the Count of Autonomous Messages Sent

 

This Self-Monitoring command gets the count of the number of Autonomous Messages sent by the Agent. The Syntax of the Input Command is as follows:

 

GET-SM-ALRMSENT:::<CTAG>::;

 

Example Request:

 

GET-SM-ALRMSENT:::12::;

 

The Response Message for the above input command appears as shown below:

3. Acknowledgment Messages Sent

 

This Self-Monitoring command gets the count of the number of Acknowledgment Messages sent by the Agent for the request messages received from the Clients. The Syntax of the Input Command is as follows:

 

GET-SM-MSGACK:::<CTAG>::;

 

Example Request: GET-SM-MSGACK:::13::;

 

The Response Message for the above input command appears as shown below:

4. Delayed Activation Messages

 

This Self-Monitoring command gets the number of pending input request messages (i.e., delayed activation messages) which require processing to send responses at a later stage. In other words, this Self-Monitoring command gets number of Delay activation messages that are to be processed and responded to the Client at a later stage.

 

The Syntax of the Input Command is as follows:

 

GET-SM-MSGDA:::<CTAG>::;

 

Example Request: GET-SM-MSGDA:::14::;

 

The Response Message for the above input command appears as shown below:

5. Output Responses

 

This Self-Monitoring command gets the number of Output Response Messages that have been sent by the Agent. The Syntax of the Input Command for getting the value of this parameter is as follows:

 

GET-SM-MSGOUT::<CommandcompletionCode>:<CTAG>::;

 

Example Request: GET-SM-MSGOUT::COMPLD:15::;

 

The Response Message for the above input command appeara as shown below:

The above input command gets and displays the number of Output Response Messages that were processed and sent successfully. The following is the syntax for the Input Command for getting and displaying the number of Output Messages for the input messages that were partially completed:

 

GET-SM-MSGOUT::PRTL:<CTAG>::;

Example Request: GET-SM-MSGOUT::PRTL:17::;

 

The Response Message for the above input command appears as shown below:

The following is the syntax for the Input Command for getting and displaying the number of Input Messages that were denied successful execution:

 

GET-SM-MSGOUT::DENY:<CTAG>::;

 

Example Request: GET-SM-MSGOUT::DENY:17::;

 

The Response Message for the above input command appears as shown below:

The following is the syntax for the Input Command for getting and displaying the number of Output Messages that were sent for the input retrieve commands that were sent to retrieve from the NE:

 

GET-SM-MSGOUT::RTRV:<CTAG>::;

 

Example Request: GET-SM-MSGOUT::RTRV:20::;

 

The Response Message for the above input command appears as shown below:

The following is the syntax for the Input Command for getting and displaying the number of Output Messages that were delayed processing and queued up in the processing queue:

 

GET-SM-MSGOUT::DELAY:<CTAG>::;

 

Example Request: GET-SM-MSGOUT::DELAY:11::;

 

The Response Message for the above input command appears as shown below:

Copyright © 2012, ZOHO Corp. All Rights Reserved.
Network Monitoring Software from ManageEngine