Configuring the Nokia Solutions and Networks NetAct XML Interface for Configuration Management collector

The Nokia Solutions and Networks (NSN) NetAct XML Interface for Configuration Management collector processes 2G, 3G and LTE RAN data by utilizing the configuration management XML file for the NSN NetAct EMS. This XML file contains the NetAct Configurator network configuration data, in RAML/CM2 format.

About this task

The collector can retrieve the configuration management XML file for the NSN NetAct EMS in one of the following ways:
  • By connecting to the NSN NetAct EMS. In this case the collector uses either FTP or SFTP. Therefore if you want to use this method, you must configure the collector properties file with the FTP and SFTP connection details between the NSN NetAct EMS and Network Manager.
  • By accessing the XML file in a designated local directory. If you want to use this method, you must specify the local directory that will contain XML files retrieved from the EMS.
In either case, you must configure the relevant data acquisition properties within the collector configuration file, as specified in the procedure that follows.
Note: The collector stores the operating system timestamp of each processed XML file. If, during a discovery, the collector finds that the last modified timestamp of the current XML file is the same as the timestamp recorded during the last discovery, the file is not processed. This ensures that only files containing device data updated since the last discovery are processed.

To configure the NSN NetAct XML Interface for Configuration Management collector, complete the following steps:

Procedure

  1. Change to the NSN NetAct XML Interface for Configuration Management collector directory. 
    cd $NCHOME/precision/collectors/javaCollectors/NetActCMDump/
  2. Within this directory, find the sample configuration file for the collector and copy it to the working configuration file. 
    cp NetActCMDumpCollector.properties.sample NetActCMDumpCollector.properties
  3. Edit the collector configuration file:
    $NCHOME/precision/collectors/javaCollectors/NetActCMDump/NetActCMDumpCollector.properties.
    This file includes the following configuration sections:
    • Collector configuration properties
    • Data acquisition properties
    • Data source properties
    Note: The following steps list the configurable parameters. The remaining properties in this file are collector system-based configuration values and are not meant to be changed.
  4. Configure the following collector properties:
    port
    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.
    log.level
    Level of logging for the collector framework. Takes one of the following values:
    • NONE
    • FINEST
    • FINER
    • FINE
    • CONFIGINFO
    • WARNING
    • SEVERE
    • ALL
    The default value is INFO.
    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
    Level of trace for the collector framework. Takes one of the following values:
    • NONE
    • FINEST
    • FINER
    • FINE
    • CONFIGINFO
    • WARNING
    • SEVERE
    • ALL
    The default value is INFO.
  5. 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
    Hostname 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
    DataSource.emsUserName
    Username of the EMS.
    DataSource.emsPassword
    Password of the EMS.
    DataSource.SecondaryEmsHost
    Host address of the Secondary EMS.
    DataSource.SecondaryEmsPort
    Port of the Secondary EMS.
    Datasource.switchEms
    You can use this parameter to switch between the primary and secondary EMS.
  6. Configure data acquisition parameters for the collector:
    collectData
    Takes one of the following values. 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 0.
    1: Enable
    Enables download of physical entity data from the EMS.
    0: Disable
    Disables download of physical entity data from the EMS.
    DataAcquisition.getRanTopology
    Takes one of the following values. The default value is 1.
    1: Enable
    Enables download of RAN connectivity data for the Net Act EMS.
    0: Disable
    Disables download of RAN connectivity data for the Net Act EMS.
    DataAcquisition.localDataDirectory
    Specifies the location of XML files retrieved from the EMS.
    DataAcquisition.postProcessFlag
    Defines how the collector handles the data file after processing. The default valus is 0.
    0 : Delete
    Deletes the xml file after processing.
    1 : Move
    Moves the xml file after processing. Used in conjunction with parameter DataAcquisition.moveLocation.
    2 : Leave
    Leaves the xml file in the data directory after processing. Used in conjunction with parameter DataAcquisition.localDataDirectory.
    DataAcquisition.moveLocation
    Specifies the location for the files to be moved post processing. This parameter only takes effect if the variable DataAcquisition.postProcessFlag has the value of 1.
    DataAcquisition.loadFirstRun
    Defines whether to process XML files in the XML local data directory upon start of the collector, without waiting for the XML-RPC call from the GUI.
    0
    Do not process data directory upon collector start. Other values will process the data directory immediately.
    1
    Process data directory upon collector start.
    DataAcquisition.downloadFile
    Defines whether to download the XML file using FTP or SFTP (secure FTP) from the EMS upon discovery.
    0
    Do not download.
    1
    Download.
    The default value is 1.
    DataAcquisition.maskCredentials
    Defines whether to mask the user credentials in the log when issuing the FTP or SFTP command to transfer the XML file from the EMS.
    0
    Do not mask credentials.
    1
    Mask credentials.
    DataAcquisition.remoteFtpHost
    Hostname or IP of the EMS where the XML data is generated.
    DataAcquisition.remoteDir
    Remote directory containing the file or files to be processed.
    DataAcquisition.remoteFile
    Name of the XML file that contains the CM data. If retrieving files using FTP or SFTP, then set this property to a wildcard value, such as *.xml or *.xml.gz.
    Note: If the remote directory configured using the DataAcquisition.remoteDir property contains more than the current file, and you have set DataAcquisition.remoteFile as a wildcard value, then all files that match the wildcard will be transferred from the remote directory and processed. To prevent the collector retrieving all previously processed files the remote directory must only contain the most recent XML file or files to be processed.
    DataAcquisition.remoteFtpUser
    Username to be used for the FTP or SFTP connection.
    DataAcquisition.remoteFtpPassword
    Password to be used for the FTP or SFTP connection.
    DataAcquisition.remoteFtpPort
    Port to be used for the FTP or SFTP connection.
    DataAcquisition.secureConnection
    Indicates whether to use secure connection (SFTP) when retrieving the cmdump files.
    1
    Use SFTP to connect to the EMS.
    0
    Use FTP to connect to the EMS.
    Default is 0.
    DataAcquisition.ftpTimeout
    Timeout interval for the FTP process.
    DataAcquisition.technologyType
    Mobile technology that will be handled by the collector. Available options are as follows:
    • 2G3G
    • LTE
    • ALL
    Default is 2G3G.
  7. Save the collector configuration file.