.\"
.\" $Id: nsr_pool.5,v 6.14.22.2 2005/11/15 00:50:58 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_POOL 5 "Aug 23, 06" "StorEdge EBS 7.3.2"
.SH NAME
nsr_pool \- Sun StorEdge EBS resource type ``NSR pool''
.SH SYNOPSIS
.B  "type: NSR pool"
.SH DESCRIPTION
Each NSR pool is described by a single resource of type
.BR "NSR pool"
(see
.BR nsr_resource (5)). 
To edit the NSR pool resources for a Sun StorEdge EBS server type:
.br
.RS
\fR\s10nsradmin \-c "type:NSR pool"\fP\s0
.RE
.br
Be careful to include the quotes and the space between ``NSR'' and ``pool''.
See the
.BR nsradmin (8)
manual page for more information on using the Sun StorEdge EBS administration program.
.LP
These resources are used by Sun StorEdge EBS
to determine what volumes save sets should reside on depending upon
the characteristics, for example, Group or Level, of the save.
Consult your 
.I "Sun StorEdge EBS Administrator's Guide"
for more guidelines on using pools.
.LP
There are six types of pools.  
.I Backup
pools accept data from
.B savegrp
and manual backups.  
.I Archive
pools accept archive data.
Data cloned from a backup pool can be directed to a
.I "backup clone"
pool.
Likewise, archive data can be cloned to an
.I "archive clone"
pool. Similiarly,
.I "PC Archive"
pools accept PC archive data. Also, PC archive data can be cloned to a 
.I "PC Archive Clone"
pool.
.LP
There are ten pools shipped pre-enabled with Sun StorEdge EBS.
The
.I Default
pool is meant to collect any backup data not directed to a pool a user creates
with selection criteria.
Any archive data not directed to a pool with selection criteria
is collected in the
.I "Indexed Archive"
pool.
While
.I Archive
pool is the counterpart of
.I "Indexed Archive"
pool that does not store index entries.
When cloning data, the user must select a destination pool for the operation.
The
.I "Default clone"
pool is available for users to clone backup data to.
Both
.I "Indexed Archive clone"
pool and
.I "Archive clone"
pool are available for users to clone archive data to, with
.I "Indexed Archive clone"
pool designed for users to clone indexed archives and
.I "Archive clone"
pool designed for cloning non-indexed archives. The
.I "PC Archive"
pool is designed for the PC archive data, whereas the 
.I "PC Archive Clone"
is available for users to clone PC archive data to. Similarly, the
.I "Migration"
and
.I "Migration Clone"
pools are designed for migration data and cloning of migration data respectively. 
.LP
There are also a few pools shipped with Sun StorEdge EBS
that are not enabled by default.
The
.I Full
and
.I NonFull
pools can be used to segregate full level backups from other backups, for
example, fulls versus incrementals.
The
.I Offsite
pool can be used to generate offsite backups, because no index entries
are stored for the media pool and will not be referenced during
normal recovers.
Note that one can also clone media to
produce copies of data to be taken offsite.
Save sets that are generated without index entries can still be
recovered using the ``Save Set Recover'' feature of
.B nwrecover (8)
or
.BR recover (8).
.SH ATTRIBUTES
.LP
The following attributes are defined for resource type
.BR "NSR pool" .
The information in parentheses describes how the attribute values are accessed.
.B Create-only
indicates that the value cannot be changed after
the resource has been created.
.B Read/write
means the value can be updated by authorized administrators.
.B Yes/no
means only a yes or no choice is possible.
.B Choice 
indicates that the value can only be selected from a given list.
.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).
.TP
.BR "comment" "		(read/write)"
This attribute is provided for the administrator to keep any explanatory
remarks or supplementary information about the pool.
.br
.TP
.BR "archive only" "  (read/write, yes/no, hidden, create)"
If 
.B yes
is selected, only archive saves are allowed to this pool.
.IR "This hidden attribute can be modified by a user."
.br
.I Example:
\fR\s10archive only: no;\fP\s0
.TP
.BR "auto media verify" "	(read/write, yes/no, choice)"
.br
If set to
.BR yes ,
Sun StorEdge EBS verifies data written to volumes from this pool.
Data is verified by re-positioning the volume to read a portion of the data
previously written to the media and comparing the data read to the original
data written.
If the data read matches the data written, verification succeeds; otherwise
it fails.
Media is verified whenever a volume becomes full while saving and it is
necessary to continue onto another volume, or when a volume goes idle because
all save sets being written to the volume are complete.
When a volume fails verification, it is marked full so Sun StorEdge EBS will not
select the volume for future saves.
The volume remains full until it is recycled or a user marks
it not full.
If a volume fails verification while attempting to switch volumes, all
save sets writing to the volume are terminated.
.br
.I Example:
\fR\s10auto media verify: yes;\fP\s0
.TP
.BR "clients" "	(read/write, choice)"
What
.I clients
.RB ( nsr_client (5))
are allowed in this pool.
If a
.I group
is specified, only clients that are members of that group are allowed to
be listed.
.br
.I Example:
\fR\s10clients: mars;\fP\s0
.TP
.BR "devices" "	(read/write, choice)"
.br
This attribute lists the 
.B ONLY
devices that volumes from this pool are allowed to be mounted onto.
If no devices are listed, volumes from this pool may
be mounted on any device.
.br
.I Example:
\fR\s10devices: /dev/nrst8;\fP\s0
.TP
.BR "groups" "	(read/write, choice)"
.br
What
.I groups
.RB ( nsr_group (5))
are allowed in this pool.
.br
.I Example:
\fR\s10groups: Accounting;\fP\s0
.TP
.BR "label template" "	(read/write, choice)"
.br
Determine what 
.I "label template"
.RB ( nsr_label (5))
is referenced when generating volume names for this pool.
.br
.I Example:
\fR\s10label template: Accounting;\fP\s0
.TP
.BR "levels" "	(read/write, choice)"
.br
What
.I levels
.RB ( nsr_schedule (5))
are allowed in this pool.
.br
.I Example:
\fR\s10levels: full;\fP\s0
.TP
.ta \w'store index entries'u+4n
.BR "name" "	(create-only)"
The names of pool resources are used when labeling volumes and when
determining what volumes a save set should reside on.
The name can be chosen at the administrator's convenience,
but it must be unique for this Sun StorEdge EBS server.
The pool resources named
.BR "Default" ,
.BR "Default Clone" ,
.BR "Indexed Archive",
.BR "Indexed Archive Clone",
.BR "Archive" ,
.BR "Archive Clone",
.BR "PC Archive" ,
and
.B "PC Archive Clone"
cannot be modified or deleted.
The pool resource named
.B Full
and
.B NonFull
cannot be deleted.
Other pools can only be deleted if no volumes still reference them.
.br
.I Example:
\fR\s10name: Accounting;\fP\s0
.TP
.BR "recycle from other pools " " (read/write, yes/no, choice)"
.br
This attribute determines whether or not a given pool can recycle volumes from other
pools when it exhausts all its write-able and recyclable volumes.
.br
.I Example:
\fR\s10recycle from other pools: yes;\fP\s0
.TP
.BR "recycle to other pools" " (read/write, yes/no, choice)"
.br
This attribute determines whether or not a given pool allows other pools to  recycle
its recyclable volume for their use. 
.br
.I Example:
\fR\s10recycle to other pools: yes;\fP\s0
.TP
.BR "retention policy" "        (read/write, choice)"
.br
This attribute specifies the name of the policy controlling how
long entries will remain in the media index before they are marked as
recyclable.
The default value is blank meaning there is no pool policy. In the absense
of a pool policy the client policy is used to determine the save set
expiration date. A defined pool policy is always considered if it is a
not the only instance of the save set (a clone). The pool policy is
considered for original save sets but is utilized only if the period
defined by the policy is longer the retention policy's period defined
by the client resource, see
.BR nsr_policy (5).
.br
.I Example:
\fR\s10retention policy: Year;\fP\s0
.TP
.BR "save sets" "	(read/write, choice)"
.br
What save sets
.RB ( nsr_client (5))
are allowed in this pool.
Save sets can be matched using the regular expression matching algorithm
described in
.BR nsr_regexp (5)).
.br
.I Example:
\fR\s10save sets: /, /usr, C:\\\\windows\\\\system, *\.JPG ;\fP\s0
.TP
.BR "status" "	(read/write, hidden, choice)"
.br
If set to
.BR enabled ,
this pool is considered for determining what pools a save set should be
saved to when performing backup volume selection.
If set to
.BR clone ,
this pool is considered only as the destination of cloning operations.
If set to
.BR disabled ,
this pool is completely ignored.
.IR "This hidden attribute can be modified by a user."
.br
.I Example:
\fR\s10status: enabled;\fP\s0
.TP
.BR "store index entries" "  (read/write, yes/no, choice)"
.br
If set to
.BR yes ,
entries are made into the file indexes for the backups.
Otherwise, only media database entries for the save sets are created.
.br
.I Example:
\fR\s10store index entries: yes;\fP\s0
.TP
.BR "volume type preference" "	(read/write, choice)"
.br
This attribute is used as a selection
factor when a request is made for a write-able volume.
The preferred type will be considered first within a priority level
such as
.I "jukebox"
or
.I "stand alone device".
.br
.I Example:
\fR\s10volume type preference: 4mm;\fP\s0
.TP
.BR "max parallelism" " (read/write, hidden)"
.br
This attribute can be used to impose an upper limit for the number
of parallel sessions saving to a media belonging to the pool. Fewer
parallel save session written to media reduces the time
required to recover data from a saveset. Value of zero imposes no
limit on number of parallel save sessions written to media belonging
to this pool.
.br
.TP
.BR "mount class" "	(read/write)"
.br
This attribute is kept for historical reasons only.
It has no affect.
.br
.SH EXAMPLE
.LP
A complete NSR pool resource, named `Default', follows:
.br
.nf
\fR\s10
.ta \w'store index entries:'u+2nR +2n
	type:	NSR pool;
	archive only:	No;
	auto media verify:	Yes;
	clients:	;
	comment:	;
	devices:	;
	enabled:	Yes;
	groups:	;
	label template:	Default;
	levels:	;
	name:	Default;
	pool type: 	Backup;
	save sets:	;
	store index entries:	Yes;
	recycle from other pools:	Yes;
	recycle to other pools:	Yes;
	retention policy:	;
	volume type preference:	4mm;
.ta
\fP\s0
.SH SEE ALSO
.BR nsr (5),
.BR nsr_label (5),
.BR nsr_resource (5),
.BR nsradmin (8),
.BR nwrecover (8),
.BR recover (8),
.BR savegroup (8),
.BR savefs (8),
.BR uasm (8)