VOLINFO



Syntax:    VOLINFO (VolID, item [,status])

Defn: A CI evaluator function that returns information about
the specified volume/volume class/volume set/LDEV.

Type: String, Integer, or Boolean depending upon item.

Parms:

VolID : Required. Identifies the target Volume / Volume class/
Volume Set. Volume Set and Volumeset:VolumeClass are strings.
Volumes can be represented either as a Volumeset:Volume-name
string or as an LDEV string or integer.

Item : Required. String label specifying which information is to
be returned.

Status: Optional. CI variable name where a VOLINFO error number
can be returned. Zero indicates success. Non-zero indicates
a failure. Error values returned in 'status' are the same as
the CIERROR value when an error occurs. If the 'status'
parm is passed, the CI will not set CIERROR and will not
report an error message. If 'status' is not specified the
CI performs its normal error handling.

Example: :calc VOLINFO("@", "VOLSETS")
Result: 2/MPEXL_SYSTEM_VOLUME_SET RATVOL.VOLMGT.QASYSXL
Example: :calc VOLINFO("MPEXL_SYSTEM_VOLUME_SET", "Exist")
Result: TRUE
Example: :calc VOLINFO("MPEXL_SYSTEM_VOLUME_SET:MEMBER1", "ldev")
Result: 1

The following table summarizes the items of the VOLINFO function. The
description includes the item string, one or more aliases, the data
type, and a brief description of the item.

Item String Type Description
------------ ---- ----------------------------------------------
Drivetype string Returns the drive type of the specified volume

Exists bool True if Ldev, volset:volname, or volset
Exist exists, regardless of whether it is
mounted or opened. "Exists" confirms
the input value is configured. Use
"mounted" to check if a volume is
mounted. Use "opened" to check if a
volume has been vsopen'd. Use "volclass
exists" for volume classes
LDEV int Returns the Ldev of the specified volume
VolLdev name

Loner bool True if Ldev or volset:volname exists
and is in the "loner" state. See also
"exists", "mounted", and "opened"

MemberVolClassNames string A list of volume class names, separated
MemberVolClasses by a space, which the specified volume
is a member of. Format: "total/name1
name2..nameN"

Mounted bool True if Ldev or volset:volname exists
and is mounted. See also "exists" and "opened"

NumVolumeClasses int Returns the number of volume classes in
NumVolClass the volume set

NumVolClassVolumes int Returns the number of volumes in the
NumVolClassVols Volume class

NumVolSetVolumes int Returns the number of volumes in the
NumVSVols volume set, including the master volume

NumVolumeSets int Returns the number of volume sets in the
NumVS system. VolID is "", meaning "@", or a
wildcard pattern. e.g. "@TEST@","USER@"

Opened bool True if the Ldev or volset:volname is
mounted and vsopen'd. See also "exists"
and "mounted"

SystemVolume bool True if ldev of volume is a system volume

UserVolume bool True if ldev of volume is a user volume

VolClassDirSpaceMB int Returns the directory space overhead in
megabytes of the specified volume class

VolClassDirSpaceSectors string Returns the directory space overhead in
sectors of the specified volume class as
a numeric string

VolClasses string A list of volume class names, separated
VSVolClassNames by a space, belonging to the specified
volume set. Format: "total/name1 name2..nameN"

VolClassExists bool True if volset:volclass exists. Use
VolClassExist "exists" for Ldev, volset:volume or
volset names

VolClassFileLabelMB int Returns the File Label overhead in mega-
bytes of the specified volume class

VolClassFileLabelSectors string Returns the File Label overhead in
sectors of the specified volume class as
a numeric string

VolClassFreeSpaceMB int Returns the total free space in mega-
bytes in the specified volume class

VolClassFreeSpaceSectors string Returns the total free space in sectors
in the specified volume class as a
numeric string

VolClassLargestSpaceMB int Returns the largest contiguous free
space in megabytes in the specified
volume class

VolClassLargestSpaceSectors string Returns the largest contiguous free
space in sectors in the specified
volume class as a numeric string

VolClassMaxTransSpaceMB int Returns the maximum configured
transient space in megabytes of the
specified volume class

VolClassMaxTransSpaceSectors string Returns the maximum configured
transient space in sectors of the
specified volume class as a numeric string

VolClassOverheadMB int Returns the total MPE/iX overhead in
megabytes of the specified volume class

VolClassOverheadSectors string Returns the total MPE/iX overhead in
sectors of the specified volume class as
a numeric string

VolClassPermFilesMB int Returns the permanent file disc usage in
megabytes of the specified volume class

VolClassPermFilesSectors string Returns the permanent file disc usage in
sectors of the specified volume class as
a numeric string

VolClassSizeMB int Returns the total size in megabytes of
the specified volume class

VolClassSizeSectors string Returns the total size in sectors of the
specified volume class as a numeric string

VolClassSpoolSpaceMB int Returns the spoolfile space in megabytes
of the specified volume class

VolClassSpoolSpaceSectors string Returns the spoolfile space in sectors
of the specified volume class as a numeric string

VolClassTempFileMB int Returns the temporary file disc usage in
megabytes of the specified volume class

VolClassTempFilesSectors string Returns the temporary file disc usage in
sectors of the specified volume class as
a numeric string

VolClassTransSpaceMB int Returns the transient space overhead in
megabytes of the specified volume class

VolClassTransSpaceSectors string Returns the transient space overhead in
sectors of the specified volume class as
a numeric string

