Command line interface

The probe is supplied with a Command Line Interface (CLI). This interface allows you to execute commands using the probe to acknowledge alarms or request a full resynchronization.

To use the CLI, you must use the CommandPort property to specify a port through which commands will be sent. The default port is 6970. When you want to issue commands, use Telnet to connect through this port.

Note: If there is a firewall between the probe and the ZTE EMS, keep the following ports open: TCP 21115, TCP 21126, and TCP 21111.

The following table describes the commands that you can use with the CLI.

Table 1. CLI commands
Command	Description
exit/quit	Use this command to close the connection.
help	Use this command to display online help about the CLI.
resynch_all	Use this command to perform a full resynchronization with the 3GPP interface. Resynchronization using the command line is only possible when the Resynch property is set to true.
resynch_filter `filter`	Use this command to perform partial resynchronization with the 3GPP interface. This command uses the filter specified by the AlarmFilter property as a parameter.
userid_acknowledge_alarm `alarm_id` `user_id`	Use this command to acknowledge an alarm in the 3GPP interface by specifying the `NV_ALARM_ID` identifier of the alarm and the user identifier of the user acknowledging the alarm. Before using this command, you must specify a value for the AckSystemId property.
userid_unacknowledge_alarm `alarm_id` `user_id`	Use this command to unacknowledge an alarm in the 3GPP interface by specifying the `NV_ALARM_ID` identifier of the alarm and the user identifier of the user acknowledging the alarm. Before using this command, you must specify a value for the AckSystemId property.
userid_clear_alarm `alarm_id` `user_id`	Use this command to clear an alarm by specifying the `NV_ALARM_ID` identifier of the alarm and the user identifier of the user acknowledging the alarm. Before using this command, you must specify a value for the ClearSystemId property.
userid_comment_alarm `alarm_id` `user_id` `commentText`	Use this command to add comments to an alarm by specifying the `NV_ALARM_ID` identifier of the alarm, the user identifier of the user making the comment, and the text of the comment. Before using this command, you must specify a value for the CommentSystemId property.
version	Use this command to display 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 IBM® Tivoli® Netcool/OMNIbus event list.