Syntax and parameters for the CONSOLE statement

The syntax of the CONSOLE statement is as follows:
CONSOLE   DEVNUM  {(devnum)             }
                  {(SUBSYSTEM)          }
                  {(SYSCONS)            }
                  {(SMCS)               }
                  {(HMCS)      }
 
          UNIT  {(unittype)}
                {(PRT)     }
 
          NAME  (conname)
 
          AUTH  {(MASTER)           }
                {(INFO)             }
                {([SYS][,IO][,CONS])}
                {(ALL)              }
 
          USE  {(FC)}
               {(MS)}
               {(SD)}
 
          ROUTCODE  {(ALL)                   }
                    {(NONE)                  }
                    {(nnn[,nnn-nnn][,nnn]...)}
 
          LEVEL  {(ALL)                       }
                 {([ALL][,NB])                }
                 {([R][,I][,CE][,E][,IN][,NB])}
 
          CON  {(Y)}
               {(N)}
 
          SEG(nn)
 
          DEL  {(Y) }
               {(R) }
               {(RD)}
               {(N) }
               {(W) }
 
          RNUM  {(nn)}
                {(5) }
 
          RTME  {(nnn)}
                {(2)  }
 
          MFORM  {(M)              }
                 {([J][,S][,T][,X])}
 
          AREA  {(nn[,nn]...)}
                {(NONE)      }

          PFKTAB(tablname)
 
          MONITOR({JOBNAMES[-T]}{,SESS[-T]}{,STATUS})

          MSCOPE  {([sysname|*][,sysname|*]...)}
                  {(*ALL)                      }

          CMDSYS  {(sysname)}
                  {(*)      }
 
          RBUF  {(nn)}
                {(15)}
          AUTOACT  (groupname)
 
          SYSTEM  (sysname)
 
          LU  (nnnnnnnn)
 
          LOGON  {(REQUIRED)}
                 {(OPTIONAL)}
                 {(AUTO)    }
                 {(DEFAULT) }
          
          INTIDS{(Y)|(N)}

          UNKNIDS{(Y)|(N)}

          ALLOWCMD{(Y)|(N)}
          SUPSBY{(Y)|(N)}
          TIMEOUT(nn)
ALLOWCMD(Y)|(N)
Specifies when the system console is able to issue commands. ALLOWCMD is only valid when DEVNUM is SYSCONS. If there are no entries with DEVNUM(SYSCONS), the system uses the default ALLOWCMD(N) as part of the IBM-defined console attributes.
(N)
The system console is restricted from issuing commands until it enters PD mode. This is the default value.
(Y)
The system console is permitted to issue commands even if it is not running in problem determination (PD) mode.
AREA
Specifies the size of the out-of-line display area on the display console. nn is a decimal specifying the number of lines in one display area. The first number defines the bottom area of the screen. Subsequent numbers define areas working toward the top of the screen. The minimum number of lines in an area is 4. The maximum number of areas is 11. The sum of the lines in all of the areas must not exceed the screen size. No individual area can be larger than 99. You can separate multiple values with a blank or a comma.
AREA     {(nn[,nn]...)}
         {(NONE)      }
Restriction: AREA is not valid when UNIT is PRT, or DEVNUM is SYSCONS.
Default: For screen sizes and maximum and default values for AREA, see Table 1.
AUTH
Specifies the group of operator commands that can be entered from the console. IBM® strongly suggests using a security product, such as RACF®, to control commands instead of using AUTH, especially with SMCS. For more information about SMCS and console security see z/OS MVS Planning: Operations.
Restriction: AUTH is not valid with UNIT(PRT).

You can separate multiple values with a blank or a comma.

AUTH     {(MASTER)           }
         {(INFO)             }
         {([SYS][,IO][,CONS])}
         {(ALL)              }
From a console with master authority, you can enter all MVS™ operator commands. The corresponding authority levels for JES3 are:
  • CONS: JES3 authority level=10
  • I/O: JES3 authority level=10
  • INFO: JES3 authority level=0
  • MASTER: JES3 authority level=15
  • SYS: JES3 authority level=5
