Loading...

IntelliSnap - Command Line Interface

Table of Contents

Log On to the CommServe

IntelliSnap Configuration

IntelliSnap Backup

Snapshots Operations

Log Off from the CommServe

Log On to the CommServe

To run command line operations, you must first login to the CommServe.

From Command prompt, navigate to <Software_Installation_Directory>/Base and run the following command:

qlogin -cs <commserve name> -u <user name>

For example, to log on to CommServe 'server1' with username 'user1':

qlogin -cs server1 -u user1

IntelliSnap Configuration

The following sections describe the steps to enable IntelliSnap on a client and configure a subclient with IntelliSnap properties.

Adding Arrays

To add an array in the Array Management list, use the Save As Script option, which generates XML and script files. You must generate the XML file on the computer where the CommServe is running, following these steps:

  1. From the CommCell Browser, click the Storage tab and then click the Array Management icon.
  2. In the Array Management dialog box, click Add.
  3. In the Array Properties dialog box, specify the following:

    From the Snap Vendor list, select a vendor.

    In the Name and Control Host box, specify the name and the control host.

    Click Change and enter the access information of a user with administrative privileges in the Username and Password fields in Enter User Name and Password dialog box.

    Use the Description field to enter a description about the entity. This description can include information about the entity's content, cautionary notes, etc.

  4. Click Save As Script to open the Save As Script dialog box.
  5. In the Client box, select the client computer where the script will be saved.
  6. In the File Path box, enter the location where the script will be saved.

    Alternatively, you can click Browse and navigate to the location.

  7. Add the file name and extension to the location. For example, "C:\scripts\myscript.bat" for Windows or "/usr/scripts/myscript.sh" for UNIX.

    If .xml and .bat/.sh files with the same name already exist, they cannot be overwritten unless the bAllowSaveAsScriptFileOverWrite additional setting is used. For information on adding bAllowSaveAsScriptFileOverWrite, see Enabling File Overwrite.

  8. Click OK.

Enabling or Disabling IntelliSnap Backup at Client Level

  1. Download the update_client_snap_backup_template.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute -af update_client_snap_backup_template.xml -entity/clientName xxxxx -EnableSnapBackups xxxxx

Enabling or Disabling IntelliSnap Backup at Subclient Level

  1. Download the update_subclient_template.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute -af update_subclient_template.xml -entity/appName 'xxxxx' -entity/clientName xxxxx -entity/backupsetName xxxxx -entity/subclientName xxxxx -isSnapBackupEnabled xxxxx

Creating an IntelliSnap Enabled Subclient

  1. Download the create_subclient_template.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute -af create_subclient_template.xml -subClientEntity/clientName xxxxx -subClientEntity/backupsetName xxxxx -subClientEntity/subclientName xxxxx -storagePolicyName xxxxx -isSnapBackupEnabled true snapToTapeProxyToUse/clientName xxxxx -useSeparateProxyForSnapToTape true -separateProxyForSnapToTape/clientName xxxxx -snapToTapeProxyToUseSource true -subClientEntity/instanceName xxxxx -cssnaptest -contentOperationType ADD -content/path xxxxx

Selecting the Storage Engine

  1. Download the update_subclient_template.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute -af update_subclient_template.xml -entity/appName 'xxxxx' -entity/clientName xxxxx -entity/backupsetName xxxxx -entity/subclientName xxxxx -isSnapBackupEnabled true -snapShotEngineName 'xxxxx'

Selecting Transport Mode

  1. Download the update_subclient_template.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute -af update_subclient_template.xml -entity/appName 'xxxxx' -entity/clientName xxxxx -entity/backupsetName xxxxx -entity/subclientName xxxxx -isSnapBackupEnabled xxxx -transportModeForVMWare AUTO

Setting the Proxy for ESX Host

  1. Download the update_subclient_template.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute -af update_subclient_template.xml -entity/appName 'xxxxx' -entity/clientName xxxxx -entity/backupsetName xxxxx -entity/subclientName xxxxx -isSnapBackupEnabled true -proxyESXHost xxxxx

Enabling Application Aware Backups and Truncating Exchange Database Logs

  1. Download the update_subclient_template.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute -af update_subclient_template.xml -entity/appName 'xxxxx' -entity/clientName xxxxx -entity/backupsetName xxxxx -entity/subclientName xxxxx -isSnapBackupEnabled true -backupForGranularRecovery true -truncateExDBLogs true

