LST parameters for the BSA TCP/IP server

Overview

This section describes the LST parameters that are available for controlling the BSA TCP/IP server.

_app suffix

Some applications (add-ons) may need to be controlled differently from other applications. This is why you can define application ports, which can only be used by the specified application of one product. Use a global port instead if you want different applications of one or more products to share the same port.

A keyword with the _app suffix defines values for an application port, where app is the 3‑character identifier of the application (add-on). A keyword without the _app suffix is generally valid for all applications of the product or defines values for a global port.

Most keywords can be coded with and without the _app suffix. Keywords with the prefix BSA_ are valid for all applications and products.

Examples:

B93_TCPIP_PORT
B93_TCPIP_PORT_BWE
B92_TCPIP_PORT_OSY
BSA_TCPIP_TRACE

Examples

Examples on how to use the LST parameters for the BSA TCP/IP server can be found in the B02LST00 member in the BSA.SAMPLIB.

Changing parameters dynamically

A subset of the LST parameters can be set or changed dynamically via the BSA Service Manager.

The BSA Service Manager panel "Display Modifiable Parameter Keywords/Values" (Option D.S.1.2) shows a complete list of the parameters that you can change dynamically in your subsystem. For more information on using this option, see the BSA Service Manager Manual.

Note: When you set or change parameters using the BSA Service Manager, these changes are temporary and will no longer be valid after restarting the started task.

PORT LST parameter

Following is a description of the PORT LST parameter. For a description of the other LST parameters of the BSA TCP/IP server, see "Parameter descriptions".

Syntax

Bnn_TCPIP_PORT[_app] = port,ipa[<resolve>],tcpname[,[clnt],[mssid],[rssid],[keepalive]]

Values are coded as a comma-separated list of positional parameters. The port number (port), the IP address (ipa), and the name of the TCP/IP started task (tcpname) are required. The other parameters are optional.

Parameter

Description

Opt./Req.

port

Listening port (max. 5 digits)

required

ipa[<resolve>]

Bind address (numeric or symbolic)

Use the following notations if you want to specify an all-zeros address to bind to all available interfaces:

0.0.0.0

All available IPv4 addresses; accepts only connections via IPv4 protocol.

IPA_ANY4

Same as 0.0.0.0

::

All available IPv4 and IPv6 addresses; accepts connections via IPv4 and IPv6 protocol.

IPA_ANY6

Same as ::

Symbolic addresses (max. 255 characters) are resolved to numeric addresses (IPv6 and/or IPv4) via DNS. The resolution sequence is determined by the DNS server. By default, IPv6 addresses have precedence over IPv4 addresses. You can use the <resolve> parameter to control DNS resolution if ipa is a symbolic address:

ipa

The TCP/IP server uses all addresses from DNS resolution and binds to the first reachable IPv6 address and to the first reachable IPv4 address. This is the default, which is adequate in most situations.

ipa<IPV6>

The TCP/IP server uses all IPv6 addresses from DNS resolution and binds to the first reachable address.

ipa<IPV4>

The TCP/IP server uses all IPv4 addresses from DNS resolution and binds to the first reachable address.

ipa<IPV6:ALL>

The TCP/IP server uses all IPv6 addresses from DNS resolution and binds to all reachable addresses.

ipa<IPV4:ALL>

The TCP/IP server uses all IPv4 addresses from DNS resolution and binds to all reachable addresses.

ipa<ALL>

The TCP/IP server uses all IPv6 and IPv4 addresses from DNS resolution and binds to all reachable addresses.

The <resolve> parameter has no effect if ipa is a numeric address.

required

tcpname

Name of the TCP/IP started task (TCP/IP stack) on the z/OS system (max. 8 characters)

required

clnt

This parameter should only be used in exceptional situations. Specify only if asked to do so by Beta Systems support:

Program name of the server client (max. 8 characters)

optional

mssid

Use this parameter if the BSA TCP/IP server runs as a standalone Beta 02 STC and ports are defined for _beta doc|z (B93_TCPIP_ PORT[_app]) or _beta doc|z plus (B97_TCPIP_ PORT[_app]):

Specify the ssid (max. 4 digits) of the subsystem if it should receive copies of TCP/IP messages from Beta 02 STC. The receiving subsystem can store these messages in its message database.

optional

rssid

This parameter is necessary for the keyword Bnn_TCPIP_PORT_EDF if the BSA TCP/IP server runs as a standalone Beta 02 STC:

The subsystem ID (max. 4 digits) where requests are to be sent

optional

keepalive

Interval in seconds that is used to send keepalive probes

When no data flows, TCP keepalive processing periodically sends packets over the TCP connection to prevent the connection from being reset. The default is okay for most applications, and there is no need to change it. Beta Systems support may ask you to change this value if you are experiencing TCP connection reset problems.

Several LST parameters can be used to specify the interval in seconds that is used to send keepalive probes. When the keepalive value is set for a specific port, the following hierarchy applies (from highest to lowest):

  1. Value specified in Bnn_TCPIP_PORT[_app]
  2. Value specified in Bnn_TCPIP_KEEPALIVE_TIME_port
  3. Value specified in Bnn_TCPIP_KEEPALIVE_TIME

Valid values: 0..2147460
(default is 5 seconds; 0 deactivates keepalive)

It is possible to modify the keepalive value of each active port dynamically with the help of the BSA Service Manager (option D.S.4.2.2, Action: Display; Line command L (Limit)). The modification takes effect when the first new connection is established after the value has been modified.

For detailed information on the handling of the TCP_KEEPALIVE value, see also z/OS Communications Server: IP Programmer's Guide and Reference.

optional

Parameter descriptions

Keyword

Value

Description

Opt./Req.

Default

Bnn_TCPIP_BACKLOG

nnnnnnnnn

Defines how many pending connections the queue will hold.

This parameter applies to all global and application ports defined for the product.

Optional

255

Bnn_TCPIP_COMPRESS

Bnn_TCPIP_ COMPRESS_app

method

Specifies the compression method to be used

This keyword excludes the use of the keyword Bnn_TCPIP_CRYPT_EXIT. Only use this keyword if the product client supports compression.

The following methods can be specified:

STD

Beta standard compression

YES

Same as STD

NO

No compression

Optional

NO

Bnn_TCPIP_ENCRYPT

Bnn_TCPIP_ ENCRYPT_app

method
[,key]

Specifies the encryption method to be used

Optionally, you can also specify the key. Keys must consist of HEX values only (0123456789ABCDEF). If no key is specified, a key based on the indicated method will be generated automatically during each connect. Only use this keyword if the product client supports this encryption.

The following methods can be specified:

DES

DES algorithm; key length = 16

TRD

Triple DES algorithm, key length = 48

AES

Advanced encryption standard, key length = 64 (encryption mode CBC; fallback to Triple DES if client does not support AES)

BFS

Blowfish algorithm,
key length >=16 and <=128, divisible by 2

NO

No encryption

Optional

NO

Bnn_TCPIP_ KEEPALIVE_ TIME

Bnn_TCPIP_ KEEPALIVE_ TIME_port

0..2147460

Interval in seconds that is used to send keepalive probes

For details on valid values and handling, see "PORT LST parameter".

Optional

5

Bnn_TCPIP_LOGON_ EXIT

Bnn_TCPIP_LOGON_ EXIT_app

name

Use only if supported by the product (see product documentation):

Name of the product logon exit that is to be called by the default BSA TCP/IP server logon exit

Optional

none

Bnn_TCPIP_MAX_ CLIENT

Bnn_TCPIP_MAX_ CLIENT_app

nnnn

Specifies the number of client connects/ logons that can be made in parallel. Once this number has been reached, no more connects will be accepted until an existing one is closed. The BSA TCP/IP server checks this cyclically after the period of time specified by Bnn_TCPIP_ CLIENT_WAIT.

Optional

1000

Bnn_TCPIP_MAX_ CLIENT_GROUPS

Bnn_TCPIP_MAX_ CLIENT_GROUPS_app

nn

nn specifies the number of SFF client groups to be generated for the port. If more than 26 client groups are specified, the parameter is automatically reset to 26. When the product STC is started, the number of client groups specified here are defined.

Optional

1

Bnn_TCPIP_MAX_ CLIENT_REJECT

Bnn_TCPIP_MAX_ CLIENT_REJECT_app

YES | NO

This parameter controls how the BSA TCP/IP server handles incoming TCP/IP connect attempts when the maximum number of active clients has been reached for a port (see Bnn_TCPIP_MAX_ CLIENT[_app]).

If NO: The client waits for a connection. The BSA TCP/IP server checks for closed connections at the specified interval.

If YES: The BSA TCP/IP server rejects the connection attempt without waiting. This is indicated by messages 9280W and 9281W. In case of EDF, the connection is refused immediately after the messages are output. In case of other applications, the BSA TCP/IP server completes the protocol handshake with the requestor (client), sends specific terminating information according to an internal protocol, and then closes the connection. There is no message indicating that the BSA TCP/IP server is ready to accept connects again.

This handling applies to all applications in case of a global port. Code the application identifier _app in the keyword if this handling should apply only to a specific application port.

Optional

NO

Bnn_TCPIP_CLIENT_ WAIT

Bnn_TCPIP_CLIENT_ WAIT_app

nnnn

Specifies the number of seconds that the BSA TCP/IP server waits before checking whether the number of clients specified by Bnn_TCPIP_MAX_CLIENT is no longer exceeded.

