NetVault Plug-in for Oracle 13.0

Use Oracle Password File Authentication: Oracle supports two methods to authenticate DBAs or SYSDBA users: OS authentication and password-file authentication. Select this option to enable the password file as the authentication method. Oracle’s OS authentication takes precedence over password-file authentication; that is, if the requirements for OS authentication are met, even if you use a password file, the user is authenticated by OS authentication.

When this option is selected, the plug-in uses the SYSDBA authentication details from the Oracle password file to connect to the Oracle target instance with RMAN:

connect target <SYSDBA User>/<password>@<connect identifier>

When this option is cleared, the plug-in uses OS authentication when connecting to the Oracle target instance:

connect target /

•

Flash Recovery Area Enabled: Select this option when FRA has been enabled for all the databases that reside on the Oracle Database Server where the plug-in has been installed. When this option is selected, Flash Recovery Area Backups and Backup Destination options are available. For more information on available FRA features, see Reviewing the other backup types and Defining a Backup Destination strategy.

•

Oracle SYSDBA User Name: Specify the default Oracle user with SYSDBA privileges that is used by the plug-in to connect to the database.

•

NLS_LANG: Select the character set that matches the National Language Support (NLS) Language or NLS_LANGUAGE parameter for the databases residing on this Oracle Database Server. The NLS_LANGUAGE parameter specifies the default language of the database. This language is used for messages, day and month names, symbols for AD, BC, a.m., and p.m., and the default sorting mechanism.

To determine the current NLS_LANGUAGE parameter for the database, issue the following command from SQL*Plus as a SYSDBA user:

select * from v$NLS_PARAMETERS where PARAMETER = 'NLS_LANGUAGE' or

PARAMETER = 'NLS_TERRITORY' or PARAMETER = 'NLS_CHARACTERSET';

The results are combined in the following format to match the available selections in the list:

<NLS_LANGUAGE>_<NLS_TERRITORY>.<NLS_CHARACTERSET>

For a list of languages that the plug-in supports and their corresponding NLS_LANG value, see Language support.

•

Incomplete backup of ALL items selected: When multiple items are included in a backup, and the plug-in is unable to back up all the items selected even if RMAN has successfully cataloged some of the selected items, the plug-in lets you specify what action the backup should take. For example, if a job includes multiple tablespaces and archived redo logs, and the backup of archive logs is unsuccessful while the tablespaces are backed up successfully, you can specify what action the backup job should take.

Plug‑in for Oracle can do one of the following when this error condition occurs:

•

Complete with Warnings — Saveset Retained: The job returns a status of “Backup Completed with warnings” and a backup saveset is created that includes the items that were successfully backed up.

•

Complete without Warnings — Saveset Retained: The job completes and returns a status of “Backup Completed.” The errors are logged in the NetVault binary logs and ignored on the Job Status page. A backup saveset is created that includes the items that were backed up.

•

Fail — Saveset Retained: The job returns a status of “Backup Failed.” However, a backup saveset is generated that includes the items that were successfully backed up.

•

Fail — No Saveset Retained: The job returns a status of “Backup Failed” and no saveset of backed-up objects is kept. That is, even if some of the objects were successfully backed up, the saveset is discarded.

•

Use Catalog for RMAN Based Backups: Select this option to specify that a Recovery Catalog database is used for maintaining a record of all RMAN backup operations performed with this plug-in.

•

Catalog Instance Name: Enter the Oracle Instance name — which might differ from the Oracle Net Service name — for the default Recovery Catalog database. This instance name must be defined in the “tnsnames.ora” file on the Oracle Database Server so that the plug-in can connect to the Recovery Catalog database.


	NOTE: If you upgraded from a version of the plug-in before 7.0, the Catalog Instance Name field is labeled Catalog Net Service Name.

•

Catalog Owner: Specify the user that was defined as the owner of the Catalog and was granted the RECOVERY_CATALOG_OWNER role.

•

User Managed Raw Devices Blocking Factor (KB): For User Managed backups only, use this field to set the Block Read units for quicker User Managed backups of raw devices. The value can be between 1 kilobyte (KB) and 64KB; for example, if you enter 8 in this field, the plug-in would read 8KB chunks of data at a time while taking backups.

•

NetVault Server (required for RMAN Backups): Specify the name of the NetVault Server where the Oracle Database Server was added as a NetVault Client.

•

Do Restore from NetVault Server (required for RMAN Backups): Specify the name of the NetVault Server where the Oracle Database Server was added as a NetVault Client.