Selecting a Proxy Client for Snap

  1. Download the update_subclient_template.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute -af update_subclient_template.xml -entity/appName 'xxxxx' -entity/clientName xxxxx -entity/backupsetName xxxxx -entity/subclientName xxxxx -isSnapBackupEnabled true - snapToTapeProxyToUse/clientName xxxxx

Selecting a Proxy Client for Movement to Tape

  1. Download the update_subclient_template.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute -af update_subclient_template.xml -appName 'xxxxx' -entity/clientName xxxxx -backupsetName xxxxx -subclientName xxxxx -isSnapBackupEnabled true -useSeparateProxyForSnapToTape true -separateProxyForSnapToTape/clientName xxxxx

    Note: If you use useSeparateProxyForSnapToTape, set the snapToTapeProxyToUseSource parameter to true so that IntelliSnap operations take place in the original client computer, in case the proxy is unreachable.

Pre-processes and Post-processes

Use the following steps to perform pre-processes and post-processes:

  1. Download the update_subclient_template.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute -af update_client_template.xml -entity/clientName xxxxx -appName xxxxx -entity/instanceName xxxxx -entity/backupsetName xxxxx -entity/subclientName xxxxx -isSnapBackupEnabled True -preSnapCommand xxxxx -postSnapCommand xxxxx -preSnapProcessOn 1 -postSnapProcessOn 1

Available Parameters

The following table describes the parameters used in the above sections.

Parameter

Description of Parameter values

appName

Name of the agent. Valid values are:

  • Exchange Database
  • File System
  • MySQL
  • NAS
  • Notes Database
  • Oracle
  • Oracle RAC
  • PostgreSQL
  • SAP for MAX DB
  • SAP for Oracle
  • SQL Server
  • Sybase Database
  • Virtual Server

 

backupForGranularRecovery

Option to enable the application aware backup operation to allow granular recovery of files. Valid values are true/false.

When this option is set to true, you can also truncate the Exchange Database logs using the truncateExDBLogs parameter.

backupsetname

Name of the backup set. If the backup set name is not specified in the command query, the default backup set is used by default.

backupType

Option to set the backup level at which the IntelliSnap backup should run. Valid values are:

  • FILE_LEVEL
  • VOLUME_LEVEL
  • DISK_LEVEL

entity/clientName

Name of the client computer.

enableSnapBackup

Option to enable the IntelliSnap configuration on the client.

Valid values are true/false.

instanceName

Name of the virtual server instance or of the database instance.

isRMANEnableForTapeMovement

To enable or disable RMAN for backup copy.

Valid values are true/false.

isSnapBackupEnabled

Option to enable the IntelliSnap configuration on the subclient.

Valid values are true/false.

snapToTapeProxyToUse/clientName

Name of the separate proxy computer for snap to tape.

To use this option, set the useSeparateProxyForSnapToTape parameter to true.

snapToTapeProxyToUseSource

Option to allow IntelliSnap operations to take place in the original client computer, in case the proxy is unreachable.

Valid values are true/false.

separateProxyForSnapToTape/clientName

Name of the client computer that will be used as a proxy to perform IntelliSnap operations.

subclientname

Name of the subclient.

snapShotEngineName

Note: Name of the storage array to be configured with the subclient.

The name of the storage array should match with the name displayed in the Available Snap Engine list in the subclient properties.

Valid values are:

  • Data Replicator
  • DataCore Snap
  • DataCore Clone
  • Dell Compellent Snap
  • Dell Equallogic Clone
  • Dell Equallogic Snap
  • EMC Isilon Snap
  • EMC VNX / Celerra
  • EMC VNX / CLARiiON SnapView Clone
  • EMC VNX / CLARiiON SnapView Snap
  • EMC VPLEX Snap
  • EMC VPLEX Clone
  • EMC TimeFinder BCV
  • EMC TimeFinder Clone
  • EMC TimeFinder Snap
  • EMC TimeFinder VP Snap
  •  EMC CLARiiON SnapView Snap
  • Fujitsu ETERNUS Clone
  • Fujitsu ETERNUS Snap
  • Fujitsu ETERNUS SnapOPC+
  • HDS Copy on Write Snapshot
  • HDS Shadow Image
  • HDS Shadow Image CCI
  • HDS Thin Image CCI
  • HP 3PAR Clone
  • HP 3PAR Snap
  • HP EVA Clone
  • HP EVA Snapshot
  • Huawei OceanStore Snap
  • Huawei OceanStore Clone
  •  IBM XIV Snap
  • IBM SVC FlashCopy
  • IBM SVC Space-efficient FlashCopy
  • INFINDAT IntelliSnap
  • LSI Snapshot
  • LSI Volume Copy
  • Native
  • NetApp
  • NetApp E-Series PiT
  • Nimble Storage CS-Series Snap
  • Nimble CS-Series Snap and Replicate
  • Oracle ZFS Storage Snap
  • Pure Storage Snap
  • Virtual Server Software Snap

