TMF Management Programming Manual (H06.05+)

SPI Programming Considerations for TMF
HP NonStop TMF Management Programming Manual—540140-002
3-4
Object Names
All commands and responses contain an object-type token in the header. For TMF,
object types are identified in programs by symbolic names of the form ZTMF-OBJ-
name, where name identifies the object type. For example, the MEDIA object type is
represented by the name ZTMF-OBJ-MEDIA. The object-type header token, ZSPI-
TKN-OBJECT-TYPE, always has one of these values.
Object Names
Many TMF commands and responses contain object-name tokens that, when
combined with object-type information, designate which objects are to be or were
affected by the command.
In the management programming interface to TMF, the form of an object name
depends on the object type. The “Object Types and Object Names” subsection of
Section 4, Common Definitions,” describes the name formats for objects of each type.
Object-name templates (wildcards) within TMF are implemented as predefined value
names (for example, ZTMF-VAL-WILDAUDITTRAILID, which specifies all audit trails
on a system). Valid object-name templates contain only the asterisk (*) wild-card
character; the question mark character (?) is not allowed. The object-name templates
are used to represent all instances of the object type. The tokens and fields that allow
object-name templates are indicated in Section 5, “Commands and Responses.”
Event Numbers
All event messages contain a header token identifying the event by number. This
event number, in combination with the subsystem ID header token, uniquely identifies
the kind of event being reported. Event numbers for event messages defined by TMF
are identified by symbolic names of the form ZTMF-EVT-name, where name gives a
brief description of the event being reported.
In these event messages, the event-number header token (ZEMS-TKN-
EVENTNUMBER) can assume any one of the set of event numbers for TMF, which are
listed at the beginning of Section 6, “Event Messages.” The TMF event messages are
described in Section 6, “Event Messages.”
Other Tokens
Commands, responses, and event messages for TMF, like those for other subsystems,
also include other tokens providing further information.
Data Lists and Error Lists
Responses from TMF can contain data lists and error lists as described in the SPI
Programming Manual.