summaryrefslogtreecommitdiff
path: root/docs/configuration/interfaces/wwan.rst
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2021-06-13 13:59:14 +0200
committerChristian Poessinger <christian@poessinger.com>2021-06-13 13:59:14 +0200
commit5a8a33ac3677147b8642423e7246015c5d2f457a (patch)
treec0a2fe8d24e8dc5bf1aeedbd3b96da5e33b0c387 /docs/configuration/interfaces/wwan.rst
parent24fcb422ea2d7e31e4c8864a097e12580a0df266 (diff)
downloadvyos-documentation-5a8a33ac3677147b8642423e7246015c5d2f457a.tar.gz
vyos-documentation-5a8a33ac3677147b8642423e7246015c5d2f457a.zip
wwan: adjust documentation to latest CLI syntax version
Diffstat (limited to 'docs/configuration/interfaces/wwan.rst')
-rw-r--r--docs/configuration/interfaces/wwan.rst107
1 files changed, 107 insertions, 0 deletions
diff --git a/docs/configuration/interfaces/wwan.rst b/docs/configuration/interfaces/wwan.rst
new file mode 100644
index 00000000..cfe074f6
--- /dev/null
+++ b/docs/configuration/interfaces/wwan.rst
@@ -0,0 +1,107 @@
+.. _wwan-interface:
+
+#################################
+Wireless Wide-Area-Network (WWAN)
+#################################
+
+The Wireless Wide-Area-Network interface provides access (through a wireless
+modem/wwan) to wireless networks provided by various cellular providers.
+
+VyOS uses the `interfaces wwan` subsystem for configuration.
+
+*************
+Configuration
+*************
+
+Common interface configuration
+==============================
+
+.. cmdinclude:: /_include/interface-address-with-dhcp.txt
+ :var0: wwan
+ :var1: wwan0
+
+
+.. cmdinclude:: /_include/interface-description.txt
+ :var0: wwan
+ :var1: wwan0
+
+.. cmdinclude:: /_include/interface-disable.txt
+ :var0: wwan
+ :var1: wwan0
+
+.. cmdinclude:: /_include/interface-disable-link-detect.txt
+ :var0: wwan
+ :var1: wwan0
+
+.. cmdinclude:: /_include/interface-mtu.txt
+ :var0: wwan
+ :var1: wwan0
+
+.. cmdinclude:: /_include/interface-ip.txt
+ :var0: wwan
+ :var1: wwan0
+
+.. cmdinclude:: /_include/interface-ipv6.txt
+ :var0: wwan
+ :var1: wwan0
+
+.. cmdinclude:: /_include/interface-vrf.txt
+ :var0: wwan
+ :var1: wwan0
+
+**DHCP(v6)**
+
+.. cmdinclude:: /_include/interface-dhcp-options.txt
+ :var0: wwan
+ :var1: wwan0
+
+.. cmdinclude:: /_include/interface-dhcpv6-options.txt
+ :var0: wwan
+ :var1: wwan0
+
+.. cmdinclude:: /_include/interface-dhcpv6-prefix-delegation.txt
+ :var0: wwan
+ :var1: wwan0
+
+WirelessModem (WWAN) options
+============================
+
+.. cfgcmd:: set interfaces wwan <interface> apn <apn>
+
+ Every WWAN connection requires an :abbr:`APN (Access Point Name)` which is
+ used by the client to dial into the ISPs network. This is a mandatory
+ parameter. Contact your Service Provider for correct APN.
+
+
+*********
+Operation
+*********
+
+TBD
+
+*******
+Example
+*******
+
+The following example is based on a Sierra Wireless MC7710 miniPCIe card (only
+the form factor in reality it runs UBS) and Deutsche Telekom as ISP. The card
+is assembled into a :ref:`pc-engines-apu4`.
+
+.. code-block:: none
+
+ set interfaces wwan wwan0 apn 'internet.telekom'
+ set interfaces wwan wwan0 address 'dhcp'
+
+*****************
+Supported Modules
+*****************
+
+The following hardware modules have been tested successfully in an
+:ref:`pc-engines-apu4` board:
+
+* Sierra Wireless AirPrime MC7304 miniPCIe card (LTE)
+* Sierra Wireless AirPrime MC7430 miniPCIe card (LTE)
+* Sierra Wireless AirPrime MC7455 miniPCIe card (LTE)
+* Sierra Wireless AirPrime MC7710 miniPCIe card (LTE)
+* Huawei ME909u-521 miniPCIe card (LTE)
+* Huawei ME909s-120 miniPCIe card (LTE)