Skip to main content
Snap Creator Framework

Snap Creator CLI commands for workflow actions

Contributors netapp-barbe netapp-aherbin NetAppZacharyWambold
PDFs

You can use command-line interface (CLI) commands to perform various Snap Creator workflow actions that are based on the graphical user interface (GUI).

The following table provides the CLI commands for performing Snap Creator GUI-based workflow actions:

Workflow area Action/description Command and associated parameters

Backups

Create a backup copy. Performs a backup operation based on the configuration file associated with the profile.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action backup
--policy Policy
--verbose

Create an Open Systems SnapVault backup. Performs a backup operation using Open Systems SnapVault. This requires Snap Creator Agent. Snap Creator Server communicates with Snap Creator Agent and performs a SnapVault update. No primary backup copy is made.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action ossv
--policy Policy
--verbose

Delete a backup copy (manually). Manually deletes an existing backup. This operation is menu-driven.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action backupDel
--policy Policy
--verbose

Delete a backup copy (automatically).

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action backupDel
--policy Policy
--verbose
--nonInteractive
--cntName controller
--volName volume
--backupName name

List backup copies. Lists the Snap Creator backup copies on the primary and secondary storage systems.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action backupList
--policy Policy
--verbose

Mount a backup copy. Performs the mount operation on an existing backup. Creates a volume clone based on the backup, and enables the mounting of the clone through Snap Creator Agent using the MOUNT_CMD command.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action mount
--backupName name
--verbose

Unmount a backup copy. Performs the unmount operation on an existing backup. Deletes a volume clone based on the backup, and enables the unmounting of the clone through Snap Creator Agent using the UMOUNT_CMDs command.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action umount
--backupName name
--verbose

Backup types

Create a new backup type.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action backupTypeAdd
--backupTypeName name
--verbose

Update an existing backup type.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action backupTypeUpdate
--backupTypeId 1
--backupTypeName name
--verbose

Delete an existing backup type.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action backupTypeDelete
--backupTypeId 1
--verbose

List the backup types.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action backupTypeList
--verbose

Clones

Clone a LUN. Backs up the primary storage system and then clones the backup using a LUN clone. The volume mapping of igroups is also handled. This requires a SAN or iSAN environment.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action cloneLun
--policy Policy
--verbose

Clone a volume. Backs up the primary storage system and then clones the backup using a volume clone. The volume mapping of igroups, NFS, or CIFS is also handled. This requires a SAN, iSAN, or NAS environment.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action cloneVol
--policy Policy
--verbose

Delete a clone. Performs a clone deletion operation based on the specified retention policy. Only one copy of the LUN clone is retained. Volume clones have policy-associated usage.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action cloneDel
--policy Policy
--verbose

List Snap Creator clones. Lists the Snap Creator volume clones for the given configuration.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action cloneList
--verbose

List Snap Creator volumes. Lists the Snap Creator volumes for the specified configuration on the primary storage system.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action volumeList
--verbose

Configuration files

Import a configuration.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action configImport
--importFile file_path
--verbose

Export a configuration.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action configExport
--exportFile file_path
--verbose

Import a global configuration file.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action globalImport
--importFile file_path
--verbose

Export a global configuration file.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action globalExport
--ExportFile file_path
--verbose

Delete a global configuration file from the repository.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action globalDelete
--verbose

Import a global configuration file for a particular profile to the repository.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--action profileglobalImport
--importFile file_path
--verbose

Export a global configuration file for a particular profile from the repository.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--action profileglobalExport
--exportFile file_path
--verbose

Delete a global configuration for a particular profile from the repository.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--action profileglobalDelete
--verbose

Upgrade older configuration files in a profile. Adds newly introduced parameters to older configuration files. Before executing this command, all old configuration files must be copied to the scServer/engine/configs folder along with the profile folder.

 
snapcreator
--server IP
--port port
--user userid
--passwd password
--upgradeConfigs
--profile profile_name
--verbose

Jobs

List all jobs and their status.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action jobStatus
--verbose

Policy

