XAUTOLOG

Notes:

¹ The PASSWORD, PROMPT, and ON operands are valid only for a Class A or Class B user.
² The password operand is not accepted if password suppression is active.

Authorization

Privilege Class: A, B, G

Purpose

Use XAUTOLOG to log on another user virtual machine automatically.

Note: If you have Class G privileges only, the other user must have the appropriate XAUTOLOG statement in their system directory. If you have Class A or Class B privileges, and are not specifying a password, you are automatically authorized to log that virtual machine on.

Operands

userid

identifies the virtual machine you are logging on.

Ipl vdev

Ipl sysname

specifies the virtual device number or named saved system that you want IPLed after logon processing. This option overrides the IPL (if any) specified in the user's entry in the system directory.

If SYNCH is not specified, the IPL command processor determines whether the IPL operand is valid after the logon is completed; it is not verified as part of LOGON or XAUTOLOG processing.

If SYNCH is specified with IPL, the IPL operand is checked for validity before control returns to the XAUTOLOG command issuer.

The IPL command processor determines whether the IPL operand is valid after the logon is completed; it is not verified as part of logon processing.

NOIpl

means that the IPL device specified in the user's entry in the system directory should not be used for an automatic IPL.

ACcount nnnnnnnn

specifies an alternate account number to be assigned to the user's virtual machine at logon. This account number must be valid in order for the logon to complete successfully. If you do not specify this option, the primary (or first) account number specified in the user's entry in the system directory is used.

MACHine ESA

MACHine XA

MACHine XC

MACHine Z

specifies the mode (architecture) of the virtual machine. This option overrides the machine statement (if any) specified in the user's entry in the system directory. For further information on the MACHINE directory statement, see z/VM: CP Planning and Administration.

ESA designates ESA/390 (31-bit) architecture. A guest operating system can switch between ESA/390 and z/Architecture® (64-bit) mode. XA is supported for compatibility and is functionally equivalent to ESA. XC designates ESA/XC architecture. A guest operating system can switch between ESA/XC and z/XC mode. Z designates a machine that executes only in z/Architecture mode.

See usage note 21.

Storage nu

specifies an alternate storage size to be assigned to the virtual machine. The storage size is specified in the form nu, where n is a 1- to 8-digit decimal number and u is the 1-character storage unit suffix:

Table 1. Maximum Input Values for Storage Units
Storage unit suffix(u)	Maximum input value(n)
K - kilobytes	99999999
M - megabytes	99999999
G - gigabytes	99999999
T - terabytes	16777216
P - petabytes	16384
E - exabytes	16

Notes:

A K specification is rounded up to a MB value.
The maximum input value of 99999999 for the K, M, or G suffix is not a size limit but the physical limit of the operand (8 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.
The value you specify for this option must be valid in order for the logon to be completed successfully. If you do not specify a value, the storage size defined in the user directory entry for the virtual machine is used. The maximum allowed value is the maximum storage size defined in the user directory entry for the virtual machine. The maximum cannot exceed a processor-specific limit imposed at run time.

PASSword password

is userid's logon password. The ability to specify the password is available only to Class A or Class B users. Class A or Class B users are authorized to automatically log on any virtual machine without specifying a password, but this PASSWORD option is available when password verification is desired.

To determine whether password suppression is active for this command, use the QUERY PASSWORD XAUTOLOG command. If password suppression is active, you cannot specify a password on the command line. If you want to specify a password for the XAUTOLOG operation, use the PROMPT operand.

PRompt

specifies that you should be prompted for the password at the terminal. If password suppression is active for this command, you must specify PROMPT in order to use password authorization when entering the command at the terminal. The ability to specify PROMPT is available only to Class A or Class B users.

DIRectory

indicates that the user's entry in the system directory must contain an XAUTOLOG statement to authorize you to log on the virtual machine if you do not have Class A or Class B privileges.

SYNch

indicates that the command is to be run synchronously. CP returns control to the issuer of the XAUTOLOG command when the target user ID is logged on and IPL command is validated (if an automatic IPL is performed). Unless NOIPL is specified, there must be an IPL statement in the target user ID's directory entry or the IPL parameter must be specified on the XAUTOLOG command. (Note: If NOIPL is specified, CP returns control when the target user ID is logged on.)

If SYNCH is not specified, the XAUTOLOG command runs asynchronously, and CP returns control after a logon is scheduled. The XAUTOLOG command issuer receives a message when the target user is logged on. For asynchronous execution, no IPL statement or parameter is required.

ON rdev

specifies the real device number of a local 3270 device that is to be used as the console of the virtual machine. The ON option is available only to Class A or Class B users.

ON ldev

specifies the logical device number of the device that is to be used as the console of the virtual machine. Specify a logical device number as an "L" followed by up to four hexadecimal digits. Leading zeros may be omitted. The ON option is available only to Class A or Class B users.

CMD console_input_data

specifies the data that you want used as virtual console input in response to the first read issued by the user's virtual machine. You may use the remainder of the command line to enter console data.

Note: This option differs from #console_input_data in that logical line-end characters are not honored. Because of this, only one command can be sent. This option is intended to be used when the XAUTOLOG command is issued with the AT command to a remote member of the SSI cluster. It can also be used if the user being logged on is on the same system, with or without the AT command.

#console_input_data

is data that you want used as virtual console input in response to the first read issued by the user's virtual machine. You may use the remainder of the command line to enter console data; the entire line including any logical line-end characters (#) is passed to the virtual machine.

Note: # refers to the whatever logical line-end character is currently in effect for the virtual machine in which the XAUTOLOG command is being used.

If you are using CMS and you specify #console_input_data with the logical line-end character (#) on the command line, CMS truncates the XAUTOLOG command at the first logical line-end character. To prevent this, enter a logical escape character before the logical line-end character, or enter #CP, where # is your logical line-end character, before the XAUTOLOG command itself.

Usage Notes

XAUTOLOG was a synonym for the AUTOLOG command. It was provided to ease future migration for those who wanted to use the extended options of the z/VM® XAUTOLOG command.
A virtual machine is allowed to be logged on with XAUTOLOG even though the number of users already logged on is equal to or greater than the maximum allowed by the MAXUSERS operand of the FEATURES system configuration statement or by the SET MAXUSERS command if the user directory for the virtual machine was created using the IGNMAXU operand of the OPTION directory statement.
If neither IPL nor NOIPL is specified, the virtual machine that you log on using the XAUTOLOG command must have an IPL statement in its system directory entry unless it is a CF Service Machine (has OPTION CFVM in the directory).
Unless NOIPL is specified, an automatic IPL is scheduled. If the IPL statement is not valid, you receive a message and userid is forced off the system.
Authorization to log on a user through the XAUTOLOG command is granted:
- If you have Class A or Class B command privileges and you specify or default to the DIRECTORY option
- If you have Class A or Class B command privileges and you specify a correct password in response to a prompt or through the PASSWORD option
- If you have Class G (and not Class A or Class B) command privileges and your user ID appears in the XAUTOLOG directory statement belonging to the virtual machine that you want to XAUTOLOG.
Users with a password of NOLOG in their directory entries cannot be logged on by the XAUTOLOG command. For a complete description of the XAUTOLOG directory statement, see z/VM: CP Planning and Administration.
If you do not specify the ON option, the virtual machine that you log on using the XAUTOLOG command operates in disconnect mode. The same restraints that apply to any disconnected machine also apply to virtual machines that are logged on with the XAUTOLOG command.
If you are using CMS and specify #console_input_data on the XAUTOLOG command line, CMS interprets the input line as two separate commands because of the logical line-end character (#). You can avoid this situation by turning off line editing, by preceding the logical line-end character with a logical escape character, or by preceding the XAUTOLOG command line with #CP, where # is your logical line-end character.
If the user ID you specify has a secondary user ID specified on the CONSOLE statement in its directory entry, messages from CP (and from the virtual machine if automatic IPL takes place) are routed to the secondary user if that user is logged on and not disconnected. If your user ID (XAUTOLOG issuer) is the designated secondary user ID and you are not running in disconnect mode, you receive messages resulting from the LOGON of the target user.
If your installation is using the password suppression facility for this command (controlled by the PASSWORDS_ON_CMDs operand of the FEATURES system configuration statement or by the SET PASSWORD command) and you want to use password authorization, you should enter the PROMPT parameter on the XAUTOLOG command line. Wait for the ENTER PASSWORD prompt before you type in the password. For system security, the password is automatically masked.
CP disables the XAUTOLOG and AUTOLOG commands for the rest of a user's log on session if a user enters excessive incorrect passwords to logon another user ID automatically. The initial system limit depends on how the JOURNALING system configuration statement is coded. Use the QUERY CMDLIMIT command to see the system limit value set by your installation. See z/VM: CP Programming Services for special considerations when issuing XAUTOLOG through the simulated virtual console interface (DIAGNOSE X'08').
If SYNCH is specified and an automatic IPL is scheduled but IPL processing is unsuccessful, you receive a message and the user ID is forced off the system.
If an external security manager (ESM) is installed on your system, you might not be authorized to use this command or you might not be authorized to use the ON operand for this command. For additional information, contact your security administrator.
There is no password authorization for an XAUTOLOG of a userid defined with the NOPASS operand, unless an ESM is installed. When an ESM is installed, password authorization may be required despite the NOPASS operand. Refer to documentation provided by your ESM for more information.
CP typically presents console_input_data to CMS through an interruption sequence before a CMS program has requested a console read. CMS places the #console_input_data into its terminal input queue in anticipation of some subsequent request to read from the console. This subsequent request is usually the PARSE EXTERNAL instruction in the SYSPROF EXEC, unless the SYSPROF EXEC is bypassed or the AUTOCR parameter was used at IPL time. The EXTERNALS() VM REXX built-in function can be used to test for the existence of console_input_data before the PARSE EXTERNAL is issued.
Users defined with the LBYONLY operand in the password field of their USER or IDENTITY statement in the system directory may be restricted from performing functions that require password validation. When an ESM is not installed, users defined with the LBYONLY operand cannot be logged on by the XAUTOLOG command if password validation is required. When an ESM is installed, refer to the documentation provided by your ESM for more information.
Refer to the USER Directory Statement or IDENTITY Directory Statement in z/VM: CP Planning and Administration for more details on the LBYONLY operand.
CP does not support System/370 architecture (370 mode) virtual machines. If a LOGON is attempted for a virtual machine whose directory entry specifies 370 mode, the XAUTOLOG command will be completed, but the virtual machine will be set to XA mode instead of 370 mode. Message HCP1512E is issued to inform the user.
If an XAUTOLOG is attempted for a virtual machine whose directory entry specifies z/Architecture-only mode, but the relocation domain does not support that mode, the XAUTOLOG command is completed, the virtual machine is set to ESA mode instead, and message HCP1512E is issued to inform the user.
If the ON option is specified, the designated real or logical device must exist and must be enabled.
If the ON option is specified and the virtual machine is already logged on, it will be reconnected on the designated device if it is disconnected or it will be disconnected from its current console device and reconnected on the designated device.
If the AT command is used to issue XAUTOLOG on a remote member of an SSI cluster, the PROMPT option is not allowed. If it is specified in this case, message HCP1516E is issued and the command is rejected.
An ESA (or XA) virtual machine will be put into either full ESA/390 mode or ESA/390 compatibility mode, depending on the level of ESA/390 capability available in the machine where the virtual machine is logged on or in the virtual machine's relocation domain. ESA/390 compatibility mode allows a subset of ESA/390 functionality sufficient for CMS and GCS, but lacks advanced functions like dynamic address translation (DAT). For details on ESA/390 compatibility mode, see z/Architecture Principles of Operation.

Responses

Response 1:

ENTER PASSWORD:

is the response to the PROMPT parameter. Enter the password of the user ID you want to XAUTOLOG.

Response 2:

Command accepted

indicates that the command syntax is correct.

This response appears if SYNCH is not specified and the command line syntax is accepted. This response means that the logon has been scheduled and VM has returned control to you. More information about the logon and IPL arrives later.

If the SYNCH parameter is specified, the COMMAND ACCEPTED response does not appear. All processing concerning the automatic logon is completed before VM returns control to you.

If an error occurs in trying to autolog the specified user, you receive an error message.

Response 3:

AUTO LOGON  ***       userid USERS = nnnnn

is the response XAUTOLOG sends to the issuer of the command when that person is not the system operator. This response is generated by successful command completion.

***: indicates there is no assigned line address for the virtual console.
userid: identifies the virtual machine initiated by XAUTOLOG.
USERS = nnnnn: is the number of logged-on users.

Response 4:

hh:mm:ss AUTO LOGON  ***       userid USERS = nnnnn BY {SYSTEM }
                                                       {userid2}

is the response XAUTOLOG sends to the system operator when the command completes successfully.

***: indicates there is no assigned line address for the virtual console.
userid: identifies the virtual machine initiated by XAUTOLOG.
USERS = nnnnn: is the number of logged-on users.
SYSTEM: indicates that the XAUTOLOG process has occurred as part of VM system initialization. Typically, your primary system operator's virtual machine is logged on as part of the system initialization process.
userid2: identifies the user issuing the XAUTOLOG command.

Response 5:

hh:mm:ss USER DSC LOGOFF AS userid USERS = nnnnn FORCED

is the response to the system operator upon failure of the IPL for the user specified on the XAUTOLOG command. The system operator receives this response only if SYNCH is specified and an automatic IPL was scheduled for the userid.

DSC: indicates that the user you autologged is operating in disconnect mode.
userid: identifies the virtual machine initiated by the XAUTOLOG command.
USERS = nnnnn: is the number of logged-on users.

Response 6:

USER  DSC  LOGOFF AS  userid USERS = nnnnn FORCED

is the response to the system operator if a not valid IPL statement is processed for the user specified in the XAUTOLOG command. The system operator receives this response only if an automatic IPL was scheduled for the user ID.

userid: identifies the virtual machine initiated by XAUTOLOG.
USERS = nnnnn: is the number of logged-on users.

Response 7:

AUTO LOGON type {rdev} userid USERS = nnnnn
                {ldev}

is the response to the issuer of the command when that person is not the system operator and when the ON option of the XAUTOLOG command is specified.

type: is the display type.
rdev
ldev: is the real or logical device number where the user was logged on or reconnected.
userid: identifies the virtual machine initiated by XAUTOLOG.
USERS = nnnnn: is the number of logged-on users.

Response 8:

hh:mm:ss type {rdev} {AUTOLOGON} userid USERS = nnnnn BY userid2
              {ldev} {RECONNECT}

is the response to the system operator when an XAUTOLOG command with the ON option specified completes successfully.

type: is the display type.
rdev
ldev: is the real or logical device number where the user was logged on or reconnected.
userid: identifies the virtual machine initiated by XAUTOLOG.
USERS = nnnnn: is the number of logged-on users.
userid2: identifies the user issuing the XAUTOLOG command.

Messages

HCP003E Invalid option - {option|command contains extra option(s) starting with option}
HCP005E Invalid hexdata - <hexdata>
HCP006E Invalid device type - <rdev | ldev>
HCP013E Conflicting option - option
HCP020E Userid missing or invalid
HCP021E A real device number was not supplied or it is invalid
HCP025E Storage missing or invalid
HCP040E Device <rdev | ldev> does not exist
HCP046E GRAF <rdev | ldev> is offline
HCP049E GRAF <rdev | ldev> in use
HCP051E GRAF <rdev | ldev> is not enabled
HCP052E [XAUTOLOG failed for userid:] Error in CP directory
HCP053E value not in CP directory [XAUTOLOG failed for userid:] userid not in CP directory
HCP054E [XAUTOLOG failed for userid:] Already logged on {line vdev|GRAF vdev |LUNAME vdev|device vdev|LDEV vdev| disconnected|SYSTEM sysname|SYSC}
HCP059E {XAUTOLOG|AUTOLOG} failed for userid - {IPL missing|IPL failed|accounting errors|incorrect password}
HCP093E Storage size requested reqsize exceeds maximum allowed on this processor maxsize. Size set to maximum allowed.
HCP115E {LINK|AUTOLOG|XAUTOLOG} invalid; excessive incorrect passwords
HCP145I User userid at rdev issued an AUTOLOG command specifying userid userid with an invalid password nnn times. The limit is limit.
HCP205I The virtual=real area is not available because it was not generated.
HCP266E An account number was not supplied or is invalid.
HCP361E [XAUTOLOG failed for userid:] LOGOFF/FORCE pending for user userid
HCP475I Fatal I/O error trying to read directory from volid [for user userid]
HCP780E [XAUTOLOG failed for userid:] Maximum password attempts exceeded, try again later.
HCP1001E An operand is missing for option.
HCP1100E A logical device number was not supplied or it is invalid
HCP1472I One or more directory COMMAND statements were found for the CFVM user and were discarded. Directory COMMAND statements are not allowed for CFVM users.
HCP1502E [XAUTOLOG failed for userid:] The directory entry for this userid is in use.
HCP1509E You are not authorized to issue XAUTOLOG with the PASSWORD, PROMPT, or ON options.
HCP1512E The System/370 machine mode was requested, but CP does not support System/370 mode virtual machines; the machine mode will be set to XA instead.
HCP1512E The z/Architecture-only machine mode was requested, but is not supported in this relocation domain. The machine mode will be set to ESA instead.
HCP1513E [XAUTOLOG failed for userid:] A logon is already in progress [on {type rdevltype idevliuname|SYSC}]
HCP1516E XAUTOLOG failed: The PROMPT option cannot be specified with the AT command.
HCP6050E Your userid is not authorized to automatically logon userid userid
HCP6052E XAUTOLOG command rejected; command format not valid.
HCP6054E XAUTOLOG failed for userid: Explanatory message to follow.
HCP6525E External Security Manager is unavailable.
HCP6056I XAUTOLOG information for userid: The IPL command is verified by the IPL command processor.
HCP6525E Authorization request failed.