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
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 --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
Performance_tier
Replication
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
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 --set_rw --name <name> [--id <number>]
vtl --show_replstate --name <name>
vtl --help
Maintenance
About us
Maintenance command
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
maintenance --diags --delete_all
Description
Deletes all of the diagnostics files on a QoreStor server.
|
|
Caution: Carefully consider before using the --delete_all command. If you delete all diagnostics log files without first saving them to another location, all previous system status information that they contained is lost and unrecoverable. |
Syntax
maintenance --diags --delete_all
Result
Deleting all diagnostics
maintenance --disaster_recovery
Description
Begins a disaster recovery of the QoreStor server using data archived to a cloud tier.
Syntax
maintenance --disaster_recovery --cloud_string <name> --container_name <name> --cloud_provider_type <name> --passphrase <name> [--logfile <name>]
Where
--cloud_string cloud connecion string. --container_name cloud cotainer name. --cloud_provider_type cloud provider type. --passphrase passphrase. --logfile log file path.
Result
Filesystem disaster recovery started successfully.
maintenance --help
Description
Displays the list of maintenance-related options that can be used as a reference when using the QoreStor CLI.
Syntax
maintenance --help
Result
Usage:
maintenance --filesystem [--scan_status] [--scan_report [verbose]] [--repair_status [verbose]] [--repair_history [verbose]] [--scan_restart [verify_data | verify_rda_metadata | verify_metadata]] [--repair_now] [--reclaim_space] [--stop_reclaim_space] [--clear_quarantine] [--start_scan [verify_data | verify_rda_metadata | verify_metadata]] [--storage_group <name>] [--stop_scan] [--shutdown] maintenance --diags [--collect] [--show] [--delete <name>] [--delete_all] maintenance --disaster_recovery --cloud_string <name> --container_name <name> --cloud_provider_type <name> --passphrase <name> [--logfile <name>] maintenance --help maintenance <command> <command-arguments> <command> can be one of: --filesystem Maintenance operations on filesystem. --diags Diags operations. --disaster_recovery Disaster recovery For command-specific help, please type maintenance --help <command> eg: maintenance --help filesystem
About us
About us
Quest provides software solutions for the rapidly-changing world of enterprise IT. We help simplify the challenges caused by data explosion, cloud expansion, hybrid datacenters, security threats, and regulatory requirements. We are a global provider to 130,000 companies across 100 countries, including 95% of the Fortune 500 and 90% of the Global 1000. Since 1987, we have built a portfolio of solutions that now includes database management, data protection, identity and access management, Microsoft platform management, and unified endpoint management. With Quest, organizations spend less time on IT administration and more time on business innovation. For more information, visit www.quest.com.
Technical support resources
Technical support is available to Quest customers with a valid maintenance contract and customers who have trial versions. You can access the Quest Support Portal at https://support.quest.com.
The Support Portal provides self-help tools you can use to solve problems quickly and independently, 24 hours a day, 365 days a year. The Support Portal enables you to:
- Submit and manage a Service Request
- View Knowledge Base articles
- Sign up for product notifications
- Download software and technical documentation
- View how-to-videos
- Engage in community discussions
- Chat with support engineers online
- View services to assist you with your product