Configuring the Nokia5529Idm Java collector

Before running the collector, copy the required .jar files from the EMS to the server on which the collector is installed:

Log into the Schema page of the IDM using the credentials of an IDM NBI user.
The URL of the IDM Schema page is https://hostname:8443/idm/schemadoc/html/index.html, where hostname is the name or IP address of the IDM server.
Click on the Client sample URL and download the idm-oss-client.tar.gz file to the server on which the collector is installed.
Uncompress the file.

If the EMS version is 9.4 or below, then copy the following files to the $NCHOME/precision/collectors/javaCollectors/lib directory:

axs-mobject-remote-api-9.4-268573.jar
hornetq-core-client-2.3.1.Final-ALU-1
hornetq-jms-client-2.3.1.Final-ALU-1.jar
jaxen-1.1.jar
jboss-as-security-7.2.0.Final-ALU-8.jar
jboss-client.jar
jboss-logging-3.1.2.GA-ALU-1.jar
jboss-remoting-3.2.17.GA.jar
jdom-1.1.2-ALU-2.jar
jms-1.1.jar
log4j-1.2.13.jar
netty-3.6.2.Final-ALU-1.jar
trove-2.1.1.jar

If the EMS version is 9.6.07 or 9.6.08, then copy the following files to the $NCHOME/precision/collectors/javaCollectors/lib directory:

axs-encription-app-9.6.07-399857.jar
jboss-logging-3.3.0.Final.jar
slf4j-simple-1.7.21.jar
axs-mobject-api-9.6.07-399857.jar
log4j-1.2.14.jar
wildfly-client-all.jar
axs-mobject-remote-api-9.6.07-399857.jar
picketbox-4.9.6.Final.jar
xbean-2.6.0.jar
idm-oss-client-1_9.6.07-399857.jar
picketbox-infinispan-4.9.6.Final.jar

If the EMS version is 9.7.03, then copy the following files to the $NCHOME/precision/collectors/javaCollectors/lib directory:

axs-encription-app-9.7.03-426853.jar
axs-encrypt-utils-9.7.03-426853.jar
axs-jboss-patch-9.7.03-426853.jar
axs-mobject-api-9.7.03-426853.jar
axs-mobject-remote-api-9.7.03-426853.jar
jboss-logging-3.3.1.Final.jar
log4j-api-2.11.0.jar
log4j-core-2.11.0.jar
picketbox-5.0.2.Final.jar
picketbox-infinispan-5.0.2.Final.jar
slf4j-api-1.8.0-beta2.jar
slf4j-simple-1.8.0-beta2.jar
wildfly-client-all.jar
xbean-2.6.0.jar

Change to the collector directory:

cd $NCHOME/precision/collectors/javaCollectors/Nokia5529Idm/

Within this directory, find the sample configuration file for the Nokia5529Idm Java collector and copy it to the working configuration file using a command similar to the following example:

cp Nokia5529IdmCollector.properties.sample Nokia5529IdmCollector.properties

The configuration file consists of the following sections:

Collector properties: General configuration parameters for the collector, such as port number and log and trace details.
Data Source properties: Details of the EMS that the collector is connecting to. Data from these fields is used by Network Manager to model the EMS.
Data Acquisition properties: Parameters that specify which data to collect from the EMS.
SOAP properties: SOAP-specific parameters.
FTP properties: FTP-specific parameters.
JMS properties: Properties relating to the Java Messaging System.
JMS HTTPS properties: Properties relating to the JMS HTTPS configuration.
CSV properties: Properties relating to comma-separated value format files.

Configure the collector port and log and trace parameters:

port

The port on which to run the collector. The port must match the port configured in the insert into the collectorFinder.collectorRules table in the DiscoCollectorFinderSeeds.cfg file. The default value is 8080.

log.filename

Filename for the collector log file. You can also specify a pattern for the log file name using a set of system-defined elements. The default value is Alcatel5529IdmCollector.log.

log.level

Takes one of the following values:

