AIFWGPURGE

Purges a workgroup from the current list of workgroups.

Syntax

                  REC            CA          

AIFWGPURGE(overall_status, workgroup_name, 

                 B         I32

               purgescan, user_id )

Parameters

overall_status

record by reference (required)

Returns the overall status of the call. A zero indicates a successful call. A negative value indicates an error in the overall call. A positive value indicates a warning.

Record type: status_type

workgroup_name

256-byte character array by reference (required)

Passes the name of the workgroup to be deleted. The workgroup name follows the convention for CI variables and Job Control Words(JCW's) and can be a maximum of 255 alphanumeric characters or underscores, where the first character cannot be numeric. The user-specified name (including case) is preserved, though comparisions are case insensitive. All 255 characters are significant. The workgroup_name is terminated by a NULL character (ASCII 0).

Note that the following system workgroups cannot be purged:

AS_Default, BS_Default, CS_Default, DS_Default, and ES_Default.

purgescan

Boolean by reference (optional)

Passes a boolean value denoting the deletion of the workgroup should cause a scan of all processes of the deleted workgroup in order to assign them to the new workgroups. The default does not cause any scanning of the processes.

This parameter when set to true will re-assign processes of ALL PURGE-PENDING WORKGROUPS to other workgroups.

Default: False

user_id

32-bit signed integer by value (optional)

The user ID assigned to a vendor at the time of purchase of the Architected Interface Facility: Operating System product. If it is not passed, the caller must have previously called AIFACCESSON.

Default: 0

Operation Notes

AIFWGPURGE deletes a workgroup from the current list of workgroups. A user can call AIFWGPURGE with the default "scan" option and the last call of AIFWGPURGE with purge-pending scan option. This will result in purge of all the requested workgroups and the last call to AIFWGPURGE will result in scanning of the processes of ALL the purged workgroups and their reassignment. This prevents scanning and reassignment of member processes at every workgroup purge.

When a workgroup is purged, the Workload Manager will rescan the affected member processes. The cost of such a rescan is dependent upon the number of processes, and workgroups, involved. If parameter "purgescan" is not passed the system does not complete the purge until all member processes have found a new workgroup. A workgroup in such a state is considered to have a purge pending. The scan of processes assigned to purge-pending workgroups is a subset of a system-wide scan. A system-wide scan checks all processes on the system for reassignment, while a purge-pending scan will only check processes that are assigned to purge-pending workgroups.

Logically, a workgroup in the purge-pending state no longer exists and thus can not accept new members. However, physically the workgroup remains until either its last member has died or been moved to another workgroup, or a scan is performed. When a workgroup goes into the purge-pending state, the system renames the workgroup by prepending the previous name with "~". The last character may be truncated to keep the new name to 255 characters.

AIFWGPURGE

Technical documentation

» Table of Contents

» Index

Syntax

Parameters

Operation Notes