EMC Legato NetWorker Commands Reference

nsr_notification

SYNOPSIS

       type: NSR notification

DESCRIPTION

       A  resource of type NSR notification is used for each combination of an
       event, priority, and action handled by the NetWorker notification  sys-
       tem.   A NetWorker notification consists of a single event type, a sin-
       gle priority, and a message.  The notification system posts  each  mes-
       sage  to the action of each NSR notification resource (by executing the
       command listed in the action, with the message on standard input)  that
       includes  that  event  type and priority.  See nsr_resource(5) for more
       information on NetWorker  resources.   To  edit  the  NSR  notification
       resources type:
              nsradmin -c "type:NSR notification"
       or  use  the  nwadmin(1)  GUI.  See nsradmin(1) for more information on
       using the NetWorker administration program.

ATTRIBUTES

       The following attributes are defined for resource  type  NSR  notifica-
       tion.   The information in parentheses describes how the attribute val-
       ues are accessed.  Create-only  indicates  that  the  value  cannot  be
       changed  by  an  administrator,  except  when  the resource is created.
       Read/write means the value can be changed at  any  time  by  authorized
       administrators.   Choice  list  means  that any number of values can be
       chosen from the given list.  Single string means  that  only  a  single
       value  is  allowed.   Static  attributes change values rarely, if ever.
       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 nsradmin(1) or expert mode  (-x)  in  nwadmin(1).   For
       example, an attribute marked (create-only, static) has a value which is
       set when the attribute is created and  never  changes.   Several  addi-
       tional  attributes  (for  example,  administrator)  are  common  to all
       resources, and are described in nsr_resource(5).

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

       action          (read/write, single string)
              The value is a command line to be executed when the given  event
              occurs.   The command line is run (see popen(3s)) with the event
              information connected to standard input.  Typical actions are to
              log  the  message with the syslog(3) package, or send electronic
              mail to a system operator.
              Example: action: /usr/ucb/mail -s "savegroup completion" root;

       event     (create-only, choice list, hidden)
              Each value is a class of events  that  will  trigger  the  given
              notification.   More than one class may be selected.  Valid val-
              ues are: Media for events related to the media multiplexor  sub-
              system, Savegroup for events generated by the savegrp(1) command
              This attribute holds the name of the notification resource.

       priority  (create-only, choice list, hidden)
              Each value is a priority at which the notification will be trig-
              gered.   More than one priority may be selected.  The valid val-
              ues in increasing priority order are Info - supplies information
              about  the  current  state  of the server; Notice - an important
              piece of information; Warning - information  about  a  non-fatal
              error;  Waiting  - the server is waiting for an operator to per-
              form a routine task, such as mounting a  tape;  Critical  -  the
              server  detected  an  error  condition that should be fixed by a
              qualified operator;  Alert  -  a  severe  error  condition  that
              demands  immediate  attention;  Emergency - a condition that may
              cause NetWorker to fail unless corrected immediately.
              Example: priority: Notice;

EXAMPLE

       A complete example follows with two resources, one  for  mail  and  one
       using the syslog mechanism:

                 type:  NSR notification;
                 name:  savegroup completion;
        administrator:  root;
               action:  /usr/bin/mail -s \"savegroup completion\" root;
                event:  Savegroup;
             priority:  Notice;

                 type:  NSR notification;
                 name:  log default;
        administrator:  root;
               action:  /usr/bin/logger -p daemon.notice -f -;
                event:  Media, Savegroup, Index, Server, Registration;
             priority:  Info, Notice, Warning, Waiting,
                        Critical, Alert, Emergency;

FILES

       /nsr/res/nsrdb - files in this directory should never be edited
       directly. Use nwadmin(1) instead.

SEE ALSO

       nsr_resource(5), nsr_service(5), nsr_device(5), nsr(1), nsrmm(1),
       syslog.conf(5), syslog(3), nsradmin(1), nsrmmd(1), nwadmin(1)

ADVERTISEMENT