NONE
FINEST
FINER
FINE
CONFIGINFO
WARNING
SEVERE
ALL

trace.filename

Filename for the collector trace file. You can also specify a pattern for the trace file name using a set of system-defined elements. The default value is Alcatel5529Collector-trace.log.

trace.level

Takes one of the following values:

NONE
FINEST
FINER
FINE
CONFIGINFO
WARNING
SEVERE
ALL

You can optionally configure details about the source element management system (EMS) in the Data Source properties section by configuring the following generic fields. Data from these fields is used by Network Manager to model the EMS.

DataSource.id

Unique identifier for the datasource, in the form of an integer. This field takes the value 1, indicating that this is the primary data source.

DataSource.descr

Description of the EMS.

DataSource.emsName

Name of the EMS.

DataSource.emsPort

Port of the EMS.

DataSource.emsVersion

Version of the EMS.

DataSource.emsIdentifier

Identifier for the EMS and key to integrate the Network Manager collector with the Netcool Configuration Manager driver.

DataSource.emsRole

Role of the EMS. This parameter can take one of the following values:

unknown
primary
backup
other

DataSource.emsStatus

Status of the EMS. This parameter can take one of the following values:

unknown
up
down
other

In the Data Acquisition properties section, configure data acquisition parameters:

collectData

The default value is true.

True: Enables the collector. The collector collects data from the EMS.
False: Disables the collector. The collector does not collect data from the EMS.

DataAcquisition.fullDiscoTimeout

The number of seconds that the collector waits for the Bulk Network Export operation to be completed by the EMS. The default value is 30.

DataAcquisition.domainName

Sets the network element domain name in partial discovery.

DataAcquisition.exportProfileName

Sets the export network profile name. The default is cpp3exportProfile.

DataAcquisition.skipEmsConnection

Set to true to skip the data collection from EMS and read the local export CSV file. The location of the file is configured in the DataAcquisition.exportFileLocation property. Set to false to collect data from the EMS. The default is false.

DataAcquisition.exportFileLocation

The full name and location of the .csv export inventory file. This value is used only if the DataAcquisition.skipEmsConnection set to true.

DataAcquisition.processVlans

Set to true to process VLAN data, or false to not process VLAN data. The default is false.

DataAcquisition.processLLDP

Set to true to process LLDP data, or false to not process LLDP data. The default is false.

In the SOAP properties section, configure the SOAP properties:

soap.username: Username for the SOAP service.
soap.password: Password for the SOAP service.
soap.port: Port for the SOAP service.
soap.secure: This property can be true or false. The default value is false. If it is set to true, a secure HTTPS connection is used to connect to the EMS. If it is false, the collector uses an HTTP connection to the EMS.
jsse.httpsImpl: The HTTPS implementation class name. The default class name is com.ibm.net.ssl.www2.protocol. This property takes effect only when the soap.secure property is set to true.
jsse.trustStore: Complete path to the trust-store file. This property takes effect only when the soap.secure property is set to true.
jsse.trustPass: Password for the trust-store file. This property takes effect only when the soap.secure property is set to true.
TLSVersion: The protocol version of the SSL TLS protocol. The default version is TLSv1.2. If you specify the value TLSv1.2 the collector uses TLS v1.2 instead during the SSL handshake.
SSLDebugInfo: If true, the SSL handshake trace info is logged during the SSL handshake. If false, the debug information is not printed. The default is false.
jsse.keystoreType: The type of the keystore file using, default is JKS. Other possible type PKCS12 and other types.

In the FTP properties section, configure the FTP properties.

ftp.host

The IP address or hostname of the server on which the collector is running.

ftp.username

The FTP session username. This user must be able to log in to the server and have write permissions for the FTP directory.

ftp.password

The password for the username specified for the FTP session.

ftp.directory

The full path to the destination directory for files transferred from the EMS. This directory is on the server on which the collector is running. The default directory is /tmp.

ftp.compressed

The default is false.

True: Files are transferred in a compressed archive.
False: Files are not compressed.

