INGCLEAN

Purpose

The INGCLEAN command can be used to clean up the in-storage data model of the local system. The data model is compared to the currently loaded configuration files. Entries within the data model that have no corresponding entries in the configuration files are deleted. For entries that have a hard-coded default provided by System Automation, this default value is restored.

Syntax

Read syntax diagramSkip visual syntax diagramINGCLEAN

Parameters

There are no parameters. Any specified parameters will be ignored without notification.

Return Codes

0
Cleanup was successful.
4
Parameter Error.
6
Environment check failed.
8
An error occurred.

Restrictions and Limitations

In order to run INGCLEAN the configuration must be loaded and the configuration files must be accessible from disk.

INGCLEAN does not affect data for subsystems, subsystem defaults, application groups and monitor resources because they are cleaned up by the main configuration loader process.

INGCLEAN does not affect data for automation operators because work could be scheduled there and a cleanup would cause an immediate log off from the corresponding task.

For all other elements, INGCLEAN will remove all data if the element is not present in the currently loaded configuration files. This means especially that all data that has been added via ACF REQ=REPL is deleted. Note that INGCLEAN does not restore the values from the configuration files for data that has been modified via ACF REQ=REPL.

INGCLEAN always runs on the local system where it is invoked.

Security Considerations

The INGCLEAN command supports resource level security. If turned on, the following profiles in class SYSAUTO are checked:
Profile Authority Condition
AGT.sysplex.xcfgrp.RES._CONFIG UPDATE Always

For further details, refer to IBM Z® System Automation Planning and Installation.

Usage

You can run INGCLEAN from the policy, the automation table, an automation script or directly from the command line. It is recommended to run INGCLEAN as an environment setup exit if you want it to run everytime you load or refresh your configuration from the command line for an instantaneous regular cleanup timer.

Examples

If you want to run INGCLEAN on every configuration refresh, specify it as the first environment setup exit.

 COMMANDS  HELP                                                               
 ------------------------------------------------------------------------------ 
                                System Information                   
 Command ===>                                                                   
                                                                                
 Entry Type : System                PolicyDB Name   : USER_PBD                  
 Entry Name : SYS3                  Enterprise Name : USER_ENTERPRISE           
                                                                   
 Operating system . . . : MVS                                                   
 Image/System name. . . . SYS3                                                  
                                                                                
 The following specifications are for MVS systems only:                         
 Primary JES. . . . . . . JES2      Primary JES2/JES3 subsystem name            
 System Monitor Time. . . 00:59     Time between monitor cycles (hh:mm or NONE) 
 Gateway Monitor Time . . 00:15     Time between monitor cycles (hh:mm or NONE) 
 Automation Table(s). . . INGMSG01                                              
                                                                                
                                    NetView automation table members            
 SDF Root Name. . . . . .           Root of system's SDF tree                   
 Exit name(s) . . . . . . INGCLEAN MYEXIT                                       
                                    Environment setup user exit names           
 USS automation path. . . 
 /usr/lpp/ing/ussauto/lib                                                         
                                                                                                    
                                    System Automation UNIX installation path   
      
 SA NetView Domain. . . .           NetView domain ID of SA z/OS                
 Network NetView Domain .           NetView domain ID of network automation     
                                                                                                   
  F1=HELP      F2=SPLIT     F3=END       F4=RETURN    F5=RFIND     F6=RCHANGE   
  F7=UP        F8=DOWN      F9=SWAP     F10=LEFT     F11=RIGHT    F12=RETRIEVE