aXesW3 - Terminal Server User Configuration File
Users Section
This optional section is used to specify User options for the aXes Terminal Server (aXes-TS) and is prefaced by a User tag. Each entry in the section is a comma-separated list of values. Each entry specifies a set of overrides for a specific user.
This section must be at the end of the configuration file.
The Users section can be replaced by a separate file if you specify Users=path. For example:
Users=/axes/configs/aXesTSUsers.conf
Each entry in the Users section or the Users file is formatted as follows:
username=enable,device,inlpgm,inlmnu,curlib,ipmask,view,sessions,devtype, kbdtype,charset,codepagewhere username is an IBM i user profile name. Generic names may be specified by using wildcard characters. The question mark (?) represents any single character and the asterisk (*) represents any number of characters. The order of generic entires is important because the first match found is used. Generic names should be listed in order of most specific to least specific.
You can omit option values by specifying commas as placeholders, for example, JOE=1,,,,JOELIB but count the commas carefully. A user can be disabled from aXes Terminal Server by specifying a zero, for example, JOE=0.
The allowable option values are:
|
Value |
Description |
|---|---|
| enable | Enables or disables terminal access for a specific user. The default is to allow terminal access for anyone who has a valid IBM i user profile and password. Allowable values are 0 or 1. Zero (0) disables terminal access for the user. If the value is 0 the remaining parameters can be omitted. |
| Device |
|
| Inlpgm | The initial IBM i program to be run after a successful sign on. This value overrides any value defined on the user profile. There is no default value. See Note 1 below. |
| Inlmnu | The initial IBM i menu displayed after a successful sign on. This value overrides any value defined on the user profile. There is no default value. See Note 1 below. |
| Curlib | The initial current library for the user. This value overrides any value specified on the user profile. There is no default value. |
| Ipmask | An IP address mask that must match the client IP address. This can be used to constrain user access from a range of IP addresses or a specific IP addresses. The default is to allow connection from any IP address. Address ranges may be specified by using wildcard characters. The wildcards have the following meanings: ? matches any single character. * matches any characters except the dot (.) separator. ** matches any characters. |
| view or noview or default | Specify view to indicate that this user’s sessions can be viewed by an authorised administrator. |
| sessions | Specify the maximum number of aXes Terminal Server sessions this user is allowed to start at one time. The default is no maximum. |
| Devtype | Specify the type of workstation device created for this user. The default is to use the value specified in DefaultWorkstationType. |
| kbdtype | Specify the type of keyboard for the workstation device created for this user. The default is to use the value specified in DefaultKeyboardType. |
| Charset | Specify the character set for the workstation device created for this user. The default is to use the value specified in DefaultWorkstationCharset. If charset is specified then codepage must also be specified. |
| codepage | Specify the character set for the workstation device created for this user. The default is to use the value specified in DefaultWorkstationCodepage. If codepage is specified then charset must also be specified. |
Note 1: specifying the initial program, initial menu, and current library is an arcane 5250 method and should not be used in a modernized application. Instead you should use the INLPGM associated with the user profile to call the required program.
User options example 1
User option: JOE=1,JOEDSP0001,QCMD,MAIN,JOELIB,192.10.1.*,view,1
Means: User JOE is allowed to start an aXes Terminal Server session.
JOE sessions will acquire the display device JOEDSP0001.
The initial program will be QCMD.
The initial menu will be MAIN. Note: This is ignored by IBM i because an initial program is specified which takes precedence over an initial menu.
The current library will be set to JOELIB.
JOE must sign-on from a client within the 192.10.1 network.
Administrators can view JOE sessions.
And JOE is restricted to a single session. Note: This is also a side effect of specifying a named device with no substitution values.
User options example 2
User option: QSECOFR=0
Means: QSECOFR cannot use any aXes Terminal Server sessions.
User options example 3
User option: SHC=1,AXESTS2$*
Means: User SHC is allowed to start an aXes Terminal Server session
SHC sessions will acquire display devices using the name AXESTS2nn where nn is a sequence number.
SHC can sign-on from any client
SHC sessions cannot be viewed
SHC can start any number of sessions
User options example 4
User option: TP*=1,AXES$U,,,,,,1
Means: Any user starting with TP is allowed to start aXes Terminal Server sessions
TP users will acquire display devices using the name AXESxxxxxx where xxxxxx will be the first six characters of the user name.
TP users can sign-on from any client
TP sessions cannot be viewed
TP users are restricted to one session each
User options example 5
User option: *=1,AX$U$*
Means: All users are allowed to start aXes Terminal Server sessions
Users will acquire display devices using the name AXxxxxxxnn where xxxxxx will be the first 6 characters of the user name and nn will be a sequential number.
A catch-all entry such as this example must be the last entry in a list of user entries.
