Quick Reference

Startup Parameters in Alphabetical Order

The startup parameter descriptions are listed in alphabetical order by their names.

Notes:

  1. Elements in italics (e.g. name) denote a variable that must be replaced by a real value, for example, a name.

This document covers the following startup parameters:

ADA5SVC

Type Default
Required. None

The Adabas SVC number to be used. The Adabas SVC is used to perform various internal functions, including communication between the Natural program and the Entire System Server nucleus in multi-user mode.

Note
This parameter is also valid for all Adabas versions.

APPC-LUNAME

Type Default Maximum Value Length
Optional NPRLU01 8 bytes

The name of the APPC/MVS LU to be used for the transaction program invoked by the SYSTEM-COMMAND view processor to execute TSO/E commands.

APPC-MODENAME

Type Default Maximum Value Length
Optional APPCHOST 8 bytes

The name of the default logon mode name to be used with the APPC/MVS transaction program invoked by the SYSTEM-COMMAND view processor to execute TSO/E commands.

APPC-TPNAME

Type Default Maximum Value Length
Optional SAG.NPRvrs.XCOMTP46 64 bytes

The name of the APPC/MVS transaction program to be invoked by the SYSTEM-COMMAND view processor to execute TSO/E commands.

AUTOLOG

Type Default
Optional YES

Specifies automatic logon to the Entire System Server at the start of the Natural session. Possible options:

Option Explanation
YES No password check is done as part of the Entire System Server logon, as long as the specified user ID matches the internal Natural user ID. An implicit logon is performed if the first user request is not a logon call.
NO No logon to the Entire System Server is performed at the start of the Natural session, but note that if an external security system is installed, a logon to the Entire System Server including user ID and password is always required.

The usage of the AUTOLOG parameter depends on the network environment. If there is no Net-Work installed, the autolog feature should be used to avoid additional logon procedures if the password check has already been done as part of the TP or Natural logon.

In a Net-Work environment, the usage of AUTOLOG depends on the defined Net-Work nodes. If only mainframes are connected, we recommend using the autolog feature. In environments with PCs connected to Net-Work, Entire System Server should run without autolog (AUTOLOG=NO).

CDATALEN

Type Default
Optional 0

The maximum size (in K bytes) of the common data pool. A value greater than 0 must be specified if the view COMMON-DATA is to be used.

COMPLETE

Type Default
Optional NO

Specifies whether Com-plete is installed on the system.

CONSNAME

Type Default
Optional is the string ESYnnnnn, where nnnnn is the node number of this Entire System Server.

This parameter indicates the name for your logical console in an MCS environment. If you have 2 different Entire System Servers running on the same SYSPLEX system with the same node number, you may choose your own name for your console in this case.

CONSTAB

Type Default
Optional 1000 messages.

nnn is the number of messages to be kept. This parameter has been valid since MVS/ESA 5.1. A wraparound table for z/OS console messages is generated. The number of slots for this table can be defined here.

CONSTAB=0 will switch off the reading of console messages which is done in the background.

DEFNATSEC

Type Default
Optional ADDRSP

This parameter controls if a Natural subtask for an Entire System Management (ESM) product is to run in the security environment of the Entire System Server’s address space or in a separate subtask security environment with a RACF protected user ID.

Possible options:

Option Explanation
ADDRSP Natural subtasks are run in the security environment of the address space.
TASK Natural subtasks are run in the security environment of the task with the user ID specified in the DEFNATUSER startup parameter. This user ID must be defined in RACF as a protected user ID.

DEFNATUSER

Type Default
Optional None

This parameter indicates a default z/OS Natural user which can be used to run Natural in Entire System Server's address space (for example: NCL, NOM, NOP).

EDIT-TIMEOUT

Type Default
Optional 600 (=10 hours)

An EDIT session using Natural ISPF will stay active nnn minutes for Entire System Server, until it erases all resources for this user. You should adjust this value to timeout values for your TP system (Com-plete, CICS, TSO, etc.).

ESYTRACE

Type Default
Optional NO

This parameter allows you to switch on the internal tracing facility of Entire System Server.

Important
It should only be used upon request of our support staff.

Option Explanation
YES Activate internal tracing facility.
NO Default. Deactivate internal tracing facility.