•

Restore Backup taken from NetVault Client: When a restore is performed by the plug-in from a terminal session, this field indicates the NetVault Client from which the original backup was performed. If no client name is entered, the restore command defaults to the local NetVault Machine Name performing the restore. For a complete description of this functionality, see CLI-based RMAN backups and restores: an overview.

•

CLI Backup/Autobackup Advanced Options Set: This option requires that you first create a set of desired options on the Advanced Options tab, and then save it with a specific name. To have all CLI-based RMAN backups automatically use the Advanced Options specified in this set, enter the name of this set in the text box. If a set name is not specified, all CLI-based RMAN backups use the default Advanced Options.

When defining the CLI Backup/Autobackup Advanced Options Set, the Discard After Days/Weeks/Years option must be specified instead of the 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.

•

CLI Backup/Autobackup Target Set (required for RMAN Backups): Specify the name of the Target Set that was created in Configuring a default Target Set for RMAN backups.


	IMPORTANT: If a Target Set or Advanced Options Set is named in its appropriate field, you override it from the command line by specifying the name of a different set as a variable in the syntax. For more details on naming Sets in the CLI syntax, see CLI-based RMAN backups and restores: an overview.

•

Slave Connection Timeout (minutes - 0 = Never): Use this option to set an amount, in minutes, that serves as an inoperability timeout between the plug-in and the Oracle database. If the plug-in senses no activity for this length of time during a backup, it times out and disconnects from the backup. The default entry of zero (“0”) indicates that no timeout exists.

•

Generate Script Default Directory: Enter the full path name of the default directory where RMAN-generated scripts are stored. This directory is used as the default directory for the Generate RMAN Script feature available on all Backup Options and Restore Options tabs.

•

Generate Sbt trace to Oracle Dump Directory: Select this option to send the System Backup to Tape (SBT) trace information to the Oracle dump directory. You can then review the log file to see the sequence of trace commands that were run by the Oracle Server.

•

CLI will not check Quest NetVault Server name: Select this option if you do not want the RMAN CLI to verify that the specified NetVault Server is available and can be contacted. Do not select this option if you want to ensure that backup jobs do not time out while trying to process a job for an unknown NetVault Server.

•

Preferred Phase for Restores (0 = default): The Advanced Options section of the Create Backup Job page lets you create a Secondary Copy of a backup using either the Duplicate or Data Copy option. When you restore an RMAN backup, use this field to indicate which backup phase you prefer to use to complete the restore if the applicable backup set from the phase is available. The default entry of 0 indicates that NetVault automatically chooses the copy to which it has easier access, phase 1 or phase 2. To instruct NetVault to use the original (phase 1) backup if it is available, enter a 1. To instruct NetVault to use the Secondary Copy (phase 2) for a Data Copy backup if it is available, enter a 2.


	IMPORTANT: For a Data Copy backup, NetVault always runs the restore from the original (phase 1) backup unless you enter a 2.

•

Maximum Number of Objects in Contents Courtesy List (x100 - 0 = all): Use this field to specify a maximum number of items that the plug-in displays on the Backup Contents tab of Restore Options. Limiting the number of items reduces the amount of memory used during runtime when the plug-in generates the backup index. The value that you enter is multiplied by a factor of 100. For example, if you enter 50, the maximum is 5000. To specify no limit, that is, display all items, enter 0. Quest recommends that you enter 0 and change the entry only if the plug-in encounters failures during backups while generating the backup index or Restore Options.

To save the settings, click OK.

Adding a database

To begin using the plug-in for backup and restore, first add the target Oracle database to the plug-in. To add a database, perform the following steps for each database running on the Oracle server that is protected with the plug-in.

In the Navigation Pane, click Create Backup Job, and click

next to the Selections list.

In the selection tree, open the applicable client node, click Plug‑in for Oracle, and select Add Database from the context menu.

On the Oracle Instance Details tab, set the following parameters:

All the parameters pertaining to the Oracle Instance are mandatory for both RMAN and User Managed backup methods.

•

Oracle SID: Enter the SID for the target Oracle database. For help on determining the Oracle SID, see Determining the Oracle SID and Home directory in a non-RAC environment.


	NOTE: In general, the SID is case-sensitive for Linux and UNIX. The plug-in uses the SID that you enter without modifications to access the Oracle Instance. To determine whether the SID that you enter is case-sensitive, see the documentation for your Oracle installation.

•

