Backup-Restore Utility (ESFSPTP) › Command Syntax of the EXEC Statement › Optional Parameters

Optional Parameters

The optional parameters for ESFSPTP are:

SUBSYS=xxxx

This parameter specifies that a request is to be directed to a particular CA Spool subsystem.

If this parameter is omitted, the subsystem name is filled-in by user exit ESFUSS. For a backup function, this name (specified by you or the exit routine) is saved, and is the default subsystem name if this parameter is omitted in a later restore run.

D=xxxxxxxx

This parameter specifies that only files with a specific destination name are processed.

O=xxxxxxxx

This parameter specifies that only files with a specific filename are processed.

Note that a generic specification can be used for the above two parameters, as follows:

• %—Any character will match.
• *—The rest of name matches.

Q=x

This parameter specifies that only files within a specific class are processed.

F=xxxx

This parameter specifies that only files using a specific form number are processed.

C=xxxx

This parameter specifies that only files using a specific FCB are processed.

EOF=YES|NO|ONLY

This parameter specifies whether a file is to be processed by the utility if the end-of-file flag is on (that is, printed files).

• YES—(Default) Causes the program to process files with the EOF mark set on
• NO—Bypasses processing those files
• ONLY—Specifies that only files with EOF are to be processed

PURGE=YES|NO

This parameter specifies whether the files being backed up are to be purged after back up. PURGE=NO causes the program not to purge the files which are backed up. The default value is NO.

FROMDATE=YY/MM/DD

This parameter specifies that processing is limited to files which are created after a certain date. See also the FROMTIME parameter.

FROMTIME=YY/MM/DD

This parameter specifies that processing is limited to files which are created after a certain time. See also the FROMDATE parameter.

TODATE=YY/MM/DD

This parameter specifies that processing is limited to files which are created before a certain date. See also the TOTIME parameter.

TOTIME=YY/MM/DD

This parameter specifies that processing is limited to files which are created before a certain time. See also the TODATE parameter.

USERID=XXXXXXXX

This parameter specifies that processing is limited to files created by a specific userid.

GROUP=99999

This parameter specifies that processing is limited to files with destinations in a specific group, as follows:

DUP=YES|NO

For the backup function, this parameter specifies whether all multi destination files must be backed up or not. Valid values are:

• NO—(Default) Causes only the first multi destination file to be backed up.
• YES—Causes all multi destination files to be backed up.

For the load function, this parameter specifies whether a file is to be restored by the load function even if a duplicate spool file already exists. Valid values are:

• NO—(Default) Causes the program not to reload files when a duplicate already exists.
• YES—Reloads all files from the back up media without testing for duplicates.

FORMAT=F|C

For the backup function, this parameter specifies the format F (fixed) or C (compressed) for the INDEXXT generated file, if it was requested.

• F—(Default) The F format will result in the generated file having a fixed field format, with leading and trailing spaces in all fields.
• C—The C format will result in the generated file having a compressed and variable format, with all fields separated by commas. If a field is non-existent, it will be represented as ",,". In this format, all leading and trailing spaces are removed from the fields, with the exception of the Account Information field, the Programmer Name field, and the file Creation and Last Used date and time fields. In addition, all commas in the Account Information and Programmers Name fields will be changed to spaces.

BACKUP=MULTI|SINGLE

For the backup function, this parameter specifies whether the load function must only process the first backup generation or must process all backup generations until EOF. Valid values are:

• BACKUP=MULTI—(Default) Causes the program to process all backup data sets.
• BACKUP=SINGLE—Causes the program to stop when the higher limit of the specified file range has been reached.

ENCRYPT=YES|nnn|NO

Specifies whether an ESFSPTP back up dataset should be AES encrypted or not.

• YES—Backup dataset will encrypted with encryption key interval 365.
• nnn—Backup dataset will be encrypted with specified encryption key interval 1 – 365 days.
• NO —Backup dataset will not be encrypted if ESFSPTP is executed from an APF authorized library and requestor's userid has read access to SAFTYPE 12, 13 and 14.

If ENCRYPT is not specified encryption will default to the SPOOLENC= parameter value for the specified SUBSYS= CA Spool subsystem.

Note: The parameter for ESFSPTP utility is valid only for making backups, not for restore processing.