Vertivâ„¢ NetSureâ„¢ Control Unit (NCU) User Manual
RETRIEVE-ALARM
(RTRV-ALM-{EQPT|ALL})
Referenced In: TR-NWT-000833, Issue 5; pg. 4-205
General Description: Instructs the NE (NCU) to send the current state of its alarm conditions associated with one or more
equipment units, facilities, etc. within the NE (NCU).
NCU Access Level: any access level
Input Format:
RTRV-ALM-{EQPT|ALL}:
[<tid>]:<aid>:<ctag>::[<ntfcncde>],[<condtype>], [<srveff>],[<locn>],[<dirn>][,<tmper>];
NOTE!
The command code modifier of COM is not supported. If specified, an error response with the error code ICNV is
returned.
<aid>
A value of ALL requests retrieval of alarm conditions for all AIDs of the type defined by the command code modifier.
Use of the command code modifier ALL results in retrieval of all alarm conditions in the NE (NCU).
If the command code modifier is ALL, the <aid> must be ALL. A <null> value is not permitted for this parameter.
<ntfcncde>
This is the notification code associated with the alarm conditions being retrieved. Valid values for this parameter are as
follows:
CR critical alarm
MJ major alarm
MN minor alarm
<null> request retrieval of alarm conditions for all of the above codes
<condtype>
This is the condition type of alarm conditions to be retrieved. A <null> value causes all conditions classified as alarm
conditions to be retrieved.
<srveff>
This is the effect on service caused by the alarm condition. Valid values for this parameter are as follows:
SA service-affecting condition
NSA nonservice-affecting condition
<null> request retrieval of alarm conditions for both of the above codes
<locn>
This is the location of the alarm condition. This parameter does not apply to this application. A <null> value is the only
value which is accepted for this parameter. If any other value is received for this parameter, an error response is
returned with the error code INUP.