Command Line - Overview

Table of Contents

Introduction

SnapProtect users can perform backup, restore and other CommCell operations from the command line. Run these operations individually from the command prompt or combine these operations into a script or third-party application for automation. For example, create a script to trigger a backup whenever a client goes offline and then to restore to a different location.

CommCell operations can be performed through the Command Line Interface (CLI), QScripts, and the Application Programming Interface (QAPI).

Command Line Interface (CLI)

QCommands and XML files are run from the command line interface to perform CommCell Console operations such as backup and restore.

To run CommCell operations through the command line, you can:

  • Select options from the CommCell Console, click Save As Script to save them as an XML file, and then execute the file from the command prompt.
  • Use the XML templates provided in this documentation for operations that cannot be saved using Save As Script.
  • Execute QCommands to perform other common operations that are not available through XML files.

Use the following table to learn more about the command line operations that are available for each component you want to configure:

CommServe

MediaAgent

Active Directory

DB2 iDataAgent

DB2 MultiNode iDataAgent

Image Level iDataAgent

Informix iDataAgent

Notes Database iDataAgent

Notes Document iDataAgent

Macintosh File System iDataAgent

Microsoft Exchange Database iDataAgent

Microsoft Exchange Mailbox iDataAgent

Microsoft Exchange Public Folder iDataAgent

Microsoft SharePoint Server iDataAgent

Microsoft SQL Server iDataAgent

Microsoft Windows File System iDataAgent

MySQL iDataAgent

NAS iDataAgent

OES File System iDataAgent

Oracle Instance Configuration

Oracle Subclient Configuration

Oracle RAC iDataAgent

PostgreSQL iDataAgent

SAP for MAXDB iDataAgent

SAP for Oracle iDataAgent

Unix File System iDataAgent

Sybase iDataAgent

Virtual Server iDataAgent

  VMware

  Microsoft Hyper-V

Unix File System iDataAgent

ContinuousDataReplicator

SnapProtect Backup

QScripts

QScripts are SQL scripts that query and modify the CommServe database directly for CommCell-wide changes. For more information, see QScripts.

Application Programming Interface (QAPI)

The Application Programming Interface, or QAPI, allows users to create custom commands using C or C++. These customized API applications can be run on Windows and UNIX computers from the CommCell Console or using command line utilities. For more information, see QAPI Developer's Guide.

Documentation Conventions

Command line operations in the documentation observe the following conventions:

  • Bolded Courier New font type is used for all command line arguments.
  • Brackets ([...]) indicate arguments or options that are optional in the command usage description.
  • Italic Arial font type is used to highlight the QCommand operation name in a description.
  • In XML commands, the available XML options are referred to as parameters.