Your Browser is not longer supported

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

{{viewport.spaceProperty.prod}}

SHOW-CACHE-CONFIGURATION

&pagelevel(3)&pagelevel

Show configuration of the PFA cache areas

Component:

BS2000

Functional area:

Caching media control Pubset and MRSCAT management

Domain:

MULTI-CATALOG-AND-PUBSET-MGMT

Privileges:

TSOS
HARDWARE-MAINTENANCE
SW-MONITOR-ADMINISTRATION

Function

The SHOW-CACHE-CONFIGURATION command supplies systems support staff with information on the PFA cache areas. As part of the PFA (“Performant File Access”) concept, the user can put files into buffer storage (“cache” them) via the DMS interfaces. The cache medium supported via PFA interfaces is: main memory (MM). The DAB subsystem is required as the cache handler driver software for the use of the cache medium.

The command supports structured output in S variables (see "Output in S variable").

Format

SHOW-CACHE-CONFIGURATION                                                                                                             

CACHE-MEDIUM = *ALL / *MAIN-MEMORY

,CACHE-ID = *ALL / list-poss(2000): <alphanum-name 1..4>

Operands

CACHE-MEDIUM =
Identifies the storage medium which is used for caching.

CACHE-MEDIUM = *ALL
Preset value: all supported storage media will be considered. If an explicit CACHE-ID is specified, a check is made to determine if this cache area is held in any of the supported media. If CACHE-ID=*ALL is specified, information is supplied for all the cache areas in the supported media.

The cache medium main memory is currently the only supported medium.

CACHE-MEDIUM = *MAIN-MEMORY
Requests information about the cache areas which use main memory as the cache medium.
If the cache area is not found in this medium, or if there is no cache area set up in this medium, the command will be rejected with an error message.

CACHE-ID = *ALL / list-poss(2000): <alphanum-name 1..4>
Identifier of the cache area for which information is required. With PFA cache areas this is the pubset identifier (SF pubsets) or the volume set identifier (SM pubsets). 

Return codes

(SC2)

SC1

Maincode

Meaning


0

CMD0001

No error


1

CMD2201

Error at the interface between SDF and the command server


3

CMD2203

SDF version is not supported


32

ECC0001

Internal error


64

CMD0216

No authorization to call command


64

ECC0303

No cache handler loaded


64

ECC0006

Cache handler DAB not loaded


64

ECC0301

Cache area does not exist


64

ECC0304

No cache area exists

Format of the output data

The output starts with the heading line:

CACHE-CONFIGURATION IN CACHE-MEDIUM <mdm> FOR CACHE-METHOD <mtd>

where the following values are possible:

<mdm>

 =

MAIN-MEMORY

<mtd>

 =

DAB

The output specifies the configuration of all the cache buffers for the named cache medium and managed by the DAB cache handler. This is subdivided into various configuration records; these are

  1. PARTITION-CONFIGURATION-RECORD

  2. Buffer configuration records.

A PARTITION-CONFIGURATION-RECORD is always output. The partition configuration record contains the following information on the DAB partitions:

  • Size of the partition in megabytes: Size of the reserved cache storage. With MM, what is shown is the total amount of cache storage occupied so far; with ES and GS it is the area within the cache medium which is allocated to the partition in question.

  • Status of the partition in the cache medium.
    With MM, the availability of the medium is indicated (OPERABLE / DEFECT).

  • The number of installed cache areas in the medium or in the GS partition

A BUFFER-CONFIGURATION-RECORD for each cache area. When MM is used as the cache medium, the BUFFER-CONFIGURATION-RECORD provides the following information:

  • Cache ID:
    Identifier of the cache area for which information is required. With PFA cache areas this is the pubset ID (SF pubsets) or the volume set ID (SM pubsets).

  • Cache size in megabytes or kilobytes.

  • Segment size of the cache area in kilobytes (not for AutoDAB).

  • Cache area utilization.
    Indicates how much of the cache area is occupied by data.

  • Status.

    • CONNECTED: the cache area is being actively used for a pubset.

    • DISCONNECTED: the cache area is currently not being used (typically because it could not be saved when the pubset was exported). The next time the pubset is imported, the status will change back to CONNECTED.

    • DEFECT: an access error was detected when the cache medium was addressed. Where possible, caching is disabled.

  • Force-out cycle.
    Indicates when the write data in the cache area is transferred to the associated disks

    • NO: the data is not written out periodically, but only when the files are closed or the cache area is deleted

    • AT-HIGH-FILLING: the data is written out when the cache is 75% full of write data

    • AT-LOW-FILLING: the data is written out when the cache is 25% full of write data.

Example

/show-cache-configuration

%
%   CACHE-CONFIGURATION IN CACHE-MEDIUM MAIN-MEMORY OF CACHE-METHOD DAB:
%
%   PARTITION-CONFIGURATION-RECORD:
%   PARTITION-ID  SIZE      FREE                  STATE         #BUFFER
%   --------      31MB      ----                  OPERABLE         1
%
%   BUFFER-CONFIGURATION-RECORD:
%   CACHE-ID      SIZE  SEG-SIZE         IN-USE   STATE         FORCE-OUT
%    2OSQ         19MB      ----            18%   CONNECTED     AT-LOW-FILLING
%
%   BUFFER-CONFIGURATION-RECORD:
%   CACHE-ID      SIZE  SEG-SIZE         IN-USE   STATE         FORCE-OUT
%    2OSG         12MB      32KB            73%   CONNECTED     AT-HIGH-FILLING
Explanation of output for the DAB cache media

