Your Browser is not longer supported

Please use Google Chrome, Mozilla Firefox or Microsoft Edge to view the page correctly
Loading...

{{viewport.spaceProperty.prod}}

CREATE-ARCHIVE Create archive

&pagelevel(4)&pagelevel

This statement is used for creating an HSMS archive and defining its attributes. CREATE-ARCHIVE defines the archive type and optionally the protection attributes, if any. In addition, default values can be defined for the processing of requests referring to this archive and for writing to storage levels S1 and S2.

This statement has different formats for nonprivileged users and HSMS administrators. Privileged operands or operand values are marked with *P). 

Format

CREATE-ARCHIVE

Alias: CRA

ARCHIVE-NAME = <filename 1..22 without-cat-gen-vers>

,ENVIRONMENT = *STD / *NODE-STD / *SINGLE-FEATURE / *SYSTEM-MANAGED(...)


*SYSTEM-MANAGED(...)



|

CATALOG-ID = <cat-id>

,OWNER-FIELD = *NONE / <c-string 1..54>

,ALLOWED-USAGE = *BACKUP(...) / *ARCHIVAL / *NODEBACKUP / *NODEARCHIVAL /





*MIGRATION*P) / *SHADOW(...)*P) / *VERSIONBACKUP*P)


*BACKUP(...)



|

SAVE-FILE-STRUCTURE = *SEVERAL-SVID / *SINGLE-SVID


*SHADOW(...)*P)



|

ORIGINAL-ARCHIVE = <filename 1..22 without-cat-gen-vers>

,USER-ACCESS = *OWNER-ONLY / *ALL-USERS(...)


*ALL-USERS(...)



|

ACCESS = *READ / *WRITE

,ACCESS-FROM-NODE*P) = *STD / *NONE / *PARAMETERS(...)


*PARAMETERS(...)



|

NORMAL-USER = *NONE / *READ / *WRITE / *SAME



|

ADMINISTRATOR = *NONE / *READ / *WRITE / *SAME 

,DIRECTORY-NAME = <filename 1..54 without-gen-vers>(...)


<filename 1..54 without-gen-vers>(...)



|

NEW-DIRECTORY = *YES / *NO(...)



|


*NO(...)



|



|

RECONSTRUCT-ARCHIVE = *NO / *YES

,RETENTION-PERIOD = *FROM-ORIGINAL-SAVE-FILE / <integer 0..16383 days>

,FILE-EXPIRATION-DATE*P) = *RESTRICTED / *UNRESTRICTED(...)


*UNRESTRICTED(...)



|

SAVE-FILE-RETPD-UPD = *NO / *YES

,SECURE-PERIOD = *STD / <integer 0..32767 days>

,COMPRESS-FILES = *NO / *YES / *S1-ONLY

,S2-DEVICE-TYPE = *STD / <c-string 1..8>

,LOCATION = *ANY / <alphanum-name 1..8>

,BACKUP-SERVER-USAGE = *NO / *STD

,MONITORING = *NO / *STD

,SAVE-OPTIONS = *STD / *PARAMETERS(...)


*PARAMETERS(...)



|

SAVE-DATA = *S0 / *S1-S0 / *S2-S1-S0



|

,SAVE-PLAM-INFO = *NO / *YES

,OPERATION-CONTROL = *STD / *PARAMETERS(...)


*PARAMETERS(...)



|

PARALLEL-RUNS = 1 / <integer 1..16> / *MULTIPLEXING(...)*P)



|


*MULTIPLEXING(...)*P)



|



|

NUMBER-OF-DEVICES = 1 / <integer 1..16>



|



|

,MULTIPLEXING-FACTOR = *AUTOMATIC / <integer 2..14>



|

,WRITE-CHECKPOINTS = *YES / *NO



|

,OPERATOR-INTERACTION = *NOT-ALLOWED / *ALLOWED



|

,AUTOMATIC-DELETION = *NO / *OBSOLETE-SAVE-FILES / *OBSOLETE-SAVE-VERSIONS

,TAPE-CONTROL = *STD / *PARAMETERS(...)


*PARAMETERS(...)



|

NEW-STD-SAVE-FILE = *AT-EACH-REQUEST / *EACH-TAPE-SESSION / *IN-PERIODS(...) /



|




