.\"
.\" $Id: nsr_jukebox.5,v 1.11.10.5 2005/11/15 00:48:43 gajand Exp $ Copyright (c) 2005 EMC Corporation.
.\"

.\"
.\" Copyright (c) 2005 EMC Corporation.
.\"
.\" All rights reserved.  This is an UNPUBLISHED work, and
.\" comprises proprietary and confidential information of EMC.
.\" Unauthorized use, disclosure, and distribution are strictly
.\" prohibited.  Use, duplication, or disclosure of the software
.\" and documentation by the U.S. Government is subject to
.\" restrictions set forth in a license agreement between the
.\" Government and EMC or other written agreement specifying
.\" the Government's rights to use the software and any applicable
.\" FAR provisions, such as FAR 52.227-19.
.\"
.TH "NSR_JUKEBOX" 5 "Aug 23, 06" "StorEdge EBS 7.3.2"
.SH NAME
nsr_jukebox \- Sun StorEdge EBS resource type ``NSR jukebox''
.SH SYNOPSIS
.B  "type: NSR jukebox"
.SH DESCRIPTION
Each jukebox known to Sun StorEdge EBS is described by a single resource of type
.BR "NSR jukebox" .
A jukebox keeps track of the resources, volumes and
devices that are being managed by an external media management service and
are available to this Sun StorEdge EBS server. An example of an external media
management service is OpenVault. 
This resource describes the physical characteristics of a jukebox.
See
.BR nsr_resource (5).
To edit the NSR jukebox resources for a Sun StorEdge EBS server, type:
.br
.RS
\fR\s10nsradmin -c "type:NSR jukebox"\fP\s0
.RE
.br
or use
.B Sun StorEdge EBS Management Console.
See the
.BR nsradmin (8)
manual page for more information on
using the Sun StorEdge EBS Administration program.
.SH ATTRIBUTES
.LP
The following attributes are defined for resource type
.BR "NSR jukebox" .
The information in parentheses describes how the attribute values are accessed.
.B Create-only
indicates that the value cannot be changed by an administrator, except
when the resource is created.
.B Read-only
indicates that the value cannot be changed by an administrator.
.B Read/write
means the value can be set as well as read at any time.
.B Choice list
means that any number of values can be chosen from the given list.
.B Yes/no
means only a yes or no choice is possible.
.B Single string
means that only a single value is allowed.
.B Number
means that only numeric values are allowed.
.B Static
attributes change values rarely, if ever.
.B Dynamic
attributes have values which change rapidly.
.B Hidden
means it is an attribute of interest only to programs or experts,
and these attributes can only be seen when the hidden option is turned on in
.BR nsradmin (8).
For example, an attribute marked
.B "(read-only, dynamic)"
has a value which cannot be changed by the administrator but which may
change each time it is retrieved from the Sun StorEdge EBS server due to
underlying state changes.
Several additional attributes (for example, administrator) are common
to all resources, and are described in
.BR nsr_resource (5).
.TP
.BR "name" "		(create-only, single string)"
This attribute specifies the name of this jukebox.
The value of this attribute may follow the "rd=hostname:" syntax of
a remote device, when the jukebox is defined on a storage node.  See
.BR nsr_storage_node (5)
for additional detail on storage nodes.
.br
.I Example:
\fR\s10name: Huntington;\fP\s0
.TP
.BR "comment" "		(read/write)"
This attribute is provided for the administrator to keep any explanatory
remarks or supplementary information about the jukebox.
.br
.TP
.BR "description " "	(read/write)"
This attribute is used to store a brief description about the jukebox. The
description is used to help administrators identify the jukebox,
and it can be in any format.
.br
.I Example:
\fR\s10description: DLT Changer drive in Engineerning Lab;\fP\s0
.TP
.BR "model" "		(create-only, single string)"
This attribute specifies the jukebox model.
.br
.I Example:
\fR\s10model: ADIC-VLS;\fP\s0
.TP
.BR "physical slots" " (read-only, list of numbers, hidden)"
This attribute specifies the first and last
physical slot numbers in the jukebox.
The first slot number must be less than or equal to the last slot number.
The numbers must also be specified as two separate attribute values.
.IP ""
For Silo Tape Libraries (STL), this attribute is equal to the number
of volumes allocated to this Sun StorEdge EBS server,
.BR nsrjb (5)
.BR \-a
or
.BR \-x.
The number of physical slots changes as volumes are added or removed from
the STL.
.br
.I Example:
\fR\s10physical slots: 1, 54;\fP\s0
.TP
.BR "control port" "	(read/write, single string)"
This attribute specifies the path of the control port for the
jukebox robotics.
Control commands (load slot 47 into drive b, for example) are sent to
the jukebox via the control port.
.IP ""
For an STL, this attribute specifies the information required to set up
a connection to the STL server. Form and contents of the attribute
depend on the type of the STL, but most often it merely contains the
hostname of STL server.
.IP ""
The value of this attribute may follow the "rd=hostname:" syntax of
a remote device, when the jukebox is defined on a storage node.  See
.BR nsr_storage_node (5)
for additional detail on storage nodes.
.br
.I Example:
\fR\s10control port: scsidev@0.6.0;\fP\s0
.TP
.BR "devices" "		(read/write, list of strings)"
This attribute lists the device pathnames of the devices in the jukebox.
Each entry that appears in this attribute must have a corresponding
.B "NSR device"
resource.
Unless any of the drives are being shared by multiple device resources, there must be the same number of entries in the
.I "devices"
attribute as there are physical drives in the jukebox.
In addition, they must be listed in the same order as they are physically
installed in the jukebox.
The entries are specified as separate attribute values.
.br
.I Example:
\fR\s10devices: /dev/rmt/0mbn, /dev/rmt/1mbn;\fP\s0
.PP
.RS 5
This attribute is updated by
.B jbedit
when adding or deleting a shared device or a physical drive.
.RE
.TP
.BR "number devices" "  (read/write, single number, hidden)"
The number of configured devices in the jukebox.
This value corresponds to the number of entries in the
.B devices
attribute.
.br
.I Example:
\fR\s10number devices: 2;\fP\s0
.PP
.RS 5
This attribute is incremented or decremented by
.B jbedit
depending on whether a device is being added to or deleted from the jukebox.
.RE
.TP
.BR "number drives" "  (read/write, single number, hidden)"
The number of unique physical drives configured in the jukebox.  When
multiple device resources share a physical drive, each drive is
represented by a unique
.B hardware ID
attribute, that is specified in all of the device resources
sharing the same drive.
.br
.I Example:
\fR\s10number drives: 2;\fP\s0
.PP
.RS 5
This attribute is updated by
.B jbedit
when adding or deleting a unique physical drive but left unmodified when changing a shared device.
.RE
.TP
.BR "device hardware ids" "	(read-only, hidden)"
The hardware ids of the jukebox's devices. For each entry in the
.B devices
attribute of the jukebox resource, there will be a corresponding entry in the
.B device hardware ids
attribute. The
.B hardware id
entries of those devices sharing a physical drive will have the same value.
.TP
.BR "slot tags" "	(read-only, hidden)"
The tags of the jukebox's slots as reported by the
.B nsrlcpd (8)
process. This attribute will have a
.B tag
entry for each configured slot.
.TP
.BR "drive tags" "	(read-only, hidden)"
The tags of the jukebox's drives as reported by the
.B nsrlcpd (8)
process. For each entry in the
.B devices
attribute of the jukebox resource, there will be a corresponding entry in the
.B drive tags
attribute. The
.B drive tags
entries of those devices sharing a physical drive will have the same value.
.TP
.BR "idle device timeout" "	(read/write, hidden)"
This attribute specifies the number of minutes to wait before unmounting a
volume in an idle device.
Setting this attribute's value to zero disables unmounting idle volumes.
The function of this attribute only applies to SmartMedia jukeboxes, or
silo and native jukeboxes with device sharing enabled.
.br
.I Example:
\fR\s10idle device timeout: 10;\fP\s0
.TP
.BR "SmartMedia update interval" "    (read/write, hidden)"
This attribute specifies the number of hours between calls to update
the SmartMedia server's database.
The SmartMedia database contains information copied from the Sun StorEdge EBS
media database.
The information includes the pool to which a volume belongs,
whether the volume is full, and so forth.
This information is used by the SmartMedia server
when selecting a volume for writing.
Since this information may change over time,
it is necessary to periodically make sure that the data replicated
in the SmartMedia server's database is current.
This attribute determines the time period between attempts to
update the SmartMedia server's database.
This attribute only applies to SmartMedia jukeboxes.
.br
.I Example:
\fR\s10SmartMedia update interval: 12;\fP\s0
.TP
.BR "write enabled" "	(read/write, yes/no, hidden)"
This attribute indicates whether writing can be done to the mounted volume.
This attribute is only used during a jukebox ``Load'' operation.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10write enabled: Yes;\fP\s0
.TP
.BR "bar code reader" "	(read/write, yes/no)"
This attribute indicates whether Sun StorEdge EBS should use the barcode
label from the media if the jukebox has a barcode label reader.
This should only be enabled if the jukebox has a barcode label reader.
.br
.I Example:
\fR\s10bar code reader: No;\fP\s0
.TP
.BR "match bar code labels" "	(read/write, yes/no)"
This attribute indicates whether Sun StorEdge EBS should use the barcode
label instead of a label template when labeling media volumes.
This should only be enabled if the jukebox has a barcode label reader
and the attribute "bar code reader" is enabled.
.br
.I Example:
\fR\s10match bar code labels: No;\fP\s0
.TP
.BR "verify label on unload" "  (read/write, yes/no)"
This attribute indicates whether Sun StorEdge EBS should verify that a label
exists at the beginning of every tape before it is unloaded.  If this
attribute is set to Yes and this label does not exist, all savesets on
the volume are marked suspect and the volume is marked full.
.TP
.BR "volume expiration" "  (read/write, single string, hidden)"
This attribute specifies the expiration time of a volume currently
being labeled.  For jukeboxes interacting with external media
management services, this attribute specifies
the minimum expiration time for the volume to be loaded.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.TP
.BR "available slots" "	(read/write, list of numbers)"
This attribute specifies the slots containing volumes available
to automatically satisfy Sun StorEdge EBS requests for writable volumes.
When automatically selecting a writable volume,
.BR nsrjb (8)
will only consider volumes from the list of available slots.
The slots are specified as a list of ranges, one range per attribute value.
A range may be a single slot number or a pair of
slot numbers separated by a dash.
The first number of a pair must be less than or equal to the second.
.IP ""
For Silo Tape Libraries, this attribute is automatically updated
when adding or removing volumes,
.BR nsrjb (8)
.BR \-a
or
.BR \-x.
.IP ""
When satisfying requests to mount a particular volume (that is, by its volume
name)
or slot, all of the volumes in the slots listed in
.I physical slots
can be used.
This allows the jukebox to be partitioned, with saves restricted to a group of
volumes while all of the volumes contained within the jukebox are accessible
for recovers.
.br
.I Example:
\fR\s10available slots: 1-10;\fP\s0
.TP
.BR "enabler code" "	(read-only, single string, hidden)"
This attribute lists the enabler code for the
.B "NSR license"
resource
(see
.BR nsr_license (5))
corresponding to this jukebox resource.
A jukebox cannot be used until a license enabler has been loaded to
control that jukebox.
.br
.I Example:
\fR\s10enabler code: 123456-123456-123456;\fP\s0
.TP
.BR "enabled slots" "  (read-only, single string, hidden)"
The value of this attribute is the number of slots enabled for this jukebox.
This attribute's value is set by the server when an enabler code is loaded to
the jukebox.
.br
.I Example:
\fR\s10enabled slots: 8;\fP\s0
.TP
.BR "operation" "	(read/write, choice list, hidden)"
This attribute shows the operation currently being performed on the jukebox.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10operation: Load;\fP\s0
.TP
.BR "command" "	(read-only, single string, hidden)"
This attribute shows the command that caused the current operation to be
performed on the jukebox. If the operation was generated via a
.B nsrjb
command then this attribute shows the entire
.B nsrjb
command line, otherwise it shows a description of the operation.
The attribute is used to pass information between Sun StorEdge EBS programs,
and to help the administrator track the status of individual operations
(see 
.BR nsr_jbop (5)).
This attribute should not be changed manually by the administrator.
.br
.I Example:
\fR\s10command: nsrjb -lnv -S 2;\fP\s0
.TP
.BR "operation message" "  (read-only, single string, hidden)"
This attribute displays an error message after a jukebox operation fails.
.br
.I Example:
\fR\s10operation message: ;\fP\s0
.TP
.BR "operation device" "  (read/write, single string, hidden)"
This attribute passes the name of the device to which the
current operation refers.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10operation device: /dev/rmt/0mbn;\fP\s0
.TP
.BR "operation drive element address" "    (read/write, hidden)"
This attribute passes the element address of the drive to which the
current operation refers.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10operation drive element address: D:082;\fP\s0
.TP
.BR "operation slots" " (read/write, single string, hidden)"
This attribute passes the
slots on which the current operation will be performed.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10operation slots: 1-10;\fP\s0
.TP
.BR "operation options" " (read/write, single string, hidden)"
This attribute passes the mode of the volume used when the
current operation will be performed,
.BR nsrjb (5)
.BR \-o
option.
This attribute is used to pass information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10operation options: manual;\fP\s0
.TP
.BR "operation barcodes" " (read/write, list of strings, hidden)"
This attribute passes the volume tags or barcodes on which
the current operation will be performed.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
This attribute is only used for Silo Tape Libraries and
is only defined on platforms which provide support for Silo Tape Libraries.
.br
.I Example:
\fR\s10operation barcodes: A01B, A0/3\-5/B;\fP\s0
.TP
.BR "operation response" " (read/write, choice list, hidden)"
This attribute designates a default response to questions that may be
asked while performing the operation.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10operation response: Yes;\fP\s0
.PP
.BR "operation report mode" " (read/write, choice list, hidden)"
This attribute designates the amount of output generated during the
execution of the operation.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10operation report mode: verbose;\fP\s0
.PP
.BR "operation label state" " (read/write, choice list, hidden)"
This attribute designates whether a volume being labeled is to be
recycled or is expected to be unlabeled. If a volume is to be recycled,
it must already have a Sun StorEdge EBS label.  You can recycle a volume
while it is being mounted.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10operation label state: recycle;\fP\s0
.PP
.BR "operation volume capacity" " (read/write, single string, hidden)"
This attribute specifies the capacity of a volume being labeled.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10operation volume capacity: 10G;\fP\s0
.PP
.BR "operation volume type" " (read/write, choice list, hidden)"
This attribute specifies types of volumes that may be considered when
allocating a volume.   It is only used when interacting with an external media
management service.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10operation volume type: 8mm, dlt;\fP\s0
.TP
.BR "operation ineligible" "	(read/write, hidden)"
This attribute specifies volumes which are ineligible for the current
operation. Only used when interacting with an external media management
service.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10operation ineligible: ;\fP\s0
.TP
.BR "operation task" " (read/write, choice list, hidden)"
This attribute designates a secondary task or operation to be performed
with the current operation. For example, choosing the
.B mount after label
task will cause the volume to be mounted after it has been labeled.
Currently, this attribute is
only used when interacting with an external media management
service.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10operation task: mount after label;\fP\s0
.TP
.BR "operation instance" " (read/write, single string, hidden)"
This attribute designates an instance number to be associated with
the operation. The instance must be unique for all current operations.
.TP
.BR "operation hostname" " (read/write, single string, hidden)"
This attribute designates the name of the machine on which the operation
is to be executed. This attribute is only
used for those jukeboxes which support devices
attached to multiple hosts. The host machine may be inferred
from other attributes for the operation, such as
.B operation device.
If a device is specified, the operation will be executed on the
host for the device. Otherwise the host will be inferred from the name of
the jukebox, unless a value is specified for this attribute.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10operation hostname: host1;\fP\s0
.PP
.BR "operation dev hostname" " (read/write, single string,"
.RS
hidden)
.br
This attribute designates the name of the machine from which a device
is to be selected for the operation.  It applies to shared jukeboxes,
which can have drives attached to multiple hosts.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10operation dev hostname: host1;\fP\s0
.RE
.TP
.BR "operation template" " (read/write, single string, hidden)"
This attribute shows the template that the label operation will use.
The verify operation sets this to the volume name found
on a piece of media.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10operation template: Default;\fP\s0
.PP
.BR "operation volume pool" " (read/write, choice list, hidden)"
This attribute specifies the default volume pool to use when labeling.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10operation volume pool: NonFull;\fP\s0
.PP
.BR "operation source pool" " (read/write, choice list, hidden)"
This attribute specifies the pool from which a volume may be selected
when recycling a volume. This attribute is
only supported on jukeboxes for volumes
being managed by an external media management package.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10operation source pool: Default;\fP\s0
.PP
.BR "operation uses left" " (read/write, single string, hidden)"
This attribute sets the number of times a cleaning cartridge
may be used.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10operation uses left: 12;\fP\s0
.TP
.BR "volumes" "      (read/write, list of strings, hidden)"
This attribute contains a list of resident volume names.
The order corresponds to the slot number.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10volumes: mars.001, mars.002, mars.003, mars.004;\fP\s0
.TP
.BR "volume ids" "    (read/write, list of strings, hidden)"
Every volume labeled by Sun StorEdge EBS is assigned a volume identifier, often
referred to as a volid.
This attribute contains a list of volume identifiers for the resident
volumes.
The volume identifiers stored could be the new long volume IDs or
the older and shorter volume IDs. The type of volume identifiers
stored depends on whether the storage node on which the device
belonging to the jukebox resides on, supports the new
long volume id or not. 
The order corresponds to the slot number.
.br
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10volumes: 24198, 24199, 24200, 24197;\fP\s0
.PP
.BR "volume cartridge ids" " (read/write, list of strings, hidden)"
Some jukeboxes track volumes that are managed by external media
management services. There may be multiple volumes on the same media,
for example, a volume on each side of an optical disk. This attribute is used
to track the identifier for each cartridge on which a volume resides.
The order corresponds to the slot number.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.TP
.BR "loaded volumes" " (read/write, list of strings, hidden)"
This attribute contains the names of the volumes currently loaded on the
jukebox devices.
The order is with respect to the
.I "devices"
attribute.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.IP ""
This attribute is updated by
.B jbedit
when adding or deleting a shared device or a physical drive.
.br
.I Example:
\fR\s10loaded volumes: mars.089, mars.003;\fP\s0
.br
.IP ""
Using the names specified in the previous
.I devices
attribute,
.I mars.089
is loaded in `/dev/rmt/0mbn' and
.I mars.003
is loaded in `/dev/rmt/1mbn'.
.TP
.BR "loaded bar codes" " (read/write, list of strings, hidden)"
This attribute contains the barcodes of the loaded volumes,
if the use of barcodes is enabled for the jukebox.
The order is with respect to the
.I "devices"
attribute.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.IP ""
This attribute is modified by
.B jbedit
when a device is added to or removed from the jukebox resource.
.br
.I Example:
\fR\s10loaded barcodes: 12345, 67890;\fP\s0
.br
.IP ""
Using the names specified in the previous
.I devices
attribute,
the volume with barcode 12345 is loaded in `/dev/rmt/0mbn' and
the volume with barcode 67890 is loaded in `/dev/rmt/1mbn'.
.TP
.BR "loaded slots" " (read/write, list of numbers, hidden)"
This attribute contains the slot numbers of the loaded volumes.
The order is with respect to the
.I "devices"
attribute.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.IP ""
This attribute is modified by
.B jbedit
when a device is added to or removed from the jukebox resource.
.br
.I Example:
\fR\s10loaded slots: 48, 3;\fP\s0
.br
.IP ""
Using the names specified in the previous
.I devices
attribute,
the volume in slot 48 is loaded in `/dev/rmt/0mbn' and
the volume in slot 3 is loaded in `/dev/rmt/1mbn'.
.TP
.BR "event tag" "	(read/write, single number, hidden)"
This attribute contains the tag (unique identifier) of the last
notification event sent to the
.BR nsrd (8)
daemon.
The tag is used by
.BR nsrjb (8)
to clear the previous event.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10event tag: 6319962287;\fP\s0
.br
.TP
.BR "event message" " (read/write, single string, hidden)"
This attribute contains the text of the last notification event sent to the
.BR nsrd (8)
daemon.
The
.BR nsrjb (8)
command will send a notification event to
.B nsrd
when operator intervention is needed before
.B nsrjb
can proceed.
This attribute passes information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10event message: could not unload device /dev/rmt/1mbn into slot 4;\fP\s0
.br
.TP
.BR "messages" "	(read/write, list of strings, hidden)"
This attribute contains a log of messages reflecting previous operations
.BR nsrjb (8)
has done.
Generally, an entry is made each time
.B nsrjb
is invoked and for each mechanical operation.
Each entry is timestamped.
This attribute is used to pass information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.br
.I Example:
\fR\s10messages: 04/01/91 01:15:08 loaded slot 4 into drive a;\fP\s0
.TP
.BR "minimum space" " (read/write, single string, hidden)"
This attribute contains the low water mark for  remaining
space.   When  the  remaining space on the volumes
contained in the  available  slots  is  less  than  the
minimum  space,  irrespective  of whether there is only
one volume or more in the Jukebox, an  alert  notification
is sent that states that the volumes in the named jukebox
has passed the low water mark, the  first  time its noticed.
After this, during subsequent checks, if the situation has
not changed, that is, remaining space is still less than or 
equal to the limit specified in "minimum space", a notification is sent to
.BR nsrd
about the  available space on the volume(s). If there is just
one volume, then,  even  if  the  limit  has  not  been
reached,  the notification about the available space on
the volume, is sent. This  hidden  attribute  can  be
modified by a user.
.I "This hidden attribute can be modified by a user."
.IP ""
The minimum space may be specified as a number of gigabytes or megabytes.
Either `G' or `g' may be used for gigabytes, `M' or `m' for megabytes.
.br
.I Example:
\fR\s10minimum space: 7g;\fP\s0
.br
.TP
.BR "jukebox options" " (read-only, list of strings, hidden)"
This attribute contains a list of the options for this jukebox.  This option
is automatically set after jukebox creation.
.br
.I Example:
\fR\s10jukebox options: two_sided;\fP\s0
.br
.TP
.BR "auto clean" "	(read/write, yes/no)"
This attribute specifies whether automatic cleaning of devices in the
the jukebox is enabled.
.br
.I Example:
\fR\s10auto clean: Yes;\fP\s0
.br
.TP
.BR "cleaning slots" "	(read/write, list of numbers)"
This attribute designates a range of slots in the jukebox that has
been set aside for cleaning cartridges. A range may be a single slot
number or a pair of slot numbers separated by a dash.
If a pair of slot numbers is given, the first number of the pair must
be less than or equal to the second. Only one range of slots may
be set aside for cleaning cartridges.
If
.B "auto clean"
is set to \fBno\fR,
the value of cleaning slots is ignored and these slots may contain
regular volumes.
When
.B auto clean
is set to \fByes\fR,
the range of slots specified for this attribute are assumed to contain
cleaning cartridges, and
the range of slots specified by
.B available slots
and this attribute must not overlap.
.IP ""
For Silo Tape Libraries this attribute should not be changed
directly. This attribute is automatically updated, when adding
(\fBnsrjb \-U\fR)
or removing
(\fBnsrjb \-x\fR)
cleaning cartridges.

.br
.I Example:
\fR\s10cleaning slots: 9-10;\fP\s0
.br
.TP
.BR "default cleanings" "	(read/write, single number)"
This attribute designates the number of uses assigned to a new cleaning
cartridge during an inventory of a jukebox by
.BR nsrjb (8).
A cleaning cartridge is considered to be new when a slot set aside for
cleaning cartridges that was empty is discovered to be full during an
inventory of a jukebox.
.br
.I Example:
\fR\s10default cleanings: 12;\fP\s0
.br
.TP
.BR "auto media management" "	(read-write)"
This attribute indicates whether automated media management for the jukebox
is enabled.
The value can be \fByes\fR or \fBno\fR.
If the value is set to \fByes\fR, then unlabeled volumes in the jukebox
may be automatically labeled by Sun StorEdge EBS.
Sun StorEdge EBS verifies that the volume is unlabeled before labeling the volume.
A volume is considered to be unlabeled if the volume does not contain a label
that may be read by the device in the jukebox into which the volume is loaded.
Note that if the volume contains a label, but the label is written at a
density that cannot be read by the device the volume is considered to
be unlabeled.
If the volume contains data written by an application other than Sun StorEdge EBS,
it most likely does not have a label recognizable by Sun StorEdge EBS and the
volume is considered to be unlabeled.
With this attribute enabled, care should be taken when loading any volume
considered to be unlabeled into the jukebox.
The volume may be re-labeled and the data previously on the volume
over-written by Sun StorEdge EBS.
For devices in a jukebox the value of their
.BR "auto media management"
attribute is always \fBno\fR.
.br
.I Example:
\fR\s10auto media management: yes;\fP\s0
.TP
.BR "STL device names" "	(read/write, list of strings)"
This attribute lists the corresponding Silo device names of the devices
listed in the
.B devices
attribute.  If several device resources are sharing the same physical
Silo drive, as indicated by a common
.B hardware ID
value, this attribute will only have an entry for each of the physical
drives.  This attribute is only used for Silo Tape Libraries and
is only defined on platforms which provide support for Silo Tape Libraries.
.TP
.BR "STL interface lib" "	(read/write, single string)"
The pathname of the dynamically linked interface library.
This attribute is only used for Silo Tape Libraries and
is only defined on platforms which provide support for Silo Tape Libraries.
.br
.I Example:
\fR\s10STL interface lib: /usr/lib/libstl.so.1;\fP\s0
.TP
.BR "STL device sharing" "	(read/write, single string)"
This attribute specifies how to handle device sharing.
Device sharing means automatic, load dependent, device switching of devices
in a Silo Tape Library between different hosts connected to the library.
This feature can only be used if it is supported by the
.BR "STL interface lib".
Possible values for this attribute are an empty string
(device sharing disabled) or "perm-max", where perm and max are numbers 
with perm < max. The perm value is the number of devices that can be reserved 
permanently (do not require releasing).  The max value is 
the maximum number of devices that can be reserved.
This attribute is only used for Silo Tape Libraries and
is only defined on platforms which provide support for Silo Tape Libraries.
.br
.I Example:
\fR\s10STL device sharing: 2-4;\fP\s0
.TP
.BR "STL barcodes" "  (read/write, list of strings, hidden)"
The barcodes of the volumes in the library, which are available for Sun StorEdge EBS.
This attribute maintains the volume names used by the Silo Tape Libraries for
the corresponding volumes in the
.BR volumes
attribute.
This attribute is only used for Silo Tape Libraries and OpenVault virtual
jukeboxes. The attribute
is only defined on platforms which provide support for Silo Tape Libraries
or OpenVault.
.PP
.BR "STL device reservation" " (read/write, list of strings,"
.RS
hidden)
.br
This list contains the reservation state of shared devices in a tape library.
The possible states are "Yes" (device is reserved),
"No" (device is not reserved)
and "Error" (an error occurred during release of this device).
The order of the reservation state matches the `devices' attribute.
This attribute is only used for Silo Tape Libraries with device
sharing enabled and
is only defined on platforms which provide support for Silo Tape Libraries.
.RE
.TP
.BR "application name" " (read/write, encrypted, hidden)"
This attribute is only used for OpenVault jukeboxes. OpenVault
requires any application to identify itself when submitting a request.
This is the name used by this server to identify itself to OpenVault
when submitting a request to access resources listed in this jukebox.
.TP
.BR "application key" "	(read/write, encrypted, hidden)"
This attribute is only used for OpenVault jukeboxes. OpenVault
requires any application to identify itself when submitting a request.
This is the key used by this server to identify itself to OpenVault
when submitting a request to access resources listed in this jukebox.
.TP
.BR "read hostname" "	(read/write, single string)"
The hostname that is used in selecting a storage node for recover and
read-side clone requests.  For recover requests, if the required volume
is not mounted, and the client's "storage nodes" attribute does not
match one of the owning hosts in the jukebox, then this attribute is
used.  For clone requests, if the required volume is not mounted, then
this attribute is used.
.TP
.BR "NDMP jukebox" "	(read-only, yes/no)"
This attribute specifies that the jukebox robotics is controlled by the NDMP
Tape Server host.
.TP
.BR "NDMP type" "	(read-only, Choice list, hidden)"
This attribute specifies the type of control that the NDMP jukebox provides. Other than
Celestra 1.6 on Solaris, all other jukeboxes that are controlled by NDMP Tape
Server will have the value "Logical Handle Device".
.TP
.BR "NDMP hostname" "	(read-only, single string)"
This attribute specifies the NDMP Tape Server hostname that is controlling
the jukebox robotics.
.TP
.BR "remote user" "	(read/write, single string, hidden)"
This field is no longer used. The NDMP user name on the NDMP Tape Server host
is used from
.B NSR storage node
(5) resource.
.TP
.BR "password" "	(read/write, single string, hidden)"
This field is no longer used. The password for the NDMP user on the NDMP Tape
Server host is used from
.B NSR storage node
(5) resource.
.TP
.BR "NDMP jukebox handle" "	(read-only, single string)"
This attribute specifies the jukebox handle on the NDMP Tape Server host to control
the jukebox robotics.
.TP
.BR "NDMP bus number" "	(read-only, number, hidden)"
This attribute specifies the BUS number of the Jukebox on the NDMP Tape Server
host. This field maintained for backward compitiability.
.TP
.BR "autodetect id" "	(read/write, hidden)"
This attribute is for identifying autodetected devices.
It is used by Sun StorEdge EBS programs only,
and should not be changed manually by the administrator.
.TP
.BR "server network interface" " (read/write, hidden)"
This attribute defines the network address or the hostname
which is used to communicate with nsrjb. This field is only relevant,
if the jukebox is connected to a storage node.
.TP
.BR "jukebox serial number" " (read only)"
This attribute indicates the serial number of the jukebox.
.TP
.BR "hardware id" "           (read only, hidden)"
This attribute indicates the hardware identifier for the auto-detected jukebox.
.TP
.BR "ASCAPI" "		(read/write, yes/no, hidden)"
This attribute is kept for historical reasons only.
It has no affect.
.TP
.BR "debug trace level" "(read/write, single number, hidden)"
The level of debug messages generated & displayed during a jukebox
operation may be set on a per jukebox basis. The value default value
is 0, which means no debug information collected or displayed. Higher
values represent increasingly larger amounts of debug information
being captured.
.TP
.BR "operation timeout" "(read/write, single number, hidden)"
The time, in seconds, that a jukebox operation may sit idle before
it is automatically cancelled. The default is 1800 seconds (30 minutes).
.TP
.BR "operation lifespan" "(read/write, single number, hidden)"
The time, in seconds, that the jukebox operation resource (for a completed
jukebox operation) is kept in
.B nsrd
before automatically being deleted.  The default value is 1800
seconds (30 minutes)
.TP
.BR "ready" "		(read/write, yes/no, hidden)"
Indicates whether the jukebox is ready to accept operations to
be executed. The value is automatically set to "No" when Networker
is started, and will be changed to "Yes" once Networker determines
that the jukebox has finished initializing, and is ready to begin
work.  Any reset of the jukebox will also change the
.I ready
attribute back to "No" until the rest has completed.
.TP
.BR "unconfigured devices" "        (read only, hidden)"
Indicates the list of device names belongs to this jukebox, which are
discovered by auto-detect during last scan however not yet configured
in the library.
.TP
.BR "library drive base address" "  (read only, hidden)"
Indicates the base element address of the drives in the jukebox.
The device detection program,
.B dvdetect,
updates the resource.
.TP
.BR "existing drive ids" "          (read only, hidden)"
Inidcates the serial numbers information of the currently existing
drives in the jukebox. The device detection program,
.B dvdetect,
updates the resource.
.TP
.BR "existing drive addresses" "    (read only, hidden)"
Indicates the element addresses of the currently existing drives
in the jukebox. The device detection program,
.B dvdetect,
updates the resource.
.TP
.BR "unconfigured drive ids" "      (read only, hidden)"
Indicates the serial numbers information of the unconfigured drives
(detected in last scan however not yet configured) in the jukebox.
The device detection program,
.B dvdetect,
updates the resource.
.TP
.BR "unconfigured drive addresses" "(read only, hidden)"
Indicates the element addresses of the unconfigured drives
(detected in last scan however not yet configured) in the jukebox.
The device detection program,
.B dvdetect,
updates the resource.

