OPTIONS entry (global zone)

The OPTIONS entry defines processing options that are to be used for an SMP/E command or set of commands. Although OPTIONS entries exist only in the global zone, they are also used to process commands for target and distribution zones. There are two ways you can specify the OPTIONS entry that should be in effect when you are processing a zone:

In the GLOBALZONE, TARGETZONE, and DLIBZONE entries. The OPTIONS entry specified here is the default OPTIONS entry for that zone.
On the SET command. The name specified on the SET command overrides the default OPTIONS name.

When SMP/E processes a command, it checks these sources to determine which OPTIONS entry should be in effect for that command. If SMP/E cannot find a reference to an OPTIONS entry, it will use defaults for some of the subentries. The following topic describes these defaults, as well as the other values you can specify for each subentry.

Subentries

These are the subentries for the OPTIONS entry as they appear in the LIST output:

name

is the name of the OPTIONS entry.

The name can contain from 1 to 8 alphanumeric characters.

AMS

is the name of the UTILITY entry that SMP/E is to use to obtain information when calling the access method services (AMS) utility.

The UCL operand is AMS(name).

The name can contain from 1 to 8 alphanumeric characters.
If no entry name is specified, SMP/E uses a default UTILITY entry. For details, see Table 1.

ASM

is the name of the UTILITY entry that SMP/E is to use to obtain information when calling the assembler utility.

The UCL operand is ASM(name).

The name can contain from 1 to 8 alphanumeric characters.
If no entry name is specified, SMP/E uses a default UTILITY entry. For details, see Table 1.

CHANGEFILE

specifies whether library change file records should be generated and written to the SMPDATA1 and SMPDATA2 data sets during APPLY and RESTORE command processing.

The UCL operand is CHANGEFILE(YES|NO), where:

YES: indicates that library change file records should be generated during APPLY or RESTORE processing.
NO: indicates that library change file records should not be generated during APPLY or RESTORE processing. This is the default for APPLY and RESTORE processing.

COMP

is the name of the UTILITY entry that SMP/E is to use to obtain information when calling the utility program to compress data sets.

The UCL operand is COMP(name).

The name can contain from 1 to 8 alphanumeric characters.
If no entry name is specified, SMP/E uses a default UTILITY entry. For details, see Table 1.

COMPACT

specifies whether inline element data within SYSMODs in the SMPPTS data set should be compacted. The element data is normally compacted during the GZONEMERGE and RECEIVE commands.

The UCL operand is COMPACT(YES|NO), where:

YES: indicates inline element data within SYSMODs in the SMPPTS should be compacted to reduce the space requirements of the SMPPTS during the GZONEMERGE and RECEIVE commands. The element data is expanded as needed during ACCEPT and APPLY command processing. YES is the default.
NO: indicates inline element data within SYSMODs in the SMPPTS should not be compacted during the GZONEMERGE and RECEIVE commands. The element data will reside in the SMPPTS data set in its original form.

COPY

is the name of the UTILITY entry that SMP/E is to use to obtain information when calling the copy utility.

The UCL operand is COPY(name).

The name can contain from 1 to 8 alphanumeric characters.
If no entry name is specified, SMP/E uses a default UTILITY entry. For details, see Table 1.

DSPREFIX

specifies the data set prefix to be used to construct the full data set name when SMPTLIB data sets are being allocated for RELFILEs. For more information about names for SMPTLIB data sets, see SMP/E for z/OS Commands.

The UCL operand is DSPREFIX(prefix).

The prefix can contain from 1 to 26 alphanumeric characters.
The prefix must follow standard naming conventions for data sets.
If a DDDEF entry is in effect for the SMPTLIB data sets, the DSPREFIX value in that DDDEF entry overrides the DSPREFIX value specified in the OPTIONS entry in effect.
If no DSPREFIX value is specified in either the OPTIONS entry or the DDDEF entry, no high-level qualifier is assigned to the SMPTLIB data sets.
If the DSPREFIX value is the same as the RFDSNPFX value for the RELFILE data sets that are being processed, the SMPTLIB data sets cannot be allocated in either of these cases:
- The RELFILE data sets are on DASD.
- The RELFILE data sets are on tape and are cataloged.

