NSR_NOTIFICATION(5) Legato NetWorker 4.0 NSR_NOTIFICATION(5)
NAME
NSR notification - NetWorker resource type ``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
system. A NetWorker notification consists of a single event type, a
single priority, and a message. The notification system posts each
message 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 nsrresource(5) for
more information on NetWorker resources. To edit the NSR notifica
tion resources type:
nsradmin -c "type:NSR notification"
or use the networker(8) GUI. See nsradmin(8) 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
values 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(8) or expert mode (-x) in networker(8). For
example, an attribute marked (create-only, static) has a value which
is set when the attribute is created and never changes. Several
additional attributes (e.g. administrator) are common to all
resources, and are described in nsrresource(5).
name (create-only, static)
This attribute holds the name of the notification resource.
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
values are: Media for events related to the media multiplexor
subsystem, Savegroup for events generated by the savegroup(8)
command (usually the nightly automatic backups), Index for
events related to the on-line file index subsystem, Registra
tion for events caused by changes in the product's registra
tion status (e.g. a license that will soon time out), and
Server for other NetWorker server events, such as restarting.
Example: event: Media;
priority (create-only, choice list, hidden)
Each value is a priority at which the notification will be
Licensed material--property of copyright holder(s) 1
NSR_NOTIFICATION(5) Legato NetWorker 4.0 NSR_NOTIFICATION(5)
triggered. More than one priority may be selected. The valid
values in increasing priority order are Info - supplies infor
mation 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 opera
tor to perform a routine task, such as mounting a tape; Criti
cal - the server detected an error condition that should be
fixed by a qualified operator; Alert - a severe error condi
tion that demands immediate attention; Emergency - a condition
that may cause NetWorker to fail unless corrected immediately.
Example: priority: Notice;
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;
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/ucb/mail -s \"savegroup completion\" root;
event: Savegroup;
priority: Notice;
type: NSR notification;
name: log default;
administrator: root;
action: /usr/ucb/logger -p daemon.notice -f -;
event: Media, Savegroup, Index, Server, Registration;
priority: Info, Notice, Warning, Waiting,
Critical, Alert, Emergency;
FILES
/nsr/res/nsr.res - this file should never be edited directly. Use
nsradmin(8) instead.
SEE ALSO
nsrresource(5), nsrservice(5), nsrdevice(5), nsr(8), nsrmm(8),
syslog.conf(5), syslog(3), nsradmin(8), nsrmmd(8).
Licensed material--property of copyright holder(s) 2