7. RESTAPI XML Provisioning

Document Date	2020.11.02
Tested with ONT HALNy HL-1GE/2, HL-1GC, HL-4G, HL-4GMV	Supported on Version: V2.0.15 or above
Tested with ONT HALNy HL-4GQV, HL-4GQVS/2, HL-4GXV/-F, HL-4GMV2/3/4	Supported on Version: V3.1.24p1 or above
Tested with ONT HALNy HL-1B, HL-2BV, HL-4G2	Supported on Version: V4.0.8p1 or above
Tested with ONT HALNy HL-4BX3V-F, HL-4GX3VR	Supported on Version: V5.0.9 or above

Overview

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.
Help could be displayed by: http://IP.IP.IP.IP:48625/api/v1/help

---

JSON Example

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

• HTTP

http://192.168.5.6

• HTTPS

https://192.168.5.6

• FTP

ftp://LOGIN:PASSWD@192.168.5.6

• FTPS

ftps://LOGIN:PASSWD@192.168.5.6

• TFTP

tftp://192.168.5.6

---

Check status

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 using CURL

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 using POSTMAN

---

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