*PUBLIC-DISK(...)*P)



|


*IN-PERIODS(...)



|



|

CONTINUATION-PERIOD = <integer 1..32767 days>



|


*PUBLIC-DISK(...)*P)



|



|

PUBSET-ID = <cat-id>



|

,BLOCKING-FACTOR = *STD / <integer 2..15 2Kbyte> / *MAX



|

,UNLOAD-TAPE = *NO / *YES

,DISK-CONTROL = *STD / *PARAMETERS(...)


*PARAMETERS(...)



|

PRIMARY-ALLOCATION = *STD / <integer 36..50331645 2Kbyte>



|

,SECONDARY-ALLOCATION = *STD / <integer 0..32767 2Kbyte>



|

,WRITE-CHECK = *NO / *YES / *SAVE-FILES / *RESTORED-FILES



|

,DESTROY-BY-DELETE = *STD / *NO / *YES

,REQUEST-PRIORITIES*P) = *STD / *PARAMETERS(...)


*PARAMETERS(...)



|

READ = *STD / <integer 1..255>



|

,WRITE = *STD / <integer 1..255>

*P) Privileged operand or operand value

ARCHIVE-NAME = <filename 1..22 without-cat-gen-vers>
Name of the archive to be created in the specified environment.
The same format is used as for file names without a catalog ID. Note, however, that the name without the owner ID must not exceed a length of 12 characters.
The default owner ID is either identical with the user ID of the archive owner creating the archive or, for the HSMS administrator, SYSHSMS. The option of specifying an owner ID other than one’s own is restricted to the HSMS administrator.

ENVIRONMENT =
Defines the HSMS environment in which the archive is to be defined. This HSMS environment must be used in all HSMS statements for this archive. (Two archives in different environments can have the same name.)

ENVIRONMENT = *STD
The archive is to be defined in the default environment for DMS archives:

  • For privileged users: *STD is set to the value *SINGLE-FEATURE.

  • For nonprivileged users: *STD is the environment that is associated with the user’s default pubset (the default pubset is defined in the user catalog).

ENVIRONMENT = *NODE-STD
The archive is to be defined in the default environment for node files:

  • For privileged users: *NODE-STD is set to the value *SINGLE-FEATURE.

  • For nonprivileged users: *NODE-STD is set to the value of the environment in which the home directory of the user is defined.

ENVIRONMENT = *SINGLE-FEATURE
The archive is defined in the SF pubset environment.

ENVIRONMENT = *SYSTEM-MANAGED(...)
The archive is defined in the specified SM pubset environment.

CATALOG-ID = <cat-id>
Catalog ID of the SM pubset to which the HSMS statement applies.

OWNER-FIELD = *NONE / <c-string 1..54>
Field to which the user may write a remark concerning the archive to be created. The remark is output in response to the HSMS statement SHOW-ARCHIVE-ATTRIBUTES INFORMATION=*ALL.
Unless otherwise specified, no remark is written.

ALLOWED-USAGE =
Defines the archive type, i.e. the basic HSMS function for which the archive is to be used.

ALLOWED-USAGE = *BACKUP(...)
The archive is to be used exclusively as a backup archive for BS2000 files.
Use as an archive of any other type is prohibited.

SAVE-FILE-STRUCTURE = *SEVERAL-SVID
Each save file of this archive at storage level S2 may contain more than one save version and can therefore be updated with a further backup.

SAVE-FILE-STRUCTURE = *SINGLE-SVID
Each save file of this archive may contain no more than one save version and can therefore not be updated with a new save version.

ALLOWED-USAGE = *ARCHIVAL
The archive is to be used exclusively as a long-term archive for BS2000 files.
Use as an archive of any other type is prohibited.

ALLOWED-USAGE = *NODEBACKUP
The archive is to be used exclusively as a backup archive for node files of a BS2000-UFS (POSIX) or node S0.
Use as an archive of any other type is prohibited.

ALLOWED-USAGE = *NODEARCHIVAL
The archive is to be used exclusively as a long-term archive for node files of a BS2000-UFS (POSIX) or node S0.
Use as an archive of any other type is prohibited.

ALLOWED-USAGE = *MIGRATION
This operand value is only available to the HSMS administrator.
The archive is to be used exclusively as a migration archive for BS2000 files.
Use as an archive of any other type is prohibited.

