Coding the administrative data utility

For examples of how to set up your JCL and code the control statements for administrative policy data, see the following figures:

For automatic restart management, see Administrative data utility for automatic restart manager Policy Data.
For CFRM, see Administrative data utility for CFRM policy data.
For LOGR, see Administrative data utility for the LOGR policy.
For SFM, see Administrative data utility for SFM policy data.

The utility control statements are described below:

PGM=IXCMIAPU

The administrative data utility program that is shipped with SP 5.1. (Program IXCM2APU also exists as an alias for IXCMIAPU.)

SYSPRINT

Describes where the output messages from the administrative data utility are to be printed. The SYSPRINT DD statement is required.

SYSABEND

Describes where SYSABEND data from the administrative data utility is to be printed. The SYSABEND DD statement is required.

SYSIN

Describes the utility control statements that are input to the utility.

DATA

Indicates that a couple data set is to be updated. The couple data set is identified with the following parameters of DATA.

TYPE(ARM)

TYPE(CFRM)

TYPE(LOGR)

TYPE(SFM)

Specifies the type of administrative data that the data set is to contain. TYPE is a required parameter.

LOGR Policy-Specific Information:The information for the LOGR type of policy being updated is identified with specific parameters of the DATA statement.

See LOGR keywords and parameters for the administrative data utility for a description of the keywords to identify log streams and structures in a LOGR policy.

DSN(data-set-name)

Specifies the 1 - 44 character length name of the couple data set that was formatted with the IXCL1DSU format utility to contain the specified type of administrative data. The valid characters are alphanumeric characters (A-Z and 0-9), national characters ($,@,#), a period (.), and a hyphen (-). The first character must be either an alphabetic or a national character. DSN is an optional parameter when you are updating administrative data. When you do not specify DSN when updating administrative data, the utility applies the changes to the data set (or data sets, if both primary and alternate exist) that contains the active policy — CFRM, SFM, or ARM, and any administrative policies. The DSN parameter is not supported for TYPE(LOGR), since you can only update the active LOGR administrative policy. If you specify DSN for TYPE(LOGR), the IXCMIAPU utility ends with a non-zero return code and error message IXG432E.

Note that the changes are applied to the administrative policy. If the changes are to an administrative policy that is also the current active policy, the changes are applied to the administrative copy of the active policy and not directly to the active policy itself. To activate the changes in the active policy in the sysplex, issue a SETXCF command to make the updated administrative policy the active policy.

If you want to obtain a report of the policy information contained in the active couple data set, ensure that you omit the DSN keyword. Otherwise, the system issues allocation error messages.

When to Specify DSN: (An active couple data contains the current active policy.)

DO specify DSN if you are creating your administrative policies initially or want to have a secondary set of policies in a couple data set that is not active in your sysplex.
DO NOT specify DSN if you want to add a new policy or update an existing policy in the couple data set that is active in your sysplex.

See Updating a CFRM policy for an example of how to update a policy.

VOLSER(serial number)

Specifies the 1 - 6 character length name of the volume on which the couple data set resides if the data set is not cataloged. The valid characters are alphanumeric characters (A-Z and 0-9) and national characters ($,@,#). VOLSER is an optional parameter and can be specified only if DSN parameter also is specified.

The VOLSER parameter is not supported for TYPE(LOGR), since you can only update the active LOGR administrative policy. If you specify VOLSER for TYPE(LOGR), the IXCMIAPU utility ends with a non-zero return code and error message IXG432E.

REPORT(YES)

REPORT(NO)

Specifies whether a report of the contents of the policy data for all administrative policies defined in the data set is to be output to the SYSPRINT file. The default is YES, to output a report.

Note: If you specify REPORT(YES) (or accept the default for the report keyword) with a DATA TYPE of LOGR, the requestor must have SAF read access to the MVSADMIN.LOGR resource to successfully obtain a report.

DEFINE POLICY NAME(polname)

Specifies the beginning of the definition of a new administrative policy. The limit for the number of policies that can be defined in a couple data set is established when the couple data set is formatted.

polname specifies the name of the policy. The name can be from 1 - 8 characters in length. Valid characters are A-Z and 0-9. The policy name must start with an alphabetic character.

A policy name can be defined only once in a single run of the administrative data utility.ARM, CFRM, and SFM Policy-Specific Information:The information for the ARM, CFRM, and SFM type of policy being updated is identified with specific parameters of the DEFINE POLICY statement.

See Automatic restart management parameters for administrative data utility for a description of the keywords to define elements and restart groups in an automatic restart management policy.
See CFRM parameters for administrative data utility for a description of the keywords to identify coupling facilities and structures in a CFRM policy.
See SFM parameters for the administrative data utility for a description of the keywords to identify systems in the sysplex and PR/SM™ reconfiguration scenarios in an SFM policy.

The LOGR policy does not use the DEFINE POLICY statement. See LOGR keywords and parameters for the administrative data utility for LOGR policy-specific keywords on the DATA statement.

REPLACE(NO)

REPLACE(YES)

REPLACE(timestring)

Specifies whether or not the existing policy identified by polname is to be replaced.

If the named administrative policy currently exists in the data set, REPLACE(YES) causes the policy definition to be replaced with the policy being defined. REPLACE(NO) will not allow the policy definition in the data set to be replaced.
If the named administrative policy does not currently exist in the data set, either REPLACE(YES) or REPLACE(NO) allow the policy definition to be added to the data set.
If you specify REPLACE(timestring), the system will only replace policy polname if the policy is already defined in the CFRM couple data set with a matching time string, which is the local time of the policy definition. timestring can be up to 26 characters long (not including the quotation marks) in the format 'mm/dd/yyyy hh:mm:ss.ssssss'.
You can obtain the the policy definition time by running the administrative policy utility with REPORT(YES) specified.

You can only specify REPLACE(timestring) for the CFRM policy.

DELETE POLICY NAME(polname)

Specifies that the named administrative policy is to be deleted from the set of policies previously defined by the administrative data utility on the couple data set.