Overview of the HSMS statements

Selecting and outputting files from catalogs and archives

SHOW-ARCHIVE

Output the files, job variables, save files, save versions and volumes in HSMS or ARCHIVE directories

Action statements available to all users

ARCHIVE-FILES

Save files and job variables in a long-term archive

ARCHIVE-NODE-FILES

Save node files in a long-term archive

BACKUP-FILES

Save files and job variables in a backup archive

BACKUP-FILE-VERSIONS

Save files in a version backup archive

BACKUP-NODE-FILES

Save node files in a backup archive

COPY-EXPORT-SAVE-FILE

Copy a save file created by means of the action statement EXPORT-FILES or the EXPORT statement of software product ARCHIVE

COPY-NODE-SAVE-FILE

Copy a node save file and the save versions of an HSMS archive it contains

COPY-SAVE-FILE

Copy a save file and the save versions of an HSMS archive it contains

EXPORT-FILES

Export files, job variables and catalog entries

IMPORT-FILES

Import files, job variables and catalog entries

LIST-SAVE-FILE

List the contents of disk safe files that were created with HSMS/ARCHIVE

LIST-VOLUMES

List the contents of volumes that were created with HSMS/ARCHIVE

MIGRATE-FILES

Move files to a default system migration archive

MOVE-SAVE-FILES

Move save files or node save files from a backup archive

RECALL-MIGRATED-FILES

Recall migrated files to processing level S0

RESTORE-FILES

Restore files and job variables from an HSMS archive

RESTORE-LIBRARY-ELEMENTS

Restore elements of a library file from an HSMS archive

RESTORE-NODE-FILES

Restore node files from an HSMS archive

SELECT-FILE-NAMES

Select the file names from pubset catalogs or archive directories for use in a subsequent action statement

SELECT-JV-NAMES

Select the job variable names from pubset catalogs or archive directories for use in a subsequent action statement

SELECT-NODE-FILES

Select the file names from archive directories for use in a subsequent action statement

UPDATE-EXPORT-SAVE-FILE

Update a save file created with the action statement EXPORT-FILES, using a selected online data set

Statements for HSMS request management

DELETE-REQUESTS

Delete completed or interrupted requests from the request file.
The HSMS administrator and users with TSOS privileges can also delete requests which have the status “STARTED”.

RESTART-REQUESTS

Restart interrupted requests from the request file

SHOW-REQUESTS

Output the requests in the request file

HSMS statements available to archive owners for archive management

CREATE-ARCHIVE

Create an HSMS archive and define its attributes

DELETE-ARCHIVE

Delete an HSMS archive definition

MODIFY-ARCHIVE

Modify a directory, delete save files and add/remove volumes

MODIFY-ARCHIVE-ATTRIBUTES

Modify the attributes of an HSMS archive

MOVE-SAVE-FILES

Move save files or node save files from a backup archive

SHOW-ARCHIVE

Output the files, job variables, save files, save versions and volumes in HSMS archive directories or ARCHIVE directory files

SHOW-ARCHIVE-ATTRIBUTES

Output the attributes of an HSMS archive

Privileged HSMS statements for the HSMS administrator

Action statements available to HSMS administrator only

REORGANIZE-VERSION-BACKUP

Reorganization of version backup archives

Statements for controlling HSMS operation

CHECK-CATALOGED-FILES

Check cataloged files in version backup archives

CREATE-MANAGEMENT-CLASS

Define a management class in an SM pubset that is under HSMS control

CREATE-SM-PUBSET-PARAMETERS

       Place SM pubset under HSMS management and assign certain parameter values

DELETE-MANAGEMENT-CLASS

Delete a management class in an SM pubset that is under HSMS control

MODIFY-HSMS-PARAMETERS

Define and modify the global HSMS control parameters

MODIFY-MANAGEMENT-CLASS

Modify the attribute values contained in a management class

MODIFY-NODE-PARAMETERS

Place a node S0 under HSMS management and modify the pubset parameters

MODIFY-PUBSET-PARAMETERS

Place a SF pubset under HSMS management and modify the pubset parameters

MODIFY-SM-PUBSET-PARAMETERS

Modify the specific control parameters of an SM pubset

MODIFY-TAPE-CONTROL

Modify the tape control parameters, in particular for tape session control

RECOVER-REQUESTS

Recover requests after a host crash

