1isdnctrl(8)               Linux System Administration              isdnctrl(8)
2
3
4

NAME

6       isdnctrl - get/set ISDN device information
7

SYNOPSIS

9       isdnctrl action device ...
10

DESCRIPTION

12       isdnctrl  is used to create and delete network interfaces for ISDN, set
13       up the various parameters and phone numbers for dial in and  dial  out.
14       It is also used to list the current parameters of an already configured
15       network interface.  isdnctrl is not needed for  configuration  of  ISDN
16       ttys!
17
18       The use of isdnctrl is independent of the hardware driver.
19

OPTIONS

21       The following actions may be given to isdnctrl.
22
23       addif name
24              Adds  a  new ISDN interface name to the kernel. If name is omit‐
25              ted, the kernel will use ethX, where X is an  increasing  number
26              starting  from 0. This is probably not useful with ISDN so using
27              a name like isdn0 (for raw ip interfaces) or ippp0 (for synchro‐
28              nous PPP interfaces) is always recommended.
29
30       delif name [force]
31              Removes the ISDN interface name from the kernel. If the optional
32              keyword force is appended, isdnctrl executes ifconfig name  down
33              before removing it.
34
35       reset [force]
36              Removes  all  ISDN interfaces from the kernel if it is possible.
37              If the optional keyword force  is  appended,  isdnctrl  executes
38              ifconfig name down before removing an interface.
39
40       ifdefaults name
41              resets the interface name to some reasonable defaults.
42
43       dialmode name [off|manual|auto]
44              Sets the dial mode of the interface to one of:
45
46              off
47              no  connection can be made; an existing connection is terminated
48              immediately.  Incoming connections are also not possible.
49
50              manual
51              manual dialing / hangup; a connection will only  be  made  after
52              isdnctrl  dial  name but the line will be disconnected after the
53              huptimeout value set if using kernel drivers updated since 1 Nov
54              1998;  otherwise an explicit isdnctrl hangup name will be needed
55              to cause the connection to be dropped.
56              Incoming connections are possible; however, if this interface is
57              configured  in callback in mode, the callback dial will not hap‐
58              pen (as this is actually an outgoing connection, not an incoming
59              one).
60
61              auto
62              autodial  mode; an outgoing packet will trigger a dialout, and a
63              hangup will occur after  the  huptimeout  value  specified  (see
64              below).
65              An interface in auto dial mode will call another system back (if
66              configured in callback in mode).
67
68              auto was the "old" behaviour (as  it  was  before  dialmode  was
69              implemented).
70
71              If  no  argument  is  given,  the current dialmode value is dis‐
72              played.
73
74              You can give all as the interface name; the command will then be
75              executed for all interfaces.
76
77       addphone name out num
78              Adds the phone number num to the list of outgoing numbers of the
79              ISDN interface name.  Numbers in this list are used to dial  the
80              remote  station  if the connection is down and packets are to be
81              sent via the interface (Dial on demand). More  than  one  number
82              can be set by calling isdnctrl addphone repeatedly. If more than
83              one number is set, these will be tried one  after  another  (the
84              last  added  number  is tried first, etc.).  When using a german
85              SPV-type connection, the number has to be prefixed by a  capital
86              S.
87
88       addphone name in num
89              Adds the phone number num to the list of incoming numbers of the
90              ISDN interface name.  Numbers in this list are  used  to  verify
91              access  permission  of the remote station if an incoming call is
92              received. The verification can be disabled by setting the inter‐
93              face  into insecure mode using isdnctrl name secure off.  If the
94              list is empty, incoming calls are disabled.  More than one  num‐
95              ber  can  be added by calling isdnctrl addphone repeatedly. Also
96              wildcards can be used (see below).
97
98       delphone name in|out num
99              Removes phone number num from the  incoming  or  outgoing  phone
100              list.
101
102       eaz name [num]
103              Set the EAZ (German 1TR6 protocol) or MSN (Euro-ISDN E-DSS1) for
104              ISDN interface name to num.  For an EAZ this is only one  digit,
105              while  for  an MSN num is the whole MSN (usually the local phone
106              number). If num is omitted, isdnctrl prints the current  setting
107              for ISDN interface name.
108
109       huptimeout name [seconds]
110              Set  the  hangup timeout for ISDN interface name to seconds.  If
111              there is inactivity (i.e. no traffic on the interface)  for  the
112              given  time  the driver automatically shuts down the connection.
113              If seconds is omitted isdnctrl prints the  current  setting  for
114              interface name.
115
116       cbdelay name [seconds]
117              Set  the  callback delay for ISDN interface name to seconds.  If
118              callback mode for this interface is in, dialing is  delayed  the
119              given  time.  If the callback mode is out, after dialing out and
120              waiting the given time, a hangup is issued to free the line  for
121              the  incoming  callback  from  the  remote machine. This hangup-
122              after-dial is disabled by setting cbdelay to 0.  If  seconds  is
123              omitted isdnctrl prints the current setting for interface name.
124
125       dialmax name [num]
126              Set  the number of dial attempts for ISDN interface name to num.
127              If dialing, each phone number is tried this  many  times  before
128              giving  up.   If num is omitted isdnctrl prints the current set‐
129              ting for interface name.
130
131       ihup name [on|off]
132              Turn on or off the hangup timeout for incoming calls  on  inter‐
133              face  name.   If  on  or  off  is omitted the current setting is
134              printed.
135
136       chargehup name [on|off]
137              Turn on or off hangup before  next  charge  info  for  interface
138              name.   This  can  only  be  used if the ISDN provider transmits
139              charge info during and after the connection.  If set to on,  the
140              driver  will  close  the  connection just before the next charge
141              info will be received if the interface is inactive. If on or off
142              is omitted the current setting is printed.
143
144       chargeint name [seconds]
145              If  seconds  are given, the charge interval for the given inter‐
146              face is set. This may be useful on ISDN lines with no chargeinfo
147              or no online chargeinfo. The connection will be closed 2 seconds
148              before the end of the next estimated charge interval if huptime‐
149              out  seconds  of  inactivity  have  been reached. If ihup is on,
150              incoming connections are closed  by  this  mechanism  also.   On
151              lines  with  online  charge info you also might ask by chargeint
152              name for the current charge interval as delivered from the tele‐
153              com on a given interface.
154
155       secure name [on|off]
156              Turns on or off the security feature for interface name.  If set
157              to on, incoming calls will only be accepted if the calling  num‐
158              ber can be found in the incoming access list. See description of
159              action addphone for information about how to add numbers to this
160              list.  If on or off is omitted, the current setting is printed.
161
162       callback name [mode]
163              Set  callback mode for interface name to mode mode.  If callback
164              mode is in, then after getting an incoming call, a  callback  is
165              triggered.  If  callback mode is out, then the local system does
166              the initial call and then  waits  for  callback  of  the  remote
167              machine.  The option on is available only for compatibility with
168              older versions. Its meaning is the same like  in.   If  callback
169              mode is off, calls are handled normally without special process‐
170              ing.
171
172       cbhup name [on|off]
173              Turns on or off Hangup (Reject) for interface name before start‐
174              ing  callback.  If cbhup is on, when receiving an incoming call,
175              the interface  first  rejects  that  call  before  the  callback
176              sequence  is  started. If on or off is omitted, the current set‐
177              ting is printed.
178
179       encap name [encapsulation]
180              Set the encapsulation mode for interface name.  Possible  encap‐
181              sulations are:
182
183              rawip
184              raw ip encapsulation (default)
185
186              ip
187              IP + typefield encapsulation
188
189              cisco-h
190              Special  mode  for  communicating with a Cisco in HDLC-mode with
191              Cisco-keepalive switched off.
192
193              ethernet
194              ethernet over ISDN (MAC-header included)
195
196              syncppp
197              Synchronous PPP over ISDN
198
199              uihdlc
200              raw ip with additional ui-header
201
202              cisco-hk
203              Special mode for communicating with a Cisco  in  HDLC-mode  with
204              Cisco-keepalive switched on.
205
206              x25iface
207              Provides an interface as required by the Linux X.25 PLP protocol
208              implementation (requires Linux 2.1.x or newer).
209
210       If encapsulation is omitted, the current setting is printed.
211
212       l2_prot name [protocol]
213              Set the layer-2 protocol for interface  name.   Possible  values
214              for protocol are:
215              x75i,  x75ui,  x75bui and hdlc.  If protocol is omitted the cur‐
216              rent setting is printed.
217
218       l3_prot  name  [ protocol ]
219              Set the layer-3 protocol for interface name.  At the moment only
220              trans  is  supported  here.   If protocol is omitted the current
221              setting is printed.
222
223       list name
224              List all parameters and the charge info for interface name.   If
225              name is all, then all interfaces are listed.
226
227       status name
228              Show  the  connection status for interface name.  The output can
229              be one of the following types:
230
231              ippp0 not connected
232              There is no connection
233
234              ippp0 connected to 0123456789
235              There is an outgoing connection to phone number 0123456789
236
237              ippp0 connected from 0123456789
238              There is an incoming connection from phone number 0123456789
239
240       If the interface is connected, the exit status of the command is  true,
241       else it is false.
242       If name is all, then the connection status for all interfaces is shown.
243       The exit status is always true in this case.
244       If name is active, then only those interfaces that are  currently  con‐
245       nected are shown. The exit status is always true in this case.
246
247       verbose num
248              Set verbosity level to num.
249
250       hangup name
251              The connection of interface name is closed immediately.
252
253       bind name driverId,channel [exclusive]
254              Binds  an  interface  name  to a physical channel.  The driverId
255              identifies a specific S0-Port. The  channels  of  a  port  start
256              counting with zero. If exclusive is given, other interfaces can‐
257              not use that channel anymore.  Otherwise,  the  channel  may  be
258              used by other interfaces.
259
260       unbind name
261              Unbinds a the previously bound interface name.
262
263       pppbind name [num]
264              Binds  the  interface name to an ippp device /dev/ipppnum.  This
265              works only for synchronous ppp. The value must be a number.   If
266              num  is omitted and name is called ipppX , then the interface is
267              bound to /dev/ipppX.
268
269       pppunbind name
270              Unbinds the previously bound interface name.
271
272
273       busreject driverId [on|off]
274              If switched on, instead of ignoring incoming calls not  matching
275              any interface, isdn4linux responds with a REJECT to those calls.
276              If switched off, isdn4linux is passive, allowing  other  devices
277              connected  to  the same S0-bus to answer the call.  You normally
278              should not enable this feature, if the ISDN adaptor is  not  the
279              only device connected to the S0-bus.  Otherwise it could happen,
280              that isdn4linux  rejects  an  incoming  call  which  belongs  to
281              another device on the bus.
282
283
284       addslave name slave
285              Adds  a  slave  interface  named slave to interface name for raw
286              channel-bundling. For bundling of more than  two  channels,  any
287              number of slaves can be added to an interface by using this com‐
288              mand repeatedly.  name must refer to an existing "master" inter‐
289              face (not a slave). Slave interfaces are not visible to the ker‐
290              nel, however all usual ISDN settings can be configured.  Because
291              slave interfaces are not visible to the kernel, they are config‐
292              ured "through" their "master", so it  is  important  that  slave
293              interfaces  are  added  before  the  corresponding  "master"  is
294              started by ifconfig.  If the "master" is already up, it  has  to
295              be  shutdown with ifconfig down ...  otherwise the addslave com‐
296              mand will be rejected.
297
298
299       sdelay name num
300              Set delay for slave-dialing.  The master interface name  has  to
301              have  a  load of more than trigger cps for at least num seconds,
302              before its slave starts dialing.
303              Note that this only works for rawIP, not MPPP!
304
305
306       trigger name num
307              Set trigger level for slave-dialing.  The master interface  name
308              has to have a load of more than num cps for at least sdelay sec‐
309              onds, before its slave starts dialing.
310              Note that this only works for rawIP, not MPPP!
311
312
313       addlink name
314              For MPPP, this adds a slave interface to  the  existing  connec‐
315              tion, i.e. connect the extra channel now. It is like a dial com‐
316              mand for the extra channel.
317              This also means that addlink will only work if the master inter‐
318              face  name must already be connected! Also, the dialmode for the
319              slave interface must be auto.
320
321
322       removelink name
323              For MPPP, this removes a slave interface from the existing  con‐
324              nection, i.e. hangup the extra channel now.
325
326
327       dial name
328              Force dialing of interface name.
329
330       mapping driverId MSN0[,MSN1[,MSN2]] ... [,MSN9]
331              Installs  a  mapping-table for MSN<->EAZ-mapping. See README for
332              details.
333

WILDCARDS

335       When using isdnctrl addphone name in num to add phone  numbers  to  the
336       incoming-call  accept-list  of an interface, wildcards similar to shell
337       wildcards can be used.  The following wildcards are supported:
338
339
340       ?      one arbitrary digit
341
342       *      zero or arbitrary number of digits
343
344       [list] one of the digits in list
345
346       [1-5]  one digit in the range of (including) 1 and 5.
347
348       ^      if this appears as the first character in a  list,  inverts  the
349              list.
350

BUGS

352       This man page is not complete.
353

AUTHOR

355       Fritz Elfert <fritz@isdn4linux.de>
356

SEE ALSO

358       ttyI(4), isdnctrl(4), isdninfo(4), isdn_audio(4), isdn_cause(7).
359
360
361
362isdn4k-utils-3.9                  2003/03/11                       isdnctrl(8)
Impressum