Commands supported by the probe over Telnet

You can use the CLI to update the SpectroSERVER fields listed in the following table.
Table 1. SpectroSERVER fields

SpectroSERVER field

Description

Acknowledged

This field indicates whether the alarm has been acknowledged by a CA Spectrum operator.

AlarmStatus

This field indicates the status of the corrective action.

EventIDList

This field lists all the CA Spectrum events that resulted in the alarm.

Troubleshooter

This field shows the name of the troubleshooter.

TroubleshooterModel

This field identifies the type of the troubleshooter.

TroubleTicketID

This field contains the trouble ticket number for an alarm.

The following table describes the commands that the probe supports over Telnet. The spectrumName parameter used by the CLI commands requires the name of the SpectroSERVER host as specified by the Name attribute of the SpectroServer property in the host configuration file. The alarmID parameter must be given in hexadecimal format.

Table 2. Commands supported over Telnet

Command

Description

acknowledgeAlarm alarmIds

Use this command to acknowledge one or more alarms, where alarmIds is a comma-separated list of identifiers of the alarms that you want to acknowledge.

exit/quit

Use this command to close the connection.

help

Use this command to display online help about the CLI.

resync

Use this command to perform a resynchronization using the values specified by the ResyncSeverityFilter and ResyncProbableCauseFilter properties.

resyncFilter filter

Use this command to perform a resynchronization using a custom filter.

Custom filters take the following format:

resyncFilter sev=severity1;severity2; pbCause=pbCause1;pbCause2;

To perform a full resynchronization, use the following command:

resyncFilter sev= pbCause=

Note: This command does not accept spaces in the sev and pbCause arguments. If you want to use a filter that contains spaces, you must use the ResyncSeverityFilter and ResyncProbableCauseFilter properties.

stop

Use this command to shut down the probe.

unacknowledgeAlarm alarmIds

Use this command to unacknowledge one or more alarms, where alarmIds is a comma-separated list of identifiers of the alarms that you want to unacknowledge.

version

Use this command to print the version of the probe.

CLI scripts

Because the CLI uses Telnet connections, you can connect to the probe from anywhere by creating a desktop tool to open a Telnet connection, send a command, and then close the connection. This means that simple scripts can be set up to allow users to acknowledge selected events from the Netcool/OMNIbus Event List.