SHOW-HSMS-PARAMETERS

Output the current or permanent HSMS control parameters

SHOW-MANAGEMENT-CLASS

Output the attribute values of a management class

SHOW-NODE-PARAMETERS

Output the parameters of the nodes under HSMS management

SHOW-PUBSET-PARAMETERS

Output the parameters of the pubsets under HSMS management

SHOW-PUBSET-USAGE

Output information on pubset utilization and occupancy

SHOW-SM-PUBSET-PARAMETERS

Output the permanent or current, specific control parameters of an SM pubset

SHOW-TAPE-CONTROL

Output the current or permanent parameter values for tape session control and the number of requests waiting to be processed

HSMS statements for correcting errors in the migration area

REPAIR-CATALOG-BY-EXCHANGE

Correct inconsistencies in migrated files using EXCHANGE

REPAIR-CATALOG-BY-RESTORE

Correct inconsistencies in migrated files using RESTORE

REPLACE-SAVE-FILE-BY-EXCHANGE

Replace a save file in the migration archive using EXCHANGE

REPLACE-SAVE-FILE-BY-RESTORE

Replace a save file in the migration archive using RESTORE

Privileged HSMS statements for the subsystem administrator

START-HSMS

Load HSMS and define the global parameters for the HSMS session

STOP-HSMS

Terminate the HSMS session and unload HSMS

SDF standard statements

END

Terminate the HSMS run

EXECUTE-SYSTEM-CMD

Execute a system command during the HSMS run

HELP-MSG-INFORMATION

Display message texts

HOLD-PROGRAM

Stop the HSMS run

MODIFY-SDF-OPTIONS

Activate or deactivate the user syntax file and modify the SDF parameter settings

REMARK

Identify a text as a comment

RESET-INPUT-DEFAULTS

Delete task-specific default values

RESTORE-SDF-INPUT

Output operands and operand values of the last accepted statement

SHOW-INPUT-DEFAULTS

Output task-specific default values

SHOW-INPUT-HISTORY

Display the contents of the input buffer

SHOW-SDF-OPTIONS

Output the SDF parameter settings

SHOW-STMT

Output the syntax of a statement of the program currently loaded

STEP

Define a restart point in procedures (will be rejected in dialog jobs)

WRITE-TEXT

Write a text to SYSOUT or SYSLST

With the exception of END, the standard SDF statements are not described in the present manual. Users are referred to the “SDF Dialog Interface” [3].

Which HSMS statements may be entered by whom?

The standard SDF statements are not listed here as they are available to all HSMS users.

HSMS statement (alias)	HSMS administrator privilege	Subsystem management privilege	Nonprivileged user
ARCHIVE-FILES (ARF)	X		E
ARCHIVE-NODE-FILES (ANF)	X		E
BACKUP-FILES (BCF)	X		E
BACKUP-FILE-VERSIONS (BFV)	X		E
BACKUP-NODE-FILES (BNF)	X		E
CHECK-CATALOGED-FILES (CCF)	X
COPY-EXPORT-SAVE-FILE (CES)	X		E
COPY-NODE-SAVE-FILE (CNF)	X		E
COPY-SAVE-FILE (CSF)	X		E
CREATE-ARCHIVE (CRA)	X		E
CREATE-MANAGEMENT-CLASS (CMC)	X
CREATE-SM-PUBSET-PARAMETERS (CSP)	X
DELETE-ARCHIVE (DLA)	X		X
DELETE-MANAGEMENT-CLASS (DMC)	X
DELETE-REQUESTS (DLR)	X		E
EXPORT-FILES (EXF)	X		E
IMPORT-FILES (IMF)	X		E
LIST-SAVE-FILE (LSF)	X		X
LIST-VOLUMES (LIV)	X		X
MIGRATE-FILES (MGF)	X		E
MODIFY-ARCHIVE (MDA)	X		X
MODIFY-ARCHIVE-ATTRIBUTES (MAA)	X		E
MODIFY-HSMS-PARAMETERS (MHP)	X
MODIFY-MANAGEMENT-CLASS (MMC)	X
MODIFY-NODE-PARAMETERS (MNP)	X
MODIFY-PUBSET-PARAMETERS (MPP)	X
MODIFY-SM-PUBSET-PARAMETERS (MSP)	X
MODIFY-TAPE-CONTROL (MTC)	X
MOVE-SAVE-FILES (MSF)	X		X
RECALL-MIGRATED-FILES (RMF)	X		E
RECOVER-REQUESTS (RER)	X
REORGANIZE-VERSION-BACKUP (RVB)	X
REPAIR-CATALOG-BY-EXCHANGE (RCE)	X
REPAIR-CATALOG-BY-RESTORE (RCR)	X
REPLACE-SAVE-FILE-BY-EXCHANGE (RFE)	X
REPLACE-SAVE-FILE-BY-RESTORE (RFR)	X
RESTART-REQUESTS (RSR)	X		E
RESTORE-FILES (RSF)	X		E
RESTORE-LIBRARY-ELEMENTS (RLE)	X		E
RESTORE-NODE-FILES (RNF)	X		E
SELECT-FILE-NAMES (SFN)	X		E
SELECT-JV-NAMES (SJN)	X		E
SELECT-NODE-FILES (SNF)	X		E
SHOW-ARCHIVE (SHA)	X		E
SHOW-ARCHIVE-ATTRIBUTES (SAA)	X		E
SHOW-HSMS-PARAMETERS (SHP)	X
SHOW-MANAGEMENT-CLASS (SMC)	X		X
SHOW-NODE-PARAMETERS (SNP)	X
SHOW-PUBSET-PARAMETERS (SPP)	X
SHOW-PUBSET-USAGE (SPU)	X
SHOW-REQUESTS (SHR)	X		E
SHOW-SM-PUBSET-PARAMETERS (SSP)	X
SHOW-TAPE-CONTROL (STC)	X
START-HSMS (STA)		X
STOP-HSMS (STO)		X
UPDATE-EXPORT-SAVE-FILE (UES)	X		E

