Previous Topic: LISTH

Next Topic: SOURCE

OPTIONS

The OPTIONS control statement allows the specification of CA SMF Director program product options. The OPTIONS statement can be used as a standalone statement or can appear after the COMPILE CONFIGURATION STORE control statement and within the definition of a new configuration or the updating of an existing configuration. If you are not sure about the current definition of a configuration, use the LISTC SID (sidid) or LISTC All command to get a list of current parameter values for a configuration to use during the process to add OPTIONS values. When you are updating a configuration, any values that are not explicitly defined for a particular configuration will contain default values.

The standalone OPTIONS statement is valid only if there are existing configurations defined. Any values that are not explicitly coded in standalone OPTIONS statements will not be changed and will contain previous values.

Figure 14 shows example output from a successful update of OPTIONS values.

Statement Format:

OPTIONS

►►─ OPTIONS ─ SDAY(hhmm) ─ MAXLINES(nnn) ─┬───────────────┬───────────────────►
                                          ├─ NOAUTODEL ◄ ─┤
                                          └─ AUTODEL ─────┘

 ►─┬─────────────┬─ SITE(name) ─┬───────────────────────────┬─────────────────►
   ├─ NODYNAM ◄ ─┤              ├─ PDEVN( ─┬─ dname ─┬─ ) ──┤
   ├─ DYNAM ─────┤              │          └─ NONE ──┘      │
   └─ DYNAMVTS ──┘              └─ PSTORC( ─┬─ class ─┬─ ) ─┘
                                            └─ NONE ──┘

 ►─┬───────────────────────────┬──────────────────────────────────────────────►
   ├─ ADEVN( ─┬─ dname ─┬─ ) ──┤
   │          └─ NONE ──┘      │
   └─ ASTORC( ─┬─ class ─┬─ ) ─┘
               └─ NONE ──┘

 ►─┬──────────────┬─┬────────────────────┬────────────────────────────────────►
   └─ OVERLAP(n) ─┘ └─ MAXFILESONVOL(n) ─┘

 ►────COPIES( ─┬─ 1 ◄ ─┬─ ) ──────┬─────────────┬──────┬───────────────┬──────►
               └─ 2 ───┘          ├─ NOCATLG ◄ ─┤      ├─ SCRATCH ─────┤
                                  └─ CATLG ─────┘      └─ NOSCRATCH ◄ ─┘

 ►─┬─────────────────┬─┬────────────────────────┬─┬─────────────────┬─────────►
   ├─ EXPDT(yyyddd) ─┤ ├─ AEXPDT(yyyddd) ◄ ─────┘ └─ TRTCH(value) ──┘
   └─ RETPD(nnnn) ───┘ └─ ARETPD(nnnn) ─┘

 ►─┬──────────────────────┬────────────────────────────┬──────────────────────►
   └─ ATRTCH(value) ─┘    └─ DAYSTACK( ─┬─ NO ◄ ─┬─ ) ─┘
                                        └─ YES ──┘
 ►─┬────────────────────────────┬─┬─────────────────────────────┬─────────────►
   └─ PDSNLARGE( ─┬─ NO ◄ ─┬─) ─┘ └─ ADSNLARGE( ─┬─ NO ◄ ─┬─ ) ─┘
                  └─ YES ──┘                     └─ YES ──┘

 ►─┬────────────────────┬─────────┬───────────────────┬───────────────────────►
   ├─ NOPREFIX ◄ ───────┤         ├─ NOAPREFIX ◄ ─────┤
   └─ PREFIX(prefix) ───┘         └─ APREFIX(prefix) ─┘

 ►─┬────────────────────────────┬───────────────────────────── . ─────────────►◄
   ├─ NOSERVICEDESK ◄ ──────────┤ 
   ├─ SERVICEDESK ──────────────┤ 
   └─┤ SERVICEDESK parameters ├─┘ 

SERVICEDESK parameters

►►─┬─────────────────────┬─┬────────────────────┬─────────────────────────────►
   └─ SDHIGHSEVERITY(n) ─┘ └─ SDLOWSEVERITY(n) ─┘

 ►─┬─────────────────────────┬─┬───────────────────────────────┬──────────────►◄
   └─ SDURL( ─┬─ url ──┬─ ) ─┘ ├─ SDUSERID( ─┬─ user ID ─┬─ ) ─┤
              └─ NONE ─┘       │             └─ NONE ────┘     │
                               └─ SDPASSWORD(password) ────────┘

Operands and Descriptions:

SDAY(hhmm)

Specifies the hour (hh) and minute (mm) that CA SMF Director is to treat as the logical start of a day. If this parameter is not coded, a day will be considered as starting at midnight (0000).

