Properties and command line options

You use properties to specify how the probe interacts with the device. You can override the default values by using the properties file or the command line options.

The following table describes the properties and command line options specific to this probe. For more information about generic Netcool/OMNIbus properties and command line options, see the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide.

Table 1. Properties and command line options

Property name

Command line option

Description

AckSystemId string

-acksystemid string

Use this property to specify the system identifier to use when acknowledging alarms using the CLI.

The default is Default.

Note: You must provide the system ID of the processing system instead of the default null value.

Agentheartbeat integer

-agentheartbeat integer

Use this property to specify the frequency (in seconds) with which the probe checks the status of the ZTE EMS server.

The default is 300.

AlarmFilter string

-alarmfilter string

Use this property to specify the filter that the Alarm IRP uses to limit the alarms sent to the probe.

The default is "".

AlarmIrpName string

-alarmirpname string

Use this property to specify the name of the Alarm IRP Agent that the probe uses to resolve the AlarmIRP point in the Naming Service.

The default is ALARM IRP V1.0.0.

ClearSystemId string

-clearsystemid string

Use this property to specify the system identifier to use when clearing alarms using the CLI.

The default is Default.

CommandPort integer

-commandport integer

Use this property to specify the port through which you can use Telnet to send commands using the CLI.

The default is 6970.

CommandPortLimit integer

-commandportlimit integer

Use this property to specify the maximum number of Telnet connections that the probe can make.

The default is 10.

CommentSystemId string

-commentsystemid string

Use this property to specify the system identifier to use when adding comments to an alarm using the CLI.

The default is Default.

EncodingTo

string

-encodingto string

Use this property to specify the encoding standard used by the probe.

The default is ISO-8859-1.

Note: When connecting to a ZTE EMS running in Chinese mode, specify the following value for this property: GB18030.

EntryPointIrpFile string

-entrypointirpfile string

Use this property to specify the location of the EntryPoint IRP file.

The default is "" .

EntryPointIrpFtp Command string

-entrypointirpftpcommand string

Use this property to specify the complete FTP command that the probe uses to access a remote Entry Point IRP file.

The default is "".

FileTransferIrpName

string

-filetransferirpname string

Use this property to specify the name that the probe uses to resolve the FileTransferIRP point in the Naming Service.

The default is FILETRANSFER IRP V1.0.0.

Note: The default value is for use with ZTE NetNumen M31 CN. Use the following value for ZTE NetNumen M31 RAN:

FileTransfer IRP V1.0

FlushBufferInterval integer

-flushbufferinterval integer

Use this property to specify how often (in seconds) the probe flushes all alerts in the buffer to the ObjectServer.

The default is 0 (which instructs the probe to never flush the alerts to the ObjectServer).

FtpPassword string

-ftppassword string

Use this property to specify the FTP password that the probe uses to access the Entry Point IRP file over FTP.

The default is "".

Note: Encrypt the password using the nco_g_crypt utility supplied with Netcool/OMNIbus.

InstanceId

string

-instanceid string

Use this property to specify a unique identifier for an instance of the probe. This property allows you to run multiple instances of the probe on the same machine.

The default is default.

ManagerIdentifier string

-manageridentifier string

Use this property to specify the name of the Manager Identifier that receives all the IRPs.

The default is Netcool.

NotificationCategories string

-notificationcategories string

Use this property to specify the notification categories to which the probe subscribes.

To specify multiple categories, separate them using semicolons, in the following format:

category1;category2;categoryn

For example, use the following value to subscribe to alarms and heartbeat events:

ALARM IRP V1.0.0; CS IRP V1.0.0

The default is "" (the probe subscribes to all available notification categories).

NotificationFilter string

-notificationfilter string

Use this property to specify the filter that the Notification IRP uses to limit the notifications sent to the probe.

This property uses the Extended Trader Constraint Language (Extended TCL) syntax defined in the OMG Notification Service specification.

The default is "".

NotificationIrpName string

-notificationirpname string

Use this property to specify the name that the probe uses to resolve the Notification IRP point in the Naming Service.

The default is NOTIFICATION IRP V1.0.0.

ORBCharEncoding string

-orbcharencoding string

Use this property to specify the native character encoding set used by the Object Request Broker (ORB) for character data. This property takes the following values:

  • ISO8859_1
  • UTF8

The default is ISO8859_1.

Note: If the value of this property does not match the character encoding set used by the target system, the probe might not be able to perform resynchronization or get new notifications.

ORBDebug string

-orbdebug string

Use this property to specify whether the probe includes ORB messages in the debug file. This property takes the following values:

false: The probe does not include ORB messages in the debug file.

true: The probe includes ORB messages in the debug file.

The default is false.

ORBDebugFileName string

-orbdebugfilename string

Use this property to specify the name of the ORB debug file.

The default is orb.debug.

ORBDebugFilePath string

-orbdebugfilepath string

Use this property to specify the location of the ORB debug file.

The default is ${OMNIHOME}/log/.

ORBLocalHost string

-orblocalhost string

Use this property to specify the local host used by the server-side ORB to place the server's host name into the IOR of a remote object.

The default is "".

ORBLocalPort integer

-orblocalport integer

Use this property to specify the local port to which the Object Request Broker (ORB) listens.

The default is 0 (the ORB selects an available port at random).

ORBWCharDefault string

-orbwchardefault string

Use this property to specify what wide character (wchar) set the IBM® ORB uses when communicating with other ORBs that do not publish a wchar set. This property takes the following values:

  • UTF16
  • UCS2

The default is UTF16.

PersistentSubscription string

-persistentsub (This is equivalent to PersistentSubscription with a value of true.)

-nopersistentsub (This is equivalent to PersistentSubscription with a value of false.)

Use this property to specify whether the probe maintains a persistent subscription to the ZTE EMS across sessions. This property takes the following values:

true: The probe maintains a persistent subscription to the EMS.

false: The probe does not maintain a persistent subscription to the EMS.

The default is false.

Resynch string

-resynch (This is equivalent to Resynch with a value of true.)

-noresynch (This is equivalent to Resynch with a value of false.)

Use this property to specify whether the probe requests all existing active alarms from the ZTE EMS before connecting to the notification service for new alarms. This property takes the following values:

false: The probe does not perform resynchronization.

true: The probe performs resynchronization.

The default is false.

Retry string

-retry (This is equivalent to Retry with a value of true.)

-noretry (This is equivalent to Retry with a value of false.)

Use this property to specify whether the probe attempts to reconnect to the ZTE EMS after losing the connection. This property takes the following values:

false: The probe does not attempt to reconnect to the EMS.

true: The probe attempts to reconnect to the EMS.

The default is false.

TargetEMS

string

-targetems string

Use this property to specify the target EMS to which the probe will connect to get alerts. This property takes the following values:
  • RAN
  • CN
  • M31_CN_UNICOM
  • M31_RAN_UNICOM
  • U31
  • U31_HKCSL

The default is RAN.

Timeout integer

-timeout integer

Use this property to specify the time period (in seconds) that the probe waits for the next alarm before disconnecting.

The default is 0 (which instructs the probe to maintain the connection indefinitely).

TimeTick integer

-timetick integer

Use this property to specify the lifetime (in minutes) of the Notification IRP session on the 3GPP server.

The value of this property must match or exceed the default time tick setting on the ZTE EMS system.

The default is 0 (the session remains open indefinitely).

ValidateXML

string

-validatexml (This is equivalent to ValidateXML with a value of true.)

-novalidatexml (This is equivalent to ValidateXML with a value of false.)

Use this property to specify whether the probe validates XML alarm data files received from ZTE NetNumen M31 CN. This property takes the following values:

false: The probe does not validate the XML file.

true: The probe validates the XML file.

The default is false.

XSDFile

string

-xsdfile string

Use this property to specify the location of the XML schema file (XSD) used to validate the XML alarm data file.

The default is "".

XSDFtpCommand

string

-xsdftpcommand string

Use this property to specify the complete FTP command that the probe uses to access the XSD file.

The default is "".

XSDFtpPassword

string

-xsdftppassword string

Use this property to specify the password required to access the XSD file over FTP.

The default is "".

Note: Encrypt the password using the nco_g_crypt utility supplied with Netcool/OMNIbus.