HCI operator commands

This topic explains all the operator commands that help you deactivate the HCI region, display information about the HCI region, and manipulate the HCI journals.

You can enter operator commands to the HCI via a Write to Operator Request (WTOR) or via the z/OS MODIFY, depending on the value specified for the configuration HCICNGCA element's OPCMD attribute.

Commands List

All supported operator commands are listed below. The uppercase letters of each command are the minimum characters required to execute the valid short form of the command.

ACTivate subtask
DEactivate subtask
Display
Open
Close
SWap
JMask
REFRESH (modname)
REFRESH XML (modname)
SDump
SHUTDOWN

Note

Separate the command from the attributes by one or more spaces (no comma). If you specify more than one attribute, separate each from the next with a comma (no spaces). Not all commands require attributes.

ACTIVATE subtask

The ACTIVATE command restarts a VTAM- or TCP/IP-related subtask that has previously been deactivated either by operator command or by exhausting the retry count in the subtask recovery routine.

DEACTIVATE subtask

The DEACTIVATE command directs the HCI to deactivate the subtask named in the command. Attributes for this command include normal deactivation and a forced abend deactivation.

DISPLAY

The DISPLAY command allows you to display various components and statuses within the HCI. The following table shows the available attributes for the DISPLAY command.

Operands	Description
ALL	Displays all HCI status fields.
JOURNAL	Displays information about the journal.
STOR	Displays information about current storage utilization.
CB	Displays information about control block utilization. The CURRENT utilization, HIGHEST utilization, and MAXIMUM allowed as configured in the HCICNFIG file are displayed.
ENQ	Displays BMC AMI DevX Workbench for Eclipse tasks with an ENQ on the data set specified. For example: /F jobname,DSP ENQ=dataset.name
USER	Displays the list of all active user IDs associated with HCI.

OPEN

The OPEN command directs the HCI to allocate and open the first journal data set and begin journaling.

CLOSE

The CLOSE command directs the HCI to close and deallocate the current journal data set and to refrain from any further journaling until an OPEN command is issued.

SWAP

The SWAP command directs the HCI to close and deallocate the current journal data set, and to allocate and open the next one.

JMASK

The JMASK command sets the journal mask to on or off. The table shows the available attributes for the JMASK command.

Attribute	Description
ON	Sets the journal mask to all ones (x'FFFFFFFFFFFFFFFF').
OFF	Sets the journal mask to zeroes (x'0000000000000000').

REFRESH =modname (HCI 2.5 only)

The REFRESH command is supported only by HCI Release 2.5 and has been removed from HCI Release 3.0. This command directs the HCI to read the configuration module named modname from the //FDBDRPL DD concatenation and to dynamically update the running parameters in the HCI from the values in the named configuration module. If modname is omitted, the HCICNFIG element is used as the default.

REFRESH **XML=xmlname (HCI 3.0 only)**

The refresh command directs the HCI to read the specified XML document member from the //HCIXML DD and to dynamically apply the values contained in this document to the running HCI.

Important

For the dynamic refresh capability for XML to be active, the HCIXML DD must refer to a partitioned data set. The xmlname operand on this command specifies the member name within this PDS which is to be parsed and applied to the running HCI.

SDUMP

The SDUMP command prepares z/OS and the HCI to take an SDUMP. This command sets the four internal values of the HCI, DMPPFX, DMPVOL, DMPCLAS, and DMPUNIT of the HCICNGCA to the appropriate values for an SDUMP. For HCI to action SDUMP, the DMPUNIT must be set to a valid SYSUNIT name, and the DMPPFX must be set to SDUMP. DMPVOL and DMPCLAS, must not be specified. The SDUMP command resets the DMPVOL and DMPCLAS internal values. The two positional attributes—SYSUNIT and CONNAME (console name) separated by a comma (,)—are optional. If the second is specified, the comma must be present. If the second attribute is omitted, those operator commands to set the options for the SDUMP are displayed only. If the second attribute is specified, the HCI issues the operator commands to establish the proper SDUMP options for an HCI SDUMP. The original values can be reset only by restarting the HCI or issuing the REFRESH command. The following table shows valid SDUMP command syntax variations:

Command Syntax	Description
SDump	Displays the operator commands to set the SDUMP options. This form does not change any of the HCI internal values.
SDump sysunit	Sets the DMPUNIT internal value and displays the operator commands to set the SDUMP options.
SDump sysunit,conname	Sets the DMPUNIT internal value and issues the console commands to correctly set the SDUMP options.
SDump ,	Sets SYSDA as the internal DMPUNIT name and displays the operator commands to set the SDUMP options.
SDump *,conname	Uses the currently set DMPUNIT internal value and issues the operator commands to set the SDUMP options.
SDUMP ,conname	Displays current control block utilization.

SHUTDOWN

The SHUTDOWN command directs the HCI to terminate. The following table shows the available attributes for the SHUTDOWN command:

Operands	Description
IMMED	For an immediate shutdown. The HCI will not wait for any user tasks to end prior to termination. Consequently, the HCI will end with a SA03 abend if there are any active users at shutdown time.
NORMAL	For normal shutdown
ABEND	For a forced abend situation

If none of the attributes are specified, a normal shutdown occurs.

Operator Commands to Control the SSAS

The following commands control the start and shutdown of SSAS. There may be multiple ports, each with a TP control task and SSAS. These port numbers are specified on the PORT_CONFIG parameter in the HCIxxxx parameter member. Be sure to specify the port number whose associated SSAS you wish to start or shutdown.

Shutdown the SSAS

F hci,SSAS SHUTDOWN ppppp

where, hci is the job name of the HCI address space and ppppp is the port number associated with the TP control task that owns the SSAS.

The minimum abbreviation for the SHUTDOWN command is SHUT.

Start the SSAS

F hci,SSAS START PPPPP

where, hci is the job name of the HCI address space and ppppp is the port number associated with the TP control task that owns the SSAS.

Operator Commands for ENQ Management

The following commands help manage ENQs within the HCI address space. If an HCI started task is indicated as holding an ENQ on a data set, the PURGE command will purge any BMC AMI DevX Workbench for Eclipse tasks with an ENQ on the specified data set. Its syntax is:

F HCIjobname,PURGE ENQ=dataset.name

If this command fails to clear the ENQ, you can also issue the DEALLOC operator command to clear any SYSDSN ENQs on the data set. This command’s syntax is:

F HCIjobname,DEALLOC DSN=dataset.name

Notes

If the ENQ remains after issuing these two commands, you will have to recycle your HCI started task in order to clear it.
If managing ENQs from the HCI is a continual issue at your site, we recommend using the INACTIVITY parameter to prevent users from holding data sets that are not in use.

Operator Commands for Purge TP Connection

The following command helps to Purge TPs connection from the HCI address space. Its syntax is:

F HCIjobname,PURGE TP=TPSeqNumber

While the HCI USER command displays the list of all active user IDs associated with HCI (TPID), this command can be used to obtain a list of active HCI user ids along with TP sequence numbers.