OSI/MHS Management Programming Manual

Commands and Responses
OSI/MHS Management Programming Manual—424824-001
5-6
Command Descriptions
Nonsensitive commands do not affect the operation or status of an object; therefore
these commands can be issued by any user. The nonsensitive OSI/MHS commands and
their functions are as follows:
Command Descriptions
Each OSI/MHS 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/MHS commands support every extended SPI (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/MHS error lists, see Appendix A, Errors and Error Lists
. For
descriptions of extended SPI error lists, see the SPI Common Extensions Manual.
SUSPEND Places an object in the SUSPENDED state (ZCOM-VAL-
SUMSTATE-SUSP).
SWITCH Switches the primary and backup CPUs of a process.
TRACE Starts or stops generating trace records for an object.
GETVERSION Returns an object’s software-release version information.
INFO Returns an object’s current attribute values.
LISTOBJECTS Returns the names and types of MHS objects.
LISTOPENS Returns the names of processes that have opened the specified
object.
STATISTICS Returns the contents of an object’s statistics counters.
STATUS Returns current operational status information about an object.