# How to install EasyPON
There are a few ways to install EasyPON distribution. You can use the bash script for the automatic installation of EasyPON and all required OS dependencies or you can get acquainted with the demo.
## OS requirements
**OS:** Debian 11
[**Platform**](#user-content-fn-1)[^1]**:** Tested on [amd64](https://wiki.debian.org/DebianAMD64).
**RAM:** 4GB
**Storage:** 30GB
## Installation
{% content-ref url="/pages/6IUCvZASENUH3AbLE43j" %}
[Guide for Debian 11](/readme/guide-for-debian-11)
{% endcontent-ref %}
{% content-ref url="/pages/XNCvi1NOCOSU7KwP4Yu1" %}
[Docker compose installation guide](/readme/docker-compose-installation-guide)
{% endcontent-ref %}
## Demo
To see what EasyPON is capable of, simply visit our demo and give it a try on the web at [https://demo.easypon.in](https://demo.easypon.in/login).
#### Credentials:
**Login:** demo \
**Password:** epdemo12
### Updating EasyPON
[Debian 11 update](/readme/guide-for-debian-11#updating-easypon-debian) guide.
[Docker compose](/readme/docker-compose-installation-guide) upgrade instructions.
[^1]: It is possible to use other available Debian platforms with a workaround.
# Guide for Debian 11
This guide will provide step-by-step instructions for installing the EasyPON web application on your system.
1. Register an account in the EasyPON personal cabinet [https://cabinet.easypon.in](https://cabinet.easypon.in/login)
2. Login to your EasyPON personal cabinet account, and choose the existing license or add a new license instance.
3. Use the installation shell script or download the distribution archive of the latest Easypon version from your license on the **Download EasyPON > Script for Debian** tab.
4. [Install](/readme/guide-for-debian-11/install-easypon), [upgrade](/readme/guide-for-debian-11/upgrade-easypon), or [repair](/readme/guide-for-debian-11/repair-easypon-installation) EasyPON.
5. [Access](/readme/guide-for-debian-11/accessing-easypon) your fresh EasyPON installation.
# Install EasyPON
To install EasyPON, run the following command in your terminal:
{% code fullWidth="false" %}
```bash
apt update && apt install curl -y
bash <(curl -k https://cabinet.easypon.in/install_ep.sh) install
```
{% endcode %}
The installation process will prompt you for various configuration options, such as your domain name and credentials for the EasyPon cabinet account. Also, it is required to choose the EasyPON license which will be installed. Once installed it can not be reinstalled again.
{% hint style="info" %}
Please contact technical support if you want to reset your EasyPON license for a new installation.
{% endhint %}
The EasyPON app will be installed in `/usr/apps/easypon` and `superuser` will be created for your convenience for accessing EasyPON.
# Upgrade EasyPON
To update EasyPON to the latest version, run the following command from a terminal:
```bash
bash <(curl -k https://cabinet.easypon.in/install_ep.sh) upgrade
```
Before upgrading, you will be asked for your EasyPON user cabinet credentials. All your data will be kept after the upgrading process.
# Repair EasyPON installation
To restore the EasyPON installation and restore to the previous stable version, run the following command from a terminal:
```bash
bash <(curl -k https://cabinet.easypon.in/install_ep.sh) repair
```
Before repairing, you will be asked for your EasyPON user cabinet credentials. All your data will be kept in backup after the repair process. It can be the rollback to the previous stable version of EasyPON.
# Access EasyPON
To access EasyPon, open your browser and navigate to your server's domain name or IP address from installation instructions in Terminal.
You will be prompted to log in with your credentials, which you received in the Terminal during installation, or which can be found in `/root/.tmp_ep_users`.
# Docker compose installation guide
This guide will provide step-by-step instructions the process of creating an EasyPON web application Docker compose build.
* Register an account in the EasyPON personal cabinet [https://cabinet.easypon.in](https://cabinet.easypon.in/login)
* Login to your EasyPON personal cabinet account, and choose the existing license or add a new license instance.
* Use the installation shell script or download the distribution archive of the latest Easypon version from your license on the **Download EasyPON > Docker compose** tab.
* [Install](/readme/docker-compose-installation-guide/automatic-docker-compose-installation), [upgrade](/readme/docker-compose-installation-guide/upgrading-docker-compose-build), or [repair](/readme/docker-compose-installation-guide/repair-docker-compose-build) EasyPON Docker compose build.
* [Access](/readme/docker-compose-installation-guide/accessing-easypon-in-docker) your fresh EasyPON Docker compose build.
# Automatic Docker compose installation
You can install EasyPON with Docker Compose just by executing the bash script with the docker-install parameter in Terminal:
```bash
apt update && apt install curl -y
bash <(curl https://cabinet.easypon.in/install_ep.sh) docker-install
```
# Upgrading Docker compose build
To upgrade EasyPON Docker composer build you can run
Before upgrading, you will be asked for your EasyPON user cabinet credentials. All your data will be kept after the upgrading process.
# Repair Docker compose build
To repair the EasyPON build run the following script:
Repair restores the last backup of the EasyPON web application. It can be the rollback to the previous stable version of EasyPON. All your data will be kept in backup after the repair process.
# Manual Docker compose installation
If you need to execute a manual Docker compose installation process you can follow the instructions.
You need to have Docker Engine and Docker Compose on your machine. You can either:
* Install [Docker Engine](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) as standalone binaries or
* Install [Docker Desktop](https://docs.docker.com/desktop/) which includes both Docker Engine and Docker Compose
* Installation instructions specific for [Docker Engine](https://docs.docker.com/engine/install/debian/) on Debian
You don't need to install Python or Redis, as Docker images provide both.
1. Download the archive from your [EasyPON personal cabinet account](https://cabinet.easypon.in/) license, unpack the archive, and go to the unpacked directory by using the commands.
```bash
tar -xvf easypon.tar
cd easypon
```
2. Create env files
```bash
touch .env_docker
touch .env
```
2. Build images with the following command:
```bash
docker compose build
```
3. Generate .env\_docker
```bash
docker run --rm easypon-backend init > .env_docker
```
4. Start your project
```bash
docker compose up -d
```
5. To create an admin user, utilize the login and password from the environment variables specified in the `.env_docker` file:
```bash
docker compose exec -ti backend_main bash compose/backend-entry-point.sh create_user
```
# Access EasyPON in Docker
To access EasyPon, open your browser and navigate to your server's domain name or IP address.
You will be prompted to log in with your credentials, which you received in the Terminal during installation, or which can be found in `/root/.tmp_ep_users`.
# Access & Management
Easily manage, access EasyPON users and assign their permissions. Setup EasyPON settings and integrations.
## Log in
Hi there! My name is Docs and today I will tell you more about our PON management system.
The first step is to [log in](/management-and-access/login-page) to the system. To do this, go to your server address and use the credentials that were provided to you in the Terminal after successfully installing EasyPON on your server.
After that, you can check out your account and get info about the license by clicking on the [Profile](/management-and-access/management-and-access) main menu section.
## Users
You can add new users to your EasyPON system, [configure their access](/management-and-access/users#all-permissions), or use [default permission Groups](/management-and-access/group-access#standard-permission-groups) to assign system permissions in one click.
## Settings
This block contains a [Periodic task page](/management-and-access/periodic-tasks) and a [Group permissions configuration page](/management-and-access/group-access).
Periodic task configuration allows you to manage requests for information from your OLTs to optimize the capacity of requests and not overload them by asking for something frequently.
Group permissions are made for you to easily give access to a special part of the system to a group of people. You can configure any step from here and ensure your employees have all the required information for work.
You can also find the [Preset list](/configuration-features/presets) for ONU registration, [actions](/configuration-features/custom-action) for ONU, and [integration](#integration) sections.
## Integration
The [Integration](/management-and-access/integration) section of the EasyPON web application empowers users to seamlessly connect various external components to enhance their experience with EasyPON. Integrate Google services, UserSide integration, and create public API keys for interfacing with external EasyPON API.
# Login page
The Login page serves as the entry point to the EasyPON system. Users must authenticate themselves by providing valid credentials to gain access which can be gramted by system administrators.
You can use the Sign-in form to log into the EasyPON system. To do this, fill in the Username and Password fields and click Sign In.
Login page
After successful login, the user will be redirected to the [Dashboard](/dashboard) page, where you can start working with the EasyPON system.
> It is possible to obtain data for accessing the EasyPON system from the system administrator or by login in with your corporate email address with allowed domain.
# User Profile
The Profile page displays information about the user's account and the history of his operation sessions in the EasyPON system.
There are three cards available: User info, License, and Sessions.
## User info
The User info card displays information on the user's name and surname, account name - Username, and the user's email address - Email. You can also change your user's personal information, password, and EasyPON system language here.
## License
Check your subscription plan and payment amount. On the License card you can check your company name from the EasyPON personal cabinet, the next payment checkout date for the active Easypon tariff, the current tariff name, and the status of the EasyPON license.
You can also synchronize the current license status by pressing the "Sync license status" button.
## Sessions
The list with the session history in the Sessions card is displayed in tabular form with fields:
* **Date created** - session creation date and time
* **Last activity** - date and time of the user's last activity
* **Expiry** - the expiration date of the session in the system
* **IP address** - IP address of the user
* **Current session** – session status. Yes for the current session which can not be deleted and No for past sessions preserved for history.
* **Delete** – remove the user session button.
The Logout button lets you close the session and exit the EasyPON system. After the session ends, the user will be redirected to the login page.
# Permissions
Easily manage users and assign their permissions.
{% hint style="info" %}
The Permissions section may not be displayed due to the limited access permissions of your account.
{% endhint %}
With group access, you can create rules to assign permissions to multiple users. Additionally, you have the option to grant individual users special permissions that override the permissions assigned to their respective groups.
## Group list
The Group list card displays information about already existing permission groups and allows their creation, editing, and deletion in the EasyPON system.
We added you two standard groups with permissions, that are, in our opinion, suitable for administrators and support managers.
By the way, you can easily configure them by your own preferences.
Permissions Group list
## Group creation and editing
To add a group press the "+ Add group button", by specifying the name in the Name group input and checking the sections of access permissions or individual permissions that will be allowed in the group. Press the Save button to create the permission group or press Cancel to reset any changes and close the form.
If you need to set full access to the section, you need to activate the Full Access switch. If the permissions are limited, then the group will have Partial Access and the necessary accesses must be set separately.
Permission groups can be assigned while creating or editing users on the user account creation or editing form.
The permission group can not be deleted if it is assigned at least to one user account. All the permission group changes when edited are automatically applied to the users with this group assigned. If the group is not chosen for the user, for example, if you set custom permissions, only his individual permissions will be allowed and need to be configured separately for each such user.
## Viewing group
After clicking the View button, a page with information about the selected group of access rights is displayed in the Group list table. On this page, you can edit the group name and access rights or delete the selected group.
{% hint style="info" %}
Standard Admin and Support permissions groups can be edited but can not be deleted.
{% endhint %}
The Group page displays sections of access permissions that are active. With full access to the section, the **Full Access** switch will be active, if the permissions are limited, then the group will have the inscription as **Partial Access**. If no items are checked in the section it will be marked as **No Access**.
The display of individual elements in the access permissions section has the value **Yes** and **No**.
# Users
All you should know about user management in EasyPON
{% hint style="info" %}
The All Users section may not be displayed due to the limited access permissions of your account.
{% endhint %}
## All users
The All Users section displays the list of users available in your company's EasyPON system and is displayed in the form of a table with several fields.
You can filter users in the Users list table by multiple parameters for convenient and quick access for user management.
### Quick Actions Bar
You can view these Docs, by pressing Show Downloads to locate filtered user reports which are generated by the "Export to XLSX" option.
it is also possible to add a new user from the All Users section by pressing the "+Add user" button.
### Filter User
You can filter users by the following parameters:
* Username
* Name
* Email
* Joined before
* Joined after
* Last login before
* Last login after
You can also use the Add saved search record and always have fast access for applying frequent search templates. You can always delete saved searches to clear the applied filter with the corresponding options.
## User creation
The "Create user" form presents fields for completion. In order for the user to have access to system operations, you can assign them group permissions by selecting the group or customize their individual permissions.
* Group - the permission group assigned to the user. You can read more on [Permissions](https://app.archbee.com/docs/TzlFsLikA7TqxqriFHwd8/Im7vwaMN7zMOZSwvWoA5y) in the appropriate section.
* Individual permissions for the user. Individual user permissions have a higher priority status than group permissions.
Press the Save button to create a user and save changes. Press Cancel to reset all changes and back to the All users section.
## User page
After clicking the View link in the User list table or creating a new user, the page with information about a specific user opens.
The user data page displays the buttons Back - return to the User list and Deactivate - deactivation of the user account in the system. After deactivation, the user will be blocked and will not be able to use the EasyPON system.
#### All permissions
User access permissions are displayed in the User Permission and Group permissions sections. If the user has full access to the permission group, it will be marked as Full Access, if the rights are limited, then the group can have Partial Access. If the user does not have the rights of visible rights in the group of permissions, it will be marked as No Access.
## Editing a user
The edit form allows you to change details of the user, such as their password and permissions, categorized by either group or personal preferences.
You can assign a group to a user and provide them with special permissions by granting access in the "special permissions" sector. These permissions will take precedence over the permissions assigned to their group, but assigned already group permissions will not be excluded.
Edit user form
# Periodic Tasks
Execute routine tasks automatically and periodically in EasyPON system.
List of periodic tasks created in the system in the form of a table with the following fields:
* **Name** - the title of the periodic task.
* **OLT Name** - the title of the OLT on which the task should be executed.
* **Last run** - last date and time the task was run.
* **Activity** – task activity status. It can be Yes or No.
* **View** - a link to view detailed information about a specific task.
### Filter tasks
You can filter tasks in the Tasks list table by multiple parameters for convenient and quick access to task management:
* **OLT name** - search by OLT name string.
* **Search** - search periodic tasks by multiple parameters.
* **Activity** - activity of switch.
* **Last run before** - last switch run before the date.
* **Last run after** - last switch run after the date.
### Quick Actions Bar
You can view these Docs, by pressing Show Downloads to locate filtered tasks reports which are generated by the "Export to XLSX" option in the Tasks table.
## Periodic Task view
Clicking on the View button from the Tasks table displays detailed information about the recurring task.
### Quick Actions Bar
* **Back** – return to the list of periodic tasks.
* **Edit** - editing task parameters.
* **Deactivate** – task deactivation.
### Periodic Task information card
* **Description** - detailed description of the task.
* **The month of the year** - the number of the month of the year when the task should be performed.
* **Day of month** - the day of the month when the task is to be performed.
* **Day of week** - the day of the week when the task is to be performed.
* **Hour** - the hour when the task is to be performed.
* **Minute** - the minute the task is due.
## Periodic Task Editing
You can set the following values on the editing form by clicking Edit in the Actions Bar:
* **Description** - detailed description of the task.
* **The month of the year** - the number of the month of the year when the task should be performed.
* **Day of month** - the day of the month when the task is to be performed.
* **Day of week** - the day of the week when the task is to be performed.
* **Hour** - the hour when the task is to be performed.
* **Minute** - the minute the task is due.
Click Save to save periodic task parameter changes.
## Available periodic tasks
The are several tasks available in the EasyPON system for maintaining and automating everyday routines from synchronizing data to performing backups of valuable system data.
### General system tasks
* **Userside synchronization user groups**
* **Block inactive users**
* **Cleanup old report files**
* **Cleanup old view account logs**
* **Userside synchronization clients**
* **Userside synchronization tariffs**
### OLT and ONU-related tasks
* **Update onu client macs** - update client Mac address.
* **Update onu ethernet ports** - update client Mac ethernet port info on ONUs.
* **Sync full info all onus** - updates ONU data
* **Save olt config** - saves OLT configuration data for every night
* **Update onu measurement** - updates registered ONU measurements
* **Check olt is alive** - updates OLT online status
* **Get unregistered onus on olt** - a periodic task for monitoring and updating the list of unregistered ONU
* **Update olt info** - updates OLT and port data
### Switch related tasks
* **Update port info in switch**
# Integration
The Integration section of the EasyPON web application empowers users to seamlessly connect various external components to enhance their experience with EasyPON.
## **Integration Section Overview**
This guide will walk you through the steps to integrate Google services, UserSide integration, and create public API keys for interfacing with external EasyPON API.
Integration section page
### **1. Connecting Google Authentification Integration**
The Google Integration feature allows you to streamline your operations by linking your EasyPON account with Google corporate services. Follow these steps to set up this integration:
{% hint style="info" %}
Please notice, Google Authentification Integration works only by HTTPS protocol.
{% endhint %}
Google authentification integration options
1. **Log in to EasyPON Dashboard**: Navigate to the EasyPON dashboard and log in using your credentials.
2. **Access Integration Section**: From the dashboard, locate and click on the 'Integration' section.
3. **Google Integration**: In the Integration section, select the **Turn on Google Authorization?** option.
4. **Authenticate Google Account**: You will be prompted to authenticate your Google account. Fill in the
* **Client ID** - your Google client ID
* **API key** - API key from Google corporate account
* **Allowed corporate domains**. You can add multiple allowed domains by clicking **Add domain**
You can **Cancel** or **Save** changes.
5. **Authorization**: Grant the necessary permissions to allow EasyPON to access your Google services.
6. **Confirmation**: Once authenticated, you will receive a confirmation message indicating successful integration.
### **2. UserSide Integration**
UserSide integration is a vital aspect of the EasyPON ecosystem, enabling a seamless interaction between UserSide and EasyPON. Follow these steps to implement UserSide integration:
UserSide integration options
1. **Access Integration Section**: From the EasyPON dashboard, navigate to the 'Integration' section.
2. **UserSide Integration**: Select the 'UserSide Integration' option.
3. **Configuration Settings**: Fill in the required configuration settings based on your application's requirements. Ensure accuracy in the provided information.
4. **Integration parameters:**
* Integration type: Import or Synchronization. Import for one-time synchronization or periodical.
* Domain (API URL) - your UserSide domain
* API key - public API key of your UserSide account
5. **Test connection.** It's advisable to conduct thorough testing to confirm the successful implementation of UserSide integration.
6. **Select data to display in ONU information.** You can choose options that should be synchronized with UserSide integration:
* ID
* User Name
* User full Name
* User Login
* Contacts
* Contract ID
* User ID
* User Address
* Status
* Balance
* Tariff
* Network activity
* Internet activity
* Connection date
* Comment
* Incoming traffic
* Outgoing traffic
* Group
* Billing ID
* Creation date
* Positive balance date
7. **Cancel or Save Changes**: Click on 'Save' to apply the integration settings or Cancel them.
### **3. Creating Public API Keys**
Public API keys are essential for secure communication between your application and the external EasyPON API. Follow these steps to generate API keys:
Creating public API key
1. **Access API Keys Panel**: In the Integration section, locate and click on the 'API Keys' panel.
2. **Generate New API Key**: Click on the 'Generate New Key' button.
3. **Define Expiry date**: Specify the expiry date for the API key. You can also make it last indefinitely by checking the "Make it last indefinitely" option.
4. **Save API Key**: Click 'Save' to generate and save the API key or Cancel changes.
5. **Copy and Store Securely**: Once generated, copy the API key and store it securely, it will not be invisible for copying for the second time. Treat it as confidential information.
#### **External EasyPON API Documentation**
For detailed information on utilizing the EasyPON API, please refer to the External EasyPON API Documentation by following the **API documentation** link.
External API endpoints and documentation are only available if activated in the EasyPON system.
API keys panel
This guide provides comprehensive instructions for integrating Google services, UserSide integration, and creating public API keys in the EasyPON web application. For further assistance or inquiries, please refer to the EasyPON support resources.
# OLT workspace
"Optical Line Terminal" is a critical component in a Passive Optical Network (PON), a technology used in telecommunications to provide fiber-optic access. It is a main point for managing ISP network.
## All OLT
In this section, you can connect new OLTs and manage existing OLTs in the EasyPON application.
### Quick Actions Bar
With the help of the Quick Actions Bar, you can view documentation of this section, view downloaded reports that were generated by the "Export to XLSX" option, manage ONu migrations by accessing the [Migrations](/all-olt/port-migration) sections, and add new OLT to the EasyPON application.
### Filter OLT
You can filter the OLT base by the following filter parameters:
* [**OLT type**](/easypon-information/supported-olts) **- the type of OLT.**
* **Name - the name of OLT in the EasyPON system.**
* **Hostname**
* **Status**
* **Online Status**
* **Autosave**
* **ONU min count**
* **ONU max count**
* **Shel**
You can also use the Add saved search record and always have fast access for applying frequent search templates. You can always delete saved searches to clear the applied filter with the corresponding options.
### OLT list page
You can access basic information about the OLTs in the general sector. To explore further about any of them, you can navigate to the [OLT detailed info](#olt-detailed-information) page by clicking on the arrow in the "View" column.
{% content-ref url="/pages/6iTeAGceDbukeAzzhRCk" %}
[Actions on the OLT](/all-olt/add-olt)
{% endcontent-ref %}
{% content-ref url="/pages/gN8N7EE3yMSEKwqDdnet" %}
[OLT information](/all-olt/olt)
{% endcontent-ref %}
{% content-ref url="/pages/rbNWsIrg4nsLxJ7CO9RO" %}
[Port Migrations](/all-olt/port-migration)
{% endcontent-ref %}
# Actions on the OLT
Monitor and manage OLT
## Add OLT
The Add OLT button opens the form for creating a new OLT Create OLT. On this page, it is possible to add a new OLT to the system and check the connection with the OLT before adding it using the Test Connection button.
The Add OLT form consists of the following fields:
**OLT Name** - OLT title to identify it in the EasyPON system.
**Type OLT** - the [type](/easypon-information/supported-olts) of current OLT.
**IP address** - the IP address of the OLT.
**Shel** - the shelf number on the OLT.
**SNMP read community** - SNMP sequence for reading OLT statistics.
**SNMP write community** - SNMP sequence for recording OLT statistics data.
**SNMP port -** :Simple Network Management Protocol port.
**Telnet login -** username that is used to access a device via Telnet, which is a network protocol used for accessing and administering a device remotely.
**Telnet password -** along with the Telnet login, the password is the credential required to authenticate to a device when using the Telnet protocol.
**Telnet port -** the network port that the Telnet service listens on for incoming connections. When you connect to a device using Telnet, you are essentially establishing a TCP connection to this port.
**Autosave** (On or Off) - automatic saving of the current configuration to non-volatile memory, ensuring that settings are retained after a reboot or power loss.
**Activate SSH** - activate SSH status on the OLT. It can be done only once when adding the OLT or editing it later.
**Status** - synchronization status of the OLT. If disabled all OLT periodic tasks will be postponed to the moment you enable OLT status again.
## Edit OLT
OLT data can be edited by pressing the **Edit** button in the Quick Actions Bar section on the OLT page. To edit the OLT you need to modify data fields and then **Save** the form.
## Test connection
You can also Check the connection with the existing OLT on the OLT page or before saving the OLT add/edit form results by pressing the "Test Connection" button.
Test connection in complete
## Migrations
{% content-ref url="/pages/rbNWsIrg4nsLxJ7CO9RO" %}
[Port Migrations](/all-olt/port-migration)
{% endcontent-ref %}
# OLT information
On the OLT page, you can find all the information about the device, Its main info, and event logs. Also, there are actions available: OLT editing, OLT and ONU synchronization, and deleting OLT.
## OLT detailed information
The detailed OLT information page contains:
* [Main info](#main-info)
* [Quick actions bar ](#quick-actions-bar)
* [Slots & Ports panel](#slots-and-ports)
* [Graph all ONU / Online ONU](#graph-all-onu-online-onu)
* [Graph of the amount of errors by OLT in the time](#amount-of-errors-by-olt-in-the-time-graph)
OLT page
## Main info
The following main information about OLT is available:
* **Hostname -** This refers to the unique identifier assigned to the OLT device within a network. It helps in distinguishing this device from others, especially when managing or addressing networked devices.
* **OLT Type -** This specifies the model or category of the OLT. [OLT types](/easypon-information/supported-olts) vary based on their capabilities, such as the number of supported connections, power levels, and compatibility with different optical network standards.
* **Name SNMP (Simple Network Management Protocol) -** This is the identifier used within SNMP to manage and monitor the OLT. It facilitates the communication of management data between network devices and the management systems.
* **Online Status -** Indicates whether the OLT is currently active and connected to the network. An online status means the device is operational and can manage the fiber optic lines connected to it.
* **Status -** This broader term refers to its operational state, ad Active or Not Active. This option can be changed on the OLT edit form.
* **SNMP Port -** The network port used by SNMP to communicate with the OLT. This port allows for the remote configuration, monitoring, and management of the device.
* **Telnet Port -** This is the port used for Telnet access to the OLT. Telnet provides a user interface for configuring and managing the device via a command-line interface over the network.
* **Port SSH (Secure Shell)**: Similar to the Telnet port but offers a secure channel for network communication. SSH is used for securely logging into the OLT, executing commands, and transferring files.
* **Software Version -** Refers to the specific version of the firmware or software that is currently running on the OLT. This information is crucial for understanding the device's capabilities, compatibility, and any known issues or vulnerabilities.
## Quick Actions Bar
**Back** – return to the [OLT list](/all-olt)
**Edit** - open the [OLT editing](/all-olt/add-olt#edit-olt) form.
**Periodic tasks** - view [periodic tasks](/management-and-access/periodic-tasks) for the OLT.
**Event logs -** OLT event logs are records of activities and incidents that occur on an Optical Line Terminal (OLT) within a Passive Optical Network (PON) or similar network infrastructure. These logs are essential for network administrators and technicians to monitor, troubleshoot, and maintain the OLT and the PON network effectively. All events are logged with time stamps and information about the author of the event. Here are some common types of events that may be logged on an OLT:
* **Check connection** - when checking the connection with OLT
* **Sync all onus** - synchronizing ONU events by the Get ONU option
* **Synchronize** - OLT data synchronization
* **Create object** -creating OLT object event in the EasyPON application
**Synchronize** – OLT main data synchronization. After successful synchronization, all OLT data should be up to date.
**Get ONU** – synchronize all ONUs on the current OLT. With the help of Get ONU, it is possible to perform the synchronization process of all ONUs on the OLT Slots & Ports section. This option is available both from the Quick Actions Bar on the OLT page, in separate slots, and on individual OLT ports with an 'Up' Link Status.
**Delete OLT** - delete the OLT from the EasyPON system. OLT can be deleted by pressing the Delete button in the Quick Actions Bar section on the OLT page. To delete the OLT from the EasyPON system user confirmation is required.
## Slots & Ports
In this panel, you can access the information about slots and ports you have on your OLT.
Slots panel
Ports are displayed in the summary table under the corresponding slot. Selecting a slot in the "Slots" section will display its ports in this section.
Port section fields:
**№** - serial number of the port
**Registered ONU** – the number of registered ONUs on the port
**Admin Status (On/Off)** - administrative status of the port, which can be interactively changed by a left button click.
**Link status (Up/Down)** – port connection status
**QinQ status** - the list of QinQ ports.
**Port load** - the load on the port in the following format: registered ONUs / total port capacity - port load in percentages.
**Get ONU button** – synchronization of all ONUs on the OLT slot and separate port.
**Migration** - plan ONU [migration](/all-olt/port-migration) on a separate OLT port.
By clicking the **Registered ONU** field it is possible to view the full list of ONU filtered by OLT slot and port.
## Graph all ONU / Online ONU
The graph displays the number of all ONUs on the OLT relative to the ONUs that had Online status on the OLT within a time scale. It is possible to view statistics for the last 24 hours, for yesterday, for 7, 30, and 90 days ago.
Press the indicator in the legend to isolate its view on the graph or press back to select and view all data again. You can also press the Command key on Mac or Windows key on PC for multiple indicators selection and viewing them on the graph.
## Amount of errors by OLT in the time graph
The graph displays the number of errors on the OLT within a time scale. It is possible to view statistics for the last 24 hours, for yesterday, for 7, 30, and 90 days ago.
Press the indicator in the legend to isolate its view on the graph or press back to select and view all data again. You can also press the Command key on Mac or Windows key on PC for multiple indicators selection and viewing them on the graph.
# Port Migrations
OLT port migration, refers to the process of moving subscribers or Optical Network Units (ONUs) from one port on an Optical Line Terminal (OLT) to another.
This migration can be necessary for various reasons, such as network optimization, hardware upgrades, or addressing congestion issues.
OLT port migration requires careful planning and execution to minimize service disruptions and ensure a smooth transition for subscribers. It's crucial to follow best practices and maintain clear communication with both subscribers and network operators throughout the process. EasyPON offers a user-friendly interface for such migration planning and executing at the moment you need it.
It is possible to migrate a separate port with all registered ONU cards on OLT to a different OLT port with just a few actions:
1. Choose a port for migration in the Ports section on a specific OLT page and click action Migration. A migration process will be planned for the port.
2. You will be redirected to the Migration page.
3. Reconnect the chosen OLT port to the incoming migration port and press "Finish Migration" to finish the migration process. All migrated ONU cards will be shown in the History list.
If the migration process has been planned earlier on the specific port, the action Migration icon will be changed to the link for locating planned migration.
The Migrations button can be also accessed from the [OLT workspace](/all-olt) quick action bar. All 'Planned', 'In the process', and 'Finished' port migrations can be found here.
## Specific migration page
The main information about this action is located on the migration page, while its history is only available after completion. You can always back to the Migrations page when required.
You can view migration details on the **Main info**: These are:
* Port - OLT port
* Date created - timestamp when migration was created
* User - the name of the user who started the migration process
* Status - status of the migration
On the **History** panel, you can view
* № - number in the ONU
* Port - ONU port
* ONU - ONU name
* MAC/SN - MAC address or serial number of the ONU
* Status - ONU status
* Date created - the timestamp the ONU was created
* Show configs - view ONU configuration in the terminal.
By clicking **Finish migration** you can **Finish** the migration process or **Cancel** it.
Specific Migration page
# ONU configuration features
All you should know about ONU configuration and applying commands in EasyPON
## Presets for ONU
The first main feature to start after adding OLT is the [Presets for ONU](/configuration-features/presets). This workspace will help you add a list of saved ONU configurations (Presets), allowing you to apply them on unregistered ONUs for [registration](/onu-workspace/onu-registration) process or [change](/onu-workspace/onu#quick-actions-panel) the configuration of an existing ONU on the specific ONU page to work the way you want. Usually, these settings are done through the terminal manually for each ONU, but in the EasyPON web application, it can be done simply with UI right from the web in seconds.
## Actions for ONU
In the EasyPON web application, an [Action](#actions-for-onu)[ for ONU](#actions-for-onu) (Optical Network Unit) could be a specific operation or function that you want to perform on an ONU device in your daily ISP tasks and operations. This could include tasks like provisioning, configuring, or troubleshooting the ONU. Actions can be applied from a specific ONU page.
# Presets for ONU
The Presets section displays a list of available script templates, which can be used for registering ONU on the OLTs of different types.
In this section the presets can be added, edited, and deleted. Also empty presets can be kept for adding different OLTs and ONU types to them later and archiving.
For your convenience, we prepared standard drafts of presets so you can use them from the beginning of your interaction with EasyPON:
* [ZTE c220 v1 GPON preset](/configuration-features/presets/zte-s220-v1-gpon)
* [ZTE c320/300 v1 GPON preset](/configuration-features/presets/zte-s320-300-v1-gpon)
* [ZTE c320/300 v2 GPON preset](/configuration-features/presets/zte-s320-300-v2-gpon)
By default, a few distributed presets are also available in the EasyPON system as well. To use them it is required to assign OLT, ONU technology, and ONU type in the [edit Preset](#edit-preset-for-onu) form. Then you can select the assigned preset during [ONU registration](/onu-workspace/onu-registration).
## Preset list
Displaying added Presets at the Presets list in the Preset for ONU section.
You can select items in the list to open a preset for the ONU on the specific page for viewing the selected Preset detailed information.
Also, the **Add Preset** button is available in the section, which allows you to add new Presets. You can also find the Docs button to get to this manual section.
## Preset for ONU page
By clicking the view button on the specific preset item in the Preset list you can view specific Preset for the ONU page.
It is also possible to view the event logs of selected presets by pressing the Event Logs quick actions menu button. You will be redirected to [Event Logs](/event-log) filtered by specific preset
The values are displayed in the page of the selected Preset
**Preset title** - the title of the preset
**ONU Type** - selected ONU types to which the Preset corresponds
**Code** - Preset configuration script
**Description** - a detailed description of the Preset
**Macros used** - Macros which are used in the Preset
Preset for ONU page
## Add Preset for ONU
On the Add Preset for ONU form, you can add the following preset information:
* **Preset title** - the title of the preset
* **Code** - Preset configuration script with Macros
* **ONU Type** - selected ONU types to which the preset corresponds
* **Description** - a detailed description of the preset
* **Macros list** - select macros which will be used in the preset
While adding or editing Preset you can choose **Preset for auto-registration** option. When marked the preset will be managed for autoregistration through the external API. You can fill default inputs params below this option.
Add Preest for ONU form
## Edit Preset for ONU
You can change the preset data by pressing the **Edit** button modifying the Preset Name, Description, and Code with selected Macroses, and assigning ONU types.
Edit preset for ONU form
## Re-configure ONU with Preset
Preset can be chosen and used while [registering the new ONU](/onu-workspace/onu-registration) or re-applied on the specific ONU page later after registration has been finished.
Re-configure ONU with the different Preset
## Macros list
There is a [Macros list](/configuration-features/macros) available on the right side. Macro variables can be used as the template for substituting standard parameters into a Preset configuration in the Code input field while adding or editing the preset.
Macros list
# ZTE с220 v1 GPON
Preset for ONU you want to register on this OLT
```sh
// ZTE с220 v1 GPON Preset
interface {{onu.port_interface}}
onu {{onu_number}} type {{onu_type.value}} mac {{onu.mac_address | split:"."}} ip-cfg static
!
interface {{onu.onu_interface}}
property description {{input_params.name}}
switchport mode trank vport 1
switchport vlan {{input_params.vlan}} tag vport 1
port-location sub-option remote-id enable vport 1
dhcp-option82 disable vport 1
!
pon-onu-mng {{onu.onu_interface}}
vlan port eth_0/1 mode tag vlan {{input_params.vlan}}
dhcp-ip ethuni eth_0/1 from-internet
```
# ZTE с320/300 v1 GPON
Preset for ONU you want to register on this OLT
To start, you need to describe OLT profiles:
```
gpon
profile tcont UP-1000Mb type 4 maximum 1024000
profile traffic DOWN-1000Mb sir 1024000 pir 1024000
!
onu-profile gpon line 1000mb
fec upstream
tcont 1 name T-INET profile UP-1000Mb
gemport 1 name G-INET tcont 1
gemport 1 traffic-limit downstream DOWN-1000Mb
!
pon
onu-profile gpon remote standart
gemport 1 flow 1
!
```
Then add this preset to the [Preset list](/configuration-features/presets) in EasyPON and start to use it while registering ONU.
```
interface {{onu.port_interface}}
onu {{onu_number}} type {{onu_type.value}} sn {{onu.serial_number}}
onu {{onu_number}} profile line 1000mb remote standart
!
interface {{onu.onu_interface}}
name {{input_params.name}}
switchport mode trank vport 1
switchport vlan {{input_params.vlan}} tag vport 1
port-location sub-option remote-id enable vport 1
dhcp-option82 enable vport 1
dhcp-option82 trust true keep vport 1
!
pon-onu-mng {{onu.onu_interface}}
vlan port eth_0/1 mode tag vlan {{input_params.vlan}}
dhcp-ip ethuni eth_0/1 from-internet
```
# ZTE с320/300 v2 GPON
Preset for ONU you want to register on this OLT
To start, you need to describe OLT profiles:
```
gpon
profile tcont UP-1000Mb type 4 maximum 1024000
profile traffic DOWN-1000Mb sir 1024000 pir 1024000
!
onu-profile gpon line 1000mb
fec upstream
tcont 1 name T-INET profile UP-1000Mb
gemport 1 name G-INET tcont 1
gemport 1 traffic-limit downstream DOWN-1000Mb
!
pon
onu-profile gpon remote standart
gemport 1 flow 1
!
```
Then add this preset to the [Preset list](/configuration-features/presets) in EasyPON and start to use it while registering ONU.
```
// ZTE с320/300 v2 GPON Preset
interface {{onu.port_interface}}
onu {{onu_number}} type {{onu_type.value}} sn {{onu.serial_number}}
onu {{onu_number}} profile line 10mb remote standart
!
interface {{onu.onu_interface}}
description {{input_params.name}}
switchport mode trunk vport 1
service-port 1 vport 1 user-vlan {{input_params.vlan}} transparent
!
pon-onu-mng {{onu.onu_interface}}
vlan port eth_0/1 mode tag vlan {{input_params.vlan}}
dhcp-ip ethuni eth_0/1 from-internet
```
# Actions for ONU
In the EasyPON web application, an Action for an ONU (Optical Network Unit) could be a specific operation or function that you want to perform on an ONU device.
Action is a feature, that helps you to apply custom code to the ONU, that otherwise you have to perform manually step by step. This simplifies any interaction with ONU and helps you automate your daily routine. This could include tasks like provisioning, configuring, or troubleshooting the ONU.
The main difference between Preset and Action is that Ppreset is used for registering new ONUs instead of creating custom actions with registered ONUs in the EasyPON web application.\
\
You may access the Action submenu by clicking on **Settings -> Action** in the Main Menu.
## Action list
Displaying added Actions at the Action for ONU list in the Action for ONU section.
You can select items in the list to open an action on the specific page for viewing the selected Action detailed information.
Action for ONU
Also, the **Add Action** button is available in the section, which allows you to add new Actions. You can also find the Docs button to get to this manual section.
## Action for ONU page
You can also **Edit**, **Delete**, and view event logs of documentation by clicking the Docs icon.
It is also possible to view the event logs of selected actions by pressing the Event Logs quick actions menu button. You will be redirected to [Event Logs](/event-log) filtered by specific action
Action for ONU page
## Add Action for ONU
To add a new Action click on the button **Add Action**. After that, you can set the Action Name, Code, Description, and ONU types on the Action form. You can use the [Macros list](/configuration-features/macros) for your convenience to fill the required ONU parameters in the code field by clicking on the macros.
On the Add Action for ONU form, you can add the following preset information:
* **Action title** - the title of the action
* **Code** - Action configuration script with Macros
* **ONU Type** - selected ONU types to which the action corresponds
* **Description** - a detailed description of the action
* **Macros list** - select macros which will be used in the action
Create Action for ONU form
## Edit Action for ONU
You can change the preset data by pressing the **Edit** button modifying the Action Name, Description, and Code with selected Macroses, and assigning ONU types.
Edit Action for ONU form
## Run Actions
Actions can be run from a specific ONU page by clicking Action on the Quick Actions Bar. On the modal window, you can Apply or Cancel the action.
Custom action for ONU
After the run, the action will be executed in the configuration console with the execution output. Action can be re-run by using the up key on the keyboard
Action execution information
## Macros list
There is a [Macros list](/configuration-features/macros) available on the right side. Macro variables can be used as the template for substituting standard parameters into a Preset configuration in the Code input field while adding or editing the preset.
Macros list
# Macros list
A list of predefined Macros variables that can be used as templates for substituting attributes in the Preset configuration.
While creating or editing Preset or Action, it is possible to click on a macros field with the left mouse button to add it to the Code field while editing Preset in the Preset or Action form.
Below is a macro[ variables description](#macros-variables-description) along with examples to help you understand how it works.
What do each macros represent?
* `onu.serial_number` - serial number of the ONU
* `onu.port_interface` - ONU port interface
* `onu.qinq_free_vlan` - free qinq vlan ONU port
* `onu.onu_interface` - ONU interface
* `onu_number` - ONU number
* `onu.name` - ONU name
* `onu_type.value` - ONU type value
* `onu.mac_address` - ONU Mac address
* `onu.mac_address | split "."` - mac address of the current ONU, separated by the dot character
* `onu.mac_address | split "-"` - mac address of the current ONU, separated by the dash character
* `input_params.field_name` - field name input\_params
You can view examples of their samples in the [Macros variables description](#macros-variables-description).
### View macros info
Clicking on the view icon opposite a specific Macros opens a modal window with Macros details. The following fields are available:
* Name - Macros title
* Example - an example value
* Description - Description of Macros.
Specific macros view
You can **Close** the Macros view modal window after review.
## Macros variables description
#### onu.serial\_number
The macros substitute the ONU serial number. Example:
```clike
ZTEGC1282BD3
```
#### onu.port\_interface
The number of the port on which the ONU is located is substituted. Example:
```clike
gpon-olt_1/2/16
```
#### onu.qinq\_free\_vlan
Finds a free q-in-q vlan and substitutes its number.
```clike
vlan-smart-qinq ingress-port gpon-olt_1/12/5 cvlan 1074 to 1314 svlan 150
```
Example for the rule above:
```clike
1075
```
#### onu.onu\_interface
Substitutes the name of the ONU interface. Example:
```clike
gpon-onu_1/2/16:2
```
#### onu\_number
Finds a free ONU number on the port and substitute it. For example, there is a configured port
```csharp
interface gpon-olt_1/5/3
no shutdown
linktrap disable
onu 1 type universal sn ZTEGC041AF2B
onu 1 profile line 1000mb remote standart
onu 3 type universal sn ZTEGC6961A2E
onu 3 profile line 1000mb remote standart
onu 4 type universal sn ZTEGC0F4D2C9
onu 4 profile line 1000mb remote standart
```
There is no ONU with the number 2. EasyPON will determine that the number 2 is free and substitutes it in the configuration.
```clike
2
```
#### onu\_type.value
Substitutes the type selected by the user during registration. Example:
```clike
ZTE-F660-WIFI
```
#### onu.mac\_address
Substitutes the Mac address of the ONU. Example:
```kotlin
00005e0053af
onu.mac_address | split:"."
0000.5e00.53af
onu.mac_address | split:":"
00:00:5e:00:53:af
onu.mac_address | split:"-"
00-00-5e-00-53-af
```
#### input\_params.field\_name
Request the user to input a value that will be inserted into the ONU configuration code before its registration. For example:
```clike
property description {{input_params.name}}
```
During registration, the user will be requested for the name, which will be placed while applying the `onu.name` configuration.
# ONU workspace
This workspace allows you to manage your network units: make changes, configure it, find it on the map and simply use the monitoring features.
You have the [Find ONU](/onu-workspace/onu-search) tool in the main menu section where you can find ONU by MAC address or serial number or even the MAC address of the client's device on the OLT or Switch.
ONU Quick actions panel
To [register an ONU](/onu-workspace/onu-registration), locate a new ONU in the Unregistered ONU modal window by pressing the New ONU button. If the configuration has already been added to the [Preset list](/configuration-features/presets), you can easily apply it in this step.
You can get monitoring information on the [detailed ONU page](/onu-workspace/onu) by clicking on any View button in the table item on the [All ONU page](/onu-workspace/all-onu).
# ONU registration
You can register an ONU on the OLT in the EasyPON system using the Unregistered ONU modal window, which is called up from the main menu by pressing the X New ONU button, where X is the number of currently unregistered ONUs in the EasyPON system.
## Unregistered ONU
The Unregistered ONU modal window displays the complete list of ONUs that can be registered to the OLT using the existing configuration that was added in [Preset](https://app.archbee.com/docs/lY30u8w4Ej45vCHqsmBtW/9wfmoGkq8ifJUp7u_bjWb). It is also possible to use the Refresh button to manually update unregistered ONUs. In normal mode, the list of unregistered ONUs in the EasyPON system is periodically updated.
## ONU Registration
After selecting the "+" in the Action section in the Unregistered ONU table, open the Registration ONU dialog box. After filling in the сriteria of Type, Preset for ONU, Name, Preview Preset, and pressing the Apply button, the ONU will be registered. Before registration, it is possible to change the configuration by clicking the Edit button. After registration, it becomes available in the ONU list on the [All ONU](https://app.archbee.com/docs/lY30u8w4Ej45vCHqsmBtW/F5D_Qnyv1UDPnwrwsSLdw) page.
# ONU search
To search for ONUs and switches in the EasyPON system, use the Find ONU button located in the main menu.
## Find ONU
By opening the Find ONU modal, it becomes possible to search [ONUs](/onu-workspace/all-onu) and [Switches](/switch) by MAC address or ONU serial number, ONU, or Switch client MAC address. The found objects are displayed in the table below in the same dialog box.
For search results, the OLT name, its position on the OLT, ONU Mac address, and ONU view button are shown.
The switch name and port are shown for the found Switch.
It is possible to go to the search object by using the View link. The Mac address by which the search was performed will be highlighted by color.
## Last Found ONU
It is also possible to use the Last Found ONU list in the [Find ONU](/onu-workspace/onu-search) section to keep track of all ONUs that have been searched for in the EasyPON system for the last 24 hours.
# All ONU
A list of ONUs registered in the system in a tabular form with the data about it.
In the ONU main menu section, the All ONU page displays the list of ONU available in the EasyPON system In a summary table it is possible to filter and open a specific ONU page. It is also possible to Download filtered ONU tables and download reports in the [Reports](/reports) section.
## Quick Actions Bar
With the help of the Quick Actions Bar, you can view documentation of this section, view downloaded reports that were generated by the "Export to XLSX" option in the [Show downloads](/reports), manage ONu firmware versions by accessing the [Firmware versions](/onu-workspace/onu-variety) section, and view [Event logs](/event-log) and view [ONU Duplicates.](/onu-workspace/double-onu)
## Filter ONU list
The page consists of a Filters ONU list, by which it is possible to search for ONUs by all available criteria fields.
The Filter ONU list panel can be used to filter data in the ONU list table by the following fields:
**MAC/SN** - ONU MAC address/serial number
**OLT Name** - ONU name OLT Name - a drop-down list with the names of available OLTs in the EasyPON system
**Status** - ONU active status
**Slot** - slot number
**Port** - ONU port number
**Vendor -** ONU vendor
**Real type -** ONU real type
**Firmware version** - ONU firmware version
**Name** - ONU name
**Description** - ONU description
**ONU** - number of ONU on the OLT port
**Rx min** - the minimum value of the Rx signal
**Rx max** – the maximum value of the Rx signal
**Tx min** - the minimum value of the Tx signal
**Tx max** – the maximum value of the Tx signal
When a filter is applied, it is saved when moving between specific ONU pages and the All ONU page so you can always come back to it.
You can also use the Add saved search record and always have fast access for applying frequent search templates. You can always delete saved searches or clear the applied filter with the corresponding options.
## ONU list
On the ONU list, you can view the list of all ONUs which is available and synchronized in the EasyPON web application. You can also use "Export to XLSX" to generate reports and see the Amount of ONUs available in the ONU list table.
The view is a link to view the ONU. When clicked, a page with detailed information about [ONU](https://app.gitbook.com/o/FLfeqEYvh9QVB713VXQE/s/MviMfLPCHms6Yo2oirJF/~/changes/6/onu-main-page-about-all/onu) is opened.
# ONU detailed info
The ONU page displays data on the selected ONU and consists of several blocks.
[Quick actions panel](#quick-actions-panel) - quick commands are available on the quick actions panel that can be executed on the page or from the ONU\
[Information](#information) - general information about ONU\
[Stats](#stats) - Display of ONU statistical data\
[ONU Ports](#onu-ports) - ONU display with available ports and their status\
[ONU location](#onu-location) - functional of pointing ONU on the map and changing it\
[Ethernet ports](#ethernet-ports) - display of ONU Ethernet ports\
[Charts](#charts) - graphs with optical signal readings are displayed\
[Graph Tx/Rx](#graph-tx-rx) - the graph represents the readings of the optical Tx/Rx signal\
[Graph attenuations](#graph-attenuations) - the graph represents the readings of the attenuation signals on OLT and ONU The header additionally displays information about the ONU's MAC/SN. ONU name and description and OLT name with ONU position on OLT in "Shelf/Slot/Port:Number" format.
* **Shelf** - ONU position
* **Slot** - slot number
* **Port** - ONU port number
* **Number** – ONU number on the OLT port
## Quick Actions Panel
On the quick actions panel, quick commands are available that can be executed on the page or from the ONU:
* **Docs** - a hyperlink to the current ONU configuration page.
* **Back** - return to the [All ONU](/onu-workspace/all-onu) section.
* **Sync** - synchronize and update the latest ONU information in the EasyPON.
* **Configs** - display the current ONU config in the [ONU CLI](/onu-workspace/onu-command-line-interface).
* **Preset** - change the ONU configuration with the saved [Preset](/configuration-features/presets).
* **Action** - change custom ONU configuration by applying saved [Action](/configuration-features/custom-action).
* **Logs** - redirect us to the [Event logs](https://ep.stg.disoft.dev/log?base_content_type=21\&base_object_id=5193\&itemTitle=1%2F2%2F1%3A1\&page=1) page.
* **Reboot** - reboot ONU. It may be in offline or reboot status mode during the process.
* **Delete** - delete ONU from OLT in EasyPON. After deletion, it will be shown in the list of [unregistered ONUs](/onu-workspace/onu-registration#unregistered-onu) again.
Quick Actions Panel buttons
## Information
General information about ONU
* **Name** - ONU name provided during registration
* **ID** - ONU identifier
* **Firmware version** - firmware version
* **MAC/SN** - mac address or serial number of the ONU
* **OLT** - the name of the OLT on which ONU is registered
* **Configured type** - ONU configuration type
* **Real Type** - ONU type
* **Date created** - ONU registration date
* **Description** - a detailed description of the ONU
* **Address** - the address of the ONU location on the map.
## Stats
Displaying ONU statistical data in sections:
* **Status** - ONU status.
* **Uptime** - a time stamp that shows how many ONUs are online.
* **Date modified** - a time marker that shows how much time has passed since the last modification of the ONU.
* **Rx/Tx** indicators on OLT, ONU, and signal attenuation (Attenuation).
* **Last synchronized client MAC and VLAN** - a table of client MAC addresses assigned to the ONU.
ONU Stats
## ONU Ports
ONU display with available ports and their status. The connected port type and its operational status.
* **Port type** - port type (Auto, 10m/half(full), 100m/half(full), 1000m/full)
* **Port status** - administrative port status (Auto, Down)
## ONU location
Shows ONU's location on the map. If we move the mouse cursor over the label of ONU displays additional information, such as ONU's amount, address, status, and commentary.
Also If the map is extended there are 2 buttons:
* **Create building** - creating a new ONU location. You can view specific building information at [Building Workspace](/building-workspace).
* **Edit location** - edit an existing ONU location
{% hint style="info" %}
Notice, that even if ONU was deleted it keeps its location information after re-registration.
{% endhint %}
## Ethernet Ports
Ethernet Ports consist of table with futher fields:
* **Admin status** - the administrative status of the Ethernet port (can be Auto or Down)
* **Oper. status** - operational status
* **Vlans** - available Vlans ports
* **Type** - port type
* **Speed** - port speed
## Charts
This section displays graphs with readings of the optical signal, collected by periodic polling once every set number of minutes (hours). Attenuations and Tx/Rx signals are displayed in separate graphs.
## Graph Tx/Rx
The graph represents the readings of the optical Tx/Rx signal. It is possible to view data statistics for the last 24 hours, yesterday, 7, 30, and 90 days.
Press the indicator in the legend to isolate its view on the graph or press back to select and view all data again. You can also press the Command key on Mac or Windows key on PC for multiple indicators selection and viewing them on the graph.
## Graph attenuations
The graph represents the readings of the attenuation signals on OLT and ONU. Viewing data statistics for the last 24 hours, yesterday, 7, 30, and 90 days.
Press the indicator in the legend to isolate its view on the graph or press back to select and view all data again. You can also press the Command key on Mac or Windows key on PC for multiple indicators selection and viewing them on the graph.
# ONU Filmware versions
View ONU firmware versions variety by OLT
The ONU types list page displays the summary table of ONU firmware versions variety by OLT and the amount of such ONU to be found in the EasyPON system. You can locate this page from the [ All ONU](https://app.gitbook.com/o/FLfeqEYvh9QVB713VXQE/s/MviMfLPCHms6Yo2oirJF/~/changes/6/onu-main-page-about-all/all-onu) section.
## Filter ONU type
Filter ONUs with the following fields in the ONU types list table:
* Vendor
* Real type
* Firmware version
* ONU amount min
* ONU amount max
By clicking the ONU amount value it is possible to view the full list of ONU filtered by OLT and ONU firmware version parameters. This is necessary to understand the equipment variety in your network to help you manage it and update it in the future.
# Duplicated ONU
The Double ONU page displays the list of duplicated ONUs in the EasyPon system.
This section will help you manage the removal of unnecessary equipment from the OLT that requests information about the ONU and rid your system of storing this data.
On the Quick Actions Bar, you can download generated reports by "Export to XLSX" for generation reports by pressing the Show Downloads button, and return back to the[ All ONU ](/onu-workspace/all-onu)section. Also, it is possible to view this documentation section by pressing the Docs button.
Om Duplicates ONU table you can view duplicated ONU information, synchronize ONU information, Deelte, or view the specific ONU page.
# ONU command line interface
Configuring an ONU is an essential task for network administrators to ensure proper communication between the end-users devices and the broader network infrastructure. The process usually involves acc
**Accessing the ONU CLI** To view configuration, you need to access the ONU's CLI, which the Configs button can do in the quick access bar. After opening the output of the current ONU configuration will be shown.
**Basic Commands** The screenshot you've shared shows a set of commands available in the CLI. Here's a rundown of some common ones:
* `show_config` – This command displays the current configuration of the ONU. It’s useful for verifying changes or troubleshooting.
* `show_info -` displays detailed ONU information after registration if the "View config after apply" option was selected. This includes hardware specs, software versions, system uptime, network interfaces, and other crucial information.
* `run ` - re-apply [action](/configuration-features/custom-action). You can also add parameters to the command with the `--parameter_name value.`
* `help` - view all available commands.
* `exit` – This will close the current CLI session.
ONU configuration CLI
# Building workspace
Welcome to the EasyPON Building Workspace, a versatile platform designed to facilitate the assignment of ONUs (Optical Network Units) to buildings while providing a visual representation on a map.
Our platform is tailored to meet the needs of network administrators, ensuring efficient management of network infrastructure.
{% hint style="info" %}
There is UserSide integration available for synchronizing ISP buildings database with EasyPON. You can enable synchronization in the Settings > Integration section in the Main Menu.
{% endhint %}
With the intuitive map feature, users can easily assign ONUs to specific buildings, enhancing network organization and optimization.
Building location map and filters
EasyPON is committed to contributing to the efficiency and effectiveness of your network management tasks, leaving you with the peace of mind to focus on other important aspects of your work.
Whether you are a tech enthusiast, a professional, or simply someone seeking streamlined network management, Easypon offers a solution that ensures your network runs smoothly.
As you use EasyPON, you can trust in its reliability and user-friendliness, much like any reliable tool in your work arsenal.
# All buildings
On the All Buildings page, you can find information about buildings and add new ones. Each ONU in the system can be bound to the building instance to indicate the ONU location on the network map.
#### Quick Actions Bar
All buildings page
On the **Quick Actions Bar**, you can locate filters, which can be applied by
* OLT name - the name of the OLT was given during the OLT adding process
* Building type -a type of the building. There are two types private and apartment,
* Status - ONU status
* Card - ONU card number
* Port - OLT port number
Filter building panel
You can also locate filters on the Building location map.
Filter building on the map
You can also use the Add saved search record and always have fast access for applying frequent search templates. You can always delete saved searches or clear the applied filter with the corresponding options.
#### Building location
There are a few options available on the Building location map:
* Increase scale on the map
* Decrease the scale on the map
* Create building
* Search - search buildings by their address on the map
* Filter buildings
* Update ONU status on the visible area
**Create building**
You can add a new building by pressing the Create building button on the Building location map and indicate the new building location by assigning the exact mark on the map.
Fill inputs below in the Create building form and Save or Cancel changes:
* Building type - there are two types private and apartment
* Address - the address of the building which is bound to the map
* Entrances count - the number of building entries
* Floors count - the number of building floors
* Apartments count - the number of building apartments
* Description - specific brief description of the building
#### Building list
The building list indicates all added buildings to the EasyPON system.
Building list
There are a few fields available in the Building list table:
* № - number of the element in the table
* Name - name indicates the address of the building
* Apartments count - the number of building apartments
* ONU amount - the amount of the connected ONU in the building
* Entrances count - count of building entrances
* Floors count - count of the building floors
* View - the button to view full information about the building and the full list of oNU assigned to it.
# Building
This is a manual on how to assign an ONU to a building, view building information, and manage ONUs on the map and table within the Easypon web application:
**Viewing Building Information on the Page:**
1. **Select the Building:** On the All Building page, select the specific building you want to view information for by clicking on a view in the table.
2. **Building Details:** You'll now see a detailed view of the selected building. This view typically includes information like the building's name, address, and any other relevant details you've added.
* ID - unique building number
* Address - building location
* Coordinates - building location coordinates on the map
* Entrances count - amount of building entrances
* Floors count - amount of floors in the building
* Apartments count - the number of apartments in the building
* Description - specific building description
Building page
**Viewing Assigned ONUs on the Map and ONU list table:**
1. **Map View:**
* After selecting a building, navigate to the map view.
* ONUs assigned to the selected building will be marked on the map with their respective details.
* You can click on each ONU marker to get more information about that specific ONU.
2. **Table View:**
1. Look for an option like "ONU list" within the building details page.
2. To access a table listing all assigned ONUs for the selected building:
3. You'll find a table with columns displaying ONU details, including ONU name, OLT model, and ONU configuration parameters.
* OLT - OLT type the ONU assigned to
* Position - ONU position on the OLT
* Name - ONU name
* Description - ONE description
* MAC/SN - ONU MAC address or serial number
* ONU Rx - Rx parameters
* ONU Tx - Tx parameters
* Status - ONU's current status
* View - view specific [ONU page](/onu-workspace/onu) with details
House information and Map view
With the help of the **Quick Actions Bar**, you can view documentation of this section, return to the [All Buildings](/building-workspace/all-buildings) section, view downloaded reports that were generated by the "Export to XLSX" option in the table, filter the ONU list, or delete the current building.
Quick Actions Bar on the Building page
{% hint style="info" %}
Be careful to delete the building. Once deleted, all ONUs which was assigned to the building will lose their location information.
{% endhint %}
**Editing Building Location:**
1. **Select the Building map:** To edit the location of a building, start by selecting "Edit Building" and pointing to the new site of the building on the map.
Edit building form
1. **Edit Building Details:**
1. Look for an "Edit" option.
2. You can modify the building's location information, such as its coordinates or address.
* Building type - a type of building: private or apartments
* Entrances count - amount of building entrances
* Floors count - amount of floors in the building
* Apartments count - the number of apartments in the building
* Description - specific building description
3. Save the changes to update the building's information.
**Filtering Available ONUs:**
1. **Navigate to the ONUs Page:** To filter available ONUs, go to the ONUs management section, usually accessible from the main menu.
2. **Apply Filters:**
* You can apply filters to refine your search for available ONUs.
* Filters might include options like model, status, or location.
* Apply the desired filters to narrow down the list of ONUs.
3. **View Filtered Results:**
* The filtered ONUs will be displayed in a table, showing only those that meet your criteria.
Filter ONU list option
You can also use the **Add saved search** record and always have fast access for applying frequent search templates. You can always delete saved searches to clear the applied filter with the corresponding options.
By following these steps, you can efficiently assign ONUs to buildings, view building information, manage ONUs on the map and table, edit building locations, and filter available ONUs within the Easypon web application. If you have any further questions or need assistance, please consult further application's help center or support team.
# Event log
Basic information about Event logs section
The Event log section serves as a record of events and actions that occur within an organization. It maintains a chronological sequence of events, capturing important information such as timestamps, descriptions, and relevant details about each event. By capturing and preserving a detailed account of events, it becomes a valuable resource for troubleshooting, analysis, and security purposes.
**Where I can find it?**\
You can find Event logs menu on the several pages: ONU, OLT and SWITCH.
We can go to Event logs via button, which located in the upper right corner
**How it works?**\
Each event capturing and displaying in Event logs table. For example:\
\
1\. Open information about ONU
2. ONU information page is opened
3. Event displays in the Event logs table
# Dashboard
General EasyPON up-to-date statistics
## Main info
Main ONU information:
* All ONU units connected to EasyPON
* The number of OLT units that are not currently connected and polling ONU units
* The total number of ONUs with online status
* The total number of ONUs with offline status
ONU and OLT quantitative indicators in the EasyPON system
## Graphs
### Graph all ONU/Online ONU
The ratio of all ONUs and online ONUs in the period
* The total number of terminals in the EasyPON system for the time and date you choose
* Get the exact amount at a specific time by pointing to the graph
It is possible to view data statistics for the last 24 hours, yesterday, 7, 30, and 90 days.
Press the indicator in the legend to isolate its view on the graph or press back to select and view all data again. You can also press the Command key on Mac or Windows key on PC for multiple indicators selection and viewing them on the graph.
Graphical representation of the number of ONUs in the network to the total number of ONU
### Amount of errors by OLT in time
The graph represents the amount of appeared errors by OLT in time.
It is possible to view data statistics for the last 24 hours, yesterday, 7, 30, and 90 days.
Press the indicator in the legend to isolate its view on the graph or press back to select and view all data again. You can also press the Command key on Mac or Windows key on PC for multiple indicators selection and viewing them on the graph.
Graphs of indications are stacked - indications for each next value are superimposed on the previous one. On hover, you can view information about the number of ONU over time.
### Last found ONU
Block shows the ONU you have found in the last 24 hours in your account. You can see the search time basic information on ONU and follow the specific ONU page.
### Periodic Tasks
A block with the table that shows all active periodic tasks in the EasyPON system.
# Switch
The 'All Switches' section is a central feature of the EasyPON management interface, designed to facilitate the monitoring and management of network switches.
## Add Switch
The 'Add Switch' form in EasyPON is designed to facilitate the addition of new switches to your network. This manual section will guide you through each step of the process.
### Accessing the 'Add Switch' Form
To access the 'Add Switch' form:
1. Navigate to the 'All Switches' section of EasyPON.
2. Click on the 'Add Switch' button located in the Quick Access Bar at the top right of the page.
Add Switch form
### Completing the 'Add Switch' Form
The form requires you to input detailed information for the new switch:
* **Name** - Enter a unique name for the switch to identify it within the network.
* **IP Address** - Provide the IP address assigned to the switch.
* **SNMP Read Community** - Input the community string for SNMP read access.
* **SNMP Write Community** - Input the community string for SNMP write access.
* **Port SSH** - Set the SSH port, the default is usually 22.
* **SNMP Port -** Set the SNMP port, the default is usually 161.
* **Telnet Login -** Provide the login credentials for Telnet access.
* **Telnet Password -** Enter the password for Telnet access.
* **Telnet Port -** Set the Telnet port, often set to 23.
Fields marked with an asterisk (\*) are mandatory and must be filled out to proceed.
### Testing the Connection
Before saving the new switch details, you can test the connection to ensure that all credentials and addresses are correct. Look for a test button or link, often indicated by a looped arrow icon, to verify connectivity.
### Saving the Switch
After entering all the necessary details and testing the connection:
1. Review the information for accuracy.
2. Click the 'Save' button to add the switch to your network.
### Canceling the Process
If you need to exit the form without adding the switch:
1. Click the 'Cancel' button to discard any information entered.
2. You will return to the 'All Switches' list without adding a new switch.
The 'Add Switch' form is a straightforward tool for expanding your network's capabilities within the EasyPON interface. By following the above steps, you can ensure that each new switch is correctly added and configured for remote management.
The list of connected switches in the EasyPON system is presented in the form of a Switch List table. You can connect it easily by filling in the required fields:
## All Switches
### Quick Access Bar
Positioned on the top right of the 'All Switches' section, the Quick Access Bar offers tools for additional actions and settings. Key features include:
* **Docs -** A **l**ink to this manual article.
* **Show downloads -** A shortcut to view all the downloaded files from the system.
* **Event logs -** Provides immediate access to the log records of events on the switches.
* **Add Switch -** This button allows you to seamlessly add new switches to your network.
These tools are designed to enhance user experience by providing quick access to frequently used features within the EasyPON interface.
### Filter Switches
To refine the switches displayed in the switch list, use the 'Filter Switches' panel at the top of the 'All Switches' section. You can filter switches by:
* **Name -** Enter the name of the switch to find specific devices quickly.
* **IP Switch -** Input the IP address to locate switches by their network address.
* **Switch Type -** Select from a dropdown menu to filter switches based on their type or model.
Once the filters are set, you can close the filter panel to maximize screen real estate for the switch list view.
### Switch List
The 'Switch List' displays all the switches within the network in a tabular format. Essential details like the switch number, name, and IP address are listed for easy identification. Each entry has a 'View' button, enabling detailed inspection of a particular switch. For enhanced navigability, the switch list supports pagination.
The 'Amount' option shows the number of switches you wish to view per page. Furthermore, there's an option to export the list to an XLSX file, offering a convenient way to handle data offline or for reporting purposes. You can download all generated reports in the [Reports](/reports) section.
The 'All Switches' section of EasyPON provides a comprehensive overview of the network's switches. With the Quick Access Bar, filtering options, and a paginated switch list, network administrators can effectively monitor and manage their network infrastructure.
## Switch page
The 'Switch' page in the EasyPON interface allows you to manage individual switches within your network. This section of the manual covers the use of the Quick Access Bar and the Information section on the Switch page.
### Quick Access Bar
The Quick Access Bar on the 'Switch' page includes several functional icons that allow you to perform various tasks:
* **Back Arrow -** Returns you to the previous page, usually the 'All Switches' list.
* **Event Logs -** This directs you to a log of all events related to this particular switch, which is crucial for troubleshooting and monitoring purposes.
* **Synchronize -** The synchronize function enables you to update the switch's configuration and status in real-time to ensure that the data displayed is current.
* **Delete -** Delete OLT from the EasyPON system,
Quick access bar of the Switch page
These icons are designed to provide quick access to frequently used functions, enhancing the efficiency of switch management.
### Information
Below the Quick Access Bar, the Information section provides detailed data regarding the switch:
* **Hostname -** Shows the name assigned to the switch within the network.
* **Username -** The username used for accessing the switch, often for secure shell or web access.
* **Name SNMP -** Displays the SNMP (Simple Network Management Protocol) name for the switch, used for monitoring and management.
* **SNMP port -** The network port number assigned to SNMP traffic, typically 161.
* **Telnet port -** Reveals the port number used for Telnet access, generally set to 23.
* **Port SSH -** Indicates the port used for SSH (Secure Shell) access, commonly 22.
This section is essential for network administrators to view and manage the network settings associated with the switch.
### Ports
The block displays the list of ports on the switch in tabular form. The following information is available in the table:
* **Port -** The physical port number on the switch.
* **Name -** An assigned name or identifier for the port.
* **Admin Status -** Displays whether the port is administratively up or down.
* **Oper. Status -** Shows the current operational status of the port (whether it's actively up and transmitting data).
* **Vlans -** Lists the VLAN IDs associated with the port.
* **Type -** Indicates the port type, such as access or trunk.
* **Client MAC address -** Displays the MAC addresses of clients connected to that port.
Specific Switch page
This comprehensive overview allows for effective monitoring and management of individual port statuses and configurations.
You can also change the Admin Status on the switch port. Also, each port displays the client MAC addresses on which the [global search](/onu-workspace/onu-search) works.
### Admin Status change
By clicking on the port Admin Status icon in the table, you can change the administrative status on the Switch port. Also, each port displays the client MAC addresses on which the [global search](/onu-workspace/onu-search) works.
Admin status change action on Switch port dialog
### Event logs
We added an Event log button to the Switch detailed info page for your convenience. It will navigate you to the filtered [Event log page](#event-logs) by specific Switch, you would like to see changes with.
### Synchronize
By clicking the Synchronize button located in the Quick Actions Bar section on the Switch page, it is feasible to synchronize the connection and data with the existing Switch. Once the synchronization process is successful, all data related to the Switch should be current and up-to-date.
### Delete Switch
The Switch can be deleted by pressing the Delete button in the Quick Actions Bar section on the Switch page. To delete Switch from the EasyPON system user confirmation is required.
Delite Switch confirmation dialog
The 'Switch' page in EasyPON is a powerful interface for detailed management of each switch in your network. By utilizing the Quick Access Bar and comprehending the Information section, network administrators can efficiently oversee the functionality and performance of their network switches.
# Reports
The report section within EasyPON has been designed to allow you to download generated reports with data in XSLX format for your personal use.
You have the flexibility to download any information from the table, regardless of whether it has been filtered or not. Generating a comprehensive report based on your selection may require some time for the system to process. However, you will receive a notification once the report is ready, and the action button will become active, enabling you to proceed with the download.
The Reports section can be located mostly in every section of EasyPON. To get to the section click the **All Downloads** button in the Quick Actions Bar.
"Show downloads" button in "All ONU" section
## ONU List Section Report
Download generated reports from the ONU list section. The reports are generated in electronic table format and can be found in the Reports section. You will be redirected after the report generation or can get there later. All the reports are kept in the EasyPON system for 30 days.
Reports can be generated also by applying the filters to the ONU list, pressing the **Export to XSLX** button, and confirming the generating process.
After report generation, you can download the generated report from the Reports list by pressing the **Action** button to the corresponding report in the table. After the confirmation report will be downloaded.
# EasyPON Information
This section describes general EasyPON information like license pricing, supported hardware and functionality. You can also view the release history on the Releases page
* Supported hardware
* ONU functions
* OLT functions
* Releases History
# Supported hardware
It is possible to use GPON OLTs 4/8/16 port and EPON OLTs 4/8/16 ports versions of the following vendors and models:
* ZTE C220
* ZTE C300
* ZTE C300v2
* ZTE C320
* ZTE C320v2
* ZTE C620
* BDCOM P3310B
* BDCOM P3608B
* BDCOM P3310C
* BDCOM GP3600-08B
* BDCOM P3600-08E
* BDCOM GP3600-16B
* BDCOM P3600-16E
* Huawei MA5608T
* Huawei MA5603T
# ONU functions
Supported ONU cards functionality
EP version: 2.3.15
| | ZTE C300 V1 GPON Card | ZTE C300 V2 GPON Card | ZTE C320 V1 GPON Card | ZTE C320 V2 GPON Card | ZTE C220 EPON Card | ZTE C300 V1 EPON Card | ZTE C300 V2 EPON Card | ZTE C320 V2 EPON Card | BDcom P3310B EPON Card | BDcom P3310C EPON Card |
| ----------------------------------------- | --------------------- | --------------------- | --------------------- | --------------------- | ------------------ | --------------------- | --------------------- | --------------------- | ---------------------- | ---------------------- |
| Delete onu | + | + | + | + | + | + | + | + | + | + |
| Get onu ethernet port admin status | + | + | + | + | + | + | + | + | + | + |
| Get onu status | + | + | + | + | + | + | + | + | + | + |
| Get onu tx | + | + | + | + | + | + | + | + | + | + |
| Get onu last online | + | + | + | + | + | + | + | + | + | + |
| Get onu firmware version | + | + | + | + | + | + | + | + | + | + |
| Get onu ethernet port oper status | + | + | + | + | + | + | + | + | + | + |
| Get onu dist | + | + | + | + | + | + | + | + | + | + |
| Get onu description | + | + | + | + | + | + | + | + | + | + |
| Get olt rx | + | + | + | + | + | + | + | + | + | + |
| Reboot onu | + | + | + | + | + | + | + | + | + | + |
| Set onus port admin status | + | + | + | + | + | + | + | + | + | + |
| Get onu rx | + | + | + | + | + | + | + | + | + | + |
| Get onu registration config for migration | + | + | + | + | + | + | + | + | - | - |
| Get onu vendor | + | + | + | + | + | + | + | + | - | - |
| Get onu uptime | + | + | + | + | + | + | + | + | - | - |
| Prepare config for migration | + | + | + | + | + | + | + | + | - | - |
| Get onu name | + | + | + | + | + | + | + | + | - | - |
| Get onu real type | + | + | + | + | + | + | + | + | - | - |
| Get ethernet tag vlan | + | + | + | + | + | + | + | + | - | - |
| Get onu ethernet port speed | + | + | + | + | + | + | + | + | - | - |
| Get onu config type | + | + | + | + | + | + | + | + | - | - |
| Get ethernet vlans | + | + | + | + | + | + | + | + | - | - |
| Get ethernet untag vlan | + | + | + | + | + | + | + | + | - | - |
| Get ethernet type ports | + | + | + | + | + | + | + | + | - | - |
| Get onu mac address | - | - | - | - | + | + | + | + | + | + |
| Get onu serial | + | + | + | + | - | - | - | - | - | - |
| Get qinq vlan | + | + | + | + | - | - | - | - | - | - |
| Get slot qinq ports | + | + | + | + | - | - | - | - | - | - |
| Set onus port speed | + | + | + | + | - | - | - | - | - | - |
| Get service ports | - | - | - | - | - | - | - | - | - | - |
# OLT functions
Supported OLTs functionality
EP version: 2.3.8
| | ZteC300v2 | ZteC320v2 | ZteC220 | ZteC300 | ZteC320 | HuaweiMa5608tOlt | BdcomP3310BOlt | BdcomP3310COlt |
| ------------------------------ | --------- | --------- | ------- | ------- | ------- | ---------------- | -------------- | -------------- |
| Save olt config | + | + | + | + | + | + | + | + |
| Check snmp connection | + | + | + | + | + | + | + | + |
| Configuration mode commands | + | + | + | + | + | + | + | + |
| Prepare ssh telnet response | + | + | + | + | + | + | + | + |
| Get olt name | + | + | + | + | + | + | + | + |
| Get olt tx | + | + | + | + | + | + | + | + |
| Has error in remote response | + | + | + | + | + | + | + | + |
| Get slots config type | + | + | + | + | + | + | + | + |
| Get shelf | + | + | + | + | + | + | + | + |
| Get slot temperature | + | + | + | + | + | + | + | + |
| Get slot cpu | + | + | + | + | + | + | + | + |
| Get slot memory | + | + | + | + | + | + | + | + |
| Get slot status | + | + | + | + | + | + | - | - |
| Get unregistered onus | + | + | + | + | + | + | - | - |
| Get slot sw | + | + | + | + | + | + | - | - |
| Get slot hw | + | + | + | + | + | + | - | - |
| Add community | + | + | + | + | + | + | - | - |
| Delete community | + | + | + | + | + | + | - | - |
| Get slot | + | + | + | + | + | - | - | - |
| Get time | + | + | + | + | + | - | - | - |
| Get port magic for port status | + | + | + | + | + | - | - | - |
| Get olt version | + | + | + | + | + | - | - | - |
| Olt port check | + | + | + | + | + | - | - | - |
| Olt port set | + | + | + | + | + | - | - | - |
| Activate ssh | + | + | + | + | + | - | - | - |
| Get port magic v2 | + | + | - | - | - | - | - | - |
# Release History
## v2.3.20 - 2024-03-13
***
## v2.3.19 - 2024-02-16
***
## v2.3.18 - 2024-02-01
***
## v2.3.17 - 2024-01-16
***
## v2.3.16 - 2023-12-12
#### Changes:
* Fixed error during switch initialisation
* Allowed changing username and email from the user profile page
* Added users avatars in general list of users and to the profile
* Added support for the OLTs: BDCOM P3600-16E, BDCOM GP3600-16B, GP3608B
* Added support for the new OLT: BDCOM GP3600-08B. (fbb0933b)
* Optimized time for display of detailed info about OLT on the OLT page
* Cleared ONU ethernet ports and client macs when ONU was deleted.
* Added user avatars to event log detailed page
* Added the new 404 page look
* Created redirection from detailed OLT page to periodic tasks table for this OLT
* Blog to the Website! We started our blog and very exited about it!
***
## v2.3.15 - 2023-11-13
#### Changes:
* Increased productivity of ONU registration on OLT ZTE C220
* Added the error messages on impossible license syncronization with the EasyPON server
* Fixed ONU deletion on the BDCOM 3310 OLTs
* Log entry improvements.
* Improved establishing SSH connection with OLT
* Added button to syncronize license status with the server
* Added feature of search ONU by its location.
* Handle error from invalid response during updating OLTs tx value. (36bb7ddb)
* Implemented a new method for the ONU deletion on Huawei OLTs. Reduced total process execution time by a factor of 10.
* Increased speed of get ONU on the specified card or port for the Huawei OLTs.
* Fixed displaying new installed version after upgrading EasyPON.
* Fixed port oper and admin status for BDCOM OLTs. Added Loss and PowerOFF statuses for ONU on this vendor.
* Changed services in the Debian installation to make it run better.
* Added functional of enable/disable public API
* Added filters for the ONU firmware variety table
* Redesigned OLT reply in the log, formatted as the terminal output. (2bec47c4)
* Added switch info for public API
* Updated public API: added config type to the ONU detail response and created new endpoint for detail config type response in the directory.
***
## v2.3.14 - 2023-09-22
#### Changes:
* Fixed installation
***
## v2.3.13 - 2023-09-22
#### Changes:
* Added some endpoints for the public API: onu types, olt types, custom action
* Removed external modules from the requirements (998e6ba2)
***
## v2.3.12 - 2023-09-20
#### Changes:
* Implemented secure auth module for the user profiles
* Fixed ONU filtering by mac and ordering by another field at the same time. (f3daeaa7)
* Fixes for system stability response
***
## v2.3.11 - 2023-08-31
#### Changes:
* Reduce task chunk amount for OLT ZTE c220
* Added detailed endpoint for report files
* Building map and table filters have been changed on to work with statuses and filters by OLT
* New methods to get ONU MAC-addresses from Userside by integration
* The comment section for ONU was added for use on each page of ONU detailed information
* Added block for application configuration to a non-existing ONU
* Fixed the missing ONU amount in generated reports on the All OLT page
* Added variety of statuses that are given by OLT BDCOM P3600-08E to see in the EasyPON
* The building types on the map and in general table now can be filtered and be seen differently by the icon as apartment buildings and private houses
***
## v2.3.10 - 2023-08-07
***
## v2.3.9 - 2023-07-24
#### Changes:
* The ONU autoregistration on 220 ZTE OLTs for additional clients were fixed (c18a636)
* Added the retry attempts to send command for the ONU registration
* Changed balance information in license by adding user address
* Added not showing the deleted ONUs on a building map (4c73cfd)
* Added new endpoint for external API (42f26ec)
* Set timeouts for cache keys (2f8247e)
* Move this documentation files to the correct folder for a right ordering (05fd9d0)
* Fixed proccess of getting ONU configs on BDCOM OLTs (467deea)
***
## v2.3.8 - 2023-07-13
#### Changes:
* Minor fixes of frontend layout (cff5d0f)
***
## v2.3.7 - 2023-07-12
#### Changes:
* Code refactoring (d3c300e)
* Added new statuses for building and to the filter (6c33c8f)
* Added filters by slots and ports to the building map (45993cf)
* Reduced DB queries (2aa3264)
* Added more info about author to the Event log section (c62a7d5)
* Forbid celery remote control (af06d42)
* Added usage of update methods to change port's admin status (33c9bd4)
***
## v2.3.6 - 2023-07-04
#### Changes:
* method for send and receive commands with retry (d0dd251)
* Merge branch 'EP-000/fix\_bdcom\_olt\_creating' into 'stg' (8c448f3)
* fix BDCOM olt snmp protocol connection check and adding new one (4e9b45b)
* Added Userside check connection with data from user or from the settings (fe6a3a3)
* Opportunity to enable Userside sync and Google auth flag in the settings(d0b2269)
* Limited max retries and added timeout for OLT ZTE c220 ONU configuration(3747b37)
* Assigned new default permissions to the admin group (516a7c5)
* Fixed OLT SNMP protocol connection checking and adding new one for BDCOM vendors (78ac96a)
* Added external API schema (559a073)
* Awaken an error when the port operational status is unknown (5c7d9fd)
* Set port status as unknown when OLT does not response with the information about it (0be0975)
***
## v2.3.5 - 2023-06-21
#### Changes:
* Generated titles for log entry (f00af8e)
* Fixed registering ONU when number on port is unavailable (4a4c2de)
* Minor fixes for enhancing user experience satisfaction
***
## v2.3.4 - 2023-06-20
***
## v2.3.3 - 2023-06-20
***
## v2.3.2 - 2023-06-16
#### Changes:
* Fixes on the functional of ONU port migration (150f665)
* Changed default interval for periodic tasks (6e48c59)
* Fixes on ONU task status receiving (5687238)
* Added collecting of requested IP address(d8450d5)
* Started to update main ONU info on sync and refresh buttons from DB (55888cb)
* Separation of the templates and custom actions in a list through the system (a4c7241)
***
## v2.3.1 - 2023-06-13
#### Changes:
* fix mac assigment in userside integration (537c7be)
* Merge branch 'EP-000/more\_descriptive\_title\_for\_patch\_log\_entry' into 'stg' (0989103)
* added changed data to the title of log entry (3294376)
* Merge branch 'EP-000/fix\_get\_onu\_mac\_from\_user\_info' into 'stg' (fd5c754)
* use suppress context manager (dca7401)
* fix get onu mac or serial from userside user info (3d28ec1)
* Merge branch 'EP-000/add\_ordering\_by\_title\_to\_account\_logs' into 'stg' (fe215d4)
* added ordering by title (6e7175e)
* Merge branch 'EP-000/add\_page\_size\_to\_map\_building' into 'stg' (a99ee45)
* replaced paginator with increased page size (48547d8)
* Merge branch 'EP-1025/validate\_onu\_instances\_with\_serializer' into 'stg' (fca4f54)
* Merge branch 'EP-000/fix\_setting\_userside\_fields' into 'stg' (badf76d)
* Merge branch 'EP-000/fix\_kwargs\_assigment\_in\_api\_logging' into 'stg' (37f1f5a)
* validate onu instances with serializer (b66d621)
* fix settings for userside integration (3933b50)
* create signal kwargs on class initialization (a524912)
* Merge branch 'EP-000/fix\_client\_group\_assigment' into 'stg' (cf4aa13)
* fix retrieving crontab for tasks (aa4d4ea)
* fix retrieving crontab for tasks (b1da729)
* add client to admin site (5dd062b)
* fix group creation when not exists (a221259)
* Merge branch 'EP-000/remove\_not\_exists\_task' into 'stg' (eeded54)
* Merge branch 'EP-000/fix\_loging\_failed\_requests' into 'stg' (ab704e8)
* Merge branch 'EP-000/fix\_userside\_request\_serivce' into 'stg' (1e7c96b)
* remove not exists task (cf7c15e)
* fix log error on failed request (c9be74e)
* fix request args (ad5d1f2)
* Merge branch 'EP-1076/filtering\_and\_ordering\_building\_list' into 'stg' (09d27de)
* remove redundant serializer (c16c12b)
* created filters and split serializers (69f0331)
* Merge branch 'EP-000/add\_pagination\_to\_building\_map' into 'stg' (7a8edf0)
* add pagination to building map (214444a)
* Merge branch 'EP-000/return\_all\_buildings\_on\_map' into 'stg' (262ae72)
* Resolve EP-000 "/return all buildings on map" (70909ef)
* Merge branch 'EP-000/include\_onu\_magic\_and\_olt\_type\_in\_onu\_response' into 'stg' (ddb617d)
* add onu magic and olt type in external onu response (eda168d)
* Merge branch 'EP-000/send\_domain\_name\_on\_sync\_license\_request' into 'stg' (6d0dd0c)
* send domain name in header on check license requests (d67d098)
* Merge branch 'EP-000/add\_onu\_list\_to\_building' into 'stg' (3755d5d)
* Resolve EP-000 "/add onu list to building" (90f63d2)
* Merge branch 'EP-1057/userside\_integration\_settings' into 'stg' (559cb1b)
* Resolve EP-1057 "/userside integration settings" (a8250c8)
* Merge branch 'stg' into 'master' (34f12f7)
* Fix filtering in map building (7751d9e)
* Merge branch 'stg' into 'master' (2865952)
* Exclude from map building empty buildings (9ca4343)
* Merge branch 'stg' into 'master' (d5fa64d)
* Add celery integration to sentry sdk (a9cf1e3)
* Change crontab of userside sync (507c2a2)
* Merge branch 'stg' into 'master' (b39dbdd)
* Merge branch 'EP-1059/add\_permission\_to\_config\_endpoint' into 'stg' (61c7c12)
* Resolve EP-1059 "/add permission to config endpoint" (03db858)
* Merge branch 'EP-000/fix\_get\_qinq\_ports' into 'stg' (b79c9c0)
* fix retrieving qinq port (97ac61d)
* Merge branch 'EP-1048/save\_search\_filters' into 'stg' (d21f575)
* Save and manage filters the user uses to filter some data in different modules. (47a6c5d)
* Change format of geopoint in map\_building (2077d63)
* Merge branch 'EP-1025/transfer\_onu\_location\_and\_notice\_after\_dublicate\_deletion' into 'stg' (ba793ce)
* Resolve EP-1025 "/transfer onu location and notice after dublicate deletion" (6df012e)
* Fix switch urls (46d71ca)
* Merge branch 'EP-759/switch\_topology' into 'stg' (9e83aa4)
* Add switch topology graph (9d9fc15)
* Merge branch 'EP-000/cherry\_pick\_card\_type\_to\_external\_onu\_api' into 'master' (726de9d)
* added connection type to external onu api response (c108634)
* Merge branch 'EP-000/add\_card\_type\_to\_external\_onu\_api' into 'stg' (ea94f0d)
* added connection type to external onu api response (73c1a6a)
* Add type of userside synchronization (a642b6d)
* Merge branch 'EP-1015/change\_invalid\_login\_description\_message' into 'stg' (ba5ce34)
* Merge branch 'EP-1014/logout\_user\_after\_deactivating' into 'stg' (8247c19)
* change invalid login description message (3747b18)
* logout user after deactivating (4eca60d)
***
## v2.3.0 - 2023-05-18
#### Changes:
* Merge branch 'stg' into 'master' (e11a482)
* Rename some settings (68bbc2e)
* Merge branch 'master' into stg (dd0d43a)
* Fix configuration with live settings (07475ea)
* Done with config in web (f9c95fc)
* Done with adding building to onu (37b964a)
* Add views/serializers for buildings and clients (af2391f)
* Done with buildings and clients (b768c8e)
* Add migration (4a1dede)
* Add integration for userside, now you can import geolocation onu (a4e6f7e)
* Update disprofile module (b882b4b)
* Add near onu geolocation (920ac3c)
* Merge branch 'EP-000/fix\_searching\_soft\_deleted\_onus' into 'stg' (f2cfbd4)
* Fix registering onu on deleted onu. (d0642c3)
* Merge branch 'EP-000/init\_olt\_cache\_task' into 'stg' (f30824c)
* Add detail task information about initialise OLT. (34f1690)
* Merge branch 'EP-000/fix\_creating\_onu\_config\_type\_on\_huawei\_ilt' into 'stg' (8b1427f)
* Fix onu config type creating on Huawei olt. (607e04d)
* Merge branch 'EP-000/fix\_clear\_deleting\_old\_report\_files' into 'stg' (44bd020)
* Remove damaged reports after unsuccessful file downloading. (085058a)
* Merge branch 'EP-000/fix\_updating\_task\_status\_on\_long\_tasks' into 'stg' (64d58ab)
* Fix onu task status changes. (b5c685d)
* Merge branch 'EP-000/handle\_snmp\_error\_on\_onu\_reboot' into 'stg' (3fe5f32)
* Return descriptive message when try to reboot onu and get the connection error. (78c153b)
* Add release to sentry tracking (250da80)
* Fix clients mac on huawei (9c851d5)
* Add find by hexed serial number onu (25aa30b)
* Merge branch 'EP-000/cherry\_pick\_fix\_onu\_tasks' into 'master' (505e319)
* Fix onu update tasks (e6f7c46)
* Skipped slots without qinq (bb6b87d)
* Merge branch 'EP-000/connect\_status\_information\_with\_update\_onu\_tasks' into 'stg' (d29df40)
* Fix onu update tasks (d787667)
* Merge branch 'EP-000/fix\_update\_vlans\_task' into 'stg' (5b5a49f)
* Fix update onu ethernet vlans tasks. (c85d573)
* Merge branch 'EP-954/format\_response\_from\_custom\_actions' into 'stg' (c2d74ae)
* Formatted custom action result response. (11990b6)
* Merge branch 'EP-822/additional\_ordering\_for\_some\_tables' into 'stg' (8c7316c)
* Added ordering to for onu port migration and file report tables. (2a19963)
* Merge branch 'EP-948/remove\_reports\_with\_non\_exisiting\_files' into 'stg' (299142e)
* Clear not existing files and delete them from the filesystem. (f7f0e37)
* Merge branch 'EP-000/show\_onu\_as\_base\_object\_in\_applied\_presets' into 'stg' (763515d)
* Improved onu filtering in logs. (2420155)
* Merge branch 'EP-988/onu\_soft\_deletion' into 'stg' (f5afd7e)
* Log can handle the entire onu history. After onu deletion, it does not remove from db. (85dcc5a)
* Add version checker for huawei (56a90d0)
* Change commands for show config in huawei (a3d353a)
* Fix reboot on huawei (4a368e4)
* Fix full update onu on huawei (cab7422)
* Merge branch 'EP-980/add\_huawei\_support' into 'stg' (942ab9a)
* Add support of Huawei MA5608T. (9540005)
* Merge branch 'EP-964/client\_can\_set\_google\_keys\_for\_oauth2' into 'stg' (64a0208)
* make google keys not required (022017f)
* Merge branch 'EP-000/change\_endpoint\_for\_release\_check' into 'stg' (f7e0b51)
* It was improved receiving latest release information. Now get the version that matches client requirements. (267121d)
* Merge branch 'EP-959/show\_is\_user\_member\_of\_admin\_group' into 'stg' (34c008e)
* Show notification for admin users if a new version of EeasyPON was released. (a1e4374)
***
## v2.2.2 - 2023-05-01
#### Changes:
* Merge branch 'stg' into 'master' (c869301)
* Stg (5070bd3)
* Merge branch 'EP-000/add\_action\_permissions' into 'master' (acdb91f)
* Created permission for custom onu action. (4a8fded)
***
## v2.2.1 - 2023-04-27
#### Changes:
* Merge branch 'stg' into 'master' (ed310bd)
* Fix update onu on ZTE GPON (0b33d05)
***
## v2.2.0 - 2023-04-27
#### Changes:
* Release v2.1.1 (982ac49)
* Update .gitlab-ci.yml file (a2e4a18)
* Merge branch 'stg' into 'master' (c32a656)
* Fix problem with compiled version (cb893d1)
***
## v2.1.1 - 2023-04-27
#### Changes:
* Update .gitlab-ci.yml file (a2e4a18)
* Merge branch 'stg' into 'master' (c32a656)
* Fix problem with compiled version (cb893d1)
***
## v2.1.0 - 2023-04-27
#### Changes:
* Merge branch 'stg' into 'master' (07e33df)
* Merge branch 'EP-000/fix\_template\_variable\_migration' into 'stg' (99f52d2)
* Fix install issue with DB migration. (03db83c)
* Fix problem with infinity get all onu on some ZTE (6c6e247)
* Fix problem on c320 with "No such instance" on get onu status (60459eb)
* Merge branch 'EP-000/find\_olt\_timezone\_based\_on\_retrieved\_time' into 'stg' (58752c1)
* Changed method for retrieving olt timezone to improve time calculation. (576fef3)
* Merge branch 'EP-946/fix\_editing\_periodic\_tasks' into 'stg' (7989163)
* Fixed error when trying to update periodic tasks. (5b5866e)
* Merge branch 'EP-000/fix\_shelf\_retrieving\_on\_c220\_olts' into 'stg' (4b2b435)
* Fixed error on retrieving shel information on ZTE C220 olts. (fc40d8a)
* Merge branch 'EP-000/set\_name\_for\_deleted\_onu\_on\_onu\_configruation\_log\_entry' into 'stg' (64b7037)
* Increased description information about config onu log entry. (62134b9)
* Fix migrate onu on another port (19bbfe2)
* Disable prefetch related in olt viewset (b243cad)
* Merge branch 'EP-000/additional\_fields\_to\_log\_list' into 'stg' (4a178ee)
* Show additional info about the object in the main user log table. (9091164)
* Merge branch 'EP-000/remove\_view\_switch\_logentry' into 'stg' (eb78d4d)
* Remove logging every view action on the switch and switch port. (7bb4929)
* Merge branch 'EP-000/onu\_port\_number\_macros' into 'stg' (c987b52)
* New macros for retrieving onu port number (8bad61b)
* Merge branch 'EP-926/change\_description\_for\_xlsx\_export\_when\_filters\_are\_not\_set' into 'stg' (61e098a)
* A more informative description of the Excel exported file. (f348f53)
* Merge branch 'EP-922/total\_onus\_counter' into 'stg' (83cb743)
* Added to background task that scans all "onus" on the olt more detailed information about each record.\
Implemented a counter to keep track of the total number of ONUs found when scanning them on OLT. (3792717)
* Merge branch 'EP-000/update\_install\_instruction' into 'stg' (ba99a28)
* Updated install instructions (25e7fda)
* Merge branch 'EP-000/get\_google\_client\_id\_endpoint' into 'stg' (497691b)
* Retrieve Google client id for oauth2 authentication. (79ebeb7)
* Add redis to ci/cd (dffe609)
* Add redis to ci/cd (103f6e5)
* Add redis to ci/cd (1b444e8)
* Add redis to ci/cd (f744867)
* Done with export documentation to gitbook (d9107f0)
* Done with export documentation to gitbook (6800d06)
* Done with export documentation to gitbook (e1af4cc)
* Done with export documentation to gitbook (d5d41ef)
* Done with export documentation to gitbook (e50a8e1)
* Done with export documentation to gitbook (ff09f6d)
* Done with export documentation to gitbook (a31d634)
* Done with export documentation to gitbook (9ba1d43)
* Done with export documentation to gitbook (830ffcd)
* Add override xclsx name for olt classes (3317a2c)
* Merge branch 'EP-000/change\_location\_map\_route' into 'stg' (d8f6790)
* Changed location map route. (e8e78cb)
* Merge branch 'EP-000/fix\_onu\_location\_retrieving' into 'stg' (26b2b41)
* Fixed onu location retrieving (63cef46)
* Add cache-control to allow headers (db2c1ed)
* Test clear cache endpoint (1dfa70d)
* Merge branch 'EP-000/hide\_internal\_periodic\_tasks' into 'stg' (89551c0)
* Removed the internal periodic tasks from the request result, so now users will only see the main tasks associated with them. (8dedbd9)
* Merge branch 'EP-819/save\_front\_filters' into 'stg' (46a718b)
* Added ability for users to save and retrieve filter parameters. (be73aef)
* Merge branch 'EP-820/create\_install\_md\_file' into 'stg' (4149dbc)
* Added installation instructions for EasyPON. (496bf5e)
* Merge branch 'EP-888/add\_new\_fields\_to\_onu\_logs' into 'stg' (d026ff1)
* Improve ONU logging to include information on retrieval and applying configuration results: success and failure. (bcefcc4)
* Merge branch 'EP-899/merge\_migrations' into 'stg' (da92e29)
* Resolve EP-899 "/merge migrations" (7142e3b)
* Merge branch 'EP-899/add\_permission\_for\_onu\_duplicates' into 'stg' (c791550)
* Implement access control for dedicated source with new 'Can view onu duplicates' permission (f5ae1d0)
* add celery-expoter binary adn systemd service (49e2c1a)
* Merge branch 'EP-895/get\_olt\_name\_on\_the\_olt\_creation' into 'stg' (decdba2)
* Simplify the OLT registration process with the minimal required info: IP, login, pass, and olt type (30c8973)
* Merge branch 'EP-907/add\_offline\_time\_to\_duplicates\_onus\_on\_detail\_onu\_edpoint' into 'stg' (691dbbd)
* Resolve EP-907 "/add offline time to duplicates onus on detail onu edpoint" (eb4648b)
* Merge branch 'EP-907/add\_field\_with\_onu\_duplicates\_to\_detail\_onu' into 'stg' (04d8758)
* Implemented new feature for detail page that allows users to view a list of duplicated ONUs, if they exist. (6f27c17)
* Merge branch 'EP-903/remove\_ru\_description' into 'stg' (9df91a6)
* Streamlined project language support by keeping only English descriptions. (e81eaa2)
* Merge branch 'EP-822/add\_ordering\_for\_all\_tables' into 'stg' (8da11e8)
* Implemented new feature: Ordering filter now available for all tables. (e665ddd)
* Merge branch 'EP-884/remove\_olt\_name\_from\_onu\_firmware\_variety\_list' into 'stg' (59771d2)
* In the onu firmware variety list, all rows are not grouped by olt. (6319bbb)
* Merge branch 'EP-847/change\_start\_time\_for\_tasks' into 'stg' (a6b4e2d)
* Resolve EP-847 "/change start time for tasks" (4ca46db)
* Merge branch 'EP-872/translate\_permissions' into 'stg' (410955c)
* edit all permissions name (250d4db)
* Merge branch 'EP-847/rework\_olt\_periodic\_tasks' into 'stg' (cf8e0f3)
***
## v2.0.3 - 2023-04-03
***
## v2.0.2 - 2023-03-29
#### Changes:
* Merge branch 'stg' (cc9940f)
* Update release-it package (da53d73)
* Merge remote-tracking branch 'origin/master' (af56bc3)
* Add artifacts (7b8e461)
***
## v2.0.1 - 2023-03-29
#### Changes:
* Merge branch 'stg' (8466619)
* Done with cicd (e6735b6)
* Merge branch 'stg' into 'master' (7bcda83)
* Merge remote-tracking branch 'origin/stg' into stg (0a9a612)
* Fix module (764a6ea)
* Merge branch 'EP-000/release\_changelog\_and\_decompess\_response\_data' into 'stg' (ea4a79d)
* remove compressed data (f41cb55)
* fix outdated checking (750abc7)
* add latest ep release endpoint (f3eab1f)
* decompress data in license check request (5af9d9b)
***
## v2.0.0 - 2023-03-29
***
## v1.0.0 - 2023-03-28
# FAQ
Frequently asked questions about our platform
What type of equipment does EasyPON support?
We are currently in an active development stage and we plan to expand our list of supported hardware, you can be the one to help us with this by simply applying the contact form as a request. [Here is a link](/easypon-information/supported-olts) to the types of equipment we currently support.
How to install EasyPON?
You can install it in two ways: on a Debian 11 or run in with Docker. All required information about installation you van get on [How to install EasyPON](/) page.