Note: The SDAY value is used to determine the starting and ending times for all EXTRACT and PRINT requests, except when the FROM, JFROM, TO or JTO parameter gives a specific starting or ending time. For example, if option SDAY(0600) is in effect, the command EXTRACT ALL FROM(040208) TO(040608) will cause the extraction of all SMF data from 0600 on April 2, 2008 up to—but not including—0600 on April 7,2008.

MAXLINES(nnn)

Specifies the maximum number of lines per page for CA SMF Director SYSPRINT output. "nnn" can be a numeric value from 0 or 10 through 255. The default is 0, which breaks pages every 60 lines.

AUTODEL|NOAUTODEL

Identifies if CA SMF Director should perform the auto-delete feature. If AUTODEL is specified, this product scans the SCDS file for any SMF inventory entries referencing history files that have expired at least three days earlier. If any entries exist, they are deleted from the SCDS and the system catalog entry is deleted as well, if it exists. The default is NOAUTODEL.

This operand is a global option only, but you can override this setting using the EXPDT/RETPD operands on a system-by-system or stream-by-stream basis on the DUMPOPTIONS or STREAMOPTIONS statements.

DYNAM|NODYNAM|DYNAMVTS

Controls whether or not this product will dynamically allocate history files when performing dump, extract, and print operations:

Note: If the DYNAM option is in effect and a history DD statement is coded, the parameters in the DD statement override the dynamic allocation options such as PSTORC, ASTORC, and so on. See the descriptions of the PSTORC and ASTORC operands for more information.

Note: The NODYNAM option may cause problems involving incorrect mount messages at installations that employ virtual tape. The DYNAMVTS option can be used to avoid this problem while maintaining control over allocation of output history files during dumps.

Note: If logstream or substream recorded SMF data will be managed with any defined configuration, DYNAM must be specified.

SITE(name)

'name' is an optional comment identifying the computing complex of up to 20 characters long and within quotes.

PDEVN(dname)

'dname' is the esoteric device name to be used when creating SMF history files in the primary pool. Up to eight characters can be specified. It is mutually exclusive with PSTORC. If no device name or SMS storage class is specified and the DYNAM option is enabled, the system default device name is used. This default name can be set in the active ALLOCxx member of the system PARMLIB. NONE can be used to reset the device name.

Note: If you are changing the PDEVN parameter from one tape unit name to another, from tape to DASD, or from DASD to tape, you must immediately run a TAPEINIT command against every SID defined in your SCDS.

If using DASD for history files, this parameter must only be used for non-SMS managed volumes.

PSTORC(class)

'class' is the IBM DFSMS storage class to be used when creating SMF history files in the primary pool. Up to eight characters can be specified. It is mutually exclusive with the PDEVN keyword. NONE can be used to reset the storage class.

If using DASD for history files, this operand will allocate files only to SMS-managed volumes. Note that some issues may arise with DASD history file allocations based on how SMS is set up at your data center. For DASD history allocations with the DYNAM option set, there must still be a temporary history file allocated in the JCL that indicates how large the history file should be. SMS may not allow the allocation on the storage class indicated in the PSTORC operand and will indicate an allocation error for the history file, causing the dump process to end prematurely.

To avoid this issue, here are some remedies you can use:

ADEVN(dname)

'dname' is the esoteric device name to be used when creating SMF history files in the alternate pool. Up to eight characters can be specified. It is mutually exclusive with ASTORC. If no device name or SMS storage class is specified and the DYNAM option is enabled, the default device name used will be the device name used for the primary pool. NONE can be used to reset the device name.

Note: If you are changing the ADEVN parameter from one tape unit name to another, from tape to DASD, or from DASD to tape, you must immediately run a TAPEINIT command against every SID defined in your SCDS.

If using DASD for history files, this parameter must only be used for non-SMS managed volumes.

ASTORC(class)

'class' is the IBM DFSMS storage class to be used when creating SMF history files in the alternate pool. Up to eight characters can be specified. It is mutually exclusive with the ADEVN keyword. NONE can be used to reset the storage class.

If using DASD for history files, this operand will allocate files only to SMS-managed volumes. Note that some issues may arise with DASD history file allocations based on how SMS is set up at your data center. For DASD history allocations with the DYNAM option set, there must still be a temporary history file allocated in the JCL that indicates how large the history file should be. SMS may not allow the allocation on the storage class indicated in the ASTORC operand and will indicate an allocation error for the history file, causing the dump process to end prematurely.

To avoid this issue, here are some remedies you can use:

OVERLAP(n)

