Snap Creator supports the following built-in (or native) plug-ins: Oracle, DB2, MySQL, Sybase ASE, Domino, SnapManager for Microsoft SQL Server, SnapManager for Microsoft Exchange, MaxDB, VMware (vSphere and vCloud Director), Red Hat KVM, Citrix XenServer, and SAP HANA. Community plug-ins are not included in the package and must be downloaded separately.
Parameters | Setting | Description |
---|---|---|
APP_NAME | oracle|db2|mysql|domino|vibe|smsql|sme|sybase|maxdb|kvm|xen|hana<plug-in> | Determines which application is being backed up. Snap Creator has built-in support for the listed applications. You can either use APP_NAME or configure APP_QUIESCE_CMDXX, APP_UNQUIESCE_CMDXX, and PRE_EXIT_CMDXX. If the application is not directly supported in Snap Creator, you can use a plug-in or run your own application quiesce or unquiesce commands or scripts. <PLUG-IN>: Copy the plug-in to the /path_to_scServer|scAgent/plug-ins directory and specify the plug-in in the APP_NAME parameter. Commands or Scripts: APP_QUIESCE_CMD01=path_to_quiesceCMD APP_UNQUIESCE_CMD01=path_to_unquiesceCMD PRE_EXIT_CMD01=path_to_unquiesceCMD |
APP_IGNORE_ERROR | (Y|N) | Determines whether Snap Creator should ignore errors from application plug-ins. This is useful when you want to back up multiple databases and do not want to stop the backup if the quiesce or unquiesce operations of one database fails. |
APP_DEFINED_BACKUP | (Y|N) | The application plug-in is expected to perform the entire backup operation including quiescing, creating a Snapshot copy, and unquiescing. The built-in plug-ins do not support this kind of backup. |
APP_DEFINED_RESTORE | (Y|N) | Enables application-based restore operations. In the event of a restore operation, Snap Creator sends a request to the application plug-in and the plug-in handles the request. |
APP_DEFINED_MOUNT | (Y|N) | The built-in mount abilities of Snap Creator are ignored. Instead, the plug-in is responsible for all mount activities including volume or LUN clone creation. The built-in plug-ins do not support this type of mount. |
APP_DEFINED_UMOUNT | (Y|N) | The built-in unmount abilities of Snap Creator are ignored. Instead, the plug-in is responsible for handling all unmount activities including volume or LUN clone deletion. The built-in plug-ins do not support this type of unmount operation. |
APP_AUTO_DISCOVERY | (Y|N) | Enables application automatic discovery. Snap Creator sends a discover request to the application plug-in and the plug-in is then responsible for the discovery of the storage configuration. This can be done dynamically or made persistent using the APP_CONF_PERSISTENCE parameter, if the information is to be saved to the configuration file. |
APP_CONF_PERSISTENCE | (Y|N) | Enables automatic discovery to be persistent, which means changes are dynamically updated in configuration file. |
APP_DEFINED_CLONE | (Y|N) | The built-in cloning abilities of Snap Creator are ignored. Instead, the plug-in is responsible for handling all clone activities, including volume or LUN clone creation and deletion. The built-in plug-ins do not support this type of clone. |
FS_NAME | plug-in | Determines which plug-in is being used for file system operations. |
JAVA_HOME | Text | This setting points to the Java Virtual Machine (JVM) that should be used for executing .class and .jar files. |
JVM_ARGS | Text | This setting controls the JVM settings when native Java .class or .jar files are executed. The default setting is -Xms32M -Xmx128M. |
JAVA_CLASSPATH | Text | This setting defines the Java classpath. By default, plug-ins/native is configured and can be completed using this environment variable, which is appended to the default. |
META_DATA_VOLUME | Enables a Snapshot copy of the specified volume to be created after the unquiesce operation. This can be valuable for certain plug-ins for which the Snapshot copy of data must be created at different times. The parameter must not only specify the volume but the controller as well (for example, controller1:volume1,volume2;controller2:volume3,volume4;controller3:volume5,volume6). | |
PERL_HOME | Text | This setting points to the Perl interpreter that should be used for executing .pl files. |
PERL_OPTS | Text | This setting controls the PERL interpreter settings when native Perl files are executed. Options for additional settings include directories (-I) that can be passed to the Perl interpreter. |
PYTHON_HOME | Text | This setting points to the Python interpreter that should be used for executing .py files. |
PYTHON_OPTS | Text | This setting controls the Python interpreter settings when native Python files are executed. |
VALIDATE_VOLUMES | data | Validates that all the volumes in which the database resides are part of the backup operation. Currently, there are limitations:
|