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
AdvancedFilterConfigFile `string`	-advancedfilter configfile `string`	Use this property to specify the path of an advanced JMS filter XML file. The Nokia NFM-P server uses this file to determine which events to send to the probe when the JmsTopic property is set to 5620-SAM-topic-xml-filtered. For details about how to dynamically change the advanced JMS filter while the probes is running, see Subscribing to the 5620-SAM-topic-xml-filtered topic. On UNIX and Linux operating systems, the default is $OMNIHOME/var/registerNotification.txt. On Windows operating systems, the default is %OMNIHOME%\\var\\registerNotification.txt.
CertificateStore `string`	-certificatestore `string`	Use this property to specify the path of the certificate store file. The default is "".
CertificateStorePassword `string`	-certificatestore password `string`	Use this property to specify the password required to access the certificate store file. The default is "".
CertificateStoreType `string`	-certificatestore type `string`	Use this property to specify the certificate type obtained from the certificate store. The default is JKS.
Durable `string`	-durable `string`	Use this property to specify that the probe makes a durable subscription to the JMS. false: JMS subscription is not durable. true: JMS subscription is durable. The default is true.
EJBPort `integer`	-ejbport `integer`	Use this property to specify the EJB port to which the probe connects. The default is 1099.
EnableFailover `string`	-noenablefailover (This is equivalent to EnableFailover with a value of false.) -enablefailover (This is equivalent to EnableFailover with a value of true.)	Use this property to specify an instance of probe to support redundant NFM servers. The default is false. If EnableFailover is set to true then the RetryCount must be set to a value greater than 0.
Host `string`	-host `string`	Use this property to specify the IP address of the host machine on which the Nokia NFM-P server is running. The default is localhost.
HTTPPort `integer`	-httpport `integer`	Use this property to specify the HTTP port to which the probe connects. The default is 8080.
JMSAcknowledgeMode `string`	-jmsacknowledge mode `string`	Use this property to specify the acknowledgment mode in which the probe runs. This property takes the following values: AUTO_ACKNOWLEDGE: The probe runs in automatic acknowledgement (AUTO_ACKNOWLEDGE) mode. DUPS_OK_ACKNOWLEDGE: The probe runs in deduplication allowed (DUPS_OK_ACKNOWLEDGE) mode. The default is DUPS_OK_ACKNOWLEDGE
JmsFilter `string`	-jmsfilter `string`	Use this property to specify the filter the probe uses to limit the events received from Nokia NFM-P. For details of the format in which to specify this filter, see Filtering events. The default value is ALA_clientId in ('netcool@127.0.0.1', '') and ALA_category not in (\'STATISTICS\', \'ACCOUNTING\').
JmsTopic `string`	-jmstopic `string`	Use this property to specify the XML topic that the probe uses to subscribe to events within the JMS. For details about valid values for this property, see Table 1. The default is 5620-SAM-topic-xml.
NfmpServerPassword `string`	-nfmpserverpassword `string`	Use this property to specify the password required with the NfmpServerUserName property to log in to the JMS. The default is "".
NfmpServerUserName `string`	-nfmpserverusername `string`	Use this property to specify the user name with which the probe logs in to the JMS. The default is "".
Optimize `integer`	-optimize `integer`	Use this property to specify whether the probe optimizes performance: 0: The probe does not optimize performance. 1: The probe optimizes performance by writing neither events received from the HTTP request nor JMS events to the log file. The default is 1.
ParseSaxDebug `integer`	-parsesaxdebug `integer`	Use this property to specify whether the probe outputs extra debug information from the SAX Parser. The default is 0. Note: Use this option for debug purposes only.
PersistentJmsId `string`	-persistentjmsid `string`	Use this property to specify the ID of the JMS subscription. The default is netcool@127.0.0.1.
RecoveryFile `string`	-recoveryfile `string`	Use this property to specify the name of the recovery file in which the probe stores the timestamp of the last keepAlive event read before disconnecting from the Nokia NFM-P server. The probe uses this when reconnecting to the server. On UNIX and Linux operating systems, the default is $OMNIHOME/var/NFMPRecovery. On Windows operating systems, the default is %OMNIHOME%\\var\\NFMPRecovery. This recovery file does not exist by default. You must create this file manually when this property is specified for the first time. Note: You should backup or remove the recovery file when switching to a new machine or upgrading to a newer version of the probe. Failure to do so may result in successive resynchronizations but with missing events.
ResyncBatchSize `integer`	-resyncbatchsize `integer`	Use this property to specify the maximum number of alarms that the probe retrieves in each batch of resynchronization alarms. The default is 100.
SecondaryEJBPort `integer`	-secejbport `integer`	Use this property to specify the EJB port of secondary host machine to which the probe connects. The default is 1099.
SecondaryHost `string`	-sechost `string`	Use this property to specify the IP address of the secondary host machine on which the Nokia NFM-P server is running.
SecondaryHTTPPort `integer`	-sechttpport `integer`	Use this property to specify the HTTP port of the secondary host machine to which the probe connects. The default is 8080.
StoreEvents `integer`	-storeevents `integer`	Use this property to specify whether Nokia NFM-P continues to store events after the probe has been stopped by a `CTRL-C` command. This property takes the following values: 0: Nokia NFM-P does not store events after a `CTRL-C` stop. 1: Nokia NFM-P stores events after a `CTRL-C` stop. The default is 1.
TrustStore `string`	-truststore `string`	Use this property to specify the file path of the truststore file. The default is "".
TrustStorePassword `string`	-truststorepassword `string`	Use this property to specify the password required to access the truststore file containing the trusted certificates. The default is "".
UseSSL `string`	-usessl `string`	Use this property to enable SSL authentication when connecting to the Nokia NFM-P server. This property takes the following values: false: SSL is not used when connecting to the Nokia NFM-P server. true: SSL is used when connecting to the Nokia NFM-P server. The default is false. Note: If UseSSL is set to true, the HTTPPort property must be configured to use the Nokia NFM-P HTTPS port. The default Nokia NFM-P port is 8443. You must also configure the following properties for the Probe for Nokia Network Functions Manager for Packet: CertificateStoreType CertificateStore CertificateStorePassword TrustStore TrustStorePassword
XMLFile `string`	-xmlfile `string`	Use this property to specify the XML file that the probe reads to check the SAX parser. The default is "". Note: Use this option for debug purposes only.
XMLFileRead `integer`	-xmlread `integer`	Use this property to specify whether the probe reads an XML file to check the SAX parser. This property takes the following values: 0: The probe does not read an XML file. 1: The probe reads the XML file specified by the XMLFile property. The default is 0. Note: Use this option for debug purposes only.
XMLretrieveUseInService `integer`	-xmlretrieveusein service `integer`	Use this property to specify whether the probe receives alarms from the nodes that are in either `inService` or `inMaintenance` mode. This property takes the following values: 0: The probe receives alarms from all the nodes. 1: The probe receives alarms only from the nodes that are in the `inService` mode. The default is 0.