Configuring the NokiaAltiplanoRest collector

This collector retrieves data from the Nokia Altiplano Access Controller EMS. Before running the collector in a network discovery, you must configure the connection details between the EMS and Network Manager.

1. Change to the collector directory:

   cd $NCHOME/precision/collectors/javaCollectors/NokiaAltiplanoRest/

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

   cp NokiaAltiplanoRestCollector.properties.sample NokiaAltiplanoRestCollector.properties

3. 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 Acquisition properties

   Parameters that specify which data to collect from the EMS.

   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.

   REST connection properties

   Properties relating to the REST connection to the EMS.

4. 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 8443.

   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.

   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.

   trace.level

   Takes one of the following values:

   • NONE
   • FINEST
   • FINER
   • FINE
   • CONFIGINFO
   • WARNING
   • SEVERE
   • ALL

5. 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.GetEntities

   Takes one of the following values. The default value is 1.

   1: Enable

   Enables download of physical entity data.

   0: Disable

   Disables download of physical entity data.

   DataAcquisition.ONTs

   Takes one of the following values. The default value is 1.

   1: Enable

   Enables download of ONT data.

   0: Disable

   Disables download of ONT data.

   DataAcquisition.localDataDirectory

   Specifies the location of the output files generated from the EMS. Use a relative or absolute path to the directory location. Do not use directory variables such as $NCHOME.

   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.

6. 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.emsHost

   The host name of the EMS.

   DataSource.emsPort

   Port of the EMS.

   DataSource.emsUserName

   The user name to use when logging into the EMS.

   DataSource.emsPassword

   The password to use when logging into the EMS.

7. Configure REST connection properties for the collector.

   enableSSL

   Enable or disable SSL connectivity between the collector and the EMS server. This property takes the following values: true or false. The default is false.

   pathToKeyStoreFile

   The full path to the keyStoreFileName directory. You must specify the relative or full path to the directory location. You can not use $NCHOME. For example, /opt/IBM/netcool/core/precision/collectors/javaCollectors/CiscoApicRest/.

   TLSVersion

   The version of the TLS protocol. The allowed value and the default version is TLSv1.2.

   SSLDebugInfo

   If true, prints all the SSL debug info during the SSL handshake. The default is false.

   keyStoreFileName

   Specify the name of the keystore file that contains the SSL client certificate and trusted authority certificate.

   The keystore file must be placed in the directory specified in the pathToKeyStoreFile parameter.

   keyStorePassword

   Specify the password required to access the certificate specified by the keyStoreFileName property.

   setResponseTimeout

   Specify how long (in seconds) the collector waits for a response from the EMS before timing out. The default is 300.

   setHttpVersion

   Specify the version of the HTTP protocol that the target system supports. The default is 1.1.

   setRefreshInterval

   Specify the interval (in seconds) that the collector waits between successive login refresh requests. The default is 600.

   MaxBufferSize

   The maximum size of REST response that the collector processes, measured in MB. The default is 1024.

8. Save the collector configuration file.