Chat now with support
Chat with Support

NetVault 12.2 - Administration Guide

Introduction Getting started Configuring clients Managing catalog search Configuring storage devices Backing up data Managing policies Restoring data Managing NetVault Backup dashboard Managing jobs Monitoring logs Managing storage devices
Monitoring device activity Managing disk-based storage devices in list view Managing disk-based storage devices in tree view Managing the Snapshot Array Manager Managing tape libraries in list view Managing tape libraries in tree view Managing tape drives in list view Managing tape drives in tree view Adding shared devices
Managing storage media Managing user and group accounts Monitoring events and configuring notifications Reporting in NetVault Backup Working with client clusters Configuring default settings for NetVault Backup
About configuring default settings Configuring encryption settings Configuring plug-in options Configuring default settings for post-scripts Configuring default settings for Verify Plug-in Configuring Deployment Manager Settings Configuring Job Manager settings Configuring Logging Daemon settings Configuring Media Manager settings Configuring Network Manager settings Configuring Process Manager settings Configuring RAS device settings Configuring Schedule Manager settings Configuring Web Service settings Configuring Auditor Daemon settings Configuring firewall settings Configuring general settings Configuring security settings Synchronizing NetVault Time Configuring default settings for global notification methods Configuring the reporting utility Configuring NetVault Backup WebUI default settings Configuring NetVault Backup to use a specific VSS provider Configuring default settings using Txtconfig
Diagnostic tracing Managing diagnostic data Using the deviceconfig utility NetVault Backup processes Environment variables Network ports used by NetVault Backup Troubleshooting

Using custom notification methods

This section includes the following topics:

•
About custom notification methods
•
Creating a custom notification method
•
Setting up a custom notification method

About custom notification methods

About custom notification methods

Custom Notification Methods are created using external scripts, and typically used to perform some tasks when an event occurs in the NetVault Backup Domain.

The script file contains header and body. The header specifies the script name and provides a brief description about the script. The script body contains the commands. You can use any text editor to create the script file. The script file should reside in the global subdirectory under the NetVault Backup scripts directory (<NetVault Backup home>\scripts\global on Windows and <NetVault Backup home>/scripts/global on Linux).

Only users with a good knowledge of scripting using NetVault Backup executable files and environmental variables should use this feature.

Creating a custom notification method

To create a custom notification method:
1
Open a new script file in a text editor.
2
Create the script header:
•
Specify the method name on the first line. Enclose the name within the NVNAMESTART and NVNAMEEND tags.
On Linux and UNIX platforms, specify the interpreter name on the first line of the script (for example, #!\bin\sh).
•
To include a description about the script, enclose the text within the NVCOMMENTSTART and NVCOMMENTEND tags. You can use multiple lines of text. Script description is optional.
•
Begin each header line with a REM tag on Windows and the “#” character on Linux and UNIX to mark the line as a comment.
Example (Windows):
REM NVNAMESTART My Custom MethodNVNAMEEND
REM NVCOMMENTSTART Start a new
REM occurrence of this event.
REM NVCOMMENTEND
3
Create the script body and specify the syntax for the commands. You can open the NetVault Backup scripts in the util directory using any text editor to view the proper structure and use them as a template for custom scripts.
To use NetVault Backup scripts residing in the scripts directory, provide the complete path:
•
Windows: %NVHOME%\scripts\<command>
•
Linux and UNIX: $NVHOME/scripts/<command>
Verify that the script has a valid exit status.
4
Save the script:
•
On Windows, assign “.bat” extension to the file and save it in the <NetVault Backup home>\scripts\global directory.
•
On Linux, assign “.sh” extension to the file and save it in the <NetVault Backup home>/scripts/global directory.

Setting up a custom notification method

To set a custom notification method:
1
In the Navigation pane, click Configure Notifications.
2
On the Editing Global Notification Profile page, open the event class, and then open the event type that you want to be notified about.
3
Select the custom notification method.
4
In the Notification Method box, set the environment variables:
•
To specify multiple arguments, you can use a Comma (“,”), Carriage Return (CR), or Line Feed (LF) as a delimiter.
Example: Comma as a delimiter
ARG0=NVTEST.NV_Test_SP_v2, ARG1=1, ARG2=NETVAULT, ARG3=NVRelease, ARG4=1, ARG5=1, ARG6=p_return_msg, ARG7=p_status
Example: CR or LF (that is, a new line) as a delimiter
ARG0=NVTEST.NV_Test_SP_v2
ARG1=1
...
ARG7=p_status
•
To include special characters in the value string, use the Exclamation Mark (“!”) escape character:
•
To specify Comma (“,”) in the value string, enter “!,”
•
To specify Exclamation Mark (“!”) in the value string, enter “!!”
•
To specify Equals (“=”) in the value string, enter “!=”
You cannot use Escape characters in the name string.
5
Click Save to save the global notification profile.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating