Operator Commands

This documentation describes the operator commands that can be entered on the operator console to control and display Entire System Server activities.

This section covers the following topics:


Command Syntax

The following command format is required to communicate with the Entire System Server via the operator console. Note that parameters in UPPERCASE must be typed as is. Parameters in italics must be substituted with a valid value.

OS/390:

F taskname, command parameter

where:

taskname is the name of the Entire System Server started task or job at your installation.
command is the operator command keyword.
parameter is a parameter that allows you to issue an operator command for selected items.

VSE/ESA:

MSG pt
  replid command parameter

where:

pt is the partition in which the Entire System Server is executing.
replid is the reply identifier assigned to prompt.
command is the operator command keyword.
parameter is a parameter that allows you to issue an operator command for selected items.

BS2000/OSD:

/INTR tsn,command parameter

where:

tsn is the task sequence number of the Entire System Server main task (with loaded module NPRINIT).
command is the operator command keyword
parameter is a parameter that allows you to issue an operator command for selected items.

Top of Page

Command Descriptions

Syntax Conventions

In the syntax diagrams that follow, a parameter enclosed in curly braces {} are optional, parameters in italics are variables that must be substituted with a real value, for example, a name. If more than one parameter appears, only one may be specified.

In the examples, only the command and parameter keywords are described. You must supply the other command operands as appropriate to the operating system.

ADAEND

Command Parameter Operating System
ADAEND   OS/390, BS2000/OSD, VSE/ESA

No more processing takes place. Existing calls to the Entire System Server are allowed to finish, but new calls are rejected. Processing ends after the last call has finished.

If the startup parameter SHUTDOWN-MAX-DELAY is specified as non-zero, the Entire System Server tries to stop any available ESM monitor (EOM, EOR, ...) and waits for the monitors to shut down. New calls are not rejected until SHUTDOWN-MAX-DELAY time is elapsed. If all ESM monitors are stopped in the meantime, the deferred shutdown is not needed any longer and ADAEND will be executed.

CANCEL

Command Parameter Operating System
CANCEL USER=userid
ID=sessionid
JOB=jobname
OS/390, BS2000/OSD, VSE/ESA

Cancels the specified user in the Entire System Server address space.

Examples:

SERVER-DYN

Activates or deactivates dynamic server support.

Command Parameter Operating System
SERVER-DYN YES
NO
BS2000/OSD, VSE/ESA

SERVER-MIN

Sets the SERVER-MIN parameter to the specified value. nn must not be more than SERVER-MAX.

Command Parameter Operating System
SERVER-MIN nn BS2000/OSD, VSE/ESA

SERVER-MAX

Sets the SERVER-MAX parameter to the specified value. nn must not be less than SERVER-MIN.

Command Parameter Operating System
SERVER-MAX nn BS2000/OSD, VSE/ESA

SERVERS

Displays information about current server load.

Command Parameter Operating System
SERVERS   BS2000/OSD, VSE/ESA

SHUTDOWN

Command Parameter Operating System
SHUTDOWN EOR
NOM
NCM
ALL
*
 

The operator command SHUTDOWN is now supported to stop the monitors of Entire System Management products (ESM).

Using the above syntax, you can shutdown the monitors of Entire Operations (EOR), Entire Output Management (NOM), Entire Event Management (NCM) or all running monitors at a time (ALL or *).

START

Command Parameter Operating System
START ALL OS/390, VSE/ESA, BS2000/OSD

"START ALL" (re)starts the initial SAT task to run ESM monitors.
Command is rejected if the SAT environment is still active.

Issue command "SHUTDOWN ALL" to stop SAT environment.

TAPES

Command Parameter Operating System
TAPES   OS/390

Display tape units allocated to the Entire System Server.

TAPEFREE

Command Parameter Operating System
TAPEFREE ddname
ALL
OS/390

Free tape units allocated to the Entire System Server.

Example:

USERS

Command Parameter Operating System
USERS userid OS/390, VSE/ESA, BS2000/OSD

Displays the specified user ID as a message on the console. Without the userid parameter, a list of all users is displayed. You can also specify a prefix followed by an asterisk * to select those user IDs starting with that prefix.

Example:

VSAM

Command Parameter Operating System
VSAM   OS/390

Display open VSAM files.

VSAMFREE

Command Parameter Operating System
VSAMFREE ddname
ALL
OS/390

Free VSAM files.

Example:

XCANCEL

Command Parameter Operating System
XCANCEL   OS/390, VSE/ESA, BS2000/OSD

Processing stops immediately and a dump is created. Existing calls to the Entire System Server are not allowed to finish.

XCQES

Command Parameter Operating System
XCQES   OS/390, VSE/ESA, BS2000/OSD

The number of Command Queue Elements currently active is displayed. The highest number of currently active CQES is also shown.

XHALT

Command Parameter Operating System
XHALT   OS/390, VSE/ESA, BS2000/OSD

New calls to the Entire System Server are temporarily rejected. Processing is resumed with the XSTART operator command (see below).

XPARM

Command Parameter Operating System
XPARM   OS/390, VSE/ESA, BS2000/OSD

A set of startup parameters such as node number, maximum number of command queue elements and attached buffers are displayed as console messages.

XSTART

Command Parameter Operating System
XSTART   OS/390, VSE/ESA, BS2000/OSD

Processing of calls to the Entire System Server, interrupted with the XHALT command, is resumed.

XSTAT

Command Parameter Operating System
XSTAT   OS/390, VSE/ESA, BS2000/OSD

Entire System Server statistics are displayed as console messages.

XSTOP

Command Parameter Operating System
XSTOP   OS/390, VSE/ESA, BS2000/OSD

Processing stops immediately. Existing calls to the Entire System Server are not allowed to finish.

XUSER

Command Parameter Operating System
XUSER   OS/390, VSE/ESA, BS2000/OSD

The current number of users is displayed as a console message, and the highest number is displayed.

Top of page