2 Status Codes

This chapter includes all return and component status information.

The following is a description of all STATUS codes. The STATUS enumerated type is defined in db_defs_api.h. The list is alphabetized to help the reader find the particular STATUS value.

STATUS_ACS_FULL

Explanation: This return status is specific to dismount and enter request functions

• On a dismount request, an available cell location cannot be found in the database in which to dismount the cartridge.

• On a dismount request, an available cell location cannot be found in the database in which to dismount the cartridge.

• On an enter request, if no cell is available in the ACS for the tape cartridge(s), the tape cartridge(s) are not entered and remain in the CAP.

STATUS_ACSLM_IDLE

Explanation: This is an unsolicited message which is sent when the ACSLS enters. This unsolicited message is specific to idle request functions.

STATUS_ACS_NOT_IN_LIBRARY

Explanation: The acs_id specified in the request is syntactically valid, but is not in the current configuration.

This return status is common to all ACSAPI request functions.

STATUS_ACS_OFFLINE

Explanation: This is an unsolicited message which is sent when the ACS is varied offline.

This unsolicited message is specific to idle and vary request functions.

STATUS_ACS_ONLINE

Explanation: A vary OFFLINE request, with or without the FORCE option, specified the last online port to an online ACS. This status is returned for the port_id specified.

This return status is specific to idle and vary request functions.

STATUS_ACTIVITY_END

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_ACTIVITY_START

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_AUDIT_ACTIVITY

Explanation: This return status is specific to audit and query request functions.

Whenever an audit request function returns an intermediate response, an eject_enter response is returned to the request originator with this message_status value filled in and the audit_int_status field filled in with the appropriate status.

• On a query request, an LSM is being audited.

• On a query request, a CAP is being audited.

STATUS_AUDIT_FAILED

Explanation: Whenever an audit request function fails or terminates due to some error condition, an intermediate response is returned to the request originator with this message_status value filled in and the audit_int_status field filled in with the appropriate status.

This return status is specific to audit request functions.

STATUS_AUDIT_IN_PROGRESS

Explanation: A request attempted to access a cell locked by a current audit request. When an audit request is in progress, cell locations being actively audited are temporarily unavailable for access by other request processes.

On an enter request, if no cell is available in the ACS library for the tape cartridge and an audit is in progress (which may be denying access to available cells), the tape cartridges are not entered and remain in the CAP.

This return status is specific to all ACSAPI request functions.

STATUS_AUTOMATIC

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_CANCELED

Explanation: A request was canceled by the cancel request procedure. The current process is halted. This status is common to all ACSAPI request functions which are cancellable.

• On an enter request, the continuous mode of operation terminates when a cancel request is received. If a cancel request is issued against a pending enter request, that request is terminated. If a cancel request is issued against a current enter request, enter processing is halted for that request, and the count value reflects the number of volume identifiers acted upon in the final response. Entered cartridges are not ejected. If any cartridges are left in the CAP, the ACSLM issues a STATUS_REMOVE_CARTRIDGES unsolicited message to the ACSSA and waits for the operator to remove the cartridges before returning the final response.

• On a lock request, no resources are locked. Component status is set to STATUS_VALID. When a lock request is waiting for a tape cartridge or library drive resource to become available and the pending lock is cleared by a clear_lock request, the ACSLM issues a final response as if the pending lock request had been canceled (return status is set to STATUS_CANCELED). However, the cleared resource has its component status set to STATUS_CANCELED.

• If a cancel request is issued against a current query request, query processing is halted for that request. If the query request is current (not pending) the count represents the number of identifiers processed before receipt of the cancel request.

• If a cancel request is issued against a current set_cap request, the ACSLM (ACS Library Manager) stops setting CAP attributes and sets count to the number of CAP identifiers acted upon before the cancel request.

• If a cancel request is issued against a current set_clean request, set_clean processing is halted for that request; count reflects the number of volume identifiers acted upon. Tape cartridges that have been set to clean are not reset.

STATUS_CAP_AVAILABLE

Explanation: This return status is specific to query request functions.

• On a query request, an LSM is available for use.

• On a query request, a CAP is available for use.

STATUS_CAP_DOOR_OPEN

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a CAP_DOOR_OPEN event.

This status is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_CAP_FULL

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a CAP FULL event.

This is a status value which is reserved for use inside the ACS storage Server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_CAP_INOPERATIVE

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a CAP INOPERATIVE event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_CAP_IN_USE

Explanation: This return status is specific to audit, eject, and enter request functions.

• On an audit operation, ANY_CAP was specified in cap_id and the LSM specified in cap_id did not have any CAPs with a nonzero priority. The request is rejected and no cells are audited

• On an audit operation, ANY_ACS or ANY_LSM was specified in cap_id and the acs_id specified did not have any CAPs with a nonzero priority.

• On an audit, enter, or another eject operation, an explicitly specified CAP identifier is being used by another request. No cartridges are ejected or entered.

