PC Press: Internet

home *** CD-ROM | disk | FTP | other *** search

/ PC Press: Internet / PC_PRESS.ISO / software / dos / misc / inar-100.exe / DOC / CONFIG.DOC next >

Wrap

Text File | 1995-05-21 | 21.1 KB | 613 lines

Documentation to the INAR configuration file ============================================ The configuration file contains all the details about your IP router formulated in a special syntax. This syntax is outlined in the file `SYNTAX.DOC', where objects in square brackets are optional and keywords separated by a vertical bar (pipeline character) are alternative choices. To get a better understanding of the structure of the configuration file you should print out the `SYNTAX.DOC' file and at least some of the sample config files and look at them while you are reading the following description. Note: In the following section words in angle brackets are to be replaced (including the angle brackets) by objects of the respective type. The order of entries in the config file is not important, with the two exceptions: - If multiple link entries have the same name, their order determines the order in which the associated ISDN numbers will be dialed. - If the gateway field of a route entry points to a direct route instead of an interface the direct route has to come first. If more than one interface, route or source entry is matching an IP address, the one with the narrowest netmask wins. The first `#' character in a line starts a comment. Comments are ignored by the configuration program. You can define variables as follows: set <string> <string> The first string is the name of the variable while the second string is its value. If the second string is missing the variable is set to the null string. Variables can be used like this: $(<string>) The string is the name of the variable. Variables are expanded at the time a line is read from the config file. Therefore, the order of definition and use of variables is important. An undefined variable expands to the null string. An escape character (`\') is defined which can precede the `$' or `#' character in order to revoke its special meaning. Also, if the escape character is followed by certain other characters the corresponding control character is generated (as defined in the ANSI C standard). And at last, the escape character can be used for line continuations if you place it directly at the end of a line. THE GLOBAL SETTINGS: ------------------------------------------- global syslog host <IP number> priority <keyword> logsource system routing monitor endlogsource endsyslog bootp <IP number> transitnet <IP number> transitmask <IP number> prefix <string> suffix <string> endglobal ------------------------------------------- global endglobal (optional) Contains settings that are not interface dependent. syslog endsyslog (optional) Send status messages to a UNIX host running a syslog daemon. The syslog facility is `local0'. Note that you might have to modify the `syslog.conf' file on the UNIX host in order to be able to log INAR's messages. Default: Don't send syslog messages. host <IP number> The IP address of the UNIX host. priority <keyword> Syslog messages of this priority or higher are sent. Refer to the syslog documentation on the UNIX host. You can chose one of the following arguments emergency alert critical error warning notice info debug logsource endlogsource Determines which events in the INAR router will trigger syslog messages. Possible arguments are system General infos and error messages. routing Infos about routes learned by RIP. monitor Periodic alive message (15 minutes interval). bootp <IP number> (optional) The IP address of the computer to which BOOTP requests should be forwarded to. Default: 0.0.0.0 (don't forward BOOTP requests). transitnet <IP number> (optional) The internal transit net base address for point-to-point links. You don't want to change this address. Default: 127.1.0.0 transitmask <IP number> (optional) The netmask for the transit net. You don't want to change this netmask. Default: 255.255.0.0 prefix <string> (optional) An MS-DOS command line to be inserted into `INAR.BAT' before the first line generated by interface entries. It is passed to the C language printf() function as the format string. Also, the number of interfaces is passed to printf() as an additional argument. So a `%u', for instance, would be expanded to the decimal representation of the number of interfaces. Default: No line. suffix <string> (optional) An MS-DOS command line to be inserted into `INAR.BAT' after the last line generated by interface entries. It is passed to the C language printf() function as the format string. Also, the number of interfaces is passed to printf() as an additional argument. So a `%u', for instance, would be expanded to the decimal representation of the number of interfaces. Default: No line. THE INTERFACE SETTINGS: ------------------------------------------- interface name <string> type <keyword> address <IP number> netmask <IP number> gateway <IP number> metric <decimal number> attributes send_rip listen_rip send_default_route listen_default_route poison_reverse no_directed_broadcast no_icmp_redirects hidden_interface host_route_split unreachable_network route_broadcasts global_broadcast broadcast_0 proxy_arp no_reverse_check endattributes driver prefix <string> command <string> controller <decimal number> index <decimal number> syslog <keyword> options <string> suffix <string> enddriver endinterface ------------------------------------------- interface endinterface Contains settings for an interface. name <string> The name of the interface. type <keyword> The type of the interface. You can chose one of the following arguments ethernet Real ethernet interface. point2point Point-to-point ethernet interface. isdn ISDN point-to-point interface. address <IP number> The IP address of the interface. If this interface is of type `point2point' or `isdn', take the IP address of one of the ethernet interfaces so that you don't have to waste an IP address for a point-to-point interface. netmask <IP number> (only with interface type `ethernet') The netmask for the IP net of the interface. gateway <IP number> (optional, only with interface type `point2point') The IP address of the gateway at the other end of the data link. Note: You should set this only if you are using a device driver in ethernet bridging mode (necessary for RIP over point-to-point links). Default: No gateway address (doesn't matter). metric <decimal number> A value to tell other routers in the network (via RIP) how "costly" this link is. A higher value discourages routes via this interface. attributes endattributes (optional) Change the behaviour of the interface. Possible arguments are send_rip Send routing informations (excl. default route) (RIP). listen_rip Listen to routing informations (excl. default route) (RIP). send_default_route Send default route informations (RIP). listen_default_route Listen to default route informations (RIP). poison_reverse If `send_rip' is also set, makes the network react faster to router failures under some circumstances, at the expense of slightly increased network bandwidth consumption. no_directed_broadcast (only with interface type `ethernet') Don't allow computers connected to a different interface to directly send IP packets to the broadcast address of this interface. no_icmp_redirects (only with interface type `ethernet') Don't send ICMP_REDIRECT messages to the sender of misrouted IP packets. hidden_interface (only with interface type `ethernet') Don't propagate informations about this interface via RIP. host_route_split (only with interface type `ethernet') Propagate the interface route via RIP as a number of host routes instead of a single network route. In order to avoid flooding the LAN with hundreds of host routes this works only for interfaces with a netmask corresponding to a class C net or smaller. unreachable_network (only with interface type `ethernet') IP packets addressed to this interface will be dropped and an ICMP_UNREACHABLE message will be returned. route_broadcasts (only with interface type `ethernet') Route global broadcasts to this interface if source and destination global IP net of the packet are identical. global_broadcast (only with interface type `ethernet') If `route_broadcasts' is set, route broadcasts to the global broadcast address of this interface instead of the subnet broadcast address. broadcast_0 (only with interface type `ethernet') Instead of the last address, use the first address of the IP net for broadcasts. This is for compatibility with old IP implementations and shouldn't be used in modern networks. proxy_arp (only with interface type `ethernet') Answer all ARP requests for addresses INAR knows a route for, provided the route points to a different interface. no_reverse_check Don't check whether the source IP address of a packet would be routed to the same interface as the packet came from. Setting this attribute creates a security gap but may be necessary if a computer with two or more interfaces is connected to two or more INAR interfaces. driver enddriver Details about the packet driver used for the interface. prefix <string> (optional) An MS-DOS command line to be inserted into `INAR.BAT' before the line generated for the packet driver. It is passed to the C language printf() function as the format string. Also, the number of the software interrupt used to communicate with the packet driver is passed to printf() as an additional argument. So a `%u', for instance, would be expanded to the decimal representation of the number of the software interrupt. Default: No line. command <string> (only with interface type `ethernet' or `point2point') An MS-DOS command line to be inserted into `INAR.BAT' containing the packet driver invocation. It is passed to the C language printf() function as the format string. Also, the number of the software interrupt used to communicate with the packet driver is passed to printf() as an additional argument. So a `%u', for instance, would be expanded to the decimal representation of the number of the software interrupt. Note: The packet driver used here has to act like a genuine ethernet driver even if it isn't a real ethernet driver but, for instance, a SLIP driver. That is, it has to support ARP etc. controller <decimal number> (only with interface type `isdn') The number of the ISDN controller. Usually, for an S0 bus connection, each controller handles two B channels. The first controller has the number zero. index <decimal number> (only with interface type `isdn') For the national german ISDN standard 1tr6 this is the EAZ (Endgeraeteauswahlziffer) assigned to this interface. A `0' means a global call while an EAZ in the range of `1' to `8' allows for an individual selection of devices on the S0 bus. For the EuroISDN standard E-DSS1 this is the index into the table of ISDN numbers which was defined during the CAPI installation. The ISDN number to which the index points is assigned to this interface. The first number in the table has the index zero. syslog <keyword> (only with interface type `isdn') Send dialin/dialout messages to a UNIX host running a syslog daemon. You can chose one of the following arguments on Enable syslog messages. off Disable syslog messages. Dialin/dialout messages will be sent to the screen instead. If you don't want this to happen you may want to add the `-q' (quiet) flag to the `options' line (see below). options <string> (optional, only with interface type `isdn') Options for the ISDN driver (ISPA). These options can be used to define the behaviour of ISDN links that don't have a link entry assigned to the respective route entry. Refer to the file `ISPA18.TXT' for further informations. Default: No options. suffix <string> (optional) An MS-DOS command line to be inserted into `INAR.BAT' after the line generated for the packet driver. It is passed to the C language printf() function as the format string. Also, the number of the software interrupt used to communicate with the packet driver is passed to printf() as an additional argument. So a `%u', for instance, would be expanded to the decimal representation of the number of the software interrupt. Default: No line. THE ROUTE SETTINGS: ------------------------------------------- route name <string> net <IP number> netmask <IP number> interface <string> gateway <IP number> link <string> metric <decimal number> attributes hidden_route host_route_split transient_route unreachable_network endattributes endroute ------------------------------------------- route endroute (optional) Contains settings for a static route. name <string> The name of the route. net <IP number> The IP address of the net or host to which this route applies. If this is the default route, instead of an IP number the keyword `default' is used. Note that a default route has no netmask. netmask <IP number> (only if not the default route) The netmask for the net or host to which this route applies. interface <string> The name of the interface to which IP packets matched by this route are to be sent. gateway <IP number> (only with interface type `ethernet') The IP address of the next gateway to which IP packets matched by this route are to be sent. If the destination net or host is directly connected to the interface used by this route, instead of an IP number the keyword `direct' is used. Note that a direct connection has no metric. link <string> (optional, only with interface type `isdn') The name of the link assigned to this route. The ISDN number of incoming calls is verified. Default: The ISDN driver uses the settings defined by the interface driver options string. No verification of the ISDN number of incoming calls is performed. metric <decimal number> (only if not a direct connection) A value to tell other routers in the network (via RIP) how "costly" this link is. A higher value discourages routes via this interface. attributes endattributes (optional) Change the behaviour of the route. Possible arguments are hidden_route Don't propagate informations about this route via RIP. host_route_split Propagate the route via RIP as a number of host routes instead of a single network route. In order to avoid flooding the LAN with hundreds of host routes this works only for routes with a netmask corresponding to a class C net or smaller. transient_route The route can be overridden by RIP. This can be used to define an initial route that is valid until it is replaced by the first RIP route matching the same net or host. unreachable_network IP packets matched by this route will be dropped and an ICMP_UNREACHABLE message will be returned. THE SOURCE ROUTE SETTINGS: ------------------------------------------- source net <IP number> netmask <IP number> refer <string list> attach <string list> route <keyword> endsource ------------------------------------------- source endsource (optional) Contains settings for a source route. The default action for an IP packet not matched by any source route is to let it pass. net <IP number> (mutualy exclusive with refer line) The IP source address of the net or host to which this route applies. If this is the default route, instead of an IP number the keyword `default' is used. Note that a default route has no netmask. netmask <IP number> (only if not the default route, mutualy exclusive with refer line) The netmask for the net or host to which this route applies. refer <string list> (mutualy exclusive with net/netmask line) Instead of using explicit net and netmask IP numbers to define the source route it can be linked to a static route or an interface. In this case the net and netmask of the static route or the interface are used for the source route. Multiple static route and interface names can be given in a comma separated list. Note: Source routes can't refer to interfaces of type `isdn' and of type `point2point' with omitted `gateway' field. attach <string list> The name of the route or interface this source route is attached to. If an IP packet is matched by a route or interface a lookup for an attached source route that matches the IP source address of the packet is performed. If a matching source route was found it determines whether the packet is to be dropped or passed. Multiple static route and interface names can be given in a comma separated list. Additionally, a `*' stands for all routes and interfaces while a `+' means all routes learned by RIP. The special case `+name' tells INAR to attach the source route to routes learned by RIP on interface `name'. Note: Source routes can't attach to interfaces of type `isdn' and of type `point2point' with omitted `gateway' field. route <keyword> Determines whether an IP packet matched by this source route is to be dropped or passed. You can chose one of the following arguments permit Pass packet. deny Drop packet and return an ICMP_UNREACHABLE message. THE LINK SETTINGS: ------------------------------------------- link name <string> address <string list> options <string> endlink ------------------------------------------- link endlink (optional, only with interface type `isdn') Contains settings for an ISDN link. name <string> The name of the link. Multiple links with the same name can exist and are tried in the order of their appearance until a connection can be established. address <string list> The destination ISDN number. The complete number including the area code has to be given. If the destination is in the same area as this IP router a period (`.') should be placed between the area code and the remainder of the ISDN number so that for dialouts the area code is stripped off of the ISDN number. For an SPV connection (only with national german ISDN standard 1tr6) an `s' has to be appended to the ISDN number. A subaddress (EuroISDN standard E-DSS1) may be appended to the ISDN number and is separated from it by a slash (`/'). It can only consist of digits (up to 16 characters). A second ISDN number can be given (separated from the first number by a comma) for channel bundling. options <string> (optional) The ISDN driver (ISPA) options used for this link. Refer to the file `ISPA18.TXT' for further informations. Default: No options.