HCI configuration parameters

SYSID

SYSID is the short form for SUB_SYSTEM_ID. Must be specified either in the XML parameter space or on the PARM= operand of the EXEC statement that invokes the HCI. If specified in both places, the EXEC statement PARM overrides the SYSID specified here if they differ. Must be four characters in length and is used by the HCI initialization routines to create a z/OS subsystem. Must be unique among all subsystems running on this LPAR. Must not be defined in SYS1.PARMLIB. The HCI dynamically creates this subsystem. Each HCI to run on a single LPAR must have its own unique SYSID value.

Default: None

Required: Yes

ARMNAME

The Automatic Restart Management (ARM) Facility in the HCI is activated by including this element and specifying a non-null name. Element names that begin with A through I and SYS are reserved for use by IBM.

Default: None

Required: No

ARMTYPE

If ARMNAME is specified and if the installation requires that an element type be specified in the IXCARM TYPE=REGISTER macro, then specify the type here. Element types that start with A through I and SYS are reserved for use by IBM.

Default: None

Required: No

CES_NOTIFY

Indicates whether or not job completion messages are to be sent to Common Enterprise Services (CES).

Values:  YES | NO

Default: NO

Required: No

DAE

The z/OS Dump Analysis and Elimination (DAE) facility can be detrimental in obtaining dumps of the HCI.

Default: NO

Required: None

Values: NO|YES

NO Causes the HCI to change portions of the summary dump in such a way that DAE never suppresses an HCI dump.

YES Causes the DAE facility to suppress what it considers duplicate dumps.

DEFAULT_USER

Specifies the name of a valid RACF (ACF/2 or TOPSECRET) user ID to be used by the HCI when TP jobs are submitted or started and when there is no other user ID available.

The user ID must be assigned within the security system and granted authority to perform any processing the TP requires until the TP issues one of the set security calls. Until that time, the new user ID is in effect.

Ensure that the default user ID has either ACCESS(READ) or ACCESS(EXECUTE) to the //STEPLIB DD used in the TP JCL and that it has appropriate access to any other data sets that it processes under the default user ID.

Default: HCIUSER

Required: No

DMPCLAS

Specifies a valid JES/n output class to which SNAP dumps are to be directed. If this attribute is omitted, then the DMPPFX, DMPUNIT and DMPVOL attributes define the output data set to contain SNAP dump information.

Default: None

Required: No

DMPPFX

The prefix of all dumps taken by the HCI.

Values: SDUMP specifies that all dumps taken by the HCI are system dumps (via SDUMPX) and are directed to the SYS1.DUMPxx (or customer-defined) data set. The DMPUNIT, DMPVOL, and DMPCLASS attributes are ignored.

prefix causes a data set to be allocated whose DSNAME is prefixed by this prefix and a SNAP dump is taken to this data set. In this case, the DMPUNIT and DMPVOL attributes further define the location of the data set. The prefix can be from 1 to 12 valid characters for a DSNAME prefix. Note that the user ID under which the HCI is executing must have ACCESS(ALTER) to this DSNAME prefix.

Default: SDUMP

Required: No

DMPUNIT

Specifies the unitname for SNAP dumps allocated by the HCI. If this attribute is omitted, then the DMPPFX attribute must specify SDUMP.

Values: a valid name for DASD allocation at your installation; for example, DMPUNIT=SYSDA.

Default: SDUMP

Required: No

DMPVOL

Specifies the VOLSER for SNAP dumps allocated by the HCI. If this attribute is omitted, then the DMPPFX attribute must specify SDUMP. VOLSER must be a valid volume serial number for DASD allocation at your installation.

Default: None

Required: No

EMCS_CONSOLE_NAME

Provides a mechanism to allow installations to guarantee uniqueness between ports within an HCI and between LPARs in a SYSPLEX through the use of system symbols. This prevents an EMCS console from remaining in the system until an IPL occurs.

The use of system symbols in the parameter value will guarantee uniqueness between ports within an HCI, and between LPARs in a SYSPLEX.

Values: maximum 8-character name

Default: Current time appended to LPAR or system name

Required: No

HCIPLEX_NAME

Specifies the name of the HCIPlex. By specifying a value for this parameter, the HCIPlex feature is enabled.

Values: 1 to 8 alphanumeric characters. The first character must be an alphabetic or national character.

Default: None

Required: No 