• On an eject or enter request, if ANY_CAP is specified in cap_id and the LSM specified in cap_id doesn't have any available nonzero priority CAPs, the request is rejected. No cartridges are ejected or entered.

• On an eject or enter request, if ANY_LSM is specified in cap_id and the ACS specified in cap_id does not have any available CAPs with a nonzero priority, the request is rejected. No cartridges are ejected or entered.

• On an eject or enter request, if ANY_ACS is specified in cap_id and an ACS containing cartridges designated for ejection does not have any available CAPs with a nonzero priority, the request is rejected. No cartridges are ejected or entered.

• On an eject or enter request, if ALL_CAP is specified in cap_id and no available nonzero priority CAPs exist in the LSM, the request is rejected. No cartridges are ejected or entered.

STATUS_CAP_NOT_IN_LIBRARY

Explanation: The cap_id specified in the request is syntactically valid, but is not in the current configuration.

This status is common to all ACSAPI request functions.

STATUS_CAP_OFFLINE

Explanation: The request cannot be completed because a specified component is contained in an OFFLINE or OFFLINE_PENDING ACS or LSM, or the specified CAP is in an OFFLINE or OFFLINE-PENDING state.

On a set_cap request, if the CAP state is STATE_DIAGNOSTIC, a set_cap request from the CSI cannot alter the enter processing mode of the CAP. If set_cap attempts to change the processing mode of a CAP in the diagnostic state, the mode is not altered and this status is returned in the component status for that CAP.

This status is common to all ACSAPI request functions.

STATUS_CARTRIDGES_IN_CAP

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a CARTRIDGES IN CAP event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_CELL_EMPTY

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a CELL EMPTY event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_CELL_FULL

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a CELL FULL event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_CELL_INACCESSIBLE

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a CELL INACCESSIBLE event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_CELL_RESERVED

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a CELL RESERVED event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_CLEAN_DRIVE

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a CLEAN DRIVE event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_CLEAN_DRIVE_COMPLETE

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a CLEAN DRIVE COMPLETE event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_COMMAND_ACCESS_DENIED

Explanation: The user is not allowed to perform this command.

This return status is the result of an attempt to invoke a command when command access has been denied.

STATUS_COMMUNICATION_FAILED

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a COMMUNICATION FAILED event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_COMPLETE

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_CONFIGURATION_ERROR

Explanation: The ACSLM detected an inconsistency between the database and the physical library configuration.

This status is common to all ACSAPI request functions.

STATUS_COUNT_TOO_LARGE

Explanation: The count field in the message_header is greater than the largest count expected for this particular request.

No acknowledge response is returned.

This status is common to all ACSAPI request functions.

STATUS_COUNT_TOO_SMALL

Explanation: The count field in the message_header is less than the smallest count expected for this particular request.

No acknowledge response is returned.

This status is common to all ACSAPI request functions.

STATUS_CURRENT

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_DATABASE_DEADLOCK

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a DATABASE DEADLOCK event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_DATABASE_ERROR

Explanation: The ACSLM detected a database consistency error while processing a request.

This status is common to all ACSAPI request functions.

STATUS_DEADLOCK

Explanation: This status value may be returned for lock_drive or lock_volume. If it is seen, notify ACSLS Support.

STATUS_DEGRADED_MODE

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a DEGRADED MODE event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_DIAGNOSTIC

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_DISK_FULL

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_DISMOUNT_ACTIVITY

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a DISMOUNT ACTIVITY event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_DONE

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_DOOR_CLOSED

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a DOOR CLOSED event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_DOOR_OPENED

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a DOOR OPENED event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_DRIVE_AVAILABLE

Explanation: This return status is specific to the clear_lock, dismount, query and unlock request functions.

• On a dismount request, an attempt was made to dismount a tape from a library drive which didn't contain a tape cartridge.

• On a query request, a specified drive does not contain a tape cartridge or is released after a dismount.

• On a query_lock request, the specified drive is not locked.

• On an unlock request, an attempt was made to release the lock on a drive_id which was not locked.

STATUS_DRIVE_IN_USE

Explanation: This return status is specific to dismount, mount, mount_scratch, query and vary request functions. The cartridge was not unloaded on the library drive.

• An attempt was made to dismount a locked tape cartridge without including the correct lock identifier of that tape cartridge, and the message_options FORCE was not used.

• An attempt was made to dismount a tape cartridge from a locked library drive without including the correct lock identifier.

• On a mount request, when a library drive contains a tape cartridge, subsequent mount requests for that library drive are rejected.

• On a mount request, when a mount request attempts to mount a locked library drive without including the lock identifier of that library drive, the request is rejected.

• On a mount_scratch request, if the specified drive is locked with a lock_id different from the one specified in the mount_scratch request, the mount_scratch request is rejected.

• On a query response, a drive contains a tape cartridge or is reserved for a mount.

• On a query_lock response, the request was issued on a component which is locked.

• A vary_OFFLINE request, with or without the FORCE option, specified a library drive which is currently in use.

