Details of the SSH Client Configuration File

The SSH client configuration file comprises global parameters.

The following table lists the global parameters that provide the SSH client with general guidelines and limitations to follow.

Table 84. Global Parameters

Global Parameter

Description

DEL_OLDREQ_DAYS

Specifies the number of days the SSH client request file can store the completed requests. The SSH client deletes completed requests older than 99 days or lower.

Note: The default value is 5.

LOG_LEVEL

Specifies the amount of information to capture in the SUMLOG using Major Type 19 (Diagnostic Entry) and Minor Type 41 (Secure Shell). The following are valid values:

  • ALL. Captures detailed information about the SSH Command including TCP/IP port status changes. This is the default setting.

  • BASIC. Captures a minimum amount of information.

  • NONE. Captures only Alerts. This is the default setting.

Note: The default value is NONE.

MAP_PRIORITY0

Specifies the priority level on the MCP system of a normal-priority SSH client request. You must set this value lower than the value for MAP_PRIORITY1.

  • This value must be 99 or lower.

  • The default value is 60.

MAP_PRIORITY1

Specifies the priority level on the MCP system of an urgent-priority SSH client request. You must set this value higher than the value for MAP_PRIORITY0

Note: The default value is 70.

MAX_REQUEST

Specifies the maximum number of requests that can occur concurrently and the maximum number of sockets that the SSH client opens concurrently to each server with which it is communicating.

  • This value must be 999 or lower.

  • The default value is 10.

MAX_RETRY

Specifies the maximum number of times the SSH client retries an SSH client connection.

  • This value must be 99 or lower.

  • The default value is 0.

RETRY_INTERVAL

Specifies the time (in seconds) between an unsuccessful SSH client connection attempt and the next attempt to establish the connection.

  • This value must be 999 or lower.

  • The default value is 1.

BLOCKED_TIMEOUT

Specifies the number of minutes that the system transmits keep-alive packets.

The system transmits these packets as follows:

  1. The system sends a keep-alive packet and waits up to four seconds for a response.

  2. If the previous step returns no response, the system sends another keep-alive packet and waits up to eight seconds for a response.

  3. If the previous step returns no response, the system sends another keep-alive packet and waits up to 16 seconds for a response.

The pattern continues until a response is received or BLOCKED_TIMEOUT minutes elapse. If the system receives a response, it exits the keep-alive mode. If the system does not receive a response in BLOCKED_TIMEOUT minutes, it closes the socket and notifies the user.

This value ranges from 0 to 1440 minutes. A value of 0 indicates that the feature is disabled.

Note: During the first minute of the keep-alive mode, a maximum of four keep-alive packets are sent. The default value is 1.

DIALOG_CHECK_INTERVAL

Specifies the number of minutes of inactivity on an open socket before the system sends the keep-alive packets. The system resets the DIALOG_CHECK_INTERVAL timer for an open socket when it detects activity on that socket.

  • This value ranges from 0 to 1440 minutes. A value of 0 indicates that the feature is disabled.

  • The default value is 3.


Examples

The following are examples of global parameter configurations:

% Maximum concurrent requests 
MAX_REQUEST = 10 

% Map normal request worker task to priority 60
MAP_PRIORITY0=60 

% Map urgent request worker task to priority 70
MAP_PRIORITY1=70

% Number of days to keep completed requests in
% the request file before deleting them
DEL_OLDREQ_DAYS=5

% Number of retries for recoverable errors
MAX_RETRY=0 

% Retry in the interval of 600 seconds
RETRY_INTERVAL=1

% Level of logging. BASIC or ALL or NONE
LOG_LEVEL=NONE

% Provide keep-alive capability for a socket.
% Both of the following attributes must be 
% enabled to run keep-alive mode:
% BLOCKED_TIMEOUT
% DIALOG_CHECK_INTERVAL

% Number of minutes (1-1440) that keep-alive packets
% continue to be transmitted
BLOCKED_TIMEOUT=1

% Number of minutes (1-1440) to wait before keep-alive
% packets are sent to a remote host that is not 
% responding to messages
DIALOG_CHECK_INTERVAL=3
Note: You can edit the SSH client configuration file before starting or restarting SSHCLIENT.