Command line interface

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

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.

Use the CommandPortLimit property to specify how many CLI connections can be open at the same time.

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

Command

Description

ackAlarm <alarmId> <emsId> <managedElementId> <username>

Note: If connecting to the ZTE U31 R10 system, the emsId and managedElementId values are optional. You can specify any value to proceed with acknowledging the alarm.
Use this command to acknowledge an alarm, where:
  • <alarmId> is the identifier stored in the alarm's emsAlarmId field.
  • <emsId> is the identifier stored in the alarm's EMS field.
  • <managedElementId> is the identifier stored in the alarm's ManagedElement field.
  • <username> is the user name of the user acknowledging the alarm (the default is root).

clearAlarm <alarmId> <emsId> <managedElementId> <username>

Note: If connecting to the ZTE U31 R10 system, the emsId and managedElementId values are optional. You can specify any value to proceed with clearing the alarm.
Use this command to clear an alarm, where:
  • <alarmId> is the identifier stored in the alarm's emsAlarmId field.
  • <emsId> is the identifier stored in the alarm's EMS field.
  • <managedElementId> is the identifier stored in the alarm's ManagedElement field.
  • <username> is the user name of the user acknowledging the alarm (the default is root).

exit/quit

Use this command to close the connection.

help

Use this command to display online help about the CLI.

getEventQueueSize

Use this command to display the current size of the internal event queue.

name

Use this command to display the name of the probe.

resync

Use this command to perform a resynchronization using the values specified by the ResyncSeverityFilter and ResyncProbableCauseFilter properties.

resyncFilter filter

Use this command to perform a resynchronization using a custom filter.

Custom filters take the following format:

resyncFilter sev=severity1;severity2; pbCause=pbCause1;pbCause2;

To perform a full resynchronization, use the following command:

resyncFilter sev= pbCause=

Note: This command does not accept spaces in the sev and pbCause arguments. If you want to use a filter that contains spaces, you must use the ResyncSeverityFilter and ResyncProbableCauseFilter properties.

shutdown

Use this command to shutdown the probe.

version

Use this command to print 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 Netcool/OMNIbus Event List.