Previous Topic: DUMP

Next Topic: DUMPTAPES

DUMPOPTIONS

This control statement allows systems personnel to define the specifications for dumping SMF records to history files managed by CA SMF Director. The DUMPOPTIONS control statement must follow the BEGIN control statement defining the dump options for the specified system configuration, and precede the END CONFIG control statement.

Statement Format:

DUMPOPTIONS

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

 ►─┬──────────────┬───────────────────────────────────────────────────────────►
   ├─ NOVERIFY ◄ ─┤
   └─ VERIFY ─────┘

 ►─┬────────────────────────┬─────────────────────────────────────────────────►
   ├─ PREFIX(─┬──*─────┬─)──┤
   ├─         └ prefix ┘    │
   └─ NOPREFIX ◄ ───────────┘

 ►─┬─────────────────────────┬────────────────────────────────────────────────►
   ├─ APREFIX(─┬──*─────┬─)──┤
   ├─          └ prefix ┘    │
   └─ NOAPREFIX ─────────────┘

 ►─┬──────────────────────┬───────────────────────────────────────────────────►
   ├─ RETPD(──┬──0 ◄ ──┬─)┤
              ├ nnnn ──┤  │
   └─         └─ * ────┘ ─┘
   ├─ EXPDT(──┬──0 ◄ ──┬─)│
              ├ yyyddd ┤  │
   └─         └─ * ────┘ ─┘

 ►─┬──────────────────────┬───────────────────────────────────────────────────►
   ├─ ARETPD(─┬──*───┬─)──┤
   ├─         └ nnnn ┘    │
   ├─ AEXPDT(─┬──*─────┬─)│
   └─         └ yyyddd ┘  ┘ 

 ►─┬───────────────────────┬──────────────────────────────────────────────────►
   └─ TRTCH(──┬──*────┬─)──┘
              └ value ┘    

 ►─┬───────────────────────┬──────────────────────────────────────────────────►
   └─ ATRTCH(─┬──*────┬─)──┘
              └ value ┘    

 ►─┬────────────────────────────────┬────────┬───────────────────┬────────────►
   ├─ LSNAME(lsname lsname ...)    ─┤        └─ FIRSTYEAR(yyyy) ─┘
   └─ SUBNAME(subname subname ...) ─┘


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

 ►─┬────────────────────────────┬─────────────────────────────────────────────►
   └─ DAYSTACK( ─┬─ NO ◄ ─┬─ ) ─┘
                 ├─ YES ──┤
                 └─ * ────┘

 ►─┬────────────────────────────┬─┬─────────────────────────────┬─────────────►
   └─ PDSNLARGE( ─┬─ NO ◄ ─┬─) ─┘ └─ ADSNLARGE( ─┬─ NO ◄ ─┬─ ) ─┘
                  ├─ YES ──┤                     ├─ YES ──┤
                  └── * ───┘                     └── * ───┘
 ►─┬─────────────┬──────────────┬───────────────────────────┬─────────────────►
   ├─ NODYNAM ───┤              ├─ PDEVN( ─┬─ dname ─┬─ ) ──┤
   ├─ DYNAM ─────┤              │          ├─ NONE ──┤      │
   ├─ DYNAMVTS ──┤              │          └── * ────┘      │
   └─ UPDYNAM ◄ ─┘              └─ PSTORC( ─┬─ class ─┬─ ) ─┘
                                            ├─ NONE ──┤
                                            └── * ────┘

 ►─┬───────────────────────────┬───────────────┬────────────────┬─────── . ───►◄
   │  ADEVN( ─┬─ dname ─┬─ ) ──┤               └─ SDAY(hhmm) ───┘ 
   │          ├─ NONE ──┤      │
   │          └── * ────┘      │
   └─ ASTORC( ─┬─ class ─┬─ ) ─┘
               ├─ NONE ──┤
               └── * ────┘

Operands and Descriptions:

COPIES(1|2|*)

