DEPLOY action output

The DEPLOY action produces job output that provides information about the deployment of the data sets as a result of the job.

When running in default mode, the DEPLOY action writes summarized output and the job return code to the KCIPRINT SYSOUT data set and produces a more detailed report in the $REPORT DD. The following sections provide information about these output data sets and their contents, which includes data set deployment states and DEPLOY action return codes.

KCIPRINT

KCIPRINT contains a count of the data sets that the DEPLOY action processes, summarized by deployment state (deployed, skipped, failed), for each package data set. Looking at KCIPRINT, you can see if any data sets failed, but you will not see the exact data set names. This content is a condensed preview of what is included in the $REPORT output. KCIPRINT also contains the return code for the job.

The following figures show example KCIPRINT output for the DEPLOY action.

The example in Figure 1 shows sample summary counts of the data sets processed by the DEPLOY action for each package (dump) data set; the actual number of data sets reported will be unique to the job:
Figure 1. DEPLOY action output in KCIPRINT — data set deployment summary
IMB Z Monitoring Configuration manager is about to perform DEPLOY action

Processing: PACKMN
- Deployed: .. 30
- Skipped: ... 21
- Failed: .... 0

Processing: PACKHN
- Deployed: .. 0
- Skipped: ... 23
- Failed: .... 0

Processing: PACKMV
- Deployed: .. 38
- Skipped: ... 41
- Failed: .... 0

Processing: PACKHV
- Deployed: .. 0
- Skipped: ... 14
- Failed: .... 0

For more detailed information see $REPORT DD statement
For more information about the deployment states, see Data set deployment states.
The example in Figure 2 shows a possible return code for the DEPLOY action; the actual return code will be unique to the job:
Figure 2. DEPLOY action output in KCIPRINT — return code
KFU00004I KCIALPHA is ending; RC=4 SYSPLEX=sysplex LPAR=lpar DATE=… 
For more information about return codes for the DEPLOY action, see DEPLOY action return codes.

For more information about KCIPRINT, see Navigating Configuration Manager action output and Action job output.

$REPORT

$REPORT provides details about which data sets were deployed, which were intentionally skipped, and which failed. In addition, the report includes the deployment status of the z/OS UNIX System Services (z/OS UNIX) data sets as a result of the job.
Note: If you encounter issues with the DEPLOY action and the normal run does not explain what failed, use the DEPLOY action with OPTION DEBUG to print the complete output.

The following figures shows example $REPORT output.

The $REPORT content lists the individual data sets that were skipped, deployed, and failed (if any) for each package (dump) data set. The report sample in Figure 3 shows a portion of the report for the PACKMN package data set only; the actual number of data sets reported will be unique to the job:
Figure 3. DEPLOY action output in $REPORT — data set deployment state
Processing data set: PACKMN             
Will NOT REPLACE existing data sets            
----------------------------------------       
Total deployed data sets: .......... 0         
Total skipped data sets: ........... 21        
Total failed to deploy data sets: .. 0         
                                               
Details:                                       
|- Skipped data sets:                          
||- rte_plib_hilev.rte_name.ims_id.RKOIPCSV              
||- rte_plib_hilev.rte_name.ims_id.RKOIPFSV              
||- rte_plib_hilev.rte_name.ims_id.RKOIPCSV              
...
****************************************       

Processing data set: PACKMN                    
Will REPLACE existing data sets                
----------------------------------------       
Total deployed data sets: .......... 30       
Total skipped data sets: ........... 0        
Total failed to deploy data sets: .. 0            
                                                    
Details:                                                   
|- Deployed data sets:                                     
||- rte_plib_hilev.rte_name.EMBEDS                   
||- rte_plib_hilev.rte_name.PGMSCN            
||- rte_plib_hilev.rte_name.PGMSDS       
...
For more information about the deployment states, see Data set deployment states.
The report sample in Figure 4 shows a portion of the report that lists the z/OS UNIX data sets that were deployed:
Figure 4. DEPLOY action output in $REPORT — z/OS UNIX data sets
****************************************                                                   
z/OS UNIX System Services:                                                                 
                                                                                           
Extracting files to: /proj/tdci2/MS/MSDEPL/PGMS                                            
----------------------------------------                                                   
KS3                                                                                        
KS3/rdm                                                                                    
KS3/rdm/jobs                                                                               
KS3/rdm/jobs/RDMUNPX                                                                       
...

Data set deployment states

The DEPLOY action job output categorizes the processed data sets as follows:
Deployed
The DEPLOY action has successfully restored these data sets to the target system.
Skipped
The DEPLOY action skipped these data sets because they contain user data, such as configuration information and history-related files. These data sets should not be overwritten. It is normal to see numerous data sets skipped by the DEPLOY action.
Failed
The DEPLOY action did not restore these data sets to the target system. You should investigate any data sets that failed to deploy.

DEPLOY action return codes

The DEPLOY action uses the DFSMSdss ADRDSSU program to restore the data sets. It performs an unconditional restore for the main VSAM and non-VSAM packages (fully replaces the data sets) and a conditional restore for the history packages (does not replace existing data sets). Note the following behaviors:
  • If history dump data sets (**.PACKHN or **.PACKHV) are not found or failed to restore, a return code of 4 will be generated.
  • If the main dump data sets (**.PACKMN or **.PACKMV) are not found or failed to restore, a return code of 8 will be generated.
The DEPLOY action replaces all main package VSAM and non-VSAM files, but does not replace any history-related files. Therefore, it is normal for PACKHN and PACKHV deploy flows to end with RC=8. If you want to avoid this, for example if you roll out maintenance, do not transfer these packages to the target system. While normally a return code of 8 would cause Configuration Manager to stop, in this particular situation (history files), a return code of 8 is considered acceptable and will not prevent Configuration Manager from continuing to function.