Operator Commands

#### Search Results

Search

# Operator Commands

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

Note
Support for z/VSE is deprecated. Support for BS2000 is also deprecated, except in conjunction with the ESM adapter. Features that are z/VSE and BS2000 specific will be removed from future releases.

This document covers the following topics:

- Command Syntax

- Command Descriptions

## 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.

### z/OS:

    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.

### z/VSE:

    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:

    /INTR tsn,command parameter

where:

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

## 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` |  | z/OS, BS2000, z/VSE

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.

Important
We recommend to use `ADAEND` to ensure a smooth termination of a running Entire System Server including all running calls and ESM monitors used within its address space.

#### CANCEL

Command | Parameter | Operating System
--- | --- | ---
`CANCEL` | `USER=userid` `ID=sessionid` `JOB=jobname` | z/OS, BS2000, z/VSE

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

#### Examples:

- To cancel the user `ITSME` from the Entire System Server subtask `XCOM148`, enter the following command in the operator console:

      CANCEL USER=ITSME

  cancels all active sessions with the Entire System Server for user `ITSME`.

- The following command cancels the one specific session for a user:

      CANCEL ID=nnnn

  where `nnnn` is the corresponding Entire System Server ID retrievable using the view `NATPROC-USERS`, or via the operator command:

      USERS userid

- To cancel all users originating from job name `ESYSTART`, enter the following command:

      CANCEL JOB=ESYSTART

#### EVENTS

Command | Parameter | Operating System
--- | --- | ---
`EVENTS` |  | z/OS, z/VSE

The `EVENTS` command displays the contents of the `EVENTING` view control blocks on the console. It generally is to be issued at the request of Software AG customer support for problem determination.

#### FILES

Command | Parameter | Operating System
--- | --- | ---
`FILES` |  | BS2000

The `FILES` command creates a list of all open files per user in this server task. It is supported in the server tasks (with loaded module `ESYSERV`), therefore the TSN of the server task has to be used.

#### Example:

    /INTR 9083,files    " --> FROM USER TSOS"
    ESY4001I 00113 Operator typed in: FILES.
    ESY2173I 00113 USER     ESY-ID ACT VIEW DSNAME.
    ESY2173I 00113 -------- ------ --- ---- ------------------------------------
    ESY2173I 00113 DC1       0004   N     2 :NAT:$DC1.P.NRTvrs.3932.
    ESY2173I 00113 TSOS      0003   N     2 :CIS:$NETWORK.WCP.SRC.

If no files are open, the following message is displayed:

    /INTR 9083,files    " --> FROM USER TSOS"
    ESY4001I 00113 Operator typed in: FILES.
    ESY2174I 00113 Nothing found for this request.

#### LOGGING

Command | Parameter | Operating System
--- | --- | ---
`LOGGING` | `YES` | z/OS
`NO`

The operator command `LOGGING=YES` starts command logging as described in Common Entire System Server Features.

Command `LOGGING=NO` stops the active logging. This operator command can be used to log a specific situation without stopping and restarting Entire System Server.

#### SERVER-DYN

Activates or deactivates dynamic server support.

Command | Parameter | Operating System
--- | --- | ---
`SERVER-DYN` | `YES` | BS2000, z/VSE
`NO`

#### 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, z/VSE

#### 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, z/VSE

#### SERVERS

Displays information about current server load.

Command | Parameter | Operating System
--- | --- | ---
`SERVERS` |  | BS2000, z/VSE

#### SHUTDOWN

Command | Parameter | Operating System
--- | --- | ---
`SHUTDOWN` | `EOR`, `NOM`, `NCL`, `RPC`, `ALL`, `*` |

The operator command `SHUTDOWN` stops the monitors of Entire System Management (ESM) products.

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

#### START

Command | Parameter | Operating System
--- | --- | ---
`START` | `ALL` | z/OS, z/VSE, BS2000

`START ALL` (re)starts the initial SAT task to run ESM monitors.

Command is rejected if the SAT environment is still active.

Issue the command `SHUTDOWN ALL` to stop the SAT environment.

#### STATUS

Command | Parameter | Operating System
--- | --- | ---
`STATUS` | `EOR`, `NOM`, `NCL`, `RPC` | z/OS, z/VSE, BS2000

The operator command `STATUS` returns information about Natural subtasks related to Entire System Management (ESM) products.

#### TAPES

Command | Parameter | Operating System
--- | --- | ---
`TAPES` |  | z/OS

Display tape units allocated to the Entire System Server.

#### TAPEFREE

Command | Parameter | Operating System
--- | --- | ---
`TAPEFREE` | `ddname`, `ALL` | z/OS

Free tape units allocated to the Entire System Server.

#### Example:

- The following command frees the tape allocated to DDNAME `MYTAPE`:

      TAPEFREE MYTAPE

- The following command frees all tapes allocated to the Entire System Server session:

      TAPEFREE ALL

#### USERS

Command | Parameter | Operating System
--- | --- | ---
`USERS` | `userid` | z/OS, z/VSE, BS2000

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:

- The following command displays user `ITSME`:

      USERS ITSME

- The following command displays all users whose IDs begin with SAG:

      USERS SAG*

#### VSAM

Command | Parameter | Operating System
--- | --- | ---
`VSAM` |  | z/OS

Display open VSAM files.

#### VSAMFREE

Command | Parameter | Operating System
--- | --- | ---
`VSAMFREE` | `ddname` | z/OS
`ALL`

Free VSAM files.

#### Example:

- The following command frees VSAM file allocated to DDNAME `MYFILE`:

      VSAMFREE MYFILE

- The following command frees all VSAM files allocated to the Entire System Server session:

      VSAMFREE ALL

#### XABS

Command | Parameter | Operating System
--- | --- | ---
`XABS` |  | z/OS, z/VSE, BS2000

Displays the total size, the number of bytes in use, the number of free bytes and the largest free windows in the Adabas attached buffer pool on the console.

#### Sample Output:

    XCO0016I 00113 Operator command: XABS
    XCO0090I 00113 Attached buffer usage
    XCO0090I 00113 0000409600 bytes total = 0000000100 NABS
    XCO0090I 00113 0000007168 bytes used
    XCO0090I 00113 0000007168 bytes used HWM
    XCO0090I 00113 0000402176 bytes free
    XCO0090I 00113 0000402176 bytes current largest free windows
    XCO0090I 00113 0000402176 bytes minimum of all largest free windows

#### XCANCEL

Command | Parameter | Operating System
--- | --- | ---
`XCANCEL` |  | z/OS, z/VSE, BS2000

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` |  | z/OS, z/VSE, BS2000

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` |  | z/OS, z/VSE, BS2000

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` |  | z/OS, z/VSE, BS2000

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` |  | z/OS, z/VSE, BS2000

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

#### XSTAT

Command | Parameter | Operating System
--- | --- | ---
`XSTAT` |  | z/OS, z/VSE, BS2000

Entire System Server statistics are displayed as console messages.

#### XSTOP

Command | Parameter | Operating System
--- | --- | ---
XSTOP |  | z/OS, z/VSE, BS2000

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

Important
This command is not recommended for a regular shut down of a running Entire System Server because existing calls and ESM monitors within its address space are shut down immediately and cannot terminate in a regular way. Therefore, `XSTOP` can be compared to an emergency brake that should only be applied to avoid an accident. For a regular shut down and to ensure a smooth termination, we strongly recommend `ADAEND`.

#### XUSER

Command | Parameter | Operating System
--- | --- | ---
`XUSER` |  | z/OS, z/VSE, BS2000

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

### On this page

- Command Syntax
- Command Descriptions