Change TCP/IP Attributes (CHGTCPA)

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

The Change TCP/IP Attributes (CHGTCPA) command is used to change the TCP, UDP, IP, and ARP protocol layer attributes. The changes take effect immediately.

The default values for the keywords follow. These values are also used if *DFT is specified for the keyword.

Keyword
Default Value
TCPKEEPALV
120 minutes
TCPURGPTR
*BSD
TCPRCVBUF
8192 bytes
TCPSNDBUF
8192 bytes
TCPR1CNT
3
TCPR2CNT
16
TCPMINRTM
250 milliseconds
TCPCLOTIMO
120 seconds
TCPCNNMSG
*THRESHOLD
UDPCKS
*YES
IPPATHMTU
*YES, 10 minutes
IPDTGFWD
*NO
IPSRCRTG
*YES
IPRSBTIMO
10 seconds
IPTTL
64
IPQOSENB
*NO
IPDEADGATE
*YES, 2 minutes
ARPTIMO
15 minutes
ECN
*NO
NFC
*YES, 300 seconds, 10MB
LOGPCLERR
*NO

Restriction:

Top

Parameters

Keyword Description Choices Notes
TCPKEEPALV TCP keep alive 1-40320, *SAME, *DFT Optional
TCPURGPTR TCP urgent pointer *SAME, *BSD, *RFC Optional
TCPRCVBUF TCP receive buffer size 512-8388608, *SAME, *DFT Optional
TCPSNDBUF TCP send buffer size 512-8388608, *SAME, *DFT Optional
TCPR1CNT TCP R1 retransmission count 1-15, *SAME, *DFT Optional
TCPR2CNT TCP R2 retransmission count 2-16, *SAME, *DFT Optional
TCPMINRTM TCP minimum retransmit time 100-1000, *SAME, *DFT Optional
TCPCLOTIMO TCP time-wait timeout 0-14400, *SAME, *DFT Optional
TCPCNNMSG TCP close connection message *SAME, *THRESHOLD, *ALL, *NONE Optional
UDPCKS UDP checksum *SAME, *YES, *NO Optional
IPPATHMTU Path MTU discovery Single values: *SAME, *DFT, *NO
Other values: Element list
Optional
Element 1: Enablement *YES
Element 2: Interval 5-40320, *ONCE
IPDTGFWD IP datagram forwarding *SAME, *YES, *NO Optional
IPSRCRTG IP source routing *SAME, *YES, *NO Optional
IPRSBTIMO IP reassembly time-out 5-120, *SAME, *DFT Optional
IPTTL IP time to live (hop limit) 1-255, *SAME, *DFT Optional
IPQOSENB IP QoS enablement *SAME, *TOS, *YES, *NO Optional
IPDEADGATE IP dead gateway detection Single values: *SAME, *DFT, *NO
Other values: Element list
Optional
Element 1: Enablement *YES
Element 2: Interval 1-60
ARPTIMO ARP cache timeout 1-1440, *SAME, *DFT Optional
ECN Enable ECN *SAME, *YES, *NO Optional
NFC Network file cache Single values: *DFT, *CLEAR
Other values: Element list
Optional
Element 1: Enablement *SAME, *YES, *NO
Element 2: Cached file timeout 30-604800, *SAME, *NOMAX
Element 3: Cache size 10-100000, *SAME
LOGPCLERR Log protocol errors *SAME, *YES, *NO Optional
IPQOSBCH IP QoS datagram batching *SAME, *NORMAL, *MINDELAY Optional
IPQOSTMR IP QoS timer resolution 5-5000, *SAME, *DFT Optional
Top

TCP keep alive (TCPKEEPALV)

Specifies the amount of time, in minutes, that TCP waits before sending out a probe to the other side of a connection. The probe is sent when the connection is otherwise idle, even when there is no data to be sent.

The transmission of keep-alive packets is controlled by individual sockets applications through use of the SO_KEEPALIVE socket option. For more information see the Sockets Programming information in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter.

*SAME
The keep-alive time interval value does not change from its current setting.
*DFT
The keep-alive time interval value of 120 minutes is used.
1-40320
Specify a keep-alive time interval in minutes. Valid values range from 1 through 40320 minutes (28 days).
Top