ALLOWED-USAGE = *SHADOW(...)
This operand value is only available to the HSMS administrator.
The archive is to be used exclusively as a shadow archive for a backup or long-term archive.

ORIGINAL-ARCHIVE = <filename 1..22 without-cat-gen-vers>
Name of the archive to be linked with this shadow archive. The archive must be an existing backup or long-term archive. It must not be already linked with a shadow archive and must belong to the owner of the shadow archive to be created.

ALLOWED-USAGE = *VERSIONBACKUP
This operand value is only available to the HSMS administrator.
The archive is to be used exclusively as a version backup archive for BS2000 files.
Use as an archive of any other type is prohibited.

Version backup archives are always created with the attributes SAVE-FILE-STRUCTURE=*SEVERAL-SVID.

USER-ACCESS =
Regulates access to the archive.

For a shadow archive this operand only regulates direct access to the shadow archive. The permission for automatic duplication to a shadow archive depends entirely on the access permission to the associated backup or long-term archive.

In addition, co-owners can use (not manage) the archive at the archive directory like the archive owner.

USER-ACCESS = *OWNER-ONLY
Access is to be restricted to the archive owner. Other users who have co-ownership of the archive or of the directory also have access.

USER-ACCESS = *ALL-USERS(...)
Access is to be granted to other users as well. The access mode can be specified more precisely.

ACCESS = *READ
Other users are to be granted read access to the archive. In other words: the archive is assigned the protection attribute “read access”.

ACCESS = *WRITE
Other users are to be granted read and write access to the archive. In other words: the archive is assigned the protection attribute “write access”.

ACCESS-FROM-NODE =
This operand is only available to the HSMS administrator and is supported for compatibility reasons only.
Controls archive access for remote node calls.

This operand is only of relevance for node archives which are assigned to a remote node as a system archive for archival or backup (see the HSMS statement MODIFY-NODE-PARAMETERS in section "MODIFY-NODE-PARAMETERS Modify parameters of node S0").

ACCESS-FROM-NODE = *STD
Same meaning as NORMAL-USER=*SAME and ADMINISTRATOR=*WRITE.
This default value guarantees compatibility with earlier HSMS versions (HSMS versions< 4.0A).

ACCESS-FROM-NODE = *NONE
Remote access is not possible. Neither remote users nor administrators of remote nodes are permitted to back up their files in archive or to restore or list them.

ACCESS-FROM-NODE = *PARAMETERS(...)
Access is permitted as defined in the following operands:

NORMAL-USER = *NONE / *READ / *WRITE / *SAME
Defines archive access for remote node users.

*SAME means that normal BS2000 user access is permitted (see also the USER-ACCESS operand and associated ACCESS suboperand in this statement).

ADMINISTRATOR = *NONE / *READ / *WRITE / *SAME
Defines additional access permissions for administrators of remote nodes.

*SAME means that normal BS2000 user access is permitted (see also the USER-ACCESS operand and associated ACCESS suboperand in this statement).

A node administrator possesses at least the same access permissions as a nonprivileged user (ACCESS operand). Consequently, this operand cannot be used to restrict or cancel a node administrator’s access permissions.

The definition of “administrator” depends on the operating system running at the node.

DIRECTORY-NAME = <filename 1..54 without-gen-vers>(...)
Path name of the archive directory. If no user ID is specified, the name is extended by the user ID of the caller. The option of specifying a user ID other than one’s own is restricted to the HSMS administrator.

If the archive is to be defined in an SM pubset environment

  • and no catalog ID is specified, the path name is extended by the catalog ID of the corresponding SM pubset.

  • the name of the archive directory must similarly be located on the SM pubset.

