


NSR_CLIENT(5)                                       NSR_CLIENT(5)


NNAAMMEE
       nsr_client - NetWorker resource type ``NSR client''

SSYYNNOOPPSSIISS
       ttyyppee:: NNSSRR cclliieenntt

DDEESSCCRRIIPPTTIIOONN
       Each  NSR client is described by a single resource of type
       NNSSRR cclliieenntt (see nnssrr__rreessoouurrccee(5)).  To edit the NSR  client
       resources for a NetWorker server type:

              nsradmin -c "type:NSR client"

       See  the  nnssrraaddmmiinn(8)  manual page for more information on
       using the NetWorker administration  program.   The  client
       resource  may also be edited using the command nnwwaaddmmiinn(8).

       For each NetWorker client, this resource  describes  which
       files  should  be  saved,  the schedule used to save these
       files, which directive should be used to omit  files  from
       the save, how long the files' index entries should be kept
       in the on-line file index and the media index, and who  is
       allowed  to  back  up,  browse,  and recover this client's
       files.  A client may have more than one resource  describ-
       ing it.

AATTTTRRIIBBUUTTEESS
       The following attributes are defined for resource type NNSSRR
       cclliieenntt.  The information in parentheses describes how  the
       attribute  values  are accessed.  RReeaadd--oonnllyy indicates that
       the  value  cannot  be  changed   by   an   administrator.
       RReeaadd//wwrriittee  means  the  value  can be set as well as read.
       HHiiddddeenn means it is an attribute of interest only  to  pro-
       grams  or  experts,  and these attributes can only be seen
       when the hidden option is turned on in nnssrraaddmmiinn(8)  or  by
       selecting  the  details  Menu  Item in the View Menu for a
       particular window in nnwwaaddmmiinn(8).  DDyynnaammiicc attributes  have
       values which change rapidly.  EEnnccrryypptteedd attributes contain
       data that is not displayed  in  its  original  form.   The
       assumption  is  that  the  data is sensitive in nature and
       needs to be protected from accidental disclosure.  Several
       additional  attributes  (e.g. administrator) are common to
       all resources, and are described in nnssrr__rreessoouurrccee(5).

       nnaammee           (read-only, single string)
              This attribute specifies the hostname of this  Net-
              Worker client.
              _E_x_a_m_p_l_e_: name: venus;

       sseerrvveerr              (constant, single string)
              This  attribute  specifies  the  hostname  of  this
              client`s NetWorker server.  The  server`s  hostname
              will be used as the default value.
              _E_x_a_m_p_l_e_: server: jupiter;



NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        1





