michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: networking: Add IPv4 commandline options description

Browse source 
Add the documentation on how to use the commandline options to set the
IPv4 addr, gateway and netmask of a native_sim setup.

Signed-off-by: Ibe Van de Veire <ibe.vandeveire@basalte.be>
This commit is contained in:
Ibe Van de Veire 2025-03-06 15:42:52 +01:00 • committed by Henrik Brix Andersen
commit 2340dfad52
1 changed files with 14 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

17
doc/connectivity/networking/native_sim_setup.rst
View file

@ -145,18 +145,29 @@ For TCP test, type:
./echo-client -t 127.0.0.1
Setting interface name from command line
****************************************
Setting interface name and IPv4 parameters from command line
************************************************************
By default the Ethernet interface name used by native_sim is determined by
:kconfig:option:`CONFIG_ETH_NATIVE_TAP_DRV_NAME`, but is also possible
to set it from the command line using ``--eth-if=<interface_name>``.
The same applies to the IPv4 address, gateway and netmask. They can be set
from the command line using ``--ipv4-addr=<ip_address>``,
``--ipv4-gw=<gateway>`` and ``--ipv4-nm=<netmask>``.
Note that the configuration :kconfig:option:`CONFIG_NET_CONFIG_MY_IPV4_ADDR`
and the command line arguments work in parallel. This means that if both are
set, the interface might end up with two IP addresses. In most cases, it does
make sense to only use one of both at the same time.
This can be useful if the application has to be
run in multiple instances and recompiling it for each instance would be
troublesome.
.. code-block:: console
./zephyr.exe --eth-if=zeth2
./zephyr.exe --eth-if=zeth2 --ipv4-addr=192.0.2.2 --ipv4-gw=192.0.0.1
--ipv4-nm=255.255.0.0
.. _`net-tools`: https://github.com/zephyrproject-rtos/net-tools