ARCHIVE

Common Fields for all Operating Systems

The following fields correspond to parameters of the ARCHIVE command PARAM. They can be set only with the fisrt call, and will be ignored for all subsequent calls. Possible values for all fields are YES or NO.

Relevant Error Codes

Field Descriptions

For detailed information, refer to documentation of SNI's product ARCHIVE. Some field descriptions simply refer to the corresponding ARCHIVE command to avoid duplicate explanations.

The possible values for this field relate to the corresponding ARCHIVE command to be executed, unless stated otherwise:

Relevant for function SAVE. Minimum backup level.

Relevant for functions SAVE, EXPORT.

Relevant for function SAVE. Possible values:

Relevant for functions SAVE, EXPORT. Specifies whether a compress is to be done with save. Possible values:

Relevant for functions SAVE, EXPORT. Continuation of a previous SAVE/EXPORT run. Possible values:

Relevant for functions SAVE, EXPORT. Maximum of 5 volumes if keyword VSN-LIST is specified in field CONTINUE.

Relevant for functions RESTORE, IMPORT. PAM key conversion required to import or restore files to non-key disks. Possible values:

Relevant for functions SAVE, EXPORT. Number of days the object to be saved must have been unused.

Relevant for functions SAVE, EXPORT, RESTORE, IMPORT, POOL, LIST. Device type (for example, T9G).

Relevant for functions SAVE, EXPORT, RESTORE, IMPORT, POOL, LIST, PURGE, INQUIRE. Name of directory file. Default is NONE.

Relevant for functions SAVE, EXPORT, RESTORE, IMPORT, LIST. Number of drives to be used in parallel.

Relevant for functions SAVE, EXPORT. Specifies erasing of objects after SAVE or EXPORT. Possible values:

Relevant for functions FILES, FILESC. Maximum of 20 file expressions for EXCEPT option of ARCHIVES FILES command. Same syntax as for FILE-ARRAY.

Relevant for functions JOBVAR, JOBVARC. Maximum of 20 JV expressions for EXCEPT option of ARCHIVES JOBVAR command. Same syntax as for JOB-VARIABLE-ARRAY.

Relevant for functions FILES, FILESC, INQUIRE. Maximum of 20 file expressions, where a file expression can be a file name of a file name prefixed by THRU= or RENAME=.

Relevant for function PURGE. Specify to force purging of saved versions. Possible values:

Relevant for functions RESTORE, IMPORT, LIST. Possible values:

• LATEST

• LATEST,STATE

• SVID

• SVID,STATE,yymmdd.hhmmss

• SVID,VSN-LIST

• VSN-LIST

• yymmdd.hhmmss

• yymmdd.hhmmss,STATE

If SVID is specified, the field SAVE-ID must be specified. If VSN-LIST is specified, the VOLSER-ARRAY field must be specified.

Relevant for function INQUIRE. Possible values:

• POOL

• POOL,AVAILABLE

Relevant for functions JOBVAR, JOBVARC, INQUIRE. Maximum of 20 JV expressions, where a JV expression can be a JV name or a JV name prefixed by THRU= or RENAME=.

Relevant for functions SAVE, EXPORT, RESTORE, IMPORT, PURGE, LIST, INQUIRE. Destination for ARCHIVE report. Possible values:

• BOTH

• NONE

• SYSLST

• SYSOUT

Some functions allow the adding of ,ALL, see the ARCHIVE documentation.

Relevant for functions SAVE, EXPORT, POOL.

Relevant for functions SAVE, EXPORT, RESTORE, IMPORT, POOL, PURGE, LIST. Possible values:

Relevant for functions SAVE, EXPORT, RESTORE, IMPORT, POOL, PURGE, LIST, INQUIRE. If files or job variables are password-protected, maximum of 10 passwords. Only the first password will be used with function INQUIRE.

Relevant for function POOL. Possible values:

• ADD

• REMOVE

Relevant for functions RESTORE, IMPORT. Possible values:

Relevant for functions SAVE, EXPORT. Retention period for save version in number of days.

Relevant for function SAVE. Only for SECOS/FACS. Save ACL entries. Possible values:

Relevant for functions SAVE, EXPORT. Possible values:

Relevant for functions SAVE, EXPORT, PROCESS, DELETE. ARCHIVE Save Identifier, in case the keyword SVID was specified in field FROM-OPTION or CONTINUE.

Relevant for functions SAVE, EXPORT, RESTORE, IMPORT. Password for the SAVE run.

Relevant for functions SAVE, EXPORT. Possible values:

Relevant for functions RESTORE, IMPORT. Possible values:

Relevant for function STATUS. Type of ARCHIVE tasks for which status information is required. Possible values:

Relevant for function STATUS. Only for TSOS: user ID for which status information is required.

Relevant for functions INQUIRE and PURGE. For possible values, see the SV option of the corresponding ARCHIVE commands.

Relevant for functions SAVE, EXPORT. Block size in number of PAM pages. Maximum is 15.

Relevant for functions SAVE, EXPORT. Possible values:

Relevant for functions SAVE, EXPORT, POOL. A maximum of 10 volumes can be specified. Required also for functions RESTORE, IMPORT, UST when field FROM-OPTION=VSN-LIST.

Example

The following ARCHIVE commands are created by the example program shown below:

PARAM UNLOAD=YES

FILES NAME=(MYFILE.1,MYFILE.2,MYFILE.SHARE.),
                 NAME=(BADFILE,RENAME=NICEFILE)

EXPORT SHARE=YES,DEVICE=T-C1,LIST=BOTH,
                 TAPES=(MYTAPE)

  DEFINE DATA
              LOCAL USING ARCHIV-L
  END-DEFINE
  *
  * ---  build first part of FILES command and set PARAM options  ---
  *
  PROCESS ARCHIVE
    USING NODE           = 148
        , FUNCTION       = 'FILES'
        , PAR-UNLOAD     = 'YES'
        , FILE-ARRAY     = 'MYFILE.1'      /*  FIRST FILE
        , FILE-ARRAY     = 'MYFILE.2'      /*  SECOND FILE
        , FILE-ARRAY     = 'MYFILE.SHARE.' /*  ALL FILES STARTING  *
               WITH THIS PREFIX
  *
  IF ERROR-CODE NE 0
    WRITE ERROR-TEXT
    ESCAPE ROUTINE
  END-IF
  *
  * ---  continue FILES command  ---
  *
  PROCESS ARCHIVE
    USING NODE           = 148
        , FUNCTION       = 'FILESC'
        , FILE-ARRAY     = 'BADFILE'         /* rename this file
        , FILE-ARRAY     = 'RENAME=NICEFILE' /* .. with this name
    *
  IF ERROR-CODE NE 0
    WRITE ERROR-TEXT
    ESCAPE ROUTINE
  END-IF
  *
  * ---  build EXPORT command  ----
  *
  PROCESS ARCHIVE
    USING NODE           = 148
        , FUNCTION       = 'EXPORT'
        , LIST           = 'BOTH'
        , SHARE          = 'YES'
        , DEVICE         = 'T-C1'
        , VOLSER-ARRAY   = 'MYTAPE'
  *
  IF ERROR-CODE NE 0
    WRITE ERROR-TEXT
    ESCAPE ROUTINE
  END-IF
  *
  * ---  ready to go  ---
  *
  PROCESS ARCHIVE
    USING NODE           = 148
        , FUNCTION       = 'CLOSE'         /* execute ARCHIVE
  *
  IF ERROR-CODE NE 0
    WRITE ERROR-TEXT
    ESCAPE ROUTINE
  END-IF
  END