Oracle Home: Enter the complete path to the installation directory of the target database. For help on determining the Oracle Home, see Determining the Oracle SID and Home directory in a non-RAC environment.


	IMPORTANT: To prevent an Oracle error from occurring, do not include a forward slash at the end of the ORACLE_HOME directory on Linux and UNIX. Using a backward slash on Windows does not generate an error.

•

Oracle SYSDBA User Name: Specify an Oracle user with SYSDBA privileges that is used by the plug-in to connect to the database.

•

Oracle SYSDBA Password: Enter the password associated with the name specified in the preceding field.


	NOTE: You can also configure the authentication details for Plug‑in for Oracle later by accessing the Set Database Password functionality. For more information, see Setting the database password.


	IMPORTANT: If the plug-in’s authentication details are not configured on the Add Oracle Database dialog box or by using Set Database Password, a prompt appears each time a connection to the database is required.

•

For Linux and UNIX only: Configure these parameters:

•

Oracle Software Owner: Specify the name of the Linux or UNIX user that owns all the Oracle software. This user must have the Oracle Inventory group as its primary group and the OSDBA and OSOPER groups as secondary groups. The usual name chosen for this user is oracle.

•

Oracle Software Group: Specify the name of the Linux or UNIX group that owns the Oracle inventory, which is a catalog of all Oracle software installed on the system. The usual name chosen for this group is oinstall.

•

NLS_LANG: Select the character set that matches the NLS Language or NLS_LANGUAGE parameter for the databases residing on this Oracle Database Server. The NLS_LANGUAGE specifies the default language of the database. This language is used for messages, day and month names, symbols for AD, BC, a.m., and p.m., and the default sorting mechanism.

To determine the current NLS_LANGUAGE parameter for the database, issue the following command from SQL*Plus as a SYSDBA user:

select * from v$NLS_PARAMETERS where PARAMETER = 'NLS_LANGUAGE' or

PARAMETER = 'NLS_TERRITORY' or PARAMETER = 'NLS_CHARACTERSET';

The results are combined in the following format to match the available selections in the list:

<NLS_LANGUAGE>_<NLS_TERRITORY>.<NLS_CHARACTERSET>

For a list of languages that the plug-in supports and their corresponding NLS_Lang value, see Language support.

If you are unable to find an NLS_LANG in this list that exactly matches your current settings from the SQL*Plus query, you can enter — or copy and paste — the exact value in the list. Moreover, a perfect match is not required; a compatible match is sufficient. For example, any charset 1252 is compatible with the charset WE8MSWIN1252.

•

Parameter File(s) Path: When an Oracle Instance is started, the parameters specified within the initialization parameter file establish the characteristics of the Instance. These initialization parameters are either stored in the PFILE or SPFILE.

Specifying the path is required when using the User Managed backup method. When using the RMAN backup method, you have three options for backing up the SPFILE. These options include:

•

Enabling Control File Autobackups, which include Autobackups of the SPFILE by selecting the Control File Autobackup Enabled option on the RMAN Details tab.

•

Disabling Control File Autobackups and using RMAN commands to back up the SPFILE when the Use RMAN Commands to Backup SPFILE option on the RMAN Details tab is selected.

•

Disabling Control File Autobackups and using File System-based commands to back up the SPFILE by entering the path for the SPFILE in the Parameter File(s) Path field.

If you are using the User Managed or RMAN backup method but you want to use File System-based backups for the SPFILE, specify the complete path; include the directory and filename of the PFILE or SPFILE, depending on whichever is in use. Provide the details for both if you are using SPFILE as well as PFILE.

The following table provides the default paths:


Init. file	Platform	Default name	Default location
PFILE	Windows	initSID.ora	%ORACLE_HOME%\database\
PFILE	Linux and UNIX	initSID.ora where the SID represents the ORACLE_SID	$ORACLE_HOME/dbs
SPFILE	Windows	spfileSID.ora where SID represents the ORACLE_SID	%ORACLE_HOME%\database\
SPFILE	Linux and UNIX	spfileSID.ora where SID represents the ORACLE_SID	$ORACLE_HOME/dbs

You can enter multiple parameter file paths by using a comma as a delimiter. The default length of this field is 2048 characters.

•

Auto Discover: To complete the remaining database-configuration fields automatically, click this button after you have completed the Oracle SID, Oracle Home, Oracle SYSDBA User Name, and Oracle SYSDBA Password fields.


	IMPORTANT: When using the Auto Discover option, Quest recommends that you review all database-configuration fields for accuracy.

On the RMAN Details tab, set the following parameters if you intend to use the RMAN backup method.