STATUS_DRIVE_NOT_IN_LIBRARY

Explanation: The drive_id specified in the request is syntactically valid, but is not in the current configuration.

This status is common to all ACSAPI request functions.

STATUS_DRIVE_OFFLINE

Explanation: The request cannot be completed because the specified drive_id is either in an OFFLINE or OFFLINE-PENDING state.

This status is common to all ACSAPI request functions.

STATUS_DRIVE_RESERVED

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a DRIVE RESERVED event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_DUPLICATE_IDENTIFIER

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a DUPLICATE IDENTIFIER event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_DUPLICATE_LABEL

Explanation: On an enter or venter request, if duplicate tape cartridge labels are found in the CAP, the tape cartridges with the duplicate labels remain in the CAP and are not entered into the ACS library.

STATUS_EJECT_ACTIVITY

Explanation: This return status is specific to query request functions.

• On a query request, cartridges are being ejected from the LSM.

• On a query_cap request, cartridges are being ejected from the CAP.

STATUS_ENTER_ACTIVITY

Explanation: This return status is specific to query request functions.

• On a query request, cartridges are being entered into the LSM.

• On a query request, cartridges are being entered into the CAP.

STATUS_EVENT_LOG_FAILURE

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_EVENT_LOG_FULL

Explanation: This is an unsolicited message which is sent when the ACSLS server receives an EVENT LOG FULL event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_IDLE_PENDING

Explanation: When the idle request is issued without the FORCE option and the ACSLM has current or pending requests outstanding.

This return status is specific to idle request functions.

STATUS_INCOMPATIBLE_MEDIA_TYPE

Explanation: This status code is returned under the following circumstances:

• On mount requests, when the media type of the given volume is incompatible with the given drive.

• On mount_scratch requests, when the given media type in the request is always a cleaning cartridge.

• On set_clean requests, when the cartridge is never a cleaning cartridge and an attempt is made to set the tape attribute to a cleaning cartridge, or when the cartridge is always a cleaning cartridge and an attempt is made to remove the cleaning attribute.

• On set_scratch requests, when the cartridge is always a cleaning cartridge and an attempt is made to set the cartridge to a scratch cartridge or to reset it from the beginning.

STATUS_INCORRECT_ATTRIBUTE

Explanation: This return status is specific to define_pool, query, set_cap, set_clean and set_scratch request functions.

• On define_pool requests, pool attributes other than OVERFLOW were specified; or the high_water_mark is not greater than the low_water_mark in the request.

• On a query (type clean) request, the tape cartridge specified is not a cleaning cartridge.

• On a set_cap request, if the CAP priority is not set to a value within the range of NO_PRIORITY and MAX_PRIORITY, the request is rejected. No attributes are set.

• On a set_cap request, if CAP mode is not MODE_SAME, MODE_AUTOMATIC, or MODE_MANUAL, the request is rejected. No attributes are set.

• On a set_clean request, when set_clean attempts to change scratch attributes, the request is rejected and this status is returned.

• On a set_scratch request, when a requested volume is marked as being a cleaning cartridge, set_scratch requests for that volume are rejected. This event does not impact the set_scratch operation for other volumes specified in the request.

STATUS_INCORRECT_CAP_MODE

Explanation: If an explicit enter request (standard, continuous or virtual label modes) specifies a CAP identifier that is assigned the automatic enter mode, the request is rejected. No cartridges are entered.

This return status is specific to enter request functions.

STATUS_INCORRECT_LOCKID

Explanation: This return status is specific to clear_lock, unlock and vary request functions.

• An attempt was made to release the lock on a resource with a lock_id other than NO_LOCK_ID but the resource was not currently locked under the specified lock_id.

• If a vary request with or without the FORCE option specifies a locked library drive without including the lock identifier of that library drive, the drive is not varied.

STATUS_INCORRECT_STATE

Explanation: This return status is specific to vary request functions.

• On a vary acs request, any request to change the state of an ACS is interpreted as a request to change the state of all subordinate LSMs and CAPs. If any LSM or CAP cannot be varied due to its current state, all subordinate LSMs and CAPs are left in their original states and this status is returned for that ACS.

• On a vary lsm request, any request to change the state of an LSM is interpreted as a request to change the state of all subordinate CAPs. If any CAP cannot be varied due to its current state, all subordinate CAPs are left in their original state and this status is returned for that LSM.

STATUS_INPUT_CARTRIDGES

Explanation: This is an unsolicited message which is sent when the ACSLS server receives an INPUT CARTRIDGES event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_INSERT_MAGAZINES

Explanation: This is an unsolicited message which is sent when the ACSLS server receives an INPUT MAGAZINES event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_INVALID_ACS

Explanation: The acs_id specified in the request is syntactically incorrect. On a vary request function, ANY_ACS is specified in cap_id. This status is common to all ACSAPI request functions.

STATUS_INVALID_CAP

Explanation: This status is common to all ACSAPI request functions.