Specifies whether or not CA SMF Director should create a duplicate copy of the dumped SMF data (duplexing). 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 we recommend that COPIES(2) be set for all SMF data that needs to be kept on a long-term basis. To use the value coded on the OPTIONS statement, specify COPIES(*).

NOCATLG|CATLG|UPCATLG

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. To indicate that the system being configured should use the value coded on the OPTIONS statement, specify the UPCATLG operand.

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

SCRATCH|NOSCRATCH|UPSCRATCH

Specifies whether CA SMF Director should request specific or nonspecific magnetic tape volumes when creating the history file. If the default SCRATCH is specified, a nonspecific mount request for a scratch tape is performed when a new tape volume is needed for a history file. If NOSCRATCH is specified, it selects a volume serial from the predefined pool of volumes when a new tape volume is needed for a history file. (See the DUMPTAPES control statement). To indicate that the system being configured should use the value coded on the OPTIONS statement, specify the UPSCRATCH operand.

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 this configuration, SCRATCH is required.

NOVERIFY|VERIFY

Indicates whether or not CA SMF Director should enable the Write Validity Check Feature if available on the device used to create a history file. This ensures the integrity of the SMF data written. This product also checks the standard header of each SMF record for validity. The record length, date, and time are all checked for validity. If an error is detected, a dump of the record in question is dumped to the SYSPRINT DD statement, and processing is continued if the default NOVERIFY is specified. When VERIFY is specified, the hardware supplied Write Validity Check feature is enabled, and any errors detected by CA SMF Director results in termination of processing.

Note: This feature is obsolete but is still supported for backward compatibillity.

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. To use the value of the PREFIX operand on the global OPTIONS statement, code PREFIX(*).

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 alternate or duplex history file data set names. If NOAPREFIX is specified or this operand is not specified, the value specified by the PREFIX keyword is used. To use the value of the APREFIX operand on the global OPTIONS statement, code PREFIX(*).

See Attributes of History Files for more details.