DSSPACE

specifies the primary and secondary space allocation (in tracks) and the number of directory blocks to be allocated for each SMPTLIB data set. After the data set is loaded, unused space is freed. For more information about SMPTLIB data sets, see SMP/E for z/OS Commands.

The UCL operand is DSSPACE(prime, secondary, directory).

Each value can contain from 1 to 4 numeric characters.
If a DDDEF entry is in effect for the SMPTLIB data sets, the SPACE and DIR values in that DDDEF entry override the DSSPACE values specified in the OPTIONS entry in effect.
These values should be specified in the appropriate OPTIONS or DDDEF entries before you receive a relative file. Otherwise, SMP/E cannot allocate any new SMPTLIB data sets.

EXRTYDD

specifies the list of ddnames that are not eligible for retry processing after an x37 abend. EXRTYDD is used with RETRYDDN in order to exclude a subset of libraries from retry processing.

The UCL operand is EXRTYDD(ddname…).

The ddnames can contain from 1 to 8 alphanumeric characters.
If a ddname is specified in both the EXRTYDD list and the RETRYDDN list, the ddname is excluded from retry processing.
If no ddnames are specified for RETRYDDN, no retry processing will be done for any libraries. The ddnames specified on EXRTYDD are ignored.
If ALL is specified on EXRTYDD, it is treated as just another ddname; it does not exclude all ddnames from retry processing. To exclude all libraries from retry processing, do one of the following instead:
- Specify RETRY(NO) on the SMP/E command being processed.
- Do not specify a RETRYDDN list in the OPTIONS entry that is in effect for the SMP/E command being processed.
- Do not have an OPTIONS entry in effect for the SMP/E command being processed.

FIXCAT

specifies the list of fix categories. During APPLY, ACCEPT, and REPORT MISSINGFIX processing, this subentry, or the FIXCAT operand on the command, identifies the fix categories of interest and is used to determine which FIXCAT HOLDDATA entries will affect command processing.

The UCL operand is FIXCAT(category…).