Key:

X E	all the statement operands are available some statement operands and operand values are not available

Strictly speaking, nonprivileged users have access to fewer operands than the HSMS administrator for virtually all statements. For example, they are generally restricted to objects under their own user ID.

Hierarchy of operands in HSMS

Overview of the operands for which either global or archive-specific default values exist; the default values can, however, be modified for individual requests, HSMS sessions, node S0s or pubsets.

Operands which are not included in this table are only specified at one location and have no place in any hierarchy.

HSMS statement Operand

ANF ARF

BCF BNF BFV

CNF CSF MSF RVB

CRA

MDA

RLE

MAA

MHP

MNP

MPP MSP

MTC

RMF MGF CCF

RCR RFR

RNF RSF

STA

BLOCKING-FACTOR

X

X

A

A

COMMON-MEMORY-SIZE

H

S

DESTROY-BY-DELETE

B

B

A

A

(S2-)DEVICE-TYPE

X

X

A

A

H

EXPRESS-CONTROL

H

A

FILE-EXPIRATION-DATE

X

A

X

A

LOCATION

X

X

A

A

MULTIPLEXING

X1)

A

A

NUMBER-OF-SUBTASKS

H

S

OPERATIONAL-MODUS

H

S

OPERATOR-INTERACTION

X2)

A

X

A

X

X

OUTPUT

X

X

X

X

X

H

X

X

X

PARALLEL-RUNS

X

X2)

A

X

A

X

X

PRIMARY-ALLOCATION

X

X

A

A

READ-CONTROL

H

A

RETENTION-PERIOD

X

X2)

X2)

A

X

A

SAVE-DATA

X2)

A

A

SAVE-PLAM-INFO

X

A

A

SECONDARY-ALLOCATION

X

X

A

A

SHADOW-COPY

X

X

A

A

SYSARCHIVE

H

P

SYSBACKUP

H

P

SYSMIGRATE

H

P

SYSNODEARCHIVE

N

SYSNODEBACKUP

N

S1-PUBSET-ID

H

P

UNLOAD-TAPE

X

X

A

X

A

X

X

WRITE-CHECK

B

B

A

A

WRITE-CHECK-POINTS

X

B

A

B

A

X

B

WRITE-CONTROL

H

A

Key:

X	the operand value is valid for the current request only. (if X1) only for BNF, if X2) not valid for BFV or RVB)
A B H N P S	default values for the operand from the archive definition. the operand is not valid for HSMS statements referring to nodes. global HSMS default value for the operand. the operand value is valid for the specified node S0 only. the operand value is valid for the specified pubset only. the operand value is valid for the current HSMS session only.