Input Command Message

 



 

Overview

 

An Input command message is a message from an OS or other source (i.e., manager) to a Network Element (NE). (i.e., agent). The message requests the NE to perform some action. The TLI Agent Simulator supports to configure parameters defined in the TCS file for the Target Identifier, Access Identifier and Message Payload blocks.

 

This topic explains the different blocks which form the Input Command Message and the steps involved in configuring the TID, AID, and MPB parameter values. Users who are familiar with the TL1 message structure can skip the relevant contents in the topic.

 

Message Format

 

The general structure of a TL1 Input message is of the form.

 

<command_code>:[<targetidentifier>]:[<accessidentifier(s)>]:<correlationtag>:

[<general block>]:[<message_payload_block>];

 

Command Code

 

It determines the action to be taken at the NE as a result of receiving the input message. Each command must begin with a command code consisting of a mandatory verb followed by up to two optional identifiers,each separated by hyphen.

      <command code> ::= <verb>[-<modifier>[-<modifiers>]]

Verb identifies the action to be taken at the NE as a result of receiving a TL1 message from an OS. The command code modifiers are optional depending upon the specific command and application domain. The first modifier identifies where the action is to be applied in the NE. The second modifier may be used to further define the identity of the object upon which the action is to be taken.

 

For example, the command DLT-CRS-T0 will disconnect (DLT) one or more cross-connected (CRS) DS0 object entities (T0). The modifier CRS is further defined to identify T0 object entities.

 

Target Identifier Block

 

An input message associated with the management of a particular object may be directly addressed to an NE or it may be routed to or through one or more intermediate NEs. The Target Identification code (TID ) parameter block provides the capability within the TL1 message format to perform network routing tasks. The presence of the TID in all input commands is a requirement, but its value may be null (represented by two successive colons).

 

The TID block contains a single position-defined parameter that identifies the end-target NE to which the input command is directed. The value of TID may be any valid simple or compound TL1 identifier or text string limited to 20 characters.

 

Access Identifier Block

 

The Access IDentifier (AID) block normally contains one or more parameters that uniquely identifies the entity within the target NE to be acted upon by the input message. Typical examples of entities addressed by the AID parameter values are

Correlation Tag (CTAG)

 

It contains one position defined parameter to serve as a means of correlating an input command with its associated output response. The OS assigns an arbitrary non-zero CTAG value and it is the responsibility of the NE to copy this value into the output response associated with that input command. The value of CTAG must either be a TL1 identifier or a non-zero decimal number consisting of not more than six characters.

 

General Block (GB)

 

It includes support parameters whose values affect the way in which the input command is to be executed in the NE. The presence of GB in all input commands is a requirement but its value may be null (represented by two successive colons). The form of the General Block is

Delay Activation is a function whereby an input message may be stored in a message pending buffer at the NE for final execution at some later time. To simulate delayed response, refer to Simulating Random Variations in Response -> Simulate Delayed Response. The Delay Activation function is provided by a set of parameters within the GB of the form:

Contingency Flag parameter is a boolean data type within the GB that indicates,when set true, a dependent relationship among the several records specified in the AID data block of a multi-unit command. If CF is false,partial installation of the records in a multi-unit message may be completed with a report sent to the OS listing the records that were not successfully installed in a database.

 

Indirect Data Retrieval Indicator is a functional capability by which information may be retrieved from more than one linked administrative view by a single RTRV command.

 

Message Payload Block (MPB)

 

This block indicates the subject matter of the message. This section may consists of zero or more data blocks in the form (:<Px>(,<Px>)*)*; where Px represents a data item. Each data block is delimited by colons (:) and the last terminated by a semicolon (;).

 

Each data block may have an unlimited number of data items,each delimited by commas (,). The data items within a data block may be either name-defined ( <keyword>=<value> ) or position-defined where values are specified and the keyword is implied by its position in the data block.

 

The semi-colon character (;) terminates a TL1 input message. This is required for all TL1 message types.

 

Configuring Values for Input Command Message

 

Configuring Target Identifier (TID)

 

To configure TID,

Configuring Access Identifier (AID)

 

The AID Block parameter values can be configured only if AID block is defined in the TCS file, for the input message.

 

To configure Access Identifier Parameters, do the following :

  1. Select the required command code from the loaded command set file ( as .tcs file or .prp configuration file format ).

  2. If the command code allows configuration of new Access Identifiers, the Add button in the AID field is enabled.

  3. Click Add to configure the AID value. The Configure Access ID dialog is displayed with the Param Name and Param Type.

  4. Specify the AID value for the Param Name and click OK.

 

Configuring Message PayLoad Block (MPB)

 

The Message Payload block parameter values can be configured in the simulator, only if this block is defined in the TCS file, for the input message. To configure Message Payload Block, do the following :

  1. Select the required command code from the loaded command set file ( as .tcs file or .prp configuration file format ).

  2. Select the Access Identifier (AID) , if any, configured for the selected command code.

  3. If the command code allows configuration of Message Payload block, the Add button in the Message Payload field is enabled.

  4. Click Add to configure the Message Payload values. The Configure Message Payload Block dialog is displayed with the Param Name and Param Type.

  5. Specify the message payload value for the Param Name and click OK.

 

Deleting AID and MPB Values

 

To Delete an AID value, do the following :

  1. Select the required command code from the loaded command set file ( as .tcs file or .prp configuration file format ).

  2. If the command code allows configuration of AID values, the AID field on the right-hand side gets enabled.

  3. Select the AID to be deleted from the list. Click Delete to delete the Access Identifier.

 

To Delete a Message Payload value, do the following :

  1. Select the required command code from the loaded command set file ( as .tcs file or .prp configuration file format ).

  2. Select the message payload block value to be deleted from the list and click Delete.



Copyright © 1996-2006, AdventNet Inc. All Rights Reserved.