Remove TCP/IP Route (RMVTCPRTE)

Where allowed to run: All environments (*ALL)
Threadsafe: No
Parameters
Examples
Error messages

The Remove TCP/IP Route (RMVTCPRTE) command removes a previously identified route from the Transmission Control Protocol/Internet Protocol (TCP/IP) configuration.

Five parameter values uniquely define an IPv4 route. These values are the route destination (RTEDEST), the subnet mask (SUBNETMASK), the type of service (TOS), the IPv4 address of the next system on the route (NEXTHOP), and the preferred binding interface (BINDIFC). For default routes and default multicast routes (*DFTROUTE and *DFTMCAST), the NEXTHOP, TOS and BINDIFC values uniquely define the route because the SUBNETMASK is always *NONE.

Four parameter values uniquely define an IPv6 route. These values are the route destination (RTEDEST), the address prefix length (ADRPFXLEN), the IPv6 address of the next system on the route (NEXTHOP), and the binding line description (BINDLIND).

Note: When a RMVTCPRTE command is entered using option 4 of the Work with TCP/IP Routes display, a confirmation display is shown. This display warns that the removal of a route might affect active TCP connections and that unpredictable results might occur. A confirmation display is not shown when the RMVTCPRTE CL command is issued directly.

Restrictions:

Top

Parameters

Keyword Description Choices Notes
RTEDEST Route destination Character value, *DFTROUTE, *DFTMCAST, *DFT6ROUTE, *DFT6MCAST Required, Positional 1
SUBNETMASK Subnet mask Character value, *NONE, *HOST Optional, Positional 2
TOS Type of service *MINDELAY, *MAXTHRPUT, *MAXRLB, *MINCOST, *NORMAL Optional, Positional 3
NEXTHOP Next hop Character value Optional
ADRPFXLEN Address prefix length 1-128, 64, *HOST, *NONE Optional
BINDIFC Preferred binding interface Character value, *NONE Optional
BINDLIND Binding line description Name Optional
Top

Route destination (RTEDEST)

Specifies the route destination being removed.

For an IPv4 route, you must specify all 4 bytes that make up an internet address though some of the bytes may be equal to 0. For example, a route to all the hosts on the 9.5.11 subnetwork is identified by entering 9.5.11.0 for the route destination. Used in combination with a subnetmask, type of service value, and next hop, the route destination uniquely identifies a route to a network or system.

For an IPv6 route, the entire 16 byte IPv6 address must be specified, and the suffix portion of the RTEDEST field must be zero. For example, a RTEDEST with value 1234:5678:: and address prefix length (ADRPFXLEN) of 32 is a valid combination, but a RTEDEST with value 1234:5678:8000:: and ADRPFXLEN of 32 is not.

This is a required parameter.

*DFTROUTE
Specifies that a default IPv4 route is being removed. A default route is used by the system to send data to a remote destination for which a specific route is not defined. The default routes are used based on the availability of the next hop gateway and the type of service (TOS). If the application requests a specific TOS, the TOS of the default route used must match the TOS requested. If no default route is found that matches the requested TOS, the first available default route with a TOS of *NORMAL is used.
*DFTMCAST
Use the *DFTMCAST special value to indicate that the static IPv4 route you are removing is a default multicast route. A default multicast route is used by an application when sending data to a multicast destination address and a specific outgoing interface is not specified.

Note: When RTEDEST(*DFTMCAST) is specified, then SUBNETMASK(*NONE) must also be specified and the NEXTHOP parameter must be a local TCP/IP interface (on this system).

