User manual

Wide Bank 28 DS3 - Release 2.4 July 2004 9-53
TL1 Commands and Messages
TL1 Command List
RTRV-ALM-ENV
Name: Retrieve Alarm Environment
Purpose: Retrieves active environment alarms. For facility alarms, see RTRV-ALM-<AIDType>
on page 9-51.
Purpose:
Category: Transport Surveillance Commands
Security: R
Syntax: RTRV-ALM-ENV:[<tid>]:[<envAid >]:[<ctag>]::
[<ntfcncde>],[<almtype >];
Example: RTRV-ALM-ENV:tid::ctag::;
Retrieve All Environment Alarms.
Example: RTRV-ALM-ENV:tid:EXT48V-A:ctag::;
Retrieve Alarms for a Specific AID.
Example: RTRV-ALM-ENV:tid:FAN-A:ctag::,MJ,CLFAN;
Retrieve a Specific Alarm.
Response Format:
<cr> <lf> <lf>
^^^<tid>^YYYY-MM-DD^HH:MM:SS <cr> <lf>
M^^<ctag>^COMPLD <cr> <lf>
(^^^"<aid>:<ntfcncde>,<almtype>,[<ocrdat>],[<ocrtm>]
[,<almmsg>]" <cr> <lf>)*
;
* - the contents of the parentheses can occur zero or more times.
Field Description
almtype Type of alarm. See Condition Type <condtype> on page 9-87. Null
value defaults to ALL
ctag Correlation Tag (optional)
envAid Environmental Access ID. See Environment Access Identifier
(EnvAID) on
page 9-91. Null value defaults to ALL
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)