The CAP number portion of the cap_id specified in the request is out of range (it must be between MIN_CAP and MAX_CAP); or ANY_CAP is used in the wrong context; or ALL_CAP is used in the wrong context.

• On an eject operation, if ALL_CAP is specified in cap_id and ANY_ACS or ANY_LSM is also specified, the request is rejected. No cartridges are ejected.

• On an enter request, if ALL_CAP is specified in cap_id with ANY_ACS or ANY_LSM is also specified, the request is rejected. On an enter request, if ALL_CAP is specified in cap_id and CONTINUOUS is not specified in extended_options the request is rejected. No cartridges are entered.

• On a vary request function, ANY_CAP or ALL_CAP is specified in the CAP identifier.

STATUS_INVALID_COLUMN

Explanation: The COLUMN value in a subpanel_id or a panel_id specified in the request is out of range. It must be between MIN_COLUMN and MAX_COLUMN.

This status is common to all ACSAPI request functions.

STATUS_INVALID_COMMAND

Explanation: This status is common to all ACSAPI request functions. The COMMAND field in the message_header is not one of the following valid commands:

COMMAND_AUDIT, COMMAND_CANCEL, COMMAND_CLEAR_LOCK, COMMAND_DEFINE_POOL, COMMAND_DELETE_POOL, COMMAND_DISMOUNT, COMMAND_EJECT, COMMAND_ENTER, COMMAND_IDLE, COMMAND_LOCK, COMMAND_MOUNT, COMMAND_MOUNT_SCRATCH, COMMAND_QUERY, COMMAND_QUERY_LOCK, COMMAND_SET_CAP, COMMAND_SET_CLEAN, COMMAND_SET_SCRATCH, COMMAND_START, COMMAND_UNLOCK or COMMAND_VARY.

No acknowledge response is returned.

STATUS_INVALID_COMM_SERVICE

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_INVALID_DRIVE

Explanation: The drive_id specified in the request is syntactically incorrect.

This status is common to all ACSAPI request functions.

STATUS_INVALID_DRIVE_TYPE

Explanation: This status value is returned by the vary request when a drive type that is unknown to the system is discovered. This drive type is marked as UNKNOWN_DRIVE_TYPE in the database and the drive state is set to offline for the drive.

STATUS_INVALID_LOCKID

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

This status is specific to cmd_proc and the ACSCP/ACSSA.

STATUS_INVALID_LSM

Explanation: The lsm_id specified in the request is syntactically incorrect.

On a vary request function, ANY_LSM is specified in the CAP identifier.

This status is common to all ACSAPI request functions.

STATUS_INVALID_MEDIA_TYPE

Explanation: This status value is returned by the mount_scratch request when a media type that is unknown to the system is given in the request, and by the query_mount_scratch request when ANY_MEDIA_TYPE or a media type that is unknown to the system are given in the request.

STATUS_INVALID_MESSAGE

Explanation: The message_id specified in the request is out of range. It must be between MIN_MESSAGE and MAX_MESSAGE.

This status is common to all ACSAPI request functions.

STATUS_INVALID_OPTION

Explanation: The message_options field in the message_header is not one of the following valid options: ACKNOWLEDGE, EXTENDED, FORCE, INTERMEDIATE, or READONLY or the extended_options field in the message_header is not one of the following valid extended_options: CONTINUOUS, RANGE, RESET, VIRTUAL, or WAIT.

On an enter request, if both CONTINUOUS and VIRTUAL are specified as extended_option parameters, the request is rejected. No cartridges are entered. The continuous and virtual label modes of operation are mutually exclusive.

No acknowledge response is returned.

This status is common to all ACSAPI request functions.

STATUS_INVALID_PANEL

Explanation: The panel_id specified in the request is syntactically incorrect.

This status is common to all ACSAPI request functions.

STATUS_INVALID_POOL

Explanation: This return status is specific to the define_pool, delete_pool, mount_scratch and set_scratch request functions.

pool_id of SAME_POOL was specified in the define_pool request.

pool_id of COMMON_POOL or SAME_POOL was specified to the delete_pool request.

On a mount_scratch request, if the pool identifier SAME_POOL is specified, the mount_scratch request is rejected.

If RESET is specified in a set_scratch request and the pool identifier specified in the request (other than SAME_POOL) does not match the pool identifier of the requested volume, the request is rejected.

STATUS_INVALID_PORT

Explanation: The port_id specified in the request is syntactically incorrect.

This status is common to all ACSAPI request functions.

STATUS_INVALID_RANGE

Explanation: The volume range identifier specified in the request is syntactically incorrect. It contains invalid characters, or the fixed portions of the starting and ending vol_ids do not match, or the rightmost numeric field of the ending vol_id is less than the rightmost numeric field of the starting vol_id.

On an eject request, if an invalid vol_range identifier is detected, the request is rejected. No cartridges are ejected.

On set_clean and set_scratch requests, if an invalid volume range is specified, the request is rejected and no volume attributes are modified.

