.\"
.\" $Id: nsr_device.5,v 1.4.32.3 2006/04/26 18:52:18 castrv 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_DEVICE 5 "Aug 23, 06" "StorEdge EBS 7.3.2"
.SH NAME
.B nsr_device
\- Sun StorEdge EBS resource type "NSR device"
.SH SYNOPSIS
.B  "type: NSR device"
.SH DESCRIPTION
Each storage device used by a Sun StorEdge EBS server is described by a
single resource of type
.BR "NSR device".
See
.BR nsr_resource (5)
for information on Sun StorEdge EBS resources.
To edit the
.B NSR device
resources run:
.br 
.RS
\fR\s10nsradmin -c "type:NSR device"\fP\s0
.RE
.br 
Be sure to include quotation marks and to insert a space between
"NSR" and "device".
See
.BR nsradmin (8)
for information on using the Sun StorEdge EBS administration program.
The mounting and unmounting of individual
volumes (tapes or disks) is performed using the
.BR nsrmm (8),
and
.BR nsrjb (8),
commands and
.B Sun StorEdge EBS Management Console.
.SH ATTRIBUTES
.LP
The following attributes are defined for resource type
.BR "NSR device" .
The information in parentheses describes how the attribute values are accessed.
.B Read-only
indicates that the value cannot be changed by an administrator.
.B Read/write
indicates a value that can be set as well as read.
.B Hidden
indicates a hidden attribute of interest only to programs or experts.
These attributes can only be seen when the hidden option is turned on in
.BR nsradmin (8).
.B Static
attributes change values rarely, if ever.
.B Dynamic
attributes have values that change rapidly.
For example, an attribute marked
.B "(read-only, static)"
has a value that is set when the attribute is created and never changes.
.TP
.BR "name " "	(read-only, static)"
This attribute specifies the path name of the device.
Only non-rewinding tape devices are supported.
For systems that support "Berkeley style" tape positioning, use
the BSD tape device name.
The name given to Optical disks is typically the name given
to the "c" partition of the raw device.
.br
.br
A logical device type has been defined to facilitate
interaction with external media management services.
When interacting with external media management services, the device name may be
determined by the media management service associated with the device where a volume
is loaded. The logical device is used to define a Sun StorEdge EBS device resource.
The number of device resources that can exist is limited by the number of volumes
managed by the service that Sun StorEdge EBS may access simultaneously.
The name given to a logical device is not related to any specific device,
but is required to be a unique name for the device.
For logical devices, both the media type and the family are set to
.B logical.
The name, type, and family are determined after the media management service
has loaded a volume into a device in response to a request made by Sun StorEdge EBS.
The name, type, and family of the actual device are then stored in the
attributes
.B logical name,
.B logical type,
and
.B logical family,
respectively.
The association between the logical device and the actual device only exists
when the volume is loaded into the device and allocated for use by
Sun StorEdge EBS.  
.br
.br
Specify UNC (\\\\<server-name>\\<share-point-name>) path
when creating an adv_file device of a network filesystem on
Windows storage node.
.br
.br
When defining a remote device on a storage node, include the prefix
"rd=hostname:", in the path name; where 
.I hostname
is the system to which the
device is directly attached (the storage node).  For more information, see
.BR nsr_storage_node (5).
.br
.br
.B Example:
\fR\s10name: /dev/rmt/0hbn;\fP\s0
.TP
.BR "comment" "		(read/write)"
This attribute is provided for the administrator to keep any explanatory
remarks or supplementary information about the device.
.br
.TP
.BR "description " "	(read/write)"
This attribute is used to store a brief description about the device. The
description is used to help administrators identify the device,
and it can be in any format.
.br
.br
.B Example:
\fR\s10description: DLT8000 tape drive in Engineering Lab rack #2;\fP\s0
.TP
.BR "message" "	(read-only, dynamic, hidden)"
This attribute specifies the last message received
from the Sun StorEdge EBS server regarding this device.
The values for this attribute may include
information on the progress or rate of the operation.
.br
.B Example:
\fRmessage: "Tape full, mount volume mars.017 on /dev/nrst8";\fP\s0
.TP
.BR "volume name" "	(read-only, dynamic, hidden)"
This attribute monitors the mounting and unmounting of
volumes for a device. When a volume is mounted, the value is the volume name,
otherwise there is no value.
.br
.B Example:
\fR\s10volume name: mars.017;\fP\s0
.TP
.BR "media family" "	(read-only, static, hidden)"
This attribute describes the class of storage media, as determined from the
media type. The only legal values are:
.B tape
\- tape storage device;
.B disk
\- disk storage device;
.B logical
\- used when interacting with an external media management service.
.br
.B Example:
\fR\s10media family: tape;\fP\s0
.TP
.BR "media type" "	(read-only, static)"
This attribute indicates the type of media a device uses.
The
.I media type
varies depending on the operating system/platform (See the
online Sun StorEdge EBS Hardware Compatibility Guide, which is
referenced in the Sun StorEdge EBS Administration Guide in the Device
and Media Management chapter, for a
comprehensive list of media types supported on your platform.).
Potential values, their meaning, and default capacities are:
.br
.na
.B 4mm
\- 4mm digital audio tape (1 GB);
.B 8mm
\- 8mm video tape (2 GB);
.B 8mm 5GB
\- 8mm video tape (5 GB);
.B adv_file
\- advanced file type device,
standard UNIX file system is supported;
.B dlt
\- digital linear tape cartridge (10 GB);
.B vhs
\- VHS data grade video tape (14 GB);
.B 3480
\- high-speed cartridge tape (200 MB);
.B qic
\- quarter inch data cartridge (150 MB);
.B himt
\- half inch magnetic tape (100 MB);
.B tk50
\- DEC TK50 cartridge tape (94 MB);
.B tk70
\- DEC TK70 cartridge tape (296 MB);
.B optical
\- optical disks, Write Once Read Many (WORM),
Erasable Optical Disks (EOD), or standard UNIX files are supported;
.B file
\- file type device,
standard UNIX file system is supported;
.B logical
\- used when interacting with an external media management service.
.br
.B Example:
\fR\s10media type: 8mm 5GB;\fP\s0
.TP
.BR "enabled" "	(read-write)"
This attribute indicates whether a device is available for use.
The value for this attribute is either \fBYes\fR, \fBNo\fR or \fBService\fR.
If the value is set to \fBYes\fR the device is fully operational and can
be used for all operations.  This is the default setting for a device.
If the value is set to \fBNo\fR, the device is disabled and may not be
used. A device cannot be set to \fBNo\fR if a device is mounted, since
it would cause the mounted volume to become inaccessible to Sun StorEdge EBS
until the device is set back to \fBYes\fR. If the value is set to
\fBService\fR, the device may not be mounted for save or recover operations.
This state is used to reserve a device for maintenance. The device can be
used for administrative purposes such as volume verification, labeling or
inventories if the device is selected using the -f option.  A device set
in \fBService\fR mode can not be used for save or recover operations. If
the device is set to \fBService\fR while the device is in use, all
current sessions will be allowed to complete normally, but no new
sessions will be assigned to the device.
If the device is a jukebox device, the device will be unloaded after the  
sessions have completed.
.br
.B Example:
\fR\s10enabled: yes;\fP\s0
.TP
.BR "shared devices" "	(read-write, hidden)"
This attribute enables, disables or service modes all devices that have the
same value for their
.B hardware id
attribute, and so are sharing the same physical drive.
Possible values are \fBenable all\fR, \fBdisable all\fR, \fBservice all\fR or
\fBdone\fR.
After the value is set to either \fBenable all\fR, \fBdisable all\fR or 
\fBservice all\fR and the action is performed, the value will be reset to
\fBdone\fR.
The action will enable, disable or service mode as many devices as it can,
regardless of any error conditions.  For example, it is not possible to
disable a device that has a mounted volume.  So when this attribute is set
to \fBdisable all\fR, as many devices as possible will be disabled,
excluding those with mounted volumes.  For such cases, an error message
will be logged.
.br
.B Example:
\fR\s10shared devices: done;\fP\s0
.TP
.B "write enabled" "	(read/write, dynamic, hidden)"
This attribute indicates whether writing to the current volume is allowed.
The value for this attribute may be set to \fByes\fR or \fBno\fR.
This value can only be set when a volume is not mounted.
.br
.B Example:
\fR\s10write enabled: no;\fP\s0
.TP
.BR "read only" "	(read-write)"
This attribute indicates whether a device is reserved for read-only
operations, such as recover or retrieve. The value for this
attribute can be either \fByes\fR or \fBno\fR.
If the value is set to \fByes\fR, only read operations are permitted on the device.
This value cannot be changed if a volume is mounted.
.br
.B Example:
\fR\s10read only: yes;\fP\s0
.TP
.BR "target sessions" "			(read/write)"
This attribute indicates the target number of sessions that will write
to a device.  When all devices on a host have the same value for this
attribute, sessions are assigned to a device, until the device's
.B target sessions
is reached; then sessions are assigned to the next device on the host.
Once all devices have reached their
.B target sessions,
new sessions are assigned equally across all devices.
.br
When this attribute has different values for devices on a host, and
the
.BR nsrmmd (8)
has not yet been assigned to a device, then sessions are assigned to an
.BR nsrmmd (8)
based on the lowest attribute value among the host's devices.  Once the
.BR nsrmmd (8)
is assigned to a device, the
.B target sessions
value for the assigned device is used.
.br
Use higher values to multiplex more clients onto each tape.
This attribute is not a maximum number for a device, but is used for
load-balancing.
.br
.B Example:
\fR\s10target sessions: 3;\fP\s0
.TP
.BR "volume label" "	(read/write, dynamic, hidden)"
This attribute is set by the
.B "Verify label"
operation and can be performed before the
.B Label 
operation.  If this attribute is blank during the labeling process, then the
volume's
current label is reused.
.TP
.BR "volume default capacity" "	(read/write, static, hidden)"
This attribute is used by the
.B Label
operation when the
.B "volume current capacity"
attribute is blank.  To override the volume default capacity associated with
the media type, you must enter a specific value, such as 1 or greater.
The value of this attribute must end with K, M, or G, where K represents
kilobytes, M represents megabytes, and G represents gigabytes.
The actual capacity written to the volume may be slightly lesser or greater
than the value specified.
.br
.br
This hidden attribute can be modified by a user, and
can be used to override default sizes when using devices
(and/or tapes) with different capacities than the defaults.
.br
.br
.B Example:
To override the default capacity of a tape drive to 10 Gb
for all future volume label operations, set the value as follows:
.br
\fR\s10volume default capacity: 10G;\fP\s0
.br
.TP
.BR "volume current capacity" "	(read/write, dynamic, hidden)"
If the attribute's value is non-blank, it determines the
capacity of a volume during the
.B Label
operation.  Its format is the same as
.B volume default capacity.
.br
.B Example:
\fR\s10volume current capacity: 5G;\fP\s0
.TP
.B "volume expiration" "	(read/write, dynamic, hidden)"
This attribute is set by the
.B "Verify label"
operation and can also be used by the
.B Label 
operation.
The value for this attribute is specified in
.BR nsr_getdate (3)
format.
A blank value causes the default expiration to be used during labeling.
.br
.B Example:
\fR\s10volume expiration: next year;\fP\s0
.TP
.BR "volume pool" "	(read/write, hidden)"
This attribute indicates the pool that a mounted
volume belongs to.  This attribute can be set right after a device
has been created and prior to a volume has been labeled to specify or
display the default pool selection for the
.B Label
operation.
If this attribute is set during a
.B Label
or
.B "Label without mount"
operation,
this value will indicate the pool a volume is being assigned to.
In order to change the volume pool assignment,
.B Label
operation must be performed by specifying a different pool.
Manual updates to this attribute in Devices resource has no effect
on the pool assignment.  See
.BR nsr_pool (5)
for more information on volume pools.
.br
.B Example:
\fR\s10volume pool: myPool;\fP\s0
.TP
.BR "volume flags" "	(read/write, hidden)"
This attribute displays the new flags for the volume being operated on.
This attribute is used during "Label" or "Label without mount" operations.
.TP
.BR "volume operation" "	(read/write, dynamic, hidden)"
The 
.I volume operation
attribute manipulates the media (volume) currently located inside the
device.  This attribute can be set to one of the following values:
.BR Unmount ,
.BR Mount ,
.BR "Verify label" ,
.BR "Verify write time" ,
.BR Label ,
.BR "Label without mount" ,
.BR Eject ,
or
.BR "Monitor device".
Each of these operations may require parameters to be set.
.br
.br
When the value is
.BR Unmount ,
Sun StorEdge EBS releases the device.
The
.B Unmount
operation is asynchronous.
.br
.br
When the value is
.BR Mount ,
Sun StorEdge EBS mounts the loaded volume into the device.
The
.B Mount
operation is asynchronous.
.br
.br
When the value is
.BR "Verify label" ,
the volume's label is read by Sun StorEdge EBS, and the 
.B volume label
and
.B volume expiration
attributes are set.
The
.B Verify label
operation is synchronous, and therefore the operation may take a long time to
complete.
.br
.br
When the value is
.B Verify write time,
the volume's label is read by Sun StorEdge EBS, and the attributes
.BR "volume label" ,
.BR "volume expiration" ,
and
.B "volume write time"
are set. The
.B Verify write time
operation is synchronous, and therefore the operation may take a long time to complete.
.br
.br
When the value is
.B Label 
or
.BR "Label without mount" ,
the volume receives a new label as determined by the attributes below.
When the value is
.B Label,
the volume is then mounted.
These operations are asynchronous.
.br
.br
When the value is
.BR Eject ,
Sun StorEdge EBS ejects the volume from the device.
The
.B Eject
operation is asynchronous.
.br
.br
When the value is
.BR "Monitor device"
and the device is idle (no volume loaded into the device), Sun StorEdge EBS will
periodically check the device to determine whether a volume has been
loaded into the device.
When a volume containing a readable Sun StorEdge EBS label is loaded, the volume
is placed into the Sun StorEdge EBS media database. The volume can then be written to by
Sun StorEdge EBS if the
volume is mounted with write permissions turned on; otherwise, the volume is mounted
as read-only, and cannot be written to by Sun StorEdge EBS.
When a volume without a readable Sun StorEdge EBS label is loaded into the device,
the device's
.BR "unlabeled volume loaded"
attribute is set to \fByes\fR, and the volume may be labeled at a later
date. The
.BR "Monitor device"
operation is never performed on jukebox devices, because Sun StorEdge EBS only monitors
non-jukebox devices.
.TP
.BR "volume write time" "	(read-only, dynamic, hidden)"
This attribute indicates the time that a save set was first written to the volume.
.TP
.BR "volume error number" "	(read-only, dynamic, hidden)"
This attribute indicates the last error number reported for this device. This is a numeric value encoded with the source, severity and the actual error number. Processes check for this value only on error in a media operation when the media operation is known to update this field, e.g., a label verify. The error number is not reset on a successful media operation, so it is not an indication of the status of the last media operation, but just the last error number reported for this device.
.TP
.BR "volume block size" "	(read-only, dynamic, hidden)"
This attribute indicates the block size of the currently mounted volume.
.TP
.BR "volume id" "	(read-only, dynamic, hidden)"
This attribute indicates the volume id for the currently mounted volume.
.TP
.BR "long volume id" "	(read-only, dynamic, hidden)"
This attribute indicates the volume id for the currently mounted volume in
the long globally unique format.
.TP
.BR "accesses" "	(read-only, hidden)"
This attribute indicates the total number of operations performed on the
device since it was configured as a Sun StorEdge EBS device.
Changes to this attribute are propagated to all devices that have the same
.B "hardware id"
value.
.TP
.BR "access weight" "	(read/write, hidden)"
This attribute indicates the weight of a single operation performed on the
device.  The "accesses" attribute will be incremented by "access weight"
each time an operation is performed on the device.  The higher the weight,
the less often the device will be selected for new operations.
Changes to this attribute are propagated to all devices that have the same
.B "hardware id"
value.
.TP
.BR "consecutive errors" "	(read-only, dynamic, hidden)"
This attribute indicates the current number of consecutive errors on a device.
Changes to this attribute are propagated to all devices that have the same
.B "hardware id"
value.
.TP
.BR "max consecutive errors" "	(read/write, hidden)"
This attribute indicates the maximum number of consecutive errors allowed
before disabling the device.
Changes to this attribute are propagated to all devices that have the same
.B "hardware id"
value.
.TP
.BR "operation arg" "	(read-only, dynamic, hidden)"
This attribute indicates extra parameters to be used during device operations.
Parameters are packed into a string and parsed by the associated operation's function.
.TP
.BR "volume message" "	(read-only, dynamic, hidden)"
This attribute indicates the result of the last volume operation.
.TP
.BR "event tag" "	(read/write, single number, hidden)"
This attribute contains the tag (unique identifier) of the last
notification event sent to the
.B nsrd (8)
daemon.
The tag is used to clear the previous event.
This attribute is used to pass information between Sun StorEdge EBS programs,
and should not be changed manually by the administrator.
.TP
.BR "NSR operation" "	(read-only, dynamic, hidden)"
This attribute indicates the current operation being performed by a device.
The valid values for this attribute are:
.BR Idle ,
.BR Write ,
.BR Read ,
.BR Eject ,
.BR "Verify label" ,
or
.BR Label .
.br
.br
.B Example:
\fR\s10NSR operation: Write;\fP\s0
.TP
.BR "minor mode" "	(read-only, dynamic, hidden)"
This attribute indicates the current state of a device.  The
.BR "NSR operation"
attribute is the major mode.
The valid values for this attribute are:
.BR idle ,
.BR reading ,
.BR writing ,
.BR rewinding ,
.BR "moving forward" ,
.BR "moving backward" ,
.BR error ,
.BR done ,
.BR "writing eof" ,
or
.BR "finding eom" .
.br
.br
.B Example:
\fR\s10minor mode: moving forward;\fP\s0
.TP
.BR "jukebox device" "	(read/write, dynamic, hidden)"
This attribute indicates the media device that is part of a jukebox device.
This value can be either \fByes\fR or \fBno\fR.
.TP
.BR "statistics" "	(read-only, dynamic, hidden)"
This attribute reports the statistics for the operation of this device.
The statistics include:
.br
the time of operation ("\fBelapsed\fR"),
the number of errors ("\fBerrors\fR"),
the last writing rate ("\fBlast rate\fR"),
the maximum number of concurrent clients ("\fBmax clients\fR"),
the number of file marks written ("\fBfile marks\fR"),
the number of rewinds ("\fBrewinds\fR"),
the number of files skipped ("\fBfiles skipped\fR"),
the number of records skipped ("\fBrecords skipped\fR"),
the current file number ("\fBcurrent file\fR"),
the current record number ("\fBcurrent record\fR"),
the relative number of files being spaced over ("\fBseek files\fR"),
the relative number of records being spaced over ("\fBseek records\fR"),
the total estimated amount read/written on the volume, in KB
("\fBestimated KB\fR", to be implemented in a future release),
the total amount read/written on the volume, in KB ("\fBamount KB\fR"),
the current amount read/written on this file, in KB ("\fBfile amount KB\fR"),
and the current number of sessions assigned to this device ("\fBsessions\fR").
.TP
.BR "cleaning required" "	(read/write)"
This attribute indicates whether a device needs to cleaned. The value for
this attribute may be either \fByes\fR or \fBno\fR. If the value of this attribute
changes from
yes to no and the value of
.B "date last cleaned"
attribute is not updated, then the
.B "date last cleaned"
attribute is set to the current time. Sun StorEdge EBS might set this attribute to yes
if, at the time the device is next scheduled to be cleaned, it is not available
to be cleaned. In this case, the following message is displayed:
.B device cleaning required.
This message indicates that the device needs to be cleaned.
This attribute can only be used for a device whose
.B "media family"
is \fBtape\fR
and
.B "jukebox device"
is \fByes\fR.
For all other devices, the value of this attribute is always \fBno\fR.
.TP
.BR "cleaning interval" "	(read/write)"
This attribute indicates the amount of time from the
.B "date last cleaned"
until the next scheduled cleaning for the device. This value can be
specified in \fBdays\fR, \fBweeks\fR, or \fBmonths\fR. One day, week,
or month is implied if a number is not specified. If this attribute is
set and
.B "date last cleaned"
is blank,
.B "date last cleaned"
is set to the current time.
This attribute may only be used for a device whose
.B "media family"
is \fBtape\fR
and
.B "jukebox device"
is \fByes\fR.
.br
.br
.B Example:
\fR\s10cleaning interval: 2 weeks;\fP\s0
.TP
.BR "date last cleaned" "	(read/write)"
This attribute indicates the time and day a device was last cleaned.
Input may be in any format acceptable to
.BR nsr_getdate (3).
Some values acceptable to
.BR nsr_getdate (3)
are relative, for example, \fBnow\fR. For that reason all input is
converted into
.BR ctime (3)
format, weekday, month, day, time, year.
As noted in the description of
.B "cleaning required"
and
.B "cleaning interval",
the value of this attribute might be set automatically by Sun StorEdge EBS.
This attribute can only be used for a device whose
.B "media family"
is \fBtape\fR
.TP
.B "auto media management" "	(read-write)"
This attribute indicates whether "automated media management" is enabled for
a device.
For jukebox devices this value is always \fBno\fR.
See
.BR nsr_jukebox (5)
for a description of
.BR "auto media management"
for a jukebox.
For non-jukebox devices, this value can be either \fByes\fR or \fBno\fR.
If this value is set to \fByes\fR, then any recyclable volumes loaded into the
device might be automatically re-labeled by Sun StorEdge EBS for re-use, and
unlabeled volumes
loaded into the device can be automatically labeled.
When Sun StorEdge EBS is labeling a volume that is not expected to have a valid
Sun StorEdge EBS label, it 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 this device.
.br
.br
.B Note: 
If a volume contains a label, but the label is written at a
density that cannot be read by the associated 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 or recyclable into the device.
The volume might be re-labeled and the data previously on the volume
over-written by Sun StorEdge EBS.
.br
.br
When this attribute is set to \fByes\fR for a device, and the device is
idle (no tape loaded into the device), Sun StorEdge EBS will monitor
the device and wait for a volume to be loaded.
See the description of \fBMonitor device\fR in the discussion of the
.BR "volume operation"
attribute.
.br
.br
.B Example:
\fR\s10auto media management: yes;\fP\s0
.TP
.BR "NDMP" "	(read-only)"
This attribute is used to note which devices are associated with
NDMP servers.
This attribute cannot be changed after the resource has been created.  The
resource must be deleted and recreated if the user needs to change this
attribute for this device.
The same username 
.RB ( "remote user " "attribute)"
and 
.B password
should be configured in the device
resource as they are configured for the NDMP server.
.br
.B Example:
\fR\s10NDMP: yes;\fP\s0
.TP
.BR "max active devices" "	(read-write)"
This attribute set the maximum number of devices Sun StorEdge EBS may use
from the storage node associated with the device.
All devices on a storage node must have the same value for
this attribute. When this attribute is modified, the new value is
propagated to all other devices on the storage node.
The default value for this attribute is NULL = no limit on the number of
active devices on the storage node.
For newly created devices the value of this attibute is inherited from
other devices on the same storage node or set to the default value of
NULL if there are no other devices on the storage node.
Value for this attribute must be an integer greater than the number
of non-shared devices on the storage. 
This attribue can only be set on storage nodes with shared devices.
.TP
.BR "dedicated storage node" "	(read-write)"
The value for this attribute can be either \fByes\fR or \fBno\fR.
The value of this attribute determines whether a storage node is a
dedicated storage node.
A dedicated storage node can only back up its local data.
All devices on a storage node must have the same value for this attribute.
When a device is created or the value of this attribute is modified,
the value of this attribute is propagated to all other devices on the
storage node.
.br
.B Example:
\fR\s10dedicated storage node: yes;\fP\s0
.TP
.BR "remote user" "		(read/write, string)"
This attribute is used when the NDMP attribute is set to a value
of yes.  The value entered for this attribute should be the username
configured for the NDMP server.  This attribute is also used when creating
an adv_file device of a network drive on Windows storage node.
Specify remote user attribute as the user name for the Windows storage node
(nsrmmd) to connect to the network drive.
.br
.B Example:
\fR\s10remote user: root;\fP\s0
.TP
.BR "password" "	(read/write, encrypted)"
This attribute is used in conjunction with the
.B "remote user"
attribute to configure access to a NDMP server.
This attribute is also used in conjunction with the
.B "remote user"
attribute to connect to an adv_file device of a network drive on
Windows storage node.
.br
.B Example:
\fR\s10password: ;\fP\s0
.TP
.BR "unlabeled volume loaded" "	(read-only, dynamic, hidden)"
This attribute indicates whether a volume loaded into the device has
a readable Sun StorEdge EBS volume label. This value can be either \fByes\fR or \fBno\fR.
This attribute is set to \fByes\fR when Sun StorEdge EBS is monitoring the device,
a volume is loaded into the device, and the volume does not have a valid
Sun StorEdge EBS label that can be read by this device.
This attribute is set to \fBno\fR when the volume in the device is labeled
or ejected from the device.
.TP
.BR "logical name" "	(read-only, hidden, no create)"
This attribute indicates the name of the actual device
associated with the logical device.
This attribute is only used for logical devices.
.br
.br
.B Example:
\fR\s10logical name: /dev/rmt/0hbn;\fP\s0
.TP
.BR "logical family" "	(read-only, hidden, no create)"
This attribute indicates the family of the actual device
currently associated with the logical device. The values that can
be associated with this attribute are the values that are valid
for the 
.B "media family"
attribute.
The only exception is that the value of this attribute cannot
be set to
.B logical.
This attribute is only used for logical devices.
.br
.br
.B Example:
\fR\s10logical family: tape;\fP\s0
.TP
.BR "logical type" "	(read-only, hidden, no create)"
This attribute indicates the actual device type associated with the logical device.
The values that
can be associated with this attribute are the values that
are valid
for the 
.B "media type"
attribute.
The only exception is that the value of this attribute cannot
be set to
.B logical.
This attribute is only used for logical devices.
.br
.br
.B Example:
\fR\s10logical type: 8mm 5GB;\fP\s0
.TP
.BR "hardware id" "	(read/write)"
This attribute represents the unique identification of a shared physical
drive, which can be accessed by multiple device resources.  Each device
resource that shares the same physical drive must have the same value
for this attribute.  It can only be updated when the device is disabled
and not within a jukebox resource.  When a value is defined for this
attribute, corresponding device messages will contain a number that
uniquely represents the
.B "hardware id"
attribute, and will be visible in administrator commands, such as
.B Sun StorEdge EBS Management Console
and
.BR nsrwatch (8).
This number identifies the devices that share the same physical drive. 
.TP
.BR "save mount timeout" "	(read/write, hidden, no create)"
This attribute indicates the timeout value for an initial save mount
request for the storage node on which a device is located.  If the
request is not satisfied within the indicated time, the storage
node will be locked from receiving save processes for
the "save lockout" time.  See
.BR nsr_storage_node (5)
for a description of storage nodes.  This attribute can be used for
local devices as well, but "save lockout" cannot be changed from its
default value of zero.  Hence, local devices cannot be locked out from
save requests.
.TP
.BR "save lockout" "	(read/write, hidden, no create)"
This attribute indicates the number of minutes a storage node will be
locked from receiving save assignments after it reaches the
.B "save mount timeout"
time during a save mount request.
A value of zero indicates that the node will not be locked.  This
attribute cannot be changed for local devices.
.TP
.BR "CDI" "	(read-write, no create)"
This attribute indicates whether CDI (Common Device Interface) is 
used to communicate with this device and if so, which CDI method is used.
The value for this attribute is one of:
.RS 10
.IP "\fBNot used\fR" 5
Sun StorEdge EBS will use the same method to communicate with a device as in 
versions up to and including 6.x. This setting is mainly for debugging
purposes, since selecting \fBNot used\fR essentially turns off the use of CDI.  
.IP "\fBSCSI commands\fR" 5
Sun StorEdge EBS will use the CDI interface to send explicit SCSI commands to 
tape drives.  This allows the best control of and status collection from
a device and is the default for SCSI or SCSI-like tape drives directly 
under Sun StorEdge EBS's control. 
.IP "\fBTape driver commands\fR" 5 
Sun StorEdge EBS will use all available functions that are present in the
operating system's tape driver interface.  There are many capabilities 
that tape drivers lack which are unavailable to Sun StorEdge EBS if this setting
is selected.  Also, different OSes support different functions, so devices
may behave differently on different platforms if this choice is selected.  
.IP "\fBGeneric tape driver commands\fR" 5
Sun StorEdge EBS will use only those functions that are present on all Unix 
platforms.  This will give results similar to the \fBNot used\fR 
selection, except that CDI code will be used instead of the pre 7.0 code. 
.IP "\fBNDMP\fR" 5
Sun StorEdge EBS will use NDMP to control NDMP connected tape devices.  The 
exact functions available will likely depend on the NDMP server being
used.  
.IP "\fBiSCSI\fR" 5
Sun StorEdge EBS will use iSCSI commands to control iSCSI connected tape devices.
.RE
.TP

.B Example:
\fR\s10CDI: SCSI commands;\fP\s0

.TP
.BR "device block size" "	(read-write, single number, hidden)"
This attribute allows you to override the device's default block size
on a per-device basis. Allowable values are  \fBhandler default\fR (the 
default setting for this attribute), \fB32kB\fR, \fB64kB\fR, \fB96kB\fR,
\fB128kB\fR, \fB160kB\fR, \fB192kB\fR, \fB224kB\fR, \fB256kB\fR, \fB384kB\fR,
\fB512kB\fR, \fB640kB\fR, \fB768kB\fR, \fB896kB\fR, and \fB1024kB\fR.
Note that the block size for a Sun StorEdge EBS volume is set when the volume is
labeled, so a change to this attribute will not have any effect until a
volume is recycled.  Also, resetting this attribute to  \fBhandler default\fR
will not have any effect until the nsrmmd daemon for this device is restarted. 
Also, hardware platform limitations may result in the use of a block size 
smaller than that selected in this attribute, as some SCSI adapters or adapter
drivers place limits on the maximum size of a SCSI transfer. These
limits are usually silently enforced by Sun StorEdge EBS.
.TP
.BR "device file size" "	(read-write, single number, hidden)"
This attribute allows you to override the default tape file size used by
Sun StorEdge EBS for this device.  The file size is the number of blocks (tape 
records) that Sun StorEdge EBS will write before writing a filemark to the
tape.  Allowable values are between 100 and 3,000,000.
.TP
.BR "device load time" "	(read-write, single number, hidden)"
This attribute allows you to override the default load time used by
Sun StorEdge EBS for this device.  The load time is the number of seconds
that Sun StorEdge EBS will continue trying to open a tape device after 
loading it into a tape drive.  Allowed values are between 10 and 900
seconds.

This attribute is only used when \fBCDI\fR is set to \fBNot used\fR.
.TP
.BR "device eject time" "	(read-write, single number, hidden)"
This attribute allows you to override the default tape eject time used by
Sun StorEdge EBS for this device.  The eject time is the number of seconds that 
Sun StorEdge EBS will wait for a tape drive to eject a tape before trying
to remove the tape from the drive.  Allowed values are between 30 and 900
seconds.
.TP
.BR "device poll interval" "	(read-write, single number, hidden)"
This attribute allows you to override the default tape polling interval 
used by Sun StorEdge EBS for this device.  The polling interval is the number
of seconds that Sun StorEdge EBS will wait between successive attempts to
determine whether a tape drive is ready for use.  Allowed values are 
between 1 and 30 seconds.
.TP
.BR "device min load tries" "	(read-write, single number, hidden)"
This attribute allows you to override the load try limit used by 
Sun StorEdge EBS for this device.  The load try limit is the minimum number
of times that Sun StorEdge EBS will attempt to determine if a tape drive is 
ready for use.  This is primarily intended for operating systems where
the open() system call to a tape drive that is not yet ready takes a
very long time to fail. Allowable values are between 2 and 120.

This attribute is only used when \fBCDI\fR is set to \fBNot used\fR.
.TP
.BR "device tape flags" "	(read-write, hidden)"
This attribute allows you to override the default flags used by
Sun StorEdge EBS for this device.  The flags are settings that
control major aspects of how Sun StorEdge EBS interacts with a device.
Allowable values are \fBTAPE\fR, \fBNOEOM\fR, \fBPHYSREC\fR, 
\fBSIZED\fR, \fBNOBSF\fR, \fBFILE\fR, \fBFILESYS\fR, \fB32K\fR, 
separated with either spaces or an 'or' symbol (\fB|\fR), and possibly
preceded by an 'or' symbol (\fB|\fR).

\fBWARNING:\fR You should only use this attribute if you have been
instructed to by EMC Technical Support, as misuse can cause the 
loss of data on any tapes that get loaded into the drive when this
attribute is set to anything other than the default empty value.
.TP
.BR "device default capacity" "	(read-write, single number, hidden)"
This attribute allows you to override the default capacity used by
Sun StorEdge EBS for this device.  The default capacity is a typical value
for the uncompressed storage capacity for drives of a given device
type, and does not take different tape sizes or compression methods
into account.  It is only used for rough informational purposes and
has no effect whatever on the amount of data that Sun StorEdge EBS will 
write to a tape.

This attribute is only used when \fBCDI\fR is set to \fBNot used\fR.
.TP
.BR "TapeAlert Critical" "	(read-write, no create)"
This attribute stores a list of any Critical TapeAlert flags that may
have been collected from a tape drive during operations.  Critical flags
are those that might result in data loss.  Often, these will require user
intervention to resolve.  

There are several Critical flags that will automatically be cleared by 
Sun StorEdge EBS when the particular flag no longer pertains to the drive. 
(The actual TapeAlert flag number is in parentheses after the flag name):
.RS 10
.IP "Media (4)" 5
unrecoverable read, write or positioning error caused by tape
.IP "Write protect (9)" 5
Attempt to write to a write-protected tape
.IP "Recoverable snapped tape (13)" 5
tape has snapped in a drive where the tape can be ejected
.IP "Forced eject (16)" 5
The tape was manually ejected from the drive
.IP "Clean now (20)" 5
The tape drive needs to be cleaned
.RE
.RS 5
Note that all of the TapeAlert attributes really should be "delete-only"
lists, since they are used purely to report problems that the hardware
reports to us.  However, Sun StorEdge EBS does not have a "delete only" attribute,
so these are read-write.  Sun StorEdge EBS does use the values held in these 
attributes to suppress repeated warnings about a problem that has 
already been reported in the daemon.log, messages file and any Sun StorEdge EBS
administrative GUI that might be open.
.RE
.TP
.BR "TapeAlert Warning" "	(read-write, no create)"
This attribute stores a list of any Warning TapeAlert flags that may
have been collected from a tape drive during operations.  Warning flags
are those that do not indicate the immediate danger of data loss, but do
represent some aspect of device operation that may lead to data loss in
the future. 

There are several Warning flags that will automatically be cleared by Sun StorEdge EBS:
.RS 10
.IP "Read warning (1)" 5
The drive is having problems reading from the tape.  No data
has been lost but performance may suffer
.IP "Clean periodic (21)" 5
The drive is due for routine cleaning
.RE

.TP
.BR "TapeAlert Information" "	(read-write, no create)"
This attribute stores a list of any Information TapeAlert flags that may
have been collected from a tape drive during operations.  Information flags
represent occurrences that should be noted but which will not lead to loss
of data.

There are several Information flags that will automatically be cleared
by Sun StorEdge EBS:
.RS 10
.IP "No removal (10)" 5
An attempt was made to eject a tape when the drive was in use
.IP "Cleaning media (11)" 5
The tape in the drive is a cleaning tape and cannot be used for data
.IP "Unsupported format (12)" 5
The tape in the drive is a format that is not supported by the drive
.IP "Nearing media life (19)" 5
The tape cartridge is nearing the end of its specified life
.RE

.TP
.B "autodetect id" "	(read/write, hidden)"
This attribute is for identifying auto-detected devices.
It is used by Sun StorEdge EBS programs only,
and should not be changed manually by the administrator.
.TP
.B "server network interface" " (read/write, hidden)"
This attribute defines the network address or the hostname
which is used to communicate with mmd. This field is only relevant,
if the device is connected to a storage node.
.SH EXAMPLE
.LP
A complete example follows:
.nf
.na
.ta \w'volume current capacity:'u+1nR +2n

	type:	NSR device;
	name:	/dev/nrst8;
	message:	writing, done
	volume name:	mars.017;
	media family:	tape;
	media type:	8mm 5GB;
	enabled:	Yes;
	shared devices:	done;
	dedicated storage node:	No;
	write enabled:	Yes;
	read only:	No;
	target sessions:	4;
	volume label:	mars.017;
	volume default capacity:	;
	volume current capacity:	5000 MB;
	volume expiration:	"Thu Sep 21 17:23:37 1996";
	volume pool:	Default;
	volume flags:	;
	volume operation:	;
	volume write time:	;
	volume block size:	32 KB;
	volume id:	32449;
	accesses:	199;
	access weight:	1;
	consecutive errors:	0;
	max consecutive errors:	20;
	operation arg:	;
	volume message:	;
	NSR operation:	;
	minor mode:	idle;
	jukebox device:	Yes;
	statistics:	elapsed = 257572, errors = 0, last rate = 397,
		max clients = 3, file marks = 22, rewinds = 4,
		files skipped = 1976, records skipped = 0,
		current file = 2389, current record = 162,
		seek files = 0, seek records = 0,
		estimated kb = 0, amount kb = 6273,
		file amount kb = 6273, sessions = 1;
	cleaning required:	No;
	cleaning interval:	2 weeks;
	date last cleaned:	"Tue Apr 11 15:10:32 1995";
	auto media management:	No;
	unlabeled volume loaded:	No;
	logical name:	;
	logical type:	;
	logical family:	;
	connection process id:	;
	connection message:	;
	connection status:	;
	hardware id:	;
	save mount timeout:	30;
	save lockout:		0;
	CDI:	SCSI commands;
	device block size: handler default;
	device default capacity: 20GB;
	device eject time:;
	device file size:;
	device load time: 120;
	device min load tries:;
	device poll interval:;
	device tape flags:;
	TapeAlert Critical:	Media, Cleaning;
	TapeAlert Information:	Read warning;
	TapeAlert Warning:	Cleaning media;

.ta
\fR\s0
.fi
.SH FILES
.I /nsr/res/nsrdb
\- files in this directory should never be edited directly. Use
.BR nsrmm (8),
.BR nsradmin (8),
or
.B Sun StorEdge EBS Management Console
instead.
.SH SEE ALSO
.na
.BR nsr_getdate (3),
.BR ctime (3),
.BR nsr_resource (5),
.BR nsr_pool (5),
.BR nsr_schedule (5),
.BR nsr_service (5),
.BR nsr_storage_node (5),
.BR nsr (8),
.BR nsrmmd (8),
.BR nsrmm (8),
.BR nsradmin (8),
.ad