*DFT6ROUTE
Specifies that a default IPv6 route is being removed. A default IPv6 route is used by the system to send data to a remote IPv6 destination for which a specific route is not defined. If *DFT6ROUTE is specified, ADRPFXLEN must specify *NONE.
*DFT6MCAST
Specifies that a default IPv6 multicast route is being removed. A default IPv6 multicast route is used by an application when sending data to a IPv6 multicast destination address and a specific outgoing physical interface is not specified. If *DFT6MCAST is specified, ADRPFXLEN must specify *NONE.
character-value
Specify the route destination being removed. For an IPv4 route, the route destination can be specified in the form nnn.0.0.0, for Class A, nnn.nnn.0.0 for Class B, and nnn.nnn.nnn.0 for Class C, or nnn.nnn.nnn.nnn for any combination thereof, where nnn is a decimal number ranging from 0 through 255.

Any combination thereof means that you may specify a route, such as 9.5.0.0 to the hosts on the 9.5 subnet, even though all 9.5.x.x addresses are class A network addresses.

Exceptions:

  • The first byte (octet) must be greater than 0 and less than 255.
  • The last byte (octet) may not equal 255.
  • The last byte (octet) may not equal 0 if *HOST is specified for the SUBNETMASK value.
  • Routes to a broadcast address are not allowed.

For an IPv6 route, the route destination is specified in the form x:x:x:x:x:x:x:x, where x is a hexadecimal number ranging from 0 through X'FFFF'. "::" may be used once in the route destination to indicate one or more groups of 16 bits of zeros. The "::" may be used to compress leading, imbeddeded, or trailing zeros in the route destination. The suffix portion of the route destination must contain zeros.

Top

Subnet mask (SUBNETMASK)

Specifies a bit mask that identifies to TCP/IP which bits of the value specified for the route destination (RTEDEST) compose the network and subnet portions of the internet address. By defining the network portion and subnetwork portion of the RTEDEST address, the subnet mask also defines which bits of the RTEDEST address make up the host portion.

The mask is a 32-bit combination that is logically ANDed with the internet address to determine a particular subnetwork. The bits of the mask set to the value one (1) determine the network and subnetwork portions of the address. The bits set to the value zero (0) determine the host portion of the address.

SUBNETMASK is ignored if RTEDEST contains an IPv6 address.

*NONE
No subnet mask is used. A subnet mask is not used when specifying default routes. For example, when RTEDEST(*DFTMCAST) or RTEDEST(*DFTROUTE) is specified, SUBNETMASK(*NONE) must also be specified.
*HOST
The internet address value specified in the route destination field is a host address. The subnetmask value is calculated to be 255.255.255.255.
character-value
Specify the mask of the subnet field. The internet address is in the form nnn.nnn.nnn.nnn, where nnn is a decimal number ranging from 0 through 255. For example, a destination route's internet address value of 129.35.192.0 identifies a Class B subnetwork. The network ID part of its address is 129.35. The portion of the subnetmask that is associated with the network portion of a particular class of address must equal 255. Therefore, the upper 2 bytes must be equal to 255.255 in the subnetmask. The subnetmask in this example may be 255.255.192.0 if the third octet is used as the subnetwork ID portion of the internet address.
Top

Type of service (TOS)

Specifies the type of service to be used. The type of service defines how the internet hosts and routers should make trade-offs between throughput, delay, reliability, and cost.

TOS is ignored if RTEDEST contains an IPv6 address.

*NORMAL
Normal service is used for delivery of data.
*MINDELAY
Minimize delay means that prompt delivery is important for data on this connection.
*MAXTHRPUT
Maximize throughput means that a high data rate is important for data on this connection.
*MAXRLB
Maximize reliability means that a higher level of effort to ensure delivery is important for data on this connection.
*MINCOST
Minimize monetary cost means that lower cost is important for data on this connection.
Top

Next hop (NEXTHOP)

Specifies the internet address of the next system (gateway) on the route.

Note: If RTEDEST specifies an IPv4 address, NEXTHOP must contain an IPv4 address. If RTEDEST specifies an IPv6 address, NEXTHOP must contain an IPv6 address.

character-value
Specify the internet address.