VolClassVols string A list of volume names, separated by a
VolClassVolumeNames space, belonging to the specified volume
class. Format: "total/name1 name2 ..nameN"

VolClassXMMB int Returns the Transaction Management (XM)
overhead in megabytes of the specified
volume class

VolClassXMSectors string Returns the Transaction Management (XM)
overhead in sectors of the specified
volume class as a numeric string

VolDirSpaceMB int Returns the directory space overhead in
megabytes of the specified volume

VolDirSpaceSectors string Returns the directory space overhead in
sectors of the specified volume as a
numeric string

VolFileLabelMB int Returns the File Label overhead in
megabytes of the specified volume

VolFileLableSectors string Returns the File Label overhead in
sectors of the specified volume as a
numeric string

VolFreeSpaceMB int Returns the total free space in mega-
bytes in the specified volume

VolFreeSpaceSectors string Returns the total free space in sectors string

VolLargestSpaceMB int Returns the largest contiguous free
space in megabytes in the specified volume

VolLargestSpaceSectors string Returns the largest contiguous free
space in sectors in the specified
volume as a numeric string

VolMaxTransSpaceMB int Returns the maximum configured transient
space in megabytes of the specified volume

VolMaxTransSpaceSectors string Returns the maximum configured transient
space in sectors of the specified volume
as a numeric string

VolName string Returns the volume name of the specified Ldev

VolOverheadMB int Returns the total MPE/iX overhead in
megabytes of the specified volume

VolOverheadSectors string Returns the total MPE/iX overhead in
sectors of the specified volume as a
numeric string

VolPermFilesMB int Returns the permanent file disc usage in
megabytes of the specified volume

VolPermFilesSectors string Returns the permanent file disc usage in
numeric string

VolSetDirSpaceMB int Returns the directory space overhead in
megabytes of the specified volume set

VolSetDirSpaceSectors string Returns the directory space overhead in
sectors of the specified volume set as a
numeric string

VolSetFileLabelMB int Returns the File Label overhead in mega-
bytes of the specified volume set

VolSetFileLabelSectors string Returns the File Label overhead in
sectors of the specified volume set as a
numeric string

VolSetFreeSpaceMB int Returns the total free space in mega-
bytes in the specified volume set

VolSetFreeSpaceSectors string Returns the total free space in sectors
in the specified volume set as a numeric string

VolSetLargestSpaceMB int Returns the largest contiguous free space
in megabytes in the specified volume set
space in sectors in the specified
volume set as a numeric string

VolSetMaxTransSpaceMB int Returns the maximum configured transient
space in megabytes of the specified volume set

VolSetMaxTransSpaceSectors string Returns the maximum configured transient
space in sectors of the specified volume
set as a numeric string

VolSetName string Returns the volume set name of the
specified Ldev

VolSetOverheadMB int Returns the total MPE/iX overhead in
megabytes of the specified volume set

VolSetOverheadSectors string Returns the total MPE/iX overhead in
sectors of the specified volume set as a
numeric string

VolSetPermFilesMB int Returns the permanent file disc usage in
megabytes of the specified volume set

VolSetPermFilesSectors string Returns the permanent file disc usage in
sectors of the specified volume set as a
numeric string

VolSets string A list of volume set names separated by
VolumeSetNames a space. Format: "total/name1 name2 ..
nameN". VolId can be "", meaning "@", or
a wildcarded pattern
the specified volume set

VolSetSizeSectors string Returns the total size in sectors of the
specified volume set as a numeric string

VolSetSpoolSpaceMB int Returns the spoolfile space in megabytes
of the specified volume set

VolSetSpoolSpaceSectors string Returns the spoolfile space in sectors
of the specified volume set as a numeric string

VolSetTempFilesMB int Returns the temporary file disc usage in
megabytes of the specified volume set

VolSetTempFilesSectors string Returns the temporary file disc usage in
sectors of the specified volume set as a
numeric string

VolSetTransSpaceMB int Returns the transient space overhead in
in megabytes of the specified volume set

VolSetTransSpaceSectors string Returns the transient space overhead in
sectors of the specified volume set as a
numeric string

VolSetXMMB int Returns the Transaction Management (XM)
overhead in megabytes of the specified
volume set

VolSetXMSectors string Returns the total MPE/iX overhead in
overhead in sectors of the specified
volume set as a numeric string

VolSizeMB int Returns the size in megabytes of the
specified volume

VolSizeSectors string Returns the size in sectors of the
specified volume as a numeric string

VolSpoolSpaceMB int Returns the spoolfile space in mega-
bytes of the specified volume

VolSpoolSpaceSectors string Returns the spoolfile space in sectors
of the specified volume as a numeric string

VolTempFilesMB int Returns the temporary file disc usage in
in megabytes of the specified volume

VolTempFilesSectors string Returns the temporary file disc usage in
sectors of the specified volume as a
numeric string

VolTransSpaceMB int Returns the transient space overhead in
megabytes of the specified volume

VolTransSpaceSectors string Returns the transient space overhead in
sectors of the specified volume as a
numeric string

VolType string Returns the status of the volume as
displayed by the DSTAT command: "MASTER"
"MEMBER","LONER","SCRATCH","UNKNOWN",
"DISABLED","LOCKED"

VolXMMB int Returns the Transaction Management (XM)
overhead in megabytes of the specified volume

VolXMSectors string Returns the Transaction Management (XM)
overhead in sectors of the specified
volume as a numeric string

VSVolumeNames string A list of volume names, separated by a
VSVols space, belonging to the specified volume
set. Format: "total/name1 name2..nameN"