Configuring the Alcatel5620SamSoap collector

Edit online

To use data from the Alcatel5620SamSoap 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 Alcatel5620SamSoap collector, complete the following steps:

Procedure

Edit the collector configuration file:
$NCHOME/precision/collectors/perlCollectors/Alcatel5620SamSoap/Alcatel5620SamSoapCollector.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. Configure the following properties:

Host

The hostname of the EMS.

Port

The port to connect to the EMS.

Username

The username to connect to the EMS.

Password

The password to use to connect to the EMS.

Timeout

The timeout for the SOAP communication between the collector and the EMS.
The following example shows example and default values of these properties:
```
DataSource =>
{
        Host => 192.168.1.2,
        Port => 8080

        Username => 'oss',
        Password => 'myPa55w0rd',

        Timeout => 30,
…
…
…
},
```
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.
The following example shows the default values of these properties:
```
DataAcquisition =>
{
        GetEntities => 1
        GetVplsVpns => 1,
        GetVllVpns => 1,
        GetLayer3Vpns => 1,
        GetMplsInterfaces => 1,
        GetLayer2Connections => 1
},
```
5. Edit the DataProcessing section of the configuration file. Configure the ContainmentMethod property.
The ContainmentMethod property controls how the entity data is processed in cases where containment is ambiguous due to missing or duplicate index data, which can occur with module(card)/slot data.
The possible values of the ContainmentMethod property are:

0

Ignore duplicate indexes and prefer slots. Slot entities are stored, but module (card) entities might be lost if they share the same data as the slot.

1

Ignore duplicate indexes and prefer cards. Module entities are stored, but slot entities might be lost if they share the same data as the module.

2

Keep card and slot entities. Generates a false index if duplicates are encountered.

The default value is 2.
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 new configuration file in the collector directory, or edit the default file $NCHOME/precision/collectors/perlCollectors/Alcatel5620SamSoap/extraInfo.cfg.
2. 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.