Command line interface

When using the probe with IBM Tivoli Netcool/OMNIbus V7.3.1 or earlier, there is a command line interface (CLI) that you can use to manage the probe over a Telnet connection. For IBM Tivoli Netcool/OMNIbus V7.4 and later, use the HTTP/HTTPS command interface.

To use the CLI, ensure the following probe properties have suitable values:

CommandPort: Set this to the port number on the probe that Telnet connects through.
CommandPortLimit: Set this to the maximum number of CLI connections that can be open concurrently.

Table 1. CLI commands
Command	Description
acknowledge_alarm `alarm_id`	Use this command to acknowledge an alarm in the 3GPP interface. Note: This command takes as a parameter the `AlarmId` of the alarm being acknowledged. Only one alarm can be acknowledged at a time. This command also uses the values specified by the AckSystemId and AckUserId properties in the properties file.
exit	This command closes the Command Port connection.
help	Use this command to display online help about the CLI.
clear_alarm `alarm_id`	Use this command to clear an alarm in the 3GPP interface. Note: Version 3.2 of the 3GPP Interface does not support this command.
resynch_all	Use this command to perform a full resynchonization with the 3GPP interface.
resynch_filter `filter_name`	Use this command to perform partial resynchronization with the 3GPP interface.
unacknowledge_alarm `alarm_id`	Use this command to unacknowledge an alarm in the 3GPP interface.
userid_acknowledge_alarm `user_id alarm_id`	Use this command to acknowledge an alarm in the 3GPP interface by specifying the `AlarmId` of the alarm being acknowledged and the `AckUserId`. The format of the alarm is: `userID` `ID`.
userid_clear_alarm `user_id` `alarm_id`	Use this command to clear an alarm by specifying the identifier user (`AckUserId`) of the user who created the alarm. If you specify a value for the ClearUserId property, the `user_id` parameter is not required. Note: Version 3.2 of the 3GPP Interface does not support this command.
userid_unacknowledge_alarm `user_id alarm_id`	Use this command to unacknowledge an alarm in the 3GPP interface by specifying the `AlarmId` of the alarm being acknowledged and the `AckUserId`.
version	Use this command to display the version of the probe.

Note: Because the CLI is based upon Telnet connections, you can connect to the probe from anywhere. This means that simple scripts can be set up to allow users to acknowledge selected events from the event list by creating desktop tools to Telnet to the probe, send a command, and then close the connection.