In the JCL of Entire System Server, the following card is required: 

//ESYTRACE DD SYSOUT=X

FORCE

Type Default
Optional NO

Allows or disallows DBID table entry overwrite. Meaning of the options:

Option Explanation
YES Only required when the DBID table entry is not deleted after an abnormal termination. Note that overwriting an existing entry prevents any further communication with the overwritten node. Use FORCE=YES only when you are absolutely sure that no target node with that node ID is active.
NO Protects the node table entry from being overwritten.

HOST-CODE-PAGE

Type Default
Optional None

This parameter is used to define the default host codepage used for any input data in view SEND-EMAIL.

Possible options:

Option Explanation
1140 Brazil, Canada, Netherlands, Portugal, U.S.
1141 Austria, Germany
1142 Denmark, Norway
1143 Finland, Sweden
1144 Italy
1145 Latin America, Spain
1146 United Kingdom
1147 France
1148 International
1149 Iceland
114A Israel Hebrew code page 424.

IDENTIFIER

Type Default
Optional None

String to identify the node. Maximum length is 50 bytes. This string can be retrieved from the field NODE-ID in the view SYSTEM-INFO.

Using this identifier, you can see the machine on which this Entire System Server is running in an Entire Net-Work environment.

IMAP-HOST

Type Default Maximum Value Length
Optional None 64 bytes

The name of the IMAP server, from which e-mails are received. IP notation is not supported. There is no default. If this parameter remains unspecified, view RECEIVE-EMAIL cannot be used.

IMAP-PORT

Type Default Maximum Value Length
Optional None 5 bytes

The port number by which the IMAP-HOST is accessed. This is usually port 993 for a connection secured by SSL. There is no default.

IUBL

Type Default
Optional 32767

Maximum length of the buffer that can be passed from the caller to the Entire System Server.

Note
When using the remote PDSE program object-copying feature, we recommend not reducing this value, otherwise NAT3152 or Adabas response code 152 errors may occur.

LIST-NUM-MAILS

Type Default Maximum Value Length
Optional None 3 bytes

The default number of mails to be received by function LIST in view RECEIVE-EMAIL. Default is 20. You can specify a different value in the Natural programme. The maximum value is specified by LIST-NUM-MAILS-MAX.

LIST-NUM-MAILS-MAX

Type Default Maximum Value Length
Optional 100 3 bytes

The maximum value for field LIST-NUM-EMAILS in view RECEIVE-EMAIL. Default is 100, maximum is 999.

LOCAL

Type Default
Optional NO

Specifies whether the node (specified by the NODE parameter) is accessible in a network from remote nodes.

Option Explanation
YES Node is accessible locally only (not from remote nodes).
NO Node is accessible globally.

LOCAL-HOST

Type Default Maximum Value Length
Optional None 63 bytes

Specifies the domain name. In combination with the LOGON-ID, the parameter is used as sender address in SEND-EMAIL requests. It should be used only if there are difficulties in using the existing host name setting of the local machine.

LOGCB

Type Default
Optional NO

Specifies Adabas control block logging.

The value can be changed dynamically by using an operator command,

for example, /F taskname,LOGCB=YES .

see Operator Commands.

See also Command Logging in the Section Common Entire System Server Features of the Entire System Server Administration documentation.

Possible options:

Option Explanation
YES Adabas control block is logged.
NO Adabas control block is not logged.

LOGFB

Type Default
Optional NO

Specifies format buffer logging.

The value can be changed dynamically by using an operator command,

for example, /F taskname,LOGFB=YES .

See the section Operator Commands in the Entire System Server User's Guide. See also Command Logging in the Section Common Entire System Server Features of the Entire System Server Administration documentation.

Possible options:

Option Explanation
YES Format buffer is logged.
NO Format buffer is not logged.

LOGGING

Type Default
Optional NO

Specifies command logging.

The value can be changed dynamically by using an operator command,

for example, /F taskname,LOGGING=YES. See the section Operator Commands in the Entire System Server User's Guide. See also Command Logging in the Section Common Entire System Server Features of the Entire System Server Administration documentation.

This allows logging of data for a certain amount of time only and without restarting Entire System Server.

Possible options:

Option Explanation
YES Command logging is activated.
NO No command logging.

LOGRB

