Configure an EMS discovery to collect topology data from Element Management Systems and integrate this data into the discovered topology.
You configure an EMS discovery in the same way that you configure the discovery of any other type of network. In addition to the standard discovery configuration activities you must perform some EMS-specific discovery configuration activities.
To configure an EMS discovery, do the following activities in addition to standard discovery configuration activities:
v Configure and start the EMS collectors
v Seed the EMS discovery by seeding the Collector finder v Enable collector discovery agents
These EMS-specific discovery configuration activities are described in the following topics.
Configuring collectors:
You can configure a collector to pass data requests and responses between Network Manager and the associated EMS or other data source.
Configuring the collector depends on the type of data source:
v For EMS: specify the hostname, port, username and password of the EMS.
v For CSV file: specify details of the CSV files and how to parse them.
You must also instruct the collector which port to listen on for XML-RPC requests from Network Manager. This is typically a one-time setup task required when a new collector is added to your Network Manager installation.
To configure a collector:
1. Edit the collector configuration file. For example, to configure the collector for the Alcatel 5620 SAM EMS, edit the file, Alcatel5620SamSoapCollector.cfg, located in:
$NCHOME/precision/collectors/perlCollectors/Alcatel5620SamSoap/
2. Specify the port the collector must listen on for XML-RPC requests from Network Manager.
This is also the port the collector uses to provide XML-RPC responses to Network Manager. By default this is port 8081. To make this change, find and make any changes to the General section of the configuration file, as shown in the following example:
General =>
{
Debug => 0, Listen => 8081 },
3. Specify the data source for this collector. This varies depending on the type of data source that the collector is using:
v If this is a SOAP collector and the data source is an EMS, then specify the hostname and port of the EMS, together with a username and password on the EMS. To make this change, find and make any changes to the DataSource section of the configuration file, as shown in the following example:
DataSource =>
{
Host => 192.168.1.2, Port => 8080
Username => ’oss’, Password => ’myPa55w0rd’
...
...
...
},
v If this is a CSV collector and the data source is a CSV file, specify the
filename of the CSV file. To make this change, find and make any changes to the DataSource section of the configuration file, as shown in the following example:
DataSource =>
{
CsvCfg => ’exampleCsv.cfg’, ...
...
...
},
4. Save the collector configuration file.
Configuring the Alcatel5620SamSoap collector:
To use data from the Alcatel5620SamSoap collector in a network discovery, you must configure the connection details between the EMS and Network Manager.
You can also configure additional information to be collected from the EMS. To configure the Alcatel5620SamSoap collector, complete the following steps:
1. Edit the collector configuration file: NCHOME/precision/collectors/
perlCollectors/Alcatel5620SamSoap/Alcatel5620SamSoap Collector.cfg
2. Specify the port the collector must listen on for XML-RPC requests from Network Manager.
This port is also used by the collector to provide XML-RPC responses to Network Manager. By default the port is 8081. Find and edit the General section of the configuration file, as shown in the following example:
General =>
{
Debug => 0, Listen => 8081 },
The port must match the port you have configured in the insert into the collectorFinder.collectorRules table in the DiscoCollectorFinderSeeds.cfg file when seeding the collector for a first discovery.
3. Edit the DataSource section of the configuration file. Specify the hostname and port of the EMS, and the username and password to connect to the EMS, as shown in the following example:
DataSource =>
{
Host => 192.168.1.2, Port => 8080
Username => ’oss’, Password => ’myPa55w0rd’
...
...
...
},
4. Optional: If you want to retrieve custom data from the EMS in addition to the data retrieved by default, complete the following steps.
a. Create a configuration file in the collector directory, for example NCHOME/precision/collectors/perlCollectors/Alcatel5620SamSoap/
extraInfo.cfg.
b. Edit the new file and specify the data to be retrieved, as in the following example:
Device =>
{
extraFields => [ { srcField => ’version’, destField =>
’m_Version’, typeField => ’string’ }]
},
Where srcField is the name of the field in the SAM object, destField is the name of the field to which the data will be mapped within the extraInfo field, and typeField is an optional type descriptor.
The field you want to retrieve must be part of one of the objects already retrieved by the collector. The objects queried by the collector are:
v netw.NetworkElement
v equipment.PhysicalPort v lag.Interface
v equipment.MediaAdaptor v equipment.PhysicalPort v equipment.DaughterCard v equipment.Equipment v equipment.Shelf v vpls.L2AccessInterface v vll.L2AccessInterface v l3fwd.ServiceSite v vprn.L3AccessInterface v netw.PhysicalLink v lldp.RemotePeer.
Valid types are int and string.
c. Save and close the new configuration file.
d. Edit the CustomData section of the NCHOME/precision/collectors/
perlCollectors/Alcatel5620SamSoap/Alcatel5620SamSoap
Collector.cfgcollector configuration file. Specify the name and location of the configuration file that defines the extra information to be collected, as in the following example:
CustomData =>
{
ExtraInfoCfg => ’extraInfo.cfg’
},
5. Save the collector configuration file.
Configuring the Alcatel5620SamSoapFindToFile collector:
To use data from the Alcatel5620SamSoapFindToFile collector in a network discovery, you must configure the connection details between the EMS and Network Manager, and the FTP details using which the XML files can be sent to the Network Manager server.
You can also configure additional information to be collected from the EMS. To configure the Alcatel5620SamSoapFindToFile collector, complete the following steps:
1. Edit the collector configuration file: NCHOME/precision/collectors/
perlCollectors/Alcatel5620SamSoap FindToFile/Alcatel5620SamSoap FindToFileCollector.cfg
2. Specify the port the collector must listen on for XML-RPC requests from Network Manager.
This port is also used by the collector to provide XML-RPC responses to Network Manager. By default the port is 8081. Find and edit the General section of the configuration file, as shown in the following example:
General =>
{
Debug => 0, Listen => 8081 },
The port must match the port you have configured in the insert into the collectorFinder.collectorRules table in the DiscoCollectorFinderSeeds.cfg file when seeding the collector for a first discovery.
3. Configure the following FTP parameters:
FtpUsername
The FTP username on the Network Manager server.
FtpPassword
The FTP password on the Network Manager server.
FtpHost
The IP address of the Network Manager server.
PasswordFtpDirectory
The directory on the Network Manager server where the files are to be sent.
Tip: Copy these files to another location before the next discovery so that they do not get overwritten.
4. Edit the DataSource section of the configuration file. Specify the hostname and port of the EMS, and the username and password to connect to the EMS, as shown in the following example:
DataSource =>
{
Host => 192.168.1.2, Port => 8080
Username => ’oss’, Password => ’myPa55w0rd’
...
...
...
},
5. Optional: If you want to retrieve custom data from the EMS in addition to the data retrieved by default, complete the following steps.
a. Create a configuration file in the collector directory, for example NCHOME/precision/collectors/perlCollectors/Alcatel5620SamSoap/
extraInfo.cfg.
b. Edit the new file and specify the data to be retrieved, as in the following example:
Device =>
{
extraFields => [ { srcField => ’version’, destField =>
’m_Version’, typeField => ’string’ }]
},
Where srcField is the name of the field in the SAM object, destField is the name of the field to which the data will be mapped within the extraInfo field, and typeField is an optional type descriptor.
The field you want to retrieve must be part of one of the objects already retrieved by the collector. The objects queried by the collector are:
v netw.NetworkElement v equipment.PhysicalPort v lag.Interface
v equipment.MediaAdaptor v equipment.PhysicalPort v equipment.DaughterCard
v equipment.Equipment v equipment.Shelf v vpls.L2AccessInterface v vll.L2AccessInterface v l3fwd.ServiceSite v vprn.L3AccessInterface v netw.PhysicalLink v lldp.RemotePeer.
Valid types are int and string.
c. Save and close the new configuration file.
d. Edit the CustomData section of the NCHOME/precision/collectors/
perlCollectors/Alcatel5620SamSoap/Alcatel5620SamSoap
Collector.cfgcollector configuration file. Specify the name and location of the configuration file that defines the extra information to be collected, as in the following example:
CustomData =>
{
ExtraInfoCfg => ’extraInfo.cfg’
},
6. Save the collector configuration file.
Configuring the Alcatel5620Csv collector:
To use data from the Alcatel5620Csv collector in a network discovery, you must configure the connection details between the EMS and Network Manager.
1. Edit the collector configuration file: NCHOME/precision/collectors/
perlCollectors/Alcatel5620SamCsv/Alcatel5620SamCsv Collector.cfg
2. Specify the port the collector must listen on for XML-RPC requests from Network Manager.
This port is also used by the collector to provide XML-RPC responses to Network Manager. By default the port is 8081. Find and edit the General section of the configuration file, as shown in the following example:
General =>
{
Debug => 0, Listen => 8081 },
The port must match the port you have configured in the insert into the collectorFinder.collectorRules table in the DiscoCollectorFinderSeeds.cfg file when seeding the collector for a first discovery.
3. Edit the DataSource section of the configuration file and specify the filename of the CSV file, as shown in the following example:
DataSource =>
{
CsvCfg => ’exampleCsv.cfg’, ...
...
...
},
4. Save the collector configuration file.
Configuring the HuaweiU2000Imanager collector:
To use data from the HuaweiU2000Imanager collector in a network discovery, you must configure the connection details between the EMS and Network Manager.
1. Edit the collector configuration file: NCHOME/precision/collectors/
perlCollectors/HuaweiU2000iManagerTL1/HuaweiU2000iManagerTL1 Collector.cfg
2. Specify the port the collector must listen on for XML-RPC requests from Network Manager.
This port is also used by the collector to provide XML-RPC responses to Network Manager. By default the port is 8081. Find and edit the General section of the configuration file, as shown in the following example:
General =>
{
Debug => 0, Listen => 8081 },
The port must match the port you have configured in the insert into the collectorFinder.collectorRules table in the DiscoCollectorFinderSeeds.cfg file when seeding the collector for a first discovery.
3. Edit the DataSource section of the configuration file. Specify the hostname and port of the EMS, and the username and password to connect to the EMS, as shown in the following example:
DataSource =>
{
Host => 192.168.1.2, Port => 8080
Username => ’oss’, Password => ’myPa55w0rd’
GetEntities => 1 DataAcquisition =>
{
StoreONTs => 1, }
...
...
,
Set GetEntities to 1 if you want to collect entity information from the collector.
Set StoreONTs to 1 if you want to retrieve ONT data.
4. Save the collector configuration file.
Configuring the Alcatel5529IdmSoap collector:
To use data from the Alcatel5529IdmSoap collector in a network discovery, you must configure the connection details between the EMS and Network Manager.
1. Edit the collector configuration file: NCHOME/precision/collectors/
perlCollectors/Alcatel5529IdmSoap/Alcatel5529IdmSoap Collector.cfg
2. Specify the port the collector must listen on for XML-RPC requests from Network Manager.
This port is also used by the collector to provide XML-RPC responses to Network Manager. By default the port is 8081. Find and edit the General section of the configuration file, as shown in the following example:
General =>
{
Debug => 0, Listen => 8081 },
The port must match the port you have configured in the insert into the collectorFinder.collectorRules table in the DiscoCollectorFinderSeeds.cfg file when seeding the collector for a first discovery.
3. Ensure that the Batchsize parameter is set to 500, unless otherwise advised by IBM Support. This parameter controls the size of the SOAP/XML response.
4. Edit the DataSource section of the configuration file. Specify the hostname and port of the EMS, the username and password to connect to the EMS, and other options, as shown in the following example:
DataSource =>
{
Host => 192.168.1.2, Port => 8080
Username => ’oss’, Password => ’myPa55w0rd’
Domain => ’AMS’
GetEntities => 1 GetOnt => 0 ,
In the above example:
v The domain of the AMS system on which the Inventory Data Manager is running is AMS.
v Collection of entity information is enabled (GetEntities => 1).
v Collection of ONT information is disabled (GetOnt => 0) 5. Save the collector configuration file.
Configuring the GenericSVC collector:
To use data from the GenericSVC collector in a network discovery, you must configure the connection details between the EMS and Network Manager.
1. Edit the collector configuration file: NCHOME/precision/collectors/
perlCollectors/GenericCsv/GenericCsv Collector.cfg
2. Specify the port the collector must listen on for XML-RPC requests from Network Manager.
This port is also used by the collector to provide XML-RPC responses to Network Manager. By default the port is 8081. Find and edit the General section of the configuration file, as shown in the following example:
General =>
{
Debug => 0, Listen => 8081 },
The port must match the port you have configured in the insert into the collectorFinder.collectorRules table in the DiscoCollectorFinderSeeds.cfg file when seeding the collector for a first discovery.
3. Edit the DataSource section of the configuration file and specify the filename of the CSV file, as shown in the following example:
DataSource =>
{
CsvCfg => ’exampleCsv.cfg’, ...
...
...
},
4. Save the collector configuration file.
Starting collectors:
Before discovery starts, all the collectors must be running. You must start the collectors or make sure the collectors are running before starting a discovery that includes collectors.
You start a collector by going to the relevant collector directory and issuing a command-line interface command. Issue the following command to start a collector (note that the command is entered on one line; options are explained in the table below):
ncp_perl collector_script -cfg COLLECTOR_CONFIG_FILE
[ -csvcfg CSV_COLLECTOR_CONFIG_FILE ] [ -listen PRECISION_PORT ] [ -debug DEBUG ] [ -logdir ] [ -nologdir DIRNAME ]
[ -help ] [ -version ]
Table 8. Explanation of command-line options
Option Explanation
collector_script The name of the perl script that implements the collector; for example, main.pl.
-cfg COLLECTOR_CONFIG_FILE Specifies the collector configuration file.
-csvcfg CSV_COLLECTOR_CONFIG_FILE Use this optional parameter to specify the name of a CSV file to use as a data source. You can also specify this parameter within the collector configuration file.
Restriction: This parameter is valid only when the data source is a CSV file.
-listen PRECISION_PORT An alternative method to specify the port on which the collector must listen for requests from Network Manager. Only specify a value here if no port value has been specified in the SOAP-based collector configuration file or in the CSV-based collector configuration file.
-debug DEBUG The level of debugging output (1-4, where 4 represents the most detailed output).
-logdir DIRNAME Directs log messages for each process started by CTRL to NCHOME/log/precision.
-nologdir DIRNAME Directs log messages for each process started by CTRL to a separate file in the specified directory.
-help All Network Manager components have a special
-helpoption that displays the command line options. The component is not started even if –help is used in conjunction with other arguments.
-version All Network Manager components have a special
-versionoption that displays the version number of the component. The component is not started even if –version is used in conjunction with other arguments.
Seeding an EMS discovery:
Seed the EMS discovery by seeding the Collector finder. This is typically a one-time setup task required when a new collector is added to your installation.
To enable Network Manager to find the collectors, you must seed the Collector finder. Seeding the Collector finder involves specifying for each collector:
v The hostname of the device on which the collector is running v The port on that device on which the collector is listening
If a collector is running on the same host as Network Manager, then you need only specify the port.
Note: If you are rediscovering a device using the Collector finder, then specify the IP address of the device or subnet to rediscover using the Discovery Configuration GUI.
You can seed the Collector finder to perform a discovery or to perform a partial rediscovery of a single device or subnet. If you seed the Collector finder to perform a partial rediscovery, then you can also specify a single device or subnet retrieved by the collector.
You must seed the Collector finder with the host name of the device on which the collector is running, and the port on that device on which the collector is listening.
If the collector is running on the same host as Network Manager, then you need to specify only the port.
Seeding the Collector for a first discovery
You seed the Collector finder for a first discovery by appending an insert into the collectorFinder.collectorRules table to the DiscoCollectorFinderSeeds.cfg
configuration file. The following insert seeds the Collector finder with a host name of 172.16.25.1, and a port of 8082. This insert means that the collector is running on a host with IP address 172.16.25.0, which is different to the host on which Network Manager is running. The override number of retries for this collector is 5.
insert into collectorFinder.collectorRules (
m_Host, m_Port, m_NumRetries )
values (
"172.16.25.1", 8082,
5 );
Enabling collector discovery agents:
By default, the collector discovery agents are not enabled. You must enable these agents if you are running a discovery that includes collector-based discovery.
To enable the collector agents:
1. In the Discovery Configuration GUI, select the Full Discovery Agents tab.
2. Select the following agents by checking the box next to the agent:
v CollectorDetails v CollectorInventory v CollectorLayer2 v CollectorLayer3 v CollectorVpn
Tip: You might need to scroll down the agent list to find these agents.
3. Click Save to save these configuration settings to the
DiscoAgents.DOMAIN_NAME.cfg schema file, where DOMAIN_NAME is the name of the discovery domain, for example NCOMS.
Related tasks:
“Activating agents” on page 27
You must enable the appropriate agents for the discovery you want to perform.
You can specify agents for a full discovery or for a partial discovery.
Locations and files for EMS collectors:
Perl scripts and a plain-text configuration file for each of the default collectors are held in a separate directory within the NCHOME/precision/collectors/
perlCollectors/ directory.
Experienced users can develop new collectors to enable Network Manager to interact with other EMS. Configuration and executable files for each new collector must be placed in an appropriately named directory within the
NCHOME/precision/collectors/perlCollectors/directory.
The default collectors are listed in the following table.
Name Directory Configuration file
Alcatel5620SamSoap NCHOME/precision/collectors/
perlCollectors/Alcatel5620SamSoap/
Alcatel5620SamSoap Collector.cfg Alcatel5620SamSoapFindToFile NCHOME/precision/collectors/
perlCollectors/Alcatel5620SamSoap FindToFile/
Alcatel5620SamSoap FindToFileCollector.cfg
Alcatel5620SamCsv NCHOME/precision/collectors/
perlCollectors/Alcatel5620SamCsv/
Alcatel5620SamCsv Collector.cfg Alcatel5529IdmSoap NCHOME/precision/collectors/
Alcatel5620SamCsv Collector.cfg Alcatel5529IdmSoap NCHOME/precision/collectors/