An IPv4 internet address is specified in the form nnn.nnn.nnn.nnn, where nnn is a decimal number ranging from 0 through 255. An IPv4 internet address is not valid if it has a value of all binary ones or all binary zeros for the network identifier (ID) portion or the host ID portion of the address.

An IPv6 internet address is specified in the form x:x:x:x:x:x:x:x, where x is a hexadecimal number ranging from 0 through X'FFFF'. "::" may be used once in the IPv6 address to indicate one or more groups of 16 bits of zeros. The "::" may be used to compress leading, imbedded, or trailing zeros in the address.

:: (null IPv6 address), ::1 (IPv6 loopback address) and addresses beginning with FF (IPv6 multicast address) are not allowed.

If the internet address is entered from a command line, the address must be enclosed in apostrophes.

Top

Address prefix length (ADRPFXLEN)

Specifies the IPv6 address prefix length (in bits) of the RTEDEST parameter. The address prefix length specifies how much of the leftmost portion of an IPv6 address is the subnet prefix. This parameter applies only if RTEDEST is an IPv6 address.

64
The default is 64 since most IPv6 networks have a 64 bit interface ID (address suffix).
*HOST
The RTEDEST field specifies the IPv6 address of a specific host system. *HOST corresponds to a value of 128.
*NONE
No address prefix length is specified.
1-128
Specify how much of the leftmost portion of the RTEDEST IPv6 address is the subnet prefix.
Top

Preferred binding interface (BINDIFC)

Specifies the IP interface this route is bound to.

BINDIFC is ignored if RTEDEST contains an IPv6 address.

*NONE
No particular IP interface is bound to this route. The first active IP interface on the network defined by the NEXTHOP and SUBNETMASK parameters is used. This is the default value.
character-value
Specify the internet address (IP address) of the interface this route is bound to.
Top

Binding line description (BINDLIND)

Specifies the line description (LIND) object to which this route is bound. This value must be specified for an IPv6 route and is ignored for an IPv4 route.

name
Specify the name of the line description.
Top

Examples

Example 1: Removing a Route

RMVTCPRTE   RTEDEST('132.65.0.0')  SUBNETMASK('255.65.0.0')
            TOS(*MINDELAY)  NEXTHOP('9.5.15.1')

This command removes the route identified as 132.65.0.0 with a subnetmask of 255.65.0.0, a type of service of *MINDELAY, and a next hop of 9.5.15.1.

Example 2: Removing a Default Route

RMVTCPRTE   RTEDEST(*DFTROUTE)  SUBNETMASK(*NONE)
            NEXTHOP('186.34.76.92')

This command removes a host route identified as a default route (*DFTROUTE). The subnetmask is specified as *NONE and the type of service defaults to *NORMAL. The subnetmask, type of service, and next-hop value differentiate this *DFTROUTE from the other possible eight *DFTROUTE entries.

Example 3: Removing an IPv6 Route

RMVTCPRTE   RTEDEST('1234:5678::') ADRPFXLEN(32)
            NEXTHOP('AAAA::BBBB') BINDLIND(ETHLINE)

This command removes the IPv6 route identified with route destination 1234:5678::, address prefix length 32, next hop aaaa::bbbb, and binding line description ETHLINE.

Example 4: Removing an IPv6 Default Route

RMVTCPRTE   RTEDEST(*DFT6ROUTE) ADRPFXLEN(*NONE)
            NEXTHOP('AAAA::CCCC') BINDLIND(ETHLINE2)

This command removes the IPv6 default route identified with next hop aaaa::cccc, and binding line description ETHLINE2.

Top

Error messages

*ESCAPE Messages

TCP1D03
&1 member record length not correct.
TCP1D04
Error occurred processing member &1 of &2/&3.
TCP1901
Internet address &2 not valid.
TCP261C
Process completed successfully.
TCP264A
&2 &1 not removed.
TCP8050
*IOSYSCFG authority required to use &1.
TCP9999
Internal system error in program &1.
Top