| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Error code | I/O | Char(*) |
The Retrieve Security Attributes (QSYRTVSA) API retrieves information about the current and pending security attributes of the system.
None.
The receiver variable that receives the information requested. You can specify the size of the area to be smaller than the format requested as long as you specify the length parameter correctly. As a result, the API returns only the data that the area can hold.
The length of the receiver variable provided. The length of receiver variable parameter may be specified up to the size of the receiver variable specified in the user program. If the length of receiver variable parameter specified is larger than the allocated size of the receiver variable specified in the user program, the results are not predictable. The minimum length is 8 bytes.
The format of the command information to be returned.
The following format name may be used:
| RTSA0100 | Basic system security attributes. |
The structure in which to return error information. For the format of the structure, see Error code parameter.
The following table describes the information that is returned in the receiver variable for the RTSA0100 format. For detailed descriptions of the fields, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | BINARY(4) | Current security level |
| 12 | C | BINARY(4) | Pending security level |
| 16 | 10 | BINARY(4) | Current password level |
| 20 | 14 | BINARY(4) | Pending password level |
| 24 | 18 | CHAR(1) | Allow change to security related system values |
| 25 | 19 | CHAR(1) | Allow add of digital certificates |
| 26 | 1A | CHAR(1) | Allow service tools user ID password change |
Allow add of digital certificates. Specifies whether or not digital certificates can be added to a certificate store using the Add Verifier (QYDOADDV) API, and whether or not the password for a certificate store can be reset using Digital Certificate Manager (DCM).
| 0 | Digital certificates cannot be added to a certificate store using the QYDOADDV API, and certificate store passwords cannot be reset using DCM. |
| 1 | Digital certificates can be added to a certificate store using the QYDOADDV API, and certificate store passwords can be reset using DCM. |
Allow change to security related system values. Specifies whether or not the security related system values can be changed.
| 0 | The security related system values cannot be changed. |
| 1 | The security related system values can be changed. |
Allow service tools user ID password change. Specifies whether or not a service tools user ID with a default password that is expired can change its own password.
| 0 | A service tools user ID with a default password that is expired cannot change its own password. |
| 1 | A service tools user ID with a default password that is expired can change its own password. |
Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.
Bytes returned. The number of bytes of data returned.
Current security level. This is the security level that is currently being used by the system. See the QSECURITY system value for a list of the possible values.
Current password level. This is the password level that is currently being used by the system. See the QPWDLVL system value for a list of the possible values.
Pending security level. This is the security level that the system will use after the next IPL. It is the same value as displayed by the Display System Value (DSPSYSVAL) command for the QSECURITY system value. See the QSECURITY system value for a list of the possible values.
Pending password level. This is the password level that the system will use after the next IPL. It is the same value as displayed by the Display System Value (DSPSYSVAL) command for the QPWDLVL system value. See the QPWDLVL system value for a list of the possible values.
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3C19 E | Error occurred with receiver variable specified. |
| CPF3C1D E | Length specified in parameter &1 not valid. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C36 E | Number of parameters, &1, entered for this API was not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
[ Back to top | Security APIs | APIs by category ]