Chat now with support
Chat with Support

QoreStor 7.3.0 - Command Line Interface Reference Guide

Introduction to the QoreStor Command Line Reference Guide Introducing QoreStor Managing QoreStor
Alerts Commands Authenticate Commands Email_alerts Commands OST RDA SAML sc_manager command Stats Storage Group commands System User
Managing QoreStor Storage Operations
Cloud_tier Connection Container iSCSI NDMP Object_container Object_direct Performance_tier Replication Seed Schedule VTL
Maintaining QoreStor About us


To allow QoreStor replication operations, ensure that TCP ports 9904, 9911, 9915, and 9916 are enabled. For more information about supported ports for the QoreStor, see the QoreStor Administrator Guide.

The Replication QoreStor CLI command and its options allow you to manage the status of all current replication relationships and tasks on a system by:

  • Displaying the current replication process status information
  • Creating and defining new replication links or relationships to containers
  • Deleting specific replication links
  • Starting and stopping the replication process between source and target containers
  • Limiting the bandwidth consumed during replication
  • Resynchronizing replication between source and target containers
  • Troubleshooting replication connection issues

NOTE: You can set a replication schedule for daily replication operations. For details, see schedule --add .

Replication Command Usage

This topic introduces the replication command usage:

  • replication --show [options]
  • replication --add --name --role --peer [options]
  • replication --update --name --role --peer [options]
  • replication --delete --name --role [options]
  • replication --start --name --role [options]
  • replication --stop --name --role [options]
  • replication --limit --speed --target [options]
  • replication --resync --name --role [options]
  • replication --troubleshoot --peer
  • replication --help

NOTE: If you specify a command without supplying the expected value or option, you will be prompted to provide the correct value or option.

replication --show


Displays the current status of all existing replication containers (and respective roles) in the QoreStor.


replication --show [--air]
	[--name <name>]
	[--role <source | target>]


--air       Auto Image replication enabled.
--name      Name of container.
--role      Role of container.
--verbose   Display more details.
--limits    Replication speed limits.


Container Name		Replication Role		Status
backup			 Source, Target			 Enabled
acme-59		 Source				 Enabled
acmeStorage1		 Source				 Enabled
acmeStorage2 		 Source				 Enabled
acmeStorage3		 Target				 Enabled

replication --add --name <name> --role <source | target> --peer <ip address | hostname> [--peer_name <name>] [--peer_group_name <name>] [--replication_traffic <ip address | hostname>] [--encryption <none | aes128 | aes256>][--username <user name>]


Adds a new replication link to a container on the QoreStor, for which you need to define its name, role, peer IP address/hostname, peer name, peer group name, user name on the peer system, and encryption level to apply. The peer group name is the name of the remote container’s group to replicate to/from, and this parameter is applicable only if a remote container is not present.

There are three options for encryption:

  • none,
  • aes128 (Advanced Encryption Standard) which uses128-bit cryptographic keys
  • aes256 (using 256-bit AES cryptographic keys).

If the username is a domain login (for example, domain\username), ensure that '\' characters and spaces are either escaped or in quotes.

NOTE: Make sure that the data container you intend to replicate already exists. If it does not, the following error message displays: Error: Container <container_name> does not exist.


replication --add --name <name>
	--role <source | target>
	--peer <ip address | hostname>
	[--peer_name <name>]
	[--peer_group_name <name>]
	[--replication_traffic <ip address | hostname>]
	[--encryption <none || aes256>]
	[--username <user name>]


--name                  Name of container to replicate.
--role                  Role of container.
--peer                  Peer appliance IP address/name of replication network interface(s).
--peer_name             Name of remote container to/from replicate.
--peer_group_name       Name of remote container's group to/from replicate. Only applicable if remote container is not present
--replication_traffic   IP address/name of local dedicated replication network interface(s).
--encryption            Type of encryption to use on the wire.
--username              Username on peer system.
--air			Auto Image replication enabled.


Enter password foradministrator@
Replication entry created successfully.
Replication Container          : backup
Replication Role               : Source
Replication Target             :
Replication Target IP          :
Replication Target Mgmt Name   :
Replication Target Mgmt IP     :
Replication Local Data Name    : QS2K-01
Replication Local Data IP      :
Replication Target Container   : backup
Replication Enabled            : Yes
Replication Compression Enabled: Yes
Replication Encryption         : AES 128-bit

NOTE: To verify that you have successful added a replication link to the QoreStor (or to view the current status of existing containers), see replication --show.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating