| Where allowed to run: Compiled CL program or interpreted REXX (*BPGM *IPGM *BREXX *IREXX) Threadsafe: Yes |
Parameters Examples Error messages |
The Retrieve Auxiliary Storage Pool Session (RTVASPSSN) command is used in a control language (CL) program or a REXX procedure to get one or more of the values that are stored and associated with an auxiliary storage pool session. The values are returned in the specified variables.
The parameter prompt text lists the minimum length for the variables next to the appropriate parameters you want to retrieve.
Restrictions: You must have use (*USE) authority to the ASP device description for which session information is being retrieved.
| Top |
| Keyword | Description | Choices | Notes |
|---|---|---|---|
| SSN | Session | Name | Required, Positional 1 |
| TYPE | CL var for TYPE (10) | Character value | Optional |
| ASPCPYLST | CL var for ASPCPYLST (4472) | Character value | Optional |
| DELIVERY | CL var for DELIVERY (8) | Character value | Optional |
| MODE | CL var for MODE (8) | Character value | Optional |
| INTRANSIT | CL var for INTRANSIT (10 0) | Decimal number | Optional |
| TIMEOUT | CL var for TIMEOUT (4 0) | Decimal number | Optional |
| PRIORITY | CL var for PRIORITY (8) | Character value | Optional |
| TRACKSPACE | CL var for TRACKSPACE (3 0) | Decimal number | Optional |
| PERSISTENT | CL var for PERSISTENT (8) | Character value | Optional |
| FLASHTYPE | CL var for FLASHTYPE (8) | Character value | Optional |
| ASPCPY | CL var for ASPCPY (31232) | Character value | Optional |
| Top |
Specifies the name of the ASP session to be retrieved.
This is a required parameter.
| Top |
Specifies the name of the variable used to return the type of session. Possible values are:
| Top |
Specifies the name of the variable used to return the list of ASP copy descriptions associated with the session.
The ASP copy list contains a 12-byte header composed of the following, which is followed by one or more copy description entries.
Position Length Field
1 4-byte integer number Offset from beginning of
ASPCPYLST
to first ASP copy
description list entry
5 4-byte integer number Length of each ASP copy
description list entry
9 4-byte integer number Number of ASP copy
description entries
The following field repeats for each ASP copy description.
Position Length Field 1 10 characters Preferred source copy description 11 10 characters Preferred target copy description
| Top |
Specifies the name of the variable used to return the transmission delivery method for this ASP session. This attribute only applies to Geographic Mirroring sessions. Possible values are:
| Top |
Specifies the name of the variable used to return the mirroring mode for this ASP session. This attribute only applies to Geographic Mirroring sessions. Possible values are:
| Top |
Specifies the name of the variable used to return the total data in transit in megabytes.
| Top |
Specifies the name of the variable used to return the suspend timeout in seconds. Possible values range from 0 to 3600 seconds.
| Top |
Specifies the name of the variable used to return the synchronization priority for the ASP session. This attribute only applies to Geographic mirroring sessions. Possible values are:
| Top |
Specifies the name of the variable used to return the percentage of the maximum assignable tracking space currently allocated. This attribute only applies to Geographic Mirroring sessions.
| Top |
Specifies the name of the variable used to return the persistence of the FlashCopy session. This attribute only applies to FlashCopy sessions. Possible values are:
| Top |
Specifies the name of the variable used to return the type of the FlashCopy session. This attribute only applies to FlashCopy sessions. Possible values are: :
| Top |
Specifies the name of a variable that is used to retrieve the ASP copy description information for each ASP copy in the session. The ASP copy description contains a 12-byte header composed of the following, which is then followed by two or more ASP copy description entries.
Position Length Field
1 4 byte integer Offset from beginning of
ASPCPY to the first ASP copy
description entry
5 4 byte integer Number of ASP copy
description entries
9 4 byte integer Length of an ASP copy
description entry
The following fields repeat for each ASP copy description entry.
Position Length Field 1 10 characters ASP copy description 11 10 characters ASP device 21 10 characters Role 31 10 characters State 41 10 characters Data state 51 8 characters Node 59 4 byte integer Percent tracking space used 63 4 byte integer Total data out of sync 67 4 byte integer Synchronization progress
The Role parameter retrieves the current roles for the ASP. Possible Role values are:
The State parameter retrieves the current state of the ASP. For the production or source copy, the vary configuration state is retrieved. For the mirror or target copy, the mirroring state is retrieved. Possible values are:
The Data state parameter retrieves the current data state of the ASP. This parameter is only valid for Geographic Mirroring sessions. Possible values are:
| Top |
ADDASPCPYD ASPCPY(COPY1)
ASPDEV(IASP001)
CRG(CRG)
SITE(SITE1)
ADDASPCPYD ASPCPY(COPY2)
ASPDEV(IASP001)
CRG(CRG)
SITE(SITE2)
STRASPSSN SSN(GEOSSN) TYPE(*GEOMIR) ASPCPY((COPY1 COPY2))
If Geographic mirroring had been configured for IASP001, two copy descriptions and an ASP session had been created using the above commands, and a CL program was run containing the following:
DCL VAR(&TYPE) TYPE(*CHAR) LEN(10)
DCL VAR(&ASPCPYLST) TYPE(*CHAR) LEN(32)
DCL VAR(&DELIVERY) TYPE(*CHAR) LEN(8)
DCL VAR(&MODE) TYPE(*CHAR) LEN(8)
DCL VAR(&INTRANSIT) TYPE(*DECIMAL) LEN(10 0)
DCL VAR(&TIMEOUT) TYPE(*DECIMAL) LEN(4 0)
DCL VAR(&PRIORITY) TYPE(*CHAR) LEN(7)
DCL VAR(&TRACKSPACE) TYPE(*DECIMAL) LEN(3 0)
DCL VAR(&ASPCPY) TYPE(*CHAR) LEN(256)
RTVASPSSN SSN(GEOSSN)
TYPE(&TYPE)
ASPCPYLST(&ASPCPY)
DELIVERY(&DELIVERY)
MODE(&MODE)
INTRANSIT(&INTRANSIT)
TIMEOUT(&TIMEOUT)
PRIORITY(&PRIORITY)
TRACKSPACE(&TRACKSPACE)
ASPCPY(&ASPCPY)
The following information about the ASP session would be returned:
&TYPE '*GEOMIR '
&ASPCPYLST '001300200001COPY1 COPY2 '
&DELIVERY '*SYNC '
&MODE '*SYNC '
&INTRANSIT '0000000013'
&TIMEOUT '0120'
&PRIORITY '*MEDIUM '
&TRACKSPACE '0005'
&ASPCPY '001300020067COPY1 IASP001 PRODUCTION'
'AVAILABLEUSABLE NODE1 00000000'
'COPY2 IASP001 MIRROR ACTIVE '
'USABLE NODE2 00000000'
| Top |
*ESCAPE Messages
| Top |