transportModeForVMWare

Option to set the transport mode of your environment. Valid values are:

  • AUTO, to allow the software to automatically set the transport mode based on your setup.
  • SAN
  • HOT_ADD
  • NAS
  • NBD_SSL
  • NBD

truncateExDBLogs

Option to truncate the Exchange Database logs. Valid values for this parameter are true/false. Must be used with backupForGranularRecovery.

useSeparateProxyForSnapToTape

Option to enable the use of a proxy computer to perform movement to tape operations on a different client. Valid values are true/false.

When this option is set to true, you also need to specify the proxy computer using the separateProxyForSnapToTape/clientName parameter.

IntelliSnap Backup

Performing a IntelliSnap Backup

Before you begin, check whether you have the input xml file, which contains the parameter values for configuring the IntelliSnap backup options. The input xml file can be obtained by:

  1. Downloading the input xml file template and saving it on the computer from where the backup will be performed.
  2. Generating the input xml file from the CommCell Console and saving it on the computer from where the backup will be performed.

Use the following steps to perform the IntelliSnap backup:

  1. Download the snapbackup_template.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute -af snapbackup_template.xml -appName 'File System' -entity/clientName xxxxx -backupsetName xxxxx -subclientName xxxxx -backupLevel FULL

Examples

Performing a full backup

qoperation execute -af snapbackup_template.xml -appName 'File System' -entity/clientName client1 -backupsetName backupset1 -subclientName subclient1 -backupLevel FULL

Performing an incremental backup

qoperation execute -af snapbackup_template.xml -appName 'File System' -entity/clientName client1 -backupsetName backupset1 -subclientName subclient1 -backupLevel INCREMENTAL

Performing a differential full backup

qoperation execute -af snapbackup_template.xml -appName 'File System' -entity/clientName client1 -backupsetName backupset1 -subclientName subclient1 -backupLevel DIFFERENTIAL

Performing a Backup Copy

Before you begin, check whether you have the input xml file, which contains the parameter values for configuring the IntelliSnap backup options. The input xml file can be obtained by:

  1. Downloading the input xml file template and saving it on the computer from where the backup will be performed.
  2. Generating the input xml file from the CommCell Console and saving it on the computer from where the backup will be performed.

Use the following steps to perform the backup:

  1. Download the inline_backup_copy_template.xml file or the offline_backup_copy_template.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

    qoperation execute -af inline_backup_copy_template.xml

Performing an RMAN Backup Copy

  1. Download the update_sc.xml file and save it on the computer from where the command will be executed.
  2. Execute the following command from the <Software_Installation_Directory>/Base folder after substituting the parameter values.

If you select RMAN for backup copy, you should install the Oracle iDataAgent and the oracle instance configured in CommCell browser should be identical to the instance in the source computer.

qoperation execute -af update_sc.xml -entity/clientName <clientname> -instanceName <oraclesid> -subclientName <subclientname> -storagePolicyName <storagepolicyname> -isSnapBackupEnabled true -snapShotEngineName <Snapshot engine> -snapToTapeProxyToUse/clientName <proxy client> -isRMANEnableForTapeMovement true

Snapshots Operations

Before You Begin

You need the VolumeID of the backup job ID in order to run the mount command. To obtain the VolumeID identifier, use the qlist snap command. Refer to qlist snap.

Mounting Snapshots

Single Snapshot

This command allows you to mount single snapshot.

qoperation snap [-cs <commserve_host_name>] -o mount [-cid <Commcell Id>] -v <Volume Id> [-dc <Destination Client Name>] [-dpath <Destination Path>] [-tf <tokenfile>] [-tk <token>] [-h]

Note: To mount Oracle ASM (Automatic Storage Management) snapshots, provide the ASM diskgroup name in the -dpath option.
To mount VMware snapshots, the "<DestinationPath>" must be in the following format:
"{vcname:<vCenterClientName>,esxname:<ESXHostFQDN>,username:<UserName>,password:<EncryptedPassword>}"
You can create an encrypted password by saving any supported operation (such as a backup or restore job) as a script using the CommCell Console. The script contains the qlogin string with the encrypted password, which you can copy and paste into other scripts.

