Skip to main content
Snap Creator Framework

Oracle plug-in

Contributors NetAppZacharyWambold

The Oracle plug-in uses SQL*Plus to communicate with the database and quiesce & unquiesce oracle database for backup.

The Snap Creator Oracle plug-in supports Oracle Automatic Storage Management (offline or online backups) and online backup of a Real Application Clusters (RAC) database configuration. The Interoperability Matrix contains the latest information about support and compatibility.

To use C Shell (CSH) with the Oracle plug-in on UNIX or Linux platforms, the following conditions should be met:

  • Snap Creator Agent must be started as the Oracle user, instead of the root user.

  • The Oracle user must have the proper environmental variables (ORACLE_HOME and ORACLE_SID) set for the plug-in driven SQL*Plus commands to work.

    This can be accomplished using a shell startup file, such as ~/.cshrc.

The following table lists the Oracle plug-in parameters, provides their settings, and describes them:

Parameter Setting Description



Application name



List of Oracle databases and user names Multiple databases and user names can be specified as a semicolon-separated list, for example, db1:user1;db2:user2.


Path to the sqlplus command


Path to the directory where the user should store the backup control filesThe Oracle user must have appropriate permissions to this directory.


Path to the directory to store the temporary file, for example, /tmp.The Oracle user must have appropriate permissions to this directory.






Informs the Oracle plug-in to perform only a switch log operationThis setting is useful if you are handling archive log backups separately from data backups.


Path to the Oracle home directory


Path to the Oracle home directory for a given system identifier (SID)When backing up multiple databases, it might be important to specify more than one Oracle home directory.



N )

The ORACLE_HOME and ORACLE_SID environment parameters are exported by using the export command. This is applicable only in UNIX or a Linux-based environment.


Option to configure offline or online backups by using the Snap Creator policy. The default option is online. ORACLE_BACKUPMODE=hourly:online,daily:offline



Related information