Your Browser is not longer supported

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

{{viewport.spaceProperty.prod}}

BACKUP-NODE-FILES Save node files of the BS2000-UFS

&pagelevel(4)&pagelevel

This statement is used for saving node files of a BS2000-UFS (POSIX) and if applicable mounted nodes S0 to a backup archive. You can choose between full backup and incremental backup. Furthermore, you can specify the storage media from and to which the data is to be written and whether the data is to be erased after backup.

In contrast to the BACKUP-FILES statement, the BACKUP-NODE-FILES statement does not offer the SAVE-DIRECTORY operand since the archive directory cannot be stored in the same save file as the node files. This is why users have to handle the backing up of the archive directory themselves, immediately following the backup of the node files, either by backing up the archive directory separately, or by initiating a BS2000 system backup.

Implicit deletion of obsolete backups can be set for BACKUP-NODE-FILES requests using archive attributes.

Note

Some of the attributes of the files and directories will be modified by the BACKUP-NODE-FILES statement, as indicated in the table below:


Object

Attribute

Date of last
access

Date of last
modification

Date of last
modification of
the inode

Other attributes

Files

unmodified

unmodified

modified

unmodified

Directories

new

unmodified

unmodified

unmodified


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

Format

BACKUP-NODE-FILES

Alias: BNF

PATH-NAMES = *OWN / *ALL*P) / *SELECTED / *FROM-FILE(...) / 





*FROM-LIBRARY-ELEMENT(...)/ *PATH-NAME(...)


*FROM-FILE(...)



|

LIST-FILE-NAME = <filename 1..54 without-gen-vers>


*FROM-LIBRARY-ELEMENT(...)



|

LIBRARY = <filename 1..54 without-gen-vers>



|

,ELEMENT = <composed-name 1..64 with-under>


*PATH-NAME(...)



|

PATH = <posix-pathname 1..1023 with-wild>



|

,NODE-ID *P) = *BS2000-UFS / *ALL / <posix-filename 1..48 with-wild> 

,EXCEPT-PATH-NAMES = *NONE / *FROM-FILE(...) / *FROM-LIBRARY-ELEMENT(...) / *PATH-NAME(...)


*FROM-FILE(...)



|

LIST-FILE-NAME = <filename 1..54 without-gen-vers>


*FROM-LIBRARY-ELEMENT(...)



|

LIBRARY = <filename 1..54 without-gen-vers>



|

,ELEMENT = <composed-name 1..64 with-under>


*PATH-NAME(...)



|

PATH = <posix-pathname 1..1023 with-wild>



|

,NODE-ID *P) = *BS2000-UFS / *ALL / <posix-filename 1..48 with-wild>

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


*SYSTEM-MANAGED(...)



|

CATALOG-ID = <cat-id>

,SELECTION-BOUNDARY = *ALL-FI LE -SYS TEMS / *SPECIFIED-PATHS / *CURRENT-FILE-SYSTEM /





*ALL-LOCAL-FILE-SYSTEMS

,SELECT-FILES = *MODIFIED-F ILES / *ALL-FILES(...) / *BY-CATALOG-MODIFICATION(...)


*ALL-FILES(...)*P)



|

FROM = *S0 / *LATEST-BACKUPS-OR-S0 / *ONLY-LATEST-BACKUPS


*BY-CATALOG-MODIFICATION(...)



|

CHANGED-AFTER = *LATEST-SAVE-VERSION-DATE / <date with-compl>(...) /



|





<integer -99999..0 days>(...)



|


<date with-compl>(...)



|



|

TIME = 00:00:00 / <time>



|


<integer -99999..0 days>(...)



|



|

TIME = 00:00:00 / <time>

,DELETE-FILES = *NO / *YES(...)


*YES(...)

PROTECTION-RESPECTED = *ALL / *NONE *P)

,ARCHIVE-NAME = *SYSNODEBACKUP *P) / <filename 1..22 without-cat-gen-vers>

,SAVE-FILE = *NEW(...) / *CONTINUE / *STD


*NEW(...)



|

RETENTION-PERIOD = *STD / <integer 0..16383 days>

