Usm pon EN: различия между версиями

Материал из WiKi - UserSide
(Новая страница: «en | ru {{ActivEN}}»)
 
Нет описания правки
 
(не показана 1 промежуточная версия этого же участника)
Строка 2: Строка 2:


{{ActivEN}}
{{ActivEN}}
'''USM_PON''' ''- is a module for polling the OLT to monitor the health of the PON network (see ''[[PON_EN|PON]]'').''
'''This module is a replacement for the obsolete [[us_pon_EN|us_pon]] module'''
'''Module Language:''' Perl
'''Current version:''' see page: [[Modules_EN|Modules]]
'''Module Status:''' [https://www.userside.eu/en/pricing Paid]
Required Perl modules:
Time::Local
Socket
FindBin
URI
URI::Escape
LWP::UserAgent
JSON
Data::Dumper
Installation in Debian:
sudo apt install -y liburi-perl libwww-perl libjson-perl
'''Module installation information''' and general information for all modules, see the page: [[Modules_EN|Modules]]
== Main Functions ==
* output of the optical signal from OLT to ONU outside the permissible limits
* detection of ONUs on the OLT that are not listed in the ERP "UserSide" ''(unknown)'''
* detection of ONUs that are registered on two OLTs at the same time
In case of discrepancies - the information will be displayed on the main page of ERP "UserSide". For more details, see "[[PON_EN|PON]]" page
Detected and recognised ONU-devices will have their network activity date updated.
The method of data acquisition is SNMP.
The module traverses all OLT-devices in order in one run.
== Supported equipment ==
It should be noted that in PON there are no standards for SNMP information output and all vendors come up with their own storage tables and methods of interpretation of ONU information. Below are the equipment vendors whose models we have studied and added support for. From different vendors/models we are able to capture a different set of information. It is possible that some individual OLT models will not work - this is solved in the working order within the framework of technical support. Addition of new OLTs is carried out on request and in co-operation with the customer.
- BDCOM ''(EPON/GPON)''
- C-Data/Gateray/Topvision ''(GPON)''
- Eltex ''(EPON/GPON)''
- GCOM ''(EPON/GPON)''
- GWDelight ''(EPON)''
- Huawei ''(EPON/GPON)''
- Iskratel ''(GPON)''
- QTECH ''(EPON)''
- Raisecom ''(EPON/GPON)''
- Spectra ''(EPON)''
- Stels ''(EPON)''
- V-Solution ''(EPON/GPON)''
- ZTE ''(EPON/GPON)''
== Install and configure the module ==
# Allocate a separate directory. A completely arbitrary one. It is better not to place it in a catalogue accessible via web. Interaction with ERP "UserSide" is carried out by means of API via http/s-protocol. Thus, the module is fully autonomous and can work on any separate computer in any subnet. Also create a separate directory for the module logs. Do not forget to specify write permissions for it.
# Transfer there the files from the module archive. Rename the sample configuration file "usm_pon.conf-example" to "usm_pon.conf". In it, configure the parameters. The list of possible parameters is given below.
# Check for additional perl packages that are required to run the module. Their list is given above. If you do not have them installed, the module will generate an error at startup and the perl-package will need to be installed ''(using CPAN or PPM)'''.
# In the "[[Settings - Modules]]" section, switch on the usm_pon module
# Run the module manually
perl usm_pon.pl
It should start and run without errors.
6. Write the module startup to the system cron, with the recommended frequency of once every 30 minutes
*/30 * * * *    root    perl /home/usm_pon/usm_pon.pl &> /dev/null
== Parameters ==
The module is configured in the usm_pon.conf file
$usUrl - URL to the ERP "UserSide"
$usApiKey - [[UserSide_API_Key_EN|API]]-key to ERP "UserSide"
$logsPath - Path to the directory for module logs
$isSilence - Flag - hide notifications to the console when the module is running
The usm_pon module can be run with the parameters ''(specify the specific device to be polled)''
Example:
perl usm_pon 998
will poll the OLT with ID 998
== Running in a Docker environment ==
Refer to the instructions at: https://github.com/userside/usm_pon-docker-env

Текущая версия от 18:19, 22 декабря 2023

en | ru

This function is one of the possibilities
to update the activity date of an object

USM_PON - is a module for polling the OLT to monitor the health of the PON network (see PON).

This module is a replacement for the obsolete us_pon module


Module Language: Perl

Current version: see page: Modules

Module Status: Paid

Required Perl modules:

Time::Local
Socket
FindBin
URI
URI::Escape
LWP::UserAgent
JSON
Data::Dumper

Installation in Debian:

sudo apt install -y liburi-perl libwww-perl libjson-perl

Module installation information and general information for all modules, see the page: Modules

Main Functions

  • output of the optical signal from OLT to ONU outside the permissible limits
  • detection of ONUs on the OLT that are not listed in the ERP "UserSide" (unknown)'
  • detection of ONUs that are registered on two OLTs at the same time

In case of discrepancies - the information will be displayed on the main page of ERP "UserSide". For more details, see "PON" page

Detected and recognised ONU-devices will have their network activity date updated.

The method of data acquisition is SNMP.

The module traverses all OLT-devices in order in one run.

Supported equipment

It should be noted that in PON there are no standards for SNMP information output and all vendors come up with their own storage tables and methods of interpretation of ONU information. Below are the equipment vendors whose models we have studied and added support for. From different vendors/models we are able to capture a different set of information. It is possible that some individual OLT models will not work - this is solved in the working order within the framework of technical support. Addition of new OLTs is carried out on request and in co-operation with the customer.

- BDCOM (EPON/GPON)
- C-Data/Gateray/Topvision (GPON)
- Eltex (EPON/GPON)
- GCOM (EPON/GPON)
- GWDelight (EPON)
- Huawei (EPON/GPON)
- Iskratel (GPON)
- QTECH (EPON)
- Raisecom (EPON/GPON)
- Spectra (EPON)
- Stels (EPON)
- V-Solution (EPON/GPON)
- ZTE (EPON/GPON)

Install and configure the module

  1. Allocate a separate directory. A completely arbitrary one. It is better not to place it in a catalogue accessible via web. Interaction with ERP "UserSide" is carried out by means of API via http/s-protocol. Thus, the module is fully autonomous and can work on any separate computer in any subnet. Also create a separate directory for the module logs. Do not forget to specify write permissions for it.
  2. Transfer there the files from the module archive. Rename the sample configuration file "usm_pon.conf-example" to "usm_pon.conf". In it, configure the parameters. The list of possible parameters is given below.
  3. Check for additional perl packages that are required to run the module. Their list is given above. If you do not have them installed, the module will generate an error at startup and the perl-package will need to be installed (using CPAN or PPM)'.
  4. In the "Settings - Modules" section, switch on the usm_pon module
  5. Run the module manually
perl usm_pon.pl

It should start and run without errors.

6. Write the module startup to the system cron, with the recommended frequency of once every 30 minutes

*/30 * * * *    root    perl /home/usm_pon/usm_pon.pl &> /dev/null

Parameters

The module is configured in the usm_pon.conf file

$usUrl - URL to the ERP "UserSide"
$usApiKey - API-key to ERP "UserSide"
$logsPath - Path to the directory for module logs

$isSilence - Flag - hide notifications to the console when the module is running

The usm_pon module can be run with the parameters (specify the specific device to be polled)

Example:

perl usm_pon 998

will poll the OLT with ID 998

Running in a Docker environment

Refer to the instructions at: https://github.com/userside/usm_pon-docker-env