SPI Programming Manual (G06.24+, H06.03+, J06.03+)

SPI Programming Manual—427506-006
2-1
2 SPI Concepts and Protocol
This section defines the basic concepts on which the Subsystem Programmatic
Interface (SPI) is based:
SPI Message Protocol
Communication between a management application and a subsystem follows the
standard HP requester-server model, with the management application in the role of
requester and the subsystem manager process in the role of server. The requester is
an application program that can run as a stand-alone process or a process pair. The
subsystem manager process is the server process that accepts SPI requests and
prepares SPI responses.
This subsection overviews the protocol followed by SPI requesters and servers when
exchanging messages. Details are presented in the remainder of this manual.
Requester Initializes a Buffer
The requester calls the SPI procedure SSINIT to initialize a message buffer in which it
composes a command message. The message contains the subsystem ID (SSID) of
the target subsystem and is at least as large as the buffer size recommended by the
subsystem. (Both the SSID and a recommended buffer size are provided by the
subsystem as part of its SPI data definitions.)
Requester Composes a Command Message
The requester uses the SSPUT procedure to add tokens and values to the message.
Before adding an extensible structured token to the message, the requester calls the
SSNULL procedure to initialize the structure, then places values in the fields of the
structure, and finally adds the structured token to the message using SSPUT.
Topic Page
SPI Message Protocol
2-1
Tokens 2-3
Data Definitions 2-10
SPI Message Buffer 2-13
Lists 2-19
Commands 2-27
Responses 2-28
Subsystem IDs (SSIDs) 2-44
Errors and Warnings 2-47