WirelessModem (WWAN)

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

set interfaces wirelessmodem <interface> description <description>

Set a human readable, descriptive alias for this connection. Alias is used by e.g. the show interfaces command or SNMP based monitoring tools.

Example:

set interfaces wirelessmodem wlm0 description 'This is an awesome interface running on VyOS'
set interfaces wirelessmodem <interface> disable

Disable given <interface>. It will be placed in administratively down (A/D) state.

Example:

set interfaces wirelessmodem wlm0 disable
set interfaces wirelessmodem <interface> vrf <vrf>

Place interface in given VRF instance.

See also

There is an entire chapter about how to configure a VRF, please check this for additional information.

Example:

set interfaces wirelessmodem wlm0 vrf red

WirelessModem (WWAN) options

set interfaces wirelessmodem <interface> apn <apn>
Every WWAN connection requires an APN which is used by the client to dial into the ISPs network. This is a mandatory parameter. Contact your Service Provider for correct APN.
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.
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.
set interfaces wirelessmodem <interface> no-peer-dns
Do not install DNS nameservers received from ISP into system wide nameserver list.
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.

Operation

show interfaces wirelessmodem <interface>

Retrive interface information from given WWAN interface.

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
show interfaces wirelessmodem <interface> statistics

Retrive interface statistics from given WWAN interface.

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
show interfaces wirelessmodem <interface> log
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 PC Engines APU4.

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 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)