summaryrefslogtreecommitdiff
path: root/docs/interfaces/wirelessmodem.rst
blob: 5e2eac4056e5916c441a4aafb6d0c74dd4996a43 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
.. _wwan-interface:

####################
WirelessModem (WWAN)
####################

Configuration
#############

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.

Common interface configuration
------------------------------

.. cmdinclude:: ../_include/interface-description.txt
   :var0: wirelessmodem
   :var1: wlm0

Address
-------

.. cfgcmd:: set interfaces wirelessmodem <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.

.. cfgcmd:: set interfaces wirelessmodem <interface> backup distance <metric>

   Configure metric of the default route added via the Wireless Modem interface.
   The default metric if not specified is 10.

.. cfgcmd:: set interfaces wirelessmodem <interface> device <tty>

   Device identifier of the underlaying physical interface. This is usually a
   ttyUSB device, if not configured this defaults to ttyUSB2.

.. cfgcmd:: set interfaces wirelessmodem <interface> no-peer-dns

   Do not install DNS nameservers received from ISP into system wide nameserver
   list.

.. cfgcmd:: set interfaces wirelessmodem <interface> connect-on-demand

   When set the interface is enabled for "dial-on-demand".

   Use this command to instruct the system to establish a PPP connection
   automatically once traffic passes through the interface. A disabled on-demand
   connection is established at boot time and remains up. If the link fails for
   any reason, the link is brought back up immediately.

Link Administration
-------------------

.. cfgcmd:: set interfaces wirelessmodem <interface> description <description>

   Assign given `<description>` to interface. Description will also be passed
   to SNMP monitoring systems.

.. cfgcmd:: set interfaces wirelessmodem <interface> disable

   Disable given `<interface>`. It will be placed in administratively down
   state.

.. cfgcmd:: set interfaces wirelessmodem <interface> mtu <mtu>

   Configure :abbr:`MTU (Maximum Transmission Unit)` on given `<interface>`. It
   is the size (in bytes) of the largest ethernet frame sent on this link.

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>

   Retrive interface information from given WWAN interface.

   .. code-block:: none

     vyos@vyos:~$ show interfaces wirelessmodem wlm0
     wlm0: <POINTOPOINT,MULTICAST,NOARP,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast master black state UNKNOWN group default qlen 3
         link/ppp
         inet 10.26.238.93 peer 10.64.64.64/32 scope global wlm0
            valid_lft forever preferred_lft forever
         Description: baaar

         RX:  bytes    packets     errors    dropped    overrun      mcast
                 38          5          0          0          0          0
         TX:  bytes    packets     errors    dropped    carrier collisions
                217          8          0          0          0          0

.. opcmd:: show interfaces wirelessmodem <interface> statistics

   Retrive interface statistics from given WWAN interface.

   .. code-block:: none

     vyos@vyos:~$ show interfaces wirelessmodem wlm0 statistics
         IN   PACK VJCOMP  VJUNC  VJERR  |      OUT   PACK VJCOMP  VJUNC NON-VJ
         38      5      0      0      0  |      217      8      0      0      8

.. opcmd:: show interfaces wirelessmodem <interface> log

   Displays log information for a WWAN interface.

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)