TCP urgent pointer (TCPURGPTR)

Specifies which convention to follow when interpreting which byte the urgent pointer in the TCP header points to. The urgent pointer in the TCP header points to either the byte immediately following the last byte of urgent data (BSD convention) or the last byte of the urgent data (RFC convention).

Note: This value must be consistent between the local and remote ends of a TCP connection. Socket applications that use this value must use it consistently between the client and server applications. This value is set on a system basis. All applications using this system will use this value.

*SAME
The urgent pointer value does not change from its current setting.
*BSD
Use the BSD defined convention. The TCP urgent pointer points to the byte immediately following the last byte of urgent data. This is the initial value.
*RFC
Use the RFC defined convention. The TCP urgent pointer points to the last byte of the urgent data.
Top

TCP receive buffer size (TCPRCVBUF)

Specifies what to allocate for the default receive buffer size. The TCP receive window size is based on this value. Decreasing this value decreases the amount of data that the remote system can send before being read by the local application. Decreasing this value may improve performance in situations where many retransmissions occur due to the overrunning of a network adapter.

Notes:

  1. This value is also used by the User Datagram Protocol (UDP) as its default receive buffer size.
  2. This value is also used as the default receive buffer size by IP over SNA processing.
  3. Setting this parameter does not guarantee the size of the TCP receive buffer. This is the default buffer size that is used for initial TCP connection negotiations. An individual application can override this value by using the SO_RCVBUF socket option. For more information see the Sockets Programming information in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter.
*SAME
The TCP receive buffer size does not change from its current value.
*DFT
The default TCP receive buffer size of 8192 (8K) is used.
512-8388608
Specify the number of bytes to be used for the TCP receive buffer size.
Top

TCP send buffer size (TCPSNDBUF)

Specifies the TCP send buffer size. This parameter informs TCP what to use for the default send buffer size. The TCP send buffer size provides a limit on the number of outgoing bytes that are buffered by TCP. Once this limit is reached, attempts to send additional bytes may result in the application blocking until the number of outgoing bytes buffered drops below this limit. The number of outgoing bytes buffered is decremented when the remote system acknowledges the data sent.

Notes:

  1. This value is used also as the default send buffer size by IP over SNA processing.
  2. UDP does not have a configurable send buffer size.
  3. Setting this parameter does not guarantee the size of the TCP send buffer. This is the default buffer size that is used for initial TCP connection negotiations. An individual application can override this value by using the SO_SNDBUF socket option. For more information see the Sockets Programming information in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter.
*SAME
The TCP send buffer size does not change from its current value.
*DFT
The default TCP send buffer size of 8192 (8K) is used.
512-8388608
Specify the number of bytes to be used for the TCP send buffer size.
Top

TCP R1 retransmission count (TCPR1CNT)

Specifies the TCP R1 retransmission count value. This parameter is a counter that specifies the number of TCP retransmissions that will be attempted before TCP requests a different network route from IP.

Note: The R1 retransmission count value must be less than the R2 retransmission count value.

*SAME
The TCP R1 retransmission count does not change from its current setting.
*DFT
The default TCP R1 retransmission count value of 3 is used.
1-15
Specify the TCP R1 retransmission count value.
Top

TCP R2 retransmission count (TCPR2CNT)

Specifies the TCP R2 retransmission count value. This parameter is a counter that specifies the number of TCP retransmissions that will be attempted before TCP assumes that the connection has been lost and stops retransmitting.

Note: The R2 retransmission count value must be greater than the R1 retransmission count value.

*SAME
The TCP R2 retransmission count does not change from its current setting.
*DFT
The default TCP R2 retransmission count value of 16 is used.
2-16
Specify the TCP R2 retransmission count value.
Top

TCP minimum retransmit time (TCPMINRTM)

Specifies the TCP minimum retransmit time value which is the lowest amount of time (expressed in milliseconds) to elapse before TCP decides that a transmitted packet is lost and needs to be sent again. After each unsuccessful attempt to transmit a packet, this value will be doubled until it reaches a maximum value of 2 minutes.

*SAME
The TCP minimum retransmit time value does not change from its current value.
*DFT
The default TCP minimum retransmit time value of 250 milliseconds is used.
100-1000
Specify the number of milliseconds to be used for the TCP minimum retransmit time value.
Top