,SAVE-VERSION-NAME = *NONE / <name 1..8>

,TO-STORAGE = *S2-STORAGE-LEVEL(...) / *PUBLIC-DISK(...)*P)


*S2-STOR AGE-LEVEL(...)



|

VOLUMES = *FROM-POOL / *FROM-OPERATOR / list-poss(20): <vsn 1..6>



|

,DEVICE-TYPE = *STD / <device>



|

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


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



|

PUBSET-ID = <cat-id>

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


*PARAMETERS(...)



|

REQUEST-NAME = *STD / <name 1..8>



|

,REQUEST-DESCRIPTOR = *NONE / <text 1..60>



|

,EXPRESS-REQUEST = *NO / *YES*P)



|

,CONTROL-JV= *NONE / <filename 1..54 without-gen-vers>



|

,WAIT-FOR-COMPLETION = *NO / *YES



|

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



|


*MULTIPLEXING(...)*P)



|



|

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



|



|

,MULTIPLEXING-FACTOR = *AUTO MATIC / <integer 2..4>



|

,PRE-POST-PROCESSING = *NO / *YES



|

,WRITE-CHECKPOINTS = *STD / *YES / *NO



|

,SHADOW-COPY = *ALLOW ED / *INHIBITED



|

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



|


*PARAMETERS(...)



|



|

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



|



|

,UNLOAD-TAPE = *STD / *YES / *NO



|

,PERFORMANCE-ANALYSIS = *NO / *YES(...)



|


*YES(...)



|



|

SEPARATOR = ; / <c-string 1..1>



|

,REPORT = *SUMMARY / *SAVED-FILES / *FULL / *NONE



|

,OUTPUT = *STD / *PRINTER / *NONE / *MAIL / *LIBRARY-ELEMENT(...) / <filename 1..54 without-gen-vers>



|


*LIBRARY-ELEMENT(...)



|



|

LIBRARY = <filename 1..54 without-gen-vers>



|



|

,ELEMENT = <composed-name 1..64 with-under>

*P) Privileged operand or operand value

PATH-NAMES =
Serves to specify the path names of the node files of a BS2000-UFS (POSIX) and node S0 to be backed up. Specification of this operand is mandatory.

If node files from more than one node S0 are specified and are to be saved to a default system archive, then the same default system archive must be assigned to all these node S0s. Otherwise, the HSMS statement will be rejected. To prevent this you should therefore only specify files from one node S0 for each backup request.

Only the HSMS administrator can back up node files belonging to other users.
Node files on remote node S0s can also only be backed up by the HSMS administrator

More information about path names can be found in the “HSMS Vol. 1” manual [1].

PATH-NAMES = *OWN
*OWN is equivalent to “ / ” (root), subject to the restriction that the user must be the owner of all the files.

Meaning for the HSMS administrator:
The system is to archive all node files and directories belonging to the user ID root which reside on that branch on the central BS2000-UFS which corresponds to the specified environment.

Meaning for nonprivileged users:
The system is to archive all node files belonging to the user’s own ID which reside on that branch on the central BS2000-UFS which corresponds to the specified environment.

PATH-NAMES = *ALL
This operand value is only available to the HSMS administrator.
All node files are to be backed up that reside either on the central BS2000-UFS or on a connected node S0 and which are located in the specified environment. *ALL is equivalent to “ / ”.

PATH-NAMES = *SELECTED
The path names of the node 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-NODE-FILES.
The path names to be processed must be in the specified environment.

PATH-NAMES = *FROM-FILE(...)
The path names of the node 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.
The path names to be processed must be in the specified environment.

LIST-FILE-NAME = <filename 1..54 without-gen-vers>
Path name of the list file.

PATH-NAMES = *FROM-LIBRARY-ELEMENT(...)
The path names of the node 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.

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.

PATH-NAMES = *PATH-NAME(...)
The path name of the node file to be backed up is specified directly. The node files can also be selected using wildcards.

The option of backing up the node files of other users or node files of remote node S0s is restricted to the HSMS administrator.

PATH = <posix-pathname 1..1023 with-wild>
Path name of the node file.