NSR_CLIENT(5)                                       NSR_CLIENT(5)


       aarrcchhiivvee sseerrvviicceess    (read/write, choice)
              This  attribute  determines  if this system can use
              archive services.  This attribute can only  be  set
              if  archive support has been enabled on the server.
              The choices  are  enabled  or  disabled.   _E_x_a_m_p_l_e_:
              archive services: enabled;

       sscchheedduullee       (read/write, choice)
              This  attribute  specifies the name of the schedule
              controlling the backup levels  for  the  save  sets
              listed  in  the  `save set' attribute.  The default
              value is `Default'.  Any currently defined schedule
              names may be used, see nnssrr__sscchheedduullee(5).
              _E_x_a_m_p_l_e_: schedule: Default;

       bbrroowwssee ppoolliiccyy       (read/write, choice)
              This  attribute  specifies  the  name of the policy
              controlling how long entries will  remain  in  this
              client's  on-line file index.  The default value is
              `Month'.  Any currently defined policy name may  be
              used as long as the period defined by the policy is
              not longer than the retention policy's period,  see
              nnssrr__ppoolliiccyy(5).
              _E_x_a_m_p_l_e_: browse policy: Month;

       rreetteennttiioonn ppoolliiccyy         (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 `Year'.  Any currently defined
              policy  name  may  be  used  as  long as the period
              defined by the  policy  is  not  shorter  than  the
              browse policy's period, see nnssrr__ppoolliiccyy(5).
              _E_x_a_m_p_l_e_: retention policy: Year;

       ddiirreeccttiivvee      (read/write, choice)
              This  attribute specifies the directive to use when
              backing up the client.  The default value is  NULL.
              The  valid  choices  for the directive resource are
              names of  the  currently  defined  `NSR  directive'
              resources, see nnssrr__ddiirreeccttiivvee(5).
              _E_x_a_m_p_l_e_:  directive:  Unix  with compression direc-
              tives;

       ggrroouupp               (read/write, choice list)
              This attribute specifies the group this client is a
              member  of.   The group controls the start time for
              automatic backups.  The value may be  one  of  cur-
              rently   defined   `NSR   group'   resources,   see
              nnssrr__ggrroouupp(5).  The default value is `Default'.
              _E_x_a_m_p_l_e_: group: Default;

       ssaavvee sseett            (read/write, list)
              The _s_a_v_e _s_e_t attribute lists the path names  to  be



NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        2





NSR_CLIENT(5)                                       NSR_CLIENT(5)


              saved  for  this client.  The names should be sepa-
              rated by comma space (, ).  The  default  value  is
              `All'.   On  Unix  clients,  `All'  refers  to  the
              mounted file systems.  On DOS clients, `All' refers
              to  file  systems  that  have been specified on the
              client via the `Change Automatic Backup'  selection
              of the _N_e_t_W_o_r_k_e_r _f_o_r _D_O_S_.  By default, all of a DOS
              client's hard disks are backed up.

              When a client needs to have different file  systems
              saved  on different schedules, a client resource is
              needed for each set of file systems on a particular
              schedule.   For  all  the client resources with the
              same name in a group, a given path  name  may  only
              appear once.  When a client resource lists the save
              set `All', it must be the only client resource with
              it's name belonging to it's group.
              _E_x_a_m_p_l_e_: save set: /, /usr, /usr/src;

       pprriioorriittyy            (hidden, read/write, choice)
              This attribute controls the backup priority of this
              client.  Priority 1 is the  highest,  1000  is  the
              lowest.   Automated  savegrp's will attempt to back
              up clients with higher  priorities  before  clients
              with  lower  priorities.   Note that this is a hint
              only.  The ssaavveeggrrpp command has many  parameters  to
              consider,  and  may  choose a lower priority client
              while trying to balance the load.
              _E_x_a_m_p_l_e_: priority: 500;

       rreemmoottee aacccceessss       (read/write, string list)
              This attribute controls who may  back  up,  browse,
              and  recover  a  client's  files.   By default this
              attribute is an empty list,  signifying  that  only
              users on the client are allowed to back up, browse,
              and recover it's files.  Additional  users,  hosts,
              and  netgroups  may be granted permission to access
              this client's files by adding their names  to  this
              attribute.   Netgroup  names must be preceded by an
              ampersand ('&').  Input of the  form  <user>@<host>
              or  <host>/<user>,  grants  access  to the client's
              files to the specified users.   The  <user>  and/or
              <host>  may be a wild card, "*".  If a user name is
              a wild card, it means all users  at  the  host  are
              granted  access the the client's data.  When a host
              name is a wild card, that  user  on  all  hosts  is
              granted  access to the client's data.  All users on
              a host may also be granted access to  the  client's
              data  by  just listing the host's name, i.e. <host>
              is equivalent to  *@<host>  or  <host>/*.   A  plus
              sign, ``+'', grants access to the client's files to
              all users on any host whose root user is trusted by
              the server's remote command system.  Note that this
              attribute   does   not   override    file    system



NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        3





NSR_CLIENT(5)                                       NSR_CLIENT(5)


              permissions,  the  user  still  needs the necessary
              file system permissions  to  back  up,  browse,  or
              recover  a  file.   The  following  example  grants
              access to the client's data for all users that sat-
              isfy  at least one of the following criteria, <user
              name, user's hostname, server's domain> is a member
              of  the  netgroup "netadmins", the user is from the
              host mars, the user is from the host  jupiter,  the
              user's  name  is sam from host pluto, or the user's
              id is root from any host.
              _E_x_a_m_p_l_e_:   remote   access:    &netadmins,    mars,
              *@jupiter, sam@pluto, */root;

       rreemmoottee uusseerr         (read/write, string)
              This attribute has several uses.  For those clients
              that are accessed  via  the  rrsshh(1)  protocol  (new
              clients  use  nnssrreexxeeccdd(8)  instead), this attribute
              specifies the user login name the NetWorker  server
              will  use  to  authenticate itself with the client.
              The default value is  NULL,  implying  that  `root'
              should  be  used.  When savegrp -p (see ssaavveeggrrpp(8))
              is run on the NetWorker  server,  the  server  runs
              commands  on the client to determine which files to
              save.  Note that when the nnssrreexxeeccdd(8)  protocol  is
              used   to   access  the  client,  the  remote  user
              attribute is not used for authentication.
              Certain clients, such as NetWare  fileservers,  use
              this  attribute  along with the ppaasssswwoorrdd attribute,
              below, to gain access to the files being backed up.
              Other  clients  that back up application data, such
              as Sybase databases, use this attribute along  with
              the  password  to  gain  access  to the application
              data.  There may  be  a  different  value  of  this
              attribute for each resource that describes the same
              client.
              _E_x_a_m_p_l_e_: remote user: operator;

       ppaasssswwoorrdd  (read/write, encrypted)
              The ssaavveeggrrpp command uses this attribute when initi-
              ating  the commands ssaavveeffss and ssaavvee on the client's
              machine.  The commands  ssaavveeffss  and  ssaavvee  use  the
              password  to  gain access to the files being backed
              up.  If a password is given, then the "remote user"
              attribute  for  the  client  resource  must also be
              defined.  There may be a different  value  of  this
              attribute for each resource that describes the same
              client.  This attribute does not need to be set for
              existing  Unix  clients that are not backing up any
              application specific data.

       bbaacckkuupp ccoommmmaanndd      (read/write, string)
              The remote command to run to backup data  for  this
              client  and save sets.  This command can be used to
              perform pre and post backup processing and defaults



NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        4





NSR_CLIENT(5)                                       NSR_CLIENT(5)


              to  the ssaavvee command.  The value must not include a
              path and must  start  with  the  prefix  "save"  or
              "nsr".
              _E_x_a_m_p_l_e_: backup command: savemsg;

       eexxeeccuuttaabbllee ppaatthh          (read/write, string, hidden)
              This  attribute  specifies the path to use when the
              NetWorker  server  is  executing  commands  on  the
              client.  When  no  path  is  specified, the "remote
              user's" $PATH is used.
              _E_x_a_m_p_l_e_: executable path: /etc/nsr;

       sseerrvveerr nneettwwoorrkk iinntteerrffaaccee (read/write, string, hidden)
              The name of the network interface on the server  to
              be used for saves and recovers.
              _E_x_a_m_p_l_e_: server network interface: mars-2;

       aalliiaasseess             (read/write, string list, hidden)
              This  is  a  list  of  aliases  (nicknames) for the
              client machine that queries  can  match.   If  this
              list is empty, match on client name alone.
              _E_x_a_m_p_l_e_: aliases: mars;

       oowwnneerr nnoottiiffiiccaattiioonn  (read/write, hidden)
              A  notification  action  to be executed to send the
              contents of status messages  to  the  owner/primary
              user  of  a  machine  (e.g. savegrp completion mes-
              sages).
              _E_x_a_m_p_l_e_:  owner  notification:   /usr/ucb/mail   -s
              "mars' owner notification" carl@mars;

       ssttaattiissttiiccss          (constant, hidden, dynamic)
              This  attribute  contains three values: the size of
              the client's on-line file index in  kilobytes,  the
              number  of  kilobytes actually used, and the number
              of entries in the index.
              _E_x_a_m_p_l_e_:
              statistics: elapsed = 1761860, index  size  (KB)  =
              776,
                          amount used (KB) = 680, entries = 2216;

       iinnddeexx ssaavvee sseett      (update-only, hidden, dynamic)
              This attribute specifies the client file index save
              set  to  purge  when  the index operation is set to
              purging oldest cycle.
              _E_x_a_m_p_l_e_: index save set: /;

       iinnddeexx ppaatthh          (read/write, hidden)
              This attribute  is  used  to  allow  the  NetWorker
              administrator  to  balance  NetWorker  online  file
              index disk utilization across multiple disk  parti-
              tions.   If  set,  this attribute contains the full
              path  to  the  directory  containing  the  client's
              online file index.  Note that the last component of



NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        5





