Chapter 2 TL1 Reference
TL1 Command and Response Conventions
26
SSU-2000e Technical Reference
12713140-003-2 Revision E.01 – January 2007
;
indicates the end of the message
<cr>
and
<lf>
or
<cr lf>
indicate the ASCII carriage return (CR) and line feed
(LF) codes used as a line terminator and may be used separately or combined
The ASCII cancel code character (hex 18) can be used to cancel a partially sent
command and clear the input buffer.
Input Command Message Conventions
Command messages entered and sent by the user determine the action that the
SSU-2000e will take. Command messages are input messages, and are always
followed by an acknowledgment or output response message.
The format for the input command message is:
cmd:tid:[aid]:ctag[:[gb]:<other>;<cr lf>
where:
cmd
(Command) is a descriptive string of letters that represents the input
command. The command string consists of a standard TL1 command verb,
followed by one or two command modifiers. The modifiers identify the subject of
the command verb and each may be as many as five characters. If two modifiers
are used, they must be separated by dashes:
verb- mod1- mod2
.
tid
(Target Identifier) represents the name assigned to the SSU-2000e. The
assigned name must be either null or match the name assigned to the
SSU-2000e. If the tid is not null, it may must begin with a letter and may contain
up to 20 alphanumeric characters see
.
aid
(Access Identifier) is an optional field that represents the shelf, module, and
port within the SSU-2000e to which the command is addressed or to which the
response applies. The aid must be null (
::
, indicating ALL or not used), ALL
(indicating all modules and ports related to the command type), or the aid
assigned to an entity in the SSU-2000e.
Follow these conventions for entering the aid field:
SxAy-z
or
ALL
where:
S
placeholder to indicate Shelf number
x
SSU-2000e main (1) or expansion shelf (2-5) number
A
placeholder to separate the shelf number form the slot position
y
slot position (1-16)
z
port number (1-20)
ALL
all modules or ports to which the command applies
Note:
The SSU-2000e does not generate a response for entries
without a valid tid.