If the archive is to be defined in an SF pubset environment

  • and no catalog ID is specified, the path name is extended by the default catalog ID of the user (the default catalog ID is defined in the user catalog).

  • the archive directory must be located on an SF pubset for the nonprivileged user.

    NEW-DIRECTORY = *YES
    HSMS is to create a new archive directory.

    If an archive is created in an SM pubset environment, the directory file is created on the SM pubset.

    NEW-DIRECTORY = *NO(...)
    An existing directory (e.g. an ARCHIVE directory file) is to be placed under HSMS management.
    An ARCHIVE directory file cannot be placed under HSMS management unless it supports catalog IDs (see the note at the end of the operand description of this statement).

    It is not possible to use an archive directory for BS2000 files and job variables instead of an archive directory for node files, and vice versa.

    If an existing archive directory is used for an archive that was declared on an SM pubset, HSMS checks whether

    • the archive directory refers only to files and job variables located on this pubset.

    • backup was made to any disks that do not belong to this pubset.

    This check is pointless for node archives.

    If the archive directory was previously used by another archive, that archive must first be deleted.

    RECONSTRUCT-ARCHIVE = *NO
    The attributes for the archive to be created are taken from the CREATE-ARCHIVE statement.

    RECONSTRUCT-ARCHIVE = *YES
    Restore of an archive together with its attributes is performed from a directory that has already been used. For this purpose as of HSMS V8.0 the archive attributes for //CREATE-ARCHIVE or //MODIFY-ARCHIVE-ATTRIBUTES are also saved in the directory.

    Only the archive name and the HSMS environment are transferred from the specifiecations in the CREATE-ARCHIVE statement. The other specifications are ignored and instead the attributes from the directory are used. If the directory can be restored from backup tapes in the event of a disk failure the associated archive can now also be restored from this.

    When the archive attributes are restored from a directoy that was used in a shadow archive the ALLOWED-USAGE attribute from an earlier main archive is used (i.e. not *SHADOW).

RETENTION-PERIOD = *FROM-ORIGINAL-SAVE-FILE / <integer 0..16383 days>
(Physical) retention period in days which applies to the save files of the archive unless otherwise specified.
The expiration date derived from the specified retention period is recorded both on the volume and in the archive directory. The expiration date for standard save files (NEW-STD-SAVE-FILE) is calculated as follows:

expiration date = creation date + retention period [+ continuation period]

Once the expiration date has been reached, the save file and the save volumes are assigned the state “OBSOLETE”.

RETENTION-PERIOD = *FROM-ORIGINAL-SAVE-FILE
A save file which is copied into a shadow archive or another archive is assigned the retention period of the original save file. This setting is used both for automatic duplication during a backup or archival request and for explicit duplication with the HSMS statement COPY-SAVE-FILE.

FILE-EXPIRATION-DATE =
This operand is only available to the HSMS administrator.
For long-term archives only:
Defines whether or not the file expiration date which the user can specify in an archival request for the files to be archived must lie within the (physical) retention period defined for the save file or save volume.

For shadow archives which are connected to a long-term archive the specified value is ignored and FILE-EXPIRATION-DATE=*UNRESTRICTED is always assumed.

FILE-EXPIRATION-DATE = *RESTRICTED
The file expiration date of the files to be archived must lie within the retention period defined for the save file or save volume.

FILE-EXPIRATION-DATE = *UNRESTRICTED(...)
No restriction on the file expiration date is defined. In this case, it is the archive owner’s responsibility to take appropriate administrative measures to protect the volumes against overwriting once the physical retention period has expired.

SAVE-FILE-RETPD-UPD = *NO / *YES
Specifies whether the expiration date of the save file is to be changed automatically.

For shadow archives which are connected to a long-term archive the specified value is ignored and SAVE-FILE-RETPD-UPD=*YES is always assumed.

SAVE-FILE-RETPD-UPD = *NO
The expiration date of the save file is not to be changed automatically.

SAVE-FILE-RETPD-UPD = *YES
If a new save file or a save file to be continued contains a save version whose expiration date is later than that of the associated save file, the save file is automatically given the same expiration date as the save version.

If the expiration date of a save version becomes later than that of the associated save file, the retention period of the save file is automatically increased.

SECURE-PERIOD = *STD / <integer 0..32767 days>
The default value for the minimum time that a file deleted from processing level is protected against deletion from the archive, i.e. before it can be marked for deletion with //MODIFY-ARCHIVE. The standard value is 180 days (*STD). Files that have been flagged for deletion are removed from the archive during a reorganization run.

The archive attribute makes sense only for version backup archives. For all other types any specification will be ignored.

COMPRESS-FILES = *NO / *YES / *S1-ONLY
Determines whether or not data is compressed before being written to the output volume.

This operand is ignored for backups to S2 and the compression in the MTC drive is always used.

