OPTIONS statement

This topic describes how to use the OPTIONS statement.

Syntax


   .-----------------------------------------------------------------.   
   V                            .-no--.                              |   
>>---OPTIONS--+-default.router--+-yes-+----------------------------+-+-><
              |         .-on------------.                          |     
              +-supply--+-off-----------+--------------------------+     
              |         +-default.route-+                          |     
              |         +-hosts---------+                          |     
              |         '-locals--------'                          |     
              |              .-0-.                                 |     
              +-trace.level--+-1-+---------------------------------+     
              |              +-2-+                                 |     
              |              +-3-+                                 |     
              |              '-4-'                                 |     
              +-gateway --ip_addr --+-block ----+------------------+     
              |                     +-noreceive-+                  |     
              |                     '-none------'                  |     
              '-interface --name --ip_addr --| interface options |-'     

interface options

|--+-block --destination --fmask --mask --------+---------------|
   +-forward --destination --fmask --mask ------+   
   +-forward.cond --destination --fmask --mask -+   
   +-metric ------------------------------------+   
   +-noforward --destination --fmask --mask ----+   
   +-receive --destination --fmask --mask ------+   
   +-receive.cond --destination --fmask --mask -+   
   +-noreceive --destination --fmask --mask ----+   
   +-none---------------------------------------+   
   +-passive -----------------------------------+   
   +-ripon -------------------------------------+   
   +-ripoff ------------------------------------+   
   |          .-off-.                           |   
   +-supply --+-on -+---------------------------+   
   +-key -authentication_key -------------------+   
   +-nokey -------------------------------------+   
   +-supply.control -supply_control ------------+   
   '-receive.control -rec._control -------------'

Parameters

default.router

Enables the default router. When this option is specified, NCPROUTE adds a default route to its routing information and propagates it over all local interfaces. If the adjacent routers add the default route to their routing tables, NCPROUTE receives all unknown packets from them and funnel them to a destination router, provided that a default route is defined. If this option is used, define a default route to a destination router on an IPROUTE statement in NCP generation definition or in the NCPROUTE gateways data set. See z/OS Communications Server: IP Configuration Guide.

yes: This is the default router.
no: This is not the default router.

interface

A constant. The parameters name and ipaddr follow this keyword.

name: Specifies the name of the interface according to NCP clients-NCP generation. A specification of an asterisk (*) can only be used with the NONE parameter option to indicate all interface names.
ipaddr: Specifies the IP address of the interface associated with the interface name. A specification of an asterisk (*) can only be used with the NONE parameter option to indicate all IP addresses of the interfaces.
noreceive (or block): If an interface option, specifies that the destination route in the received RIP packets for this interface are to be ignored. If a gateway option, specifies that routing table broadcasts from this gateway are to be ignored. This option is provided as an RIP input filter.
destination: Specifies that the destination route is in network, subnetwork, or host format. A specification of an asterisk (*) indicates that all destination routes are to be used with the noforward and noreceive options. This serves as a blackhole filter option which can be used to filter out all routes RIP packets over an interface and allow routes with specified forward and receive filters to be used.
fmask: A constant. The value that follows this keyword is the filter mask for the route.
mask: Optional bit mask (expressed in dotted-decimal form) defining the routing filter mask associated with the destination route. This mask is to be used as an optional parameter to the forward and receive parameters to filter in and filter out multiple routes matching the mask of the destination route. This option can be used to define a single RIP input or output filter representing multiple routes as opposed to defining individual RIP input or output filters for each route.
forward: Specifies that the destination route in the RIP responses is to be forwarded to this interface only. This option is provided as an RIP output filter and can be used for inbound and outbound traffic splitting.
forward.cond: Specifies that the destination route is to be forwarded to this interface only when the interface is active. In case of an interface outage, NCPROUTE includes the destination route in the RIP responses to other active interfaces. After recovery of an interface outage, NCPROUTE resumes to sending the destination route over this interface only. This option is provided as an RIP output filter and can be used for inbound and outbound traffic splitting.
metric: The metric associated with the cost of use for the link. When sending routing information over this link, NCPROUTE uses the new_metric value in the routing metrics for the routes that are advertised over this link. If this option is not used, the metric value that is used is the value specified in the IPLOCAL statement of NCP generation definition. This option allows you to override the genned metric. If a metric of 1 is specified, a metric value of 1 is used; this is the default cost for a directly connected network. If a metric of 2 is specified, a metric value of 2 is used. As the metric gets higher, the routes sent over this link become less preferred. The range is from 1 to 15. A metric of 1 is usually coded so that the routes sent over the interface is the most preferred.
noforward: Specifies that the destination route in the RIP responses is not to be forwarded. This option is provided as an RIP output filter.
none: If an interface option, specifies that any RIP filter options for this interface are to be turned off or reset. If asterisks (*) are specified for interface name and ipaddr, all options are cleared from all interfaces. If a gateway option, specifies that any RIP filter options for the gateway are to be turned off or reset. If an asterisk (*) is specified for the IP addresses, all gateway entries with gateway options are cleared.
receive: Specifies that the destination route in the RIP responses is to be received over this interface only. This option is provided as an RIP input filter.
receive.cond: Specifies that the destination route is to be received over this interface only when it is active. In case of an interface outage, NCPROUTE allows the destination route in the RIP responses to be received over other active interfaces. This option is provided as an RIP input filter and can be used for inbound and outbound traffic splitting.
ripoff (or passive): Specifies that RIP is disabled for this interface. NCPROUTE does not supply nor receive RIP updates.
ripon: Specifies that RIP is enabled for this interface. RIP responses are allowed to be sent or received over this interface.

