This statement performs a version backup by saving files to a version backup archive. With version backup, only differential backups are performed: only changed files are backed up. There is no logging of unmodified files (in contrast to backup archives, where unmodified files are assigned the status CNS in the log and in the archive). During the backup, the file attribute NUM-OF-BACKUP-VERS is also stored or updated in the archive for each file. It determines how many file versions should be kept for a file in the version backup archive. In the SM environment, this value is taken from the assigned management class if necessary. If a deletion date or a mark for deletion flag has already been set for a file in the archive directory and the system determines that the file exists again when it saves, these attributes are reset. The corresponding notes are output in the report.
Only system archives set up by the HSMS administrator are used for the version backup (SYSVERSION). These are assigned to specific pubsets.
For migrated files always catalog entries and data are saved.
The backup class may be used as a criterion for deciding whether a file is to be backed up. Furthermore, the user can specify the storage media from and to which the data is to be written.
Version Backup is not possible for:
- files on private disk
- FGGs
- temporary files
- JVs
- catalog entries of tape files
Version Backup is supported for:
- “normal” files on public disk and Net-Storage
- migrated files (=backup from *S2-S1-S0)
- CAT files (= files that consist of a catalog entry only but do not have extents; created by /CREATE-FILE <filename>,SUPPORT=*NONE, ISP command: /CAT or macro CATAL)
Net-Storage files are always saved with their data. SAM node files with their SAM structure.
The version backup functionality is available only from BS2000 OSD/BC V11.0B and with the HSMS global parameter setting SAVE-FILE-PROCESSING = *HSMS-V10-COMPATIBLE.
This statement has different formats for nonprivileged users and HSMS administrators. Privileged operands or operand values are marked with *P).
Format
BACKUP-FILE-VERSIONS | Alias: BFV | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
*P) Privileged operand or operand value
FILE-NAMES =
Serves to specify the files to be backed up within the sysversion archive. Specification of this operand is mandatory. The user can further restrict the selection made here by means of the operands EXCEPT-FILE-NAMES, SUPPORT and MAXIMUM-BACKUP-CLASS. Only the files with number of backup version > 0 are saved. If files have already been backed up to a version backup archive and the file attribute NUM-OF-BACKUP-VERS = 0 is then set, this value is copied to the archive directory. The files are then removed from the archive the next time the archive is reorganized.
Since version backup is possible only within system archive and the archive can be assigned only to one SF pubset at the same time, file only from one pubset must be specified. Otherwise, the statement will be rejected. The system version archive (SYSVERSION) for the backup run is determined using the Catid in the path name.
All nonprivileged users can also backup files belonging to other user IDs if they are co-owners of these files. Only SYSVERSION archives are used for the purpose.
FILE-NAMES = *SELECTED
The path names of the files to be backed up are to be taken from a list that was compiled within the same HSMS run by means of the HSMS statement SELECT-FILE-NAMES.
The files to be processed must be available in the specified environment.
FILE-NAMES = *FROM-FILE(...)
The path names of the files to be backed up are to be taken from a file. The nonprivileged caller must be owner or co-owner of this file. This list file must be a SAM file with variable-length records containing one path name per record. Only upper-case characters may be used. The list file can be created, for instance, by means of the HSMS statement SELECT-FILE-NAMES or the DMS command SHOW-FILE-ATTRIBUTES.
The files to be processed must be available in the specified environment.
LIST-FILE-NAME = <filename 1..54 without-gen-vers>
Path name of the list file.
FILE-NAMES = *FROM-LIBRARY-ELEMENT(...)
The path names of the files which are to be backed up are taken from a PLAM library element (type S). The library element contains one path name per record. Only upper-case letters may be used.
LIBRARY = <filename 1..54 without-gen-vers>
Name of the PLAM library.
ELEMENT = <composed-name 1..64 with-under>
Name of the type-S element. The element of the highest existing version is used.
FILE-NAMES = list-poss(20): <filename 1..80 without-vers-with-wild> / <partial-filename 2..79 with-wild>
The path names of the files to be backed up are specified directly. A list of up to 20 names may be specified.
The file names may be specified as fully or partially qualified names, with or without a catalog/user ID. If required, the file name is extended by the user ID of the request and the catalog ID which is taken either from the specified environment or from the default catalog ID of the user ID.
The files can alternatively be selected using wildcards. Note, however, that only the HSMS administrator may use wildcards for user ID specification because only the HSMS administrator is allowed to specify other user IDs. In the case of shared pubsets, the replacement of wildcards for catalog IDs does not refer to SF pubsets for which the home computer is the slave.
EXCEPT-FILE-NAMES =
Serves to specify files that are to be excluded from backup.
EXCEPT-FILE-NAMES = *NONE
All files specified with the FILE-NAMES operand are to be backed up.
EXCEPT-FILE-NAMES = *FROM-FILE(...)
The path names of the files to be excluded from backup are to be taken from a file. The nonprivileged caller must be owner or co-owner of this file. This list file must be a SAM file with variable-length records containing one path name per record. File names must be in uppercase characters only. The list file can be created, for instance, by means of the SELECT-FILE-NAMES statement or the DMS command SHOW-FILE-ATTRIBUTES.
LIST-FILE-NAME = <filename 1..54 without-gen-vers>
Path name of the list file.
EXCEPT-FILE-NAMES = *FROM-LIBRARY-ELEMENT(...)
The path names of the files which are not to be backed up are taken from a PLAM library element (type S). The library element contains one path name per record. Only upper-case letters may be used.
LIBRARY = <filename 1..54 without-gen-vers>
Name of the PLAM library.
ELEMENT = <composed-name 1..64 with-under>
Name of the type-S element. The element of the highest existing version is used.
EXCEPT-FILE-NAMES = list-poss(20): <filename 1..80 without-vers-with-wild> /
<partial-filename 2..79 with-wild>
The path names of the files to be excluded from backup are specified directly. A list of up to 20 names may be specified.
The first character of the file names must not be a hyphen. The file names may be specified as fully or partially qualified names, with or without a catalog/user ID. If required, the file name is extended by the user ID of the request and the catalog ID, which is either taken from the specified environment or from the default catalog ID of the user ID.
You can also use wildcard syntax to select the files.
In the case of shared pubsets, the replacement of wildcards for catalog IDs does not refer to SF pubsets for which the home computer is the slave.
ENVIRONMENT =
Defines the HSMS environment in which the HSMS statement is to be processed.
ENVIRONMENT = *STD
Meaning for privileged users: *STD is set to the value *SINGLE-FEATURE.
Meaning 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 = *SINGLE-FEATURE
The HSMS statement is valid in the SF environment.
ENVIRONMENT = *SYSTEM-MANAGED(...)
The HSMS statement is valid in the specified SM pubset environment.
CATALOG-ID = <cat-id>
Catalog ID of the SM pubset for which the HSMS statement is valid.
MANAGEMENT-CLASS =
This operand is only available to the HSMS administrator.
The objects to be processed are selected in accordance with the management class assigned to them.
MANAGEMENT-CLASS = *NONE
The HSMS statement is processed with all specified objects to which no management class is assigned.
MANAGEMENT-CLASS = *ANY
The HSMS statement is processed irrespective of whether the objects are assigned to a management class or not. In case a file assigned to a management class, the value of number of backup versions is taken from it and written into the version backup directory. If for some reasons, for example HSMS is not started on master system of the SM pubset, information from management classes of the SM pubset cannot be received, the files assigned to the management classes are not saved and common error message is issued into the report.
MANAGEMENT-CLASS = <alphanum-name 1..8>
The HSMS statement is processed with all the specified objects to which the specified management class is assigned. The value of number of backup versions is taken from the management class and written into the version backup directory. If for some reasons, for example HSMS is not started on master system of the SM pubset, information from the management classes of the SM pubset cannot be received, the files are not saved.
SUPPORT =
The files to be saved are selected via the type of volume (public disk or Net-Storage) on which they reside.
SUPPORT = *ANY
The type of volume on which the files reside is not a selection criterion.
SUPPORT = *PUBLIC-DISK(...)
Restricts backup to files residing on the disks of a pubset or on the assigned Net-Storage. Files residing on Net-Storage volumes of NETVOL volume type are saved only on BS2000 V21.0A or higher.
STORAGE-TYPE =
Selects the storage type for public volumes.
STORAGE-TYPE = *ANY
The files are saved irrespective of the storage type. They can reside on the disks of a pubset or on Net-Storage.
STORAGE-TYPE = *PUBLIC-SPACE
Only files which reside on the disks of a pubset are saved. Files on Net-Storage are ignored.
STORAGE-TYPE = *NET-STORAGE(...)
Only files which reside on Net-Storage volumes are saved.
VOLUMES = *ALL / list-poss(150): <vsn 1..6>
Specifies the Net-Storage volume on which the files to be saved reside. If more than one Net-Storage is assigned to the pubset, the Net-Storage volumes from which files are to be saved can be specified in a list. *ALL selects all Net-Storage volumes which are assigned to the specified pubsets.
FILE-TYPE =
Selects the file type of Net-Storage files that will be saved.
FILE-TYPE = *ANY
The Net-Storage files are selected irrespective of the file type.
FILE-TYPE = *BS2000
Only Net-Storage files of the type BS2000 are selected.
FILE-TYPE = *NODE-FILE
Only Net-Storage files of the type node file are selected.
MAXIMUM-BACKUP-CLASS = *STD / *A / *B / *C / *D / *E
Only the files whose backup class is equal or inferior to the backup class specified here are to be backed up. *E saves files of all backup classes.
Meaning of *STD:
If a new save file is created, the default value set for ARCHIVE is used (see the “ARCHIVE” manual [2], SAVE statement).
If a save file is continued, it is continued with the same backup class with which it was created. Save files which can only contain one save version (save files on disks) can only be continued with the same backup class with which they were created.
SAVE-OPTIONS =
Save options can be defined during the course of this backup run.
SAVE-OPTIONS = *STD
The default values specified for each operand described below apply to the following save options.
SAVE-OPTIONS = *PARAMETERS(...)
The following save options can be modified:
SAVE-ONLINE-FILES = *NO / *YES
Determines whether or not appropriately marked database files are to be backed up even when open (online).
SAVE-DIRECTORY = *NO / *YES
This operand is only available to the HSMS administrator.
Determines whether the archive directory used for this run is written to the backup volume as the last file in the run.
If the archive directory is included in the backup, its name remains unchanged even if files are renamed during backup (NEW-FILE-NAMES operand).
The VSN of the volume to which the archive directory was saved is listed in the report, also in a summary report (REPORT=*SUMMARY).
SAVE-PLAM-INFO = *STD / *NO / *YES
Determines whether information about the element structure should also be written to the save volume when PLAM library files are saved. Only with this additional information can elements of a library file be restored with the RESTORE-LIBRARY-ELEMENTS statement. If this information is not contained on the save volume, a library can only be restored as a complete library file.
The library files saved with the element structure are listed in the full report (REPORT=*FULL) of the save type FULB or PARB (see also SHOW-ARCHIVE output in section "SHOW-ARCHIVE Show archive directory").
Note
The element structure of migrated PLAM libraries cannot be saved.
SAVE-FILE =
Defines the save file to which the backed up files are to be written.
SAVE-FILE = *NEW
The backed up files are to be written to a new save file.
The retention period is taken from the archive definition. The save file is to be created as non-shareable. This implicitly protects the save file against access by other users who are working without HSMS.
SAVE-FILE = *CONTINUE(...)
If the specified save file to be continued is on a disk storage (public disk or Net-Storage), it is to be extended by a disjunct set of files. In such a case continuation of the save file implies extension of the save version it contains.
If such a save file is to be continued, the operands MAXIMUM-BACKUP-CLASS must have the same values as when the save file was created. Furthermore, the save file must be continued using the same storage level and the same device type.
If the specified save file is on storage level S2, a new save version is added to the save file.
Note
Despite the archive definition permits several save versions for each save file, only save files on storage level S2 can contain more than one save version.
If the last SFID/SVID is not consistent due to a DMS error the current save file cannot be continued. Therefore a new save file for this directory must be created.
It is important to bear in mind when saving to level S1, that the save files can only be continued if S1-PUBSET in SF environment or S1-VOLUME-SET in SM environment settings under which the original backup was created must be identical to the current settings under which the save file is to be continued.
SAVE-FILE-ID = *LATEST
The most recently created save file for this archive is to be continued.
SAVE-FILE-ID = <composed-name 15..15>
The specified save file is to be continued. The save file ID must be specified as follows: S.yymmdd.hhmmss
Only the last save file in the archive can be processed.
SAVE-FILE = *STD
A standard save file is to be created or continued. The (physical) retention period valid for the save file is defined in the archive definition.
This operand value may be specified only for archives that permit more than one save version per save file (see the HSMS statement CREATE-ARCHIVE, SAVE-FILE-STRUCTURE=*SEVERAL-SVID).
COMPRESS-FILES = *STD / *YES / *NO
Determines whether or not data is compressed before being written to the volume.
Unless otherwise specified, the default value in the archive definition is used. The operand is not evaluated when saving to magnetic tape cartridge as the data in this case might be compressed by the device.
TO-STORAGE =
Defines the storage level at which the files and job variables are to be backed up. Private disks and pubsets are permitted in addition to levels S1 and S2. Save files must be continued using the same storage level and the same device type as for their creation.
TO-STORAGE = *S2-STORAGE-LEVEL(...)
The files are to be backed up to storage level S2 of the specified environment. The volumes to be used can be specified. If more than one volume is specified, all volumes must be of the same device type.
VOLUMES = *FROM-POOL
The volumes are to be taken from the volume pool of the specified archive, i.e. the pool of the archive directory or the associated MAREN pool.
VOLUMES = *FROM-OPERATOR
The volumes are to be allocated by the operator on request.
VOLUMES = list-poss(20): <vsn 1..6>
List of volume serial numbers, which will be requested in the specified order.
DEVICE-TYPE = *STD / <device>
Device type of the requested volumes. The device type must belong to the class “TAPE”. Only device types known in the system are accepted. In interactive mode, DEVICE-TYPE=? calls up a list of the available device types.
Unless otherwise specified, the preset value from the archive definition applies if a new save file is created (S2-DEVICE-TYPE). If an existing save file is continued, the device type specified when the save file was created is used.
LOCATION = *STD / *ANY / <alphanum-name 1..8>
Location used for requesting volumes. This 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 in use, you must specify for LOCATION the value *ANY, or *STD if *ANY is the default location of the archive.
LOCATION = *STD
The default location of the archive is used.
LOCATION = *ANY
No location is to be used.
TO-STORAGE = *S1-STORAGE-LEVEL
This value applies in an SF pubset environment, as well as in an SM pubset environment. In an SF pubset environment, the files are stored on an S1 pubsetwhich may also be an S1-SM-pubset.
In an SM pubset environment, the files are stored on the S1 volume set. When an extended S1 level is defined for the SM pubset (S1-VOLUME-SET=*ALL-HSMS-CONTROLLED), TO-STORAGE=*S1-STORAGE-LEVEL is only accepted under the following circumstances:
SAVE-FILE-PROCESSING=*HSMS-V10-COMPATIBLE is set.
BS2000 OSD/BC V11.0 or higher is used on the system. In the case of a shared pubset network, all pubset sharers of the SM pubset must satisfy this requirement.
TO-STORAGE = *PUBLIC-DISK(...)
This operand value is only available to the HSMS administrator. This value is only valid in an SF pubset environment.
The files are backed up to a pubset.
PUBSET-ID = <cat-id>
Catalog ID of the pubset.
TO-STORAGE = *NET-STORAGE(...)
The files are backed up to Net-Storage.
VOLUMES = list-poss(16): <vsn 1..6>
Specifies the Net-Storage volume to which the files are backed up. The specified volume must be accessible.
More than one Net-Storage volume can also be specified in a list (e.g. when there is more than one save task).
CONCURRENT-COPY =
Specifies whether this function is to be activated, i.e. whether modifications can be made to files during the backup (following initialization of the Concurrent Copy session).
CONCURRENT-COPY = *NO
The Concurrent Copy function is not to be activated.
CONCURRENT-COPY = *YES(...)
The Concurrent Copy function is activated. Concurrent Copy requests are only accepted, however, if they can be processed without delay as a result of tape accesses:
If no tape processing times are defined, there are no restrictions.
If tape processing times are defined, Concurrent Copy requests are only accepted within the period in which tape accesses are possible.
All work files required for this function will be deleted prior to termination. If they cannot be deleted immediately for any reason (e.g. due to a system crash), they will be deleted automatically during IMPORT-PUBSET processing.
With shared pubsets, work files with the system ID of the host on which IMPORT-PUBSET is executed are deleted.
In shared pubset environment the backup job with CONCURRENT-COPY=*YES is always handled either on the local system or on the master system. The backup server settings are ignored if applicable.
WORK-FILE-NAME =
The user can specify whether the Concurrent Copy function is to be used to back up constantly changing resources (e.g. applications), to back up a pubset copy created using SHC-OSD. In the former case, WORK-FILE-NAME specifies the name of the work file that is to be created. This work file is used during processing to save the original contents of any files modified while backup is being performed.
If the backup process is sent to the master of a shared pubset, the work file must be accessible from the master and the slave.
WORK-FILE-NAME = *STD
The work file is assigned the following standard name:
S.DCH.<sysid>.<CC.session-id>.DATA
The work file is created on the user’s default pubset (the default pubset is defined in the user catalog).
If the ENVIRONMENT operand is set to *SYSTEM-MANAGED(...), the work file is not created on the SM pubset.
WORK-FILE-NAME = <filename 1..54 without-gen-vers>
The work file is assigned the specified name. It is not created until version backup is initiated. The work file should preferably be created on an accessible pubset with, for example, a very powerful cache system.
If an existing file is to be used as the work file, its original contents are overwritten by the Concurrent Copy processing.
When files of a shared pubset are backed up, the work file must be on a pubset that the master managing the request can access.
When files of an SM pubset are backed up, the work file should be created on the
SM pubset itself. A volume set that possesses the correct attributes can be selected prior to the HSMS statement BACKUP-FILES using a CREATE-FILE command.
A further work file is created in addition to the work file containing the modified data. The additional one contains meta data and has an internally selected name. Both work files are deleted before the end of the save run. If the files cannot be deleted, e.g. because of a system failure, they will be deleted automatically later when importing.
WORK-FILE-NAME = *BY-ADDITIONAL-UNIT(...)
This operand value is only available to the HSMS administrator.
This specification applies only for backing up a pubset copy which was created in a disk storage system using SHC-OSD. The backed up pubset copy will not be full, as the job variables and not modified files are not processed within //BACKUP-FILE-VERSIONS. To perform the version backup, mirroring of the pubset volumes is interrupted and the assigned units (additional mirror or clone units, depending on the mirroring function) are detached.
The complete SF or SM pubset is taken into account. After a pubset crash it will not be possible to reconstruct the complete SF or SM pubset from the mirrored data volumes of the original pubset and the backed up files, only the pubset copy after //BACKUP-FILES can be used.
In shared-pubset operation the pubset copy is always backed up locally as the catalog accesses take place locally on the mirror units, and moving them to the master side would not enhance the performance of the catalog accesses.
DISCARD-COPY = *YES / *NO
Specifies whether the pubset copy is to be discarded after the version backup. If the pubset copy is discarded, its units are available for another backup: mirroring is continued with these units, or in the case of clone units the assignment to the original disks is retained.
WORK-FILE-NAME = *BY-TARGET-CONTROLLER(...)
This operand value is only available to the HSMS administrator.
In the case of remote mirroring the target controller’s mirror units are used for saving. You disconnect the mirror units from the original volumes on the target controller in the same manner as the source controller’s mirror units (WORK-FILE-NAME=*BY-ADDITIONAL-UNIT).
In a shared pubset environment the version backup job with operand value *BY-TARGET-CONTROLLER is always handled locally, i.e. it is not sent to the master or a backup server if applicable.
SELECT = *BY-ADDITIONAL-UNIT
The target controller’s mirror units are used as redundant volumes for the save.
OPERATION-CONTROL =
Enables the user to define certain parameters which are relevant to the execution of the version backup run.
OPERATION-CONTROL = *STD
The default values of the operands described below apply.
OPERATION-CONTROL = *PARAMETERS(...)
The operands controlling the backup run can be modified as follows:
REQUEST-NAME = *STD / <name 1..8>
Request name that can be used in the HSMS request management statements (DELETE-REQUESTS, RESTART-REQUESTS and SHOW-REQUESTS) to refer to this request. The name is extended internally by a prefix derived from the user ID (or SYSHSMS for the HSMS administrator) and a suffix in the form of a time stamp. Unless otherwise specified, the request name is formed by the short code “BFV#” and the TSN of the calling user task yyyy as follows: BFV#yyyy.
REQUEST-DESCRIPTOR = *NONE / <text 1..60>
It is possible to enter any text that describes the request in more detail.
This text is displayed at the operator console when the request is started. The text can be output using the HSMS statement SHOW-REQUESTS.
CONTROL-JV = *NONE / <filename 1..80 without-gen-vers>
Specifies the name of a job variable that HSMS supplies with various values corresponding to important actions performed by HSMS/ARCHIVE during a complex processing operation, for this version of HSMS this only applies to complex operations, for example the processing of shadow archives.
The nonprivileged caller must be owner or co-owner of this job variable. The user issuing the request can query the job variable to obtain an overview of the current processing status. How to use the job variable is described in detail in the “HSMS Vol. 1” manual [1] in the section “Job variable for request monitoring”.
EXPRESS-REQUEST = *NO / *YES
This operand is only available to the HSMS administrator.
Determines whether tape access is to take place during the sessions defined for express requests.
WAIT-FOR-COMPLETION = *NO / *YES
Specifies whether the user wishes to wait until processing of his or her request has been completed (synchronous processing) or whether control is to be returned to the user after the validity of the HSMS statement has been checked (asynchronous processing). The maximum wait times for batch tasks and interactive tasks are different and are determined by preset global HSMS parameters.
Interactive tasks are permitted to carry out synchronous statement processing during tape sessions only.
PARALLEL-RUNS = *STD / <integer 1..16>
This operand is only significant if you are working at storage level S2. It specifies the number of save tasks (ARCHIVE subtasks) running in parallel.
PARALLEL-RUNS = *STD
The preset value from the archive definition applies if a new save file is created.
PARALLEL-RUNS = <integer 1..16>
Number of save tasks (ARCHIVE subtasks) running simultaneously.
There must be one tape device available for each task.
WRITE-CHECKPOINTS = *STD / *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 interruption (state INTERRUPTED).
Unless otherwise specified, the preset value from the archive definition applies.
TAPE-CONTROL =
Defines the parameters which are relevant for version backup to tape.
TAPE-CONTROL = *STD
The preset values from the definition of the version backup archive to be used for backup apply.
TAPE-CONTROL = *PARAMETERS(...)
The operands relevant for backup to tape can be modified as follows:
UNLOAD-TAPE = *STD / *NO / *YES
Specifies whether or not tapes are to be unloaded after processing.
The preset value from the archive definition applies unless otherwise specified.
It is possible that HSMS will ignore the value of this operand in order to avoid irrational tape processing, for example to avoid unloading a tape several times while rewinding it.
DISK-CONTROL =
Defines the parameters which are relevant for version backup to disk.
DISK-CONTROL = *STD
The preset values from the definition of the version backup archive to be used for version backup apply.
DISK-CONTROL = *PARAMETERS(...)
The operands relevant for version backup 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 preset value from the archive definition applies.
SECONDARY-ALLOCATION = *STD / <integer 0..32767 2Kbyte>
Size in PAM pages of the secondary allocation for save file extension on disk (see the description of the CREATE-FILE command in the “Commands” manual [5]).
Unless otherwise specified (*STD), the preset value from the archive definition applies.
Values from 1 through 35 are not permitted.
WRITE-CHECK = *STD / *NO / *YES
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.
Unless otherwise specified, the preset value from the archive definition applies.
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.
Unless otherwise specified, the preset value from the archive definition applies.
PERFORMANCE-ANALYSIS =
Specifies whether a statistics file is to be produced for each ARCHIVE subtask. ARCHIVE writes a new line to this statistics file:
when it opens a save file ARCHIVE.SAVE.FILE.
when it closes this save file.
whenever it begins saving or restoring a new file.
every 2 seconds while it is saving/restoring.
This gives a detailed overview of the ARCHIVE activities taking place during the save and restore operations.
PERFORMANCE-ANALYSIS = *NO
No statistics file is to be produced.
PERFORMANCE-ANALYSIS = *YES(...)
A statistics file is to be produced for each ARCHIVE subtask.
SEPARATOR = ; / <c-string 1..1>
Character that is inserted between the different fields in the statistics files. This enables programs such as EXCEL or LOTUS to differentiate the different fields.The default value is “ ; ”. This corresponds to the EXCEL default setting.
REPORT =
Serves to define whether a report is to be output for this backup request and to determine the scope of this report.
REPORT = *SUMMARY
A summary of the results of the backup request, including any error messages, is to be output.
REPORT = *SAVED-FILES
A full report is to be output, including a list of the files actually saved, i.e. files of save type CNS are not output.
REPORT = *FULL
A full report is to be output, including a list of all backed up files, i.e. including the files which were cataloged but not saved (save type CNS).
REPORT = *NONE
No report is to be output.
OUTPUT =
Specifies where the report is to be output.
OUTPUT = *STD
The output destination of the report is determined by the default value that is defined by the global HSMS parameter OUTPUT.
OUTPUT = *PRINTER
The report for this backup request is to be printed.
OUTPUT = *NONE
No report is output. Nevertheless the report is available as a pdf file via the SE manager application Backup Monitoring, if the monitoring is activated in the global HSMS parameters.
OUTPUT = *MAIL
The report for this backup request is sent as an email attachment to the address which is entered in the caller’s user entry. If it is not possible to send the report by email, it is printed out.
OUTPUT = *LIBRARY-ELEMENT(...)
The report for this backup request is edited and output to the specified PLAM library element (type P). If this is not possible, the report is printed out.
LIBRARY = <filename 1..54 without-gen-vers>
Name of the PLAM library.
ELEMENT = <composed-name 1..64 with-under>
Name of the element. A type P element is created with a version which contains the user ID plus the date and time.
OUTPUT = <filename 1..54 without-gen-vers>
The report for this backup request is be edited and written to the specified file.If the file already exists, the following applies:
if it is a non-empty SAM file, it is continued
if it is not a SAM file, the report is printed.
For nonprivileged callers the report files must be under the user’s own user ID. If not, co-ownership is a prerequisite.