Multiple Snapshots

This command allows you to mount multiple snapshots.

qoperation snap [-cs <commserve_host_name>] -o mount -v <Volume Id1> -v <Volume Id2> [-dc <Destination Client Name>] [-dpath <Destination Path1>] [-dpath <Destination Path2>]

In case of an error, an error code and the error description are displayed in the following format: "snap: Error errorcode: errordescription"

Options:

-cs

CommServe host name

-o

Operation to be performed on the snapshot

-cid

CommCell Id

-v

Volume Id

-dc

Destination client name

-dpath

Destination path or ASM diskgroup

-tf

Reads token from a file

-tk

Token string

-h

Displays help

Diagnostics:

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example for mounting a single snapshot:

For mounting -o mount -v volumeID -dc Destination Client Name -dpath Destination Path are mandatory options.

E:\commandline>qoperation snap -v 128 -o "mount" -dc "client1" -dpath "/mpath"

Example for mounting multiple snapshots:

For mounting -o mount -v volumeID -dc Destination Client Name -dpath Destination Path are mandatory options.

E:\commandline>qoperation snap -v 128 -v 129 -o "mount" -dc "client1" -dpath "/mpath1" -dpath "/mpath2"

Example for mounting a single ASM snapshot:

For mounting -o mount -v volumeID -dc Destination Client Name -dpath Destination Path are mandatory options. Specify the ASM diskgroup in the -dpath option.

E:\commandline>qoperation snap -v 128 -o "mount" -dc "client1" -dpath "+ASMSNAP"

Example for mounting multiple ASM snapshots:

For mounting -o mount -v volumeID -dc Destination Client Name -dpath Destination Path are mandatory options. Specify each ASM diskgroup in the -dpath option.

E:\commandline>qoperation snap -v 128 -v 129 -o "mount" -dc "client1" -dpath "+ASMSNAP1" -dpath "+ASMSNAP2"

Example for mounting a single VMware snapshot:

For mounting, -o mount -v <VolumeID> -dc <DestinationClientName> -dpath <DestinationPath> are mandatory options.

E:\commandline>qoperation snap -v 128 -o "mount" -dc "client1"
-dpath "{vcname:my_vcenter_client,esxname:my_esx_host.mydomain.com,username:myname,password:<EncryptedPassword>}"

Example for mounting multiple VMware snapshots:

For mounting, -o mount -v <VolumeID> -dc <DestinationClientName> -dpath <DestinationPath> are mandatory options.

E:\commandline>qoperation snap -v 128 -v 129 -o "mount" -dc "client1"
-dpath "{vcname:my_vcenter_client1,esxname:my_esx_host1.mydomain.com,username:myname,password:<EncryptedPassword>}"
-dpath "{vcname:my_vcenter_client2,esxname:my_esx_host2.mydomain.com,username:myname,password:<EncryptedPassword>}"

Unmounting Snapshots

Single Snapshot

This command allows you to unmount single snapshot.

qoperation snap [-cs commserver] -o unmount [-cid Commcell Id] -v Volume Id [-dc Destination Client Name] [-dpath Destination Path] [-tf tokenfile] [-tk token] [-h]

Multiple Snapshots

This command allows you to unmount multiple snapshots.

qoperation snap [-cs commserver] -o ummount -v Volume Id1 -v Volume Id2 [-dc Destination Client Name] [-dpath Destination Path1] [-dpath Destination Path2]

In case of an error, an error code and the error description are displayed in the following format: "snap: Error errorcode: errordescription"

Options:

-cs

CommServe host name

-o

Operation to be performed on the snapshot

-cid

CommCell Id

-v

Volume Id

-dc

Destination client name

-dpath

Destination path

-tf

Reads token from a file

-tk

Token string

-h

Displays help

Diagnostics:

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example for unmounting a single snapshot:

For unmounting -o unmount -v volumeID are mandatory options.

E:\commandline>qoperation snap -v 128 -o "unmount"

Example for unmounting multiple snapshots:

For unmounting -o unmount -v volumeID are mandatory options.

E:\commandline>qoperation snap -v 128 -v 129 -o "unmount" -dc "client1" -dpath "/mpath1" -dpath "/mpath2"

Note: Command line does not support revert or delete operations.

Log Off from the CommServe

Once you have completed the command line operations, you can logout from the CommServe using the following command:

qlogout -cs commserve

For example, to log out from the CommServe 'Server1'.

qlogout -cs Server1

Last modified: 3/1/2018 4:56:39 PM