In the JMS properties section, configure the properties that relate to the Java Messaging Service:

jms.username

Username for the JMS service.

jms.password

Password for the JMS service.

jms.topic

The Topic name to listen for JMS messages.

jms.filter

Message filter to process specific messages. Leave blank for no filtering.

jms.durable

Set as true to enable durable subscription. Default is false.

jms.unsubscribe

Set as true to unsubscribe from the Topic when durable subscription is enabled. Default is false.

jms.clientId

JMS client identifier to be set for durable subscriptions.

jndi.properties.file

Complete path of the jndi.properties file that contains all the JNDI related properties. If this property is not found or not configured, or the file is incorrect, then the collector will use the default JNDI configuration. If you configure this property, set the following properties in the file:

java.naming.factory.initial: Specifies the initial context factory to use. The value of the property must be the fully qualified class name of the factory class that will create an initial context. The default value is org.jboss.naming.remote.client.InitialContextFactory.; Note: For AMS/IDM version 9.7 or 9.7.03 or 9.7.05, use the java.naming.factory.initial value as org.wildfly.naming.client.WildFlyInitialContextFactory.
java.naming.provider.url: Specifies the location of the JBoss JNDI service provider that the client will use. The NamingContextFactory class uses this information to know which JBossNS server to connect to. The value of the property must be a URL string. The format of this value is remote://EMS host:port. The default value is remote://127.0.0.1:4447. Change this value to the EMS host and port.
java.naming.factory.url.pkgs: Specifies the list of package prefixes to use when loading in URL context factories. The value of the property must be a colon-separated list of package prefixes for the class name of the factory class that will create a URL context factory. Default is org.jboss.ejb.client.naming.
java.naming.security.principal: The principal to authenticate. This must be a string representing the name of a principal. The default is admin.
java.naming.security.credentials: The credentials to authenticate the principal, for example, the password. The default is admin.
jnp.maxRetries: An integer that controls the number of connection retry attempts that will be made on the initial connection to the naming server. This parameter only applies to ConnectException failures. A value less than or equal to 1 means that only one attempt will be made. The default value is 5.
jnp.timeout: The connection timeout in milliseconds. The default value is 30000. If this value is set to 0(zero), the connection will block until the VM TCP/IP layer times out.
jnp.partitionName: This property is applicable only for a Cluster JNDI setup. If you are not using a Cluster JNDI setup, remove this property. Specifies the cluster partition name that discovery is to be restricted to. If you are running the product in an environment with multiple clusters, you might want to restrict the naming discovery to a particular cluster. There is no default value, which means that any cluster response will be accepted.
jnp.discoveryGroup: This property is applicable only for a Cluster JNDI setup. If you are not using a Cluster JNDI setup, remove this property. The multicast IP address to which the discovery query is sent. The default is 228.1.2.5.
jboss.naming.client.connect.options.org.xnio.Options.SSL_STARTTLS: Note: This property is applicable only to AMS/IDM version 9.6 or above. If you are not using AMS/IDM version 9.6 or above, remove this property from the file.

Boolean parameter.
jboss.naming.client.connect.options.org.xnio.Options.SASL_POLICY_NOPLAINTEXT: Note: This property is applicable only to AMS/IDM version 9.6 or above. If you are not using AMS/IDM version 9.6 or above, remove this property from the file.

Boolean parameter.
jboss.naming.client.remote.connectionprovider.create.options.org.xnio.Options.SSL_ENABLED: Note: This property is applicable only to AMS/IDM version 9.6 or above. If you are not using AMS/IDM version 9.6 or above, remove this property from the file.

Boolean parameter.
jboss.naming.client.connect.options.org.xnio.Options.SSL_PROTOCOL: Note: This property is applicable only to AMS/IDM version 9.6 or above. If you are not using AMS/IDM version 9.6 or above, remove this property from the file.

Specifies the protocol to be used. Allowed values are TLSv1.2.

Configure the CSV Properties section.

