Command line interface

The probe has a command line interface (CLI) that you can use to issue commands.

To use the CLI, use the CommandPort property to specify a port through which commands can be sent. Use Telnet to send commands to this port.

The following table lists the commands that you can use with the CLI:

Table 1. CLI commands
Command	Description
`acknowledge_alarm`	This command allows you to acknowledge an alarm in the 3GPP interface. Note: This command takes as a parameter the `NV_ALARM_ID` of the alarm being acknowledged. Only one alarm can be acknowledged at a time.
`exit/quit`	This command closes the connection.
`help`	This command displays online help about the CLI.
`resynch_all`	This command allows you to perform a full resynchonization with the 3GPP interface. Note: Successful resynchronization requires that the Resynch property is set to true.
`resynch_filter`	This command allows you to a perform partial resynchronization with the 3GPP interface. Note: This command takes as a parameter a filter in the same format as the `AlarmFilter` property. For details, see Filtering notifications and alarms.
`unacknowledge_alarm`	This command allows you to unacknowledge an alarm in the 3GPP interface. Note: This command is not currently supported by Nokia-Siemens NetAct.
`userid_acknowledge_alarm`	This command allows you to acknowledge an alarm in the 3GPP interface by specifying the `NV_ALARM_ID` and `NV_ACK_USER_ID` parameters. These parameters are specified by the `AckSystemId` and `AckUserId` properties.
`userid_clear_alarm userid`	This command allows you to clear an alarm created by a specific user ID.
`userid_unacknowledge_alarm`	This command allows you to un-acknowledge an alarm in the 3GPP interface by specifying the `NV_ALARM_ID` and `NV_ACK_USER_ID` parameters.
`version`	This command displays the version of the probe.

Note: Since the CLI uses 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 Netcool/OMNIbus event list. You can create desktop tools that use Telnet to connect to the probe, send a command, and then close the connection.