NODE-ID =
This operand value is only available to the HSMS administrator.
Physical location of the node file to be backed up.

NODE-ID = *BS2000-UFS
The node file resides on the local BS2000-UFS.

NODE-ID = *ALL
The local BS2000-UFS and all node S0s under HSMS management are searched for the node file.

NODE-ID = <posix-filename 1..48 with-wild>
This operand value only exists for compatibility reasons.

EXCEPT-PATH-NAMES =
Serves to specify node files that are to be excluded from backup.

EXCEPT-PATH-NAMES = *NONE
All node files specified with the PATH-NAMES operand are to be backed up. This specification is required if the restriction file is to be evaluated on the workstation.

EXCEPT-PATH-NAMES = *FROM-FILE(...)
The path names of the node 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.

LIST-FILE-NAME = <filename 1..54 without-gen-vers>
Path name of the list file.

EXCEPT-PATH-NAMES = *FROM-LIBRARY-ELEMENT(...)
The path names of the node 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.

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-PATH-NAMES = *PATH-NAME(...)
The path name of the node files to be excluded from backup is specified directly. The first character of the path name must not be a hyphen.
The node files can also be selected using wildcards.

PATH = <posix-pathname 1..1023 with-wild>
Path name of the node file.

NODE-ID =
This operand value is only available to the HSMS administrator.
Physical location of the node file to be excluded from backup.

NODE-ID = *BS2000-UFS
The node file resides on the local BS2000-UFS.

NODE-ID = *ALL
The system searches the local BS2000-UFS and all decentral node S0s under HSMS control and reside in the specified environment for the node file.

NODE-ID = <posix-filename 1..48 with-wild>
This operand value only exists for compatibility reasons.

ENVIRONMENT =
HSMS environment in which the statement is to be processed.

ENVIRONMENT = *NODE-STD
The environment is derived from either:

  • the operand PATH-NAMES=*PATH-NAME(NODE-ID) or

  • the list of node IDs which are referenced in the file using the operand PATH-NAMES=*FROM-FILE(LIST-FILE-NAME) or in the library element with the operand PATH-NAMES=*FROM-LIBRARY-ELEMENT(LIBRARY,ELEMENT) .

For a workstation, this is the environment in which the HSMS statement MODIFY-NODE-PARAMETERS is performed.

For a privileged user under BS2000-UFS it is the SINGLE-FEATURE environment; for a nonprivileged user *NODE-STD assumes the value of the environment in which the home directory of the user is defined.

If the affected node files are located in different environments the statement is rejected with message HSM0530.

ENVIRONMENT = *SINGLE-FEATURE
This statement is valid in the SF environment.

ENVIRONMENT = *SYSTEM-MANAGED(...)
This statement is valid in the specified SM pubset environment.

CATALOG-ID = <cat-id>
The catalog ID of the SM pubset for which the statement is valid.

SELECTION-BOUNDARY =
Defines which part of the node file tree is used for file name expansion.

SELECTION-BOUNDARY = *ALL-FILE-SYSTEMS
All node files and directories specified with the PATH-NAMES operand will be processed.Any node files and directories subordinated to a directory to be processed will be included in the selection.
Node files and directories will be selected from all levels of the file tree.

SELECTION-BOUNDARY = *SPECIFIED-PATHS
All node files and directories specified with the PATH-NAMES operand will be processed.For directories, only their inodes will be included. Any node files and directories subordinated to a directory to be processed will be ignored.

SELECTION-BOUNDARY = *CURRENT-FILE-SYSTEM
All node files and directories specified with the PATH-NAMES operand will be processed.Any node files and directories subordinated to a directory to be processed will be included in the selection (for node files both the inode and the data will be included, for directories only the inode).
The selection will be restricted to the current file system.

SELECTION-BOUNDARY = *ALL-LOCAL-FILE-SYSTEMS
All node files and directories specified with the PATH-NAMES operand will be processed.If one of the objects to be processed is a directory, the node files and directories which reside on the subordinate levels of the file tree are also included.
The selection is restricted to the UFS file system.

SELECT-FILES =
Serves to define the scope of the backup. In addition to a full backup or an incremental backup, backup can only be performed for files which were modified after a particular date.