supply

Defines the supply routing setting. The default is on. This option is provided as an RIP input and output filter.

on: Supply routing information for this NCP client or interface.
off: Suppresses supply of routing information for this NCP client or interface. NCPROUTE continues to receive routing updates.
default.route: Supply the default route only for this NCP client. When this option is specified, yes is internally set for the default.router option. This option is provided as an RIP output filter.
hosts: Supply routing information with host routes added.
locals: Supply only local (directly connected) routes.

trace.level

Specifies the trace level to be used for this NCP client. The default is 0.

0: Do not allow tracing.
1: Activates tracing of actions by the NCPROUTE server.
2: Activates tracing of actions and packets sent or received.
3: Activates tracing of actions, packets sent or received, and packet history. Circular trace buffers are used for each interface to record the history of all packets traced and are displayed whenever an interface goes inactive.
4: Activates tracing of actions, packets sent or received, packet history, and packet contents. The packet contents display the RIP network routing information.

key

Specifies a plain text password authentication key containing up to 16 characters to be used for this interface and that is used to override the server-wide setting defined in the NCPROUTE profile. It can contain mixed case and blank characters. Single quotation marks (') can be included as delimiters to include leading and trailing blanks. A null or blank key indicates that the server-wide key is used as the default. For examples on authentication passwords, see the RIP2_AUTHENTICATION_KEY statement in NCPROUTE profile data set.

nokey

Specifies that authentication is disabled for this interface even though the server-wide specification from the NCPROUTE profile is defined.

supply.control

Specifies that the RIP supply_control is to be used for this client or interface and is used to override the NCPROUTE profile setting.

supply_control

Specifies one of the RIP supply control options. The default is set to the NCPROUTE profile setting. The following values are valid options:

RIP1
RIP2B
RIP2M
RIP2
NONE

receive.control

Specifies that the RIP receive_control is to be used for this client or interface and is used to override the NCPROUTE profile setting.

rec_control

Specifies one of the RIP receive control options. The default is set to the NCPROUTE profile setting. Valid options are RIP1, RIP2, ANY, and NONE.

gateway

A constant. The value that follows this keyword identifies the gateway or router.

ipaddr

If an interface option, specifies the IP address of the interface associated with the interface name. If a gateway option, specifies the gateway address of the adjacent router. A specification of an asterisk (*) applies to all gateway addresses.

none

If an interface option, specifies that any RIP filter options for this interface are to be turned off or reset. If a gateway option, specifies that any RIP filter options for this gateway are to be turned off or reset. A specification of an asterisk (*) indicates all interface IP addresses or all gateway addresses.

noreceive (or block)

If an interface option, specifies that the destination route in the RIP responses propagates is not to be received over this interface only. If a gateway option, specifies that no RIP packets are to be received from the specified gateway address of the adjacent router. This option provides an RIP input filter.

Result: All traces go to a standard output referred to in the //SYSPRINT DD statement in the NCPROUTE cataloged procedure.

The options can be specified in any order. For example:

   options default.router yes supply on trace.level 2
   options interface ETH1 10.1.1.1 passive
   options interface ETH1 10.1.1.1 supply off
   options interface TR1 9.67.112.25 metric 2
   options interface TR1 9.67.112.25 forward 11.0.0.0
   options interface TR1 9.67.112.25 forward.cond 12.0.0.0
   options interface TR1 9.67.112.25 block 9.1.0.0 
   options interface TR1 9.67.112.25 supply.control rip1
   options interface ETH1 10.1.1.1 receive.control rip2
   options interface ETH2 9.1.1.1 forward 9.2.0.0 fmask 255.255.0.0
   options interface ETH1 10.1.1.1 none
   options interface * * none 
   options gateway 9.67.112.77 noreceive
   options gateway 9.67.112.77 none
   options gateway * none