.\"
.\" $Id: nsr_notification.5,v 1.2.12.3 2006/04/26 18:52:18 castrv 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_NOTIFICATION 5 "Aug 23, 06" "StorEdge EBS 7.3.2"
.SH NAME
nsr_notification \- Sun StorEdge EBS resource type ``NSR notification''
.SH SYNOPSIS
.B  "type: NSR notification"
.SH DESCRIPTION
A resource of type
.B "NSR notification"
is used for each combination of an event, priority, and action handled 
by the Sun StorEdge EBS notification system.
A Sun StorEdge EBS notification consists of a single event type, a single
priority, and a message.
The notification system posts each message to the action of each
.B "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
.BR nsr_resource (5)
for more information on Sun StorEdge EBS resources.
To edit the NSR notification resources type:
.br 2
.RS
\fR\s10nsradmin \-c "type:NSR notification"\fP\s0
.RE
.br 2
or use
.B Sun StorEdge EBS Management Console.
See
.BR nsradmin (8)
for more information on using the Sun StorEdge EBS administration program.
.SH ATTRIBUTES
.LP
The following attributes are defined for resource type
.BR "NSR notification" .
The information in parentheses describes how the attribute values are accessed.
.B Create-only
indicates that the value cannot be changed by an administrator, except
when the resource is created.
.B Read/write
means the value can be changed at any time by authorized administrators.
.B Choice list
means that any number of values can be chosen from the given list.
.B Single string
means that only a single value is allowed.
.B Static
attributes change values rarely, if ever.
.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).
For example, an attribute marked
.B "(create-only, static)"
has a value which is set when the attribute is created and never changes.
Several additional attributes (for example, administrator) are common
to all resources, and are described in
.BR nsr_resource (5).
.TP
.BR "comment" "		(read/write)"
This attribute is provided for the administrator to keep any explanatory
remarks or supplementary information about the event.
.br
.TP
.BR "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
.BR popen (3s))
with the event information connected to standard
input.  Typical actions are to log the message with the
.BR syslog (3)
package, or send electronic mail to a system operator.
.br
.I Example:
\fR\s10action: /usr/ucb/mail \-s "savegroup completion" root;\fP\s0
.TP
.BR "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:
.B Media
for events related to the media multiplexor subsystem,
.B Savegroup
for events generated by the 
.BR savegrp (8)
command (usually the nightly automatic backups),
.B Index
for events related to the on-line file index subsystem,
.B Registration
for events caused by changes in the product's registration status (for example,
a license that will soon time out),
and
.B Server
for other Sun StorEdge EBS server events, such as restarting.
.br
.I Example:
\fR\s10event: Media;\fP\s0
.TP
.BR "name" "            (create-only, static)"
This attribute holds the name of the notification resource.
.TP
.BR "priority" "	(create-only, choice list, hidden)"
Each value is a priority at which the notification will be triggered.
More than one priority may be selected.
The valid values in increasing priority order are
.B Info
\- supplies information about the current state of the server;
.B Notice
\- an important piece of information;
.B Warning
\- information about a non-fatal error;
.B Waiting
\- the server is waiting for an operator to perform a routine
task, such as mounting a tape;
.B Critical
\- the server detected an error
condition that should be fixed by a qualified operator;
.B Alert
\- a severe error condition that demands immediate attention;
.B Emergency
\- a condition that may cause Sun StorEdge EBS to fail unless corrected immediately.
.br
.I Example:
\fR\s10priority: Notice;\fP\s0
.TP
.BR "mail home" "		(read-only, hidden)"
This attribute indicates whether a notification resource is associated
with mail the home feature.
.br
.TP
.BR "enabled" "		(read/write)"
This attribute indicates whether an email shall be sent to EMC
customer support if the event named in the notification resource occurs.
This attribute applies only to mail home notifications.
.br
.TP
.BR "immediate" "		(read/write)"
This attribute applies only to mail home notifications.
This attribute indicates whether the notification is emailed immediately
or deferred until the day specified by the mail home day attribute.
.br
.TP
.BR "mail home day" "		(read/write, choice list)"
This attribute applies only to mail home notifications.
This attribute indicates the day of the week for sending deferred mail home alerts.
.br
.TP
.BR "pending event info" "		(read-only, hidden)"
This attribute contains mail home event information for which email has not
been sent to EMC. This attribute applies only to mail home notifications.
.br
.TP
.SH EXAMPLE
.LP
A complete example follows with two resources, one for mail and one
using the syslog mechanism:
.nf
.na
.ta \w'administrator:'u+1nR +2n

	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;
.ta
\fR\s0
.fi
.SH FILES
.I /nsr/res/nsrdb
\- files in this directory should never be edited directly. Use
.B Sun StorEdge EBS Management Console
instead.
.SH SEE ALSO
.na
.hy 0
.BR nsr_resource (5),
.BR nsr_service (5),
.BR nsr_device (5),
.BR nsr (8),
.BR nsrmm (8),
.BR syslog.conf (5),
.BR syslog (3),
.BR nsradmin (8),
.BR nsrmmd (8),
.hy 14
.ad