HSMS / ARCHIVE V12.0 (en)

&pagelevel(4)&pagelevel

This statement is for the HSMS administrator only and is used to display the current or permanent HSMS parameters.

In addition to output to SYSOUT or SYSLST, the statement also supports structured output to an S variable.

Format (only for HSMS administrators)

SHOW-HSMS-PARAMETERS

Alias: SHP

VALID-PERIOD = SESSION / PERMANENT
,OUTPUT = NONE / list-poss(2): SYSOUT / *SYSLST
,STRUCTURE-OUTPUT = SYSINF / NONE / <composed-name 1..255>(...)
	<composed-name 1..255>(...)
		\|	WRITE-MODE = REPLACE / EXTEND

VALID-PERIOD =
Determines whether the current or permanently valid HSMS parameters are to be displayed.

VALID-PERIOD = *SESSION
The HSMS parameters valid for the current session are displayed.

VALID-PERIOD = *PERMANENT
The permanently valid HSMS parameters are displayed.

OUTPUT =
Determines the output medium for the desired information. Output generally takes place to SYSLST for batch requests.

OUTPUT = *NONE
The information is not output in text format.

OUTPUT = *SYSOUT
The information is output to the logical system file SYSOUT, i.e. it is normally displayed on the screen in interactive mode.

OUTPUT = *SYSLST
The information is output to the logical system file SYSLST. Each mask comprises 43 lines.

STRUCTURE-OUTPUT =
Controls structured output in S variables.

STRUCTURE-OUTPUT = *SYSINF
Structured output is directed to the SYSINF S variable stream.

STRUCTURE-OUTPUT = *NONE
No structured output takes place.

STRUCTURE-OUTPUT = <composed-name 1..255>(...)
Name of the S variable that is to be used for the structured output.

WRITE-MODE =
Determines whether the output should replace or complement the current content of the S variables.

WRITE-MODE = *REPLACE
The current content of the S variable is replaced by the new output.

WRITE-MODE = *EXTEND
The new output extends the current content of the S variable.

Layout of the screen masks

The output comprises 2 masks:

SHOW-HSMS-PARAMETERS (01)               VALID-PERIOD = @@@@@@@@@
--------------------------------------------------------------------------------
HSMS-ACCOUNT : @@@@@@@@                   HSMS-VERSION : @@@@@@@
                                        SAVE-FILE-PROC : @@@@@@@@@@@@@@@@
OPERATION-CONTROL
   OPERATIONAL-MODUS   : @@@@@@@@@@@      NUMBER-OF-SUBTASK   : @@
   COMMON-MEMORY-SIZE  : @@               HSMS-SV-PORT-NUMBER : @@@@@
   FILE-SIZE-DEFAULT   : @@@@@,@@@@@      FILE-SIZE-RESULT    : @@@@@,@@@@@
   MONITORING : @@@@@@@@@@@@@@@@@@@@      OUTPUT              : @@@@@@@@
                                          KEEP-REQUESTS       : @@@@@@@
DEFAULT-HSMS-STORAGE
   S1-PUBSET-ID : @@@@@@@@@@@           S2-DEVICE-TYPE : @@@@@@@@
   SYSMIGRATE : @@@@@@@@@@@@@@@@@@@@@@  BACKUP-SERVER  : @@@@@@@@@
   SYSBACKUP  : @@@@@@@@@@@@@@@@@@@@@@  SYSNODEBACKUP  : @@@@@@@@@@@@@@@@@@@@@@
   SYSARCHIVE : @@@@@@@@@@@@@@@@@@@@@@  SYSNODEARCHIVE : @@@@@@@@@@@@@@@@@@@@@@

MIGRATION-CONTROL
   EXCEPT-FILE      : @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
   FILE-INHIBIT     : @@@@@@@@@
   RECALL-FROM-S2   : @@@@@@@@@@@         MAXIMUM-WAIT-TIME : @@@@
   CANCEL-AT-RECALL : @@@@@@@@@@@@         BACKUP-MANDATORY : @@@@@@@@@
--------------------------------------------------------------------------------
NEXT-PAGE :    (+, -, ++, --, E)

SHOW-HSMS-PARAMETERS (02)               VALID-PERIOD = @@@@@@@@@               
--------------------------------------------------------------------------------
REQUEST-WAIT-LIMITS
   DIALOG-REQUEST-TIME : @@@@@          BATCH-REQUEST-TIME : @@@@@
   DIALOG-EXEC-TIME    : @@@@@          BATCH-EXEC-TIME    : @@@@@

DEFAULT-TAPE-CONTROL                    START-TIME     PERIOD
   READ-CONTROL    : @@@@@@@@@@@@@@@@     @@@@@@@@       @@@@
   WRITE-CONTROL   : @@@@@@@@@@@@@@@@     @@@@@@@@       @@@@
   EXPRESS-CONTROL : @@@@@@@@@@@@@@@@     @@@@@@@@       @@@@

REQUEST-PRIORITIES     READ  WRITE                        READ  WRITE
   IMPORT/EXPORT :      @@@    @@@      IMPLICIT-RECALL :  @@@
   BACKUP        :      @@@    @@@      NODEBACKUP      :  @@@    @@@
   ARCHIVAL      :      @@@    @@@      NODEARCHIVAL    :  @@@    @@@
   MIGRATION     :      @@@    @@@      SHADOW          :  @@@    @@@
   VERSIONBACKUP :      @@@    @@@


--------------------------------------------------------------------------------
NEXT-PAGE :    (+, -, ++, --, E)
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@

Key:

Column	Values	Meaning
VALID-PERIOD		Indicates which control parameters (current or permanent) were requested in the operand of the same name.
HSMS-ACCOUNT		Account number for accounting resources used by HSMS server tasks.
HSMS-VERSION		Shows the current HSMS version.
SAVE-FILE-PROC		Current mode of save file processing.
	HSMS-V9-COMP	Save files are created in the same way as in HSMS V9.0B and are completely supported by HSMS V9.0B. The functionality of HSMS introduced since V10.0A is not completely available.
	HSMS-V10-COMP	The functionality of HSMS V10.0A is completely available. Save files on public disk and Net-Storage created in this mode are not supported by lower versions.
OPERATION-CONTROL		Information block with the parameters for starting HSMS.
OPERATIONAL-MODUS		Indicates the HSMS operating mode.
	OPERATION	HSMS is run with the full range of functions.
	SIMULATION	All HSMS statements are permitted but action statements are only simulated.
	DEFINE-SHOW	Only HSMS statements which modify or output HSMS settings are permitted.
NUMBER-OF-SUBTASK		Number of HSMS server tasks
COMMON-MEMORY-SIZE		Minimum size of the HSMS common memory pool in 1-Mbyte segments
HSMS-SV-PORT-NUMBER		for compatibility reasons: port number which HSMS-SV uses
FILE-SIZE-DEFAULT		Primary and secondary allocation for internal HSMS files
FILE-SIZE-RESULT		Primary and secondary allocation for internal HSMS result files
MONITORING		Indicates monitoring in an SE Server environment.
	NONE	No requests are monitored regardless of the definition of the corresponding archive attribute or privilege of the user.
	ALL	All requests are monitored regardless of the definition of the corresponding archive attribute.
	BY-ARCHIVE-ATTRIBUTE	If monitoring is performed, all requests concerning archives with the attribute MONITORING=*STD are monitored.
	SYSHSMS-ONLY	If monitoring is performed, only the following requests are monitored: All requests concerning archives of the owner SYSHSMS. Requests that do not concern archives (EXPORT-/IMPORT-FILES), if the run is started under a user ID with the HSMS-ADMINISTRATION privilege.
