Content-type: text/html Man page of NSR_NOTIFICATION

NSR_NOTIFICATION

Section: File Formats (5)
Updated: Dec 11, 08
Index Return to Main Contents

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 nsr_resource(5) for more information on NetWorker resources. To edit the NSR notification resources type:

: nsradmin -c "type:NSR notification"

or use NetWorker Management Console. See nsradmin(8) for more information on using the NetWorker administration program.

ATTRIBUTES

The following attributes are defined for resource type NSR notification. 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). 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 (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 values are: Media for events related to the media multiplexor subsystem, Savegroup for events generated by the savegrp(8) command (usually the nightly automatic backups), Index for events related to the on-line file index subsystem, Registration for events caused by changes in the product's registration status (for example, a license that will soon time out), and Server for other NetWorker server events, such as restarting.
Example: event: Media;
name (create-only, static): 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 triggered.
More than one priority may be selected. The valid values 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 perform 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;
mail home (read-only, hidden): This attribute indicates whether a notification resource is associated
with the mail home feature.
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.
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.
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.
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.

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 NetWorker Management Console instead.

This document was created by man2html, using the manual pages.
Time: 02:39:47 GMT, October 02, 2010