HCI_PROCNAME

This parameter is only needed when the HCI job name is not the same as the name of the member containing the PROC

Values: 

Default: 

Required: No

JESCHAR

Specifies the command character used from the master console or from an SDSF log screen to issue commands to the JES2 or JES3 subsystem. The value of this attribute is used by the HCI as the first character of the command used to cancel TP programs that have been started by the Server Activation Facility, but which have not registered with the HCI within the allowable time limit.

For example, the command for JES2 using the default dollar sign ($) character:

In this way, multiple JES subsystems can support HCI TP programs.

Default: $ (U.S. dollar sign)

Required: No

JESID

Specifies that either JES2 or JES3 is the primary subsystem for the LPAR on which the HCI is executing. Various functions within the HCI depend on the correct setting of this attribute.

Values: 2|3

Default: 2

Required: No

JESJPRM

A value of YES specifies that HCI should add a /*JOBPARM SYSAFF=* for JES2 systems or a //*MAIN SYSTEM=xxxxxxxx for JES3 systems to JCL submitted by the HCI to start TP programs. If your JCL for TP programs is to run on systems other than the one on which the HCI is executing, then omit this attribute or specify JESJPRM=NO.

Values: NO|YES

Default: NO

Required: No

JES3

The JES3 statement is used for installations using a JESPLEX that require a command prefix to be specified in front of JES3 commands used to cancel or purge jobs and SYSOUT data sets from the spool. The BMC AMI DevX Workbench for Eclipse JES Explorer View function can issue these commands on behalf of a user in order to allow them control of their own output.

If your installation is not using JES3 or does not require a command prefix, do not code this statement. If you require a command prefix, specify the prefix after the JES3 keyword.

Default: none

Values: 1 to 8-character command prefix appended on the front of any JES3 command sent to the system.

Required: no

JOURNALn

Specifying journal data sets allows for logging of HCI activity. The HCI uses the Journaling Facility to write out diagnostic information that may then be provided to BMC developers. Journal data sets cannot be shared across multiple HCI instances. Each HCI instances requires its own set of journal data sets.

Values: valid data set name

Default: None

Required: No

JRNMASK

Specifies exactly 16 hexadecimal digits (0-9 and A-F) that are used to control which journal events are to be collected when journaling is active.

Values: 16 hexadecimals

Default: 0000000000000002

hhhhhhhhhhhhhhhh is the 16-place hexadecimal specifying the number of events to be written to the HCI journal. For example, sixteen zeros (0000000000000000) causes no journal events to be written to the HCI journal, where sixteen Fs (FFFFFFFFFFFFFFFFFF) causes all journal events to be written to the HCI journal.

Required: No

MAXCCBS

Specifies the maximum number of concurrent conversations or connections that the HCI will support. Setting this attribute to a large number increases private storage usage, but otherwise does not cause any negative effects.

Values: 128 through 32768. Each CCB is 1376 (decimal) bytes long.

Default: 378

Required: No

MAXDCBS

Specifies the maximum number of concurrent discrete destinations that the HCI will support. Setting this attribute to a large number increases private storage usage, but otherwise does not cause any negative effects.

Values: 8 through 32768. Each DCB is 760 (decimal) bytes long.

Default: 378

Required: No

MAXJRES

Specifies the maximum number of concurrent journal requests that the HCI will support. Setting this attribute to a large number increases private storage usage, but otherwise does not cause any negative effects. In addition, a large number ensures that no journal records are lost due to JRE exhaustion.

Values: 512 through 32768. Each DCB is 16 (decimal) bytes long.

Default: 8192

Required: No

MAXLUBS

Specifies the maximum number of SNA LU2 sessions that the HCI will support. If you are not supporting any LU2 remote partners, then allowing this attribute to use the default is sufficient.

Values: 1 through 2768. Each LUB is 496 (decimal) bytes long.

Default: 16

Required: No

MAXRCBS

Specifies the maximum number of concurrent TP program address spaces that the HCI will support. Each address space can be associated with multiple TP users, but in most cases it is a one-for-one correspondence. Region control blocks (RCBs) are allocated from ECSA (SP=241), and therefore this number should not be excessively bigger than necessary.  

Values: 8 through 32768. Each RCB is 96 (decimal) bytes long.

Default: 378

Required: No

MAXUIBS

Specifies the maximum number of concurrent TP program TPNAMES that the HCI will support. User interface blocks (UIBs) are allocated from ECSA (SP=241), and therefore this number should not be excessively bigger than necessary.

Values: 8 through 32768. Each UIB is 1040 (decimal) bytes long.

Default: 378

Required: No

MAXWRES

Specifies the maximum number of concurrent work requests that the HCI will support. Work request elements (WREs) are allocated from ECSA (SP=241), and therefore this number should not be excessively bigger than you find necessary.

Values: 8 through 32768. Each WRE is 1040 (decimal) bytes long.

Default: 4096

Required: No

OACBINT

Specifies the time in hundredths of a second that the HCI will allow to elapse between attempts to open a VTAM ACB specified by the ACBNAME attribute of an HCICNAMB element.

Values: 1 through 360000.

Default: 3000

Required: No

OPCMD

Specifies how operator commands are to be entered into the HCI.

Values: WTOR|MODIFY

WTOR Specifies that a Reply to Operator command (r nn,) is to be used.

MODIFY Specifies that the z/OS MODIFY (F) command is to be used.

Default: WTOR

Required: No

PREPROC

Specifies the name of a procedure in SYS1.PROCLIB (or an appropriate user procedure library) that starts the initialization of the secondary HCI on each member of a parallel sysplex. The main HCI is initialized by the customer via JCL or a started task. The HCI automatically routes z/OS START commands to each other member of the sysplex indicating that the PROC named in the PREPROC attribute be started. Name this PROC any maximum eight-character name, but the PROC must be available to every member of the sysplex.

If the SYSPLEX attribute is omitted (indicating no sysplex support requested), then the PREPROC attribute is ignored.

Values: any maximum 8-character name

Default: HCIYPREP

Required: No

ROUTCMD

Specifies whether TP programs that are initiated by START commands are to be routed to the member of the sysplex indicated on the member in the HCI //PARMLIB DD.

Values: NO|YES

NO specifies that the z/OS START command is to be issued only on the system on which the primary HCI is running.

YES specifies to route z/OS START commands to each z/OS in the SYSPLEX.

Default: None

Required: No

SECFAC

Specifies the name of a Facility Class entity that is to be checked when a TP program issues a CWOPER call in order to issue an operator command. The user ID under which the TP is executing must have ACCESS=UPDATE to the Facility Class entity in order to issue the CWOPER call.

Default: None

Required: No

SRVRJOB

Specifies a one- to five-character job name prefix that the HCI uses for all TP programs submitted by the HCI. A 1- to 3-digit numeric suffix is added onto this prefix and incremented each time the job is submitted in order that the job names will be unique. When the suffix reaches 9, 99, or 999.

Values: 1- to 3-digit numeric suffix

Default: HCITP

Required: No

SYSPLEX

Specifies a 4-character subsystem ID to be assigned to each of the sysplex HCI members. The value must be exactly four characters in length and must consist of uppercase letters and numbers only. Omitting this attribute specifies that you do not want sysplex support to be activated.

Values: 4-character subsystem ID

Default: None

Required: No

TCP_ACEE

Indicates whether the individual user or HCI security environment will be used for cross-LPAR communications. If TCP_ACEE set to USER, each user needs to have their own fully defined OMVS segment for any cross-LPAR communications. If TCP_ACEE set to HCI, the OMVS segment of the HCI user ID will be used.

This will only affect permissions for the TCP/IP connection and has no effect on data set permissions.

Values: USER | HCI

Default: USER

Required: No

TCPAMSG

Specifies whether the TCPACCESS TERROR macro is to be used to display error messages if your TCP/IP protocol stack is CA's TCPACCESS product.

Values: NO|YES

NO sends TCPACCESS messages to the //HCIPRINT DD.

YES uses the TCPACCESS TERROR macro to display error messages.

Default: NO

Required: No

TPSEC

Specifies whether you want the HCI to ensure that the user ID under which a TP program is executing has access to the TPNAME that it is connecting to.

Values: NO|YES

NO specifies that no RACF checking of the user ID versus the TPNAME is to occur.

YES specifies that the user ID must have ACCESS(READ) to the FACILITY CLASS entity in order for the HCI to allow execution of the TP. The FACILITY CLASS entity name is constructed by prefixing the TPNAME with the four-character subsystem ID of the HCI.

Default: NO

Required: No

TPT_NAME