TCP time-wait timeout (TCPCLOTIMO)

This parameter indicates the amount of time, in seconds, for which a socket pair (client IP address and port, server IP address and port) cannot be reused after a connection is closed.

Note: Setting the TCP time wait timeout value to 0 means that a timer will not be used.

*SAME
The TCP time wait timeout value does not change from its current setting.
*DFT
The default TCP time wait timeout value of 120 seconds is used.
0-14400
Specify the number of seconds to be used for the TCP time wait timeout value.
Top

TCP close connection message (TCPCNNMSG)

Specifies whether abnormally closed TCP connections will be logged via messages to the QTCP message queue. TCP connections could be abnormally closed for the following reasons:

*SAME
The closed TCP connection message value does not change from its current value.
*THRESHOLD
At most, one abnormally closed TCP connection message per minute will be logged. TCPCNNMSG(*THRESHOLD) is the initial value.
*ALL
All abnormally closed TCP connections will be logged. Note that there are some conditions that could cause MANY closed connection messages to be logged at the same time.
*NONE
Abnormally closed TCP connections will not be logged.
Top

UDP checksum (UDPCKS)

Specifies whether UDP processing should generate and validate checksums. It is strongly recommended that you specify UDPCKS(*YES) to use UDP checksum processing. If you are concerned about obtaining the best possible performance and are not concerned with the protection provided by UDP checksum processing, specify UDPCKS(*NO).

*SAME
The status of checksum protection for UDP data does not change from its current value.
*YES
Checksum protection is provided for UDP data. UDPCKS(*YES) is the initial value.
*NO
Checksum protection is not provided for UDP data.
Top

Path MTU discovery (IPPATHMTU)

Specifies whether the Path Maximum Transmission Unit (MTU) discovery function will be enabled on this system. Path MTU discovery allows for dynamic MTU adjustment, on a per connection basis, in order to maximize network throughput.

Single values

*SAME
The path MTU discovery enablement status and path MTU discovery time interval do not change from their current values.
*NO
Path MTU discovery is not enabled for this system.
*DFT
The default path MTU discovery enablement status is *YES and the default path MTU discovery time interval is 10 minutes.

Element 1: Enablement

*YES
Path MTU discovery is enabled for this system.

Element 2: Interval

Specifies the amount of time, in minutes, that the TCP/IP protocol stack will cache the results of a path MTU discovery. When the time interval is exceeded, the path MTU is rediscovered.

*ONCE
Once a path MTU is discovered, it is not recalculated.
5-40320
Specify a path MTU discovery interval in minutes. Valid values range from 5 through 40320 minutes (28 days).

Notes:

  1. In order for the path MTU discovery interval element to be specified, the first element must be set to *YES.
  2. Path MTU discovery, if enabled, is only done over routes with a MTU value of *IFC.
  3. The use of Path MTU discovery for UDP applications is controlled by individual sockets applications through the use of the SO_PATHMTU socket option.
Top

IP datagram forwarding (IPDTGFWD)

Specifies whether the IP layer forwards Internet Protocol (IP) datagrams between different networks. It specifies whether the IP layer is acting as a gateway.

Note: IP does not forward datagrams between interfaces on the same subnet.

The i5/OS implementation of TCP/IP does not include full gateway function as defined in RFC1009. A subset of the gateway functions are supported. One of the gateway functions supported is IP datagram forwarding capabilities.

*SAME
The IP datagram forwarding status does not change from its current value.
*NO
IP datagrams are not forwarded. IPDTGFWD(*NO) is the initial value.
*YES
IP datagrams are forwarded.
Top

IP source routing (IPSRCRTG)

The default setting for IP Source Routing (IPSRCRTG) is *YES or on. Some firewalls will not pass datagrams that have IP Source Routing switched on. This parameter allows you to switch IP Source Routing on or off as required for your situation.

*SAME
If the IP Source Routing value was previously set, that setting will remain in effect. If the IP Source Routing parameter was not previously set, use of the *SAME value will default to the *YES or on value.
*NO
The value *NO switches IP Source Routing off.
*YES
The value *YES switches IP Source Routing on. IPSRCRTG(*YES) is the initial value.
Top

