Command line interface

The probe is supplied with a command line interface (CLI) that enables you to execute commands to acknowledge alarms or request a full resynchronization with the CORBA 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
acknowledge_alarm `alarm_id`	Use this command to acknowledge an alarm in the CORBA interface by specifying the identifier (`NV_ALARM_ID`) of the alarm. Before you can use this command, you must specify a value for the AckSystemId property.
userid_acknowledge_alarm `alarm_id` `user_id`	Use this command to deacknowledge an alarm in the CORBA interface by specifying the identifier (`NV_ALARM_ID`) of the alarm and the user identifier (`NV_ACK_USER_ID`) of the user acknowledging the alarm. Before you can use this command, you must specify a value for the AckSystemId property. If you specify a value for the AckUserId property, the `user_id` parameter is not required.
unacknowledge_alarm `alarm_id`	Use this command to deacknowledge an alarm in the CORBA interface by specifying the identifier (`NV_ALARM_ID`) of the alarm. Before you can use this command, you must specify a value for the AckSystemId property.
userid_unacknowledge_alarm `alarm_id` `user_id`	Use this command to deacknowledge an alarm in the CORBA interface by specifying the identifier (`NV_ALARM_ID`) of the alarm and the user identifier (`NV_ACK_USER_ID`) of the user acknowledging the alarm. Before you can use this command, you must specify a value for the AckSystemId property. If you specify a value for the AckUserId property, the `user_id` parameter is not required.
clear_alarm `alarm_id`	Use this command to clear an alarm by specifying the identifier (`NV_ALARM_ID`) of the alarm. Before you can use this command, you must specify a value for the ClearSystemId property.
userid_clear_alarm `alarm_id` `user_id`	Use this command to clear an alarm by specifying the identifier (`NV_ALARM_ID`) of the alarm and the user identifier (`NV_ACK_USER_ID`) of the user clearing the alarm. Before you can use this command, you must specify a value for the ClearSystemId property. If you specify a value for the ClearUserId property, the `user_id` parameter is not required.
resynch_all	Use this command to perform a full resynchronization with the CORBA interface.
resynch_filter `filter`	Use this command to perform a partial resynchronization with the CORBA interface. The `filter` parameter uses the same filter format as the AlarmFilter property.
help	This command displays online help about the CLI.
exit/quit	This command closes the connection.
version	This command displays 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.