OSI/TS Management Programming Manual

Command Descriptions
Commands and Responses
5–4 056786 Tandem Computers Incorporated
SWITCH Starts the takeover of the backup process.
TRACE Generates trace records for an object.
Nonsensitive commands do not affect the operation or status of an object; therefore
these commands can be issued by any user. The nonsensitive OSI/TS commands and
their functions are as follows:
AGGREGATE Returns the count of the objects in a given state.
GETVERSION Returns an object’s software-release version information.
INFO Returns an object’s current attribute values.
LISTOBJECTS Returns the names and types of various objects.
LISTOPENS Returns the process IDs of an object’s openers.
STATISTICS Returns the contents of an object’s statistics counters.
STATUS Returns an object’s summary-state and last-error information.
Command
Descriptions
Each OSI/TS programmatic command and its response is described in detail on the
following pages. The command descriptions are presented in alphabetical order; for
commands that can be applied to more than one object type, a separate description is
given for each command object-type pair. Each command description includes a
syntax box that names (in DDL form) the command, the object type, the tokens in the
command buffer, and the tokens in the response buffer. Following the syntax box are
descriptions of the tokens in the command and the response, in the same order in
which the tokens are listed in the box. Finally, any special considerations (operational
notes) for this command are given.
Not all OSI/TS commands support every common data communications (ZCOM)
token that could apply to that command. If a token other than a header token does not
appear in the box for a command, that token cannot be used in that command.
The syntax notation used for simple tokens is a shorthand version of the essential
information given in the DDL TOKEN-CODE statement. The notation used for
extensible structured tokens gives the token map name first, followed by the DDL DEF
statement declaring the corresponding structure, showing all the fields and their types.
In the syntax box, the contents of error lists are indicated by ellipses; error-list contents
depend on which error occurred (indicated by the value of ZSPI-TKN-RETCODE). For
descriptions of OSI/TS error lists, see Appendix A. For descriptions of common data
communications error lists, refer to the Communications Management Programming
Manual.
The token descriptions that follow the syntax box state whether each token (or field of
an extensible structured token) is required or optional, what its ranges or possible
values are, and what its defaults are, if applicable. Each required field of an extensible
structured token must be assigned a value other than its null value. Optional fields
can also be assigned a value other than the field’s null value, but this is not required.