RETCODE2 is an optional parameter on the OSREQ API. It can be
used to determine if OAM scheduled additional processing for this
OSREQ request. The information returned in RETCODE2 depends on the
OSREQ function (RETRIEVE or STORE) requested. Refer to z/OS DFSMS OAM Application Programmer's Reference for
more information on the OSREQ API and its keywords.
For an OSREQ RETRIEVE request, RETCODE2 specifies whether this
RETRIEVE request resulted in scheduling a RECALL of the object to DB2® DASD. The value returned in
this keyword is valid only when the RETRIEVE is successful, in which
case it provides the following information:
Table 1. RETCODE2 values for OSREQ
RETRIEVE| RETCODE2 |
Description |
|---|
| 0 (X'00') |
Either RECALL not specified on OSREQ RETRIEVE
request so no attempt was made to schedule recall, or RECALL specified
on OSREQ RETRIEVE request and recall successfully scheduled |
|---|
| 4 (X'04') |
RECALL not specified on OSREQ RETRIEVE request,
however, recall successfully scheduled due to CBROAMxx PARMLIB member
specifications. |
|---|
| 8 (X'08') |
An attempt to schedule a recall for this object
was not successful because OSMC=No specified on OAM started procedure. |
|---|
| 10(X'0A') |
An attempt to schedule a recall for this object
was not successful because MAXRECALLTASKS(0) specified in CBROAMxx
member of PARMLIB |
|---|
| 12 (X'0C') |
An attempt to schedule a recall for this object
was not successful because RECALLOFF(ON) specified in CBROAMxx member
of PARMLIB |
|---|
| 14 (X'0D') |
An attempt to schedule a recall for this object
was not successful due to unexpected scheduling error. |
|---|
| 16 (X'10') |
An attempt to schedule a recall for this object
was not successful because the retrieve was performed on a down-level
OAMplex member that does not support recall processing. |
|---|
For an OSREQ STORE request, RETCODE2 specifies whether this STORE
request resulted in scheduling an Immediate Backup copy be written
for this object. The value returned is only valid when the STORE is
successful, in which case it provides the following information:
Table 2. RETCODE2
values for OSREQ STORE| RETCODE2 |
Description |
|---|
| 0 (X'00') |
Immediate backup copy request successfully scheduled. |
| 4 (X'04') |
Immediate backup copy request not required. |
| 8 (X'08') |
An attempt to schedule an immediate backup for
this object was not successful because OSMC is not up and running. |
| 14 (X'0D') |
An attempt to schedule an immediate backup for
this object was not successful due to unexpected scheduling error. |
| 16 (X'0F') |
Immediate backup to optical not supported for
STOREEND. |