Skip to main content
Snap Creator Framework

Parameters for setting up Snapshot copies

Contributors NetAppZacharyWambold netapp-aherbin

Several configuration file parameters are required to set up Snapshot copies for Snap Creator Server.

Parameter Setting Description

NTAP_SNAPSHOT_ RETENTION_AGE

Enables you to define the retention age (in days) for Snapshot copies. If configured, Snapshot copies are deleted only if they exceed the number defined in theNTAP_SNAPSHOT_ RETENTIONS parameter, and if they are older than the retention age (in days).

SNAPDRIVE

“Y” or “N”

Enables you to use SnapDrive instead of the Data ONTAP API to create a Snapshot copy.

SNAPDRIVE_DISCOVERY

“Y” or “N”

Enables you to use SnapDrive for storage discovery. This is required in a SAN or an iSAN environment when using the VALIDATE_VOLUMES parameter.

NTAP_SNAPSHOT_ DISABLE

“Y” or “N”

Disables Snap Creator from creating a Snapshot copy so that Snap Creator can handle SnapVault or SnapMirror for SnapManager. For this setting to work, the SnapManager Snapshot copies must follow this naming convention: snapshot_copy_name-policy_recent.

NTAP_SNAPSHOT_ NODELETE

“Y” or “N”

Overrides the NTAP_SNAPSHOT_RETENTIONS parameter, and prevents Snapshot copies from being deleted. Enabling this variable can make the volume full.

NTAP_SNAPSHOT_DELETE_CMD

Deletes snapshots through SnapDrive instead of Snap Creator based on snapshot retention.Note: All the volumes (mount drives) used in this Snapdrive command for snapshot deletion should be included the configuration file as well.

NTAP_SNAPSHOT_DELETE_BY_AGE_ONLY

(PRIMARY

SECONDARY

BOTH

N)

Enables the deletion of old Snapshot copies. This parameter requires the NTAP_SNAPSHOT_RETENTION_AGE parameter, and forces deletion based on Snapshot copy age rather than the number of Snapshot copies.

NTAP_SNAPSHOT_DEPENDENCY_IGNORE

“Y” or “N”

Applies only to Snapshot copy deletion using the backupDel action. Manually deletion of Snapshot copies with a dependency is not permitted.

NTAP_SNAPSHOT_ CREATE_CMD ##

Creates a Snapshot copy and flushes the file system buffers; ## is a number from 1 to 99. Note: This setting is required if you enable the SNAPDRIVE parameter. The Data ONTAP API is still used to perform everything else, but the SNAPDRIVE option creates Snapshot copies.

NTAP_ METADATA_SNAPSHOT_ CREATE_CMD ##

Creates the metadata volume Snapshot copy, and flushes the file system buffers; ## is a number from 1 to 99.

NTAP_CONSISTENCY_ GROUP_SNAPSHOT

“Y” or “N”

Enables the use of consistency groups for creating consistent Snapshot copy across multiple volumes.

NTAP_CONSISTENCY_ GROUP_SNAPSHOT_RETRY_COUNT

Specifies the number of times a consistency group Snapshot should be retried in case of failure.

NTAP_CONSISTENCY_ GROUP_SNAPSHOT_RETRY_WAIT

Time (in seconds)

Specifies the time to wait between each retry of a consistency group Snapshot.

NTAP_CONSISTENCY_ GROUP_TIMEOUT

(URGENT

MEDIUM

RELAXED)

Specifies the wait time for the storage controller to consistently group Snapshot copies.

NTAP_CONSISTENCY_GROUP_WAFL_SYNC

“Y” or “N”

Improves the performance of a consistency group Snapshot copy by forcing a consistency point (CP) through a wafl-sync before the cg-start. Note: If you are performing consistency group backup with the DB2 plug-in, you must set this parameter to “N”.

NTAP_SNAPSHOT_RESTORE_AUTO_DETECT

“Y” or “N”

If disabled, this setting always forces a Single File SnapRestore (SFSR) when performing a single file restore.

NTAP_SNAPSHOT_CLEANUP

“Y” or “N”

Removes any Snapshot copies that were created in the event of backup failure.

NTAP_USE_EXTERNAL_SNAPSHOT

“Y” or “N”

Enables the import of a non-Snap Creator Snapshot copy. The most recent Snapshot copy is matched.

NTAP_EXTERNAL_SNAPSHOT_REGEX