This statement is used to display the attributes of an HSMS archive.
All nonprivileged users can output the attributes of an archive which does not belong to them provided that the archive is shareable or the user is co-owner of the archive directory.
In addition to output to SYSOUT or SYSLST, the statement also supports structured output to an S variable.
This statement has different formats for nonprivileged users and HSMS administrators. Privileged operands or operand values are marked with *P).
Format
SHOW-ARCHIVE-ATTRIBUTES | Alias: SAA | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
*P) Privileged operand or operand value
ARCHIVE-NAME =
Specifies the archives about which information is to be displayed.
ARCHIVE-NAME = *BY-ATTRIBUTES(...)
The archives are selected in the specified environment by their attributes.
OWNER-ID =
The archives can be selected within the specified environment by their owner IDs.
OWNER-ID = *OWN
Only the archives under the user’s own owner ID are selected.
OWNER-ID = *ALL
This operand value is only available to the HSMS administrator.
The archives under all owner IDs are selected.
OWNER-ID = <name 1..8>
The archives under the specified owner ID are selected.
ALLOWED-USAGE =
You can restrict the selection of archives still further by archive type, i.e. by their allowed usage.
ALLOWED-USAGE = *ANY
The archives are selected irrespective of their usage.
ALLOWED-USAGE = *BACKUP
Only backup archives are selected.
ALLOWED-USAGE = *ARCHIVAL
Only long-term archives are selected.
ALLOWED-USAGE = *MIGRATION
Only migration archives are selected.
ALLOWED-USAGE = *NODEBACKUP
Only backup archives for node files of a BS2000-UFS (POSIX) or node S0 are selected.
ALLOWED-USAGE = *NODEARCHIVAL
Only long-term archives for node files of a BS2000-UFS (POSIX) or node S0 are selected.
ALLOWED-USAGE = *VERSIONBACKUP
Only version backup archives are selected.
ALLOWED-USAGE = *SHADOW
This operand value is only available to the HSMS administrator.
Only shadow archives for node files are selected.
ARCHIVE-NAME = <filename 1..22 without-cat-gen-vers>
Name of the archive.
ENVIRONMENT =
HSMS environment of the selected archives.
ENVIRONMENT = *STD
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
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 of the environment in which the home directory of the user is defined.
ENVIRONMENT = *SINGLE-FEATURE
SF environment.
ENVIRONMENT = *SYSTEM-MANAGED(...)
The SM pubset environment specified below.
CATALOG-ID = <cat-id>
Catalog ID of the SM pubset.
INFORMATION = *SUMMARY
The following attributes are displayed in table format for each archive:
owner ID
archive name
allowed usage of the archive
access rights
default values for the S2 device type.
Additional information on individual archives can be requested by marking the archive.Details on the content of the screen mask are provided in the section "Output with INFORMATION=*SUMMARY".
INFORMATION = *ALL
All the archive attributes are output (see also CREATE-ARCHIVE).
Details on the content of the screen mask are provided in the section "Output with INFORMATION=*ALL (comprises 2 screens) per archive)".
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 (for the variable layout see "Output in S variables").
STRUCTURE-OUTPUT = *SYSINF
Structured output is directed to the SYSINF S variable stream.
STRUCTURE-OUTPUT = *NONE
No structured output is required.
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 to be replaced by the new output.
WRITE-MODE = *EXTEND
The new output extends the current content of the S variable.
Layout of the screen masks
Output with INFORMATION=*SUMMARY
SHOW-ARCHIVE-ATTRIBUTES INFORMATION = SUMMARY ENVIRONMENT = @@@@@@@@ OWNER-ID = @@@@@@@@ ALLOWED-USAGE = @@@@@@@@@@@@ -------------------------------------------------------------------------------- M OWNER-ID ARCHIVE-NAME USAGE USER-ACCESS S2-DEVICE COMPRESS _ @@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@ @@@@@@@@ @@@@@@@ _ @@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@ @@@@@@@@ @@@@@@@ _ @@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@ @@@@@@@@ @@@@@@@ _ @@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@ @@@@@@@@ @@@@@@@ _ @@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@ @@@@@@@@ @@@@@@@ _ @@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@ @@@@@@@@ @@@@@@@ _ @@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@ @@@@@@@@ @@@@@@@ _ @@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@ @@@@@@@@ @@@@@@@ _ @@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@ @@@@@@@@ @@@@@@@ _ @@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@ @@@@@@@@ @@@@@@@ _ @@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@ @@@@@@@@ @@@@@@@ _ @@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@ @@@@@@@@ @@@@@@@ _ @@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@ @@@@@@@@ @@@@@@@ _ @@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@ @@@@@@@@ @@@@@@@ _ @@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@ @@@@@@@@ @@@@@@@ _ @@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@ @@@@@@@@ @@@@@@@ _ @@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@ @@@@@@@@ @@@@@@@ -------------------------------------------------------------------------------- NEXT-PAGE : __ (+, -, + +, - -, E) @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
Key:
Column | Values | Meaning |
M | Mark column for selecting the archives for which a detailed view with all information is to be output (the branch from a detailed mask takes place in accordance with the current assignment in the NEXT-PAGE field). | |
NEXT-PAGE | Input field for scrolling within an environment, for leaving an environment and for specifying the return address: | |
+ |
| |
- |
| |
++ |
| |
-- |
| |
E |
| |
Blank |
| |
OWNER-ID | Owner ID of the displayed archive | |
ARCHIVE-NAME | Name of the displayed archive | |
USAGE | Type of usage allowed for the archive (archive type) | |
USER-ACCESS | Right of other users to access the archive | |
OWNER-ONLY |
| |
ALL-USERS (WRITE) |
| |
ALL-USERS (READ) |
| |
S2-DEVICE | Default volume type for writing to the archive: | |
STD |
| |
COMPRESS | Compression option | |
NO |
| |
YES |
| |
S1-ONLY |
|
Output with INFORMATION=*ALL (comprises 2 screens) per archive)
SHOW-ARCHIVE-ATTRIBUTES INFORMATION = FULL ENVIRONMENT = SF OWNER-ID = OWN ALLOWED-USAGE = ANY -------------------------------------------------------------------------------- OWNER-ID ARCHIVE-NAME USAGE USER-ACCESS S2-DEVICE COMPRESS HSMS SYSHSMS ARCHY BACKUP OWNER-ONLY STD NO V025 -------------------------------------------------------------------------------- OWNER-FIELD : NONE DIRECTORY-NAME : :A:$TSOS.ARCH.DIR LINKED-ARCHIVE-NAME : SHADOW-COPY : WITH NEW SFID LOCATION : *ANY BACKUP-SERVER-USAGE : NO NORMAL-USER-ACCESS : SAME ADMINISTRATOR-ACCESS : WRITE RETENTION-PERIOD : 3 FILE-EXPIRATION-DATE : RESTRICTED SAVE-DATA : S0 SAVE-FILE-STRUCTURE : SEVERAL-SVID SAVE-PLAM-INFO : NO MONITORING : NO REQUEST-PRIORITIES : READ STD WRITE STD SECURE-PERIOD : 180 OPERATION-CONTROL: AUTOMATIC-DELETION : OBSOLETE-SFID PARALLEL-RUNS : 1 WRITE-CHECKPOINTS : YES NUMBER-OF-DEVICES : - MULTIPLEXING-FACTOR : - OPERATOR-INTERACTION : NOT-ALLOWED SAVE-FILE-RETPD-UPD : NO -------------------------------------------------------------------------------- NEXT-PAGE : + (+, -, ++, --, E)
SHOW-ARCHIVE-ATTRIBUTES INFORMATION = ALL ENVIRONMENT = @@@@@@@@ OWNER-ID = @@@@@@@@ ALLOWED-USAGE = @@@@@@@@@@@@ -------------------------------------------------------------------------------- OWNER-ID ARCHIVE-NAME USAGE USER-ACCESS S2-DEVICE COMPRESS HSMS @@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@ @@@@@@@@@@@@@@@@@ @@@@@@@@ @@@@@@@ V@@@ -------------------------------------------------------------------------------- TAPE-CONTROL: UNLOAD-TAPE : @@@ NEW-STD-SAVE-FILE : @@@@@@@@@@@@@@@@@ BLOCKING-FACTOR : @@@ STD-SAVE-FILE : @@@@@@@@@@@@@@@ STREAM-MODE : @@@ DISK-CONTROL: PRIMARY-ALLOCATION : @@@@@@@@ WRITE-CHECK : @@@@@@@@@@@@@@ SECONDARY-ALLOCATION : @@@@@ DESTROY-BY-DELETE : @@@ -------------------------------------------------------------------------------- NEXT-PAGE : __ (+, -, ++, --, E) @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
Key:
Column | Values | Meaning |
OWNER-ID | Owner ID of the displayed archive | |
ARCHIVE-NAME | Name of the displayed archive | |
USAGE | Type of usage allowed for the archive (archive type) | |
USER-ACCESS | Right of other users to access the archive | |
OWNER-ONLY |
| |
ALL-USERS (WRITE) |
| |
ALL-USERS (READ) |
| |
S2-DEVICE | Default volume type for writing to the archive | |
STD |
| |
COMPRESS | Compression option | |
NO |
| |
YES |
| |
S1-ONLY |
| |
HSMS | Minimum HSMS version necessary so that all possible functions can be used for this archive. If an earlier HSMS version is used, only SHOW statements can be issued; action statements will not be possible. | |
OWNER-FIELD | Remark entered when the archive was created | |
DIRECTORY-NAME | Archive directory name | |
LINKED-ARCHIVE-NAME | Name of the assigned archive | |
SHADOW-COPY | Indicates whether the save version is automatically duplicated in a shadow archive if one is assigned. | |
ALLOWED |
| |
INHIBIT |
| |
WITH-NEW-SFID |
| |
LOCATION | Storage location of the archive | |
BACKUP-SERVER-USAGE | Specifies whether the backup server will be used to process requests | |
NORMAL-USER-ACCESS | Indicates the archive access rights for a remote node user who does not possess administrator privileges. | |
ADMINISTRATOR-ACCESS | Indicates the archive access rights for the administrator of a remote node. | |
RETENTION-PERIOD | Retention period of the archive in days or | |
FILE-EXPIRATION- DATE | Logical expiration date for archived files | |
RESTRICTED |
| |
UNRESTRICTED |
| |
SECURE-PERIOD | For version backup archives only: period during which it is not possible to mark the file for deletion. A file can only be marked for deletion after this period has elapsed after the file has been deleted on the pubset. | |
SAVE-DATA | Indicates whether just the catalog entry or the catalog entry and the data are saved for migrated files. | |
S0 |
| |
S1-S0 |
| |
S2-S1-S0 |
| |
SAVE-FILE-STRUCTURE | Save file structure: | |
SINGLE-SVID |
| |
SEVERAL-SVID |
| |
SAVE-PLAM-INFO | Indicates whether or not the information about the element structure should be written to the backup volume. This additional information enables elements of a library file to be restored: | |
STD |
| |
NO |
| |
YES |
| |
MONITORING | Indicates monitoring in an SE Server environment. | |
NO |
| |
STD |
| |
REQUEST-PRIORITIES | Indicates the processing priority of read and write requests which are issued for the specified archive. | |
READ |
| |
WRITE |
| |
AUTOMATIC-DELETION | Shows whether obsolete save files are automatically (when saving or copying) deleted (for backup and long-term archives). | |
NO |
| |
OBSOLETE-SFID |
| |
OBSOLETE-SVID |
| |
PARALLEL-RUNS | Number of parallel save tasks | |
WRITE-CHECKPOINTS | Indicates whether checkpoints are written to the checkpoint file during processing. | |
YES |
| |
NO |
| |
NUMBER-OF-DEVICES | Number of devices available for a backup run. | |
MULTIPLEXING-FACTOR | Multiplexing factor per device, i.e. the number of ARCHIVE subtasks generated for this device. | |
OPERATOR-INTERACTION | Indicates whether messages requiring operator an response are displayed on the console. | |
ALLOWED |
| |
NOT-ALLOWED |
| |
SAVE-FILE-RETPD-UPD | Indicates whether the expiration date of the save file is automatically modified: | |
YES |
| |
NO |
| |
Content of the next screen: | ||
OWNER-ID | Owner ID of the displayed archive | |
ARCHIVE-NAME | Name of the displayed archive | |
USAGE | Type of usage allowed for the archive (archive type) | |
USER-ACCESS | Right of other users to access the archive | |
OWNER-ONLY |
| |
ALL-USERS (WRITE) |
| |
ALL-USERS (READ) |
| |
S2-DEVICE | Default volume type for writing to the archive | |
STD | HSMS/other volume type from the control file | |
COMPRESS | Compression option | |
NO |
| |
YES |
| |
S1-ONLY |
| |
HSMS | Minimum HSMS version necessary so that all possible functions can be used for this archive. If an earlier HSMS version is used, only SHOW statements can be issued; action statements will not be possible. | |
UNLOAD-TAPE | Indicates whether a magnetic tape is to be unloaded when processing has finished: | |
YES |
| |
NO |
| |
NEW-STD-SAVE-FILE | Indicates when the archive's standard save file is to be changed: | |
AT-EACH-REQUEST |
| |
EACH-TAPE-SESSION |
| |
IN-PERIODS |
| |
PUBLIC-DISK(<catid>) |
| |
BLOCKING-FACTOR | Blocking factor used to write to the save file to the magnetic tape. The value specified is the number of 2Kbyte blocks (PAM pages) which can be written to the magnetic tape in a single I/O operation. | |
STD-SAVE-FILE | Identification for the standard save file | |
STREAM-MODE | Indicates whether the data is written to the magnetic tape in streaming mode: | |
YES |
| |
NO |
| |
PRIMARY-ALLOCATION | Size in PAM pages of the primary allocation for the creation of save files on the hard disk | |
WRITE-CHECK | Indicates whether a write check is to be carried out after each write operation in order to detect errors: | |
YES |
| |
NO |
| |
SAVE-FILES |
| |
RESTORED-FILES |
| |
SECONDARY-ALLOCATION | Size in PAM pages of the secondary allocation for the expansion of save files on the hard disk | |
DESTROY-BY-DELETE | Indicates whether the storage space released when a save file is deleted is overwritten with binary zeros: | |
YES |
| |
NO |
|
Output in S variables
All variables are of the data type string.
Name of the S variable | Content | Footnote |
var(*list).ARCHIVE-NAME | <string 1..22> | |
var(*list).USAGE | *BACKUP | |
var(*list).USER-ACCESS | *OWNER-ONLY | |
var(*list).S2-DEV-TYPE | *STD | |
var(*list).COMPRESS | *YES | |
var(*list).MIN-HSMS-VERSION | <string 3..3> | 2) |
var(*list).OWNER-FIELD | *NONE | 2) |
var(*list).SAVE-F-STRUCT | *SINGLE-SVID | 2) |
var(*list).DIR-NAME | <string 1..54> | 2) |
var(*list).SHADOW-ARCHIVE | <string 1..22> | 2) 6) |
var(*list).ORIG-ARCHIVE | <string 1..22> | 2) 7) |
var(*list).LOCATION | *ANY | 2) |
var(*list).BACKUP-SERVER-USAGE | *NO | 2) |
var(*list).RETENT-PERIOD | *FROM-ORIG-SAVE-F | 1) 2) 1) 2) |
var(*list).F-EXPIR-DATE | *RESTRICT | 2) |
var(*list).SECURE-PERIOD | 0..32767 | 1) 2) 9) |
var(*list).SAVE-F-RETPD-UPDATE | *YES | 2) |
var(*list).ACCESS-FROM-NODE.NORMAL-USER | *NONE | 2) |
var(*list).ACCESS-FROM-NODE.ADM | *NONE | 2) |
var(*list).SAVE-OPT.SAVE-DATA | *S0 | 2) 3) |
var(*list).SAVE-OPT.SAVE-PLAM-INFO | *YES | 2) 3) |
var(*list).MONITORING | *NO | 2) |
var(*list).OPERATION-CONTR.PARALLEL-RUN | 1..16 | 1) 2) |
var(*list).OPERATION-CONTR.NUM-OF-DEV | 1..16 | 1) 2) 8) |
var(*list).OPERATION-CONTR.MULTIPLEX-FACT | 2..4 | 1) 2) 8) |
var(*list).OPERATION-CONTR.WRITE-CHECKP | *YES | 2) |
var(*list).OPERATION-CONTR.OPER-INTERACT | *ALLOW | 2) |
var(*list).OPERATION-CONTR. | *NO | |
var(*list).SHADOW-CONTR.SHADOW-COP | *ALLOW | 2) |
var(*list).TAPE-CONTR.NEW-STD-SAVE-F | *AT-EACH-REQ | 2) 4) |
var(*list).TAPE-CONTR.CONTI-PERIOD | 1..32767 | 1) 2) 5) |
var(*list).TAPE-CONTR.STD-SAVE-F | *UNDEF | 2) |
var(*list).TAPE-CONTR.BLOCK-FACT | *STD | 2) |
var(*list).TAPE-CONTR.UNLOAD-TAPE | *YES | 2) |
var(*list).TAPE-CONTR.STREAM-MODE | *YES | 2) |
var(*list).DISK-CONTR.PRIMARY-ALLOC | *STD | 2) 6) |
var(*list).DISK-CONTR.SECONDARY-ALLOC | *STD | 2) 6) |
var(*list).DISK-CONTR.WRITE-CHECK | *NO | 2) 6) |
var(*list).DISK-CONTR.DESTROY-BY-DEL | *STD | 2) 6) |
var(*list).REQ-PRIO.READ | *STD | 1) 2) |
var(*list).REQ-PRIO.WRITE | *STD | 1) 2) |
1) | The integer values are output in string format. |
2) | Output if //SHOW-ARCHIVE-ATTRIBUTES INFORMATION=*ALL |
3) | Useable output only if USAGE=*BACKUP/*ARCHIVAL; otherwise output with blank character string |
4) | Useable output only if SAVE-FILE-STRUCTURE=*SEVERAL-SVID; otherwise output with blank character string |
5) | Useable output only if NEW-STD-SAVE-FILE=*IN-PERIOD; otherwise output with blank character string |
6) | Output with blank character string if USAGE=*SHADOW |
7) | Useable output only if USAGE=*SHADOW; otherwise output with blank character string |
8) | Useable output only if PARALLEL-RUNS=*MULTIPLEXING; otherwise output with blank character string |
9) | Useable output only if USAGE=*VERSIONBACKUP; otherwise output with blank character string |
For more detailed information on S variables, refer to the manual “Commands” [5].