Add a new local policy.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action policyAdd
--schedId 1
--backupTypeId 1
--policyType local
--policyName testPolicy
--primaryCount 7
--primaryAge 0
--verbose

Add a new SnapMirror policy.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action policyAdd
--schedId 1
--backupTypeId 1
--policyType snapmirror
--policyName testPolicy
--primaryCount 7
--primaryAge 0
--verbose

Add a new SnapVault policy.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action policyAdd
--schedId 1
--backupTypeId 1
--policyType snapvault
--policyName testPolicy
--primaryCount 7
--primaryAge 0
--secondaryCount 30
--secondaryAge 0
--verbose

Update a SnapMirror policy.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action policyUpdate
--policyId 1
--schedId 1
--backupTypeId 1
--policyType snapmirror
--policyName testPolicy
--primaryCount 7
--primaryAge 0
--verbose

Update a SnapVault policy.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action policyUpdate
--policyId 1
--schedId 1
--backupTypeId 1
--policyType snapvault
--policyName testPolicy
--primaryCount 7
--primaryAge 0
--secondaryCount 30
--secondaryAge 0
--verbose

Delete a policy.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action policyDelete
--policyId 1
--verbose

List all policies.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action policyList
--verbose

Show additional details for a particular policy.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action policyDetails
--policyId 1
--verbose

Assign policies to a profile.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--action policyAssignToProfile
--policies testPolicy
--verbose

Undo the assignment of policies for a profile.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--action policyUnassignFromProfile
--verbose

List all policies assigned to a profile.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--action policyListForProfile
--verbose

Policy schedules

Create an hourly policy schedule.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action policySchedAdd
--schedName HourlyBackup
--schedFreqId 2
--schedActionId 1
--schedMin minute
--schedActive true
--verbose

Create a daily policy schedule.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action policySchedAdd
--schedName DailyBackup
--schedFreqId 3
--schedActionId 1
--schedHour hour
--schedMin minute
--schedActive true
--verbose

Create a weekly policy schedule.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action policySchedAdd
--schedName WeeklyBackup
--schedFreqId 4
--schedActionId 1
--schedDayOfWeek day_of_week
--schedHour hour
--schedMin minute
--schedActive true
--verbose

Create a cron policy schedule.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action policySchedAdd
--schedName CronBackup
--schedFreqId 5
--schedActionId 1
--schedCron '0 0/5 14,18 * * ?'
--schedActive true
--verbose

Update an hourly policy schedule.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action policySchedUpdate
--schedId 1
--schedName HourlyBackup
--schedFreqId 2
--schedActionId 1
--schedMin minute
--schedActive true
--verbose

Update a daily policy schedule.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action policySchedUpdate
--schedId 1
--schedName DailyBackup
--schedFreqId 3
--schedActionId 1
--schedHour hour
--schedMin minute
--schedActive true
--verbose

Update a weekly policy schedule.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action policySchedUpdate
--schedId 1
--schedName WeeklyBackup
--schedFreqId 4
--schedActionId 1
--schedDayOfWeek day_of_week
--schedHour hour
--schedMin minute
--schedActive true
--verbose

Update a cron policy schedule.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action policySchedUpdate
--schedId 1
--schedName CronBackup
--schedFreqId 5
--schedActionId 1
--schedCron '0 0/5 14,18 * * ?'
--schedActive true
--verbose

Delete a policy schedule.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action policySchedDelete
--schedId 1
--verbose

List policy schedules.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action policySchedList
--verbose

Show additional information about a policy schedule.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action policySchedDetails
--schedId 1
--verbose

Profiles

Create a new profile.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--action profileCreate
--verbose

Delete a profile. Note: The configuration files in the profile are also deleted.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--action profileDelete
--verbose

Restore

Perform interactive restore. Performs an interactive file restore operation or an interactive volume restore operation for a given policy.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action restore
--policy Policy
--verbose

Perform non-interactive volume restore. Performs a non-interactive volume restore.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action restore
--policy Policy
--verbose
--nonInteractive
--cntName controller
--volName volume
--backupName name

