3.4 TL1 Response Message
TL1 response message, its structure,
and syntax are discussed in detail here.
Response is an output message sent
by the NE to OSS on completion of the task requested by the TL1 input message.
It may be preceded by an acknowledgment message. A simple response message
confirms the outcome of the requested task or operation. It says whether
the requested task was completed successfully or not. A complex response
message, in addition to giving the status of the task, includes data in
the message.
TL1 response message takes the following
format
header response_id
[response_block] terminator
3.4.1 Response Header
Response message’s header block take
the following form:
^^^sid^year-month-day^hour:min:sec
Here, SID is the source identifier,
year-month-day and hour:min:sec represent the date and time of the message.
SID
Source identifier represents the
name of the NE used for identifying the NE emitting the message. SID is
similar to the target identifier.
3.4.2 Response ID
Response ID identifies the type of
output message - whether it is a response or an autonomous message. Response
Id takes the following format
M^^ctag^completion_code
- M - used to differentiate
between response and autonomous message
- ctag - indicates the correlation
tag assigned with the input message.
- completion code - indicates
the status of the task - whether it is completed successfully or not.
|
Completion Code Type
|
Parameters
|
| Success response code |
COMPLD - indicates successful completion of the requested
operation.
DELAY - indicates successful delayed activation of
the requested operation. |
| Other response code |
DENY - indicates failure of the TL1 command and provides
an error message with the reason for the failure.
PRTL - indicates partially successful response. That is,
the requested action can be completed for some of the specified AIDs, but
not all.
RTRV - indicates that the response is successful,
but it is lengthy and is being returned in multiple parts. Final response
has a COMPLD response code. |
Error Categories
Whenever a TL1 command fails, the
response message contains the failure code. Following are the failure codes
EXXX - Equipage errors
FXXX - Fault errors
IXXX - Input errors
PXXX - Privilege errors
RXXX - Resource errors
SXXX - Status errors
3.4.3 Response Block
TL1 output messages contain text
blocks. These text blocks hold the main body of the output message and
the payload. In response messages, these text blocks are called response
blocks. Response block have quoted lines, unquoted lines, and comments.
An unquoted line is made up
of a list of parameters (either name defined or position defined) separated
by mandatory white spaces or optional commas.
A quoted line consists of
a double quoted (") line of machine parsable text.
A comment allows free form
text messages to be generated by the NE for presentation to the OS. The
comment must begin with /* and end with */.
3.4.4 Terminators
Syntax of terminators : <cr><lf>(
; | > )
The semicolon (;)indicates the termination
of output messages and greater than (>) character indicates more output
associated with this response will follow under another header. The size
of the output message should not exceed 4096 bytes. If it exceeds the specified
size, then the output response is split into multiple responses with the
same CTAG.
3.4.5 Examples for TL1 response
messages:
|
TL1 Input Message
|
Corresponding Response
|
| RTRV-USER-SECU::root:12::; |
<CR>
<LF><LF> Source 02-01-09 20:25:02<CR>
<LF>M 12 RTRV<CR>
<LF> "UID=root:CID=TCP&CRAFT,UAP=1:PAGE=60,PCND=7,
PCNN=3,POINT=180,UOUT=90,LSTOI=1"<CR>
<LF>; |
| ENT-TCPRE:GNE1::4::NE3, 192.168.1.1,9090; |
<CR>
<LF><LF> System 02-01-11 19:30:43<CR>
<LF>M 4 COMPLD<CR>
<LF>; |
| ACT-USER::root:4::public; |
<CR>
<LF><LF> Source 02-05-06 14:26:12<CR>
<LF>M 4 COMPLD<CR>
<LF> "UID=root:LASTLOGIN=Mon May 6 14:25:13
2002,UNSUCCESSATTEMPTS=0"<CR> <LF>; |
| ENT-CRS-STS1::STS-4-3, STS-2-1:43:; |
Error Message
<CR>
<LF><LF> Source 02-05-06 14:30:42<CR>
<LF>M 4 DENY<CR>
<LF> EANS<CR>
<LF> "ACCESS NOT SUPPORTED"<CR>
<LF>; |
Download PDF (zipped)