Elements

The probe breaks event data down into tokens and parses them into elements. Elements are used to assign values to ObjectServer fields; the field values contain the event details in a form that the ObjectServer understands.

The following table describes the elements that the probe generates. Not all the elements described are generated for each event. The elements that the probe generates depend on the event type.

Table 1. Elements
Element name	Element description
`$Acknowledged`	This element indicates if the alarm has been acknowledged by a CA Spectrum operator.
`$AlarmID`	This element contains the identifier of the alarm. The probe sends this element to the rules file as a zero-padded 8-character hexadecimal string. Note: The alarm ID changes when an event fails over to a secondary SpectroSERVER.
`$AlarmStatus`	This element displays the status of the alarm.
`$AlarmSource`	This element indicates the source of the alarm. The following values are currently supported: 0: specifies that the alarm is current. 1: specifies that the alarm is residual from a previous run of the SpectroSERVER.
`$ClearMe`	This element indicates whether the event is a resolution event. A value of true sets the ObjectServer field `@Type` to 2 in the rules file. This indicates that it is a resolution event.
`$CauseNum`	This element shows the probable cause number of the event. The probe sends this element to the rules file as a zero-padded 8-character hexadecimal string.
`$ClearedBy`	This element contains the user name associated with the user who cleared the alarm through the CA Spectrum API. This element is not present when an alarm is created but it is added prior to removal.
`$CreationDate`	This element contains the date when the alarm was generated.
`$DomainID`	This element contains the domain ID of the SpectroSERVER.
`$EventIDList`	This element contains the list of SpectroSERVER event identifiers that triggered the alarm.
`$IPAddress`	This element contains the IP address of the reporting node.
`$ModelHandle`	This element contains a model handle. A model handle is a 32-bit number in which the high-order 12 bits make up the landscape and the remaining 20 bits make up the model identifier.
`$ModelID`	This element shows the identifier of the model.
`$ModelName`	This element contains a description of the model.
`$ModelType`	This element shows the type of the device that raised the alarm.
`$Occurrences`	This element shows the number of times that the event has occurred.
`$PrimaryAlarm`	This element indicates the priority of the alarm in the SpectroSERVER. A value of true identifies the alarm as a primary alarm. Primary alarms have the highest priority.
`$Pre-existing`	This element indicates whether the received event is already present in the SpectroServer.
`$Primary`	This element indicates whether the probe is connected to a primary SpectroSERVER or to a secondary SpectroSERVER. A value of false indicates that the probe is connected to a secondary server.
`$Priority`	This element indicates the priority in the SpectroSERVER.
`$Severity`	This element indicates the severity of the alarm in the SpectroSERVER.
`$TroubleShooter`	This element displays the name of the specified troubleshooter. This element maps to the `TroubleShooter` SpectroSERVER field, which can be updated using the `updateTroubleShooterName` CLI command.
`$TroubleShooterModel`	This element displays the model type of the specified troubleshooter. This element maps to the `TroubleShooterModel` SpectroSERVER field, which can be updated using the `updateTroubleShooterModel` CLI command.
`$TroubleTicketID`	This element displays the identifier of the trouble ticket associated with an alarm. This element maps to the `TroubleTicketID` SpectroSERVER field, which can be updated using the `updateTroubleTicket` CLI command.
`$UserClearable`	This element indicates whether or not a client can clear the alarm. This element is provided so that client applications can indicate to users that the alarm is not clearable. A client cannot control whether an alarm is clearable.