######################################################################################################################## # Snap Creator Framework Configuration File # # # # Referencing a Variable # # Reference previously assigned variables or variables assigned within Snap Creator itself by prepending the variable # # name with "%". # # # # For example) If you want to reference a VARIABLE: # # BLAH=/usr/local/bin/foo %USER_DEFINED # # # # Below is a list of all the built in referenceable variables: # # %SNAP_TYPE # # The Snapshot Schedule: daily, monthly, etc # # %SNAP_TIME # # An epoch time stamp associated with the snapshot # # %ACTION # # Could be -snap, -clone_vol, -clone_lun, -arch, or -list depending on which action you used # # %MSG # # Used to send the error message to other monitoring tools or email. Can only be used with SENDTRAP function. # # %USER_DEFINED # # Pass a user defined argument to the script, a good example would be in order to integrate with a backup # # application like netbackup, you may need to pass into configuration file the netbackup schedule desired in the # # case where you have multiple schedules. # ######################################################################################################################## ######################################################################################################################## # CONFIG_TYPE - (required) - (STANDARD|PLUGIN) # # We can have two types of configuration in SC 3.4.0 app or standard. We can use multiple app configs to build up # # complex quiesce and unquiesce workflows. # # META_DATA_VOLUME - (optional) # # Allows for Snapshot copy of specified volume to occur after unquiesce. This can be valuable for certain plugins # # where data Snapshot copy should occur at different times. The meta data volume must not be only volume # # specified. # # i. e.: controller1:volume1,volume2;controller2:volume3,volume4;controller3:volume5,volume6 # # LOG_NUM - (optional) - Number # # The number of logs .debug and .out for Snap Creator to keep # # SNAPDRIVE - (optional) - (Y|N) # # Setting which allows you to use snapdrive instead of ZAPI for Snapshot copy creation # # SNAPDRIVE_DISCOVERY - (optional) - (Y|N) # # Setting which enables use of snapdrive for storage discovery, required in SAN or iSAN environment when using # # VALIDATE_VOLUMES parameter # # LOG_TRACE_ENABLE - (optional) - (Y|N) # # This setting allows logging of all the events. If disabled, the ZAPI result objects get not logged. # # VOLUME_GROUPS - (optional) # # List of volume groups, each volume group has a list of primary filers and volumes you want to Snapshot copy. # # i. e.: #VOLUMES_01 - filer1:vol1,vol2,vol3;filer2:vol1 # # #VOLUMES_02 - filer1:vol3,vol4 # # #VOLUMES_03 - filer2:vol3,vol4 # # #VOLUME_GROUPS - VOLUMES_01,VOLUMES_02,VOLUMES_03 # # USE_PROXY - (optional) - (Y|N) # # Setting which allows API calls to go through DFM proxy instead of storage controller directly. If this option # # is used NTAP_USERS is no longer required. # # NTAP_PWD_PROTECTION - (required) - (Y|N) # # Setting for enabling password protection, you must first create a encrypted password and then save that # # password in config file # # NTAP_TIMEOUT - (optional) - Number # # (seconds) Setting which sets timeout for all storage controller zapi calls. Default is 60 secs. # # USE_GLOBAL_CONFIG - (optional) - (Y|N) # # (Y|N) Setting which allows to use global config for storing values. # # FEDERATED_APPLICATIONS - (optional) # # List of config and profile names for all the federated application under this config # # i. e.: databases@db2;databases@oracle # # ALLOW_IP_ADDR - (optional) - (Y|N) # # (Y|N) Setting which allows to use IP in secondary configuration (snapvault, snapmirror etc). # # SC_TMP_DIR - (optional) - Text # # The directory used for storing temporary created files. It must exist and must be writable. If not specified, # # the system default will be used. # # MANAGEMENT_INTERFACES - (optional) - Text # # List of primary controllers and their management interfaces used for communications # # i. e.: controller1:controller1-mgmt;controller2:controller2-mgmt # # NTAP_USERS - (optional) - Text # # List of primary controllers and volumes you want to Snapshot copy. # # i. e.: controller1:user/password;controller2:user/password # # PORT - (optional) - Number - (\d+) # # Setting which configures which port number on the NetApp controller to use # # TRANSPORT - (optional) - (HTTP|HTTPS) # # Setting to use either HTTP or HTTPS to connect to NetApp controller # # SECONDARY_INTERFACES - (optional) - Text # # List of primary controllers or vfilers and their secondary interfaces source/destination for snapvault and # # snapmirror relationships # # i. e.: # # controller1:controller1-source/controller2-destination;controller3:controller3-source/controller4-destination # # OR # # controller1:controller1-source/controller2-destination;controller1:controller1-source/controller3-destination # # CMODE_CLUSTER_NAME - (optional) - Text # # (required for Clustered ONTAP) Name of the primary Clustered ONTAP cluster # # CMODE_CLUSTER_USERS - (optional) - Text # # (required for Clustered ONTAP) List of primary/secondary Clustered ONTAP clusters and their corresponding # # users/passwords # # i. e.: cluster1:joe/password1;cluster2:bob/password2 # # CMODE_SNAPSHOT_FORCE_DELETE - (optional) - (Y|N) # # Setting which ensures Snapshot copies will be deleted. In Clustered ONTAP Snapshot copies will not be deleted # # if they have dependencies like a clone. # # CMODE_SET - (optional) - (Y|N) # # Setting which defines if the configuration is a Clustered ONTAP or 7-mode configuration # # SNAME - (required) - Text # # Your Snapshot copy naming convention, should be unique, Snapshot copies on netapp will be deleted according to # # this naming convention # # i. e.: xyz # # SNAP_TIMESTAMP_ONLY - (optional) - (Y|N) # # Setting to set snapshot naming convention "Y" will create _recent, "N" will use a human readable timestamp # # NTAP_SNAPSHOT_POLICIES - (optional) # # Setting which determines the number of netapp Snapshot copies you want to retain for a given policy, backup # # type and scheduler information. # # NTAP_USE_EXTERNAL_SNAPSHOT - (optional) - (Y|N) # # (Y|N) Setting which allows for import of non Snap Creator Snapshot copy, most recent Snapshot copy is matched. # # NTAP_SNAPSHOT_NODELETE - (optional) - (Y|N) # # Setting which will override NTAP_SNAPSHOT_RETENTIONS and ensure no Snapshot copies are deleted, leaving this on # # can cause your netapp volume to fill up # # NTAP_CONSISTENCY_GROUP_TIMEOUT - (optional) - (URGENT|MEDIUM|RELAXED) # # Setting which defines how long controller will wait for consistently group Snapshot copy # # NTAP_SNAPSHOT_RETENTIONS - (required) # # Setting which determines the number of netapp Snapshot copies you want to retain for a given policy # # i. e.: daily:7,weekly:4,monthly:1 # # NTAP_SNAPSHOT_CREATE_CMD<#> - (optional) # # SnapDrive command to create a Snapshot copy and flush the file system buffers where "#" is a number 01-xx # # NTAP_CONSISTENCY_GROUP_WAFL_SYNC - (optional) - (Y|N) # # Setting which can improve performance of the CG Snapshot copy by forcing a CP through a wafl-sync before the # # cg-start # # NTAP_CONSISTENCY_GROUP_SNAPSHOT - (optional) - (Y|N) # # Setting which enables use of consistency groups for creating consistent Snapshot copy across multiple volumes # # NTAP_SNAPSHOT_RETENTION_AGE - (optional) - Text # # Setting in (days) which allows you to define a retention age for Snapshot copies. If configured Snapshot copies # # will only be deleted if there are more than defined in NTAP_SNAPSHOT_RETENTIONS and if they are older than # # retention age (days) # # NTAP_METADATA_SNAPSHOT_CREATE_CMD<#> - (optional) # # SnapDrive command to create meta data volume Snapshot copy and flush the file system buffers where "#" is a # # number 01-xx # # NTAP_SIS_CLONE_FILES - (optional) # # # # NTAP_SNAPSHOT_DELETE_BY_AGE_ONLY - (optional) - (PRIMARY|SECONDARY|BOTH|N) # # Setting which allows the deletion of out-dated Snapshot copies, regardless of the retentions count # # NTAP_SNAPSHOT_DEPENDENCY_IGNORE - (optional) - (Y|N) # # Setting which allows for ignoring Snapshot copy dependencies when prompted for deletion using the "--action # # delete" option # # NTAP_SNAPSHOT_RESTORE_AUTO_DETECT - (optional) - (Y|N) # # Setting which - if disabled - will always force a SFSR when doing a single file restore # # NTAP_SNAPSHOT_DISABLE - (optional) - (Y|N) # # Setting which tells Snap Creator to not take a Snapshot copy. # # NTAP_SNAPSHOT_LABEL - (optional) - Text # # A Clustered ONTAP setting which allows an optional snapmirror label to be applied to the snapshot. # # NTAP_EXTERNAL_SNAPSHOT_REGEX - (optional) - Text # # A regular expression for matching imported Snapshot copies, requires the NTAP_USE_EXTERNAL_SNAPSHOT option. # # ALLOW_DUPLICATE_SNAME - (optional) - (Y|N) # # (Y|N) Setting which will prevent/allow sname duplication. # # NTAP_SNAPSHOT_CLEANUP - (optional) - (Y|N) # # (Y|N) Setting which in the event of backup failure will remove any Snapshot copies taken. # # NTAP_SNAPVAULT_UPDATE - (optional) - (Y|N) # # Setting which allows you to turn off and on the snapvault update function # # NTAP_SNAPVAULT_NODELETE - (optional) - (Y|N) # # Setting which will override NTAP_SNAPVAULT_RETENTIONS and ensure no Snapshot copies are deleted, leaving this # # on can cause your netapp volume to fill up # # SNAPVAULT_QTREE_INCLUDE - (optional) # # List of primary storage controllers and qtree paths which should be included in snapvault update. Without this # # option all qtrees under a volume will be backed up qtrees listed here will be backed up, the rest will be # # ignored. # # i. e.: controller1:/vol/qtree/qtree1,/vol/volume/qtree2;controller2:/vol/volume/qtree1 # # NTAP_SNAPVAULT_RESTORE_WAIT - (optional) - (Y|N) # # Setting which waits for snapvault restore to complete. This is recommended since after restore is complete user # # will be prompted to delete the baseline snapshot which gets created on the primary volume # # NTAP_SNAPVAULT_RETENTION_AGE - (optional) - Text # # Setting in (days) which allows you to define a retention age for snapvault Snapshot copies. If configured # # snapvault snapshots will only be deleted if there are more than defined in SNAPVAULT Retentions and if they are # # older than retention age (days) # # NTAP_SNAPVAULT_SNAPSHOT - (optional) - (Y|N) # # Setting which enables creation of snapvault Snapshot copy. A Snapshot copy compatible with the storage # # controller snapvault scheduler. Snapshots are named sv_.<#> and deletion is handled by the storage # # controller # # NTAP_SNAPVAULT_MAX_TRANSFER - (optional) - Number # # Maximum bandwidth for snapvault to consume in kbps, if left blank snapvault will consume as much bandwidth as # # possible # # NTAP_SNAPVAULT_WAIT - (optional) - Number - (\d+) # # Time in minutes where we will wait for snapvault update process to complete before taking a Snapshot copy on # # the snapvault secondary # # NTAP_SNAPVAULT_RETENTIONS - (optional) # # Setting which determines the number of netapp Snapshot copies on the snapvault secondary you want to retain for # # a given policy # # i. e.: daily:7,weekly:4,monthly:1 # # SNAPVAULT_VOLUMES - (optional) # # List of primary controller and volumes you want to perform a snapvault update on # # i. e.: controller1:vol1,vol2,vol3;controller2:vol1;controller3:vol2,vol3 # # NTAP_SNAPMIRROR_WAIT - (optional) - Number # # Time in minutes where we will wait for snapmirror update process to complete # # NTAP_SNAPMIRROR_USE_SNAPSHOT - (optional) - (Y|N) # # Setting which determines if the Snapshot copy will be sent with the snapmirror update # # NTAP_SNAPMIRROR_MAX_TRANSFER - (optional) - Number # # Maximum bandwidth for snapvault to consume in kbps, if left blank or 0, snapvault will consume as much # # bandwidth as possible # # SNAPMIRROR_VOLUMES - (optional) # # A list of volumes to perform snapmirror operations on. Volumes can be subset or complete list of those in # # VOLUMES parameter # # SNAPMIRROR_CASCADING_VOLUMES - (optional) # # List of secondary controller and volumes where you want to perform a snapmirror update from snapvault source # # volume (snapshot->snapvault->snapmirror) # # NTAP_SNAPMIRROR_CASCADING_UPDATE - (optional) - (Y|N) # # Setting which allows you to turn off and on the cascading snapmirror function (snapshot->snapvault->snapmirror) # # NTAP_SNAPMIRROR_UPDATE - (optional) - (Y|N) # # Setting which allows you to turn off and on the snapmirror update function # # NTAP_CLONE_IGROUP_MAP - (optional) - Text # # List of filer(s), source volume(s), and the Igroups used to map cloned volumes and luns # # i. e.: controller1:src_volume1/igroup1;controller2:src_volume2/igroup2 # # NTAP_LUN_CLONE_RESERVATION - (optional) - (Y|N) # # If true will reserve space for cloned luns if false will not # # NTAP_CLONE_SECONDARY_VOLUMES - (optional) # # Mapping of primary controllers and their secondary controller/volume. # # i. e.: controller1:secondaryController1/vol1;controller2:secondaryController2/vol2 # # NTAP_NFS_EXPORT_ACCESS - (optional) - (root|read-write|read-only) # # Setting which controls access permission to cloned vol # # NTAP_NUM_VOL_CLONES - (optional) - Number # # Setting which configures how many volume clones Snap Creator will keep # # NTAP_NFS_EXPORT_PERSISTENT - (optional) - (Y|N) # # Setting which allows for export permissions of cloned vol to be saved in the /etc/exports file on the storage # # controller. # # NTAP_CLONE_FOR_BACKUP - (optional) - (Y|N) # # Setting which determines when the clone is deleted. "Y" will delete clone after it is created, "N" will delete # # clone before Snapshot copy occurs so during the next run of Snap Creator for the given policy and config # # NTAP_CLONE_SECONDARY - (optional) - (Y|N) # # Setting which determines where to perform a clone. If "Y" is selected the snapmirror destination will be # # cloned. This only works with snapmirror and you must set NTAP_SNAPMIRROR_USE_SNAPSHOT to Y # # NTAP_CIFS_EXPORT_ENABLE - (optional) - (Y|N) # # (Y|N) Setting to share a cloned volume using cifs # # NTAP_NFS_EXPORT_HOST - (optional) - Text # # The hostname or IP address of the server where cloned volume should be exported # # NTAP_VOL_CLONE_RESERVE - (optional) - (NONE|FILE|VOLUME) # # Space Guarantee for cloned volume # # NTAP_DFM_DATA_SET - (optional) - Text # # List of controllers and their NetApp Management Console dataset to volume correlations # # i. e.: controller1:dataset1/vol1,vol2;controller1:dataset2/vol3 # # NTAP_PM_RUN_BACKUP - (optional) - (Y|N) # # Setting which enables starting the NetApp Management Console backup as soon as the Snapshot copy registration # # process is complete. Eliminates need to schedule secondary backup in NetApp Management Console. # # NTAP_PM_UPDATE - (optional) - (Y|N) # # Setting which allows you to turn off and on the NetApp Management Console backup update. The NetApp Management # # Console backup will use a Snap Creator Snapshot copy. # # NTAP_DFM_SNAPSHOT_FORMAT - (optional) - Text # # Optional setting for the format of the secondary Snapshot copies when using NetApp Management Console. This # # option requires DFM 5.0 or higher. You also must specify %T (timestamp). Other variables are %R (retention # # type), %L (dataset label), %H (storage controller), %N (volume name), and %A (application specific data). If # # this option is not set then the default PM naming convention will be used. The naming convention can only be # # set at the time of dataset creation. # # i. e.: controller1:volume1 # # OM_TRANSPORT - (optional) - (HTTP|HTTPS) # # Setting to use either HTTP or HTTPS to connect to NetApp Management Console # # OM_HOST - (optional) - Text # # Name or IP Address of your NetApp Management Console system # # OM_EVENT_GENERATE - (optional) - (Y|N) # # Setting which will enable event creation in NetApp Management Console # # OM_USER - (optional) - Text # # User name of an NetApp Management Console user which has privileges to create events # # OM_PWD - (optional) - Text # # Password of the NetApp Management Console user name # # OM_PORT - (optional) - Number # # The port to use for communications with NetApp Management Console; 8088 is the default HTTP port that the # # NetApp Management Console uses # # NTAP_OSSV_FS_SNAPSHOT - (optional) - (Y|N) # # Setting which enables ability to create file system snapshot. The file system snapshot command must be provided # # using the NTAP_OSSV_FS_SNAPSHOT_CREATE_CMD<#> parameter # # NTAP_OSSV_FS_SNAPSHOT_CREATE_CMD<#> - (optional) # # Script or command that takes a file system snapshot in use with ossv backup, where "#" is a number between # # 01-xx # # NTAP_OSSV_HOMEDIR - (optional) - Text # # The path to the OSSV home directory # # i. e.: /usr/snapvault # # NTAP_OSSV_ENABLE - (optional) - (Y|N) # # Setting which enables the Open Systems Snapvault (OSSV) integration. This option must be used in combination # # with the NTAP_OSSV_HOMEDIR parameter. OSSV is also required on the host running Snap Creator # # UMOUNT_CMD<#> - (optional) # # Umount commands to be used to mount file system for cloning or mount actions where "#" is a number 01-xx # # ARCHIVE_CMD<#> - (optional) # # The archive command command where "#" is a number 01-xx # # MOUNT_CMD<#> - (optional) # # Mount commands to be used to mount file system for cloning or mount actions where "#" is a number 01-xx # # APP_UNQUIESCE_CMD<#> - (optional) # # Script or command that takes your application out of backup mode, where "#" is a number between 01-xx # # APP_QUIESCE_CMD<#> - (optional) # # Script or command that puts your application into backup mode, where "#" is a number between 01-xx # # PRE_CLONE_CREATE_CMD<#> - (optional) # # The pre clone create command, where "#" is a number 01-xx # # PRE_RESTORE_CMD<#> - (optional) # # The pre restore command where "#" is a number 01-xx # # PRE_EXIT_CMD<#> - (optional) # # Command which will run before Snap Creator exists due to an error, i. e. you want to return application or # # backup into normal mode before Snap Creator exist due to an error. Where "#" is a number between 01-xx # # PRE_NTAP_CMD<#> - (optional) # # The pre netapp command where "#" is a number 01-xx # # PRE_APP_UNQUIESCE_CMD<#> - (optional) # # The pre application unquiesce command where "#" is a number 01-xx # # PRE_APP_QUIESCE_CMD<#> - (optional) # # The pre application quiesce command where "#" is a number 01-xx # # PRE_NTAP_CLONE_DELETE_CMD<#> - (optional) # # The pre netapp clone delete command where "#" is a number 01-xx # # POST_NTAP_DATA_TRANSFER_CMD<#> - (optional) # # The post data transfer command runs after SnapVault or SnapMirror transfer Where "#" is a number 01-xx. # # POST_RESTORE_CMD<#> - (optional) # # The post restore command where "#" is a number 01-xx # # POST_APP_QUIESCE_CMD<#> - (optional) # # The post application quiesce command where "#" is a number 01-xx # # POST_NTAP_CMD<#> - (optional) # # The post netapp command where "#" is a number 01-xx # # POST_CLONE_CREATE_CMD<#> - (optional) # # The post clone create command, where "#" is a number 01-xx # # POST_APP_UNQUIESCE_CMD<#> - (optional) # # The post application unquiesce command where "#" is a number 01-xx # # SUCCESS_MSG - (optional) - Text # # Upon snapcreator success will log the message you define and also send it to SENDTRAP, if SENDTRAP is defined # # NTAP_ASUP_ERROR_ENABLE - (optional) - (Y|N) # # Setting which enables SnapCreator error messages to also log an auto support message on the NetApp storage # # controller. Snap Creator will always create an info auto support message when the backup has started and # # completed # # SENDTRAP - (optional) - Text # # Command which interfaces with your monitoring software or email, allows you to pass alerts generated from # # SnapCreator into your own monitoring infrastructure. The %MSG variable is the message sent from Snap Creator # # SUCCESS_TRAP - (optional) - Text # # Command which interfaces with your monitoring software or email, allows you to pass the success message # # generated from SnapCreator into your own monitoring infrastructure. The %SUCCESS_MSG variable is the success # # message for Snap Creator # # SC_AGENT_UNQUIESCE_TIMEOUT - (optional) - Number - (\d+) # # Time to wait after a database quiesce operation to bring back the database into normal operation mode again. # # This is only available in combination with SC_AGENT_WATCHDOG_ENABLE set to Y # # SC_AGENT_WATCHDOG_ENABLE - (optional) - (Y|N) # # Snap Creator starts a watchdog process while quiescing the database. After the period specified with # # SC_AGENT_UNQUIESCE_TIMEOUT, the database will be brought into normal operation automatically. # # SC_AGENT - (optional) - Text - (([a-zA-Z][a-zA-Z0-9-_.]*|\d{1,3}.\d{1,3}.\d{1,3}.\d{1,3}|^ *$):(\d+)) # # Snap Creator has the capability to perform tasks on remote hosts. A task is either a defined module (parameter # # APP_NAME) or a command specified with the parameters *_CMD*, e. g. NTAP_SNAPSHOT_CREATE_CMD01 # # To specify a remote host, enter it's name or ip address followed by a colon and the port, the Snap Creator # # Agent listening on. # # On the remote host, start the Snap Creator Agent # # /snapcreator --start-agent # # If running in local mode, the parameter must be left blank. # # SC_AGENT_LOG_ENABLE - (optional) - (Y|N) # # Enables logging on the agent side. # # SC_AGENT_TIMEOUT - (optional) - Number - (\d+) # # The implemented client/server architecture uses a timeout mechanism. This means, if the client does not respond # # in the specified interval, the server fails with a timeout message. However, the task on the client is left # # untouched (will not be aborted) and needs further investigation. # # On server with high load or known, long running tasks like own scripts or complex SnapDrive operations it might # # be necessary to extend the timeout and adapt this value on your own needs. # # Per default, a timeout of 300 seconds is used. # # SC_CLONE_TARGET - (optional) - Text - (([a-zA-Z][a-zA-Z0-9-_.]*|\d{1,3}.\d{1,3}.\d{1,3}.\d{1,3}|^ *$):(\d+)) # # Snap Creator has the capability to perform clone operations. Using the action "clone_vol" in combination with # # {PRE|POST}_CLONE_CREATE_CMDxx to handle the storage objects on the remote side (e. g. mounting/unmounting # # filesytems), either the module is enabled to perform all the necessary activities to # # To specify a clone target, enter it's name or ip address followed by a colon and the port, the Snap Creator # # Agent listening on. # # APP_NAME - (optional) - Text # # Setting which determines which plug-in is being used. # # APP_CONF_PERSISTENCE - (optional) - (Y|N) # # If APP_AUTO_DISCOVERY is used configuration parameters can be changed dynamically. This setting allows any # # changes to be saved, meaning the configuration file updated dynamically. # # APP_IGNORE_ERROR - (optional) - (Y|N) # # If set to Y will cause Snap Creator to not exit when encountering an application error. An error message will # # be sent if SENDTRAP is configured but Snap Creator will not exit. This may be useful if you are backing up # # multiple databases and dont want a single database failure to stop the backup # # APP_DEFINED_RESTORE - (optional) - (Y|N) # # The normal cli restore interface will not be shown. Instead the plug-in is responsible for handling all restore # # activities including the restore of the snapshot copy. The built-in plug-ins do not support this type of a # # restore # # PYTHON_OPTS - (optional) - Text # # (Text) Setting for controlling the Python interpreter when executing native Python files. # # APP_DEFINED_CLONE - (optional) - (Y|N) # # The built-in cloning abilities of Snap Creator will be ignored. Instead the plug-in is responsible for handling # # all clone activities including vol or lun clone creation and deletion. The built-in plug-ins do not support # # this type of clone. # # JAVA_HOME - (optional) - Text # # (Text) Setting which points to the Java Virtual Machine which should be used for executing .class and .jar # # files. If set, $JAVA_HOME/bin/java will be used, otherwise just java to run the .class/.jar file. # # PYTHON_HOME - (optional) - Text # # (Text) Setting which points to the Python interpreter which should be used for executing .py files. If set, # # $PYTHON_HOME/python will be used, otherwhise just python to run the .py file. # # FS_NAME - (optional) - Text # # Setting which determines which FS plug-in is being used. # # JVM_ARGS - (optional) - Text # # (Text) Setting for controlling the Java Virtual Machine when executing native Java .class or .jar files. The # # default setting is "-Xms32M -Xmx128M". # # PERL_OPTS - (optional) - Text # # (Text) Setting for controlling the Perl interpreter when executing native Perl files. Options for settings # # additional include directories (-I) etc. can be passed to the Perl interpreter. # # PERL_HOME - (optional) - Text # # (Text) Setting which points to the Perl interpreter which should be used for executing .pl files. If set, # # $PERL_HOME/bin/perl will be used, otherwise just perl to run the .pl file # # PLUGINS_FORWARD - (optional) # # Plugins forward order for quiesce and discovey steps. # # VALIDATE_VOLUMES - (optional) # # Snap Creator validates that all volumes where the database resides are in fact part of the backup. Currently, # # there are some limitations. Only NFS is supported with this option. Currently, this option only checks data # # files only for the above databases. Going forward, support for more data types like LOG will be added. # # APP_AUTO_DISCOVERY - (optional) - (Y|N) # # Similar to APP_DEFINED _RESTORE this parameter allows the plug-in to handle application discovery. As with # # restore the plug-in must handle this operation itself # # JAVA_CLASSPATH - (optional) - Text # # (Text) Setting which defines the Java classpath. Per default, plugins/native is configured and can be completed # # with this environment variable, which will be appended to the default. # # PLUGINS_RESTORE - (optional) # # Plugins order for restore operations. # # i. e.: VSC,HOST,ORACLE # # APP_DEFINED_BACKUP - (optional) - (Y|N) # # (Y|N) The application plugin will be expected to perform entire backup operation including quiesce, Snapshot # # copy, and unquiesce. The built-in plugins do not support this kind of backup. # # APP_DEFINED_UMOUNT - (optional) - (Y|N) # # The built-in umount abilities of Snap Creator will be ignored. Instead the plug-in is responsible for handling # # all umount activities. # # PLUGINS_REVERSE - (optional) # # Plugins reverse order for unquiesce and cleanup steps. # # APP_DEFINED_MOUNT - (optional) - (Y|N) # # The built-in mount abilities of Snap Creator will be ignored. Instead the plug-in is responsible for handling # # all mount activities. # # ARCHIVE_LOG_DIR - (optional) - Text # # Path to where the archive logs are stored # # ARCHIVE_LOG_RECURSIVE_SEARCH - (optional) - (Y|N) # # to be filled # # ARCHIVE_LOG_EXT - (optional) - Text # # File Extension for the archive logs, must be . ie # # ARCHIVE_LOG_RETENTION - (optional) - Number # # Retention in Days for how long archive logs should be kept # # ARCHIVE_LOG_ENABLE - (optional) - Text # # Setting which Enables Archive Log Management (deletion of old archive logs) # ######################################################################################################################## CONFIG_TYPE=STANDARD VOLUMES=is set META_DATA_VOLUME= LOG_NUM=30 SNAPDRIVE=N SNAPDRIVE_DISCOVERY=N LOG_TRACE_ENABLE=N USE_PROXY=N NTAP_PWD_PROTECTION=Y NTAP_TIMEOUT=120 USE_GLOBAL_CONFIG=N FEDERATED_APPLICATIONS= ALLOW_IP_ADDR=Y SC_TMP_DIR= ######################################################################################################################## # Connection Options # ######################################################################################################################## MANAGEMENT_INTERFACES= NTAP_USERS=is set PORT=443 TRANSPORT=HTTPS SECONDARY_INTERFACES= ######################################################################################################################## # CMode Options # ######################################################################################################################## CMODE_CLUSTER_NAME= CMODE_CLUSTER_USERS= CMODE_SNAPSHOT_FORCE_DELETE=Y CMODE_SET=N ######################################################################################################################## # Snapshot Options # ######################################################################################################################## SNAME=lza_teasy_kdvres081_daily SNAP_TIMESTAMP_ONLY=Y NTAP_SNAPSHOT_POLICIES= NTAP_USE_EXTERNAL_SNAPSHOT=N NTAP_SNAPSHOT_NODELETE=N NTAP_CONSISTENCY_GROUP_TIMEOUT=MEDIUM NTAP_SNAPSHOT_RETENTIONS=DAILY:7,MONTHLY:0,HOURLY:0,WEEKLY:0 NTAP_SNAPSHOT_CREATE_CMD01= NTAP_CONSISTENCY_GROUP_WAFL_SYNC=N NTAP_CONSISTENCY_GROUP_SNAPSHOT=N NTAP_SNAPSHOT_RETENTION_AGE= NTAP_METADATA_SNAPSHOT_CREATE_CMD= NTAP_SNAPSHOT_DELETE_BY_AGE_ONLY=N NTAP_SNAPSHOT_DEPENDENCY_IGNORE=N NTAP_SNAPSHOT_RESTORE_AUTO_DETECT=N NTAP_SNAPSHOT_DISABLE=N NTAP_SNAPSHOT_LABEL= NTAP_EXTERNAL_SNAPSHOT_REGEX=.* ALLOW_DUPLICATE_SNAME=N NTAP_SNAPSHOT_CLEANUP=N ######################################################################################################################## # SnapVault Options # ######################################################################################################################## NTAP_SNAPVAULT_UPDATE=N NTAP_SNAPVAULT_NODELETE=N SNAPVAULT_QTREE_INCLUDE= NTAP_SNAPVAULT_RESTORE_WAIT=N NTAP_SNAPVAULT_RETENTION_AGE= NTAP_SNAPVAULT_SNAPSHOT=N NTAP_SNAPVAULT_MAX_TRANSFER= NTAP_SNAPVAULT_WAIT=0 NTAP_SNAPVAULT_RETENTIONS= SNAPVAULT_VOLUMES= ######################################################################################################################## # SnapMirror Options # ######################################################################################################################## NTAP_SNAPMIRROR_WAIT=60 NTAP_SNAPMIRROR_USE_SNAPSHOT=N NTAP_SNAPMIRROR_MAX_TRANSFER= SNAPMIRROR_VOLUMES= SNAPMIRROR_CASCADING_VOLUMES= NTAP_SNAPMIRROR_CASCADING_UPDATE=N NTAP_SNAPMIRROR_UPDATE=N ######################################################################################################################## # Clone Options # ######################################################################################################################## NTAP_CLONE_IGROUP_MAP= NTAP_LUN_CLONE_RESERVATION=N NTAP_CLONE_SECONDARY_VOLUMES= NTAP_NFS_EXPORT_ACCESS=read-only NTAP_NUM_VOL_CLONES=1 NTAP_NFS_EXPORT_PERSISTENT=N NTAP_CLONE_FOR_BACKUP=N NTAP_CLONE_SECONDARY=N NTAP_CIFS_EXPORT_ENABLE=N NTAP_NFS_EXPORT_HOST= NTAP_VOL_CLONE_RESERVE=NONE ######################################################################################################################## # ProtectionManager Options # ######################################################################################################################## NTAP_DFM_DATA_SET= NTAP_PM_RUN_BACKUP=N NTAP_PM_UPDATE=Y NTAP_DFM_SNAPSHOT_FORMAT= ######################################################################################################################## # OperationsManager Options # ######################################################################################################################## OM_TRANSPORT=HTTPS OM_HOST=is set OM_EVENT_GENERATE=N OM_USER=is set OM_PWD=is set OM_PORT=8488 ######################################################################################################################## # OSSV Options # ######################################################################################################################## NTAP_OSSV_FS_SNAPSHOT= NTAP_OSSV_FS_SNAPSHOT_CREATE_CMD01= NTAP_OSSV_HOMEDIR= NTAP_OSSV_ENABLE=N ######################################################################################################################## # APP Commands # ######################################################################################################################## UMOUNT_CMD01= ARCHIVE_CMD01= MOUNT_CMD01= APP_UNQUIESCE_CMD01=D:\MySQL57\bin\mysql -uroot -proot -e "unlock tables" APP_QUIESCE_CMD01=D:\MySQL57\bin\mysql -uroot -proot -e "flush tables with read lock" APP_QUIESCE_CMD02=D:\MySQL57\bin\mysql -uroot -proot -e "flush logs" ######################################################################################################################## # Pre Commands # ######################################################################################################################## PRE_CLONE_CREATE_CMD01= PRE_RESTORE_CMD01= PRE_EXIT_CMD01= PRE_NTAP_CMD01= PRE_APP_UNQUIESCE_CMD01= PRE_APP_QUIESCE_CMD01= PRE_NTAP_CLONE_DELETE_CMD01= ######################################################################################################################## # Post Commands # ######################################################################################################################## POST_NTAP_DATA_TRANSFER_CMD01= POST_RESTORE_CMD01=net stop mysql57 POST_RESTORE_CMD02=net start mysql57 POST_APP_QUIESCE_CMD01= POST_NTAP_CMD01= POST_CLONE_CREATE_CMD01= POST_APP_UNQUIESCE_CMD01= ######################################################################################################################## # Event Options # ######################################################################################################################## SUCCESS_MSG=INFO: NetApp Snap Creator Framework finished successfully "(Action: %ACTION) (Config: %CONFIG_NAME)" NTAP_ASUP_ERROR_ENABLE=N SENDTRAP= SUCCESS_TRAP= ######################################################################################################################## # Agent Options # ######################################################################################################################## SC_AGENT_UNQUIESCE_TIMEOUT=30 SC_AGENT_WATCHDOG_ENABLE=N SC_AGENT=194.113.125.81:9090 SC_AGENT_LOG_ENABLE=Y SC_AGENT_TIMEOUT=35 ######################################################################################################################## # Clone Target Options # ######################################################################################################################## SC_CLONE_TARGET= ######################################################################################################################## # Application Options # ######################################################################################################################## APP_NAME= APP_CONF_PERSISTENCE=Y APP_IGNORE_ERROR=Y APP_DEFINED_RESTORE=N PYTHON_OPTS= APP_DEFINED_CLONE=N JAVA_HOME= PYTHON_HOME= FS_NAME= JVM_ARGS= PERL_OPTS= PERL_HOME= PLUGINS_FORWARD= VALIDATE_VOLUMES= APP_AUTO_DISCOVERY=N JAVA_CLASSPATH= PLUGINS_RESTORE= APP_DEFINED_BACKUP=N APP_DEFINED_UMOUNT=N PLUGINS_REVERSE= APP_DEFINED_MOUNT=N ######################################################################################################################## # Archive Options # ######################################################################################################################## ARCHIVE_LOG_DIR= ARCHIVE_LOG_RECURSIVE_SEARCH=N ARCHIVE_LOG_EXT= ARCHIVE_LOG_RETENTION= ARCHIVE_LOG_ENABLE= ######################################################################################################################## # Plug-In Parameter # ######################################################################################################################## HOST=localhost MASTER_SLAVE=N MYSQL_DATABASES=mysql:3306;performance_schema:3306;sys:3306 and other db in original file