OUTPUT		Indicates the default destination for report output.
	PRINTER	A report is to be directed to a printer.
	MAIL	A report is sent as an email attachment to the address which is entered in a caller's user entry. If it is not possible to send the report by email, it is printed out.
	STD-FILE	A report is output to a standard file whose name is generated automatically.
	STD-LIB	A report is output to a standard PLAM library element (type P). The name of the library and the name of the library element are generated automatically.
KEEP-REQUESTS		Indicates if old requests will be deleted at HSMS subsystem start.
	ALWAYS	All requests are kept.
	NO	All requests are deleted.
	YES	Requests older than 40 days are deleted.
	<0..32767>	Requests older than specified number of days are deleted.
DEFAULT-HSMS-STORAGE		Information block with the parameters for standard S1 pubset and standard system archives of the SF environment
S1-PUBSET-ID		ID of pubset used as the default S1 pubset
S2-DEVICE-TYPE		Default device type for backups to S2
SYSMIGRATE		Name of the default system archive for migration
SYSBACKUP		Name of the default system archive for backup
SYSARCHIVE		Name of the default system archive for archival
SYSNODEBACKUP		Name of the default system archive for the backup of nodes
SYSNODEARCHIVE		Name of the default system archive for the archival of nodes
BACKUP-SERVER		Host name of the backup server
MIGRATION-CONTROL		Information block with parameters for migration
EXCEPT-FILE		Name of the except file containing the names of files to be excluded from migration
FILE-INHIBIT		Indicates whether migration inhibits set by the user are respected.
	RESPECTED	The user's migration inhibits are respected.
	IGNORED	The user's migration inhibits are ignored.
RECALL-FROM-S2		Indicates whether the BS2000 DMS may implicitly recall migrated files from storage level S2.
	ALLOWED	Permitted in batch and dialog requests.
	BATCH-ONLY	Permitted in batch requests only.
	NOT-ALLOWED	Not permitted.
CANCEL-AT-RECALL		Displays whether cancel is permitted when a file is recalled
	ALLOWED	Cancel is allowed
	NOT-ALLOWED	Cancel is not allowed
MAXIMUM-WAIT-TIME		Specification in seconds defining how long HSMS is to wait for the user’s response
BACKUP-MANDATORY		Indicates whether the migration of files which have not yet been backed up is permitted or not.
REQUEST-WAIT-LIMITS		Information block with parameters for maximum wait times
DIALOG-REQUEST-TIME		Maximum wait time for HSMS to respond to a dialog request
BATCH-REQUEST-TIME		Maximum wait time for HSMS to respond to a batch request
DIALOG-EXEC-TIME		Maximum wait time for HSMS to complete a dialog request
BATCH-EXEC-TIME		Maximum wait time for HSMS to complete a batch request
DEFAULT-TAPE-CONTROL		Information block with parameters for tape processing
READ-CONTROL		Indicates tape sessions for read access.
	PROCESS-REQUESTS	Tape access is permitted at any time.
	HOLD-REQUESTS	Tape access is temporarily disabled.
	BY-TAPE-SESSIONS	Tape access according to preset chronological pattern defined by tape sessions.
WRITE-CONTROL		Indicates tape session for write access. Settings shown are the same as for READ-CONTROL.
EXPRESS-CONTROL		Indicates tape sessions for express requests. Settings shown are the same as for READ-CONTROL.
START-TIME		Start time of the tape session for READ, WRITE and EXPRESS-CONTROL
	IMMEDIATELY	Tape access is permitted as soon as the statement is issued or the HSMS session starts.
	<time>	Time at which tape session starts.
PERIOD		Time in minutes which is to elapse between tape sessions for READ, WRITE and EXPRESS-CONTROL
REQUEST-PRIORITIES		Information block with parameters for processing priorities of the different request types
READ		Processing priority for read requests of the request type concerned
WRITE		Processing priority for write requests of the request type concerned
IMPORT/EXPORT		Import/export requests
IMPLICIT-RECALL		Implicit recall requests (only read requests are possible here)
BACKUP		Requests for a backup archive
ARCHIVAL		Requests for a long-term archive
MIGRATION		Requests for a migration archive
NODEBACKUP		Requests for a node backup archive
NODEARCHIVAL		Requests for a node long-term archive
SHADOW		Requests for a shadow archive
VERSIONBACKUP		Requests for a version backup archive

