User manual

Wide Bank 28 DS3 - Release 2.4 July 2004 9-51
TL1 Commands and Messages
TL1 Command List
RTRV-ALM-<AIDType>
Name: Retrieve Alarm
Purpose: Displays active facility alarms. For environmental alarms, see RTRV-ALM-ENV on
page 9-53.
Category: Transport Surveillance Commands
Security: R
Syntax: RTRV-ALM-{T3|T1|E1|EQPT}:[<tid>]:[<aid>]:[<ctag>]::
[<ntfcncde>],[<condtype>];
Example: RTRV-ALM-T3:tid:DS3-A:ctag::CR,LOS;
Retrieves Critical LOS alarm on DS3-A.
Response Format:
<cr><lf><lf>
^^^<tid>^<YYYY-MM-DD>^<HH:MM:SS><cr><lf>
M^^<ctag>^COMPLD<cr><lf>
(^^^"[<aid>]:<ntfcncde>,<condtype>,<srveff>,[<ocrdat>],
[<ocrtm>],[<locn>],[<dirn>],[:[<conddescr>],[<aiddet>]"
<cr><lf>)*
;
* - the contents of the parentheses can occur zero or more times.
Example: RTRV-ALM-T3:tid::ctag;
Retrieve all Active DS3 Alarms.
Field Description
aid Access ID depends on AIDType:
For T3, use DS3-A or DS3-B or ALL
For T1, use DS1-1 to DS1-28, or ALL
For E1, use E1-1 to E1-27, or ALL
For EQPT, see Access Identifier <aid> on
page 9-84
Null value defaults to ALL
condtype Type of alarm or condition. See Condition Type <condtype> on
page 9-87. Null value defaults to ALL.
ctag Correlation Tag (optional)
ntfcncde Severity or class of alarm, event or condition. See Notification Code
<ntfncde> on
page 9-96. Null value defaults to ALL.
tid
Target ID of network element (optional)