Changes

Blanked the page
Line 1: Line 1: −
==Using JSON-RPC with Linux OS==
     −
This section describes how to use JSON-RPC commands with a Linux OS system. To find the guide for Windows users, jump to this section: '''[[Monitoring_via_JSON-RPC#Using_JSON-RPC_with_Windows_OS|JSON-RPC on Widnows]]'''
  −
  −
===Obtaining a session ID===
  −
----
  −
To log in to the router via JSON-RPC you must first obtain a Session ID. To do so, you must send an '''HTTP POST''' request to the router. Open the Linux '''Terminal''' app and execute this command:
  −
  −
curl -d "{ \"jsonrpc\": \"2.0\", \"id\": 1, \"method\": \"call\", \"params\": [ \"00000000000000000000000000000000\", \"session\", \"login\", { \"username\": \"root\", \"password\": \"<span style=color:orange>admin01</span>\"  } ] }" http://<span style=color:green>192.168.1.1</span>/ubus 
  −
  −
The section highlighted in orange is the router's admin password. admin01 is the default value, replace it with your router's password. The address highlighted in green is the router's IP address. Replace this value with your router's IP. If you're trying to reach the router from '''[[LAN]]''', use the local IP address (default: 192.168.1.1), if you're trying to reach the router from '''[[WAN]]''', use the router's WAN IP address.
  −
  −
  −
[[Image:Configuration examples json-rpc terminal get id.png]]
  −
  −
The picture above depicts the process of obtaining a Session ID. The ID itself is encapsulated in a blue rectangle. Copy this ID as you will need it to authenticate yourself when using other commands.
  −
  −
===Getting router parameters===
  −
----
  −
Now that you have obtained a Session ID, you can issue commands to the router. Lets start with commands that return information about the router. For example, this is a command that returns the router's '''[[RSSI]]'''(signal strength) value:
  −
  −
curl -d "{ \"jsonrpc\": \"2.0\", \"id\": 1, \"method\": \"call\", \"params\": [\"<span style=color:red>a74c8e07646f0da2bfddce35bf3de1f3</span>\", \"file\", \"exec\", { \"command\":\"<span style=color:orange>gsmctl</span>\", \"params\": [\"<span style=color:green>-q</span>\"] } ] }" http://<span style=color:black>192.168.1.1</span>/ubus
  −
Highlighted in red is the Session ID. Replace it with the Session ID that was provided to you. Highlighted in orange is the command that we used for our query and highlighted in green is the parameter for the command: '''gsmctl -q'''.
  −
  −
The picture bellow is a visual representation of this example. Encapsulated in a blue rectangle is the answer to the ''gsmctl -q'' query: '''-69 dBm'''.
  −
  −
  −
[[Image:Configuration examples json-rpc terminal gsmctl.png]]
  −
  −
You can issue almost any Linux command in a similar manner. For example, if you wish to get a list of file names contained in the config folder, the Linux command to do so would be '''ls /etc/config''', which, translated to JSON-RPC, would be:
  −
  −
curl -d "{\"jsonrpc\": \"2.0\", \"id\": 1, \"method\": \"call\", \"params\": [\"a74c8e07646f0da2bfddce35bf3de1f3\", \"file\", \"exec\", {\"command\":\"<span style=color:orange>ls</span>\", \"params\": [\"<span style=color:orange>/etc/config</span>\"] } ] }" http://<span style=color:black>192.168.1.1</span>/ubus
  −
  −
[[Image:Configuration examples json-rpc terminal ls.png]]
  −
  −
The command is encapsulated in an orange rectangle and the answer - in a blue one.
  −
  −
===Setting router parameters===
  −
----
  −
This section will describe how to use '''uci set''' commands in order to set or change various router parameters via JSON-RPC. For more general information about the usage and syntax of UCI commands, check out our '''[[UCI command usage]]''' guide.
  −
  −
====uci set====
  −
----
  −
The ''uci set'' command is used to set router parameters. As an example, lets try to change the router's '''LAN IP address'''. The command to do so looks like this:
  −
  −
curl -d "{\"jsonrpc\":\"2.0\", \"id\":1, \"method\":\"call\", \"params\":[\"590bde71578da2fabfe77ba86c00e4e5\", \"uci\", \"set\", { \"config\":\"<span style=color:orange>network</span>\", \"type\":\"<span style=color:orange>interface</span>\", \"match\": {\"ipaddr\":\"<span style=color:red>192.168.1.1</span>\"}, \"values\": {\"ipaddr\":\"<span style=color:green>192.168.56.1</span>\"} } ] }" http://<span style=color:black>192.168.1.1</span>/ubus
  −
  −
The sections highlighted in orange describe the config file's name and section (in this case, network config and interface section). Highlighted in red is the option in the config file that you wish to change (in this case, the router's LAN IP address, '''ipaddr'''). Finally, highlighted in green is the value that will to replace the old value (in this case, change the router's LAN IP address to 192.168.56.1). If the command was issued successfully, you should see a Response like this:
  −
  −
  −
[[Image:Configuration examples json-rpc terminal uci set.png]]
  −
  −
====uci commit====
  −
----
  −
In order to commit the changes from RAM to flash memory, you must execute a '''uci commit''' command. Continuing from the example above, lets commit the changes made to the ''network'' config. The command to do so looks like this:
  −
  −
curl -d "{\"jsonrpc\":\"2.0\", \"id\":1, \"method\":\"call\", \"params\":[\"9704f676709d9dedc98d7718c4e3e7d2\", \"uci\", \"commit\", {\"config\":\"<span style=color=orange>network</span>\"} ] }" http://<span style=color:black>192.168.1.1</span>/ubus
  −
  −
When committing changes, you will need to specify the name of the file where the changes took place (in this case, network, which is highlighted in orange). If the commit was successful, you should see the same message as before:
  −
  −
'''{"jsonrpc":"2.0","id":1,"result":[0]}'''
  −
  −
====luci-reload====
  −
----
  −
In order for the changes to take effect, use the '''luci-reload''' command which restarts all of the router's services. The luci-reload command looks like this:
  −
  −
curl -d "{\"jsonrpc\":\"2.0\",\"id\":1, \"method\":\"call\", \"params\":[\"428a9fa57f1a391db0bd1b865fa16bb5\", \"file\", \"exec\", {\"command\": \"<span style=color:orange>luci-reload</span>\"} ] }" http://<span style=color:black>192.168.56.1</span>/ubus
  −
  −
The command itself is highlighted in orange.
  −
  −
====Setting Multiple Parameters====
  −
----
  −
This next example describes how to set multiple parameters in a single config file with one command. Lets change the default configuration of the Ping Reboot function (ping_reboot config file):
  −
  −
curl -d "{\"jsonrpc\":\"2.0\", \"id\":1, \"method\":\"call\", \"params\":[\"558a9b03c940e52f373f8c02498952e3\", \"uci\", \"set\", {\"config\":\"ping_reboot\", \"match\":{\"enable\":\"<span style=color:orange>0</span>\", \"host\":\"<span style=color:orange>8.8.8.8</span>\", \"packet_size\":\<span style=color:orange>"56</span>\"}, \"values\":{\"enable\":\"<span style=color:green>1</span>\", \"host\":\"<span style=color:green>8.8.4.4</span>\", \"packet_size\":\"<span style=color:green>64</span>\"} } ] }" http://<span style=color:black>192.168.1.1</span>/ubus
  −
  −
The command above will '''enable''' the Ping Reboot function, set the host to ping to '''8.8.4.4''' and ping packet size to '''64'''. The default values are highlighted in orange and the new ones are highlighted in green.
  −
  −
==Some Additional Commands==
  −
  −
If the commands found in the guide above did not suffice your needs, this section provides a list of additional ones. The commands presented in this section will be for both Linux and Windows operating systems. They should be used as syntax examples for your own purposes.
  −
  −
===WiFi clients list===
  −
----
  −
This command returns a list of devices connected to your WLAN and some additional information about the connection.
  −
  −
'''Windows:'''
  −
{
  −
    "jsonrpc": "2.0", "id": 1, "method": "call", "params":
  −
    [
  −
        "86fc586fa1471622473434ff0176fd66", "<span style=color:red>iwinfo</span>", "<span style=color:red>assoclist</span>",
  −
        {
  −
            "device":"wlan0"
  −
        }
  −
    ]
  −
}
  −
  −
'''Linux:'''
  −
curl -d "{ \"jsonrpc\": \"2.0\", \"id\": 1, \"method\": \"call\", \"params\": [ \"86fc586fa1471622473434ff0176fd66\", \"<span style=color:red>iwinfo</span>\", \"<span style=color:red>assoclist</span>\", {\"device\":\"wlan0\"} ] }" http://<span style=color:black>192.168.1.1</span>/ubus
  −
  −
'''The response''' should look something like this:
  −
{"jsonrpc":"2.0","id":1,"result":[0,{"results":
  −
[{"mac":"<span style=color:green>E4:02:9B:88:09:AA</span>","signal":<span style=color:blue>-32</span>,"noise":<span style=color:blue>-88</span>,"inactive":<span style=color:blue>10</span>,"rx":
  −
{"rate":<span style=color:blue>1000</span>,"mcs":<span style=color:blue>0</span>,"40mhz":<span style=color:blue>false</span>,"short_gi":<span style=color:blue>false</span>},"tx":
  −
{"rate":<span style=color:blue>72200</span>,"mcs":<span style=color:blue>7</span>,"40mhz":<span style=color:blue>false</span>,"short_gi":<span style=color:blue>true</span>}},
  −
{"mac":"<span style=color:green>D8:C7:71:47:90:E1</span>","signal":<span style=color:blue>-12</span>,"noise":<span style=color:blue>-88</span>,"inactive":<span style=color:blue>400</span>,"rx":
  −
{"rate":<span style=color:blue>1000</span>,"mcs":<span style=color:blue>0</span>,"40mhz":<span style=color:blue>false</span>,"short_gi":<span style=color:blue>false</span>},"tx":
  −
{"rate":<span style=color:blue>72200</span>,"mcs":<span style=color:blue>7</span>,"40mhz":<span style=color:blue>false</span>,"short_gi":<span style=color:blue>true</span>}}]}]}
  −
  −
To obtain these values, the Linux '''iwinfo''' command and '''assoclist''' parameter (red) are used. Highlighted in green are the devices connected to the router via WiFi as identified by their MAC addresses. The response information about the connection with the device, such as signal strength, noise, time of inactivity (idle time), rx, tx rate, etc., is highlighted in blue.
  −
  −
===WiFi information===
  −
----
  −
This command returns information on your WiFi Access Point.
  −
  −
'''Windows:'''
  −
{
  −
    "jsonrpc": "2.0", "id": 1, "method": "call", "params":
  −
    [
  −
        "a70ceeba344b6046625d8bcec132796c", "<span style=color:red>iwinfo</span>", "<span style=color:red>info</span>",
  −
        {
  −
            "device":"wlan0"
  −
        }
  −
    ]
  −
}
  −
  −
'''Linux:'''
  −
curl -d "{ \"jsonrpc\": \"2.0\", \"id\": 1, \"method\": \"call\", \"params\": [ \"a70ceeba344b6046625d8bcec132796c\", \"<span style=color:red>iwinfo</span>\", \"<span style=color:red>info</span>\", {\"device\":\"wlan0\"} ] }" http://<span style=color:black>192.168.1.1</span>/ubus
  −
  −
'''Response:'''
  −
  −
{"jsonrpc":"2.0","id":1,"result":[0,
  −
{"phy":"<span style=color:blue>phy0</span>","ssid":"<span style=color:blue>HAL9000</span>","bssid":"<span style=color:blue>00:1E:42:16:D6:68</span>","country":"<span style=color:blue>00</span>","mode":"<span style=color:blue>Master</span>","channel":<span style=color:blue>6</span>,"frequency":<span style=color:blue>2437</span>,"txpower":<span style=color:blue>20</span>,
  −
"quality":<span style=color:blue>22</span>,"quality_max":<span style=color:blue>70</span>,"signal":<span style=color:blue>22</span>,"noise":<span style=color:blue>-61</span>,"bitrate":<span style=color:blue>72200</span>,"encryption":
  −
{"enabled":<span style=color:blue>false</span>},"hwmodes":["<span style=color:blue>b</span>","<span style=color:blue>g</span>","<span style=color:blue>n</span>"],"hardware":{"name":"<span style=color:blue>Generic MAC80211</span>"}}]}
  −
  −
As with the clients list command described above, to obtain this information the Linux '''iwinfo''' command is used, but this time with the '''info''' parameter (red). The relevant information, such as WiFi SSID, WiFi MAC address, WiFi channel, Encryption type, etc., is highlighted in blue
  −
  −
===Manufacturing information===
  −
----
  −
This command returns information about the device's manufacturing details like device's Product Code, Serial Number MAC Address, etc.
  −
  −
'''Windows:'''
  −
{
  −
    "jsonrpc": "2.0", "id": 1, "method": "call", "params":
  −
    [
  −
        "805725a19ab0fba6c2b44ecf2f952fb9","file", "exec",
  −
        {
  −
            "command":"<span style=color:red>mnf_info</span>", "params":["<span style=color:red>name</span>", "<span style=color:red>sn</span>", "<span style=color:red>mac</span>"]
  −
        }
  −
    ]
  −
}
  −
  −
'''Linux:'''
  −
curl -d "{ \"jsonrpc\": \"2.0\", \"id\": 1, \"method\": \"call\", \"params\": [ \"805725a19ab0fba6c2b44ecf2f952fb9\",\"file\", \"exec\",{ \"command\":\"<span style=color:red>mnf_info</span>\", \"params\":[\"<span style=color:red>name</span>\", \"<span style=color:red>sn</span>\", \"<span style=color:red>mac</span>\"] } ] }" http://<span style=color:black>192.168.1.1</span>/ubus
  −
  −
'''Response:'''
  −
{"jsonrpc":"2.0","id":1,"result":[0,{"code":0,"stdout":"<span style=color:blue>RUT950HG12C0</span>\n<span style=color:blue>1367435694</span>\n<span style=color:blue>001e4216d666</span>\n"}]}
  −
  −
To obtain the manufacturing information the '''mnf_info''' (highlighted in red) command is used. In this case a query was sent asking for the device's Product Code (name), Serial Number (sn) and MAC Address (mac) (highlighted in red in the query; returned values highlighted in blue). Using ''mnf_info'', you can "ask" the router for any type of manufacturing information. Here is the list of possible ''mnf_info'' parameters:
  −
  −
* '''mac''' - returns the router's LAN MAC address
  −
* '''maceth''' - returns the router's WAN MAC address
  −
* '''name''' - returns the router's Product Code
  −
* '''wps''' - returns the router's WPS PIN number
  −
* '''sn''' - returns the router's Serial number
  −
* '''batch''' - returns the router's Batch number
  −
* '''hwver''' - returns the router's Hardware Revision number
  −
* '''simpin''' - returns the router's SIM card's PIN (as it is specified in the '''[[Mobile]]''' section)
  −
* '''blver''' - returns the router's Bootloader version
  −
  −
===Firmware number===
  −
----
  −
This command returns the device's Firmware version number.
  −
  −
'''Windows:'''
  −
{
  −
    "jsonrpc": "2.0", "id": 1, "method": "call", "params":
  −
    [
  −
        "85ea4cb00398d8387b22d8fa6f75f753", "<span style=color:red>file</span>", "<span style=color:red>read</span>",
  −
        {
  −
            "path":"<span style=color:red>/etc/version</span>"
  −
        }
  −
    ]
  −
}
  −
  −
'''Linux:'''
  −
curl -d "{ \"jsonrpc\": \"2.0\", \"id\": 1, \"method\": \"call\", \"params\": [ \"85ea4cb00398d8387b22d8fa6f75f753\",\"<span style=color:red>file</span>\", \"<span style=color:red>read</span>\",{ \"path\":\"<span style=color:red>/etc/version</span>\"} ] }" http://<span style=color:black>192.168.1.1</span>/ubus
  −
  −
'''Response:'''
  −
{"jsonrpc":"2.0","id":1,"result":[0,{"data":"<span style=color:blue>RUT9XX_R_00.05.00.5</span>\n"}]}
  −
  −
This command ('''file''', '''read''', highlighted in red) is an alternative to the Linux '''cat''' command we see used in the '''[[Monitoring_via_JSON-RPC#Getting_router_parameters|Getting router paramaters]]''' section of this guide. All you need is to specify the path (in this case '''/etc/version''', highlighted in red) to the file that you wish to read.
  −
  −
===Reboot===
  −
----
  −
'''Windows:'''
  −
{
  −
    "jsonrpc":"2.0","id":1,"method":"call","params":
  −
    [
  −
        "5cd4b143b182c07bc578ae3310d6280e","file","exec",
  −
        {
  −
            "command":"<span style=color:red>reboot</span>","params":["<span style=color:red>config</span>"]
  −
        }
  −
    ]
  −
}
  −
  −
'''Linux:'''
  −
curl -d "{\"jsonrpc\":\"2.0\",\"id\":1,\"method\":\"call\",\"params\":[\"5cd4b143b182c07bc578ae3310d6280e\",\"file\",\"exec\",{\"command\":\"<span style=color:red>reboot</span>\",\"params\":[\"<span style=color:red>config</span>\"]}]}" http://<span style=color:black>192.168.1.1</span>/ubus
  −
  −
'''Response:'''
  −
  −
The success response for this command is an empty message. If the response contains no data, the command was executed successfully.
  −
  −
===Set SIM card information===
  −
----
  −
In this last example we'll try to change the mobile connection's MTU and Service mode values.
  −
  −
'''Windows:'''
  −
{
  −
    "jsonrpc":"2.0", "id":1, "method":"call", "params":
  −
    [
  −
        "558a9b03c940e52f373f8c02498952e3", "<span style=color"red>uci</span>", "<span style=color:red>set</span>",
  −
        {
  −
            "config":"<span style=color:orange>simcard</span>", "type":"<span style=color:orange>sim1</span>", "match":
  −
            {
  −
                "service":"<span style=color:orange>auto</span>",
  −
                "mtu":"<span style=color:orange>1500</span>"
  −
            },
  −
            "values":
  −
            {
  −
                "service":"<span style=color:orange>lte-only</span>",
  −
                "mtu":"<span style=color:orange>1476</span>"
  −
            }
  −
        }
  −
    ]
  −
}
  −
  −
'''Linux:'''
  −
curl -d "{\"jsonrpc\":\"2.0\", \"id\":1, \"method\":\"call\", \"params\":[\"558a9b03c940e52f373f8c02498952e3\", \"<span style=color:red>uci</span>\", \"<span style=color:red>set</span>\", {\"config\":\"<span style=color:orange>simcard</span>\", \"type\":\"<span style=color:orange>sim1</span>\", \"match\":{\"service\":\"<span style=color:orange>auto</span>\", \"mtu\":\"<span style=color:orange>1500</span>\"}, \"values\":{\"service\":\"<span style=color:orange>lte-only</span>\", \"mtu\":\"<span style=color:orange>1476</span>\"} } ] }" http://<span style=color:black>192.168.1.1</span>/ubus
  −
  −
'''Response:'''
  −
{"jsonrpc":"2.0","id":1,"result":[<span style=color:blue>0</span>]}
  −
  −
The command used is ''uci set'' (highlighted in red). The config file name is '''simcard''', section '''sim1''', options '''mtu''' and '''service''' (configs, sections and options highlighted in orange). The response shown above is a positive response, but don't forget to execute ''uci commit'' and ''luci-reload'' afterwards or else your changes will not take effect. The usage of ''uci commit'' and ''luci-reload'' commands is described '''[[Monitoring_via_JSON-RPC#Setting_router_parameters|here]]''' (for Windows) and '''[[Monitoring_via_JSON-RPC#Setting_router_parameters_2|here]]''' (for Linux).
  −
  −
==External links==
  −
  −
* https://chrome.google.com/webstore/detail/chrome-poster/cdjfedloinmbppobahmonnjigpmlajcd?hl=en - Chrome Poster add-on download link
  −
[[Category:{{{name}}} Configuration Examples]]
 
685

edits

Navigation menu