SELECT-FILES = *MODIFIED-FILES
An incremental backup is to be carried out, i.e. node files will be backed up only if their current version is not yet present in the specified archive.

SELECT-FILES = *ALL-FILES(...)
A full backup is to be performed, i.e. all node files are to be completely saved. Further specifications in the FROM operand can only be made by the HSMS administrator.

FROM = *S0
All node files on storage level S0 are to be backed up, i.e. the entire backup is performed online.
This is the preset value for nonprivileged users.

FROM = *LATEST-BACKUPS-OR-S0
Modified files are to be backed up from storage level S0.
Node files that have not been modified are to be backed up from their last full or incremental backup in the current archive.

FROM = *ONLY-LATEST-BACKUPS
All files which refer to the last save version are to be backed up from their last full or incremental backup in the current archive.

SELECT-FILES = *BY-CATALOG-MODIFICATION(...)
An incremental backup is only performed on the basis of the catalog entries: only those files are backed up whose catalog entry was modified after a certain date.

As archive entries are not taken into account, this backup takes place independently of previous backups. Note that files that had not been saved before the specified date are not backed up.

For save versions created with this setting, the backup scope is displayed in the output of the SHOW-ARCHIVE statement with “CAT-F”. The save version contains only “fully saved” files and job variables; catalog entries for files that are not saved (save type CNS) are not included. Consequently the recovery of large data volumes should not be restricted to one save version, but all save versions since the last full backup should be specified.

CHANGED-AFTER =
All files are taken into account which have been modified since the specified date. With explicit date specification the modification time can be defined more precisely by specifying the time.

CHANGED-AFTER = *LATEST-SAVE-VERSION-DATE
Date and time of the last save are used, in other words all files are taken into account whose catalog entries have been modified since this save. This setting can be used if saves to this archive always incorporate the same file set and the last save was completed successfully.

CHANGED-AFTER = <date with-compl>(...)
Explicit specification of the modification date.

TIME = 00:00:00 / <time>
Time that determines the modification time specifically.

CHANGED-AFTER = <integer -99999..0 days >(...)
Explicit specification of the modification date in days relative to the current date.

TIME = 00:00:00 / <time>
Time that determines the modification time specifically.

DELETE-FILES = *NO / *YES(...)
Defines whether the backed up node files are to be deleted from the processing level after backup.

DELETE-FILES = *YES(...)
The archived node files – with the exception of the CNS files – are to be deleted from the node S0. The system administrator can restrict the deletion operation by specifying which file protection attributes of the node files are to be respected:

PROTECTION-RESPECTED = *ALL
Deletion is restricted to node files which are not write-protected.
This operand value is set automatically if a nonprivileged user specifies
DELETE-FILES=*YES.

PROTECTION-RESPECTED = *NONE
This operand value is only available to the HSMS administrator.
All node files are to be deleted, irrespective of their protection attributes.

ARCHIVE-NAME = *SYSNODEBACKUP / <filename 1..22 without-cat-gen-vers>
Name of the archive to which the node files are to be saved. The specified archive must already exist and be available for use as a backup archive for node files.

If the archive directory is protected by a password, this password must be entered by means of the ADD-PASSWORD command prior to statement entry. This also applies to HSMS administrators.

Specification of *SYSNODEBACKUP is restricted to the HSMS administrator. Nonprivileged users can access only their own archives.

SAVE-FILE =
Defines the save file to which the backed up node files are to be written.

SAVE-FILE = *NEW(...)
The backed up node files are to be written to a new save file. The following attributes for this save file can be defined here:

RETENTION-PERIOD = *STD / <integer 0..16383 days >
(Physical) retention period in days. During this period, neither the save file nor the save volume may be modified or deleted.
Unless otherwise specified, the preset value from the archive definition applies.

SAVE-FILE = *CONTINUE
The last save file created in the archive is to be continued with the current backup. It must be continued using the same storage level and the same device type.
A multiplexed save file cannot be continued with a normal (non-multiplexed) save version and vice versa since the formats of the save files are different.

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.