This status is common to all ACSAPI request functions.

STATUS_INVALID_ROW

Explanation: The ROW value in a subpanel_id or a panel_id specified in the request is out of range. It must be between MIN_ROW and MAX_ROW.

This status is common to all ACSAPI request functions.

STATUS_INVALID_STATE

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

This status is specific to cmd_proc and the ACSCP/ACSSA.

STATUS_INVALID_SUBPANEL

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

This status is specific to cmd_proc and the ACSCP/ACSSA.

STATUS_INVALID_TYPE

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

This status is specific to cmd_proc and the ACSCP/ACSSA.

STATUS_INVALID_VALUE

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

This status is specific to cmd_proc and the ACSCP/ACSSA.

STATUS_INVALID_VERSION

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

This status is specific to cmd_proc and the ACSCP/ACSSA.

STATUS_INVALID_VOLUME

Explanation: The vol_id specified in the request is syntactically incorrect.

On a venter request, if the request contains invalid volume identifiers, the tape cartridges that would have otherwise been assigned these labels remain in the CAP and are not entered into the ACS library.

This status is common to all ACSAPI request functions

STATUS_IPC_FAILURE

Explanation: There was an irrecoverable error communications failure in the IPC layer. Most likely, two internal components were unable to communicate.

STATUS_LAST

Explanation: This is an illegal status. If it is ever seen, there is a bug in the SSI. It is reserved for internal use only. If it is seen, notify ACSLS Support.

STATUS_LIBRARY_BUSY

Explanation: The ACSLM was unable to communicate with the ACS library after the allotted retries and timeouts (set in config) expired for a particular request.

This status is common to all ACSAPI request functions.

STATUS_LIBRARY_FAILURE

Explanation: A request requiring ACS library resources failed due to the failure of the ACS library component.

If eject detects that a CAP door is open or inoperative before it starts ejecting cartridges from that CAP, a STATUS_CAP_DOOR_OPEN or STATUS_CAP_INOPERATIVE unsolicited message is issued to the ACSSA as appropriate. No additional cartridges are ejected.

More than one library failure may cause eject or enter processing to terminate. All library failures encountered are reported in the event log, but only one failure is returned in the message status.

On a vary request, if a library failure occurs while a vary OFFLINE request is trying to vary specified devices offline, the devices' states are changed to OFFLINE in the database and this component status is returned for that device.

This status is common to all ACSAPI request functions.

STATUS_LIBRARY_NOT_AVAILABLE

Explanation: A request other than acs_query_server() or acs_query_mm_info() is received by the ACSLM while it is in STATE_RECOVERY, or a request requiring ACS library resources arrived at the ACSLM while the ACSLM is in STATE_IDLE or STATE_IDLE_PENDING.

On an idle request, when issued without the FORCE option, all current and pending requests are completed, except for pending lock requests. Pending lock requests are rejected. New requests, except for cancel, idle, query, query_lock, start, and vary are rejected. The ACSLM is put in the IDLE state. Current and pending requests are terminated.

This status is common to all ACSAPI request functions.

STATUS_LOCATION_OCCUPIED

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_LOCK_FAILED

Explanation: This return status is specific to lock request functions.

• When a lock request is issued with the wait option set to TRUE and resources are specified which are invalid or not within the library, a response is returned immediately. The entries in the component status array indicate the specified identifiers which are in error. Component status of STATUS_VALID is returned for valid identifiers

• When a lock request is issued with the wait option set to FALSE and resources are specified which are not available (for example, resources are locked or in use), the resources are not locked. Component status is set to STATUS_DRIVE_IN_USE for each affected library drive resource, and to STATUS_VOLUME_IN_USE for each affected tape cartridge resource. Component status is set to STATUS_VALID for each available resource.

• When a lock request specifies a resource that forces a deadlock condition, the request is rejected. The specific resource that created the deadlock will be returned with a component status of STATUS_DEADLOCK. All resources that would not create a deadlock are returned with a component status of STATUS_VALID; however, no resources are locked. The component status record which contains STATUS_DEADLOCK will have type and identifier set to the device which must be released to clear the deadlock.

STATUS_LOCKID_NOT_FOUND

Explanation: The lock_id specified has no resources currently assigned to it.

This status is common to all ACSAPI request functions.

STATUS_LSM_FULL

Explanation: This is an unsolicited message which is sent when the ACSLS server receives an LSM FULL event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_LSM_NOT_IN_LIBRARY

Explanation: The lsm_id specified in the request is syntactically valid, but is not in the current configuration.

This status is common to all ACSAPI request functions.

STATUS_LSM_OFFLINE

Explanation: The request cannot be completed because a specified component is contained in an offline or offline-pending LSM, or the specified LSM is in an OFFLINE or OFFLINE-PENDING state.

This status is common to all ACSAPI request functions.

STATUS_MANUAL

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_MAX_PORTS

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_MESSAGE_NOT_FOUND

Explanation: The message_id specified in the request is valid, but not found to be associated with a current or pending request in the ACSLM.

This status is common to all ACSAPI request functions.

STATUS_MESSAGE_TOO_LARGE

Explanation: The request packet which the ACSLM received is larger than the expected message size calculated by the ACSLM. If this is seen, check the actual request packet for errors.

STATUS_MESSAGE_TOO_SMALL

Explanation: The request packet which the ACSLM received is smaller than the expected message size calculated by the ACSLM. If this is seen, check the actual request packet for errors.

STATUS_MISPLACED_TAPE

Explanation: This return status is specific to dismount, eject and mount request functions.

• On a dismount request, the ACSLM compares the external tape cartridge label of the tape cartridge in the library drive with the vol_id of the tape cartridge in the request. If the labels are not identical, the dismount request is rejected. The vol_id of the tape cartridge in the library drive is not the same as the vol_id recorded in the database. The database is updated with the vol_id of the tape cartridge in the library drive

• On an eject operation, if a different tape cartridge is in the location specified by the ACSLM database, the database is updated with the external tape cartridge label of the tape cartridge found in the storage location.

• On a mount request, using the volume identifier of the request, the ACSLM locates the tape cartridge in the ACS library. The ACSLM compares the external tape cartridge label and media type of the tape cartridge found in the library with the volume identifier of the request. If they are not identical, the mount request is rejected.

STATUS_MISSING_OPTION

Explanation: The request packet which the ACSLM received is missing an option in the message_header portion of the request. If this is seen, check the actual request packet for errors.

STATUS_MOUNT_ACTIVITY

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a MOUNT ACTIVITY event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_MULTI_ACS_AUDIT

Explanation: The identifier list specified more than one ACS, and cap_id was not set to ANY_ACS.

This return status is specific to audit request functions.

STATUS_NI_FAILURE

Explanation: The ACSLM has lost contact with the CSI. Check the connection, and verify that the client is still alive.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_NI_TIMEDOUT

Explanation: The CSI has timed out waiting for a response from a client.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_NO_CAP_AVAILABLE

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a NO CAP AVAILABLE event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_NONE

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_NO_PORTS_ONLINE

Explanation: A vary ONLINE request specifies an ACS and no ports attached to that ACS are online. This return status is specific to vary request functions.

STATUS_NORMAL

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_NOT_IN_SAME_ACS

Explanation: This return status is specific to audit, eject and mount request functions.

• On an audit request, an explicitly-specified CAP identifier and a second identifier in the same audit request function do not specify the same ACS.

• On an eject request, an explicitly specified CAP identifier and a volume identifier are not in the same ACS. The cartridge is not ejected.

• On an eject request, if the ACS explicitly specified in the CAP identifier and a volume identifier are not in the same ACS, the command is rejected and the cartridge is not ejected.

• On a mount request, when the tape cartridge and the library drive are not in the same ACS, the mount request is rejected.

STATUS_OFFLINE

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_ONLINE

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_PENDING

Explanation: ACS response will return this status when there is no input from the SSI. The recommendation is to write code to retry in this situation.

STATUS_POOL_HIGH_WATER

Explanation: This return status is specific to define_pool, mount_scratch, query and set_scratch request functions.

• On a define_pool request, an existing scratch pool's characteristics are modified such that the number of volumes in the scratch pool is greater than or equal to the high_water_mark.

• On a mount_scratch request, if, after a scratch volume has been selected, the number of volumes remaining in the scratch pool is greater than or equal to the high_water_mark for the pool. The selected volume is mounted on the specified library drive.

• On a set_scratch request, if, after the set_scratch request has been processed, the number of scratch volumes in the specified pool is greater than or equal to the high_water_mark specified by the define_pool request.

STATUS_POOL_LOW_WATER

Explanation: This return status is specific to define_pool, mount_scratch, query and set_scratch request functions.

• On a define_pool request, an existing scratch pool's characteristics are modified such that the number of volumes in the scratch pool is less than or equal to the low_water_mark.

• On a mount_scratch request, if, after a scratch volume has been selected, the number of volumes remaining in the scratch pool is less than or equal to the low_water_mark for the pool. The selected volume is mounted on the specified library drive.

• On a set_scratch request, if, after the set_scratch request has been processed, the number of scratch volumes in the specified pool is less than or equal to the low_water_mark specified by the define_pool request.

STATUS_POOL_NOT_EMPTY

Explanation: The specified scratch pool is not empty.

This return status is specific to delete_pool request functions.

STATUS_POOL_NOT_FOUND

Explanation: The specified scratch pool does not exist.

This return status is specific to delete_pool, define_pool, mount_scratch and set_scratch request functions.

STATUS_PORT_ALREADY_OPEN

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_PORT_FAILURE

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_PORT_NOT_IN_LIBRARY

Explanation: The port_id specified in the request is syntactically valid, but is not in the current configuration.

This status is common to all ACSAPI request functions.

