Distributed Systems Network Management (DSNM) Subsystem Interface Development Guide

The Input Object List
4-8
109759—Distributed Systems Network Management (DSNM) Subsystem Interface
Development Guide
DSNM Command Requirements
In addition to the previous states, an object may not be configured, or it may be
configured but its state cannot be determined (because a manager is not running or the
object is not secured correctly, for instance). For these cases, the following DSNM
states are provided:
The Input Object List
An object in a DSNM command is a subsystem object name qualified with the
subsystem name, the object type, and possibly the object’s manager. Depending on the
subsystem, a manager may be required, optional, or not allowed.
The input object list consists of input list members, each of which includes a formatted
object structure named FOBJ (defined by ZDSN^DDL^FOBJECT^DEF) that describes
one object to which the command is to be applied. The command should be applied to
objects in the order they appear on the input list.
Subsystems usually have a hierarchy of object types. A DSNM command may specify
that the command is applied to only the specified objects, to only their subordinates, or
to both.
Each input object list member contains the following FOBJ fields:
ZDSN^STATE^UNDEFINED Object is not defined in the subsystem. An error
could have been made, either in configuring the
subsystem or entering the object name.
ZDSN^STATE^UNKNOWN State of the object cannot be determined.
ZDSN^STATE^NULL Subsystem may have one or more objects that act
only to group other objects rather than being
functional entities. These objects are represented in
DSNM as having a NULL operational state. (This
type of object usually doesn’t support state-change
commands.)
Note. ZDSN^STATE^UP and ZDSN^STATE^GREEN have the same value and may be used
interchangeably. Similarly, DOWN/RED and PENDING/YELLOW are interchangeable.
Externally in DSNM responses, UP, DOWN, and PENDING are used.
Z^HMOD Is an INT field that contains a hierarchy modifier
(HMOD) applying to this object only. If present, it
overrides the hierarchy modifier (for this object only)
associated with the command as a whole.
Z^SUBSYS Is a structure (defined by ZDSN^DDL^SUBSYS^DEF)
that identifies the subsystem to which the object
belongs.
Z^OBJTYPE Is a structure (defined by
ZDSN^DDL^OBJTYPE^DEF) that specifies the
subsystem object type of the object.