com.ibm.as400.access.list

Class AspListItem

  • java.lang.Object
    • com.ibm.as400.access.list.AspListItem


  • public class AspListItem
    extends java.lang.Object
    Contains ASPs information that was generated by AspOpenList.

    Some attributes will not be available, depending on the format that was used to generate this item. The javadoc for each attribute getter indicates which formats will generate valid data for the given attribute. If an attribute getter that is only valid for a format other than what was used to generate this AspListItem, the data returned by that getter is not valid.

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      int getaspCapacity()
      Returns the total number of used and unused megabytes in the ASP.
      int getaspCapacityAvailable()
      Returns The total number of unused megabytes in the ASP.
      int getaspCapacityAvaProtected()
      Returns The number of unused megabytes in the ASP that are protected by mirroring or device parity.
      int getaspCapacityAvaUnprotected()
      Returns The number of unused megabytes in the ASP that are not protected by mirroring or device parity.
      int getaspCapacityProtected()
      Returns The total number of used and unused megabytes in the ASP that are protected by mirroring or device parity.
      int getaspCapacityUnprotected()
      Returns The total number of used and unused megabytes in the ASP that are not protected by mirroring or device parity.
      int getASPNumber()
      Returns the auxiliary storage pool (ASP) number.
      int getASPStatus()
      Returns the device configuration status of an auxiliary storage pool.
      int getaspSystemStorage()
      Returns The amount of storage in megabytes currently allocated in the ASP for system use.
      java.lang.String getaspType()
      Returns The type of ASP.
      int getASPUsage()
      Returns the use that is assigned to the auxiliary storage pool.
      java.lang.String getavaParitySetUnit()
      Returns An indicator of whether a disk unit is in an availability parity set.
      int getbalanceDataMoved()
      Returns The number of megabytes that have been moved by the balance function.
      int getbalanceDataRemain()
      Returns The number of megabytes that remain to be moved by the balance function before the move is considered complete.
      java.util.Date getbalanceDateTime()
      Returns The date and time of the last status change for the balance function.
      java.lang.String getbalanceStatus()
      Returns The current status of the balance function for this ASP.
      java.lang.String getbalanceType()
      Returns The type of balance activity that is currently running or was done last.
      int getblockTransfer2MainStorage()
      Returns The number of 512-byte blocks transferred from the disk unit since the last IPL.
      int getblockTransferFromMainStorage()
      Returns The number of 512-byte blocks transferred to the disk unit since the last IPL.
      java.lang.String getchangesWritten2Disk()
      Returns An indicator of whether all changes made the previous time the IASP was online were written to disk.
      java.lang.String getcompressedDiskUnitInASP()
      Returns Whether there are compressed disk units in the ASP.
      java.lang.String getcompressedStatus()
      Returns The current status of compression for this disk unit.
      java.lang.String getcompressedUnit()
      Returns The compression attribute of the disk unit.
      java.lang.String getcompressionRecoveryPolicy()
      The compression recovery policy for the ASP.
      int getcurrentCount()
      Returns The number of entities that have been processed by the function.
      int getcurrentItemCount()
      Returns The number of items that have been processed by the function.
      java.lang.String getDatabaseName()
      Returns the name that is assigned to the database that this ASP defines.
      java.lang.String getDevDescriptionName()
      Returns the auxiliary storage pool (ASP) device description name.
      int getdiskCapacity()
      Returns The total size of the disk unit in megabytes.
      java.lang.String getdiskModel()
      Returns The model of the disk unit.
      java.lang.String getdiskProtectionType()
      Returns The type of protection that has been assigned to this disk unit.
      java.lang.String getdiskResourceName()
      Returns The unique system-assigned name of the disk unit.
      java.lang.String getdiskSerialNumber()
      Returns The serial number of the disk unit.
      int getdiskStorageAvailable()
      Returns The number of megabytes of space not currently assigned.
      int getdiskStorageReserved()
      Returns The number of megabytes of auxiliary storage on the disk unit reserved for use by the system.
      java.lang.String getdiskType()
      Returns The type of disk unit Available in format: FORMAT_0300
      int getDiskUnitNumber()
      Returns the total number of disk units in the ASP.
      int getdiskUnitpresence()
      Returns Indicates whether disk units in the ASP were found on the system.
      java.lang.String getelapsedTime()
      Returns The time that has elapsed since the start of the function.
      java.lang.String getendImmeControl()
      Returns This field has meaning in the system ASP (ASP 1) only.
      java.lang.String geterrorCode()
      Returns An error code that identifies a hardware problem related to the use of an independent ASP (error codes are not available for other ASP types).
      java.lang.String getFormat()
      Returns the format that was used by AspOpenList to generate this item.
      java.lang.String getfunction()
      Returns The function that is currently running as part of a state transition for an ASP.
      int getgeographicMirrorCpDataStat()
      Returns The condition of the data on the target.
      int getgeographicMirrorCpStat()
      Returns The mirror state of the mirror copy.
      int getgeographicMirrorPerfMode()
      Returns The performance mode of the mirroring.
      int getgeographicMirrorResumePriority()
      Returns The resume priority following a suspend.
      int getgeographicMirrorRole()
      Returns The current role of a physical IASP.
      int getgeographicMirrorSuspendTimeout()
      Returns The number of seconds the production node waits for a response from the mirror copy node before suspending geographic mirroring.
      java.lang.String getjobName()
      Returns The simple job name of the job that is using an ASP.
      java.lang.String getjobNumber()
      Returns The system-assigned job number of the job that is using an ASP.
      java.lang.String getjobUserName()
      Returns The user name under which the job that is using an ASP was started.
      java.lang.String getmirroredUnitProtected()
      Returns The mirrored status of the mirrored pair of which this unit is a member.
      java.lang.String getmirroredUnitReported()
      Returns This mirrored unit reported present.
      java.lang.String getmirroredUnitStatus()
      Returns The mirrored status of the unit.
      java.lang.String getmirrorUnitIdentifier()
      Returns One of a pair of mirrored units.
      int getmultiConnDiskUnit() 
      java.lang.String getmultiConnectionUnit()
      Returns A disk unit may have multiple resource names.
      int getnotBusyCount()
      Returns The number of times the disk queue was empty during the same time period that the sample count was taken.
      java.lang.String getoverflowRecovery()
      Returns An indicator of the result of the ASP overflow recovery operation, which is performed during IPL at the user's request.
      int getOverflowStorage()
      Returns The number of megabytes of storage that has overflowed from the user ASP into the system ASP.
      int getpermanentBlockTransferFromMainStorage()
      Returns The number of 512-byte blocks of permanent storage transferred to the disk unit since the last IPL.
      java.lang.String getPrimaryASPResourceName()
      Returns the resource name of the primary ASP for a secondary ASP.
      java.lang.String getRAIDType()
      Returns The type of RAID protection that has been assigned to this disk unit.
      int getreqDataTransfer2MainStorage()
      Returns The number of input data transfer requests processed for the disk unit since the last IPL.
      int getreqDataTransferFromMainStorage()
      Returns The number of output data transfer requests processed for the disk unit since the last IPL.
      int getreqPermanentBlockTransferFromMainStorage()
      Returns The number of output permanent data transfer requests processed for the disk unit since the last IPL.
      java.lang.String getResourceName()
      Returns the auxiliary storage pool (ASP) resource name.
      int getsampleCount()
      Returns The number of times the disk queue was checked to determine whether or not the queue is empty.
      int getspace2ErrorLog()
      Returns The number of megabytes of auxiliary storage allocated to the error log.
      int getspace2MachineLog()
      Returns The number of megabytes of auxiliary storage allocated to the machine log.
      int getspace2MachineTreac()
      Returns The number of megabytes of auxiliary storage allocated to the machine trace.
      int getspace2Microcode()
      Returns The number of megabytes of auxiliary storage allocated to the microcode and space used by the microcode.
      int getspace4MainStoragedump()
      Returns The number of megabytes of auxiliary storage allocated to the main storage dump space.
      int getstorageThresholdPer()
      Returns When the storage in the ASP reaches this percentage, a warning message is sent to the QSYSOPR message queue.
      java.lang.String getstroageAllocationRestrictUnit()
      Returns An indicator of whether new storage allocations are allowed on the disk unit.
      java.lang.String getthreadIdentifier()
      Returns A value that addresses a particular thread within a job.
      java.lang.String getthreadStatus()
      Returns The current status of the thread.
      int gettotalCount()
      Returns The total number of entities to be processed by the function.
      int gettotalItemCount()
      Returns The total number of items that are to be processed by the function.
      java.util.Date gettraceDateTime()
      Returns The date and time of the last status change for the trace function.
      int gettraceDuration()
      Returns The number of minutes that the trace function has run collecting data for this ASP.
      java.lang.String gettraceStatus()
      Returns The current status of the trace function.
      java.lang.String gettranfitionTarget()
      Returns The state transition target of the ASP.
      int getunitControl()
      Returns The disk status for the disk unit.
      int getuseIdentification()
      Returns An identification of how an ASP is being used Available in format: FORMAT_0600
      int getVersion()
      Returns the version of objects in an independent ASP.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getASPNumber

        public int getASPNumber()
        Returns the auxiliary storage pool (ASP) number. Possible values are:
        • 1 - The system auxiliary storage pool (*SYSTEM).
        • 2-255 - The number of the auxiliary storage pool.

        Available in all format.

        Returns:
        The auxiliary storage pool number.
      • getResourceName

        public java.lang.String getResourceName()
        Returns the auxiliary storage pool (ASP) resource name.

        Available in format: FORMAT_0100, FORMAT_0300

        Returns:
        The auxiliary storage pool resource name.
      • getDevDescriptionName

        public java.lang.String getDevDescriptionName()
        Returns the auxiliary storage pool (ASP) device description name.

        Available in format: FORMAT_0100

        Returns:
        The auxiliary storage pool device description name.
      • getVersion

        public int getVersion()
        Returns the version of objects in an independent ASP. Possible values are:
        • 0 - Objects are usable by a system at release level V5R1M0.
        • 1 - Objects are usable by a system at release level V5R2M0.
        • 2 - Objects are usable by a system at release level V5R3M0.
        • 3 - Objects are usable by a system at release level V5R4M0.
        • 4 - Objects are usable by a system at release level V6R1M0.
        • 5 - Objects are usable by a system at release level V7R1M0.
        • 6 - Objects are usable by a system at release level V7R2M0.
        • 7 - Objects are usable by a system at release level V7R3M0.

        Available in format: FORMAT_0100

        Returns:
        The version of objects in an independent ASP.
      • getASPUsage

        public int getASPUsage()
        Returns the use that is assigned to the auxiliary storage pool. Possible values are:
        • 0 - The usage attribute does not apply or is not known. This value is used for the system ASP, any basic user ASPs and any independent ASPs whose use cannot be determined (eg, one whose disk drives are not powered on).
        • 1 - The ASP is a user-defined file system ASP.
        • 2 - The ASP is a primary ASP.
        • 3 - The ASP is a secondary ASP.

        Available in format: FORMAT_0100

        Returns:
        The use that is assigned to the auxiliary storage pool.
      • getASPStatus

        public int getASPStatus()
        Returns the device configuration status of an auxiliary storage pool. Possible values are:
        • 0 - There is no status. This value is used for the system ASP and any basic user ASPs.
        • 1 - The status of the ASP is varyoff.
        • 2 - The status of the ASP is varyon.
        • 3 - The status of the ASP is active.
        • 4 - The status of the ASP is available.

        Available in format: FORMAT_0100

        Returns:
        The device configuration status of an auxiliary storage pool.
      • getDatabaseName

        public java.lang.String getDatabaseName()
        Returns the name that is assigned to the database that this ASP defines. If the ASP is neither a primary or secondary ASP, this field consists of blanks.

        Available in format: FORMAT_0100

        Returns:
        The name that is assigned to the database that this ASP defines. If the ASP is neither a primary or secondary ASP, this field consists of blanks.
      • getPrimaryASPResourceName

        public java.lang.String getPrimaryASPResourceName()
        Returns the resource name of the primary ASP for a secondary ASP. Only a secondary ASP contains this value.

        Available in format: FORMAT_0100

        Returns:
        The resource name of the primary ASP for a secondary ASP. Only a secondary ASP contains this value.
      • getDiskUnitNumber

        public int getDiskUnitNumber()
        Returns the total number of disk units in the ASP. If mirroring is active for disk units within the ASP, the mirrored pair of units is counted as one.

        Available in format: FORMAT_0200,FORMAT_0300,FORMAT_0400

        Returns:
        The total number of disk units in the ASP. If mirroring is active for disk units within the ASP, the mirrored pair of units is counted as one.
      • getaspCapacity

        public int getaspCapacity()
        Returns the total number of used and unused megabytes in the ASP. A special value of -2 is returned if the size of this field is exceeded.

        Available in format: FORMAT_0200

        Returns:
        The total number of used and unused megabytes in the ASP. A special value of -2 is returned if the size of this field is exceeded.
      • getaspCapacityAvailable

        public int getaspCapacityAvailable()
        Returns The total number of unused megabytes in the ASP. A special value of -2 is returned if the size of this field is exceeded.

        Available in format: FORMAT_0200

        Returns:
        The total number of unused megabytes in the ASP. A special value of -2 is returned if the size of this field is exceeded.
      • getaspCapacityProtected

        public int getaspCapacityProtected()
        Returns The total number of used and unused megabytes in the ASP that are protected by mirroring or device parity. A special value of -2 is returned if the size of this field is exceeded

        Available in format: FORMAT_0200

        Returns:
        The total number of used and unused megabytes in the ASP that are protected by mirroring or device parity. A special value of -2 is returned if the size of this field is exceeded
      • getaspCapacityAvaProtected

        public int getaspCapacityAvaProtected()
        Returns The number of unused megabytes in the ASP that are protected by mirroring or device parity. A special value of -2 is returned if the size of this field is exceeded.

        Available in format: FORMAT_0200

        Returns:
        The number of unused megabytes in the ASP that are protected by mirroring or device parity. A special value of -2 is returned if the size of this field is exceeded.
      • getaspCapacityUnprotected

        public int getaspCapacityUnprotected()
        Returns The total number of used and unused megabytes in the ASP that are not protected by mirroring or device parity. A special value of -2 is returned if the size of this field is exceeded.

        Available in format: FORMAT_0200

        Returns:
        The total number of used and unused megabytes in the ASP that are not protected by mirroring or device parity. A special value of -2 is returned if the size of this field is exceeded.
      • getaspCapacityAvaUnprotected

        public int getaspCapacityAvaUnprotected()
        Returns The number of unused megabytes in the ASP that are not protected by mirroring or device parity. A special value of -2 is returned if the size of this field is exceeded.

        Available in format: FORMAT_0200

        Returns:
        The number of unused megabytes in the ASP that are not protected by mirroring or device parity. A special value of -2 is returned if the size of this field is exceeded.
      • getaspSystemStorage

        public int getaspSystemStorage()
        Returns The amount of storage in megabytes currently allocated in the ASP for system use.

        Available in format: FORMAT_0200

        Returns:
        The amount of storage in megabytes currently allocated in the ASP for system use.
      • getOverflowStorage

        public int getOverflowStorage()
        Returns The number of megabytes of storage that has overflowed from the user ASP into the system ASP. A special value of -2 is returned if the size of this field is exceeded.

        Available in format: FORMAT_0200

        Returns:
        The number of megabytes of storage that has overflowed from the user ASP into the system ASP. A special value of -2 is returned if the size of this field is exceeded.
      • getspace2ErrorLog

        public int getspace2ErrorLog()
        Returns The number of megabytes of auxiliary storage allocated to the error log.

        Available in format: FORMAT_0200

        Returns:
        The number of megabytes of auxiliary storage allocated to the error log.
      • getspace2MachineLog

        public int getspace2MachineLog()
        Returns The number of megabytes of auxiliary storage allocated to the machine log.

        Available in format: FORMAT_0200

        Returns:
        The number of megabytes of auxiliary storage allocated to the machine log.
      • getspace2MachineTreac

        public int getspace2MachineTreac()
        Returns The number of megabytes of auxiliary storage allocated to the machine trace.

        Available in format: FORMAT_0200

        Returns:
        The number of megabytes of auxiliary storage allocated to the machine trace.
      • getspace4MainStoragedump

        public int getspace4MainStoragedump()
        Returns The number of megabytes of auxiliary storage allocated to the main storage dump space.

        Available in format: FORMAT_0200

        Returns:
        The number of megabytes of auxiliary storage allocated to the main storage dump space.
      • getspace2Microcode

        public int getspace2Microcode()
        Returns The number of megabytes of auxiliary storage allocated to the microcode and space used by the microcode.

        Available in format: FORMAT_0200

        Returns:
        The number of megabytes of auxiliary storage allocated to the microcode and space used by the microcode.
      • getstorageThresholdPer

        public int getstorageThresholdPer()
        Returns When the storage in the ASP reaches this percentage, a warning message is sent to the QSYSOPR message queue. When this percentage is reached for the system ASP (ASP 1), message CPF0907 is sent. When this percentage is reached for one of the user ASPs, message CPI0953 is sent.

        Available in format: FORMAT_0200

        Returns:
        When the storage in the ASP reaches this percentage, a warning message is sent to the QSYSOPR message queue. When this percentage is reached for the system ASP (ASP 1), message CPF0907 is sent. When this percentage is reached for one of the user ASPs, message CPI0953 is sent.
      • getaspType

        public java.lang.String getaspType()
        Returns The type of ASP. The possible ASP types are:
        • 00 - The ASP is the system ASP.
        • 10 - The ASP is a user ASP that does not contain libraries.
        • 20 - The ASP is a user ASP that does contain libraries.

        Available in format: FORMAT_0200

        Returns:
        The type of ASP.
      • getoverflowRecovery

        public java.lang.String getoverflowRecovery()
        Returns An indicator of the result of the ASP overflow recovery operation, which is performed during IPL at the user's request. When this operation is requested, the machine attempts to recover the user ASP from an overflow condition by moving overflowed auxiliary storage from the system ASP back to the user ASP during the storage management recovery step of an IPL.
        • 0 - All overflowed storage was successfully moved.
        • 1 - ASP overflow recovery failed due to insufficient space in the user ASP.
        • 2 - ASP overflow recovery was cancelled prior to completion.

        Available in format: FORMAT_0200

        Returns:
        An indicator of the result of the ASP overflow recovery operation, which is performed during IPL at the user's request. When this operation is requested, the machine attempts to recover the user ASP from an overflow condition by moving overflowed auxiliary storage from the system ASP back to the user ASP during the storage management recovery step of an IPL.
      • getendImmeControl

        public java.lang.String getendImmeControl()
        Returns This field has meaning in the system ASP (ASP 1) only. The possible ASP types are:
        • 0 - If a request for space in the system ASP cannot be satisfied because there is not enough storage, the system will be allowed to continue running.
        • 1 - If a request for space in the system ASP cannot be satisfied because there is not enough storage, the system will be ended immediately.

        Available in format: FORMAT_0200

        Returns:
        This field has meaning in the system ASP (ASP 1) only.
      • getcompressionRecoveryPolicy

        public java.lang.String getcompressionRecoveryPolicy()
        The compression recovery policy for the ASP. If the ASP has compressed drives as part of its configuration, this value controls how overflow situations are handled for this ASP. The following policies allow the user to control what is done when the ASP appears full. For more information about the compression recovery policy, see the Recovering your system topic collection. The following values are returned:
        • 1 - When the system detects that the ASP capacity is about to be exceeded, the system posts system reference code (SRC) A6xx 0277 in the system control panel and waits for a limited time for space to become available. If space becomes available before the limited time ends, the SRC is removed from the system control panel and normal operations resume. If space does not become available before the limited time ends, data overflows into the system ASP.
        • 2 - When the system detects that the ASP capacity is about to be exceeded, the data immediately overflows into the system ASP.
        • 3 - When the system detects that the ASP capacity is about to be exceeded, the system posts SRC A6xx 0277 in the system control panel and waits indefinitely for space to become available. The user must take action before normal operation resumes. Possible actions include deleting objects from the ASP or changing the compression recovery policy to a value that allows the ASP to overflow.

        Available in format: FORMAT_0200

        Returns:
        The compression recovery policy for the ASP. If the ASP has compressed drives as part of its configuration, this value controls how overflow situations are handled for this ASP. The following policies allow the user to control what is done when the ASP appears full. For more information about the compression recovery policy, see the Recovering your system topic collection.
      • getcompressedDiskUnitInASP

        public java.lang.String getcompressedDiskUnitInASP()
        Returns Whether there are compressed disk units in the ASP. The following special values are returned:
        • 0 - If a request for space in the system ASP cannot be satisfied because there is not enough storage, the system will be allowed to continue running.
        • 1 - If a request for space in the system ASP cannot be satisfied because there is not enough storage, the system will be ended immediately.

        Available in format: FORMAT_0200

        Returns:
        Whether there are compressed disk units in the ASP.
      • getbalanceStatus

        public java.lang.String getbalanceStatus()
        Returns The current status of the balance function for this ASP. This field is valid for an IASP if its status is either ACTIVE or AVAILABLE, otherwise hexadecimal zeros are returned. The following special values are returned:
        • 0 - No balance activity has occurred for this ASP.
        • 1 - The ASP balance function is currently running for this ASP.
        • 2 - The ASP balance function is currently in the process of ending. Either the time limit has run out or the End ASP Balance (ENDASPBAL) command was issued for this ASP.
        • 3 - The ASP balance function has run, but was ended before the ASP was completely balanced. The Start ASP Balance (STRASPBAL) command can be used to restart the balance function.
        • 4 - The ASP balance function has completed running. The ASP is completely balanced.

        Available in format: FORMAT_0200

        Returns:
        The current status of the balance function for this ASP. This field is valid for an IASP if its status is either ACTIVE or AVAILABLE, otherwise hexadecimal zeros are returned.
      • getbalanceType

        public java.lang.String getbalanceType()
        Returns The type of balance activity that is currently running or was done last. This field is valid for an IASP if its status is either ACTIVE or AVAILABLE, otherwise hexadecimal zeros are returned. The possible types of ASP balancing are:
        • 0 - No balance activity has occurred for this ASP.
        • 1 - Capacity balancing. Capacity balancing redistributes data so that the percentage of disk space used is the same on all disk units within the ASP.
        • 2 - Usage balancing. Usage balancing redistributes data so that the percentage of disk activity is the same on all disk units within the ASP. High-use and low-use data is identified by running the Trace ASP Balance (TRCASPBAL) command. Usage balancing moves data among the disk units, guided by the trace results, in an attempt to equalize the utilizations.
        • 3 - Heirarchical Storage Management (HSM) balancing. HSM balancing can be run only on an ASP that contains a mixture of high-performance and low-performance disk units. An example of low-performance disk units is compressed disk units. The HSM balance function moves high-use data to high-performance units and moves low-use data to low-performance units. The high-use and low-use data is identified by running the Trace ASP Balance (TRCASPBAL) command.
        • 4 - Clear collection data. Clear collection data removes the trace data created by running the Trace ASP Balance (TRCASPBAL) command.
        • 5 - Move data. Move data is used to reduce the down time associated with removing a disk unit. The Check ASP Balance (CHKASPBAL) command can be used to determine which units are currently marked to no longer receive new allocations and to have their existing allocations moved to other disk units.
        • 6 - Media Preference (MP) balancing. MP balancing can be run only on an ASP that contains a mixture of Solid State Disk (SSD) units and Hard Disk Drive (HDD) units. The goal of the MP balance function is to have high-use data on SSD units and low-use data on HDD units. The high-use and low-use data is identified by running the Trace ASP Balance (TRCASPBAL) command.

        Available in format: FORMAT_0200

        Returns:
        The type of balance activity that is currently running or was done last. This field is valid for an IASP if its status is either ACTIVE or AVAILABLE, otherwise hexadecimal zeros are returned.
      • getbalanceDateTime

        public java.util.Date getbalanceDateTime()
        Returns The date and time of the last status change for the balance function. This field is valid for an IASP if its status is either ACTIVE or AVAILABLE, otherwise hexadecimal zeros are returned. The 13 characters are:
        • 1 Century, where 0 indicates years 19xx and 1 indicates years 20xx.
        • 2-7 The date, in YYMMDD (year, month, day) format.
        • 8-13 The time of day, in HHMMSS (hours, minutes, seconds) format.

        Available in format: FORMAT_0200

        Returns:
        The date and time of the last status change for the balance function. This field is valid for an IASP if its status is either ACTIVE or AVAILABLE, otherwise hexadecimal zeros are returned.
      • getbalanceDataMoved

        public int getbalanceDataMoved()
        Returns The number of megabytes that have been moved by the balance function. A special value of -2 is returned if the size of this field is exceeded. If the ASP status is neither ACTIVE nor AVAILABLE, 0 is returned.

        Available in format: FORMAT_0200

        Returns:
        The number of megabytes that have been moved by the balance function. A special value of -2 is returned if the size of this field is exceeded. If the ASP status is neither ACTIVE nor AVAILABLE, 0 is returned.
      • getbalanceDataRemain

        public int getbalanceDataRemain()
        Returns The number of megabytes that remain to be moved by the balance function before the move is considered complete. A special value of -2 is returned if the size of this field is exceeded. If the ASP status is neither ACTIVE nor AVAILABLE, 0 is returned.

        Available in format: FORMAT_0200

        Returns:
        The number of megabytes that remain to be moved by the balance function before the move is considered complete. A special value of -2 is returned if the size of this field is exceeded. If the ASP status is neither ACTIVE nor AVAILABLE, 0 is returned.
      • gettraceDuration

        public int gettraceDuration()
        Returns The number of minutes that the trace function has run collecting data for this ASP. The trace can be run multiple times for an ASP. If the ASP status is neither ACTIVE nor AVAILABLE, zero is returned.

        Available in format: FORMAT_0200

        Returns:
        The number of minutes that the trace function has run collecting data for this ASP. The trace can be run multiple times for an ASP. If the ASP status is neither ACTIVE nor AVAILABLE, zero is returned.
      • gettraceStatus

        public java.lang.String gettraceStatus()
        Returns The current status of the trace function. The trace gathers statistics about the data on the disk units within the ASP. This data is used by the balance functions. This field is valid for an IASP if its status is either ACTIVE or AVAILABLE, otherwise hexadecimal zeros are returned. The following special values are returned:
        • 0 - There is no current trace data for this ASP.
        • 1 - The trace function is currently running for this ASP.
        • 2 - The trace function is currently in the process of ending. Either the time limit has run out or the trace was stopped through use of the Trace ASP Balance (TRCASPBAL) command.
        • 3 - The trace function has completed running. The statistics for the ASP have been gathered and are ready for the balance function to start.
        • 4 - The trace data for this ASP is being cleared.
        • 5 - The trace function has completed and the statistics for the ASP have been gathered. The ASP is ready for further collection or for the balance function to start.

        Available in format: FORMAT_0200

        Returns:
        The current status of the trace function. The trace gathers statistics about the data on the disk units within the ASP. This data is used by the balance functions. This field is valid for an IASP if its status is either ACTIVE or AVAILABLE, otherwise hexadecimal zeros are returned.
      • gettraceDateTime

        public java.util.Date gettraceDateTime()
        Returns The date and time of the last status change for the trace function. The 13 characters are:
        • 1 Century, where 0 indicates years 19xx and 1 indicates years 20xx.
        • 2-7 The date, in YYMMDD (year, month, day) format.
        • 8-13 The time of day, in HHMMSS (hours, minutes, seconds) format.

        Available in format: FORMAT_0200

        Returns:
        The date and time of the last status change for the trace function.
      • getchangesWritten2Disk

        public java.lang.String getchangesWritten2Disk()
        Returns An indicator of whether all changes made the previous time the IASP was online were written to disk. Varyoff processing attempts to write changed IASP storage but, in some failures, it may not be successful.
        • 0 - Not all changes were written.
        • 1 - All changes were written.

        Available in format: FORMAT_0200

        Returns:
        An indicator of whether all changes made the previous time the IASP was online were written to disk. Varyoff processing attempts to write changed IASP storage but, in some failures, it may not be successful.
      • getmultiConnDiskUnit

        public int getmultiConnDiskUnit()
      • getgeographicMirrorRole

        public int getgeographicMirrorRole()
        Returns The current role of a physical IASP.
        • 0 - Geographic mirroring is not configured.
        • 1 - System does not own a physical IASP copy.
        • 2 - Geographic mirror role is unknown.
        • 196 - System owns a detached mirror copy.
        • 212 - System owns the mirror copy.
        • 215 - System owns the production copy.

        Available in format: FORMAT_0200

        Returns:
        The current role of a physical IASP.
      • getgeographicMirrorCpStat

        public int getgeographicMirrorCpStat()
        Returns The mirror state of the mirror copy.
        • 0 - Geographic mirroring is not configured.
        • 1 - The system attempts to perform geographic mirroring when the IASP is online.
        • 2 - The geographic mirroring role is resuming.
        • 3 - The system is resuming and the IASP is online and performing synchronization.
        • 4 - The geographic mirroring mirror copy is suspended and geographic mirroring is not being performed.

        Available in format: FORMAT_0200

        Returns:
        The mirror state of the mirror copy.
      • getgeographicMirrorCpDataStat

        public int getgeographicMirrorCpDataStat()
        Returns The condition of the data on the target.
        • 0 - Geographic mirroring is not configured.
        • 1 - The remote copy is absolutely in sync with the production copy.
        • 2 - The remote copy contains usable data. A detached mirror copy always has this state.
        • 3 - There is incoherent data in the mirror copy and the data cannot be used.

        Available in format: FORMAT_0200

        Returns:
        The condition of the data on the target.
      • getgeographicMirrorSuspendTimeout

        public int getgeographicMirrorSuspendTimeout()
        Returns The number of seconds the production node waits for a response from the mirror copy node before suspending geographic mirroring.

        Available in format: FORMAT_0200

        Returns:
        The number of seconds the production node waits for a response from the mirror copy node before suspending geographic mirroring.
      • getgeographicMirrorPerfMode

        public int getgeographicMirrorPerfMode()
        Returns The performance mode of the mirroring.
        • -1 - The performance mode is unknown.
        • 0 - There is no performance mode.
        • 1 - The performance mode is synchronous.
        • 2 - The performance mode is asynchronous.

        Available in format: FORMAT_0200

        Returns:
        The performance mode of the mirroring.
      • getdiskUnitpresence

        public int getdiskUnitpresence()
        Returns Indicates whether disk units in the ASP were found on the system.
        • 0 - No disk units were found.
        • 1 - The disk unit that is used to provide the identity of the ASP was found but some other disk units were not found.
        • 2 - All disk units were found.

        Available in format: FORMAT_0200

        Returns:
        Indicates whether disk units in the ASP were found on the system.
      • getgeographicMirrorResumePriority

        public int getgeographicMirrorResumePriority()
        Returns The resume priority following a suspend.
        • -1 - The priority is unknown.
        • 0 - There is no priority.
        • 1 - The priority is low.
        • 2 - The priority is medium.
        • 3 - The priority is high.

        Available in format: FORMAT_0200

        Returns:
        The resume priority following a suspend.
      • getdiskType

        public java.lang.String getdiskType()
        Returns The type of disk unit

        Available in format: FORMAT_0300

        Returns:
        The type of disk unit
      • getdiskModel

        public java.lang.String getdiskModel()
        Returns The model of the disk unit.

        Available in format: FORMAT_0300

        Returns:
        The model of the disk unit.
      • getdiskSerialNumber

        public java.lang.String getdiskSerialNumber()
        Returns The serial number of the disk unit.

        Available in format: FORMAT_0300

        Returns:
        The serial number of the disk unit.
      • getdiskResourceName

        public java.lang.String getdiskResourceName()
        Returns The unique system-assigned name of the disk unit.

        Available in format: FORMAT_0300

        Returns:
        The unique system-assigned name of the disk unit.
      • getdiskCapacity

        public int getdiskCapacity()
        Returns The total size of the disk unit in megabytes.

        Available in format: FORMAT_0300

        Returns:
        The total size of the disk unit in megabytes.
      • getdiskStorageAvailable

        public int getdiskStorageAvailable()
        Returns The number of megabytes of space not currently assigned.

        Available in format: FORMAT_0300

        Returns:
        The number of megabytes of space not currently assigned.
      • getdiskStorageReserved

        public int getdiskStorageReserved()
        Returns The number of megabytes of auxiliary storage on the disk unit reserved for use by the system. This storage contains system data related to hardware configuration, hardware error processing, and so forth.

        Available in format: FORMAT_0300

        Returns:
        The number of megabytes of auxiliary storage on the disk unit reserved for use by the system. This storage contains system data related to hardware configuration, hardware error processing, and so forth.
      • getmirroredUnitProtected

        public java.lang.String getmirroredUnitProtected()
        Returns The mirrored status of the mirrored pair of which this unit is a member.
        • 0 - One mirrored unit of a mirrored pair is not active.
        • 1 - Both mirrored units of a mirrored pair are active.

        Available in format: FORMAT_0300

        Returns:
        The mirrored status of the mirrored pair of which this unit is a member.
      • getmirroredUnitReported

        public java.lang.String getmirroredUnitReported()
        Returns This mirrored unit reported present. Information concerning this unit may or may not be current.
        • 0 - The mirrored unit is missing. Information concerning the unit may not be current.
        • 1 - The mirrored unit reported at the time this information was gathered. The information is current to that point in time.

        Available in format: FORMAT_0300

        Returns:
        This mirrored unit reported present. Information concerning this unit may or may not be current.
      • getmirroredUnitStatus

        public java.lang.String getmirroredUnitStatus()
        Returns The mirrored status of the unit.
        • 0 - This mirrored unit of a mirrored pair is active (that is, online with current data).
        • 1 - This mirrored unit is being synchronized.
        • 2 - This mirrored unit is suspended.

        Available in format: FORMAT_0300

        Returns:
        The mirrored status of the unit.
      • getRAIDType

        public java.lang.String getRAIDType()
        Returns The type of RAID protection that has been assigned to this disk unit. The following values are returned:
        • 0 - No storage protection has been set up for this disk unit.
        • 5 - This disk unit has been set up with RAID 5 protection.
        • 6 - This disk unit has been set up with RAID 6 protection.

        Available in format: FORMAT_0300

        Returns:
        The type of RAID protection that has been assigned to this disk unit.
      • getunitControl

        public int getunitControl()
        Returns The disk status for the disk unit. The possible values for the field are:
        • 0 - There is no unit control value.
        • 1 - The disk unit is active.
        • 2 - The disk unit has failed.
        • 3 - Some other disk unit in the disk subsystem has failed.
        • 4 - There is a hardware failure within the disk subsystem that affects performance, but does not affect the function of the disk unit.
        • 5 - There is a hardware failure within the disk subsystem that does not affect the function or performance of the disk unit.
        • 6 - The disk unit's parity protection is being rebuilt.
        • 7 - The disk unit is not ready.
        • 8 - The disk unit is write protected.
        • 9 - The disk unit is busy.
        • 10 - The disk unit is not operational.
        • 11 - The disk unit has returned a status that is not recognizable by the system.
        • 12 - The disk unit cannot be accessed.
        • 13 - The disk unit is read/write protected.

        Available in format: FORMAT_0300

        Returns:
        The disk status for the disk unit.
      • getblockTransfer2MainStorage

        public int getblockTransfer2MainStorage()
        Returns The number of 512-byte blocks transferred from the disk unit since the last IPL. This value wraps around to zero and continues counting in the case of an overflow of the field with no indication of the overflow having occurred.

        Available in format: FORMAT_0300

        Returns:
        The number of 512-byte blocks transferred from the disk unit since the last IPL. This value wraps around to zero and continues counting in the case of an overflow of the field with no indication of the overflow having occurred.
      • getblockTransferFromMainStorage

        public int getblockTransferFromMainStorage()
        Returns The number of 512-byte blocks transferred to the disk unit since the last IPL. This value wraps around to zero and continues counting in the case of an overflow of the field with no indication of the overflow having occurred.

        Available in format: FORMAT_0300

        Returns:
        The number of 512-byte blocks transferred to the disk unit since the last IPL. This value wraps around to zero and continues counting in the case of an overflow of the field with no indication of the overflow having occurred.
      • getreqDataTransfer2MainStorage

        public int getreqDataTransfer2MainStorage()
        Returns The number of input data transfer requests processed for the disk unit since the last IPL. If the field overflows, this value wraps around to zero and continues counting, with no indication that the overflow occurred. This value is not directly related to the number of blocks transferred for the disk unit because the number of blocks to be transferred for a given transfer request can vary greatly.

        Available in format: FORMAT_0300

        Returns:
        The number of input data transfer requests processed for the disk unit since the last IPL. If the field overflows, this value wraps around to zero and continues counting, with no indication that the overflow occurred. This value is not directly related to the number of blocks transferred for the disk unit because the number of blocks to be transferred for a given transfer request can vary greatly.
      • getreqDataTransferFromMainStorage

        public int getreqDataTransferFromMainStorage()
        Returns The number of output data transfer requests processed for the disk unit since the last IPL. If the field overflows, this value wraps around to zero and continues counting, with no indication that the overflow occurred. This value is not directly related to the number of blocks transferred for the disk unit because the number of blocks to be transferred for a given transfer request can vary greatly.

        Available in format: FORMAT_0300

        Returns:
        The number of output data transfer requests processed for the disk unit since the last IPL. If the field overflows, this value wraps around to zero and continues counting, with no indication that the overflow occurred. This value is not directly related to the number of blocks transferred for the disk unit because the number of blocks to be transferred for a given transfer request can vary greatly.
      • getpermanentBlockTransferFromMainStorage

        public int getpermanentBlockTransferFromMainStorage()
        Returns The number of 512-byte blocks of permanent storage transferred to the disk unit since the last IPL. If the field overflows, this value wraps around to zero and continues counting, with no indication that the overflow condition occurred.

        Available in format: FORMAT_0300

        Returns:
        The number of 512-byte blocks of permanent storage transferred to the disk unit since the last IPL. If the field overflows, this value wraps around to zero and continues counting, with no indication that the overflow condition occurred.
      • getreqPermanentBlockTransferFromMainStorage

        public int getreqPermanentBlockTransferFromMainStorage()
        Returns The number of output permanent data transfer requests processed for the disk unit since the last IPL. If the field overflows, this value wraps around to zero and continues counting, with no indication that the overflow occurred. This value is not directly related to the permanent blocks transferred from main storage for the disk unit because the number of blocks transferred for a given transfer request can vary greatly.

        Available in format: FORMAT_0300

        Returns:
        The number of output permanent data transfer requests processed for the disk unit since the last IPL. If the field overflows, this value wraps around to zero and continues counting, with no indication that the overflow occurred. This value is not directly related to the permanent blocks transferred from main storage for the disk unit because the number of blocks transferred for a given transfer request can vary greatly.
      • getsampleCount

        public int getsampleCount()
        Returns The number of times the disk queue was checked to determine whether or not the queue is empty.

        Available in format: FORMAT_0300

        Returns:
        The number of times the disk queue was checked to determine whether or not the queue is empty.
      • getnotBusyCount

        public int getnotBusyCount()
        Returns The number of times the disk queue was empty during the same time period that the sample count was taken.

        Available in format: FORMAT_0300

        Returns:
        The number of times the disk queue was empty during the same time period that the sample count was taken.
      • getcompressedStatus

        public java.lang.String getcompressedStatus()
        Returns The current status of compression for this disk unit. The following values are returned:
        • 0 - Compression for this disk unit is not active.
        • 1 - Compression for this disk unit is active.

        Available in format: FORMAT_0300

        Returns:
        The current status of compression for this disk unit.
      • getdiskProtectionType

        public java.lang.String getdiskProtectionType()
        Returns The type of protection that has been assigned to this disk unit. The following values are returned:
        • 0 - No storage protection has been set up for this disk unit.
        • 1 - This disk unit has been set up with mirrored protection.
        • 2 - This disk unit is part of a parity protection array.

        Available in format: FORMAT_0300

        Returns:
        The type of protection that has been assigned to this disk unit.
      • getcompressedUnit

        public java.lang.String getcompressedUnit()
        Returns The compression attribute of the disk unit.
        • 0 - Data on the disk unit is not compressed.
        • 1 - Data on the disk unit is compressed.

        Available in format: FORMAT_0300

        Returns:
        The compression attribute of the disk unit.
      • getstroageAllocationRestrictUnit

        public java.lang.String getstroageAllocationRestrictUnit()
        Returns An indicator of whether new storage allocations are allowed on the disk unit.
        • 0 - The disk unit does not allow new storage allocations.
        • 1 - The disk unit allows new storage allocations.

        Available in format: FORMAT_0300

        Returns:
        An indicator of whether new storage allocations are allowed on the disk unit.
      • getmultiConnectionUnit

        public java.lang.String getmultiConnectionUnit()
        Returns A disk unit may have multiple resource names. Each resource name represents a unique connection to the disk unit. All active connections are used to communicate with the disk unit. This attribute indicates whether the disk unit has more than one connection.
        • 0 - The disk unit has only one connection.
        • 1 - The disk unit has more than one connection.

        Available in format: FORMAT_0300

        Returns:
        A disk unit may have multiple resource names. Each resource name represents a unique connection to the disk unit. All active connections are used to communicate with the disk unit. This attribute indicates whether the disk unit has more than one connection.
      • getavaParitySetUnit

        public java.lang.String getavaParitySetUnit()
        Returns An indicator of whether a disk unit is in an availability parity set.
        • 0 - The disk unit is not in an availability parity set.
        • 1 - The disk unit is in an availability parity set.

        Available in format: FORMAT_0300

        Returns:
        An indicator of whether a disk unit is in an availability parity set.
      • geterrorCode

        public java.lang.String geterrorCode()
        Returns An error code that identifies a hardware problem related to the use of an independent ASP (error codes are not available for other ASP types). An error code of less than 1000 is an error. An error code of 1000 or greater is a warning. The possible error code values and their descriptions and recovery actions can be found in message file QSYS/QCPFMSG in these messages: CPDB8E0, CPDB8E1, CPDB8E2 and CPDB8E3.

        Available in format: FORMAT_0400

        Returns:
        An error code that identifies a hardware problem related to the use of an independent ASP (error codes are not available for other ASP types). An error code of less than 1000 is an error. An error code of 1000 or greater is a warning. The possible error code values and their descriptions and recovery actions can be found in message file QSYS/QCPFMSG in these messages: CPDB8E0, CPDB8E1, CPDB8E2 and CPDB8E3.
      • getmirrorUnitIdentifier

        public java.lang.String getmirrorUnitIdentifier()
        Returns One of a pair of mirrored units. The possible values are:
        • 0 - The disk unit is not mirrored or the error does not relate to a specific disk unit.
        • 1 - The first half of a mirrored pair.
        • 2 - The second half of a mirrored pair.

        Available in format: FORMAT_0400

        Returns:
        One of a pair of mirrored units. The possible values are:
      • gettranfitionTarget

        public java.lang.String gettranfitionTarget()
        Returns The state transition target of the ASP. This field is valid for an IASP if its status is either ACTIVE or AVAILABLE, otherwise hexadecimal zeros are returned. The possible values are:
        • 0 - The ASP is not in a state transition.
        • 1 - The disk unit has more than one connection.

        Available in format: FORMAT_0500

        Returns:
        The state transition target of the ASP. This field is valid for an IASP if its status is either ACTIVE or AVAILABLE, otherwise hexadecimal zeros are returned.
      • getfunction

        public java.lang.String getfunction()
        Returns The function that is currently running as part of a state transition for an ASP.

        Available in format: FORMAT_0500

        Returns:
        The function that is currently running as part of a state transition for an ASP.
      • getcurrentCount

        public int getcurrentCount()
        Returns The number of entities that have been processed by the function. The definition of an entity depends on the function; it may be an object, an address, a data structure, and so on.

        Available in format: FORMAT_0500

        Returns:
        The number of entities that have been processed by the function. The definition of an entity depends on the function; it may be an object, an address, a data structure, and so on.
      • gettotalCount

        public int gettotalCount()
        Returns The total number of entities to be processed by the function. The definition of an entity depends on the function; it may be an object, an address, a data structure, and so forth.

        Available in format: FORMAT_0500

        Returns:
        The total number of entities to be processed by the function. The definition of an entity depends on the function; it may be an object, an address, a data structure, and so forth.
      • getcurrentItemCount

        public int getcurrentItemCount()
        Returns The number of items that have been processed by the function. The definition of an item depends on the function.

        Available in format: FORMAT_0500

        Returns:
        The number of items that have been processed by the function. The definition of an item depends on the function.
      • gettotalItemCount

        public int gettotalItemCount()
        Returns The total number of items that are to be processed by the function. An item is a part of an object, but has no precise definition; that is, items differ by object type if an object type has them at all.

        Available in format: FORMAT_0500

        Returns:
        The total number of items that are to be processed by the function. An item is a part of an object, but has no precise definition; that is, items differ by object type if an object type has them at all.
      • getelapsedTime

        public java.lang.String getelapsedTime()
        Returns The time that has elapsed since the start of the function. This value is in the format HHMMSS where HH is the hour, MM is the minute, and SS is the second.

        Available in format: FORMAT_0500

        Returns:
        The time that has elapsed since the start of the function. This value is in the format HHMMSS where HH is the hour, MM is the minute, and SS is the second.
      • getuseIdentification

        public int getuseIdentification()
        Returns An identification of how an ASP is being used

        Available in format: FORMAT_0600

        Returns:
        An identification of how an ASP is being used
      • getjobName

        public java.lang.String getjobName()
        Returns The simple job name of the job that is using an ASP.

        Available in format: FORMAT_0600

        Returns:
        The simple job name of the job that is using an ASP.
      • getjobUserName

        public java.lang.String getjobUserName()
        Returns The user name under which the job that is using an ASP was started.

        Available in format: FORMAT_0600

        Returns:
        The user name under which the job that is using an ASP was started.
      • getjobNumber

        public java.lang.String getjobNumber()
        Returns The system-assigned job number of the job that is using an ASP.

        Available in format: FORMAT_0600

        Returns:
        The system-assigned job number of the job that is using an ASP.
      • getthreadIdentifier

        public java.lang.String getthreadIdentifier()
        Returns A value that addresses a particular thread within a job. While the thread identifier uniquely identifies the thread within the job, the thread handle can improve performance when referencing the thread.

        Available in format: FORMAT_0600

        Returns:
        A value that addresses a particular thread within a job. While the thread identifier uniquely identifies the thread within the job, the thread handle can improve performance when referencing the thread.
      • getthreadStatus

        public java.lang.String getthreadStatus()
        Returns The current status of the thread. Refer to the description of Thread status in Work Management API Attribute Descriptions for the possible values that can be returned.

        Available in format: FORMAT_0600

        Returns:
        The current status of the thread. Refer to the description of Thread status in Work Management API Attribute Descriptions for the possible values that can be returned.
      • getFormat

        public java.lang.String getFormat()
        Returns the format that was used by AspOpenList to generate this item.
        Returns:
        The format.
        See Also:
        getFormat()