SETROPTS reporting functions
This pair of function codes allows you to retrieve RACF® SETROPTS settings in either of two formats:
- In unload format, you get the data in the same format in which it is reported by the SMF Unload Utility (IRRADU00).
- In SETROPTS extract format, the output is formatted in
the same manner as the input to the SETROPTS alter function. Note:
- Although conceptually similar, this is a different format from the output produced by the profile extract functions.
- The IRRXUTIL program provides a REXX interface to the SETROPTS extract format. The IRRXUTIL program is designed to be invoked by REXX in problem state, and converts the output of an R_admin extract request to a set of REXX stem variables. For more information, refer to z/OS Security Server RACF Macros and Interfaces.
The unload format is available only to supervisor state callers. The extract format is available to both supervisor and problem state callers.
No input parameter list is required for these functions. However,
additional options may be specified by providing a parameter list.
| Offset | Length | Description |
|---|---|---|
| 0 | 4 | Request flags |
| x'80000000' | Apply FACILITY class check to caller. Caller will require READ access to IRR.RADMIN.SETROPTS.LIST | |
| x'40000000' | Apply SETROPTS LIST command authority checks to caller. | |
| 4 | 10 | Reserved |
The mapping of the output message block returned by R_admin for
the ADMN_XTR_SETR and ADMN_UNL_SETR function codes is as follows.
The output storage is obtained in the subpool specified by the caller
in the Out_message_subpool parameter of IRRSEQ00, and is returned
in the Out_message_strings parameter. It is the responsibility of
the caller to free this storage:
| Offset | Length | Description |
|---|---|---|
| 0 | 4 | Eye catcher to aid in virtual storage dumps: 'RXTR' or 'RUNL' |
| 4 | 4 | Total length of the output buffer |
| 8 | 4 | Reserved |
| 12 | 2 | Number of segment entries for ADMN_XTR_SETR (always 1 for the BASE segment), or number of record types returned for ADMN_UNL_SETR |
| 14 | 0 | Start of the BASE segment entry (for extract) or the first record entry (for unload) |
For ADMN_XTR_SETR, the output consists of a single segment entry
for the base segment, followed by field entries for each of the supported
input fields documented in SETROPTS administration.
Note: Not all of the fields are returned, and fields that are not
returned are noted in the field table.
There is no defined order in which fields are returned. The segment and field entry for ADMN_XTR_SETR uses the standard ADMN_USRADM_SEGENTRY and ADMN_USRADM_FLDENTRY mappings used by other R_admin functions. See Segment and field entry mappings for details.
For ADMN_UNL_SETR, the output data is mapped using the following
mapping for each unloaded record type, the number of which is contained
in ADMN_EXTRACT_NUM. There is a single record type of "RACFINIT" to
describe the basic RACF options.
Following this record is a series of records of type "CLASNAME". There
are as many "CLASNAME" records as there are classes defined in the
class descriptor table (CDT). These include classes supplied by IBM® (ICHRRCDX), installation-defined
classes defined in ICHRRCDE, and classes in the dynamic class descriptor
table. Columns 44 through 51 of each record identify the name of the
class that the record describes. See z/OS Security Server RACF Macros and Interfaces for
detailed mappings of these record types.
Note: For ADMN_UNL_SETR,
R_admin does not fill in the time-written, date-written, and SMF system
ID fields.
| Offset | Length | Description |
|---|---|---|
| 0 | 8 | The SMF data unload record type (see z/OS Security Server RACF Macros and Interfaces) |
| 8 | 4 | The length of an individual record of this type |
| 12 | 4 | The number of records of this type |
| 16 | 8 | Reserved |
| 24 | * | The start of the first record of this type |