Request doc changesEdit this pageLearn how to contribute
ON THIS PAGE
    • Product and Solutions
    • Support and Training
    • Cloud Central
    • Community
    • Blog
    • Customer Stories
    • Contact
    Menu bars
    netapp-mark netapp-logo
    English globe
    • English
    • 日本語
    • 한국어
    • 简体中文
    • 繁體中文
    • Deutsch
    • Español
    • Français
    • Italiano
    Available PDFs
    • PDF of this doc site
      • Installation
        • What Snap Creator Framework does
          • Snap Creator architecture
        • Preinstallation requirements for Snap Creator
          • Creating a Snap Creator user for Data ONTAP
          • Configuring settings for the Domino plug-in
            • Configuring UNIX-specific settings: Creating symbolic links
        • Installing the Snap Creator Server
          • Installing the Snap Creator Server on a Windows host
        • Installing the Snap Creator Agent
          • Installing Snap Creator Agent on Windows
        • Upgrading Snap Creator
          • Upgrading from Snap Creator 3.6.x
          • Upgrading from Snap Creator 4.0.x
          • Upgrading from Snap Creator 4.1.x
        • Uninstalling Snap Creator
          • Uninstalling Snap Creator on UNIX
        • CLI reference
          • CLI commands for creating a role for a Snap Creator user in clustered Data ONTAP
      • IBM® Domino® Plug-in Operations
        • IBM Domino plug-in overview
        • Preparing for IBM Domino backup and restore
          • SnapMirror and SnapVault setup
        • Creating a backup and restore configuration
          • Adding commands to the backup and restore configuration
        • Backing up databases
        • Restoring databases
          • Performing a single-file restore in a SAN environment
        • Viewing job status and logs
      • SAP HANA® Plug-in Operations
        • SAP HANA backup and restore solution overview
        • Installing and configuring required software components
        • Configuring data backups
          • Starting the SnapVault relationships
        • Configuring log backups
        • Executing database backups
        • SAP HANA File-Based Backup and Database Integrity Checks
        • Restoring and recovering SAP HANA databases
          • Resuming a SnapVault relationship after a restore
          • Restoring databases after primary storage failure
      • Administration
        • What Snap Creator Framework does
        • Snap Creator architecture
        • Managing Snap Creator Server
        • Managing Snap Creator Agent
          • Snap Creator Agent security
        • Backup and recovery workflow
          • Creating retention policies
          • Creating clones
          • Performing restore operations
        • Managing user access
        • Managing profiles
        • Managing configuration files
        • Managing retention policies
        • Managing backups
        • Managing scheduled jobs
        • Managing clones
        • Plug-in information required to configure Snap Creator
          • VMware VIBE plug-in
        • Troubleshooting Snap Creator issues
          • Types of error messages and troubleshooting logs
          • Troubleshooting Snap Creator GUI errors
          • Troubleshooting security issues
          • Troubleshooting Snap Creator Server or Snap Creator Agent issues
          • Troubleshooting CLI command errors
          • Error messages
        • Snap Creator configuration file variables, parameters, and commands
        • Guidelines for using the Snap Creator command-line interface 
    Collection of separate PDF docs

    Creating your file...

    This may take a few minutes. Thanks for your patience.
    Your file is ready
    • Home
    • Release notes
    • Installation
      • What Snap Creator Framework does
        • Snap Creator architecture
          • Snap Creator Server
          • Snap Creator Agent
          • Plug-ins for application integration
      • Preinstallation requirements for Snap Creator
        • Snap Creator installation and configuration requirements
        • Downloading the Snap Creator software
        • Creating a Snap Creator user for Data ONTAP
          • Creating a Snap Creator user for Data ONTAP operating in 7-Mode
          • Creating a Snap Creator user for clustered Data ONTAP
        • Installing Java on Snap Creator hosts
        • Synchronizing time on Snap Creator Server and Agent hosts
        • Configuring settings for the Domino plug-in
          • Configuring Windows-specific settings: Adding path to the environment variables
          • Configuring UNIX-specific settings: Creating symbolic links
            • Creating symbolic links for the Domino plug-in on Linux and Solaris hosts
            • Creating symbolic links for the Domino plug-in on AIX hosts
      • Installing the Snap Creator Server
        • Installing the Snap Creator Server on a Windows host
          • Starting the Server from a command prompt
        • Installing the Snap Creator Server on UNIX-based systems
      • Installing the Snap Creator Agent
        • Installing Snap Creator Agent on Windows
          • Starting the Agent from a command prompt
        • Installing the Snap Creator Agent on UNIX-based systems
        • Changing the Snap Creator Agent port after installation
      • Upgrading Snap Creator
        • Checking job monitor size
        • Upgrading from releases earlier than Snap Creator 3.6
        • Upgrading from Snap Creator 3.6.x
          • Upgrading the Snap Creator Server 3.6.x on Windows
          • Upgrading the Snap Creator Server 3.6.x on UNIX-based systems
          • Upgrading Snap Creator Agent 3.6.x on Windows
          • Upgrading the Snap Creator Agent 3.6.x on UNIX
        • Upgrading from Snap Creator 4.0.x
          • Upgrading Snap Creator Server 4.0.x on Windows
          • Upgrading Snap Creator Server 4.0.x on UNIX-based systems
          • Upgrading Snap Creator Agent 4.0.x on Windows
          • Upgrading the Snap Creator Agent 4.0.x on UNIX
        • Upgrading from Snap Creator 4.1.x
          • Upgrading Snap Creator Server 4.1.x on Windows
          • Upgrading Snap Creator Server 4.1.x on UNIX-based systems
          • Upgrading Snap Creator Agent 4.1.x on Windows
          • Upgrading Snap Creator Agent 4.1.x on UNIX-based systems
        • Upgrading from Snap Creator 4.3.x
      • Uninstalling Snap Creator
        • Uninstalling Snap Creator on Windows
        • Uninstalling Snap Creator on UNIX
          • Uninstalling Snap Creator Agent on UNIX
          • Uninstalling Snap Creator Server on UNIX
      • CLI reference
        • CLI commands for creating a role for a Snap Creator user in clustered Data ONTAP
          • CLI commands for creating cluster roles
          • CLI commands for creating SVM roles
    • IBM® Domino® Plug-in Operations
      • IBM Domino plug-in overview
        • Understanding IBM Domino plug-in backup operations
        • Understanding IBM Domino plug-in restore operations
      • IBM Domino backup and recovery workflow
      • Preparing for IBM Domino backup and restore
        • Storage layout requirements
        • SnapMirror and SnapVault setup
          • Preparing storage systems for SnapMirror replication
          • Preparing storage systems for SnapVault replication
      • Creating a backup and restore configuration
        • Logging in to the Snap Creator GUI
        • Creating a configuration file
        • Adding commands to the backup and restore configuration
          • Allowing supplemental commands on the Snap Creator Agent
          • Adding supplemental commands to the configuration
        • Cleaning up archived copies of Domino transaction logs
        • Backing up the changeinfo directory
      • Backing up databases
        • Backing up databases on demand
        • Scheduling backups
      • Restoring databases
        • Performing a volume restore
        • Performing a single-file restore
        • Performing a single-file restore in a SAN environment
          • Using SnapDrive to mount a Snapshot copy
          • Copying the file to the Data Restore Directory
          • Using a Snap Creator custom action to complete restore processing
          • Disconnecting the Snapshot Copy
      • Viewing job status and logs
        • Viewing job status and logs in the Job Monitor
        • Viewing logs in the Reports pane
        • Using scdump to gather logs in a compressed format
      • Troubleshooting Domino plug-in-specific errors
      • Where to go next
    • SAP HANA® Plug-in Operations
      • SAP HANA backup and restore solution overview
        • Considerations for backing up SAP HANA systems
        • The NetApp solution
        • Backup solution components
        • SAP HANA plug-in overview
        • Requirements
      • Installing and configuring required software components
        • Setup assumptions in this guide
        • Setup used with clustered Data ONTAP
      • Configuring data backups
        • Configuring the backup user and hdbuserstore
        • Configuring SnapVault relationships
        • Starting the SnapVault relationships
          • Starting the SnapVault relationships with Data ONTAP operating in 7-Mode
          • Starting the SnapVault relationships with clustered Data ONTAP
        • Configuring the Snap Creator Framework and SAP HANA database backup
      • Configuring SAP HANA for SAN environments
      • Configuring log backups
        • Housekeeping of log backups
        • Modifying the housekeeping of log backups
      • Executing database backups
        • Overview of database backups
        • Backing up the database with the Snap Creator GUI
        • Backing up the database with Snap Creator command line
        • Reviewing available backups in SAP HANA Studio
      • SAP HANA File-Based Backup and Database Integrity Checks
        • Modifying configuration for File-Based Backup
        • Modifying configuration for Database Integrity Checks
        • Scheduling file-based backup
        • Scheduling database integrity checks
        • Performing File-Based Backup from the Snap Creator GUI
        • Performing File-Based Backup from Snap Creator command line
        • Performing Database Integrity Checks from Snap Creator GUI
        • Performing Database Integrity Checks from Snap Creator command line
      • Restoring and recovering SAP HANA databases
        • Restoring and recovering databases from primary storage
        • Restoring and recovering databases from secondary storage
        • Resuming a SnapVault relationship after a restore
          • Resuming a SnapVault relationship with Data ONTAP operating in 7-Mode
          • Resuming a SnapVault relationship with clustered Data ONTAP
        • Restoring databases after primary storage failure
          • Restoring databases after a primary storage failure with Data ONTAP operating in 7-Mode
          • Restoring databases after a primary storage failure with clustered Data ONTAP
      • SAP HANA plug-in parameters
      • Troubleshooting
      • Where to go next
    • Administration
      • What Snap Creator Framework does
        • Benefits of using Snap Creator
      • Snap Creator architecture
        • Snap Creator Server overview
        • Snap Creator Agent overview
        • Plug-ins for application integration
      • Managing Snap Creator Server
        • Starting, verifying, and stopping Snap Creator Server on Windows
        • Starting, verifying, and stopping Snap Creator Server on UNIX
        • Changing the Snap Creator Server port after installation
        • Setting Snap Creator Server credentials
      • Managing Snap Creator Agent
        • Starting, verifying, and stopping Snap Creator Agent on Windows
        • Starting, verifying, and stopping Snap Creator Agent on UNIX
        • Changing the Snap Creator Agent port after installation
        • Snap Creator Agent security
          • Managing Snap Creator Agent security
          • Customizing the default keystore
      • Backup and recovery workflow
        • Creating profiles
        • Creating global configuration files
        • Creating configuration files
        • Creating backups
        • Monitoring jobs
        • Monitoring logs
        • Creating scheduled jobs
        • Creating retention policies
          • Guidelines to define Snap Creator policies
          • Creating backup types
          • Creating policy schedules
          • Creating policies
          • Assigning policies
        • Creating clones
          • Creating clones from a new backup
          • Creating clones from an existing backup
        • Performing restore operations
          • Performing volume restore
          • Performing single file restore operations
          • Performing application-defined restore operations
      • Managing user access
        • Creating Snap Creator users
        • Assigning profiles to Snap Creator users
        • Viewing a list of Snap Creator users and assigned profiles by using the CLI
        • Creating Snap Creator roles
        • Assigning roles to Snap Creator users
        • Viewing a list of Snap Creator users and assigned roles
        • Viewing Snap Creator users assigned to a role by using the CLI
        • Creating Snap Creator permissions by using the CLI
        • Assigning permissions to Snap Creator roles
        • Creating a list of all Snap Creator permissions by using the CLI
        • Viewing Snap Creator permissions assigned to a role
      • Managing profiles
        • Creating profiles
        • Viewing profiles
        • Deleting profiles
      • Managing configuration files
        • Creating configuration files
        • Creating new configuration files by downloading existing configuration files
        • Creating new configuration files by copying existing configuration files
        • Viewing a list of configuration files assigned to a profile
        • Deleting configuration files from a profile
      • Managing retention policies
        • Creating backup types
        • Creating policy schedules
        • Creating policies
        • Assigning policies
        • Viewing retention policies
        • Deleting retention policies
      • Managing backups
        • What Snap Creator information should be backed up
        • Creating backups
        • Viewing a list of backup copies of a configuration file
        • Deleting backups
      • Managing scheduled jobs
        • Creating scheduled jobs
        • Running scheduled jobs
        • Viewing a list of scheduled jobs
        • Editing scheduled jobs
        • Deleting scheduled jobs
      • Managing clones
        • Creating clones from a new backup
        • Creating clones from an existing backup
        • Unmounting clones
      • Plug-in information required to configure Snap Creator
        • Archive log plug-in
        • Citrix XenServer plug-in
        • DB2 plug-in
        • IBM Domino plug-in
        • MaxDB plug-in
        • MySQL plug-in
        • Oracle plug-in
        • Red Hat KVM plug-in guidelines
        • SAP HANA plug-in
        • SnapManager for Microsoft Exchange plug-in
        • SnapManager for Microsoft SQL Server plug-in
        • Sybase ASE plug-in
        • VMware VIBE plug-in
          • Requirements for vCloud vApp backup and restore operations using the VMware plug-in
          • Virtual machine backup and restore by using the VMware plug-in
        • Using the plug-in framework to create custom plug-ins
        • Configuring Snap Creator for multilevel application quiesce operations when using hypervisor plug-ins
      • Troubleshooting Snap Creator issues
        • Types of error messages and troubleshooting logs
          • Performing a Snap Creator dump
        • Troubleshooting Snap Creator GUI errors
          • Cannot connect to the Snap Creator GUI
          • Error starting the Snap Creator GUI
        • Troubleshooting network issues
        • Troubleshooting security issues
          • Cryptographic flaws in Transport Layer Security
          • Self-signed SSL certificate not matching the URL
          • CA-signed SSL certificate is required for Snap Creator Framework
        • Troubleshooting Snap Creator Server or Snap Creator Agent issues
          • Snap Creator Server or Agent not starting
          • Snap Creator Agent not responding
          • Snap Creator password reset
        • Troubleshooting CLI command errors
          • CLI command results in 403 Forbidden error
          • CLI command results in 404 Not Found error
          • CLI command results in 500 Cannot locate object error
          • CLI command results in 500 Connect Failed error
        • cloneVol reports that aggregate does not exist
        • Error messages
          • Snap Creator Framework error messages
          • Snap Creator Agent error messages
          • Repository error messages
          • Storage error messages
          • Snap Creator GUI error messages
      • Snap Creator configuration file variables, parameters, and commands
        • Snap Creator variable and parameter descriptions
        • Parameters for configuring the Snap Creator Agent host client and Snap Creator Server
        • Parameters to connect to vFiler units and interfaces
        • Parameters to set up cloning operations
        • Parameters for setting up event management
        • Parameters to set up Operations Manager console
        • Parameters to set up OSSV
        • Parameters for setting up SnapMirror
        • Parameters for setting up Snapshot copies
        • Parameters to set up SnapVault
        • Parameters to set up the NetApp Management Console data protection capability
        • APP commands
        • Mount and unmount commands
        • PRE commands
        • POST commands
      • Snap Creator terminology
      • Guidelines for using the Snap Creator command-line interface
        • Snap Creator CLI commands for workflow actions
        • Commands used to manage Snap Creator user access
    • Legal notices
    • docs.netapp.com
    • Snap Creator Framework

    CLI reference

    02/12/2021

    This section contains reference information for using Snap Creator from the command line interface.

    • © 2023 NetApp, Inc.
    • Terms of Use
    • Privacy Policy
    • Cookie Policy
    • Cookie Settings
    • Send feedback about this page
    • blog blog@
    • community community@
    • twitter twitter@
    • facebook facebook@
    • linkedin linkedin@
    • youtube youtube@
    • slideshare slideshare@