Changes

* values: value of an option

* values: value of an option

[[File:Uci config hierarchy v2.png]]

[[File:Uci config hierarchy v3.jpg|1000px]]

===Sections===

===Sections===

===Configuration files===

===Configuration files===

----

----

This section provides a list of all available configuration files of RUT routes.  

This section provides a list of all available configuration files of RUT routers. Note that these are all possible config files from any RUT router ([[RUT230]], [[RUT240]], [[RUT850]], [[RUT950]], [[RUT955]]) and that therefore some of them may not exist in your router.

{| class="wikitable"

{| class="wikitable"

| style="text-align: left; vertical-align: top;" | Stores SAMBA configuration settings

| style="text-align: left; vertical-align: top;" | Stores SAMBA configuration settings

|-

|-

! style="text-align: left; vertical-align: top;" | /etc/config/simThis section contains no values yet_idle_protection

! style="text-align: left; vertical-align: top;" | /etc/config/sim_idle_protection

| style="text-align: left; vertical-align: top;" | Stores SIM Idle Protection configuration settings

| style="text-align: left; vertical-align: top;" | Stores SIM Idle Protection configuration settings

|-

|-

==Obtaining parameters==

==Obtaining parameters==

This section will overview uci get and uci show commands used to obtain router parameters as well as provide some basic knowledge on configuration hierarchy needed to successfully use most uci commands.

This section will overview uci get and uci show commands used to obtain router parameters, option and section names and contents of entire configs or sections.

===UCI get===

===UCI get===

[[File:Uci get wireless ssid response.png]]

[[File:Uci get wireless ssid response.png]]

The command above returns the Wi-Fi Access Point's SSID. As you can see the  <span style=color:purple>uci get</span> command is used. What follows after the command is the path to the value that we're looking for (SSID, in this case). The SSID value can be found in the <span style=color:red>wireless</span> config, the <span style=color:blue>@wifi-iface[0]</span> section, stored in an option called <span style=color:green>ssid</span>. So the basic syntax for a uci get command is this:

The command above returns the Wi-Fi Access Point's SSID. As you can see the  <span style=color:purple>uci get</span> command is used. What follows after the command is the path to the value that we're looking for (SSID, in this case). The SSID value can be found in the <span style=color:red>wireless</span> config, the <span style=color:blue>@wifi-iface[0]</span> section, stored under an option called <span style=color:green>ssid</span>. So the basic syntax for a uci get command is this:

  # <span style=color:purple>uci get</span> <span style=color:red><config></span>.<span style=color:blue><section></span>[.<span style=color:green><option></span>]

  # <span style=color:purple>uci get</span> <span style=color:red><config></span>.<span style=color:blue><section></span>[.<span style=color:green><option></span>]

[[File:Uci show wireless response v2.png]]

[[File:Uci show wireless response v2.png]]

As you can see, this time the response shows the entire wireless config and instead of just showing values (like in the case of uci get) you can see the config name, section name and option name before each one.

As you can see, the response shows the entire wireless config and its entities. Note that instead of just showing values (like in the case of uci get) you can see the config name, section name and option name before each one.

Most config file names are simple. Wireless config is called wireless, OpenVPN config is called openvpn, etc. But even so one doesn't necessarily have to know what a config file is called, especially before interacting with it. To see the names of all config files and what kind of settings they store you can refer to the '''[[UCI_command_usage#Configuration_files|table above]]'''. Or if you're CLI or SSH and want to check the names of config files on the spot, you can use the '''ls''' command. Since RUT configs ar stored in '''/etc/config''', the full commands should look like this:

Most config file names are simple. Wireless config is called wireless, OpenVPN config is called openvpn, etc. But even so one doesn't necessarily have to know what a config file is called, especially before interacting with it. To see the names of all config files and what kind of settings they store you can refer to the '''[[UCI_command_usage#Configuration_files|table above]]'''. Or if you're CLI or SSH and want to check the names of config files on the spot, you can use the '''ls''' command. Since RUT configs ar stored in '''/etc/config''', the full commands should look like this:

[[File:Uci ls config.png]]

[[File:Uci ls config.png]]

==Setting parameters==

==Setting parameters==

===UCI add_list===

===UCI add_list===

----

----

Some variables hold more than one value unlike options. These variables are called '''lists'''. For example, if you use MAC filter on your Wi-Fi Acsess point, the MAC addresses are saved not as options but as a list.

Some variables hold more than one value, unlike options. These variables are called '''lists'''. For example, if you use MAC filter on your Wi-Fi Access point, the MAC addresses are saved not as options but as a list.

Example of maclist (cmd: uci show wireless):

Example of maclist (cmd: uci show wireless):

===Extensive example===

===Extensive example===

 

With all that we have learned lets try a more complicated example: lets you want to create an OpenVPN server. The server will be called '''MyServer''', will use a '''TUN''' type interface and '''TLS''' authentication. In order to create this server we will first have to create a section for the server in the openvpn config:

With all that we have learned lets try a more complicated example: lets you want to create an OpenVPN server. The server will be called '''MyServer''', will use a '''TUN''' type interface and '''TLS''' authentication. In order to create this server we will first have to create a section for the server in the openvpn config:

  # uci uci add openvpn server_MyServer

  # uci add openvpn server_MyServer

  # uci set openvpn.server_MyServer=openvpn

  # uci set openvpn.server_MyServer=openvpn

==External links==

==External links==

OpenWRT wiki page on the UCI system: https://wiki.openwrt.org/doc/uci?do=

* https://wiki.openwrt.org/doc/uci?do= - OpenWRT wiki page on the UCI system

 

* https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html - PuTTY downloads page

PuTTY app download: https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html