GDSX Management Programming Manual Abstract This manual is for programmers writing management applications that use the GDS subsystem. It describes the token-oriented programmatic interfaces, the Subsystem Programmatic Interface (SPI) and the Event Management Service (EMS), to the Extended General Device Support (GDSX) product. Product Version GDSX D44 Supported Release Version Updates (RVUs) This manual supports the G06.
Document History Part Number Product Version Published 139167 GDSX D44 February 1998 529930-001 GDSX D44 July 2005
GDSX Management Programming Manual Index Figures What’s New in This Manual v Manual Information v New and Changed Information Tables v About This Manual vii Purpose of This Manual vii Who Should Use This Manual vii Related Reading vii Prerequisite Reading viii What Is Included in This Manual viii Notation Conventions ix 1.
3. SPI Programming Considerations Contents Constructs Involving Multiple Tokens 2-6 Components of Commands and Responses Components of an Event Message 2-6 2-6 3. SPI Programming Considerations Building the Command Buffer 3-1 Discontinuing a Command in Progress 3-2 Receiving and Decoding the Response Buffer Handling Errors 3-2 Version Compatibility 3-3 Maintaining Security 3-3 3-2 4.
6. Event Messages Contents SWITCH Command 5-73 TRACE Command 5-75 6. Event Messages Subsystem Processes That Report Events Critical Events 6-2 Programming Considerations 6-3 Strategies 6-3 Event Message Tokens 6-3 Header Tokens 6-3 Standard EMS Token 6-5 Subsystem-Specific Tokens 6-5 Event Messages 6-6 6-1 7. Error Numbers and Error Lists Notation Used 7-1 Error Lists 7-1 Error-List Descriptions 7-2 Index Figures Figure 1-1. How an Application Fits Into GDSX Architecture 1-3 Tables Table 1-1.
Contents GDSX Management Programming Manual—529930-001 iv
What’s New in This Manual Manual Information GDSX Management Programming Manual Abstract This manual is for programmers writing management applications that use the GDS subsystem. It describes the token-oriented programmatic interfaces, the Subsystem Programmatic Interface (SPI) and the Event Management Service (EMS), to the Extended General Device Support (GDSX) product. Product Version GDSX D44 Supported Release Version Updates (RVUs) This manual supports the G06.
What’s New in This Manual New and Changed Information GDSX Management Programming Manual—529930-001 vi
About This Manual This preface describes the purpose and contents of the GDSX Management Programming Manual and lists other manuals that are closely related to it. The GDSX Management Programming Manual provides subsystem specific information about the management programming interfaces to GDSX using the Subsystem Programmatic Interface (SPI) and the Event Management Service (EMS).
Prerequisite Reading About This Manual • • • • Asynchronous Terminal and Printer Processes Programming Manual Device-Specific Access Method—AM6520 X25AM Programming Manual CP6100 I/O Process Programming Manual Prerequisite Reading The following manuals contain general information about SPI, EMS, and the management of data communications subsystems. You should be familiar with the information provided by these manuals, and you may need to refer them while using this manual.
Notation Conventions About This Manual Notation Conventions Hypertext Links Blue underline is used to indicate a hypertext link within text. By clicking a passage of text with a blue underline, you are taken to the location described. For example: This requirement is described under Backup DAM Volumes and Physical Disk Drives on page 3-2. General Syntax Notation This list summarizes the notation conventions for syntax presentation in this manual. UPPERCASE LETTERS.
General Syntax Notation About This Manual { } Braces. A group of items enclosed in braces is a list from which you are required to choose one item. The items in the list can be arranged either vertically, with aligned braces on each side of the list, or horizontally, enclosed in a pair of braces and separated by vertical lines. For example: LISTOPENS PROCESS { $appl-mgr-name } { $process-name } ALLOWSU { ON | OFF } | Vertical Line.
Notation for Messages About This Manual a blank line. This spacing distinguishes items in a continuation line from items in a vertical list of selections. For example: ALTER [ / OUT file-spec / ] LINE [ , attribute-spec ]… !i and !o. In procedure calls, the !i notation follows an input parameter (one that passes data to the called procedure); the !o notation follows an output parameter (one that returns data to the calling program).
Notation for Management Programming Interfaces About This Manual lowercase italic letters. Lowercase italic letters indicate variable items whose values are displayed or returned. For example: p-register process-name [ ] Brackets. Brackets enclose items that are sometimes, but not always, displayed.
Notation for Management Programming Interfaces About This Manual UPPERCASE LETTERS. Uppercase letters indicate names from definition files. Type these names exactly as shown. For example: ZCOM-TKN-SUBJ-SERV lowercase letters. Words in lowercase letters are words that are part of the notation, including Data Definition Language (DDL) keywords. For example: token-type !r. The !r notation following a token or field name indicates that the token or field is required. For example: ZCOM-TKN-OBJNAME !o.
About This Manual Notation for Management Programming Interfaces GDSX Management Programming Manual—529930-001 xiv
1 Introduction This section introduces the Extended General Device Support (GDSX) product and provides a brief explanation of its architecture. It also describes the objects that can be managed by the GDS subsystem and the commands that enable you to carry out different management functions.
Introduction • • How Applications Fit Into the GDSX Architecture It is efficient to transfer as many routine management tasks as possible on to the computer system or network itself. Doing this frees the operators and other personnel to do the work that requires judgment and creativity. Information obtained through the programmatic interfaces can be used directly by an application to control its actions, produce reports, and so forth.
Commands an Application Can Issue Introduction Figure 1-1. How an Application Fits Into GDSX Architecture User Business Transaction Program (SCREEN COBOL) User-Written Requesters Pathway/iTS TCP Application Interfaces $0 Event Collector TACL Macros or User Application Mgmt.
Event Messages Introduction Table 1-1. GDSX Management Programming Commands Command Description ABORT Terminates the operation of lines or subdevices immediately. ADD Defines lines or subdevices to the GDS subsystem. ALLOWOPENS Allows subdevices to accept further connections. ALTER Changes the values of attributes of processes, lines, or subdevices. DELETE Removes lines or subdevices from GDS. FORBIDOPENS Prevents further connections from being established to subdevices.
GDSX Management Functions Introduction • • • The TASK object that is an independent entity running within GDSX and is responsible for a specific function The LINE object which is a communication line controlled by GDSX The SUBDEVICE (SU) object which is a logical terminal that is known to application programs and is mapped to a physical terminal by GDSX The STOPPED and STARTED object states occur in GDSX. Both lines and terminals can be in these states.
Programmatic Commands Versus Interactive Commands Introduction • • • Size and capacity parameters (such as memory size). These parameters determine the resources needed to run a GDSX process. Attribute parameters (such as a flag specifying whether or not dynamic terminals are supported). These parameters determine the attributes of a terminal. Control parameters (such as whether or not debugging is used).
Programmatic Commands Versus Interactive Commands Introduction Table 1-2.
Introduction Programmatic Commands Versus Interactive Commands GDSX Management Programming Manual—529930-001 1 -8
2 Communicating With GDSX This section provides subsystem-specific information about the tokens used to communicate with the GDS subsystem. General information about tokens can be found in the SPI Programming Manual, and information about tokens that is common to all data communications subsystems can be found in the SPI Common Extensions Manual.
Naming Rules and Guidelines for Applications Communicating With GDSX • • Data communications definition file GDS definition file If the application also communicates with other subsystems, then the definition files for those other subsystems must also be used. For example, a GDSX application written in COBOL85 that retrieves event messages would require the following definition files: ZSPIDEF.ZSPICOB ZSPIDEF.ZEMSCOB ZSPIDEF.ZCOMCOB ZSPIDEF.
Commands and Command Numbers Communicating With GDSX Commands and Command Numbers In the GDS subsystem, command numbers are represented by symbolic names of the form ZCOM-CMD-name, where name identifies the command. The command number is a 16-bit unsigned integer.
Communicating With GDSX Event Numbers $GDS.*.*. Section 1 describes the kinds of objects the GDS subsystem manages. The names of all object types are defined in Section 4, Common Definitions. Event Numbers In the GDS subsystem, event numbers are represented by symbolic names of the form ZGDS-EVT-name, where name identifies the event. Each event message is assigned a different number. GDSX event message numbers and their associated event messages are described in Section 6, Event Messages.
Communicating With GDSX Other Tokens Predefined Value Names The predefined values used by the GDS subsystem are represented by symbolic names of the form subsys-VAL-name, where subsys is the four-character subsystem abbreviation and name identifies the predefined value. For example, ZGDSVAL-VERSION is a predefined value name containing the value “D10.” Extensible Structured Tokens All GDSX commands use extensible structured tokens.
Communicating With GDSX Constructs Involving Multiple Tokens Constructs Involving Multiple Tokens The GDS subsystem supports data lists and error lists as described in the SPI Programming Manual. Components of Commands and Responses Each GDSX command and response and the tokens contained are described in Section 5, Commands and Responses. Considerations for building command buffers and decoding response buffers are described in Section 3, SPI Programming Considerations.
3 SPI Programming Considerations This section discusses the SPI programming considerations that are specific to the GDS subsystem. Building the Command Buffer The following programming considerations are relevant when an application builds the command buffer for a GDSX command: • • • • • • • The recommended buffer length in bytes for a GDSX command is a predefined value with the symbolic name ZGDS-VAL-BUFLEN. The GDS subsystem does not support multiple commands in a single request message.
SPI Programming Considerations Discontinuing a Command in Progress Discontinuing a Command in Progress When the GDS subsystem discontinues a command because of an error or warning, it immediately sends a reply message to the application. The GDS subsystem supports the use of the token ZSPI-TKN-ALLOW-TYPE, which allows an application to specify, in a command operating on multiple objects, whether or not GDSX should continue with the next object if it failed on the previous one.
SPI Programming Considerations Version Compatibility Version Compatibility The version of GDSX must be D10.00 or later to run correctly with the managementprogramming interfaces. Maintaining Security Security for the GDS subsystem is handled by GDSX itself as described in the Extended General Device Support (GDSX) Manual. Some of the GDSX commands are sensitive commands, meaning that they can be issued only by certain users.
SPI Programming Considerations GDSX Management Programming Manual—529930-001 3 -4 Maintaining Security
4 Common Definitions The token-oriented programmatic interface to the GDS subsystem makes use of definitions from four different sources: the SPI standard definitions, the EMS standard definitions, the data communications standard definitions, and the GDS definitions. The common definitions from these four sources that can be used in a management application to communicate with the GDS subsystem are explained here.
SPI Standard Definitions Common Definitions Table 4-1.
EMS Standard Definitions Common Definitions ZSPI-TKN-CMD contains the command number of a GDSX command. These command numbers and their associated commands are described in Section 5, Commands and Responses. ZSPI-TKN-ERROR is the error token. For descriptions of the GDSX error numbers and their associated error lists, refer to Section 7, Error Numbers and Error Lists. ZSPI-TKN-MANAGER contains the file name of the GDSX process. This token is optional for GDSX.
Data Communications Standard Definitions Common Definitions These definitions consist of the following: • • Header tokens available to applications using GDSX Simple tokens used in GDS event messages Table 4-2.
Data Communications Standard Definitions Common Definitions Table 4-3.
Common Definitions for the GDS Subsystem Common Definitions ZCOM-TKN-OBJNAME contains the name of a GDSX object. The object name of a line object or subdevice object is the name of a specific line or subdevice, respectively, usually configured on a single system. These names are assigned at system generation time, and they are unique within a system. The object name of a process object can be any name, but it cannot be the same as the name of a line object (that is, $GDS.#GDS is not valid).
Tokens in Error Lists Common Definitions ZGDS-VAL-MAXBUFLEN is the maximum buffer size in bytes for command messages sent to the GDS subsystem. ZGDS-VAL-SSID is the subsystem ID for the GDS subsystem. Its structure definition is given on page 4-7. For more information about ZGDS-VAL-SSID, refer to the discussion of the subsystem ID in the SPI Programming Manual. ZGDSX-VAL-VERSION is the version number of the GDS subsystem software.
Tokens in Event Messages Common Definitions ZGDS-TKN-DEVTYPE indicates what type of object generated the event. It has the token type ZSPI-TYPENUM. The following values are valid: • • • ZGDS-VAL-TYPE-TASK: The event is generated by a task. ZGDS-VAL-TYPE-LINE: The event is generated by a line. ZGDS-VAL-TYPE-TERM: The event is generated by a terminal. ZGDS-TKN-OPENER identifies a requester in a ZGDS-EVT-TASK-OPENED event or a ZGDS-EVTTASK-CLOSED event. It has the token type ZSPI-TYP-CRTPID.
5 Commands and Responses This section describes the syntax and semantics for all commands and responses in the programmatic control-and-inquiry interface to the GDS subsystem.
Commands by Object Type Commands and Responses Table 5-1.
Sensitive and Nonsensitive Commands Commands and Responses Table 5-2. Commands and Object Types (page 2 of 2) Object Types Command PROCESS TASK LINE SU STATISTICS X X X X STATUS X X X X STOP X X X SWITCH X TRACE X Sensitive and Nonsensitive Commands Commands are divided into two groups based on whether or not a user must have proper security to be able to use the command. These two groups, shown in Table 5-3, are called sensitive commands and nonsensitive commands.
Command Descriptions Commands and Responses command buffer, and another list specifying tokens that can be present in the response buffer. With the exception of the tokens ZSPI-TKN-DATALIST and ZSPI-TKN-ENDLIST, the order of the tokens as they appear in the command and response buffers, is not necessarily the same as the order in which they appear in a command or response. The token ZSPI-TKN-DATALIST, if present in a response, always occurs at the beginning of a response record.
ABORT Command Commands and Responses ABORT Command The ABORT command terminates the operation of a LINE or SU object as quickly as possible. Only enough processing is done to ensure the integrity of the subsystem. Command ZCOM-CMD-ABORT Object Type ZCOM-OBJ-LINE or ZCOM-OBJ-SU Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT ZCOM-TKN-SUB ZCOM-MAP-REQID def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end.
Commands and Responses ABORT Command ZCOM-TKN-OBJNAME is the name of the LINE or SU (subdevice) object to be terminated. This token is required and is described in ZCOM-TKN-OBJNAME on page 4-6. ZCOM-TKN-CMD-TIMEOUT ZCOM-MAP-REQID are described in the SPI Common Extensions Manual. Duplicate occurrences of these tokens are not allowed. ZCOM-TKN-SUB is described in the SPI Common Extensions Manual.
Commands and Responses ABORT Command For descriptions of all GDSX error numbers and their associated error lists, refer to Section 7, Error Numbers and Error Lists. ZSPI-TKN-ERRLIST is described in the SPI Programming Manual. The list ends with the token ZSPITKN-ENDLIST. ZSPI-TKN-CONTEXT is described in the SPI Programming Manual. Operational Notes After this command is executed, the final summary state is STOPPED. ZCOM-TKN-SUB is supported only when the line object type is specified.
ADD Command Commands and Responses ADD Command The ADD command defines a LINE or SU object to the GDS subsystem. Command ZCOM-CMD-ADD Object Type ZCOM-OBJ-LINE or ZCOM-OBJ-SU Tokens in Command Buffer ZSPI-TKN-MANAGER TYPE ZSPI-TYP-FNAME32.!o ZGDS-MAP-ADD-LINE def ZGDS-DDL-ADD-LINE 02 ZACCESSNAME TYPE ZSPI-DDL-FNAME.!r 02 ZNOWAIT-DEPTH TYPE ZSPI-DDL-INT.!r end.
ADD Command Commands and Responses Tokens in Response Buffer ZSPI-TKN-DATALIST ... ZSPI-TKN-ENDLIST ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ... ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT TYPE ZSPI-TYP-LIST. TYPE TYPE TYPE TYPE TYPE ZSPI-TYP-SSCTL. ZSPI-TYP-STRING. ZCOM-TYP-ENM-OBJ. ZSPI-TYP-ENUM. ZSPI-TYP-LIST. TYPE ZSPI-TYP-SSCTL. TYPE ZSPI-TYP-BYTESTRING. Tokens in Command Buffer ZSPI-TKN-MANAGER is the file name of the GDSX process.
Commands and Responses ADD Command ZACCESSNAME is appropriate only when the GDS subsystem is interfaced to subsystems other than CP6100 and ENVOY. The device name can be up to 24 characters long in extended form. If you do not assign a value to this field, the default is the qualifier name of the subdevice object name. ZEXT-SU-SIZE specifies the length of the user’s extended data. If you do not assign a value to this field, the default is the value of the GDSX configuration parameter EXTSUSIZE.
Commands and Responses ADD Command ZCOM-TKN-OBJNAME is the name of the LINE or SU (subdevice) object to be added. This token is required and is described in ZCOM-TKN-OBJNAME on page 4-6. ZCOM-TKN-CMD-TIMEOUT ZCOM-MAP-REQID are described in the SPI Common Extensions Manual. Duplicate occurrences of these tokens are not allowed. ZSPI-TKN-MAXRESP ZSPI-TKN-CONTEXT ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT are described in the SPI Programming Manual.
ALLOWOPENS Command Commands and Responses For descriptions of all GDS subsystem error numbers and their associated error lists, refer to Section 7, Error Numbers and Error Lists. ZSPI-TKN-ERRLIST ZSPI-TKN-CONTEXT are described in the SPI Programming Manual. . Operational Notes After this command is executed, the final summary state is STOPPED. Before a subdevice can be added, the line with which it is associated must be added.
ALLOWOPENS Command Commands and Responses Tokens in Response Buffer ZSPI-TKN-DATALIST ... ZSPI-TKN-ENDLIST ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ... ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT TYPE ZSPI-TYP-LIST. TYPE TYPE TYPE TYPE TYPE ZSPI-TYP-SSCTL. ZSPI-TYP-STRING. ZCOM-TYP-ENM-OBJ. ZSPI-TYP-ENUM. ZSPI-TYP-LIST. TYPE ZSPI-TYP-SSCTL. TYPE ZSPI-TYP-BYTESTRING. Tokens in Command Buffer ZSPI-TKN-MANAGER is the file name of the GDSX process.
Commands and Responses ALTER Command ZCOM-TKN-OBJTYPE is the type of object named in ZCOM-TKN-OBJNAME. The following value is valid: • ZCOM-OBJ-SU: The object is a subdevice. ZCOM-TKN-OBJTYPE is present in every response record and is described in the SPI Common Extensions Manual. ZSPI-TKN-RETCODE is described in the SPI Programming Manual.
ALTER Command Commands and Responses Tokens in Command Buffer ZSPI-TKN-MANAGER TYPE ZSPI-TYP-FNAME32.!o ZGDS-MAP-ALTER-PROC def ZGDS-DDL-ALTER-PROC 02 ZASSOC TYPE ZSPI-DDL-BOOLEAN.!r 02 ZDYN-MAP TYPE ZSPI-DDL-BOOLEAN.!r 02 ZSESS TYPE ZSPI-DDL-BOOLEAN.!r 02 ZSTATS TYPE ZSPI-DDL-BOOLEAN.!r 02 ZPSEUDO-MSG TYPE ZSPI-DDL-BOOLEAN.!r 02 ZTRAP-DEBUG TYPE ZSPI-DDL-ENUM.!r 02 ZUSER-DEBUG TYPE ZSPI-DDL-BOOLEAN.!r 02 ZBKUP-DEBUG TYPE ZSPI-DDL-BOOLEAN.!r 02 ZPOOL-CHECK TYPE ZSPI-DDL-BOOLEAN.
ALTER Command Commands and Responses Tokens in Command Buffer (continued) ZGDS-MAP-ALTER-SU def ZGDS-DDL-ALTER-SU 02 ZACCESSNAME 02 ZEXT-SU-SIZE 02 ZASSOC 02 ZAUTOSTOP 02 ZNOWAIT-DEPTH 02 ZSUTYPE 02 ZUSER-DATA 02 02 02 ZDEVTYPE ZDEVSUBTYPE ZDEVRECLEN TYPE TYPE TYPE TYPE TYPE TYPE TYPE ZSPI-DDL-FNAME.!r ZSPI-DDL-INT.!r ZSPI-DDL-BOOLEAN.!r ZSPI-DDL-BOOLEAN.!r ZSPI-DDL-INT.!r ZSPI-DDL-ENUM.!r ZSPI-DDL-INT.!r occurs 128 times TYPE ZSPI-DDL-INT.!r TYPE ZSPI-DDL-INT. !r TYPE ZSPI-DDL-INT. !r end.
Commands and Responses ALTER Command ZGDS-MAP-ALTER-PROC is a structured token that describes the process being altered. It has the token number ZGDS-TNM-ALTER-PROC and the DDL definition ZGDS-DDL-ALTERPROC. This token is required and must occur only once. ZGDS-MAP-ALTERPROC contains the following fields: ZASSOC specifies how many TERM tasks are created to handle requests to a terminal.
Commands and Responses ALTER Command ZPSEUDO-MSG refers to messages for pseudo OPENs and CLOSEs. The following values are valid: • • ON: Pseudo-messages are sent to the corresponding task. OFF: Pseudo-messages are not sent. If you do not assign a value to this field, the default is OFF. ZTRAP-DEBUG is the debug error trap number. If you do not assign a value to this field, the default is 0. ZUSER-DEBUG is the user task debug flag.
Commands and Responses ALTER Command If you do not assign a value to this field, the default is OFF. ZDYN refers to dynamic terminals. The following values are valid: • • ON: Dynamic terminals can be created. OFF: All terminals must be preconfigured using the ADD TERM command. If you do not assign a value to this field, the default is ON. ZDYN-NOWAIT-DEPTH is the nowait depth for dynamic terminals. Valid values are in the range from 1 through 15.
Commands and Responses • • ALTER Command C: Any member of the owner’s group can alter the process from any network node. N: Any user can alter the process from any network node. If you do not assign a value to this field, the default is G. ZGDS-MAP-ALTER-LINE is a structured token that describes the line being altered. It has the token number ZGDS-TNM-ALTER-LINE and the DDL definition ZGDS-DDL-ALTER-LINE. This token is required and must occur only once.
Commands and Responses ALTER Command ZCOM-TKN-OBJTYPE is the type of object named in ZCOM-TKN-OBJNAME. The following values are valid: • • • ZCOM-OBJ-PROCESS: The object is a process. ZCOM-OBJ-LINE: The object is a line. ZCOM-OBJ-SU: The object is a subdevice. ZCOM-TKN-OBJTYPE is present in every response record and is described in the SPI Common Extensions Manual. ZSPI-TKN-RETCODE is described in the SPI Programming Manual.
DELETE Command Commands and Responses DELETE Command The DELETE command removes LINE or SU objects from the subsystem. Only objects that were added with the ADD command can be deleted. Command ZCOM-CMD-DELETE Object Type ZCOM-OBJ-LINE or ZCOM-OBJ-SU Tokens in Command Buffer ZSPI-TKN-MANAGER TYPE ZSPI-TYP-FNAME32.!o ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT ZCOM-TKN-SUB ZCOM-MAP-REQID def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end.
Commands and Responses DELETE Command ZCOM-TKN-OBJNAME is the name of the object to be deleted. This token is required. ZCOM-TKN-CMD-TIMEOUT ZCOM-MAP-REQID are described in the SPI Common Extensions Manual. Duplicate occurrences of these tokens are not allowed. ZCOM-TKN-SUB is described in the SPI Common Extensions Manual. ZSPI-TKN-MAXRESP ZSPI-TKN-CONTEXT ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT are described in the SPI Programming Manual.
Commands and Responses DELETE Command For descriptions of all GDS subsystem error numbers and their associated error lists, refer to Section 7, Error Numbers and Error Lists. ZSPI-TKN-ERRLIST ZSPI-TKN-CONTEXT are described in the SPI Programming Manual. Operational Note ZCOM-TKN-SUB is supported only when the line object type is specified.
FORBIDOPENS Command Commands and Responses FORBIDOPENS Command The FORBIDOPENS command prohibits an SU object from having further connections created to it. The command has no effect on existing connections or connections created from the SU object. Command ZCOM-CMD-FORBIDOPENS Object Type ZCOM-OBJ-SU Tokens in Command Buffer ZSPI-TKN-MANAGER TYPE ZSPI-TYP-FNAME32.!o ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT ZCOM-MAP-REQID def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end.
Commands and Responses FORBIDOPENS Command ZCOM-TKN-OBJNAME is the name of the object to be acted upon. This token is required. ZCOM-TKN-CMD-TIMEOUT ZCOM-MAP-REQID are described in the SPI Common Extensions Manual. Duplicate occurrences of these tokens are not allowed. ZSPI-TKN-MAXRESP ZSPI-TKN-CONTEXT ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT are described in the SPI Programming Manual. Duplicate occurrences of these tokens are not allowed.
GETVERSION Command Commands and Responses ZSPI-TKN-ERRLIST ZSPI-TKN-CONTEXT are described in the SPI Programming Manual. GETVERSION Command The GETVERSION command displays the version level of the specified process object. Command ZCOM-CMD-GETVERSION Object Type ZCOM-OBJ-PROCESS Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT ZCOM-MAP-REQID def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end.
Commands and Responses GETVERSION Command ZCOM-TKN-OBJNAME is the name of the PROCESS object to which the command is directed. This token is required and is described in ZCOM-TKN-OBJNAME on page 4-6. ZCOM-TKN-CMD-TIMEOUT ZCOM-MAP-REQID are described in the SPI Common Extensions Manual. Duplicate occurrences of these tokens are not allowed. ZSPI-TKN-MAXRESP ZSPI-TKN-CONTEXT ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT are described in the SPI Programming Manual.
INFO Command Commands and Responses INFO Command The INFO command displays the current or default attribute settings for the specified PROCESS, TASK, LINE, or SU (subdevice) object. Command ZCOM-CMD-INFO Object Type ZCOM-OBJ-PROCESS or ZCOM-OBJ-TASK or ZCOM-OBJ-LINE or ZCOM-OBJ-SU Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT ZCOM-TKN-SUB ZCOM-MAP-REQID def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end.
INFO Command Commands and Responses Tokens in Response Buffer ZSPI-TKN-DATALIST ... ZSPI-TKN-ENDLIST TYPE ZSPI-TYP-LIST. TYPE ZSPI-TYP-SSCTL. ZGDS-MAP-INFO-PROC def ZGDS-DDL-INFO-PROC. 02 ZASSOC TYPE 02 ZDYN TYPE 02 ZDYN-NOWAIT-DEPTH TYPE 02 ZIOCB-WAIT-TIME TYPE 02 ZLOOP-TIME TYPE 02 ZMAX-CP-SIZE TYPE 02 ZMAX-IOCBS TYPE 02 ZMAX-LINES TYPE 02 ZMAX-FILES TYPE ZSPI-DDL-BOOLEAN. ZSPI-DDL-BOOLEAN. ZSPI-DDL-INT. ZSPI-DDL-INT. ZSPI-DDL-INT. ZSPI-DDL-INT. ZSPI-DDL-INT. ZSPI-DDL-INT. ZSPI-DDL-INT.
INFO Command Commands and Responses Tokens in Response Buffer (continued) 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 ZMAX-OPENS ZMAX-TASKS ZMAX-TERMS ZMAX-PROCS ZTRAP-DEBUG ZAUTOTRACE ZUSER-DEBUG ZBKUP-DEBUG ZPOOL-CHECK ZFATAL-DEBUG ZDYN-MAP ZSESS ZSTATS ZPSEUDO-MSG ZSECUR ZAUTO-RESTART ZRESTART-TIME ZTRACERECSIZE ZTMFFLAG ZCONTROL26 ZBUFFERWAIT ZAUTOSTOP ZDEVICEINFO ZMAXITC ZSERVER ZMAXLCBS ZUSERSTARTSU ZMAXTC
INFO Command Commands and Responses Tokens in Response Buffer (continued) ZGDS-MAP-INFO-TASK def ZGDS-DDL-INFO-TASK. 02 ZWAIT-EVTS TYPE 02 ZTASKNUM TYPE 02 ZLAST-EVTS TYPE 02 ZFILE-ERR TYPE 02 ZSTATE TYPE 02 ZSTATE-X TYPE 02 ZOPENID TYPE 02 ZTASKTYPE TYPE end. ZSPI-DDL-INT. ZSPI-DDL-INT. ZSPI-DDL-INT. ZSPI-DDL-UINT. ZSPI-DDL-INT. ZSPI-DDL-INT. ZSPI-DDL-INT2. ZSPI-DDL-INT. or ZGDS-MAP-INFO-LINE def ZGDS-DDL-INFO-LINE. 02 02 02 02 02 end.
Commands and Responses INFO Command Tokens in Command Buffer ZSPI-TKN-MANAGER is the file name of the GDSX process. This token is optional if the process name exists in ZCOM-TKN-OBJNAME; the token must occur only once. See the SPI Programming Manual for a description of this token. ZCOM-TKN-OBJNAME is the name of the object to which the command is directed. This token is required and is described in ZCOM-TKN-OBJNAME on page 4-6.
Commands and Responses • INFO Command OFF: One TERM task is created to handle each requester opening a terminal. If multiple requesters make multiple requests to a terminal, then multiple TERM tasks are created; that is, one TERM task per opener. ZDYN refers to dynamic terminals. The following values are valid: • • ON: Dynamic terminals can be created. OFF: All terminals must be preconfigured using the ADD TERM command. ZDYN-NOWAIT-DEPTH is the nowait depth for dynamic terminals.
Commands and Responses INFO Command ZMAX-TERMS is the maximum number of terminal tasks that can run within GDSX. ZMAX-PROCS is the maximum number of processes started by GDSX that can run at one time. ZTRAP-DEBUG is the debug error trap number. ZAUTOTRACE indicates whether the tracing function is turned on. The following values are valid: • • ON: The TRACE function was automatically turned on when GDSX was started. OFF: The TRACE function is turned off. ZUSER-DEBUG is the user task debug flag.
Commands and Responses • INFO Command OFF: GDSX does not enter DEBUG when a fatal error occurs. ZDYN-MAP specifies the dynamic session control. The following values are valid: • • ON: Dynamic mapping is used between a TERM task and a LINE task. OFF: Dynamic mapping is not used. ZSESS specifies the session control mechanism. The following values are valid: • • ON: You define your own mechanism for session control in dynamic mapping.
Commands and Responses • • • • • • INFO Command G: Any member of the owner’s group may alter the process, provided that the member runs SPI on the node from which the GDSX process was created. A: Any user may alter the process, provided that the user runs SPI on the node from which the GDSX process was created. -: Only SUPER.SUPER ID on the GDSX process’ node can alter a GDSX process. Note that the local SUPER.SUPER ID can always alter a GDSX process.
Commands and Responses INFO Command ZOPENID is the opener identifier. ZTASKTYPE indicates the type of task—TERM task or LINE task. ZGDS-MAP-INFO-LINE is a structured token containing the current or default attribute settings for a LINE object. It has the token number ZGDS-TNM-INFO-LINE and the DDL definition ZGDS-DDL-INFO-LINE. ZGDS-MAP-INFO-LINE contains the following fields: ZACCESSNAME is the name of the device to be opened when the line is started. ZOPENS is the number of current OPENs.
Commands and Responses INFO Command ZASSOC indicates whether one or multiple TERM tasks are created to handle requests to a terminal. The following values are valid: • • ON: Only one TERM task handles all requesters attempting to open a particular physical terminal; that is, one TERM task per terminal. OFF: One TERM task is created to handle each requester opening a terminal.
Commands and Responses LISTOBJECTS Command ZSPI-TKN-RETCODE is described in the SPI Programming Manual. A value of this token that might occur in response to the INFO command is the following: • 1: ZGDS-ERR-OBJNAME-UNKNOWN For descriptions of all GDSX error numbers and their associated error lists, refer to Section 7, Error Numbers and Error Lists. ZSPI-TKN-ERRLIST is described in the SPI Programming Manual. The list ends with the token ZSPITKN-ENDLIST.
LISTOBJECTS Command Commands and Responses Object Type ZCOM-OBJ-PROCESS or ZCOM-OBJ-LINE or ZCOM-OBJ-SU Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT ZCOM-TKN-SUB ZCOM-MAP-REQID def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end. ZSPI-TKN-MAXRESP ZSPI-TKN-CONTEXT ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT TYPE TYPE TYPE TYPE ZSPI-TYP-FNAME32.!o ZSPI-TYP-STRING.!r ZSPI-TYP-TIMESTAMP.!o ZCOM-TYP-ENM-SUB.!o TYPE ZSPI-DDL-CRTPID.!o TYPE ZSPI-DDL-INT.
Commands and Responses LISTOBJECTS Command ZCOM-TKN-CMD-TIMEOUT ZCOM-MAP-REQID are described in the SPI Common Extensions Manual. Duplicate occurrences of these tokens are not allowed. ZCOM-TKN-SUB is described in the SPI Common Extensions Manual. ZSPI-TKN-MAXRESP ZSPI-TKN-CONTEXT ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT are described in the SPI Programming Manual. Duplicate occurrences of these tokens are not allowed.
LISTOPENS Command Commands and Responses ZSPI-TKN-ERRLIST is described in the SPI Programming Manual. The list ends with the token ZSPI-TKN-ENDLIST. ZSPI-TKN-CONTEXT is described in the SPI Programming Manual. LISTOPENS Command The LISTOPENS command returns information about the origin of the connection (the opener) of the specified SU object.
Commands and Responses LISTOPENS Command Tokens in Response Buffer ZSPI-TKN-DATALIST TYPE ZSPI-TYP-LIST. ... ZSPI-TKN-ENDLIST TYPE ZSPI-TYP-SSCTL. ZGDS-MAP-LISTOP-SU def ZGDS-DDL-LISTOP-SU. 02 ZPROCID TYPE ZSPI-DDL-INT occurs 3 times. 02 ZPPID TYPE ZSPI-DDL-INT. 02 ZBPID TYPE ZSPI-DDL-INT. 02 ZSYNCDEPTH TYPE ZSPI-DDL-INT. 02 ZOWNER TYPE ZSPI-DDL-INT. end. ZCOM-TKN-OBJNAME TYPE ZSPI-TYP-STRING. ZCOM-TKN-OBJTYPE TYPE ZCOM-TYP-ENM-OBJ. ZSPI-TKN-RETCODE TYPE ZSPI-TYP-ENUM. ZSPI-TKN-ERRLIST TYPE ZSPI-TYP-LIST.
Commands and Responses LISTOPENS Command Tokens in Response Buffer ZSPI-TKN-DATALIST is described in the SPI Programming Manual. ZGDS-MAP-LISTOP-SU is a structured token containing information about the origin of the connection (the opener) of the specified subdevice. It has the token number ZGDS-TNM-LISTOPSU and the DDL definition ZGDS-DDL-LISTOP-SU. ZGDS-MAP-LISTOP-SU contains the following fields: ZPROCID is the process ID. ZPPID is the primary process ID (the CPU number and the process number).
RESETSTATS Command Commands and Responses ZSPI-TKN-ERRLIST is described in the SPI Programming Manual. The list ends with the token ZSPITKN-ENDLIST. ZSPI-TKN-CONTEXT is described in the SPI Programming Manual. RESETSTATS Command The RESETSTATS command returns and then resets the current statistical information for the specified PROCESS, TASK, LINE, or SU (subdevice) object.
RESETSTATS Command Commands and Responses Tokens in Response Buffer ZSPI-TKN-DATALIST ... ZSPI-TKN-ENDLIST ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ... ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT TYPE ZSPI-TYP-LIST. TYPE TYPE TYPE TYPE TYPE ZSPI-TYP-SSCTL. ZSPI-TYP-STRING. ZCOM-TYP-ENM-OBJ. ZSPI-TYP-ENUM. ZSPI-TYP-LIST. TYPE ZSPI-TYP-SSCTL. TYPE ZSPI-TYP-BYTESTRING. Tokens in Command Buffer ZSPI-TKN-MANAGER is the file name of the GDSX process.
Commands and Responses START Command ZCOM-TKN-OBJTYPE is the type of object named in ZCOM-TKN-OBJNAME on page 4-6. The following values are valid: • • • • ZCOM-OBJ-PROCESS: The object is a process. ZCOM-OBJ-TASK: The object is a task. ZCOM-OBJ-LINE: The object is a line. ZCOM-OBJ-SU: The object is a subdevice. ZCOM-TKN-OBJTYPE is present in every response record and is described in the SPI Common Extensions Manual. ZSPI-TKN-RETCODE is described in the SPI Programming Manual.
START Command Commands and Responses Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT ZCOM-TKN-SUB ZCOM-MAP-REQID def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end. ZSPI-TKN-MAXRESP ZSPI-TKN-CONTEXT ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT TYPE TYPE TYPE TYPE ZSPI-TYP-FNAME32.!o ZSPI-TYP-STRING.!r ZSPI-TYP-TIMESTAMP.!o ZCOM-TYP-ENM-SUB.!o TYPE ZSPI-DDL-CRTPID.!o TYPE ZSPI-DDL-INT.!o TYPE TYPE TYPE TYPE TYPE ZSPI-TYP-INT.!r ZSPI-TYP-BYTESTRING.
Commands and Responses START Command ZSPI-TKN-MAXRESP ZSPI-TKN-CONTEXT ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT are described in the SPI Programming Manual. Duplicate occurrences of these tokens are not allowed. Tokens in Response Buffer ZSPI-TKN-DATALIST is described in the SPI Programming Manual. ZCOM-TKN-OBJNAME is the name of the object to be started. This token is present in every response record. ZCOM-TKN-OBJTYPE is the type of object named in ZCOM-TKN-OBJNAME.
STATISTICS Command Commands and Responses For a given line, no SU object can enter the STARTED state until the LINE object has entered the STARTED state. STATISTICS Command The STATISTICS command returns statistical information about the specified PROCESS, TASK, LINE, or SU (subdevice) object.
STATISTICS Command Commands and Responses Tokens in Response Buffer ZSPI-TKN-DATALIST ... ZSPI-TKN-ENDLIST ZGDS-MAP-STATS-PROC def ZGDS-DDL-STATS-PROC. 02 ZGDS-TCB. 04 ZSIZE 04 ZINUSE 04 ZLARGEST 04 ZATTEMPTS 04 ZWAITES 04 ZWAITER 04 ZMAX-WAITERS 04 ZFAILS TYPE ZSPI-TYP-LIST. TYPE ZSPI-TYP-SSCTL. TYPE TYPE TYPE TYPE TYPE TYPE TYPE TYPE ZSPI-DDL-INT2. ZSPI-DDL-INT2. ZSPI-DDL-INT2. ZSPI-DDL-INT2. ZSPI-DDL-INT2. ZSPI-DDL-INT. ZSPI-DDL-INT. ZSPI-DDL-INT2.
STATISTICS Command Commands and Responses Tokens in Response Buffer (continued) 02 ZGDS-FCB. ZSIZE ZINUSE ZLARGEST ZATTEMPTS ZWAITES ZWAITER ZMAX-WAITERS ZFAILS 02 ZGDS-RCB. 04 ZSIZE 04 ZINUSE 04 ZLARGEST 04 ZATTEMPTS 04 ZWAITES 04 ZWAITER 04 ZMAX-WAITERS 04 ZFAILS 02 ZGDS-IOCB. 04 ZSIZE 04 ZINUSE 04 ZLARGEST 04 ZATTEMPTS 04 ZWAITES 04 ZWAITER 04 ZMAX-WAITERS 04 ZFAILS 02 ZGDS-BUF-POOL. 04 ZSIZE 04 ZINUSE 04 ZLARGEST 04 ZATTEMPTS 04 ZWAITES 04 ZWAITER 04 ZMAX-WAITERS 04 ZFAILS 02 ZGDS-MSG-POOL.
STATISTICS Command Commands and Responses Tokens in Response Buffer (continued) 04 04 ZMAX-WAITERS ZFAILS 02 ZGDS-DCBS. 04 ZSIZE 04 ZINUSE 04 ZLARGEST 04 ZATTEMPTS 04 ZWAITES 04 ZWAITER 04 ZMAX-WAITERS 04 ZFAILS 02 ZGDS-BUF-POOLX. 04 ZSIZE 04 ZINUSE 04 ZLARGEST 04 ZATTEMPTS 04 ZWAITES 04 ZWAITER 04 ZMAX-WAITERS 04 ZFAILS 02 ZGDS-MSG-POOLX. 04 ZSIZE 04 ZINUSE 04 ZLARGEST 04 ZATTEMPTS 04 ZWAITES 04 ZWAITER 04 ZMAX-WAITERS 04 ZFAILS TYPE ZSPI-DDL-INT. TYPE ZSPI-DDL-INT2.
STATISTICS Command Commands and Responses Tokens in Response Buffer (continued) or ZGDS-MAP-STATS-LINE. def ZGDS-DDL-STATS-LINE. 02 ZRECV-MSGS TYPE ZSPI-DDL-INT2. 02 ZRECV-BYTES TYPE ZSPI-DDL-INT4. 02 ZRECV-LARGEST TYPE ZSPI-DDL-INT. 02 ZREPLIES TYPE ZSPI-DDL-INT2. 02 ZREPLY-BYTES TYPE ZSPI-DDL-INT4. 02 ZREPLY-LARGEST TYPE ZSPI-DDL-INT. 02 ZDSPTCHS TYPE ZSPI-DDL-INT2. 02 ZCHKPTS TYPE ZSPI-DDL-INT2 occurs 2 times. 02 ZITC-MSGS TYPE ZSPI-DDL-INT2. 02 ZITC-BYTES TYPE ZSPI-DDL-INT4.
Commands and Responses STATISTICS Command Tokens in Command Buffer ZSPI-TKN-MANAGER is the file name of the GDSX process. This token is optional if the process name exists in ZCOM-TKN-OBJNAME on page 4-6; the token must occur only once. See the SPI Programming Manual for a description of this token. ZCOM-TKN-OBJNAME is the name of the object to which the command is directed. This token is required and is described in ZCOM-TKN-OBJNAME on page 4-6.
Commands and Responses • • • • • STATISTICS Command ZATTEMPTS: Number of TCB allocation attempts ZWAITES: Total number of TCB events waiting ZWAITER: Number of TCB events currently waiting ZMAX-WAITERS: Maximum number of TCB events allowed to wait ZFAILS: Number of TCB allocation attempts that failed ZGDS-FCB contains file-control-block (FCB) statistics.
Commands and Responses STATISTICS Command ZGDS-IOCB contains I/O-control-block (IOCB) statistics.
Commands and Responses • STATISTICS Command ZFAILS: Number of message pool allocation attempts that failed ZGDS-EXT-POOL contains external pool statistics.
Commands and Responses STATISTICS Command ZCHKPTS is the number of checkpoints used. ZITC-MSGS is the number of internal task communication messages. ZITC-BYTES is the number of bytes used for all internal task communication messages. ZWRITES is the number of WRITE commands issued. ZOUT-BYTES is the number of bytes written. ZREADS is the number of READ commands issued. ZIN-BYTES is the number of bytes read. ZERRS is the number of errors.
Commands and Responses STATISTICS Command ZREPLY-BYTES is the number of bytes of message replies sent. ZREPLY-LARGEST is the largest number of bytes of message replies sent. ZDSPTCHS is the number of dispatches. ZCHKPTS is the number of checkpoints used. ZITC-MSGS is the number of internal task communication messages. ZITC-BYTES is the number of bytes used for all internal task communication messages. ZWRITES is the number of WRITE commands issued. ZOUT-BYTES is the number of bytes written.
Commands and Responses STATISTICS Command ZRECV-BYTES is the number of bytes allocated for messages received. ZRECV-LARGEST is the largest number of message bytes received. ZREPLIES is the number of message replies sent. ZREPLY-BYTES is the number of bytes of message replies sent. ZREPLY-LARGEST is the largest number of bytes of message replies sent. ZDSPTCHS is the number of dispatches. ZCHKPTS is the number of checkpoints used. ZITC-MSGS is the number of internal task communication messages.
Commands and Responses STATUS Command ZCOM-TKN-OBJNAME is the name of the object for which statistical information is being returned. This token is present in every response record. ZCOM-TKN-OBJTYPE is the type of object named in ZCOM-TKN-OBJNAME. The following values are valid: • • • • ZCOM-OBJ-PROCESS: The object is a process. ZCOM-OBJ-TASK: The object is a task. ZCOM-OBJ-LINE: The object is a line. ZCOM-OBJ-SU: The object is a subdevice.
STATUS Command Commands and Responses Object Type ZCOM-OBJ-PROCESS or ZCOM-OBJ-TASK or ZCOM-OBJ-LINE or ZCOM-OBJ-SU Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT ZCOM-TKN-SUB ZCOM-MAP-REQID def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end. ZSPI-TKN-MAXRESP ZSPI-TKN-CONTEXT ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT TYPE TYPE TYPE TYPE ZSPI-TYP-FNAME32.!o ZSPI-TYP-STRING.!r ZSPI-TYP-TIMESTAMP.!o ZCOM-TYP-ENM-SUB.!o TYPE ZSPI-DDL-CRTPID.!o TYPE ZSPI-DDL-INT.
STATUS Command Commands and Responses Tokens in Response Buffer (continued) 02 02 end. ZLOG-FILE ZDEFLT-VOL TYPE ZSPI-DDL-FNAME. TYPE ZSPI-DDL-FNAME. or ZGDS-MAP-STATUS-TASK. def ZGDS-DDL-STATUS-TASK. 02 ZFILE-ERR TYPE 02 ZOPENS TYPE 02 ZTASKNUM TYPE 02 ZFNUM TYPE 02 ZSTATE TYPE 02 ZDEV-ERR TYPE 02 ZLAST-EVTS TYPE 02 ZWAIT-EVTS TYPE end. ZSPI-DDL-UINT. ZSPI-DDL-INT. ZSPI-DDL-INT. ZSPI-DDL-INT. ZSPI-DDL-INT. ZSPI-DDL-INT. ZSPI-DDL-UINT. ZSPI-DDL-UINT. or ZGDS-MAP-STATUS-LINE. def ZGDS-DDL-STATUS-LINE.
Commands and Responses STATUS Command Tokens in Command Buffer ZSPI-TKN-MANAGER is the file name of the GDSX process. This token is optional if the process name exists in ZCOM-TKN-OBJNAME on page 4-6; the token must occur only once. See the SPI Programming Manual for a description of this token. ZCOM-TKN-OBJNAME is the name of the object to which the command is directed. This token is required and is described in ZCOM-TKN-OBJNAME.
Commands and Responses STATUS Command ZAPID is the access process ID. ZUSER-TASKS is the number of user tasks. ZSYS-TASKS is the number of GDSX internal tasks. ZSSID is the subsystem ID. ZOWNER-SYSNUM is the system number of the GDSX creator. ZSYSNAME is the system name where GDSX is running. ZSYSNUM is the system number where GDSX is running. ZSWAP-FILE is the name of the swap file for GDSX. ZLIB-FILE is the name of the library file used by GDSX. ZLOG-FILE is the name of the log file (always $0).
Commands and Responses STATUS Command ZOPENS is the number of current OPENs. ZTASKNUM is the task number. ZFNUM is the file number. ZSTATE is the summary state of the object. ZDEV-ERR is the last error number. ZLAST-EVTS is the last dispatched event. ZWAIT-EVTS displays any waiting events. ZGDS-MAP-STATUS-LINE is a structured token containing the current summary-state information for the specified line. It has the token number ZGDS-TNM-STATUS-LINE and the DDL definition ZGDS-DDL-STATUS-LINE.
Commands and Responses STATUS Command ZDEV-ERR is the last error number. ZLAST-EVTS is the last dispatched event. ZWAIT-EVTS displays any waiting events. ZGDS-MAP-STATUS-SU is a structured token containing the current summary-state information for the specified subdevice. It has the token number ZGDS-TNM-STATUS-SU and the DDL definition ZGDS-DDL-STATUS-SU. ZGDS-MAP-STATUS-SU contains the following fields: ZFILE-ERR is the last file error. ZOPENS is the number of current OPENs. ZTASKNUM is the task number.
Commands and Responses STOP Command ZCOM-TKN-OBJTYPE is the type of object named in ZCOM-TKN-OBJNAME. The following values are valid: • • • • ZCOM-OBJ-PROCESS: The object is a process. ZCOM-OBJ-TASK: The object is a task. ZCOM-OBJ-LINE: The object is a line. ZCOM-OBJ-SU: The object is a subdevice. ZCOM-TKN-OBJTYPE is present in every response record and is described in the SPI Common Extensions Manual. ZSPI-TKN-RETCODE is described in the SPI Programming Manual.
STOP Command Commands and Responses Tokens in Command Buffer ZSPI-TKN-MANAGER TYPE ZSPI-TYP-FNAME32.!o ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT ZCOM-TKN-SUB ZCOM-MAP-REQID def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end. ZSPI-TKN-MAXRESP ZSPI-TKN-CONTEXT ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT TYPE ZSPI-TYP-STRING.!r TYPE ZSPI-TYP-TIMESTAMP.!o TYPE ZCOM-TYP-ENM-SUB.!o TYPE ZSPI-DDL-CRTPID.!o TYPE ZSPI-DDL-INT.!o TYPE TYPE TYPE TYPE TYPE ZSPI-TYP-INT.!r ZSPI-TYP-BYTESTRING.
Commands and Responses STOP Command ZSPI-TKN-MAXRESP ZSPI-TKN-CONTEXT ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT are described in the SPI Programming Manual. Duplicate occurrences of these tokens are not allowed. Tokens in Response Buffer ZSPI-TKN-DATALIST is described in the SPI Programming Manual. The list ends with the token ZSPITKN-ENDLIST. ZCOM-TKN-OBJNAME is the name of the object that was stopped. This token is present in every response record.
SWITCH Command Commands and Responses Operational Note After this command is executed, the final summary state is STOPPED. SWITCH Command The SWITCH command switches a process object between two resources, or initiates a planned takeover of a backup facility (for example, CPU). Command ZCOM-CMD-SWITCH Object Type ZCOM-OBJ-PROCESS Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-SWITCH-CPU ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT ZCOM-MAP-REQID def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end.
Commands and Responses SWITCH Command Tokens in Command Buffer ZSPI-TKN-MANAGER is the file name of the GDSX process. This token is optional if the process name exists in ZCOM-TKN-OBJNAME; the token must occur only once. See the SPI Programming Manual for a description of this token. ZCOM-TKN-SWITCH-CPU is described in the SPI Common Extensions Manual. Duplicate occurrences of this token is not allowed. ZCOM-TKN-OBJNAME is the name of the object to be switched. This token is required and is described in .
Commands and Responses TRACE Command ZCOM-TKN-OBJTYPE is present in every response record and is described in the SPI Common Extensions Manual. ZSPI-TKN-RETCODE is described in the SPI Programming Manual. A value of this token that might occur in response to the SWITCH command is the following: • 2: ZGDS-ERR-OBJSTATE-INV For descriptions of all GDSX error numbers and their associated error lists, refer to Section 7, Error Numbers and Error Lists.
TRACE Command Commands and Responses Tokens in Command Buffer ZSPI-TKN-MANAGER TYPE ZSPI-TYP-FNAME32.!o ZCOM-TKN-OBJNAME TYPE ZSPI-TYP-STRING.!r ZCOM-TKN-CMD-TIMEOUT TYPE ZSPI-TIMESTAMP.!o ZCOM-MAP-TRACE-MODIF def ZCOM-DDL-TRACE-MODIF. 02 ZSTOP TYPE ZSPI-DDL-BOOLEAN.!r 02 ZPRIM TYPE ZSPI-DDL-BOOLEAN.!r 02 ZREC-SIZE TYPE ZSPI-DDL-INT.!r 02 ZCNT TYPE ZSPI-DDL-INT2.!r 02 ZXDS-PAGES TYPE ZSPI-DDL-INT.!r 02 ZCOLL TYPE ZSPI-DDL-BOOLEAN.!r 02 ZFNAME TYPE ZSPI-DDL-FNAME32.!r 02 ZWRAP TYPE ZSPI-DDL-BOOLEAN end.
Commands and Responses TRACE Command ZCOM-TKN-OBJNAME is the object-name token containing the name of the process to be terminated. This token must be present in the command. ZCOM-TKN-OBJNAME on page 4-6 is described in Section 4, Common Definitions. ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard data communications tokens that are described in the SPI Common Extensions Manual. Duplicate occurrences of these tokens are not allowed.
TRACE Command Commands and Responses ZSPI-TKN-ERRLIST is a standard SPI error list, as described in the SPI Programming Manual. The list ends with the token ZSPI-TKN-ENDLIST. ZSPI-TKN-CONTEXT is the standard SPI context token described in the SPI Programming Manual. Operational Note The trace collector modifier is not supported. Programming Notes Table 5-4 contains a list of all trace options specific to the GDS subsystem (that is, options whose names begin with ZGDS-VAL-TRACE-OPT-).
TRACE Command Commands and Responses Table 5-4.
Commands and Responses GDSX Management Programming Manual—529930-001 5- 80 TRACE Command
6 Event Messages The GDS subsystem provides information about events that occur in the subsystem by issuing event messages. A management application can obtain these event messages by opening an Event Management System (EMS) distributor process and requesting the messages. The application can also specify that a filter be applied to select certain event messages.
Critical Events Event Messages Table 6-1.
Programming Considerations Event Messages Programming Considerations GDS event messages do not contain extensible structured tokens or lists. The eventmessage buffer size is 128 words. All GDS event messages are reported to EMS and none are reported to the HP Tandem Maintenance and Diagnostic System (TMDS). All messages are also displayed on the operator console controlled by the capability distributor ($Z0).
Header Tokens Event Messages Table 6-2. Standard EMS Header Tokens Token and Token Type Data Type Description ZEMS-TKN-CPU 16-bit integer Identifies the processor in which GDS was running when the event message was generated. 8 bytes Contains the Guardian internal format process ID of GDS. 16-bit integer Conveys an estimate of the seriousness of the event. If the value is ZSPI-VALTRUE, the event is a GDS subsystem internal error condition.
Standard EMS Token Event Messages Standard EMS Token Table 6-4 lists a standard EMS token that appears in all event messages but is not a message-header token; it is an unconditional token. Table 6-4. Standard EMS Token Token Description ZEMS-TKN-SUBJECT-MARK Indirectly identifies the GDS subsystem object or file that is most involved in the event. It always immediately the subject token. ZSPI-TYP-MARK For more information about ZEMS-TKN-SUBJECT-MARK, see the EMS Manual.
Event Messages Event Messages Table 6-5. Subsystem-Specific EMS Tokens Token and Token Type Description ZGDS-TKN-ID Contains the product ZSPI-TYP-STRING ZGDS-TKN-PROCNAME ZSPI-TYP-STRING ZGDS-TKN-SEVERITY ZSPI-TYP-ENUM number and date for the GDS version. It is a 20-byte string. Contains the process ID of the process generating the event. It is the subject of the event message.
Event Messages Event Messages 1001: ZGDS-EVT-STARTUP Cause. GDS has started. Effect. None. Recovery. Informational message only; no corrective action required. Refer to Event Message Tokens on page 6-3, for a description of tokens that are present in this event message but are not described below.
Event Messages Event Messages Refer to Event Message Tokens on page 6-3, for a description that are present in this event message but are not described below. Unconditional Tokens ZSPI-TKN-SSID ZEMS-TKN-EVENTNUMBER ZEMS-TKN-SUBJECT-MARK ZGDS-TKN-PROCNAME ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT ZGDS-TKN-SEVERITY ZEMS-TKN-CPU ZEMS-TKN-CRTPID ZEMS-TKN-GENTIME ZEMS-TKN-LOGTIME ZEMS-TKN-PIN ZEMS-TKN-SYSTEM ZEMS-TKN-USERID TYPE TYPE TYPE TYPE TYPE TYPE TYPE TYPE TYPE TYPE TYPE TYPE TYPE TYPE ZSPI-TYP-SSID.
Event Messages Event Messages Refer to Event Message Tokens on page 6-3, for a description that are present in this event message but are not described below. Unconditional Tokens ZSPI-TKN-SSID ZEMS-TKN-EVENTNUMBER ZEMS-TKN-SUBJECT-MARK ZGDS-TKN-PROCNAME ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT ZGDS-TKN-SEVERITY ZEMS-TKN-CPU ZEMS-TKN-CRTPID ZEMS-TKN-GENTIME ZEMS-TKN-LOGTIME ZEMS-TKN-PIN ZEMS-TKN-SYSTEM ZEMS-TKN-USERID TYPE TYPE TYPE TYPE TYPE TYPE TYPE TYPE TYPE TYPE TYPE TYPE TYPE TYPE ZSPI-TYP-SSID.
Event Messages Event Messages Refer to Event Message Tokens on page 6-3, for a description of tokens that are present in this event message but are not described below.
Event Messages Event Messages Refer to Event Message Tokens on page 6-3, for a description of tokens that are present in this event message but are not described below.
Event Messages Event Messages Refer to Event Message Tokens on page 6-3, for a description of tokens that are present in this event message but are not described below.
Event Messages Event Messages Refer to Event Message Tokens on page 6-3, for a description of tokens that are present in this event message but are not described below.
Event Messages Event Messages ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. ZGDS-TKN-SEVERITY contains the value ZGDS-VAL-SEV-ERR indicating this event reports an error that prevents the process from operating. ZGDS-TKN-FAULTNUM contains the fault number. The recommended fault number ranges are listed below.
Event Messages Event Messages TSCODE Fault Fault Cause 10 Memory manager (Guardian) trap. 11 No memory (Guardian) trap. 12 Uncorrectable memory error trap. 13 Map parity error trap. 14 IOCB fault; GDS was unable to allocate an IOCB to handle an I/O request. 15 Checkpoint fault; bad parameter to call CHECKPOINT routines, or task has too much buffer space to checkpoint. 16 Task tried to close $RECEIVE. 17 Task called INIT^SEM passing a nonzero semaphore.
Event Messages Event Messages Refer to Event Message Tokens on page 6-3, for a description of tokens that are present in this event message but are not described below.
Event Messages Event Messages ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. ZGDS-TKN-SEVERITY contains the value ZGDS-VAL-SEV-STATUS indicating that this event reports status only. 1023: ZGDS-EVT-TASK-STOPPED Cause. GDS stopped a task. Effect. None. Recovery. Informational message only; no corrective action is needed. Refer to Event Message Tokens on page 6-3, for a description of tokens that are present in this event message but are not described below.
Event Messages Event Messages ZGDS-TKN-DEVTYPE contains the device type of the device generating the event. The following values are valid: • • • ZGDS-VAL-TYPE-TASK: The event is generated by a task. ZGDS-VAL-TYPE-LINE: The event is generated by a line. ZGDS-VAL-TYPE-TERM: The event is generated by a terminal. ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-FALSE, indicating that this is not a critical event. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE.
Event Messages Event Messages Event-Message Text STATUS *1024* dev type dev num (dev name) - Opened by: opener name ZEMS-TKN-EVENTNUMBER contains the value ZGDS-EVT-TASK-OPENED (1024). ZGDS-TKN-DEVNAME is the name of the GDS device generating the event. ZGDS-TKN-DEVNUM contains the device number of the device generating the event. ZGDS-TKN-DEVTYPE contains the device type of the device generating the event. The following values are valid: • • • ZGDS-VAL-TYPE-TASK: The event is generated by a task.
Event Messages Event Messages Refer to Event Message Tokens, for a description of tokens that are present in this event message but are not described below.
Event Messages Event Messages ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. ZGDS-TKN-SEVERITY contains the value ZGDS-VAL-SEV-STATUS indicating that this event reports status only. 1026: ZGDS-EVT-TASK-CLOSED Cause. A requester closed a task. Effect. None. Recovery. Informational message only; no corrective action is needed. Refer to Event Message Tokens, for a description of tokens that are present in this event message but are not described below.
Event Messages Event Messages ZGDS-TKN-DEVNUM contains the device number of the device generating the event. ZGDS-TKN-DEVTYPE contains the device type of the device generating the event. The following values are valid: • • • ZGDS-VAL-TYPE-TASK: The event is generated by a task. ZGDS-VAL-TYPE-LINE: The event is generated by a line. ZGDS-VAL-TYPE-TERM: The event is generated by a terminal. ZGDS-TKN-OPENER identifies the requester in this event.
Event Messages Event Messages Refer to Event Message Tokens, for a description of tokens that are present in this event message but are not described below.
Event Messages Event Messages ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. ZGDS-TKN-SEVERITY contains the value ZGDS-VAL-SEV-STATUS indicating that this event reports status only. 1041: ZGDS-EVT-CHKPT-FAIL Cause. The specified I/O error occurred during a checkpoint operation. Effect. The GDS primary process stops the backup process, then creates a new GDS backup process. Recovery.
Event Messages Event Messages Event-Message Text ERROR *1041* CheckPoint Failure: I/O error number ZEMS-TKN-EVENTNUMBER contains the value ZGDS-EVT-CHKPT-FAIL (1041). ZGDS-TKN-CHKPT-ERRNUM contains the I/O error number in this event message. ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this is a critical event. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE.
Event Messages Event Messages Refer to Event Message Tokens on page 6-3, for a description of tokens that are present in this event message but are not described below.
Event Messages Event Messages Recovery. Refer to the Operator Messages Manual for information on the errors.
Event Messages Event Messages ZGDS-TKN-FILESYS-ERRNUM contains the file-system error number in ZGDS-EVT-CREATE-BKUP-FAIL messages. ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this is a critical event. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. ZGDS-TKN-SEVERITY contains the value ZGDS-VAL-SEV-ERR indicating that this event reports an error that prevents the process from operating. 1044: ZGDS-EVT-OPEN-BKUP-FAIL Cause. A GDS process could not open its backup process.
Event Messages Event Messages Refer to Event Message Tokens on page 6-3, for a description of tokens that are present in this event message but are not described below.
Event Messages Event Messages Recovery.
Event Messages Event Messages ZGDS-TKN-SEVERITY contains the value ZGDS-VAL-SEV-WARN indicating that this event reports a warning only. The process is still operational. 1046: ZGDS-EVT-BKUP-DELETED Cause. A GDS backup process was deleted. Effect. The GDS primary process runs without a backup process. Recovery. The GDS primary process will create its backup process.
Event Messages Event Messages ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. ZGDS-TKN-SEVERITY contains the value ZGDS-VAL-SEV-WARN indicating that this event reports a warning only. The process is still operational. 1047: ZGDS-EVT-BKUP-ABENDED Cause. A GDS backup process abended. Effect. The GDS primary process runs without a backup process. Recovery.
Event Messages Event Messages ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this is a critical event. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. ZGDS-TKN-SEVERITY contains the value ZGDS-VAL-SEV-ERR indicating that this event reports an error that prevents the process from operating. 1048: ZGDS-EVT-BKUP-STOPPED Cause. A GDS backup process was stopped. Effect. The GDS primary process waits 30 seconds, then recreates the backup process. Recovery.
Event Messages Event Messages Event-Message Text WARNING *1048* Backup Stopped ZEMS-TKN-EVENTNUMBER contains the value ZGDS-EVT-BKUP-STOPPED (1048). ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-FALSE, indicating that this is not a critical event. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. ZGDS-TKN-SEVERITY contains the value ZGDS-VAL-SEV-WARN indicating that this event reports a warning only. The process is still operational. 1049: ZGDS-EVT-BKUP-TAKEOVER Cause.
Event Messages Event Messages Refer to Event Message Tokens on page 6-3, for a description of tokens that are present in this event message but are not described below.
Event Messages Event Messages • ZGDS-VAL-PRIM-OP-CMD: An operator command initiated the takeover. 1050: ZGDS-EVT-BKUP-CREATED Cause. A GDS backup process was created. Effect. None. Recovery. Informational message only; no corrective action is needed. Refer to Event Message Tokens on page 6-3, for a description of tokens that are present in this event message but are not described below.
Event Messages Event Messages ZGDS-TKN-SEVERITY contains the value ZGDS-VAL-SEV-STATUS indicating that this event reports status only. 1051: ZGDS-EVT-CHKPT-EXCEEDED Cause. The checkpoint information exceeds the configured checkpoint buffer size. Effect. The GDS backup process stops. The primary process recreates the backup process. Recovery. Use the command INFO PROCESS to find the configured checkpoint buffer size. Reconfigure GDS and increase the checkpoint buffer size.
Event Messages Event Messages ZGDS-TKN-SEVERITY contains the value ZGDS-VAL-SEV-ERR indicating that this event reports an error that prevents the process from operating. 1052: ZGDS-EVT-CHKPT-OVERFLOW Cause. The checkpoint table overflowed. Effect. The GDS backup process stops. The primary process reestablishes the backup process. Recovery.
Event Messages Event Messages ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this is a critical event. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. . ZGDS-TKN-SEVERITY contains the value ZGDS-VAL-SEV-ERR indicating that this event reports an error that prevents the process from operating. 1053: ZGDS-EVT-INTL-ERR Cause. GDS detected an unrecoverable internal error. There is a logic problem in the program reporting the error. Effect. GDS stops. Recovery.
Event Messages Event Messages Event-Message Text ERROR *1053* INTERNAL ERROR at %E register.P register ZEMS-TKN-EVENTNUMBER contains the value ZGDS-EVT-INTL-ERR (1053). ZGDS-TKN-EREG contains the environment register information where an error was detected. ZGDS-TKN-PREG contains the p-register relative address within the code segment where an error was detected. ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this is a critical event.
Event Messages Event Messages Refer to Event Message Tokens on page 6-3, for a description of tokens that are present in this event message but are not described below.
Event Messages Event Messages ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this is a critical event. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. ZGDS-TKN-SEVERITY contains the value ZGDS-VAL-SEV-ERR indicating this event reports an error that prevents the process from operating. ZGDS-TKN-FAULTNUM contains the fault number. 1055: ZGDS-EVT-USER-TASK-UNCONVERTED Cause. An unconverted GDS user task attempted to call a restricted D-series procedure. Effect.
Event Messages Event Messages Event-Message Text ERROR *1055* dev type dev num (dev name) - D-series call attempted fault number ZEMS-TKN-EVENTNUMBER contains the value ZGDS-EVT-USER-TASK-UNCONVERTED (1055). ZGDS-TKN-DEVNAME is the name of the GDS device generating the event. ZGDS-TKN-DEVNUM contains the device number of the GDS device generating the event. ZGDS-TKN-DEVTYPE contains the device type of the device generating the event.
Event Messages Event Messages GDSX Management Programming Manual—529930-001 6- 44
7 Error Numbers and Error Lists This section describes all the error numbers provided by the GDS subsystem (that is, the values whose symbolic names begin with ZGDS-ERR) and describes the error lists associated with these error numbers. These error numbers can occur as values of the return token, ZSPI-TKN-RETCODE, and as part of the value of the error token, ZSPITKN-ERROR. For a description of what error lists are and how they are retrieved from the buffer, refer to the SPI Programming Manual.
Error-List Descriptions Error Numbers and Error Lists Table 7-1. Error List Tokens (page 2 of 2) Token Description ZCOM-TKN-OBJNAME This token contains the object name provided with the command on which the error occurred. ZCOM-TKN-OBJTYPE This token contains the object type provided with the command on which the error occurred. ZSPI-TKN-PARM-ERR This token identifies the token at which the error occurred.
Error-List Descriptions Error Numbers and Error Lists 2: ZGDS-ERR-OBJSTATE-INV The object state given is invalid. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-PARM-ERR ZCOM-TKN-OBJSTATE ZSPI-TKN-ENDLIST TYPE TYPE TYPE TYPE TYPE TYPE TYPE ZSPI-TYP-LIST. ZSPI-TYP-ERROR. ZSPI-TYP-STRING. ZSPI-TYP-ENM-OBJ. ZSPI-TYP-PARM-ERR. ZSPI-TYP-ENUM. ZSPI-TYP-SSCTL. ZSPI-TKN-ERROR contains the subsystem ID and the error number ZGDS-ERR-OBJSTATE-INV.
Error-List Descriptions Error Numbers and Error Lists Cause. The maximum number of objects that can be configured has been reached. Recovery. Check to see what maximum-number values have been configured. You can configure more objects if you increase the values in the maximum-number configuration parameters. 4: ZGDS-ERR-ATTR-VAL-INV The attribute value given is invalid.
Error-List Descriptions Error Numbers and Error Lists 6: ZGDS-ERR-MODIF-DUP The modifier value has been given twice. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-PARM-ERR ZSPI-TKN-ENDLIST TYPE TYPE TYPE TYPE TYPE TYPE ZSPI-TYP-LIST. ZSPI-TYP-ERROR. ZSPI-TYP-STRING. ZSPI-TYP-ENM-OBJ. ZSPI-TYP-PARM-ERR. ZSPI-TYP-SSCTL. ZSPI-TKN-ERROR contains the subsystem ID and the error number ZGDS-ERR-MODIF-DUP.
Error-List Descriptions Error Numbers and Error Lists 8: ZGDS-ERR-DELETE-SUB-OBJ GDSX attempted to delete a line that still has subdevices configured under it. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-PARM-ERR ZSPI-TKN-ENDLIST TYPE TYPE TYPE TYPE TYPE TYPE ZSPI-TYP-LIST. ZSPI-TYP-ERROR. ZSPI-TYP-STRING. ZSPI-TYP-ENM-OBJ. ZSPI-TYP-PARM-ERR. ZSPI-TYP-SSCTL. ZSPI-TKN-ERROR contains the subsystem ID and the error number ZGDS-ERR-DELETE-SUB-OBJ.
Error-List Descriptions Error Numbers and Error Lists If the cause is improper reallocation, check the buffer allocation, correct if necessary, and try the request again. If nothing appears to be wrong and the problem persists, resize the memory. 10: ZGDS-ERR-FS-ERR GDSX failed to open the terminal while processing START LINE or START SU. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-PARM-ERR ZSPI-TKN-ENDLIST TYPE TYPE TYPE TYPE TYPE TYPE ZSPI-TYP-LIST. ZSPI-TYP-ERROR.
Error-List Descriptions Error Numbers and Error Lists 12: ZGDS-ERR-STOP-SUB-OBJ A line cannot be stopped because subdevices have been opened under the line. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-PARM-ERR ZSPI-TKN-ENDLIST TYPE TYPE TYPE TYPE TYPE TYPE ZSPI-TYP-LIST. ZSPI-TYP-ERROR. ZSPI-TYP-STRING. ZSPI-TYP-ENM-OBJ. ZSPI-TYP-PARM-ERR. ZSPI-TYP-SSCTL. ZSPI-TKN-ERROR contains the subsystem ID and the error number ZGDS-ERR-STOP-SUB-OBJ.
Error-List Descriptions Error Numbers and Error Lists 14: ZGDS-ERR-CASE-VAL-INV The CASE modifier has an invalid name. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-PARM-ERR ZSPI-TKN-ENDLIST TYPE TYPE TYPE TYPE TYPE TYPE ZSPI-TYP-LIST. ZSPI-TYP-ERROR. ZSPI-TYP-STRING. ZSPI-TYP-ENM-OBJ. ZSPI-TYP-PARM-ERR. ZSPI-TYP-SSCTL. ZSPI-TKN-ERROR contains the subsystem ID and the error number ZGDS-ERR-CASE-VAL-INV.
Error-List Descriptions Error Numbers and Error Lists 16: ZGDS-ERR-TRACE-NOT-START The requested trace cannot be started. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-PARM-ERR ZCOM-TKN-FNAME ZSPI-TKN-ENDLIST TYPE TYPE TYPE TYPE TYPE TYPE TYPE ZSPI-TYP-LIST. ZSPI-TYP-ERROR. ZSPI-TYP-STRING. ZSPI-TYP-ENM-OBJ. ZSPI-TYP-PARM-ERR. ZSPI-TYP-FNAME. ZSPI-TYP-SSCTL. ZSPI-TKN-ERROR contains the subsystem ID and the error number ZGDS-ERR-TRACE-NOTSTART.
Error-List Descriptions Error Numbers and Error Lists Recovery. Correct the SELECT option value and retry the request. 18: ZGDS-ERR-TRACE-FNAME-REQ The trace file name is missing. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-PARM-ERR ZSPI-TKN-ENDLIST TYPE TYPE TYPE TYPE TYPE TYPE ZSPI-TYP-LIST. ZSPI-TYP-ERROR. ZSPI-TYP-STRING. ZSPI-TYP-ENM-OBJ. ZSPI-TYP-PARM-ERR. ZSPI-TYP-SSCTL. ZSPI-TKN-ERROR contains the subsystem ID and the error number ZGDS-ERR-TRACE-FNAMEREQ.
Error-List Descriptions Error Numbers and Error Lists 20: ZGDS-ERR-SU-ALRDY-FORBIDOPENS The specified subdevice is already prohibited from having further connections created to it. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-PARM-ERR ZSPI-TKN-ENDLIST TYPE TYPE TYPE TYPE TYPE TYPE ZSPI-TYP-LIST. ZSPI-TYP-ERROR. ZSPI-TYP-STRING. ZSPI-TYP-ENM-OBJ. ZSPI-TYP-PARM-ERR. ZSPI-TYP-SSCTL. ZSPI-TKN-ERROR contains the subsystem ID and the error number ZGDS-ERR-SU-ALRDYFORBIDOPENS.
Index A ABORT command 1-4, 5-1, 5-5 ADD command 1-4, 5-1, 5-8 ALLOWOPENS command 1-4, 5-1, 5-12 ALTER command 1-4, 5-1, 5-14 Application commands 1-3 guidelines 2-2 naming rules 2-2 Architecture, GDSX 1-2 Attributes changing 5-14 display of current values 5-29 B Buffer size for commands 3-1 maximum 4-7 of event message 6-3 recommended 4-6 C Capability distributor 4-4, 6-3 Changing attributes 5-14 Command buffers 3-1 components of 2-6 descriptions of 5-3 numbers 2-3, 4-3 semantics of 5-1 syntax of 5-1 Comm
E Index Definitions common 4-1 data communications standard 4-4 EMS standard 4-3 GDSX 4-5 SPI standard 4-1, 4-2 DELETE command 1-4, 5-1, 5-22 Deleting a line or subdevice 5-22 connections 5-70 Descriptions error-list 7-2 event-message 6-3, 6-6 of commands 5-3 Device handler procedure missing 6-8 Device name and number 4-7 Disk volume, default 2-2 Distributor process of Event Management 6-1 Distributor, capability 4-4, 6-3 E EMS definition file 2-1 EMS standard definitions 4-3 EMSGET 2-4 Error lists token
F Index selecting 6-3 severity of 4-8 subjects 2-4 tokens in 4-7, 6-1 Event number 4-4 Event numbers 2-4, 6-1 Event reporting 6-1 Event Subsystem Control Program 1-2 Events beginning process execution 6-7 critical 6-2 device handler not in GDS object code 6-8 I/O error during checkpoint 6-24 NEWPROCESS error during backup attempt 6-26 noncritical 6-2 shutdown 6-7 Extensible structured tokens 2-5, 3-1, 4-4 F Field types 2-5 Field values 2-5, 4-6 File name 4-3 Filter 6-1, 6-3 FORBIDOPENS command 1-4, 5-1
M Index resetting statistics for 5-46 LISTOBJECTS command 1-4, 5-1, 5-40 LISTOPENS command 1-4, 5-1, 5-43 M Management functions 1-5 Maps, token 2-5 Message completion 1-4 elements of SPI 2-1 error 1-6 event 1-2, 1-4, 6-1, 6-1/6-2 subjects for 2-4 single reply 3-2 SPI 2-1 status 1-6 warning 1-6 Messages multiple 3-1 multiple reply 3-1 Messages, event header tokens 6-3 standard EMS token 6-5 subsystem-specific standard tokens 6-5 Multiple commands 3-1 Multiple messages 3-1 Multiple reply messages 3-1 Mult
R Index tracing 5-75 Programmatic commands 1-3, 1-4, 1-6 Programmatic commands versus interactive 1-6 Programmatic interfaces 1-1 Programming considerations event-management 6-3 responses 3-2 SPI 3-1 R Reply messages multiple 3-1 single 3-2 Requester identifier 4-8 Required token 5-4 RESETSTATS command 1-4, 5-2, 5-46 Resetting statistical information 5-46 Response buffer decoding 3-2 receiving 3-2 Response records multiple 3-2 single 3-2 Retrieving statistical information 5-51 Retrieving summary state in
T Index definition file 2-1 description 2-1 error list tokens 7-1 message, elements of 2-1 programming considerations 3-1 standard definitions 4-1, 4-2 Summary state information retrieval 5-46 SWITCH command 1-4, 4-6, 5-2, 5-73 Switching a process object resource 5-73 Symbolic names of commands 5-1/5-2 T TASK objects names 2-3, 4-6 obtaining attribute values 5-29 obtaining statistics for 5-51 obtaining status for 5-63 resetting statistics for 5-46 Terminating a line 5-5 Terminating a subdevice 5-5 TMDS 6
Z Index INV-CPU 7-9 MODIF-DUP 7-5 NOSTOP-OBJ-ACTIVE 7-7 NO-BACKUP 7-8 NO-MEM-SPACE 7-6 OBJNAME-UNKNOWN 7-2 OBJSTATE-INV 7-3 SELECT-VAL-INV 7-5 STOP-SUB-OBJ 7-8 SU-ALRDY-ALLOWOPENS 7-11 SU-ALRDY-FORBIDOPENS 7-12 TRACE-FNAME-REQ 7-11 TRACE-NOT-START 7-10 TRACE-SEL-OPT-INV 7-10 ZGDS-EVT-messages BKUP-ABENDED 6-32 BKUP-CREATED 6-36 BKUP-DELETED 6-31 BKUP-STOPPED 6-33 BKUP-TAKEOVER 6-34 CHKOPEN-FAIL 6-25 CHKPT-EXCEEDED 6-37 CHKPT-FAIL 6-24 CHKPT-OVERFLOW 6-38 CREATE-BKUP-FAIL 6-26 DEV-HANDLER-ERR 6-8 INTL-ERR
Z Index GDSX Management Programming Manual—529930-001 Index -8