This operand is ignored for shadow archives. Instead, the value defined for the original archive is used.

This operand is ignored for node archives. The value *NO is used by default.

COMPRESS-FILES = *S1-ONLY
The data is compressed by the software only when written to storage level S1.

S2-DEVICE-TYPE = *STD / <c-string 1..8>
Default device type to be used for saving to this archive at storage level S2. The tape device type must belong to the class “TAPE”.
Unless otherwise specified, the value is taken from the HSMS control file.

LOCATION = *ANY / <alphanum-name 1..8>
Default location used for selecting the volumes for saving to this archive at storage level S2. The specified location must be known to MAREN. If the location manager is in use, the location should be properly defined in MARENLM. Otherwise MAREN ignores the specified value.

If MAREN is not used, you must specify the value *ANY for LOCATION.

LOCATION = *ANY
No location is used to select the volumes.

BACKUP-SERVER-USAGE =
Specifies whether the backup server can be used to process requests.

BACKUP-SERVER-USAGE = *NO
No backup server will be used.

BACKUP-SERVER-USAGE = *STD
The system (local or backup server) that will process the request is selected according to the specification in the BACKUP-SERVER operand of the MODIFY-HSMS-PARAMETERS statement.

MONITORING =
Controls the monitoring in an SE Server environment. If monitoring is enabled, HSMS reports every creation, deletion or update of a request to the Management Unit.

MONITORING = *NO
No requests concerning the archive will be monitored unless MONITORING=*ALL is set with the MODIFY-HSMS-PARAMETERS statement or unless the user is SYSHSMS and MONITORING=*SYSHSMS-ONLY is set with MODIFY-HSMS-PARAMETERS.

MONITORING = *STD
The requests concerning the archive will be monitored according to the MONITORING operand of the MODIFY-HSMS-PARAMETERS statement.

SAVE-OPTIONS =
Only for long-term and backup archives.
This operand defines the possible save options.

SAVE-OPTIONS = *STD
Specifies that the standard save options are to be used.

SAVE-OPTIONS = *PARAMETERS(...)
The following non-standard save options can be selected:

SAVE-DATA =
Specifies whether just the catalog entries of migrated BS2000 files or the catalog entries and the data are to be saved.

This operand is ignored for shadow archives. Instead, the value defined for the original archive is used.

SAVE-DATA = *S0
Only the files on S0 are to be saved with their data. For migrated BS2000 files, only the metadata is to be saved.

SAVE-DATA = *S1-S0
Only the files on S0 and BS2000 files migrated to S1 are to be saved with their data.For BS2000 files migrated to S2, only the metadata is to be saved.

SAVE-DATA = *S2-S1-S0
All BS2000 files are saved with their data, regardless of whether or not they have been migrated.

