The Retrieve ASP (Auxiliary Storage Pool) Status tool retrieves the
status and descriptive information about a single ASP. One or more
return variables are provided.
A typical command would be:
DCL &USEPCT *DEC LEN(6 4)
.
RTVASPSTS USEPCT(&USEPCT)
All disk size fields will return a -2 if the number of MB exceeds 9
digits.
RTVASPSTS escape messages you can monitor for
---------------------------------------------
TAA9893 The ASP number does not exist.
Escape messages from based on functions will be re-sent.
Command parameters *CMD
------------------
ASP The number of the ASP to be retrieved. Basic ASPs
must be a value between 1 and 32. If a device name
is requested, this parameter must be defaulted (a 0
value is passed).
Primary or secondary ASPs are known externally by
their name although a number between 33 and 255 is
assigned by the system. If you know the name of the
primary or secondary ASP, you should use the default
for this parameter and enter the name in the ASPDEV
parameter.
If the number of the primary or secondary ASP is
known, but the ASP device name is not known, a
number between 33 and 255 may be entered to retrieve
the information about the ASP. This allows the
device name of the ASP to be accessed if only the
number is known.
ASPDEV The ASP device name to retrieve. If an ASP number
is requested, this parameter must be blank.
RTNASP The number of the ASP retrieved. The number will
exist regardless of whether ASP or ASPDEV was
specified. The value may be helpful if ASPDEV was
used. This is an optional return variable that if
defined must be specified as *DEC LEN(3 0).
RESOURCE The resource assigned by CRTDEVASP. For *SYSBAS
ASPs, the value will be blank. This is an optional
return variable that if defined must be specified as
*CHAR LEN(10).
ASPUSAGE The use that is assigned to the ASP.
*UNKNOWN will be returned if the attribute is not
known or does not apply. The value will be returned
for the *SYSBAS ASPs or an ASP that is not powered
on.
*USRDFLSYS will be returned for a user-defined file
system ASP.
*PRIASP will be returned for a primary ASP.
*SECASP will be returned for a secondary ASP.
This is an optional return variable that if defined
must be specified as *CHAR LEN(10).
ASPSTS The status of the ASP.
*NONE will be returned for *SYSBAS ASPs.
*VARYOFF will be returned if the ASP is in a 'varied
off' state.
*VARYON will be returned if the ASP is in a 'varied
on' state. A *VARYON state is a transitional state
and would normally indicate a problem if repeatedly
returned.
*ACTIVE will be returned if the ASP is in an active
state. An *ACTIVE state is a transitional state and
would normally indicate a problem if repeatedly
returned. *ACTIVE is used during RCLSTG of an ASP.
*AVAILABLE will be returned if the ASP is in an
available state. *AVAILABLE is the required state
for user processing.
This is an optional return variable that if defined
must be specified as *CHAR LEN(10).
DBNAME The name of the data base assigned by CRTDEVASP.
The value will be blank for *SYSBAS ASPs. This is
an optional return variable that if defined must be
specified as *CHAR LEN(10).
ASPTYPE The type of ASP. '00' is returned for the system
ASP. '10' is returned if the user ASP does not
contain libraries. '11' is returned if the user ASP
does contain libraries. This is an optional return
variable that if defined must be specified as *CHAR
LEN(2).
DISKUNITS The number of disk units in the ASP. This is an
optional return variable that if defined must be
specified as *DEC LEN(9 0).
USEPCT The percentage of capacity used in the ASP. The
result will differ slightly from that shown on
WRKSYSSTS for the system ASP due to rounding
differences. This is an optional return variable
that if defined must be specified as *DEC LEN(6 4).
THDPCT The threshold percentage defined for the ASP. The
threshold percent may be set using DST, SST or the
TAA command CHGASPA2. This is an optional return
variable that if defined must be specified as *DEC
LEN(2 0).
TOTALCAP The total capacity in MB for the ASP. This is an
optional return variable that if defined must be
specified as *DEC LEN(9 0).
AVAILCAP The amount of storage in MB that is still available
to be used within the ASP. This is an optional
return variable that if defined must be specified as
*DEC LEN(9 0).
PROTCAP The amount of storage in MB that is protected within
the ASP. This is an optional return variable that
if defined must be specified as *DEC LEN(9 0).
OVRFLWSTG The amount of storage in MB that has overflowed from
the ASP to the system ASP. This is an optional
return variable that if defined must be specified as
*DEC LEN(9 0).
OVRFLWRCY The result of an ASP overflow recovery operation.
The operation is performed at IPL. '0' is returned
if all overflowed storage was successfully moved.
'1' is returned if overflow recovery failed because
there was not enough space in the user ASP. '2' is
returned if overflow recovery was cancelled prior to
completion. This is an optional return variable
that if defined must be specified as *CHAR LEN(1).
MIRROR A Y/N value for whether the ASP is mirrored. This
is an optional return variable that if defined must
be specified as *CHAR LEN(1).
PARITY A Y/N value for whether the ASP is being protected
by a parity array of disks. This is an optional
return variable that if defined must be specified as
*CHAR LEN(1).
CPRRCVPCY A return value for the compression recovery policy.
After each * return value, the number in the
parenthesis is the value returned from the QYASPOL
API which contains a complete description. This is
an optional return variable that if defined must be
specified as *CHAR LEN(10).
*RETRY (1). The system posts an SRC and waits for a
limited time. If space becomes available, overflow
occurs to the system ASP.
*OVERFLOW (2). Space overflows immediately to the
system ASP.
*WAIT (3). The system posts an SRC and waits
indefinitely for space to become available in the
same ASP.
CPRDSKUNTS A return value to determine the compression status
of disk units in the ASP. After each * return
value, the number in the parenthesis is the value
returned from the QYASPOL API which contains a
complete description. This is an optional return
variable that if defined must be specified as *CHAR
LEN(10).
*NONE (0). No compressed disk units exist.
*BOTH (1). Compressed and uncompressed disk units
exist.
*ALL (2). All disk units are compressed.
BALSTS A return value to determine the balanced status of
disk units in the ASP. After each * return value,
the number in the parenthesis is the value returned
from the QYASPOL API which contains a complete
description. This is an optional return variable
that if defined must be specified as *CHAR LEN(10).
*NONE (0). No compressed disk units exist.
*RUNNING (1). Disk units are being balanced.
*ENDING (2). The balancing function is in the
process of ending.
*INCOMPLT (3). The balancing function has ended,
but is incomplete.
*BALANCED (4). The balancing function is complete.
BALTYP A return value to determine the balanced type of
disk units in the ASP. After each * return value,
the number in the parenthesis is the value returned
from the QYASPOL API which contains a complete
description. This is an optional return variable
that if defined must be specified as *CHAR LEN(10).
*NONE (0). No balancing activity was requested.
*SPACE (1). Balancing will be done based on space
used.
*ACTIVITY (2). Balancing will be done based on disk
activity.
*HSM (3). Hierarchical Storage Management type.
BALDATE The last date that balancing occurred in CYMD
format.
BALTIME The last time that balancing occurred in hhmmss
format.
BALDTAMOVD A return value to determine the number of megabytes
that have been moved. This is an optional return
variable that if defined must be specified as *DEC
LEN(10 0).
BALDTARMNG A return value to determine the number of megabytes
remaining to be moved. This is an optional return
variable that if defined must be specified as *DEC
LEN(10 0).
MLTCNNUNIT A return value to determine the number of multiple
connection units. This is an optional return
variable that if defined must be specified as *DEC
LEN(7 0).
RTNINFO A return value to describe whether all information
has been returned properly. A Y or N will be
returned. If an independent ASP has been switched
or powered off, some information such as PARITY and
MIRROR are returned as blanks. Other disk
information such as TOTALCAP will probably be 0.
This is an optional return variable that if defined
must be specified as *CHAR LEN(1).
Restrictions
------------
Because the command returns values, it may only be used in a CL
program.
All size fields will return a -2 if the number of MB exceeds 9
digits.
Prerequisites
-------------
The following TAA Tools must be on your system:
EDTVAR Edit variable
SNDESCMSG Send escape message
Implementation
--------------
None, the tool is ready to use.
Objects used by the tool
------------------------
Object Type Attribute Src member Src file
------ ---- --------- ---------- ----------
RTVASPSTS *CMD TAAASPD QATTCMD
TAAASPDC *PGM CLP TAAASPDC QATTCL
|