The data from the EMS is downloaded as a file in the Comma-Separated Values (CSV) format. You can configure which values from the EMS for the NE and NE System are exported to the CSV file. The first three values are always mapped to the NE name (or NE System name), managed object type, and object identifier. Because the exact order of the remaining values in the CSV file can vary in different systems, you must configure the mapping so that the values are mapped correctly by the collector.

Restriction: The values that you use for the following variables must match exactly the attribute names exported by the EMS.

csv.NE.1

Specifies the mapping for the first unmapped variable for a line in the CSV file that describes an NE, that is, for the fourth variable in the line. For example:

csv.NE.1=IP Address

csv.NE.n

Specifies the mapping for the next unmapped variable, where n is an integer that increases by 1 with each subsequent variable.

csv.NE_System.1

Specifies the mapping for the first unmapped variable for a line in the CSV file that describes an NE System, that is, for the fourth variable in the line. For example:

csv.NE_System.1=Contact

csv.NE_System.n

Specifies the mapping for the next unmapped variable, where n is an integer that increases by 1 with each subsequent variable.

In the following example data for an NE, the NE name is ISAM123, the managed object type is NE, and the object identifier is ISAM123.

ISAM123,NE,ISAM123,192.168.242.175

The value 192.168.242.175 is the IP address. So you must define the following property:

csv.NE.1=IP Address

In the following example data for an NE System, the NE System name is ISAM123, the managed object type is NE System, and the object identifier is ISAM123.

ISAM123,NE System,ISAM123,Mike,Main UK ISAM system,R4.5.02,,00:80:C0:52:D4:8F,"Administrators office"/,3FE478262BNAA_E3.2.0.9,EX1234,LEUK,10/9/14 3:11:26 AM

In order to correctly map the remaining values, you would define the following properties:

csv.NE_System.1=Contact
csv.NE_System.2=Description
csv.NE_System.3=Ethernet DSL
csv.NE_System.4=ETSI Version
csv.NE_System.5=HUB MAC Address
csv.NE_System.6=Location
csv.NE_System.7=MIB Version
csv.NE_System.8=System ID
csv.NE_System.9=Type
csv.NE_System.10=Up Time

In the JMS HTTPS properties section, configure the properties that relate to the secure Java Messaging Service:

jms.secure: If true, the HTTPS secure JMS connection is established. If false, the connection is insecure. The default is true.
jms.keystore: The complete path to the trust-store file. This property takes effect only when the soap.secure property is set to true.
jms.keypass: Password for the trust-store file. This property takes effect only when the soap.secure property is set to true.
jndi.isClusterSetup: Set to true if the JNDI server is running in cluster mode. Set to false if the JNDI server is not running in cluster mode. If the EMS version is 9.6 or above, set the value to false. The default is true.

In the SKIP Properties section, configure the properties to skip some MOs or devices from processing.

skipMos: List of comma-separated MO names which should be skipped from processing. If you do not want to skip any devices, then leave this section empty.
skipDevices: Set to true to skip devices, or set to false to not skip devices. The default is false.
skipDevicesRegex: List of comma-separated regular expression patterns for device names that are to be skipped from processing. If you do not want to skip any devices, then leave this section empty. In the following example, all the device names, which are in the first column in the CSV file, that match the two patterns are skipped.

05-\\d+-\\d+-\\d+(.*), 06-\\d+-\\d+-\\d+(.*)

Save the collector configuration file.

Command to run the collector:

To run the collector use the following command and feed the EMS version using the argument -idmVersion.

./run_Nokia5529Idm_collector.sh -Xms512m -Xmx2G –jar Nokia5529Idm/Nokia5529IdmCollector.jar -propsFile Nokia5529Idm/Nokia5529IdmCollector.properties -idmVersion <version> -bg

The <version> must be replaced with one of the value from the following list based on target EMS version.

9.7.03
9.6.07
9.6.08
9.5
9.4

Note: If -idmVersion is not specified in the aforementioned command, then the default value is considered. The default value is 9.4. Then, it sets the classpath for 9.4 version of EMS libraries.