STATUS_PROCESS_FAILURE

Explanation: The ACSLM was not able to spawn the request or the ACSLM received a process failure from a spawned process.

This status is common to all ACSAPI request functions.

STATUS_QUEUE_FAILURE

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_READABLE_LABEL

Explanation: This return status is specific to venter request functions.

On a venter request, if any of the external labels are readable, the cartridges with readable labels remain in the CAP and are not entered into the ACS library. The component volume identifier contains the volume identifier of the external label.

STATUS_RECOVERY_COMPLETE

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a RECOVERY COMPLETE event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_RECOVERY_FAILED

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a RECOVERY FAILED event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_RECOVERY_INCOMPLETE

Explanation: This return status is specific to vary request functions.

• On a vary request, if recovery of in-transit cartridges is unsuccessful while varying an LSM online or diagnostic, this component status is returned for the LSM. The LSM is changed to the requested state in the database; however, the unrecovered in-transit cartridges may restrict use of Pass-Though Ports or the robot's ability to empty its hands of cartridges following a system failure. If the vary request specified an ACS, this status indicates that at least one LSM failed to successfully recover in-transit cartridges.

• On a vary request, if during recovery of in-transit cartridges no available storage cells can be found for a labeled in-transit cartridge, the cartridge is moved to the CAP. If the CAP is full or cannot accept all in-transit cartridges, recovery of in-transit cartridges is unsuccessful and this component status is returned for the LSM.

• On a vary request, if a vary online or diagnostic request specifies an ACS and one or more of its LSMs fails to go online or diagnostic, or in-transit cartridge recovery fails, this component status is returned for the ACS.

• On a vary request, if a vary online or diagnostic request specifies an ACS, LSM or CAP, and the ACSLM detects that the CAP door is open or inoperative, and there are in-transit cartridges to recover in the LSM then this component status is returned.

STATUS_RECOVERY_STARTED

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a RECOVERY STARTED event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_REMOVE_CARTRIDGES

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a REMOVE CARTRIDGES event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_RETRY

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_RPC_FAILURE

Explanation: The ACSLM has lost contact with the CSI/SSI. Check the connection, and verify that the client is still alive.

Note: This was redefined in ACSLS Release 3.0 to be the same as STATUS_NI_FAILURE.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_SCRATCH_NOT_AVAILABLE

Explanation: On a mount_scratch command, if no scratch volumes are available to satisfy the mount_scratch request, the request is rejected.

This return status is specific to mount_scratch request functions.

STATUS_STATE_UNCHANGED

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a STATE UNCHANGED event.

This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_SUCCESS

Explanation: This return status is returned on a final response on successful completion.

This status is common to all ACSAPI request functions.

STATUS_TERMINATED

Explanation: This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_TRANSLATION_FAILURE

Explanation: This is a generic CSI failure. It indicates that there may be an XDR translation problem between the client and the server.This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.No acknowledge response is returned.This status is common to all ACSAPI request functions.

STATUS_UNREADABLE_LABEL

Explanation: This return status is specific to the audit, dismount, enter, mount and venter request functions.

• On an audit request, if a cartridge in a storage cell has a missing or unreadable label and has not been assigned a virtual label. This cartridges is ejected from the library, and this status is placed in the vol_status portion of the intermediate response sent back to the audit request originator.

• On an dismount request, if a cartridge's external label is unreadable, and the cartridge has not been assigned a virtual label, the request is rejected.

• On an enter request, if the external tape cartridge labels are unreadable and a virtual enter was not specified, the tape cartridges with the unreadable labels remain in the CAP and are not entered into the ACS library.

• On a mount request, if the tape cartridge label is unreadable, and the cartridge has not been assigned a virtual label, the mount request is rejected.

• On a venter, if the request contains fewer volume identifiers than there are unreadable cartridges in the CAP, the unreadable tape cartridges that cannot be assigned labels remain in the CAP and are not entered into the ACS library. This component status is set for each volume for which no volume identifier exists.

STATUS_UNSUPPORTED_COMMAND

Explanation: The command field in the message_header is valid, but not supported for this particular version.No acknowledge response is returned.This status is common to all ACSAPI request functions.

STATUS_UNSUPPORTED_OPTION

Explanation: The message_options field in the message_header is valid, but not supported for this particular request or the extended_options field in the message_header is valid, but not supported for this particular request.No acknowledge response is returned.This status is common to all ACSAPI request functions.

STATUS_UNSUPPORTED_STATE

Explanation: The state field in the message_header is valid, but not supported for this particular request No acknowledge response is returned.This status is common to all ACSAPI request functions.

STATUS_UNSUPPORTED_TYPE

Explanation: The type field in the message_header is valid, but not supported for this particular request No acknowledge response is returned.This status is common to all ACSAPI request functions.

STATUS_VALID

Explanation: The request sent to the ACSLM is valid and this status is returned with the acknowledge. This status is common to all ACSAPI request functions.

