Networking and Data Communications Library Tandem TCP/IP TELNET Management Programming Manual Abstract Part Number This manual describes the command/response interface and the Event Management Service (EMS) interface available to an application program for communication with the Tandem TCP/IP TELNET process. The manual is for programmers.
Document History Edition Part Number Product Version First Edition 18337 Second Edition 53474 Operating System Version Date Tandem TCP/IP TELNET C11 GUARDIAN 90 C10 Tandem TCP/IP TELNET C20 GUARDIAN 90 C20 August 1989 May 1991 New editions incorporate any updates issued since the previous edition. Copyright All rights reserved.
New and Changed Information This version of the Tandem TCP/IP TELNET Management Programming Manual contains the following changes: The ADD command has been modified to accept SERVICETYPE. The service types supported by the Tandem TCP/IP TELNET subsystem are: CONVERSATION, BLOCK, and PRINT. The INFO command has been modified to accept SERVICETYPE.
New and Changed Information iv 53474 Tandem Computers Incorporated
Contents Preface ix Notation Conventions Section 1 xi Introduction Brief Overview of TELNET 1-1 Objects Controlled by the Subsystem Required Management Functions 1-2 Relationship With Other Subsystems Subsystem Architecture Section 2 1-1 1-3 1-4 Management Programming for the TELNET Subsystem How a Management Application Fits Into the Architecture Commands 2-4 Event Messages 2-6 Communicating With the TELNET Subsystem Section 3 2-2 2-6 Elements of SPI Messages for the TELNET Subsystem
Contents Section 5 Common Definitions SPI Standard Definitions 5-1 EMS Standard Definitions 5-8 Data Communications Standard Definitions 5-9 Common Definitions for the TELNET Subsystem 5-14 Buffer Declarations 5-14 TELNET Private Token and Field Types 5-15 TELNET Predefined Token and Field Values 5-16 TELNET Simple Tokens 5-18 TELNET Extensible Structured Tokens 5-19 TELNET Tokens in Error Lists 5-19 TELNET Tokens in Event Messages 5-19 Section 6 Commands and Responses Commands by Object Type 6-2
Contents Examples of Filters 7-20 Example 1 7-20 Example 2 7-21 Appendix A Error Numbers and Error Lists Appendix B Telnet Subsystem DDL Index Figures Index–1 Figure 1-1. Relationship to Other Subsystems 1-4 Figure 1-2. TELNET Subsystem Architecture 1-5 Figure 2-1. How an Application Fits Into the Architecture Tables Table 2-1. TELNET Programmatic Commands 2-3 2-4 Table 2-2. SCF Commands and Programmatic Commands Table 5-1. SPI Standard Definitions Table 5-2.
Contents viii 53474 Tandem Computers Incorporated
Preface This manual describes the subsystem-specific information needed by an application programmer to develop an application that manages the Tandem TCP/IP TELNET subsystem according to the Distributed Systems Management (DSM) procedures. It includes detailed descriptions of the TELNET subsystem control-and-inquiry interface and the TELNET subsystem Event Management Service (EMS) interface.
Preface Section 6 describes the TELNET subsystem programmatic commands and responses. Each description includes the syntax, object types, command tokens, response tokens, and operational notes associated with the command. Section 7 describes event management for applications communicating with the TELNET subsystem.
Notation Conventions The following list summarizes the conventions for syntax presentation in this manual. Notation Meaning UPPERCASE LETTERS Uppercase letters represent keywords and reserved words; enter these items exactly as shown. Lowercase italic letters represent variable items that you supply. Brackets enclose optional syntax items. A group of vertically aligned items enclosed in brackets represents a list of selections from which you can choose one or none. Braces enclose required syntax items.
1 Introduction This section introduces the Tandem TCP/IP TELNET subsystem, the objects controlled by the TELNET subsystem, and the management concepts applicable to the TELNET subsystem. Some of the concepts discussed here include the monitoring and control functions available and the relationship of the TELNET subsystem to other Tandem subsystems. Brief Overview of The TELNET subsystem is Tandem’s implementation of the TELNET server portion of TELNET the TELNET protocol.
Introduction Required Management Functions Once the process is created, you can add windows. Each window object corresponds to one pseudoterminal. The term pseudoterminal is used to represent an independent virtual terminal (commonly referred to in the TELNET protocol as a network virtual terminal or NVT) through which a client’s or user’s data is sent to or received from the network. The data sent or received is subject to the same transformation semantics that are associated with a physical terminal.
Introduction Relationship With Other Subsystems Once you have acquired this information, you can make informed decisions about controlling the TELNET subsystem. You can take action either programmatically or interactively with the available commands.
Introduction Relationship With Other Subsystems Figure 1-1. Relationship to Other Subsystems TELNET SCP SCF TCP/IP Subsystem MLMAN ETHERNET Interface CONFIG MLAM (TLAM IOP) MLMUX Controller 5600 (ETHERNET 802.3) 001 Subsystem The TELNET subsystem consists of a process that controls as many as 128 windows or Architecture pseudoterminals. You can manage the TELNET subsystem through both interactive and programmatic interfaces.
Introduction Relationship With Other Subsystems The control-and-inquiry interface, which provides control and inquiry capability to an application program. This interface (which is also provided by the SCP) allows an application program to send commands to the subsystem to control the subsystem or to obtain information. The Event Management Service (EMS) interface, which provides eventmanagement capability to an application program.
2 Management Programming for the TELNET Subsystem You can manage the TELNET subsystem interactively or programmatically. For the TELNET subsystem, the Subsystem Control Facility (SCF) and VIEWPOINT provide interactive subsystem management, while the control-and-inquiry interface and the Event Management Service (EMS) interface provide programmatic subsystem management.
Management Programming for the TELNET Subsystem How a Management Application Fits Into the Architecture How a Management A management application uses Subsystem Programmatic Interface (SPI) messages to Application Fits Into communicate with the TELNET subsystem. These messages are passed between the the Architecture management application and the TELNET subsystem by means of the Subsystem Control Point (SCP) or the EMS interface.
Management Programming for the TELNET Subsystem How a Management Application Fits Into the Architecture Figure 2-1.
Management Programming for the TELNET Subsystem Commands Commands Table 2-1 lists and briefly describes the commands that a management application using the control-and-inquiry interface can send to the TELNET subsystem. For detailed descriptions of these commands as they relate to the TELNET subsystem, refer to Section 6, “Commands and Responses.
Management Programming for the TELNET Subsystem Commands Table 2-2.
Management Programming for the TELNET Subsystem Commands Event Messages An event message describes an event that has occurred in a subsystem, such as a hardware error or a software error. All event messages are in SPI message format. All event messages issued by the TELNET subsystem are sent to the EMS collector process ($0). These event messages are then placed into the user-specified log files.
Management Programming for the TELNET Subsystem Commands 6. Decode the response. 7. Take appropriate action and return to Step 2, if necessary. 8. Terminate communication with SCP or the EMS distributor process. All data communications subsystems must use the same message protocol to communicate with SCP. For details on this protocol, refer to the Communications Management Programming Manual and the Distributed Systems Management (DSM) Programming Manual.
3 Elements of SPI Messages for the TELNET Subsystem The Subsystem Programmatic Interface (SPI) procedures facilitate communication between a management application and the TELNET subsystem. These procedures allow a management application to build commands in SPI message format to be sent through SCP to the subsystem. These procedures also allow a management application to decode the responses that have been sent from the subsystem through SCP in SPI message format.
Elements of SPI Messages for the TELNET Subsystem Definition Files To include the definition files in your management application, use the mechanism appropriate for the programming language in which the application is written. The appropriate mechanisms are as follows: In TAL or C, source-in the definition files In COBOL85, copy the definition files into your program using COPY statements. In TACL, load the definition files using LOAD commands.
Elements of SPI Messages for the TELNET Subsystem Common Syntax Elements for the Subsystem Note This manual uses the DDL to describe all tokens. For a brief review of DDL, refer to the appendix “Overview of DDL for SPI” in the Distributed Systems Management (DSM) Programming Manual. In that appendix, definition names contain hyphens. If you are programming in TAL or TACL, substitute a circumflex (^) for each hyphen in a definition name as it appears in this manual.
Elements of SPI Messages for the TELNET Subsystem Common Syntax Elements for the Subsystem Although all data communications subsystems must use symbolic names that have the form ZCOM-CMD-name, each subsystem defines which commands it supports. The TELNET subsystem supports the following commands: ABORT ADD ALTER DELETE GETVERSION INFO LISTOBJECTS LISTOPENS RESETSTATS START STATISTICS STATUS STOP TRACE These commands are described in Section 6, “Commands and Responses.
Elements of SPI Messages for the TELNET Subsystem Common Syntax Elements for the Subsystem A Tandem system can support only one TELNET process per TCP/IP process. As with any Tandem subsystem, the TELNET subsystem must have a GUARDIAN 90 process name. When you assign an object name to a process, you must assign a unique name. The name must be preceded by a dollar sign ($) and can have a maximum of four alphanumeric characters, not including the dollar sign.
Elements of SPI Messages for the TELNET Subsystem Common Syntax Elements for the Subsystem You can use wild-card characters in any combination; for example, $ZTNT.*1?? selects all windows associated with the process $ZTNT that have names ending with a 1 followed by two characters.
Elements of SPI Messages for the TELNET Subsystem Common Syntax Elements for the Subsystem The actual token value can be in one of the following forms: A single field, such as an integer or a character string A fixed structure, which consists of a fixed number of data fields that are always present An extensible structure, which consists of data fields whose number can be extended from software release to software release and may contain fields with null (unassigned) values Tokens having a token value that
Elements of SPI Messages for the TELNET Subsystem Common Syntax Elements for the Subsystem and name identifies the token type. For example, ZTNT-TYP- TRACE defines the token type of the process object options for the TRACE command as enumerated values. See Section 5, “Common Definitions,” for all the token types used by the TELNET subsystem.
4 SPI Programming Considerations The Communications Management Programming Manual discusses general programming considerations for writing applications that use the Subsystem Programmatic Interface (SPI) to communicate with data communications subsystems such as the TELNET subsystem. This section discusses SPI programming considerations that are specific to the TELNET subsystem.
SPI Programming Considerations Receiving and Decoding the Response Buffer subsystem should continue to the next object only if no errors or warnings occurred on the previous object. Although this option stops processing whenever an error or warning occurs, the application can still continue the command by using the context token according to the following procedure: When the TELNET subsystem discontinues a command because of an error or warning, it immediately sends a reply message to the application.
SPI Programming Considerations Security Error Handling General programming considerations for handling errors that occur when using management-programming interfaces are discussed in the Communications Management Programming Manual. The programmatic control-and-inquiry interface to the TELNET subsystem features two values for the return token; these values indicate that the response record does not contain an error list. One value, ZSPI-ERR-OK, means that no error or warning occurred.
5 Common Definitions The management-programming interfaces to the TELNET subsystem use definitions from four sources: SPI standard definitions, EMS standard definitions, data communications standard definitions, and TELNET subsystem-specific definitions. Many of the definitions are used in multiple commands, responses, event messages, or error lists. This section contains general information that applies to all uses of the common definitions in the interfaces to the TELNET subsystem.
Common Definitions SPI Standard Definitions Table 5-1.
Common Definitions SPI Standard Definitions Definitions specific to the TELNET subsystem are described here. ZSPI-SSN-ZTNT specifies the subsystem number assigned to the TELNET subsystem. This value name is defined as a constant in the SPI DDL file, ZSPIDEF.ZSPIDDL. ZSPI-TKN-ALLOW-TYPE indicates, within a command buffer, the conditions under which the processing of a set of objects will continue. This token applies to only those commands that accept object-name templates.
Common Definitions SPI Standard Definitions ZSPI-TKN-CONTEXT indicates to the requester within the response buffer that more objects are waiting to be to processed. This token applies only when a command references more than one object and the information that is going to be returned cannot fit into one response buffer. For the TELNET subsystem, this occurs only when an objectname template has been specified for a command, or the NULL object has been specified for the LISTOBJECTS command.
Common Definitions SPI Standard Definitions Multiple error lists can be returned in a single response buffer or even in a single data list. ZSPI-TKN-ERROR is the standard SPI error token described in the Distributed Systems Management (DSM) Manual. Its value consists of the TELNET subsystem ID and one of the TELNET subsystem-specific error numbers described in Appendix A, “Error Numbers and Error Lists.” This token is always present in an error list.
Common Definitions SPI Standard Definitions ZSPI-TKN-RETCODE is the return token, which specifies whether a command completed successfully. If a command completes successfully, including when a command completes with a warning, the value of this token is ZCOM-ERR-OK. Note that if the empty response (ZCOM-ERR-EMPT-RSP) is returned, the value of this token is nonzero even though the command has completed successfully.
Common Definitions SPI Standard Definitions ZTNT-VAL-SSID has the following structure definition: def ZTNT-VAL-SSID tacl ssid. 02 Z-FILLER type character 8 value is ZSPI-VAL-TANDEM. 02 Z-OWNER redefines Z-FILLER type ZSPI-DDL-CHAR8. 02 Z-NUMBER type ZSPI-DDL-INT value is ZSPI-SSN-ZTNT. 02 Z-VERSION type ZSPI-DDL-UINT value is ZTNT-VAL-VERSION. end. ZSPI-TKN-USEDLEN specifies the length of the used portion of a command message.
Common Definitions EMS Standard Definitions EMS Standard Definitions Definitions whose names begin with ZEMS- are Event Management Service (EMS) standard definitions. These definitions are available to all subsystems that support EMS and can be found in the EMS DDL file, ZSPIDEF.ZEMSDDL, and in the definition files for other languages. Table 5-2 lists only those EMS standard definitions used in the managementprogramming interfaces to the TELNET subsystem.
Common Definitions Data Communications Standard Definitions ZEMS-TKN-EMPHASIS specifies whether the event message is considered critical. If the value of the token is ZSPI-VAL-TRUE, the event is considered critical; if the value is ZSPI-VALFALSE, the event is not considered critical. ZEMS-TKN-EVENTNUMBER specifies the event number of a TELNET event message. These event numbers and their associated event messages are described in Section 7, “Event Management.
Common Definitions Data Communications Standard Definitions standard definitions and error numbers, refer to the Communications Management Programming Manual. The following data communications definitions are used by the TELNET subsystem: Simple tokens Extensible structured tokens Object types Fixed structures Command numbers Token and field values Table 5-3.
Common Definitions Data Communications Standard Definitions Definitions specific to the TELNET subsystem are described here. ZCOM-MAP-REQID provides security checking, in addition to the sensitive/nonsensitive command implementation. Sensitive commands can be issued buy SUPER.SUPER user only. This token contains the GUARDIAN 90 process ID (PID) and the process access ID (PAID) of the application issuing the command. The ZCOM-MAP-REQID token is valid only if the requester has the SUPER.SUPER user ID.
Common Definitions Data Communications Standard Definitions ZCOM-OBJ-NULL does not represent a controllable TELNET object. It is used as the object type in commands that do not require an object-name token. Only two TELNET subsystem commands use the NULL object, GETVERSION and LISTOBJECTS. ZCOM-OBJ-PROC is the TELNET process running on a Tandem NonStop system. The TELNET process is created using the RUN command. The only valid summary state for this object is the STARTED summary state.
Common Definitions Data Communications Standard Definitions The object name of a WINDOW object is the name of a specific window. A window can be created with the ADD command or it can be added dynamically when a connection is established. The name is assigned when the window is created, and is unique within a process. As many as 128 windows can be created on one TELNET process. The NULL object has no object name. The object name of the PROC object is the object name of the TELNET process.
Common Definitions Common Definitions for the TELNET Subsystem ZCOM-TKN-SUBJ-WINDOW indicates the name of a TELNET window that is the subject of an event message. ZCOM-TKN-TRACE-OPT indicates what items are to be traced by the TRACE command. For information on the possible values of this token, refer to the TRACE command in Section 6, “Commands and Responses.” The SCP creates a bit mask from the trace options specified and sends it to the TELNET subsystem.
Common Definitions Common Definitions for the TELNET Subsystem ZTNT-DDL-MSG-BUFFER is the message buffer declaration recommended for command messages and for responses in which each response message will contain a single response record. def ZTNT-DDL-MSG-BUFFER. 02 Z-MSGCODE type ZSPI-DDL-INT. 02 Z-BUFLEN type ZSPI-DDL-UINT. 02 Z-OCCURS type ZSPI-DDL-UINT. 02 Z-FILLER type ZSPI-DDL-BYTE occurs 0 to ZCOM-VAL-BUFLEN times depending on Z-OCCURS. end.
Common Definitions Common Definitions for the TELNET Subsystem ZTNT-TYP-SEV defines the token type of the values of the ZTNT-TKN-SEV token as enumerated values. ZTNT-TYP-TRACE defines the token type of the PROC object options for the TRACE command as enumerated values. ZTNT-TYP-WIN-TRACE defines the token type of the WINDOW object options for the TRACE command as enumerated values.
Common Definitions Common Definitions for the TELNET Subsystem ZTNT-VAL-MAX-CAUSE defines the upper limit of the values supported by the TELNET subsystem for the ZCOM-TKN-CAUSE-SUMSTATE-CHG token in event message ZTNT-EVTSUMSTATE-CHG. ZTNT-VAL-MAX-SEV defines the upper limit of the values supported by the TELNET subsystem for the ZTNT-TKN-SEV token. The ZTNT-TKN-SEV token appears in all the event messages issued by the TELNET subsystem.
Common Definitions Common Definitions for the TELNET Subsystem ZTNT-VAL-SSID is the subsystem ID for the TELNET subsystem. Its structure definition is given earlier in this section under “SPI Standard Definitions.” For more information about ZTNT-VAL-SSID, refer to the discussion of the subsystem ID in the Distributed Systems Management (DSM) Programming Manual.
Common Definitions Common Definitions for the TELNET Subsystem TELNET Extensible Structured Tokens Here are the extensible structured tokens defined by the TELNET subsystem: ZTNT-MAP-ADD-WIN ZTNT-MAP-ALTER-PROC ZTNT-MAP-ALTER-WIN ZTNT-MAP-INFO-PROC ZTNT-MAP-INFO-WIN ZTNT-MAP-OPENS-TELNET ZTNT-MAP-STATS-TELNET ZTNT-MAP-STATS-WIN ZTNT-MAP-STATUS-WIN These tokens are described with the commands and responses in which they appear. See Section 6, “Commands and Responses.
6 Commands and Responses This section describes each of the commands and responses in the programmatic control-and-inquiry interface to the TELNET subsystem. Each description includes the syntax, object types, command tokens, response tokens, and operational notes associated with the command. In this section, command numbers, types, tokens, and their values are represented in DDL.
Commands and Responses Commands by Object Type Table 6-1 lists the commands available in the programmatic control-and-inquiry interface to the TELNET subsystem and gives their symbolic names. Table 6-1.
Commands and Responses Command Descriptions The TELNET subsystem accepts the PROC object type in the following control-andinquiry interface commands: ALTER GETVERSION INFO LISTOPENS RESETSTATS STATISTICS STATUS TRACE The TELNET subsystem accepts the WINDOW object type in the following controland-inquiry interface commands: ABORT ADD ALTER DELETE INFO LISTOBJECTS RESETSTATS START STATISTICS STATUS STOP TRACE The TELNET subsystem accepts the NULL object type in the following control-andinquiry interface
Commands and Responses ABORT Command With the exception of the tokens ZSPI-TKN-DATALIST, ZSPI-TKN-ERRLIST, and ZSPI-TKN-ENDLIST, the order of the tokens listed in the command buffer and response buffer is not necessarily the order in which they will actually appear in a command or response. The token ZSPI-TKN-DATALIST, if present in a response, always appears at the beginning of a response record. The token ZSPI-TKN-ERRLIST, if present in a response, always appears at the beginning of an error list.
Commands and Responses ABORT Command ABORT Command The ABORT command terminates the operation of the specified window and clears any existing connection to it. When the subsystem finishes processing the command, the specified window is placed in the STOPPED summary state. This command is not valid for the PROC object. You can use an object-name template to abort multiple windows.
Commands and Responses ABORT Command Tokens in Response Buffer ZSPI-TKN-SSID ZSPI-TKN-SERVER-VERSION ZSPI-TKN-DATALIST ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ... ZSPI-TKN-ENDLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT token-type token-type token-type token-type token-type token-type token-type ZSPI-TYP-SSID. ZSPI-TYP-UINT. ZSPI-TYP-LIST. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TYP-ENUM. ZSPI-TYP-LIST. !{} !{} !... !{} !{} !{} !... token-type ZSPI-TYP-SSCTL.
Commands and Responses ABORT Command ZSPI-TKN-SERVER-VERSION indicates the software release version of the TELNET subsystem. See “SPI Standard Definitions” in Section 5 for a detailed description of this token. ZSPI-TKN-DATALIST indicates the beginning of a data list. The ZSPI-TKN-MAXRESP token must have a value other than zero or else data lists will not be included in the response. See “SPI Standard Definitions” in Section 5 for a detailed description of this token.
Commands and Responses ADD Command Here are the possible nonzero values of RETCODE in response to the ABORT command: ZSPI-ERR-INVBUF (-1) ZCOM-ERR-CMD-MISMATCH (-4) ZCOM-ERR-CMD-TOO-LARGE (-8) ZCOM-ERR-OBJ-ALRDY-IN-SUMSTATE (-16) ZCOM-ERR-OBJ-NOT-FOUND (-17) ZCOM-ERR-OBJ-NOT-SUPP (-18) ZCOM-ERR-SECUR-VIOL (-22) ZCOM-ERR-SPI-ERR (-23) ZCOM-ERR-SSID-INV (-24) ZCOM-ERR-TKN-CODE-INV (-26) ZCOM-ERR-TKN-DUP (-27) ZCOM-ERR-TKN-REQ (-29) ZSPI-TKN-ERRLIST indicates the beginning of an error list.
Commands and Responses ADD Command ADD Command The ADD command adds a window to the TELNET subsystem. Windows can be created with the ADD command or they can be added dynamically when a connection is established. Windows created with the ADD command generally provide a class of service. To create a class of service, you add a set of windows with like characteristics. Programs associated with a class of service can be run on any window belonging to that service.
Commands and Responses ADD Command ZSPI-TKN-SSID ZCOM-TKN-OBJNAME token-type ZSPI-TYP-SSID. !{} token-type ZSPI-TYP-STRING. !{} ZCOM-MAP-REQID def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end. ZSPI-TKN-MAXRESP ZSPI-TKN-COMMENT !Specify values, if map present. type ZSPI-DDL-CRTPID. type ZSPI-DDL-INT. token-type ZSPI-TYP-INT. token-type ZSPI-TYP-STRING. Tokens in Response Buffer ZSPI-TKN-SSID ZSPI-TKN-SERVER-VERSION ZSPI-TKN-DATALIST ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ...
Commands and Responses ADD Command ZEOL-CHAR is a one-byte character value that indicates the ASCII control character used to signal that an input line is complete. The range of possible values is %H0 through %HFF. The default value is a carriage return (%H0D). ZINTRPT-CHAR is a one-byte character value that indicates the ASCII control character used to send a break message to the process that owns the break for the window. The range of possible values is %H0 through %HFF.
Commands and Responses ADD Command ZCOM-MAP-REQID is a standard data communications token your application can optionally provide. This token is described in “Data Communications Standard Definitions” in Section 5. (ZSPI-TKN-) MAXRESP and COMMENT are standard SPI tokens your application can optionally provide. These tokens are described in “SPI Standard Definitions” in Section 5. Tokens in Response Buffer ZSPI-TKN-SSID identifies the subsystem ID. The value for the TELNET subsystem is ZTNT-VALSSID.
Commands and Responses ADD Command (ZCOM-ERR-EMPT-RSP) is returned, the value of this token is nonzero even though the command has completed successfully. If the command did not complete successfully, the value of this token indicates the reason the command failed. Always check the contents of the error list to determine the token or value in error. For details on the ZCOM return codes and associated error lists, see the Communications Management Programming Manual.
Commands and Responses ALTER Command If a process is started on a window without the specification of the window name as the input and output files, the service will not be available to incoming TELNET users. Once a window and service have been added, selecting the service name from the Tandem TCP/IP TELNET server menu of services returns an error unless a process is running against that window. Use the RUN command to add a TELNET process.
Commands and Responses ALTER Command ALTER Command The ALTER command changes attribute values associated with the specified object. You can change attributes for a process or a window. Object-name templates do not apply to this command. Command ZCOM-CMD-ALTER Object Type ZCOM-OBJ-PROC or ZCOM-OBJ-WINDOW Tokens in Command Buffer ZTNT-MAP-ALTER-PROC !{A} !OBJ-PROC def ZTNT-DDL-ALTER-PROC. 02 ZTERM-TIMEOUT 02 ZMAX-TERM end. ZTNT-MAP-ALTER-WIN !{A} !OBJ-WINDOW def ZTNT-DDL-ALTER-WIN.
Commands and Responses ALTER Command def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end. ZSPI-TKN-MAXRESP ZSPI-TKN-COMMENT !Specify values, if map present. type ZSPI-DDL-CRTPID. type ZSPI-DDL-INT. token-type ZSPI-TYP-INT. token-type ZSPI-TYP-STRING. Tokens in Response Buffer ZSPI-TKN-SSID ZSPI-TKN-SERVER-VERSION ZSPI-TKN-DATALIST ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ...
Commands and Responses ALTER Command and the DDL definition ZTNT-DDL-ALTER-WIN. Although this extensible structured token must be in the command when the specified object is ZCOMOBJ-WINDOW, original values exist for each of the fields, and each field’s specification is optional. Each attribute is defined in a separate field. Duplicate occurrences of either the token or the fields are not allowed.
Commands and Responses ALTER Command (ZSPI-TKN-) MAXRESP and COMMENT are standard SPI tokens your application can optionally provide. These tokens are described in “SPI Standard Definitions” in Section 5. Tokens in Response Buffer ZSPI-TKN-SSID identifies the subsystem ID. The value for the TELNET subsystem is ZTNT-VALSSID. This token is described more fully in “SPI Standard Definitions” in Section 5. ZSPI-TKN-SERVER-VERSION indicates the software release version of the TELNET subsystem.
Commands and Responses DELETE Command codes and associated error lists, see the Distributed Systems Management (DSM) Programming Manual.
Commands and Responses DELETE Command DELETE Command The DELETE command removes windows from the TELNET subsystem. You cannot delete a process. Before you use the DELETE command, the window(s) to be deleted must be in the STOPPED summary state. In addition, when your management application issues the DELETE command, the TELNET subsystem checks for an object-name template. If one is present, all windows that meet the template requirements are removed from the subsystem.
Commands and Responses DELETE Command Tokens in Response Buffer ZSPI-TKN-SSID ZSPI-TKN-SERVER-VERSION ZSPI-TKN-DATALIST ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ... ZSPI-TKN-ENDLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT token-type token-type token-type token-type token-type token-type token-type ZSPI-TYP-SSID. !{} ZSPI-TYP-UINT. !{} ZSPI-TYP-LIST. !... ZSPI-TYP-STRING. !{} ZSPI-TYP-ENUM. !{} ZSPI-TYP-ENUM. !{} ZSPI-TYP-LIST. !... token-type ZSPI-TYP-SSCTL.
Commands and Responses DELETE Command ZSPI-TKN-SERVER-VERSION indicates the software release version of the TELNET subsystem. See “SPI Standard Definitions” in Section 5 for a detailed description of this token. ZSPI-TKN-DATALIST indicates the beginning of a data list. The ZSPI-TKN-MAXRESP token must have a value other than zero or else data lists will not be included in the response. See “SPI Standard Definitions” in Section 5 for a detailed description of this token.
Commands and Responses GETVERSION Command The following nonzero values of RETCODE can be returned in response to the DELETE command: ZSPI-ERR-INVBUF (-1) ZCOM-ERR-CMD-INV-IN-SUMSTATE (-3) ZCOM-ERR-CMD-MISMATCH (-4) ZCOM-ERR-CMD-TOO-LARGE (-8) ZCOM-ERR-OBJ-NOT-FOUND (-17) ZCOM-ERR-OBJ-NOT-SUPP (-18) ZCOM-ERR-SECUR-VIOL (-22) ZCOM-ERR-SPI-ERR (-23) ZCOM-ERR-SSID-INV (-24) ZCOM-ERR-TKN-CODE-INV (-26) ZCOM-ERR-TKN-DUP (-27) ZCOM-ERR-TKN-REQ (-29) ZSPI-TKN-ERRLIST indicates the beginning of an error list.
Commands and Responses GETVERSION Command GETVERSION Command The GETVERSION command obtains server version and server-banner string from the TELNET subsystem. The server-banner string identifies the product name, product number, and release date. The string can contain a maximum of 50 bytes. Your management application can issue the GETVERSION command with the NULL or PROC object type. If your management application specifies any other object type in the command, the TELNET subsystem returns an error.
Commands and Responses GETVERSION Command Tokens in Response Buffer ZSPI-TKN-SSID ZSPI-TKN-SERVER-VERSION ZSPI-TKN-DATALIST ZSPI-TKN-SERVER-BANNER ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ... ZSPI-TKN-ENDLIST ZSPI-TKN-ENDLIST token-type token-type token-type token-type token-type token-type token-type token-type ZSPI-TYP-SSID. !{} ZSPI-TYP-UINT. !{} ZSPI-TYP-LIST. !... ZSPI-TYP-CHAR50.!{} ZSPI-TYP-STRING.!{} ZSPI-TYP-ENUM. !{} ZSPI-TYP-ENUM. !{} ZSPI-TYP-LIST. !...
Commands and Responses GETVERSION Command ZSPI-TKN-SERVER-VERSION indicates the software release version of the TELNET subsystem. See “SPI Standard Definitions” in Section 5 for a detailed description of this token. ZSPI-TKN-DATALIST indicates the beginning of a data list. The ZSPI-TKN-MAXRESP token must have a value other than zero for data lists to be included in the response. See “SPI Standard Definitions” in Section 5 for a detailed description of this token.
Commands and Responses INFO Command The following nonzero values of RETCODE can be returned in response to the GETVERSION command: ZSPI-ERR-INVBUF (-1) ZCOM-ERR-CMD-MISMATCH (-4) ZCOM-ERR-CMD-TOO-LARGE (-8) ZCOM-ERR-OBJ-NOT-FOUND (-17) ZCOM-ERR-OBJ-NOT-SUPP (-18) ZCOM-ERR-SPI-ERR (-23) ZCOM-ERR-SSID-INV (-24) ZCOM-ERR-TKN-CODE-INV (-26) ZCOM-ERR-TKN-DUP (-27) ZCOM-ERR-TKN-REQ (-29) ZSPI-TKN-ERRLIST indicates the beginning of an error list.
Commands and Responses INFO Command INFO Command The INFO command obtains the values of the configurable attributes of the specified object(s) from the TELNET subsystem. These values are returned in the ZTNT-MAPINFO-PROC or ZTNT-MAP-INFO-WIN extensible structured tokens. When your management application issues the INFO command for a window, the subsystem checks for an object-name template. If one is present, information is returned for all the windows that meet the template requirements.
Commands and Responses INFO Command ZSPI-TKN-MAXRESP ZSPI-TKN-CONTEXT ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT token-type token-type token-type token-type ZSPI-TYP-INT. ZSPI-TYP-BYTESTRING. ZSPI-TYP-ENUM. ZSPI-TYP-STRING. Tokens in Response Buffer ZSPI-TKN-SSID ZSPI-TKN-SERVER-VERSION ZSPI-TKN-DATALIST token-type ZSPI-TYP-SSID. !{} token-type ZSPI-TYP-UINT. !{} token-type ZSPI-TYP-LIST.!... ZTNT-MAP-INFO-PROC !{} !OBJ-PROC def ZTNT-DDL-INFO-PROC.
Commands and Responses INFO Command ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ... ZSPI-TKN-ENDLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT token-type token-type token-type token-type ZSPI-TYP-STRING. !{} ZSPI-TYP-ENUM. !{} ZSPI-TYP-ENUM. !{} ZSPI-TYP-LIST. !... token-type ZSPI-TYP-SSCTL. token-type ZSPI-TYP-SSCTL. token-type ZSPI-TYP-BYTESTRING. Tokens in Command Buffer ZSPI-TKN-SSID identifies the subsystem ID. Your application must provide this token in the command.
Commands and Responses INFO Command ZSPI-TKN-DATALIST indicates the beginning of a data list. The ZSPI-TKN-MAXRESP token must have a value other than zero or else data lists will not be included in the response. See “SPI Standard Definitions” in Section 5 for a detailed description of this token. ZTNT-MAP-INFO-PROC is an extensible structured token that lists the configurable attributes for the TELNET process. It has the token number ZTNT-TNM-INFO-PROC and the DDL definition ZTNT-DDL-INFO-PROC.
Commands and Responses INFO Command The following fields are in the ZTNT-MAP-INFO-WIN extensible structured token: ZERASE-CHAR is a one-byte character value that indicates the ASCII control character used to erase a single character of input. ZKILL-CHAR is a one-byte character value that indicates the ASCII control character used to delete the line currently being entered. ZEOF-CHAR is a one-byte character value that indicates the ASCII control character used to signal the end of input condition.
Commands and Responses INFO Command requirements. ZCOM-TKN-OBJNAME is described more fully in “Data Communications Standard Definitions” in Section 5. ZCOM-TKN-OBJTYPE specifies the type of object that was queried. This token has the value ZCOM-OBJPROC or ZCOM-OBJ-WINDOW. See Section 5, “Common Definitions,” for a detailed description of this token. ZSPI-TKN-RETCODE specifies whether the command completed successfully.
Commands and Responses LISTOBJECTS Command Operational Notes INFO is a nonsensitive command; all users on the system can issue this command. The summary state of an object does not affect the ability of a user or subsystem to obtain information on the object. When the command is completed, the object remains in the same summary state as before the command was executed. Use the ALTER command to change the values of the attributes.
Commands and Responses LISTOBJECTS Command LISTOBJECTS Command The LISTOBJECTS command returns the names of objects known to the TELNET subsystem. The objects returned depend on the value of the ZSPI-TKN-OBJECT-TYPE and ZCOM-TKN-OBJNAME tokens. When your management application specifies the NULL object, all object types and object names known to the TELNET subsystem are returned. In this case, the OBJNAME token must either have a zero length or be absent.
Commands and Responses LISTOBJECTS Command Tokens in Command Buffer ZSPI-TKN-SSID ZCOM-TKN-OBJNAME token-type ZSPI-TYP-SSID. !{} token-type ZSPI-TYP-STRING. ZCOM-MAP-REQID def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end. ZSPI-TKN-MAXRESP ZSPI-TKN-CONTEXT ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT !Specify values, if map present. type ZSPI-DDL-CRTPID. type ZSPI-DDL-INT. token-type token-type token-type token-type ZSPI-TYP-INT. ZSPI-TYP-BYTESTRING. ZSPI-TYP-ENUM. ZSPI-TYP-STRING.
Commands and Responses LISTOBJECTS Command ZCOM-MAP-REQID is a standard data communications token your application can optionally provide. This token is described in “Data Communications Standard Definitions” in Section 5. (ZSPI-TKN-) MAXRESP, CONTEXT, ALLOW-TYPE, and COMMENT are standard SPI tokens your application can optionally provide. These tokens are described in “SPI Standard Definitions” in Section 5. Tokens in Response Buffer ZSPI-TKN-SSID identifies the subsystem ID.
Commands and Responses LISTOPENS Command If the command did not complete successfully, the value of this token indicates the reason the command failed. Always check the contents of the error list to determine the token or value in error. For details on the ZCOM return codes, see the Communications Management Programming Manual. For details on the ZSPI return codes and associated error lists, see the Distributed Systems Management (DSM) Programming Manual.
Commands and Responses LISTOPENS Command LISTOPENS Command The LISTOPENS command returns information about the openers of the TELNET process. The extensible structured token ZTNT-MAP-OPENS-TELNET, which contains the opener information, can be returned multiple times (once for each open). Command ZCOM-CMD-LISTOPENS Object Type ZCOM-OBJ-PROC Tokens in Command Buffer ZSPI-TKN-SSID ZCOM-TKN-OBJNAME token-type ZSPI-TYP-SSID. token-type ZSPI-TYP-STRING. !{} !{} ZCOM-MAP-REQID def ZCOM-DDL-REQID.
Commands and Responses LISTOPENS Command Tokens in Response Buffer ZSPI-TKN-SSID ZSPI-TKN-SERVER-VERSION ZSPI-TKN-DATALIST ZTNT-MAP-OPENS-TELNET token-type ZSPI-TYP-SSID. token-type ZSPI-TYP-UINT. token-type ZSPI-TYP-LIST. !{} def ZTNT-DDL-OPENS-TELNET. !All 02 ZBKUP-CPU type 02 ZBKUP-PIN type 02 ZBKUP-FNUM type 02 ZPRIM-CPU type 02 ZPRIM-PIN type 02 ZPRIM-FNUM type 02 ZPROCNAME type end. ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ...
Commands and Responses LISTOPENS Command (ZSPI-TKN-) MAXRESP, CONTEXT, ALLOW-TYPE, and COMMENT are standard SPI tokens your application can optionally provide. These tokens are described in “SPI Standard Definitions” in Section 5. Tokens in Response Buffer ZSPI-TKN-SSID identifies the subsystem ID. The value for the TELNET subsystem is ZTNT-VALSSID. This token is described more fully in “SPI Standard Definitions” in Section 5.
Commands and Responses LISTOPENS Command ZPRIM-FNUM is an integer value that specifies the primary file number assigned to the opener when the OPEN procedure was called. ZPROCNAME is a null-terminated string that specifies the system name of the opener. ZCOM-TKN-OBJNAME specifies the name of the TELNET process specified in the command. Unless an error prevents the LISTOPENS command from being attempted at all, this token is present in every response record.
Commands and Responses RESETSTATS Command ZSPI-TKN-ENDLIST indicates the end of a data list or an error list. See “SPI Standard Definitions” in Section 5 for a detailed description of this token. ZSPI-TKN-CONTEXT specifies whether more response messages are going to be received for a response. If this token is present, the response continues to the next response message. If this token is not present, the response message is the last to be received.
Commands and Responses RESETSTATS Command RESETSTATS Command The RESETSTATS command returns statistical information about the execution history of the specified object(s). The type of information returned by this command is the same as that returned by the STATISTICS command, but this command initializes the statistics counters after the information is placed in a response message. The RESETSTATS command is a sensitive command.
Commands and Responses RESETSTATS Command ZCOM-MAP-REQID def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end. ZSPI-TKN-MAXRESP ZSPI-TKN-CONTEXT ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT !Specify values, if map present. type ZSPI-DDL-CRTPID. type ZSPI-DDL-INT. token-type token-type token-type token-type ZSPI-TYP-INT. ZSPI-TYP-BYTESTRING. ZSPI-TYP-ENUM. ZSPI-TYP-STRING. Tokens in Response Buffer ZSPI-TKN-SSID ZSPI-TKN-SERVER-VERSION ZSPI-TKN-DATALIST token-type ZSPI-TYP-SSID. token-type ZSPI-TYP-UINT.
Commands and Responses RESETSTATS Command def ZTNT-DDL-STATS-WIN. 02 ZUSER-BYTES 02 ZNET-BYTES 02 ZREAD-REQ 02 ZWRITE-REQ 02 ZWRITE-READ-REQ 02 ZCTL-REQ 02 ZSETMODE-REQ 02 ZCANCEL-REQ 02 ZCURR-TIME 02 ZRESET-TIME end. ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ... ZSPI-TKN-ENDLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT !All type type type type type type type type type type fields are present. ZSPI-DDL-INT2. ZSPI-DDL-INT2. ZSPI-DDL-INT2. ZSPI-DDL-INT2. ZSPI-DDL-INT2. ZSPI-DDL-INT2.
Commands and Responses RESETSTATS Command (ZSPI-TKN-) MAXRESP, CONTEXT, ALLOW-TYPE, and COMMENT are standard SPI tokens your application can optionally provide. These tokens are described in “SPI Standard Definitions” in Section 5. Tokens in Response Buffer ZSPI-TKN-SSID identifies the subsystem ID. The value for the TELNET subsystem is ZTNT-VALSSID. This token is described more fully in “SPI Standard Definitions” in Section 5.
Commands and Responses RESETSTATS Command ZTOTAL-USER-DATA is an integer value that indicates the number of bytes of data sent by users during the sample period. ZTOTAL-NET-REQ is an integer value that indicates the number of packets received from the network by the TELNET subsystem during the sample period. ZTOTAL-USER-REQ is an integer value that indicates the number of user requests received by the TELNET subsystem during the sample period.
Commands and Responses RESETSTATS Command ZRESET-TIME is the time at which the window statistics counters were last reset. This time indicates the beginning of the sample period. ZCOM-TKN-OBJNAME specifies the name of a TELNET object for which statistical information was requested. Unless an error prevents the RESETSTATS command from being attempted at all, this token is present in every response record.
Commands and Responses START Command The following nonzero values of RETCODE can be returned in response to the RESETSTATS command: ZSPI-ERR-INVBUF (-1) ZCOM-ERR-CMD-MISMATCH (-4) ZCOM-ERR-CMD-TOO-LARGE (-8) ZCOM-ERR-OBJ-NOT-FOUND (-17) ZCOM-ERR-OBJ-NOT-SUPP (-18) ZCOM-ERR-SECUR-VIOL (-22) ZCOM-ERR-SPI-ERR (-23) ZCOM-ERR-SSID-INV (-24) ZCOM-ERR-TKN-CODE-INV (-26) ZCOM-ERR-TKN-DUP (-27) ZCOM-ERR-TKN-REQ (-29) ZSPI-TKN-ERRLIST indicates the beginning of an error list.
Commands and Responses START Command START Command The START command initiates the operation of windows. When the subsystem finishes processing this command, the specified window is placed in the STARTED summary state. You can start a window but not a process. You can use an object-name template to start multiple windows. Refer to “ObjectName Templates” in Section 3, “Elements of SPI Messages for the TELNET Subsystem,” for a detailed description of this token.
Commands and Responses START Command Tokens in Response Buffer ZSPI-TKN-SSID ZSPI-TKN-SERVER-VERSION ZSPI-TKN-DATALIST ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ... ZSPI-TKN-ENDLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT token-type token-type token-type token-type token-type token-type token-type ZSPI-TYP-SSID. !{} ZSPI-TYP-UINT. !{} ZSPI-TYP-LIST. !... ZSPI-TYP-STRING. !{} ZSPI-TYP-ENUM. !{} ZSPI-TYP-ENUM. !{} ZSPI-TYP-LIST. !... token-type ZSPI-TYP-SSCTL.
Commands and Responses START Command ZSPI-TKN-SERVER-VERSION indicates the software release version of the TELNET subsystem. See “SPI Standard Definitions” in Section 5 for a detailed description of this token. ZSPI-TKN-DATALIST indicates the beginning of a data list. The ZSPI-TKN-MAXRESP token must have a value other than zero or else data lists will not be included in the response. See “SPI Standard Definitions” in Section 5 for a detailed description of this token.
Commands and Responses STATISTICS Command The following nonzero values of RETCODE can be returned in response to the START command: ZSPI-ERR-INVBUF (-1) ZCOM-ERR-CMD-INV-IN-SUMSTATE (-3) ZCOM-ERR-CMD-MISMATCH (-4) ZCOM-ERR-CMD-TOO-LARGE (-8) ZCOM-ERR-OBJ-ALRDY-IN-SUMSTATE (-16) ZCOM-ERR-OBJ-NOT-FOUND (-17) ZCOM-ERR-OBJ-NOT-SUPP (-18) ZCOM-ERR-SECUR-VIOL (-22) ZCOM-ERR-SPI-ERR (-23) ZCOM-ERR-SSID-INV (-24) ZCOM-ERR-TKN-CODE-INV (-26) ZCOM-ERR-TKN-DUP (-27) ZCOM-ERR-TKN-REQ (-29) ZSPI-TKN-ERRLIST indicates t
Commands and Responses STATISTICS Command STATISTICS Command The STATISTICS command returns statistical information about the execution history of the specified object(s). The type of information returned by this command is the same as that returned by the RESETSTATS command, but this command does not initialize the statistics counters after the TELNET subsystem places the information in a response message. This is a nonsensitive command.
Commands and Responses STATISTICS Command def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end. ZSPI-TKN-MAXRESP ZSPI-TKN-CONTEXT ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT !Specify values, if map present. type ZSPI-DDL-CRTPID. type ZSPI-DDL-INT. token-type token-type token-type token-type ZSPI-TYP-INT. ZSPI-TYP-BYTESTRING. ZSPI-TYP-ENUM. ZSPI-TYP-STRING. Tokens in Response Buffer ZSPI-TKN-SSID ZSPI-TKN-SERVER-VERSION ZSPI-TKN-DATALIST token-type ZSPI-TYP-SSID. token-type ZSPI-TYP-UINT. token-type ZSPI-TYP-LIST.
Commands and Responses STATISTICS Command def ZTNT-DDL-STATS-WIN. 02 02 02 02 02 02 02 02 02 02 end. ZUSER-BYTES ZNET-BYTES ZREAD-REQ ZWRITE-REQ ZWRITE-READ-REQ ZCTL-REQ ZSETMODE-REQ ZCANCEL-REQ ZCURR-TIME ZRESET-TIME ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ... ZSPI-TKN-ENDLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT !All type type type type type type type type type type fields are present. ZSPI-DDL-INT2. ZSPI-DDL-INT2. ZSPI-DDL-INT2. ZSPI-DDL-INT2. ZSPI-DDL-INT2. ZSPI-DDL-INT2.
Commands and Responses STATISTICS Command Tokens in Response Buffer ZSPI-TKN-SSID identifies the subsystem ID. The value for the TELNET subsystem is ZTNT-VALSSID. This token is described more fully in “SPI Standard Definitions” in Section 5. ZSPI-TKN-SERVER-VERSION indicates the software release version of the TELNET subsystem. See “SPI Standard Definitions” in Section 5 for a detailed description of this token. ZSPI-TKN-DATALIST indicates the beginning of a data list.
Commands and Responses STATISTICS Command ZTOTAL-USER-REQ is an integer value that indicates the number of user requests received by the TELNET subsystem during the sample period. ZCURR-TIME is the time at which the TELNET process read the TELNET subsystem statistics counters. This time indicates the end of the sample period. ZRESET-TIME is the time at which the TELNET subsystem statistics counters were last reset. This time indicates the beginning of the sample period.
Commands and Responses STATISTICS Command ZCOM-TKN-OBJNAME specifies the name of a TELNET object for which statistical information was requested. Unless an error prevents the STATISTICS command from being attempted at all, this token is present in every response record. If you have used an object-name template, a separate ZCOM-TKN-OBJNAME token is returned for each window that meets the template requirements.
Commands and Responses STATUS Command ZSPI-TKN-ENDLIST indicates the end of a data list or an error list. See “SPI Standard Definitions” in Section 5 for a detailed description of this token. ZSPI-TKN-CONTEXT specifies whether more response messages are going to be received for a response. If this token is present, the response continues to the next response message. If this token is not present, the response message is the last to be received.
Commands and Responses STATUS Command STATUS Command The STATUS command returns information about the current summary state of the specified object(s). When the TELNET subsystem finishes processing this command, the specified object remains in the same summary state. You can inquire about the status of the process or windows. When your management application issues the STATUS command for the WINDOW object, the TELNET subsystem checks for object-name templates.
Commands and Responses STATUS Command Tokens in Response Buffer ZSPI-TKN-SSID ZSPI-TKN-SERVER-VERSION ZSPI-TKN-DATALIST ZTNT-TKN-STATUS-PROC token-type ZSPI-TYP-SSID. token-type ZSPI-TYP-UINT. token-type ZSPI-TYP-LIST. !{} !{} !... token-type ZSPI-TYP-ENUM. !{} !OBJ-PROC ZTNT-MAP-STATUS-WIN !{} !OBJ-WINDOW def ZTNT-DDL-STATUS-WIN. !All fields are present. 02 ZSTATUS type ZSPI-DDL-ENUM. end. ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ...
Commands and Responses STATUS Command (ZSPI-TKN-) MAXRESP, CONTEXT, ALLOW-TYPE, and COMMENT are standard SPI tokens your application can optionally provide. These tokens are described in “SPI Standard Definitions” in Section 5. Tokens in Response Buffer ZSPI-TKN-SSID identifies the subsystem ID. The value for the TELNET subsystem is ZTNT-VALSSID. This token is described more fully in “SPI Standard Definitions” in Section 5.
Commands and Responses STATUS Command ZCOM-TKN-OBJTYPE specifies the type of object for which information was requested. The possible values are ZCOM-OBJ-PROC and ZCOM-OBJ-WINDOW. This token is present in every response record. The value of the ZCOM-TKN-OBJTYPE token is the same as the value of the ZSPI-TKN-OBJECT-TYPE token in the header. See Section 5, “Common Definitions,” for a detailed description of this token. ZSPI-TKN-RETCODE specifies whether the command completed successfully.
Commands and Responses STOP Command ZSPI-TKN-CONTEXT specifies whether more response messages are going to be received for a response. If this token is present, the response continues to the next response message. If this token is not present, the response message is the last to be received. See “SPI Standard Definitions” in Section 5 for a detailed description of this token. Operational Notes STATUS is a nonsensitive command; any user on the system can issue this command.
Commands and Responses STOP Command STOP Command The STOP command terminates the operation of the specified window. You can stop a window but not a process. You can use an object-name template to terminate the operation of multiple windows. When the subsystem finishes processing the command, the specified window is placed in the STOPPED summary state.
Commands and Responses STOP Command Tokens in Response Buffer ZSPI-TKN-SSID ZSPI-TKN-SERVER-VERSION ZSPI-TKN-DATALIST ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ... ZSPI-TKN-ENDLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT token-type token-type token-type token-type token-type token-type token-type ZSPI-TYP-SSID. !{} ZSPI-TYP-UINT. !{} ZSPI-TYP-LIST. !... ZSPI-TYP-STRING. {} ZSPI-TYP-ENUM. {} ZSPI-TYP-ENUM. !{} ZSPI-TYP-LIST. ... token-type ZSPI-TYP-SSCTL. token-type ZSPI-TYP-SSCTL.
Commands and Responses STOP Command ZSPI-TKN-SERVER-VERSION indicates the software release version of the TELNET subsystem. See “SPI Standard Definitions” in Section 5 for a detailed description of this token. ZSPI-TKN-DATALIST indicates the beginning of a data list. The ZSPI-TKN-MAXRESP token must have a value other than zero or else data lists will not be included in the response. See “SPI Standard Definitions” in Section 5 for a detailed description of this token.
Commands and Responses TRACE Command The following nonzero values of RETCODE can be returned in response to the STOP command: ZTNT-ERR-NO-STOP-OBJ-ACTV (2) ZSPI-ERR-INVBUF (-1) ZCOM-ERR-CMD-INV-IN-SUMSTATE (-3) ZCOM-ERR-CMD-MISMATCH (-4) ZCOM-ERR-CMD-TOO-LARGE (-8) ZCOM-ERR-OBJ-ALRDY-IN-SUMSTATE (-16) ZCOM-ERR-OBJ-NOT-FOUND (-17) ZCOM-ERR-OBJ-NOT-SUPP (-18) ZCOM-ERR-SECUR-VIOL (-22) ZCOM-ERR-SPI-ERR (-23) ZCOM-ERR-SSID-INV (-24) ZCOM-ERR-TKN-CODE-INV (-26) ZCOM-ERR-TKN-DUP (-27) ZCOM-ERR-TKN-REQ (-29) ZSPI
Commands and Responses TRACE Command TRACE Command The TRACE command allows your management application to capture and store records that can be displayed using the PTRACE utility. The TELNET subsystem does not support the TRACE command directly. Instead, your management application issues the command to SCP, which then invokes the SCP trace facility. Once the TRACE command has been issued for an object, that object enters trace mode and normal operation cannot take place.
Commands and Responses TRACE Command Command ZCOM-CMD-TRACE Object Type ZCOM-OBJ-PROC or ZCOM-OBJ-WINDOW Tokens in Command Buffer ZCOM-MAP-TRACE-MODIF {} def ZCOM-DDL-TRACE-MODIF. 02 ZSTOP 02 ZPRIM 02 ZREC-SIZE 02 ZCNT 02 ZXDS-PAGES 02 ZCOLL 02 ZFNAME 02 ZWRAP end. !All type type type type type type type type fields are required. ZSPI-DDL-BOOLEAN. ZSPI-DDL-BOOLEAN. ZSPI-DDL-INT. ZSPI-DDL-INT2. ZSPI-DDL-INT. ZSPI-DDL-BOOLEAN. ZSPI-DDL-FNAME32. ZSPI-DDL-BOOLEAN.
Commands and Responses TRACE Command Tokens in Response Buffer ZSPI-TKN-SSID ZSPI-TKN-SERVER-VERSION token-type ZSPI-TYP-SSID. token-type ZSPI-TYP-UINT. !{} !{} ZSPI-TKN-DATALIST ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ... ZSPI-TKN-ENDLIST ZSPI-TKN-ENDLIST token-type token-type token-type token-type token-type !{} !{} !{} ZSPI-TYP-LIST. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TYP-ENUM. ZSPI-TYP-LIST. token-type ZSPI-TYP-SSCTL. token-type ZSPI-TYP-SSCTL.
Commands and Responses TRACE Command ZCOM-TKN-OBJNAME specifies the object that is going to be traced. Your application must provide this token in the command. The object name cannot be an object-name template. This token is described more fully in “Data Communications Standard Definitions” in Section 5. ZCOM-MAP-REQID is a standard data communications token your application can optionally provide. This token is described in “Data Communications Standard Definitions” in Section 5.
Commands and Responses TRACE Command ZSPI-TKN-RETCODE specifies whether the command completed successfully. If the command completed successfully, including when the command completes with a warning, the value of this token is zero (ZCOM-ERR-OK). Note that if the empty response (ZCOM-ERR-EMPT-RSP) is returned, the value of this token is nonzero even though the command has completed successfully. If the command did not complete successfully, the value of this token indicates the reason the command failed.
Commands and Responses TRACE Command The following nonzero values of RETCODE can be traced in response to the TRACE command: 6–76 Error Value ZSPI-ERR-INVBUF ZCOM-ERR-CMD-MISMATCH ZCOM-ERR-CMD-SEQ-INV ZCOM-ERR-CMD-TOO-LARGE ZCOM-ERR-OBJ-NOT-FOUND ZCOM-ERR-OBJ-NOT-SUPP ZCOM-ERR-SECUR-VIOL ZCOM-ERR-SPI-ERR ZCOM-ERR-SSID-INV ZCOM-ERR-TKN-CODE-INV ZCOM-ERR-TKN-DUP ZCOM-ERR-TKN-REQ ZCOM-ERR-TRACE-ATTR-INV ZCOM-ERR-TRACE-LCB-INV ZCOM-ERR-TRACE-FUNC-INV ZCOM-ERR-TRACE-NOT-ACTV ZCOM-ERR-TRACE-SEG-OVERFLOW ZCOM
Commands and Responses TRACE Command ZSPI-TKN-ERRLIST indicates the beginning of an error list. See “SPI Standard Definitions” in Section 5 for a detailed description of this token. ZSPI-TKN-ENDLIST indicates the end of a data list or an error list. See “SPI Standard Definitions” in Section 5 for a detailed description of this token. Operational Notes TRACE is a sensitive command. This command is processed by the SCP trace facility.
7 Event Management The TELNET subsystem reports information about events it detects by issuing event messages. A management application can obtain these event messages by opening an Event Management Service (EMS) distributor process and requesting the messages. The application can also specify the application of a filter to select certain event messages.
Event Management Event-Management Programming Event-Management TELNET event messages are made up of individual tokens, each containing one piece Programming of information about the event. These event messages contain no extensible structured tokens or lists. All TELNET event messages are reported to the EMS collector ($0). The TELNET subsystem does not report action events. Action events prompt the operator for intervention, such as to mount a tape.
Event Management Event-Management Programming event messages, no difference exists between the two versions (except possibly the standard header). The notation used in the box for simple tokens is a shorthand version of the essential information given in the DDL TOKEN-CODE statement. Following the box, the event-message tokens are described in the same order in which they appear in the box. However, because Tandem internal tokens are intended for Tandem use only, they are not described.
Event Management ZTNT-EVT-NO-MEM ZTNT-EVT-NO-MEM The internal allocation of memory buffers (MBUFs) failed. An attempt was made to allocate memory to MBUFs, but the size specified was larger than the amount available. This could cause data transfer to be slower or to fail when memory cannot be allocated for data structures. This event is critical. The event message is reported to the EMS collector ($0).
Event Management ZTNT-EVT-NO-MEM ZCOM-TKN-SUBJ-PROC contains the name of the TELNET process that is the subject of this event message. ZEMS-TKN-EMPHASIS is a header token that contains the value ZSPI-VAL-TRUE, indicating that this is a critical event. (ZEMS-TKN-) CONSOLE-PRINT, CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and USERID are automatically placed in the header when the EMSINIT procedure is called and the event message buffer is initialized.
Event Management ZTNT-EVT-TELNET-WRITE-ERR ZTNT-EVT-TELNET-WRITE-ERR A WRITE operation to the TCP/IP process failed. This causes the window that attempted the WRITE operation to go down and the connection to the remote machine to be severed. This event is critical. The event message is reported to the EMS collector ($0).
Event Management ZTNT-EVT-TELNET-WRITE-ERR ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token— here, ZCOM-TKN-SUBJ-WINDOW. ZCOM-TKN-SUBJ-WINDOW contains the name of the TELNET window that is the subject of this event message. ZEMS-TKN-EMPHASIS is a header token that contains the value ZSPI-VAL-TRUE, indicating that this is a critical event.
Event Management ZTNT-EVT-TELNET-WRITE-ERR Probable Cause A WRITE operation to the TCP/IP process has failed. Recommended Action If the window was added dynamically when the connection was established, the window will disappear and a new connection must be established. If the window was added with the ADD command, recovery is automatic and the window will be available to the next user who logs on.
Event Management ZTNT-EVT-TELNET-READ-ERR ZTNT-EVT-TELNET-READ-ERR A READ operation to the TCP/IP process failed. This causes the window that attempted the READ operation to go down and the connection to the remote machine to be severed. This event is critical. The event message is reported to the EMS collector ($0).
Event Management ZTNT-EVT-TELNET-READ-ERR ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token— here, ZCOM-TKN-SUBJ-WINDOW. ZCOM-TKN-SUBJ-WINDOW contains the name of the TELNET window that is the subject of this event message. ZEMS-TKN-EMPHASIS is a header token that contains the value ZSPI-VAL-TRUE, indicating that this is a critical event.
Event Management ZTNT-EVT-TELNET-READ-ERR Probable Cause A READ operation to the TCP/IP process has failed. Recommended Action If the window was added dynamically when the connection was established, the window will disappear and a new connection must be established. If the window was added with the ADD command, recovery is automatic and the window will be available to the next user who logs on.
Event Management ZTNT-EVT-TELNET-AWAITIO-ERR ZTNT-EVT-TELNET-AWAITIO-ERR The TELNET process called the AWAITIO procedure during communication with the TCP/IP process, but an error occurred while the operation was waiting to complete to the socket. This event causes the window to go down and the connection to the remote machine to be severed. This event is critical. The event message is reported to the EMS collector ($0).
Event Management ZTNT-EVT-TELNET-AWAITIO-ERR ZEMS-TKN-EVENTNUMBER is a header token that contains the event number. Its value is ZTNT-EVTTELNET-AWAITIO-ERR (4). ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token— here, ZCOM-TKN-SUBJ-WINDOW. ZCOM-TKN-SUBJ-WINDOW contains the name of the TELNET window that is the subject of this event message. ZEMS-TKN-EMPHASIS is a header token that contains the value ZSPI-VAL-TRUE, indicating that this is a critical event.
Event Management ZTNT-EVT-TELNET-AWAITIO-ERR Probable Cause An error occurred while the TELNET process was waiting for an I/O operation to complete on the TCP/IP process. This event message is returned only if the TCP/IP process called the AWAITIO procedure. Recommended Action If the window was added dynamically when the connection was established, the window will disappear and a new connection must be established.
Event Management ZTNT-EVT-SUMSTATE-CHG ZTNT-EVT-SUMSTATE-CHG The summary state of a TELNET window has changed as a result of an operator command or an error. If the summary-state change is the result of an error, one of the four events described earlier in this section (TELNET event messages 1 through 4) will also occur and will provide additional information on the cause of the error. This event is a noncritical event. The event message is reported to the EMS collector ($0).
Event Management ZTNT-EVT-SUMSTATE-CHG ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token— here, ZCOM-TKN-SUBJ-WINDOW. ZCOM-TKN-SUBJ-WINDOW contains the name of the TELNET window that is the subject of this event message. ZEMS-TKN-EMPHASIS is a header token that contains the value ZSPI-VAL-FALSE, indicating that this is not a critical event.
Event Management ZTNT-EVT-SUMSTATE-CHG Event-Message Text In the text message, win-spec corresponds to the value in ZCOM-TKN-SUBJWINDOW, old-state corresponds to the value in ZCOM-TKN-OLD-OBJSTATE, new-state corresponds to the value in ZCOM-TKN-OBJSTATE, and cause corresponds to the value in ZCOM-TKN-CAUSE-SUMSTATE-CHG. Probable Cause The summary state of a TELNET window has changed. This can be the result of a command or an error.
Event Management ZTNT-EVT-INTL ZTNT-EVT-INTL The TELNET process detected an internal error and has halted. The TELNET process no longer exists. This event is critical. The event message is reported to the EMS collector ($0).
Event Management ZTNT-EVT-INTL ZCOM-TKN-SUBJ-PROC contains the name of the TELNET subsystem that is the subject of this event message. ZEMS-TKN-EMPHASIS is a header token that contains the value ZSPI-VAL-TRUE, indicating that this is a critical event. (ZEMS-TKN-) CONSOLE-PRINT, CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM and USERID are automatically placed in the header when the EMSINIT procedure is called and the event message buffer is initialized.
Event Management Examples of Filters Examples of Filters The following two examples illustrate simple filters that could be created to select TELNET event messages. For both examples, the following assumptions have been made: All TELNET definitions used in the filters have been loaded into TACL before compilation. Tokens and subsystems you have created have been defined and loaded before compilation. All subsystem IDs not initialized in the filter have been initialized by some other means.
Event Management Examples of Filters Example 2 The following filter selects all the critical TELNET event messages that are not fatal and that have a particular process as their subject. — Filter that selects only critical TELNET event messages — that are not fatal and have as their subject a particular — process name. [#SET ztnt^val^ssid [zspi^val^tandem].[zspi^ssn^ztnt].
Appendix A Error Numbers and Error Lists This appendix describes the error numbers and associated error lists defined by the TELNET subsystem (that is, the error values whose symbolic names begin with ZTNTERR-). These error numbers occur as values of the tokens ZSPI-TKN-RETCODE and ZSPI-TKN-ERROR. These errors cannot occur for all commands. To determine which commands return these TELNET-specific errors, refer to the following descriptions of each of the error numbers.
Error Numbers and Error Lists ZTNT-ERR-ATTR-OUT-OF-RANGE ZTNT-ERR-ATTR-OUT-OF-RANGE The ALTER PROCESS command has been issued but cannot execute because a value specified for one of the attributes is outside the valid range. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-ENDLIST token-type ZSPI-TYP-LIST. token-type ZSPI-TYP-ERROR. token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-ENUM. token-type ZSPI-TYP-SSCTL.
Error Numbers and Error Lists ZTNT-ERR-NO-STOP-OBJ-ACTV ZTNT-ERR-NO-STOP-OBJ-ACTV The STOP WINDOW command has been issued but cannot execute because the specified window still has active opens. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-ENDLIST token-type ZSPI-TYP-LIST. token-type ZSPI-TYP-ERROR. token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-ENUM. token-type ZSPI-TYP-SSCTL.
Appendix B Telnet Subsystem DDL This appendix contains a listing of the TELNET subsystem-specific DDL file. This DDL file, along with other DDL files, is provided to you with the TELNET software package. It is included here as a convenient quick reference to the TELNET subsystem-specific definitions.
Telnet Subsystem DDL * TELNET _ T9553C11 _ 29FEB89 ?SETSECTION *---------------------------------------------------------------* * SPI Definitions for TELNET * *---------------------------------------------------------------* *---------------------------------------------------------------* * The attributes that are recognized (in Add and Alter) are: * * * * erase-char - The erase character. * * kill-char - The line kill (delete line). * * eof-char - End of file from terminal. * * eol-char - End of line.
Telnet Subsystem DDL * loc_port Local Port * * forgn_port Foreign Port * *---------------------------------------------------------------* ?SECTION zTNT-ddl-info-win ?TALBOUND 0 DEF zTNT-ddl-info-win. 02 zerase-char 02 zkill-char 02 zeof-char 02 zeol-char 02 zintrpt-char 02 zloc-addr 02 zforgn-addr 02 zloc-port 02 zforgn-port 02 zservname END. TYPE TYPE TYPE TYPE TYPE TYPE TYPE TYPE TYPE TYPE zspi-ddl-char. zspi-ddl-char. zspi-ddl-char. zspi-ddl-char. zspi-ddl-char. zspi-ddl-int2. zspi-ddl-int2.
Telnet Subsystem DDL *---------------------------------------------------------------* ?SECTION zTNT-ddl-status-win ?TALBOUND 0 DEF zTNT-ddl-status-win. 02 zstatus TYPE zspi-ddl-enum. END. *---------------------------------------------------------------* * in_conn is the number of incoming connections. * * total_open is the number of opens from user programs. * * total_net_data is the number of bytes of data received from * * net.
Telnet Subsystem DDL 02 zwrite-read-req 02 zctl-req 02 zsetmode-req 02 zcancel-req 02 zcurr-time 02 zreset-time END. TYPE TYPE TYPE TYPE TYPE TYPE zspi-ddl-int2. zspi-ddl-int2. zspi-ddl-int2. zspi-ddl-int2. zspi-ddl-timestamp. zspi-ddl-timestamp. *---------------------------------------------------------------* * All opens listed below by process name. * * zprocname is a null terminated string. * * zcpu says which cpu the process is working in. * * zpin is the process id in the CPU.
Telnet Subsystem DDL * Can't allocate mbufs.
Telnet Subsystem DDL CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT zTNT-tnm-file-num zTNT-tnm-size zTNT-tnm-text zTNT-tnm-term zTNT-tnm-info-proc zTNT-tnm-info-win zTNT-tnm-stats-telnet zTNT-tnm-stats-win zTNT-tnm-status-win zTNT-tnm-opens-telnet VALUE VALUE VALUE VALUE VALUE VALUE VALUE VALUE VALUE VALUE 7. 8. 9. 10. 11. 12. 13. 14. 15. 16. DEF zTNT-val-ssid TACL ssid. 02 z-filler TYPE CHARACTER 8 VALUE zspi-val-tandem.
Telnet Subsystem DDL TOKEN-CODE zTNT-tkn-status-proc VALUE zTNT-tnm-status-proc TOKEN-TYPE zspi-TYP-enum. *---------------------------------------------------------------* * The next tokens are used for the EMS system * *---------------------------------------------------------------* TOKEN-CODE zTNT-tkn-sev VALUE zTNT-tnm-sev TOKEN-TYPE zspi-TYP-int. TOKEN-CODE zTNT-tkn-err-num VALUE zTNT-tnm-err-num TOKEN-TYPE zspi-TYP-int. TOKEN-CODE zTNT-tkn-file-num VALUE zTNT-tnm-file-num TOKEN-TYPE zspi-TYP-int.
Telnet Subsystem DDL TOKEN-MAP zTNT-map-opens-telnet VALUE zTNT-tnm-opens-telnet DEF zTNT-ddl-opens-telnet. VERSION "C00" FOR zbkup-cpu THROUGH zprocname. END.
Index A ABORT command 6-5 Action events 7-2 ADD command 6-9 ALTER command 6-15 Applications naming rules and guidelines for 3-3 obtaining event messages 7-1 using letter Z 3-3 B BLOCK 6-32 Buffer declarations TELNET 5-14 Buffer size recommended for commands 4-1 recommended for responses 4-2 Building the command buffer 4-1 C Command buffer, building 4-1 Command numbers 3-3 Command-number token 5-3 Commands 6-1 ABORT 6-5 ADD 6-9 ALTER 6-15 building the buffer for 4-1 by object type 2-5, 6-2 compared to SCF co
Index multiple, in single request message 4-1 nonsensitive 6-3 notation used to describe 6-3 numbers 3-3 order of tokens in 6-4 programmatic 2-4 recommended buffer size for 4-1 RESETSTATS 6-44 SCF verses programmatic 2-5 sensitive 6-3 START 6-51 STATISTICS 6-55 STATUS 6-62 STOP 6-67 symbolic names 6-2 table of 2-4 TRACE 6-71 Commands and responses 6-1 Common definitions 5-1 Common syntax elements 3-3 Components of a command 3-8 Components of a response 3-8 Components of an event message 3-8 Constructs invo
Index Data lists 3-8 representation in responses 6-4 Decoding the response buffer 4-2 Definition files 3-1 Definitions common 5-1 data communications standard 5-9 EMS standard 5-8 files 3-1 fixed structures 5-1 header tokens 5-1 simple tokens 5-1 SPI standard 5-1 TELNET subsystem 5-14 token types 5-1 token values 5-1 value names 5-1 DELETE command 6-20 Discontinuing a command 4-1 E Elements of SPI messages 3-1 EMS interface 1-5, 2-2 EMS procedures 3-1 EMS standard definitions 5-8 header tokens 5-8 simple t
Index general description of 2-6 notation 7-2 obtaining 7-1 order of tokens 7-2 reported to EMS 7-2 standard header in text version 7-2 subjects 3-6 TELNET subsystem 7-1 TELNET subsystem ID 7-1 text version 7-2 Event numbers 3-6 Event-management programming 7-2 Event-number token 5-9 Events 2-6 action 7-2 critical 7-1 management of 7-1 noncritical 7-1 Examples of filters 7-20 Extensible structured tokens 3-7 using SSNULL to initialize 4-1 F Field types 3-8 Fields initializing 4-1 null values of 4-1 types o
Index G GETVERSION command 6-24 GUARDIAN data lists 3-8 error lists 3-8 GUARDIAN 90 file-system procedures 2-6 H Header tokens 5-1 I INFO command 6-28 Initializing structured tokens 4-1 Interactive interface 1-4 L LISTOBJECTS command 6-35 LISTOPENS command 6-39 M Management programming 2-1 MLAM relationship to TELNET subsystem 1-3 MLMUX relationship to TELNET subsystem 1-3 Monitoring statistics 6-55 Multiple objects in commands 3-5 Multiple tokens, constructs involving 3-8 N Names of objects, See Object na
Index LISTOBJECTS 6-35 LISTOPENS 6-39 STATISTICS 6-55 STATUS 6-62 NULL object commands affecting 6-3 format of object name 3-4 getting release version 6-24 object type of 5-11 NVT 1-1 O Object names format 3-4 process 5-13 when required in a command 5-13 windows 5-12 Object types 3-4 commands listed by 6-2 hierarchy 3-4 NULL 3-4, 5-11 PROC 3-4, 5-12 process 5-12 WINDOW 3-4 window 5-12 Object-name templates 3-5 commands accepted in 3-5 Object-name token 5-12 Object-type header token 5-5 Object-type number 3
Index P Predefined value names 3-8 PRINT 6-32 PROC object object type of 5-12 Process altering 6-15 creating 1-1 current status 6-62 event messages reported 7-1 format of object name 3-4 monitoring statistics 6-55 naming conventions 3-5 object names 5-13 obtaining statistics 6-44 resetting statistical counters 6-44 tracing 6-71 Programmatic interface 1-4 Programming considerations 4-1 Programming for event management 7-2 Pseudoterminal 1-1 R Receiving the response buffer 4-2 Release version 6-24 Required m
Index receiving the buffer for 4-2 recommended buffer sizes for 4-2 that describe multiple objects 4-2 Return token 5-5 S SCF corresponding commands 2-4 SCP 2-6, 3-1 Security 4-3 Sensitive commands 6-3 ABORT 6-5 ADD 6-9 ALTER 6-15 DELETE 6-20 RESETSTATS 6-44 START 6-51 STOP 6-67 Simple tokens 3-7, 5-1 SPI messages 2-2 elements of 3-1 SPI procedures 2-6, 3-1 SPI programming considerations 4-1 SPI standard definitions 5-1 fixed structures 5-1 header tokens 5-1 simple tokens 5-1 token types 5-1 token values 5
Index Syntax elements command numbers 3-3 Syntax elements, common 3-3 T TCP/IP relationship to TELNET subsystem 1-3 TELNET data communications definitions 5-10 TELNET application layer 1-3 TELNET definitions 5-14 buffer declarations 5-14 extensible structured tokens 5-19 field types 5-15 field values 5-16 simple tokens 5-18 token types 5-15 token values 5-16 tokens in error lists 5-19 tokens in event messages 5-19 TELNET process commands affecting 6-2 creation of 1-1 TELNET protocol description 1-1 TELNET
Index relationship with other subsystems 1-3 responses issued by 6-1 SPI definitions 5-1 SPI programming considerations 4-1 subsystem number 5-3 system configuration 1-1 TELNET subsystem ID in event messages 7-1 TLAM relationship to TELNET subsystem 1-3 TNT subsystem subsystem ID 5-18 Token codes 3-6, 3-7 Token maps 3-7 Token numbers 3-6 Token types 3-6, 3-7, 5-1 Token values 3-6, 5-1 Tokens 3-1, 3-6 constructs involving multiple tokens 3-8 definition of 3-1 duplicate occurrences of in commands 4-1 duplica
Index Types objects 3-4 of fields 3-8 of tokens 3-7 V Value names 5-1 predefined 3-8 VIEWPOINT 1-4, 2-6 W Wild-card characters 3-5 asterisk 3-5 question mark 3-5 WINDOW BLOCK 6-32 CONVERSATIONAL 6-32 PRINT 6-32 WINDOW object object type of 5-12 Windows aborting 6-5 adding 1-1, 6-9 altering 6-15 commands affecting 6-3 current status 6-62 definition of 1-1 deleting 6-20 format of object names 3-5 monitoring statistics 6-55 naming conventions 3-5 object names 5-12 obtaining statistics 6-44 providing a class o
Index Z Z, using in applications 3-3 ZCOM-CMDABORT 6-5 ADD 6-9 GETVERSION 6-24 RESETSTATS 6-44 START 6-51 ZCOM-DDLREQID 5-11 TRACE-MODIF 5-11, 6-72 ZCOM-MAPREQID 5-10 TRACE-MODIF 5-11 ZCOM-OBJNULL 5-11 PROC 5-12 WINDOW 5-12 ZCOM-TKNCAUSE-SUMSTATE-CHG 5-12 OBJNAME 5-12 OBJSTATE 5-13 OBJTYPE 5-13 OLD-OBJSTATE 5-13 SUBJ-PROC 5-13 SUBJ-WINDOW 5-13 TRACE-OPT 5-14 ZCOM-VALBUFLEN 5-14 MAXBUFLEN 5-14 SUMSTATE-STARTED 5-14 SUMSTATE-STOPPED 5-14 ZEMS-TKNCONSOLE-PRINT 5-8 CPU 5-8 CRTPID 5-8 EMPHASIS 5-8, 7-1 EVENTNUM
Index SUBJECT-MARK 5-9, 7-2 SYSTEM 5-9 USERID 5-9 ZSERVICETYPE 6-32 BLOCK 6-32 CONVERSATIONAL 6-32 PRINT 6-32 ZSPI-ERROK 4-3 ZSPI-SSNZTNT 5-2 ZSPI-TKNALLOW-TYPE 4-2, 5-3 COMMAND 5-3 COMMENT 5-3 CONTEXT 5-3 DATALIST 5-4, 6-4 ENDLIST 5-4, 6-4 ERRLIST 5-4, 6-4 HDRTYPE 5-5 MAX-FIELD-VERSION 5-5 MAXRESP 4-2, 5-5 OBJECT-TYPE 5-5 RETCODE 5-5 SERVER-BANNER 5-6 SERVER-VERSION 5-6 SSID 5-6 USEDLEN 5-7 ZSPI-VALCMDHDR 5-7 EVTHDR 5-7 TANDEM 5-7 ZTNT subsystem ID 5-18 ZTNT-DDLADD-WIN 6-9 ALTER-PROC 6-15 ALTER-WIN 6-15 I
Index STATS-TELNET 6-45, 6-56 STATS-WIN 6-45, 6-56 STATUS-WIN 6-63 ZTNT-ERRATTR-OUT-OF-RANGE A-2 NO-STOP-OBJ-ACTV A-3 ZTNT-EVTINTL 7-18 NO-MEM 7-4 SUMSTATE-CHG 7-15 TELNET-AWAITIO-ERR 7-12 TELNET-READ-ERR 7-9 TELNET-WRITE-ERR 7-6 ZTNT-MAPADD-WIN 6-10 ALTER-PROC 6-16 ALTER-WIN 6-16 INFO-PROC 6-31 INFO-WIN 6-31 OPENS-TELNET 6-41 STATS-TELNET 6-47, 6-58 STATS-WIN 6-48, 6-59 STATUS-WIN 6-64 ZTNT-TKNERR-NUM 7-7, 7-10, 7-13 FILE-NUM 7-7, 7-10 SEV 7-1 SIZE 7-5 STATUS-PROC 5-18, 6-64 TERM 7-7, 7-10, 7-13 ZTNT-TYPC
Index MAX-TRACE 5-17 MAX-WIN-TRACE 5-17 MIN-CAUSE 5-17 MIN-SEV 5-17 MIN-TRACE 5-17 MIN-WIN-TRACE 5-17 SEV-FATAL 5-17 SEV-INFO 5-17 SEV-WARN 5-17 SSID description 5-18 structure definition 5-6 TRACE-ALLOC 5-18, 6-73 TRACE-CONN 5-18, 6-73 TRACE-CREATE 5-18, 6-73 TRACE-NEW-PROC 5-18, 6-73 TRACE-OPEN 5-18, 6-73 VERSION 5-18 WIN-TRACE-SETMODE 5-18, 6-73 WIN-TRACE-TELNET-OPT 5-18, 6-73 53474 Tandem Computers Incorporated Index–15
