Sending commands to the CORBA interface using a command line interface

The Probe for Alcatel-Lucent 5620 SAM 3GPP v8 is supplied with a command line interface (CLI). This interface allows you to perform commands using the probe (for example, to acknowledge alarms or to request a resynchronization).

To use the CLI, you must use the CommandPort property in the properties file to specify a port through which commands will be sent. When you want to execute commands, Telnet to this port.

Important: If a firewall separates the probe and the Alcatel-Lucent 5620 SAM device, keep the following ports open: TCP 21115, TCP 21126, and TCP 21111.

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

Table 1. CLI commands
Command	Description
exit/quit	Use this command to close the Telnet connection to the probe.
acknowledgeAlarms `alarm_id_1 alarm_id_2 ... alarm_id_n`	Use this command to acknowledge one or more alarms in the CORBA interface by specifying the ID of the alarms being acknowledged. Note: You must specify a user ID using the UserId property and the system ID using the SystemId property before you can perform this command using the CLI.
cleanupSubscription `subscription_id`	Use this command to detach the specified subscription from the SAM server. Note: You only need to use this command if the probe has shut down unexpectedly. During normal usage the probe unsubscribes as it shuts down.
clearAlarms `alarm_id_1 alarm_id_2 ... alarm_id_n`	Use this command to clear one or more alarms in the CORBA interface by specifying the ID of the alarms being cleared. Note: You must specify a user ID using the UserId property and the system ID using the SystemId property before you can perform this command using the CLI.
commentAlarms `comment_text alarm_id_1 alarm_id_2 ... alarm_id_n`	Use this command to add comments to one or more alarms in the CORBA interface by specifying the text to be added, followed by the ID of the alarms being commented. If the comment that you want to add to the alarm contains whitespace, you must put the comment portion of the command inside double quotation marks. Note: You must specify a user ID using the UserId property and the system ID using the SystemId property before you can perform this command using the CLI.
getEventQueueSize	Use this command to display the current size of the internal event queue.
getSubscriptionStatus `subscription_id`	Use this command to display the status of the specified subscription.
help	Use this command to display online help about the CLI.
resync	Use this command to perform a resynchronization with the CORBA interface. This command reuses the filter specified by the ResyncFilter property.
shutdown	Use this command to shut down the probe.

Note: As the CLI is based on Telnet connections, you can connect to the probe from anywhere by creating desktop tools to open a Telnet connection, send a command, and then to 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.