USER Directory Statement

Read syntax diagramSkip visual syntax diagram User userid passwordNOLOGNOPASSAUTOONLYLBYONLYstormstorclpriSymbols
Symbols
Read syntax diagramSkip visual syntax diagramONONONONONOFFleONONONONOFFldONONONOFFcdONOFFes

Purpose

The USER statement starts a single-configuration virtual machine definition. The statement also defines a user ID and password, a logon and maximum virtual machine storage size, command privileges, and special symbol usage for the virtual machine.

How to Specify

When processing the USER statement, DIRECTXA checks for a maximum of ten tokens: userid, password, logon storage size, maximum storage size, privilege class, a placeholder for compatibility with VM/SP, line-end symbol, line-delete symbol, character-delete symbol, and escape character, in that order. If you specify more than ten tokens, DIRECTXA ignores the extra tokens and system processing continues as if you had not specified the extra tokens.

Operands

userid
defines the virtual machine's 1- to 8-character user ID. LOGNxxxx, LOGLxxxx, LOGVxxxx, SYSTEM, and SYSTEMMP are reserved for CP use. The xxxx can be any character, number, or symbol.

The user ID cannot be the same as a user ID specified on an IDENTITY statement or an ID specified on a SUBCONFIG statement.

You should not assign user IDs that are system keywords (such as command names, command operands, or 1- to 4-digit user IDs that could be spool IDs). Assigning system keywords as user IDs can cause unpredictable results. For a list of restricted user IDs, see Restricted User IDs.

You should not assign user IDs that contain colons (:), periods (.), semicolons (;), or slashes (/). These characters are used, or can be used in the future, as delimiters in several CP commands that also take a user ID as a parameter. Results are unpredictable when these commands are entered with a user ID containing any of these delimiter characters.

Ttranslation test tables in HCPTBL allow only the following characters in user IDs:
alphabetics
A-Z
numerics
0-9
The following, comma-delimited characters are also allowed:
@, #, $, _ (underscore), - (hyphen)
Note: It is recommended that the characters @, #, ¢, and " not be used in the userid because the system, by default, assigns these characters as logical line editing symbols. For more information, see Logical Line Editing Symbols.

You can override the translation tables in HCPTBL. See the TRANSLATE_TABLE Statement.

password
specifies a 1- to 8-character password that a user enters during the logon procedure.
Note: If DELETEUSER is specified as the password of a user when the DELTA option of the DIRECTXA utility is in effect, the user will be marked for deletion in its user index entry. For more information, see DIRECTXA.
NOLOG
specifies that a user cannot log on. You can use the NOLOG option to create virtual machines to which no one can log on. For example, you can place special system DASD areas (allocation, warm-start, and checkpoint areas) on minidisks and then assign the minidisks to virtual machines with NOLOG passwords. This helps you identify areas on a DASD.

Also, you can create minidisks for common user data and then assign the minidisks to virtual machines with NOLOG passwords. Users can then enter a CP LINK command to access those minidisks when they need the data.

Note: It is recommended that the characters @, #, ¢, and " not be used in the userid because the system, by default, assigns these characters as logical line editing symbols. For more information, see Logical Line Editing Symbols.
NOPASS
specifies that a user does not require a password to log on. It also specifies that a virtual machine can be automatically logged on using the XAUTOLOG command without password authorization.

Even though a user ID is defined with the NOPASS operand, LOGON password authorization might be required when an External Security Manager is installed. For more information, refer to documentation provided by your External Security Manager.

AUTOONLY
specifies that a user can be autologged, but not logged on at a terminal.
LBYONLY
specifies that:
  • Logging on to this virtual machine with the LOGON command requires use of the BY option.
  • This user ID cannot be used to log on to any virtual machine with the BY option.
Furthermore, this user ID might not be able to perform functions that require password validation, because LBYONLY is not accepted as a valid password.

CP allows an external security manager (ESM) to override these restrictions, so they are effective only when no ESM is installed or when the ESM defers to CP's processing. (See the ESM documentation for more information.)

For more information, see LOGONBY Directory Statement.

stor
specifies the virtual machine's primary address space size at logon. Specify stor as nu, where n is a 1- to 7-digit decimal number and u is the 1-character storage unit suffix (see Table 1).

This operand can contain an asterisk (*) as a placeholder. If the operand is omitted or specified as an asterisk, this indicates that the storage size is defined by a STORAGE statement in either the user entry or a profile entry.

Table 1. Maximum Input Values for Storage Units
Storage unit suffix (u) Maximum input value (n)
K - kilobytes 9999999
M - megabytes 9999999
G - gigabytes 9999999
T - terabytes 9999999
P - petabytes 16384
E - exabytes 16
Notes:
  1. A K specification is rounded up to a MB value.
  2. The maximum input value of 9999999 for the K, M, G, or T suffix is not a size limit but the physical limit of the operand (7 digits plus suffix). If the maximum input value for one of these suffixes does not allow you to define the amount of storage you want, you need to use a larger storage unit.
  3. The maximum size you can specify is 16E or 16384P, although the actual maximum size supported might be restricted by the model of the server where the directory is used.
  4. An XC virtual machine can address up to 2047 MB of storage in its base address space.
  5. Allowing many virtual machines to have large storage sizes might affect real storage availability. See usage note 1.
mstor
specifies the maximum size of the virtual machine's primary address space. Specify mstor as nu, where n is a 1- to 7-digit decimal number and u is the 1-character storage unit suffix (see Table 1). The default is 1M (1 MB).

This operand can contain an asterisk (*) as a placeholder. If the operand is omitted or specified as an asterisk, this indicates that the maximum storage size is defined by a MAXSTORAGE statement in either the user entry or a profile entry.

