Command Line Interface

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

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. You can use the CommandPortLimit property to limit the number of Telnet connections that the probe can make at one time.

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

Table 1. CLI commands

Command

Description

exit

quit

Use these commands 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 CORBA interface.

resynch_filter filter

Use this command to perform partial resynchronization with the CORBA interface.

The filter parameter uses the same filter format as the ResyncFilter property. For example:

> resynch_filter $h==3

userid_acknowledge_alarm alarm_id user_id

Use this command to acknowledge an alarm in the CORBA interface by specifying the alarm ID (NV_ALARM_ID) and the user ID of the user acknowledging the alarm.

If you specify a value for the AckUserId property, the user_id parameter is not required.

userid_unacknowledge_alarm alarm_id user_id

Use this command to unacknowledge an alarm in the CORBA interface by specifying the alarm ID (NV_ALARM_ID) and the user ID of the user acknowledging the alarm.

If you specify a value for the AckUserId property, the user_id parameter is not required.

userid_clear_alarm alarm_id user_id

Use this command to clear an alarm by specifying the alarm ID (NV_ALARM_ID) and the user ID of the user acknowledging the alarm.

If you specify a value for the ClearUserId property, the user_id parameter is not required.

userid_comment_alarm alarm_id user_id comment_text

Use this command to add comments to an alarm by specifying the alarm ID (NV_ALARM_ID), the user ID of the user making the comment, and the text of the comment.

If you specify a value for the CommentUserId property, the user_id parameter is not required.

Note: There is a known issue with comments longer than one word being logged as the user ID in the log file. For details, see Known issues.

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.