'n' can be from 0 through 30 seconds, which is the maximum allowable overlap of SMF dump history files before CA SMF Director considers a file to be in an 'overlap' condition. The default is zero.

For example, assume that two SMF data history files contain these date ranges:

If OVERLAP(0) was specified, File B would contain overlapped data with File A. If OVERLAP(3) was specified, neither of these files would be considered to contain overlapped data.

Note: We recommend that you observe the overlap conditions that occur and analyze them to see if they are truly overlaps. They may just be records written with timestamps in error. This is especially true with non-IBM SMF records that may be created with timestamps that do not account for leap seconds.

MAXFILESONVOL(n)

Indicates the maximum number of history files that can be written to a single tape volume. With some devices that use very large tapes, performance issues can occur if a large number of files are written to the tape. Using this operand, the number of files that are placed on one tape can be limited so that the performance issues are avoided. The value of the operand can be set to any integer value from 1 to 32760. If this operand is not specified, a default value of 300 is set.

COPIES(1|2)

Specifies whether or not CA SMF Director should create a duplicate copy of the dumped SMF data (duplexing) if the COPIES operand is not specified for the system (with DUMPOPTIONS) or stream (with STREAMOPTIONS). If 1 is specified, no duplexing is performed. If 2 is specified, duplexing of the history file is performed. A duplicate index entry is also created on the SCDS file to maintain an inventory of the SMF data for the duplex file. Duplex files are placed in the alternate archive. The default is COPIES(1), but it is recommended that COPIES(2) be set for all SMF data that needs to be kept on a long-term basis.

CATLG|NOCATLG

Indicates whether CA SMF Director should catalog the history file data set, creating an entry within the system catalog, or not. The default is NOCATLG. This value can be overridden on a system basis using DUMPOPTIONS or on a stream basis using STREAMOPTIONS.

Note: If the PSTORC or ASTORC option is in effect, SMS may override the NOCATLG/CATLG specification.

NOSCRATCH|SCRATCH

Specifies whether CA SMF Director should request specific or nonspecific magnetic tape volumes when creating history files:

The value specified here is used for all configurations if UPSCRATCH is specified on the DUMPOPTIONS statement.

Note: If tape management products such as CA 1, CA Vtape Virtual Tape System, or CA TLMS are used, SCRATCH is recommended.

Note: If logstreams or substreams are going to be dumped in a configuration, SCRATCH must be set for that configuration. We recommend that the SCRATCH operand be set in each configuration if streams are going to be used.

EXPDT(yyyddd)|RETPD(nnnn)

Specifies the expiration date or retention period of the history file data sets within the primary pool. If the expiration date is specified, it must be in Julian date format. The default is EXPDT(0) or RETPD(0), which causes CA SMF Director not to set an expiration date for the history file.

See Control Statement Language Rules for a description of two special expiration dates: 099000 and 099366.

We recommend that expiration dates or retention periods be used, since it increases the integrity of the SMF data. If the AUTODEL feature is desired, setting expiration dates or retention periods is required.

Note: If the PSTORC option is in effect, SMS may override the specified expiration date or retention period.

AEXPDT(yyyddd)|ARETPD(nnnn)

Specifies the expiration date or retention period of the history file data sets within the alternate pool for configurations that do not have a specific EXPDT or RETPD. If the expiration date is specified, it must be in Julian date format. The default is EXPDT(0) or RETPD(0), which causes CA SMF Director not to set an expiration date for the history file.

See Control Statement Language Rules for a description of two special expiration dates: 099000 and 099366.

We recommend that expiration dates or retention periods be used, since it increases the integrity of the SMF data. If the AUTODEL feature is desired, setting expiration dates or retention periods is required.

Note: If the PSTORC option is in effect, SMS may override the specified expiration date or retention period.

TRTCH(value)
ATRTCH(value)

Lets you use the z/OS JCL TRTCH parameter on dynamically allocated history files in CA SMF Director. The values of the TRTCH and ATRTCH operands are the same as the values allowed in z/OS JCL when writing an output file to tape. TRTCH is used to set the recording technique for the primary history file, while ATRTCH is used to set the TRTCH for the alternate history file.

Valid values are as follows:

NOCOMP

For cartridge tapes, writes the history file without data compression.

COMP

For cartridge tapes, writes the history file with data compression.

C

Performs data conversion for history files on reel tapes.

E

Writes history files to reel tape with even parity.

ET

Writes history files to reel tape with even parity and perform EBCDIC translation.

T

Writes history files to reel tape and perform EBCDIC translation.

Note: Although CA SMF Director does support TRTCH options C, E, ET, and T, they are not recommended for history files.

