Skip to main content
Snap Creator Framework

Snap Creator variable and parameter descriptions

Contributors netapp-aherbin NetAppZacharyWambold
PDFs

Snap Creator includes built-in variables and parameters required in a basic configuration.

Variables Description

%SNAP_TYPE

Used when you run Snap Creator and it is your retention policy (daily, weekly, monthly)

%SNAP_TIME

The timestamp (YYYYMMDDhhmmss) used in the naming of Snapshot copies to create a guaranteed unique name for every Snapshot copy. It is also used to name the backup reports and Sybase transaction logs.

%ACTION

The list of actions you can perform when you run Snap Creator: (backup

cloneVol

cloneLun

arch

restore

backupDel

backupList

cloneList

pmsetup

ossv)

%MSG

Used to send an error message to another program such as email or Tivoli It can only be used with the SENDTRAP function.

%USER_DEFINED

The following table lists and describes the Snap Creator parameters used in a basic configuration:

Parameter

Setting

Description

SNAME

Specifies the Snapshot copy naming convention It should be unique. Snapshot copies are deleted according to the naming convention.

SNAP_TIMESTAMP_ONLY

(Y

N)

Sets the Snapshot naming conventionIf set to Y, Snapshot copies end with YYYYMMDDHHMMSS. Otherwise, new Snapshot copies are renamed to end with YYYYMMDDHHMMSS.

VOLUMES

Lists the primary storage controllers and volumes of which you want to create a Snapshot copy For example:

controller1:vol1,vol2,vol3;
controller2:vol1;
controller3:vol2,vol3

VOLUME_GROUPS

vol_1,vol_2,vol_n

Defines multiple volumes into a single group. Multiple volumes are specified as a comma-separated listFor example:

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
Note VOLUME_GROUPS is only supported for backup operations. If this parameter is set, then the VOLUMES parameter will be ignored during the backup.

NTAP_SNAPSHOT_RETENTIONS

Determines the number of Snapshot copies to be retained for a given policyFor example:

daily:7,weekly:4,monthly:1

NTAP_USERS

Lists the storage systems and their corresponding user names and passwordsFor example:

controller1:joe/password1;
controller2:bob/password2;
controller3:ken/password3
Note Password must contain a minimum of two characters.

NTAP_PWD_PROTECTION

(Y

N)

Enables or disables password protection You must encrypt all passwords (storage system and applications or plug-ins) and save encrypted passwords in configuration file.

TRANSPORT

HTTP

HTTPS

Enables you to use either HTTP or HTTPS to connect to the storage controllerNote: HTTPS might require openssl-devel libraries.

PORT

Configures the port number the storage controllers use; normally: 80 and 443

LOG_NUM

Specifies the number of .debug and .out reports that Snap Creator has to retain

CONFIG_TYPE

PLUGIN

STANDARD

Specifies the configuration typeThere are two types of configurations: plug-in and standard. You can use multiple plug-in configurations to build complex quiesce and unquiesce backup workflows.

CMODE_CLUSTER_USERS

(Required for clustered Data ONTAP) Lists the primary and secondary clustered Data ONTAP clusters and their corresponding user names and passwordsFor example:

cluster1:joe/password1;
cluster2:bob/password2
Note Password must contain a minimum of two characters.

CMODE_CLUSTER_NAME

(Required for clustered Data ONTAP) Specifies the name of the primary clustered Data ONTAP cluster

CMODE_SNAPSHOT_FORCE_DELETE

(Y

N)

Ensures deletion of Snapshot copies that should be deleted based on the Snapshot copy policy In clustered Data ONTAP, Snapshot copies are not deleted if they have any dependencies, such as a clone.

LOG_TRACE_ENABLE

(Y

N)

Enables or disables logging of all events If disabled, the Manage ONTAP Solution result objects are not logged.

NTAP_TIMEOUT

Seconds

Sets the timeout value for all storage controller Manage ONTAP Solution calls; default is 60 seconds

USE_GLOBAL_CONFIG

(Y

N)

Enables you to use global configuration to store values

FEDERATED_APPLICATIONS

Lists the configuration and profile names for the federated applications under the configuration For example:

databases@db2;databases@oracle

CMODE_SET

(Y

N)

Defines whether the configuration is for clustered Data ONTAP or Data ONTAP operating in 7-Mode

ALLOW_DUPLICATE_SNAME

(Y

N)

(Optional) Enables or disables the ability to create a configuration file with a duplicate Snapshot name This parameter will not work with global (Super Global or Profile Global) configuration files.

SNAPCREATOR_MISSEDJOB_RUN

(Y

N)