NAME
router.conf - WANPIPE configuration file
DESCRIPTION
This is the main router configuration file which defines WAN links and network interfaces to configure WANPIPE drivers. The router.conf file in the /etc directory has to editted to make it specific to the WANPIPE hardware and the protocol being used. The following steps should be followed to ensure proper setup of your WANPIPE driver:
- 1) Edit [devices] section
-
WANPIPE devices are named 'wanpipeN', where N is 1 to 8. For each adapter installed add a line to the [devices] section as follows:
wanpipeN = { config_id }, { description }
where config_id is one of the following:
WAN_X25 for X.25 link WAN_FR for frame relay link WAN_PPP for PPP link
and description is an optional description string
For example:
wanpipe1 = WAN_X.25, X.25 link wanpipe2 = WAN_FR, frame relay link
- 2) Edit [interfaces] section
-
This section defines the Network interfaces created by the Configure script. For each interface defined add a line to the [interfaces] section as follows:
{ name } = { device },{ media_addr },{ description }
where:
-
name represents name of the interface defined in (/usr/lib/router/interfaces/)
-
device represents name of the device (from the [devices] section) this interface is associated with
-
media_addr represents media address for this logical channel, if applicable.
-
description description of this interface (optional)
Media address syntax is device and media specific. The convention is as follows:
for X.25 permanent virtual circuit use PVC number in decimal notation
for X.25 switched virtual circuit use '@' character followed by the X.25 destination address in decimal notation
for Frame relay permanent virtual use DLCI number in decimal notation circuit
For example:
-
wan0 = wanpipe1, @123456, X.25 connection to the branch office 1 (SVC)
-
wan1 = wanpipe1, 1, X.25 PVC connection to the branch office 2 (PVC)
-
wan2 = wanpipe2, 16, frame relay connection to the branch office 3
-
wan3 = wanpipe2, 17, frame relay connection to ISP
- 3) Edit device private configuration section
-
For each WANPIPE device defined in the [devices] section create a section with the same name, i.e. for the device wanpipe1 create a section [wanpipe1], for the device wanpipe2 create a section [wanpipe2] and so on.
This section includes all the card specific parameters with additonal protocol specific parameters if applicable. With this section you can configure all the WANPIPE cards. However for the Integrated CSU/DSU (FT1) boards you MUST also configure them using the DOS FT1 CONFIGURATION UTILITY that can be found on the utilities disk that came with the card.
The following explains the keywords used in device private configuration section and states whether they are mandatory or optional. It also states which keywords are protocol specific.
-
IOPort Adapter's I/O port address. Make sure there is no conflict. (Mandatory for all cards and protocols)
-
IRQ Adapter's interrupt request level. Make sure there is no conflict. (Mandatory for all cards and protocol)
-
MemAddr Address of the adapter shared memory window. If commented out the memory address is determined automatically. (Optional)
-
Firmware Name of the adapter firmware (including path). (Mandatory for all cards) Notice the difference for each PROTOCOL:
-
FRAME RELAY Avaiable options are:
For 508 cards: /usr/lib/router/wanpipe/fr508.sfm
-
PPP Available options are:
For 508 cards: /usr/lib/router/wanpipe/ppp508.sfm
-
X25 Available options are:
For 508 cards: /usr/lib/router/wanpipe/x25_508.sfm
-
Interface Physical interface type. Available options (508 cards) are:
-
RS232 : RS-232C interface (V.10)
-
V35 : V.35 interface (V.11/RS-422/RS-485/X.21)
Does not apply to FT1 cards.
-
Clocking Source of the adapter transmit and receive clock signals. Available options are:
-
External : Clock is provided externally (e.g. by the modem or CSU/DSU). Use this for FT1 boards.
-
Internal : Clock is generated on the adapter. When there are two Sangoma Cards back to back set clocking to Internal on one of the cards.
-
BaudRate Data transfer rate in bits per second. These values are meaningful if internal clocking is selected. (like in a back-to-back testing configuration) Notice the difference for each PROTOCOL:
-
FRAME RELAY and PPP Typical values are:
9600 9.6 kbps 19200 19.2 kbps 38400 38.4 kbps 56000 56 kbps 64000 64 kbps 128000 128 kbps 1544000 1.544 Mbps (T-1) 2048000 2 Mbps (E-1)
-
X25 Typical values are:
9600 9.6 kbps 19200 19.2 kbps 38400 38.4 kbps 56000 56 kbps 64000 64 kbps 128000 128 kbps
-
MTU Maximum transmit unit size (in bytes). This value limits the maximum size of the data packet that can be sent over the WAN link, including any encapsulation header that router may add. It usually has to be not less than the largest MTU of all interfaces configured for this link plus WAN media header size (if any), unless the WAN driver can perform fragmentation of data packets. Notice the difference for each PROTOCOL:
-
FRAME RELAY Note that this also includes header information required for encapsulating higher level protocols such as TCP/IP and IPX. The maximum MTU size supported by the adapter is 4096 bytes. Default value is 1500.
-
X25 This value defines the maximum size of the X.25 data packet. Available options are:
64 128 256 512 1024
Note that X.25 driver provides for packet fragmentation, so that MTUs of the network interfaces using X.25 link can be as large as needed
-
PPP The MTU value specified is used for Local Maximum-Receive-Unit(MRU)/MTU and Minimum Remote MRU. Recommended value for PPP is 1500.
-
UDPPORT The UDP port to be used for UDP management by the monitor (explained later). The monitor utilities like fpipemon and pipemon should refer to the udpport defined here.
-
Station Notice the difference for each PROTOCOL:
-
FRAME RELAY This parameter specifies whether the adapter should operate as a Customer Premises Equipment (CPE) or emulate a frame relay switch (Access Node). Available options are:
CPE CPE mode (default) Node Access Node (switch emulation mode)
-
PPP Does not Apply.
-
X25 This parameter defines whether the adapter should operate as a Data Terminal Equipment (DTE) or Data Circuit Equipment (DCE). Normally, you should select DTE mode. DCE mode is primarily used in back-to-back testing configurations. Available options are:
DTE DTE mode (default) DCE DCE mode
-
TTL This keyword defines the Time To Live for a UDP packet used by the monitoring system. The user can control the scope of a UDP packet by associating a number that decrements with each hop. Notice the difference for each PROTOCOL:
-
FRAME RELAY Any value between 0 to 255.
-
PPP Any value between 0 to 255.
-
X25 Currently not implemented.
-
IPX This parameter either enables or disables the use of IPX data. YES or NO (default) is allowed. (See also wanpipe.ipx) Notice the difference for each PROTOCOL:
-
FRAME RELAY Supported for multiple channels.
-
PPP Supported.
-
X25 Supported for multiple channel.
-
NETWORK This parameters specifies the IPX Network Number. Can be any unique 8 digit hexadecimal number. The default is 0xDEADBEEF. (See also wanpipe.ipx) Notice the difference for each PROTOCOL:
-
FRAME RELAY Supported for multiple channel.
-
PPP Supported.
-
X25 Supported for multiple channel.
-
Signalling *****ONLY APPLIES TO FRAME RELAY PROTOCOL*****
This parameter specifies frame relay link management type. Available options are:
ANSI ANSI T1.617 Annex D (default) Q933 ITU Q.933A LMI LMI
-
DLCINUMBER *****ONLY APPLIES TO FRAME RELAY PROTOCOL*****
This parameter is used to define logical channels activated by the adapter configured as an Access Node. Number of DLCI should not exceed 100 for the S508 adapter. Default value for DLCINUMBER parameter is 0. This is typically used in a back-to-back testing configuration.
-
T391 *****ONLY APPLIES TO FRAME RELAY PROTOCOL*****
This is the Link Integrity Verification Timer value in seconds. It should be within a range from 5 to 30 and is relevant only if adapter is configured as CPE.
-
T392 *****ONLY APPLIES TO FRAME RELAY PROTOCOL*****
This is the Polling Verification Timer value in seconds. It should be within a range from 5 to 30 and is relevant only if adapter is configured as Access Node.
-
N391 *****ONLY APPLIES TO FRAME RELAY PROTOCOL*****
This is the Full Status Polling Cycle Counter. Its value should be within a range from 1 to 255 and is relevant only if adapter is configured as CPE.
-
N392 *****ONLY APPLIES TO FRAME RELAY PROTOCOL*****
This is the Error Threshold Counter. Its value should be within a range from 1 to 10 and is relevant for both CPE and Access Node configurations.
-
N393 *****ONLY APPLIES TO FRAME RELAY PROTOCOL*****
This is the Monitored Events Counter. Its value should be within a range from 1 to 10 and is relevant for both CPE and Access Node configurations.
-
LowestPVC, HighestPVC *****ONLY APPLIES TO X25 PROTOCOL*****
These parameters are used to define permanent virtual circuit range as assigned by your the X.25 service provider. Valid values are between 0 and 4095. Default values for both parameters are 0, meaning that no PVCs are assigned. Note that maximum number of both permanent and virtual cuircuits should not exceed 255.
-
LowestSVC, HighestSVC *****ONLY APPLIES TO X25 PROTOCOL*****
These parameters are used to define switched virtual circuit range as assigned by your the X.25 service provider. Valid values are between 0 and 4095. Defaultvalues for both parameters are 0, meaning that no SVCs are assigned. Note that maximum number of both permanent and virtual cuircuits should not exceed 255.
-
HDCLWindow *****ONLY APPLIES TO X25 PROTOCOL*****
This parameter defines the size of the HDLC frame window, i.e. the maximum number of sequentially numbered Information frames that can be sent without waiting for acknowledgement. Valid values are from 1 to 7. Default is 7.
-
PacketWindow *****ONLY APPLIES TO X25 PROTOCOL*****
This parameter defines the default size of the X.25 packet window, i.e. the maximum number of sequentially numberred data packets that can be sent without waiting for acknowledgement. Valid values are from 1 to 7. Default is 2.
-
CCITTCompat *****ONLY APPLIES TO X25 PROTOCOL*****
This parameter defines CCITT X.25 compatibility level. Available options are:
-
1988 1988 version of the Recommendation X.25 (default)
-
1984 1984 version of the Recommendation X.25
-
1980 1980 version of the Recommendation X.25
-
AUTHENTICATOR *****ONLY APPLIES TO PPP PROTOCOL*****
This paramater decides whether your local host will be the authenticator or not. Options : YES or NO.
If your local side is the authenticator then your side will require that the authentication is passed before the link can be established. If your local side is not the authenticator then your peer side will determine if any authentication is required or not.
- 4) Edit/Create Interface private configuration section
-
This section applies only to FRAME RELAY, PPP and X25 protocol. For every interface listed in the [interfaces] section create another section underneath all the private device configuration section. For instance for interface "fr1" create section [fr1], for interface "svc1" create section [svc1] and so on. If these sections are not defined then all the parameters in the section are assigned default value.
For FRAME RELAY protocol the following parameter(s) should be added in the interfaces section:
-
MULTICAST This parameter either enables or disables discarding packets with a multicast source address. Available options are:
-
YES Do not discard packets with a multicast source addr.
-
NO Discard packets with a multicast source addr.
Default is set to NO.
For X25 protocol the following parameter(s) should be added in the interfaces section:
-
IDLETIMEOUT The time in seconds before an SVC will disconnect if there is no data over the link. The default is 90 seconds.
-
HOLDTIMEOUT The time in seconds to wait before retrying a failed connection. The default is 10 seconds.
For PPP protocol the following parameter(s) should be added in the interfaces section:
EXAMPLES
FILES
- /etc/router.conf
-
Configuration file for WANPIPE
AUTHOR
Jaspreet Singh <[email protected]>