SAVE-VERSION-NAME = *NONE / <name 1..8>
Name of the save version generated by the backup request. This name can be used to refer to the save version for restore operations or in the HSMS statements RESTORE-NODE-FILES and SHOW-ARCHIVE. The name is extended internally by a prefix derived from the user ID (or, in the case of the HSMS administrator, by SYSHSMS). Any save version is uniquely identified by its name and an internal time stamp. Unless otherwise specified, no save version name is assigned.

TO-STORAGE =
Defines the storage level at which the node files are to be backed up. 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 node files are to be backed up to storage level S2. 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. 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 = *PUBLIC-DISK(...)
This operand value is only available to the HSMS administrator.
The files are backed up to a pubset.
In an SM pubset environment, the catalog ID must be an SM pubset.

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

OPERATION-CONTROL =
Enables the user to define certain parameters which are relevant to the execution of the backup run.

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

OPERATION-CONTROL = *PARAMETERS(...)
The parameters 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, in the case of the HSMS administrator, from SYSHSMS) and a suffix in the form of a time stamp.
Unless otherwise specified, the request name is formed by the short code “BNF#” and the TSN of the calling user task yyyy as follows: BNF#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.

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.

CONTROL-JV = *NONE / <filename 1..54 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, e.g. one involving 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”.

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 =
Number of simultaneously active backup tasks (ARCHIVE subtasks) used for this backup run.

PARALLEL-RUNS = *STD
The preset value from the archive definition applies by default if a new save file is created. If an existing save file is continued, the value specified when the save file was created is used.

PARALLEL-RUNS = <integer 1..16>
Number of simultaneously active backup tasks (ARCHIVE subtasks).
For backups, a tape device must be available for each task.
In the case of 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 operand 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 devices (the result of this division is the multiplexing factor for each device).

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

PRE-POST-PROCESSING =
Indicates whether preprocessing or postprocessing is to be activated on a remote workstation.

PRE-POST-PROCESSING = *NO
No preprocessing or postprocessing is to be activated on a remote workstation, even if this is actually defined on the workstation.

PRE-POST-PROCESSING = *YES
Preprocessing or postprocessing is to be activated on a remote workstation if this is actually defined on the workstation.

WRITE-CHECKPOINTS = *STD / *NO / *YES
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.

The operand value *YES causes checkpoints to be written at file tree levels only.

SHADOW-COPY =
Specifies whether the save version is to be automatically duplicated to a shadow archive which may have been assigned.

SHADOW-COPY = *ALLOWED
If the long-term archive in question has been assigned a shadow archive, the save version is automatically duplicated to this shadow archive after the backup run. Whether a save file is updated in the shadow archive, a new one is created like in the main archive or a new one is always created is specified by the SHADOW-CONTROL archive attribute of the main archive.

SHADOW-COPY = *INHIBITED
The save version is not automatically duplicated to a shadow archive which may have been assigned.

TAPE-CONTROL =
Defines the parameters which are relevant for backup to tape.

TAPE-CONTROL = *STD
The preset values from the definition of the archive to be used for backup apply.

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