Perform non-interactive file restore. Performs a non-interactive file restore.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action restore
--policy Policy
--verbose
--nonInteractive
--cntName controller
--volName volume
--backupName name
--fileNames file_path1,file_path2,etc.

Schedules

Create a new hourly schedule.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action schedCreate
--policy Policy
--schedName HourlyBackup
--schedFreqId 2
--schedActionId 1
--schedMin minute
--schedActive true
--schedStartDate date
--verbose

Create a new daily schedule.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action schedCreate
--policy Policy
--schedName DailyBackup
--schedFreqId 3
--schedActionId 1
--schedHour hour
--schedMin minute
--schedActive true
--schedStartDate date
--verbose

Create a new weekly schedule.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action schedCreate
--policy Policy
--schedName WeeklyBackup
--schedFreqId 4
--schedActionId 1
--schedDayOfWeek day_of_week
--schedHour hour
--schedMin minute
--schedActive true
--schedStartDate date
--verbose

Create a new cron schedule.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action schedCreate
--policy Policy
--schedName CronBackup
--schedFreqId 5
--schedActionId 1
--schedCron "0 0/5 14,18 * * ?"
--schedActive true
--schedStartDate date
--verbose

Run a schedule.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action schedRun
--schedId 1
--verbose

Delete a schedule.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action schedDelete
--schedId 10
--verbose

Update an hourly schedule.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action schedUpdate
--policy Policy
--schedName HourlyBackup
--schedFreqId 2
--schedId 1
--schedActionId 1
--schedMin minute
--schedActive true
--schedStartDate date
--verbose

Update a daily schedule.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action schedUpdate
--policy Policy
--schedName DailyBackup
--schedFreqId 3
--schedId 1
--schedActionId 1
--schedHour hour
--schedMin minute
--schedActive true
--schedStartDate date
--verbose

Update a weekly schedule.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action schedUpdate
--policy Policy
--schedName WeeklyBackup
--schedFreqId 4
--schedId 1
--schedActionId 1
--schedDayOfWeek day_of_week
--schedHour hour
--schedMin minute
--schedActive true
--schedStartDate date
--verbose

Update a cron schedule.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action schedUpdate
--policy Policy
--schedName CronBackup
--schedFreqId 5
--schedId 1
--schedActionId 1
--schedCron "0 0/5 14,18 * * ?"
--schedActive true
--schedStartDate date
--verbose

List all schedules.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action schedList
--verbose

List supported scheduler actions.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action schedActionList
--verbose

List supported scheduler frequencies.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action schedFreqList
--verbose

Show additional details for a schedule ID.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action schedDetails
--schedId 1
--verbose

scdump

Create an scdump file.Dumps logs, configuration files, and support information about a particular profile in a .zip file called scdump located under the Snap Creator root directory.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
-- profile Profile
--config Config
--action scdump
--policy Policy
--verbose

Snap Creator Server and Agent

List the status for all agents known to the Snap Creator Server.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action agentStatus
--verbose

Ping a Snap Creator Server.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action pingServer
--verbose

Ping a Snap Creator Agent.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--action pingAgent
--agentName host_name
--agentPort port
--verbose

Archive

Perform archive log management according to the settings in the configuration file. This operation requires Snap Creator Agent.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action arch
--verbose

Data protection capability

Configure the NetApp Management Console data protection capability dataset for a given configuration.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action pmsetup
--verbose

Show the data protection status of the SnapVault and SnapMirror relationship for a controller. If SnapVault or SnapMirror is not configured, the results are not displayed.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action dpstatus
--verbose

Quiesce/unquiesce

Perform the quiesce operation for a given application. This operation requires Snap Creator Agent.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action quiesce
--verbose

Perform the unquiesce operation for a given application. This operation requires Snap Creator Agent.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action unquiesce
--verbose

Discover

Perform discovery for a given application. This operation requires Snap Creator Agent.

 
snapcreator
--server IP
--port Port
--user User
--passwd Password
--profile Profile
--config Config
--action discover
--verbose