Chat now with support
Chat with Support

NetVault Plug-in for Oracle 10.0.5 - User Guide

Introducing Dell™ NetVault™ Backup Plug-in for Oracle® Defining a backup strategy Installing and removing the plug-in Configuring the plug-in Backing up data Using the Oracle® Flashback Database Restoring data
Restoring and recovering data: an overview Performing User Managed restores Using advanced User Managed restore procedures Performing RMAN restores Using RMAN types of recovery in a non-RAC environment Using advanced procedures with RMAN restores
Maintaining the Recovery Catalog Using the RMAN CLI Using the Plug-in with Oracle® RAC Using the Plug-in in a failover cluster environment Using the plug-in with Oracle® Data Guard Troubleshooting Glossary

More parameters: the "send" and "PARMS" clauses

Use the parameters described in this section with either the “send” or the “PARMS” command to set up the NetVault Backup options for a backup job run from the command line. This section describes how the “send” and the “PARMS” clauses work.
•
“send” clause: The parameters specified with the “send” clause are applied to a specific job.
send '<Variable>=<Value>';
The following shows an example:
run { allocate channel ch1 type 'SBT_TAPE'
send 'NV_TARGET_MEDIA=Mid' }
run { allocate channel ch2 }
In this example, the “NV_TARGET_MEDIA” command affects only the “SBT_TAPE” Channel “ch1”.
The “send” clause is used within a run block and is specified immediately after the “allocate” command in the syntax.
run {
allocate channel c1 type 'SET_TAPE';
send 'NV_VERIFICATION=TRUE';
backup
tablespace USERS;
release channel c1;
•
“PARMS” clause: The parameters specified with the “PARMS” clause are applied to all the jobs run from the Oracle® Instance.
PARMS="ENV=(<Variable>=<Value>)"
The following shows an example:
run { allocate channel ch1 type 'SBT_TAPE' PARMS="ENV=(NV_TARGET_MEDIA=Mid)" }
run { allocate channel ch2 }
In this example, the “NV_TARGET_MEDIA” command affects the “SBT_TAPE” Channel “ch1” and any other channels set in the other run blocks.
The “PARMS” clause is used within a run block and is specified immediately after the “allocate” command in the syntax.
run {
allocate channel c1 type 'SBT_TAPE'
PARMS="ENV=(NV_VERIFICATION=TRUE)";
backup
tablespace USERS;
release channel c1;
Variables available with “send” and “PARMS”
The following table describes the variables available for use with the “send” and “PARMS” clauses:
 
Table 3. Variables
Variable
Description
NETVAULTCLIACCOUNT
NETVAULTCLIPASSWORD
Use these variables to set the NetVault Backup user and password that performs the backup or restore. These variables must be set when a password has been defined for the default NetVault Backup user or a non-default user performs the backup or restore.
Example:
send 'NETVAULTCLIACCOUNT=default';
send 'NETVAULTCLIPASSWORD=<password>';
PARMS="ENV=(NETVAULTCLIACCOUNT=default, NETVAULTCLIPASSWORD=<password>)";
NOTE: Use of the NETVAULTCLIPASSWORD variable is a security risk. As an alternative, Dell recommends using the nvpluginaccess utility described in Running the NetVault Backup ‘nvpluginaccess’ utility. If the NETVAULTCLIPASSWORD variable is implemented, it displays the NetVault Backup password in plain text.
NV_ADVANCED_OPTIONS_SET
Use this variable to specify a template for an Advanced Options Set created for use with Oracle® RMAN CLI backups to target a specific set of NetVault Backup Advanced Options during backup. This parameter overrides the Advanced Options Set that you specified on the Configure dialog box.
Example:
send 'NV_ADVANCED_OPTIONS_SET= my_advanced_options_set_name';
PARMS="ENV=(NV_ADVANCED_OPTIONS_SET=my_advanced_options_set_name)";
For more information on Advanced Option Sets, see the discussion of Selection Sets in the Dell NetVault Backup Administrator’s Guide.
NOTE: Due to ambiguity resolution, NetVault Backup does not support specifying a template of an Advanced Options Set while simultaneously specifying individual Advanced Options (for example, NV_VERIFICATION). If this step is attempted from the RMAN CLI prompt, the backup job might fail and the error message might indicate what occurred.
NV_AUTO_LABEL_MEDIA
Use this variable to label and use any blank media automatically when no other media is available for the job. The permissible values are:
•
True
•
False
Example:
send 'NV_AUTO_LABEL_MEDIA=TRUE';
PARMS="ENV= (NV_AUTO_LABEL_MEDIA=TRUE)";
NV_BACKUP_LIFE
Use this variable to control how long a backup exists on its target media. The permissible values are:
•
count {full | days | weeks | years}
The parameters within curly braces are optional. Count followed by full determines the number of generations that the backup is kept. This parameter is the default (that is, if nothing is specified with count, the number of backup generations is considered for the backup life). Days, weeks, or years represents the number of days, weeks, or years that the backup is kept before it is discarded.
Example:
send 'NV_BACKUP_LIFE=2';
PARMS="ENV=(NV_BACKUP_LIFE=2)";
NV_BACKUP_SERVER
Use this variable with the “PARMS” clause to establish the default NetVault Backup Server for an entire Oracle Instance.
Example:
PARMS="ENV=(NV_BACKUP_SERVER=NVSERVER)"
NV_GROUP_LABEL
Use this variable to select a specific group of media based on its group label. This variable must be used with the “NV_TARGET_MEDIA” variable; otherwise, it has no effect.
Example:
send 'NV_TARGET_MEDIA=Group Label, NV_GROUP_LABEL=Group_2';
PARMS="ENV=(NV_TARGET_MEDIA=Group Label,NV_GROUP_LABEL=Group_2)";
NV_JOB_PRIORITY
Use this variable to set the NetVault Backup Job Priority for the CLI task. The value input can range from 1 (highest priority) to 100 (lowest priority). If this parameter is not specified, the default job priority is 30.
Example:
send 'NV_JOB_PRIORITY=5';
PARMS="ENV=(NV_JOB_PRIORITY=5)";
NV_JOB_TITLE
Use this variable to assign a title to the job. Dell recommends that only use this variable with the “send” command on a per job basis (that is, to avoid the chance of all future jobs being labeled with this Job Title, when applied with the “PARMS” clause).
Example:
send 'NV_JOB_TITLE=Backup_1';
NV_MID_LABEL
Use this variable to select a specific piece of media based on its media label. This variable must be used with the “NV_TARGET_MEDIA” variable; otherwise, it has no effect.
Example:
send 'NV_TARGET_MEDIA=Mid, NV_MID_LABEL=Media_1';
PARMS="ENV=(NV_TARGET_MEDIA=Mid, NV_MID_LABEL=Media_1)"
NV_NETWORK_COMPRESSION
Use this variable to compress backup data before it is transferred over the network (that is, in the same manner as the Advanced Options tab’s “Network Compression” option). The permissible values are:
•
True
•
False
Example:
send 'NV_NETWORK_COMPRESSION=True';
PARMS="ENV=(NV_NETWORK_COMPRESSION=False)";
NV_ORIGINAL_NV_CLIENT
Use this variable with the “PARMS” clause to establish the machine name of the original NetVault Backup Client Machine Name where the backup was performed.
Example:
PARMS="ENV=(NV_ORIGINAL_NV_CLIENT= <nv_client_machine_name>)"
NV_POSTSCRIPT
Use this variable to run a script after completion of a backup job. The script to run must be saved in the “…\netvault\scripts” subdirectory on the Oracle Database Server (where “…” refers to the complete path to the installation of NetVault Backup).
Example:
send 'NV_POSTSCRIPT=C:\NetVault\scripts\p2.txt';
PARMS="ENV=(NV_POSTSCRIPT=p2.txt)";
NV_PRESCRIPT
Use this variable to run a script before a backup job. The script to run must be saved in the “…\netvault\scripts” subdirectory on the Oracle Database Server (where “…” refers to the complete path to the installation of NetVault Backup).
Example:
send 'NV_PRESCRIPT=C:\NetVault\scripts\p1.txt';
PARMS="ENV=(NV_PRESCRIPT=p1.txt)";
NV_RESET_ENV_PARMS
Use this variable to reset the Oracle environment after the “PARMS” clause has been used in the run block.
Example:
send 'NV_RESET_ENV_PARMS=TRUE'
PARMS="ENV=(NV_RESET_ENV_PARMS=TRUE)"
NV_REUSE_MEDIA
Use this variable to set a specific media as reusable. The permissible values are:
•
Never
•
Any
•
With same group label as target media
If the value is set as Never, no media marked for reuse is used for the backup. With the parameter set as Any, any media previously marked for reuse is considered for the backup. If the value is set as With same group label as the target media, any media containing the specified group label that has been previously marked for reuse is considered for the backup.
Example:
send 'NV_REUSE_MEDIA=Any';
PARMS="ENV=(NV_REUSE_MEDIA=Any)";
NV_RESTORE_SOURCE_SET
Use this variable to specify a Restore Device Source Set created for use with Oracle RMAN CLI restores. This variable lets you target a specific NetVault Backup set of devices and device options during a restore. Do not use this option if you want to use the default NetVault Backup setting of Any Device.
NOTE: To use this variable, you must specify a Restore Device Source Set that was created from the Restore Source option on the Restore Options tab. Do not use NetVault Backup Backup Target Sets. A NetVault Backup Backup Target Set is used to specify target devices during a backup. A NetVault Backup Restore Source Set is used to specify a set of source devices and devices options during a restore.
Set this variable through the “send” or “PARMS” clause in the RMAN CLI.
•
Using “send”: The specified parameters apply only to a specific job.

send '<Variable>=<Value>';
Example:
run {
allocate channel ch1 type 'sbt_tape';
send 'NV_RESTORE_SOURCE_SET=
my_device_options_source_set_name';
restore tablespace 'TEST1';
}
•
Using “PARMS”: The specified parameters apply to all jobs run from the Oracle Instance.

PARMS="ENV=(<Variable>=<Value>)
Example:
run {
allocate channel ch1 type 'sbt_tape'
PARMS="ENV=(NV_RESTORE_SOURCE_SET=
my_device_options_source_set_name)";
restore tablespace 'TEST1';
}
NV_SCHEDULE_SET
Use this variable to specify a Schedule Set created for use with Oracle RMAN CLI backups to specify or reuse a pre-existing schedule set during backup.
Example:
send 'NV_SCHEDULE_SET=my_schedule_set';
PARMS="ENV=(NV_SCHEDULE_SET=my_schedule_set)";
For more information on Schedule Sets, see the Dell NetVault Backup Administrator’s Guide.
NV_TARGET_MEDIA
Use this variable to set the media in the targeted device. The permissible values are:
•
Any not in a group: To target any media that does not have a Group Label assigned to it.
•
Any: To target any available media.
•
MID: To target a specific piece of media based on its media label (in which case the NV_MID_LABEL variable has to accompany this variable, and the applicable piece of media must be named).
•
Group Label: To target the media within a specific group based on its Group Label (in which case the NV_GROUP_LABEL variable has to accompany this variable, and the applicable Group Label must be named).
Example:
send 'NV_TARGET_MEDIA=Any';
PARMS="ENV=(NV_TARGET_MEDIA=Mid, NV_MID_LABEL=Media_1)";
NV_TARGET_SET
Use this variable to specify a Target Set created for use with Oracle RMAN CLI backups to target a specific NetVault Backup device during backup. (Ignore this option if you want to use the NetVault Backup default setting of “Any Device.”) This parameter overrides the Target Set specified on the Configure dialog box.
Example:
send 'NV_TARGET_SET=my_target_set_name';
PARMS='ENV=(NV_TARGET_SET=my_target_set_name)";
For more information on Target Sets, see the discussion of Selection Sets in the Dell NetVault Backup Administrator’s Guide.
NV_VERIFICATION
Use this variable to verify completion of a backup job. The permissible values are:
•
True
•
False
If set to True, the data transfer is checked and a job message is added to the NetVault Backup Job log stating “Backup job has verified successfully.”
Example:
send 'NV_VERIFICATION=TRUE';
PARMS="ENV=(NV_VERIFICATION=TRUE)";
Resetting the RMAN environment
After the “PARMS” clause has been used, use either of the following lines of syntax to reset the RMAN environment:
send 'NV_RESET_ENV_PARMS=TRUE'
PARMS="ENV=(NV_RESET_ENV_PARMS=TRUE)"
 
* 
IMPORTANT: Close any terminal session or window in which you have set the NETVAULTCLIACCOUNT and NETVAULTCLIPASSWORD variables.

Querying the NetVault Backup media name

For RMAN CLI backups performed through the plug-in, you can use SQL*Plus to determine the physical media on which the RMAN backup pieces are stored. The following example shows how to query the media information using Oracle® SQL*Plus.
Example
SQL> select handle, media from v$backup_piece;
HANDLE
-----------------------------------------------------------------
MEDIA
-----------------------------------------------------------------
NVBU_Server:#642:NVBU_Server:1_692655825:RMAN INCRMTAL LVL 0 SALESDB_1248060220 MMS NetVault Backup Tape
NVBU_Server:#642:NVBU_Server:2_692655843:RMAN INCRMTAL LVL 0 SALESDB_1248060220 MMS NetVault Backup Tape
NVBU_Server:#642:NVBU_Server:3_692655935:RMAN INCRMTAL LVL 0 SALESDB_1248060220 MMS NetVault Backup Tape
SQL*Plus uses the following format to display the media information:
•
If the media has a barcode identified by NetVault Backup, the format is:
(tape_barcode) tape_media_label
Sample Output from RMAN CLI
SQL> select handle, media from v$backup_piece;
[…]
HANDLE
----------------------------------
MEDIA
----------------------------------
oml4dtid_1_1
(05A999L3) medialabel
•
If the media does not have a bar code identified by NetVault Backup, the format is:
tape_media_label
Sample Output from RMAN CLI
SQL> select handle, media from v$backup_piece;
[…]
HANDLE
-----------------------------------------------------
MEDIA
-----------------------------------------------------
okl4dri2_1_1
(NONE) medialabel
Note the following traits regarding the string shown in the media field:
•
The tape_barcode is shown in parentheses.
•
If there is no tape_media_label, the media label defaults to “MMS NetVault Backup Tape”.
•
If a backup piece spans multiple tapes, only the information from one tape is presented.
•
The string is truncated to 60 bytes (60 characters in English). Barcodes are usually 6 bytes or 8 bytes, but the media label can be of variable length. By keeping the media label to a reasonable length, you can ensure that the entire string is shown.
•
If you perform RMAN backups from the NetVault Backup WebUI, the format is:
MMS NetVault Backup Tape
Sample output:
SQL> select handle, media from v$backup_piece;
[…]
HANDLE
-----------------------------------------------------
MEDIA
-----------------------------------------------------
NVSERVER:#376:NVCLIENT:792_709294286:RMAN INCRMTAL LVL 0 ORCL_1264468284
MMS NetVault Backup Tape

Performing CLI-based restores

This form of restore is performed using the RMAN CLI Utility. Through this utility, you can perform restores of backups, regardless of how they were created (that is, either through the plug-in or from the command line). For more information on the RMAN commands, see the Oracle® Database Backup and Recovery Reference Guide.
 
* 
IMPORTANT: Although this form of restore is initiated locally from a terminal session on the Oracle Database Server, you can monitor job progress from the Jobs Status page in the NetVault Backup WebUI. However, this option applies only to data restores from the media contained in devices controlled by the NetVault Backup Server.

Using the Plug-in with Oracle® RAC

•
Oracle RACs: an overview
•
Recommended additional reading
•
Defining a deployment strategy
•
Licensing
•
Installing the plug-in in a RAC environment
•
Configuring the plug-in
•
Backing up data
•
Restoring data in a RAC environment
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating