Configuration Keywords

This section contains information about the format and parameters of the Session Persistence Server stored configuration. The configuration information is entered in keyword/value pairs, and the entries are organized into the following sections.

For examples of a configuration file, see Sample Session Persistence Server Configurations.

Proxy Service

A proxy service entry defines the connections between the Clients and the Session Persistence Server. You must have at least one proxy service defined. Use the following format to create a proxy service entry in the Session Persistence Server configuration:

proxyservice [proxyservicename]

listen [ipaddr]:[port]

server [hostservicename]:[hostserviceport]

timeout [min]

ssl [on | off]

encryption [passphrase]

Details about each parameter in the proxy service entry:

Parameter	Description
proxyservice [proxyservice name]	Specify a name for the proxy service. The name is used in the Session Persistence Server user interface and log file. This is a required parameter.
listen [ipaddr:port]	Specify the interface and port number on which the proxy server should listen for Client connections. Use 0.0.0.0 to specify that the proxy server should listen for a specific port number on all local interfaces. For example, the value 0.0.0.0:2301 instructs Session Persistence Server to listen for Client connections on port 2301 for all local interfaces on the Session Persistence Server. This is a required parameter.
server [hostservice]	Specify the host service names to be associated with a proxy service. This parameter defines the host services that a Client can access through this proxy service. The parameter value is a comma-separated list of host service names. An asterisk (*) can be specified as the host service name. Session Persistence Server will then allow the Client to establish sessions with arbitrary applications, whether they are configured with a host service statement or not. This should not be used when Session Persistence Server is reachable through a firewall or is located in a DMZ. This is a required parameter.
timeout [time]	Specify the amount of time before Session Persistence Server terminates the Client-proxy session due to Client inactivity (also referred to as the Client timeout). Specify a value of 0 to allow sessions to remain open indefinitely. An inactive Client connection is one where the Client has not sent or received data during the specified timeout interval. When Session Persistence Server terminates a Client connection, it will leave the proxy-host connection intact until the host timeout interval expires due to inactivity. A suffix can be used to indicate a time unit (1d or 24h or 1440m or 86400s). This parameter is optional and will default to 24h.
ssl [on \| off]	Set this value to on to use SSL/TLS to communicate with the Client. Session Persistence Server generates self-signed certificates during installation, or you can supply your own valid server certificate and private key PEM files.
encryption [passphrase]	Specify an encryption key to use custom encryption for Client connections.

You cannot define a connection to support both SSL and custom encryption. That is, if you have SSL turned on, do not specify a passphrase for custom encryption. If you define the passphrase for custom encryption, make sure SSL is turned off.

Host Service

A host service entry defines the connections between the Session Persistence Server and the host. Use the following format to create a host service entry in the Session Persistence Server configuration:

hostservice [hostservicename]

connect [ipaddr:port]

ssh [on | off]

ssh-verify [on | off]

timeout [min]

reconnect-string [reconnect-string]

reconnect-buffer [size]

undeliverable [Discard | Abort]

codeset [ASCII | EBCDIC]

stationid-template {regular expression]

translate-tohost [tablename]

translate-fromhost [tablename]

The following table contains detailed information about each parameter in the host service entry.

Parameter	Description
hostservice [hostservicname]	Specify a name for the host service. The name is used in the Session Persistence Server user interface and log file. There is a 64-character maximum. This is a required parameter.
connect [ipaddr:port]	Specify the IP address and port of a target host. This is the interface and port number on which the proxy server should connect to the host service, where [ipaddr] is the IP address of the interface and [port] is the port number on that interface. A DNS name may be used in place of the IP address, but it must be followed by a colon and the port number. Example: app.host.com:1235 This is a required parameter.
ssh [on \| off]	Specify either on or off to determine whether Session Persistence Server uses SSH encryption for the proxy-host session.
ssh-verify [on \| off]	Specify either on or off to determine whether to allow connections to the host if the public key does not match the expected key. When this option is set to off and the public key does not match, the connection will be allowed and warning messages are displayed on the Client. When this option is set to on and the public key does not match, the connection fails.
timeout [min]	Specify the amount of time after a Client disconnects that the Session Persistence Server will maintain the proxy-host session. Specify a value of 0 to allow sessions to remain open indefinitely. This time begins once the Client-proxy connection closes and after the Client timeout expires. This parameter is optional and will default to 15m.
reconnect-string [string]	A reconnect string requests the last screen data that the host had before the mobile device disconnected. Input a reconnect string or use one you defined in the Session Persistence Server configuration file. The reconnect string in the host profile takes precedence over the reconnect string in the Session Persistence Server configuration file. Requirements for connect strings depend upon the application, but the strings are required in 5250 and 3270 environments. For more information on reconnect strings, see Configuring Reconnect Strings.
reconnect-buffer [size]	Specify a value to determine the maximum amount of host-to-Client data (in bytes) that will be saved when a Client reestablishes a connection with Session Persistence Server. This option is only available if no reconnect-string is specified.
undeliverable [DISCARD \| ABORT]	Specify either DISCARD or ABORT for sessions with a host connection, but no current Client connection. DISCARD will delete unsolicited outbound data sent by the host application. ABORT will terminate the host connection. This parameter is optional and will default to DISCARD.
codeset [ASCII \| EBCDIC]	Specify ASCII or EBCDIC to determine how Session Persistence Server searches the application data for a station ID and how it presents capture file records. Select EBCDIC when using 5250 and the stationid-template. This parameter defaults to ASCII.
stationid-template [regular expression]	Specify the stationid-template. The stationid-template extracts the workstation ID from the initial outbound screen buffer of an IBM AS/400 Telnet server session and presents the ID in the active session list, alongside the Client IP address. The search pattern must be in the form of a regular expression containing a single tagged expression. Example: Display [ .]+:\s+(.+?)[ ] This is an optional parameter and configured only with 5250.
translate-tohost [tablename]	Session Persistence Server provides a simple byte-replacement mechanism for the inbound data stream. To use this feature, you must define one or more mapping tables and reference the tables through the translate-tohost keywords. For more information, see Translating Table Statements. This parameter is optional and defaults to No translation.
translate-fromhost [tablename]	Specify the mapping tables for the outbound data stream. Session Persistence Server provides a simple byte-replacement mechanism for the outbound data stream. For more information, see Translating Table Statements. This parameter is optional and defaults to No translation.

Log Level

Use the following format to create a log level entry in the Session Persistence Server configuration:

loglevel [preferred default logging level]

The following table contains detailed information about the loglevel entry.

Parameter	Description
loglevel [logging level]	Specify the log level. The log level controls the amount of data Session Persistence Server writes into the log file. The information stored in the log file can be useful for trouble-shooting and auditing purposes. The log level allows you to manage the amount of collected data. This configuration setting is meant to be the ‘normal’ setting for the day-to-day operation. The Logging and Data Capture Settings page in the Session Persistence Server web interface allows you to temporarily change that level setting. The following is a list of the log level settings. The numbers in parentheses can be used in place of the name. CRITICAL (1) — Catastrophic error logging only ERRORS (2) — Errors only WARNING (3) — Errors and warnings INFO (4) — Errors, warnings, informational DEBUG (5) — Trouble-shooting mode VERBOSE (6) — All logging information

Parameter

Description

loglevel [logging level]

Specify the log level. The log level controls the amount of data Session Persistence Server writes into the log file. The information stored in the log file can be useful for trouble-shooting and auditing purposes. The log level allows you to manage the amount of collected data.

This configuration setting is meant to be the ‘normal’ setting for the day-to-day operation. The Logging and Data Capture Settings page in the Session Persistence Server web interface allows you to temporarily change that level setting.

The following is a list of the log level settings. The numbers in parentheses can be used in place of the name.

CRITICAL (1) — Catastrophic error logging only
ERRORS (2) — Errors only
WARNING (3) — Errors and warnings
INFO (4) — Errors, warnings, informational
DEBUG (5) — Trouble-shooting mode
VERBOSE (6) — All logging information

Capture

Session Persistence Server can capture proxy communication information. Use the following format to create a capture entry in the Session Persistence Server configuration:

capture [on |off]
clear [on | off]
include [filter]

The following table contains detailed information about the capture entry.

Parameter	Description
capture [on \| off]	Specify either on or off to determine whether proxy communication data is captured.
clear [on \| off]	Specify either on or off to determine whether the data capture file is emptied when Session Persistence Server starts or restarts.
include [filter]	Specify a comma-delimited list of Client IP addresses that will have their data captured. Use the format x.x.x.x/y to specify an entire subnet. Example: 10.0.0.0/8 indicates addresses 10.0.0.0 to 10.255.255.255. Do not use the include parameter if you want to capture the network traffic for all devices.

Restart

Use the following format to create a restart entry in the Session Persistence Server configuration:

restart [restart time]

The following table contains detailed information about the restart entry.

Parameter	Description
restart [time]	Specify a comma-delimited list of times that Session Persistence Server will automatically restart. Enter times using the following format: HH:MM[a\|p]. If there is no 'a' or 'p' following the time (representing AM or PM), the time is assumed to be in a 24-hour format. Specify a weekly time by preceding the time with the day of the week. Examples: 10:00P, 06:00A, MONDAY22:30 This is a required parameter.

Parameter

Description

restart [time]

Specify a comma-delimited list of times that Session Persistence Server will automatically restart.

Enter times using the following format: HH:MM[a|p]. If there is no 'a' or 'p' following the time (representing AM or PM), the time is assumed to be in a 24-hour format. Specify a weekly time by preceding the time with the day of the week.

Examples: 10:00P, 06:00A, MONDAY22:30

This is a required parameter.

HTTPserver

Use the following format to create an httpserver entry in the Session Persistence Server configuration:

httpserver [ipaddr]:[port]
ssl [on | off]

The following table contains information about the httpserver entry.

Parameter	Description
httpserver [ipaddr:port]	Specify the IP address and port to which the Session Persistence Server HTTP service binds itself. You would normally specify the ANY/ALL address and a free port number. Example: 0.0.0.0:4428 Alternatively, you could restrict access to the HTTP interface to the local machine. Example: httpserver localhost:4428. Session Persistence Server requires both an httpserver statement and a userid/password specification before it will activate the HTTP service. This is a required parameter.
ssl [on \| off]	Specify on to use the Secure Sockets Layer (SSL) protocol to communicate with the browser. Session Persistence Server must be supplied with a valid server certificate and private key PEM file for SSL HTTP service to become operational. The directory where the Session Persistence Server service is installed should contain a default servercert.pem and serverkey.pem file.

Parameter

Description

httpserver [ipaddr:port]

Specify the IP address and port to which the Session Persistence Server HTTP service binds itself. You would normally specify the ANY/ALL address and a free port number. Example: 0.0.0.0:4428

Alternatively, you could restrict access to the HTTP interface to the local machine. Example: httpserver localhost:4428.

Session Persistence Server requires both an httpserver statement and a userid/password specification before it will activate the HTTP service.

This is a required parameter.

ssl [on | off]

Specify on to use the Secure Sockets Layer (SSL) protocol to communicate with the browser. Session Persistence Server must be supplied with a valid server certificate and private key PEM file for SSL HTTP service to become operational.

The directory where the Session Persistence Server service is installed should contain a default servercert.pem and serverkey.pem file.

For examples of a configuration file, see Sample Session Persistence Server Configurations.