Have a Question?
EasyMesh Agent upgrade
| Tested with HALNy ONTs: HL-4GQV, HL-4GQVS, HL-4GQVS2, HL-4GXV, HL-4GXV-F, HL-4GMV2, HL-4GMV3, HL-4GMV4, HL-4GMVR, HALNy Routers: HLE-3GM, HLE-3GX-F | Supported from Version: V3.1.24/ V3.2.36 or above for both controller and agent |
| Tested with HALNy ONT: HL-4BX3V-F, HL-4GX3VR HALNy Router: HLE-4BX3V-F | Supported on Version: V5.0.11 or above for both controller and agent |
How to run
- Prepare server available from a WAN Internet of a EasyMesh controller.
(Passive mode must be enabled on the file server.) - Upload software to the server.
- Set up EasyMesh Agent upgrade on the Controller using one of the following methods:
1. Web configuration
- Navigate to Advanced → EasyMesh → Upgrade in the controller’s web interface.
- Select one of the server types.
- Fill in all the required information as shown in the example below.

- Model Name needs to be the same as the model name shown in the Agent list or on the sticker located on the bottom of the device.
- Firmware Version must start with a “V”. Digits should be separated by dots, e.g., V3.2.50.
- File Name must match the file name on the server and include the correct file extension, e.g., e-bin.
- Server Type – select one of the four supported types: FTP, FTPS, HTTP, or HTTPS.
- Server IP, Server Login, and Server Password must be filled in to allow proper access to the server.
ReplaceIP.IP.IP.IPwith the actual IP address.
Note: The server must be accessible from the controller’s WAN (Internet) interface.
2. XML configuration
In the XML file, the MESH_AGENT_UPGRADE node is placed in the management section.
Below is an example of EasyMesh Agent Upgrade nodes:
<MESH_AGENT_UPGRADE>
<AGENT_TYPE_1>
<MODEL_NAME>HL-4GXV-F</MODEL_NAME>
<FILE_NAME>G_ONU_HL-4GXV-F_V3-2-50-e.bin</FILE_NAME>
<FIRMWARE_VERSION>V3.2.50</FIRMWARE_VERSION>
<SERVER_TYPE>FTP</SERVER_TYPE>
<SERVER_IP>172.17.60.34</SERVER_IP>
<SERVER_LOGIN>FTP_login</SERVER_LOGIN>
<SERVER_PASSWORD>FTP_password</SERVER_PASSWORD>
<REBOOT_TIME>NOW</REBOOT_TIME>
</AGENT_TYPE_1>
<AGENT_TYPE_2>
<MODEL_NAME>HLE-3GM</MODEL_NAME>
<FILE_NAME>G_ONU_HLE-3GM_V3-2-50-e.bin</FILE_NAME>
<FIRMWARE_VERSION>V3.2.50</FIRMWARE_VERSION>
<SERVER_TYPE>FTP</SERVER_TYPE>
<SERVER_IP>172.17.60.34</SERVER_IP>
<SERVER_LOGIN>FTP_login</SERVER_LOGIN>
<SERVER_PASSWORD>FTP_password</SERVER_PASSWORD>
<REBOOT_TIME>NOW</REBOOT_TIME>
</AGENT_TYPE_2>
</MESH_AGENT_UPGRADE>
- MODEL_NAME needs to be the same as the model name shown in the Agent list or on the sticker located on the bottom of the device.
- FIRMWARE_VERSION must start with a “V”. Digits should be separated by dots, e.g., V3.2.50.
- FILE_NAME must match the file name on the server and include the correct file extension, e.g., e-bin.
- SERVER_TYPE – select one of the four supported types: FTP, FTPS, HTTP, or HTTPS.
- SERVER_IP, SERVER_LOGIN, and SERVER_PASSWORD have to be filled in for correct data access. IP.IP.IP.IP has to be replaced by digits.
Note: The server must be accessible from the controller’s WAN (Internet) interface.
3. Rest APIv2 configuration
1.Configuration
URL to use:
http://{{ont_ip}}:48626/api/v2/meshagentupgrade/x
where ont_ip is ONT’s ip-host 1 address, and x is the index number of Agent upgrade entry
JSON:
{
"model_name":"HLE-3GM",
"firmware_version":"V3.2.50",
"server_type":"ftp",
"server_address":"192.168.89.99",
"server_login":"admin",
"server_password":"AdmiN*123",
"file_name":"G_ONU_HLE-3GM_V3-2-50-e.bin",
"reboot_time":"now"
}
- model_name needs to be the same as the model name shown in the Agent list or on the sticker located on the bottom of the device.
- firmware_version must start with a “V”. Digits should be separated by dots, e.g., V3.2.50.
- server_type – select one of the four supported types: FTP, FTPS, HTTP, or HTTPS.
- server_address, server_login and server_password must be filled in to allow proper access to the server.
ReplaceIP.IP.IP.IPwith the actual IP address. - file_name must match the file name on the server and include the correct file extension, e.g., e-bin.
Note: The server must be accessible from the controller’s WAN (Internet) interface.
2. Apply changes
URL to use:
http://{{ont_ip}}:48626/api/v2/meshagentupgrade/apply
JSON:
{
"apply":"yes"
}
More info about REST APIv2, such as credentials, available nodes and configuration details, can be found here
4. Rest API configuration
URL to use:
http://ont_ip:48625/api/v1/meshagentupgrade/1/model_name
where ont_ip is ONT’s ip-host 1 address.
In below example, IP.IP.IP.IP is the address IP of the server with software.
Configuration by curl
curl -H 'Content-Type: application/json' -d '{"meshagentupgrade_1_model_name":"HL-4GXV-F"}' "http://ont_ip:48625/api/v1/meshagentupgrade/1/model_name" --connect-timeout 2
curl -H 'Content-Type: application/json' -d '{"meshagentupgrade_1_firmware_version":"V3.1.24"}' "http://ont_ip:48625/api/v1/meshagentupgrade/1/firmware_version" --connect-timeout 2
curl -H 'Content-Type: application/json' -d '{"meshagentupgrade_1_server_type":"ftp"}' "http://ont_ip:48625/api/v1/meshagentupgrade/1/server_type" --connect-timeout 2
curl -H 'Content-Type: application/json' -d '{"meshagentupgrade_1_server_ip":"IP.IP.IP.IP"}' "http://ont_ip:48625/api/v1/meshagentupgrade/1/server_ip" --connect-timeout 2
curl -H 'Content-Type: application/json' -d '{"meshagentupgrade_1_server_login":"FTP_login"}' "http://ont_ip:48625/api/v1/meshagentupgrade/1/server_login" --connect-timeout 2
curl -H 'Content-Type: application/json' -d '{"meshagentupgrade_1_server_password":"FTP_password"}' "http://ont_ip:48625/api/v1/meshagentupgrade/1/server_password" --connect-timeout 2
curl -H 'Content-Type: application/json' -d '{"meshagentupgrade_1_file_name":"G_ONU_HL-4GXV-F_V3-1-24_001-enc.bin"}' "http://ont_ip:48625/api/v1/meshagentupgrade/1/file_name" --connect-timeout 2
curl -H 'Content-Type: application/json' -d '{"meshagentupgrade_1_reboot_time":"NOW"}' "http://ont_ip:48625/api/v1/meshagentupgrade/1/reboot_time" --connect-timeout 2
curl -H 'Content-Type: application/json' -d '{"apply":"yes"}' "http://ont_ip:48625/api/v1/meshagentupgrade/apply" --connect-timeout 2
curl -H 'Content-Type: application/json' -d '{"meshagentupgrade_2_model_name":"HLE-3GM"}' "http://ont_ip:48625/api/v1/meshagentupgrade/2/model_name" --connect-timeout 2
curl -H 'Content-Type: application/json' -d '{"meshagentupgrade_2_firmware_version":"V3.1.24"}' "http://ont_ip:48625/api/v1/meshagentupgrade/2/firmware_version" --connect-timeout 2
curl -H 'Content-Type: application/json' -d '{"meshagentupgrade_2_server_type":"ftp"}' "http://ont_ip:48625/api/v1/meshagentupgrade/2/server_type" --connect-timeout 2
curl -H 'Content-Type: application/json' -d '{"meshagentupgrade_2_server_ip":"IP.IP.IP.IP"}' "http://ont_ip:48625/api/v1/meshagentupgrade/2/server_ip" --connect-timeout 2
curl -H 'Content-Type: application/json' -d '{"meshagentupgrade_2_server_login":"FTP_login"}' "http://ont_ip:48625/api/v1/meshagentupgrade/2/server_login" --connect-timeout 2
curl -H 'Content-Type: application/json' -d '{"meshagentupgrade_2_server_password":"FTP_password"}' "http://ont_ip:48625/api/v1/meshagentupgrade/2/server_password" --connect-timeout 2
curl -H 'Content-Type: application/json' -d '{"meshagentupgrade_2_file_name":"G_ONU_HLE-3GM_V3-1-24_001-enc.bin"}' "http://ont_ip:48625/api/v1/meshagentupgrade/2/file_name" --connect-timeout 2
curl -H 'Content-Type: application/json' -d '{"meshagentupgrade_2_reboot_time":"NOW"}' "http://ont_ip:48625/api/v1/meshagentupgrade/2/reboot_time" --connect-timeout 2
curl -H 'Content-Type: application/json' -d '{"apply":"yes"}' "http://ont_ip:48625/api/v1/meshagentupgrade/apply" --connect-timeout 2
- meshagentupgrade_x_model_name needs to be the same as the model name shown in the Agent list or on the sticker located on the bottom of the device.
- meshagentupgrade_x_firmware_version must start with a “V”. Digits should be separated by dots, e.g., V3.2.50.
- meshagentupgrade_x_server_type – select one of the four supported types: ftp, ftps, http, or https.
- meshagentupgrade_x_server_ip, meshagentupgrade_x_server_login and meshagentupgrade_x_server_password must be filled in to allow proper access to the server.
ReplaceIP.IP.IP.IPwith the actual IP address. - meshagentupgrade_x_file_name must match the file name on the server and include the correct file extension, e.g., e-bin.
Note: The server must be accessible from the controller’s WAN (Internet) interface.
5. TR-069 configuration
Main node:
InternetGatewayDevice.X_HALNY_EasyMeshUpgrade.Device
Configuration:
InternetGatewayDevice.X_HALNY_EasyMeshUpgrade.Device.1
InternetGatewayDevice.X_HALNY_EasyMeshUpgrade.Device.1.ModelName HLE-3GM
InternetGatewayDevice.X_HALNY_EasyMeshUpgrade.Device.1.FirmwareVersion V3.2.50
InternetGatewayDevice.X_HALNY_EasyMeshUpgrade.Device.1.FileName G_ONU_HLE-3GM_V3-2-50-e.bin
InternetGatewayDevice.X_HALNY_EasyMeshUpgrade.Device.1.ServerType ftp
InternetGatewayDevice.X_HALNY_EasyMeshUpgrade.Device.1.ServerIp 192.168.89.121
InternetGatewayDevice.X_HALNY_EasyMeshUpgrade.Device.1.ServerLogin ftp_login
InternetGatewayDevice.X_HALNY_EasyMeshUpgrade.Device.1.ServerPassword ftp_password
InternetGatewayDevice.X_HALNY_EasyMeshUpgrade.Device.1.RebootTime NOW
InternetGatewayDevice.X_HALNY_EasyMeshUpgrade.Device.2
InternetGatewayDevice.X_HALNY_EasyMeshUpgrade.Device.2.ModelName HLE-3GX-F
InternetGatewayDevice.X_HALNY_EasyMeshUpgrade.Device.2.FirmwareVersion V3.2.50
InternetGatewayDevice.X_HALNY_EasyMeshUpgrade.Device.2.FileName G_ONU_HLE-3GX-F_V3-2-50-e.bin
InternetGatewayDevice.X_HALNY_EasyMeshUpgrade.Device.2.ServerType ftp
InternetGatewayDevice.X_HALNY_EasyMeshUpgrade.Device.2.ServerIp 192.168.89.121
InternetGatewayDevice.X_HALNY_EasyMeshUpgrade.Device.2.ServerLogin ftp_login
InternetGatewayDevice.X_HALNY_EasyMeshUpgrade.Device.2.ServerPassword ftp_password
InternetGatewayDevice.X_HALNY_EasyMeshUpgrade.Device.2.RebootTime NOW
Apply config:
InternetGatewayDevice.X_HALNY_EasyMeshUpgrade.ApplyConfig any_string_different_that_previous
- ModelName needs to be the same as the model name shown in the Agent list or on the sticker located on the bottom of the device.
- FirmwareVersion must start with a “V”. Digits should be separated by dots, e.g., V3.2.50.
- FileName must match the file name on the server and include the correct file extension, e.g., e-bin.
- ServerType – select one of the four supported types: ftp, ftps, http, or https.
- ServerIp, ServerLogin, and ServerPassword must be filled in to allow proper access to the server.
ReplaceIP.IP.IP.IPwith the actual IP address.
Note: The server must be accessible from the controller’s WAN (Internet) interface.
6. Triggers of Easy Mesh Agent Upgrade
Easy Mesh Agent Upgrade is triggered by:
- Save & Apply button at the WEB interface
- REST API v2 apply – /api/v2/meshagentupgrade/apply
- REST API apply – /api/v1/meshagentupgrade/apply
- TR-069 apply – InternetGatewayDevice.X_HALNY_EasyMeshUpgrade.ApplyConfig
- Restart of a controller – five minutes after the controller restarts, the EasyMesh Agent upgrade will begin automatically.
