In this chapter you will learn how to use the display
command.
If you think in terms of SQL and look at the options, you will realize the power and flexibility in the display
command. The display
command is a powerful tool for reporting information from the ACSLS database. Like a SQL SELECT statement, display allows you to specify:
the database table (ACSLS object) you want to display.
wildcards.
conditions that objects must meet to be selected.
fields to report and the order in which they will be reported.
the sort order in which output will be displayed.
that only the count of the number of objects meeting the selection criteria be displayed.
The result is a query
facility that lets you customize what you want displayed and how it should be presented. Much more information is available through the display
command than is possible through ACSLS query
commands. For example, display volume
gives access to volume information that was only available through a custom volrpt. display lsm
and display drive
provide LSM and tape drive serial numbers.
The display commands are:
Displays specific CAP information based on the options selected.
Displays specific cell information based on the options selected.
Displays specific drive information based on the options selected.
Displays specific lock information based on user ID.
Displays specific LSM information based on the options selected.
Displays specific library panel information based on the options selected.
Displays specific scratch pool information based on the options selected.
Displays specific port information based on the options selected.
Displays specific volume information based on the options selected.
The display
command displays various fields of information for different library components. The display
command allows you to select the order and format in which the output is displayed.
The information displayed can include multiple columns and long lines.To prevent lines from wrapping, you can re-size the terminal window used for display. A cmd_proc -lq
window will probably be your best choice.
Wildcards, numeric or alpha ranges, and selection lists can be used with the display
command.
The wildcard character, *, can be used to substitute: for certain display
operands; for one or more subfields in compound display operands; or at the beginning or end of a volume ID. It must match one or more characters.
Many of the ACSLS library components have a primary key composed of multiple fields.
For example, the primary key of:
an LSM is acs,lsm
a drive is acs,lsm,panel,drive
When you wildcard a primary key that contains multiple fields, you can either specify an asterisk (*) for all fields in the key, or you can wildcard individual key fields. If you specify (*) some key fields and wildcard others, specify all of the key fields.
Do not use an asterisk (*) for a vol_id
. Use an underscore (_) to match a single character in a vol_id
. The underscore is positional, and represents a single character. It may be used more than once in a vol_id
to represent more than one character.
Examples of valid wildcards using the * character:
display drive *
(display all drives)
display drive 0,1,*,*
(displays all drives in LSM 0,1)
display volume *100
(displays all volumes ending in 100)
display drive * -volume RB0001
(displays the drive(s) that contain volume RB0001)
Examples of invalid wildcards using the * character:
display drive 0,1,*
(Asterisks for both the panel and drive positions must be specified when selecting all drives in LSM 0,1)
display cap * *
(Only one asterisk is allowed when selecting all CAPs)
display volume 1*111
(The embedded asterisk is not allowed. Use display volume 1_111
).
A range is denoted with a ’-' (hyphen or dash).
Rules for using ranges, are:
Negative numbers are not allowed, except for volume home LSM.
<n and >n are allowed. <n is all numerics less than n. >n is all numerics greater than n.
Multiple numbers or ranges can be used, separated by a white space.
Volume ranges can be alphanumeric.
Examples of valid ranges, are:
display volume * -drive 0,1,2,2-5
(displays all volumes in acs 0, lsm 1, panel 2, drives 2 through 5)
display lsm * -state online -free_cells >50 -type 9730
(displays all 9730 lsms in an online state with a free cell count greater than 50)
Examples of invalid ranges, are:
display drive 0,1,1,1-*
(* is not valid in a range)
display volume * -drive 0,1,?,1-5
(? is not valid in a range)
display
type arg
... [
-selection
... ] [ [ -c ] | [ -f
field
... ] [ -s
sort_field
... ] [ -n
n
] ]
type
specifies the object to be displayed. Valid types are: cap, cell, drive, lock, LSMs, panel, pool, port, and volume.
arg
(argument) specifies the identifiers for the object type. Only objects that match one or more of the identifiers are returned.
-
selection
specifies additional selection criteria. To be selected, a component must match at least one of the selection identifiers for each selection criteria.
-c
(count) causes the request to display only the number of objects that satisfy the arg
and selection
criteria. This option is mutually exclusive with the -f
field
, -s
sort_field
,
and -n
n options.
-f
field
specifies the fields of information to be returned, and the order in which they are to be returned for each object selected. Each display type has a list of available, key, and default fields. If -f
is specified, the default fields are not displayed unless they are key fields or have been specified. If -f
is not specified, then the default fields are returned. Key fields for each type are normally displayed first. However, you can change the order in which the key fields are displayed by specifying them after the -f
option.
The list of fields is separated by spaces.
-s
sort_field
sorts the objects returned by the field(s) selected in the order specified. The default sort order for each display command is discussed under each command. Sorting is based on internal database values and may not always display in alphanumeric order.
All returned fields for a type are valid sort_fields.
-n
n
specifies the maximum number of objects to be displayed.
The cmd_proc
command started in curses mode cannot display lines longer than 80 characters, and the cmd_proc
window hangs if it attempts to display a line longer than 80 characters.
Because of this, it is a good idea to start cmd_proc
in line mode (with the –l
option) when displaying many optional fields. Example: display drive * -f volume type state serial_num wwn
using a cmd_proc
started as cmd_proc –l
.
This section discusses the display commands.
The display cap command displays specific CAP information based on the options selected.
Note:
On SL3000s and SL8500s with 4.70 and later firmware. To prevent CAP IDs from changing when additional modules are added to the SL3000 or additional CAPs are installed, the library returns all possible CAP locations in its configuration information. CAPs that are not installed will be reported as ”not installed” in the CAP Status.ACSLS only adds database records for CAP locations that actually have CAPs installed.
Note:
See "Using display Command Options" for details about specifying display selection criteria and selecting the data to be displayed.display cap cap_id ... ][ -availability cap_availability ...] [ -status cap_status ... ][-priority cap_priority ... ] [ -state cap_state ... ] [ -manual | -automatic ] [ -condition cap_condition ... ] [ [ -c ] | [ -f field ... ] [ -s sort_field ... ] [ -n n ] ]
The fields for display cap, are:
key fields: acs, lsm, cap
default fields: acs, lsm, cap, status, priority, state, mode, size, availability
available fields: acs, lsm, cap, status, priority, state, desired_state, mode, size, condition, availability
cap_id
specifies the CAP(s) to display. A cap_id
is of the format: acs, lsm, cap.
Wildcard character,*, can be used in any cap_id
subfield or used to represent all subfields. However, if it represents all cap_ids
(example: display cap * or display cap *,*,*
), additional cap_ids
(either numeric or *) are not allowed. Numeric ranges apply to any subfield of cap_id
.
availability
cap_availability
specifies one or more cap availabilities as additional selection criteria. CAP availabilities are: lib_not_partn, cap_shared, cap_dedicated, dedicated_other, not_installed.
CAPs that are dedicated_other
or not_installed
are not defined in the ACSLS database. These values are only seen when a CAP's availability has changed (since it was configured). Reconfigure to remove these CAPs.
-status
cap_status
specifies one or more CAP statuses as additional selection criteria. CAP statuses are: audit, available, eject, enter, insert_magazines
.
-priority
cap_priority
specifies one or more CAP priorities. Numeric range rules apply. CAP numeric ranges: 0-16.
-state
cap_state
specifies one or more CAP states. CAP states are: diagnostic, offline, offline_pending, online, recovery
.
-manual
selects CAPs in manual mode.
-automatic
selects CAPs in automatic mode.
-condition
cap_condition
specifies one or more CAP conditions from which to select. Valid conditions are: inoperative, maint_required
, or operative
.
Note:
An inoperative ormaint_required
condition is only cleared when a drive, LSM, or ACS is varied online. So, a CAP condition of inoperative
or maint_required
may be inaccurate.-c
(count) causes the request to display only the number of objects that satisfy the arg and selection criteria. This option is mutually exclusive with the -f field, -s sort_field, and -n n options.
-f
field
specifies the fields of information to be returned and the order in which they are to be returned for each object selected. Each display type has a list of available, key, and default fields. If -f
is specified, the default fields are not displayed unless they are key fields or have been specified. If -f
is not specified, then the default fields are returned. Key fields for each type are normally displayed first. However, you can change the order in which the key fields are displayed by specifying them after the -f
option.
The list of fields is separated by spaces.
The following is a new CAP field that is not reported by query cap
.
desired_state
The desired state
for an ACS, port, LSM, drive, or CAP is the availability that you want for the component. ACSLS sets desired state when an explicit vary
operation is performed. (This is a vary from a cmd_proc
or ACSAPI client
command. It is not a vary
that ACSLS internally generates because of a library status change.)
The current state (specified as "state") for an ACS, port, LSM, drive, or CAP is the current availability of the component limited by desired state. When a drive is varied online, its desired state is online. However, its current state could be offline because the drive is inoperative or is in an LSM that is offline or not ready. The current state of an ACS, port, LSM, drive, or CAP is also referred to as the ”state” of the component in the results of query
and display
commands.
The current state of a CAP, based on availability, is not maintained at this time.
The availability of logical libraries and tape drives in logical libraries is also governed by the desired state that you set for both the underlying physical library and the logical library. If the desired states for both the physical library and logical library are online, the current states of logical libraries and logical tape drives reflect the current state of the underlying physical libraries and drives.
-s
sort_field
sorts the objects returned by the field(s), selected in the order specified. Sorting is based on internal database values and may not always display in alphanumeric order.
All returned fields for a type are valid sort_fields
.
-n
n
specifies the maximum number of objects to be displayed.
The display cell
command displays specific information about a cell based on the options selected.
Note:
See "Using display Command Options" for details about specifying display selection criteria and selecting the data to be displayed.display cell
cell_loc
... [ -status
cell_status
... ] [ [ -c ] | [ -f
field
... ] [ -s
sort_field
... ] [ -n
n
] ]
The fields for display cell, are:
key fields: acs
, lsm
, panel
, row
, column
,
default fields: acs
, lsm
, panel
, row
, column
, status
available fields: acs
, lsm
, panel
, row
, column
, status
-status
cell_status
specifies one or more cell statuses as additional selection criteria. Valid cell statuses: empty, full, inaccessible, reserved
.
The wildcard character,*, can be used in any cell_id
subfield or used to represent all subfields. However, if it represents all cell_ids (example: display cell *
or display
cell_id
*,*,*,*), additional cell_ids (either numeric or *) are not allowed. Numeric ranges apply to any subfield of cell_id.
-c
(count) causes the request to display only the number of objects that satisfy the arg and selection criteria. This option is mutually exclusive with the -f field, -s sort_field,
and -n
n options.
-f
field
specifies the fields of information and the order in which they are to be returned for each object selected. Each display type has a list of available, key, and default fields. If -f
is specified, the default fields are not displayed unless they are key fields or have been specified. If -f
is not specified, then the default fields are returned. Key fields for each type are normally displayed first. However, you can change the order in which the key fields are displayed by specifying them after the -f
option.
The list of fields is separated by spaces.
-s
sort_field
sorts the objects returned by the field(s), selected in the order specified. Sorting is based on internal database values and may not always display in alphanumeric order.
All returned fields for a type are a valid sort_field
.
-n
n
specifies the maximum number of objects to be displayed.
The display drive
command displays specific drive information based on the options selected.
Note:
See "Using display Command Options" for details about specifying display selection criteria and selecting the data to be displayed.display drive drive_id ... [ -status drive_status ... ][-state drive_state ... ] [ -type drive_type ... ][ -volume vol_id ... ] [ -lock lock_id... ] [ -serial drive_serial_num ... ] [ -condition drive_condition ...][ [ -c ] | [ -f field ... ] [ -s sort_field ... ] [ -n n ] ]
The fields for display drive are:
key fields: acs, lsm, panel, drive
default fields: acs, lsm, panel, drive, status, state, volume, type
available fields: acs, lsm, panel, drive, status, state, volume, type, lock, desired_state, serial_num, condition, wwn, last_dismount_time, error
drive_id
displays the drive_id
in the following format: acs, lsm, panel, drive.
Wildcard character,*, can be used in any drive_id subfield or used to represent all subfields. However, if it represents all drive_ids (example: display drive *
or display
drive_id
*,*,*,*), additional drive_ids (either numeric or *) are not allowed. Numeric ranges apply to any subfield of drive_id.
-status
drive_status
displays one of the following statuses as additional selection criteria: available, in_use, reserved.
Possible scenario: You perform a query drive all
and get a message saying that the drive is in use. You then perform a display
drive
* and get a message saying that the drive is reserved. This means: the reserved status for the drive implies that a mount request is in progress and that a volume is on its way to the drive. At the same time, the drive is considered to be in use.
-state
drive_state
displays the following states for one or more drives: diagnostic, online, offline, recovery.
-type
drive_type
displays drives by transport type.
-volume
vol_id
displays volume(s) mounted on the drive(s) selected. A vol_id
can be a 6-alphanumeric string or wildcard string that specifies a tape volume or range of volume IDs.
-lock
lock_id
displays drive information on locked drives by lock ID.
-serial
drive_serial_num
specifies the drive serial number.
-condition
drive_condition
displays condition of the drive(s) specified. Valid conditions are: operative, inoperative,
or maint_required
.
Note:
An inoperative ormaint_required
condition is only cleared when a drive, LSM, or ACS is varied online. So, a drive condition of inoperative or maint_required
may be inaccurate.-c
(count) causes the request to display only the number of objects that satisfy the arg and selection criteria. This option is mutually exclusive with the -f field
, -s sort_field
, and -n
n
options.
-s
sort_field
sorts the objects returned by the field(s) selected in the order specified. Sorting is based on internal database values and may not always display in alphanumeric order.
All returned fields for a type are valid sort_fields.
-f
field
specifies the fields of information and the order in which they are to be returned for each object selected. Each display type has a list of available, key, and default fields. If -f
is specified, the default fields are not displayed unless they are key fields or have been specified. If -f
is not specified, then the default fields are returned. Key fields for each type are normally displayed first. However, you can change the order in which the key fields are displayed by specifying them after the -f
option.
The list of fields is separated by spaces.The following is a list of new tape drive field descriptions that are not reported by query drive
.
desired_state
The desired state for an ACS, port, LSM, drive, or CAP is the availability that you want for the component. ACSLS sets desired state when an explicit vary
operation is performed. (This is a vary from a cmd_proc
or ACSAPI client
command. It is not a vary
that ACSLS internally generates because of a library status change.)
The current state (specified as "state") for an ACS, port, LSM, drive, or CAP is the current availability of the component limited by desired state. When a drive is varied online, its desired state is online. However, its current state could be offline because the drive is inoperative or is in an LSM that is offline or not ready. The current state of an ACS, port, LSM, drive, or CAP is also referred to as the ”state” of the component in the results of query
and display
commands.
The availability of logical libraries and tape drives in logical libraries is also governed by the desired state that you set for both the underlying physical library and the logical library. If the desired states for both the physical library and logical library are online, the current states of logical libraries and logical tape drives reflect the current state of the underlying physical libraries and drives.
serial_num
ACSLS can only report drive serial numbers when the drive reports its serial number to the library and the library reports its serial number to ACSLS. Only modern libraries and drives report the drive serial numbers to ACSLS. This includes T9840, T10000, and LTO drives. SL150, SL3000 and SL8500, and later libraries report serial numbers to ACSLS.
ACSLS reports the serial number on the tape drive "brick,” not the serial number on the drive tray.
The serial number on the drive brick is the serial number reported by the drive to the library and to you through SL Console and ACSLS. It is also the serial number reported over the SCSI/Fibre data path (such as, to the backup application).
The drive tray is labeled with its own serial number. The serial number on the drive tray label licenses service and so on, through StorageTek. The number on the drive tray is used for activating, so drives (drive "bricks") can be replaced without needing to update the activated serial number.
There is minimal communication between the drive tray and drive brick. This is displayed by way of a few ready/not ready indicators. The drive tray is basically a power supply for the drive without any smarts.
wwn
The drive's World Wide Name. The WWN is 8 bytes (binary). It is displayed as 16 hex characters (0-9 and A-F) with dot separators between the pairs of hex characters (bytes).
The WWN displayed is the WWN of the node. The WWN of the first port (Port A) is one number greater. If the drive has two ports, the WWN of Port B is two numbers greater.
The drive's WWN is available for SL3000 libraries and for SL8500 libraries with 3.94 and later firmware.
last_dismount_time
The date and time of the last time a cartridge was dismounted from the drive. ACSLS uses this to order the drives reported to query mount
. The drives are listed primarily by LSM closeness (least pass-thrus) to the volume being mounted and secondarily by earliest last_dismount_time
. Ordering the drives by earliest last_dismount_time
evens out the use of drives.
These statistics are reported to ACSLS when a cartridge is dismounted from a drive. The following statistics fields are only reported for these libraries and drives:
Libraries:
All SL3000s.
SL8500s with 4.13 and later firmware.
Tape drives:
T9840C and T9840D with 1.42 and later drive firmware.
T10000A
error
- (drive maintenance required)
This is currently only reported for T10000 drives. Values are:
none - No drive error reported.
maint_reqd
- Maintenance is required for the tape drive.
This is only reported when the tape drive has determined that the drive is to be avoided and should be taken offline. You should call for service.
Primary drive error scenarios:
In these scenarios, the drive and library waits for manual intervention.
Table 13-1 Drive and Library waiting for Manual Intervention
Unload failures | The cartridge is stuck in the drive |
---|---|
Drive Leader Off Hook failures |
The drive won't indicate a drive error until the media is extracted |
Drive IPL failures |
The drive stops communicating with the library. |
-s
sort_field
sorts the objects returned by the field(s) selected in the order specified. Sorting is based on internal database values and may not always display in alphanumeric order. For example, drive type
is sorted by an internal numeric drive type and not by the literal that is display.
All returned fields for a type are valid sort_fields
.
-n
n
specifies the maximum number of objects to be displayed.
To display all drives in panel 0,1,1.
display drive 0,1,1,*
To display all drives in LSM 0,1.
display drive 0,1,*,*
To display a maximum of 56 rows for all drives in ACS 1, sorted by panel and drive:
display drive 1,*,*,* -s panel drive -n 56
To display drive data for ACS 1, LSM 1, with status available:
display drive 1,1,*,* -status available
To display drive types, serial numbers, and world wide names (wwn) for all drives:
display drive * -f type
serial_num
wwn
To display all drives desired state:
display drive * -f state desired_state
The display lock
command displays specific lock information by lock_id based on the options selected.
Note:
See "Using display Command Options" for details about specifying display selection criteria and selecting the data to be displayed.display lock
lock_id
... [ -user user_id ... ] [ [ -c ] | [ -f
field ... ] [ -s sort_field ... ] [ -n n ] ]
The fields for display lock, are:
key fields: lock_id
default fields: lock_id
, user_id
available fields: lock_id
, user_id
lock_id
displays the numeric lock_id
.
Wildcard character,*, can be used in any lock_id
subfield or used to represent all subfields. However, if it represents all lock_ids
(example: display lock *
or display
lock_id
*,*,*), additional lock_ids (either numeric or *) are not allowed. Numeric ranges apply to any subfield of lock_id
.
user_id
specifies the user name (example: acsss
) that has locked the volume or transport. The user_id
wraps after 80 characters.
-c
(count) causes the request to display only the number of objects that satisfy the arg
and selection
criteria. This option is mutually exclusive with the -f field
, -s
sort_field
, and -n n
options.
-f
field
specifies the fields of information and the order in which they are to be returned for each object selected. Each display type has a list of available, key, and default fields. If -f
is specified, the default fields are not displayed unless they are key fields or have been specified. If -f
is not specified, then the default fields are returned. Key fields for each type are normally displayed first. However, you can change the order in which the key fields are displayed by specifying them after the -f
option.
The list of fields is separated by spaces.
-s
sort_field
sorts the objects returned by the field(s) selected in the order specified. Sorting is based on internal database values and may not always display in alphanumeric order.
All returned fields for a type are valid sort fields.
-n
n
specifies the maximum number of objects to be displayed.
The display lsm command
displays specific LSM information based on the options selected.
Note:
See "Using display Command Options" for details about specifying display selection criteria and selecting the data to be displayed.display lsm
lsm_id
... [ -status
lsm_status
... ][-state
lsm_state
... ] [ -free_cells
cell_count
... ][ -type
lsm_type
... ] [ -serial
lsm_serial_num
... ][ -condition
lsm_condition
] [ -door_open | -door_closed ] [ [ -c ] |[ -f field ... ] [ -s
sort_field
... ][ -n
n ] ]
The fields for display lsm, are:
key fields: acs, lsm
default fields: acs, lsm, status, state, free_cells
available fields: acs, lsm, status, state, desired_state, free_cells, type, serial_num, activity, condition, door_status
lsm_id
displays the lsm id in the following format: acs
, lsm
.
Wildcard character, *, can be used in any lsm_id
subfield or used to represent all subfields. However, if it represents all lsm_ids
(example: display
lsm *
or display
lsm_id *,*
), additional lsm_ids
(either numeric or *) are not allowed. Numeric ranges apply to any subfield of lsm_id
.
-status
lsm_status
specifies one or more LSM statuses from which to select. Valid statuses are: audit
, normal
-state
lsm_state
specifies one or more LSM states from which to select. Valid states are: diagnostic, online, offline, offline_pending, recovery
.
-free_cells
cell_count
selects LSMs by the number of free cells.
-type
lsm_type
displays LSMs by type.
-serial
lsm_serial_num
displays serial numbers for selected LSMs.
With SL8500 6.0+ and SL3000 3.0+ firmware, the library reports the licensed serial number. (To get the SL8500 library number, add 1 to the LSM number and divide by 4.)
-condition
lsm_condition
displays condition of the selected LSMs. Valid conditions are: operative
, inoperative
, or maint_required
.
Note:
Aninoperative
or maint_required
condition is only cleared when a drive, LSM, or ACS is varied online. So, an LSM condition of inoperative
or maint_required
may be inaccurate.-door_open
displays LSMs with open doors.
-door_closed
displays LSMs with closed doors.
-c
(count) causes the request to display only the number of objects that satisfy the arg
and selection
criteria. This option is mutually exclusive with the -f field, -s sort_field
, and -n
n options.
-f
field
specifies the fields of information and the order in which they are to be returned for each object selected. Each display type has a list of available, key, and default fields. If -f
is specified, the default fields are not displayed unless they are key fields or have been specified. If -f
is not specified, then the default fields are returned. Key fields for each type are normally displayed first. However, you can change the order in which the key fields are displayed by specifying them after the -f
option.
The list of fields is separated by spaces. The following are new LSM fields that are not reported by query lsm
.
desired_state
The desired state for an ACS, port, LSM, drive, or CAP is the availability that you want for the component. ACSLS sets desired state when an explicit vary
operation is performed. (This is a vary
from a cmd_proc
or ACSAPI client
command. It is not a vary that ACSLS internally generates because of a library status change.)
The current state (specified as "state") for an ACS, port, LSM, drive, or CAP is the current availability of the component limited by desired state. When a drive is varied online, its desired state is online. However, its current state could be offline because the drive is inoperative or is in an LSM that is offline or not ready. The current state of an ACS, port, LSM, drive, or CAP is also referred to as the ”state” of the component in the results of query
and display
commands.
The availability of logical libraries and tape drives in logical libraries is also governed by the desired state that you set for both the underlying physical library and the logical library. If the desired states for both the physical library and logical library are online, the current states of logical libraries and logical tape drives reflect the current state of the underlying physical libraries and drives.
serial_num
The serial number that ACSLS reports for the LSM is the library's serial number that is recorded in the HBC card of the SL3000 and SL8500 libraries (before SL8500 6.00 firmware or SL3000 3.0 firmware.). SL8500 and SL3000 libraries with later firmware report the frame serial number which is the activated serial number.
SL8500 and SL3000 libraries are activated through the serial number for the base module frame. This serial number is on the UL label on the frame and is recorded in the HBK card in the library. (Manufacturing can re-generate replacement HBK cards.) These serial numbers start with 516 for SL8500s and 571 for SL3000s. The frame serial number can be displayed through the SL Console (System Detail -> Properties -> General).
In the future, library firmware will report this frame serial number to ACSLS. Whenever an LSM serial number changes, ACSLS automatically updates the serial number when an LSM is varied online.
-s
sort_field
sorts the objects returned by the field(s) selected in the order specified. Sorting is based on internal database values and may not always display in alphanumeric order.
All returned fields for a type are valid sort fields.
-n
n
specifies the maximum number of objects to be displayed.
The display panel
command displays specific library panel information based on the options selected.
Note:
See "Using display Command Options" for details about specifying display selection criteria and selecting the data to be displayed.display panel
panel_id
...[ -type
panel_type
... ] [ [ -c ] |[ -f field ... ] [ -s
sort_field
... ] [ -n
n ] ]
The fields for display panel, are:
key fields: acs
, lsm
, panel
default fields: acs
, lsm
, panel
, type
available fields: acs
, lsm
, panel
, type
panel_id
displays the panel id in the following format: acs, lsm, panel.
Wildcard character, *, can be used in any panel_id
subfield or used to represent all subfields. However, if it represents all panel_ids (example: display panel *
or display
panel_id *,*,*
), additional panel_ids (either numeric or *) are not allowed. Numeric ranges apply to any subfield of panel_id.
-type
panel_type
specifies one or more valid panel types.
-c
(count) causes the request to display only the number of objects that satisfy the arg
and selection
criteria. This option is mutually exclusive with the -f field, -s sort_field
, and -n
n options.
-f
field
specifies the fields of information and the order in which they are to be returned for each object selected. Each display type has a list of available, key, and default fields. If -f
is specified, the default fields are not displayed unless they are key fields or have been specified. If -f
is not specified, then the default fields are returned. Key fields for each type are normally displayed first. However, you can change the order in which the key fields are displayed by specifying them after the -f
option.
The list of fields is separated by spaces.
-s
sort_field
sorts the objects returned by the field(s) selected in the order specified. Sorting is based on internal database values and may not always display in numeric order.
All returned fields for a type are valid sort fields.
-n
n
specifies the maximum number of objects to be displayed.
The display pool
command displays specific scratch pool information based on the options selected.
Note:
See "Using display Command Options" for details about specifying display selection criteria and selecting the data to be displayed.display pool
pool_id
... [ -low_water
low_water_mark
... | -high_water
high_water_mark
... ][-overflow |
-no_overflow
] [ [ -c ] | [ -f
field
... ][ -s
sort_field
... ] [ -n
n
] ]
The fields for display pool, are:
key fields: pool_id
default fields: pool_id, low_water, high_water, overflow
available fields: pool_id, low_water, high_water, overflow
pool_id
displays the pool id of a scratch pool.
Wildcard character, *, can be used in any pool_id
subfield or used to represent all subfields. However, if it represents all pool_ids (example:
or
display pool *display pool_id *,*,*
), additional pool_ids (either numeric or *) are not allowed. Numeric ranges apply to any subfield of pool_id
.
-low_water
low_water_mark
specifies the minimum number of scratch cartridges in the pool. If a low_water
mark is displayed with a hyphen (-) appended to it, the number of cartridges in the library for the selected scratch pool is within the designated low_water
mark.
-high_water
high_water_mark
specifies the maximum number of scratch cartridges in the pool. If a high_water
mark is displayed with a hyphen (-) appended to it, the number of cartridges in the library for the selected scratch pool is within the designated high_water
mark.
-overflow
selects pools wherein if a scratch mount is requested and if the pool is empty, the common pool satisfies the request.
-no_overflow
selects pools wherein if a scratch mount is requested and if the pool is empty, the mount fails without checking the common pool for available tapes.
-c
(count) causes the request to display only the number of objects that satisfy the arg
and selection
criteria. This option is mutually exclusive with the -f
field
, -s
sort_field
,
and -n
n
o
ptions.
-f
field
specifies the fields of information and the order in which they are to be returned for each object selected. Each display type has a list of available, key, and default fields. If -f
is specified, the default fields are not displayed unless they are key fields or have been specified. If -f
is not specified, then the default fields are returned. Key fields for each type are normally displayed first. However, you can change the order in which the key fields are displayed by specifying them after the -f
option.
The list of fields is separated by spaces.
-s
sort_field
sorts the objects returned by the field(s) selected in the order specified. Sorting is based on internal database values and may not always display in numeric order.
All returned fields for a type are valid sort fields.
-n
n
specifies the maximum number of objects to be displayed.
The display port
command displays specific port information based on the options selected.
Note:
See "Using display Command Options" for details about specifying display selection criteria and selecting the data to be displayed.display port
port_id ... [ -online | -offline ][ -name
port_name ... ] [ [ -c ] | [ -f
field ... ][-s
sort_field ... ] [ -n
n ] ]
The fields for display port are:
key fields: acs, port
default fields: acs, port, name, state
available fields: acs, port, name, state, desired_state
port_id
displays the port id in the following format: acs, port.
Wildcard character, *, can be used in any port_id
subfield or used to represent all subfields. However, if it represents all port_ids (example:
display port *
or display port_id *,*,*
), additional port_ids (either numeric or *) are not allowed. Numeric ranges apply to any subfield of port_id
.
online
selects and displays ports in an online state.
offline
selects and displays ports in an offline state.
name
port_name
specifies the port name.
-c
(count) causes the request to display only the number of objects that satisfy the arg and selection criteria. This option is mutually exclusive with the -f
field,
sort_field
-s,
and -n
n options.
-f
field
specifies the fields of information and the order in which they are to be returned for each object selected. Each display type has a list of available, key, and default fields. If -f
is specified, the default fields are not displayed unless they are key fields or have been specified. If -f
is not specified, then the default fields are returned. Key fields for each type are normally displayed first. However, you can change the order in which the key fields are displayed by specifying them after the -f
option.
The list of fields is separated by spaces. The following is a new port field that is not reported by query
port.
desired_state
The desired state for an ACS, port, LSM, drive, or CAP is the availability that you want for the component. ACSLS sets desired state when an explicit vary
operation is performed. (This is a vary
from a cmd_proc
or ACSAPI client
command. It is not a vary
that ACSLS internally generates because of a library status change.)
The current state for an ACS, port, LSM, drive, or CAP is the current availability of the component limited by desired state. When a drive is varied online, its desired state is online. However, its current state could be offline because the drive is inoperative or is in an LSM that is offline or not ready. The current state of an ACS, port, LSM, drive, or CAP is also referred to as the ”state” of the component in the results of query
and display
commands.
The availability of logical libraries and tape drives in logical libraries is also governed by the desired state that you set for both the underlying physical library and the logical library. If the desired states for both the physical library and logical library are online, the current states of logical libraries and logical tape drives reflect the current state of the underlying physical libraries and drives.
-s
sort_field
sorts the objects returned by the field(s) selected in the order specified. Sorting is based on internal database values and may not always display in alphanumeric order
All returned fields for a type are valid sort fields.
-n
n
specifies the maximum number of objects to be displayed.
The display volume
command displays specific volume information based on the options selected.
Note:
See "Using display Command Options" for details about specifying display selection criteria and selecting the data to be displayed.display volume
vol_id ... [ -home acs,lsm,panel,row,column...] [ -drive
drive_loc ... ] [-data | -scratch | -clean ]
media_type
[ -media... ] [ -pool
pool_id... ] [ -standard |
vol_status
-virtual ] [ -status... ] [ -entry
entry_date ... ] [ -access
access_date ... ] [ -lock
lock_id ... ] [ [ -c ] |
field ... ] [ -s sort_field ... ] [ -n n
[ -f] ]
max_use
[ -max_use] [ -lock_time
lock_time]
The fields for display volume,
are:
key field: vol_id
default fields: vol_id, acs, lsm, panel, row, column, pool, status, media, type
available fields: vol_id; acs; lsm; panel; row; column; drive_lsm
, drive_panel, drive
(display all three to display where a cartridge is mounted); type; media; pool; label_type; status; entry_date; access_date; access_count; max_use; lock; lock_time; recording_format_family; recording_format_model; encrypt_status; volsafe_status; media_status; warranty_life; end_of_life; load_limit_alert
vol_id
displays the volume(s) selected.
A vol_id
can be one or more 1-16 alphanumeric strings that specifies a tape cartridge.
The wildcard character, *, can be used to represent all vol_ids (example:
display vol*) or to represent a group of cartridges (example:.display
vol_id VAP*
displays all cartridges starting with VAP).
The vol_id
may contain any valid volume ID characters and *.
home
home_loc
specifies volume home location(s) from which to retrieve volume information in the following format: acs,lsm,panel,row,column
. It cannot be used with
-drive.
home_loc
subfields can use numeric ranges. All home_loc
subfields must be specified. A wildcard character, *, can be used in place of one or more drive_loc subfields. Numeric range rules apply to any subfield or drive_loc.
acs
<acs_id
>
specifies the ACS for which volume information should be retrieved.
drive
drive_loc
specifies drive location(s) from which to retrieve volume information in the following format: acs
,lsm
,panel
,drive
. It cannot be used with -home
drive_loc
subfields can use numeric ranges. All home_loc
subfields must be specified. A wildcard character, *, can be used in place of one or more drive_loc
subfields. Numeric range rules apply to any subfield or drive_loc
.
data
selects data cartridges.
scratch
selects cartridges in scratch mode.
clean
selects cleaning cartridges.
spent_clean
selects cleaning cartridges reported as spent (used-up) by drive type.
media
media_type
selects only cartridges with the specified media type.
pool
pool_id
selects and displays cartridges from scratch pools. Cartridges retain the ID of the scratch pool even after they have changed to data cartridges.
standard
selects a tape(s) with a scannable volume ID label_type
. It cannot be used with
-virtual.
virtual
selects a tape(s) without an external volume ID label_type that was entered through the venter command. It cannot be used with -standard.
status
vol_status
valid entries are: dismount
, eject
,
enter
, mount,
home, in_drive,
move, missing,
absent, ejected.
entry
entry_date
specifies the date and time the cartridge was entered into the library. It is entered and displayed in ISO standard format (yyyy-mm-dd).
access
access_date
specifies the date and time the cartridge was last used. It is entered and displayed in ISO standard format (yyyy-mm-dd).
lock
lock_id
specifies the lock ID for the volume.
max_use
max_use
specifies the maximum number of uses for a cleaning cartridge. Non-cleaning cartridges have a max_use
value of zero.
lock_time
lock_time
specifies the date and time the lock was set. It is displayed according to the system default format.
recording_format_family drive_family
-recording_format_model drive_model
specifies the recording format drive family and drive model. Example: T10000 and T10000C
c
(count) causes the request to display only the number of objects that satisfy the arg and selection criteria. This option is mutually exclusive with the -f
field,
sort_field
-s,
and -n
n options.
-f
field
specifies the fields of information and the order in which they are to be returned for each object selected. Each display type has a list of available, key, and default fields. If -f
is specified, the default fields are not displayed unless they are key fields or have been specified. If -f
is not specified, then the default fields are returned. Key fields for each type are normally displayed first. However, you can change the order in which the key fields are displayed by specifying them after the -f
option.
The list of fields is separated by spaces. The following is a list of new volume fields that are not reported by query volume
. These statistics fields are only reported for these libraries and drives:
The following statistics fields are only reported for these libraries and drives:
Libraries:
All SL3000s.
SL8500s with 4.13 and later firmware.
Tape drives:
T9840C and T9840D with 1.42 and later drive firmware.
T10000A and T10000B with 1.38 and later drive firmware.
T10000C and T10000D
recording_format_family
This shows the drive family that last recorded data on this cartridge.
recording_format_model
This shows the drive model that last recorded data on this cartridge. This information is useful to:
avoid mounting a cartridge on a drive that cannot read the data on a cartridge (such as, A T10000A cannot read data recorded by a T10000B drive) or
append data to a cartridge (such as, A T10000B cannot append data to a cartridge written by a T10000A).
encrypt_status
This shows the encryption status of a cartridge, if known.
volsafe_status
This shows whether this is a volsafe
cartridge. Volsafe
is StorageTeks' WORM (Write Once Read Many) cartridge.
media_status
When the tape drive reports a cartridge as ”questionable,” it should be examined.
warranty_life
and end_of_life
The volumes' warranty_life
and end_of_life
percentages are the volumes' use as a percentage of its end_of_life setting. These are values from 000.0% to over 100.0%. (The warranty_life
is less than the end_of_life
.)
This information can be used to identify cartridges that need to be retired after migrating their data to new cartridges.
load_limit_alert
The volumes' load_limit_alert
is a boolean value, where: True=1 and False=0. When a volume that reports an end_of_life
percentage reaches 100%, its load_limit_alert
is set to 1. Some drive types only report a load_limit_alert
.
-s
sort_field
sorts the objects returned by the field(s), selected in the order specified. Sorting is based on internal database values, and may not always display in alphanumeric order. For example, media type
is sorted by an internal numeric media type and not by the literal that is display
.
All returned fields for a type are valid sort fields.
-n
n
specifies the maximum number of objects to be displayed.
To display volumes based on location:
This example displays all volumes with home locations in panel 0,1,9.
display volume * -home 0,1,9,*,*
To display all 9840 data volumes.
display volume * -media STK1R
To display 9840 data volumes with their recording formats (if known):
display volume * -media STK1R -f media recording_format_family recording_format_model
To display a cleaning volumes by ACS and media type:
display volume * -home acs,*,*,*,* -media media_type
-f vol_id acs lsm media max_use access_count
To display volumes by date:
To display all volumes entered in 2011:
display volume * -entry 2011
To display all volumes entered in January, 2011
display volume * -entry 2011-01
To display all volumes entered on January 27, 2011
display volume * -entry 2011-01-27
To display all volumes entered on January 27, 2011 between 10:00 a.m. and 11:00 a.m.
display volume * -entry 2011-01-27:10
To display all volumes entered between January 2011 and April 2011.
display volume * -entry 2011-01-2011-04
To display all volumes entered between 6:33 a.m. and 6:57:45 April 10 (for example, do this after an outage).
display volume * -entry 2011-04-10:06:33:00-2011-04-10:6:57:45
To display all volumes entered since February 25, 2011.
display volume * -entry >2011-02-25
To display T10000 data volumes sorted by end_of_life
usage:
display volume * -media T10000T1 T10000TS -f media end_of_life warranty_life -s end_of_life
To display all volumes warranty life and end-of-life and sorted by end_of_life usage
display volume * -f warranty_life end_of_life -s end_of_life
To display spent (used-up) cleaning cartridges:
display volume * -spent_clean