Get System Service Tools Data (QSMGSSTD) API
Required Parameter Group:
| 1 | Request information | Input | Char(*) |
| 2 | Length of request information | Input | Binary(4) |
| 3 | Format of request information | Input | Char(8) |
| 4 | Error Code | I/O | Char(*) |
Default Public Authority: *EXCLUDE
Threadsafe: No
The Get System Service Tools (SST) Data (QSMGSSTD) API allows calling a subset of the SST commands and writes the information to a spooled file. Only one instance of this program can be active within a process.
Authorities and Locks
- Authority to use the API
- To use this API, you must have service (*SERVICE) special authority.
- Authority to call the SST commands
- To call SST commands, the current user profile calling the SST command must be linked
to a Service Tools User ID with the proper privileges to
run the SST command.
- Unless otherwise stated the SST command requires the Service Tool Server privilege DisplayAlterDump.
- Disabled Service tool profiles are allowed to perform Display/Alter/Dump functions.
Required Parameter Group
- Request information
- INPUT; CHAR(*)
Information concerning the SST command to call. The format of this information depends on the specified format of request information.
- Length of request information
- INPUT; BINARY(4)
The total length in bytes of the request information input variable.
Format of request information - INPUT; CHAR(8)
The content and format for the request information. The possible format names are:
SSTD0100 This format specifies the SST command to run. See SSTD0100 Format for details.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
SSTD0100 Format
This format specifies the SST command name to run. For detailed descriptions of each field, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Char(30) | SST command name |
Field Descriptions
SST command name. The name of the SST command to be called. To find the supported SST commands, see Supported SST commands.
Usage Notes
- The SST command name must be in EBCDIC (CCSID 037).
- The following example shows how to call QSMGSSTD to run the SSDGAUGE SST command
from a CL program:
CALL PGM(QSMGSSTD) PARM('SSDGAUGE' X'00000008' 'SSTD0100' X'00000000')
- If a job has swapped to a different user profile than the initial user when API QSMGSSTD is called, the spooled file output will be found in a QPRTJOB for the current user.
Supported SST commands
The following values are the supported SST commands:
| SSDGAUGE | Provides life expectancy gauge for the SSD devices. |
Error Messages
The following messages may be sent from this function:
| Message ID | Error Message Text |
|---|---|
| CPF24B4 | Severe error while addressing the parameter list. |
| CPF3CF1 | Error code parameter not valid. |
| CPF3CF2 | Error(s) occurred during running of &1 API. |
| CPF3C21 | Format name &1 is not valid. |
| CPF7215 | System Service Tools already active in this process. |
| CPF7216 | Requested SST command &1 is not supported. |
| CPF7217 | Not authorized to run SST command &2. |
API introduced: IBM® i 7.2 by PTF