]>
Commit | Line | Data |
---|---|---|
7a302fa7 MT |
1 | <?xml version="1.0"?> |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS/DTD DocBook XML V4.2//EN" | |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | |
4 | ||
5 | <refentry id="network-zone-modem"> | |
6 | <refentryinfo> | |
7 | <title>network-zone-modem</title> | |
8 | <productname>network</productname> | |
9 | ||
10 | <authorgroup> | |
11 | <author> | |
12 | <contrib>Developer</contrib> | |
13 | <firstname>Michael</firstname> | |
14 | <surname>Tremer</surname> | |
15 | <email>michael.tremer@ipfire.org</email> | |
16 | </author> | |
17 | </authorgroup> | |
18 | </refentryinfo> | |
19 | ||
20 | <refmeta> | |
21 | <refentrytitle>network-zone-modem</refentrytitle> | |
22 | <manvolnum>8</manvolnum> | |
23 | </refmeta> | |
24 | ||
25 | <refnamediv> | |
26 | <refname>network-zone-modem</refname> | |
27 | <refpurpose>Network Configuration Control Program</refpurpose> | |
28 | </refnamediv> | |
29 | ||
30 | <refsynopsisdiv> | |
31 | <cmdsynopsis> | |
32 | <command>network zone new <replaceable>ZONE</replaceable> modem ...</command> | |
33 | </cmdsynopsis> | |
34 | </refsynopsisdiv> | |
35 | ||
36 | <refsect1> | |
37 | <title>Description</title> | |
38 | ||
39 | <para> | |
40 | The modem hook uses a serial interface to establish a PPP session to an | |
41 | Internet Service Provider. This method is used by 56k modems and mobile | |
42 | networks like LTE, GSM and 3G. | |
43 | </para> | |
44 | </refsect1> | |
45 | ||
46 | <refsect1> | |
47 | <title>Options</title> | |
48 | ||
49 | <para> | |
50 | The following options are understood: | |
51 | </para> | |
52 | ||
53 | <variablelist> | |
54 | <varlistentry> | |
55 | <term> | |
56 | <option>--device=<replaceable>DEVICE</replaceable></option> | |
57 | </term> | |
58 | ||
59 | <listitem> | |
60 | <para> | |
61 | Sets the serial device that is used to connect. | |
62 | </para> | |
63 | <para> | |
64 | Example: /dev/ttyUSB0 | |
65 | </para> | |
66 | </listitem> | |
67 | </varlistentry> | |
68 | ||
69 | <varlistentry> | |
70 | <term> | |
71 | <option>--monitor-device=<replaceable>DEVICE</replaceable></option> | |
72 | </term> | |
73 | ||
74 | <listitem> | |
75 | <para> | |
76 | The optional monitor device is used to collect status | |
77 | information like signal strength and link quality while | |
78 | the connection is established. | |
79 | </para> | |
80 | </listitem> | |
81 | </varlistentry> | |
82 | ||
83 | <varlistentry> | |
84 | <term> | |
85 | <option>--imsi=<replaceable>IMSI</replaceable></option> | |
86 | </term> | |
87 | ||
88 | <listitem> | |
89 | <para> | |
90 | Set the IMSI of the SIM card inside the wireless modem | |
91 | to identify it when it is plugged in at runtime. | |
92 | </para> | |
93 | </listitem> | |
94 | </varlistentry> | |
95 | ||
96 | <varlistentry> | |
97 | <term> | |
98 | <option>--pin=<replaceable>PIN</replaceable></option> | |
99 | </term> | |
100 | ||
101 | <listitem> | |
102 | <para> | |
103 | The PIN number of the SIM card. | |
104 | </para> | |
105 | <para> | |
106 | This will be used to unlock the SIM card when it | |
107 | is locked. | |
108 | </para> | |
109 | </listitem> | |
110 | </varlistentry> | |
111 | ||
112 | <varlistentry> | |
113 | <term> | |
114 | <option>--apn=<replaceable>APN</replaceable></option> | |
115 | </term> | |
116 | ||
117 | <listitem> | |
118 | <para> | |
119 | Sets the Access Point Name (<replaceable>APN</replaceable>) | |
120 | that the modem connects to. | |
121 | </para> | |
122 | </listitem> | |
123 | </varlistentry> | |
124 | ||
125 | <varlistentry> | |
126 | <term> | |
127 | <option>--phone-number=<replaceable>PHONE-NUMBER</replaceable></option> | |
128 | </term> | |
129 | ||
130 | <listitem> | |
131 | <para> | |
132 | Sets the phone number that is dialed by the modem when | |
133 | the connection is to be established. | |
134 | </para> | |
135 | </listitem> | |
136 | </varlistentry> | |
137 | ||
138 | <varlistentry> | |
139 | <term> | |
140 | <option>--username=<replaceable>USERNAME</replaceable></option> | |
141 | </term> | |
142 | ||
143 | <listitem> | |
144 | <para> | |
145 | Sets the username for authentication. | |
146 | </para> | |
147 | </listitem> | |
148 | </varlistentry> | |
149 | ||
150 | <varlistentry> | |
151 | <term> | |
152 | <option>--password=<replaceable>PASSWORD</replaceable></option> | |
153 | </term> | |
154 | ||
155 | <listitem> | |
156 | <para> | |
157 | Sets the password for authentication. | |
158 | </para> | |
159 | <para> | |
160 | Use the <option>--auth=</option> option to transmit it | |
161 | in a secure manner to the provider. | |
162 | </para> | |
163 | </listitem> | |
164 | </varlistentry> | |
165 | ||
166 | <varlistentry> | |
167 | <term> | |
168 | <option>--baudrate=<emphasis>921600</emphasis></option> | |
169 | </term> | |
170 | ||
171 | <listitem> | |
172 | <para> | |
173 | The baudrate for the serial link to the modem. | |
174 | </para> | |
175 | </listitem> | |
176 | </varlistentry> | |
177 | ||
178 | <varlistentry> | |
179 | <term> | |
5f76a54d | 180 | <option>--mtu=<emphasis>N</emphasis></option> |
7a302fa7 MT |
181 | </term> |
182 | ||
183 | <listitem> | |
184 | <para> | |
185 | Sets the default MTU of the PPP connection. | |
7a302fa7 MT |
186 | </para> |
187 | </listitem> | |
188 | </varlistentry> | |
189 | ||
190 | <varlistentry> | |
191 | <term> | |
192 | <option>--auth=[chap|pap]</option> | |
193 | </term> | |
194 | ||
195 | <listitem> | |
196 | <para> | |
197 | Define the authentication method that is used to | |
198 | authenticate against your provider. | |
199 | The default is to use the provider's preference. | |
200 | </para> | |
201 | <itemizedlist> | |
202 | <listitem> | |
203 | <para> | |
204 | <emphasis>Challange-Handshake Authentication Protocol</emphasis> | |
205 | (chap) is the preferred secure method. | |
206 | </para> | |
207 | </listitem> | |
208 | <listitem> | |
209 | <para> | |
210 | <emphasis>Password Authentication Protocol</emphasis> | |
211 | (pap) sends the plaintext password to the authentication | |
212 | server which is the reason why it should be avoided to use PAP. | |
213 | </para> | |
214 | </listitem> | |
215 | </itemizedlist> | |
216 | </listitem> | |
217 | </varlistentry> | |
218 | </variablelist> | |
219 | </refsect1> | |
220 | ||
221 | <refsect1> | |
222 | <title>See Also</title> | |
223 | ||
224 | <para> | |
225 | <citerefentry> | |
226 | <refentrytitle>network</refentrytitle> | |
227 | <manvolnum>8</manvolnum> | |
228 | </citerefentry>, | |
229 | <citerefentry> | |
230 | <refentrytitle>network-zone</refentrytitle> | |
231 | <manvolnum>8</manvolnum> | |
232 | </citerefentry> | |
233 | </para> | |
234 | </refsect1> | |
235 | </refentry> |