Note: If SMS is used in dynamic allocation for history files, the TRTCH setting for that history file can be changed by SMS.

If neither TRTCH nor ATRTCH is specified, the system defaults are used.

DAYSTACK(NO|YES)

Specifies whether the daystacking feature should be turned on or off. The default is NO, which turns daystacking off. See Features for a description of the daystacking feature.

PDSNLARGE(NO|YES)

Allocates the primary history file with the DSNTYPE=LARGE operand. This operand is only used for DASD history files when the DYNAM operand is specified on the OPTIONS statement; otherwise it is ignored.

ADSNLARGE(NO|YES)

Allocates the alternate history file with the DSNTYPE=LARGE operand. This operand is only used for DASD history files when the DYNAM operand is specified on the OPTIONS statement; otherwise it is ignored.

NOPREFIX|PREFIX(prefix)

Specifies the high level qualifiers to be used for the primary history file data set names. If NOPREFIX is specified, CA SMF Director uses SYS1.SMFDATA, which is the default.

See Attributes of History Files for more details. The prefix can be up to 26 characters.

NOAPREFIX|APREFIX(prefix)

Specifies the high level qualifiers to be used for the primary history file data set names if nothing is specified for a specific stream or system. If NOAPREFIX is specified, the value of SYS1.SMFDATA is used for systems that do not have a PREFIX or APREFIX specified.

See Attributes of History Files for more details. The prefix can be up to 26 characters.

NOSERVICEDESK|SERVICEDESK

SERVICEDESK specifies that an attempt should be made to open a Service Desk request in case of an error during SMP dump processing. NOSERVICEDESK is the default.

SDHIGHSEVERITY

Specifies the severity level of high Service Desk requests that CA SMF Director will open. The value can be set to any value between 1 and 4. The value itself also becomes the lower bound for the value of SDLOWSEVERITY. If this is not specified and the SERVICEDESK operand is specified, the value defaults to 2.

SDLOWSEVERITY

Specifies the severity level of low Service Desk requests that CA SMF Director will open. The value can be set to any value between the value of SDHIGHSEVERITY and 5. The default value, if the operand is not specified is 4.

Note: If only one severity level is desired for all CA SMF Director, the value of SDHIGHSEVERITY and SDLOWSEVERITY can be set to the same value from 1 to 4.

SDURL

Specifies an alternate URL for the Service Desk Web Service if the default Service Desk Web Service in the CA Common Services SOAP Client Service (CAISDI/soap) address space does not indicate the desired Service Desk instance. NONE can be used to reset the URL.

Note: The URL value is case sensitive and must be enclosed in single quotes because it will contain special characters.

SDUSERID

Specifies an alternate user ID for the Service Desk Web Service if the default value set in the CA Common Services SOAP Client Service (CAISDI/soap) address space is not the correct User ID for the Service Desk. If the SDUSERID operand is coded, SDPASSWORD is required. NONE can be used to reset the user ID. If NONE is used, the alternate password for Service Desk is also reset, and the SDPASSWORD is ignored.

SDPASSWORD

Specifies an alternate password for the Service Desk Web Service if the default value set in the CA Common Services SOAP Client Service (CAISDI/soap) address space. If the SDUSERID operand is coded, SDPASSWORD is required; otherwise, it is ignored.

Note: The operand is case-sensitive. If the operand contains special characters, it must be contained in single quotes.

Sample OPTIONS Statement:

OPTIONS AUTODEL DYNAM   PSTORC(TAPESILO)

OPTIONS statement output:

CA AUDIT TRAIL REPORT SMFD PAGE 1 CA SMF Director 12.6 SYSA 27 JUL yyyy 13:23:45 COMPILE CONFIGURATION STORE. OPTIONS AUTODEL DYNAM PSTORC(TAPESILO) . BEGIN CONFIG(001) SID(XAT1) NAME('C.A. HERNDON VA') . DUMPOPTIONS COPIES(1) CATLG SCRATCH NOVERIFY RETPD(1095) PREFIX(ELLPH01.SF16) ARETPD(1461) END CONFIG(001) . CAF1301I CONFIGURATION DEFINITION XAT1 REPLACED COMPILE CONFIGURATION STORE. BEGIN CONFIG(002) SID(XAD1) NAME('C.A. ISLANDIA TSO1') . DUMPOPTIONS COPIES(2) CATLG NOSCRATCH NOVERIFY ARETPD(1461) RETPD(1095) PREFIX(ELLPH01.SF16). END CONFIG(002) . CAF1301I CONFIGURATION DEFINITION XAD1 REPLACED CAF2900I RUN COMPLETE