For more information on Recovery Catalog, see Prerequisites for RMAN backups.

•

Control File Autobackup Enabled (Disables Manual Control File and SPFILE Backups): Select this option if the Control File Autobackups have been enabled for this database. Control File Autobackups are required for disaster recovery and multi-instance RAC environments. When this option is selected, Manual Control File backups are disabled and the Control File node is not available on the NetVault Selections page. For more information on Control File Autobackups in a multi-instance RAC environment, see Enabling Control File Autobackups in a RAC environment.

•

Use RMAN Commands to Backup SPFILE: Available only when Control File Autobackup Enabled is not selected. When this option is selected, the RMAN commands are used to back up the SPFILE. When this option is not selected, a File System-based backup of the SPFILE is performed of the SPFILE that is specified in the Parameter File(s) Path field on the Instance Details tab.

•

Use Catalog for RMAN Based Backups: Select this option if the RMAN repository for this database is stored in a Recovery Catalog database, and then configure the following parameters:

•

Catalog Instance Name: Enter the Oracle Instance name, which might differ from the Oracle Net Service name, for the Recovery Catalog database. This instance name must be defined in the “tnsnames.ora” file on the Oracle Database Server so that the plug-in can connect to the Recovery Catalog database.

•

Catalog Owner: Specify the user that was specified as the owner of the Catalog and was granted the RECOVERY_CATALOG_OWNER role.

•

Catalog Password: Provide the password associated with the Catalog owner name specified in the preceding field.

•

CLI Backup/Autobackup Advanced Options Set: If you are using CLI-based backups, specify the name of the Backup Advanced Options Set that you want to use for this database.

•

CLI Backup/Autobackup Target Set: If you are using CLI-based backups, specify the name of the Backup Target Set that you want to use for this database.

•

CLI Database Name (optional): If you are using CLI-based backups, enter the database name used by the CLI.


	IMPORTANT: If the Recovery Catalog is not enabled, the plug-in automatically stores the RMAN Repository information in the database’s Control File.

On the User Managed Details tab, set the following parameters:

This tab is only for the User Managed backup method; it is not supported in multi-instance RAC or Data Guard environments.


	NOTE: The User Managed backup method can only back up File System objects; it cannot back up archive logs saved in ASM storage. You can leave the Archive Log Destination Directory field on the User Managed Details tab blank. Backing up databases in ASM storage is only available using the RMAN backup method.

Provide the following information for making User Managed backups of Control Files and archived redo logs. You can leave these fields blank if your backup-and-recovery strategy includes the RMAN method.

•

Control File Save Filename (Full Path): When the plug-in uses the User Managed backup method, backups and restores of the Control File are not performed using the active Control File. A snapshot of the Control File is created in the file named by the Control File Save Filename (Full Path), and the snapshot or copy of the Control File is backed up. This step ensures that a consistent copy of the Control File is protected.

During a User Managed restore sequence that includes restoring Control Files, the Control Files are restored to the Control File Save Filename (Full Path). This step ensures that active Control Files are not overwritten. During the User Managed recovery processes, copy the file manually from the Control File Save Filename (Full Path) to the original location as required.

Specify the full path name; include a filename, on the Oracle Database Server that is used as the Control File Save Filename (Full Path), and ensure that the plug-in has read/write privileges for the specified location and file.

•

Archive Log Destination Directory: Enter the complete path to the archive log directory as set in the LOG_ARCHIVE_DEST or LOG_ARCHIVE_DEST_n parameters in the parameter file. If you archive the redo logs to multiple locations, specify only the primary destination directory in this field.


	IMPORTANT: The User Managed backup method does not support dynamic path names such as a daily created subfolder in the Archive Log Destination Directory.

•

Archive Log Format: Specify the extension of the archive log files. The archive file pattern depends on what is established for the LOG_ARCHIVE_FORMAT setting in the parameter file. The following list provides some examples:

•

If LOG_ARCHIVE_FORMAT = “%t_%s_%r.dbf”, the archive file pattern is “*.dbf”.

•

If LOG_ARCHIVE_FORMAT = “%t_%s.arc”, the archive file pattern is “*.arc”.

•

If LOG_ARCHIVE_FORMAT = “arc%s.%t”, the archive file pattern is “arc*.*”.

On the External Configuration tab, set the following parameters:

Although the database depends on other types of files for operation, such as network configuration files and password files, these files cannot be backed up with Oracle RMAN commands. However, they are useful when performing disaster recovery or recovering from user error during Oracle configuration activities.

