Command Line Interface for ContinuousDataReplicator

Available Commands

The following section provides a list of commands that can be used by the ContinuousDataReplicator.

Note

Before you run a command, make sure to log on to the CommServe computer using the qlogin command. Similarly, use the qlogout command to log off from the CommServe computer.

qcreate

replicationpair

repset

qoperation

replication

qlist

dataagent

replicationpair

replicationset

qdelete

dataagent

qcreate replicationpair

Description

This command creates replication pair for the given replication set.

Usage

qcreate replicationpair [-cs commserver] -c client -a iDataAgent -repset repsetname -spath sourcepath [-dpath destinationpath] [-commonbasefolder y|n)] [-tf tokenfile] [-tk token] [-h]

Options

-cs	CommServe host name
-c	Client computer name
-a	Agent name
-repset	Replication set name
-spath	Source path
-dpath	Destination Path
-commonbasefolder	Use the common base folder. Valid values are true/false.
-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

Create a replication pair for client client1 with replication set repset1.

E:\commandline\Base>qcreate replicationpair -c client1 -a Q_FILE_REPLICATION -repset repset1 -spath E:\dir1 -dpath E:\dir2

qcreate repset

Description

This command creates a replication set under the given agent or instance.

A replication set is similar in concept to a backup set which is used by some Agents, and represents a logical grouping of Replication Pairs. This allows you to configure certain properties and activities at the Replication Set level, and thus control all the included Replication Pairs together.

Note

If you want to create repset from replication policy ensure your Replication Policy is created prior to running qcreate repset. The associated replication set policy will determine whether the replication set is for the ContinuousDataReplicator.

Upon successful completion, qcreate repset displays the message "Created replication set successfully" in the console. In case of an error, an error code and the error description are displayed in the following format: "sp: Error errorcode: errordescription"

Usage

qcreate repset [-cs commserver] [-rp replicationpolicy] -c client -a iDataAgent -n repsetname [-dh destinationhost] [-fp filterpath] [-arp allowrecoverypoint(y|n)] [-commonbasefolder commonbasefolder)] [-tf tokenfile] [-tk token] [-af argsfile]

Options

-cs	CommServe host name
-rp	Replication Set Policy
-c	Client computer name
-a	Agent type installed on client computer (Q_FILE_REPLICATION) Note This option pertains to ContinuousDataReplicator
-n	Replication set name
-dh	Destination Host
-fp	Filter File Path/Pattern
-arp	Allow Recovery Point. Valid values are 'y' and 'n'.
-tf	Reads token from a file
-tk	Token string
-af	Reads arguments from a file
-h	Displays help

Argument File

server	CommServe Name
client	Client computer name
dataagent	Agent type installed on client computer (see Argument Values - Agent Types)
replictaionpolicy	Replication Policy Name
destinationhost	Destination Host Name
allowrecoverypoint	y/n
commonbasefolder	Common Base Folder Path
filterpaths	Filter Path

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

Create a replication set (without Replication Policy) with name rd1 with common base folder under client client1 and agent Q_FILE_REPLICATION.

E:\commandline\Base>qcreate repset -cs cs1 -c client1 -n rd1 -dh host1 -a "Q_FILE_REPLICATION" -fp "*.exe" -fp "*.txt" -arp "y" -commonbasefolder E:\xyz
Created repset successfully.

Create a replication set (with Replication Policy) with name rd1 based on replication policy properties under client client1 and agent Q_FILE_REPLICATION.
```
E:\commandline\Base>qcreate repset -cs cs1 -rp reppolicy1 -c client1 -n repset1 -a "Q_FILE_REPLICATION"
Created repset successfully.
```

qlist dataagent

Description

This command lists all of the agents installed on a given client computer. For a list of agents that this command can return, see Argument Values - Agent Types.

You can also get the static list of all available agents using the -all option. When more than one agent is found, the agents are listed one agent per line, and are displayed in the console. No message is displayed in the console when no agents are found.

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

Usage

qlist dataagent -c client [-tf tokenfile] [-tk token] [-h]

Options

-c	Client computer name
-all	List all iDataAgents available in the CommServe
-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

List the all agents installed in client client1.

E:\commandline>qlist dataagent -c client1

qlist replicationpair

Description

This command lists all the replication pairs for a replication set for a client.

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

Usage

qlist replicationpair [-c client] [-rsn repset] [-tf tokenfile] [-tk token] [-h]

Options

-c	Client computer name
-rsn	Replication set name
-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

List the replication pairs for replication set repset1 in client client1.

E:\commandline>qlist replicationpair -c client1 -rsn repset1

qlist replicationset

Description

This command lists all the replication sets for a client.

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

Usage

qlist replicationset [-c client] [-tf tokenfile] [-tk token] [-h]

Options

-c	Client computer name
-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

List all the replication sets for client client1.

E:\commandline>qlist replicationset -c client1

qoperation replication

Description

This command performs replication operations with Smart and Full Sync on a replication pair or replication set.

It can also be used to stop, suspend and resume replication activity. Upon successful completion, qoperation replication displays the message "Replication operation successful" on the CommCell Console.

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

Usage

qoperation replication [-c client] [-rsn repset name] [-rpi repset pair id] [-tf tokenfile] [-tk token] [-h]

Options

-c	[list] Client computer name
-rsn	[list] Replication set name
-rpi	[list] Replication pair ID
-o	[list] Type of operations set. Valid values are: start startfullsync abort forceabort suspend resume
-tf	Reads token from a file
-tk	Token string
-h	[nil] 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

Starting replication on replication set repset1, replication pair with pair id 150 on client client1.
```
E:\commandline>qoperation replication -c client1 -rsn repset1 -rpi 150 -o start
```

qoperation execute

You can delete a replication set by using an XML file. For more information on command line parameters and XML elements, see Command Line - Syntax.

Procedure

On the ContinuousDataReplicator Agent host, run the qlogin command to log on to the CommServe computer.
Download the delete_backupset_template.xml file to the computer where you will run the command.
Open the delete_backupset_template.xml file, add your specific parameters, and save the file.

For information on supported backup set XML parameters, see Available Parameters.

On the command line, go to Software_Installation_Directory/Base and type the command.

qoperation execute -af delete_backupset_template.xml -clientName 'client_name' -appName 'Continuous Data Replicator' -instanceName 'DefaultInstanceName' -backupsetName 'backup_set'

Run the qlogout command to log off the CommServe computer.

Qdelete dataagent

Description

This command deconfigures or deletes the specified agent.

By default, the qdelete dataagent command asks for confirmation before deletion. You can skip the confirmation prompt using the "-y" option.

Upon completion, qdelete dataagent displays a message that the agent was successfully deleted on the command prompt. In case of an error, an error code and description are displayed as: "dataagent: Error errorcode: errordescription"

Usage

qdelete dataagent -c client -a agent [-deconfigure] [-y] [-tf tokenfile] [-tk token] [-h]

Options

-c	Client computer name
-a	The agent to be deleted (see Argument Values - Agent Types)
-d	Deconfigures the agent without deleting it
-y	Delete without confirmation
-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.

Examples

Delete an agent named MyDataAgent under client client1.

qdelete dataagent -c client1 -a MyDataAgent
This command deconfigures and deletes an agent, do you want to configure (y/n)

Deconfigure an agent named MyDataAgent under client client1 without any confirmation.
```
qdelete client -c client1 -a MyDataAgent -deconfigure - y
```