Configuring the MTOSISoap collector

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

About this task

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

Procedure

  1. Change to the MTOSISoap collector directory.
    cd $NCHOME/precision/collectors/javaCollectors/MTOSISoap/
  2. Within this directory, find the sample configuration file for the MTOSISoap collector and copy it to the working configuration file.
    cp MTOSISoapCollector.properties.sample MTOSISoapCollector.properties
  3. Edit the collector configuration file:
    $NCHOME/precision/collectors/javaCollectors/MTOSISoap/MTOSISoapCollector.properties.
    The file includes 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.
  4. In the Collector properties section, configure the general collector properties:
    port
    Port on which to run the embedded collector server. 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 MTOSISoap collector log file. The default value is MTOSISoapCollector.log.
    log.level
    Level of logging for the collector framework. Logging level takes one of the following values:
    • NONE
    • FINEST
    • FINER
    • FINE
    • CONFIG
    • INFO
    • WARNING
    • SEVERE
    • ALL

    The default value is INFO.

    trace.filename
    Filename for the MTOSISoap collector trace file. The default value is MTOSISoapCollector-trace.log.
    trace.level
    Level of trace for the collector framework. The default value is INFO.
  5. In the Data Acquisition properties section, configure data acquisition parameters:
    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.MSLN
    Value of the MultiLayer Subnetwork of the EMS. Default value is 1.
    DataAcquisition.ManagementDomain
    Name of the management domain of the EMS. Default value is Huawei/U2000.
    DataAcquisition.ManagedElementsBatchSize
    Defines the maximum number of MTOSI objects that can be included in a SOAP EMS response for a ManagedElementsRequest. The default value is 4500 objects.
    Note: You must set the DataAcquisition.ManagedElementsBatchSize and DataAcquisition.TopologicalLinksBatchSize parameters to values that are less than the number of elements on the EMS. Otherwise, discovery fails and you see this error in the discovery logs:
    Register Iterator faild.The number of Active Iterators is more than allowed!
    DataAcquisition.TopologicalLinksBatchSize
    Defines the maximum number of MTOSI objects that can be included in a SOAP EMS response for a TopologicalLinkRequest. The default value is 6000 objects.
    Note: You must set the DataAcquisition.ManagedElementsBatchSize and DataAcquisition.TopologicalLinksBatchSize parameters to values that are less than the number of elements on the EMS. Otherwise, discovery fails and you see this error in the discovery logs:
    Register Iterator faild.The number of Active Iterators is more than allowed!
    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.GetLayer2Connections
    Takes one of the following values. The default value is 0.
    1: Enable
    Enables download of layer 2 connectivity data from the EMS.
    0: Disable
    Disables download of layer 2 connectivity data from the EMS.
    DataAcquisition.GetLayer3Connections
    Takes one of the following values. The default value is 0.
    1: Enable
    Enables download of layer 3 connectivity data from the EMS.
    0: Disable
    Disables download of layer 3 connectivity data from the EMS.
    V4.2 FixPack 4: DataAcquisition.receiveTimeout
    V4.2 FixPack 4: The maximum time in seconds to wait for a response from the EMS. The default is 300 seconds.
  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
    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.
  7. Save the collector configuration file.