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 information about default 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
AcknowledgeFilter `string`	-acknowledgefilter `string`	Use this property to specify which alarms the probe retrieves during resynchronization based on their acknowledgement state. This property takes the following values: AI_EVENT_ACKNOWLEDGED AI_EVENT_ UNACKNOWLEDGED AI_NA The default is "" Note: If you want to retrieve alarms of more than one acknowledgement state, specify them as a comma-separated list. If you leave this property blank, the probe retrieves alarms of all acknowledgement states.
AlarmRetrievalMgr ExtURL `string`	-alarmretrievalmgr exturl `string`	Use this property to specify the path to the AlarmRetrievalMgrExt endpoint. The default is oad/services/ AlarmRetrievalMgrExt.
AlarmRetrievalMgrURL `string`	-alarmretrievalmgrurl `string`	Use this property to specify the path to the AlarmRetrievalMgr endpoint. The default is oad/services/AlarmRetrievalMgr.
AlarmsBatchSize `integer`	-alarmsbatchsize `integer`	Use this property to specify the number of alarms that the probe can receive during each resynchronization. The default is 100.
AxSSSLSupport `string`	-axssslsupport `string` (This is equivalent to AxSSSLSupport with a value of true.) -noaxssslsupportid (This is equivalent to AxSSSLSupport with a value of false.)	Use this property to enable the setting of AxSSSLSupport parameters for SSL connections. This property takes the following values: false: The probe does not allow the setting of AxSSSLSupport parameters for SSL connections true: The probe allows the setting of AxSSSLSupport parameters for SSL connections The default is false.
CertificateStore `string`	-certificatestore `string`	Use this property to specify the path of the certificate store file. The default is "".
CertificateStorePassword `string`	-certificatestorepassword `string`	Use this property to specify the password required to access the certificate store file. The default is "". Note: Encrypt the password using `nco_g_crypt`.
CleanupPersistent JmsId `string`	-cleanuppersistent jmsid `string` (This is equivalent to CleanupPersistent JmsId with a value of true.) -nocleanuppersistent jmsid (This is equivalent to CleanupPersistent JmsId with a value of false.)	Use this property to specify whether the probe clears the durable JMS subscription of the subscribers before shutting down. This property takes the following values: false: The probe does not clear the durable JMS subscription. true: The probe clears the durable subscription of the JMS subscribers. The default is true.
CertificateStoreType `string`	-certificatestore type `string`	Use this property to specify the certificate type obtained from the certificate store. The default is JKS.
ClusterURL `string`	-clusterurl `string`	Use this property to specify the IP address and port number of each OAD server in the cluster. You must specify this property value as a comma-separated list. For Alcatel-Lucent OAD 9.3 and earlier, each item in the list must be in the following format: `ip_address:port_number` Where: `ip_address` is the IP address of the server on which OAD is running. `port_number` is either 1099 or 1100. For Alcatel-Lucent OAD 9.4, each item in the list must be in the following format: `remote://ip_address:port_number` Where: `ip_address` is the IP address of the server on which OAD is running. `port_number` is 4447. The default is "". The probe will get the JMS OAD server IP address from the HTTP OAD server. Note: If the probe is running on the same server as OAD, you can specify localhost instead of the IP address of the host computer. Note: This property is only specified when deploying Alcatel-Lucent 5529 OAD in a clustered environment
CommandPort `integer`	-commandport `integer`	Use this property to specify the port to which users can telnet to communicate with the probe using the command line interface (CLI) supplied with the probe. The default is 6970.
CommandPortLimit `integer`	-commandportlimit `integer`	Use this property to specify the maximum number of telnet connections that the probe allows. The default is 10.
DiscoveryGroup `string`	-discoverygroup `string`	Use this property to specify the IP address to which the probe sends the discovery query. The default is 230.0.0.4.
FlushBufferInterval `integer`	-flushbufferinterval `integer`	Use this property to specify the interval (in seconds) that the probe waits before flushing the buffer contents to the ObjectServer. The default is 0
HttpHostPort `string`	-httphost `string`	Use this property to specify the name and port number of the host (or hosts) to which the probe connects. You can specify the details of multiple hosts in this property by using a comma-separated list. Each item in the list must be in the following format: `host:port_number` Where: `host` is an IPv4 address, an IPv6 address, or a host name. `port_number` is a port on the host to which the probe connects. The default is localhost:8843.
HttpTimeout `integer`	-httptimeout `integer`	Use this property to specify the time (in seconds) that the probe waits on a socket for a connection response, or on an input stream to receive data, before timing out. The default is 10.
Inactivity `integer`	-inactivity `integer`	Use this property to specify the time (in seconds) the probe allows between receiving JMS events before disconnecting from Alcatel-Lucent 5529 OAD. The default is 70.
InventoryRetrievalMgrExtnsURL `string`	-inventoryretrieval mgrextnsurl `string`	Use this property to specify the URL of the Web service to query for the singleton JMS server. The default value is oad/services/InventoryRetrievalMgrExtns
JavaNamingFactoryInitial `string`	-javanamingfactory initial `string`	Use this property to configure the JNDI naming factory setting that enables the probe to subscribe for JMS notifications. For Alcatel-Lucent/Nokia OAD 9.3 and earlier, the default value for this property is `org.jboss.security.jndi.JndiLoginInitialContextFactory`. For OAD 9.4 to 9.6, the default value for this property is `org.jboss.naming.remote.client.InitialContextFactory`. For OAD 9.7 and later, the value for this property is `org.wildfly.naming.client.WildFlyInitialContextFactory`.
JmsFilter `string`	-jmsfilter `string`	Use this property to specify the filter the probe uses to subscribe to events on the JMS. The default is "".
JndiConfigFile `string`	-jndiconfigfile `string`	Use this property to specify the path to the JNDI properties files for JMS connections. On UNIX and Linux platforms, the default is $OMNIHOME/probes/<arch>/alcatel_5529_oad_v6.jndi. On Windows platforms, the default is %OMNIHOME%\\probes\\win32\\alcatel_5529_oad_v6.jndi. Note: The property values for the JNDI properties file can be encrypted using `nco_aes_crypt` with a key that generated by `nco_keygen`. For details of `nco_aes_crypt`, see the following IBM Documentation page: https://www.ibm.com/support/knowledgecenter/en/SSSHTQ_8.1.0/com.ibm.netcool_OMNIbus.doc_8.1.0/omnibus/wip/admin/reference/omn_adm_ncoaescryptcmdlineopts.html For details of `nco_keygen`, see the following IBM Documentation page: https://www.ibm.com/support/knowledgecenter/en/SSSHTQ_8.1.0/com.ibm.netcool_OMNIbus.doc_8.1.0/omnibus/wip/admin/task/omn_adm_generatekeyinkeyfile.html If you use encryption, you must also set two additional properties: ConfigCryptoAlg and ConfigKeyFile in the probe properties file. For details of these properties, see the following page in IBM Documentation: https://www.ibm.com/support/knowledgecenter/SSSHTQ_8.1.0/com.ibm.netcool_OMNIbus.doc_8.1.0/omnibus/wip/probegtwy/reference/omn_prb_commonprobeprops.html
MaxSameSingleton RetryTime `integer`	-maxsamesingleton retrytime `integer`	Use this property to specify the time in minutes that the probe will retry connecting to the same singleton server after a disconnection. The default is 10.
Optimize `string`	-optimize (This is equivalent to Optimize with a value of true.) -nooptimize (This is equivalent to Optimize with a value of false.)	Use this property to specify whether the probe can run with optimized performance: false: The probe does not run with optimized performance. true: The probe runs with optimized performance. The default is true. Note: In optimized performance the probe reduces the number of messages logged into the log file.
OS.Host `string`	-oshost `string`	Use this property to specify the host name of the server where the probe's target ObjectServer is installed. This value must be the same as the value specified in `$NCHOME/etc/omni.dat`. This property is required to enable the resynchronization feature. The default is localhost.
OS.Password `string`	-ospassword `string`	Use this property to specify the password that the probe uses with the OS.UserName property to connect to the ObjectServer during resynchronization operations. This ensures that the resynchronization operation takes place on the same ObjectServer specified in the Server property in the alcatel_5529_oad_v6.props file. The default is "". Note: You must specify the password encrypted by `nco_g_crypt`.
OS.Port `integer`	-osport `integer`	Use this property to specify the port number of the server where the target ObjectServer is installed. This value must be the same as the value specified in `$NCHOME/etc/omni.dat`. This property is required to enable the resynchronization feature. The default is 4100.
OS.UserName `string`	-osusername `string`	Use this property to specify the user name that the probe uses to connect to the ObjectServer during resynchronization operations. This ensures that the resynchronization operation takes place on the same ObjectServer specified in the Server property in the alcatel_5529_oad_v6.props file. The default is root.
PartitionName `string`	-partitionname `string`	Use this property to specify the cluster partition name to which the discovery query should be restricted. The default is cluster-name.
Password `string`	-password `string`	Use this property to specify the password that the probe uses to authenticate with Alcatel-Lucent 5529 OAD. The default is "". Note: Use the `nco_g_crypt` utility supplied with Netcool/OMNIbus to encrypt the password. See the IBM Tivoli Netcool/OMNIbus Administration Guide .
PerceivedSeverity Filter `string`	-perceivedseverity filter `string`	Use this property to specify which alarms the probe retrieves during resynchronization based on their perceived severity. This property takes the following values: PROP_UPDATE PS_CLEARED PS_CRITICAL PS_INDETERMINATE PS_MAJOR PS_MINOR PS_WARNING The default is "". Note: If you want to retrieve alarms of more than one perceived severity, specify them as a comma-separated list. If you leave this property blank, the probe retrieves alarms of all perceived severities.
PersistentJmsId `string`	-persistentjmsid `string`	Use this property to specify the identifier of the durable subscriber in the JMS. The default is alcatel_5529_oad_v6.
ProbableCauseFilter `string`	-probablecausefilter `string`	Use this property to specify which alarms the probe retrieves during resynchronization based on their probable cause. Each value that you specify should be in the following format: ru=`boolean`,contra=`boolean`, type=`description` Where ru indicates whether the alarm detected is from a device on a remote network, contra indicates whether the alarm detected is related to the source atomic function, and `description` is a predefined MTOSI description of the probable cause. Make sure you separate each part of the definition with a comma and do not include spaces. The default is "". Note: If you want to retrieve alarms of more than one probable cause, specify them as a semicolon-separated list. If you leave this property blank, the probe retrieves alarms of all probable causes.
Resync `string`	-noresync (This is equivalent to Resync with a value of false.) -resync (This is equivalent to Resync with a value of true.)	Use this property to specify whether the probe requests all active alarms from the server before acquiring new alarms during startup. This property takes the following values: false: The probe does not perform resynchronization during startup. true: The probe performs resynchronization during startup. The default is true. Note: For details about how to specify whether the probe performs a full resynchronization or a partial resynchronization, see Resynchronizing alarms. Note: This property does not stop resynchronization requests through the probe CommandPort facility.
ResyncRetryInterval `integer`	-resyncretryinterval `integer`	Use this property to specify the interval (in minutes) that the probe waits between successive attempts to retry the resynchronization operation. You can specify values between 0 and 30. The default value is 3. If you set this property to 0, the probe will make no attempts to retry the resynchronization operation. If you set this property to a value greater than 0, the probe will only retry a resynchronization operation if the previous resynchronization contained exceptions. When the resynchronization operation completes successfully without exceptions, the probe will make no further resynchronization attempts.
ResyncSQLCmd `string`	-resyncsqlcmd `string`	Use this property to specify the SQL command used to clear alarms from the ObjectServer after a resynchronization. If you leave this property blank, the resynchronization will proceed, but no alarms will be cleared. The default is `delete from alerts.status where Manager='Alcatel 5529 OAD V6 probe' and (InternalLast < RESTART_TIMESTAMP)`.
Retry `string`	-noretry (This is equivalent to Retry with a value of false.) -retry (This is equivalent to Retry with a value of true.)	Use this property to specify whether the probe attempts to reconnect to the system following a timeout. This property takes the following values: false: The probe does not attempt to reconnect to the system. true: The probe attempts to reconnect to the system. The default is true.
RetryWait `integer`	-retrywait `integer`	Use this property to specify the waiting time in seconds between retry connection with the singleton server. The default value is 10. Note: The maximum value for this property is 15.
ScopeFilter `string`	-scopefilter `string`	Use this property to specify which alarms the probe retrieves during resynchronization based on their device type. Each value that you specify should be in the following format: `mdNm=manufacturer,meNm=device` Where `manufacturer` is the name of the manufacturer of the device from which the alarms originated and `device` is the name of the device itself. Make sure you separate each part of the definition with a comma and do not include spaces. The default is "". Note: If you want to retrieve alarms of more than one device type, specify them as a semicolon-separated list. If you leave this property blank, the probe retrieves alarms of all device types.
SingletonServerPort `integer`	-singletonserverport `integer`	Use this property to specify the port number on the singleton server to which the probe connects. For Alcatel-Lucent OAD 9.3 and earlier, the default value for this property is `1099` or below. For Alcatel-Lucent OAD 9.4, the default value for this property is `4447`.
Topic `string`	-topic `string`	Use this property to specify the JMS topic to which the probe subscribes. The default is topic/Fault.
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 "".
TrustStoreType `string`	-truststoretype `string`	Use this property to specify the type of truststore specified by TrustStore property. The default value is JKS.
UseSsl `string`	-nossl (This is equivalent to UseSsl with a value of false.) -usessl (This is equivalent to UseSsl with a value of true.)	Use this property to enable SSL authentication when connecting to Alcatel-Lucent 5529 OAD. This property takes the following values: false: SSL is not used when connecting to the system. true: SSL is used when connecting to the system. The default is true. Note: If UseSsl is set to true, the HttpPort must be configured to use the Alcatel-Lucent OAD HTTPS port. The default Alcatel-Lucent OAD HTTPS port is 8443. You must also configure the following properties for the Probe for the Alcatel-Lucent 5529 OAD: CertificateStore CertificateStorePassword TrustStore TrustStorePassword
Username `string`	-username `string`	Use this property to specify the user name with which the probe logs onto Alcatel-Lucent 5529 OAD. The default is "".
XmlFileDebug `string`	-xmlfiledebug `string`	Use this property to specify the XML file that the probe replays. The default is "". Note: This file is used for debugging purposes only.