This guide provides detailed information for managing Quest® QoreStor™ data backup operations by using the QoreStor command line interface (CLI).
Introduction to the QoreStor Command Line Reference Guide
Introducing QoreStor
Managing QoreStor
Alerts Commands
Authenticate Commands
Managing QoreStor Storage Operations
Authenticate Command Usage
Email_alerts Commands
OST
authenticate --show [--users]
authenticate --join --domain <domain name> [--ou <org-unit name>] --user <user name>
authenticate --leave [--user <user name>] [--force]
authenticate --update --kerberos
authenticate --add [--user <user name>]
authenticate --delete--user <user name>
authenticate --set --user <user name>
authenticate --guestmode [--enable]
authenticate --server_signing --mode <auto | mandatory | disabled>
authenticate --help
OST Command Usage
RDA
ost --show [--config] [--file_history] [--name <name>] [--active_files] [--name <name>] [--clients] [--limits]
ost --update --opdup_encryption <none | aes128 | aes256>
ost --delete_client --name <OST Client Hostname>
ost --update_client --name <OST Client Hostname> --mode <auto | passthrough | dedupe>
ost --limit --speed <<num><KBps | MBps | GBps | default> --target <ip address | hostname>
ost --partial_images --containerid <Container id> [--delete <Partial image path>] [--timeout <> 0>]
ost --help
RDA Command Usage
SAML
sc_manager command
Stats
rda --show [--config] [--file_history] [--name <name>] [--active_files] [--name <name>] [--clients] [--limits]
rda --update --opdup_encryption <none | aes128 | aes256>
rda --delete_client --name <RDA Client Hostname>
rda --update_client --name <RDA Client Hostname> --mode <auto| passthrough| dedupe>
rda --limit --speed <<num><KBps| MBps| GBps> | default> --target <ip address | hostname>
rda --partial_images --containerid <Container id> [--delete <Partial image path>] [--timeout <> 0>]
rda --help
Stats Command Usage
Storage Group commands
stats --system
stats --cpu
stats --memory
stats --nfs
stats --cifs
stats --ost
stats --rds
stats --iscsi [--verbose]
stats --container --name <name>
stats --storage_group --name <name>
stats --replication [--name <name>]
stats --cleaner
stats --clients [--type <NFS|CIFS|OST|RDS|NDMP|ISCSI|FC>]
stats --reset [--nfs] [--cifs] [--ost] [--rds] [--datacheck]
stats --seed
stats --peformance_tier
stats --cloud_tier
stats --object_direct
stats --archive_tier
stats --object_container
stats --help
Storage Group Command Usage
System
User
storage_group --show [--name <name>] [--verbose]
storage_group --add --name <name> [--compression_mode <fast|best>]
storage_group --update --name <name> [--compression_mode <fast|best>]
storage_group --encryption --name <name> [--set <ON | OFF>] [--mode <static|internal> <--interval <7 days to 70 years>]
storage_group --delete --name <name>
storage_group --setpassphrase --name <name>
storage_group --help
User Command Usage
user --show [--users] [--logins] [--verbose][--name <username>] [--roles <cifs|ost|rda|ndmp|iscsi|monitor|administrator|email_recipient>
user --add --name <user name>
user --update --name <user name> [--new_name <user name>] [--add_roles <cifs|ost|rda|ndmp|iscsi|monitor|email_recipient>] [--remove_roles <cifs|ost|rda|ndmp|iscsi|monitor|email_recipient>] [--full_name <full name>] [--phone <phone number>] [--email_addr <
user --delete --name <user name>
user --setpassword --name <user name>
user --help
Cloud_tier
Connection
Maintaining QoreStor
Connection Command Usage
Container
connection --show [--name <name>] [--type <NFS|CIFS|OST|RDS|NDMP|ISCSI|FC>] [--verbose]
connection --add --name <name> --type <NFS|CIFS|OST|RDS|NDMP|ISCSI|FC> [--clients <ip address>][--dma <ip address>][--initiator <IQN, ip address(es), hostname, or WWPN>][--target <WWPN>][--rootmap <nobody|root|administrator>] [--options <NFS|CIFS
connection --update --name <name> --type <NFS|CIFS|OST|RDS|NDMP|ISCSI|FC> [--clients <ip address>][--dma <ip address>][--initiator <IQN, ip address(es), hostname, or WWPN>][--target <WWPN>][--rootmap <nobody|root|administrator>] [--options <NFS|CI
connection --delete --name <name> --type <NFS|CIFS|OST|RDS|NDMP|ISCSI|FC> [--clients <ip address>]
connection --enable --name <name> --type <NFS|CIFS|OST|RDS>
connection --disable --name <name> --type <NFS|CIFS|OST|RDS>
connection --help
Container Command Usage
iSCSI
NDMP
Object_container
container --show [--name <name>] [--verbose]
container --add --name <name> [--type <VTL>] [--tape_size <tape_size>][--no_of_drives <1–60>][--is_oem <yes|no>][--oem_vendor <QUEST|DELL>][--group_name <name>]
container --update --name <name> [--no_of_drives <1–60>]
container --delete --name <name> [--delete_files]
container --marker [--enable <Auto | CommVault | Networker | TSM | ARCserve | HP_DataProtector | Unix_Dump | BridgeHead>] [--disable <Auto | CommVault | Networker | TSM | ARCserve | HP_DataProtector | Unix_Dump | BridgeHead>] --name <name>
container --cloud_policy
container --delete_files --name <name>
container --add_uac
container --delete_uac
container --update_uac
container --show_uac
container --help
object_container command usage
Object_direct
Performance_tier
Replication
object_container --show
object_container --add
object_container --update
object_container --encryption
object_container --delete_data
object_container --delete
object_container --setpassphrase
object_container --bkt-add
object_container --bkt-del
object_container --bkt-list
object_container --bkt-lock
object_container --bkt-version
object_container --bkt-legalhold
object_container --bkt-retention
object_container --bkt-show
object_container --policy-list
object_container --policy-set
object_container --policy-unset
object_container --policy-update
object_container --policy-show
object_container --user-add
object_container --user-del
object_container --user-enable
object_container --user-disable
object_container --user-list
object_container --help
Replication Command Usage
Seed
replication --show
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>]
replication --update --name <name> --role <source | target> [--peer <ip address | hostname>] [--encryption <none | aes128 | aes256>] [--username <user name>]
replication --delete --name <name> --role <source | target> [--force]
replication --start --name <name> --role <source | target>
replication --stop --name <name> --role <source | target>
replication --limit --speed <<num><KBps | MBps | GBps> | default> --target <ip address | hostname>
replication --resync --name <name> --role <source | target>
replication --troubleshoot --peer <ip address | hostname>
replication --help
Seed Command Usage
Schedule
VTL
seed --create --op <import | export> [--enc_type <aes128 | aes256>] [--storage_group_name <name>]
seed --add_container --name <container name>
seed --add_device --server <server name> --volume <volume> --username <username> --domain <domain name>
seed --cleanup
seed --remove_device
seed --show
seed --start
seed --help
VTL Command Usage
vtl --show [--name <name>]
vtl --update_carts --name <name> --add --no_of_tapes <number>
vtl --activate --name <name> [--force <yes|no>]
vtl --deactivate --name <name>
vtl --rescan --name <name> [--force <yes|no>]
vtl --restore
vtl --set_rw --name <name> [--id <number>]
vtl --show_replstate --name <name>
vtl --help
Maintenance
About us
Maintenance commands
maintenance --filesystem [--scan_status]
maintenance --filesystem [--scan_report [verbose]]
maintenance --filesystem [--repair_history [verbose]]
maintenance --filesystem [--scan_restart [verify_data | verify_rda_metadata | verify_metadata]]
maintenance --filesystem [--repair_now]
maintenance --filesystem [--reclaim_space]
maintenance --filesystem [--stop_reclaim_space]
maintenance --filesystem [--clear_quarantine]
maintenance --filesystem [--start_scan [verify_data | verify_rda_metadata | verify_metadata] [--storage_group <name>]
maintenance --filesystem [--stop_scan]
maintenance --diags --collect
maintenance --diags --show
maintenance --diags --delete <name>
maintenance --diags --delete_all
maintenance --disaster_recovery
maintenance --help
Introduction to the QoreStor Command Line Reference Guide
Introduction to the QoreStor Command Line Reference Guide
About the QoreStor CLI documentation
This document provides information about using the QoreStor command line interface (CLI) for managing your data backups, performing a variety of data storage operations, and using containers to meet your backup storage needs.
|
|
NOTE: The QoreStor CLI provides one method for managing QoreStor, with the other being the QoreStor graphical user interface (GUI). In some instances, the QoreStor CLI might provide additional features and options that are not available in the QoreStor GUI and vice versa. |
Other information you may need
The following table lists the documentation available for QoreStor. The documents listed in this table are available on the Quest support website by selecting your specific QoreStor version at:
http://support.quest.com/QoreStor
| Document | Description |
|---|---|
| QoreStor Installation Guide | Provides information on installation and operation requirements, supported platforms as well as procedures for installing QoreStor. |
| QoreStor User Guide | Provides information on configuring and using QoreStor. |
| QoreStor Release Notes | Provides the latest information about new features and known issues with a specific product release. |
| QoreStor Command Line Reference Guide | Provides information about managing QoreStor data backup and replication operations using the QoreStor command line interface (CLI). |
| QoreStor Interoperability Guide | Provides information on supported infrastructure components. |
| QoreStor Virtual Machine Deployment Guide | Provides information on deploying the QoreStor virtual machine on VMware ESX or Microsoft Hyper-V. |
| Additional whitepapers | Instructions and best practices for configuring additional Quest and third-party applications to work with QoreStor. |
|
|
NOTE: Check for the latest documentation updates and release notes at http://support.quest.com/qorestor. Read the release notes first because they contain the most recently documented information about known issues with a specific product release. |
Introducing QoreStor
Introducing Quest® QoreStor™
Quest® QoreStor™ is a software-defined secondary storage platform based on Quest’s proven DR Appliance’s resilient deduplication and replication technologies. With QoreStor, you can break free of backup appliances and accelerate backup performance, reduce storage requirements and costs, and replicate safer and faster to the cloud for data archiving, disaster recovery and business continuity.
QoreStor supports all of the major backup software applications in use today and can lower your backup storage costs to as little as $.16/GB while reducing your total cost of ownership.QoreStor achieves these results using patented Rapid technology as well as built-in, variable block-based deduplication and compression.
Lower costs and maximize the return on your IT investment by leveraging virtually any storage hardware, virtualization platform or cloud provider. QoreStor also supports many backup software solutions — so it’s not just for Quest. Simple to deploy and easy to manage, QoreStor enables you to shrink replication time, improve data security and address compliance requirements.
QoreStor helps you to:
- Reduce on-premises and cloud storage costs with industry-leading deduplication and compression.
- Accelerate backup completion with protocol accelerators and dedupe.
- Shrink replication time by transmitting only changed data.
- Improve data security and comply with FIPS 140-2.
- Maximize return on investment for existing data protection technologies.
- Lower total cost of ownership through all-inclusive licensing.
QoreStor includes the following features:
- Hardware and software agnostic platform
- Next-generation storage dedupe engine
- Built-in protocol accelerators
- Support for a wide variety of data backup installations and environments.