The information consists of several information

  PARTITION-CONFIGURATION-RECORD:
   PARTITION-ID  SIZE      FREE                  STATE        #BUFFER
    (1)           (2)       (3)                   (4)          (5) 

  BUFFER-CONFIGURATION-RECORD:
    CACHE-ID      SIZE  SEG-SIZE         IN-USE   STATE         FORCE-OUT
    (6)           (7)   (8)              (9)      (10)          (11)
Explanation

Partition information block (PARTITION-CONFIGURATION-RECORD)

(1)

PARTITION-ID
Information on the partition ID. The information is only of relevance for the global storage cache medium.

(2)

SIZE
Size of the partition in Mbytes. Size of the available cache. For the main memory (MM) cache medium, the total ache space in use.

(3)

FREE
Only displays '----'.

(4)

STATE
Status of the partition of the cache medium and the slices. The following states may occur:

  • HOME partition referring to the home pubset of the current system (ADM PFA partition).

  • OPERABLE The availability of the cache medium main memory.

  • DEFECT Indicates that the cache medium is not available.

  • SHARED The partition is used for a shared pubset.

(5)

#BUFFER
Number of cache areas installed in this partition.

Cache area information block (BUFFER-CONFIGURATION-RECORD)

(6)

CACHE-ID

Identifies the cache area on which information is requested. With PFA cache areas this is the pubset ID (SF pubsets) or the volume set ID (SM pubsets).

(7)

SIZE
The size of the cache area in megabytes (or in kilobytes, if the cache medium specified was MM).

(8)

SEG-SIZE
Segment size of the cache area in kilobytes.

(9)

IN-USE
Degree of utilization of the cache area.

(10)

STATE
State of the cache area. The following states may occur:

  • CONNECTED The cache area is currently in use.

  • DISCONNECTED The cache area is not in use at the moment, e.g. because it was not possible to save the related files when the pubset was exported.

  • DEFECT An error was encountered when accessing the cache medium. Where possible, caching is disabled.

(11)

FORCE-OUT
The intervals at which the write data in the cache area is transferred to the associated disks.

  • NO The data is not transferred periodically. The data is only transferred to the disk when the files are closed or when the cache area is deleted.

  • AT-HIGH-FILLING The data is written out when the cache area is 75% full of write data.

  • AT-LOW-FILLING The data is written out when the cache area is 25% full of write data.

Output in S variable

The CACHE-MEDIUM operand specifies the cache medium to which the output information relates.

Notation used in command

Abbreviated form used in table

CACHE-MEDIUM = *ALL

1

CACHE-MEDIUM = *MAIN-MEMORY

2

Output information

Name of the S variable

T

Contents                 

Condition

Cache medium
*MAIN-MEM=main memory

var(*LIST).CACHE-MED

S

*MAIN-MEM

1.2

Name of the cache area (corresponds to the pubset ID)

var(*LIST).PART(*LIST).BUF(*LIST).CACHE-ID

S

<c-string 1..4>

2

Segment size of the cache area

var(*LIST).PART(*LIST).BUF(*LIST).CACHE-SEGMENT-SIZE

S

'*UNDEF
<c-string 1..2>

2

Size of the cache area

var(*LIST).PART(*LIST).BUF(*LIST).CACHE-SIZE

I

<integer 1..999999>

2

Cache filling level from which the write data of the cache area is written back to the disks

var(*LIST).PART(*LIST).BUF(*LIST).FORCE-OUT

S

*NO
*AT-HIGH-FILL
*AT-LOW-FILL

2

Portion of cache space allocated

var(*LIST).PART(*LIST).BUF(*LIST).IN-USE

I

<integer 0..100>

2

Specification of the size of the cache area in:
*KB=kilobytes
*MB=megabytes

var(*LIST).PART(*LIST).BUF(*LIST).
SIZE-DIM

S

*KB
*MB

2

Status of the cache area

var(*LIST).PART(*LIST).BUF(*LIST).STA

S

*CONN
*DISCONN
*DEFECT

Number of cache areas in the main memory

var(*LIST).PART(*LIST).NUM-OF-BUF

I

<integer 1..999999>

2

Partition ID

var(*LIST).PART(*LIST).PART-ID

S

''
<c-string 1..8>

2

Size of the partition or total of the sizes of the cache areas in main memory

var(*LIST).PART(*LIST).SIZE

I

<integer 1..999999>

2

Specification of the size of the partition in:
*KB=kilobytes
*MB=megabytes

var(*LIST).PART(*LIST).SIZE-DIM

S

*KB
*MB

2

Status of the partition

var(*LIST).PART(*LIST).STA

S

*HOME
*PFA
*SHARED
*CONN
*OPERABLE
*DEFECT

2