Configuring the Alcatel5620Sam Java collector
To use data from the Alcatel5620Sam Java collector in a network discovery, you must copy certain files from the EMS to the server where the collector is installed, and 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 Alcatel5620Sam Java collector, complete the following steps:
Procedure
- Required: Before running the collector for the first time, copy the file /opt/5620sam/server/nms/integration/samOss.jar from the EMS server to the /opt/IBM/netcool/core/precision/collectors/javaCollectors/lib/ directory. You must use the samOss.jar file from the same version and release as the Alcatel 5620 system.
-
Change to the directory that contains the collector files.
cd $NCHOME/precision/collectors/javaCollectors/Alcatel5620Sam/
-
Within this directory, find the sample configuration file for the collector and copy it to the
working configuration file.
cp Alcatel5620Sam.properties.sample Alcatel5620Sam.properties
-
Edit the collector configuration file:
This file includes the following configuration sections:$NCHOME/precision/collectors/javaCollectors/Alcatel5620Sam/Alcatel5620Sam.properties.
- Collector properties. General configuration parameters for the collector, such as port number and log and trace details.
- EMS connection properties. Details of the EMS that the collector is connecting to. Data from these fields is used by Network Manager to model the EMS.
- HTTPS properties. Properties for configuring the HTTPS communication with the SAM 5620 EMS.
- FTP properties. Defines the file on the Network Manager server to which the SAM 5620 EMS writes the generated SOAP XML response. You must ensure that the FTP directory has public read/write permissions.
- Data Acquisition properties. Parameters that specify what data to collect from the EMS.
-
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 theDiscoCollectorFinderSeeds.cfg
file. - log.filename
- Filename for the 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
- log.maxsize
-
Maximum size of the collector log file in MB. The default is 50.
- log.maxcount
-
Maximum number of generated collector log files. The default is 100.
- trace.maxsize
-
Maximum size of the collector trace file in MB. The default is 50.
- log.maxcount
-
Maximum number of generated collector trace files in MB. The default is 100.
- trace.filename
- Filename for the 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
-
In the EMS Connection Configuration section, configure these parameters:
- EmsHost
- SAM 5620 host IP address.
- EmsPort
- SAM 5620 port accepting SOAP requests.
- Username
- Username of a SAM 5620 OSS user with OSS Management privileges.
- Password
- The SAM 5620 password, in plain text. This property only takes effect if the
md5Password
property is not used. - Md5Password
- The SAM 5620 password as an MD5 hash. If both
Password
andMd5Password
are specified,Md5Password
is used. - Secure
- If set to
true
, the HTTPS protocol is used to communicate with the EMS. - SecondaryEmsHost
- Secondary SAM 5620 host IP address. When the EMS is used in High Availability (HA) mode, this is
the IP address of the backup host. For example, the secondary EMS host IP address can be given as
10.0.0.95
. - SecondaryEmsPort
- Secondary EMS Port number. When the EMS is used in HA mode, this is the port of the backup host.
For example, the secondary EMS port number can be
8082
. - switchEms
- If set to
true
, the collector can switch between the primary and secondary EMS. If a secondary EMS is configured, the collector tries to connect to the secondary EMS when it cannot connect to the primary EMS. If the collector then cannot connect to the secondary EMS, it tries to connect to the primary EMS again. The default value isfalse
.
-
In the FTP Configurations section, configure the following parameters:
- IsRemoteFTPServer
- Indicates whether the FTP is Remote FTP server. To use remote FTP server, set the value to true. Default is false. If this value is set to true, the EMS inventory files are first copied to Remote FTP server and then downloaded to local ITNM server for processing.
- FtpUsername
- The FTP username to use to connect to the EMS.
- FtpPassword
- The FTP password to use to connect to the EMS.
- FtpHost
- The IP address of the Network Manager host.
- FtpDirectory
- A relative path within the default FTP directory to write the inventory files from EMS. If unspecified or empty, then the files are written to the FtpDefaultDirectory folder.
- FtpDefaultDirectory
- The default directory of the FTP service.
- SecureFTP
- If true, SFTP is used.
- RemoteFTPDirectory
- The absolute path in the Remote FTP server, to which EMS transfers the inventory
files.Note: Valid only when FTP server is not same as ITNM server and configured with remote server. For example,
isRemoteFTPServer
is set totrue
. - RemoteFTPTimeout
- The timeout interval for the FTP process (in seconds). Valid only when
isRemoteFTPServer
is set totrue
.
-
In the HTTPS Configuration section, configure the following parameters:
- HTTPSSecure
- If
true
, HTTPS (instead of HTTP) is used to connect to the EMS. - TrustStore
- The full path of SAM 5620 truststore file.
- TrustStorePassword
- The TrustStore Password.
- HTTPSPort
- HTTPS port for the SAM 5620. The default is 8443.
- HTTPSProtocolHandler
- Protocol handler for HTTPS connection. Because the SAM 5620 does not support the IBM HTTPS protocol handler package, the collector uses Oracle's HTTPS handler package by default.
TLSVersion
The protocol version of the SSL TLS protocol. The default version is
TLSv1.2
. If you specify the valueTLSv1.2
the collector uses TLS v1.2 instead during the SSL handshake.SSLDebugInfo
If
true
, the SSL debug info is printed during the SSL handshake. Iffalse
, the debug information is not printed. The default isfalse
.
-
In the Data Acquisition configuration section, configure the following parameters:
- GetEntities
-
- 1: Enable
- Enables download of physical entity data from the EMS.
- 0: Disable
- Disables download of physical entity data from the EMS.
- GetVplsVpns
-
- 1: Enable
- Enables download of VPLS VPN data from the EMS.
- 0: Disable
- Disables download of VPLS VPN data from the EMS.
- GetVllVpns
-
- 1: Enable
- Enables download of VLL VPN data from the EMS.
- 0: Disable
- Disables download of VLL VPN data from the EMS.
- GetLayer3Vpns
-
- 1: Enable
- Enables download of Layer 3 VPN data from the EMS.
- 0: Disable
- Disables download of Layer 3 VPN data from the EMS.
- GetMplsInterfaces
-
- 1: Enable
- Enables download of MPLS interface data from the EMS.
- 0: Disable
- Disables download of MPLS interface data from the EMS.
- GetLayer2Connections
-
- 1: Enable
- Enables download of Layer 2 connectivity data from the EMS.
- 0: Disable
- Disables download of Layer 2 connectivity data from the EMS.
- GetLteData
-
- 1: Enable
- Enables download of LTE data from the EMS.
- 0: Disable
- Disables download of LTE data from the EMS.
loadFirstRun
If
true
, the collector queries the EMS when the collector starts up. Iffalse
, the collector queries the EMS when you start the network discovery.EntityExtendedNameRequired
If
true
, theifName
andentityDescription
for Physical Interfaces contain extra information, as shown in the following examples.ifName: (displayedName att value or PortName) - Mode (mode att value) : - Speed (speed att value) : -Encap (encapType att value) : - State (compositeEquipmentState att value)
EntityDescription : displayedName ( bit att value) , (compositeEquipmentState att value) , (redundantStatus att value)
If
false
, theifName
andentityDescription
for Physical Interfaces do not contain extra information. The default isfalse
.Get5gData
- 1: Enable
- Enables download of 5G Core data from the EMS.
- 0: Disable
- Disables download of 5G Core data from the EMS.
- Save the collector configuration file.
What to do next
./collector.sh -Xms512m -Xmx1024m -jar Alcatel5620Sam/Alcatel5620SamCollector.jar -propsFile Alcatel5620Sam/Alcatel5620Sam.properties