In the Oracle Network Configuration Directory, or File(s) Path* and Oracle Password Directory, or File(s) Path* fields, you can enter one or more of the following:

•

Directory Path: If you enter a directory path, the plug-in scans the directory for filenames that might correspond to an Oracle Network Configuration File or an Oracle Password File. The rest of the files in the directory are ignored.

•

Fully Qualified Path to a File: The path includes directory and filename.

The External Configuration fields are as follows:

•

Oracle Network Configuration Directory or File(s) Path: Enter the directory where the Oracle Network Configuration files reside, or the list of Oracle Network Configuration files.

•

Oracle Password Directory or File(s) Path: Enter the directory where the Oracle Password files reside, or the list of Oracle Password files.


	NOTE: Oracle lets you install multiple versions of the Oracle Database and Oracle Client software to on the same system. In this type of environment, there might be more than one Oracle Network Configuration Directory, with each one having its own “tnsnames.ora” file. Connecting to a database that has multiple “tnsnames.ora” files might display the following error message: ORA-12154: TNS: could not resolve service name or SQL*NET Unable to resolve service name Although the Oracle service is correct, included in the appropriate “tnsnames.ora” file, and located in the appropriate Oracle network configuration directory, this issue occurs because the actual “tnsnames.ora” file that is being used by the Oracle Server is from a different directory; it is not the file that includes the database you are connecting to. You should use the environment variable TNS_ADMIN to indicate the directory where the Oracle network configuration files are located, including the “tnsnames.ora” file that is used to resolve the Oracle service name. Otherwise, the default location might be used, which might result in the preceding connection error. When you complete the Oracle Network Configuration Directory or File(s) Path field, make sure that you include all Oracle network configuration directories from the different locations for which you have configured “tnsnames.ora” files. On your system, make sure that you maintain the TNS_ADMIN variable with the proper configured location for the Oracle network configuration files that should be used for connecting to the database. If you restore the database to an alternate server, make sure that the TNS_ADMIN variable is set with the location of the Oracle network configuration files that include the “tnsnames.ora” file with the Oracle database entry to resolve the Oracle service name that you want to connect to.

On the Optional OS Authentication Details tab (for Windows-based OS only), set the following parameters:

Use the following fields to specify a Windows Administrator user name that allows the Windows installation to “impersonate” an Oracle SYSDBA user. This login is only necessary if backups fail due to “ORA-01031 insufficient” errors.

•

Windows Administrator User Name: Enter the Windows Administrator user name for the account under which the plug-in should run. The name specified in this field must have been already created in the Windows OS.

•

Password: Enter the password associated with the name specified in the preceding field.

•

Windows Domain: Specify the domain to which the user belongs. If it is the Local domain, leave this field blank.

To save the settings, click OK.

If you are using Oracle Multitenant Architecture with Oracle Database 12c or later and your CDB includes one or more PDBs, make sure that an entry is included for each PDB in the “tnsnames.ora” file and that the status of the PDB is in read-write mode.

When you create a PDB, a default Oracle service with the same name as the PDB name is created automatically. However, an entry to the “tnsnames.ora” file might not get added automatically.

Editing database information

In the Navigation Pane, click Create Backup Job, and click

next to the Selections list.

In the selection tree, open the applicable client node, and double-click Plug‑in for Oracle.

Click the name of the applicable database to highlight it; do not select the check box.

From the context menu, select Edit Database.

The Edit Oracle Database dialog box displays configured values for the database instance.

Reconfigure the parameters as required.

For information on the fields in this dialog box, see Adding a database.

To save the changes, click OK.


	IMPORTANT: The password fields on the Edit Oracle Database dialog box are blank. Set the passwords again, even if there are no changes. If this step is not done, the existing values are reset to blank when you save the updated information. To update only the authentication details for the plug-in, select the Set Database Password option instead of Edit Database.

Setting the database password

Plug‑in for Oracle lets you save the Oracle authentication details that are used to connect to the database automatically. Saving the authentication information eliminates the need to enter the details each time a connection to the database is required. You can save these details either at the time of adding a database or any time later using the Set Database Password option.

In the Navigation Pane, click Create Backup Job, and click

next to the Selections list.

In the selection tree, open the applicable client node.

Double-click Plug‑in for Oracle, click the applicable database, and select Set Database Password from the context menu.

Enter the following information:

•

Account Name: Enter an Oracle user name with SYSDBA privileges.

•

Password: Enter the password associated with the name specified in the preceding field.

To save the settings, click OK.