Distributed Systems Network Management (DSNM) Subsystem Interface Development Guide

The STATUS Command
4-18
109759—Distributed Systems Network Management (DSNM) Subsystem Interface
Development Guide
DSNM Command Requirements
The STATUS Command
STATUS issues the subsystem command(s) that return the current operational status of
objects. One output object should be returned for each subsystem object obtained by
applying the hierarchy (HMOD) and state (SMOD) modifiers to each input list object.
Valid Modifiers
HMOD, EMOD, SMOD, RMOD.
Output Object Requirements
Return one output object for each hierarchically derived input list object (unless
Z^EMOD = ZDSN^EMOD^SUPPRESS, which suppresses the reporting of objects that
cause subsystem errors).
The command thread must determine the subsystem state of each object and translate it
into a DSNM state. An object may have more than one subsystem state attribute, which
is relevant to the operational state of the object, and which is a factor in determining the
DSNM state. The command thread must translate subsystem-derived information into a
DSNM state.
Return the DSNM state of the object in the Z^RESULT field.
If the subsystem state(s) used to determine the DSNM state add relevant operational
information to the Z^RESULT code, report it by appending one line of
ZDSN^VTY^RESULTTEXT. (Result text should not repeat the DSNM state itself; it
should provide additional information). PENDING states most often require additional
interpretation.
If ZDSN^RMOD^DETAIL is in effect, append additional ZDSN^VTY^TEXT entries,
providing all operational information available from the subsystem. These additional
text lines should augment, not replace, the ZDSN^VTY^RESULTTEXT information
(see example below).
Example
The following command requests brief status information (the default) for a SNAX line
and its subordinate PUs and LUs:
STATUS SNAX LINE \WYJ.$STLR
.
.
SNAX LU \WYJ.$STLR.#TLR1 Pending, Stopping
.
.
In the resulting display, Stopping is the appended ZDSN^VTY^RESULTTEXT,
clarifying the PENDING state returned in Z^RESULT.
The following command line requests detailed status information:
STATUS SNAX LINE \WYJ.$STLR, DETAIL