A Fix Category value is case sensitive, can be 1- to 64-characters in length, can contain any nonblank character in the range X'41' - X'FE' except single quotation mark ('), comma (,), left parenthesis ((), and right parenthesis ()), and can be specified in two ways:
- Explicitly, by fully specifying a particular fix category value. For example, IBM®.Device.zIIP. In this case, all HOLDDATA associated with this Fix Category is applicable to command processing.
- Implicitly, by partially specifying a fix category value using any number of asterisks (*) as global characters and percent signs (%) as placeholders.
  - A single asterisk indicates that zero or more characters can occupy that position. Here are some examples:
    IBM.Device*
    
    In this example, all HOLDDATA associated with a fix category that begins with the character string IBM.Device is applicable.
    
    *z/OS
    
    In this example, all HOLDDATA associated with a fix category that ends with the character string z/OS is applicable.
    
    IBM*z/OS
    
    In this example, all HOLDDATA associated with a fix category that begins with the character string IBM and ends with the character string z/OS is applicable.
- A single percent sign indicates that any one single character can occupy that position. For example, IBM.Device.20%4 indicates that HOLDDATA associated with any of the following fix categories is applicable: IBM.Device.2084, IBM.Device.2094, and IBM.Device.20t4. HOLDDATA associated with a fix category of IBM.Device.20914, however, is not applicable.

The following examples are all acceptable fix categories:

IBM.Device.zIIP
*
IBM.Function*
IBM.Device.20%4.*
*.HealthChecker

HFSCOPY

is the name of the UTILITY entry that SMP/E is to use to obtain information when calling the HFS copy utility.

This is the utility used to install hierarchical file system elements and must meet the same program-to-program interface as BPXCOPY.

The UCL operand is HFSCOPY(name).

The name can contain from 1 to 8 uppercase alphanumeric characters.
If no HFSCOPY subentry is specified in the OPTIONS entry, SMP/E uses a default UTILITY entry. For details, see Table 1.

IOSUP

is the name of the UTILITY entry that SMP/E is to use to obtain information when calling the IEHIOSUP utility program to process maintenance for an OS/VS1 system.

The UCL operand is IOSUP(name).

The name can contain from 1 to 8 alphanumeric characters.

LKED

is the name of the UTILITY entry that SMP/E is to use to obtain information when calling the link-edit utility.

The UCL operand is LKED(name).

The name can contain from 1 to 8 alphanumeric characters.
If no entry name is specified, SMP/E uses a default UTILITY entry. For details, see Table 1.

MSGWIDTH

specifies whether the message output (SMPOUT only) should be formatted in 80 or 120 character widths.

The UCL operand is MSGWIDTH(value). The subentry can contain one of the following values:

80: indicates that the message text should be formatted to an 80 character width.
120: indicates that the message text should be formatted to a 120 character width. This is the default.

MSGFILTER

specifies whether messages issued to SMPOUT during APPLY, ACCEPT, and RESTORE processing should be filtered to contain only the following:

Messages with a severity of Warning or higher.
Messages with a severity of Informational that add clarity or additional information to a previously issued higher severity message.
Messages GIM20501I and GIM20502I.

The UCL operand is MSGFILTER(YES|NO), where:

YES: indicates that the number of messages issued to SMPOUT should be in a filtered format for APPLY, ACCEPT, and RESTORE processing.
NO: indicates that the number of messages issued to SMPOUT should be in a unfiltered format for APPLY, ACCEPT, and RESTORE processing. This is the default.

NOPURGE

indicates that after SMP/E accepts SYSMODs, it should not delete the associated global zone SYSMOD entries, SMPPTS MCS entries, or SMPTLIB data sets.

The UCL operand is NOPURGE.

The default is for NOPURGE not to be specified. In this case, SMP/E deletes the entries after the SYSMOD has been successfully accepted. (This is true only if the SYSMOD has been applied and BYPASS(APPLYCHECK) was not specified on the ACCEPT command.) The associated HOLDDATA, including internal SYSTEM HOLDDATA, is not deleted when the SYSMOD is deleted.
Although this operand can be specified in any OPTIONS entry, it is effective only when the OPTIONS entry is used during ACCEPT processing.

NOREJECT

specifies that the global zone SYSMOD entry and the associated MCS entry should not be deleted after the SYSMOD is restored.

The UCL operand is NOREJECT.

The default is for NOREJECT not to be specified. In this case, SMP/E deletes the entries after the SYSMOD has been successfully restored. The associated HOLDDATA, including internal SYSTEM HOLDDATA, is not deleted when the SYSMOD is deleted.
Although this operand can be specified in any OPTIONS entry, it is effective only when the OPTIONS entry is used during RESTORE processing.

ORDERRET

Indicates the retention period, in days, that ORDER entries are kept in the global zone before being deleted. During RECEIVE ORDER processing, an ORDER entry will be deleted from the global zone if either of the following conditions occurs:

The ORDER entry has a status of DOWNLOADED, and the difference between the current date and the ORDER entry's DOWNLDATE subentry value is greater than the OPTIONS entry ORDER RETENTION subentry value.
The ORDER entry has a status of ERROR or PENDING and the difference between the current date and the ORDER entry's ORDERDATE subentry value is greater than the OPTIONS entry ORDER RETENTION subentry value.

When an ORDER entry is deleted from the global zone, SMP/E also deletes the order package stored in the SMPNTS.

The UCL operand is ORDERRET(nnnn).

The value can contain from 1 to 4 numeric characters from 0 to 9999.
If no value is specified, the default is 180 days.

PAGELEN

specifies the page length for the SMPLIST, SMPHRPT, SMPOUT, and SMPRPT data sets.

The UCL operand is PAGELEN(nnnn).

The value can contain from 1 to 4 numeric characters.
If no value is specified, the default is 60.

PEMAX

specifies the maximum number of subentries that can be present in any CSI entry. Most often, the largest entry is a SYSMOD entry.

The UCL operand is PEMAX(nnnn).

The value can contain from 1 to 4 numeric characters, with a value range of 1 to 9999.
If no value is specified, the default is 32767. Therefore, if you want a value higher than 9999, you must use the default.

RECEXZGRP

specifies a list of zones or zonesets to be excluded during APPLYCHECK and ACCEPTCHECK processing during the SYSMOD selection phase of RECEIVE processing.

The UCL operand is RECEXZGRP(value…).

Each value is a zone or zoneset name. Each name can contain from 1 to 8 alphanumeric characters.
The zone or zonesets can contain both target and distribution zones.
Note: The value specified cannot be GLOBAL nor ALLZONES.
If a zone is specified in both the RECEXZGRP list and the RECZGRP list, the zone is excluded from processing.
If no zones are specified for RECZGRP, the zones specified on RECEXZGRP are ignored.

RECZGRP

specifies a list of zones and zonesets eligible for APPLYCHECK and ACCEPTCHECK processing during the SYSMOD selection phase of RECEIVE processing. Any SYSMOD that has been applied or accepted into any of the zones specified by this list will not be received by the RECEIVE command, unless the SYSMOD is specified on the SELECT operand of the RECEIVE command or the list is overridden by the BYPASS(ACCEPTCHECK) or BYPASS(APPLYCHECK) operands, or a new list is specified by the ZONEGROUP operand.

The UCL operand is RECZGRP(value…).

Each value is a zone or zoneset name. Each name can contain from 1 to 8 alphanumeric characters.
The zone or zonesets can contain both target and distribution zones.
Note: The value specified cannot be GLOBAL.
ALLZONES can be specified to indicate that all zones defined by a ZONEINDEX subentry in the GLOBALZONE entry are eligible. When ALLZONES is specified, all other values specified are ignored.
If no zones or zonesets are specified, no APPLYCHECK or ACCEPTCHECK processing is performed unless the ZONEGROUP operand is specified on the RECEIVE command.

RETRY

is the name of the UTILITY entry that SMP/E is to use to obtain information when calling the utility program to compress a data set after an x37 abend.

The UCL operand is RETRY(name).

The name can contain from 1 to 8 alphanumeric characters.
If no entry name is specified, SMP/E uses a default UTILITY entry. For details, see Table 1.

RETRYDDN

specifies the list of ddnames eligible for retry processing after an x37 abend.

The UCL operand is RETRYDDN(ddname…).

The ddnames can contain from 1 to 8 alphanumeric characters.
ALL can be specified to indicate that all ddnames are eligible.
If no ddnames are specified, no retry processing will be done, even if RETRY was specified on the command being processed.
Retry processing is attempted for partitioned data sets (PDSs) and partitioned data sets extended (PDSEs) that experience an x37 abend, indicating that they have run out of space.
For pointers on how to set up the desired retry processing, see SMP/E for z/OS User's Guide.

SAVEMTS

indicates that MTSMAC entries should not be deleted from the SMPMTS after the SYSMODs that affect those macros have been successfully accepted.

The UCL operand is SAVEMTS.

If SAVEMTS is not specified, SMP/E deletes the entries after all the SYSMODs that affect the macros have been successfully accepted. (This is true only if the SYSMOD has been applied and BYPASS(APPLYCHECK) was not specified on the ACCEPT command.)
Although this operand can be specified in any OPTIONS entry, it is effective only when the OPTIONS entry is used during ACCEPT processing.

SAVESTS

indicates that STSSRC entries should not be deleted from the SMPSTS after the SYSMODs that affect the source have been successfully accepted.

The UCL operand is SAVESTS.

If SAVESTS is not specified, SMP/E deletes the entries after all the SYSMODs that affect the source have been successfully accepted. (This is true only if the SYSMOD has been applied and BYPASS(APPLYCHECK) was not specified on the ACCEPT command.)
Although this operand can be specified in any OPTIONS entry, it is effective only when the OPTIONS entry is used during ACCEPT processing.

SUPPHOLD

specifies a list of HOLD reason IDs for which the HOLDDATA card image should not be displayed on the following reports:

Unresolved HOLD Reason Report
Bypassed HOLD Reason Report
SYSMOD Comparison HOLDDATA Report

The UCL operand is SUPPHOLD(value…), where:

value: is a HOLD reason ID, which is from 1 to 7 alphanumeric characters, #, @, and $. The first character cannot start with 0-9.

UPDATE

is the name of the UTILITY entry that SMP/E is to use to obtain information when calling the update utility.

The UCL operand is UPDATE(name).

The name can contain from 1 to 8 alphanumeric characters.
If no entry name is specified, SMP/E uses a default UTILITY entry. For details, see Table 1.

ZAP

specifies the name of the UTILITY entry that SMP/E is to use to obtain information when calling the superzap utility.

The UCL operand is ZAP(name).

The name can contain from 1 to 8 alphanumeric characters.
If no entry name is specified, SMP/E uses a default UTILITY entry with NAME(IMASPZAP), RC(4), PRINT(SYSPRINT), and PARM().

LIST Examples

To list all the OPTIONS entries in a global zone, you can use the following commands:

SET      BDY(GLOBAL)        /* Set to requested zone.     */.
LIST     OPTIONS            /* List all OPTIONS entries.  */.

To list specific OPTIONS entries in a global zone, you can use these commands:

SET      BDY(GLOBAL)        /* Set to requested zone.   */.
LIST     OPTIONS(OPT1,      /* List only these three    */
                TGT1,      /* entries.                 */
                 DLIB1)     /*                          */.

The format of the LIST output for each OPTIONS entry is the same for both of these commands. The only difference is the number of OPTIONS entries listed.

Figure 1 is an example of LIST output for OPTIONS entries.

Figure 1. OPTIONS entry: sample LIST output

PAGE nnnn  - NOW SET TO GLOBAL ZONE   DATE mm/dd/yy TIME hh:mm:ss SMP/E 36.nn SMPLIST OUTPUT

GLOBAL        OPTIONS ENTRIES


ALLOPTS   AMS             = AMS
          ASM             = ASM
          COMP            = COMPRESS
          COPY            = COPY
          HFSCOPY         = BPXCOPY
          IOSUP           = IOSUP
          LKED            = LINK
          RETRY           = COMPRESS
          UPDATE          = UPDATE
          ZAP             = ZAP
          PAGELEN         = 60
          PEMAX           = 9999
          NOPURGE
          COMPACT SMPPTS  = YES
          NOREJECT
          DSSPACE         = PRI=0100  SEC=0050  DIR=0200
          MSGFILTER       = YES
          MSGWIDTH        = 80
          CHANGEFILE      = NO
          ORDER RETENTION = 90
          DSPREFIX        = SMPE.SMPTLIB
          RETRYDDN        = ALL
          EXRTYDD         = LINKLIB   LPALIB
          RECZGRP         = ALLZONES
          RECZGRP         = DLIB      TGT
          SUPPHOLD        = DOC       IPL
          FIXCAT	         = IBM.Device.zIPP						 
                            *.HealthChecker

UCLIN Examples

You can use the ADD, REP, and DEL UCL statements to change subentries in an OPTIONS entry. When you use UCLIN to update an OPTIONS entry, remember that if a DEL statement deletes all the existing subentries in the entry, SMP/E deletes the entire entry.

The following examples are provided to help you use the OPTIONS entry.