Type Default
Optional NO

Specifies record buffer logging.

The value can be changed dynamically by using an operator command,

for example, /F taskname,LOGRB=YES.

See the section Operator Commands in the Entire System Server User's Guide. See also Command Logging in the Section Common Entire System Server Features of the Entire System Server Administration documentation.

Possible options:

Option Explanation
YES Record buffer is logged.
NO Record buffer is not logged.

LOGSB

Type Default
Optional NO

Specifies search buffer logging.

The value can be changed dynamically by using an operator command,

for example, /F taskname,LOGSB=YES.

See the section Operator Commands in the Entire System Server User's Guide. See also Command Logging in the Section Common Entire System Server Features of the Entire System Server Administration documentation.

Possible options:

Option Explanation
YES Search buffer is logged.
NO Search buffer is not logged.

LOGVB

Type Default
Optional NO

Specifies value buffer logging.

The value can be changed dynamically by using an operator command,

for example, /F taskname,LOGVB=YES.

See the section Operator Commands in the Entire System Server User's Guide. See also Command Logging in the Section Common Entire System Server Features of the Entire System Server Administration documentation.

Possible options:

Option Explanation
YES Value buffer is logged.
NO Value buffer is not logged.

LOOP

Type Default
Optional 0

Determines the amount of CPU time (in seconds) which can be used by Entire System Server servers. The default value of zero (0) means there is no limit and no CPU time is recorded for display using the NATPROC-USER view.

We recommend setting this parameter to 200 to allow CPU times to be collected without interfering with long-running programs. If you receive the 5537 time limit error, you can increase this value.

MSGLEVEL

Type Default
Optional I

Specifies which message is to be written to the system messages protocol. Possible options:

Option Explanation
E | 3 Error. Available in BS2000 only. Only error messages are written. Information and warnings are suppressed.
W | 2 Warning. Suppresses the logging of startup parameters, as well as the messages indicating a user non-activity time-out.
I | 1 Info. All messages are written.

Note
The values E, W, I are currently supported under BS2000 only.

NABS

Type Default
Optional 10

The number of attached buffers to be used. An attached buffer is an internal buffer used for interregion communication. An attached buffer pool will be allocated of a size equal to the value specified here multiplied by 4112.

NATMOD

Type Default
Optional None

Name of the linked Natural used for subtasking. Refer to the Entire System Server Installation and Customization documentation for details on how to create this module.

If NATMOD was specified, it is recommended to set also parameter SHUTDOWN-MAX-DELAY.

NATNUMSUB

Type Default
Optional 0

Number of Natural subtasks.

If NATNUMSUB was specified, it is recommended to set also parameter SHUTDOWN-MAX-DELAY.

NATSYSOUT

Type Default
Optional Z

This parameter indicates a SYSOUT class to which the output of Natural subtasks running in Entire System Server's address space can be written (for example: NCL, NOM, NOP).

If NATSYSOUT was specified, it is recommended to set also parameter SHUTDOWN-MAX-DELAY.

NCQE

Type Default
Optional 10

The number of command queue elements to be established. This value determines the maximum number of Entire System Server commands which can be queued and/or be in progress at any one time when the Entire System Server is in use. Each Entire System Server command is assigned a command queue element. This element is released when the user has received the results of the command or when the user has been timed out. 192 bytes are required for each command queue element.

NODE

Type Default
Required There is no default. n must be a value greater than or equal to 1 and less than or equal to 65535.

The Entire System Server DBID. It must be unique for each Entire System Server node.

If you set the parameter LOCAL=YES, you can use the same node number for different installations of Entire System Server in an Entire Net-Work environment.

NONACT

Type Default
Optional 60

The non-activity time (in minutes). If a user has not issued a request to the Entire System Server during this time interval, the user is logged off, and the resources of the user will be freed.

NONACT=0 is rejected as invalid parameter value.

PRODUCT

Type Default
Optional None

Name of additional library management systems. You must specify the parameter for each supported subsystem. Possible options:

Option Explanation
L CA-Librarian
M LMS
P CA-Panvalet

RECALL

Type Default
Optional. YES

Specifies whether migrated datasets can be recalled. Possible options:

Option Explanation
YES Default. Migrated datasets can be recalled automatically.
NO Migrated datasets cannot be recalled automatically.

If you are using Natural ISPF Version 2.1.1 or above, set RECALL=YES.

This parameter is used for products such as IBM's DFSMShsm or FDR which uses the SVC 109 for migration, or Siemens' HSMS.

If RECALL=NO, you must start the recall using the view FILE-MAINTENANCE, FUNCTION='RECALL'.

REVIEW

Type Default
Optional NO

Specifies whether Adabas Review is to be used with Entire System Server to collect performance data in local mode for requests originating from Natural. For other required steps, see Using Adabas Review with Entire System Server in the Section z/OS Considerations of the Entire System Server Administration documentation.

Option Explanation
NO Default. Adabas Review is not to be used.
YES Adabas Review is to be used.

SECURITY

Type Default
Optional None

The security system in use. The options are:

Option Explanation
NONE No security system is used.
RACF RACF, ACF2 or TOP-SECRET security is used. For details, see Setting Up RACF Security for Operator Commands on z/OS in the Section z/OS Considerations.
RACX RACF is installed but no logon is done. Normal security exits are invoked.

SHUTDOWN-MAX-DELAY

Type Default
Optional 0

Maximum wait time after issuing ESY shutdown until a smooth stop of running Natural subtasks (in seconds) occurs. This value is considered only if Natural subtasks are running at shutdown time.

If Entire Operations (EOR) or Entire Output Management (EOM) are installed, it is recommended to set this parameter to 90.

This value must not be greater than 600 seconds.

For more information about Natural subtasks, see Aspects of Running System Automation Tools in Entire System Server on BS2000 in the Section BS2000 Considerations.

SMFREC

Type Default
Optional 0

The record type of the SMF record to be written when a user logs off. This record contains the number of I/O operations performed, and the amount of CPU consumed by the user. See also z/OS Accounting in the Section z/OS Considerationss. Possible options:

Option Explanation
type Record type of the SMF record to be written when a user logs off.
0 No SMF records are written.

SMFTIME

Type Default
Optional 2

Value is in minutes. Controls the interval in which SMF records are written.

SMTP-HOST

Type Default Maximum Value Length
Optional There is no default. 63 bytes

Specifies the host name used as mail gateway. This is a DNS name. SEND-EMAIL view cannot work without specifying a valid value for this startup parameter. Contact your mail administrator to determine this host name.

For more information about E-Mail administration, see Run E-Mail Client in Common Entire System Server Features in the Entire System Server Administration documentation.

SMTP-PORT

Type Default
Optional 25

The SMTP port number used on the mail gateway. SEND-EMAIL view cannot work without specifying a valid value for this startup parameter. Contact your mail administrator to determine this port number.

For more information about E-Mail administration, see Run E-Mail Client in Common Entire System Server Features in the Entire System Server Administration documentation.

SPOOL

Type Default
Optional NONE

Specifies the spooling system in use. The possible values are:

Option Explanation
NONE No SPOOL interface (default)
JES2 z/OS JES2 all versions.
JES3 z/OS JES3 all versions. See also Common JES Interface for z/OS in the Section z/OS Considerations.

SPOOLACB

Type Default
Optional NONE

This parameter must be set if you are using Entire Output Management and want to print from Entire Output Management to a VTAM printer.

Possible options:

Option Explanation
name Name of the VTAMACB.
NONE The Entire Output Management printing facility is not activated

STDUSER

Type Default
Optional There is no default.

System Server who are calling from a non-mainframe Natural (VMS, UNIX, Windows, OS/2).

SUBSYS

Type Default
Optional There is no default.

This parameter is used internally and specifies the name of any subsystem. For the value of name, see the installation instructions of the relevant subsystem.

SWAP

Type Default
Optional NO

Specifies whether Entire System Server address space is swappable. The default value (NO) is recommended. Possible options:

Option Explanation
YES Address space is swappable.
NO Address space is marked non-swappable during initialization.

SYNCDB

Type Default
Optional None (no synchronization)

This parameter synchronizes the start of Entire System Server with databases. You can specify the DBIDs of databases, which must be ready if you want to start Entire System Server. This is important for products such as NOP, NOM, NCL . n, m, ..., k are DBIDs. If the database not ready, there is a wait of nnn seconds to synchronize start. See also description of startup parameter SYNCTIME, below.

