Command line interface

The probe is supplied with a Command Line Interface (CLI) that allows you to issue commands to the probe using Telnet.

The Command Port library (probe-command-port) provides CLI functions that you can use to issue commands to the probe.

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 run commands, use Telnet to connect through this port.

Note: Before you can use the CLI to acknowledge alarms, you must specify a system identifier using the SystemID property and a user identifier using the UserId property.

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

Table 1. CLI commands 

Command

Description

acknowledgeAlarms

Use this command to acknowledge one or more alarms by specifying the identifier of the alarms in the following format:

acknowledgeAlarms alarm_id_01 alarm_id_02 ... alarm_id_nn

The system returns the identifiers of any alarms that cannot be acknowledged.

exit/quit

Use this command to close the connection.

help

Use this command to display online help about the CLI.

resync

Use this command to perform a full resynchronization with the Alcatel-Lucent 1300 XMC server.

version

Use this command to display the version of the probe and the CLI.

CLI scripts

As 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.