IP reassembly time-out (IPRSBTIMO)

Specifies, in seconds, the IP datagram reassembly time. If this time is exceeded, a partially reassembled datagram is discarded and an ICMP time exceeded message is sent to the source host.

*SAME
The assembly time does not change from its current setting.
*DFT
The default assembly time of 10 seconds is used.
5-120
Specify the number of seconds to be used for an IP reassembly time.
Top

IP time to live (hop limit) (IPTTL)

Specifies the default TTL value. The IP datagram time-to-live value specifies a relative limit on the number of hops across which an IP datagram remains active. The time-to-live value acts as a "hop count" that is decremented by each gateway to prevent internet routing loops.

Note: Even though this parameter is specified as a time-to-live value, it is not used as a time value. It is used as a counter. The standard description is time to live as specified in RFCs.

*SAME
The time-to-live value does not change from its current setting.

Note: This default IP datagram time-to-live value is not used for datagrams sent to an IP multicast group address. The default IP datagram time-to-live value for datagram sent to an IP multicast group is always 1 as specified by the Internet standards. Individual multicast applications may override this default using the IP_MULTICAST_TTL socket option.

*DFT
The default time-to-live value of 64 is used.
1-255
Specify an IP time-to-live value.
Top

IP QoS enablement (IPQOSENB)

Specifies whether Quality of Service (QoS), IP Type of Service (TOS), or neither of the two are in use.

*SAME
The QoS enablement value does not change from its current value.
*TOS
Use TOS byte in the IP header.
*YES
Use QoS.
*NO
Do not use QoS or TOS. This is the initial value.
Top

IP dead gateway detection (IPDEADGATE)

Specifies whether dead gateway detection will be enabled on this system. Dead gateway detection is a mechanism which involves polling all attached gateways. If no reply is received to the polls then all routes using that gateway are inactivated. Gateways marked as dead will continue to be polled and when they respond again all routes using that gateway will be reactivated.

Single values

*SAME
The dead gateway detection enablement status and dead gateway interval do not change from their current values.
*NO
Dead gateway detection is not enabled for this system.
*DFT
The default dead gateway detection enablement status is *YES and the default dead gateway detection time interval is 2 minutes.

Element 1: Enablement

*YES
Dead gateway detection is enabled for this system.

Element 2: Interval

Specifies the amount of time, in minutes, that the TCP/IP protocol stack will wait between dead gateway detection polls. When the time interval is exceeded, the gateways are polled.

1-60
Specify a dead gateway detection interval in minutes.

Notes:

  1. In order for the dead gateway detection interval element to be specified, the first element must be set to *YES.
Top

ARP cache timeout (ARPTIMO)

Specifies, in minutes, the ARP cache time-out value. The time-out value's purpose is to flush out-of-date cache entries from the ARP cache.

*SAME
The default ARP cache time-out interval does not change from its current setting.
*DFT
The default ARP cache time-out interval of 15 minutes is used.
1-1440
Specify an ARP cache time-out interval in minutes.
Top

Enable ECN (ECN)

Specifies whether explicit congestion notification (ECN) is enabled.

If ECN is enabled, routers can notify end-nodes of congestion before queues overflow. Without ECN, end-nodes can only detect congestion when packets are lost due to queues overflowing.

*SAME
ECN does not change from its current value.
*NO
ECN is not enabled for the system.
*YES
ECN is enabled for the system.
Top

Network file cache (NFC)

Specifies whether the Network File Cache (NFC) function will be enabled on this system. The Network File Cache is used for the support of FRCA (Fast Response Cache Accelerator). FRCA dramatically improves the performance of serving non-secure static content by Web and other TCP servers.

Single values

*DFT
The default NFC enablement status is *YES with a default cache size of 10MB and a cache timeout of 300 seconds.
*CLEAR
Specifies to immediately clear the entire network file cache. After the cache is cleared, the previous Network File Cache values will be retained.

Element 1: Enablement

*SAME
The NFC enablement status does not change from its current value.
*YES
The Network File Cache is enabled for this system.
*NO
The Network File Cache is not enabled for this system.

Element 2: Cached file timeout

Specifies the maximum amount of time, in seconds, that a file can be cached in the Network File Cache. This ensures that a file is refreshed at a regular interval.

