Configuring the Alcatel5620SamSoapFindToFile collector

Edit online

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.

About this task

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

Procedure

Edit the collector configuration file:
$NCHOME/precision/collectors/perlCollectors/Alcatel5620SamSoapFindToFile/Alcatel5620SamSoapFindToFileCollector.cfg
Edit the General section of the configuration file. Configure the following properties:

Debug

The collector debug mode. Set the property to 0 to turn off debug. Set the property to 1 to turn debug on. The collector prints debug to the display (stdout).

Listen

The port that the collector listens 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. 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.

Timeout

Timeout for the communication from the collector to Network Manager. The timeout is measured in seconds. The default value is 15 seconds.
The following example shows the default values of these properties:
```
General =>
{
        Debug => 0,
        Listen => 8081,
        Timeout => 15
},
```
Edit the DataSource section of the configuration file.
1. 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',
        Timeout => 30,
…
…
…
},
```
2. Configure the following FTP parameters:
  UseSFTP
  Boolean flag to determine whether to use SSH FTP (SFTP) for transfer of XML files.
  
  UseSFTP = 1: instructs the system to use SFTP.
  
  UseSFTP = 0: instructs the system to use FTP.
  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.
  
  FtpDefaultDirectory
  
  The default directory of the FTP service on the Network Manager server.
  
  FtpDirectory
  
  A user-defined directory for the FTP service on the Network Manager server. Leave this value blank if it is not used.
  Tip: After a successful discovery, copy the generated XML files in the specified FTP directory to another location before performing a new discovery so that the XML files do not get overwritten.
Edit the DataAcquisition section of the configuration file and configure the following properties:

GetEntities

A flag for discovery of physical entities such as racks, cards, and ports. Set to 1 to discover physical entities. If this flag is set to 0, only the following information is discovered: chassis, logical entities, and data for the other enabled flags in the DataAcquisition section. The default value is 1.

GetVplsVpns

A flag for discovery of VPLS-based Layer 2 VPN data. Set to 1 to enable discovery of this data. The default value is 1.

GetVllVpns

A flag for discovery of VLL-based Layer 2 VPN data for epipes only. Set to 1 to enable discovery of this data. The default value is 1.

GetLayer3Vpns

A flag for discovery of Layer 3 VPN data. Set to 1 to enable discovery of this data. The default value is 1.

GetMplsInterfaces

A flag for discovery of MPLS interface data. Set to 1 to enable discovery of this data. The default value is 1.

GetLayer2Connections

A flag for discovery of physical link data. Set to 1 to enable discovery of this data. The default value is 1.

GetLteData

A flag for discovery of LTE data. Set to 1 to enable discovery of this data. The default value is 1.
The following example shows the default values of these properties:
```
DataAcquisition =>
{
        GetEntities => 1
        GetVplsVpns => 1,
        GetVllVpns => 1,
        GetLayer3Vpns => 1,
        GetMplsInterfaces => 1,
        GetLayer2Connections => 1,
        GetLteData => 1
}
```
Optional: If you want to retrieve custom data from the EMS in addition to the data retrieved by default, complete the following steps.
1. Create a configuration file in the collector directory, or edit the default file $NCHOME/precision/collectors/perlCollectors/Alcatel5620SamSoap/extraInfo.cfg.
2. Edit the 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 attribute 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 attribute you want to retrieve must be part of one of the objects already retrieved by the collector. The objects queried by the collector are:
  - netw.NetworkElement
  - equipment.PhysicalPort
  - lag.Interface
  - equipment.MediaAdaptor
  - equipment.PhysicalPort
  - equipment.DaughterCard
  - equipment.Equipment
  - equipment.Shelf
  - vpls.L2AccessInterface
  - vll.L2AccessInterface
  - l3fwd.ServiceSite
  - vprn.L3AccessInterface
  - netw.PhysicalLink
  - lldp.RemotePeer.
  Valid types are int and string.
3. Save and close the configuration file.
4. Edit the CustomData section of the $NCHOME/precision/collectors/perlCollectors/Alcatel5620SamSoap/Alcatel5620SamSoapCollector.cfg collector 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'
        },
```
Save the collector configuration file.