SYNCTIME

Type Default
Optional 0

If you have specified DBIDs with the parameter SYNCDB, the parameter SYNCTIME gives the time in seconds to wait between synchronization retries. If the fifth retry still does not succeed, Entire System Server comes down. If SYNCDB=NONE, SYNCTIME parameter is ignored. See also description of startup parameter SYNCDB, above.

SYSTEMCONS

Type Default
Optional NONE

This parameter indicates the system names where Entire System Server should collect console messages (for example, SYSTEMCONS=DAEF, DA2F, ABCD). In this case, we collect console messages from the 3 systems indicated.

The default value NONE means that no z/OS System limitation has been provided.

In other words, if you are running in a Sysplex environment, Entire System Server will read all messages from all z/OS consoles defined in the Sysplex. This may lead to an unwanted CPU power consumption if other products are producing much output on the related consoles.

Therefore we recommend to carefully check which console messages your programs want to see by using view CONSOLE. and to set this parameter to the system ID of your locals z/OS, if you only want to read the console messages from your local z/OS.

TAPES

Type Default
Optional NO

Specifies whether your site allows access to mounted tapes from any Natural session.

Option Explanation
YES Access to mounted tapes allowed.
NO Access to mounted tapes not allowed.

TCP-STACK

Type Default Maximum Value Length
Optional There is no default. 8 bytes

This parameter specifies the name of the started task or job in which the TCP/IP protocol stack is running. SEND-EMAIL view cannot work without specifying a valid value for this startup parameter. Contact your network administrator to determine this name.

Note:
If an invalid value has been specified as TCP-STACK, the SEND-EMAIL requests produce error message ESY5897 Mailer response: errno 1011 in EZASMI INITAPI as ERROR-TEXT reporting errno 1011 (EIBMBADTCPNAME).

  • The parameter TCP-STACK is supported at version 4.2 or above. It is ignored in earlier versions.

  • The parameter must contain the ID of the corresponding stack, that is you need to set TCP-STACK = SOCKETnn, where nn is the ID of the VSE TCP stack.

For more information about E-Mail administration, see Run E-Mail Client in Common Entire System Server Features in the Entire System Server Administration documentation.

TEMPUNIT

Type Default
Optional VIO

The unit name to be used when an Entire System Server request for allocation of a temporary data set is made (for example, SYSDA).

TIME

Type Default
Optional 30

Timeout value for Entire System Server calls in seconds. This parameter is used to prevent a command queue element and attached buffer from being held for a long period for a user who has terminated abnormally.

This parameter is the equivalent to the Adabas CT parameter.

TRACE

Type Default
Optional PREP

Specifies how to set up the TRACE environment.

Option Explanation
NO TRACE environment is completely deactivated.
PREP TRACE environment will be initialized, but not started yet.
YES TRACE environment will be activated at ESY startup.

If the YES or PREP option is specified, the TRACE activity can be manipulated via operator command to start or stop traces dynamically.

For further information, see Creating Trace Data in the Entire System Server in the Section Common Entire System Server Features.

TRACE-LEN

Type Default
Optional 8

Specifies the size of the trace memory pool (in Kbytes). This value is considered only if TRACE=YES or TRACE=PREP has been defined.

For further information, see Creating Trace Data in the Entire System Server in the Section Common Entire System Server Features.

TRACE-SAV

Type Default
Optional YES

TRACE-SAV controls the trace save routine at exit.

Option Explanation
YES Trace data buffers will be saved.
NO Trace data buffers will not be saved.

For further information, see Creating Trace Data in the Entire System Server in the Section Common Entire System Server Features.

VTAMACB

Type Default
Optional NONE

The name of the VTAM application to be used for the VTAM operator interface as it appears in the ACBNAME parameter in the VTAM APPL statement.

Possible options:

Option Explanation
name Name of the VTAM application in the ACBNAME parameter.
NONE The VTAM interface is not activated.

VTAMQLEN

Type Default
Optional 100

The maximum size (in Kbytes) of the in-core queue for pending VTAM messages. If this queue size is exceeded, the oldest half of the queue is deleted.

Option Explanation
L CA-Librarian
M LMS
P CA-Panvalet

On this page