This statement is used for modifying the attributes of an HSMS archive. The archive type cannot be modified. An archive directory cannot be used for a different basic HSMS function unless the original archive definition is deleted and the directory is assigned to a new archive.
Only HSMS administrators or the archive owner may modify attributes of an archive.
This statement has different formats for nonprivileged users and HSMS administrators. Privileged operands or operand values are marked with *P).
Format
MODIFY-ARCHIVE-ATTRIBUTES | Alias: MAA | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
*P) Privileged operand or operand value
ARCHIVE-NAME = <filename 1..22 without-cat-gen-vers>
Name of the archive whose attributes are to be modified.
Only the HSMS administrator or the archive owner may modify attributes of an archive. The option of specifying an owner ID other than one’s own is restricted to the HSMS administrator.
ENVIRONMENT =
Determines the HSMS environment in which the specified archive is located.
ENVIRONMENT = *STD
The archive is 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 located in the default environment for node archives:
For privileged users: *NODE-STD is set to the value *SINGLE-FEATURE.
For nonprivileged users: *NODE-STD is set to the value for the environment in which the home directory of the user is defined.
ENVIRONMENT = *SINGLE-FEATURE
The archive is in the SF pubset environment
ENVIRONMENT = *SYSTEM-MANAGED(...)
The archive is in the specified SM pubset environment.
CATALOG-ID = <cat-id>
Catalog ID of the SM pubset to which the HSMS statement applies.
OWNER-FIELD = *UNCHANGED / *NONE / <c-string 1..54>
Field to which the user may write a remark concerning the archive. The remark is output by SHOW-ARCHIVE-ATTRIBUTES INFORMATION=*FULL.
OWNER-FIELD = *NONE
Serves to delete a remark previously written to this field.
USER-ACCESS = *UNCHANGED / *OWNER-ONLY / *ALL-USERS(...)
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.
USER-ACCESS = *OWNER-ONLY
Access is to be restricted to the archive owner and the HSMS administrator.
Access by other users is only posssible if they are co-owners of the assigned directory.
USER-ACCESS = *ALL-USERS(...)
Access is also permitted to other users provided they are in the same environment as the archive:
ACCESS = *READ
Other users are to be granted read access to the archive. In other words: the archive is assigned the attribute “read access”. Write authorization for other users becomes possible through co-ownership of the assigned directory.
ACCESS = *WRITE
Other users are to be granted read and write access to the archive. In other words: the archive is assigned the attribute “write access”.
ACCESS-FROM-NODE = *UNCHANGED / *NONE / *PARAMETERS(...)
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 = *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 = *UNCHANGED / *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 = *UNCHANGED / *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-CATID = *UNCHANGED / <cat-id>
Specifies the catalog ID of the pubset on which the archive directory is stored. The name of the archive directory must always be retained (e.g. after the pubset is renamed).
The catalog ID of the archive directory is required, for example, when the pubset was renamed using PVSREN. If MAREN is used, in this case the system administrator must change the catalog ID of the archive directory in the relevant volume entries of the MAREN catalog.
Note that after changing the CATID, existing save files cannot be continued (SAVE-FILE=*CONTINUE or SAVE-FILE=*STD if saving to the standard save file is active). Instead, a new save file must be created with the operand SAVE-FILE=*NEW.
RETENTION-PERIOD = *UNCHANGED / *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 directory.
For version backup archives it is recommended to synchronize the retention period with the frequency of reorganization.
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 volume(s) are assigned the state OBSOLETE.
RETENTION-PERIOD = *FROM-ORIGINAL-SAVE-FILE
A save file which is copied to a shadow archive or another archive is assigned the retention period of the original save file. This setting is used in the COPY statement both for automatic duplication during a backup or archival request and for explicit duplication without specification of a retention period. If in the case of direct backup no retention period is specified, the value 0 is derived from this archive attribute.
SAVE-FILE-STRUCTURE = *UNCHANGED / *SEVERAL-SVID
For backup archives only:
The archive owner and the HSMS administrator can redefine a backup archive that permits no more than one save version per save file (*SINGLE-SVID) as a backup archive that permits more than one save version per save file (*SEVERAL-SVID).
FILE-EXPIRATION-DATE = *UNCHANGED / *RESTRICTED / *UNRESTRICTED
This operand is only available to the HSMS administrator.
Only for long-term archives:
defines whether or not the file expiration date which the user can specify in an archival request for the files to be archived has to lie within the (physical) retention period defined for the save file.
This operand is ignored for shadow archives. The value is always *UNRESTRICTED.
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.
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 =
Specifies whether the expiration date of the save file is to be changed automatically.
For shadow archives this operand is ignored and the value SAVE-FILE-RETPD-UPD=*YES is always assumed.
SAVE-FILE-RETPD-UPD = *UNCHANGED
The expiration date of the save file remains unchanged.
SAVE-FILE-RETPD-UPD = *NO
The expiration date of the save file is not 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 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 should have been recognized as deleted in order that it can be marked for deletion with //MODIFY-ARCHIVE. If it is not specified by an administrator: 180 days is the standard value (*STD).
The archive attribute is applicable only for version backup archives. For all other types any specification will be ignored.
COMPRESS-FILES = *UNCHANGED / *NO / *YES / *S1-ONLY
Determines whether or not the data is compressed before being written to the output volume.
For shadow archives this operand is ignored and the value specified for the original archive is used.
For node archives this operand is also ignored and the value is automatically set to *NO.
COMPRESS-FILES = *S1-ONLY
The data is compressed only when written to storage level S1. However, it is not decompressed when the save file is copied from S1 to S2.
S2-DEVICE-TYPE = *UNCHANGED / *STD / <device>
Default device type to be used for saving to this archive at storage level S2. The tape device type must belong to the “TAPE” class.Only device types known in the system are accepted. In interactive mode, DEVICE-TYPE=? calls up a list of the available device types.
The operand value *STD means that the value is taken from the HSMS control file.
LOCATION = *UNCHANGED / *ANY / <alphanum-name 1..8>
Default location used for selecting the volumes for saving to this archive on 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 in use, you must specify the value *ANY for LOCATION.
LOCATION = *ANY
No location is used for selecting the volumes.
BACKUP-SERVER-USAGE = *UNCHANGED / *NO / *STD
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) which will process the request is selected according to the specification in the BACKUP-SERVER operand of the MODIFY-HSMS-PARAMETERS statement.
MONITORING = *UNCHANGED / *NO / *STD
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 backup archives.
This operand defines save options.
SAVE-OPTIONS = *UNCHANGED
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 files or both the catalog entries and the data are to be saved.
For shadow archives this operand is ignored and the value that was specified for the original archive is used.
For version backup archives the value SAVE-DATA = *S2-S1-S0 is forced irrespectively of the specifications.
SAVE-DATA = *UNCHANGED
The last value selected remains valid.
SAVE-DATA = *S0
Only the files on S0 are to be saved with their data. For migrated files, only the metadata is to be saved.
SAVE-DATA = *S1-S0
Only the files on S0 and files migrated to S1 are to be saved with their data.
For files migrated to S2, only the metadata is to be saved.
SAVE-DATA = *S2-S1-S0
All files are saved with their data, regardless of whether they have been migrated or not.
SAVE-PLAM-INFO = *UNCHANGED / *NO / *YES
When saving PLAM libraries, this setting determines whether information about the element structure should also be written to the save volume. Only with this additional information can individual elements of a library 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.
This operand is only valid if the archive was created as a long-term, backup or version backup archive for BS2000 files (//CREATE-ARCHIVE with ALLOWED-USAGE=*ARCHIVAL or *BACKUP or *VERSIONBACKUP).
OPERATION-CONTROL = *UNCHANGED / *PARAMETERS(...)
A number of parameters which are relevant for HSMS operation can be defined and preset by the archive definition.
OPERATION-CONTROL = *PARAMETERS(...)
The operands 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 = <integer 1..16>
Number of simultaneously active backup tasks (ARCHIVE subtasks).
A tape device must be available for each task.
In the case of duplication or automatic duplication to a shadow archive, two tape devices must be available for each task.
No multiplexing is performed.
PARALLEL-RUNS = *MULTIPLEXING(...)
This operand 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 = *UNCHANGED
The number of devices available for the backup run remains unchanged.
NUMBER-OF-DEVICES = <integer 1..16>
Number of devices available for the backup run.
MULTIPLEXING-FACTOR = *UNCHANGED / *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 = *UNCHANGED / *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 (INTERRUPTED state).
When archiving nodes, specification of *YES causes checkpoints to be written at file tree levels only
OPERATOR-INTERACTION = *UNCHANGED / *NOT-ALLOWED / *ALLOWED
Determines whether messages requiring an operator response are to be output to 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 = *UNCHANGED / *NO / *OBSOLETE-SAVE-FILES /
*OBSOLETE-SAVE-VERSIONS
Only for long-term and backup archives.
When backing up or copying determines whether obsolete 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 or a copy operation is executed by the archive owner. The standard save file is not deleted implicitly.
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 of the associated save file 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.
In the case of backup archives save versions are normally only obsolete in conjunction with the associated save file.
SHADOW-CONTROL = *UNCHANGED / *PARAMETERS(...)
This operand only applies to archives that are linked with a shadow archive.
SHADOW-CONTROL = *PARAMETERS(...)
The parameters for the assigned shadow archive can be modified as follows:
SHADOW-COPY = *UNCHANGED / *ALLOWED / *ALLOWED-AND-NEW-SFID / *INHIBITED
The owner of an archive can control the automatic duplication of save files to the assigned shadow archive.
SHADOW-COPY = *ALLOWED
Each backup or archival to an archive initiates automatic duplication to the assigned shadow archive, unless SHADOW-COPY=*INHIBITED was specified in the save/backup statement (*SHADOW-COPY operand in the HSMS statements ARCHIVE-FILES, ARCHIVE-NODE-FILES, BACKUP-FILES and BACKUP-NODE-FILES).
When an archive is created, the value of SHADOW-COPY is set to *ALLOWED by default.
SHADOW-COPY = *ALLOWED-AND-NEW-SFID
If SHADOW-COPY=*INHIBIT was not specified in the save/backup statement each backup to a backup or backup node archive starts automatic duplication to the associated shadow archive, a new save file always being generated in the shadow archive, i.e. also when updating takes place in the main archive. In the context of a disaster protection strategy this permits the volumes generated to be stored externally immediately after the backup.
This setting becomes effective when SHADOW-COPY=*ALLOWED is specified in the save/backup statements ARCHIVE-FILES, ARCHIVE-NODE-FILES, BACKUP-FILES, BACKUP-NODE-FILES and MOVE-SAVE-FILES.
SHADOW-COPY = *INHIBITED
There is no automatic duplication to the assigned shadow archive.
TAPE-CONTROL = *UNCHANGED / *PARAMETERS(...)
The parameters which are relevant for writing to tape can be defined and preset by the archive definition.
TAPE-CONTROL = *PARAMETERS(...)
The operands relevant for writing to tape can be modified as follows:
NEW-STD-SAVE-FILE = UNCHANGED / *EACH-TAPE-SESSION / *AT-EACH-REQUEST /
*IN-PERIODS(...) / *PUBLIC-DISK(...)
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 provided 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.
For shadow archives this operand is ignored and the value that was defined for the original archive is used instead.
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 = *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 = *IN-PERIODS(...)
The standard save file is changed at the beginning of each continuation period. It is 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 attribute 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 can be issued.
PUBSET-ID = <cat-id>
Catalog ID of the pubset.
BLOCKING-FACTOR = *UNCHANGED / *STD / <integer 15..15 2Kbyte> / *MAX
Blocking factor to be used for writing the save file to tape, specified as the number of 2-Kbyte blocks (PAM pages) written to tape in a single input/output operation. As the higher blocking factor means that the occupancy level of the volume and the tape processing performance improve, values below 15 should not be selected.
When the default value *STD is selected, the default values of the ARCHIVE parameters apply (BLOCK-SIZE-TAPE for tapes, BLOCK-SIZE-T-C for magnetic tape cartridges).
*MAX selects the maximum blocking factor possible in the current BS2000 version. Currently this is the value 128.
UNLOAD-TAPE = *UNCHANGED / *YES / *NO
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 processing of tapes, for example to avoid unloading a tape several times while rewinding it.
DISK-CONTROL = *UNCHANGED / *PARAMETERS(...)
The parameters which are relevant for writing to disk can be defined and preset by the archive definition.
This operand is only useful for backup and migration archives, since both archival and duplication to shadow archives are possible on storage level S2 only.
DISK-CONTROL = *PARAMETERS(...)
The operands relevant for writing to disk can be modified as follows:
PRIMARY-ALLOCATION = *UNCHANGED / *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]).
The operand value *STD means that the ARCHIVE default value applies.
SECONDARY-ALLOCATION = *UNCHANGED / *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]).
The operand value *STD means that the ARCHIVE default value applies. Values from 1 through 35 are not permitted.
WRITE-CHECK = *UNCHANGED / *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 = *UNCHANGED / *STD / *YES / *NO
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.
If no specification is made, the presetting is taken from the archive definition.
In an SM pubset environment, *STD means that for the deletion 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 = *UNCHANGED / *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 = *UNCHANGED
The processing priority is not changed.
REQUEST-PRIORITIES = *STD
The default values for read and write requests in this archive type 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 = *UNCHANGED
The processing priority for read requests is not changed.
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= *UNCHANGED
The processing priority for write requests is not changed.
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.