STATUS_VALUE_UNCHANGED

Explanation: On a set request, the value specified is the same as the actual value.This return status is specific to all set request functions.

STATUS_VARY_DISALLOWED

Explanation: A vary request specifies an ACS, LSM, CAP, or library drive be put to or from the DIAGNOSTIC state and the originator is not the ACSSA.This return status is specific to vary request functions.

STATUS_VARY_IN_PROGRESS

Explanation: A vary OFFLINE request specified an ACS, LSM or CAP that is currently in the RECOVERY state.A vary ONLINE request specifies an ACS, LSM or CAP that is currently in the OFFLINE-PENDING or RECOVERY state.This return status is specific to vary request functions.

STATUS_VOLUME_ACCESS_DENIED

Explanation: The user is not allowed access to the specified volume.This return status is the result of an attempt to access a volume when access has been denied.

STATUS_VOLUME_ADDED

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a VOLUME ADDED event. This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_VOLUME_AVAILABLE

Explanation: This return status is specific to clear_lock,query_lock, and unlock request functions.

• On a query_lock request, the specified volume is not locked.

• On clear_lock and unlock requests, an attempt was made to release the lock on a vol_id which was not locked.

STATUS_VOLUME_DELETED

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a VOLUME DELETED event. This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_VOLUME_EJECTED

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a VOLUME EJECTED event. This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_VOLUME_ENTERED

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a VOLUME ENTERED event. This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_VOLUME_FOUND

Explanation: This return status is specific to eject and venter request functions.

• On an eject operation, if the tape cartridge is being moved, the tape cartridge is in transit. The cartridge is not ejected.

• On a venter request, If the request contains more volume identifiers than there are cartridges in the CAP, this component status is set for each extra label specified.

STATUS_VOLUME_HOME

Explanation: This return status is specific to query request functions.On a query request, a specified tape cartridge is in a storage cell.

STATUS_VOLUME_IN_DRIVE

Explanation: This return status is specific to eject, mount and query request functions.

• On an eject operation, if the tape cartridge is in a library drive, the tape cartridge is not ejected.

• On a mount request, after a tape cartridge is mounted, subsequent requests to mount that cartridge on any library drive are rejected. The returned drive identifier is the library drive which has the volume.

• On a query request, a specified tape cartridge is in a library drive.

STATUS_VOLUME_IN_TRANSIT

Explanation: This return status is specific to query request functions.On a query request, a specified tape cartridge is in transit (in-between a home location and a tape drive (or pass through port)).

STATUS_VOLUME_IN_USE

Explanation: This return status is specific to eject, mount, query, set_clean and set_scratch request functions.

• If an eject request attempts to eject a locked tape cartridge without including the lock identifier of that tape cartridge, the cartridge is not ejected.

• On a mount request, when the tape cartridge is marked in transit in the database and a mount request is issued against it, it is rejected with this status.

• When a mount request attempts to mount a locked tape cartridge without including the lock identifier of that tape cartridge, the request is rejected.

• On a query request, a specified tape cartridge is in a library drive or locked.

• On a query_lock request, the request was issued on a component which is locked.

• On a set_clean request, this status is returned when set_clean attempts to change a tape cartridge's attributes, but the tape cartridge is locked by another process, or the tape cartridge is in use.

• On a set_scratch request, when a requested volume is marked as in use, set_scratch requests for that volume are rejected. This event does not impact the set_scratch operation for other volumes specified in the request.

• On a set_scratch request, when a requested volume is locked by another client, set_scratch requests not specifying the correct lock identifier for the volume are rejected. This event does not impact the set_scratch operation for other volumes specified in the request.

STATUS_VOLUME_NOT_FOUND

Explanation: This is an unsolicited message which is sent when the ACSLS server receives a VOLUME NOT FOUND event. This is a status value which is reserved for use inside the ACS storage server. No request process will return it to the user. If it is seen, notify ACSLS Support.

STATUS_VOLUME_NOT_IN_DRIVE

Explanation: This return status is specific to dismount request functions.Using the database, the requested vol_id is matched with the requested drive_id. If the database shows that the requested vol_id is not in the requested drive, the dismount fails.

STATUS_VOLUME_NOT_IN_LIBRARY

Explanation: This status is common to all ACSAPI request functions. The vol_id specified in the request is syntactically valid, but is not found in the database.

• During an eject operation, if the list of volume identifiers contains one or more duplicates, the first instance of the volume identifier causes the ACSLM to eject the tape cartridge with that volume identifier from the ACS library. Other instances of the volume identifier return this status.

• During an eject operation, if no tape cartridge is in the location specified by the database and the volume is not in transit or in a library drive, the database entry is removed.

• During a lock request, if pending for a tape cartridge resource to become available and the tape cartridge is removed from the system by either an eject or audit request, the lock request will fail with this status. The component status is set to STATUS_VOLUME_NOT_IN_LIBRARY for the failed identifiers and component status is set to STATUS_VALID for the valid identifiers