NetWorker command:      nsr_pool

NAME

       nsr_pool - NetWorker resource type 'NSR pool'


SYNOPSIS

       type: NSR pool


DESCRIPTION

       Each  NSR  pool is described by a single resource of type NSR pool (see
       nsr_resource(5)).  To edit the  NSR  pool  resources  for  a  NetWorker
       server type:
       
              nsradmin -c "type:NSR pool"
       
       Be  careful  to  include  the  quotes and the space between 'NSR' and
       'pool'.  See the nsradmin(8) manual  page  for  more  information  on
       using the NetWorker administration program.

       These  resources	 are  used by NetWorker to determine what volumes save
       sets should reside on depending upon the characteristics, for  example,
       Group  or  Level,  of  the save.	 Consult your NetWorker Administration
       Guide for more guidelines on using pools.

       There are six types of pools.  Backup pools accept  data	 from  savegrp
       and  manual  backups.   Archive pools accept archive data.  Data cloned
       from a backup pool can be directed to a backup clone  pool.   Likewise,
       archive	data  can  be  cloned to an archive clone pool. Similiarly, PC
       Archive pools accept PC archive data. Also,  PC	archive	 data  can  be
       cloned to a PC Archive Clone pool.

       There  are  ten	pools shipped pre-enabled with NetWorker.  The 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 Indexed Archive	 pool.
       While Archive pool is the counterpart of Indexed Archive pool that does
       not store index entries.	 When cloning data, the	 user  must  select  a
       destination  pool  for the operation.  The Default clone pool is avail-
       able for users to clone backup data to.	 Both  Indexed	Archive	 clone
       pool  and  Archive  clone pool are available for users to clone archive
       data to, with Indexed Archive clone pool designed for  users  to	 clone
       indexed	archives  and  Archive	clone  pool  designed for cloning non-
       indexed archives. The PC Archive pool is designed for  the  PC  archive
       data,  whereas  the PC Archive Clone is available for users to clone PC
       archive data to. Similarly, the Migration and Migration Clone pools are
       designed for migration data and cloning of migration data respectively.

       There are also a few pools shipped with NetWorker that are not  enabled
       by  default.   The Full and NonFull pools can be used to segregate full
       level backups from other backups, for example, fulls  versus  incremen-
       tals.   The  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 gen-
       erated  without	index  entries can still be recovered using the ``Save
       Set Recover' feature of nwadmin(1) or recover(1).


ATTRIBUTES

       The following attributes are defined for resource type NSR  pool.   The
       information  in  parentheses  describes  how  the  attribute values are
       accessed.  Create-only indicates that the value cannot be changed after
       the  resource  has  been  created.   Read/write  means the value can be
       updated by authorized administrators.  Yes/no means only a  yes  or  no
       choice  is  possible.   Choice  indicates  that  the  value can only be
       selected from a given list.  Hidden means it is an attribute of	inter-
       est  only to programs or experts, and these attributes can only be seen
       when the hidden option is turned on in nsradmin(8).

       comment	      (read/write)
	      This attribute is provided for the  administrator	 to  keep  any
	      explanatory remarks or supplementary information about the pool.
       

       archive only  (read/write, yes/no, hidden, create)
              If yes is selected, only archive saves are allowed to this pool.
              This hidden attribute can be modified by a user.
              Example: archive only: no;

       auto media verify   (read/write, yes/no, choice)
              If set to yes, NetWorker 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;  oth-
              erwise  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 verifi-
              cation,  it is marked full so NetWorker will not select the vol-
              ume for future saves.  The volume remains full until it is recy-
              cled  or  a user marks it not full.  If a volume fails verifica-
              tion while attempting to switch volumes, all save  sets  writing
              to the volume are terminated.
              Example: auto media verify: yes;

       clients   (read/write, choice)
              What  clients  (nsr_client(5))  are  allowed in this pool.  If a
              group is specified, only clients that are members of that  group
              are allowed to be listed.
              Example: clients: mars;

       devices   (read/write, choice)
              This  attribute  lists  the  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.
              Example: devices: /dev/nrst8;

       groups    (read/write, choice)
              What groups (nsr_group(5)) are allowed in this pool.
              Example: groups: Accounting;

       label template (read/write, choice)
              Determine  what label template (nsr_label(5)) is referenced when
              generating volume names for this pool.
              Example: label template: Accounting;

       levels    (read/write, choice)
              What levels (nsr_schedule(5)) are allowed in this pool.
              Example: levels: full;

       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 NetWorker server.  The pool resources
              named Default, Default Clone, Indexed Archive,  Indexed Archive
              Clone, Archive, Archive Clone, PC Archive, and PC Archive	 Clone
              cannot be modified or deleted. The pool resource named Full and
              NonFull  cannot  be  deleted. Other  pools  can  only be deleted
              if no volumes still reference them.
              Example: name: Accounting;

       pool type     (create-only)
              This attribute determines how volumes that are members  of  this
              pool will be used.
              Example: pool type: Backup;

       recycle from other pools	 (read/write, yes/no, choice)
              This  attribute determines whether or not a given pool can recy-
              cle volumes from other pools when it exhausts all its write-able
              and recyclable volumes.
              Example: recycle from other pools: yes;

       recycle to other pools (read/write, yes/no, choice)
              This attribute determines whether or not  a  given  pool  allows
              other pools to  recycle its recyclable volume for their use.
              Example: recycle to other pools: yes;
              
       retention policy	       (read/write, choice)
              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  consid-
              ered  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 nsr_policy(5).
              Example: retention policy: Year;

       save sets              (read/write, choice)
              What  save  sets (nsr_client(5)) are allowed in this pool.  Save
              sets can be matched using the regular expression matching  algo-
              rithm described in nsr_regexp(5)).
              Example: save sets: /, /usr, C:\\windows\\system, *.JPG ;

       status                 (read/write, hidden, choice)
              If  set to enabled, this pool is considered for determining what
              pools a save set should be saved to when performing backup  vol-
              ume selection.  If set to clone, this pool is considered only as
              the destination of cloning operations.  If set to disabled, this
              pool  is completely ignored.  This hidden attribute can be modi-
              fied by a user.
              Example: status: enabled;

       store index entries  (read/write, yes/no, choice)
              If set to yes, entries are made into the file  indexes  for  the
              backups.   Otherwise,  only  media database entries for the save
              sets are created.
              Example: store index entries: yes;

       media type required    (read/write, choice)
              If  a required type is specified, it is the only media type that
              can be mounted, labeled or written to in this poool.
              Example: media type required: adv_file;

       volume type preference (read/write, choice)
              This attribute is used as a selection factor when a  request  is
              made  for  a write-able volume.  The preferred type will be con-
              sidered first within a priority level such as jukebox  or  stand
              alone device .
              Example: volume type preference: 4mm;
              
       max parallelism (read/write, hidden)
	      This attribute can be used to impose an upper limit for the num-
	      ber 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.

       mount class            (read/write)
              This attribute is kept for historical reasons only.  It  has  no
              effect.


EXAMPLE

       A complete NSR pool resource, named 'Default', follows:

                        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;


SEE ALSO

       nsr(5),	nsr_label(5),	nsr_resource(5),  nsradmin(8),	 nwrecover(8),
       recover(8), savegroup(8), savefs(8), uasm(8)

NetWorker 7.6.2			 Jul 14, 11			   nsr_pool(5)