Kategorie

API

You are here:
< All Topics
Document Date and version2020.07.30
Tested on OLTrequired OLT with IP-host support
Tested with ONT HALNy HL-4GMVSupported on version V2.0.10 or above
Revision2

How to run

  • configure IP-host interface for ONT and check IP-HOST-ADDRESS
  • send an HTTP request to API interface on port 48624
  • select proper parameter to read (you can check available parameters by typing here “all” value)
  • select proper output type (available xml and json)

http://IP-HOST-ADDRESS:48624/cgi-bin/api?get=parameter&out=output

http://10.10.10.2:48624/cgi-bin/api?get=all&out=json

Advantages

  • Easy to configure (you need configure only IP-host interface)
  • Secure (whole data transferred through IP-host interface, HTTPS implementation in the future)
  • Easy to parse data (data returned in XML or JSON file structure)
  • Fast and flex (do not impact of OLT CPU)
  • Easy to integrate with external software and NMS systems
  • Get data asynchronous of thousand of ONT (do not impact the performance of Your network)

List of available parameters HL-4GMV (FW V2.0.13)

{
	"ONU": {
		"PARAM": [
			{
				"NAME": "api_version",
				"VALUE": "0.3.1"
			},
			{
				"NAME": "lan_ip",
				"VALUE": "192.168.33.1"
			},
			{
				"NAME": "lan_netmask",
				"VALUE": "255.255.255.0"
			},
			{
				"NAME": "lan_dhcp",
				"VALUE": "Enabled"
			},
			{
				"NAME": "lan1_status",
				"VALUE": "Down"
			},
			{
				"NAME": "lan2_status",
				"VALUE": "Down"
			},
			{
				"NAME": "lan3_status",
				"VALUE": "Down"
			},
			{
				"NAME": "lan4_status",
				"VALUE": "Down"
			},
			{
				"NAME": "lan1_mode",
				"VALUE": "N/A"
			},
			{
				"NAME": "lan2_mode",
				"VALUE": "N/A"
			},
			{
				"NAME": "lan3_mode",
				"VALUE": "N/A"
			},
			{
				"NAME": "lan4_mode",
				"VALUE": "N/A"
			},
			{
				"NAME": "lan1_conn_dev_mac",
				"VALUE": ""
			},
			{
				"NAME": "lan2_conn_dev_mac",
				"VALUE": ""
			},
			{
				"NAME": "lan3_conn_dev_mac",
				"VALUE": ""
			},
			{
				"NAME": "lan4_conn_dev_mac",
				"VALUE": ""
			},
			{
				"NAME": "wlan24_conn_dev_mac",
				"VALUE": ""
			},
			{
				"NAME": "wlan5_conn_dev_mac",
				"VALUE": ""
			},
			{
				"NAME": "ip_host1_conn_type",
				"VALUE": "Dynamic IP"
			},
			{
				"NAME": "ip_host1_mac",
				"VALUE": "E0:5A:9F:6E:B8:D8"
			},
			{
				"NAME": "ip_host1_status",
				"VALUE": "Connected"
			},
			{
				"NAME": "ip_host1_ip",
				"VALUE": "172.17.60.64"
			},
			{
				"NAME": "ip_host1_netmask",
				"VALUE": "255.255.254.0"
			},
			{
				"NAME": "ip_host1_gateway",
				"VALUE": "172.17.60.1"
			},
			{
				"NAME": "ip_host1_dns1",
				"VALUE": "172.16.16.240"
			},
			{
				"NAME": "ip_host1_dns2",
				"VALUE": "185.228.168.10"
			},
			{
				"NAME": "wan1_conn_type",
				"VALUE": "PPPoE"
			},
			{
				"NAME": "wan2_conn_type",
				"VALUE": "Bridge"
			},
			{
				"NAME": "wan3_conn_type",
				"VALUE": "Bridge"
			},
			{
				"NAME": "wan4_conn_type",
				"VALUE": "Bridge"
			},
			{
				"NAME": "wan5_conn_type",
				"VALUE": "Bridge"
			},
			{
				"NAME": "wan6_conn_type",
				"VALUE": "Bridge"
			},
			{
				"NAME": "wan7_conn_type",
				"VALUE": "Bridge"
			},
			{
				"NAME": "wan1_mac",
				"VALUE": "E0:5A:9F:6E:B8:D9"
			},
			{
				"NAME": "wan2_mac",
				"VALUE": "E0:5A:9F:6E:B8:Da"
			},
			{
				"NAME": "wan3_mac",
				"VALUE": "E0:5A:9F:6E:B8:Db"
			},
			{
				"NAME": "wan4_mac",
				"VALUE": "E0:5A:9F:6E:B8:Dc"
			},
			{
				"NAME": "wan5_mac",
				"VALUE": "E0:5A:9F:6E:B8:Dd"
			},
			{
				"NAME": "wan6_mac",
				"VALUE": "E0:5A:9F:6E:B8:De"
			},
			{
				"NAME": "wan7_mac",
				"VALUE": "E0:5A:9F:6E:B8:Df"
			},
			{
				"NAME": "wan1_status",
				"VALUE": "Connected"
			},
			{
				"NAME": "wan2_status",
				"VALUE": "Not Connected"
			},
			{
				"NAME": "wan3_status",
				"VALUE": "Not Connected"
			},
			{
				"NAME": "wan4_status",
				"VALUE": "Not Connected"
			},
			{
				"NAME": "wan5_status",
				"VALUE": "Not Connected"
			},
			{
				"NAME": "wan6_status",
				"VALUE": "Not Connected"
			},
			{
				"NAME": "wan7_status",
				"VALUE": "Not Connected"
			},
			{
				"NAME": "wan1_ip",
				"VALUE": "10.10.10.61"
			},
			{
				"NAME": "wan2_ip",
				"VALUE": ""
			},
			{
				"NAME": "wan3_ip",
				"VALUE": ""
			},
			{
				"NAME": "wan4_ip",
				"VALUE": ""
			},
			{
				"NAME": "wan5_ip",
				"VALUE": ""
			},
			{
				"NAME": "wan6_ip",
				"VALUE": ""
			},
			{
				"NAME": "wan7_ip",
				"VALUE": ""
			},
			{
				"NAME": "wan1_netmask",
				"VALUE": "255.255.255.255"
			},
			{
				"NAME": "wan2_netmask",
				"VALUE": ""
			},
			{
				"NAME": "wan3_netmask",
				"VALUE": ""
			},
			{
				"NAME": "wan4_netmask",
				"VALUE": ""
			},
			{
				"NAME": "wan5_netmask",
				"VALUE": ""
			},
			{
				"NAME": "wan6_netmask",
				"VALUE": ""
			},
			{
				"NAME": "wan7_netmask",
				"VALUE": ""
			},
			{
				"NAME": "wan1_gateway",
				"VALUE": "10.10.10.254"
			},
			{
				"NAME": "wan2_gateway",
				"VALUE": ""
			},
			{
				"NAME": "wan3_gateway",
				"VALUE": ""
			},
			{
				"NAME": "wan4_gateway",
				"VALUE": ""
			},
			{
				"NAME": "wan5_gateway",
				"VALUE": ""
			},
			{
				"NAME": "wan6_gateway",
				"VALUE": ""
			},
			{
				"NAME": "wan7_gateway",
				"VALUE": ""
			},
			{
				"NAME": "wan1_dns1",
				"VALUE": "8.8.8.8"
			},
			{
				"NAME": "wan2_dns1",
				"VALUE": ""
			},
			{
				"NAME": "wan3_dns1",
				"VALUE": ""
			},
			{
				"NAME": "wan4_dns1",
				"VALUE": ""
			},
			{
				"NAME": "wan5_dns1",
				"VALUE": ""
			},
			{
				"NAME": "wan6_dns1",
				"VALUE": ""
			},
			{
				"NAME": "wan7_dns1",
				"VALUE": ""
			},
			{
				"NAME": "wan1_dns2",
				"VALUE": "8.8.4.4"
			},
			{
				"NAME": "wan2_dns2",
				"VALUE": ""
			},
			{
				"NAME": "wan3_dns2",
				"VALUE": ""
			},
			{
				"NAME": "wan4_dns2",
				"VALUE": ""
			},
			{
				"NAME": "wan5_dns2",
				"VALUE": ""
			},
			{
				"NAME": "wan6_dns2",
				"VALUE": ""
			},
			{
				"NAME": "wan7_dns2",
				"VALUE": ""
			},
			{
				"NAME": "br0_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "br0_tx64_bytes",
				"VALUE": "1244"
			},
			{
				"NAME": "lan_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "lan_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "lan1_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "lan1_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "lan2_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "lan2_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "lan3_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "lan3_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "lan4_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "lan4_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wlan24_0_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wlan24_0_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wlan24_1_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wlan24_1_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wlan24_2_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wlan24_2_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wlan24_3_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wlan24_3_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wlan5_0_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wlan5_0_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wlan5_1_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wlan5_1_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wlan5_2_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wlan5_2_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wlan5_3_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wlan5_3_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wan0_rx64_bytes",
				"VALUE": "4294988871"
			},
			{
				"NAME": "wan0_tx64_bytes",
				"VALUE": "8589936384"
			},
			{
				"NAME": "wan1_rx64_bytes",
				"VALUE": "25884"
			},
			{
				"NAME": "wan1_tx64_bytes",
				"VALUE": "4566"
			},
			{
				"NAME": "wan2_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wan2_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wan3_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wan3_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wan4_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wan4_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wan5_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wan5_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wan6_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wan6_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wan7_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "wan7_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "ewan0_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "ewan0_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "ewan1_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "ewan1_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "ewan2_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "ewan2_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "ewan3_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "ewan3_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "ewan4_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "ewan4_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "ewan5_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "ewan5_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "ewan6_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "ewan6_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "ewan7_rx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "ewan7_tx64_bytes",
				"VALUE": "0"
			},
			{
				"NAME": "pon_rx64_bytes",
				"VALUE": "105895"
			},
			{
				"NAME": "pon_tx64_bytes",
				"VALUE": "9596"
			},
			{
				"NAME": "ont_model",
				"VALUE": "HL-4GMV"
			},
			{
				"NAME": "ont_version",
				"VALUE": "HL-4GMV_001"
			},
			{
				"NAME": "ont_active_firmware",
				"VALUE": "V2.0.13"
			},
			{
				"NAME": "ont_standby_firmware",
				"VALUE": "V2.0.9"
			},
			{
				"NAME": "ont_gpon_serialnumber",
				"VALUE": "HALN206eb8d8"
			},
			{
				"NAME": "ont_gpon_hex_serialnumber",
				"VALUE": "48414c4e206eb8d8"
			},
			{
				"NAME": "ont_mac",
				"VALUE": "E0:5A:9F:6E:B8:D8"
			},
			{
				"NAME": "optic_link_status",
				"VALUE": "up"
			},
			{
				"NAME": "xpon_mode",
				"VALUE": "GPON"
			},
			{
				"NAME": "xpon_rxpower",
				"VALUE": "-13.0 dBm"
			},
			{
				"NAME": "xpon_txpower",
				"VALUE": "2.6 dBm"
			},
			{
				"NAME": "xpon_tx_bias_current",
				"VALUE": "13.136 mA"
			},
			{
				"NAME": "xpon_supply_voltage",
				"VALUE": "3.2779 V"
			},
			{
				"NAME": "xpon_temperature",
				"VALUE": "46 °C"
			},
			{
				"NAME": "voip_line1_status",
				"VALUE": "Idle"
			},
			{
				"NAME": "voip_line2_status",
				"VALUE": "Idle"
			},
			{
				"NAME": "voip_register1_status",
				"VALUE": "Error"
			},
			{
				"NAME": "voip_register2_status",
				"VALUE": "Error"
			},
			{
				"NAME": "xml_provisioning_download_status",
				"VALUE": ""
			},
			{
				"NAME": "xml_provisioning_exec_status",
				"VALUE": ""
			},
			{
				"NAME": "system_uptime",
				"VALUE": "00:01:42"
			},
			{
				"NAME": "memory_usage",
				"VALUE": "54.7 %"
			},
			{
				"NAME": "load_average",
				"VALUE": "2.59, 0.90, 0.32"
			}
		]
	}
}
Table of Contents