See the Item Codes section for descriptions of the various $GETUAI item
codes.
UAI$_ACCOUNT
Returns, as a blank-filled 32-character string, the account name of the
user.
An account name can include up to 8 characters. Because the account
name is a blank-filled string, however, the buffer length field of the
item descriptor should specify 32 (bytes).
UAI$_ASTLM
Returns the AST queue limit.
Because this decimal number is a word in length, the buffer length
field in the item descriptor should specify 2 (bytes).
UAI$_BATCH_ACCESS_P
Returns, as a 3-byte value, the range of times during which batch
access is permitted for primary days. Each bit set represents a 1-hour
period, from bit 0 as midnight to 1 a.m. to bit 23 as 11 p.m. to
midnight.
The buffer length field in the item descriptor should specify 3 (bytes).
UAI$_BATCH_ACCESS_S
Returns, as a 3-byte value, the range of times during which batch
access is permitted for secondary days. Each bit set represents a
1-hour period, from bit 0 as midnight to 1 a.m. to bit 23 as 11 p.m. to
midnight.
The buffer length field in the item descriptor should specify 3 (bytes).
UAI$_BIOLM
Returns the buffered I/O count.
Because this decimal number is a word in length, the buffer length
field in the item descriptor should specify 2 (bytes).
UAI$_BYTLM
Returns the buffered I/O byte limit.
Because the buffered I/O byte limit is a longword decimal number, the
buffer length field in the item descriptor should specify 4 (bytes).
UAI$_CLITABLES
Returns, as a character string, the name of the user-defined CLI table
for the account, if any.
Because the CLI table name can include up to 31 characters in addition
to a size-byte prefix, the buffer length field of the item descriptor
should specify 32 (bytes).
UAI$_CPUTIM
Returns the maximum CPU time limit (per session) for the process in
10-millisecond units.
Because the maximum CPU time limit is a longword decimal number, the
buffer length field in the item descriptor should specify 4 (bytes).
UAI$_DEFCLI
Returns, as an RMS file name component, the name of the command
language interpreter used to execute the specified batch job. The file
specification returned assumes the device name and directory SYS$SYSTEM
and the file type .EXE.
Because a file name can include up to 31 characters in addition to a
size-byte prefix, the buffer length field in the item descriptor should
specify 32 (bytes).
UAI$_DEFDEV
Returns, as a 1- to 31-character string, the name of the default device.
Because the device name string can include up to 31 characters in
addition to a size-byte prefix, the buffer length field in the item
descriptor should specify 32 (bytes).
UAI$_DEFDIR
Returns, as a 1- to 63-character string, the name of the default
directory.
Because the directory name string can include up to 63 characters in
addition to a size-byte prefix, the buffer length field in the item
descriptor should specify 64 (bytes).
UAI$_DEF_PRIV
Returns the default privileges for the user.
Because the default privileges are returned as a quadword value, the
buffer length field in the item descriptor should specify 8 (bytes).
UAI$_DFWSCNT
Returns the default working set size in pagelets .
Because the default working set size is a longword decimal number, the
buffer length field in the item descriptor should specify 4 (bytes).
UAI$_DIOLM
Returns the direct I/O count limit.
Because this decimal number is a word in length, the buffer length
field in the item descriptor should specify 2 (bytes).
UAI$_DIALUP_ACCESS_P
Returns, as a 3-byte value, the range of times during which dialup
access is permitted for primary days. Each bit set represents a 1-hour
period, from bit 0 as midnight to 1 a.m. to bit 23 as 11 p.m. to
midnight. For each hour the bit is set to 0, access is allowed. For
each hour the bit is set to 1, access is denied.
The buffer length field in the item descriptor should specify 3 (bytes).
UAI$_DIALUP_ACCESS_S
Returns, as a 3-byte value, the range of times during which dialup
access is permitted for secondary days. Each bit set represents a
1-hour period, from bit 0 as midnight to 1 a.m. to bit 23 as 11 p.m. to
midnight. For each hour the bit is set to 0, access is allowed. For
each hour the bit is set to 1, access is denied.
The buffer length field in the item descriptor should specify 3 (bytes).
UAI$_ENCRYPT
Returns one of the values shown in the following table, identifying the
encryption algorithm for the primary password.
Because the encryption algorithm is a byte in length, the buffer length
field in the item descriptor should specify 1 (byte).
| Symbolic Name |
Description |
|
UAI$C_AD_II
|
Uses a CRC algorithm and returns a longword hash value. It was used in
VAX VMS releases prior to Version 2.0.
|
|
UAI$C_PURDY
|
Uses a Purdy algorithm over salted input. It expects a blank-padded
user name and returns a quadword hash value. This algorithm was used
during VAX VMS Version 2.0 field test.
|
|
UAI$C_PURDY_V
|
Uses the Purdy algorithm over salted input. It expects a
variable-length user name and returns a quadword hash value. This
algorithm was used in VMS releases prior to Version 5.4.
|
|
UAI$C_PURDY_S
|
Uses the Purdy algorithm over salted input. It expects a
variable-length user name and returns a quadword hash value. This is
the current algorithm that the operating system uses for all new
password changes.
|
UAI$_ENCRYPT2
Returns one of the following values identifying the encryption
algorithm for the secondary password:
- UAI$C_AD_II
- UAI$C_PURDY
- UAI$C_PURDY_V
- UAI$C_PURDY_S
Because the encryption algorithm is a byte in length, the buffer length
field in the item descriptor should specify 1 byte.
UAI$_ENQLM
Returns the lock queue limit.
Because this decimal number is a word in length, the buffer length
field in the item descriptor should specify 2 (bytes).
UAI$_EXPIRATION
Returns, as a quadword absolute time value, the expiration date and
time of the account.
Because the absolute time value is a quadword in length, the buffer
length field in the item descriptor should specify 8 (bytes).
UAI$_FILLM
Returns the open file limit.
Because this decimal number is a word in length, the buffer length
field in the item descriptor should specify 2 (bytes).
UAI$_FLAGS
Returns, as a longword bit vector, the various login flags set for the
user.
Each flag is represented by a bit. The $UAIDEF macro defines the
following symbolic names for these flags:
| Symbolic Name |
Description |
|
UAI$V_AUDIT
|
All actions are audited.
|
|
UAI$V_AUTOLOGIN
|
User can only log in to terminals defined by the Automatic Login
facility (ALF).
|
|
UAI$V_CAPTIVE
|
User is restricted to captive account.
|
|
UAI$V_DEFCLI
|
User is restricted to default command interpreter.
|
|
UAI$V_DISACNT
|
User account is disabled. Same as /FLAG = DISUSER qualifier in
AUTHORIZE.
|
|
UAI$V_DISCTLY
|
User cannot use Ctrl/Y.
|
|
UAI$V_DISFORCE_PWD_CHANGE
|
User will not be forced to change expired passwords at login.
|
|
UAI$V_DISIMAGE
|
User cannot issue the RUN or MCR commands or use the foreign command
mechanism in DCL.
|
|
UAI$V_DISMAIL
|
Announcement of new mail is suppressed.
|
|
UAI$V_DISPWDDIC
|
Automatic checking of user-selected passwords against the system
dictionary is disabled.
|
|
UAI$V_DISPWDHIS
|
Automatic checking of user-selected passwords against previously used
passwords is disabled.
|
|
UAI$V_DISPWDSYNCH
|
When set, prevents synchronizing a user's SYSUAF.DAT password using an
external authentication password (when UAI$V_EXTAUTH is set).
|
|
UAI$V_DISRECONNECT
|
User cannot reconnect to existing processes.
|
|
UAI$V_DISREPORT
|
User will not receive last login messages.
|
|
UAI$V_DISWELCOME
|
User will not receive the login welcome message.
|
|
UAI$V_EXTAUTH
|
User is considered to be externally authenticated by their external
user ID and password, and not by the SYSUAF user ID and password. The
SYSUAF record is still used for checking login restrictions and quotas
and for creating the user's OpenVMS process profile.
|
|
UAI$V_GENPWD
|
User is required to use generated passwords.
|
|
UAI$V_LOCKPWD
|
SET PASSWORD command is disabled.
|
|
UAI$V_MIGRATEPWD
|
User's SYSUAF password has been set using AUTHORIZE or SYS$SETUAI and
is likely to be inconsistent with the user's external user password. If
password migration is enabled, the system will attempt to update the
external authentication service the next time the user attempts a login.
|
|
UAI$V_NOMAIL
|
Mail delivery to user is disabled.
|
|
UAI$V_PWD_EXPIRED
|
Primary password is expired.
|
|
UAI$V_PWD2_EXPIRED
|
Secondary password is expired.
|
|
UAI$V_RESTRICTED
|
User is limited to operating under a restricted account. (For a
description of restricted and captive accounts, see the HP OpenVMS Guide to System Security.)
|
|
UAI$V_VMSAUTH
|
When set, the user is allowed to authenticate using the user's
SYSUAF.DAT user name and password (when UAI$V_EXTAUTH is set).
|
UAI$_JTQUOTA
Returns the initial byte quota with which the jobwide logical name
table is to be created.
Because this quota is a longword decimal number, the buffer length
field in the item descriptor should specify 4 (bytes).
UAI$_LASTLOGIN_I
Returns, as a quadword absolute time value, the date of the last
interactive login.
UAI$_LASTLOGIN_N
Returns, as a quadword absolute time value, the date of the last
noninteractive login.
UAI$_LGICMD
Returns, as an OpenVMS RMS file specification, the name of the default
login command file.
Because a file specification can include up to 63 characters in
addition to a size-byte prefix, the buffer length field of the item
descriptor should specify 64 (bytes).
UAI$_LOCAL_ACCESS_P
Returns, as a 3-byte value, the range of times during which local
interactive access is permitted for primary days. Each bit set
represents a 1-hour period, from bit 0 as midnight to 1 a.m. to bit 23
as 11 p.m. to midnight. For each hour the bit is set to 0, access is
allowed. For each hour the bit is set to 1, access is denied.
The buffer length field in the item descriptor should specify 3 (bytes).
UAI$_LOCAL_ACCESS_S
Returns, as a 3-byte value, the range of times during which batch
access is permitted for secondary days. Each bit set represents a
1-hour period, from bit 0 as midnight to 1 a.m. to bit 23 as 11 p.m. to
midnight. For each hour the bit is set to 0, access is allowed. For
each hour the bit is set to 1, access is denied.
The buffer length field in the item descriptor should specify 3 (bytes).
UAI$_LOGFAILS
Returns the count of login failures.
Because this decimal number is a word in length, the buffer length
field in the item descriptor should specify 2 (bytes).
UAI$_MAXACCTJOBS
Returns the maximum number of batch, interactive, and detached
processes that can be active at one time for all users of the same
account. The value 0 represents an unlimited number.
Because this decimal number is a word in length, the buffer length
field in the item descriptor should specify 2 (bytes).
UAI$_MAXDETACH
Returns the detached process limit. A value of 0 represents an
unlimited number.
Because this decimal number is a word in length, the buffer length
field in the item descriptor should specify 2 (bytes).
UAI$_MAXJOBS
Returns the active process limit. A value of 0 represents an unlimited
number.
Because this decimal number is a word in length, the buffer length
field in the item descriptor should specify 2 (bytes).
UAI$_NETWORK_ACCESS_P
Returns, as a 3-byte value, the range of times during which network
access is permitted for primary days. Each bit set represents a 1-hour
period, from bit 0 as midnight to 1 a.m. to bit 23 as 11 p.m. to
midnight. For each hour the bit is set to 0, access is allowed. For
each hour the bit is set to 1, access is denied.
The buffer length field in the item descriptor should specify 3 (bytes).
UAI$_NETWORK_ACCESS_S
Returns, as a 3-byte value, the range of times during which network
access is permitted for secondary days. Each bit set represents a
1-hour period, from bit 0 as midnight to 1 a.m. to bit 23 as 11 p.m. to
midnight. For each hour the bit is set to 0, access is allowed. For
each hour the bit is set to 1, access is denied.
The buffer length field in the item descriptor should specify 3 (bytes).
UAI$_OWNER
Returns, as a character string, the name of the owner of the account.
Because the owner name can include up to 31 characters in addition to a
size-byte prefix, the buffer length field of the item descriptor should
specify 32 (bytes).
UAI$_PBYTLM
Returns the paged buffer I/O byte count limit.
Because the paged buffer I/O byte count limit is a longword decimal
number, the buffer length field in the item descriptor should specify 4
(bytes).
UAI$_PGFLQUOTA
Returns the paging file quota in blocks (on Alpha and Integrity server
systems).
Because the paging file quota is a longword decimal number, the buffer
length field in the item descriptor should specify 4 (bytes).
UAI$_PRCCNT
Returns the subprocess creation limit.
Because the subprocess creation limit is a longword decimal number, the
buffer length field in the item descriptor should specify 4 (bytes).
UAI$_PRI
Returns the default base priority in the range 0 through 31.
Because this decimal number is a byte in length, the buffer length
field in the item descriptor should specify 1 (byte).
UAI$_PRIMEDAYS
Returns, as a byte bit vector, the primary and secondary days of the
week.
Each bit represents a day of the week, with the bit clear representing
a primary day and the bit set representing a secondary day. The $UAIDEF
macro defines the following symbolic names for these bits:
UAI$V_MONDAY
UAI$V_TUESDAY
UAI$V_WEDNESDAY
UAI$V_THURSDAY
UAI$V_FRIDAY
UAI$V_SATURDAY
UAI$V_SUNDAY
UAI$_PRIV
Returns, as a quadword value, the names of the privileges the user
holds.
Because this value is a quadword in length, the buffer length field in
the item descriptor should specify 8 (bytes).
UAI$_PWD
Returns, as a quadword value, the hashed primary password of the user.
Because this value is a quadword in length, the buffer length field in
the item descriptor should specify 8 (bytes).
UAI$_PWD_DATE
Returns, as a quadword absolute time value, the date of the last
password change.
Because this value is a quadword in length, the buffer length field in
the item descriptor should specify 8 (bytes).
A value of --1 indicates that the password is marked as preexpired.
UAI$_PWD_LENGTH
Returns the minimum password length.
Because this decimal number is a byte in length, the buffer length
field in the item descriptor should specify 1 (byte).
UAI$_PWD_LIFETIME
Returns, as a quadword delta time value, the password lifetime.
Because this value is a quadword in length, the buffer length field in
the item descriptor should specify 8 (bytes).
A quadword of 0 means that none of the password mechanisms will take
effect.
UAI$_PWD2
Returns, as a quadword value, the hashed secondary password of the user.
Because this value is a quadword in length, the buffer length field in
the item descriptor should specify 8 (bytes).
UAI$_PWD2_DATE
Returns, as a quadword absolute time value, the last date the secondary
password was changed.
Because this value is a quadword in length, the buffer length field in
the item descriptor should specify 8 (bytes).
A value of --1 indicates that the password could be marked as
preexpired.
UAI$_QUEPRI
Returns the maximum job queue priority.
Because this decimal number is a byte in length, the buffer length
field in the item descriptor should specify 1 (byte).
UAI$_REMOTE_ACCESS_P
Returns, as a 3-byte value, the range of times during which remote
interactive access is permitted for primary days. Each bit set
represents a 1-hour period, from bit 0 as midnight to 1 a.m. to bit 23
as 11 p.m. to midnight.
The buffer length field in the item descriptor should specify 3 (bytes).
UAI$_REMOTE_ACCESS_S
Returns, as a 3-byte value, the range of times during which remote
interactive access is permitted for secondary days. Each bit set
represents a 1-hour period, from bit 0 as midnight to 1 a.m. to bit 23
as 11 p.m. to midnight.
The buffer length field in the item descriptor should specify 3 (bytes).
UAI$_SALT
Returns the random password salt.
Because this decimal number is a word in length, the buffer length
field in the item descriptor should specify 2 (bytes).
UAI$_SHRFILLM
Returns the shared file limit.
Because this decimal number is a word in length, the buffer length
field in the item descriptor should specify 2 (bytes).
UAI$_TQCNT
Returns the timer queue entry limit.
Because this decimal number is a word in length, the buffer length
field in the item descriptor should specify 2 (bytes).
UAI$_UIC
Returns, as a longword, the user identification code (UIC). For the
format of the UIC, see the HP OpenVMS Guide to System Security.
UAI$_USER_DATA
Returns up to 255 bytes of information from the user data area of the
system user authorization file (SYSUAF).
You can read information written to the user data area from previous
versions of the operating system as long as the information written
adheres to the guidelines described in the HP OpenVMS Guide to System Security.
UAI$_WSEXTENT
Returns the working set extent, in pagelets , for the user of the
specified queue or job.
Because the working set extent is a longword decimal number, the buffer
length field in the item descriptor should specify 4 (bytes).
UAI$_WSQUOTA
Returns the working set quota, in pagelets , for the specified user.
Because this quota is a longword decimal number, the buffer length
field in the item descriptor should specify 4 (bytes).
