Using Built-in Commands

 

 

Overview

 

Built-in Commands are provisioning input commands common to all OS/NE interfaces. They are commonly used input commands that have already been implemented in the TL1 Agent. Some General Built-in Commands as well as Built-in Commands for Delayed Activation have already been implemented in the TL1 Agent and are available in the tl1builtincommand.tcs file. This file can be loaded in the TL1CraftInterface tool to query any running agent.

 

Built-in Commands in TL1 Agent

 

The TL1 Agent supports six general Built-in Commands and three Built-in Commands for Delayed Activation. You can use these commands to query the TL1 Agent from the TL1 Craft Interface.

 

The TL1 Agent supports the following general Built-in Commands.

The TL1 Agent supports the following Built-in Commands for Delayed Activation feature.

Using General Built-in Commands

 

Following are the General Built-in commands that are available in 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 Built-in commands, make sure you do the following:

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

  2. Connect to the Agent at the specified port 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". For more information on Authentication, refer to "Configuring Security".  

 

After executing the above command successfully, you can start using the general Built-in commands that are available in the tl1builtincommands.tcs as explained.

 

1. Command To Inhibit Autonomous Message

 

The syntax for this Built-in Command is as follows:

 

INH-AUTMSG:::<ctag>::;

 

When this Built in Command is executed, the agent stops sending Autonomous messages. All the Autonomous Messages generated after executing this command will be stored in the memory and will not be displayed.

 

E.g.: INH-AUTMSG:::4::;

 

2. Command To Allow Autonomous Messages

 

The syntax for this built-in command is as follows:

 

ALW-AUTMSG:::<ctag>::;

 

This Command generally follows Inhibit Autonomous Message Command. After execution of this command, the agent will start sending Autonomous Messages that were initially stopped using the Inhibit Autonomous Message Command.

 

E.g.: ALW-AUTMSG:::5::;

 

3. Command To Clear Autonomous Messages

 

The syntax for this built-in command is as follows:

CLR-ALARM:::<ctag>::;

 

This Command is used to clear all the Autonomous messages that are collected in the memory as a result of execution of Inhibit Autonomous Message Command. The execution of this command usually follows Inhibit Command.

 

For example, you  may initially want to stop receiving Autonomous Messages, for which you may execute the Inhibit Autonomous Message Command. Then after a while, you may want to view only the Autonomous Messages  from a given time, i.e., you may not need the previously generated Autonomous Messages. Under such circumstances, you can execute the Clear Autonomous Message command followed by Allow Autonomous Message Command.

 

E.g.: CLR-ALARM:::6::;

 

4. Command To Set the Source Identification String

 

The syntax for this built-in command is as follows:

 

SET-SID:::<ctag>::<INPUT SOURCE ID STRING>;>

 

This Built-in Command is used for setting the source identification string. The default value "machine name" can be replaced by a string of your choice using this string. Source identifier resets output and autonomous message header. It identifies the NE from where output and autonomous messages are coming.

E.g.: SET-SID:::7::System;

 

The above example  sets "System" as the source identification string.

 

5. Command To Get the List of Built-in Commands

 

The syntax for this built-in command is as follows:

GET-CMD-BLTIN:::<ctag>::;

 

This Command lists all the available Built-in Commands.

Example Request:

GET-CMD-BLTIN:::1::;

 

Example Response:

 

 

6. Command To Get the List of All Registered Commands.

 

The syntax for this built-in command is as follows:

GET-CMD-REG:::<ctag>::;

 

This Command Lists all the Commands that are registered with the agent. This includes the registered Built-in Commands as well as the Commands that are specific to the TCS file.

 

Using Delayed Activation Built-in Commands

 

The TL1 Agent supports the following Built-in Commands for Delayed Activation feature:

These commands are available in the tl1builtincommands.tcs file. Before testing the examples for Built-in 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 Built-in commands that are available in the tl1builtincommands.tcs as explained. Please note that Delay Activation of messages is session specific. Retrieving, Activating, and Canceling of Delayed Activation of Messages are also session specific.

 

Please note that Delay Activation of messages are session specific. Retrieving, Activating and Canceling of Delayed Activation of Messages are also session specific.

 

1.Command To Activate Delayed Activation

 

The syntax for this command is as follows:

ACT-DA::[ALL|ORDNUM]:<ctag>::;

 

This command executes the input message, which is stored in a message pending buffer for manual activation. This can also be called as Delayed Manual Activation.

 

By specifying ALL in the AID part of the command, all the pending messages in the buffer will be executed and corresponding responses will be sent immediately.

E.g.:ACT-DA::all:26::;

 

The above example activates all commands that were delayed activation and sends the processed response.

When ORDNUM, i.e., order number is specified in the AID part of the command, the input message for the corresponding order number alone will be executed and response will be sent.

E.g.: ACT-DA::3:26::;

 

The above example activates the command with Order Number as 3 that was delayed activation and sends the processed response.

 

2. Command To Cancel Delayed Activation

 

The syntax for this command is as follows:

CANC-DA::[ALL|ORDNUM]:<ctag>::;

 

Using this Command, the Delayed activation of the input message that was initially stored in a Message Pending buffer for execution at a later time can be canceled. This input command deletes the input message from the message pending buffer.

 

By specifying ALL in the AID part of the command, all the pending messages in the buffer are deleted.

E.g.:CANC-DA::all:26::;

 

The above example cancels the execution of all commands that were delayed activation.

 

When ORDNUM, i.e., order number is specified in the AID part of the command,  the input message for the corresponding order number alone will be deleted from the message pending buffer.

E.g.:CANC-DA::3:26::;

 

The above example cancels the execution of the command with Order Number as 3 that was delayed activation.

 

3. Command To Retrieve Delayed Activation

 

The syntax for this command is as follows:

 

RTRV-DA::[ALL|ORDNUM]:<ctag>::TTYPE=TIME/MANUAL,TTIMEGE=yy-mm-dd-hh-mm, TTIMELE=yy-mm-dd-hh-mm;

 

Execution of this command lists the pending input messages in the buffer for Delayed Activation.

The AID part of the command is compulsory.

 

By specifying ALL in the AID part of the command, all the pending messages for Delayed Activation in the buffer gets retrieved and listed. The MPB list is keyword defined.

E.g., Request Sent:

RTRV-DA::all:::;

 

E.g., Response:

 

 

The above examples retrieves the all the commands that were Delayed activation.

 

When ORDNUM, i.e., order number is specified in the AID part of the command,  the input message for the corresponding order number alone gets retrieved from the message pending buffer and listed.

E.g., Request Sent

RTRV-DA::1:23::;

 

E.g., Response

 

 

TTYPE, TTIMEGE, and TTIMELE are the Message Payload block parameters for which values can be passed. These are optional inputs. One, two, or all the three MPB parameters can be passed as input along with any one of the AIDs. This helps in retrieving the required Input message quickly.

 

TTYPE is the target type, which can be Manual Delayed Activation input message or Automatic Delayed Activation input message. TTYPE can be MANUAL, or TIME, or BOTH.

 

TTIMEGE is the equal to or greater than time for which pending input message is to be retrieved and listed.

 

TTIMELE is the equal to or lesser than time for which pending input message is to be retrieved and listed.

 

TTIMEGE and TTIMELE are applicable only when  TTYPE is specified as TIME.

E.g., Request

 

RTRV-DA::all:25::TTYPE=TIME, TTIMEGE=02-01-08, TTIMELE=02-01-09;

E.g., Response

 

 

 

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