gated.conf(4) gated.conf(4) NAME gated.conf - GateDaemon Configuration Guide SYNOPSIS /etc/gated.
gated.conf(4) gated.conf(4) used to show optional keywords and parameters. The vertical bar (|) is used to indicate between a choice of optional parameters. Parentheses (( and )) are used to group keywords and parameters when necessary. For example, in the syntax description: [ backbone | ( area area ) ] The square brackets say that either parameter is optional. The keywords are backbone and area. The vertical bar indicates that either "backbone" or "area area" may be specified.
gated.conf(4) generate (control) gated.conf(4) defines which routes to generate. Preference Preference is the value GateD uses to order preference of routes from one protocol or peer over another. Preference can be set in the GateD configuration files in several different configuration statements. Preference can be set based on network interface over another, from one protocol over another, or from one remote gateway over another.
gated.conf(4) gated.conf(4) aggregate/generate routes OSPF AS external routes BGP routes EGP aggregate/generate ospf bgp egp 130 150 170 200 Sample Preference Specifications interfaces { interface 138.66.12.2 preference 10 ; } ; rip yes { preference 90 ; } ; import proto rip gateway 138.66.12.1 preference 75 ; In these statements the preference applicable to routes learned via RIP from gateway 138.66.12.1 is 75. The last preference applicable to routes learned via RIP from gateway 128.66.12.
gated.conf(4) gated.conf(4) It is not currently possible to specify packet tracing from the command line. This is because a global option for packet tracing would potentially create too much output. When protocols inherit their tracing options from the global tracing options, tracing levels that do not make sense (such as parse, adv and packet tracing options) are masked out. Global tracing statements have an immediate effect, especially parsing options that effect the parsing of the configuration file.
gated.conf(4) gated.conf(4) current the directory, it just specifies the prefix applied to included file names. %include "filename" Identifies an include file. The contents of the file is included in the gated.conf file at the point in the gated.conf file where the %include directive is encountered. If the filename is not fully qualified (does not begin with "/"), it is considered to be relative to the directory defined in the %directory directive.
gated.conf(4) gated.
gated.conf(4) gated.conf(4) preference preference Sets the preference for routes to this interface when it is up and appears to be functioning properly. The default preference is 0. down preference preference Sets the preference for routes to this interface when GateD does not believe it to be functioning properly, but the kernel does not indicate it is down. The default value is 120.
gated.conf(4) gated.conf(4) multicast Specifies that the interface is multicast capable. Interface lists An interface list is a list of references to interfaces or groups of interfaces. There are four methods available for referring to interfaces. They are listed here from most general to most specific. all This refers to all available interfaces. Interface name wildcard This refers to all the interfaces of the same type.
gated.conf(4) gated.conf(4) If a subnet mask is specified on a point-to-point interface, it is only used by RIP version 1 and HELLO to determine which subnets may be propagated to the router on the other side of this interface. nonbroadcast multiaccess or nbma This type of interface is multiaccess, but not capable of broadcast. And example would be frame relay and X.25. This type of interface has a local address and a subnet mask.
gated.conf(4) gated.conf(4) parameter may be specified to explicitly allow a subset of a range that was disallowed. Sample Definition Statements options gendefault ; autonomoussystem 249 ; interface 128.66.12.2 passive ; martians { 0.0.0.26 }; The statements in the sample perform the following functions: • The options statement tells the system to generate a default route when it peers with an EGP or BGP neighbor. • The autonomoussystem statement tells GateD to use AS number 249 for in EGP and BGP.
gated.conf(4) gated.conf(4) The EGP protocol is described in RFC 827 and RFC 904. BGP Border Gateway Protocol is replacing EGP as the exterior protocol of choice. BGP exchanges reachability information between autonomous systems, but provides more capabilities than EGP. BGP uses path attributes to provide more information about each route as an aid in selecting the best route.
gated.conf(4) gated.conf(4) Next hop The primary ones are the ability to advertise a next hop to use other than the router supplying the routing update. This is quite useful when advertising a static route to a dumb router that does not run RIP as it avoids having packets destined through the dumb router from having to cross a network twice. RIP I routers will ignore next hop information in RIP II packets. This may result in packets crossing a network twice, which is exactly what happens with RIP I.
gated.conf(4) gated.conf(4) [noripin] | [ripin] [noripout] | [ripout] [metricin metric] [metricout metric] [version 1]|[version 2 [multicast|broadcast]] [[secondary] authentication [none | [[simple|md5] password]] ; trustedgateways gateway_list ; sourcegateways gateway_list ; traceoptions trace_options ; }]; The rip statement enables or disables RIP. If the rip statement is not specified, the default is rip on ;.
gated.conf(4) gated.conf(4) ripout This is the default. This argument is necessary when it is desired to send RIP on pointto-point interfaces and may be necessary when noripin is used on a wildcard interface descriptor. metricin metric Specifies the RIP metric to add to incoming routes before they are installed in the routing table. The default is the kernel interface metric plus 1 (which is the default RIP hop count). If this value is specified, it will be used as the absolute value.
gated.conf(4) gated.conf(4) response RIP RESPONSE packets, which is the type of packet that actually contains routing information. other Any other type of packet. The only valid ones are TRACE_ON and TRACE_OFF both of which are ignored. The Hello Protocol It is really better not to use HELLO unless you have a specific need for it. We plan to drop it some time around GateD 4.0.
gated.conf(4) gated.conf(4) [nohelloin] | [helloin] [nohelloout] | [helloout] [metricin metric] [metricout metric] ; trustedgateways gateway_list ; sourcegateways gateway_list ; traceoptions trace_options ; }]; the hello statement enables or disables HELLO. If the hello statement is not specified, the default is hello off. If enabled, HELLO will assume nobroadcast when there is only one interface and broadcast when there is more than one interface.
gated.conf(4) gated.conf(4) metricout metric Specifies the HELLO metric to be added to routes that are send via the specified interface(s). The default is zero. This option is used to make other routers prefer other sources of HELLO routes over this router. trustedgateways gateway_list Defines the list of gateways from which HELLO will accept updates. The gateway_list is simply a list of host names or IP addresses. By default, all routers on the shared network are trusted to supply routing information.
gated.conf(4) gated.conf(4) OSPF uses the destination address and the type of service to choose the best route to the destination. OSPF intra- and inter-area routes are always imported into the GateD routing database with a preference of 10. It would be a violation of the protocol if an OSPF router did not participate fully in the OSPF of the area, so it is not possible to override this. Although it is possible to give other routes lower preference values explicitly, it is ill-advised to do so.
gated.conf(4) gated.conf(4) }; interface interface_list nonbroadcast [cost cost ] { pollinterval time ; routers { gateway [ eligible ] ; }; interface_parameters }; Backbone only: virtuallink neighborid router_id transitarea area { interface_parameters }; }; }]; The following are the interface_parameters referred to above. The may be specified on any class of interface and are described under the interface clause.
gated.conf(4) gated.conf(4) utility sends nonstandard OSPF packets which generate a text response from OSPF. By default these requests are not authenticated, if an authentication key is configured, the incoming requests must match the specified authentication key. No OSPF state may be changed by these packets, but the act of querying OSPF can utilize system resources. backbone area area Each OSPF router must be configured into at least one OSPF area.
gated.conf(4) gated.conf(4) hellointerval time The length of time, in seconds, between Hello packets that the router sends on the interface. routerdeadinterval time The number of seconds not hearing Hello packets of a router before the neighbors of the router will declare it down. authkey auth_key Used by OSPF authentication to generate and verify the authentication field in the OSPF header. The authentication key can be configured on a per interface basis.
gated.conf(4) gated.conf(4) request OSPF Link State Request packets which are used in synchronizing OSPF databases. lsu OSPF Link State Update packets which are used in synchronizing OSPF databases. ack OSPF Link State Ack packets which are used in synchronizing OSPF databases. The Exterior Gateway Protocol (EGP) The Exterior Gateway Protocol (EGP) is an exterior routing protocol used for exchanging routing information with gateways in other autonomous systems.
gated.conf(4) gated.conf(4) packetsize maxpacketsize This defines the expected maximum size of a packet that EGP expects to receive from this neighbor. If a packet larger than this value is received, it will be incomplete and have to be discarded. The length of this packet will be noted and the expected size will be increased to be able to receive a packet of this size. Specifying the parameter here will prevent the first packet from being dropped. If not specified, the default size is 8192 bytes.
gated.conf(4) gated.conf(4) ignored. For efficiency, some networks have external routers announce a default route to avoid sending large EGP update packets. exportdefault Enables GateD to include the default route (0.0.0.0) in EGP updates sent to this EGP neighbor. This allows the system to advertise the default route via EGP. Normally a default route is not included in EGP updates.
gated.conf(4) gated.conf(4) update EGP POLL/UPDATE packets which are used to request and receive reachability updates. The BGP Protocol The Border Gateway Protocol (BGP) is an exterior routing protocol used for exchanging routing information between autonomous systems. BGP is used for exchange of routing information between multiple transit autonomous systems as well as between transit and stub autonomous systems.
gated.conf(4) gated.conf(4) that the BGP routes will only be used to determine the path attributes associated with the IGP routes. Such groups also support distant peers, and also need to be informed of the IGP they are running with. For internal BGP group types (and for test groups), where possible a single outgoing message is built for all group peers based on the common policy.
gated.conf(4) gated.conf(4) preference preference Sets the preference for routes learned from RIP. The default preference is 170. This preference may be overridden by a preference specified on the group or peer statements or by import policy. defaultmetric metric Defines the metric used when advertising routes via BGP. If not specified, no metric is propagated. This metric may be overridden by a metric specified on the neighbor or group statements or in export policy.
gated.conf(4) gated.conf(4) the next hop is the current next hop of the local machine. All routing information advertised by and received from a test peer is discarded, and all BGP routes that can be advertised are sent back to the test peer. Metrics from EGP-derived and BGP-derived routes are forwarded in the advertisement. Otherwise no metric is included. Group parameters The BGP statement has group clauses and peer subclauses. Any number of peer subclauses may be specified within a group.
gated.conf(4) gated.conf(4) will only be opened when an interface with the appropriate local address (through which the peer or gateway address is directly reachable) is operating. For other types of peers, a peer session will be maintained when any interface with the specified local address is operating. In either case incoming connections will only be recognized as matching a configured peer if they are addressed to the configured local address.
gated.conf(4) gated.conf(4) routes on to version 3 neighbors. logupdown Causes a message to be logged via the syslog mechanism whenever a BGP peer enters or leaves the ESTABLISHED state. ttl ttl By default, GateD sets the IP TTL for local peers to one and the TTL for nonlocal peers to 255. This option mainly is provided when attempting to communicate with improperly functioning routers that ignore packets sent with a TTL of one. Not all kernels allow the TTL to be specified for TCP connections.
gated.conf(4) gated.conf(4) Redirect Processing The redirect code is passed ICMP or ISO redirects learned by monitoring ICMP messages, or via the routing socket on systems that support it. It processes the redirect request and decides whether to accept the redirect. If the redirect is accepted, a route is installed in the gated routing table with the protocol redirect . Redirects are deleted from the routing table after 3 minutes.
gated.conf(4) gated.conf(4) Tracing options There are no Redirect -specific tracing options. All nonerror messages are traced under the normal class. The Router Discovery Protocol The Router Discovery Protocol is an IETF standard protocol used to inform hosts of the existence of routers. It is intended to be used instead of having hosts wiretap routing protocols such as RIP. It is used in place of, or in addition to statically configured default routes in hosts.
gated.conf(4) gated.conf(4) minadvinterval time The minimum time allowed between sending unsolicited broadcast or multicast Router Advertisements from the interface. Must be no less than 3 seconds and no greater than maxadvinterval. The default is 0.75 * maxadvinterval. lifetime time The lifetime of addresses in a Router Advertisement. Must be no less than maxadvinterval and no greater than 2:30:00 (two hours, thirty minutes or 9000 seconds). The default is 3 * maxadvinterval.
gated.conf(4) gated.conf(4) When a Router Advertisement with a zero lifetime is received, the host deletes all routes with next-hop addresses learned from that router. In addition, any routers learned from ICMP redirects pointing to these addresses will be deleted. The same will happen when a Router Advertisement is not received to refresh these routes before the lifetime expires.
gated.conf(4) gated.conf(4) many more routes. The speed of the kernel interface becomes critical when these protocols are used. To prevent GateD from locking up for significant periods of time installing large numbers of routes (up to a minute or more has been observed on real networks), the processing of these routes is now done in batches. The size of these batches may be controlled by the tuning parameters described below, but normally the default parameters will provide the proper functionality.
gated.conf(4) gated.conf(4) no longer needs to monitor ICMP messages to learn about redirects. Plus, there is an indication of whether the kernel processed the redirect, GateD can safely ignore redirect messages that the kernel did not process. Updates visible Changes to the routing table by other processes, including the route command are received via the routing socket. This allows GateD to insure that the kernel forwarding table is in sync with the routing table.
gated.conf(4) gated.conf(4) GateD reads re-reads this list every 15 second looking for changes. When the routing socket is in use, it also re-reads it whenever a messages is received indicating a change in routing configuration. Receipt of a SIGUSR2 signal also causes GateD to re-read the list. This interval may be explicitly configured in the interface configuration. Reading the interface list with sysctl BSD 4.4 added the ability to read the kernel interface list via the sysctl system call.
gated.conf(4) gated.conf(4) flash [ limit number ] [ type interface | interior | all ] ; background [ limit number ] [ priority flash | higher | lower ] ; traceoptions trace_options ; }; options option_list Configure kernel options. The valid options are: nochange On systems supporting the routing socket this insures that changes operations will not be performed, only deletes and adds. This is useful on early versions of the routing socket code where the change operation was broken.
gated.conf(4) gated.conf(4) are processed in batches in the background, that is, when no routing protocol traffic is being received. Normally, 120 routes are installed at a time to allow other tasks to be performed and this background processing is done at lower priority than flash updates the following parameters allow tuning of these parameters: limit number Specifies the number of route which may be processed at during one batch. The default is 120.
gated.conf(4) gated.conf(4) limited by the number of multipath destinations supported (this compile time parameter is currently almost always one on Unix). Parameters for static routes are: interface interface_list When this parameter is specified, gateways are only considered valid when they are on one of these interfaces.See the section on interface list specification for the description of the interface_list. preference preference This option selects the preference of this static route.
gated.conf(4) gated.conf(4) default host host These are all the possible formats for a route filter. Not all of these formats are available in all places, for instance the host and default formats are not valid for martians . In most cases it is possible to specify additional parameters relevant to the context of the filter. For example, on a martian statement it is possible to specify the allow keyword, on an import statement you can specify a preference, and on a export you can specify a metric.
gated.conf(4) gated.conf(4) aspath aspath_regexp origin any | ( [ igp ] [egp ] [ incomplete ] ) This specifies that an AS matching the aspath_regexp with the specified origin is matched. AS path regular expressions Technically, an AS path regular expression is a regular expression with the alphabet being the set of AS numbers. An AS path regular expression is composed of one or more AS paths expressions. An AS path expressions is composed of AS path terms and AS path operators.
gated.conf(4) gated.conf(4) restrict Specifies that the routes are not desired in the routing table. In some cases this means that the routes are not installed in the routing table. In others it means that they are installed with a negative preference; this prevents them from becoming active so they will not be installed in the forwarding table, or exported to other protocols. preference preference Specifies the preference value used when comparing this route to other routes from other protocols.
gated.conf(4) gated.conf(4) The importation of RIP, HELLO and Redirect routes may be controlled by any of protocol, source interface and source gateway. If more than one is specified, they are processed from most general (protocol) to most specific (gateway). RIP and HELLO do not support the use of preference to choose between routes of the same protocol. That is left to the protocol metrics. These protocols do not save routes that were rejected since they have short update intervals.
gated.conf(4) gated.conf(4) default host host Specifying the destination As mentioned above, the syntax of the export statement varies depending on the protocol it is being applied to. One thing that applies in all cases is the specification of a metric. All protocols define a default metric to be used for routes being exported, in most cases this can be overridden at several levels of the export statement.
gated.conf(4) gated.conf(4) [ metric metric ] { export_list ; }; It is not possible to create OSPF intra- or inter-area routes by exporting routes from the GateD routing table into OSPF. It is only possible to export from the GateD routing table into OSPF ASE routes. It is also not possible to control the propagation of OSPF routes within the OSPF protocol. There are two types of OSPF ASE routes, type 1 and type 2, see the OSPF protocol configuration for a detailed explanation of the two types.
gated.conf(4) gated.conf(4) direct Routes to directly attached interfaces. static Static routes specified in a static clause. kernel On systems with the routing socket, routes learned from the routing socket are installed in the GateD routing table with a protocol of kernel. These routes may be exported by referencing this protocol. This is useful when it is desirable to have a script install routes with the route command and propagate them to other routing protocols.
gated.conf(4) gated.conf(4) Route aggregation is also used by regional and national networks to reduce the amount of routing information passed around. With careful allocation of network addresses to clients, regional networks can just announce one route to regional networks instead of hundreds. Aggregate routes are not actually used for packet forwarding by the originator of the aggregate route, only by the receiver (if it wishes).
gated.conf(4) gated.conf(4) as autonomous_system Restrict selection of routes to those learned from the specified autonomous system. tag tag Restrict selection of routes to those with the specified tag. aspath aspath_regexp Restrict selection of routes to those that match the specified AS path. restrict Indicates that these routes are not to be considered as contributors of the specified aggregate. The specified protocol may be any of the protocols supported by GateD. route_filter See below.
gated.conf(4) gated.conf(4) distance An EGP metric. See metric. Valid values are from zero to 255 inclusive. egp exterior gateway protocol exterior routing protocol A class of routing protocols used to exchange routing information within an autonomous system. A detailed explanation of exterior gateway protocols is available in the Protocol Overview. EGP Exterior Gateway Protocol One of a class of exterior gateway protocols, described in more detail in the EGP section of the Protocol Overview.
gated.conf(4) gated.conf(4) which bits of the destination are significant. Except when used in a route filter, GateD only supports contiguous masks. mask length The number of significant bits in the mask. metric One of the units used to help a system determine the best route. Metrics may be based on hop count, routing delay, or an arbitrary value set by the administrator depending on the type of routing protocol. Routing metrics may influence the value of assigned internal preferences. (See preference.
gated.conf(4) gated.conf(4) Peers are usually on a shared network, but not always. This term is mostly used by BGP. Usually synonymous with neighbor. port A UDP or TCP port number. Valid values are from 1 through 65535 inclusive. preference A preference is a value between 0 (zero) and 255 used to select between many routes to the same destination. The route with the best (numerically lowest) preference is as the active route.
gated.conf(4) ttl gated.conf(4) The Time To Live (TTL) of an IP packet. Valid values are from one (1) through 255 inclusive. TOS type of service The type of service is for internet service quality selection. The type of service is specified along the abstract parameters precedence, delay, throughput, reliability, and cost. These abstract parameters are to be mapped into the actual service parameters of the particular networks the datagram traverses.