Output in S variables

All variables are of the data type string.

Name of the S variable	Content	Footnote
var(*list).VALID-PERIOD	SESSION PERM
var(*list).HSMS-ACCOUNT	*NONE <string 1..8>
var(*list).HSMS-VERSION	<string 7..7>
var(*list).SAVE-FILE-PROCESSING	HSMS-V9-COMPATIBLE HSMS-V10-COMPATIBLE
var(*list).OPERATION-CONTR.OPERATION-MODE	OPER SIMULATION *DEFI-SHOW
var(*list).OPERATION-CONTR.NUM-OF-SUB-TASK	0..99	¹⁾
var(*list).OPERATION-CONTR.COMMON-MEM-SIZE	1..99	¹⁾
var(*list).OPERATION-CONTR.HSMS-SV-PORT-NUM	1..65535	¹⁾
var(*list).OPERATION-CONTR.PRI-ALLOC-DEFAULT	24..32767	¹⁾
var(*list).OPERATION-CONTR.SEC-ALLOC-DEFAULT	24..32767	¹⁾
var(*list).OPERATION-CONTR.PRI-ALLOC-RESULT	24..32767	¹⁾
var(*list).OPERATION-CONTR.SEC-ALLOC-RESULT	24..32767	¹⁾
var(*list).OPERATION-CONTR.MONITORING	ALL BY-ARCHIVE-ATTRIBUTE SYSHSMS-ONLY NONE
var(*list).OPERATION-CONTR.KEEP-REQUESTS	ALWAYS STD *YES 0..32767	¹⁾
var(*list).OPERATION-CONTR.OUTPUT	PRINTER MAIL STD-FILE STD-LIB
var(*list).DEF-HSMS-STOR.S1-PUBSET	*UNDEF <string 1..4>
var(*list).DEF-HSMS-STOR.S2-DEV-TYPE	<string 1..8>
var(*list).DEF-HSMS-STOR.SYSMIGRATE	*UNDEF <string 1..22>
var(*list).DEF-HSMS-STOR.SYSARCHIVE	UNDEF <string 1..22>
var(*list).DEF-HSMS-STOR.SYSBACKUP	*UNDEF <string 1..22>
var(*list).DEF-HSMS-STOR.SYSNODEARCHIVE	UNDEF <string 1..22>
var(*list).DEF-HSMS-STOR.SYSNODEBACKUP	UNDEF <string 1..22>
var(*list).DEF-HSMS-STOR.BACKUP-SERVER	NONE LOCALHOST <string 1..8>
var(*list).MIGR-CONTR.EXCEPT-F	*NONE <string 1..54>
var(*list).MIGR-CONTR.F-INHIBIT	RESPECT IGNORE
var(*list).MIGR-CONTR.RECALL-FROM-S2	ALLOW BATCH-ONLY *NOT-ALLOW
var(*list).MIGR-CONTR.CANCEL-AT-RECALL	ALLOW NOT-ALLOW
var(*list).MIGR-CONTR.MAX-WAIT-TIME	10..3600	^{1) 2)}
var(*list).MIGR-CONTR.BACKUP-MANDATORY	YES NO
var(*list).REQ-WAIT-LIM.DIALOG-REQ-TIME	0..99999	¹⁾
var(*list).REQ-WAIT-LIM.BATCH-REQ-TIME	0..99999	¹⁾
var(*list).REQ-WAIT-LIM.DIALOG-EXEC-TIME	0..99999	¹⁾
var(*list).REQ-WAIT-LIM.BATCH-EXEC-TIME	0..99999	¹⁾
var(*list).DEF-TAPE-CONTR.READ-CONTR.STA	PROC-REQ HOLD-REQ *BY-TAPE-SESSION
var(*list).DEF-TAPE-CONTR.READ-CONTR.START-TIME	*IMMED <string_1..8>	^3) 3)
var(*list).DEF-TAPE-CONTR.READ-CONTR.PERIOD	*END-OF-DAY 1..1440	^{3) 1) 3)}
var(*list).DEF-TAPE-CONTR.WRITE-CONTR.STA	PROC-REQ HOLD-REQ *BY-TAPE-SESSION
var(*list).DEF-TAPE-CONTR.WRITE-CONTR.START-TIME	*IMMED <string_1..8>	^4) 4)
var(*list).DEF-TAPE-CONTR.WRITE-CONTR.PERIOD	*END-OF-DAY 1..1400	^{4) 1) 4)}
var(*list).DEF-TAPE-CONTR.EXPRESS-CONTR.STA	PROC-REQ HOLD-REQ *BY-TAPE-SESSION
var(*list).DEF-TAPE-CONTR.EXPRESS-CONTR.START-TIME	*IMMED <string_1..8>	^5) 5)
var(*list).DEF-TAPE-CONTR.EXPRESS-CONTR.PERIOD	*END-OF-DAY 1..1440	^{5) 1) 5)}
var(*list).REQ-PRIO.IMP	1..255	¹⁾
var(*list).REQ-PRIO.EXP	1..255	¹⁾
var(*list).REQ-PRIO.IMPL-RECALL	1..255	¹⁾
var(*list).REQ-PRIO.BACKUP-READ	1..255	¹⁾
var(*list).REQ-PRIO.BACKUP-WRITE	1..255	¹⁾
var(*list).REQ-PRIO.ARCHIVAL-READ	1..255	¹⁾
var(*list).REQ-PRIO.ARCHIVAL-WRITE	1..255	¹⁾
var(*list).REQ-PRIO.MIGR-READ	1..255	¹⁾
var(*list).REQ-PRIO.MIGR-WRITE	1..255	¹⁾
var(*list).REQ-PRIO.NODEBACKUP-READ	1..255	¹⁾
var(*list).REQ-PRIO.NODEBACKUP-WRITE	1..255	¹⁾
var(*list).REQ-PRIO.NODEARCHIVAL-READ	1..255	¹⁾
var(*list).REQ-PRIO.NODEARCHIVAL-WRITE	1..255	¹⁾
var(*list).REQ-PRIO.SHADOW-READ	1..255	¹⁾
var(*list).REQ-PRIO.SHADOW-READ	1..255	¹⁾
var(*list).REQ-PRIO.VERSIONBACKUP-READ	1..255	¹⁾
var(*list).REQ-PRIO.VERSIONBACKUP-WRITE	1..255	¹⁾
var(*list).CAL-CTRL.PRIM-CN-NAME	*NONE <string_1..48>
var(*list).CAL-CTRL.PRIM-CN-IP-ADDR	*NONE <string_1..15>
var(*list).CAL-CTRL.SEC-CN-NAME	*NONE <string_1..48>
var(*list).CAL-CTRL.SEC-CN-IP-ADDR	*NONE <string_1..15>

¹⁾	The integer values are output in string format.
²⁾	Useable output only if CANCEL-AT-RECALL=*ALLOW; otherwise output with blank character string
³⁾	Useable output only if READ-CONTR.STA=*BY-TAPE-SESSION; otherwise output with blank character string
⁴⁾	Useable output only if WRITE-CONTR.STA=*BY-TAPE-SESSION; otherwise output with blank character string
⁵⁾	Useable output only if EXPRESS-CONTR.STA=*BY-TAPE-SESSION; otherwise output with blank character string

For more detailed information on S variables, refer to the manual “Commands” [5].

Your Browser is not longer supported

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

SHOW-HSMS-PARAMETERS Show HSMS parameters

Format (only for HSMS administrators)

Layout of the screen masks

Output in S variables