summaryrefslogtreecommitdiff
path: root/docs/interfaces/wirelessmodem.rst
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2020-11-13 14:46:04 +0100
committerChristian Poessinger <christian@poessinger.com>2020-11-13 14:46:04 +0100
commitd20c299b9dff3226e886a10a0e7223704fac32a0 (patch)
tree62d87c704ea4211b52e44a2bd40bc2439f287c53 /docs/interfaces/wirelessmodem.rst
parent85206b1c287de9f45d74181f636d08b11e37cd50 (diff)
downloadvyos-documentation-d20c299b9dff3226e886a10a0e7223704fac32a0.tar.gz
vyos-documentation-d20c299b9dff3226e886a10a0e7223704fac32a0.zip
interfaces: use common toc and chapter style
Diffstat (limited to 'docs/interfaces/wirelessmodem.rst')
-rw-r--r--docs/interfaces/wirelessmodem.rst57
1 files changed, 31 insertions, 26 deletions
diff --git a/docs/interfaces/wirelessmodem.rst b/docs/interfaces/wirelessmodem.rst
index 4590a3bb..f9dfa228 100644
--- a/docs/interfaces/wirelessmodem.rst
+++ b/docs/interfaces/wirelessmodem.rst
@@ -4,15 +4,16 @@
WirelessModem (WWAN)
####################
-Configuration
-#############
-
-The wirelessmodem interface provides access (through a wireless modem/wwan) to
-wireless networks provided by various cellular providers. VyOS uses the
+The wirelessmodem interface provides access (through a wireless modem/wwan)
+to wireless networks provided by various cellular providers. VyOS uses the
interfaces wirelessmodem subsystem for configuration.
+*************
+Configuration
+*************
+
Common interface configuration
-------------------------------
+==============================
.. cmdinclude:: ../_include/interface-description.txt
:var0: wirelessmodem
@@ -26,8 +27,8 @@ Common interface configuration
:var0: wirelessmodem
:var1: wlm0
-WWAN specific options
----------------------
+WirelessModem (WWAN) options
+============================
.. cfgcmd:: set interfaces wirelessmodem <interface> apn <apn>
@@ -59,23 +60,9 @@ WWAN specific options
connection is established at boot time and remains up. If the link fails for
any reason, the link is brought back up immediately.
-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 wirelessmodem wlm0 apn 'internet.telekom'
- set interfaces wirelessmodem wlm0 backup distance '100'
- set interfaces wirelessmodem wlm0 device 'ttyUSB2'
- set interfaces wirelessmodem wlm0 disable
- set interfaces wirelessmodem wlm0 no-peer-dns
-
+*********
Operation
-=========
+*********
.. opcmd:: show interfaces wirelessmodem <interface>
@@ -109,8 +96,26 @@ Operation
Displays log information for a WWAN interface.
+
+*******
+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 wirelessmodem wlm0 apn 'internet.telekom'
+ set interfaces wirelessmodem wlm0 backup distance '100'
+ set interfaces wirelessmodem wlm0 device 'ttyUSB2'
+ set interfaces wirelessmodem wlm0 disable
+ set interfaces wirelessmodem wlm0 no-peer-dns
+
+*****************
Supported Modules
-#################
+*****************
The following hardware modules have been tested successfully in an
:ref:`pc-engines-apu4` board:
@@ -120,4 +125,4 @@ The following hardware modules have been tested successfully in an
* 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)