cl
specifies the privilege class or classes of CP commands a user can enter. Command classes are A through Z, and 1 through 6. You can specify up to 32 classes (if they fit). Each character represents a single privilege class and can appear in any order, without duplication, and must not be separated by blanks. The class field can also contain an asterisk (*) as a placeholder. If the field is not specified, or if it contains an asterisk (*) and there is no CLASS statement, CP uses the default privilege class or classes that are assigned by the PRIV_CLASSES statement in the system configuration file. For more information, see PRIV_CLASSES Statement.
Note: If you have not changed your classes from the IBM®-defined defaults, only classes A through G are valid. For information on defining your own user class structure, see Redefining Command Privilege Classes.
pri
is for VM/SP compatibility and serves no z/VM function. It must be a number from 0 to 99. If the pri specification is not entered, the line-end (le), line-delete (ld), character-delete (cd), and escape (es) characters default to ON.
le
ON
OFF
le is a 1-character line-end symbol or a 2-digit hexadecimal equivalent of the symbol. Input following a line-end symbol begins a new logical line. ON means that the virtual machine uses the system value. OFF means that CP will not recognize line-end symbols. If omitted, the default is ON.
Note: If you want to set a system-wide default for the line-end symbol, use the CHARACTER_DEFAULTS statement in the system configuration file. For more information, see CHARACTER_DEFAULTS Statement.
ld
ON
OFF
ld is a 1-character line-delete symbol or a 2-digit hexadecimal equivalent of the symbol. A line-delete symbol causes the previous logical line input to be ignored. ON means that the virtual machine uses the system value. OFF means that CP will not recognize line-delete symbols. If omitted, the default is ON.
Note: If you want to set a system-wide default for the line-delete symbol, use the CHARACTER_DEFAULTS statement in the system configuration file. For more information, see CHARACTER_DEFAULTS Statement.
cd
ON
OFF
cd is a 1-character delete symbol or a 2-digit hexadecimal equivalent of the symbol. A character-delete symbol causes the previous character input to be ignored. ON means the virtual machine uses the system value. OFF means that CP will not recognize character-delete symbols. If omitted, the default is ON.
Note: If you want to set a system-wide default for the character-delete symbol, use the CHARACTER_DEFAULTS statement in the system configuration file. For more information, see CHARACTER_DEFAULTS Statement.
es
ON
OFF
es is a 1-character escape symbol or a 2-digit hexadecimal equivalent of the symbol. The escape symbol causes CP to treat the following character literally, without consideration as an le, ld, or cd character. ON means that the virtual machine uses the system value. OFF means that CP will not recognize escape symbols. If omitted, the default is ON.
Note: If you want to set a system-wide default for the escape symbol, use the CHARACTER_DEFAULTS statement in the system configuration file. For more information, see CHARACTER_DEFAULTS Statement.

Usage Notes

  1. Allowing many virtual machines to have large storage sizes might affect real storage availability. For each virtual machine, CP creates dynamic address translation (DAT) tables to reference the virtual machine storage. DAT tables include page tables, segment tables, and higher level (region) tables.

    CP keeps the page tables in page management blocks (PGMBKs). Each 8 KB PGMBK references 1 MB of virtual machine storage. PGMBKs might be pageable; as such, their impact on real storage depends on how frequently the MBs of storage they reference are used.

    Segment tables and region tables are allocated from host real storage and are not pageable:
    • To reference the page tables for a primary address space or data space up to 2 GB, 1 - 4 contiguous frames are allocated for the segment table, one frame for each 512 MB of storage.
    • For a primary address space larger than 2 GB, multiple segment tables are created, plus one or more region tables to reference the segment tables. Each region table occupies 1 - 4 contiguous frames. If needed, multiple levels of region tables are created.
  2. The cl field can contain an asterisk (*) as a placeholder. If no further options are to be specified on the USER statement, the asterisk (*) is not required. In either case, if the CLASS statement is not supplied, CP uses the default class or classes assigned by the PRIV_CLASSES statement in the system configuration file. For more information, see PRIV_CLASSES Statement.
  3. If any of the options are specified, all prior options must also be specified. The default for unspecified options is ON.
  4. The USER statement defines the special symbol usage for a specific virtual machine. To override the special symbol usage for a specific virtual machine, have the user issue the CP TERMINAL command. For more information, see TERMINAL. To set default special symbol usage for the entire system, use the CHARACTER_DEFAULTS statement in the system configuration file. For more information, see CHARACTER_DEFAULTS Statement.

    You cannot use any of the letters A through Z, the numbers 0 through 9, or the bytes X'0E' (shift out) or X'0F' (shift in) for the line-end, line-delete, character-delete, or escape symbols.

Examples

  1. To start a directory entry for user ID BONES that specifies:
    • WW11QQ as BONES's password
    • 8M as BONES's virtual machine storage size at logon
    • 16M as the maximum virtual machine storage size BONES can define
    • BONES can enter only class S commands
    specify the following USER statement:
      User bones ww11qq 8m 16m s
  2. To start a directory entry for user ID WIZARD that specifies:
    • JK76TG as WIZARD's password
    • 4M as WIZARD's virtual machine storage size at logon
    • 6M as the maximum virtual machine storage size WIZARD can define
    • WIZARD can enter class A, B, C, Z, 3, 4, and G commands
    specify the following USER statement:
      User wizard jk76tg 4m 6m abcz34g
  3. To start a directory entry for user ID SHARDATA that specifies the NOLOG option, specify the following USER statement:
      User shardata NoLog