SAVE-PLAM-INFO = *NO / *YES
This operand is only valid for long-term and backup archives of BS2000 files (see the ALLOWED-USAGE=*ARCHIVAL/*BACKUP operand).
Determines whether information on the element structure should also be written to the save volume when PLAM library files are saved. Only with this additional information can individual elements of a library file be restored with the RESTORE-LIBRARY-ELEMENTS statement. If this information is not on the save volume, a library can only be restored as a complete library file.

OPERATION-CONTROL =
A number of parameters which are relevant to HSMS operation can be defined and preset by the archive definition.

OPERATION-CONTROL = *STD
The default values of the operands described below apply.

OPERATION-CONTROL = *PARAMETERS(...)
The parameters controlling HSMS operation can be modified as follows:

PARALLEL-RUNS =
Number of simultaneously active backup tasks (ARCHIVE subtasks) used for this backup run.

PARALLEL-RUNS = 1 / <integer 1..16>
Number of simultaneously active backup tasks (ARCHIVE subtasks).
When performing backups, a tape device must be available for each task.
In the case of duplication automatic duplication to a shadow archive, two tape devices must be available for each task.

No multiplexing is performed.

PARALLEL-RUNS = *MULTIPLEXING(...)
This operand value is only available to the HSMS administrator.
This specification is only relevant for operations at the S2 storage level.
Multiplexing operation is enabled in order to achieve improved performance. In this case, multiple ARCHIVE subtasks share the same device.

NUMBER-OF-DEVICES = 1 / <integer 1..16>
Number of devices available for the backup run.

MULTIPLEXING-FACTOR = *AUTOMATIC / <integer 2..4>
Specifies a multiplexing factor for each device, i.e. the number of archive subtasks that are generated for each device.

If *AUTOMATIC is specified, ARCHIVE calculates the multiplexing factor itself, i.e. ARCHIVE distributes the specified paths to the drives (the result of this division is the multiplexing factor for each drive).

For more information on parallel processing, refer to the “HSMS Vol. 1” manual.

WRITE-CHECKPOINTS = *YES / *NO
Defines whether any checkpoints are to be written to the ARCHIVE checkpoint file during processing; these checkpoints permit a request to be restarted following an interrupt (state INTERRUPTED).

When archiving nodes, specification of *YES causes checkpoints to be written at file tree levels only.

OPERATOR-INTERACTION = *NOT-ALLOWED / *ALLOWED
Determines whether messages requiring an operator response are to be output at the console (*ALLOWED) or not (*NOT-ALLOWED). If *NOT-ALLOWED applies, HSMS performs default handling (see the description of the PARAM statement in the “ARCHIVE” manual [2]).

AUTOMATIC-DELETION = *NO / *OBSOLETE-SAVE-FILES / *OBSOLETE-SAVE-VERSIONS
Only for long-term and backup archives.
When backing up or copying determines whether save files or save versions are to be released automatically after their retention period has expired. The release of the volume is also connected with the automatic release. A prerequisite here is that a retention period is assigned.

AUTOMATIC-DELETION = *NO
Save files or save versions can only be deleted explicitly (see MODIFY-ARCHIVE).

AUTOMATIC-DELETION = *OBSOLETE-SAVE-FILES
Obsolete save files are deleted and the associated volumes are released implicitly before a backup of a copy operation is executed by the archive owner. The standard save file is not deleted implicitly. The volumes released when deletion takes place can be used again immediately for backup.

AUTOMATIC-DELETION = *OBSOLETE-SAVE-VERSIONS
In the event of backups or copy operations by the archive owner obsolete save versions are deleted beforehand and the volumes which are then no longer needed are released. In the event of backups or copy operations with update the latest save version of the save file to be updated is always retained.

TAPE-CONTROL =
The parameters which are relevant for writing to tape can be defined and preset by the archive definition.

TAPE-CONTROL = *STD
The default values of the operands described below apply.

TAPE-CONTROL = *PARAMETERS(...)
The operands relevant for writing to tape can be modified as follows:

NEW-STD-SAVE-FILE =
Defines when a new standard save file is to be started for the archive.
This operand is irrelevant for backup archives that permit no more than one save version per save file (SAVE-FILE-STRUCTURE=*SINGLE-SVID).

Requests for migration to S2 always write to the standard save file.
Archival requests write to the standard save file only if no other save file is specified.
Backup requests do not write to the standard save file unless it is explicitly specified.

The standard save file is defined by the operands NEW-STD-SAVE-FILE, S2-DEVICE-TYPE and RETENTION-PERIOD.

This operand is ignored for shadow archives. Instead, the value defined for the original archive is used.

NEW-STD-SAVE-FILE = *AT-EACH-REQUEST
A new standard save file is to be started with each new save version.
This means that each save version is written to a separate save file.

NEW-STD-SAVE-FILE = *EACH-TAPE-SESSION
A new standard save file is to be started at the beginning of each tape session. It is updated (“continued”) until the end of the tape session.
This means that, during a tape session, all save versions are written to the same save file unless otherwise specified.

NEW-STD-SAVE-FILE = *IN-PERIODS(...)
The standard save file is changed at the beginning of each continuation period. It is updated (“continued”) until the end of the continuation period.
All save versions are written to this save file during this period unless otherwise specified.

CONTINUATION-PERIOD = <integer 1..32767 days>
Continuation period in days.

NEW-STD-SAVE-FILE = *PUBLIC-DISK(...)
This operand value is only possible for backup node archives and is only available to the HSMS administrator.
A //BACKUP-NODE-FILE with SAVE-FILE=*STD specified is modified using the archive attributes to SAVE-FILE=*NEW and TO-STORAGE=*PUBLIC-DISK with the pubset specification corresponding to the archive attribute. In this way requests for disk backups on disk can be issued by specifying the standard save file.

PUBSET-ID = <cat-id>
Catalog ID of the pubset.

BLOCKING-FACTOR = *STD / <integer 2..15 2Kbyte> / *MAX
Blocking factor to be used for writing the save file to tape.
The default value *STD selects the blocking factor from the archive definition.
If this also contains the default value, the default values of the ARCHIVE parameters apply (SYSPAR.ARCHIVE.vvv: BLOCK-SIZE-TAPE for tapes, BLOCK-SIZE-T-C for magnetic tape cartridges).
For performance reasons it is recommended to write blocks with maximum size to tape.
This will be achieved already by using the default values. In the case of magnetic tape cartridges this is a blocking factor of 128 (256k per block)
The values 2 to 15 should not be used anymore and are supported for compatibility reasons only.
*MAX selects the maximum blocking factor possible in the current BS2000 version independent of the settings in the archive and the ARCHIVE parameters. Currently this is the value 128.

UNLOAD-TAPE = *NO / *YES
Specifies whether or not tapes are to be unloaded after processing.

It is possible that HSMS will ignore the value of this operand in order to avoid irrational tape processing, for example to avoid unloading the tape several times while rewinding the tape.

DISK-CONTROL =
The parameters which are relevant for writing to disk can be defined and preset by the archive definition.

This operand is meaningful for backup and migration archives for BS2000 files only, since backups of node files, the archival function, and duplication to shadow archives are only possible on storage level S2.

DISK-CONTROL = *STD
The default values of the operands described below apply.

DISK-CONTROL = *PARAMETERS(...)
The operands relevant for writing to disk can be modified as follows:

PRIMARY-ALLOCATION = *STD / <integer 36..50331645 2Kbyte>
Size in PAM pages of the primary allocation for save file creation on disk (see the description of the CREATE-FILE command in the “Commands” manual [5]).Unless otherwise specified, the ARCHIVE default value applies.
Values from 1 through 35 are not permitted.

SECONDARY-ALLOCATION = *STD / <integer 0..32767 2Kbyte>
Size in PAM pages of the secondary allocation for save file creation on disk (see the description of the CREATE-FILE command in the “Commands” manual [5]).

Unless otherwise specified (*STD), the ARCHIVE default value applies.

WRITE-CHECK = *NO / *YES / *SAVE-FILES / *RESTORED-FILES
Specifies whether a read-after-write check is to be performed after each write operation for error detection purposes. Note that read-after-write checking will result in longer execution times.

WRITE-CHECK = *SAVE-FILES
Restricts read-after-write checks to saved files.

WRITE-CHECK = *RESTORED-FILES
Restricts read-after-write checks to restored files.

DESTROY-BY-DELETE = *STD / *NO / *YES
Specifies whether the storage space released by save file deletion is to be erased by overwriting it with binary zeros for data privacy reasons. Note that erasure by overwriting will result in longer execution times for save file deletion.

In an SM pubset environment, *STD means that when deleting, the value is taken from the definition of the SM pubset.
In an SF pubset environment, *STD has the same meaning as *NO.

REQUEST-PRIORITIES = *STD / *PARAMETERS(...)
This operand is only available to the HSMS administrator.
Determines the processing priority of read and write requests which are issued for the specified archive.

REQUEST-PRIORITIES = *STD
The default values of the operands described below are used.

REQUEST-PRIORITIES = *PARAMETERS(...)
Determines the processing priority of requests which are issued for the specified archive.

READ =
Determines the processing priority of read requests.

READ = *STD
The default value for read requests in this archive type is used.

READ = <integer 1..255>
A different priority is assigned, with 1 having the highest priority.

WRITE =
Determines the processing priority of write requests.

WRITE= *STD
The default value for write requests in this archive type is used.

WRITE = <integer 1..255>
A different priority is assigned, with 1 having the highest priority.

Notes

  1. If ARCHIVE directory files are still to be used after switching from ARCHIVE to HSMS operation note the section "Special aspects when switching from ARCHIVE to HSMS operation“ in the manual HSMS Volume 1 Functions.

  2. For system archives, the directory file should be created on the control volume set of the SM pubset. This means that if a volume set of the SM pubset fails, it is still possible to restore files. If the directory file is located on the failed volume set, however, no files can be restored.