BLOCKING-FACTOR = *STD / <integer 2..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.

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 (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 = *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.

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 node files actually saved, i.e. node files of save type CNS are not output.

REPORT = *FULL
A full report is to be output, including a list of all backed up node files, i.e. including the node 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 on 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 not, 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.

In a SM pubset environment the environment catalog ID is added to the file names if there is no environment catalog ID specified in the report file name. 

Example 1

The HSMS administrator performs a central full backup of the local BS2000-UFS.

Perform preparatory activities:

/START-HSMS
//MODIFY-NODE-PARAMETERS -  ———————————————————————————————————————————  (1) 
//   NODE-ID=*BS2000-UFS, -
//   HSMS-CONTROL=*YES(SYSNODEBACKUP=*STD)
//CREATE-ARCHIVE -  ———————————————————————————————————————————————————  (2) 
//   ARCHIVE-NAME=CENTRAL, -
//   ALLOWED-USAGE=*NODEBACKUP, -
//   USER-ACCESS=*ALL-USERS, -
//   DIRECTORY-NAME=NODEBACKUP.CENTRAL.DIR, -
//   RETENTION-PERIOD=150, -
//   S2-DEVICE-TYPE='TAPE-C1', -
//   OPERATION-CONTROL=*PARAMETERS(PARALLEL-RUNS=2)
//MODIFY-ARCHIVE -  ———————————————————————————————————————————————————  (3) 
//   ARCHIVE-NAME=CENTRAL, -
//   VOLUMES=*ADD(VOLUMES=(VOLUM1,VOLUM2,...))
//MODIFY-HSMS-PARAMETERS -  ———————————————————————————————————————————  (4) 
//   VALID-PERIOD=*PERMANENT, -
//   DEFAULT-HSMS-STORAGE=*PARAMETERS(SYSNODEBACKUP=CENTRAL)
//END

(1)

The local BS2000-UFS is placed under HSMS management. The default system archive SYSNODEBACKUP is assigned to this local UFS.

(2)

The archive CENTRAL is set up as a public archive for backing up node files with read privilege.The node files which are backed up cannot be deleted for 150 days.Magnetic tape cartridges are specified as the target volumes in order to use a robotic archive connected to the system.Two backup tasks are to execute simultaneously.

Note

In order for nonprivileged users to use the directory file, it must be shareable (USER-ACCESS=*ALL-USERS).

(3)

Magnetic tape cartridges are added to the pool of free volumes of the CENTRAL archive.

(4)

The CENTRAL archive is defined as the global default system archive for backing up node files of a BS2000-UFS (POSIX) or if applicable remote nodes S0.

Create a list of the path names which are to be backed up:

Contents of SAM file "PATH.LIST":   ————————————————————————————————————  (5) 
<bs2000-ufs path-name1>
<bs2000-ufs path-name2>
<bs2000-ufs ...>

(5)

Since only a single path name can be specified in the BACKUP-NODE-FILES statement, the HSMS administrator creates the SAM file PATH.LIST, which contains the path names of the node files to be backed up.

Start full backup:

/START-HSMS
//BACKUP-NODE-FILES -   ————————————————————————————————————————————————  (6) 
//   PATH-NAMES=*FROM-FILE(LIST-FILE-NAME=PATH.LIST), -
//   ARCHIVE-NAME=*SYSNODEBACKUP, -
//   SELECT-FILES=*ALL-FILES(FROM=*LATEST-BACKUPS-OR-S0), -   ——————————  (7) 
//   OPERATION-CONTROL=*PARAMETERS(REPORT=*FULL,OUTPUT=FULL.BACKUP)
//END

(6)

The path names of the node files which are to be backed up are read from the PATH.LIST file. A full backup is made to the default system archive *SYSNODEBACKUP.

(7)

For performance reasons, the operand LATEST-BACKUPS-OR-S0 is specified for the backup. Node files which have been modified since the last backup are backed up from the node S0; unmodified node files are copied from their last backup in the same archive.The operand LATEST-BACKUPS-OR-S0 must not be specified for the very first full backup since it is first necessary to create the backup environment.

Example 2

The HSMS administrator performs a central incremental backup of the local BS2000-UFS.

Perform preparatory activities:

The preparations are the same as those in Example 1.

Start incremental backup:

/START-HSMS
//BACKUP-NODE-FILES -  ————————————————————————————————————————————————  (1) 
//   PATH-NAMES=*FROM-FILE(LIST-FILE-NAME=PATH.LIST), -
//   SELECT-FILES=*MODIFIED-FILES, -
//   ARCHIVE-NAME=*SYSNODEBACKUP, -
//   SAVE-FILE=*NEW(RETENTION-PERIOD=14), -  ——————————————————————————  (2) 
//   OPERATION-CONTROL=*PARAMETERS(REPORT=*FULL,OUTPUT=INCREMENTAL.BACKUP)
//END

(1)

The path names of the node files which are to be backed up are read from the PATH.LIST file. All the node files which have been modified since the last backup are backed up to the default system archive *SYSNODEBACKUP.

(2)

A new save file is created; this file is protected against overwriting for 14 days. A retention period of 14 days is adequate if a full backup is made every week.