EXPDT(0|yyyddd)|*|RETPD(0|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. To use the value of the EXPDT or RETPD operand on the global OPTIONS statement, code either EXPDT(*) or RETPD(*).

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, as 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. If the expiration date is specified, it must be in Julian date format. For data sets created on a DASD device it requires an operator response and confirmation if the data set is to be scratched or overwritten. If AEXPDT or ARETPD is not specified, CA SMF Director uses the values specified for EXPDT or RETPD. To use the value of the AEXPDT or ARETPD operand on the global OPTIONS statement, code either AEXPDT(*) or ARETPD(*).

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, as 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 ASTORC 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.

If neither TRTCH nor ATRTCH is specified, the system defaults are used. These values can be set in SYS1.PARMLIB or within SMS.

To use the value of the TRTCH or ATRTCH operand on the global OPTIONS statement, code them with (*).

LSNAME(lsname lsname ...)

Specifies which logstreams are recording data that will be managed. Each logstream must be indicated in the configuration for each system that is writing data to that logstream. Up to 21 logstreams can be indicated in one compile. If more than 21 logstreams are needed, you can run the compile more than once with the additional names in the LSNAME operand, and these logstreams will be added to the configuration being processed.

SUBNAME(subname subname ...)

Specifies any substreams you are defining to manage SMF MAN file recorded data. By using substreams, you can define specific recording management attributes for SMF data recorded to SYS1.MANx files based on the SMF record type. The substream names can be up to 26 characters long in a standard 8.8.8 format similar to logstream names. Unlike logstream names, the subnames cannot begin with “I” or "SYS" and must contain at least two nodes, so SUBNAME(VALID.NAME) is allowed but SUBNAME(INVALID) is not allowed.

FIRSTYEAR(yyyy)

Specifies the first year of data that will be allowed in the history file index. During the dump, if an SMF record for this configuration has a lower year than this, it will be rejected as invalid. When adding a history file manually via ADDX, the low date also has to be higher than or equal to this year; otherwise the ADDX will fail. Valid values for this option range from 1960 to the current year or 2059, whichever is lower. The default is 1960.

Note: Changing this option will have no effect on history files already in the index.

MAXFILESONVOL(n|*)

Lets you override the global MAXFILESONVOL at the configuration level. (See the description of MAXFILESONVOL on the OPTIONS statement.) To use the value of the MAXFILESONVOL operand on the global OPTIONS statement, code either MAXFILESONVOL(0) or MAXFILESONVOL(*).

DAYSTACK(NO|YES|*)

Specifies whether the daystacking feature should be turned on or off. The default is NO, which turns daystacking off. To use the value of the DAYSTACK operand on the global OPTIONS statement, code DAYSTACK(*). 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. To use the value of the PDSNLARGE operand on the global OPTIONS statement, code PDSNLARGE(*).

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. To use the value of the ADSNLARGE operand on the global OPTIONS statement, code ADSNLARGE(*).

DYNAM|DYNAMVTS|UPDYNAM|NODYNAM

Controls whether or not CA SMF Director will dynamically allocate history files when performing dump, extract, and print operations. DYNAM allows dynamic allocation of history files for all dumps and EXTRACT/PRINT operations. NODYNAM prevents dynamic allocation of history files under any circumstances. DYNAMVTS allows dynamic allocation of input history files to EXTRACT and PRINT operations, but suppresses dynamic allocation of output history files from dump operations. To indicate that the system being configured should use the value coded on the OPTIONS statement, use the UPDYNAM operand, which is the default.

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 data centers 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 this configuration, DYNAM must be active for this configuration. This can be set either by specifying DYNAM on the DUMPOPTIONS statement or by specifying UPDYNAM on this DUMPOPTIONS statement and having DYNAM coded on the enterprise-wide OPTIONS statement. We recommend that you code DYNAM on the DUMPOPTIONS statement in case the OPTIONS statement changes in the future.

PDEVN(dname|NONE|*)

'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. Specify NONE to reset the device name. To use the value of the PDEVN operand on the global OPTIONS statement, code PDEVN(*).

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

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

PSTORC(class|NONE|*)

'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. Specify NONE to reset the storage class. To use the value of the PSTORC operand on the global OPTIONS statement, code PSTORC(*).

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|NONE|*)

'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. Specify NONE to reset the device name. To use the value of the ADEVN operand on the global OPTIONS statement, code ADEVN(*).

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

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

ASTORC(class|NONE|*)

'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. Specify NONE to reset the storage class. To use the value of the ASTORC operand on the global OPTIONS statement, code ASTORC(*).

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:

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 operand is not coded, days start at the value indicated in the OPTIONS statement for this configuration. If no value is set, the value defaults to midnight, coded as SDAY(0000).

Note: The global 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 operand gives a specific starting or ending time. The value specified here is used for the daystacking feature only.

Sample DUMPOPTIONS Statement:

COMPILE CONFIGURATION STORE.
  BEGIN CONFIG(002) SID(XE96) NAME('C.A. XE96').
    DUMPOPTIONS COPIES(2) NOCATLG SCRATCH NOVERIFY
      RETPD(002) ARETPD(001) PREFIX(SYSPROG.CASMF.XE96)
      LSNAME(IFASMF.ALL,IFASMF.T30,IFASMF.RMF)
      TRTCH(NOCOMP) ATRTCH(COMP).
  END CONFIG(002).

DUMPOPTIONS statement output:

CA AUDIT TRAIL REPORT SMFD PAGE 1 CA SMF Director 12.6 SYSA 19 SEP yyyy 10:40:51 COMPILE CONFIGURATION STORE . BEGIN CONFIG(002) SID(XE96) NAME('C.A. XE96') . DUMPOPTIONS COPIES(2) NOCATLG SCRATCH NOVERIFY RETPD(002) ARETPD(001) PREFIX(SYSPROG.CASMF.XE96) LSNAME(IFASMF.ALL,IFASMF.T30,IFASMF.RMF) TRTCH(NOCOMP) ATRTCH(COMP). END CONFIG(002) . CAF1301I CONFIGURATION DEFINITION XE96 STORED