projects / people / ms / network.git / blame
| Commit | Line | Data |
|---|---|---|
| 23eec7d0 MT |
1 | = network-zone-modem(8) |
| 2 | Michael Tremer <michael.tremer@ipfire.org> | |
| 3 | ||
| 4 | == NAME | |
| 5 | network-zone-modem - Configure serial modems | |
| 6 | ||
| 7 | == SYNOPSIS | |
| 8 | [verse] | |
| 9 | `network zone new ZONE modem ...` | |
| 10 | ||
| 11 | == DESCRIPTION | |
| 12 | The modem hook uses a serial interface to establish a PPP session to an Internet | |
| 13 | Service Provider. This method is used by 56k modems and mobile networks like | |
| 14 | LTE, GSM and 3G. | |
| 15 | ||
| 16 | == OPTIONS | |
| 17 | The following options are understood: | |
| 18 | ||
| 19 | `--device=DEVICE`:: | |
| 20 | Sets the serial device that is used to connect. Example: /dev/ttyUSB0 | |
| 21 | ||
| 22 | `--monitor-device=DEVICE`:: | |
| 23 | The optional monitor device is used to collect status information like | |
| 24 | signal strength and link quality while the connection is established. | |
| 25 | ||
| 26 | `--imsi=IMSI`:: | |
| 27 | Set the IMSI of the SIM card inside the wireless modem to identify it when | |
| 28 | it is plugged in at runtime. | |
| 29 | ||
| 30 | `--pin=PIN`:: | |
| 31 | The PIN number of the SIM card. | |
| 32 | This will be used to unlock the SIM card when it is locked. | |
| 33 | ||
| 34 | `--apn=APN`:: | |
| 35 | Sets the Access Point Name (APN) that the modem connects to. | |
| 36 | ||
| 37 | `--phone-number=PHONE-NUMBER`:: | |
| 38 | Sets the phone number that is dialled by the modem when the connection is | |
| 39 | to be established. | |
| 40 | ||
| 41 | `--username=USERNAME`:: | |
| 42 | Sets the username for authentication. | |
| 43 | ||
| 44 | `--password=PASSWORD`:: | |
| 45 | Sets the password for authentication. | |
| 46 | + | |
| 47 | Use the `--auth=` option to transmit it in a secure manner to the provider. | |
| 48 | ||
| 49 | `--baudrate=921600`:: | |
| 50 | The baudrate for the serial link to the modem. | |
| 51 | ||
| 52 | `--mtu=N`:: | |
| 53 | Sets the default MTU of the PPP connection. | |
| 54 | ||
| 55 | `--auth=[chap|pap]`:: | |
| 56 | Define the authentication method that is used to authenticate against your | |
| 57 | provider. The default is to use the provider's preference. | |
| 58 | ||
| 59 | * _Challange-Handshake Authentication Protocol_ (`chap`) is the preferred, | |
| 60 | secure method. | |
| 61 | * _Password Authentication Protocol_ (`pap`) sends the plaintext password | |
| 62 | to the authentication server which is the reason why it should be avoided. | |
| 63 | ||
| 64 | == SEE ALSO | |
| 65 | link:network[8], | |
| 66 | link:network-zone[8] |