.SH EXAMPLE
.LP
A resource defining a jukebox named
.I Huntington
is shown.
The
.I model
attribute specifies a `Exabyte 210' jukebox.
The
.I control port
attribute specifies the bus, target, and LUN ID for the robotics device
`scsidev@0.6.0'.
The
.I device
attribute lists the pathnames of the two tape devices
in the jukebox, `/dev/rmt/0mbn' and `/dev/rmt/1mbn'.
Since the jukebox has a bar code reader, the two bar code yes/no attributes
are both set to `Yes'.
The
.I available slots
attribute lists the slots to consider when automatically
selecting a volume to load for writing.
The available slots are 2 through 11.
The hidden attributes are displayed.
.I auto clean
is yes so automatic cleaning of devices is enabled for this jukebox.
.I cleaning slots
is set to slot 1. This slot is reserved for a cleaning cartridge.
.LP
.br
.nf
\fR\s10
.ta \w'SmartMedia update interval:'u+2nR +1m
	type:	NSR jukebox;
	name:	Huntington;
	model:	EXB-210;
	physical slots:	1-11;
	control port:	scsidev@0.6.0;
	devices:	/dev/rmt/0mbn, /dev/rmt/1mbn;
	number devices:	2;
	number drives:	2;
	device hardware ids:	"", "";
	idle device timeout: 10;
	SmartMedia update interval: 12;
	write enabled:	Yes;
	bar code reader:	Yes;
	match bar code labels:	Yes;
	volume expiration:	;
	available slots:	2-11;
	enabler code:	012345-6789ab-cdef00;
	operation:	;
	operation message:	;
	operation device:	;
	operation slots:	;
	operation ports:	;
	operation options:	;
	operation barcodes:	;
	operation response:	;
	operation report mode:	;
	operation label state:	;
	operation volume capacity:	;
	operation volume type:	;
	operation ineligible:	;
	operation task:	;
	operation instance:	;
	operation hostname:	;
	operation dev hostname:	;
	operation template:	;
	operation number uses:	;
	operation volume pool:	;
	operation source pool:	;
	volumes:	-, -, -, -, -, -, -, -, -, -, -;
	volume ids:	"", "", "", "", "", "", "", "", "", "", "";
	STL barcodes:	;
	STL device sharing:	;
	STL device reservation:	;
	STL interface lib:	;
	event tag:	;
	event message:	;
	messages:	"09/12/03 11:50:56 CREATED";
	minimum space:	7g;
	jukebox options:	;
	auto clean:	Yes;
	cleaning slots:	1;
	default cleanings:	12;
	auto media management:	Yes;
	reset class:	initialize unload;
	application name:	;
	application key:	;
	read hostname:	hostname;
	debug trace level:	0;
	operation timeout:	1800;
	ready:		Yes;
.ta
.fi
.LP
.SH SEE ALSO
.na
.hy 0
.BR nsr (5),
.BR nsr_device (5),
.BR nsr_storage_node (5),
.BR nsradmin (8),
.BR nsrd (8),
.BR nsrjb (8),
.BR dvdetect (8),
.BR "NSR storage node" (8),
.hy 14
.ad