Optional

5

Bnn_TCPIP_PORT

Bnn_TCPIP_PORT_app

 

See "PORT LST parameter".

Required

none

Bnn_TCPIP_RETRY_ INTERVAL

secs,num

The time and the number of the retry intervals (max. 9 digits each). If the task is not active or the connection is lost, an attempt will be made to automatically reconnect the server to the TCP/IP started task after secs has elapsed. This will be repeated num times.

secs = the time in seconds the system is to wait before a reconnect is attempted.

num = the number of retry intervals. This number specifies how often a reconnect between a server and the z/OS TCP/IP stack or STC is attempted. If no reconnect to the system can be made within the specified number of retry intervals, the server will be terminated. You can reactivate the server by using the appropriate MODIFY command. 0 means the number of retries is unlimited.

This parameter applies to all global and application ports defined for the product.

Optional

60,0

Bnn_TCPIP_ROUTER

Bnn_TCPIP_ ROUTER_app

YES | NO

Select NO to attach the client directly via the BSA TCP/IP server and not via the TCP/IP router by means of bss_srqe.

Optional

YES

BSA_TCPIP_ SEND_ASY

YES | NO

In synchronous mode (NO), the entire SFF group that includes the sending function pauses until the send process has finished successfully.

In asynchronous mode (YES), only the sending function within the SFF group pauses until the send process has finished successfully. Other functions within this SFF group can continue working in parallel.

Optional

YES

Bnn_TCPIP_SESS_ TIME_LIMIT

nnnnnnnnn

Enter the maximum period of time (time limit) in minutes a user can remain inactive before being timed out. When the time is exceeded, the user will be disconnected. Disconnected users must log onto the z/OS system again if they want to proceed.

This parameter applies to all global and application ports defined for the product.

Optional

60

Bnn_TCPIP_TIMEOUT

nnnnnnnnn

The space of time (max. 9 digits) in seconds after the program will cancel a session due to system inactivity. If the time specified here elapses before any event is detected, the TCP/IP SELECT command will return the control.

The timeout value set via this parameter applies to all global and application ports defined for the product.

Optional

60

BSA_TCPIP_TRACE

YES | NO | SHO | ERR | SHORT | ERROR

If YES, all server and server client activities are logged, i.e. all requests. Specifying the value SHO or SHORT or the value ERR or ERROR for this parameter reduces the amount of information that is logged. Set this parameter to YES or SHO or ERR only if asked to do so by Beta Systems support.

Optional

NO

BSA_TCPIP_TRACE_ LST

YES | NO

If YES, all the LST keywords that are processed while the server is starting are logged. Set this parameter to YES only if asked to do so by Beta Systems support.

Optional

NO

BSA_TCPIP_TRACE_ INTERN

YES | NO

If YES, all TCP/IP requests are logged. Set this parameter to YES only if asked to do so by Beta Systems support.

Optional

NO

BSA_TCPIP_TRACE_ SNDRCV

YES | NO

This parameter has an effect only if BSA_TCPIP_TRACE_INTERN = YES:

YES

All TCP/IP SEND or RECEIVE requests are logged.

NO

Only the first SEND and RECEIVE requests are logged.

Set this parameter to NO only if asked to do so by Beta Systems support.

Optional

YES

BSA_TCPIP_TRACE_ BUF

YES | NO

If YES, all buffer data from SEND or RECEIVE requests are logged in dump format. Set this parameter to YES only if asked to do so by Beta Systems support.

Optional

NO

Bnn_WLM_SUBSYS_ TYPE

Bnn_WLM_SUBSYS_ NAME

 

See "LST parameters for ZIF"

 

 

Scope of keywords with [_app]

Please note the difference in scope when the following two groups of keywords are used with and without the _app suffix:

Keyword

Scope

Bnn_TCPIP_LOGON_EXIT[_app]
Bnn_TCPIP_COMPRESS[_app]
Bnn_TCPIP_ENCRYPT[_app]

The keywords in this group define settings for applications; settings defined for an application are independent of the type of port being used (global or application):

  • The keywords with _app suffix apply to the corresponding application of Beta nn.
  • The keywords without _app suffix apply to all applications of Beta nn.

Bnn_TCPIP_CLIENT_WAIT[_app]
Bnn_TCPIP_MAX_CLIENT[_app]
Bnn_TCPIP_MAX_CLIENT_REJECT[_app]
Bnn_TCPIP_MAX_CLIENT_GROUPS[_app]

The keywords in this group define settings for ports; settings defined for a global port are independent of the type of application being used:

  • The keywords with _app suffix apply to the corresponding application ports defined for Beta nn.
  • The keywords without _app suffix apply to the global ports defined for Beta nn.