Note: A cache time can be specified when NFC is not enabled; however, the cache time will not take affect until NFC is enabled.

SAME
The cached file timeout does not change from its current value.
*NOMAX
The cached file entries will NOT timeout.
30-604800
Specify a file cache time in seconds. The maximum value of 604800 seconds equals 1 week.

Element 3: Cache size

Specifies the maximum amount of storage that may be used by the NFC for the entire system. This is the accumulative storage used by all TCP servers for loading files.

Note: A cache time can be specified when NFC is not enabled; however, the cache size will not take affect until NFC is enabled.

SAME
The cache file size does not change from its current value.
10-100000
Specify the number of megabytes to be used for the file cache size.
Top

Log protocol errors (LOGPCLERR)

Specifies log protocol errors. This parameter enables a user to log protocol errors that occur during the processing of TCP/IP data. These TCP/IP stack layer functions use this parameter to determine if they log protocol-specific errors: IP, ICMP, ARP, and NAM. TCP and UDP do not log protocol errors.

The 7004 error reference code is logged when the LOGPCLERR(*YES) option is specified and inbound datagrams are silently discarded. Silently discarded means that an ICMP message is not returned to the originating host when a datagram is discarded because of header errors. Examples of such datagrams include those with invalid checksums and invalid destination addresses.

The error reference code is for information only. No action should be taken as a result of this error reference code. It is generated to assist with remote device or TCP/IP network problem analysis.

Note: These error conditions cannot be processed using an APAR.

The log protocol errors parameter should be used when error conditions require the logging of TCP/IP data, such as datagrams, to determine network problems.

The data is logged in the system error log. This error log is available through the Start System Service Tools (STRSST) command.

*SAME
The status of logging protocol errors does not change from its current value. LOGPCLERR(*NO) is the shipped value.
*NO
Protocol errors are not logged.
*YES
Protocol errors are logged.
Top

IP QoS datagram batching (IPQOSBCH)

This parameter is no longer supported. It exists solely for compatibility with releases earlier than Version 5 Release 3 Modification 0 of i5/OS.

Top

IP QoS timer resolution (IPQOSTMR)

This parameter is no longer supported. It exists solely for compatibility with releases earlier than Version 5 Release 3 Modification 0 of i5/OS.

Top

Examples

Example 1: Using TCP/IP with UDP Checksum Verification

CHGTCPA   UDPCKS(*YES)

This command indicates that UDP checksumming is done for UDP data.

Example 2: Using Selected IP Parameters

CHGTCPA   IPDTGFWD(*YES)  IPTTL(5)  IPRSBTIMO(60)

This command indicates that TCP/IP has the following characteristics:

Example 3: Using Selected TCP Parameters

CHGTCPA   TCPKEEPALV(100)  TCPURGPTR(*RFC)  TCPRCVBUF(16000)

This command indicates the following:

Example 4: Turning Off IP Source Routing

CHGTCPA   IPSRCRTG(*NO)

This command indicates that IP source routing will no longer be allowed. Any IP datagrams found with IP source routing turned on will be rejected.

Example 5: Changing R1/R2 Counts and QoS Attributes

CHGTCPA   TCPR1CNT(3)  TCPR2CNT(10)  TCPCLOTIMO(300)
          IPQOSENB(*YES) IPDEADGATE(*YES)

This command indicates the following:

Top

Error messages

*ESCAPE Messages

CPF9801
Object &2 in library &3 not found.
CPF9802
Not authorized to object &2 in &3.
CPF9803
Cannot allocate object &2 in library &3.
CPF9807
One or more libraries in library list deleted.
CPF9808
Cannot allocate one or more libraries on library list.
CPF9810
Library &1 not found.
CPF9820
Not authorized to use library &1.
CPF9830
Cannot assign library &1.
TCP1D03
&1 member record length not correct.
TCP1D04
Error occurred processing member &1 of &2/&3.
TCP15A3
TCP/IP attributes not changed.
TCP15A5
Error accessing member &3
TCP15A6
Attribute file keyword &4 missing
TCP15A7
Attribute file keyword &4 not valid.
TCP8050
*IOSYSCFG authority required to use &1.
TCP9503
File &3 in library &2 not available.
TCP9999
Internal system error in program &1.
Top