Configuring the CiscoWorks LMS collector

To use data from the CiscoWorks LMS collector in a network discovery, you must configure the connection details between the CiscoWorks LMS EMS and Network Manager.

Before you begin

In order to enable the Network Manager CiscoWorks LMS collector integration with the CiscoWorks LMS EMS, you must first copy the jdbc driver. To do this, and subject to your verification that you have the necessary permission or authorization to do so, manually copy the jconn2.jar library from the CiscoLMS server into the Network Manager Java™ collector library directory at $NCHOME$NCHOME/precision/collectors/javaCollectors/lib.
Note: By default, the location of the jconn2.jar on the Cisco LMS EMS server is /opt/CSCOpx/lib/classpath.

About this task

You can also configure additional information to be collected from the EMS. To configure the CiscoWorks LMS collector, complete the following steps:

To use data from the CiscoWorks LMS collector in a network discovery, you must configure connection parameters for Cisco Open Database Schema and Cisco Data Extraction Engine used to communicate between the CiscoWorks LMS EMS and Network Manager.

Procedure

  1. Change to the CiscoWorks LMS collector directory. 
    cd $NCHOME/precision/collectors/javaCollectors/CiscoLMS/
  2. Within this directory, find the sample configuration file for the CiscoWorks LMS collector and copy it to the working configuration file. 
    cp CiscoLMSCollector.properties.sample CiscoLMSCollector.properties
  3. Edit the collector configuration file:
    $NCHOME/precision/collectors/javaCollectors/CiscoLMS/CiscoLMSCollector.properties.
    This file includes the following configuration sections:
    • A section containing parameters for interfacing to the Cisco Open Database Schema, the Cisco Data Extraction Engine. This section also contains data acquisition flag settings.
    • A system configuration section.
    The following steps list the configurable parameters. The remaining properties in this file are collector system-based configurations and not meant to be changed.
  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.
    log.filename
    Filename for the CiscoWorks LMS 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 CiscoWorks LMS 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. 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
  6. Configure parameters for interfacing to the Cisco LMS database:
    DB.Host
    IP address or hostname of the Cisco LMS database.
    DB.Port
    Port number of the database. The default value is 43455.
    DB.DbName
    The schema name of the Cisco LMS database (database schema). The default value is rmengdb.
    DB.UserName
    The username used to connect to the database. The default value is lmsdatafeed.
    DB.Password
    The password used to connect to the database. The default value is lmsdatafeed.
  7. Configure parameters for interfacing to the Cisco Data Extraction Engine:
    webservice.host
    IP address or hostname of the Cisco Data Extraction Engine.
    webservice.port
    Port of the Cisco Data Extraction Engine. The default value is 1741.
    webservice.servicename
    Web service for the Cisco Data Extraction Engine. The default value is /campus/servlet/CMExportServlet.
    webservice.username
    User name for the Cisco Data Extraction Engine. The default value is admin.
    webservice.password
    User password for the Cisco Data Extraction Engine. The default value is admin.
  8. Configure data processing parameters for the Cisco Data Extraction Engine.
    The Cisco Data Extraction Engine can sometimes generate huge XML files for the layer 2 topology. In order to manage XML processing, the CiscoWorks LMS collector has the ability to read the XML envelope from the Cisco Data Extraction Engine and process it right away, or spool it to a flat file for later processing. By default, the Collector reads the XML envelope from the Cisco Data Extraction Engine and processes it right away.
    Cisco Data Extraction Engine processing parameters are as follows:
    L2TopologyXML.inputStreamEnable
    Takes one of the following values:
    1: Enable
    Collector reads from the input stream and consumes the XML envelope.
    0: Disable
    Collector reads from the input stream, spools the XML envelope to a file and consumes the XML envelope.
    L2TopologyXML.outputdirectory
    Output directory for the spooled XML envelope if L2TopologyXML.inputStreamEnable = 1. The default value is ../CiscoLMS/tmp.
    L2TopologyXML.outputfilename
    Output file for the spooled XML envelope if L2TopologyXML.inputStreamEnable = 1. The default value is output.xml.
  9. 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 CiscoWorks LMS EMS.
    False
    Disables the collector. The collector does not collect data from the CiscoWorks LMS EMS.
    DataAcquisition.GetEntities
    Takes one of the following values. The default value is 1.
    1: Enable
    Enables download of physical entity data from the CiscoWorks LMS EMS.
    0: Disable
    Disables download of physical entity data from the CiscoWorks LMS EMS.
    DataAcquisition.GetLayer2Connections
    Takes one of the following values. The default value is 1.
    1: Enable
    Enables download of layer 2 connectivity data from the CiscoWorks LMS EMS.
    0: Disable
    Disables download of layer 2 connectivity data from the CiscoWorks LMS EMS.
  10. Save the collector configuration file.