ALL
Information, system control, I/O control, and console control commands can be entered from this console.
INFO
Any informational commands can be entered from this console.
MASTER
Indicates that this is a console with master-level authority.
[SYS][,IO][,CONS]
CONS
Specifies that console control commands and informational commands can be entered from this console.
IO
Specifies that I/O control commands and informational commands can be entered from this console.
SYS
Specifies that system control commands and informational commands can be entered from this console.

For information about which commands can be entered from a console with a specific authority level, see z/OS MVS Planning: Operations.

Default: INFO is the default for all consoles except the system console, which is forced to be AUTH(MASTER).
AUTOACT (groupname)
Specifies the "automatic activate group" for the system console. It is only valid when DEVNUM(SYSCONS) is specified. If AUTOACT is specified, groupname is the name of a console group, as defined in CNGRPxx.
Value range: 1 to 8 alphanumeric or national (#, @, $) characters.
While the AUTOACT group is defined and not suspended:
  • The system console is automatically placed into PD mode when all of the consoles in AUTOACT are inactive.
  • The system console is automatically removed from PD mode when any console in the AUTOACT group becomes active.

To suspend AUTOACT processing, issue a VARY CN(*),ACTIVATE or DEACTIVATE command from the system console. This manual intervention overrides automatic processing until the opposite command is issued.

CMDSYS
Indicates the system (in the sysplex) where commands entered on this console are to be sent for processing. An asterisk (*) indicates that commands that are entered on this console are to be processed on the system where this console is defined.
CMDSYS     {(sysname)}
           {(*)      }

A value of * is recommended for SMCS consoles because the console is not tied to a system and the use of z/OS® Communication Server Generic Resources might place the console on different systems at different times.

Default: (*) An asterisk within parentheses.
CON
Indicates whether the console is to function in conversational or nonconversational mode.
CON     {(Y)}
        {(N)}
N
nonconversational mode; all messages that are selected for deletion are automatically deleted.
Y
Conversational mode; on this console you must verify all messages that are selected for message deletion with the cursor, or selector pen or through the CONTROL command.
Restriction: CON is not valid when UNIT is PRT, or DEVNUM is SYSCONS.
Default: N
DEL
Specifies the message deletion mode of the console.
DEL     {(Y) }
        {(R) }
        {(RD)}
        {(W) }
        {(N) }
N
Automatic message deletion is not in effect. Messages must be deleted manually.
R
Specifies roll mode. In roll mode, the system deletes a specified number of messages from the screen when an interval elapses. Deletion occurs only if the screen is full and messages are waiting to be displayed.
RD
Start of changeSpecifies roll mode except for messages awaiting actions (WTORs, system failure messages (descriptor code 1), immediate action messages (descriptor code 2), and critical eventual action messages (descriptor code 11)). These messages roll to the top of the screen and remain there until deleted.End of change
Start of changeWEnd of change
Start of changeSpecifies wrap mode. In wrap mode, after the screen is filled with messages, new messages overlay the old messages beginning at the top of the screen. A separator line appears and follows the most recent message on the screen. No messages are retained on the screen once overlaid by the separator line. The areas that were defined by the AREA keyword exist, but are unavailable until the console is put into a non-wrap mode.End of change
Y
All messages that are selected for deletion are deleted when the screen becomes full.
Restriction: DEL is not valid when UNIT is PRT or DEVNUM is SYSCONS.
Default: RD
CONSOLE
CONSOLE indicates the beginning of a statement that defines the characteristics of a console.
DEVNUM     {(devnum)    }
           {(SUBSYSTEM) }
           {(SYSCONS)   }
           {(SMCS)      }
           {(HMCS)      }
DEVNUM
Specifies the type of console. DEVNUM is required and must be the first keyword on the CONSOLE statement.
devnum
devnum must be the same as the number that was specified for the device on the Add Device panel in HCD.
Note: The system pins UCBs for console devices defined in CONSOLxx at IPL time, and the UCBs are only unpinned when a console definition is removed using the console removal definition service, which can be invoked using the IEARELCN sample program that resides in SYS1.SAMPLIB. To get a console device with HCD, an IPL is required, unless the console definition is deleted using the SETCON DELETE, CN= command or using IEARELCN.
Value range: 1 to 4 hexadecimal digits, optionally preceded by a slash (/).
HMCS
For an HMCS console, DEVNUM(HMCS) must be specified. DEVNUM(SMCS) is mutually exclusive with the UNIT and SYSTEM keywords.
SMCS
For an SMCS console, DEVNUM(SMCS) must be specified. DEVNUM(SMCS) is mutually exclusive with the UNIT and SYSTEM keywords.
SUBSYSTEM
Indicates that this console is reserved for subsystem use. The only keywords that are valid with the DEVNUM(SUBSYSTEM) setting are AUTH and NAME. A subsystem console can have MASTER authority, but it cannot be assigned at IPL. If this subsystem console has been specified with AUTH(Master) at IPL, the default value of the AUTH parameter is set to AUTH(ALL). Otherwise, the default is set to AUTH(INFO).
SYSCONS
Indicates that this console is the system console that is attached to this processor. The use of the SYSCONS keyword is optional. The first time that you put the system console into problem determination (PD) mode (by issuing VARY CN(*),ACTIVATE from the system console), its attributes are taken from the CONSOLE statement with DEVNUM(SYSCONS). If there is no such statement, a default set of attributes is used (see “System Console Defaults” below). The system console's attributes can be changed with the VARY CN command.

The SYSCONS is an extended MCS console. See z/OS MVS Planning: Operations for more information.

If AMRF(N) on the INIT statement is specified, then the DOM attribute for the SYSCONS extended MCS console is set to DOM(ALL) instead of DOM(NORMAL). If AMRF(Y) on the INIT statement is specified or defaulted, then the DOM attribute for the SYSCONS extended MCS console is set to DOM(NORMAL). For more information about the DOM attribute for extended MCS consoles, see z/OS MVS Planning: Operations.

If your MVS system is running as a guest on the z/VM* system, and the VM system is at release level 1.1.1 or later, VM simulates the system console hardware regardless of the processor type.

System console defaults: The system console receives the normal default values for the keywords that are valid with DEVNUM (SYSCONS), except for the following keywords:
  • NAME. The system generates a name for the system console. (For more information, see the description of the NAME keyword.)
  • AUTH. The system console is always forced to have MASTER authority.
  • MSCOPE. The system console default is MSCOPE(*).
  • LEVEL. The system console default is ALL,NB.
Note: The only keywords that are valid with DEVNUM(SYSCONS) are NAME, ROUTCODE, LEVEL, MONITOR, MSCOPE, AUTOACT, CMDSYS, INTIDS, UNKNIDS, and ALLOWCMD. All others are ignored.

For more information about using SMCS, devices or emulators that can be used with SMCS, and HMCS, see z/OS MVS Planning: Operations.

LOGON {(REQUIRED)}
      {(OPTIONAL)}
      {(AUTO)}
      {(DEFAULT)}

You can use this optional parameter to override the LOGON value that is specified on the DEFAULT statement (if any). The system treats the system console as LOGON(OPTIONAL) no matter what LOGON value is specified on the DEFAULT statement.

IBM suggests that SMCS consoles be LOGON(REQUIRED), either by the system-wide specification on the DEFAULT statement or by the individual CONSOLE statement.

If a TIMEOUT value is specified for the console and an operator has logged on with a user ID, the system automatically logs the user ID off after the number of minutes specified in TIMEOUT has occurred without any console input activity. An example of console input activity is pressing an attention-generating key such as Enter, PFK, PA1, or PA2.

(REQUIRED) specifies that an operator must log on to a console before issuing commands from that console. For MCS consoles, commands can be issued without the operator logging on under the following condition:
  • When issuing commands from a console with master authority before a security product is active.

If an operator is not logged on to the console, the system rejects commands that are issued from that console.

(OPTIONAL) specifies that the operators can optionally log on to the console.
Note: If an operator has not logged on to the console, commands are passed to the security product indicating an operator ID of *BYPASS* .

(AUTO) specifies this console is automatically logged on when the console is activated. The user ID is the console name. If a TIMEOUT value is specified for this console, it is ignored when the user ID matches the console name.

(DEFAULT) specifies that this console uses the LOGON specification on the DEFAULT statement.

Default: DEFAULT, unless the console is an SMCS console that does not specify the LU keyword, in which case the default is REQUIRED.
INTIDS
This optional keyword indicates whether the specified console receives messages that are directed to console ID zero.
(N)
The specified console is not to receive these messages.
(Y)
The specified console is to receive these messages.
Default: N
LEVEL
LEVEL specifies the message levels for the console.
LEVEL     {(ALL)                  }
          {([ALL][,NB])           }
          {([R][,I][,CE][,E][,IN])}
ALL
Indicates that the console is to receive all messages.
CE
This console is to receive critical eventual action messages.
E
This console is to receive eventual action messages.
I
This console is to receive immediate action messages.
IN
This console is to receive informational messages.
NB
This console is to receive no broadcast messages.
R
This console is to receive the messages that require an operator reply.
To receive all message levels but broadcast messages, specify the following; you can separate multiple values with a space or a comma.
LEVEL (R,I,CE,E,IN)
Default: (except for the system console, which defaults to LEVEL(ALL,NB)).
LU (nnnnnnnn)
This keyword defines the logical unit that can only use this console. The LU keyword is optional, but is only be specified with DEVNUM(SMCS). If LU is specified, the console can only be activated at that LU, and no other console can be activated with that LU. For more information, see z/OS MVS Planning: Operations.
Value range: nnnnnnnn is a character value from 1 to 8 characters. The first character of nnnnnnnn must begin with the letters A through Z or with a #,@,$; the remaining characters can be A through Z, 0 through 9, or #,@, or $.
MFORM
MFORM specifies the display format of the messages.
MFORM     {(M)              }
          {([J][,S][,T][,X])}

M indicates that the system is to display the message text only. The message display does not include timestamp, job ID, or job name information, or the system name. M is the default.

J specifies that the display is to include the job ID or name.

S specifies that the display is to include the name of the system originating the message.

T specifies that the display is to include a timestamp.

X specifies that the system suppress the job name and system name for JES3 messages that are issued from the global processor.

Notes:
  1. The MFORM keyword is ignored if specified with DEVNUM(SYSCONS).
  2. You can separate multiple values with a blank or a comma.
Default: M
MONITOR({JOBNAMES[-T]}{,SESS[-T]}{,STATUS})
MONITOR is an optional keyword that allows you to have the system report on selected events. You can specify one or more parameter options for MONITOR; you can separate multiple values with a blank or a comma:
MONITOR(JOBNAMES-T,SESS-T,STATUS)
JOBNAMES
specifies that the system is to display the names of jobs when they start and end. The system also displays input/output device allocation at the start of a job step and includes the job name in a diagnostic message if the job ends abnormally.
SESS
Specifies that the system is to display the user ID for each TSO/E session when the session starts and ends. The system also includes the user ID in a diagnostic message if a session ends abnormally.
-T
Specifies that the system is to display the time with the job name or the user ID. Code -T with the JOBNAMES or the SESS parameter. The time is displayed in hh:mm:ss format. When specified, -T is activated for all consoles that have MONITOR turned on.
STATUS
Specifies that the system is to display the names and volume serial numbers of data sets having dispositions of KEEP, CATLG, or UNCATLG whenever these data sets are freed.
Default: If you do not specify the MONITOR keyword (and a valid parameter or combination of parameters), the system does not monitor any job names, TSO/E users, or data sets.
MSCOPE
Allows you to specify those systems in the sysplex from which this console is to receive messages that are not explicitly routed to this console. An asterisk (*) indicates the system on which this CONSOLE statement is defined. You can separate multiple values with a blank or a comma.
MSCOPE     {(sysname|*[,sysname]...)}
           {(*ALL)                  }

*ALL indicates that unsolicited messages from all systems in the sysplex are to be received by this console.

Default: *ALL is the default for all consoles except the system console, which defaults to *.
NAME(conname)
Specifies the console name that uniquely identifies the console. The console name is required on all consoles except for the system console. Any values you specify for the NAME parameter (names identifying the console) must be unique across the sysplex.
Attention: If you do not specify NAME for a console, the console definition is rejected with an error message. The only exception to this rule is the system console.
Value range: conname is from 2 to 8 characters. The first character of conname must begin with the letters A through Z or with a #, $, or @; the remaining characters can be A through Z, 0 through 9, or #, $, or @.

To make the same console available to different systems in a sysplex, you must specify the same value for the NAME parameter on the CONSOLE statement in each system's CONSOLxx parmlib member.

Do not specify a console name that could be confused with a device number. For example, do not use a console name like BEAD, since it can be confused with device number x'BEAD'.

Do not use HC, INSTREAM, INTERNAL, SYSIOSRS, UNKNOWN, OPERLOG, SYSLOG, LOGON, or LOGOFF for conname; these names are reserved for the system.

Naming the system console: IBM strongly suggests that you specify a name for the system console in CONSOLxx. Select a unique name for the system console that cannot be confused with a valid device number.
Default: If your operator specifies CON=NONE, or if you do not name the system console in CONSOLxx, MVS tries to use the name of the system to which the console is attached as the name of the system console, as long as that name is unique and cannot be confused with a device number that the system can use. If you do not name the system console in CONSOLxx, use a system name that cannot be confused with a device number that the system can use.

If you specify a system name that the system can interpret as a valid device number, the system does not use SYSNAME as the name of the system console. If the system cannot use SYSNAME for the system console name, or if the system console name is not unique, the name of the system console is SYSCNxxx, where xxx is a three-character suffix generated by the system.

If you try to define a console whose name is the same as an existing console, the system rejects the definition.

PFKTAB (tablname)
PFKTAB specifies the name of the table that defines the Program Function Key (PFK) definitions.
tablname
The 1-8 alphanumeric name for the table. It must be the same as one defined in a PFKTABxx parmlib member. The PFKTABxx member must be active, that is, identified in the PFK parameter on the INIT statement in CONSOLxx.

For more information about PFK tables, see PFKTABxx (program function key table definition).

Note: PFKTAB is not valid when UNIT is PRT or DEVNUM is SYSCONS.
Default: If you do not specify a valid PFK table, the system uses the IBM-supplied default PFK definitions that are described in z/OS MVS System Commands.
RBUF(nn)
Specifies the number of previously entered commands that can be retrieved on this console by pressing the PA1 key. Set RBUF to a value greater than 1 to allow the operator to retrieve multiple commands, without having to retype each command. For example, to allow the operator to retrieve the last five commands that are entered on this console, specify RBUF(5).
Commands are retrieved as they were entered on the console. That is, commands entered with delimiters (or “stacked commands”) are treated as a single command. For example, when RBUF(2) is specified, and the previously entered commands were:
    'D T'   followed by    'D C;D R;K E,D'
  • Pressing the PA1 key once retrieves: ‘D C;D R;K E,D’
  • Pressing the PA1 key a second time retrieves: ‘D T’

Commands that are entered through PF keys cannot be retrieved, unless the keys are in conversational mode (CON=Y).

Any commands entered through PF keys are retrieved only in case of RBUF(1), even if the keys are in non-conversational mode (CON=N).

Value range: nn is a decimal value from 1 to 15. If you specify a value that is not between 1 to 15, an error message is issued and the console defaults to RBUF(15).
Default: 15 (The last 15 commands entered can be retrieved).
RNUM(nn)
RNUM specifies the maximum number of lines included in one message roll.
Value range: nn is a decimal value. The minimum is 1; the maximum is 99 or the number of lines in the message area, whichever is smaller.
Note: RNUM is not valid when UNIT is PRT or DEVNUM is SYSCONS.
Default: The default value for all unit types is 5 lines or the number of lines in the message area, whichever is smaller.
ROUTCODE
Specifies the routing codes that are assigned to the console.
ROUTCODE     {(ALL)                   }
             {(NONE)                  }
             {(nnn[,nnn-nnn][,nnn]...)}
Value range: ALL specifies all routing codes, 1 through 128. nnn specifies a decimal value from 1 through 128. nnn-nnn specifies a range of decimal value with the lower value first. You can separate multiple values with a space or a comma.

Do not assign routing code 11 to a console, because it is meant for programmer information rather than operator information.

Default: NONE is the default for all consoles.
RTME (seconds)
Specifies the number of seconds between message rolls or wraps.
Value range: nnn is an integer value from 1 to 999 or the fractions 1/2 or 1/4 (for example, RTME(1/2)).
  1. RTME is not valid when UNIT is PRT or DEVNUM is SYSCONS.
  2. Do not use the values 1/2 or 1/4 for a 3290 device.
Default: The default value for all unit types is 2 seconds.
SEG(nn)
SEG specifies the number of lines in the message area that can be deleted when the CONTROL E, SEG command is entered.
Value range: nn is a decimal value. The minimum is 1; the maximum is 99 or the number of lines in the message area, whichever is smaller.
Restriction: SEG is not valid when UNIT is PRT, or DEVNUM is SYSCONS.
Default: Default values for SEG are shown in Table 1.
SUPSBY
SUPSBY indicates whether the console supports standby mode or not. It is valid only with DEVNUM.
(N)
The system console does not support standby mode.
(Y)
The console supports standby mode.
Default: N
SYSTEM (sysname)
Specifies the system you expect the console to be attached to and activated on.

The SYSTEM keyword is mutually exclusive with DEVNUM(SMCS) and DEVNUM(HMCS).

Default: None.
Note: It is possible that a device is not ready (not turned on) when the system (or sysplex) is being initialized. The device might even be attached to another system as the sysplex is initialized (for example, during an error recovery situation). When you decide to use the device, first turn it on or reattach it to the proper system, then issue a VARY CN,ONLINE command for the console.

This parameter is primarily used for consoles which are physically attached to multiple systems and managed by a physical switch. In this case, the SYSTEM parameter determines which system should attempt to activate the console. You cannot define multiple CONSOLE statements with the same DEVNUM and specify a different SYSTEM on each statement. Only the first statement is processed, and an error message is issued if additional statements exist.

TIMEOUT(nn)
TIMEOUT specifies the length of time before users are automatically logged off from a console due to inactivity.
Value range: nn can be any value between 1 (meaning the user is automatically logged off after 1+ minutes of inactivity) to 99 (meaning the user is logged off after 99+ minutes of inactivity), or 0 (meaning the user is never automatically logged off due to inactivity). Actual logging off occurs between nn <= inactivity < nn+1 minutes.
Default: The default value is 0, which indicates that users are not automatically logged off after any period of inactivity.
UNIT
UNIT specifies the unit type of the console. The unit type must be a valid console device that is listed here. See Table 1 for the devices that can be used as MCS consoles.
UNIT     {(3270-X)}
         {(3277-2)}
         {(3278-2)}
         {(3278-2A)}
         {(3278-3)}
         {(3278-4)}
         {(3279-2A)}
         {(3279-2B)}
         {(3279-2C)}
         {(3279-3A)}
         {(3279-3B)}
         {(PRT)   }
PRT

Specifies that the console is a printer. The Add Device panel in HCD must specify a valid device type that can be defined as a printer.

Default: If you do not code the UNIT keyword, the system uses the information entered through HCD for the device number to determine the unit type. If the HCD information indicates that it is a display device, the system defaults the UNIT value to 3270-X.
Note:
  1. Specify 3270-X for devices that meet the following criteria:
    • The device supports the 3270 data stream and Read Partition Query (such as a 3471 or 3472 IBM InfoWindow terminal).
    • The device is attached to a control unit that supports Read Partition Query (should Read Partition Query fail, MCS attempts to bring the device online with 3277-2 display attributes).
  2. This keyword is mutually exclusive with DEVNUM(SMCS) and DEVNUM(HMCS). SMCS and HMCS always determines the type of device that is being used.
UNKNIDS
This optional keyword indicates whether the specified console receives messages that are directed to "unknown" console IDs. Messages that are issued to a now unresolvable 1-byte console ID are delivered to consoles receiving UNKNIDS.
(N)
The specified console is not to receive these messages. This is the default value.
(Y)
The specified console is to receive these messages.
USE {(FC) | (MS) | (SD)}
USE specifies how the display console is used.
(FC)
Defines a full-capability console able to enter commands and receive status displays and messages. If the console is a display device, specify USE(FC).
(MS)
Defines a message stream console. If the console is a printer, specify USE(MS).
(SD)
Defines a status display console.
Notes:
  1. The USE keyword is ignored if specified with DEVNUM(SYSCONS).
  2. SMCS and HMCS do not support USE(MS) or USE(SD) consoles. Only USE(FC) is accepted for an SCMS or HMCS console.
Default: If you do not specify USE, FC is the default if the console is a display device and MS is the default if the console is a printer.