Command line interface

The probe is supplied with a Command Line Interface (CLI). This interface enables you to execute commands to acknowledge alarms and update fields in the SpectroSERVER.

To use the CLI, you must use the CommandPort property to specify a port through which commands will be sent. The default port is 7777. When you want to issue commands, use Telnet to connect through this port. You can use the CommandPortLimit property to limit the number of Telnet connections that the probe can make at one time.

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.

You can use Netcool/OMNIbus automations to reflect SpectroSERVER field updates in the corresponding ObjectServer fields. For more information about using automations, see the IBM Tivoli Netcool/OMNIbus Administration Guide (SC14-7605).

CLI commands

The following table describes the commands that you can use with the CLI. 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. CLI commands
Command	Description
acknowledgeAlarm `alarmID` `spectrumName`	Use this command to acknowledge an alarm by specifying the alarm identifier and the SpectroSERVER host name.
unacknowledgeAlarm `alarmID` `spectrumName`	Use this command to unacknowledge an alarm by specifying the alarm identifier and the SpectroSERVER host name.
clearAlarm `alarmID` `spectrumName`	Use this command to clear an alarm by specifying the alarm identifier and the SpectroSERVER host name.
resync `spectrumName`	Use this command to resynchronize a SpectroSERVER.
updateStatus `alarmID` `status` `spectrumName`	Use this command to update the status of an alarm by specifying the alarm identifier, the new status, and the SpectroSERVER host name.
updateTroubleShooterName `alarmID` `name` `spectrumName`	Use this command to update the troubleshooter name of an alarm by specifying the alarm identifier, the new troubleshooter name, and the SpectroSERVER host name.
updateTroubleTicket `alarmID` `ticketID` `spectrumName`	Use this command to update the trouble ticket number for an alarm by specifying the alarm identifier, the new ticket identifier, and the SpectroSERVER host name.
updateTroubleShooterModel `alarmID` `model` `spectrumName`	Use this command to update the troubleshooter type of an alarm by specifying the alarm identifier, the new troubleshooter type, and the SpectroSERVER host name.
updateEventList `alarmID` `eventIDList` `spectrumName`	Use this command to update the event list of an alarm by specifying the alarm identifier, the event list identifier, and the SpectroSERVER host name. Note: This command feature is currently unavailable. For details, see Known issues.

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 IBM Tivoli Netcool/OMNIbus event list.