Chat now with support
Chat with Support

NetVault Plug-in for Oracle 11.3 - User Guide

Introducing Quest® 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

More parameters: the "format" clause

The “format” clause specifies the pattern to use in creating a filename for the backup pieces or image copies that it creates. The plug-in provides additional parameters that can be used as variables along with the “format” clause. These variables let you specify three parameters for a backup job:

The “format” clause is used within a run block and is specified immediately after the “backup” command in the syntax. Use of the additional colon before the “%d_%u_%p_%c” variable is required; use of the “%d_%u_%p_%c” variable is critical because Oracle® usually generates a unique string that you can use to identify the separate backup segments in the NetVault Backup Media Manager.

format '<Variable_1>:<Variable_2>:<Variable_3>::%d_%u_%p_%c'

Specific variables are included with this clause, each following a designated sequence, for example, “<Variable_1>”, “<Variable_2>”, and “<Variable_3>”. Each corresponds to specific NetVault Backup and RMAN values, and all are outlined in the following table. Ensure that each variable in the command is separated by a colon (“:”) and that a second colon is inserted before the “%d_%u_%p_%c” variable.

Table 2. Variables

<Variable_1>

NetVault Backup Server Name: The NetVault Backup Machine Name of the NetVault Backup Server from which you run the backup job. This value is required.

<Variable_2>

Target Set Name: To target a specific device during backup, specify a Target Set created for use with Oracle® RMAN backups. Leave this option blank if you want to use NetVault Backup’s default setting of “Any Device.” This option overrides the Target Set specified on the Configure dialog box. For more information on Target Sets, see the discussion of Selection Sets in the Quest NetVault Backup Administrator’s Guide.

<Variable_3>

Advanced Options Set Name: Specify an Advanced Options Set created for use with Oracle RMAN backups. Leave this option blank if you want to use NetVault Backup’s default Advanced Options settings. This option overrides the Advanced Options Set specified on the Configure dialog box.

When defining the CLI Backup Advanced Options Set, the Discard After Days/Weeks/Years option must be specified instead of Discard After Full Backups in the Backup Life section of the Advanced Options tab. CLI-based RMAN backups do not support backup-life generation for Full Backups, and backups might expire unexpectedly if the Discard After Full Backups option is specified. For more information on Advanced Option Sets, see the discussion of Selection Sets in the Quest NetVault Backup Administrator’s Guide.

“%d_%u_%p_%c”

These values pertain to unique RMAN identifiers; that is, they are Oracle environmental variables. Oracle uses this variable to generate a unique string that can be used to identify the separate backup segments in the NetVault Backup Media Manager.

%d: Specifies the name of the database.
%u: Specifies an eight-character name made up of a compressed representation of the backup set or image copy number and the time the set or copy was created.
%p: Specifies the piece number within the backup set.
%c: Specifies the copy number of the backup piece within a set of duplicated backup pieces.
NOTE: As an alternative, you can use “%d_%s_%t” or another combination of keywords that generates a unique identifier. For substitution variables that you can use with the formatSpec subclause, see your Oracle documentation.

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

Use the parameters described in this topic 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 topic 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>';
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.
“PARMS” clause: The parameters specified with the “PARMS” clause are applied to all the jobs run from the Oracle® Instance.
PARMS="ENV=(<Variable>=<Value>)"
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.

The following table describes the variables available for use with the “send” and “PARMS” clauses:

Table 3. Variables

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.

NOTE: Use of the NETVAULTCLIPASSWORD variable is a security risk. As an alternative, Quest 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.

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.

For more information on Advanced Option Sets, see the discussion of Selection Sets in the Quest NetVault Backup Administrator’s Guide.

Use this variable to label and use any blank media automatically when no other media is available for the job. The permissible values are:

Use this variable to control how long a backup exists on its target media. The permissible values are:

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.

Use this variable with the “PARMS” clause to establish the default NetVault Backup Server for an entire Oracle Instance.

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.

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.

Use this variable to assign a title to the job. Quest 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.

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.

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:

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.

PARMS="ENV=(NV_ORIGINAL_NV_CLIENT= <nv_client_machine_name>)"

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.

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.

Use this variable to reset the Oracle environment after the “PARMS” clause has been used in the run block.

Use this variable to set a specific media as reusable. The permissible values are:

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.

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, 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>';
Using “PARMS”: The specified parameters apply to all jobs run from the Oracle Instance.

PARMS="ENV=(<Variable>=<Value>)

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.

For more information on Schedule Sets, see the Quest NetVault Backup Administrator’s Guide.

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.

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.

For more information on Target Sets, see the discussion of Selection Sets in the Quest NetVault Backup Administrator’s Guide.

Use this variable to verify completion of a backup job. The permissible values are:

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.”

After the “PARMS” clause has been used, use either of the following lines of syntax to reset the RMAN environment:

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.

SQL*Plus uses the following format to display the media information:

The tape_barcode is shown in parentheses.
If there is no tape_media_label, the media label defaults to “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 Job 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.
Related Documents