7. RESTAPI XML Provisioning

Document Date and version	2020.11.02
Tested with ONT HALNy	Supported on Version: V2.0.15 or above
Revision	1

Let us know how to improve below document on: support@halny.com

Intro

URL to use: http://IP.IP.IP.IP:48625/exec/provisioning
where IP.IP.IP.IP it is ONT’s ip-host 1 address.

Attention!
Since firmware V3.1.24 a new version of the API has been released. New URL to use: http://IP.IP.IP.IP:48625/api/v1/exec/provisioning
where IP.IP.IP.IP it is ONT’s ip-host 1 address.
The help could be displayed by: http://IP.IP.IP.IP:48625/api/v1/help

Example JSON file, which must be sent with POST method:
{
"server": "http://192.168.5.6",
"xmlfile": "/xml/provisioning.xml"
}
Where:

• 192.168.5.6 – HTTP/FTP/TFTP server IP
• provisioning.xml – XML FILENAME

Supported servers:
Attention!
FTPS/HTTPS are supported from V2.0.19/V3.0.15
TFTP is supported from V2.0.16/V3.0.9

• http://192.168.5.6
• https://192.168.5.6
• ftp://LOGIN:PASSWD@192.168.5.6
• ftps://LOGIN:PASSWD@192.168.5.6
• tftp://192.168.5.6

Below is JSON file which should be displayed with RESTAPI server:
{
"json_errors": "no"
}

To check ONT provisioning status You should use GET method:
http://192.168.5.100:48625/exec/provisioning

Example JSON file with actual provisioning state:
{
"prov_status":"0"
"prov_log":"PROVISIONING WAS SUCCESSFULLY COMPLETED"
}

Provisioning ONT with CURL program

curl -d '{"server":"ftp://LOGIN:PASSWD@192.168.89.109","xmlfile":"test.xml"}' -H 'Content-Type: application/json' http://192.168.89.113:48625/exec/provisioning
{"json_errors":"no"}
Where:

• ftp://LOGIN:PASSWD@192.168.89.109 – server configuration
• test.xml – XML FILE to download
• 192.168.89.113 – ONT ip-host 1 address

curl -v http://192.168.89.113:48625/exec/provisioning
GET /exec/provisioning HTTP/1.1
Host: 192.168.89.113:48625
User-Agent: curl/7.58.0
Accept: */*
<
< HTTP/1.1 200 OK
< Connection: Keep-Alive
< Content-Length: 72
< Content-Type: application/json
< Date: Mon, 12 Oct 2020 15:46:48 GMT
<Connection #0 to host 192.168.89.113 left intact
{"prov_status":"0","prov_log":"PROVISIONING WAS SUCCESSFULLY COMPLETED"}

Provisioning ONT with POSTMAN program

---