NSR_CLIENT(5)                                       NSR_CLIENT(5)


              the path must  match  the  _n_a_m_e  attribute  of  the
              client  resource  (see  above).  If left blank, the
              index path defaults to  the  path  /nsr/index/_n_a_m_e,
              where  _n_a_m_e  is  the name attribute from the client
              resource.
              _E_x_a_m_p_l_e_: index path: /disk2/index/venus;

       iinnddeexx mmeessssaaggee       (update-only, hidden, dynamic)
              This attribute contains the ending  status  message
              for  the  previous index operation.  This attribute
              is typically blank, indicating  that  the  previous
              operation completed successfully.
              _E_x_a_m_p_l_e_: index message:;

       iinnddeexx ooppeerraattiioonn ssttaarrtt    (update-only, hidden, dynamic)
              This  attribute  contains  the starting time of the
              current index operation.  This attribute is a  null
              string ("") when the operation is `Idle'.  The for-
              mat is weekday followed by hour and minutes.
              _E_x_a_m_p_l_e_: index operation start: Wednesday 02:45;

       iinnddeexx pprrooggrreessss      (update-only, hidden, dynamic)
              This attribute contains the progress the index  has
              made  towards  finishing  the  current  task.  This
              attribute is blank when the  operation  is  `Idle'.
              The progress is expressed as a percentage.
              _E_x_a_m_p_l_e_: index progress: 45;

       iinnddeexx ooppeerraattiioonn          (update-only, hidden, dynamic)
              This  attribute  contains  the current index opera-
              tion.  It is normally `Idle'.
              _E_x_a_m_p_l_e_: index operation: Reclaiming space;

       ppaarraalllleelliissmm         (read/write, hidden)
              This attribute  specifies  the  maximum  number  of
              saves  that  should be run at the same time for the
              client.
              _E_x_a_m_p_l_e_: parallelism: 2;

       aarrcchhiivvee uusseerrss       (read/write, string list)
              This attribute specifies a list of users  that  are
              allowed  to use the archive services on the client.
              This attribute can only be set if  archive  support
              has  been  enabled  on the server.  If no users are
              listed, only administrators and the local root user
              are  allowed  to  use  the  archive services on the
              client.  A value of '*' implies any user is allowed
              to archive or retrieve data.  The '/' and '@' char-
              acters are not allowed as part of the user name.
              _E_x_a_m_p_l_e_: archive users: paul;

       aapppplliiccaattiioonn iinnffoorrmmaattiioonn       (read/write, hidden, string
       list)
              This    attribute   contains   client   application



NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        6





NSR_CLIENT(5)                                       NSR_CLIENT(5)


              information.
              _E_x_a_m_p_l_e_: application information: ;

       ssttoorraaggee nnooddeess       (read/write, string list)
              This is an ordered list of storage  nodes  for  the
              client  to use when saving its data.  Its saves are
              directed to the first  storage  node  that  has  an
              enabled  device and a functional media daemon, nnssrr--
              mmmmdd(8).  The default value of 'nsrserverhost'  rep-
              resents  the  server.   See nnssrr__ssttoorraaggee__nnooddee(5) for
              additional detail on storage nodes.

       cclloonnee ssttoorraaggee nnooddeess      (read/write, string list)
              This is an ordered list of storage  nodes  for  the
              storage  node to use when its data is being cloned.
              Cloned data originating from the storage node  will
              be  directed  to the first storage node that has an
              enabled device and a functional media daemon,  nnssrr--
              mmmmdd(8).   There  is  no  default  value.   If  this
              attribute has no value, the server's ''cclloonnee ssttoorraaggee
              nnooddeess''  will  be consulted.  If this attribute also
              has no value, then  the  server's  ''ssttoorraaggee  nnooddeess''
              attribute  will be used to select a target node for
              the clone.  See nnssrr__ssttoorraaggee__nnooddee(5) for  additional
              detail on storage nodes.

EEXXAAMMPPLLEESS
       Note:   the hidden attributes are not shown in these exam-
       ples.

       A resource to define a client, called  venus,  backing  up
       all of its files to the NetWorker server mars:


                               type: NSR client;
                               name: venus;
                             server: mars;
                   archive services: Disabled;
                           schedule: Full Every Friday;
                      browse policy: Month;
                   retention policy: Quarter;
                          directive: Unix with compression directives;
                              group: Default;
                           save set: All;
                      remote access: ;
                        remote user: ;
                           password: ;
                     backup command: ;
                            aliases: venus, venus.legato.com;
                      archive users: ;
                      storage nodes: nsrserverhost;
                clone storage nodes: ;

       The  resources  for  a  client  backing  up different file



NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        7





NSR_CLIENT(5)                                       NSR_CLIENT(5)


       systems on different schedules:


                               type: NSR client;
                               name: saturn;
                             server: mars;
                   archive services: Disabled;
                           schedule: Default;
                      browse policy: Month;
                   retention policy: Quarter;
                          directive: ;
                              group: engineering;
                           save set: /,  /usr,  /usr/src;
                      remote access: venus, sam@*, jupiter/john;
                        remote user: operator;
                           password: ;
                     backup command: ;
                            aliases: saturn.legato.com;
                      archive users: ;
                      storage nodes: nsrserverhost;
                clone storage nodes: ;

                               type: NSR client;
                               name: saturn;
                             server: mars;
                   archive services: Disabled;
                           schedule: Full on 1st Friday of Month;
                      browse policy: Month;
                   retention policy: Quarter;
                          directive: Unix standard directives;
                              group: Default;
                           save set: /usr/src/archive;
                      remote access: sam@venus, &netadmins, root@*;
                        remote user: operator;
                           password: ;
                     backup command: ;
                            aliases: saturn.legato.com;
                      archive users: ;
                      storage nodes: nsrserverhost;
                clone storage nodes: ;



SSEEEE AALLSSOO
       rrsshh(1), rruusseerrookk(3), nnssrr(5), nnssrr__sscchheedduullee(5),
       nnssrr__ddiirreeccttiivvee(5), nnssrr__ggrroouupp(5), nnssrr__ppoolliiccyy(5),
       nnssrr__ssttoorraaggee__nnooddee(5), ssaavvee(8), ssaavveeggrrpp(8), ssaavveeffss(8),
       nnssrraaddmmiinn(8), nnssrreexxeeccdd(8), nnwwaaddmmiinn(8).









NetWorker rt_1998_4Q.Build.MMaJrFcehra0l8_,0021000                        8


